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