hardware/fluke-dmm/api.c

   1 /*
   2  * This file is part of the sigrok 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_287, "287", 100, 1000 },
  58         { FLUKE_190, "199B", 1000, 3500 },
  59 };
  60
  61
  62 /* Properly close and free all devices. */
  63 static int clear_instances(void)
  64 {
  65         struct sr_dev_inst *sdi;
  66         struct drv_context *drvc;
  67         struct dev_context *devc;
  68         GSList *l;
  69
  70         if (!(drvc = di->priv))
  71                 return SR_OK;
  72
  73         drvc = di->priv;
  74         for (l = drvc->instances; l; l = l->next) {
  75                 if (!(sdi = l->data))
  76                         continue;
  77                 if (!(devc = sdi->priv))
  78                         continue;
  79                 sr_serial_dev_inst_free(devc->serial);
  80                 sr_dev_inst_free(sdi);
  81         }
  82         g_slist_free(drvc->instances);
  83         drvc->instances = NULL;
  84
  85         return SR_OK;
  86 }
  87
  88 static int hw_init(struct sr_context *sr_ctx)
  89 {
  90         return std_hw_init(sr_ctx, di, DRIVER_LOG_DOMAIN);
  91 }
  92
  93 static GSList *fluke_scan(const char *conn, const char *serialcomm)
  94 {
  95         struct sr_dev_inst *sdi;
  96         struct drv_context *drvc;
  97         struct dev_context *devc;
  98         struct sr_probe *probe;
  99         struct sr_serial_dev_inst *serial;
 100         GSList *devices;
 101         int retry, len, i, s;
 102         char buf[128], *b, **tokens;
 103
 104         if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
 105                 return NULL;
 106
 107         if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
 108                 return NULL;
 109
 110         drvc = di->priv;
 111         b = buf;
 112         retry = 0;
 113         devices = NULL;
 114         /* We'll try the discovery sequence three times in case the device
 115          * is not in an idle state when we send ID. */
 116         while (!devices && retry < 3) {
 117                 retry++;
 118                 serial_flush(serial);
 119                 if (serial_write(serial, "ID\r", 3) == -1) {
 120                         sr_err("Unable to send ID string: %s.",
 121                                strerror(errno));
 122                         continue;
 123                 }
 124
 125                 /* Response is first a CMD_ACK byte (ASCII '0' for OK,
 126                  * or '1' to signify an error. */
 127                 len = 128;
 128                 serial_readline(serial, &b, &len, 150);
 129                 if (len != 1)
 130                         continue;
 131                 if (buf[0] != '0')
 132                         continue;
 133
 134                 /* If CMD_ACK was OK, ID string follows. */
 135                 len = 128;
 136                 serial_readline(serial, &b, &len, 850);
 137                 if (len < 10)
 138                         continue;
 139                 if (strcspn(buf, ",") < 15)
 140                         /* Looks like it's comma-separated. */
 141                         tokens = g_strsplit(buf, ",", 3);
 142                 else
 143                         /* Fluke 199B, at least, uses semicolon. */
 144                         tokens = g_strsplit(buf, ";", 3);
 145                 if (!strncmp("FLUKE", tokens[0], 5)
 146                                 && tokens[1] && tokens[2]) {
 147                         for (i = 0; supported_flukedmm[i].model; i++) {
 148                                 if (strcmp(supported_flukedmm[i].modelname, tokens[0] + 6))
 149                                         continue;
 150                                 /* Skip leading spaces in version number. */
 151                                 for (s = 0; tokens[1][s] == ' '; s++);
 152                                 if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, "Fluke",
 153                                                 tokens[0] + 6, tokens[1] + s)))
 154                                         return NULL;
 155                                 if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
 156                                         sr_err("Device context malloc failed.");
 157                                         return NULL;
 158                                 }
 159                                 devc->profile = &supported_flukedmm[i];
 160                                 devc->serial = serial;
 161                                 sdi->priv = devc;
 162                                 sdi->driver = di;
 163                                 if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
 164                                         return NULL;
 165                                 sdi->probes = g_slist_append(sdi->probes, probe);
 166                                 drvc->instances = g_slist_append(drvc->instances, sdi);
 167                                 devices = g_slist_append(devices, sdi);
 168                                 break;
 169                         }
 170                 }
 171                 g_strfreev(tokens);
 172                 if (devices)
 173                         /* Found one. */
 174                         break;
 175         }
 176         serial_close(serial);
 177         if (!devices)
 178                 sr_serial_dev_inst_free(serial);
 179
 180         return devices;
 181 }
 182
 183 static GSList *hw_scan(GSList *options)
 184 {
 185         struct sr_config *src;
 186         GSList *l, *devices;
 187         int i;
 188         const char *conn, *serialcomm;
 189
 190         conn = serialcomm = NULL;
 191         for (l = options; l; l = l->next) {
 192                 src = l->data;
 193                 switch (src->key) {
 194                 case SR_CONF_CONN:
 195                         conn = g_variant_get_string(src->data, NULL);
 196                         break;
 197                 case SR_CONF_SERIALCOMM:
 198                         serialcomm = g_variant_get_string(src->data, NULL);
 199                         break;
 200                 }
 201         }
 202         if (!conn)
 203                 return NULL;
 204
 205         if (serialcomm) {
 206                 /* Use the provided comm specs. */
 207                 devices = fluke_scan(conn, serialcomm);
 208         } else {
 209                 for (i = 0; scan_conn[i]; i++) {
 210                         if ((devices = fluke_scan(conn, scan_conn[i])))
 211                                 break;
 212                         /* The Scopemeter 199B, at least, requires this
 213                          * after all the 115k/9.6k confusion. */
 214                         g_usleep(5000);
 215                 }
 216         }
 217
 218         return devices;
 219 }
 220
 221 static GSList *hw_dev_list(void)
 222 {
 223         return ((struct drv_context *)(di->priv))->instances;
 224 }
 225
 226 static int hw_dev_open(struct sr_dev_inst *sdi)
 227 {
 228         struct dev_context *devc;
 229
 230         if (!(devc = sdi->priv)) {
 231                 sr_err("sdi->priv was NULL.");
 232                 return SR_ERR_BUG;
 233         }
 234
 235         if (serial_open(devc->serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
 236                 return SR_ERR;
 237
 238         sdi->status = SR_ST_ACTIVE;
 239
 240         return SR_OK;
 241 }
 242
 243 static int hw_dev_close(struct sr_dev_inst *sdi)
 244 {
 245         struct dev_context *devc;
 246
 247         devc = sdi->priv;
 248
 249         if (devc->serial && devc->serial->fd != -1) {
 250                 serial_close(devc->serial);
 251                 sdi->status = SR_ST_INACTIVE;
 252         }
 253
 254         return SR_OK;
 255 }
 256
 257 static int hw_cleanup(void)
 258 {
 259
 260         clear_instances();
 261
 262         return SR_OK;
 263 }
 264
 265 static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi)
 266 {
 267         struct dev_context *devc;
 268
 269         if (sdi->status != SR_ST_ACTIVE)
 270                 return SR_ERR;
 271
 272         if (!(devc = sdi->priv)) {
 273                 sr_err("sdi->priv was NULL.");
 274                 return SR_ERR_BUG;
 275         }
 276
 277         switch (id) {
 278         case SR_CONF_LIMIT_MSEC:
 279                 /* TODO: not yet implemented */
 280                 if (g_variant_get_uint64(data) == 0) {
 281                         sr_err("LIMIT_MSEC can't be 0.");
 282                         return SR_ERR;
 283                 }
 284                 devc->limit_msec = g_variant_get_uint64(data);
 285                 sr_dbg("Setting time limit to %" PRIu64 "ms.",
 286                        devc->limit_msec);
 287                 break;
 288         case SR_CONF_LIMIT_SAMPLES:
 289                 devc->limit_samples = g_variant_get_uint64(data);
 290                 sr_dbg("Setting sample limit to %" PRIu64 ".",
 291                        devc->limit_samples);
 292                 break;
 293         default:
 294                 return SR_ERR_NA;
 295         }
 296
 297         return SR_OK;
 298 }
 299
 300 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi)
 301 {
 302
 303         (void)sdi;
 304
 305         switch (key) {
 306         case SR_CONF_SCAN_OPTIONS:
 307                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
 308                                 hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
 309                 break;
 310         case SR_CONF_DEVICE_OPTIONS:
 311                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
 312                                 hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
 313                 break;
 314         default:
 315                 return SR_ERR_NA;
 316         }
 317
 318         return SR_OK;
 319 }
 320
 321 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
 322                 void *cb_data)
 323 {
 324         struct dev_context *devc;
 325
 326         if (!(devc = sdi->priv)) {
 327                 sr_err("sdi->priv was NULL.");
 328                 return SR_ERR_BUG;
 329         }
 330
 331         devc->cb_data = cb_data;
 332
 333         /* Send header packet to the session bus. */
 334         std_session_send_df_header(cb_data, DRIVER_LOG_DOMAIN);
 335
 336         /* Poll every 100ms, or whenever some data comes in. */
 337         sr_source_add(devc->serial->fd, G_IO_IN, 50, fluke_receive_data, (void *)sdi);
 338
 339         if (serial_write(devc->serial, "QM\r", 3) == -1) {
 340                 sr_err("Unable to send QM: %s.", strerror(errno));
 341                 return SR_ERR;
 342         }
 343         devc->cmd_sent_at = g_get_monotonic_time() / 1000;
 344         devc->expect_response = TRUE;
 345
 346         return SR_OK;
 347 }
 348
 349 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 350 {
 351         return std_hw_dev_acquisition_stop_serial(sdi, cb_data, hw_dev_close,
 352                ((struct dev_context *)(sdi->priv))->serial, DRIVER_LOG_DOMAIN);
 353 }
 354
 355 SR_PRIV struct sr_dev_driver flukedmm_driver_info = {
 356         .name = "fluke-dmm",
 357         .longname = "Fluke 18x/28x series DMMs",
 358         .api_version = 1,
 359         .init = hw_init,
 360         .cleanup = hw_cleanup,
 361         .scan = hw_scan,
 362         .dev_list = hw_dev_list,
 363         .dev_clear = clear_instances,
 364         .config_get = NULL,
 365         .config_set = config_set,
 366         .config_list = config_list,
 367         .dev_open = hw_dev_open,
 368         .dev_close = hw_dev_close,
 369         .dev_acquisition_start = hw_dev_acquisition_start,
 370         .dev_acquisition_stop = hw_dev_acquisition_stop,
 371         .priv = NULL,
 372 };