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, receive_data_VOLTCRAFT_VC820,
 149         },
 150         {
 151                 "Voltcraft", "VC-840 (UT-D02 cable)", "2400/8n1/rts=0/dtr=1",
 152                 2400, FS9721_PACKET_SIZE, NULL,
 153                 sr_fs9721_packet_valid, sr_fs9721_parse,
 154                 NULL,
 155                 &voltcraft_vc840_ser_driver_info, receive_data_VOLTCRAFT_VC840,
 156         },
 157 };
 158
 159 /* Properly close and free all devices. */
 160 static int clear_instances(int dmm)
 161 {
 162         struct sr_dev_inst *sdi;
 163         struct drv_context *drvc;
 164         struct dev_context *devc;
 165         GSList *l;
 166         struct sr_dev_driver *di;
 167
 168         di = dmms[dmm].di;
 169
 170         if (!(drvc = di->priv))
 171                 return SR_OK;
 172
 173         drvc = di->priv;
 174         for (l = drvc->instances; l; l = l->next) {
 175                 if (!(sdi = l->data))
 176                         continue;
 177                 if (!(devc = sdi->priv))
 178                         continue;
 179                 sr_serial_dev_inst_free(devc->serial);
 180                 sr_dev_inst_free(sdi);
 181         }
 182         g_slist_free(drvc->instances);
 183         drvc->instances = NULL;
 184
 185         return SR_OK;
 186 }
 187
 188 static int hw_init(struct sr_context *sr_ctx, int dmm)
 189 {
 190         struct drv_context *drvc;
 191
 192         if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
 193                 sr_err("Driver context malloc failed.");
 194                 return SR_ERR_MALLOC;
 195         }
 196
 197         sr_dbg("Selected '%s' subdriver.", dmms[dmm].di->name);
 198
 199         drvc->sr_ctx = sr_ctx;
 200         dmms[dmm].di->priv = drvc;
 201
 202         return SR_OK;
 203 }
 204
 205 static GSList *scan(const char *conn, const char *serialcomm, int dmm)
 206 {
 207         struct sr_dev_inst *sdi;
 208         struct drv_context *drvc;
 209         struct dev_context *devc;
 210         struct sr_probe *probe;
 211         struct sr_serial_dev_inst *serial;
 212         GSList *devices;
 213         int dropped, ret;
 214         size_t len;
 215         uint8_t buf[128];
 216
 217         if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
 218                 return NULL;
 219
 220         if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
 221                 return NULL;
 222
 223         sr_info("Probing serial port %s.", conn);
 224
 225         drvc = dmms[dmm].di->priv;
 226         devices = NULL;
 227         serial_flush(serial);
 228
 229         /* Request a packet if the DMM requires this. */
 230         if (dmms[dmm].packet_request) {
 231                 if ((ret = dmms[dmm].packet_request(serial)) < 0) {
 232                         sr_err("Failed to request packet: %d.", ret);
 233                         return FALSE;
 234                 }
 235         }
 236
 237         /*
 238          * There's no way to get an ID from the multimeter. It just sends data
 239          * periodically (or upon request), so the best we can do is check if
 240          * the packets match the expected format.
 241          */
 242
 243         /* Let's get a bit of data and see if we can find a packet. */
 244         len = sizeof(buf);
 245         ret = serial_stream_detect(serial, buf, &len, dmms[dmm].packet_size,
 246                                    dmms[dmm].packet_valid, 1000,
 247                                    dmms[dmm].baudrate);
 248         if (ret != SR_OK)
 249                 goto scan_cleanup;
 250
 251         /*
 252          * If we dropped more than two packets worth of data, something is
 253          * wrong. We shouldn't quit however, since the dropped bytes might be
 254          * just zeroes at the beginning of the stream. Those can occur as a
 255          * combination of the nonstandard cable that ships with some devices
 256          * and the serial port or USB to serial adapter.
 257          */
 258         dropped = len - dmms[dmm].packet_size;
 259         if (dropped > 2 * dmms[dmm].packet_size)
 260                 sr_warn("Had to drop too much data.");
 261
 262         sr_info("Found device on port %s.", conn);
 263
 264         if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, dmms[dmm].vendor,
 265                                     dmms[dmm].device, "")))
 266                 goto scan_cleanup;
 267
 268         if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
 269                 sr_err("Device context malloc failed.");
 270                 goto scan_cleanup;
 271         }
 272
 273         devc->serial = serial;
 274
 275         sdi->priv = devc;
 276         sdi->driver = dmms[dmm].di;
 277         if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
 278                 goto scan_cleanup;
 279         sdi->probes = g_slist_append(sdi->probes, probe);
 280         drvc->instances = g_slist_append(drvc->instances, sdi);
 281         devices = g_slist_append(devices, sdi);
 282
 283 scan_cleanup:
 284         serial_close(serial);
 285
 286         return devices;
 287 }
 288
 289 static GSList *hw_scan(GSList *options, int dmm)
 290 {
 291         struct sr_hwopt *opt;
 292         GSList *l, *devices;
 293         const char *conn, *serialcomm;
 294
 295         conn = serialcomm = NULL;
 296         for (l = options; l; l = l->next) {
 297                 opt = l->data;
 298                 switch (opt->hwopt) {
 299                 case SR_HWOPT_CONN:
 300                         conn = opt->value;
 301                         break;
 302                 case SR_HWOPT_SERIALCOMM:
 303                         serialcomm = opt->value;
 304                         break;
 305                 }
 306         }
 307         if (!conn)
 308                 return NULL;
 309
 310         if (serialcomm) {
 311                 /* Use the provided comm specs. */
 312                 devices = scan(conn, serialcomm, dmm);
 313         } else {
 314                 /* Try the default. */
 315                 devices = scan(conn, dmms[dmm].conn, dmm);
 316         }
 317
 318         return devices;
 319 }
 320
 321 static GSList *hw_dev_list(int dmm)
 322 {
 323         struct drv_context *drvc;
 324
 325         drvc = dmms[dmm].di->priv;
 326
 327         return drvc->instances;
 328 }
 329
 330 static int hw_dev_open(struct sr_dev_inst *sdi)
 331 {
 332         struct dev_context *devc;
 333
 334         if (!(devc = sdi->priv)) {
 335                 sr_err("sdi->priv was NULL.");
 336                 return SR_ERR_BUG;
 337         }
 338
 339         if (serial_open(devc->serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
 340                 return SR_ERR;
 341
 342         sdi->status = SR_ST_ACTIVE;
 343
 344         return SR_OK;
 345 }
 346
 347 static int hw_dev_close(struct sr_dev_inst *sdi)
 348 {
 349         struct dev_context *devc;
 350
 351         if (!(devc = sdi->priv)) {
 352                 sr_err("sdi->priv was NULL.");
 353                 return SR_ERR_BUG;
 354         }
 355
 356         if (devc->serial && devc->serial->fd != -1) {
 357                 serial_close(devc->serial);
 358                 sdi->status = SR_ST_INACTIVE;
 359         }
 360
 361         return SR_OK;
 362 }
 363
 364 static int hw_cleanup(int dmm)
 365 {
 366         clear_instances(dmm);
 367
 368         return SR_OK;
 369 }
 370
 371 static int hw_info_get(int info_id, const void **data,
 372                        const struct sr_dev_inst *sdi)
 373 {
 374         (void)sdi;
 375
 376         switch (info_id) {
 377         case SR_DI_HWOPTS:
 378                 *data = hwopts;
 379                 break;
 380         case SR_DI_HWCAPS:
 381                 *data = hwcaps;
 382                 break;
 383         case SR_DI_NUM_PROBES:
 384                 *data = GINT_TO_POINTER(1);
 385                 break;
 386         case SR_DI_PROBE_NAMES:
 387                 *data = probe_names;
 388                 break;
 389         default:
 390                 return SR_ERR_ARG;
 391         }
 392
 393         return SR_OK;
 394 }
 395
 396 static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
 397                              const void *value)
 398 {
 399         struct dev_context *devc;
 400
 401         if (sdi->status != SR_ST_ACTIVE)
 402                 return SR_ERR;
 403
 404         if (!(devc = sdi->priv)) {
 405                 sr_err("sdi->priv was NULL.");
 406                 return SR_ERR_BUG;
 407         }
 408
 409         switch (hwcap) {
 410         case SR_HWCAP_LIMIT_SAMPLES:
 411                 devc->limit_samples = *(const uint64_t *)value;
 412                 sr_dbg("Setting sample limit to %" PRIu64 ".",
 413                        devc->limit_samples);
 414                 break;
 415         case SR_HWCAP_LIMIT_MSEC:
 416                 devc->limit_msec = *(const uint64_t *)value;
 417                 sr_dbg("Setting time limit to %" PRIu64 "ms.",
 418                        devc->limit_msec);
 419                 break;
 420         default:
 421                 sr_err("Unknown capability: %d.", hwcap);
 422                 return SR_ERR;
 423                 break;
 424         }
 425
 426         return SR_OK;
 427 }
 428
 429 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
 430                                     void *cb_data, int dmm)
 431 {
 432         struct sr_datafeed_packet packet;
 433         struct sr_datafeed_header header;
 434         struct sr_datafeed_meta_analog meta;
 435         struct dev_context *devc;
 436
 437         if (!(devc = sdi->priv)) {
 438                 sr_err("sdi->priv was NULL.");
 439                 return SR_ERR_BUG;
 440         }
 441
 442         sr_dbg("Starting acquisition.");
 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         sr_dbg("Sending SR_DF_HEADER.");
 456         packet.type = SR_DF_HEADER;
 457         packet.payload = (uint8_t *)&header;
 458         header.feed_version = 1;
 459         gettimeofday(&header.starttime, NULL);
 460         sr_session_send(devc->cb_data, &packet);
 461
 462         /* Send metadata about the SR_DF_ANALOG packets to come. */
 463         sr_dbg("Sending SR_DF_META_ANALOG.");
 464         packet.type = SR_DF_META_ANALOG;
 465         packet.payload = &meta;
 466         meta.num_probes = 1;
 467         sr_session_send(devc->cb_data, &packet);
 468
 469         /* Poll every 50ms, or whenever some data comes in. */
 470         sr_source_add(devc->serial->fd, G_IO_IN, 50,
 471                       dmms[dmm].receive_data, (void *)sdi);
 472
 473         return SR_OK;
 474 }
 475
 476 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 477 {
 478         struct sr_datafeed_packet packet;
 479         struct dev_context *devc;
 480
 481         if (sdi->status != SR_ST_ACTIVE)
 482                 return SR_ERR;
 483
 484         if (!(devc = sdi->priv)) {
 485                 sr_err("sdi->priv was NULL.");
 486                 return SR_ERR_BUG;
 487         }
 488
 489         sr_dbg("Stopping acquisition.");
 490
 491         sr_source_remove(devc->serial->fd);
 492         hw_dev_close((struct sr_dev_inst *)sdi);
 493
 494         /* Send end packet to the session bus. */
 495         sr_dbg("Sending SR_DF_END.");
 496         packet.type = SR_DF_END;
 497         sr_session_send(cb_data, &packet);
 498
 499         return SR_OK;
 500 }
 501
 502 /* Driver-specific API function wrappers */
 503 #define HW_INIT(X) \
 504 static int hw_init_##X(struct sr_context *sr_ctx) { return hw_init(sr_ctx, X); }
 505 #define HW_CLEANUP(X) \
 506 static int hw_cleanup_##X(void) { return hw_cleanup(X); }
 507 #define HW_SCAN(X) \
 508 static GSList *hw_scan_##X(GSList *options) { return hw_scan(options, X); }
 509 #define HW_DEV_LIST(X) \
 510 static GSList *hw_dev_list_##X(void) { return hw_dev_list(X); }
 511 #define CLEAR_INSTANCES(X) \
 512 static int clear_instances_##X(void) { return clear_instances(X); }
 513 #define HW_DEV_ACQUISITION_START(X) \
 514 static int hw_dev_acquisition_start_##X(const struct sr_dev_inst *sdi, \
 515 void *cb_data) { return hw_dev_acquisition_start(sdi, cb_data, X); }
 516
 517 /* Driver structs and API function wrappers */
 518 #define DRV(ID, ID_UPPER, NAME, LONGNAME) \
 519 HW_INIT(ID_UPPER) \
 520 HW_CLEANUP(ID_UPPER) \
 521 HW_SCAN(ID_UPPER) \
 522 HW_DEV_LIST(ID_UPPER) \
 523 CLEAR_INSTANCES(ID_UPPER) \
 524 HW_DEV_ACQUISITION_START(ID_UPPER) \
 525 SR_PRIV struct sr_dev_driver ID##_driver_info = { \
 526         .name = NAME, \
 527         .longname = LONGNAME, \
 528         .api_version = 1, \
 529         .init = hw_init_##ID_UPPER, \
 530         .cleanup = hw_cleanup_##ID_UPPER, \
 531         .scan = hw_scan_##ID_UPPER, \
 532         .dev_list = hw_dev_list_##ID_UPPER, \
 533         .dev_clear = clear_instances_##ID_UPPER, \
 534         .dev_open = hw_dev_open, \
 535         .dev_close = hw_dev_close, \
 536         .info_get = hw_info_get, \
 537         .dev_config_set = hw_dev_config_set, \
 538         .dev_acquisition_start = hw_dev_acquisition_start_##ID_UPPER, \
 539         .dev_acquisition_stop = hw_dev_acquisition_stop, \
 540         .priv = NULL, \
 541 };
 542
 543 DRV(digitek_dt4000zc, DIGITEK_DT4000ZC, "digitek-dt4000zc", "Digitek DT4000ZC")
 544 DRV(tekpower_tp4000zc, TEKPOWER_TP4000ZC, "tekpower-tp4000zc", "TekPower TP4000ZC")
 545 DRV(metex_me31, METEX_ME31, "metex-me31", "Metex ME-31")
 546 DRV(peaktech_3410, PEAKTECH_3410, "peaktech-3410", "PeakTech 3410")
 547 DRV(mastech_mas345, MASTECH_MAS345, "mastech-mas345", "MASTECH MAS345")
 548 DRV(va_va18b, VA_VA18B, "va-va18b", "V&A VA18B")
 549 DRV(metex_m3640d, METEX_M3640D, "metex-m3640d", "Metex M-3640D")
 550 DRV(peaktech_4370, PEAKTECH_4370, "peaktech-4370", "PeakTech 4370")
 551 DRV(pce_pce_dm32, PCE_PCE_DM32, "pce-pce-dm32", "PCE PCE-DM32")
 552 DRV(radioshack_22_168, RADIOSHACK_22_168, "radioshack-22-168", "RadioShack 22-168")
 553 DRV(radioshack_22_812, RADIOSHACK_22_812, "radioshack-22-812", "RadioShack 22-812")
 554 DRV(voltcraft_vc820_ser, VOLTCRAFT_VC820, "voltcraft-vc820-ser", "Voltcraft VC-820 (UT-D02 cable)")
 555 DRV(voltcraft_vc840_ser, VOLTCRAFT_VC840, "voltcraft-vc840-ser", "Voltcraft VC-840 (UT-D02 cable)")