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