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