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