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 <glib.h>
  21 #include <sys/types.h>
  22 #include <sys/stat.h>
  23 #include <fcntl.h>
  24 #include <string.h>
  25 #include <errno.h>
  26 #include "libsigrok.h"
  27 #include "libsigrok-internal.h"
  28 #include "agilent-dmm.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 | SR_CONF_SET,
  41         SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
  42         SR_CONF_LIMIT_MSEC | SR_CONF_SET,
  43 };
  44
  45 extern const struct agdmm_job agdmm_jobs_u12xx[];
  46 extern const struct agdmm_recv agdmm_recvs_u123x[];
  47 extern const struct agdmm_recv agdmm_recvs_u124x[];
  48 extern const struct agdmm_recv agdmm_recvs_u125x[];
  49
  50 /* This works on all the Agilent U12xxA series, although the
  51  * U127xA can apparently also run at 19200/8n1. */
  52 #define SERIALCOMM "9600/8n1"
  53
  54 static const struct agdmm_profile supported_agdmm[] = {
  55         { AGILENT_U1231, "U1231A", agdmm_jobs_u12xx, agdmm_recvs_u123x },
  56         { AGILENT_U1232, "U1232A", agdmm_jobs_u12xx, agdmm_recvs_u123x },
  57         { AGILENT_U1233, "U1233A", agdmm_jobs_u12xx, agdmm_recvs_u123x },
  58
  59         { AGILENT_U1241, "U1241A", agdmm_jobs_u12xx, agdmm_recvs_u124x },
  60         { AGILENT_U1242, "U1242A", agdmm_jobs_u12xx, agdmm_recvs_u124x },
  61         { AGILENT_U1241, "U1241B", agdmm_jobs_u12xx, agdmm_recvs_u124x },
  62         { AGILENT_U1242, "U1242B", agdmm_jobs_u12xx, agdmm_recvs_u124x },
  63
  64         { AGILENT_U1251, "U1251A", agdmm_jobs_u12xx, agdmm_recvs_u125x },
  65         { AGILENT_U1252, "U1252A", agdmm_jobs_u12xx, agdmm_recvs_u125x },
  66         { AGILENT_U1253, "U1253A", agdmm_jobs_u12xx, agdmm_recvs_u125x },
  67         { AGILENT_U1251, "U1251B", agdmm_jobs_u12xx, agdmm_recvs_u125x },
  68         { AGILENT_U1252, "U1252B", agdmm_jobs_u12xx, agdmm_recvs_u125x },
  69         { AGILENT_U1253, "U1253B", agdmm_jobs_u12xx, agdmm_recvs_u125x },
  70         ALL_ZERO
  71 };
  72
  73 SR_PRIV struct sr_dev_driver agdmm_driver_info;
  74 static struct sr_dev_driver *di = &agdmm_driver_info;
  75
  76 static int init(struct sr_context *sr_ctx)
  77 {
  78         return std_init(sr_ctx, di, LOG_PREFIX);
  79 }
  80
  81 static GSList *scan(GSList *options)
  82 {
  83         struct sr_dev_inst *sdi;
  84         struct drv_context *drvc;
  85         struct dev_context *devc;
  86         struct sr_config *src;
  87         struct sr_channel *ch;
  88         struct sr_serial_dev_inst *serial;
  89         GSList *l, *devices;
  90         int len, i;
  91         const char *conn, *serialcomm;
  92         char *buf, **tokens;
  93
  94         drvc = di->priv;
  95         drvc->instances = NULL;
  96
  97         devices = NULL;
  98         conn = serialcomm = NULL;
  99         for (l = options; l; l = l->next) {
 100                 src = l->data;
 101                 switch (src->key) {
 102                 case SR_CONF_CONN:
 103                         conn = g_variant_get_string(src->data, NULL);
 104                         break;
 105                 case SR_CONF_SERIALCOMM:
 106                         serialcomm = g_variant_get_string(src->data, NULL);
 107                         break;
 108                 }
 109         }
 110         if (!conn)
 111                 return NULL;
 112         if (!serialcomm)
 113                 serialcomm = SERIALCOMM;
 114
 115         serial = sr_serial_dev_inst_new(conn, serialcomm);
 116
 117         if (serial_open(serial, SERIAL_RDWR) != SR_OK)
 118                 return NULL;
 119
 120         serial_flush(serial);
 121         if (serial_write_blocking(serial, "*IDN?\r\n", 7, SERIAL_WRITE_TIMEOUT_MS) < 7) {
 122                 sr_err("Unable to send identification string.");
 123                 return NULL;
 124         }
 125
 126         len = 128;
 127         if (!(buf = g_try_malloc(len))) {
 128                 sr_err("Serial buffer malloc failed.");
 129                 return NULL;
 130         }
 131         serial_readline(serial, &buf, &len, 250);
 132         if (!len)
 133                 return NULL;
 134
 135         tokens = g_strsplit(buf, ",", 4);
 136         if (!strcmp("Agilent Technologies", tokens[0])
 137                         && tokens[1] && tokens[2] && tokens[3]) {
 138                 for (i = 0; supported_agdmm[i].model; i++) {
 139                         if (strcmp(supported_agdmm[i].modelname, tokens[1]))
 140                                 continue;
 141                         sdi = g_malloc0(sizeof(struct sr_dev_inst));
 142                         sdi->status = SR_ST_INACTIVE;
 143                         sdi->vendor = g_strdup("Agilent");
 144                         sdi->model = g_strdup(tokens[1]);
 145                         sdi->version = g_strdup(tokens[3]);
 146                         devc = g_malloc0(sizeof(struct dev_context));
 147                         devc->profile = &supported_agdmm[i];
 148                         devc->cur_mq = -1;
 149                         sdi->inst_type = SR_INST_SERIAL;
 150                         sdi->conn = serial;
 151                         sdi->priv = devc;
 152                         sdi->driver = di;
 153                         ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "P1");
 154                         sdi->channels = g_slist_append(sdi->channels, ch);
 155                         drvc->instances = g_slist_append(drvc->instances, sdi);
 156                         devices = g_slist_append(devices, sdi);
 157                         break;
 158                 }
 159         }
 160         g_strfreev(tokens);
 161         g_free(buf);
 162
 163         serial_close(serial);
 164         if (!devices)
 165                 sr_serial_dev_inst_free(serial);
 166
 167         return devices;
 168 }
 169
 170 static GSList *dev_list(void)
 171 {
 172         return ((struct drv_context *)(di->priv))->instances;
 173 }
 174
 175 static int cleanup(void)
 176 {
 177         return std_dev_clear(di, NULL);
 178 }
 179
 180 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 181                 const struct sr_channel_group *cg)
 182 {
 183         struct dev_context *devc;
 184
 185         (void)cg;
 186
 187         if (sdi->status != SR_ST_ACTIVE)
 188                 return SR_ERR_DEV_CLOSED;
 189
 190         if (!(devc = sdi->priv)) {
 191                 sr_err("sdi->priv was NULL.");
 192                 return SR_ERR_BUG;
 193         }
 194
 195         switch (key) {
 196         case SR_CONF_LIMIT_MSEC:
 197                 /* TODO: not yet implemented */
 198                 if (g_variant_get_uint64(data) == 0) {
 199                         sr_err("LIMIT_MSEC can't be 0.");
 200                         return SR_ERR;
 201                 }
 202                 devc->limit_msec = g_variant_get_uint64(data);
 203                 sr_dbg("Setting time limit to %" PRIu64 "ms.",
 204                        devc->limit_msec);
 205                 break;
 206         case SR_CONF_LIMIT_SAMPLES:
 207                 devc->limit_samples = g_variant_get_uint64(data);
 208                 sr_dbg("Setting sample limit to %" PRIu64 ".",
 209                        devc->limit_samples);
 210                 break;
 211         default:
 212                 return SR_ERR_NA;
 213         }
 214
 215         return SR_OK;
 216 }
 217
 218 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 219                 const struct sr_channel_group *cg)
 220 {
 221         (void)sdi;
 222         (void)cg;
 223
 224         switch (key) {
 225         case SR_CONF_SCAN_OPTIONS:
 226                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 227                                 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 228                 break;
 229         case SR_CONF_DEVICE_OPTIONS:
 230                 if (!sdi)
 231                         *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 232                                         drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
 233                 else
 234                         *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 235                                         devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 236                 break;
 237         default:
 238                 return SR_ERR_NA;
 239         }
 240
 241         return SR_OK;
 242 }
 243
 244 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
 245 {
 246         struct dev_context *devc;
 247         struct sr_serial_dev_inst *serial;
 248
 249         if (sdi->status != SR_ST_ACTIVE)
 250                 return SR_ERR_DEV_CLOSED;
 251
 252         if (!(devc = sdi->priv)) {
 253                 sr_err("sdi->priv was NULL.");
 254                 return SR_ERR_BUG;
 255         }
 256
 257         devc->cb_data = cb_data;
 258
 259         /* Send header packet to the session bus. */
 260         std_session_send_df_header(cb_data, LOG_PREFIX);
 261
 262         /* Poll every 100ms, or whenever some data comes in. */
 263         serial = sdi->conn;
 264         serial_source_add(sdi->session, serial, G_IO_IN, 100,
 265                         agdmm_receive_data, (void *)sdi);
 266
 267         return SR_OK;
 268 }
 269
 270 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 271 {
 272         return std_serial_dev_acquisition_stop(sdi, cb_data, std_serial_dev_close,
 273                         sdi->conn, LOG_PREFIX);
 274 }
 275
 276 SR_PRIV struct sr_dev_driver agdmm_driver_info = {
 277         .name = "agilent-dmm",
 278         .longname = "Agilent U12xx series DMMs",
 279         .api_version = 1,
 280         .init = init,
 281         .cleanup = cleanup,
 282         .scan = scan,
 283         .dev_list = dev_list,
 284         .dev_clear = NULL,
 285         .config_get = NULL,
 286         .config_set = config_set,
 287         .config_list = config_list,
 288         .dev_open = std_serial_dev_open,
 289         .dev_close = std_serial_dev_close,
 290         .dev_acquisition_start = dev_acquisition_start,
 291         .dev_acquisition_stop = dev_acquisition_stop,
 292         .priv = NULL,
 293 };