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