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