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