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 <stdlib.h>
  22 #include <string.h>
  23 #include "libsigrok.h"
  24 #include "libsigrok-internal.h"
  25 #include "protocol.h"
  26
  27 #define UNI_T_UT_D04_NEW "1a86.e008"
  28
  29 static const int32_t hwopts[] = {
  30         SR_CONF_CONN,
  31 };
  32
  33 static const int32_t hwcaps[] = {
  34         SR_CONF_MULTIMETER,
  35         SR_CONF_LIMIT_SAMPLES,
  36         SR_CONF_LIMIT_MSEC,
  37         SR_CONF_CONTINUOUS,
  38 };
  39
  40 SR_PRIV struct sr_dev_driver tecpel_dmm_8060_driver_info;
  41 SR_PRIV struct sr_dev_driver tecpel_dmm_8061_driver_info;
  42 SR_PRIV struct sr_dev_driver uni_t_ut60a_driver_info;
  43 SR_PRIV struct sr_dev_driver uni_t_ut60e_driver_info;
  44 SR_PRIV struct sr_dev_driver uni_t_ut61d_driver_info;
  45 SR_PRIV struct sr_dev_driver uni_t_ut61e_driver_info;
  46 SR_PRIV struct sr_dev_driver voltcraft_vc820_driver_info;
  47 SR_PRIV struct sr_dev_driver voltcraft_vc830_driver_info;
  48 SR_PRIV struct sr_dev_driver voltcraft_vc840_driver_info;
  49
  50 SR_PRIV struct dmm_info udmms[] = {
  51         {
  52                 "Tecpel", "DMM-8060", 2400,
  53                 FS9721_PACKET_SIZE, NULL,
  54                 sr_fs9721_packet_valid, sr_fs9721_parse,
  55                 NULL,
  56                 &tecpel_dmm_8060_driver_info, receive_data_TECPEL_DMM_8060,
  57         },
  58         {
  59                 "Tecpel", "DMM-8061", 2400,
  60                 FS9721_PACKET_SIZE, NULL,
  61                 sr_fs9721_packet_valid, sr_fs9721_parse,
  62                 sr_fs9721_00_temp_c,
  63                 &tecpel_dmm_8061_driver_info, receive_data_TECPEL_DMM_8061,
  64         },
  65         {
  66                 "UNI-T", "UT60A", 2400,
  67                 FS9721_PACKET_SIZE, NULL,
  68                 sr_fs9721_packet_valid, sr_fs9721_parse,
  69                 NULL,
  70                 &uni_t_ut60a_driver_info, receive_data_UNI_T_UT60A,
  71         },
  72         {
  73                 "UNI-T", "UT60E", 2400,
  74                 FS9721_PACKET_SIZE, NULL,
  75                 sr_fs9721_packet_valid, sr_fs9721_parse,
  76                 sr_fs9721_00_temp_c,
  77                 &uni_t_ut60e_driver_info, receive_data_UNI_T_UT60E,
  78         },
  79         {
  80                 "UNI-T", "UT61D", 2400,
  81                 FS9922_PACKET_SIZE, NULL,
  82                 sr_fs9922_packet_valid, sr_fs9922_parse,
  83                 NULL,
  84                 &uni_t_ut61d_driver_info, receive_data_UNI_T_UT61D,
  85         },
  86         {
  87                 "UNI-T", "UT61E", 19230,
  88                 ES51922_PACKET_SIZE, NULL,
  89                 sr_es51922_packet_valid, sr_es51922_parse,
  90                 NULL,
  91                 &uni_t_ut61e_driver_info, receive_data_UNI_T_UT61E,
  92         },
  93         {
  94                 "Voltcraft", "VC-820", 2400,
  95                 FS9721_PACKET_SIZE, NULL,
  96                 sr_fs9721_packet_valid, sr_fs9721_parse,
  97                 NULL,
  98                 &voltcraft_vc820_driver_info, receive_data_VOLTCRAFT_VC820,
  99         },
 100         {
 101                 "Voltcraft", "VC-830", 2400,
 102                 FS9922_PACKET_SIZE, NULL,
 103                 sr_fs9922_packet_valid, sr_fs9922_parse,
 104                 NULL,
 105                 &voltcraft_vc830_driver_info, receive_data_VOLTCRAFT_VC830,
 106         },
 107         {
 108                 "Voltcraft", "VC-840", 2400,
 109                 FS9721_PACKET_SIZE, NULL,
 110                 sr_fs9721_packet_valid, sr_fs9721_parse,
 111                 sr_fs9721_00_temp_c,
 112                 &voltcraft_vc840_driver_info, receive_data_VOLTCRAFT_VC840,
 113         },
 114 };
 115
 116 static int dev_clear(int dmm)
 117 {
 118         return std_dev_clear(udmms[dmm].di, NULL);
 119 }
 120
 121 static int init(struct sr_context *sr_ctx, int dmm)
 122 {
 123         sr_dbg("Selected '%s' subdriver.", udmms[dmm].di->name);
 124
 125         return std_init(sr_ctx, udmms[dmm].di, LOG_PREFIX);
 126 }
 127
 128 static GSList *scan(GSList *options, int dmm)
 129 {
 130         GSList *usb_devices, *devices, *l;
 131         struct sr_dev_inst *sdi;
 132         struct dev_context *devc;
 133         struct drv_context *drvc;
 134         struct sr_usb_dev_inst *usb;
 135         struct sr_config *src;
 136         struct sr_probe *probe;
 137         const char *conn;
 138
 139         drvc = udmms[dmm].di->priv;
 140
 141         conn = NULL;
 142         for (l = options; l; l = l->next) {
 143                 src = l->data;
 144                 switch (src->key) {
 145                 case SR_CONF_CONN:
 146                         conn = g_variant_get_string(src->data, NULL);
 147                         break;
 148                 }
 149         }
 150         if (!conn)
 151                 conn = UNI_T_UT_D04_NEW;
 152
 153         devices = NULL;
 154         if (!(usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn))) {
 155                 g_slist_free_full(usb_devices, g_free);
 156                 return NULL;
 157         }
 158
 159         for (l = usb_devices; l; l = l->next) {
 160                 usb = l->data;
 161
 162                 if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
 163                         sr_err("Device context malloc failed.");
 164                         return NULL;
 165                 }
 166
 167                 devc->first_run = TRUE;
 168
 169                 if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE,
 170                                 udmms[dmm].vendor, udmms[dmm].device, NULL))) {
 171                         sr_err("sr_dev_inst_new returned NULL.");
 172                         return NULL;
 173                 }
 174                 sdi->priv = devc;
 175                 sdi->driver = udmms[dmm].di;
 176                 if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
 177                         return NULL;
 178                 sdi->probes = g_slist_append(sdi->probes, probe);
 179
 180                 sdi->inst_type = SR_INST_USB;
 181                 sdi->conn = usb;
 182
 183                 drvc->instances = g_slist_append(drvc->instances, sdi);
 184                 devices = g_slist_append(devices, sdi);
 185         }
 186
 187         return devices;
 188 }
 189
 190 static GSList *dev_list(int dmm)
 191 {
 192         return ((struct drv_context *)(udmms[dmm].di->priv))->instances;
 193 }
 194
 195 static int dev_open(struct sr_dev_inst *sdi, int dmm)
 196 {
 197         struct drv_context *drvc;
 198         struct sr_usb_dev_inst *usb;
 199         int ret;
 200
 201         drvc = udmms[dmm].di->priv;
 202         usb = sdi->conn;
 203
 204         if ((ret = sr_usb_open(drvc->sr_ctx->libusb_ctx, usb)) == SR_OK)
 205                 sdi->status = SR_ST_ACTIVE;
 206
 207         return ret;
 208 }
 209
 210 static int dev_close(struct sr_dev_inst *sdi)
 211 {
 212         (void)sdi;
 213
 214         /* TODO */
 215
 216         sdi->status = SR_ST_INACTIVE;
 217
 218         return SR_OK;
 219 }
 220
 221 static int cleanup(int dmm)
 222 {
 223         return dev_clear(dmm);
 224 }
 225
 226 static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi)
 227 {
 228         struct dev_context *devc;
 229
 230         devc = sdi->priv;
 231
 232         switch (id) {
 233         case SR_CONF_LIMIT_MSEC:
 234                 if (g_variant_get_uint64(data) == 0) {
 235                         sr_err("Time limit cannot be 0.");
 236                         return SR_ERR;
 237                 }
 238                 devc->limit_msec = g_variant_get_uint64(data);
 239                 sr_dbg("Setting time limit to %" PRIu64 "ms.",
 240                        devc->limit_msec);
 241                 break;
 242         case SR_CONF_LIMIT_SAMPLES:
 243                 if (g_variant_get_uint64(data) == 0) {
 244                         sr_err("Sample limit cannot be 0.");
 245                         return SR_ERR;
 246                 }
 247                 devc->limit_samples = g_variant_get_uint64(data);
 248                 sr_dbg("Setting sample limit to %" PRIu64 ".",
 249                        devc->limit_samples);
 250                 break;
 251         default:
 252                 return SR_ERR_NA;
 253         }
 254
 255         return SR_OK;
 256 }
 257
 258 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi)
 259 {
 260         (void)sdi;
 261
 262         switch (key) {
 263         case SR_CONF_SCAN_OPTIONS:
 264                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
 265                                 hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
 266                 break;
 267         case SR_CONF_DEVICE_OPTIONS:
 268                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
 269                                 hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
 270                 break;
 271         default:
 272                 return SR_ERR_NA;
 273         }
 274
 275         return SR_OK;
 276 }
 277
 278 static int dev_acquisition_start(const struct sr_dev_inst *sdi,
 279                                     void *cb_data, int dmm)
 280 {
 281         struct dev_context *devc;
 282
 283         devc = sdi->priv;
 284
 285         devc->cb_data = cb_data;
 286
 287         devc->starttime = g_get_monotonic_time();
 288
 289         /* Send header packet to the session bus. */
 290         std_session_send_df_header(cb_data, LOG_PREFIX);
 291
 292         sr_source_add(0, 0, 10 /* poll_timeout */,
 293                       udmms[dmm].receive_data, (void *)sdi);
 294
 295         return SR_OK;
 296 }
 297
 298 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 299 {
 300         struct sr_datafeed_packet packet;
 301
 302         (void)sdi;
 303
 304         sr_dbg("Stopping acquisition.");
 305
 306         /* Send end packet to the session bus. */
 307         sr_dbg("Sending SR_DF_END.");
 308         packet.type = SR_DF_END;
 309         sr_session_send(cb_data, &packet);
 310
 311         /* TODO? */
 312         sr_source_remove(0);
 313
 314         return SR_OK;
 315 }
 316
 317 /* Driver-specific API function wrappers */
 318 #define HW_INIT(X) \
 319 static int init_##X(struct sr_context *sr_ctx) { return init(sr_ctx, X); }
 320 #define HW_CLEANUP(X) \
 321 static int cleanup_##X(void) { return cleanup(X); }
 322 #define HW_SCAN(X) \
 323 static GSList *scan_##X(GSList *options) { return scan(options, X); }
 324 #define HW_DEV_LIST(X) \
 325 static GSList *dev_list_##X(void) { return dev_list(X); }
 326 #define HW_DEV_CLEAR(X) \
 327 static int dev_clear_##X(void) { return dev_clear(X); }
 328 #define HW_DEV_ACQUISITION_START(X) \
 329 static int dev_acquisition_start_##X(const struct sr_dev_inst *sdi, \
 330 void *cb_data) { return dev_acquisition_start(sdi, cb_data, X); }
 331 #define HW_DEV_OPEN(X) \
 332 static int dev_open_##X(struct sr_dev_inst *sdi) { return dev_open(sdi, X); }
 333
 334 /* Driver structs and API function wrappers */
 335 #define DRV(ID, ID_UPPER, NAME, LONGNAME) \
 336 HW_INIT(ID_UPPER) \
 337 HW_CLEANUP(ID_UPPER) \
 338 HW_SCAN(ID_UPPER) \
 339 HW_DEV_LIST(ID_UPPER) \
 340 HW_DEV_CLEAR(ID_UPPER) \
 341 HW_DEV_ACQUISITION_START(ID_UPPER) \
 342 HW_DEV_OPEN(ID_UPPER) \
 343 SR_PRIV struct sr_dev_driver ID##_driver_info = { \
 344         .name = NAME, \
 345         .longname = LONGNAME, \
 346         .api_version = 1, \
 347         .init = init_##ID_UPPER, \
 348         .cleanup = cleanup_##ID_UPPER, \
 349         .scan = scan_##ID_UPPER, \
 350         .dev_list = dev_list_##ID_UPPER, \
 351         .dev_clear = dev_clear_##ID_UPPER, \
 352         .config_get = NULL, \
 353         .config_set = config_set, \
 354         .config_list = config_list, \
 355         .dev_open = dev_open_##ID_UPPER, \
 356         .dev_close = dev_close, \
 357         .dev_acquisition_start = dev_acquisition_start_##ID_UPPER, \
 358         .dev_acquisition_stop = dev_acquisition_stop, \
 359         .priv = NULL, \
 360 };
 361
 362 DRV(tecpel_dmm_8060, TECPEL_DMM_8060, "tecpel-dmm-8060", "Tecpel DMM-8060")
 363 DRV(tecpel_dmm_8061, TECPEL_DMM_8061, "tecpel-dmm-8061", "Tecpel DMM-8061")
 364 DRV(uni_t_ut60a, UNI_T_UT60A, "uni-t-ut60a", "UNI-T UT60A")
 365 DRV(uni_t_ut60e, UNI_T_UT60E, "uni-t-ut60e", "UNI-T UT60E")
 366 DRV(uni_t_ut61d, UNI_T_UT61D, "uni-t-ut61d", "UNI-T UT61D")
 367 DRV(uni_t_ut61e, UNI_T_UT61E, "uni-t-ut61e", "UNI-T UT61E")
 368 DRV(voltcraft_vc820, VOLTCRAFT_VC820, "voltcraft-vc820", "Voltcraft VC-820")
 369 DRV(voltcraft_vc830, VOLTCRAFT_VC830, "voltcraft-vc830", "Voltcraft VC-830")
 370 DRV(voltcraft_vc840, VOLTCRAFT_VC840, "voltcraft-vc840", "Voltcraft VC-840")