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