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