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