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, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  19  */
  20
  21 #include <config.h>
  22 #include <stdlib.h>
  23 #include <string.h>
  24 #include <libsigrok/libsigrok.h>
  25 #include "libsigrok-internal.h"
  26 #include "protocol.h"
  27
  28 #define UNI_T_UT_D04_NEW "1a86.e008"
  29
  30 static const uint32_t scanopts[] = {
  31         SR_CONF_CONN,
  32 };
  33
  34 static const uint32_t devopts[] = {
  35         SR_CONF_MULTIMETER,
  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                 sdi->driver = di;
  91                 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
  92                 sdi->inst_type = SR_INST_USB;
  93                 sdi->conn = usb;
  94                 drvc->instances = g_slist_append(drvc->instances, sdi);
  95                 devices = g_slist_append(devices, sdi);
  96         }
  97
  98         return devices;
  99 }
 100
 101 static int dev_open(struct sr_dev_inst *sdi)
 102 {
 103         struct sr_dev_driver *di;
 104         struct drv_context *drvc;
 105         struct sr_usb_dev_inst *usb;
 106         int ret;
 107
 108         di = sdi->driver;
 109         drvc = di->context;
 110         usb = sdi->conn;
 111
 112         if ((ret = sr_usb_open(drvc->sr_ctx->libusb_ctx, usb)) == SR_OK)
 113                 sdi->status = SR_ST_ACTIVE;
 114
 115         return ret;
 116 }
 117
 118 static int dev_close(struct sr_dev_inst *sdi)
 119 {
 120         /* TODO */
 121
 122         sdi->status = SR_ST_INACTIVE;
 123
 124         return SR_OK;
 125 }
 126
 127 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 128                 const struct sr_channel_group *cg)
 129 {
 130         struct dev_context *devc;
 131
 132         (void)cg;
 133
 134         devc = sdi->priv;
 135
 136         return sr_sw_limits_config_set(&devc->limits, key, data);
 137 }
 138
 139 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 140                 const struct sr_channel_group *cg)
 141 {
 142         (void)sdi;
 143         (void)cg;
 144
 145         switch (key) {
 146         case SR_CONF_SCAN_OPTIONS:
 147                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 148                                 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 149                 break;
 150         case SR_CONF_DEVICE_OPTIONS:
 151                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 152                                 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 153                 break;
 154         default:
 155                 return SR_ERR_NA;
 156         }
 157
 158         return SR_OK;
 159 }
 160
 161 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 162 {
 163         struct dev_context *devc;
 164
 165         devc = sdi->priv;
 166
 167         sr_sw_limits_acquisition_start(&devc->limits);
 168
 169         std_session_send_df_header(sdi, LOG_PREFIX);
 170
 171         sr_session_source_add(sdi->session, -1, 0, 10 /* poll_timeout */,
 172                       uni_t_dmm_receive_data, (void *)sdi);
 173
 174         return SR_OK;
 175 }
 176
 177 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 178 {
 179         sr_dbg("Stopping acquisition.");
 180         std_session_send_df_end(sdi, LOG_PREFIX);
 181         sr_session_source_remove(sdi->session, -1);
 182
 183         return SR_OK;
 184 }
 185
 186 #define DMM(ID, CHIPSET, VENDOR, MODEL, BAUDRATE, PACKETSIZE, \
 187                         VALID, PARSE, DETAILS) \
 188     &((struct dmm_info) { \
 189                 { \
 190                         .name = ID, \
 191                         .longname = VENDOR " " MODEL, \
 192                         .api_version = 1, \
 193                         .init = std_init, \
 194                         .cleanup = std_cleanup, \
 195                         .scan = scan, \
 196                         .dev_list = std_dev_list, \
 197                         .config_get = NULL, \
 198                         .config_set = config_set, \
 199                         .config_list = config_list, \
 200                         .dev_open = dev_open, \
 201                         .dev_close = dev_close, \
 202                         .dev_acquisition_start = dev_acquisition_start, \
 203                         .dev_acquisition_stop = dev_acquisition_stop, \
 204                         .context = NULL, \
 205                 }, \
 206                 VENDOR, MODEL, BAUDRATE, PACKETSIZE, \
 207                 VALID, PARSE, DETAILS, sizeof(struct CHIPSET##_info) \
 208         }).di
 209
 210 SR_REGISTER_DEV_DRIVER_LIST(uni_t_dmm_drivers,
 211         DMM(
 212                 "tecpel-dmm-8061", fs9721,
 213                 "Tecpel", "DMM-8061", 2400,
 214                 FS9721_PACKET_SIZE,
 215                 sr_fs9721_packet_valid, sr_fs9721_parse,
 216                 sr_fs9721_00_temp_c
 217         ),
 218         DMM(
 219                 "uni-t-ut372", ut372,
 220                 "UNI-T", "UT372", 2400,
 221                 UT372_PACKET_SIZE,
 222                 sr_ut372_packet_valid, sr_ut372_parse,
 223                 NULL
 224         ),
 225         DMM(
 226                 "uni-t-ut60a", fs9721,
 227                 "UNI-T", "UT60A", 2400,
 228                 FS9721_PACKET_SIZE,
 229                 sr_fs9721_packet_valid, sr_fs9721_parse,
 230                 NULL
 231         ),
 232         DMM(
 233                 "uni-t-ut60e", fs9721,
 234                 "UNI-T", "UT60E", 2400,
 235                 FS9721_PACKET_SIZE,
 236                 sr_fs9721_packet_valid, sr_fs9721_parse,
 237                 sr_fs9721_00_temp_c
 238         ),
 239         DMM(
 240                 "uni-t-ut60g", es519xx,
 241                 /* The baudrate is actually 19230, see "Note 1" below. */
 242                 "UNI-T", "UT60G", 19200,
 243                 ES519XX_11B_PACKET_SIZE,
 244                 sr_es519xx_19200_11b_packet_valid, sr_es519xx_19200_11b_parse,
 245                 NULL
 246         ),
 247         DMM(
 248                 "uni-t-ut61b", fs9922,
 249                 "UNI-T", "UT61B", 2400,
 250                 FS9922_PACKET_SIZE,
 251                 sr_fs9922_packet_valid, sr_fs9922_parse,
 252                 NULL
 253         ),
 254         DMM(
 255                 "uni-t-ut61c", fs9922,
 256                 "UNI-T", "UT61C", 2400,
 257                 FS9922_PACKET_SIZE,
 258                 sr_fs9922_packet_valid, sr_fs9922_parse,
 259                 NULL
 260         ),
 261         DMM(
 262                 "uni-t-ut61d", fs9922,
 263                 "UNI-T", "UT61D", 2400,
 264                 FS9922_PACKET_SIZE,
 265                 sr_fs9922_packet_valid, sr_fs9922_parse,
 266                 NULL
 267         ),
 268         DMM(
 269                 "uni-t-ut61e", es519xx,
 270                 /* The baudrate is actually 19230, see "Note 1" below. */
 271                 "UNI-T", "UT61E", 19200,
 272                 ES519XX_14B_PACKET_SIZE,
 273                 sr_es519xx_19200_14b_packet_valid, sr_es519xx_19200_14b_parse,
 274                 NULL
 275         ),
 276         DMM(
 277                 "uni-t-ut71a", ut71x,
 278                 "UNI-T", "UT71A", 2400, UT71X_PACKET_SIZE,
 279                 sr_ut71x_packet_valid, sr_ut71x_parse, NULL
 280         ),
 281         DMM(
 282                 "uni-t-ut71b", ut71x,
 283                 "UNI-T", "UT71B", 2400, UT71X_PACKET_SIZE,
 284                 sr_ut71x_packet_valid, sr_ut71x_parse, NULL
 285         ),
 286         DMM(
 287                 "uni-t-ut71c", ut71x,
 288                 "UNI-T", "UT71C", 2400, UT71X_PACKET_SIZE,
 289                 sr_ut71x_packet_valid, sr_ut71x_parse, NULL
 290         ),
 291         DMM(
 292                 "uni-t-ut71d", ut71x,
 293                 "UNI-T", "UT71D", 2400, UT71X_PACKET_SIZE,
 294                 sr_ut71x_packet_valid, sr_ut71x_parse, NULL
 295         ),
 296         DMM(
 297                 "uni-t-ut71e", ut71x,
 298                 "UNI-T", "UT71E", 2400, UT71X_PACKET_SIZE,
 299                 sr_ut71x_packet_valid, sr_ut71x_parse, NULL
 300         ),
 301         DMM(
 302                 "voltcraft-vc820", fs9721,
 303                 "Voltcraft", "VC-820", 2400,
 304                 FS9721_PACKET_SIZE,
 305                 sr_fs9721_packet_valid, sr_fs9721_parse,
 306                 NULL
 307         ),
 308         DMM(
 309                 "voltcraft-vc830", fs9922,
 310                 /*
 311                  * Note: The VC830 doesn't set the 'volt' and 'diode' bits of
 312                  * the FS9922 protocol. Instead, it only sets the user-defined
 313                  * bit "z1" to indicate "diode mode" and "voltage".
 314                  */
 315                 "Voltcraft", "VC-830", 2400,
 316                 FS9922_PACKET_SIZE,
 317                 sr_fs9922_packet_valid, sr_fs9922_parse,
 318                 &sr_fs9922_z1_diode
 319         ),
 320         DMM(
 321                 "voltcraft-vc840", fs9721,
 322                 "Voltcraft", "VC-840", 2400,
 323                 FS9721_PACKET_SIZE,
 324                 sr_fs9721_packet_valid, sr_fs9721_parse,
 325                 sr_fs9721_00_temp_c
 326         ),
 327         DMM(
 328                 "voltcraft-vc870", vc870,
 329                 "Voltcraft", "VC-870", 9600, VC870_PACKET_SIZE,
 330                 sr_vc870_packet_valid, sr_vc870_parse, NULL
 331         ),
 332         DMM(
 333                 "voltcraft-vc920", ut71x,
 334                 "Voltcraft", "VC-920", 2400, UT71X_PACKET_SIZE,
 335                 sr_ut71x_packet_valid, sr_ut71x_parse, NULL
 336         ),
 337         DMM(
 338                 "voltcraft-vc940", ut71x,
 339                 "Voltcraft", "VC-940", 2400, UT71X_PACKET_SIZE,
 340                 sr_ut71x_packet_valid, sr_ut71x_parse, NULL
 341         ),
 342         DMM(
 343                 "voltcraft-vc960", ut71x,
 344                 "Voltcraft", "VC-960", 2400, UT71X_PACKET_SIZE,
 345                 sr_ut71x_packet_valid, sr_ut71x_parse, NULL
 346         ),
 347         DMM(
 348                 "tenma-72-7730", ut71x,
 349                 "Tenma", "72-7730", 2400,
 350                 UT71X_PACKET_SIZE,
 351                 sr_ut71x_packet_valid, sr_ut71x_parse, NULL
 352         ),
 353         DMM(
 354                 "tenma-72-7732", ut71x,
 355                 "Tenma", "72-7732", 2400,
 356                 UT71X_PACKET_SIZE,
 357                 sr_ut71x_packet_valid, sr_ut71x_parse, NULL
 358         ),
 359         DMM(
 360                 "tenma-72-9380a", ut71x,
 361                 "Tenma", "72-9380A", 2400,
 362                 UT71X_PACKET_SIZE,
 363                 sr_ut71x_packet_valid, sr_ut71x_parse, NULL
 364         ),
 365         DMM(
 366                 "tenma-72-7745", es519xx,
 367                 "Tenma", "72-7745", 2400,
 368                 FS9721_PACKET_SIZE,
 369                 sr_fs9721_packet_valid, sr_fs9721_parse,
 370                 sr_fs9721_00_temp_c
 371         ),
 372         DMM(
 373                 "tenma-72-7750", es519xx,
 374                 /* The baudrate is actually 19230, see "Note 1" below. */
 375                 "Tenma", "72-7750", 19200,
 376                 ES519XX_11B_PACKET_SIZE,
 377                 sr_es519xx_19200_11b_packet_valid, sr_es519xx_19200_11b_parse,
 378                 NULL
 379         ),
 380 );