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