hardware/uni-t-dmm/api.c

   1 /*
   2  * This file is part of the sigrok project.
   3  *
   4  * Copyright (C) 2012 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 int hwopts[] = {
  30         SR_CONF_CONN,
  31         0,
  32 };
  33
  34 static const int hwcaps[] = {
  35         SR_CONF_MULTIMETER,
  36         SR_CONF_LIMIT_SAMPLES,
  37         SR_CONF_LIMIT_MSEC,
  38         SR_CONF_CONTINUOUS,
  39         0,
  40 };
  41
  42 SR_PRIV struct sr_dev_driver uni_t_ut61d_driver_info;
  43 SR_PRIV struct sr_dev_driver voltcraft_vc820_driver_info;
  44
  45 static struct sr_dev_driver *di_ut61d = &uni_t_ut61d_driver_info;
  46 static struct sr_dev_driver *di_vc820 = &voltcraft_vc820_driver_info;
  47
  48 /* After hw_init() this will point to a device-specific entry (see above). */
  49 static struct sr_dev_driver *di = NULL;
  50
  51 static int clear_instances(void)
  52 {
  53         /* TODO: Use common code later. */
  54
  55         return SR_OK;
  56 }
  57
  58 static int hw_init(struct sr_context *sr_ctx, int dmm)
  59 {
  60         if (dmm == UNI_T_UT61D)
  61                 di = di_ut61d;
  62         else if (dmm == VOLTCRAFT_VC820)
  63                 di = di_vc820;
  64         sr_dbg("Selected '%s' subdriver.", di->name);
  65
  66         return std_hw_init(sr_ctx, di, DRIVER_LOG_DOMAIN);
  67 }
  68
  69 static int hw_init_ut61d(struct sr_context *sr_ctx)
  70 {
  71         return hw_init(sr_ctx, UNI_T_UT61D);
  72 }
  73
  74 static int hw_init_vc820(struct sr_context *sr_ctx)
  75 {
  76         return hw_init(sr_ctx, VOLTCRAFT_VC820);
  77 }
  78
  79 static GSList *hw_scan(GSList *options)
  80 {
  81         GSList *usb_devices, *devices, *l;
  82         struct sr_dev_inst *sdi;
  83         struct dev_context *devc;
  84         struct drv_context *drvc;
  85         struct sr_usb_dev_inst *usb;
  86         struct sr_config *src;
  87         struct sr_probe *probe;
  88         const char *conn;
  89
  90         (void)options;
  91
  92         drvc = di->priv;
  93
  94         /* USB scan is always authoritative. */
  95         clear_instances();
  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 = src->value;
 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                 if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE,
 124                                 di->longname, NULL, NULL))) {
 125                         sr_err("sr_dev_inst_new returned NULL.");
 126                         return NULL;
 127                 }
 128                 sdi->priv = devc;
 129                 sdi->driver = di;
 130                 if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
 131                         return NULL;
 132                 sdi->probes = g_slist_append(sdi->probes, probe);
 133
 134                 devc->usb = usb;
 135
 136                 drvc->instances = g_slist_append(drvc->instances, sdi);
 137                 devices = g_slist_append(devices, sdi);
 138         }
 139
 140         return devices;
 141 }
 142
 143 static GSList *hw_dev_list(void)
 144 {
 145         return ((struct drv_context *)(di->priv))->instances;
 146 }
 147
 148 static int hw_dev_open(struct sr_dev_inst *sdi)
 149 {
 150         struct drv_context *drvc;
 151         struct dev_context *devc;
 152
 153         drvc = di->priv;
 154         devc = sdi->priv;
 155
 156         return sr_usb_open(drvc->sr_ctx->libusb_ctx, devc->usb);
 157 }
 158
 159 static int hw_dev_close(struct sr_dev_inst *sdi)
 160 {
 161         (void)sdi;
 162
 163         /* TODO */
 164
 165         return SR_OK;
 166 }
 167
 168 static int hw_cleanup(void)
 169 {
 170         clear_instances();
 171
 172         return SR_OK;
 173 }
 174
 175 static int config_set(int id, const void *value, const struct sr_dev_inst *sdi)
 176 {
 177         struct dev_context *devc;
 178
 179         devc = sdi->priv;
 180
 181         switch (id) {
 182         case SR_CONF_LIMIT_MSEC:
 183                 /* TODO: Not yet implemented. */
 184                 if (*(const uint64_t *)value == 0) {
 185                         sr_err("Time limit cannot be 0.");
 186                         return SR_ERR;
 187                 }
 188                 devc->limit_msec = *(const uint64_t *)value;
 189                 sr_dbg("Setting time limit to %" PRIu64 "ms.",
 190                        devc->limit_msec);
 191                 break;
 192         case SR_CONF_LIMIT_SAMPLES:
 193                 if (*(const uint64_t *)value == 0) {
 194                         sr_err("Sample limit cannot be 0.");
 195                         return SR_ERR;
 196                 }
 197                 devc->limit_samples = *(const uint64_t *)value;
 198                 sr_dbg("Setting sample limit to %" PRIu64 ".",
 199                        devc->limit_samples);
 200                 break;
 201         default:
 202                 sr_err("Unknown capability: %d.", id);
 203                 return SR_ERR;
 204                 break;
 205         }
 206
 207         return SR_OK;
 208 }
 209
 210 static int config_list(int key, const void **data, const struct sr_dev_inst *sdi)
 211 {
 212
 213         (void)sdi;
 214
 215         switch (key) {
 216         case SR_CONF_SCAN_OPTIONS:
 217                 *data = hwopts;
 218                 break;
 219         case SR_CONF_DEVICE_OPTIONS:
 220                 *data = hwcaps;
 221                 break;
 222         default:
 223                 return SR_ERR_ARG;
 224         }
 225
 226         return SR_OK;
 227 }
 228
 229 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
 230                                     void *cb_data)
 231 {
 232         struct dev_context *devc;
 233
 234         devc = sdi->priv;
 235
 236         devc->cb_data = cb_data;
 237
 238         /* Send header packet to the session bus. */
 239         std_session_send_df_header(cb_data, DRIVER_LOG_DOMAIN);
 240
 241         if (!strcmp(di->name, "uni-t-ut61d")) {
 242                 sr_source_add(0, 0, 10 /* poll_timeout */,
 243                               uni_t_ut61d_receive_data, (void *)sdi);
 244         } else if (!strcmp(di->name, "voltcraft-vc820")) {
 245                 sr_source_add(0, 0, 10 /* poll_timeout */,
 246                               voltcraft_vc820_receive_data, (void *)sdi);
 247         }
 248
 249         return SR_OK;
 250 }
 251
 252 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 253 {
 254         struct sr_datafeed_packet packet;
 255
 256         (void)sdi;
 257
 258         sr_dbg("Stopping acquisition.");
 259
 260         /* Send end packet to the session bus. */
 261         sr_dbg("Sending SR_DF_END.");
 262         packet.type = SR_DF_END;
 263         sr_session_send(cb_data, &packet);
 264
 265         /* TODO? */
 266         sr_source_remove(0);
 267
 268         return SR_OK;
 269 }
 270
 271 SR_PRIV struct sr_dev_driver uni_t_ut61d_driver_info = {
 272         .name = "uni-t-ut61d",
 273         .longname = "UNI-T UT61D",
 274         .api_version = 1,
 275         .init = hw_init_ut61d,
 276         .cleanup = hw_cleanup,
 277         .scan = hw_scan,
 278         .dev_list = hw_dev_list,
 279         .dev_clear = clear_instances,
 280         .config_get = NULL,
 281         .config_set = config_set,
 282         .config_list = config_list,
 283         .dev_open = hw_dev_open,
 284         .dev_close = hw_dev_close,
 285         .dev_acquisition_start = hw_dev_acquisition_start,
 286         .dev_acquisition_stop = hw_dev_acquisition_stop,
 287         .priv = NULL,
 288 };
 289
 290 SR_PRIV struct sr_dev_driver voltcraft_vc820_driver_info = {
 291         .name = "voltcraft-vc820",
 292         .longname = "Voltcraft VC-820",
 293         .api_version = 1,
 294         .init = hw_init_vc820,
 295         .cleanup = hw_cleanup,
 296         .scan = hw_scan,
 297         .dev_list = hw_dev_list,
 298         .dev_clear = clear_instances,
 299         .config_get = NULL,
 300         .config_set = config_set,
 301         .config_list = config_list,
 302         .dev_open = hw_dev_open,
 303         .dev_close = hw_dev_close,
 304         .dev_acquisition_start = hw_dev_acquisition_start,
 305         .dev_acquisition_stop = hw_dev_acquisition_stop,
 306         .priv = NULL,
 307 };