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