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