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