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