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