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, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #include <config.h>
  21 #include <stdlib.h>
  22 #include <string.h>
  23 #include <libsigrok/libsigrok.h>
  24 #include "libsigrok-internal.h"
  25 #include "protocol.h"
  26
  27 static const uint32_t scanopts[] = {
  28         SR_CONF_CONN,
  29 };
  30
  31 static const uint32_t drvopts[] = {
  32         SR_CONF_MULTIMETER,
  33 };
  34
  35 static const uint32_t devopts[] = {
  36         SR_CONF_CONTINUOUS,
  37         SR_CONF_LIMIT_SAMPLES | SR_CONF_SET | SR_CONF_GET,
  38         SR_CONF_LIMIT_MSEC | SR_CONF_SET | SR_CONF_GET,
  39 };
  40
  41 /*
  42  * Note 1: The actual baudrate of the Cyrustek ES519xx chip used in this DMM
  43  * is 19230. However, the WCH CH9325 chip (UART to USB/HID) used in (some
  44  * versions of) the UNI-T UT-D04 cable doesn't support 19230 baud. It only
  45  * supports 19200, and setting an unsupported baudrate will result in the
  46  * default of 2400 being used (which will not work with this DMM, of course).
  47  */
  48
  49 static GSList *scan(struct sr_dev_driver *di, GSList *options)
  50 {
  51         GSList *usb_devices, *devices, *l;
  52         struct sr_dev_inst *sdi;
  53         struct dev_context *devc;
  54         struct drv_context *drvc;
  55         struct dmm_info *dmm;
  56         struct sr_usb_dev_inst *usb;
  57         struct sr_config *src;
  58         const char *conn;
  59
  60         drvc = di->context;
  61         dmm = (struct dmm_info *)di;
  62
  63         conn = NULL;
  64         for (l = options; l; l = l->next) {
  65                 src = l->data;
  66                 switch (src->key) {
  67                 case SR_CONF_CONN:
  68                         conn = g_variant_get_string(src->data, NULL);
  69                         break;
  70                 }
  71         }
  72         if (!conn)
  73                 return NULL;
  74
  75         devices = NULL;
  76         if (!(usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn))) {
  77                 g_slist_free_full(usb_devices, g_free);
  78                 return NULL;
  79         }
  80
  81         for (l = usb_devices; l; l = l->next) {
  82                 usb = l->data;
  83                 devc = g_malloc0(sizeof(struct dev_context));
  84                 devc->first_run = TRUE;
  85                 sdi = g_malloc0(sizeof(struct sr_dev_inst));
  86                 sdi->status = SR_ST_INACTIVE;
  87                 sdi->vendor = g_strdup(dmm->vendor);
  88                 sdi->model = g_strdup(dmm->device);
  89                 sdi->priv = devc;
  90                 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
  91                 sdi->inst_type = SR_INST_USB;
  92                 sdi->conn = usb;
  93                 devices = g_slist_append(devices, sdi);
  94         }
  95
  96         return std_scan_complete(di, devices);
  97 }
  98
  99 static int dev_open(struct sr_dev_inst *sdi)
 100 {
 101         struct sr_dev_driver *di;
 102         struct drv_context *drvc;
 103         struct sr_usb_dev_inst *usb;
 104
 105         di = sdi->driver;
 106         drvc = di->context;
 107         usb = sdi->conn;
 108
 109         return sr_usb_open(drvc->sr_ctx->libusb_ctx, usb);
 110 }
 111
 112 static int config_set(uint32_t key, GVariant *data,
 113         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 114 {
 115         struct dev_context *devc;
 116
 117         (void)cg;
 118
 119         devc = sdi->priv;
 120
 121         return sr_sw_limits_config_set(&devc->limits, key, data);
 122 }
 123
 124 static int config_list(uint32_t key, GVariant **data,
 125         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 126 {
 127         return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
 128 }
 129
 130 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 131 {
 132         struct dev_context *devc;
 133
 134         devc = sdi->priv;
 135
 136         sr_sw_limits_acquisition_start(&devc->limits);
 137
 138         std_session_send_df_header(sdi);
 139
 140         sr_session_source_add(sdi->session, -1, 0, 10,
 141                         uni_t_dmm_receive_data, (void *)sdi);
 142
 143         return SR_OK;
 144 }
 145
 146 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 147 {
 148         std_session_send_df_end(sdi);
 149         sr_session_source_remove(sdi->session, -1);
 150
 151         return SR_OK;
 152 }
 153
 154 #define DMM(ID, CHIPSET, VENDOR, MODEL, BAUDRATE, PACKETSIZE, \
 155                         VALID, PARSE, DETAILS) \
 156         &((struct dmm_info) { \
 157                 { \
 158                         .name = ID, \
 159                         .longname = VENDOR " " MODEL, \
 160                         .api_version = 1, \
 161                         .init = std_init, \
 162                         .cleanup = std_cleanup, \
 163                         .scan = scan, \
 164                         .dev_list = std_dev_list, \
 165                         .dev_clear = std_dev_clear, \
 166                         .config_get = NULL, \
 167                         .config_set = config_set, \
 168                         .config_list = config_list, \
 169                         .dev_open = dev_open, \
 170                         .dev_close = std_dummy_dev_close /* TODO */, \
 171                         .dev_acquisition_start = dev_acquisition_start, \
 172                         .dev_acquisition_stop = dev_acquisition_stop, \
 173                         .context = NULL, \
 174                 }, \
 175                 VENDOR, MODEL, BAUDRATE, PACKETSIZE, \
 176                 VALID, PARSE, DETAILS, sizeof(struct CHIPSET##_info) \
 177         }).di
 178
 179 SR_REGISTER_DEV_DRIVER_LIST(uni_t_dmm_drivers,
 180         /* {{{ es519xx */
 181         DMM(
 182                 "tenma-72-7750", es519xx,
 183                 /* The baudrate is actually 19230, see "Note 1" below. */
 184                 "Tenma", "72-7750", 19200,
 185                 ES519XX_11B_PACKET_SIZE,
 186                 sr_es519xx_19200_11b_packet_valid, sr_es519xx_19200_11b_parse,
 187                 NULL
 188         ),
 189         DMM(
 190                 "uni-t-ut60g", es519xx,
 191                 /* The baudrate is actually 19230, see "Note 1" below. */
 192                 "UNI-T", "UT60G", 19200,
 193                 ES519XX_11B_PACKET_SIZE,
 194                 sr_es519xx_19200_11b_packet_valid, sr_es519xx_19200_11b_parse,
 195                 NULL
 196         ),
 197         DMM(
 198                 "uni-t-ut61e", es519xx,
 199                 /* The baudrate is actually 19230, see "Note 1" below. */
 200                 "UNI-T", "UT61E", 19200,
 201                 ES519XX_14B_PACKET_SIZE,
 202                 sr_es519xx_19200_14b_packet_valid, sr_es519xx_19200_14b_parse,
 203                 NULL
 204         ),
 205         /* }}} */
 206         /* {{{ fs9721 */
 207         DMM(
 208                 "tecpel-dmm-8061", fs9721,
 209                 "Tecpel", "DMM-8061", 2400,
 210                 FS9721_PACKET_SIZE,
 211                 sr_fs9721_packet_valid, sr_fs9721_parse,
 212                 sr_fs9721_00_temp_c
 213         ),
 214         DMM(
 215                 "tenma-72-7745", fs9721,
 216                 "Tenma", "72-7745", 2400,
 217                 FS9721_PACKET_SIZE,
 218                 sr_fs9721_packet_valid, sr_fs9721_parse,
 219                 sr_fs9721_00_temp_c
 220         ),
 221         DMM(
 222                 "uni-t-ut60a", fs9721,
 223                 "UNI-T", "UT60A", 2400,
 224                 FS9721_PACKET_SIZE,
 225                 sr_fs9721_packet_valid, sr_fs9721_parse,
 226                 NULL
 227         ),
 228         DMM(
 229                 "uni-t-ut60e", fs9721,
 230                 "UNI-T", "UT60E", 2400,
 231                 FS9721_PACKET_SIZE,
 232                 sr_fs9721_packet_valid, sr_fs9721_parse,
 233                 sr_fs9721_00_temp_c
 234         ),
 235         DMM(
 236                 "voltcraft-vc820", fs9721,
 237                 "Voltcraft", "VC-820", 2400,
 238                 FS9721_PACKET_SIZE,
 239                 sr_fs9721_packet_valid, sr_fs9721_parse,
 240                 NULL
 241         ),
 242         DMM(
 243                 "voltcraft-vc840", fs9721,
 244                 "Voltcraft", "VC-840", 2400,
 245                 FS9721_PACKET_SIZE,
 246                 sr_fs9721_packet_valid, sr_fs9721_parse,
 247                 sr_fs9721_00_temp_c
 248         ),
 249         /* }}} */
 250         /* {{{ fs9922 */
 251         DMM(
 252                 "uni-t-ut61b", fs9922,
 253                 "UNI-T", "UT61B", 2400,
 254                 FS9922_PACKET_SIZE,
 255                 sr_fs9922_packet_valid, sr_fs9922_parse,
 256                 NULL
 257         ),
 258         DMM(
 259                 "uni-t-ut61c", fs9922,
 260                 "UNI-T", "UT61C", 2400,
 261                 FS9922_PACKET_SIZE,
 262                 sr_fs9922_packet_valid, sr_fs9922_parse,
 263                 NULL
 264         ),
 265         DMM(
 266                 "uni-t-ut61d", fs9922,
 267                 "UNI-T", "UT61D", 2400,
 268                 FS9922_PACKET_SIZE,
 269                 sr_fs9922_packet_valid, sr_fs9922_parse,
 270                 NULL
 271         ),
 272         DMM(
 273                 "voltcraft-vc830", fs9922,
 274                 /*
 275                  * Note: The VC830 doesn't set the 'volt' and 'diode' bits of
 276                  * the FS9922 protocol. Instead, it only sets the user-defined
 277                  * bit "z1" to indicate "diode mode" and "voltage".
 278                  */
 279                 "Voltcraft", "VC-830", 2400,
 280                 FS9922_PACKET_SIZE,
 281                 sr_fs9922_packet_valid, sr_fs9922_parse,
 282                 &sr_fs9922_z1_diode
 283         ),
 284         /* }}} */
 285         /* {{{ ut372 */
 286         DMM(
 287                 "uni-t-ut372", ut372,
 288                 "UNI-T", "UT372", 2400,
 289                 UT372_PACKET_SIZE,
 290                 sr_ut372_packet_valid, sr_ut372_parse,
 291                 NULL
 292         ),
 293         /* }}} */
 294         /* {{{ ut71x */
 295         DMM(
 296                 "tenma-72-7730", ut71x,
 297                 "Tenma", "72-7730", 2400,
 298                 UT71X_PACKET_SIZE,
 299                 sr_ut71x_packet_valid, sr_ut71x_parse, NULL
 300         ),
 301         DMM(
 302                 "tenma-72-7732", ut71x,
 303                 "Tenma", "72-7732", 2400,
 304                 UT71X_PACKET_SIZE,
 305                 sr_ut71x_packet_valid, sr_ut71x_parse, NULL
 306         ),
 307         DMM(
 308                 "tenma-72-9380a", ut71x,
 309                 "Tenma", "72-9380A", 2400,
 310                 UT71X_PACKET_SIZE,
 311                 sr_ut71x_packet_valid, sr_ut71x_parse, NULL
 312         ),
 313         DMM(
 314                 "uni-t-ut71a", ut71x,
 315                 "UNI-T", "UT71A", 2400, UT71X_PACKET_SIZE,
 316                 sr_ut71x_packet_valid, sr_ut71x_parse, NULL
 317         ),
 318         DMM(
 319                 "uni-t-ut71b", ut71x,
 320                 "UNI-T", "UT71B", 2400, UT71X_PACKET_SIZE,
 321                 sr_ut71x_packet_valid, sr_ut71x_parse, NULL
 322         ),
 323         DMM(
 324                 "uni-t-ut71c", ut71x,
 325                 "UNI-T", "UT71C", 2400, UT71X_PACKET_SIZE,
 326                 sr_ut71x_packet_valid, sr_ut71x_parse, NULL
 327         ),
 328         DMM(
 329                 "uni-t-ut71d", ut71x,
 330                 "UNI-T", "UT71D", 2400, UT71X_PACKET_SIZE,
 331                 sr_ut71x_packet_valid, sr_ut71x_parse, NULL
 332         ),
 333         DMM(
 334                 "uni-t-ut71e", ut71x,
 335                 "UNI-T", "UT71E", 2400, UT71X_PACKET_SIZE,
 336                 sr_ut71x_packet_valid, sr_ut71x_parse, NULL
 337         ),
 338         DMM(
 339                 "uni-t-ut804", ut71x,
 340                 "UNI-T", "UT804", 2400, UT71X_PACKET_SIZE,
 341                 sr_ut71x_packet_valid, sr_ut71x_parse, NULL
 342         ),
 343         DMM(
 344                 "voltcraft-vc920", ut71x,
 345                 "Voltcraft", "VC-920", 2400, UT71X_PACKET_SIZE,
 346                 sr_ut71x_packet_valid, sr_ut71x_parse, NULL
 347         ),
 348         DMM(
 349                 "voltcraft-vc940", ut71x,
 350                 "Voltcraft", "VC-940", 2400, UT71X_PACKET_SIZE,
 351                 sr_ut71x_packet_valid, sr_ut71x_parse, NULL
 352         ),
 353         DMM(
 354                 "voltcraft-vc960", ut71x,
 355                 "Voltcraft", "VC-960", 2400, UT71X_PACKET_SIZE,
 356                 sr_ut71x_packet_valid, sr_ut71x_parse, NULL
 357         ),
 358         /* }}} */
 359         /* {{{ vc870 */
 360         DMM(
 361                 "voltcraft-vc870", vc870,
 362                 "Voltcraft", "VC-870", 9600, VC870_PACKET_SIZE,
 363                 sr_vc870_packet_valid, sr_vc870_parse, NULL
 364         ),
 365         /* }}} */
 366 );