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