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