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