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_config *src;
  57         GSList *usb_devices, *devices, *l;
  58         int i;
  59         const char *conn;
  60
  61         drvc = di->priv;
  62         drvc->instances = NULL;
  63
  64         conn = NULL;
  65         for (l = options; l; l = l->next) {
  66                 src = l->data;
  67                 switch (src->key) {
  68                 case SR_CONF_CONN:
  69                         conn = g_variant_get_string(src->data, NULL);
  70                         break;
  71                 }
  72         }
  73         if (!conn)
  74                 return NULL;
  75
  76         devices = NULL;
  77         if ((usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn))) {
  78                 /* We have a list of sr_usb_dev_inst matching the connection
  79                  * string. Wrap them in sr_dev_inst and we're done. */
  80                 for (l = usb_devices; l; l = l->next) {
  81                         sdi = g_malloc0(sizeof(struct sr_dev_inst));
  82                         sdi->status = SR_ST_INACTIVE;
  83                         sdi->vendor = g_strdup(VENDOR);
  84                         sdi->model = g_strdup(MODEL);
  85                         sdi->driver = di;
  86                         sdi->inst_type = SR_INST_USB;
  87                         sdi->conn = l->data;
  88                         for (i = 0; i < 3; i++)
  89                                 sr_channel_new(sdi, i, SR_CHANNEL_ANALOG, TRUE, channels[i]);
  90                         devc = g_malloc0(sizeof(struct dev_context));
  91                         sdi->priv = devc;
  92                         devc->limit_samples = 0;
  93                         devc->data_source = DEFAULT_DATA_SOURCE;
  94                         drvc->instances = g_slist_append(drvc->instances, sdi);
  95                         devices = g_slist_append(devices, sdi);
  96                 }
  97                 g_slist_free(usb_devices);
  98         } else
  99                 g_slist_free_full(usb_devices, g_free);
 100
 101         return devices;
 102 }
 103
 104 static GSList *dev_list(void)
 105 {
 106         return ((struct drv_context *)(di->priv))->instances;
 107 }
 108
 109 static int dev_open(struct sr_dev_inst *sdi)
 110 {
 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_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(void)
 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
 185         ret = std_dev_clear(di, NULL);
 186         g_free(drvc);
 187         di->priv = NULL;
 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 dev_context *devc;
 221         int ret;
 222         const char *tmp_str;
 223
 224         (void)cg;
 225
 226         if (sdi->status != SR_ST_ACTIVE)
 227                 return SR_ERR_DEV_CLOSED;
 228
 229         if (!di->priv) {
 230                 sr_err("Driver was not initialized.");
 231                 return SR_ERR;
 232         }
 233
 234         devc = sdi->priv;
 235         ret = SR_OK;
 236         switch (key) {
 237         case SR_CONF_LIMIT_SAMPLES:
 238                 devc->limit_samples = g_variant_get_uint64(data);
 239                 sr_dbg("Setting sample limit to %" PRIu64 ".",
 240                        devc->limit_samples);
 241                 break;
 242         case SR_CONF_DATA_SOURCE:
 243                 tmp_str = g_variant_get_string(data, NULL);
 244                 if (!strcmp(tmp_str, "Live"))
 245                         devc->data_source = DATA_SOURCE_LIVE;
 246                 else if (!strcmp(tmp_str, "Memory"))
 247                         devc->data_source = DATA_SOURCE_MEMORY;
 248                 else
 249                         return SR_ERR;
 250                 break;
 251         default:
 252                 ret = SR_ERR_NA;
 253         }
 254
 255         return ret;
 256 }
 257
 258 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 259                 const struct sr_channel_group *cg)
 260 {
 261
 262         (void)sdi;
 263         (void)cg;
 264
 265         switch (key) {
 266         case SR_CONF_DEVICE_OPTIONS:
 267                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 268                                 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 269                 break;
 270         case SR_CONF_DATA_SOURCE:
 271                 *data = g_variant_new_strv(data_sources, ARRAY_SIZE(data_sources));
 272                 break;
 273         default:
 274                 return SR_ERR_NA;
 275         }
 276
 277         return SR_OK;
 278 }
 279
 280 static int dev_acquisition_start(const struct sr_dev_inst *sdi,
 281                                     void *cb_data)
 282 {
 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 };