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