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