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