src/hardware/scpi-dmm/api.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2018 Gerhard Sittig <gerhard.sittig@gmx.net>
   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 struct sr_dev_driver scpi_dmm_driver_info;
  24
  25 static const uint32_t scanopts[] = {
  26         SR_CONF_CONN,
  27         SR_CONF_SERIALCOMM,
  28 };
  29
  30 static const uint32_t drvopts[] = {
  31         SR_CONF_MULTIMETER,
  32 };
  33
  34 static const uint32_t devopts_generic[] = {
  35         SR_CONF_CONTINUOUS,
  36         SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
  37         SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
  38         SR_CONF_MEASURED_QUANTITY | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  39 };
  40
  41 static const struct scpi_command cmdset_agilent[] = {
  42         { DMM_CMD_SETUP_REMOTE, "\n", },
  43         { DMM_CMD_SETUP_FUNC, "CONF:%s", },
  44         { DMM_CMD_QUERY_FUNC, "CONF?", },
  45         { DMM_CMD_START_ACQ, "MEAS", },
  46         { DMM_CMD_STOP_ACQ, "ABORT", },
  47         { DMM_CMD_QUERY_VALUE, "READ?", },
  48         { DMM_CMD_QUERY_PREC, "CONF?", },
  49         ALL_ZERO,
  50 };
  51
  52 static const struct mqopt_item mqopts_agilent_5digit[] = {
  53         { SR_MQ_VOLTAGE, SR_MQFLAG_DC, "VOLT:DC", "VOLT ", NO_DFLT_PREC, },
  54         { SR_MQ_VOLTAGE, SR_MQFLAG_AC, "VOLT:AC", "VOLT:AC ", NO_DFLT_PREC, },
  55         { SR_MQ_CURRENT, SR_MQFLAG_DC, "CURR:DC", "CURR ", NO_DFLT_PREC, },
  56         { SR_MQ_CURRENT, SR_MQFLAG_AC, "CURR:AC", "CURR:AC ", NO_DFLT_PREC, },
  57         { SR_MQ_RESISTANCE, 0, "RES", "RES ", NO_DFLT_PREC, },
  58         { SR_MQ_RESISTANCE, SR_MQFLAG_FOUR_WIRE, "FRES", "FRES ", NO_DFLT_PREC, },
  59         { SR_MQ_CONTINUITY, 0, "CONT", "CONT", -1, },
  60         { SR_MQ_CAPACITANCE, 0, "CAP", "CAP ", NO_DFLT_PREC, },
  61         { SR_MQ_VOLTAGE, SR_MQFLAG_DC | SR_MQFLAG_DIODE, "DIOD", "DIOD", -4, },
  62         { SR_MQ_TEMPERATURE, 0, "TEMP", "TEMP ", NO_DFLT_PREC, },
  63         { SR_MQ_FREQUENCY, 0, "FREQ", "FREQ ", NO_DFLT_PREC, },
  64 };
  65
  66 SR_PRIV const struct scpi_dmm_model models[] = {
  67         {
  68                 "Agilent", "34405A",
  69                 1, 5, cmdset_agilent, ARRAY_AND_SIZE(mqopts_agilent_5digit),
  70                 scpi_dmm_get_meas_agilent,
  71                 ARRAY_AND_SIZE(devopts_generic),
  72         },
  73 };
  74
  75 static const struct scpi_dmm_model *is_compatible(const char *vendor, const char *model)
  76 {
  77         size_t i;
  78         const struct scpi_dmm_model *entry;
  79
  80         for (i = 0; i < ARRAY_SIZE(models); i++) {
  81                 entry = &models[i];
  82                 if (!entry->vendor || !entry->model)
  83                         continue;
  84                 if (strcmp(vendor, entry->vendor) != 0)
  85                         continue;
  86                 if (strcmp(model, entry->model) != 0)
  87                         continue;
  88                 return entry;
  89         }
  90
  91         return NULL;
  92 }
  93
  94 static struct sr_dev_inst *probe_device(struct sr_scpi_dev_inst *scpi)
  95 {
  96         struct sr_scpi_hw_info *hw_info;
  97         int ret;
  98         const char *vendor;
  99         const struct scpi_dmm_model *model;
 100         struct sr_dev_inst *sdi;
 101         struct dev_context *devc;
 102         size_t i;
 103         gchar *channel_name;
 104
 105         ret = sr_scpi_get_hw_id(scpi, &hw_info);
 106         scpi_dmm_cmd_delay(scpi);
 107         if (ret != SR_OK) {
 108                 sr_info("Could not get IDN response.");
 109                 return NULL;
 110         }
 111         vendor = sr_vendor_alias(hw_info->manufacturer);
 112         model = is_compatible(vendor, hw_info->model);
 113         if (!model) {
 114                 sr_scpi_hw_info_free(hw_info);
 115                 return NULL;
 116         }
 117
 118         sdi = g_malloc0(sizeof(*sdi));
 119         sdi->vendor = g_strdup(hw_info->manufacturer);
 120         sdi->model = g_strdup(hw_info->model);
 121         sdi->version = g_strdup(hw_info->firmware_version);
 122         sdi->serial_num = g_strdup(hw_info->serial_number);
 123         sdi->conn = scpi;
 124         sdi->driver = &scpi_dmm_driver_info;
 125         sdi->inst_type = SR_INST_SCPI;
 126         sr_scpi_hw_info_free(hw_info);
 127
 128         devc = g_malloc0(sizeof(*devc));
 129         sdi->priv = devc;
 130         devc->num_channels = model->num_channels;
 131         devc->cmdset = model->cmdset;
 132         devc->model = model;
 133
 134         for (i = 0; i < devc->num_channels; i++) {
 135                 channel_name = g_strdup_printf("P%zu", i + 1);
 136                 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, channel_name);
 137         }
 138
 139         return sdi;
 140 }
 141
 142 static GSList *scan(struct sr_dev_driver *di, GSList *options)
 143 {
 144         return sr_scpi_scan(di->context, options, probe_device);
 145 }
 146
 147 static int dev_open(struct sr_dev_inst *sdi)
 148 {
 149         struct sr_scpi_dev_inst *scpi;
 150         int ret;
 151
 152         scpi = sdi->conn;
 153         ret = sr_scpi_open(scpi);
 154         if (ret < 0) {
 155                 sr_err("Failed to open SCPI device: %s.", sr_strerror(ret));
 156                 return SR_ERR;
 157         }
 158
 159         return SR_OK;
 160 }
 161
 162 static int dev_close(struct sr_dev_inst *sdi)
 163 {
 164         struct sr_scpi_dev_inst *scpi;
 165
 166         scpi = sdi->conn;
 167         if (!scpi)
 168                 return SR_ERR_BUG;
 169
 170         sr_dbg("DIAG: sdi->status %d.", sdi->status - SR_ST_NOT_FOUND);
 171         if (sdi->status <= SR_ST_INACTIVE)
 172                 return SR_OK;
 173
 174         return sr_scpi_close(scpi);
 175 }
 176
 177 static int config_get(uint32_t key, GVariant **data,
 178         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 179 {
 180         struct dev_context *devc;
 181         enum sr_mq mq;
 182         enum sr_mqflag mqflag;
 183         GVariant *arr[2];
 184         int ret;
 185
 186         (void)cg;
 187
 188         devc = sdi->priv;
 189
 190         switch (key) {
 191         case SR_CONF_LIMIT_SAMPLES:
 192         case SR_CONF_LIMIT_MSEC:
 193                 return sr_sw_limits_config_get(&devc->limits, key, data);
 194         case SR_CONF_MEASURED_QUANTITY:
 195                 ret = scpi_dmm_get_mq(sdi, &mq, &mqflag, NULL);
 196                 if (ret != SR_OK)
 197                         return ret;
 198                 arr[0] = g_variant_new_uint32(mq);
 199                 arr[1] = g_variant_new_uint64(mqflag);
 200                 *data = g_variant_new_tuple(arr, ARRAY_SIZE(arr));
 201                 return SR_OK;
 202         default:
 203                 return SR_ERR_NA;
 204         }
 205 }
 206
 207 static int config_set(uint32_t key, GVariant *data,
 208         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 209 {
 210         struct dev_context *devc;
 211         enum sr_mq mq;
 212         enum sr_mqflag mqflag;
 213         GVariant *tuple_child;
 214
 215         (void)cg;
 216
 217         devc = sdi->priv;
 218
 219         switch (key) {
 220         case SR_CONF_LIMIT_SAMPLES:
 221         case SR_CONF_LIMIT_MSEC:
 222                 return sr_sw_limits_config_set(&devc->limits, key, data);
 223         case SR_CONF_MEASURED_QUANTITY:
 224                 tuple_child = g_variant_get_child_value(data, 0);
 225                 mq = g_variant_get_uint32(tuple_child);
 226                 tuple_child = g_variant_get_child_value(data, 1);
 227                 mqflag = g_variant_get_uint64(tuple_child);
 228                 g_variant_unref(tuple_child);
 229                 return scpi_dmm_set_mq(sdi, mq, mqflag);
 230         default:
 231                 return SR_ERR_NA;
 232         }
 233 }
 234
 235 static int config_list(uint32_t key, GVariant **data,
 236         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 237 {
 238         struct dev_context *devc;
 239         GVariant *gvar, *arr[2];
 240         GVariantBuilder gvb;
 241         size_t i;
 242
 243         (void)cg;
 244
 245         devc = sdi ? sdi->priv : NULL;
 246
 247         switch (key) {
 248         case SR_CONF_SCAN_OPTIONS:
 249         case SR_CONF_DEVICE_OPTIONS:
 250                 if (!devc)
 251                         return STD_CONFIG_LIST(key, data, sdi, cg,
 252                                 scanopts, drvopts, devopts_generic);
 253                 return std_opts_config_list(key, data, sdi, cg,
 254                         ARRAY_AND_SIZE(scanopts), ARRAY_AND_SIZE(drvopts),
 255                         devc->model->devopts, devc->model->devopts_size);
 256         case SR_CONF_MEASURED_QUANTITY:
 257                 /* TODO Use std_gvar_measured_quantities() when available. */
 258                 if (!devc)
 259                         return SR_ERR_ARG;
 260                 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
 261                 for (i = 0; i < devc->model->mqopt_size; i++) {
 262                         arr[0] = g_variant_new_uint32(devc->model->mqopts[i].mq);
 263                         arr[1] = g_variant_new_uint64(devc->model->mqopts[i].mqflag);
 264                         gvar = g_variant_new_tuple(arr, ARRAY_SIZE(arr));
 265                         g_variant_builder_add_value(&gvb, gvar);
 266                 }
 267                 *data = g_variant_builder_end(&gvb);
 268                 return SR_OK;
 269         default:
 270                 (void)devc;
 271                 return SR_ERR_NA;
 272         }
 273 }
 274
 275 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 276 {
 277         struct sr_scpi_dev_inst *scpi;
 278         struct dev_context *devc;
 279         int ret;
 280         const char *command;
 281
 282         scpi = sdi->conn;
 283         devc = sdi->priv;
 284
 285         ret = scpi_dmm_get_mq(sdi, &devc->start_acq_mq.curr_mq,
 286                 &devc->start_acq_mq.curr_mqflag, NULL);
 287         if (ret != SR_OK)
 288                 return ret;
 289
 290         command = sr_scpi_cmd_get(devc->cmdset, DMM_CMD_START_ACQ);
 291         if (command && *command) {
 292                 ret = sr_scpi_send(scpi, command);
 293                 scpi_dmm_cmd_delay(scpi);
 294                 if (ret != SR_OK)
 295                         return ret;
 296         }
 297
 298         sr_sw_limits_acquisition_start(&devc->limits);
 299         ret = std_session_send_df_header(sdi);
 300         if (ret != SR_OK)
 301                 return ret;
 302
 303         ret = sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 10,
 304                 scpi_dmm_receive_data, (void *)sdi);
 305         if (ret != SR_OK)
 306                 return ret;
 307
 308         return SR_OK;
 309 }
 310
 311 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 312 {
 313         struct sr_scpi_dev_inst *scpi;
 314         struct dev_context *devc;
 315         const char *command;
 316
 317         scpi = sdi->conn;
 318         devc = sdi->priv;
 319
 320         command = sr_scpi_cmd_get(devc->cmdset, DMM_CMD_STOP_ACQ);
 321         if (command && *command) {
 322                 (void)sr_scpi_send(scpi, command);
 323                 scpi_dmm_cmd_delay(scpi);
 324         }
 325         sr_scpi_source_remove(sdi->session, scpi);
 326
 327         std_session_send_df_end(sdi);
 328
 329         return SR_OK;
 330 }
 331
 332 static struct sr_dev_driver scpi_dmm_driver_info = {
 333         .name = "scpi-dmm",
 334         .longname = "SCPI DMM",
 335         .api_version = 1,
 336         .init = std_init,
 337         .cleanup = std_cleanup,
 338         .scan = scan,
 339         .dev_list = std_dev_list,
 340         .dev_clear = std_dev_clear,
 341         .config_get = config_get,
 342         .config_set = config_set,
 343         .config_list = config_list,
 344         .dev_open = dev_open,
 345         .dev_close = dev_close,
 346         .dev_acquisition_start = dev_acquisition_start,
 347         .dev_acquisition_stop = dev_acquisition_stop,
 348         .context = NULL,
 349 };
 350 SR_REGISTER_DEV_DRIVER(scpi_dmm_driver_info);