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