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 int32_t hwopts[] = {
  31         SR_CONF_CONN,
  32         SR_CONF_SERIALCOMM,
  33 };
  34
  35 static const int32_t hwcaps[] = {
  36         SR_CONF_MULTIMETER,
  37         SR_CONF_LIMIT_SAMPLES,
  38         SR_CONF_LIMIT_MSEC,
  39         SR_CONF_CONTINUOUS,
  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 | SERIAL_NONBLOCK) != 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(serial, "ID\r", 3) == -1) {
  94                         sr_err("Unable to send ID string: %s.",
  95                                strerror(errno));
  96                         continue;
  97                 }
  98
  99                 /* Response is first a CMD_ACK byte (ASCII '0' for OK,
 100                  * or '1' to signify an error. */
 101                 len = 128;
 102                 serial_readline(serial, &b, &len, 150);
 103                 if (len != 1)
 104                         continue;
 105                 if (buf[0] != '0')
 106                         continue;
 107
 108                 /* If CMD_ACK was OK, ID string follows. */
 109                 len = 128;
 110                 serial_readline(serial, &b, &len, 850);
 111                 if (len < 10)
 112                         continue;
 113                 if (strcspn(buf, ",") < 15)
 114                         /* Looks like it's comma-separated. */
 115                         tokens = g_strsplit(buf, ",", 3);
 116                 else
 117                         /* Fluke 199B, at least, uses semicolon. */
 118                         tokens = g_strsplit(buf, ";", 3);
 119                 if (!strncmp("FLUKE", tokens[0], 5)
 120                                 && tokens[1] && tokens[2]) {
 121                         for (i = 0; supported_flukedmm[i].model; i++) {
 122                                 if (strcmp(supported_flukedmm[i].modelname, tokens[0] + 6))
 123                                         continue;
 124                                 /* Skip leading spaces in version number. */
 125                                 for (s = 0; tokens[1][s] == ' '; s++);
 126                                 if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, "Fluke",
 127                                                 tokens[0] + 6, tokens[1] + s)))
 128                                         return NULL;
 129                                 if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
 130                                         sr_err("Device context malloc failed.");
 131                                         return NULL;
 132                                 }
 133                                 devc->profile = &supported_flukedmm[i];
 134                                 sdi->inst_type = SR_INST_SERIAL;
 135                                 sdi->conn = serial;
 136                                 sdi->priv = devc;
 137                                 sdi->driver = di;
 138                                 if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "P1")))
 139                                         return NULL;
 140                                 sdi->channels = g_slist_append(sdi->channels, ch);
 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                 if (devices)
 148                         /* Found one. */
 149                         break;
 150         }
 151         serial_close(serial);
 152         if (!devices)
 153                 sr_serial_dev_inst_free(serial);
 154
 155         return devices;
 156 }
 157
 158 static GSList *scan(GSList *options)
 159 {
 160         struct sr_config *src;
 161         GSList *l, *devices;
 162         int i;
 163         const char *conn, *serialcomm;
 164
 165         conn = serialcomm = NULL;
 166         for (l = options; l; l = l->next) {
 167                 src = l->data;
 168                 switch (src->key) {
 169                 case SR_CONF_CONN:
 170                         conn = g_variant_get_string(src->data, NULL);
 171                         break;
 172                 case SR_CONF_SERIALCOMM:
 173                         serialcomm = g_variant_get_string(src->data, NULL);
 174                         break;
 175                 }
 176         }
 177         if (!conn)
 178                 return NULL;
 179
 180         if (serialcomm) {
 181                 /* Use the provided comm specs. */
 182                 devices = fluke_scan(conn, serialcomm);
 183         } else {
 184                 for (i = 0; scan_conn[i]; i++) {
 185                         if ((devices = fluke_scan(conn, scan_conn[i])))
 186                                 break;
 187                         /* The Scopemeter 199B, at least, requires this
 188                          * after all the 115k/9.6k confusion. */
 189                         g_usleep(5000);
 190                 }
 191         }
 192
 193         return devices;
 194 }
 195
 196 static GSList *dev_list(void)
 197 {
 198         return ((struct drv_context *)(di->priv))->instances;
 199 }
 200
 201 static int cleanup(void)
 202 {
 203         return std_dev_clear(di, NULL);
 204 }
 205
 206 static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi,
 207                 const struct sr_channel_group *cg)
 208 {
 209         struct dev_context *devc;
 210
 211         (void)cg;
 212
 213         if (sdi->status != SR_ST_ACTIVE)
 214                 return SR_ERR_DEV_CLOSED;
 215
 216         if (!(devc = sdi->priv)) {
 217                 sr_err("sdi->priv was NULL.");
 218                 return SR_ERR_BUG;
 219         }
 220
 221         switch (id) {
 222         case SR_CONF_LIMIT_MSEC:
 223                 /* TODO: not yet implemented */
 224                 if (g_variant_get_uint64(data) == 0) {
 225                         sr_err("LIMIT_MSEC can't be 0.");
 226                         return SR_ERR;
 227                 }
 228                 devc->limit_msec = g_variant_get_uint64(data);
 229                 sr_dbg("Setting time limit to %" PRIu64 "ms.",
 230                        devc->limit_msec);
 231                 break;
 232         case SR_CONF_LIMIT_SAMPLES:
 233                 devc->limit_samples = g_variant_get_uint64(data);
 234                 sr_dbg("Setting sample limit to %" PRIu64 ".",
 235                        devc->limit_samples);
 236                 break;
 237         default:
 238                 return SR_ERR_NA;
 239         }
 240
 241         return SR_OK;
 242 }
 243
 244 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
 245                 const struct sr_channel_group *cg)
 246 {
 247         (void)sdi;
 248         (void)cg;
 249
 250         switch (key) {
 251         case SR_CONF_SCAN_OPTIONS:
 252                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
 253                                 hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
 254                 break;
 255         case SR_CONF_DEVICE_OPTIONS:
 256                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
 257                                 hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
 258                 break;
 259         default:
 260                 return SR_ERR_NA;
 261         }
 262
 263         return SR_OK;
 264 }
 265
 266 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
 267 {
 268         struct dev_context *devc;
 269         struct sr_serial_dev_inst *serial;
 270
 271         if (sdi->status != SR_ST_ACTIVE)
 272                 return SR_ERR_DEV_CLOSED;
 273
 274         if (!(devc = sdi->priv)) {
 275                 sr_err("sdi->priv was NULL.");
 276                 return SR_ERR_BUG;
 277         }
 278
 279         devc->cb_data = cb_data;
 280
 281         /* Send header packet to the session bus. */
 282         std_session_send_df_header(cb_data, LOG_PREFIX);
 283
 284         /* Poll every 100ms, or whenever some data comes in. */
 285         serial = sdi->conn;
 286         serial_source_add(sdi->session, serial, G_IO_IN, 50,
 287                         fluke_receive_data, (void *)sdi);
 288
 289         if (serial_write(serial, "QM\r", 3) == -1) {
 290                 sr_err("Unable to send QM: %s.", strerror(errno));
 291                 return SR_ERR;
 292         }
 293         devc->cmd_sent_at = g_get_monotonic_time() / 1000;
 294         devc->expect_response = TRUE;
 295
 296         return SR_OK;
 297 }
 298
 299 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 300 {
 301         return std_serial_dev_acquisition_stop(sdi, cb_data, std_serial_dev_close,
 302                         sdi->conn, LOG_PREFIX);
 303 }
 304
 305 SR_PRIV struct sr_dev_driver flukedmm_driver_info = {
 306         .name = "fluke-dmm",
 307         .longname = "Fluke 18x/28x series DMMs",
 308         .api_version = 1,
 309         .init = init,
 310         .cleanup = cleanup,
 311         .scan = scan,
 312         .dev_list = dev_list,
 313         .dev_clear = NULL,
 314         .config_get = NULL,
 315         .config_set = config_set,
 316         .config_list = config_list,
 317         .dev_open = std_serial_dev_open,
 318         .dev_close = std_serial_dev_close,
 319         .dev_acquisition_start = dev_acquisition_start,
 320         .dev_acquisition_stop = dev_acquisition_stop,
 321         .priv = NULL,
 322 };