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