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