hardware/serial-dmm/api.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
   5  * Copyright (C) 2012 Alexandru Gagniuc <mr.nuke.me@gmail.com>
   6  * Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.de>
   7  *
   8  * This program is free software: you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation, either version 3 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20  */
  21
  22 #include <sys/types.h>
  23 #include <sys/stat.h>
  24 #include <fcntl.h>
  25 #include <string.h>
  26 #include <errno.h>
  27 #include <glib.h>
  28 #include "libsigrok.h"
  29 #include "libsigrok-internal.h"
  30 #include "protocol.h"
  31
  32 static const int32_t hwopts[] = {
  33         SR_CONF_CONN,
  34         SR_CONF_SERIALCOMM,
  35 };
  36
  37 static const int32_t hwcaps[] = {
  38         SR_CONF_MULTIMETER,
  39         SR_CONF_LIMIT_SAMPLES,
  40         SR_CONF_LIMIT_MSEC,
  41         SR_CONF_CONTINUOUS,
  42 };
  43
  44 SR_PRIV struct sr_dev_driver digitek_dt4000zc_driver_info;
  45 SR_PRIV struct sr_dev_driver tekpower_tp4000zc_driver_info;
  46 SR_PRIV struct sr_dev_driver metex_me31_driver_info;
  47 SR_PRIV struct sr_dev_driver peaktech_3410_driver_info;
  48 SR_PRIV struct sr_dev_driver mastech_mas345_driver_info;
  49 SR_PRIV struct sr_dev_driver va_va18b_driver_info;
  50 SR_PRIV struct sr_dev_driver metex_m3640d_driver_info;
  51 SR_PRIV struct sr_dev_driver peaktech_4370_driver_info;
  52 SR_PRIV struct sr_dev_driver pce_pce_dm32_driver_info;
  53 SR_PRIV struct sr_dev_driver radioshack_22_168_driver_info;
  54 SR_PRIV struct sr_dev_driver radioshack_22_805_driver_info;
  55 SR_PRIV struct sr_dev_driver radioshack_22_812_driver_info;
  56 SR_PRIV struct sr_dev_driver tecpel_dmm_8061_ser_driver_info;
  57 SR_PRIV struct sr_dev_driver voltcraft_vc820_ser_driver_info;
  58 SR_PRIV struct sr_dev_driver voltcraft_vc840_ser_driver_info;
  59 SR_PRIV struct sr_dev_driver uni_t_ut61d_ser_driver_info;
  60 SR_PRIV struct sr_dev_driver uni_t_ut61e_ser_driver_info;
  61
  62 SR_PRIV struct dmm_info dmms[] = {
  63         {
  64                 "Digitek", "DT4000ZC", "2400/8n1", 2400,
  65                 FS9721_PACKET_SIZE, NULL,
  66                 sr_fs9721_packet_valid, sr_fs9721_parse,
  67                 sr_fs9721_10_temp_c,
  68                 &digitek_dt4000zc_driver_info, receive_data_DIGITEK_DT4000ZC,
  69         },
  70         {
  71                 "TekPower", "TP4000ZC", "2400/8n1", 2400,
  72                 FS9721_PACKET_SIZE, NULL,
  73                 sr_fs9721_packet_valid, sr_fs9721_parse,
  74                 sr_fs9721_10_temp_c,
  75                 &tekpower_tp4000zc_driver_info, receive_data_TEKPOWER_TP4000ZC,
  76         },
  77         {
  78                 "Metex", "ME-31", "600/7n2/rts=0/dtr=1", 600,
  79                 METEX14_PACKET_SIZE, sr_metex14_packet_request,
  80                 sr_metex14_packet_valid, sr_metex14_parse,
  81                 NULL,
  82                 &metex_me31_driver_info, receive_data_METEX_ME31,
  83         },
  84         {
  85                 "Peaktech", "3410", "600/7n2/rts=0/dtr=1", 600,
  86                 METEX14_PACKET_SIZE, sr_metex14_packet_request,
  87                 sr_metex14_packet_valid, sr_metex14_parse,
  88                 NULL,
  89                 &peaktech_3410_driver_info, receive_data_PEAKTECH_3410,
  90         },
  91         {
  92                 "MASTECH", "MAS345", "600/7n2/rts=0/dtr=1", 600,
  93                 METEX14_PACKET_SIZE, sr_metex14_packet_request,
  94                 sr_metex14_packet_valid, sr_metex14_parse,
  95                 NULL,
  96                 &mastech_mas345_driver_info, receive_data_MASTECH_MAS345,
  97         },
  98         {
  99                 "V&A", "VA18B", "2400/8n1", 2400,
 100                 FS9721_PACKET_SIZE, NULL,
 101                 sr_fs9721_packet_valid, sr_fs9721_parse,
 102                 sr_fs9721_01_temp_c,
 103                 &va_va18b_driver_info, receive_data_VA_VA18B,
 104         },
 105         {
 106                 "Metex", "M-3640D", "1200/7n2/rts=0/dtr=1", 1200,
 107                 METEX14_PACKET_SIZE, sr_metex14_packet_request,
 108                 sr_metex14_packet_valid, sr_metex14_parse,
 109                 NULL,
 110                 &metex_m3640d_driver_info, receive_data_METEX_M3640D,
 111         },
 112         {
 113                 "PeakTech", "4370", "1200/7n2/rts=0/dtr=1", 1200,
 114                 METEX14_PACKET_SIZE, sr_metex14_packet_request,
 115                 sr_metex14_packet_valid, sr_metex14_parse,
 116                 NULL,
 117                 &peaktech_4370_driver_info, receive_data_PEAKTECH_4370,
 118         },
 119         {
 120                 "PCE", "PCE-DM32", "2400/8n1", 2400,
 121                 FS9721_PACKET_SIZE, NULL,
 122                 sr_fs9721_packet_valid, sr_fs9721_parse,
 123                 sr_fs9721_01_10_temp_f_c,
 124                 &pce_pce_dm32_driver_info, receive_data_PCE_PCE_DM32,
 125         },
 126         {
 127                 "RadioShack", "22-168", "1200/7n2/rts=0/dtr=1", 1200,
 128                 METEX14_PACKET_SIZE, sr_metex14_packet_request,
 129                 sr_metex14_packet_valid, sr_metex14_parse,
 130                 NULL,
 131                 &radioshack_22_168_driver_info, receive_data_RADIOSHACK_22_168,
 132         },
 133         {
 134                 "RadioShack", "22-805", "600/7n2/rts=0/dtr=1", 600,
 135                 METEX14_PACKET_SIZE, sr_metex14_packet_request,
 136                 sr_metex14_packet_valid, sr_metex14_parse,
 137                 NULL,
 138                 &radioshack_22_805_driver_info, receive_data_RADIOSHACK_22_805,
 139         },
 140         {
 141                 "RadioShack", "22-812", "4800/8n1/rts=0/dtr=1", 4800,
 142                 RS9LCD_PACKET_SIZE, NULL,
 143                 sr_rs9lcd_packet_valid, sr_rs9lcd_parse,
 144                 NULL,
 145                 &radioshack_22_812_driver_info, receive_data_RADIOSHACK_22_812,
 146         },
 147         {
 148                 "Tecpel", "DMM-8061 (UT-D02 cable)", "2400/8n1/rts=0/dtr=1",
 149                 2400, FS9721_PACKET_SIZE, NULL,
 150                 sr_fs9721_packet_valid, sr_fs9721_parse,
 151                 sr_fs9721_00_temp_c,
 152                 &tecpel_dmm_8061_ser_driver_info,
 153                 receive_data_TECPEL_DMM_8061_SER,
 154         },
 155         {
 156                 "Voltcraft", "VC-820 (UT-D02 cable)", "2400/8n1/rts=0/dtr=1",
 157                 2400, FS9721_PACKET_SIZE, NULL,
 158                 sr_fs9721_packet_valid, sr_fs9721_parse,
 159                 NULL,
 160                 &voltcraft_vc820_ser_driver_info,
 161                 receive_data_VOLTCRAFT_VC820_SER,
 162         },
 163         {
 164                 "Voltcraft", "VC-840 (UT-D02 cable)", "2400/8n1/rts=0/dtr=1",
 165                 2400, FS9721_PACKET_SIZE, NULL,
 166                 sr_fs9721_packet_valid, sr_fs9721_parse,
 167                 sr_fs9721_00_temp_c,
 168                 &voltcraft_vc840_ser_driver_info,
 169                 receive_data_VOLTCRAFT_VC840_SER,
 170         },
 171         {
 172                 "UNI-T", "UT61D (UT-D02 cable)", "2400/8n1/rts=0/dtr=1",
 173                 2400, FS9922_PACKET_SIZE, NULL,
 174                 sr_fs9922_packet_valid, sr_fs9922_parse, NULL,
 175                 &uni_t_ut61d_ser_driver_info, receive_data_UNI_T_UT61D_SER,
 176         },
 177         {
 178                 /* Note: ES51922 baudrate is actually 19230! */
 179                 "UNI-T", "UT61E (UT-D02 cable)", "19200/7o1/rts=0/dtr=1",
 180                 19200, ES51922_PACKET_SIZE, NULL,
 181                 sr_es51922_packet_valid, sr_es51922_parse, NULL,
 182                 &uni_t_ut61e_ser_driver_info, receive_data_UNI_T_UT61E_SER,
 183         },
 184 };
 185
 186 /* Properly close and free all devices. */
 187 static int clear_instances(int dmm)
 188 {
 189         struct sr_dev_inst *sdi;
 190         struct drv_context *drvc;
 191         struct dev_context *devc;
 192         struct sr_serial_dev_inst *serial;
 193         GSList *l;
 194         struct sr_dev_driver *di;
 195
 196         di = dmms[dmm].di;
 197
 198         if (!(drvc = di->priv))
 199                 return SR_OK;
 200
 201         drvc = di->priv;
 202         for (l = drvc->instances; l; l = l->next) {
 203                 if (!(sdi = l->data))
 204                         continue;
 205                 if (!(devc = sdi->priv))
 206                         continue;
 207                 serial = sdi->conn;
 208                 sr_serial_dev_inst_free(serial);
 209                 sr_dev_inst_free(sdi);
 210         }
 211         g_slist_free(drvc->instances);
 212         drvc->instances = NULL;
 213
 214         return SR_OK;
 215 }
 216
 217 static int hw_init(struct sr_context *sr_ctx, int dmm)
 218 {
 219         sr_dbg("Selected '%s' subdriver.", dmms[dmm].di->name);
 220
 221         return std_hw_init(sr_ctx, dmms[dmm].di, DRIVER_LOG_DOMAIN);
 222 }
 223
 224 static GSList *scan(const char *conn, const char *serialcomm, int dmm)
 225 {
 226         struct sr_dev_inst *sdi;
 227         struct drv_context *drvc;
 228         struct dev_context *devc;
 229         struct sr_probe *probe;
 230         struct sr_serial_dev_inst *serial;
 231         GSList *devices;
 232         int dropped, ret;
 233         size_t len;
 234         uint8_t buf[128];
 235
 236         if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
 237                 return NULL;
 238
 239         if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
 240                 return NULL;
 241
 242         sr_info("Probing serial port %s.", conn);
 243
 244         drvc = dmms[dmm].di->priv;
 245         devices = NULL;
 246         serial_flush(serial);
 247
 248         /* Request a packet if the DMM requires this. */
 249         if (dmms[dmm].packet_request) {
 250                 if ((ret = dmms[dmm].packet_request(serial)) < 0) {
 251                         sr_err("Failed to request packet: %d.", ret);
 252                         return FALSE;
 253                 }
 254         }
 255
 256         /*
 257          * There's no way to get an ID from the multimeter. It just sends data
 258          * periodically (or upon request), so the best we can do is check if
 259          * the packets match the expected format.
 260          */
 261
 262         /* Let's get a bit of data and see if we can find a packet. */
 263         len = sizeof(buf);
 264         ret = serial_stream_detect(serial, buf, &len, dmms[dmm].packet_size,
 265                                    dmms[dmm].packet_valid, 1000,
 266                                    dmms[dmm].baudrate);
 267         if (ret != SR_OK)
 268                 goto scan_cleanup;
 269
 270         /*
 271          * If we dropped more than two packets worth of data, something is
 272          * wrong. We shouldn't quit however, since the dropped bytes might be
 273          * just zeroes at the beginning of the stream. Those can occur as a
 274          * combination of the nonstandard cable that ships with some devices
 275          * and the serial port or USB to serial adapter.
 276          */
 277         dropped = len - dmms[dmm].packet_size;
 278         if (dropped > 2 * dmms[dmm].packet_size)
 279                 sr_warn("Had to drop too much data.");
 280
 281         sr_info("Found device on port %s.", conn);
 282
 283         if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, dmms[dmm].vendor,
 284                                     dmms[dmm].device, "")))
 285                 goto scan_cleanup;
 286
 287         if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
 288                 sr_err("Device context malloc failed.");
 289                 goto scan_cleanup;
 290         }
 291
 292         sdi->inst_type = SR_INST_SERIAL;
 293         sdi->conn = serial;
 294
 295         sdi->priv = devc;
 296         sdi->driver = dmms[dmm].di;
 297         if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
 298                 goto scan_cleanup;
 299         sdi->probes = g_slist_append(sdi->probes, probe);
 300         drvc->instances = g_slist_append(drvc->instances, sdi);
 301         devices = g_slist_append(devices, sdi);
 302
 303 scan_cleanup:
 304         serial_close(serial);
 305
 306         return devices;
 307 }
 308
 309 static GSList *hw_scan(GSList *options, int dmm)
 310 {
 311         struct sr_config *src;
 312         GSList *l, *devices;
 313         const char *conn, *serialcomm;
 314
 315         conn = serialcomm = NULL;
 316         for (l = options; l; l = l->next) {
 317                 src = l->data;
 318                 switch (src->key) {
 319                 case SR_CONF_CONN:
 320                         conn = g_variant_get_string(src->data, NULL);
 321                         break;
 322                 case SR_CONF_SERIALCOMM:
 323                         serialcomm = g_variant_get_string(src->data, NULL);
 324                         break;
 325                 }
 326         }
 327         if (!conn)
 328                 return NULL;
 329
 330         if (serialcomm) {
 331                 /* Use the provided comm specs. */
 332                 devices = scan(conn, serialcomm, dmm);
 333         } else {
 334                 /* Try the default. */
 335                 devices = scan(conn, dmms[dmm].conn, dmm);
 336         }
 337
 338         return devices;
 339 }
 340
 341 static GSList *hw_dev_list(int dmm)
 342 {
 343         return ((struct drv_context *)(dmms[dmm].di->priv))->instances;
 344 }
 345
 346 static int hw_dev_open(struct sr_dev_inst *sdi)
 347 {
 348         struct sr_serial_dev_inst *serial;
 349
 350         serial = sdi->conn;
 351         if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
 352                 return SR_ERR;
 353
 354         sdi->status = SR_ST_ACTIVE;
 355
 356         return SR_OK;
 357 }
 358
 359 static int hw_dev_close(struct sr_dev_inst *sdi)
 360 {
 361         struct sr_serial_dev_inst *serial;
 362
 363         serial = sdi->conn;
 364         if (serial && serial->fd != -1) {
 365                 serial_close(serial);
 366                 sdi->status = SR_ST_INACTIVE;
 367         }
 368
 369         return SR_OK;
 370 }
 371
 372 static int hw_cleanup(int dmm)
 373 {
 374         clear_instances(dmm);
 375
 376         return SR_OK;
 377 }
 378
 379 static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi)
 380 {
 381         struct dev_context *devc;
 382
 383         if (sdi->status != SR_ST_ACTIVE)
 384                 return SR_ERR_DEV_CLOSED;
 385
 386         if (!(devc = sdi->priv)) {
 387                 sr_err("sdi->priv was NULL.");
 388                 return SR_ERR_BUG;
 389         }
 390
 391         switch (id) {
 392         case SR_CONF_LIMIT_SAMPLES:
 393                 devc->limit_samples = g_variant_get_uint64(data);
 394                 sr_dbg("Setting sample limit to %" PRIu64 ".",
 395                        devc->limit_samples);
 396                 break;
 397         case SR_CONF_LIMIT_MSEC:
 398                 devc->limit_msec = g_variant_get_uint64(data);
 399                 sr_dbg("Setting time limit to %" PRIu64 "ms.",
 400                        devc->limit_msec);
 401                 break;
 402         default:
 403                 return SR_ERR_NA;
 404         }
 405
 406         return SR_OK;
 407 }
 408
 409 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi)
 410 {
 411
 412         (void)sdi;
 413
 414         switch (key) {
 415         case SR_CONF_SCAN_OPTIONS:
 416                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
 417                                 hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
 418                 break;
 419         case SR_CONF_DEVICE_OPTIONS:
 420                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
 421                                 hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
 422                 break;
 423         default:
 424                 return SR_ERR_NA;
 425         }
 426
 427         return SR_OK;
 428 }
 429
 430 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
 431                                     void *cb_data, int dmm)
 432 {
 433         struct dev_context *devc;
 434         struct sr_serial_dev_inst *serial;
 435
 436         if (sdi->status != SR_ST_ACTIVE)
 437                 return SR_ERR_DEV_CLOSED;
 438
 439         if (!(devc = sdi->priv)) {
 440                 sr_err("sdi->priv was NULL.");
 441                 return SR_ERR_BUG;
 442         }
 443
 444         devc->cb_data = cb_data;
 445
 446         /*
 447          * Reset the number of samples to take. If we've already collected our
 448          * quota, but we start a new session, and don't reset this, we'll just
 449          * quit without acquiring any new samples.
 450          */
 451         devc->num_samples = 0;
 452         devc->starttime = g_get_monotonic_time();
 453
 454         /* Send header packet to the session bus. */
 455         std_session_send_df_header(cb_data, DRIVER_LOG_DOMAIN);
 456
 457         /* Poll every 50ms, or whenever some data comes in. */
 458         serial = sdi->conn;
 459         sr_source_add(serial->fd, G_IO_IN, 50,
 460                       dmms[dmm].receive_data, (void *)sdi);
 461
 462         return SR_OK;
 463 }
 464
 465 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 466 {
 467         return std_hw_dev_acquisition_stop_serial(sdi, cb_data, hw_dev_close,
 468                                                   sdi->conn, DRIVER_LOG_DOMAIN);
 469 }
 470
 471 /* Driver-specific API function wrappers */
 472 #define HW_INIT(X) \
 473 static int hw_init_##X(struct sr_context *sr_ctx) { return hw_init(sr_ctx, X); }
 474 #define HW_CLEANUP(X) \
 475 static int hw_cleanup_##X(void) { return hw_cleanup(X); }
 476 #define HW_SCAN(X) \
 477 static GSList *hw_scan_##X(GSList *options) { return hw_scan(options, X); }
 478 #define HW_DEV_LIST(X) \
 479 static GSList *hw_dev_list_##X(void) { return hw_dev_list(X); }
 480 #define CLEAR_INSTANCES(X) \
 481 static int clear_instances_##X(void) { return clear_instances(X); }
 482 #define HW_DEV_ACQUISITION_START(X) \
 483 static int hw_dev_acquisition_start_##X(const struct sr_dev_inst *sdi, \
 484 void *cb_data) { return hw_dev_acquisition_start(sdi, cb_data, X); }
 485
 486 /* Driver structs and API function wrappers */
 487 #define DRV(ID, ID_UPPER, NAME, LONGNAME) \
 488 HW_INIT(ID_UPPER) \
 489 HW_CLEANUP(ID_UPPER) \
 490 HW_SCAN(ID_UPPER) \
 491 HW_DEV_LIST(ID_UPPER) \
 492 CLEAR_INSTANCES(ID_UPPER) \
 493 HW_DEV_ACQUISITION_START(ID_UPPER) \
 494 SR_PRIV struct sr_dev_driver ID##_driver_info = { \
 495         .name = NAME, \
 496         .longname = LONGNAME, \
 497         .api_version = 1, \
 498         .init = hw_init_##ID_UPPER, \
 499         .cleanup = hw_cleanup_##ID_UPPER, \
 500         .scan = hw_scan_##ID_UPPER, \
 501         .dev_list = hw_dev_list_##ID_UPPER, \
 502         .dev_clear = clear_instances_##ID_UPPER, \
 503         .config_get = NULL, \
 504         .config_set = config_set, \
 505         .config_list = config_list, \
 506         .dev_open = hw_dev_open, \
 507         .dev_close = hw_dev_close, \
 508         .dev_acquisition_start = hw_dev_acquisition_start_##ID_UPPER, \
 509         .dev_acquisition_stop = hw_dev_acquisition_stop, \
 510         .priv = NULL, \
 511 };
 512
 513 DRV(digitek_dt4000zc, DIGITEK_DT4000ZC, "digitek-dt4000zc", "Digitek DT4000ZC")
 514 DRV(tekpower_tp4000zc, TEKPOWER_TP4000ZC, "tekpower-tp4000zc", "TekPower TP4000ZC")
 515 DRV(metex_me31, METEX_ME31, "metex-me31", "Metex ME-31")
 516 DRV(peaktech_3410, PEAKTECH_3410, "peaktech-3410", "PeakTech 3410")
 517 DRV(mastech_mas345, MASTECH_MAS345, "mastech-mas345", "MASTECH MAS345")
 518 DRV(va_va18b, VA_VA18B, "va-va18b", "V&A VA18B")
 519 DRV(metex_m3640d, METEX_M3640D, "metex-m3640d", "Metex M-3640D")
 520 DRV(peaktech_4370, PEAKTECH_4370, "peaktech-4370", "PeakTech 4370")
 521 DRV(pce_pce_dm32, PCE_PCE_DM32, "pce-pce-dm32", "PCE PCE-DM32")
 522 DRV(radioshack_22_168, RADIOSHACK_22_168, "radioshack-22-168", "RadioShack 22-168")
 523 DRV(radioshack_22_805, RADIOSHACK_22_805, "radioshack-22-805", "RadioShack 22-805")
 524 DRV(radioshack_22_812, RADIOSHACK_22_812, "radioshack-22-812", "RadioShack 22-812")
 525 DRV(tecpel_dmm_8061_ser, TECPEL_DMM_8061_SER, "tecpel-dmm-8061-ser", "Tecpel DMM-8061 (UT-D02 cable)")
 526 DRV(voltcraft_vc820_ser, VOLTCRAFT_VC820_SER, "voltcraft-vc820-ser", "Voltcraft VC-820 (UT-D02 cable)")
 527 DRV(voltcraft_vc840_ser, VOLTCRAFT_VC840_SER, "voltcraft-vc840-ser", "Voltcraft VC-840 (UT-D02 cable)")
 528 DRV(uni_t_ut61d_ser, UNI_T_UT61D_SER, "uni-t-ut61d-ser", "UNI-T UT61D (UT-D02 cable)")
 529 DRV(uni_t_ut61e_ser, UNI_T_UT61E_SER, "uni-t-ut61e-ser", "UNI-T UT61E (UT-D02 cable)")