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