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 "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,
  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
  75 static GSList *scan(struct sr_dev_driver *di, GSList *options)
  76 {
  77         struct sr_dev_inst *sdi;
  78         struct drv_context *drvc;
  79         struct dev_context *devc;
  80         struct sr_config *src;
  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->context;
  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         serial = sr_serial_dev_inst_new(conn, serialcomm);
 109
 110         if (serial_open(serial, SERIAL_RDWR) != SR_OK)
 111                 return NULL;
 112
 113         serial_flush(serial);
 114         if (serial_write_blocking(serial, "*IDN?\r\n", 7, SERIAL_WRITE_TIMEOUT_MS) < 7) {
 115                 sr_err("Unable to send identification string.");
 116                 return NULL;
 117         }
 118
 119         len = 128;
 120         buf = g_malloc(len);
 121         serial_readline(serial, &buf, &len, 250);
 122         if (!len)
 123                 return NULL;
 124
 125         tokens = g_strsplit(buf, ",", 4);
 126         if (!strcmp("Agilent Technologies", tokens[0])
 127                         && tokens[1] && tokens[2] && tokens[3]) {
 128                 for (i = 0; supported_agdmm[i].model; i++) {
 129                         if (strcmp(supported_agdmm[i].modelname, tokens[1]))
 130                                 continue;
 131                         sdi = g_malloc0(sizeof(struct sr_dev_inst));
 132                         sdi->status = SR_ST_INACTIVE;
 133                         sdi->vendor = g_strdup("Agilent");
 134                         sdi->model = g_strdup(tokens[1]);
 135                         sdi->version = g_strdup(tokens[3]);
 136                         devc = g_malloc0(sizeof(struct dev_context));
 137                         devc->profile = &supported_agdmm[i];
 138                         devc->cur_mq = -1;
 139                         sdi->inst_type = SR_INST_SERIAL;
 140                         sdi->conn = serial;
 141                         sdi->priv = devc;
 142                         sdi->driver = di;
 143                         sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
 144                         drvc->instances = g_slist_append(drvc->instances, sdi);
 145                         devices = g_slist_append(devices, sdi);
 146                         break;
 147                 }
 148         }
 149         g_strfreev(tokens);
 150         g_free(buf);
 151
 152         serial_close(serial);
 153         if (!devices)
 154                 sr_serial_dev_inst_free(serial);
 155
 156         return devices;
 157 }
 158
 159 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 160                 const struct sr_channel_group *cg)
 161 {
 162         struct dev_context *devc;
 163
 164         (void)cg;
 165
 166         if (sdi->status != SR_ST_ACTIVE)
 167                 return SR_ERR_DEV_CLOSED;
 168
 169         if (!(devc = sdi->priv)) {
 170                 sr_err("sdi->priv was NULL.");
 171                 return SR_ERR_BUG;
 172         }
 173
 174         switch (key) {
 175         case SR_CONF_LIMIT_MSEC:
 176                 /* TODO: not yet implemented */
 177                 devc->limit_msec = g_variant_get_uint64(data);
 178                 break;
 179         case SR_CONF_LIMIT_SAMPLES:
 180                 devc->limit_samples = g_variant_get_uint64(data);
 181                 break;
 182         default:
 183                 return SR_ERR_NA;
 184         }
 185
 186         return SR_OK;
 187 }
 188
 189 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 190                 const struct sr_channel_group *cg)
 191 {
 192         (void)cg;
 193
 194         switch (key) {
 195         case SR_CONF_SCAN_OPTIONS:
 196                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 197                                 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 198                 break;
 199         case SR_CONF_DEVICE_OPTIONS:
 200                 if (!sdi)
 201                         *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 202                                         drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
 203                 else
 204                         *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 205                                         devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 206                 break;
 207         default:
 208                 return SR_ERR_NA;
 209         }
 210
 211         return SR_OK;
 212 }
 213
 214 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 215 {
 216         struct sr_serial_dev_inst *serial;
 217
 218         if (sdi->status != SR_ST_ACTIVE)
 219                 return SR_ERR_DEV_CLOSED;
 220
 221         std_session_send_df_header(sdi, LOG_PREFIX);
 222
 223         /* Poll every 100ms, or whenever some data comes in. */
 224         serial = sdi->conn;
 225         serial_source_add(sdi->session, serial, G_IO_IN, 100,
 226                         agdmm_receive_data, (void *)sdi);
 227
 228         return SR_OK;
 229 }
 230
 231 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 232 {
 233         return std_serial_dev_acquisition_stop(sdi, std_serial_dev_close,
 234                         sdi->conn, LOG_PREFIX);
 235 }
 236
 237 SR_PRIV struct sr_dev_driver agdmm_driver_info = {
 238         .name = "agilent-dmm",
 239         .longname = "Agilent U12xx series DMMs",
 240         .api_version = 1,
 241         .init = std_init,
 242         .cleanup = std_cleanup,
 243         .scan = scan,
 244         .dev_list = std_dev_list,
 245         .dev_clear = NULL,
 246         .config_get = NULL,
 247         .config_set = config_set,
 248         .config_list = config_list,
 249         .dev_open = std_serial_dev_open,
 250         .dev_close = std_serial_dev_close,
 251         .dev_acquisition_start = dev_acquisition_start,
 252         .dev_acquisition_stop = dev_acquisition_stop,
 253         .context = NULL,
 254 };