hardware/serial-dmm/api.c

   1 /*
   2  * This file is part of the sigrok 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 int hwopts[] = {
  33         SR_HWOPT_CONN,
  34         SR_HWOPT_SERIALCOMM,
  35         0,
  36 };
  37
  38 static const int hwcaps[] = {
  39         SR_HWCAP_MULTIMETER,
  40         SR_HWCAP_LIMIT_SAMPLES,
  41         SR_HWCAP_LIMIT_MSEC,
  42         SR_HWCAP_CONTINUOUS,
  43         0,
  44 };
  45
  46 static const char *probe_names[] = {
  47         "Probe",
  48         NULL,
  49 };
  50
  51 SR_PRIV struct sr_dev_driver digitek_dt4000zc_driver_info;
  52 SR_PRIV struct sr_dev_driver tekpower_tp4000zc_driver_info;
  53 SR_PRIV struct sr_dev_driver metex_me31_driver_info;
  54 SR_PRIV struct sr_dev_driver peaktech_3410_driver_info;
  55 SR_PRIV struct sr_dev_driver mastech_mas345_driver_info;
  56 SR_PRIV struct sr_dev_driver va_va18b_driver_info;
  57 SR_PRIV struct sr_dev_driver metex_m3640d_driver_info;
  58 SR_PRIV struct sr_dev_driver peaktech_4370_driver_info;
  59 SR_PRIV struct sr_dev_driver pce_pce_dm32_driver_info;
  60 SR_PRIV struct sr_dev_driver radioshack_22_168_driver_info;
  61 SR_PRIV struct sr_dev_driver radioshack_22_812_driver_info;
  62 SR_PRIV struct sr_dev_driver voltcraft_vc820_ser_driver_info;
  63 SR_PRIV struct sr_dev_driver voltcraft_vc840_ser_driver_info;
  64
  65 SR_PRIV struct dmm_info dmms[] = {
  66         {
  67                 "Digitek", "DT4000ZC", "2400/8n1", 2400,
  68                 FS9721_PACKET_SIZE, NULL,
  69                 sr_fs9721_packet_valid, sr_fs9721_parse,
  70                 dmm_details_dt4000zc,
  71                 &digitek_dt4000zc_driver_info, receive_data_DIGITEK_DT4000ZC,
  72         },
  73         {
  74                 "TekPower", "TP4000ZC", "2400/8n1", 2400,
  75                 FS9721_PACKET_SIZE, NULL,
  76                 sr_fs9721_packet_valid, sr_fs9721_parse,
  77                 dmm_details_tp4000zc,
  78                 &tekpower_tp4000zc_driver_info, receive_data_TEKPOWER_TP4000ZC,
  79         },
  80         {
  81                 "Metex", "ME-31", "600/7n2/rts=0/dtr=1", 600,
  82                 METEX14_PACKET_SIZE, sr_metex14_packet_request,
  83                 sr_metex14_packet_valid, sr_metex14_parse,
  84                 NULL,
  85                 &metex_me31_driver_info, receive_data_METEX_ME31,
  86         },
  87         {
  88                 "Peaktech", "3410", "600/7n2/rts=0/dtr=1", 600,
  89                 METEX14_PACKET_SIZE, sr_metex14_packet_request,
  90                 sr_metex14_packet_valid, sr_metex14_parse,
  91                 NULL,
  92                 &peaktech_3410_driver_info, receive_data_PEAKTECH_3410,
  93         },
  94         {
  95                 "MASTECH", "MAS345", "600/7n2/rts=0/dtr=1", 600,
  96                 METEX14_PACKET_SIZE, sr_metex14_packet_request,
  97                 sr_metex14_packet_valid, sr_metex14_parse,
  98                 NULL,
  99                 &mastech_mas345_driver_info, receive_data_MASTECH_MAS345,
 100         },
 101         {
 102                 "V&A", "VA18B", "2400/8n1", 2400,
 103                 FS9721_PACKET_SIZE, NULL,
 104                 sr_fs9721_packet_valid, sr_fs9721_parse,
 105                 dmm_details_va18b,
 106                 &va_va18b_driver_info, receive_data_VA_VA18B,
 107         },
 108         {
 109                 "Metex", "M-3640D", "1200/7n2/rts=0/dtr=1", 1200,
 110                 METEX14_PACKET_SIZE, sr_metex14_packet_request,
 111                 sr_metex14_packet_valid, sr_metex14_parse,
 112                 NULL,
 113                 &metex_m3640d_driver_info, receive_data_METEX_M3640D,
 114         },
 115         {
 116                 "PeakTech", "4370", "1200/7n2/rts=0/dtr=1", 1200,
 117                 METEX14_PACKET_SIZE, sr_metex14_packet_request,
 118                 sr_metex14_packet_valid, sr_metex14_parse,
 119                 NULL,
 120                 &peaktech_4370_driver_info, receive_data_PEAKTECH_4370,
 121         },
 122         {
 123                 "PCE", "PCE-DM32", "2400/8n1", 2400,
 124                 FS9721_PACKET_SIZE, NULL,
 125                 sr_fs9721_packet_valid, sr_fs9721_parse,
 126                 dmm_details_pce_dm32,
 127                 &pce_pce_dm32_driver_info, receive_data_PCE_PCE_DM32,
 128         },
 129         {
 130                 "RadioShack", "22-168", "1200/7n2/rts=0/dtr=1", 1200,
 131                 METEX14_PACKET_SIZE, sr_metex14_packet_request,
 132                 sr_metex14_packet_valid, sr_metex14_parse,
 133                 NULL,
 134                 &radioshack_22_168_driver_info, receive_data_RADIOSHACK_22_168,
 135         },
 136         {
 137                 "RadioShack", "22-812", "4800/8n1/rts=0/dtr=1", 4800,
 138                 RS9LCD_PACKET_SIZE, NULL,
 139                 sr_rs9lcd_packet_valid, sr_rs9lcd_parse,
 140                 NULL,
 141                 &radioshack_22_812_driver_info, receive_data_RADIOSHACK_22_812,
 142         },
 143         {
 144                 "Voltcraft", "VC-820 (UT-D02 cable)", "2400/8n1/rts=0/dtr=1",
 145                 2400, FS9721_PACKET_SIZE, NULL,
 146                 sr_fs9721_packet_valid, sr_fs9721_parse,
 147                 NULL,
 148                 &voltcraft_vc820_ser_driver_info,
 149                 receive_data_VOLTCRAFT_VC820_SER,
 150         },
 151         {
 152                 "Voltcraft", "VC-840 (UT-D02 cable)", "2400/8n1/rts=0/dtr=1",
 153                 2400, FS9721_PACKET_SIZE, NULL,
 154                 sr_fs9721_packet_valid, sr_fs9721_parse,
 155                 NULL,
 156                 &voltcraft_vc840_ser_driver_info,
 157                 receive_data_VOLTCRAFT_VC840_SER,
 158         },
 159 };
 160
 161 /* Properly close and free all devices. */
 162 static int clear_instances(int dmm)
 163 {
 164         struct sr_dev_inst *sdi;
 165         struct drv_context *drvc;
 166         struct dev_context *devc;
 167         GSList *l;
 168         struct sr_dev_driver *di;
 169
 170         di = dmms[dmm].di;
 171
 172         if (!(drvc = di->priv))
 173                 return SR_OK;
 174
 175         drvc = di->priv;
 176         for (l = drvc->instances; l; l = l->next) {
 177                 if (!(sdi = l->data))
 178                         continue;
 179                 if (!(devc = sdi->priv))
 180                         continue;
 181                 sr_serial_dev_inst_free(devc->serial);
 182                 sr_dev_inst_free(sdi);
 183         }
 184         g_slist_free(drvc->instances);
 185         drvc->instances = NULL;
 186
 187         return SR_OK;
 188 }
 189
 190 static int hw_init(struct sr_context *sr_ctx, int dmm)
 191 {
 192         struct drv_context *drvc;
 193
 194         if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
 195                 sr_err("Driver context malloc failed.");
 196                 return SR_ERR_MALLOC;
 197         }
 198
 199         sr_dbg("Selected '%s' subdriver.", dmms[dmm].di->name);
 200
 201         drvc->sr_ctx = sr_ctx;
 202         dmms[dmm].di->priv = drvc;
 203
 204         return SR_OK;
 205 }
 206
 207 static GSList *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         devc->serial = serial;
 276
 277         sdi->priv = devc;
 278         sdi->driver = dmms[dmm].di;
 279         if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
 280                 goto scan_cleanup;
 281         sdi->probes = g_slist_append(sdi->probes, probe);
 282         drvc->instances = g_slist_append(drvc->instances, sdi);
 283         devices = g_slist_append(devices, sdi);
 284
 285 scan_cleanup:
 286         serial_close(serial);
 287
 288         return devices;
 289 }
 290
 291 static GSList *hw_scan(GSList *options, int dmm)
 292 {
 293         struct sr_hwopt *opt;
 294         GSList *l, *devices;
 295         const char *conn, *serialcomm;
 296
 297         conn = serialcomm = NULL;
 298         for (l = options; l; l = l->next) {
 299                 opt = l->data;
 300                 switch (opt->hwopt) {
 301                 case SR_HWOPT_CONN:
 302                         conn = opt->value;
 303                         break;
 304                 case SR_HWOPT_SERIALCOMM:
 305                         serialcomm = opt->value;
 306                         break;
 307                 }
 308         }
 309         if (!conn)
 310                 return NULL;
 311
 312         if (serialcomm) {
 313                 /* Use the provided comm specs. */
 314                 devices = scan(conn, serialcomm, dmm);
 315         } else {
 316                 /* Try the default. */
 317                 devices = scan(conn, dmms[dmm].conn, dmm);
 318         }
 319
 320         return devices;
 321 }
 322
 323 static GSList *hw_dev_list(int dmm)
 324 {
 325         struct drv_context *drvc;
 326
 327         drvc = dmms[dmm].di->priv;
 328
 329         return drvc->instances;
 330 }
 331
 332 static int hw_dev_open(struct sr_dev_inst *sdi)
 333 {
 334         struct dev_context *devc;
 335
 336         if (!(devc = sdi->priv)) {
 337                 sr_err("sdi->priv was NULL.");
 338                 return SR_ERR_BUG;
 339         }
 340
 341         if (serial_open(devc->serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
 342                 return SR_ERR;
 343
 344         sdi->status = SR_ST_ACTIVE;
 345
 346         return SR_OK;
 347 }
 348
 349 static int hw_dev_close(struct sr_dev_inst *sdi)
 350 {
 351         struct dev_context *devc;
 352
 353         if (!(devc = sdi->priv)) {
 354                 sr_err("sdi->priv was NULL.");
 355                 return SR_ERR_BUG;
 356         }
 357
 358         if (devc->serial && devc->serial->fd != -1) {
 359                 serial_close(devc->serial);
 360                 sdi->status = SR_ST_INACTIVE;
 361         }
 362
 363         return SR_OK;
 364 }
 365
 366 static int hw_cleanup(int dmm)
 367 {
 368         clear_instances(dmm);
 369
 370         return SR_OK;
 371 }
 372
 373 static int hw_info_get(int info_id, const void **data,
 374                        const struct sr_dev_inst *sdi)
 375 {
 376         (void)sdi;
 377
 378         switch (info_id) {
 379         case SR_DI_HWOPTS:
 380                 *data = hwopts;
 381                 break;
 382         case SR_DI_HWCAPS:
 383                 *data = hwcaps;
 384                 break;
 385         case SR_DI_NUM_PROBES:
 386                 *data = GINT_TO_POINTER(1);
 387                 break;
 388         case SR_DI_PROBE_NAMES:
 389                 *data = probe_names;
 390                 break;
 391         default:
 392                 return SR_ERR_ARG;
 393         }
 394
 395         return SR_OK;
 396 }
 397
 398 static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
 399                              const void *value)
 400 {
 401         struct dev_context *devc;
 402
 403         if (sdi->status != SR_ST_ACTIVE)
 404                 return SR_ERR;
 405
 406         if (!(devc = sdi->priv)) {
 407                 sr_err("sdi->priv was NULL.");
 408                 return SR_ERR_BUG;
 409         }
 410
 411         switch (hwcap) {
 412         case SR_HWCAP_LIMIT_SAMPLES:
 413                 devc->limit_samples = *(const uint64_t *)value;
 414                 sr_dbg("Setting sample limit to %" PRIu64 ".",
 415                        devc->limit_samples);
 416                 break;
 417         case SR_HWCAP_LIMIT_MSEC:
 418                 devc->limit_msec = *(const uint64_t *)value;
 419                 sr_dbg("Setting time limit to %" PRIu64 "ms.",
 420                        devc->limit_msec);
 421                 break;
 422         default:
 423                 sr_err("Unknown capability: %d.", hwcap);
 424                 return SR_ERR;
 425                 break;
 426         }
 427
 428         return SR_OK;
 429 }
 430
 431 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
 432                                     void *cb_data, int dmm)
 433 {
 434         struct sr_datafeed_packet packet;
 435         struct sr_datafeed_header header;
 436         struct sr_datafeed_meta_analog meta;
 437         struct dev_context *devc;
 438
 439         if (!(devc = sdi->priv)) {
 440                 sr_err("sdi->priv was NULL.");
 441                 return SR_ERR_BUG;
 442         }
 443
 444         sr_dbg("Starting acquisition.");
 445
 446         devc->cb_data = cb_data;
 447
 448         /*
 449          * Reset the number of samples to take. If we've already collected our
 450          * quota, but we start a new session, and don't reset this, we'll just
 451          * quit without acquiring any new samples.
 452          */
 453         devc->num_samples = 0;
 454         devc->starttime = g_get_monotonic_time();
 455
 456         /* Send header packet to the session bus. */
 457         sr_dbg("Sending SR_DF_HEADER.");
 458         packet.type = SR_DF_HEADER;
 459         packet.payload = (uint8_t *)&header;
 460         header.feed_version = 1;
 461         gettimeofday(&header.starttime, NULL);
 462         sr_session_send(devc->cb_data, &packet);
 463
 464         /* Send metadata about the SR_DF_ANALOG packets to come. */
 465         sr_dbg("Sending SR_DF_META_ANALOG.");
 466         packet.type = SR_DF_META_ANALOG;
 467         packet.payload = &meta;
 468         meta.num_probes = 1;
 469         sr_session_send(devc->cb_data, &packet);
 470
 471         /* Poll every 50ms, or whenever some data comes in. */
 472         sr_source_add(devc->serial->fd, G_IO_IN, 50,
 473                       dmms[dmm].receive_data, (void *)sdi);
 474
 475         return SR_OK;
 476 }
 477
 478 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 479 {
 480         struct sr_datafeed_packet packet;
 481         struct dev_context *devc;
 482
 483         if (sdi->status != SR_ST_ACTIVE)
 484                 return SR_ERR;
 485
 486         if (!(devc = sdi->priv)) {
 487                 sr_err("sdi->priv was NULL.");
 488                 return SR_ERR_BUG;
 489         }
 490
 491         sr_dbg("Stopping acquisition.");
 492
 493         sr_source_remove(devc->serial->fd);
 494         hw_dev_close((struct sr_dev_inst *)sdi);
 495
 496         /* Send end packet to the session bus. */
 497         sr_dbg("Sending SR_DF_END.");
 498         packet.type = SR_DF_END;
 499         sr_session_send(cb_data, &packet);
 500
 501         return SR_OK;
 502 }
 503
 504 /* Driver-specific API function wrappers */
 505 #define HW_INIT(X) \
 506 static int hw_init_##X(struct sr_context *sr_ctx) { return hw_init(sr_ctx, X); }
 507 #define HW_CLEANUP(X) \
 508 static int hw_cleanup_##X(void) { return hw_cleanup(X); }
 509 #define HW_SCAN(X) \
 510 static GSList *hw_scan_##X(GSList *options) { return hw_scan(options, X); }
 511 #define HW_DEV_LIST(X) \
 512 static GSList *hw_dev_list_##X(void) { return hw_dev_list(X); }
 513 #define CLEAR_INSTANCES(X) \
 514 static int clear_instances_##X(void) { return clear_instances(X); }
 515 #define HW_DEV_ACQUISITION_START(X) \
 516 static int hw_dev_acquisition_start_##X(const struct sr_dev_inst *sdi, \
 517 void *cb_data) { return hw_dev_acquisition_start(sdi, cb_data, X); }
 518
 519 /* Driver structs and API function wrappers */
 520 #define DRV(ID, ID_UPPER, NAME, LONGNAME) \
 521 HW_INIT(ID_UPPER) \
 522 HW_CLEANUP(ID_UPPER) \
 523 HW_SCAN(ID_UPPER) \
 524 HW_DEV_LIST(ID_UPPER) \
 525 CLEAR_INSTANCES(ID_UPPER) \
 526 HW_DEV_ACQUISITION_START(ID_UPPER) \
 527 SR_PRIV struct sr_dev_driver ID##_driver_info = { \
 528         .name = NAME, \
 529         .longname = LONGNAME, \
 530         .api_version = 1, \
 531         .init = hw_init_##ID_UPPER, \
 532         .cleanup = hw_cleanup_##ID_UPPER, \
 533         .scan = hw_scan_##ID_UPPER, \
 534         .dev_list = hw_dev_list_##ID_UPPER, \
 535         .dev_clear = clear_instances_##ID_UPPER, \
 536         .dev_open = hw_dev_open, \
 537         .dev_close = hw_dev_close, \
 538         .info_get = hw_info_get, \
 539         .dev_config_set = hw_dev_config_set, \
 540         .dev_acquisition_start = hw_dev_acquisition_start_##ID_UPPER, \
 541         .dev_acquisition_stop = hw_dev_acquisition_stop, \
 542         .priv = NULL, \
 543 };
 544
 545 DRV(digitek_dt4000zc, DIGITEK_DT4000ZC, "digitek-dt4000zc", "Digitek DT4000ZC")
 546 DRV(tekpower_tp4000zc, TEKPOWER_TP4000ZC, "tekpower-tp4000zc", "TekPower TP4000ZC")
 547 DRV(metex_me31, METEX_ME31, "metex-me31", "Metex ME-31")
 548 DRV(peaktech_3410, PEAKTECH_3410, "peaktech-3410", "PeakTech 3410")
 549 DRV(mastech_mas345, MASTECH_MAS345, "mastech-mas345", "MASTECH MAS345")
 550 DRV(va_va18b, VA_VA18B, "va-va18b", "V&A VA18B")
 551 DRV(metex_m3640d, METEX_M3640D, "metex-m3640d", "Metex M-3640D")
 552 DRV(peaktech_4370, PEAKTECH_4370, "peaktech-4370", "PeakTech 4370")
 553 DRV(pce_pce_dm32, PCE_PCE_DM32, "pce-pce-dm32", "PCE PCE-DM32")
 554 DRV(radioshack_22_168, RADIOSHACK_22_168, "radioshack-22-168", "RadioShack 22-168")
 555 DRV(radioshack_22_812, RADIOSHACK_22_812, "radioshack-22-812", "RadioShack 22-812")
 556 DRV(voltcraft_vc820_ser, VOLTCRAFT_VC820_SER, "voltcraft-vc820-ser", "Voltcraft VC-820 (UT-D02 cable)")
 557 DRV(voltcraft_vc840_ser, VOLTCRAFT_VC840_SER, "voltcraft-vc840-ser", "Voltcraft VC-840 (UT-D02 cable)")