src/hardware/agilent-dmm/api.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
   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 <config.h>
  21 #include <glib.h>
  22 #include <sys/types.h>
  23 #include <sys/stat.h>
  24 #include <fcntl.h>
  25 #include <string.h>
  26 #include <libsigrok/libsigrok.h>
  27 #include "libsigrok-internal.h"
  28 #include "protocol.h"
  29
  30 static const uint32_t scanopts[] = {
  31         SR_CONF_CONN,
  32         SR_CONF_SERIALCOMM,
  33 };
  34
  35 static const uint32_t drvopts[] = {
  36         SR_CONF_MULTIMETER,
  37 };
  38
  39 static const uint32_t devopts[] = {
  40         SR_CONF_CONTINUOUS,
  41         SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
  42         SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
  43         SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  44 };
  45
  46 static const uint64_t samplerates[] = {
  47         SR_HZ(1),
  48         SR_HZ(20),
  49         SR_HZ(1),
  50 };
  51
  52 extern const struct agdmm_job agdmm_jobs_u12xx[];
  53 extern const struct agdmm_recv agdmm_recvs_u123x[];
  54 extern const struct agdmm_recv agdmm_recvs_u124x[];
  55 extern const struct agdmm_recv agdmm_recvs_u125x[];
  56 extern const struct agdmm_recv agdmm_recvs_u128x[];
  57
  58 /* This works on all the Agilent U12xxA series, although the
  59  * U127xA can apparently also run at 19200/8n1. */
  60 #define SERIALCOMM "9600/8n1"
  61
  62 static const struct agdmm_profile supported_agdmm[] = {
  63         { AGILENT_U1231, "U1231A", 1, agdmm_jobs_u12xx, agdmm_recvs_u123x },
  64         { AGILENT_U1232, "U1232A", 1, agdmm_jobs_u12xx, agdmm_recvs_u123x },
  65         { AGILENT_U1233, "U1233A", 1, agdmm_jobs_u12xx, agdmm_recvs_u123x },
  66
  67         { AGILENT_U1241, "U1241A", 2, agdmm_jobs_u12xx, agdmm_recvs_u124x },
  68         { AGILENT_U1242, "U1242A", 2, agdmm_jobs_u12xx, agdmm_recvs_u124x },
  69         { AGILENT_U1241, "U1241B", 2, agdmm_jobs_u12xx, agdmm_recvs_u124x },
  70         { AGILENT_U1242, "U1242B", 2, agdmm_jobs_u12xx, agdmm_recvs_u124x },
  71
  72         { AGILENT_U1251, "U1251A", 3, agdmm_jobs_u12xx, agdmm_recvs_u125x },
  73         { AGILENT_U1252, "U1252A", 3, agdmm_jobs_u12xx, agdmm_recvs_u125x },
  74         { AGILENT_U1253, "U1253A", 3, agdmm_jobs_u12xx, agdmm_recvs_u125x },
  75         { AGILENT_U1251, "U1251B", 3, agdmm_jobs_u12xx, agdmm_recvs_u125x },
  76         { AGILENT_U1252, "U1252B", 3, agdmm_jobs_u12xx, agdmm_recvs_u125x },
  77         { AGILENT_U1253, "U1253B", 3, agdmm_jobs_u12xx, agdmm_recvs_u125x },
  78
  79         { KEYSIGHT_U1281, "U1281A", 3, agdmm_jobs_u12xx, agdmm_recvs_u128x },
  80         { KEYSIGHT_U1282, "U1282A", 3, agdmm_jobs_u12xx, agdmm_recvs_u128x },
  81         ALL_ZERO
  82 };
  83
  84 static GSList *scan(struct sr_dev_driver *di, GSList *options)
  85 {
  86         struct sr_dev_inst *sdi;
  87         struct dev_context *devc;
  88         struct sr_config *src;
  89         struct sr_serial_dev_inst *serial;
  90         GSList *l, *devices;
  91         int len, i;
  92         const char *conn, *serialcomm;
  93         char *buf, **tokens;
  94
  95         devices = NULL;
  96         conn = serialcomm = NULL;
  97         for (l = options; l; l = l->next) {
  98                 src = l->data;
  99                 switch (src->key) {
 100                 case SR_CONF_CONN:
 101                         conn = g_variant_get_string(src->data, NULL);
 102                         break;
 103                 case SR_CONF_SERIALCOMM:
 104                         serialcomm = g_variant_get_string(src->data, NULL);
 105                         break;
 106                 }
 107         }
 108         if (!conn)
 109                 return NULL;
 110         if (!serialcomm)
 111                 serialcomm = SERIALCOMM;
 112
 113         serial = sr_serial_dev_inst_new(conn, serialcomm);
 114
 115         if (serial_open(serial, SERIAL_RDWR) != SR_OK)
 116                 return NULL;
 117
 118         serial_flush(serial);
 119         if (serial_write_blocking(serial, "*IDN?\r\n", 7, SERIAL_WRITE_TIMEOUT_MS) < 7) {
 120                 sr_err("Unable to send identification string.");
 121                 return NULL;
 122         }
 123
 124         len = 128;
 125         buf = g_malloc(len);
 126         serial_readline(serial, &buf, &len, 250);
 127         if (!len)
 128                 return NULL;
 129
 130         tokens = g_strsplit(buf, ",", 4);
 131         if ((!strcmp("Agilent Technologies", tokens[0]) ||
 132              !strcmp("Keysight Technologies", tokens[0]))
 133                         && tokens[1] && tokens[2] && tokens[3]) {
 134                 for (i = 0; supported_agdmm[i].model; i++) {
 135                         if (strcmp(supported_agdmm[i].modelname, tokens[1]))
 136                                 continue;
 137                         sdi = g_malloc0(sizeof(struct sr_dev_inst));
 138                         sdi->status = SR_ST_INACTIVE;
 139                         sdi->vendor = g_strdup(tokens[0][0] == 'A' ? "Agilent" : "Keysight");
 140                         sdi->model = g_strdup(tokens[1]);
 141                         sdi->version = g_strdup(tokens[3]);
 142                         devc = g_malloc0(sizeof(struct dev_context));
 143                         sr_sw_limits_init(&devc->limits);
 144                         devc->profile = &supported_agdmm[i];
 145                         devc->cur_samplerate = 5;
 146                         if (supported_agdmm[i].nb_channels > 1) {
 147                                 int temp_chan = supported_agdmm[i].nb_channels - 1;
 148                                 devc->cur_mq[temp_chan] = SR_MQ_TEMPERATURE;
 149                                 devc->cur_unit[temp_chan] = SR_UNIT_CELSIUS;
 150                                 devc->cur_digits[temp_chan] = 1;
 151                                 devc->cur_encoding[temp_chan] = 2;
 152                         }
 153                         sdi->inst_type = SR_INST_SERIAL;
 154                         sdi->conn = serial;
 155                         sdi->priv = devc;
 156                         sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
 157                         if (supported_agdmm[i].nb_channels > 1)
 158                                 sr_channel_new(sdi, 1, SR_CHANNEL_ANALOG, TRUE, "P2");
 159                         if (supported_agdmm[i].nb_channels > 2)
 160                                 sr_channel_new(sdi, 2, SR_CHANNEL_ANALOG, TRUE, "P3");
 161                         devices = g_slist_append(devices, sdi);
 162                         break;
 163                 }
 164         }
 165         g_strfreev(tokens);
 166         g_free(buf);
 167
 168         serial_close(serial);
 169         if (!devices)
 170                 sr_serial_dev_inst_free(serial);
 171
 172         return std_scan_complete(di, devices);
 173 }
 174
 175 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 176                 const struct sr_channel_group *cg)
 177 {
 178         struct dev_context *devc;
 179         int ret;
 180
 181         (void)cg;
 182
 183         devc = sdi->priv;
 184
 185         ret = SR_OK;
 186         switch (key) {
 187         case SR_CONF_SAMPLERATE:
 188                 *data = g_variant_new_uint64(devc->cur_samplerate);
 189                 break;
 190         case SR_CONF_LIMIT_SAMPLES:
 191         case SR_CONF_LIMIT_MSEC:
 192                 ret = sr_sw_limits_config_get(&devc->limits, key, data);
 193                 break;
 194         default:
 195                 return SR_ERR_NA;
 196         }
 197
 198         return ret;
 199 }
 200
 201 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 202                 const struct sr_channel_group *cg)
 203 {
 204         struct dev_context *devc;
 205         uint64_t samplerate;
 206         int ret;
 207
 208         (void)cg;
 209
 210         if (sdi->status != SR_ST_ACTIVE)
 211                 return SR_ERR_DEV_CLOSED;
 212
 213         devc = sdi->priv;
 214
 215         ret = SR_OK;
 216         switch (key) {
 217         case SR_CONF_SAMPLERATE:
 218                 samplerate = g_variant_get_uint64(data);
 219                 if (samplerate < samplerates[0] || samplerate > samplerates[1])
 220                         ret = SR_ERR_ARG;
 221                 else
 222                         devc->cur_samplerate = g_variant_get_uint64(data);
 223                 break;
 224         case SR_CONF_LIMIT_SAMPLES:
 225         case SR_CONF_LIMIT_MSEC:
 226                 ret = sr_sw_limits_config_set(&devc->limits, key, data);
 227                 break;
 228         default:
 229                 ret = SR_ERR_NA;
 230         }
 231
 232         return ret;
 233 }
 234
 235 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 236                 const struct sr_channel_group *cg)
 237 {
 238         GVariant *gvar;
 239         GVariantBuilder gvb;
 240
 241         if (key == SR_CONF_SCAN_OPTIONS) {
 242                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 243                                 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 244                 return SR_OK;
 245         }
 246
 247         if (key == SR_CONF_DEVICE_OPTIONS && !sdi) {
 248                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 249                                 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
 250                 return SR_OK;
 251         }
 252
 253         if (!sdi || cg)
 254                 return SR_ERR_ARG;
 255
 256         switch (key) {
 257         case SR_CONF_DEVICE_OPTIONS:
 258                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 259                                 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 260                 break;
 261         case SR_CONF_SAMPLERATE:
 262                 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
 263                 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), samplerates,
 264                                 ARRAY_SIZE(samplerates), sizeof(uint64_t));
 265                 g_variant_builder_add(&gvb, "{sv}", "samplerate-steps", gvar);
 266                 *data = g_variant_builder_end(&gvb);
 267                 break;
 268         default:
 269                 return SR_ERR_NA;
 270         }
 271
 272         return SR_OK;
 273 }
 274
 275 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 276 {
 277         struct dev_context *devc = sdi->priv;
 278         struct sr_serial_dev_inst *serial;
 279
 280         if (sdi->status != SR_ST_ACTIVE)
 281                 return SR_ERR_DEV_CLOSED;
 282
 283         devc->cur_channel = sr_next_enabled_channel(sdi, NULL);
 284         devc->cur_conf = sr_next_enabled_channel(sdi, NULL);
 285         devc->cur_mq[0] = -1;
 286         if (devc->profile->nb_channels > 2)
 287                 devc->cur_mq[1] = -1;
 288
 289         sr_sw_limits_acquisition_start(&devc->limits);
 290         std_session_send_df_header(sdi);
 291
 292         /* Poll every 10ms, or whenever some data comes in. */
 293         serial = sdi->conn;
 294         serial_source_add(sdi->session, serial, G_IO_IN, 10,
 295                         agdmm_receive_data, (void *)sdi);
 296
 297         return SR_OK;
 298 }
 299
 300 static struct sr_dev_driver agdmm_driver_info = {
 301         .name = "agilent-dmm",
 302         .longname = "Agilent U12xx series DMMs",
 303         .api_version = 1,
 304         .init = std_init,
 305         .cleanup = std_cleanup,
 306         .scan = scan,
 307         .dev_list = std_dev_list,
 308         .dev_clear = NULL,
 309         .config_get = config_get,
 310         .config_set = config_set,
 311         .config_list = config_list,
 312         .dev_open = std_serial_dev_open,
 313         .dev_close = std_serial_dev_close,
 314         .dev_acquisition_start = dev_acquisition_start,
 315         .dev_acquisition_stop = std_serial_dev_acquisition_stop,
 316         .context = NULL,
 317 };
 318 SR_REGISTER_DEV_DRIVER(agdmm_driver_info);