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