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 drvopts[] = {
  29         SR_CONF_OSCILLOSCOPE,
  30 };
  31
  32 static const uint32_t devopts[] = {
  33         SR_CONF_LIMIT_FRAMES | SR_CONF_GET | SR_CONF_SET,
  34         SR_CONF_SAMPLERATE | SR_CONF_GET,
  35 };
  36
  37 static struct sr_dev_driver gwinstek_gds_800_driver_info;
  38
  39 static struct sr_dev_inst *probe_device(struct sr_scpi_dev_inst *scpi)
  40 {
  41         struct dev_context *devc;
  42         struct sr_dev_inst *sdi;
  43         struct sr_scpi_hw_info *hw_info;
  44         struct sr_channel_group *cg;
  45
  46         if (sr_scpi_get_hw_id(scpi, &hw_info) != SR_OK) {
  47                 sr_info("Couldn't get IDN response.");
  48                 return NULL;
  49         }
  50
  51         if (strcmp(hw_info->manufacturer, "GW") != 0 ||
  52             strncmp(hw_info->model, "GDS-8", 5) != 0) {
  53                 sr_scpi_hw_info_free(hw_info);
  54                 return NULL;
  55         }
  56
  57         sdi = g_malloc0(sizeof(struct sr_dev_inst));
  58         sdi->vendor = g_strdup(hw_info->manufacturer);
  59         sdi->model = g_strdup(hw_info->model);
  60         sdi->version = g_strdup(hw_info->firmware_version);
  61         sdi->conn = scpi;
  62         sdi->driver = &gwinstek_gds_800_driver_info;
  63         sdi->inst_type = SR_INST_SCPI;
  64         sdi->serial_num = g_strdup(hw_info->serial_number);
  65         sdi->channels = NULL;
  66         sdi->channel_groups = NULL;
  67
  68         sr_scpi_hw_info_free(hw_info);
  69
  70         devc = g_malloc0(sizeof(struct dev_context));
  71         devc->frame_limit = 1;
  72         devc->sample_rate = 0.0;
  73         devc->df_started = FALSE;
  74         sdi->priv = devc;
  75
  76         sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "CH1");
  77         sr_channel_new(sdi, 1, SR_CHANNEL_ANALOG, TRUE, "CH2");
  78
  79         cg = g_malloc0(sizeof(struct sr_channel_group));
  80         cg->name = g_strdup("");
  81         cg->channels = g_slist_append(cg->channels, g_slist_nth_data(sdi->channels, 0));
  82         cg->channels = g_slist_append(cg->channels, g_slist_nth_data(sdi->channels, 1));
  83         cg->priv = NULL;
  84         sdi->channel_groups = g_slist_append(NULL, cg);
  85
  86         return sdi;
  87 }
  88
  89 static GSList *scan(struct sr_dev_driver *di, GSList *options)
  90 {
  91         return sr_scpi_scan(di->context, options, probe_device);
  92 }
  93
  94 static int dev_open(struct sr_dev_inst *sdi)
  95 {
  96         int ret;
  97         struct sr_scpi_dev_inst *scpi = sdi->conn;
  98
  99         if ((ret = sr_scpi_open(scpi)) < 0) {
 100                 sr_err("Failed to open SCPI device: %s.", sr_strerror(ret));
 101                 return SR_ERR;
 102         }
 103
 104         return SR_OK;
 105 }
 106
 107 static int dev_close(struct sr_dev_inst *sdi)
 108 {
 109         struct sr_scpi_dev_inst *scpi;
 110
 111         scpi = sdi->conn;
 112
 113         if (!scpi)
 114                 return SR_ERR_BUG;
 115
 116         return sr_scpi_close(scpi);
 117 }
 118
 119 static int config_get(uint32_t key, GVariant **data,
 120         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 121 {
 122         struct dev_context *devc;
 123
 124         (void)cg;
 125
 126         if (!sdi)
 127                 return SR_ERR_ARG;
 128
 129         devc = sdi->priv;
 130
 131         switch (key) {
 132         case SR_CONF_SAMPLERATE:
 133                 *data = g_variant_new_uint64(devc->sample_rate);
 134                 break;
 135         case SR_CONF_LIMIT_FRAMES:
 136                 *data = g_variant_new_uint64(devc->frame_limit);
 137                 break;
 138         default:
 139                 return SR_ERR_NA;
 140         }
 141
 142         return SR_OK;
 143 }
 144
 145 static int config_set(uint32_t key, GVariant *data,
 146         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 147 {
 148         struct dev_context *devc;
 149
 150         (void)cg;
 151
 152         if (!sdi)
 153                 return SR_ERR_ARG;
 154
 155         devc = sdi->priv;
 156
 157         switch (key) {
 158         case SR_CONF_LIMIT_FRAMES:
 159                 devc->frame_limit = g_variant_get_uint64(data);
 160                 break;
 161         default:
 162                 return SR_ERR_NA;
 163         }
 164
 165         return SR_OK;
 166 }
 167
 168 static int config_list(uint32_t key, GVariant **data,
 169         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 170 {
 171         return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
 172 }
 173
 174 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 175 {
 176         struct sr_scpi_dev_inst *scpi;
 177         struct dev_context *devc;
 178
 179         scpi = sdi->conn;
 180         devc = sdi->priv;
 181
 182         devc->state = START_ACQUISITION;
 183         devc->cur_acq_frame = 0;
 184
 185         sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 50,
 186                         gwinstek_gds_800_receive_data, (void *)sdi);
 187
 188         return SR_OK;
 189 }
 190
 191 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 192 {
 193         struct sr_scpi_dev_inst *scpi;
 194         struct dev_context *devc;
 195
 196         scpi = sdi->conn;
 197         devc = sdi->priv;
 198
 199         if (devc->df_started) {
 200                 std_session_send_df_frame_end(sdi);
 201                 std_session_send_df_end(sdi);
 202                 devc->df_started = FALSE;
 203         }
 204
 205         sr_scpi_source_remove(sdi->session, scpi);
 206
 207         return SR_OK;
 208 }
 209
 210 static struct sr_dev_driver gwinstek_gds_800_driver_info = {
 211         .name = "gwinstek-gds-800",
 212         .longname = "GW Instek GDS-800 series",
 213         .api_version = 1,
 214         .init = std_init,
 215         .cleanup = std_cleanup,
 216         .scan = scan,
 217         .dev_list = std_dev_list,
 218         .dev_clear = std_dev_clear,
 219         .config_get = config_get,
 220         .config_set = config_set,
 221         .config_list = config_list,
 222         .dev_open = dev_open,
 223         .dev_close = dev_close,
 224         .dev_acquisition_start = dev_acquisition_start,
 225         .dev_acquisition_stop = dev_acquisition_stop,
 226         .context = NULL,
 227 };
 228 SR_REGISTER_DEV_DRIVER(gwinstek_gds_800_driver_info);