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