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