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