libusb/os/netbsd_usb.c

   1 /*
   2  * Copyright © 2011 Martin Pieuchot <mpi@openbsd.org>
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2.1 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  17  */
  18
  19 #include <config.h>
  20
  21 #include <sys/time.h>
  22 #include <sys/types.h>
  23
  24 #include <errno.h>
  25 #include <fcntl.h>
  26 #include <stdio.h>
  27 #include <stdlib.h>
  28 #include <string.h>
  29 #include <unistd.h>
  30
  31 #include <dev/usb/usb.h>
  32
  33 #include "libusbi.h"
  34
  35 struct device_priv {
  36         char devnode[16];
  37         int fd;
  38
  39         usb_config_descriptor_t *cdesc;         /* active config descriptor */
  40 };
  41
  42 struct handle_priv {
  43         int endpoints[USB_MAX_ENDPOINTS];
  44 };
  45
  46 /*
  47  * Backend functions
  48  */
  49 static int netbsd_get_device_list(struct libusb_context *,
  50     struct discovered_devs **);
  51 static int netbsd_open(struct libusb_device_handle *);
  52 static void netbsd_close(struct libusb_device_handle *);
  53
  54 static int netbsd_get_active_config_descriptor(struct libusb_device *,
  55     void *, size_t);
  56 static int netbsd_get_config_descriptor(struct libusb_device *, uint8_t,
  57     void *, size_t);
  58
  59 static int netbsd_get_configuration(struct libusb_device_handle *, int *);
  60 static int netbsd_set_configuration(struct libusb_device_handle *, int);
  61
  62 static int netbsd_claim_interface(struct libusb_device_handle *, int);
  63 static int netbsd_release_interface(struct libusb_device_handle *, int);
  64
  65 static int netbsd_set_interface_altsetting(struct libusb_device_handle *, int,
  66     int);
  67 static int netbsd_clear_halt(struct libusb_device_handle *, unsigned char);
  68 static void netbsd_destroy_device(struct libusb_device *);
  69
  70 static int netbsd_submit_transfer(struct usbi_transfer *);
  71 static int netbsd_cancel_transfer(struct usbi_transfer *);
  72 static int netbsd_handle_transfer_completion(struct usbi_transfer *);
  73
  74 /*
  75  * Private functions
  76  */
  77 static int _errno_to_libusb(int);
  78 static int _cache_active_config_descriptor(struct libusb_device *, int);
  79 static int _sync_control_transfer(struct usbi_transfer *);
  80 static int _sync_gen_transfer(struct usbi_transfer *);
  81 static int _access_endpoint(struct libusb_transfer *);
  82
  83 const struct usbi_os_backend usbi_backend = {
  84         .name = "Synchronous NetBSD backend",
  85         .caps = 0,
  86         .get_device_list = netbsd_get_device_list,
  87         .open = netbsd_open,
  88         .close = netbsd_close,
  89
  90         .get_active_config_descriptor = netbsd_get_active_config_descriptor,
  91         .get_config_descriptor = netbsd_get_config_descriptor,
  92
  93         .get_configuration = netbsd_get_configuration,
  94         .set_configuration = netbsd_set_configuration,
  95
  96         .claim_interface = netbsd_claim_interface,
  97         .release_interface = netbsd_release_interface,
  98
  99         .set_interface_altsetting = netbsd_set_interface_altsetting,
 100         .clear_halt = netbsd_clear_halt,
 101
 102         .destroy_device = netbsd_destroy_device,
 103
 104         .submit_transfer = netbsd_submit_transfer,
 105         .cancel_transfer = netbsd_cancel_transfer,
 106
 107         .handle_transfer_completion = netbsd_handle_transfer_completion,
 108
 109         .device_priv_size = sizeof(struct device_priv),
 110         .device_handle_priv_size = sizeof(struct handle_priv),
 111 };
 112
 113 int
 114 netbsd_get_device_list(struct libusb_context * ctx,
 115         struct discovered_devs **discdevs)
 116 {
 117         struct libusb_device *dev;
 118         struct device_priv *dpriv;
 119         struct usb_device_info di;
 120         usb_device_descriptor_t ddesc;
 121         unsigned long session_id;
 122         char devnode[16];
 123         int fd, err, i;
 124
 125         usbi_dbg(" ");
 126
 127         /* Only ugen(4) is supported */
 128         for (i = 0; i < USB_MAX_DEVICES; i++) {
 129                 /* Control endpoint is always .00 */
 130                 snprintf(devnode, sizeof(devnode), "/dev/ugen%d.00", i);
 131
 132                 if ((fd = open(devnode, O_RDONLY)) < 0) {
 133                         if (errno != ENOENT && errno != ENXIO)
 134                                 usbi_err(ctx, "could not open %s", devnode);
 135                         continue;
 136                 }
 137
 138                 if (ioctl(fd, USB_GET_DEVICEINFO, &di) < 0)
 139                         continue;
 140
 141                 session_id = (di.udi_bus << 8 | di.udi_addr);
 142                 dev = usbi_get_device_by_session_id(ctx, session_id);
 143
 144                 if (dev == NULL) {
 145                         dev = usbi_alloc_device(ctx, session_id);
 146                         if (dev == NULL)
 147                                 return (LIBUSB_ERROR_NO_MEM);
 148
 149                         dev->bus_number = di.udi_bus;
 150                         dev->device_address = di.udi_addr;
 151                         dev->speed = di.udi_speed;
 152
 153                         dpriv = usbi_get_device_priv(dev);
 154                         strlcpy(dpriv->devnode, devnode, sizeof(devnode));
 155                         dpriv->fd = -1;
 156
 157                         if (ioctl(fd, USB_GET_DEVICE_DESC, &ddesc) < 0) {
 158                                 err = errno;
 159                                 goto error;
 160                         }
 161
 162                         static_assert(sizeof(dev->device_descriptor) == sizeof(ddesc),
 163                                       "mismatch between libusb and OS device descriptor sizes");
 164                         memcpy(&dev->device_descriptor, &ddesc, LIBUSB_DT_DEVICE_SIZE);
 165                         usbi_localize_device_descriptor(&dev->device_descriptor);
 166
 167                         if (_cache_active_config_descriptor(dev, fd)) {
 168                                 err = errno;
 169                                 goto error;
 170                         }
 171
 172                         if ((err = usbi_sanitize_device(dev)))
 173                                 goto error;
 174                 }
 175                 close(fd);
 176
 177                 if (discovered_devs_append(*discdevs, dev) == NULL)
 178                         return (LIBUSB_ERROR_NO_MEM);
 179
 180                 libusb_unref_device(dev);
 181         }
 182
 183         return (LIBUSB_SUCCESS);
 184
 185 error:
 186         close(fd);
 187         libusb_unref_device(dev);
 188         return _errno_to_libusb(err);
 189 }
 190
 191 int
 192 netbsd_open(struct libusb_device_handle *handle)
 193 {
 194         struct device_priv *dpriv = usbi_get_device_priv(handle->dev);
 195         struct handle_priv *hpriv = usbi_get_device_handle_priv(handle);
 196         int i;
 197
 198         dpriv->fd = open(dpriv->devnode, O_RDWR);
 199         if (dpriv->fd < 0) {
 200                 dpriv->fd = open(dpriv->devnode, O_RDONLY);
 201                 if (dpriv->fd < 0)
 202                         return _errno_to_libusb(errno);
 203         }
 204
 205         for (i = 0; i < USB_MAX_ENDPOINTS; i++)
 206                 hpriv->endpoints[i] = -1;
 207
 208         usbi_dbg("open %s: fd %d", dpriv->devnode, dpriv->fd);
 209
 210         return (LIBUSB_SUCCESS);
 211 }
 212
 213 void
 214 netbsd_close(struct libusb_device_handle *handle)
 215 {
 216         struct device_priv *dpriv = usbi_get_device_priv(handle->dev);
 217
 218         usbi_dbg("close: fd %d", dpriv->fd);
 219
 220         close(dpriv->fd);
 221         dpriv->fd = -1;
 222 }
 223
 224 int
 225 netbsd_get_active_config_descriptor(struct libusb_device *dev,
 226     void *buf, size_t len)
 227 {
 228         struct device_priv *dpriv = usbi_get_device_priv(dev);
 229
 230         len = MIN(len, (size_t)UGETW(dpriv->cdesc->wTotalLength));
 231
 232         usbi_dbg("len %zu", len);
 233
 234         memcpy(buf, dpriv->cdesc, len);
 235
 236         return (int)len;
 237 }
 238
 239 int
 240 netbsd_get_config_descriptor(struct libusb_device *dev, uint8_t idx,
 241     void *buf, size_t len)
 242 {
 243         struct device_priv *dpriv = usbi_get_device_priv(dev);
 244         struct usb_full_desc ufd;
 245         int fd, err;
 246
 247         usbi_dbg("index %u, len %zu", idx, len);
 248
 249         /* A config descriptor may be requested before opening the device */
 250         if (dpriv->fd >= 0) {
 251                 fd = dpriv->fd;
 252         } else {
 253                 fd = open(dpriv->devnode, O_RDONLY);
 254                 if (fd < 0)
 255                         return _errno_to_libusb(errno);
 256         }
 257
 258         ufd.ufd_config_index = idx;
 259         ufd.ufd_size = len;
 260         ufd.ufd_data = buf;
 261
 262         if ((ioctl(fd, USB_GET_FULL_DESC, &ufd)) < 0) {
 263                 err = errno;
 264                 if (dpriv->fd < 0)
 265                         close(fd);
 266                 return _errno_to_libusb(err);
 267         }
 268
 269         if (dpriv->fd < 0)
 270                 close(fd);
 271
 272         return (int)len;
 273 }
 274
 275 int
 276 netbsd_get_configuration(struct libusb_device_handle *handle, int *config)
 277 {
 278         struct device_priv *dpriv = usbi_get_device_priv(handle->dev);
 279
 280         usbi_dbg(" ");
 281
 282         if (ioctl(dpriv->fd, USB_GET_CONFIG, config) < 0)
 283                 return _errno_to_libusb(errno);
 284
 285         usbi_dbg("configuration %d", *config);
 286
 287         return (LIBUSB_SUCCESS);
 288 }
 289
 290 int
 291 netbsd_set_configuration(struct libusb_device_handle *handle, int config)
 292 {
 293         struct device_priv *dpriv = usbi_get_device_priv(handle->dev);
 294
 295         usbi_dbg("configuration %d", config);
 296
 297         if (ioctl(dpriv->fd, USB_SET_CONFIG, &config) < 0)
 298                 return _errno_to_libusb(errno);
 299
 300         return _cache_active_config_descriptor(handle->dev, dpriv->fd);
 301 }
 302
 303 int
 304 netbsd_claim_interface(struct libusb_device_handle *handle, int iface)
 305 {
 306         struct handle_priv *hpriv = usbi_get_device_handle_priv(handle);
 307         int i;
 308
 309         UNUSED(iface);
 310
 311         for (i = 0; i < USB_MAX_ENDPOINTS; i++)
 312                 hpriv->endpoints[i] = -1;
 313
 314         return (LIBUSB_SUCCESS);
 315 }
 316
 317 int
 318 netbsd_release_interface(struct libusb_device_handle *handle, int iface)
 319 {
 320         struct handle_priv *hpriv = usbi_get_device_handle_priv(handle);
 321         int i;
 322
 323         UNUSED(iface);
 324
 325         for (i = 0; i < USB_MAX_ENDPOINTS; i++)
 326                 if (hpriv->endpoints[i] >= 0)
 327                         close(hpriv->endpoints[i]);
 328
 329         return (LIBUSB_SUCCESS);
 330 }
 331
 332 int
 333 netbsd_set_interface_altsetting(struct libusb_device_handle *handle, int iface,
 334     int altsetting)
 335 {
 336         struct device_priv *dpriv = usbi_get_device_priv(handle->dev);
 337         struct usb_alt_interface intf;
 338
 339         usbi_dbg("iface %d, setting %d", iface, altsetting);
 340
 341         memset(&intf, 0, sizeof(intf));
 342
 343         intf.uai_interface_index = iface;
 344         intf.uai_alt_no = altsetting;
 345
 346         if (ioctl(dpriv->fd, USB_SET_ALTINTERFACE, &intf) < 0)
 347                 return _errno_to_libusb(errno);
 348
 349         return (LIBUSB_SUCCESS);
 350 }
 351
 352 int
 353 netbsd_clear_halt(struct libusb_device_handle *handle, unsigned char endpoint)
 354 {
 355         struct device_priv *dpriv = usbi_get_device_priv(handle->dev);
 356         struct usb_ctl_request req;
 357
 358         usbi_dbg(" ");
 359
 360         req.ucr_request.bmRequestType = UT_WRITE_ENDPOINT;
 361         req.ucr_request.bRequest = UR_CLEAR_FEATURE;
 362         USETW(req.ucr_request.wValue, UF_ENDPOINT_HALT);
 363         USETW(req.ucr_request.wIndex, endpoint);
 364         USETW(req.ucr_request.wLength, 0);
 365
 366         if (ioctl(dpriv->fd, USB_DO_REQUEST, &req) < 0)
 367                 return _errno_to_libusb(errno);
 368
 369         return (LIBUSB_SUCCESS);
 370 }
 371
 372 void
 373 netbsd_destroy_device(struct libusb_device *dev)
 374 {
 375         struct device_priv *dpriv = usbi_get_device_priv(dev);
 376
 377         usbi_dbg(" ");
 378
 379         free(dpriv->cdesc);
 380 }
 381
 382 int
 383 netbsd_submit_transfer(struct usbi_transfer *itransfer)
 384 {
 385         struct libusb_transfer *transfer;
 386         int err = 0;
 387
 388         usbi_dbg(" ");
 389
 390         transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
 391
 392         switch (transfer->type) {
 393         case LIBUSB_TRANSFER_TYPE_CONTROL:
 394                 err = _sync_control_transfer(itransfer);
 395                 break;
 396         case LIBUSB_TRANSFER_TYPE_ISOCHRONOUS:
 397                 if (IS_XFEROUT(transfer)) {
 398                         /* Isochronous write is not supported */
 399                         err = LIBUSB_ERROR_NOT_SUPPORTED;
 400                         break;
 401                 }
 402                 err = _sync_gen_transfer(itransfer);
 403                 break;
 404         case LIBUSB_TRANSFER_TYPE_BULK:
 405         case LIBUSB_TRANSFER_TYPE_INTERRUPT:
 406                 if (IS_XFEROUT(transfer) &&
 407                     transfer->flags & LIBUSB_TRANSFER_ADD_ZERO_PACKET) {
 408                         err = LIBUSB_ERROR_NOT_SUPPORTED;
 409                         break;
 410                 }
 411                 err = _sync_gen_transfer(itransfer);
 412                 break;
 413         case LIBUSB_TRANSFER_TYPE_BULK_STREAM:
 414                 err = LIBUSB_ERROR_NOT_SUPPORTED;
 415                 break;
 416         }
 417
 418         if (err)
 419                 return (err);
 420
 421         usbi_signal_transfer_completion(itransfer);
 422
 423         return (LIBUSB_SUCCESS);
 424 }
 425
 426 int
 427 netbsd_cancel_transfer(struct usbi_transfer *itransfer)
 428 {
 429         UNUSED(itransfer);
 430
 431         usbi_dbg(" ");
 432
 433         return (LIBUSB_ERROR_NOT_SUPPORTED);
 434 }
 435
 436 int
 437 netbsd_handle_transfer_completion(struct usbi_transfer *itransfer)
 438 {
 439         return usbi_handle_transfer_completion(itransfer, LIBUSB_TRANSFER_COMPLETED);
 440 }
 441
 442 int
 443 _errno_to_libusb(int err)
 444 {
 445         switch (err) {
 446         case EIO:
 447                 return (LIBUSB_ERROR_IO);
 448         case EACCES:
 449                 return (LIBUSB_ERROR_ACCESS);
 450         case ENOENT:
 451                 return (LIBUSB_ERROR_NO_DEVICE);
 452         case ENOMEM:
 453                 return (LIBUSB_ERROR_NO_MEM);
 454         case EWOULDBLOCK:
 455         case ETIMEDOUT:
 456                 return (LIBUSB_ERROR_TIMEOUT);
 457         }
 458
 459         usbi_dbg("error: %s", strerror(err));
 460
 461         return (LIBUSB_ERROR_OTHER);
 462 }
 463
 464 int
 465 _cache_active_config_descriptor(struct libusb_device *dev, int fd)
 466 {
 467         struct device_priv *dpriv = usbi_get_device_priv(dev);
 468         struct usb_config_desc ucd;
 469         struct usb_full_desc ufd;
 470         void *buf;
 471         int len;
 472
 473         usbi_dbg("fd %d", fd);
 474
 475         ucd.ucd_config_index = USB_CURRENT_CONFIG_INDEX;
 476
 477         if ((ioctl(fd, USB_GET_CONFIG_DESC, &ucd)) < 0)
 478                 return _errno_to_libusb(errno);
 479
 480         usbi_dbg("active bLength %d", ucd.ucd_desc.bLength);
 481
 482         len = UGETW(ucd.ucd_desc.wTotalLength);
 483         buf = malloc((size_t)len);
 484         if (buf == NULL)
 485                 return (LIBUSB_ERROR_NO_MEM);
 486
 487         ufd.ufd_config_index = ucd.ucd_config_index;
 488         ufd.ufd_size = len;
 489         ufd.ufd_data = buf;
 490
 491         usbi_dbg("index %d, len %d", ufd.ufd_config_index, len);
 492
 493         if ((ioctl(fd, USB_GET_FULL_DESC, &ufd)) < 0) {
 494                 free(buf);
 495                 return _errno_to_libusb(errno);
 496         }
 497
 498         if (dpriv->cdesc)
 499                 free(dpriv->cdesc);
 500         dpriv->cdesc = buf;
 501
 502         return (0);
 503 }
 504
 505 int
 506 _sync_control_transfer(struct usbi_transfer *itransfer)
 507 {
 508         struct libusb_transfer *transfer;
 509         struct libusb_control_setup *setup;
 510         struct device_priv *dpriv;
 511         struct usb_ctl_request req;
 512
 513         transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
 514         dpriv = usbi_get_device_priv(transfer->dev_handle->dev);
 515         setup = (struct libusb_control_setup *)transfer->buffer;
 516
 517         usbi_dbg("type %d request %d value %d index %d length %d timeout %d",
 518             setup->bmRequestType, setup->bRequest,
 519             libusb_le16_to_cpu(setup->wValue),
 520             libusb_le16_to_cpu(setup->wIndex),
 521             libusb_le16_to_cpu(setup->wLength), transfer->timeout);
 522
 523         req.ucr_request.bmRequestType = setup->bmRequestType;
 524         req.ucr_request.bRequest = setup->bRequest;
 525         /* Don't use USETW, libusb already deals with the endianness */
 526         (*(uint16_t *)req.ucr_request.wValue) = setup->wValue;
 527         (*(uint16_t *)req.ucr_request.wIndex) = setup->wIndex;
 528         (*(uint16_t *)req.ucr_request.wLength) = setup->wLength;
 529         req.ucr_data = transfer->buffer + LIBUSB_CONTROL_SETUP_SIZE;
 530
 531         if ((transfer->flags & LIBUSB_TRANSFER_SHORT_NOT_OK) == 0)
 532                 req.ucr_flags = USBD_SHORT_XFER_OK;
 533
 534         if ((ioctl(dpriv->fd, USB_SET_TIMEOUT, &transfer->timeout)) < 0)
 535                 return _errno_to_libusb(errno);
 536
 537         if ((ioctl(dpriv->fd, USB_DO_REQUEST, &req)) < 0)
 538                 return _errno_to_libusb(errno);
 539
 540         itransfer->transferred = req.ucr_actlen;
 541
 542         usbi_dbg("transferred %d", itransfer->transferred);
 543
 544         return (0);
 545 }
 546
 547 int
 548 _access_endpoint(struct libusb_transfer *transfer)
 549 {
 550         struct handle_priv *hpriv;
 551         struct device_priv *dpriv;
 552         char *s, devnode[16];
 553         int fd, endpt;
 554         mode_t mode;
 555
 556         hpriv = usbi_get_device_handle_priv(transfer->dev_handle);
 557         dpriv = usbi_get_device_priv(transfer->dev_handle->dev);
 558
 559         endpt = UE_GET_ADDR(transfer->endpoint);
 560         mode = IS_XFERIN(transfer) ? O_RDONLY : O_WRONLY;
 561
 562         usbi_dbg("endpoint %d mode %d", endpt, mode);
 563
 564         if (hpriv->endpoints[endpt] < 0) {
 565                 /* Pick the right node given the control one */
 566                 strlcpy(devnode, dpriv->devnode, sizeof(devnode));
 567                 s = strchr(devnode, '.');
 568                 snprintf(s, 4, ".%02d", endpt);
 569
 570                 /* We may need to read/write to the same endpoint later. */
 571                 if (((fd = open(devnode, O_RDWR)) < 0) && (errno == ENXIO))
 572                         if ((fd = open(devnode, mode)) < 0)
 573                                 return (-1);
 574
 575                 hpriv->endpoints[endpt] = fd;
 576         }
 577
 578         return (hpriv->endpoints[endpt]);
 579 }
 580
 581 int
 582 _sync_gen_transfer(struct usbi_transfer *itransfer)
 583 {
 584         struct libusb_transfer *transfer;
 585         int fd, nr = 1;
 586
 587         transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
 588
 589         /*
 590          * Bulk, Interrupt or Isochronous transfer depends on the
 591          * endpoint and thus the node to open.
 592          */
 593         if ((fd = _access_endpoint(transfer)) < 0)
 594                 return _errno_to_libusb(errno);
 595
 596         if ((ioctl(fd, USB_SET_TIMEOUT, &transfer->timeout)) < 0)
 597                 return _errno_to_libusb(errno);
 598
 599         if (IS_XFERIN(transfer)) {
 600                 if ((transfer->flags & LIBUSB_TRANSFER_SHORT_NOT_OK) == 0)
 601                         if ((ioctl(fd, USB_SET_SHORT_XFER, &nr)) < 0)
 602                                 return _errno_to_libusb(errno);
 603
 604                 nr = read(fd, transfer->buffer, transfer->length);
 605         } else {
 606                 nr = write(fd, transfer->buffer, transfer->length);
 607         }
 608
 609         if (nr < 0)
 610                 return _errno_to_libusb(errno);
 611
 612         itransfer->transferred = nr;
 613
 614         return (0);
 615 }