src/hardware/uni-t-ut32x/api.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
   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 3 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, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #include <config.h>
  21 #include <string.h>
  22 #include "protocol.h"
  23
  24 static const uint32_t scanopts[] = {
  25         SR_CONF_CONN,
  26 };
  27
  28 static const uint32_t drvopts[] = {
  29         SR_CONF_THERMOMETER,
  30 };
  31
  32 static const uint32_t devopts[] = {
  33         SR_CONF_CONTINUOUS,
  34         SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
  35         SR_CONF_DATA_SOURCE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  36 };
  37
  38 static const char *channel_names[] = {
  39         "T1", "T2", "T1-T2",
  40 };
  41
  42 static const char *data_sources[] = {
  43         "Live",
  44         "Memory",
  45 };
  46
  47 static GSList *scan(struct sr_dev_driver *di, GSList *options)
  48 {
  49         struct drv_context *drvc;
  50         struct dev_context *devc;
  51         struct sr_dev_inst *sdi;
  52         struct sr_config *src;
  53         GSList *usb_devices, *devices, *l;
  54         unsigned int i;
  55         const char *conn;
  56
  57         drvc = di->context;
  58
  59         conn = NULL;
  60         for (l = options; l; l = l->next) {
  61                 src = l->data;
  62                 switch (src->key) {
  63                 case SR_CONF_CONN:
  64                         conn = g_variant_get_string(src->data, NULL);
  65                         break;
  66                 }
  67         }
  68         if (!conn)
  69                 return NULL;
  70
  71         devices = NULL;
  72         if ((usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn))) {
  73                 /* We have a list of sr_usb_dev_inst matching the connection
  74                  * string. Wrap them in sr_dev_inst and we're done. */
  75                 for (l = usb_devices; l; l = l->next) {
  76                         sdi = g_malloc0(sizeof(struct sr_dev_inst));
  77                         sdi->status = SR_ST_INACTIVE;
  78                         sdi->vendor = g_strdup(VENDOR);
  79                         sdi->model = g_strdup(MODEL);
  80                         sdi->inst_type = SR_INST_USB;
  81                         sdi->conn = l->data;
  82                         for (i = 0; i < ARRAY_SIZE(channel_names); i++)
  83                                 sr_channel_new(sdi, i, SR_CHANNEL_ANALOG, TRUE,
  84                                                 channel_names[i]);
  85                         devc = g_malloc0(sizeof(struct dev_context));
  86                         sdi->priv = devc;
  87                         devc->limit_samples = 0;
  88                         devc->data_source = DEFAULT_DATA_SOURCE;
  89                         devices = g_slist_append(devices, sdi);
  90                 }
  91                 g_slist_free(usb_devices);
  92         } else
  93                 g_slist_free_full(usb_devices, g_free);
  94
  95         return std_scan_complete(di, devices);
  96 }
  97
  98 static int dev_open(struct sr_dev_inst *sdi)
  99 {
 100         struct sr_dev_driver *di = sdi->driver;
 101         struct drv_context *drvc = di->context;
 102         struct sr_usb_dev_inst *usb;
 103         int ret;
 104
 105         usb = sdi->conn;
 106
 107         if (sr_usb_open(drvc->sr_ctx->libusb_ctx, usb) != SR_OK)
 108                 return SR_ERR;
 109
 110 /*
 111  * The libusb 1.0.9 Darwin backend is broken: it can report a kernel
 112  * driver being active, but detaching it always returns an error.
 113  */
 114 #if !defined(__APPLE__)
 115         if (libusb_kernel_driver_active(usb->devhdl, USB_INTERFACE) == 1) {
 116                 if ((ret = libusb_detach_kernel_driver(usb->devhdl, USB_INTERFACE)) < 0) {
 117                         sr_err("failed to detach kernel driver: %s",
 118                                         libusb_error_name(ret));
 119                         return SR_ERR;
 120                 }
 121         }
 122 #endif
 123
 124         if ((ret = libusb_set_configuration(usb->devhdl, USB_CONFIGURATION))) {
 125                 sr_err("Failed to set configuration: %s.", libusb_error_name(ret));
 126                 return SR_ERR;
 127         }
 128
 129         if ((ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE))) {
 130                 sr_err("Failed to claim interface: %s.", libusb_error_name(ret));
 131                 return SR_ERR;
 132         }
 133
 134         return SR_OK;
 135 }
 136
 137 static int dev_close(struct sr_dev_inst *sdi)
 138 {
 139         struct sr_usb_dev_inst *usb;
 140
 141         usb = sdi->conn;
 142
 143         if (!usb->devhdl)
 144                 return SR_ERR_BUG;
 145
 146         libusb_release_interface(usb->devhdl, USB_INTERFACE);
 147         libusb_close(usb->devhdl);
 148         usb->devhdl = NULL;
 149
 150         return SR_OK;
 151 }
 152
 153 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 154                 const struct sr_channel_group *cg)
 155 {
 156         struct dev_context *devc;
 157
 158         (void)cg;
 159
 160         devc = sdi->priv;
 161         switch (key) {
 162         case SR_CONF_LIMIT_SAMPLES:
 163                 *data = g_variant_new_uint64(devc->limit_samples);
 164                 break;
 165         case SR_CONF_DATA_SOURCE:
 166                 if (devc->data_source == DATA_SOURCE_LIVE)
 167                         *data = g_variant_new_string("Live");
 168                 else
 169                         *data = g_variant_new_string("Memory");
 170                 break;
 171         default:
 172                 return SR_ERR_NA;
 173         }
 174
 175         return SR_OK;
 176 }
 177
 178 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 179                 const struct sr_channel_group *cg)
 180 {
 181         struct dev_context *devc;
 182         const char *tmp_str;
 183
 184         (void)cg;
 185
 186         devc = sdi->priv;
 187
 188         switch (key) {
 189         case SR_CONF_LIMIT_SAMPLES:
 190                 devc->limit_samples = g_variant_get_uint64(data);
 191                 break;
 192         case SR_CONF_DATA_SOURCE:
 193                 tmp_str = g_variant_get_string(data, NULL);
 194                 if (!strcmp(tmp_str, "Live"))
 195                         devc->data_source = DATA_SOURCE_LIVE;
 196                 else if (!strcmp(tmp_str, "Memory"))
 197                         devc->data_source = DATA_SOURCE_MEMORY;
 198                 else
 199                         return SR_ERR;
 200                 break;
 201         default:
 202                 return SR_ERR_NA;
 203         }
 204
 205         return SR_OK;
 206 }
 207
 208 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 209                 const struct sr_channel_group *cg)
 210 {
 211         switch (key) {
 212         case SR_CONF_SCAN_OPTIONS:
 213         case SR_CONF_DEVICE_OPTIONS:
 214                 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
 215         case SR_CONF_DATA_SOURCE:
 216                 *data = g_variant_new_strv(data_sources, ARRAY_SIZE(data_sources));
 217                 break;
 218         default:
 219                 return SR_ERR_NA;
 220         }
 221
 222         return SR_OK;
 223 }
 224
 225 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 226 {
 227         struct sr_dev_driver *di = sdi->driver;
 228         struct drv_context *drvc;
 229         struct dev_context *devc;
 230         struct sr_usb_dev_inst *usb;
 231         int len, ret;
 232         unsigned char cmd[2];
 233
 234         drvc = di->context;
 235         devc = sdi->priv;
 236         usb = sdi->conn;
 237
 238         devc->num_samples = 0;
 239         devc->packet_len = 0;
 240
 241         /* Configure serial port parameters on USB-UART interface
 242          * chip inside the device (just baudrate 2400 actually). */
 243         cmd[0] = 0x09;
 244         cmd[1] = 0x60;
 245         ret = libusb_control_transfer(usb->devhdl, 0x21, 0x09, 0x0300, 0x00,
 246                         cmd, 2, 5);
 247         if (ret != 2) {
 248                 sr_dbg("Failed to configure CH9325: %s", libusb_error_name(ret));
 249                 return SR_ERR;
 250         }
 251
 252         std_session_send_df_header(sdi);
 253
 254         if (!(devc->xfer = libusb_alloc_transfer(0)))
 255                 return SR_ERR;
 256
 257         /* Length of payload to follow. */
 258         cmd[0] = 0x01;
 259         if (devc->data_source == DATA_SOURCE_LIVE)
 260                 cmd[1] = CMD_GET_LIVE;
 261         else
 262                 cmd[1] = CMD_GET_STORED;
 263
 264         ret = libusb_bulk_transfer(usb->devhdl, EP_OUT, cmd, 2, &len, 5);
 265         if (ret != 0 || len != 2) {
 266                 sr_dbg("Failed to start acquisition: %s", libusb_error_name(ret));
 267                 libusb_free_transfer(devc->xfer);
 268                 return SR_ERR;
 269         }
 270
 271         libusb_fill_bulk_transfer(devc->xfer, usb->devhdl, EP_IN, devc->buf,
 272                         8, uni_t_ut32x_receive_transfer, (void *)sdi, 15);
 273         if (libusb_submit_transfer(devc->xfer) != 0) {
 274                 libusb_free_transfer(devc->xfer);
 275                 return SR_ERR;
 276         }
 277
 278         usb_source_add(sdi->session, drvc->sr_ctx, 10,
 279                         uni_t_ut32x_handle_events, (void *)sdi);
 280
 281         return SR_OK;
 282 }
 283
 284 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 285 {
 286         /* Signal USB transfer handler to clean up and stop. */
 287         sdi->status = SR_ST_STOPPING;
 288
 289         return SR_OK;
 290 }
 291
 292 static struct sr_dev_driver uni_t_ut32x_driver_info = {
 293         .name = "uni-t-ut32x",
 294         .longname = "UNI-T UT32x",
 295         .api_version = 1,
 296         .init = std_init,
 297         .cleanup = std_cleanup,
 298         .scan = scan,
 299         .dev_list = std_dev_list,
 300         .dev_clear = std_dev_clear,
 301         .config_get = config_get,
 302         .config_set = config_set,
 303         .config_list = config_list,
 304         .dev_open = dev_open,
 305         .dev_close = dev_close,
 306         .dev_acquisition_start = dev_acquisition_start,
 307         .dev_acquisition_stop = dev_acquisition_stop,
 308         .context = NULL,
 309 };
 310 SR_REGISTER_DEV_DRIVER(uni_t_ut32x_driver_info);