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