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