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