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