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 int32_t hwopts[] = {
  30         SR_CONF_CONN,
  31 };
  32
  33 static const int32_t hwcaps[] = {
  34         SR_CONF_MULTIMETER,
  35         SR_CONF_LIMIT_SAMPLES,
  36         SR_CONF_LIMIT_MSEC,
  37         SR_CONF_CONTINUOUS,
  38 };
  39
  40 SR_PRIV struct sr_dev_driver tecpel_dmm_8061_driver_info;
  41 SR_PRIV struct sr_dev_driver uni_t_ut60a_driver_info;
  42 SR_PRIV struct sr_dev_driver uni_t_ut60e_driver_info;
  43 SR_PRIV struct sr_dev_driver uni_t_ut60g_driver_info;
  44 SR_PRIV struct sr_dev_driver uni_t_ut61b_driver_info;
  45 SR_PRIV struct sr_dev_driver uni_t_ut61c_driver_info;
  46 SR_PRIV struct sr_dev_driver uni_t_ut61d_driver_info;
  47 SR_PRIV struct sr_dev_driver uni_t_ut61e_driver_info;
  48 SR_PRIV struct sr_dev_driver voltcraft_vc820_driver_info;
  49 SR_PRIV struct sr_dev_driver voltcraft_vc830_driver_info;
  50 SR_PRIV struct sr_dev_driver voltcraft_vc840_driver_info;
  51 SR_PRIV struct sr_dev_driver tenma_72_7745_driver_info;
  52 SR_PRIV struct sr_dev_driver tenma_72_7750_driver_info;
  53
  54 SR_PRIV struct dmm_info udmms[] = {
  55         {
  56                 "Tecpel", "DMM-8061", 2400,
  57                 FS9721_PACKET_SIZE,
  58                 sr_fs9721_packet_valid, sr_fs9721_parse,
  59                 sr_fs9721_00_temp_c,
  60                 &tecpel_dmm_8061_driver_info, receive_data_TECPEL_DMM_8061,
  61         },
  62         {
  63                 "UNI-T", "UT60A", 2400,
  64                 FS9721_PACKET_SIZE,
  65                 sr_fs9721_packet_valid, sr_fs9721_parse,
  66                 NULL,
  67                 &uni_t_ut60a_driver_info, receive_data_UNI_T_UT60A,
  68         },
  69         {
  70                 "UNI-T", "UT60E", 2400,
  71                 FS9721_PACKET_SIZE,
  72                 sr_fs9721_packet_valid, sr_fs9721_parse,
  73                 sr_fs9721_00_temp_c,
  74                 &uni_t_ut60e_driver_info, receive_data_UNI_T_UT60E,
  75         },
  76         {
  77                 /* The baudrate is actually 19230, see "Note 1" below. */
  78                 "UNI-T", "UT60G", 19200,
  79                 ES519XX_11B_PACKET_SIZE,
  80                 sr_es519xx_19200_11b_packet_valid, sr_es519xx_19200_11b_parse,
  81                 NULL,
  82                 &uni_t_ut60g_driver_info, receive_data_UNI_T_UT60G,
  83         },
  84         {
  85                 "UNI-T", "UT61B", 2400,
  86                 FS9922_PACKET_SIZE,
  87                 sr_fs9922_packet_valid, sr_fs9922_parse,
  88                 NULL,
  89                 &uni_t_ut61b_driver_info, receive_data_UNI_T_UT61B,
  90         },
  91         {
  92                 "UNI-T", "UT61C", 2400,
  93                 FS9922_PACKET_SIZE,
  94                 sr_fs9922_packet_valid, sr_fs9922_parse,
  95                 NULL,
  96                 &uni_t_ut61c_driver_info, receive_data_UNI_T_UT61C,
  97         },
  98         {
  99                 "UNI-T", "UT61D", 2400,
 100                 FS9922_PACKET_SIZE,
 101                 sr_fs9922_packet_valid, sr_fs9922_parse,
 102                 NULL,
 103                 &uni_t_ut61d_driver_info, receive_data_UNI_T_UT61D,
 104         },
 105         {
 106                 /* The baudrate is actually 19230, see "Note 1" below. */
 107                 "UNI-T", "UT61E", 19200,
 108                 ES519XX_14B_PACKET_SIZE,
 109                 sr_es519xx_19200_14b_packet_valid, sr_es519xx_19200_14b_parse,
 110                 NULL,
 111                 &uni_t_ut61e_driver_info, receive_data_UNI_T_UT61E,
 112         },
 113         {
 114                 "Voltcraft", "VC-820", 2400,
 115                 FS9721_PACKET_SIZE,
 116                 sr_fs9721_packet_valid, sr_fs9721_parse,
 117                 NULL,
 118                 &voltcraft_vc820_driver_info, receive_data_VOLTCRAFT_VC820,
 119         },
 120         {
 121                 /*
 122                  * Note: The VC830 doesn't set the 'volt' and 'diode' bits of
 123                  * the FS9922 protocol. Instead, it only sets the user-defined
 124                  * bit "z1" to indicate "diode mode" and "voltage".
 125                  */
 126                 "Voltcraft", "VC-830", 2400,
 127                 FS9922_PACKET_SIZE,
 128                 sr_fs9922_packet_valid, sr_fs9922_parse,
 129                 &sr_fs9922_z1_diode,
 130                 &voltcraft_vc830_driver_info, receive_data_VOLTCRAFT_VC830,
 131         },
 132         {
 133                 "Voltcraft", "VC-840", 2400,
 134                 FS9721_PACKET_SIZE,
 135                 sr_fs9721_packet_valid, sr_fs9721_parse,
 136                 sr_fs9721_00_temp_c,
 137                 &voltcraft_vc840_driver_info, receive_data_VOLTCRAFT_VC840,
 138         },
 139         {
 140                 "Tenma", "72-7745", 2400,
 141                 FS9721_PACKET_SIZE,
 142                 sr_fs9721_packet_valid, sr_fs9721_parse,
 143                 sr_fs9721_00_temp_c,
 144                 &tenma_72_7745_driver_info, receive_data_TENMA_72_7745,
 145         },
 146         {
 147                 /* The baudrate is actually 19230, see "Note 1" below. */
 148                 "Tenma", "72-7750", 19200,
 149                 ES519XX_11B_PACKET_SIZE,
 150                 sr_es519xx_19200_11b_packet_valid, sr_es519xx_19200_11b_parse,
 151                 NULL,
 152                 &tenma_72_7750_driver_info, receive_data_TENMA_72_7750,
 153         },
 154 };
 155
 156 /*
 157  * Note 1: The actual baudrate of the Cyrustek ES519xx chip used in this DMM
 158  * is 19230. However, the WCH CH9325 chip (UART to USB/HID) used in (some
 159  * versions of) the UNI-T UT-D04 cable doesn't support 19230 baud. It only
 160  * supports 19200, and setting an unsupported baudrate will result in the
 161  * default of 2400 being used (which will not work with this DMM, of course).
 162  */
 163
 164 static int dev_clear(int dmm)
 165 {
 166         return std_dev_clear(udmms[dmm].di, NULL);
 167 }
 168
 169 static int init(struct sr_context *sr_ctx, int dmm)
 170 {
 171         sr_dbg("Selected '%s' subdriver.", udmms[dmm].di->name);
 172
 173         return std_init(sr_ctx, udmms[dmm].di, LOG_PREFIX);
 174 }
 175
 176 static GSList *scan(GSList *options, int dmm)
 177 {
 178         GSList *usb_devices, *devices, *l;
 179         struct sr_dev_inst *sdi;
 180         struct dev_context *devc;
 181         struct drv_context *drvc;
 182         struct sr_usb_dev_inst *usb;
 183         struct sr_config *src;
 184         struct sr_channel *ch;
 185         const char *conn;
 186
 187         drvc = udmms[dmm].di->priv;
 188
 189         conn = NULL;
 190         for (l = options; l; l = l->next) {
 191                 src = l->data;
 192                 switch (src->key) {
 193                 case SR_CONF_CONN:
 194                         conn = g_variant_get_string(src->data, NULL);
 195                         break;
 196                 }
 197         }
 198         if (!conn)
 199                 return NULL;
 200
 201         devices = NULL;
 202         if (!(usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn))) {
 203                 g_slist_free_full(usb_devices, g_free);
 204                 return NULL;
 205         }
 206
 207         for (l = usb_devices; l; l = l->next) {
 208                 usb = l->data;
 209
 210                 if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
 211                         sr_err("Device context malloc failed.");
 212                         return NULL;
 213                 }
 214
 215                 devc->first_run = TRUE;
 216
 217                 if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE,
 218                                 udmms[dmm].vendor, udmms[dmm].device, NULL))) {
 219                         sr_err("sr_dev_inst_new returned NULL.");
 220                         return NULL;
 221                 }
 222                 sdi->priv = devc;
 223                 sdi->driver = udmms[dmm].di;
 224                 if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "P1")))
 225                         return NULL;
 226                 sdi->channels = g_slist_append(sdi->channels, ch);
 227
 228                 sdi->inst_type = SR_INST_USB;
 229                 sdi->conn = usb;
 230
 231                 drvc->instances = g_slist_append(drvc->instances, sdi);
 232                 devices = g_slist_append(devices, sdi);
 233         }
 234
 235         return devices;
 236 }
 237
 238 static GSList *dev_list(int dmm)
 239 {
 240         return ((struct drv_context *)(udmms[dmm].di->priv))->instances;
 241 }
 242
 243 static int dev_open(struct sr_dev_inst *sdi, int dmm)
 244 {
 245         struct drv_context *drvc;
 246         struct sr_usb_dev_inst *usb;
 247         int ret;
 248
 249         drvc = udmms[dmm].di->priv;
 250         usb = sdi->conn;
 251
 252         if ((ret = sr_usb_open(drvc->sr_ctx->libusb_ctx, usb)) == SR_OK)
 253                 sdi->status = SR_ST_ACTIVE;
 254
 255         return ret;
 256 }
 257
 258 static int dev_close(struct sr_dev_inst *sdi)
 259 {
 260         /* TODO */
 261
 262         sdi->status = SR_ST_INACTIVE;
 263
 264         return SR_OK;
 265 }
 266
 267 static int cleanup(int dmm)
 268 {
 269         return dev_clear(dmm);
 270 }
 271
 272 static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi,
 273                 const struct sr_channel_group *cg)
 274 {
 275         struct dev_context *devc;
 276
 277         (void)cg;
 278
 279         devc = sdi->priv;
 280
 281         switch (id) {
 282         case SR_CONF_LIMIT_MSEC:
 283                 if (g_variant_get_uint64(data) == 0) {
 284                         sr_err("Time limit cannot be 0.");
 285                         return SR_ERR;
 286                 }
 287                 devc->limit_msec = g_variant_get_uint64(data);
 288                 sr_dbg("Setting time limit to %" PRIu64 "ms.",
 289                        devc->limit_msec);
 290                 break;
 291         case SR_CONF_LIMIT_SAMPLES:
 292                 if (g_variant_get_uint64(data) == 0) {
 293                         sr_err("Sample limit cannot be 0.");
 294                         return SR_ERR;
 295                 }
 296                 devc->limit_samples = g_variant_get_uint64(data);
 297                 sr_dbg("Setting sample limit to %" PRIu64 ".",
 298                        devc->limit_samples);
 299                 break;
 300         default:
 301                 return SR_ERR_NA;
 302         }
 303
 304         return SR_OK;
 305 }
 306
 307 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
 308                 const struct sr_channel_group *cg)
 309 {
 310         (void)sdi;
 311         (void)cg;
 312
 313         switch (key) {
 314         case SR_CONF_SCAN_OPTIONS:
 315                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
 316                                 hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
 317                 break;
 318         case SR_CONF_DEVICE_OPTIONS:
 319                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
 320                                 hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
 321                 break;
 322         default:
 323                 return SR_ERR_NA;
 324         }
 325
 326         return SR_OK;
 327 }
 328
 329 static int dev_acquisition_start(const struct sr_dev_inst *sdi,
 330                                     void *cb_data, int dmm)
 331 {
 332         struct dev_context *devc;
 333
 334         devc = sdi->priv;
 335
 336         devc->cb_data = cb_data;
 337
 338         devc->starttime = g_get_monotonic_time();
 339
 340         /* Send header packet to the session bus. */
 341         std_session_send_df_header(sdi, LOG_PREFIX);
 342
 343         sr_session_source_add(sdi->session, 0, 0, 10 /* poll_timeout */,
 344                       udmms[dmm].receive_data, (void *)sdi);
 345
 346         return SR_OK;
 347 }
 348
 349 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 350 {
 351         struct sr_datafeed_packet packet;
 352
 353         (void)cb_data;
 354
 355         sr_dbg("Stopping acquisition.");
 356
 357         /* Send end packet to the session bus. */
 358         sr_dbg("Sending SR_DF_END.");
 359         packet.type = SR_DF_END;
 360         sr_session_send(sdi, &packet);
 361
 362         sr_session_source_remove(sdi->session, 0);
 363
 364         return SR_OK;
 365 }
 366
 367 /* Driver-specific API function wrappers */
 368 #define HW_INIT(X) \
 369 static int init_##X(struct sr_context *sr_ctx) { return init(sr_ctx, X); }
 370 #define HW_CLEANUP(X) \
 371 static int cleanup_##X(void) { return cleanup(X); }
 372 #define HW_SCAN(X) \
 373 static GSList *scan_##X(GSList *options) { return scan(options, X); }
 374 #define HW_DEV_LIST(X) \
 375 static GSList *dev_list_##X(void) { return dev_list(X); }
 376 #define HW_DEV_CLEAR(X) \
 377 static int dev_clear_##X(void) { return dev_clear(X); }
 378 #define HW_DEV_ACQUISITION_START(X) \
 379 static int dev_acquisition_start_##X(const struct sr_dev_inst *sdi, \
 380 void *cb_data) { return dev_acquisition_start(sdi, cb_data, X); }
 381 #define HW_DEV_OPEN(X) \
 382 static int dev_open_##X(struct sr_dev_inst *sdi) { return dev_open(sdi, X); }
 383
 384 /* Driver structs and API function wrappers */
 385 #define DRV(ID, ID_UPPER, NAME, LONGNAME) \
 386 HW_INIT(ID_UPPER) \
 387 HW_CLEANUP(ID_UPPER) \
 388 HW_SCAN(ID_UPPER) \
 389 HW_DEV_LIST(ID_UPPER) \
 390 HW_DEV_CLEAR(ID_UPPER) \
 391 HW_DEV_ACQUISITION_START(ID_UPPER) \
 392 HW_DEV_OPEN(ID_UPPER) \
 393 SR_PRIV struct sr_dev_driver ID##_driver_info = { \
 394         .name = NAME, \
 395         .longname = LONGNAME, \
 396         .api_version = 1, \
 397         .init = init_##ID_UPPER, \
 398         .cleanup = cleanup_##ID_UPPER, \
 399         .scan = scan_##ID_UPPER, \
 400         .dev_list = dev_list_##ID_UPPER, \
 401         .dev_clear = dev_clear_##ID_UPPER, \
 402         .config_get = NULL, \
 403         .config_set = config_set, \
 404         .config_list = config_list, \
 405         .dev_open = dev_open_##ID_UPPER, \
 406         .dev_close = dev_close, \
 407         .dev_acquisition_start = dev_acquisition_start_##ID_UPPER, \
 408         .dev_acquisition_stop = dev_acquisition_stop, \
 409         .priv = NULL, \
 410 };
 411
 412 DRV(tecpel_dmm_8061, TECPEL_DMM_8061, "tecpel-dmm-8061", "Tecpel DMM-8061")
 413 DRV(uni_t_ut60a, UNI_T_UT60A, "uni-t-ut60a", "UNI-T UT60A")
 414 DRV(uni_t_ut60e, UNI_T_UT60E, "uni-t-ut60e", "UNI-T UT60E")
 415 DRV(uni_t_ut60g, UNI_T_UT60G, "uni-t-ut60g", "UNI-T UT60G")
 416 DRV(uni_t_ut61b, UNI_T_UT61B, "uni-t-ut61b", "UNI-T UT61B")
 417 DRV(uni_t_ut61c, UNI_T_UT61C, "uni-t-ut61c", "UNI-T UT61C")
 418 DRV(uni_t_ut61d, UNI_T_UT61D, "uni-t-ut61d", "UNI-T UT61D")
 419 DRV(uni_t_ut61e, UNI_T_UT61E, "uni-t-ut61e", "UNI-T UT61E")
 420 DRV(voltcraft_vc820, VOLTCRAFT_VC820, "voltcraft-vc820", "Voltcraft VC-820")
 421 DRV(voltcraft_vc830, VOLTCRAFT_VC830, "voltcraft-vc830", "Voltcraft VC-830")
 422 DRV(voltcraft_vc840, VOLTCRAFT_VC840, "voltcraft-vc840", "Voltcraft VC-840")
 423 DRV(tenma_72_7745, TENMA_72_7745, "tenma-72-7745", "Tenma 72-7745")
 424 DRV(tenma_72_7750, TENMA_72_7750, "tenma-72-7750", "Tenma 72-7750")