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