src/hardware/gwinstek-gds-800/api.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2015 Martin Lederhilger <martin.lederhilger@gmx.at>
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #include <string.h>
  21 #include "protocol.h"
  22
  23 static const uint32_t scanopts[] = {
  24         SR_CONF_CONN,
  25         SR_CONF_SERIALCOMM,
  26 };
  27
  28 static const uint32_t devopts[] = {
  29         SR_CONF_OSCILLOSCOPE,
  30         SR_CONF_LIMIT_FRAMES | SR_CONF_SET,
  31         SR_CONF_SAMPLERATE | SR_CONF_GET,
  32 };
  33
  34 static struct sr_dev_driver gwinstek_gds_800_driver_info;
  35
  36 static struct sr_dev_inst *probe_device(struct sr_scpi_dev_inst *scpi)
  37 {
  38         struct dev_context *devc;
  39         struct sr_dev_inst *sdi;
  40         struct sr_scpi_hw_info *hw_info;
  41         struct sr_channel_group *cg;
  42
  43         if (sr_scpi_get_hw_id(scpi, &hw_info) != SR_OK) {
  44                 sr_info("Couldn't get IDN response.");
  45                 return NULL;
  46         }
  47
  48         if (strcmp(hw_info->manufacturer, "GW") != 0 ||
  49             strncmp(hw_info->model, "GDS-8", 5) != 0) {
  50                 sr_scpi_hw_info_free(hw_info);
  51                 return NULL;
  52         }
  53
  54         sdi = g_malloc0(sizeof(struct sr_dev_inst));
  55         sdi->vendor = g_strdup(hw_info->manufacturer);
  56         sdi->model = g_strdup(hw_info->model);
  57         sdi->version = g_strdup(hw_info->firmware_version);
  58         sdi->conn = scpi;
  59         sdi->driver = &gwinstek_gds_800_driver_info;
  60         sdi->inst_type = SR_INST_SCPI;
  61         sdi->serial_num = g_strdup(hw_info->serial_number);
  62         sdi->channels = NULL;
  63         sdi->channel_groups = NULL;
  64
  65         sr_scpi_hw_info_free(hw_info);
  66
  67         devc = g_malloc0(sizeof(struct dev_context));
  68         devc->frame_limit = 1;
  69         devc->sample_rate = 0.0;
  70         devc->df_started = FALSE;
  71         sdi->priv = devc;
  72
  73         sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "CH1");
  74         sr_channel_new(sdi, 1, SR_CHANNEL_ANALOG, TRUE, "CH2");
  75
  76         cg = g_malloc0(sizeof(struct sr_channel_group));
  77         cg->name = g_strdup("");
  78         cg->channels = g_slist_append(cg->channels, g_slist_nth_data(sdi->channels, 0));
  79         cg->channels = g_slist_append(cg->channels, g_slist_nth_data(sdi->channels, 1));
  80         cg->priv = NULL;
  81         sdi->channel_groups = g_slist_append(NULL, cg);
  82
  83         return sdi;
  84 }
  85
  86 static GSList *scan(struct sr_dev_driver *di, GSList *options)
  87 {
  88         return sr_scpi_scan(di->context, options, probe_device);
  89 }
  90
  91 static int dev_open(struct sr_dev_inst *sdi)
  92 {
  93         int ret;
  94         struct sr_scpi_dev_inst *scpi = sdi->conn;
  95
  96         if ((ret = sr_scpi_open(scpi)) < 0) {
  97                 sr_err("Failed to open SCPI device: %s.", sr_strerror(ret));
  98                 return SR_ERR;
  99         }
 100
 101         sdi->status = SR_ST_ACTIVE;
 102
 103         return SR_OK;
 104 }
 105
 106 static int dev_close(struct sr_dev_inst *sdi)
 107 {
 108         struct sr_scpi_dev_inst *scpi;
 109
 110         scpi = sdi->conn;
 111         if (scpi) {
 112                 if (sr_scpi_close(scpi) < 0)
 113                         return SR_ERR;
 114                 sdi->status = SR_ST_INACTIVE;
 115         }
 116
 117         return SR_OK;
 118 }
 119
 120 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 121                 const struct sr_channel_group *cg)
 122 {
 123         struct dev_context *devc;
 124
 125         (void)cg;
 126
 127         if (!sdi)
 128                 return SR_ERR_ARG;
 129
 130         devc = sdi->priv;
 131
 132         switch (key) {
 133         case SR_CONF_SAMPLERATE:
 134                 *data = g_variant_new_uint64(devc->sample_rate);
 135                 break;
 136         default:
 137                 return SR_ERR_NA;
 138         }
 139
 140         return SR_OK;
 141 }
 142
 143 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 144                 const struct sr_channel_group *cg)
 145 {
 146         struct dev_context *devc;
 147
 148         (void)cg;
 149
 150         if (!sdi)
 151                 return SR_ERR_ARG;
 152
 153         devc = sdi->priv;
 154
 155         switch (key) {
 156         case SR_CONF_LIMIT_FRAMES:
 157                 devc->frame_limit = g_variant_get_uint64(data);
 158                 break;
 159         default:
 160                 return SR_ERR_NA;
 161         }
 162
 163         return SR_OK;
 164 }
 165
 166 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 167                 const struct sr_channel_group *cg)
 168 {
 169         (void)sdi;
 170         (void)cg;
 171
 172         switch (key) {
 173         case SR_CONF_SCAN_OPTIONS:
 174                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 175                         scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 176                 return SR_OK;
 177         case SR_CONF_DEVICE_OPTIONS:
 178                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 179                         devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 180                 return SR_OK;
 181         default:
 182                 return SR_ERR_NA;
 183         }
 184
 185         return SR_OK;
 186 }
 187
 188 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 189 {
 190         struct sr_scpi_dev_inst *scpi;
 191         struct dev_context *devc;
 192
 193         scpi = sdi->conn;
 194         devc = sdi->priv;
 195
 196         devc->state = START_ACQUISITION;
 197         devc->cur_acq_frame = 0;
 198
 199         sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 50,
 200                         gwinstek_gds_800_receive_data, (void *)sdi);
 201
 202         return SR_OK;
 203 }
 204
 205 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 206 {
 207         struct sr_scpi_dev_inst *scpi;
 208         struct dev_context *devc;
 209         struct sr_datafeed_packet packet;
 210
 211         scpi = sdi->conn;
 212         devc = sdi->priv;
 213
 214         if (devc->df_started) {
 215                 packet.type = SR_DF_FRAME_END;
 216                 sr_session_send(sdi, &packet);
 217
 218                 std_session_send_df_end(sdi);
 219
 220                 devc->df_started = FALSE;
 221         }
 222
 223         sr_scpi_source_remove(sdi->session, scpi);
 224
 225         return SR_OK;
 226 }
 227
 228 static struct sr_dev_driver gwinstek_gds_800_driver_info = {
 229         .name = "gwinstek-gds-800",
 230         .longname = "GW Instek GDS-800 series",
 231         .api_version = 1,
 232         .init = std_init,
 233         .cleanup = std_cleanup,
 234         .scan = scan,
 235         .dev_list = std_dev_list,
 236         .config_get = config_get,
 237         .config_set = config_set,
 238         .config_list = config_list,
 239         .dev_open = dev_open,
 240         .dev_close = dev_close,
 241         .dev_acquisition_start = dev_acquisition_start,
 242         .dev_acquisition_stop = dev_acquisition_stop,
 243         .context = NULL,
 244 };
 245 SR_REGISTER_DEV_DRIVER(gwinstek_gds_800_driver_info);