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 "protocol.h"
  29
  30 static const uint32_t scanopts[] = {
  31         SR_CONF_CONN,
  32         SR_CONF_SERIALCOMM,
  33 };
  34
  35 static const uint32_t drvopts[] = {
  36         SR_CONF_MULTIMETER,
  37 };
  38
  39 static const uint32_t devopts[] = {
  40         SR_CONF_CONTINUOUS,
  41         SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
  42         SR_CONF_LIMIT_MSEC | SR_CONF_SET,
  43 };
  44
  45 static const char *scan_conn[] = {
  46         /* 287/289 */
  47         "115200/8n1",
  48         /* 87/89/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_87, "87", 100, 1000 },
  57         { FLUKE_89, "89", 100, 1000 },
  58         { FLUKE_187, "187", 100, 1000 },
  59         { FLUKE_189, "189", 100, 1000 },
  60         { FLUKE_190, "199B", 1000, 3500 },
  61         { FLUKE_287, "287", 100, 1000 },
  62         { FLUKE_289, "289", 100, 1000 },
  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 dev_context *devc;
  70         struct sr_serial_dev_inst *serial;
  71         GSList *devices;
  72         int retry, len, i, s;
  73         char buf[128], *b, **tokens;
  74
  75         serial = sr_serial_dev_inst_new(conn, serialcomm);
  76
  77         if (serial_open(serial, SERIAL_RDWR) != SR_OK)
  78                 return NULL;
  79
  80         b = buf;
  81         retry = 0;
  82         devices = NULL;
  83         /* We'll try the discovery sequence three times in case the device
  84          * is not in an idle state when we send ID. */
  85         while (!devices && retry < 3) {
  86                 retry++;
  87                 serial_flush(serial);
  88                 if (serial_write_blocking(serial, "ID\r", 3, SERIAL_WRITE_TIMEOUT_MS) < 0) {
  89                         sr_err("Unable to send ID string");
  90                         continue;
  91                 }
  92
  93                 /* Response is first a CMD_ACK byte (ASCII '0' for OK,
  94                  * or '1' to signify an error. */
  95                 len = sizeof(buf);
  96                 serial_readline(serial, &b, &len, 150);
  97                 if (len != 1)
  98                         continue;
  99                 if (buf[0] != '0')
 100                         continue;
 101
 102                 /* If CMD_ACK was OK, ID string follows. */
 103                 len = sizeof(buf);
 104                 serial_readline(serial, &b, &len, 850);
 105                 if (len < 10)
 106                         continue;
 107                 if (strcspn(buf, ",") < 15)
 108                         /* Looks like it's comma-separated. */
 109                         tokens = g_strsplit(buf, ",", 3);
 110                 else
 111                         /* Fluke 199B, at least, uses semicolon. */
 112                         tokens = g_strsplit(buf, ";", 3);
 113                 if (!strncmp("FLUKE", tokens[0], 5)
 114                                 && tokens[1] && tokens[2]) {
 115                         for (i = 0; supported_flukedmm[i].model; i++) {
 116                                 if (strcmp(supported_flukedmm[i].modelname, tokens[0] + 6))
 117                                         continue;
 118                                 /* Skip leading spaces in version number. */
 119                                 for (s = 0; tokens[1][s] == ' '; s++);
 120                                 sdi = g_malloc0(sizeof(struct sr_dev_inst));
 121                                 sdi->status = SR_ST_INACTIVE;
 122                                 sdi->vendor = g_strdup("Fluke");
 123                                 sdi->model = g_strdup(tokens[0] + 6);
 124                                 sdi->version = g_strdup(tokens[1] + s);
 125                                 devc = g_malloc0(sizeof(struct dev_context));
 126                                 sr_sw_limits_init(&devc->limits);
 127                                 devc->profile = &supported_flukedmm[i];
 128                                 sdi->inst_type = SR_INST_SERIAL;
 129                                 sdi->conn = serial;
 130                                 sdi->priv = devc;
 131                                 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
 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 std_scan_complete(di, 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,
 188         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 189 {
 190         struct dev_context *devc;
 191
 192         (void)cg;
 193
 194         devc = sdi->priv;
 195
 196         return sr_sw_limits_config_set(&devc->limits, key, data);
 197 }
 198
 199 static int config_list(uint32_t key, GVariant **data,
 200         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 201 {
 202         return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
 203 }
 204
 205 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 206 {
 207         struct dev_context *devc;
 208         struct sr_serial_dev_inst *serial;
 209
 210         devc = sdi->priv;
 211
 212         sr_sw_limits_acquisition_start(&devc->limits);
 213         std_session_send_df_header(sdi);
 214
 215         serial = sdi->conn;
 216         serial_source_add(sdi->session, serial, G_IO_IN, 50,
 217                         fluke_receive_data, (void *)sdi);
 218
 219         if (serial_write_blocking(serial, "QM\r", 3, SERIAL_WRITE_TIMEOUT_MS) < 0) {
 220                 sr_err("Unable to send QM.");
 221                 return SR_ERR;
 222         }
 223         devc->cmd_sent_at = g_get_monotonic_time() / 1000;
 224         devc->expect_response = TRUE;
 225
 226         return SR_OK;
 227 }
 228
 229 static struct sr_dev_driver flukedmm_driver_info = {
 230         .name = "fluke-dmm",
 231         .longname = "Fluke 8x/18x/28x series DMMs",
 232         .api_version = 1,
 233         .init = std_init,
 234         .cleanup = std_cleanup,
 235         .scan = scan,
 236         .dev_list = std_dev_list,
 237         .dev_clear = std_dev_clear,
 238         .config_get = NULL,
 239         .config_set = config_set,
 240         .config_list = config_list,
 241         .dev_open = std_serial_dev_open,
 242         .dev_close = std_serial_dev_close,
 243         .dev_acquisition_start = dev_acquisition_start,
 244         .dev_acquisition_stop = std_serial_dev_acquisition_stop,
 245         .context = NULL,
 246 };
 247 SR_REGISTER_DEV_DRIVER(flukedmm_driver_info);