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