src/hardware/fluke-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 "fluke-dmm.h"
  29
  30 static const uint32_t scanopts[] = {
  31         SR_CONF_CONN,
  32         SR_CONF_SERIALCOMM,
  33 };
  34
  35 static const uint32_t devopts[] = {
  36         SR_CONF_MULTIMETER,
  37         SR_CONF_CONTINUOUS,
  38         SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
  39         SR_CONF_LIMIT_MSEC | SR_CONF_SET,
  40 };
  41
  42 SR_PRIV struct sr_dev_driver flukedmm_driver_info;
  43
  44 static const char *scan_conn[] = {
  45         /* 287/289 */
  46         "115200/8n1",
  47         /* 187/189 */
  48         "9600/8n1",
  49         /* Scopemeter 190 series */
  50         "1200/8n1",
  51         NULL
  52 };
  53
  54 static const struct flukedmm_profile supported_flukedmm[] = {
  55         { FLUKE_187, "187", 100, 1000 },
  56         { FLUKE_189, "189", 100, 1000 },
  57         { FLUKE_287, "287", 100, 1000 },
  58         { FLUKE_190, "199B", 1000, 3500 },
  59 };
  60
  61 static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
  62 {
  63         return std_init(sr_ctx, di, LOG_PREFIX);
  64 }
  65
  66 static GSList *fluke_scan(struct sr_dev_driver *di, const char *conn,
  67                 const char *serialcomm)
  68 {
  69         struct sr_dev_inst *sdi;
  70         struct drv_context *drvc;
  71         struct dev_context *devc;
  72         struct sr_serial_dev_inst *serial;
  73         GSList *devices;
  74         int retry, len, i, s;
  75         char buf[128], *b, **tokens;
  76
  77         serial = sr_serial_dev_inst_new(conn, serialcomm);
  78
  79         if (serial_open(serial, SERIAL_RDWR) != SR_OK)
  80                 return NULL;
  81
  82         drvc = di->context;
  83         b = buf;
  84         retry = 0;
  85         devices = NULL;
  86         /* We'll try the discovery sequence three times in case the device
  87          * is not in an idle state when we send ID. */
  88         while (!devices && retry < 3) {
  89                 retry++;
  90                 serial_flush(serial);
  91                 if (serial_write_blocking(serial, "ID\r", 3, SERIAL_WRITE_TIMEOUT_MS) < 0) {
  92                         sr_err("Unable to send ID string");
  93                         continue;
  94                 }
  95
  96                 /* Response is first a CMD_ACK byte (ASCII '0' for OK,
  97                  * or '1' to signify an error. */
  98                 len = 128;
  99                 serial_readline(serial, &b, &len, 150);
 100                 if (len != 1)
 101                         continue;
 102                 if (buf[0] != '0')
 103                         continue;
 104
 105                 /* If CMD_ACK was OK, ID string follows. */
 106                 len = 128;
 107                 serial_readline(serial, &b, &len, 850);
 108                 if (len < 10)
 109                         continue;
 110                 if (strcspn(buf, ",") < 15)
 111                         /* Looks like it's comma-separated. */
 112                         tokens = g_strsplit(buf, ",", 3);
 113                 else
 114                         /* Fluke 199B, at least, uses semicolon. */
 115                         tokens = g_strsplit(buf, ";", 3);
 116                 if (!strncmp("FLUKE", tokens[0], 5)
 117                                 && tokens[1] && tokens[2]) {
 118                         for (i = 0; supported_flukedmm[i].model; i++) {
 119                                 if (strcmp(supported_flukedmm[i].modelname, tokens[0] + 6))
 120                                         continue;
 121                                 /* Skip leading spaces in version number. */
 122                                 for (s = 0; tokens[1][s] == ' '; s++);
 123                                 sdi = g_malloc0(sizeof(struct sr_dev_inst));
 124                                 sdi->status = SR_ST_INACTIVE;
 125                                 sdi->vendor = g_strdup("Fluke");
 126                                 sdi->model = g_strdup(tokens[0] + 6);
 127                                 sdi->version = g_strdup(tokens[1] + s);
 128                                 devc = g_malloc0(sizeof(struct dev_context));
 129                                 devc->profile = &supported_flukedmm[i];
 130                                 sdi->inst_type = SR_INST_SERIAL;
 131                                 sdi->conn = serial;
 132                                 sdi->priv = devc;
 133                                 sdi->driver = di;
 134                                 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
 135                                 drvc->instances = g_slist_append(drvc->instances, sdi);
 136                                 devices = g_slist_append(devices, sdi);
 137                                 break;
 138                         }
 139                 }
 140                 g_strfreev(tokens);
 141                 if (devices)
 142                         /* Found one. */
 143                         break;
 144         }
 145         serial_close(serial);
 146         if (!devices)
 147                 sr_serial_dev_inst_free(serial);
 148
 149         return devices;
 150 }
 151
 152 static GSList *scan(struct sr_dev_driver *di, GSList *options)
 153 {
 154         struct sr_config *src;
 155         GSList *l, *devices;
 156         int i;
 157         const char *conn, *serialcomm;
 158
 159         conn = serialcomm = NULL;
 160         for (l = options; l; l = l->next) {
 161                 src = l->data;
 162                 switch (src->key) {
 163                 case SR_CONF_CONN:
 164                         conn = g_variant_get_string(src->data, NULL);
 165                         break;
 166                 case SR_CONF_SERIALCOMM:
 167                         serialcomm = g_variant_get_string(src->data, NULL);
 168                         break;
 169                 }
 170         }
 171         if (!conn)
 172                 return NULL;
 173
 174         devices = NULL;
 175         if (serialcomm) {
 176                 /* Use the provided comm specs. */
 177                 devices = fluke_scan(di, conn, serialcomm);
 178         } else {
 179                 for (i = 0; scan_conn[i]; i++) {
 180                         if ((devices = fluke_scan(di, conn, scan_conn[i])))
 181                                 break;
 182                         /* The Scopemeter 199B, at least, requires this
 183                          * after all the 115k/9.6k confusion. */
 184                         g_usleep(5 * 1000);
 185                 }
 186         }
 187
 188         return devices;
 189 }
 190
 191 static GSList *dev_list(const struct sr_dev_driver *di)
 192 {
 193         return ((struct drv_context *)(di->context))->instances;
 194 }
 195
 196 static int cleanup(const struct sr_dev_driver *di)
 197 {
 198         return std_dev_clear(di, NULL);
 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
 206         (void)cg;
 207
 208         if (sdi->status != SR_ST_ACTIVE)
 209                 return SR_ERR_DEV_CLOSED;
 210
 211         if (!(devc = sdi->priv)) {
 212                 sr_err("sdi->priv was NULL.");
 213                 return SR_ERR_BUG;
 214         }
 215
 216         switch (key) {
 217         case SR_CONF_LIMIT_MSEC:
 218                 /* TODO: not yet implemented */
 219                 devc->limit_msec = g_variant_get_uint64(data);
 220                 break;
 221         case SR_CONF_LIMIT_SAMPLES:
 222                 devc->limit_samples = g_variant_get_uint64(data);
 223                 break;
 224         default:
 225                 return SR_ERR_NA;
 226         }
 227
 228         return SR_OK;
 229 }
 230
 231 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 232                 const struct sr_channel_group *cg)
 233 {
 234         (void)sdi;
 235         (void)cg;
 236
 237         switch (key) {
 238         case SR_CONF_SCAN_OPTIONS:
 239                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 240                                 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 241                 break;
 242         case SR_CONF_DEVICE_OPTIONS:
 243                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 244                                 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 245                 break;
 246         default:
 247                 return SR_ERR_NA;
 248         }
 249
 250         return SR_OK;
 251 }
 252
 253 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
 254 {
 255         struct dev_context *devc;
 256         struct sr_serial_dev_inst *serial;
 257
 258         if (sdi->status != SR_ST_ACTIVE)
 259                 return SR_ERR_DEV_CLOSED;
 260
 261         if (!(devc = sdi->priv)) {
 262                 sr_err("sdi->priv was NULL.");
 263                 return SR_ERR_BUG;
 264         }
 265
 266         devc->cb_data = cb_data;
 267
 268         /* Send header packet to the session bus. */
 269         std_session_send_df_header(cb_data, LOG_PREFIX);
 270
 271         /* Poll every 100ms, or whenever some data comes in. */
 272         serial = sdi->conn;
 273         serial_source_add(sdi->session, serial, G_IO_IN, 50,
 274                         fluke_receive_data, (void *)sdi);
 275
 276         if (serial_write_blocking(serial, "QM\r", 3, SERIAL_WRITE_TIMEOUT_MS) < 0) {
 277                 sr_err("Unable to send QM.");
 278                 return SR_ERR;
 279         }
 280         devc->cmd_sent_at = g_get_monotonic_time() / 1000;
 281         devc->expect_response = TRUE;
 282
 283         return SR_OK;
 284 }
 285
 286 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 287 {
 288         return std_serial_dev_acquisition_stop(sdi, cb_data, std_serial_dev_close,
 289                         sdi->conn, LOG_PREFIX);
 290 }
 291
 292 SR_PRIV struct sr_dev_driver flukedmm_driver_info = {
 293         .name = "fluke-dmm",
 294         .longname = "Fluke 18x/28x series DMMs",
 295         .api_version = 1,
 296         .init = init,
 297         .cleanup = cleanup,
 298         .scan = scan,
 299         .dev_list = dev_list,
 300         .dev_clear = NULL,
 301         .config_get = NULL,
 302         .config_set = config_set,
 303         .config_list = config_list,
 304         .dev_open = std_serial_dev_open,
 305         .dev_close = std_serial_dev_close,
 306         .dev_acquisition_start = dev_acquisition_start,
 307         .dev_acquisition_stop = dev_acquisition_stop,
 308         .context = NULL,
 309 };