hardware/serial-dmm/api.c

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