src/hardware/uni-t-dmm/api.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2012-2013 Uwe Hermann <uwe@hermann-uwe.de>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  19  */
  20
  21 #include <stdlib.h>
  22 #include <string.h>
  23 #include "libsigrok.h"
  24 #include "libsigrok-internal.h"
  25 #include "protocol.h"
  26
  27 #define UNI_T_UT_D04_NEW "1a86.e008"
  28
  29 static const uint32_t scanopts[] = {
  30         SR_CONF_CONN,
  31 };
  32
  33 static const uint32_t devopts[] = {
  34         SR_CONF_MULTIMETER,
  35         SR_CONF_CONTINUOUS,
  36         SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
  37         SR_CONF_LIMIT_MSEC | SR_CONF_SET,
  38 };
  39
  40 SR_PRIV struct sr_dev_driver tecpel_dmm_8061_driver_info;
  41 SR_PRIV struct sr_dev_driver uni_t_ut372_driver_info;
  42 SR_PRIV struct sr_dev_driver uni_t_ut60a_driver_info;
  43 SR_PRIV struct sr_dev_driver uni_t_ut60e_driver_info;
  44 SR_PRIV struct sr_dev_driver uni_t_ut60g_driver_info;
  45 SR_PRIV struct sr_dev_driver uni_t_ut61b_driver_info;
  46 SR_PRIV struct sr_dev_driver uni_t_ut61c_driver_info;
  47 SR_PRIV struct sr_dev_driver uni_t_ut61d_driver_info;
  48 SR_PRIV struct sr_dev_driver uni_t_ut61e_driver_info;
  49 SR_PRIV struct sr_dev_driver uni_t_ut71a_driver_info;
  50 SR_PRIV struct sr_dev_driver uni_t_ut71b_driver_info;
  51 SR_PRIV struct sr_dev_driver uni_t_ut71c_driver_info;
  52 SR_PRIV struct sr_dev_driver uni_t_ut71d_driver_info;
  53 SR_PRIV struct sr_dev_driver uni_t_ut71e_driver_info;
  54 SR_PRIV struct sr_dev_driver voltcraft_vc820_driver_info;
  55 SR_PRIV struct sr_dev_driver voltcraft_vc830_driver_info;
  56 SR_PRIV struct sr_dev_driver voltcraft_vc840_driver_info;
  57 SR_PRIV struct sr_dev_driver voltcraft_vc920_driver_info;
  58 SR_PRIV struct sr_dev_driver voltcraft_vc940_driver_info;
  59 SR_PRIV struct sr_dev_driver voltcraft_vc960_driver_info;
  60 SR_PRIV struct sr_dev_driver tenma_72_7745_driver_info;
  61 SR_PRIV struct sr_dev_driver tenma_72_7750_driver_info;
  62
  63 SR_PRIV struct dmm_info udmms[] = {
  64         {
  65                 "Tecpel", "DMM-8061", 2400,
  66                 FS9721_PACKET_SIZE,
  67                 sr_fs9721_packet_valid, sr_fs9721_parse,
  68                 sr_fs9721_00_temp_c,
  69                 &tecpel_dmm_8061_driver_info, receive_data_TECPEL_DMM_8061,
  70         },
  71         {
  72                 "UNI-T", "UT372", 2400,
  73                 UT372_PACKET_SIZE,
  74                 sr_ut372_packet_valid, sr_ut372_parse,
  75                 NULL,
  76                 &uni_t_ut372_driver_info, receive_data_UNI_T_UT372,
  77         },
  78         {
  79                 "UNI-T", "UT60A", 2400,
  80                 FS9721_PACKET_SIZE,
  81                 sr_fs9721_packet_valid, sr_fs9721_parse,
  82                 NULL,
  83                 &uni_t_ut60a_driver_info, receive_data_UNI_T_UT60A,
  84         },
  85         {
  86                 "UNI-T", "UT60E", 2400,
  87                 FS9721_PACKET_SIZE,
  88                 sr_fs9721_packet_valid, sr_fs9721_parse,
  89                 sr_fs9721_00_temp_c,
  90                 &uni_t_ut60e_driver_info, receive_data_UNI_T_UT60E,
  91         },
  92         {
  93                 /* The baudrate is actually 19230, see "Note 1" below. */
  94                 "UNI-T", "UT60G", 19200,
  95                 ES519XX_11B_PACKET_SIZE,
  96                 sr_es519xx_19200_11b_packet_valid, sr_es519xx_19200_11b_parse,
  97                 NULL,
  98                 &uni_t_ut60g_driver_info, receive_data_UNI_T_UT60G,
  99         },
 100         {
 101                 "UNI-T", "UT61B", 2400,
 102                 FS9922_PACKET_SIZE,
 103                 sr_fs9922_packet_valid, sr_fs9922_parse,
 104                 NULL,
 105                 &uni_t_ut61b_driver_info, receive_data_UNI_T_UT61B,
 106         },
 107         {
 108                 "UNI-T", "UT61C", 2400,
 109                 FS9922_PACKET_SIZE,
 110                 sr_fs9922_packet_valid, sr_fs9922_parse,
 111                 NULL,
 112                 &uni_t_ut61c_driver_info, receive_data_UNI_T_UT61C,
 113         },
 114         {
 115                 "UNI-T", "UT61D", 2400,
 116                 FS9922_PACKET_SIZE,
 117                 sr_fs9922_packet_valid, sr_fs9922_parse,
 118                 NULL,
 119                 &uni_t_ut61d_driver_info, receive_data_UNI_T_UT61D,
 120         },
 121         {
 122                 /* The baudrate is actually 19230, see "Note 1" below. */
 123                 "UNI-T", "UT61E", 19200,
 124                 ES519XX_14B_PACKET_SIZE,
 125                 sr_es519xx_19200_14b_packet_valid, sr_es519xx_19200_14b_parse,
 126                 NULL,
 127                 &uni_t_ut61e_driver_info, receive_data_UNI_T_UT61E,
 128         },
 129         {
 130                 "UNI-T", "UT71A", 2400, UT71X_PACKET_SIZE,
 131                 sr_ut71x_packet_valid, sr_ut71x_parse, NULL,
 132                 &uni_t_ut71a_driver_info, receive_data_UNI_T_UT71A,
 133         },
 134         {
 135                 "UNI-T", "UT71B", 2400, UT71X_PACKET_SIZE,
 136                 sr_ut71x_packet_valid, sr_ut71x_parse, NULL,
 137                 &uni_t_ut71b_driver_info, receive_data_UNI_T_UT71B,
 138         },
 139         {
 140                 "UNI-T", "UT71C", 2400, UT71X_PACKET_SIZE,
 141                 sr_ut71x_packet_valid, sr_ut71x_parse, NULL,
 142                 &uni_t_ut71c_driver_info, receive_data_UNI_T_UT71C,
 143         },
 144         {
 145                 "UNI-T", "UT71D", 2400, UT71X_PACKET_SIZE,
 146                 sr_ut71x_packet_valid, sr_ut71x_parse, NULL,
 147                 &uni_t_ut71d_driver_info, receive_data_UNI_T_UT71D,
 148         },
 149         {
 150                 "UNI-T", "UT71E", 2400, UT71X_PACKET_SIZE,
 151                 sr_ut71x_packet_valid, sr_ut71x_parse, NULL,
 152                 &uni_t_ut71e_driver_info, receive_data_UNI_T_UT71E,
 153         },
 154         {
 155                 "Voltcraft", "VC-820", 2400,
 156                 FS9721_PACKET_SIZE,
 157                 sr_fs9721_packet_valid, sr_fs9721_parse,
 158                 NULL,
 159                 &voltcraft_vc820_driver_info, receive_data_VOLTCRAFT_VC820,
 160         },
 161         {
 162                 /*
 163                  * Note: The VC830 doesn't set the 'volt' and 'diode' bits of
 164                  * the FS9922 protocol. Instead, it only sets the user-defined
 165                  * bit "z1" to indicate "diode mode" and "voltage".
 166                  */
 167                 "Voltcraft", "VC-830", 2400,
 168                 FS9922_PACKET_SIZE,
 169                 sr_fs9922_packet_valid, sr_fs9922_parse,
 170                 &sr_fs9922_z1_diode,
 171                 &voltcraft_vc830_driver_info, receive_data_VOLTCRAFT_VC830,
 172         },
 173         {
 174                 "Voltcraft", "VC-840", 2400,
 175                 FS9721_PACKET_SIZE,
 176                 sr_fs9721_packet_valid, sr_fs9721_parse,
 177                 sr_fs9721_00_temp_c,
 178                 &voltcraft_vc840_driver_info, receive_data_VOLTCRAFT_VC840,
 179         },
 180         {
 181                 "Voltcraft", "VC-920", 2400, UT71X_PACKET_SIZE,
 182                 sr_ut71x_packet_valid, sr_ut71x_parse, NULL,
 183                 &voltcraft_vc920_driver_info, receive_data_VOLTCRAFT_VC920,
 184         },
 185         {
 186                 "Voltcraft", "VC-940", 2400, UT71X_PACKET_SIZE,
 187                 sr_ut71x_packet_valid, sr_ut71x_parse, NULL,
 188                 &voltcraft_vc940_driver_info, receive_data_VOLTCRAFT_VC940,
 189         },
 190         {
 191                 "Voltcraft", "VC-960", 2400, UT71X_PACKET_SIZE,
 192                 sr_ut71x_packet_valid, sr_ut71x_parse, NULL,
 193                 &voltcraft_vc960_driver_info, receive_data_VOLTCRAFT_VC960,
 194         },
 195         {
 196                 "Tenma", "72-7745", 2400,
 197                 FS9721_PACKET_SIZE,
 198                 sr_fs9721_packet_valid, sr_fs9721_parse,
 199                 sr_fs9721_00_temp_c,
 200                 &tenma_72_7745_driver_info, receive_data_TENMA_72_7745,
 201         },
 202         {
 203                 /* The baudrate is actually 19230, see "Note 1" below. */
 204                 "Tenma", "72-7750", 19200,
 205                 ES519XX_11B_PACKET_SIZE,
 206                 sr_es519xx_19200_11b_packet_valid, sr_es519xx_19200_11b_parse,
 207                 NULL,
 208                 &tenma_72_7750_driver_info, receive_data_TENMA_72_7750,
 209         },
 210 };
 211
 212 /*
 213  * Note 1: The actual baudrate of the Cyrustek ES519xx chip used in this DMM
 214  * is 19230. However, the WCH CH9325 chip (UART to USB/HID) used in (some
 215  * versions of) the UNI-T UT-D04 cable doesn't support 19230 baud. It only
 216  * supports 19200, and setting an unsupported baudrate will result in the
 217  * default of 2400 being used (which will not work with this DMM, of course).
 218  */
 219
 220 static int dev_clear(int dmm)
 221 {
 222         return std_dev_clear(udmms[dmm].di, NULL);
 223 }
 224
 225 static int init(struct sr_context *sr_ctx, int dmm)
 226 {
 227         return std_init(sr_ctx, udmms[dmm].di, LOG_PREFIX);
 228 }
 229
 230 static GSList *scan(GSList *options, int dmm)
 231 {
 232         GSList *usb_devices, *devices, *l;
 233         struct sr_dev_inst *sdi;
 234         struct dev_context *devc;
 235         struct drv_context *drvc;
 236         struct sr_usb_dev_inst *usb;
 237         struct sr_config *src;
 238         const char *conn;
 239
 240         drvc = udmms[dmm].di->priv;
 241
 242         conn = NULL;
 243         for (l = options; l; l = l->next) {
 244                 src = l->data;
 245                 switch (src->key) {
 246                 case SR_CONF_CONN:
 247                         conn = g_variant_get_string(src->data, NULL);
 248                         break;
 249                 }
 250         }
 251         if (!conn)
 252                 return NULL;
 253
 254         devices = NULL;
 255         if (!(usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn))) {
 256                 g_slist_free_full(usb_devices, g_free);
 257                 return NULL;
 258         }
 259
 260         for (l = usb_devices; l; l = l->next) {
 261                 usb = l->data;
 262                 devc = g_malloc0(sizeof(struct dev_context));
 263                 devc->first_run = TRUE;
 264                 sdi = g_malloc0(sizeof(struct sr_dev_inst));
 265                 sdi->status = SR_ST_INACTIVE;
 266                 sdi->vendor = g_strdup(udmms[dmm].vendor);
 267                 sdi->model = g_strdup(udmms[dmm].device);
 268                 sdi->priv = devc;
 269                 sdi->driver = udmms[dmm].di;
 270                 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
 271                 sdi->inst_type = SR_INST_USB;
 272                 sdi->conn = usb;
 273                 drvc->instances = g_slist_append(drvc->instances, sdi);
 274                 devices = g_slist_append(devices, sdi);
 275         }
 276
 277         return devices;
 278 }
 279
 280 static GSList *dev_list(int dmm)
 281 {
 282         return ((struct drv_context *)(udmms[dmm].di->priv))->instances;
 283 }
 284
 285 static int dev_open(struct sr_dev_inst *sdi, int dmm)
 286 {
 287         struct drv_context *drvc;
 288         struct sr_usb_dev_inst *usb;
 289         int ret;
 290
 291         drvc = udmms[dmm].di->priv;
 292         usb = sdi->conn;
 293
 294         if ((ret = sr_usb_open(drvc->sr_ctx->libusb_ctx, usb)) == SR_OK)
 295                 sdi->status = SR_ST_ACTIVE;
 296
 297         return ret;
 298 }
 299
 300 static int dev_close(struct sr_dev_inst *sdi)
 301 {
 302         /* TODO */
 303
 304         sdi->status = SR_ST_INACTIVE;
 305
 306         return SR_OK;
 307 }
 308
 309 static int cleanup(int dmm)
 310 {
 311         return dev_clear(dmm);
 312 }
 313
 314 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 315                 const struct sr_channel_group *cg)
 316 {
 317         struct dev_context *devc;
 318
 319         (void)cg;
 320
 321         devc = sdi->priv;
 322
 323         switch (key) {
 324         case SR_CONF_LIMIT_MSEC:
 325                 if (g_variant_get_uint64(data) == 0) {
 326                         sr_err("Time limit cannot be 0.");
 327                         return SR_ERR;
 328                 }
 329                 devc->limit_msec = g_variant_get_uint64(data);
 330                 sr_dbg("Setting time limit to %" PRIu64 "ms.",
 331                        devc->limit_msec);
 332                 break;
 333         case SR_CONF_LIMIT_SAMPLES:
 334                 if (g_variant_get_uint64(data) == 0) {
 335                         sr_err("Sample limit cannot be 0.");
 336                         return SR_ERR;
 337                 }
 338                 devc->limit_samples = g_variant_get_uint64(data);
 339                 sr_dbg("Setting sample limit to %" PRIu64 ".",
 340                        devc->limit_samples);
 341                 break;
 342         default:
 343                 return SR_ERR_NA;
 344         }
 345
 346         return SR_OK;
 347 }
 348
 349 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 350                 const struct sr_channel_group *cg)
 351 {
 352         (void)sdi;
 353         (void)cg;
 354
 355         switch (key) {
 356         case SR_CONF_SCAN_OPTIONS:
 357                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 358                                 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 359                 break;
 360         case SR_CONF_DEVICE_OPTIONS:
 361                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 362                                 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 363                 break;
 364         default:
 365                 return SR_ERR_NA;
 366         }
 367
 368         return SR_OK;
 369 }
 370
 371 static int dev_acquisition_start(const struct sr_dev_inst *sdi,
 372                                     void *cb_data, int dmm)
 373 {
 374         struct dev_context *devc;
 375
 376         devc = sdi->priv;
 377
 378         devc->cb_data = cb_data;
 379
 380         devc->starttime = g_get_monotonic_time();
 381
 382         /* Send header packet to the session bus. */
 383         std_session_send_df_header(sdi, LOG_PREFIX);
 384
 385         sr_session_source_add(sdi->session, 0, 0, 10 /* poll_timeout */,
 386                       udmms[dmm].receive_data, (void *)sdi);
 387
 388         return SR_OK;
 389 }
 390
 391 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 392 {
 393         struct sr_datafeed_packet packet;
 394
 395         (void)cb_data;
 396
 397         sr_dbg("Stopping acquisition.");
 398
 399         /* Send end packet to the session bus. */
 400         sr_dbg("Sending SR_DF_END.");
 401         packet.type = SR_DF_END;
 402         sr_session_send(sdi, &packet);
 403
 404         sr_session_source_remove(sdi->session, 0);
 405
 406         return SR_OK;
 407 }
 408
 409 /* Driver-specific API function wrappers */
 410 #define HW_INIT(X) \
 411 static int init_##X(struct sr_context *sr_ctx) { return init(sr_ctx, X); }
 412 #define HW_CLEANUP(X) \
 413 static int cleanup_##X(void) { return cleanup(X); }
 414 #define HW_SCAN(X) \
 415 static GSList *scan_##X(GSList *options) { return scan(options, X); }
 416 #define HW_DEV_LIST(X) \
 417 static GSList *dev_list_##X(void) { return dev_list(X); }
 418 #define HW_DEV_CLEAR(X) \
 419 static int dev_clear_##X(void) { return dev_clear(X); }
 420 #define HW_DEV_ACQUISITION_START(X) \
 421 static int dev_acquisition_start_##X(const struct sr_dev_inst *sdi, \
 422 void *cb_data) { return dev_acquisition_start(sdi, cb_data, X); }
 423 #define HW_DEV_OPEN(X) \
 424 static int dev_open_##X(struct sr_dev_inst *sdi) { return dev_open(sdi, X); }
 425
 426 /* Driver structs and API function wrappers */
 427 #define DRV(ID, ID_UPPER, NAME, LONGNAME) \
 428 HW_INIT(ID_UPPER) \
 429 HW_CLEANUP(ID_UPPER) \
 430 HW_SCAN(ID_UPPER) \
 431 HW_DEV_LIST(ID_UPPER) \
 432 HW_DEV_CLEAR(ID_UPPER) \
 433 HW_DEV_ACQUISITION_START(ID_UPPER) \
 434 HW_DEV_OPEN(ID_UPPER) \
 435 SR_PRIV struct sr_dev_driver ID##_driver_info = { \
 436         .name = NAME, \
 437         .longname = LONGNAME, \
 438         .api_version = 1, \
 439         .init = init_##ID_UPPER, \
 440         .cleanup = cleanup_##ID_UPPER, \
 441         .scan = scan_##ID_UPPER, \
 442         .dev_list = dev_list_##ID_UPPER, \
 443         .dev_clear = dev_clear_##ID_UPPER, \
 444         .config_get = NULL, \
 445         .config_set = config_set, \
 446         .config_list = config_list, \
 447         .dev_open = dev_open_##ID_UPPER, \
 448         .dev_close = dev_close, \
 449         .dev_acquisition_start = dev_acquisition_start_##ID_UPPER, \
 450         .dev_acquisition_stop = dev_acquisition_stop, \
 451         .priv = NULL, \
 452 };
 453
 454 DRV(tecpel_dmm_8061, TECPEL_DMM_8061, "tecpel-dmm-8061", "Tecpel DMM-8061")
 455 DRV(uni_t_ut372, UNI_T_UT372, "uni-t-ut372", "UNI-T UT372")
 456 DRV(uni_t_ut60a, UNI_T_UT60A, "uni-t-ut60a", "UNI-T UT60A")
 457 DRV(uni_t_ut60e, UNI_T_UT60E, "uni-t-ut60e", "UNI-T UT60E")
 458 DRV(uni_t_ut60g, UNI_T_UT60G, "uni-t-ut60g", "UNI-T UT60G")
 459 DRV(uni_t_ut61b, UNI_T_UT61B, "uni-t-ut61b", "UNI-T UT61B")
 460 DRV(uni_t_ut61c, UNI_T_UT61C, "uni-t-ut61c", "UNI-T UT61C")
 461 DRV(uni_t_ut61d, UNI_T_UT61D, "uni-t-ut61d", "UNI-T UT61D")
 462 DRV(uni_t_ut61e, UNI_T_UT61E, "uni-t-ut61e", "UNI-T UT61E")
 463 DRV(uni_t_ut71a, UNI_T_UT71A, "uni-t-ut71a", "UNI-T UT71A")
 464 DRV(uni_t_ut71b, UNI_T_UT71B, "uni-t-ut71b", "UNI-T UT71B")
 465 DRV(uni_t_ut71c, UNI_T_UT71C, "uni-t-ut71c", "UNI-T UT71C")
 466 DRV(uni_t_ut71d, UNI_T_UT71D, "uni-t-ut71d", "UNI-T UT71D")
 467 DRV(uni_t_ut71e, UNI_T_UT71E, "uni-t-ut71e", "UNI-T UT71E")
 468 DRV(voltcraft_vc820, VOLTCRAFT_VC820, "voltcraft-vc820", "Voltcraft VC-820")
 469 DRV(voltcraft_vc830, VOLTCRAFT_VC830, "voltcraft-vc830", "Voltcraft VC-830")
 470 DRV(voltcraft_vc840, VOLTCRAFT_VC840, "voltcraft-vc840", "Voltcraft VC-840")
 471 DRV(voltcraft_vc920, VOLTCRAFT_VC920, "voltcraft-vc920", "Voltcraft VC-920")
 472 DRV(voltcraft_vc940, VOLTCRAFT_VC940, "voltcraft-vc940", "Voltcraft VC-940")
 473 DRV(voltcraft_vc960, VOLTCRAFT_VC960, "voltcraft-vc960", "Voltcraft VC-960")
 474 DRV(tenma_72_7745, TENMA_72_7745, "tenma-72-7745", "Tenma 72-7745")
 475 DRV(tenma_72_7750, TENMA_72_7750, "tenma-72-7750", "Tenma 72-7750")