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         if (sdi->status != SR_ST_ACTIVE)
 111                 return SR_ERR_DEV_CLOSED;
 112
 113         scpi = sdi->conn;
 114         if (scpi) {
 115                 if (sr_scpi_close(scpi) < 0)
 116                         return SR_ERR;
 117                 sdi->status = SR_ST_INACTIVE;
 118         }
 119
 120         return SR_OK;
 121 }
 122
 123 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 124                 const struct sr_channel_group *cg)
 125 {
 126         struct dev_context *devc;
 127
 128         (void)cg;
 129
 130         if (!sdi)
 131                 return SR_ERR_ARG;
 132
 133         devc = sdi->priv;
 134
 135         switch (key) {
 136         case SR_CONF_SAMPLERATE:
 137                 *data = g_variant_new_uint64(devc->sample_rate);
 138                 break;
 139         default:
 140                 return SR_ERR_NA;
 141         }
 142
 143         return SR_OK;
 144 }
 145
 146 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 147                 const struct sr_channel_group *cg)
 148 {
 149         struct dev_context *devc;
 150
 151         (void)cg;
 152
 153         if (!sdi)
 154                 return SR_ERR_ARG;
 155
 156         if (sdi->status != SR_ST_ACTIVE)
 157                 return SR_ERR_DEV_CLOSED;
 158
 159         devc = sdi->priv;
 160
 161         switch (key) {
 162         case SR_CONF_LIMIT_FRAMES:
 163                 devc->frame_limit = g_variant_get_uint64(data);
 164                 break;
 165         default:
 166                 return SR_ERR_NA;
 167         }
 168
 169         return SR_OK;
 170 }
 171
 172 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 173                 const struct sr_channel_group *cg)
 174 {
 175         (void)sdi;
 176         (void)cg;
 177
 178         switch (key) {
 179         case SR_CONF_SCAN_OPTIONS:
 180                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 181                         scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 182                 return SR_OK;
 183         case SR_CONF_DEVICE_OPTIONS:
 184                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 185                         devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 186                 return SR_OK;
 187         default:
 188                 return SR_ERR_NA;
 189         }
 190
 191         return SR_OK;
 192 }
 193
 194 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 195 {
 196         struct sr_scpi_dev_inst *scpi;
 197         struct dev_context *devc;
 198
 199         scpi = sdi->conn;
 200         devc = sdi->priv;
 201
 202         if (sdi->status != SR_ST_ACTIVE)
 203                 return SR_ERR_DEV_CLOSED;
 204
 205         devc->state = START_ACQUISITION;
 206         devc->cur_acq_frame = 0;
 207
 208         sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 50,
 209                         gwinstek_gds_800_receive_data, (void *)sdi);
 210
 211         return SR_OK;
 212 }
 213
 214 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 215 {
 216         struct sr_scpi_dev_inst *scpi;
 217         struct dev_context *devc;
 218         struct sr_datafeed_packet packet;
 219
 220         scpi = sdi->conn;
 221         devc = sdi->priv;
 222
 223         if (sdi->status != SR_ST_ACTIVE) {
 224                 sr_err("Device inactive, can't stop acquisition.");
 225                 return SR_ERR;
 226         }
 227
 228         if (devc->df_started) {
 229                 packet.type = SR_DF_FRAME_END;
 230                 sr_session_send(sdi, &packet);
 231
 232                 std_session_send_df_end(sdi);
 233
 234                 devc->df_started = FALSE;
 235         }
 236
 237         sr_scpi_source_remove(sdi->session, scpi);
 238
 239         return SR_OK;
 240 }
 241
 242 static struct sr_dev_driver gwinstek_gds_800_driver_info = {
 243         .name = "gwinstek-gds-800",
 244         .longname = "GW Instek GDS-800 series",
 245         .api_version = 1,
 246         .init = std_init,
 247         .cleanup = std_cleanup,
 248         .scan = scan,
 249         .dev_list = std_dev_list,
 250         .config_get = config_get,
 251         .config_set = config_set,
 252         .config_list = config_list,
 253         .dev_open = dev_open,
 254         .dev_close = dev_close,
 255         .dev_acquisition_start = dev_acquisition_start,
 256         .dev_acquisition_stop = dev_acquisition_stop,
 257         .context = NULL,
 258 };
 259 SR_REGISTER_DEV_DRIVER(gwinstek_gds_800_driver_info);