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