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