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