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