src/hardware/saleae-logic-pro/api.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2017 Jan Luebbe <jluebbe@lasnet.de>
   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 <glib.h>
  22 #include <string.h>
  23 #include "protocol.h"
  24
  25 #define BUF_COUNT 8
  26 #define BUF_SIZE (16 * 1024)
  27 #define BUF_TIMEOUT (1000 * 1000)
  28
  29 SR_PRIV struct sr_dev_driver saleae_logic_pro_driver_info;
  30
  31 static const uint32_t drvopts[] = {
  32         SR_CONF_LOGIC_ANALYZER,
  33 };
  34
  35 static const uint32_t scanopts[] = {
  36         SR_CONF_CONN,
  37 };
  38
  39 static const uint32_t devopts[] = {
  40         SR_CONF_CONTINUOUS,
  41         SR_CONF_CONN | SR_CONF_GET,
  42         SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  43 };
  44
  45 static const char *channel_names[] = {
  46         "0", "1", "2", "3", "4", "5", "6", "7",
  47         "8", "9", "10", "11", "12", "13", "14", "15",
  48 };
  49
  50 static const uint64_t samplerates[] = {
  51         SR_MHZ(1),
  52         SR_MHZ(2),
  53         SR_KHZ(2500),
  54         SR_MHZ(10),
  55         SR_MHZ(25),
  56         SR_MHZ(50),
  57 };
  58
  59 static gboolean scan_firmware(libusb_device *dev)
  60 {
  61         struct libusb_device_descriptor des;
  62         struct libusb_device_handle *hdl;
  63         gboolean ret;
  64         unsigned char strdesc[64];
  65
  66         hdl = NULL;
  67         ret = FALSE;
  68
  69         libusb_get_device_descriptor(dev, &des);
  70
  71         if (libusb_open(dev, &hdl) != 0)
  72                 goto out;
  73
  74         if (libusb_get_string_descriptor_ascii(hdl,
  75                 des.iManufacturer, strdesc, sizeof(strdesc)) < 0)
  76                 goto out;
  77         if (strcmp((const char *)strdesc, "Saleae"))
  78                 goto out;
  79
  80         if (libusb_get_string_descriptor_ascii(hdl,
  81                 des.iProduct, strdesc, sizeof(strdesc)) < 0)
  82                 goto out;
  83         if (strcmp((const char *)strdesc, "Logic Pro"))
  84                 goto out;
  85
  86         ret = TRUE;
  87
  88 out:
  89         if (hdl)
  90                 libusb_close(hdl);
  91
  92         return ret;
  93 }
  94
  95 static GSList *scan(struct sr_dev_driver *di, GSList *options)
  96 {
  97         struct drv_context *drvc;
  98         struct dev_context *devc;
  99         struct sr_dev_inst *sdi;
 100         GSList *devices, *conn_devices;
 101         libusb_device **devlist;
 102         struct libusb_device_descriptor des;
 103         const char *conn;
 104         char connection_id[64];
 105
 106         devices = NULL;
 107         drvc = di->context;
 108         drvc->instances = NULL;
 109
 110         conn = NULL;
 111         for (GSList *l = options; l; l = l->next) {
 112                 struct sr_config *src = l->data;
 113
 114                 switch (src->key) {
 115                 case SR_CONF_CONN:
 116                         conn = g_variant_get_string(src->data, NULL);
 117                         break;
 118                 }
 119         }
 120
 121         if (conn)
 122                 conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
 123         else
 124                 conn_devices = NULL;
 125
 126         libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
 127         for (unsigned int i = 0; devlist[i]; i++) {
 128                 if (conn) {
 129                         struct sr_usb_dev_inst *usb = NULL;
 130                         GSList *l;
 131
 132                         for (l = conn_devices; l; l = l->next) {
 133                                 usb = l->data;
 134                                 if (usb->bus == libusb_get_bus_number(devlist[i])
 135                                     && usb->address == libusb_get_device_address(devlist[i]))
 136                                         break;
 137                         }
 138                         if (!l)
 139                                 /* This device matched none of the ones that
 140                                  * matched the conn specification. */
 141                                 continue;
 142                 }
 143
 144                 libusb_get_device_descriptor(devlist[i], &des);
 145
 146                 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
 147
 148                 if (des.idVendor != 0x21a9 || des.idProduct != 0x1006)
 149                         continue;
 150
 151                 if (!scan_firmware(devlist[i])) {
 152                         sr_err("Found a Logic Pro device, but firmware is not loaded (use Saleae application).");
 153                         continue;
 154                 }
 155
 156                 sdi = g_malloc0(sizeof(struct sr_dev_inst));
 157                 sdi->status = SR_ST_INITIALIZING;
 158                 sdi->vendor = g_strdup("Saleae");
 159                 sdi->model = g_strdup("Logic Pro 16");
 160                 sdi->connection_id = g_strdup(connection_id);
 161
 162                 for (unsigned int j = 0; j < ARRAY_SIZE(channel_names); j++)
 163                         sr_channel_new(sdi, j, SR_CHANNEL_LOGIC, TRUE,
 164                                        channel_names[j]);
 165
 166                 sr_dbg("Found a Logic Pro 16 device.");
 167                 sdi->status = SR_ST_INACTIVE;
 168                 sdi->inst_type = SR_INST_USB;
 169                 sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
 170                                                 libusb_get_device_address(devlist[i]), NULL);
 171
 172                 devc = g_malloc0(sizeof(struct dev_context));
 173                 sdi->priv = devc;
 174                 devices = g_slist_append(devices, sdi);
 175
 176         }
 177         libusb_free_device_list(devlist, 1);
 178         g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);
 179
 180         return std_scan_complete(di, devices);
 181 }
 182
 183 static int dev_open(struct sr_dev_inst *sdi)
 184 {
 185         struct sr_dev_driver *di = sdi->driver;
 186         struct drv_context *drvc = di->context;
 187         struct dev_context *devc = sdi->priv;
 188         struct sr_usb_dev_inst *usb = sdi->conn;
 189         int ret;
 190
 191         if (sr_usb_open(drvc->sr_ctx->libusb_ctx, usb) != SR_OK)
 192                 return SR_ERR;
 193
 194         if ((ret = libusb_claim_interface(usb->devhdl, 0))) {
 195                 sr_err("Failed to claim interface: %s.", libusb_error_name(ret));
 196                 return SR_ERR;
 197         }
 198
 199         /* Configure default samplerate. */
 200         if (devc->dig_samplerate == 0)
 201                 devc->dig_samplerate = samplerates[3];
 202
 203         return SR_OK;
 204 }
 205
 206 static int dev_close(struct sr_dev_inst *sdi)
 207 {
 208         sr_usb_close(sdi->conn);
 209
 210         return SR_OK;
 211 }
 212
 213 static int config_get(uint32_t key, GVariant **data,
 214                       const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 215 {
 216         struct sr_usb_dev_inst *usb;
 217         struct dev_context *devc;
 218
 219         (void)cg;
 220
 221         switch (key) {
 222         case SR_CONF_CONN:
 223                 if (!sdi || !sdi->conn)
 224                         return SR_ERR_ARG;
 225                 usb = sdi->conn;
 226                 *data = g_variant_new_printf("%d.%d", usb->bus, usb->address);
 227                 break;
 228         case SR_CONF_SAMPLERATE:
 229                 if (!sdi)
 230                         return SR_ERR;
 231                 devc = sdi->priv;
 232                 *data = g_variant_new_uint64(devc->dig_samplerate);
 233                 break;
 234         default:
 235                 return SR_ERR_NA;
 236         }
 237
 238         return SR_OK;
 239 }
 240
 241 static int config_set(uint32_t key, GVariant *data,
 242                       const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 243 {
 244         struct dev_context *devc;
 245
 246         (void)cg;
 247
 248         devc = sdi->priv;
 249
 250         switch (key) {
 251         case SR_CONF_SAMPLERATE:
 252                 devc->dig_samplerate = g_variant_get_uint64(data);
 253                 break;
 254         default:
 255                 return SR_ERR_NA;
 256         }
 257
 258         return SR_OK;
 259 }
 260
 261 static int config_list(uint32_t key, GVariant **data,
 262                        const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 263 {
 264         GVariant *gvar;
 265         GVariantBuilder gvb;
 266
 267         (void)sdi;
 268         (void)cg;
 269
 270         switch (key) {
 271         case SR_CONF_SCAN_OPTIONS:
 272                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 273                         scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 274                 break;
 275         case SR_CONF_DEVICE_OPTIONS:
 276                 if (!sdi) {
 277                         *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 278                                 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
 279                 } else {
 280                         *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 281                                 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 282                 }
 283                 break;
 284         case SR_CONF_SAMPLERATE:
 285                 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
 286                 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
 287                         samplerates, ARRAY_SIZE(samplerates), sizeof(uint64_t));
 288                 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
 289                 *data = g_variant_builder_end(&gvb);
 290                 break;
 291         default:
 292                 return SR_ERR_NA;
 293         }
 294
 295         return SR_OK;
 296 }
 297
 298 static void dev_acquisition_abort(const struct sr_dev_inst *sdi)
 299 {
 300         struct dev_context *devc = sdi->priv;
 301         unsigned int i;
 302
 303         for (i = 0; i < devc->num_transfers; i++) {
 304                 if (devc->transfers[i])
 305                         libusb_cancel_transfer(devc->transfers[i]);
 306         }
 307 }
 308
 309 static int dev_acquisition_handle(int fd, int revents, void *cb_data)
 310 {
 311         struct sr_dev_inst *sdi = cb_data;
 312         struct drv_context *drvc = sdi->driver->context;
 313         struct timeval tv = ALL_ZERO;
 314
 315         (void)fd;
 316         (void)revents;
 317
 318         libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
 319
 320         return TRUE;
 321 }
 322
 323 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 324 {
 325         struct dev_context *devc = sdi->priv;
 326         struct drv_context *drvc = sdi->driver->context;
 327         struct libusb_transfer *transfer;
 328         struct sr_usb_dev_inst *usb;
 329         uint8_t *buf;
 330         unsigned int i, ret;
 331
 332         ret = saleae_logic_pro_init(sdi);
 333         if (ret != SR_OK)
 334                 return ret;
 335
 336         ret = saleae_logic_pro_prepare(sdi);
 337         if (ret != SR_OK)
 338                 return ret;
 339
 340         usb = sdi->conn;
 341
 342         devc->conv_buffer = g_malloc(CONV_BUFFER_SIZE);
 343
 344         devc->num_transfers = BUF_COUNT;
 345         devc->transfers = g_malloc0(sizeof(*devc->transfers) * BUF_COUNT);
 346         for (i = 0; i < devc->num_transfers; i++) {
 347                 buf = g_malloc(BUF_SIZE);
 348                 transfer = libusb_alloc_transfer(0);
 349                 libusb_fill_bulk_transfer(transfer, usb->devhdl,
 350                         2 | LIBUSB_ENDPOINT_IN, buf, BUF_SIZE,
 351                         saleae_logic_pro_receive_data, (void *)sdi, BUF_TIMEOUT);
 352                 if ((ret = libusb_submit_transfer(transfer)) != 0) {
 353                         sr_err("Failed to submit transfer: %s.",
 354                                libusb_error_name(ret));
 355                         libusb_free_transfer(transfer);
 356                         g_free(buf);
 357                         dev_acquisition_abort(sdi);
 358                         return SR_ERR;
 359                 }
 360                 devc->transfers[i] = transfer;
 361                 devc->submitted_transfers++;
 362         }
 363
 364         usb_source_add(sdi->session, drvc->sr_ctx, BUF_TIMEOUT, dev_acquisition_handle, (void *)sdi);
 365
 366         std_session_send_df_header(sdi);
 367
 368         saleae_logic_pro_start(sdi);
 369         if (ret != SR_OK)
 370                 return ret;
 371
 372         return SR_OK;
 373 }
 374
 375 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 376 {
 377         struct dev_context *devc = sdi->priv;
 378         struct drv_context *drvc = sdi->driver->context;
 379
 380         saleae_logic_pro_stop(sdi);
 381
 382         std_session_send_df_end(sdi);
 383
 384         usb_source_remove(sdi->session, drvc->sr_ctx);
 385
 386         g_free(devc->conv_buffer);
 387
 388         return SR_OK;
 389 }
 390
 391 SR_PRIV struct sr_dev_driver saleae_logic_pro_driver_info = {
 392         .name = "saleae-logic-pro",
 393         .longname = "Saleae Logic Pro",
 394         .api_version = 1,
 395         .init = std_init,
 396         .cleanup = std_cleanup,
 397         .scan = scan,
 398         .dev_list = std_dev_list,
 399         .dev_clear = std_dev_clear,
 400         .config_get = config_get,
 401         .config_set = config_set,
 402         .config_list = config_list,
 403         .dev_open = dev_open,
 404         .dev_close = dev_close,
 405         .dev_acquisition_start = dev_acquisition_start,
 406         .dev_acquisition_stop = dev_acquisition_stop,
 407         .context = NULL,
 408 };
 409
 410 SR_REGISTER_DEV_DRIVER(saleae_logic_pro_driver_info);