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