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