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