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