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