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