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