2 * Copyright © 2011-2013 Martin Pieuchot <mpi@openbsd.org>
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.
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.
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
22 #include <sys/types.h>
31 #include <dev/usb/usb.h>
36 char *devname; /* name of the ugen(4) node */
37 int fd; /* device file descriptor */
39 unsigned char *cdesc; /* active config descriptor */
40 usb_device_descriptor_t ddesc; /* usb device descriptor */
44 int endpoints[USB_MAX_ENDPOINTS];
50 static int obsd_get_device_list(struct libusb_context *,
51 struct discovered_devs **);
52 static int obsd_open(struct libusb_device_handle *);
53 static void obsd_close(struct libusb_device_handle *);
55 static int obsd_get_device_descriptor(struct libusb_device *, unsigned char *,
57 static int obsd_get_active_config_descriptor(struct libusb_device *,
58 unsigned char *, size_t, int *);
59 static int obsd_get_config_descriptor(struct libusb_device *, uint8_t,
60 unsigned char *, size_t, int *);
62 static int obsd_get_configuration(struct libusb_device_handle *, int *);
63 static int obsd_set_configuration(struct libusb_device_handle *, int);
65 static int obsd_claim_interface(struct libusb_device_handle *, int);
66 static int obsd_release_interface(struct libusb_device_handle *, int);
68 static int obsd_set_interface_altsetting(struct libusb_device_handle *, int,
70 static int obsd_clear_halt(struct libusb_device_handle *, unsigned char);
71 static int obsd_reset_device(struct libusb_device_handle *);
72 static void obsd_destroy_device(struct libusb_device *);
74 static int obsd_submit_transfer(struct usbi_transfer *);
75 static int obsd_cancel_transfer(struct usbi_transfer *);
76 static void obsd_clear_transfer_priv(struct usbi_transfer *);
77 static int obsd_handle_transfer_completion(struct usbi_transfer *);
78 static int obsd_clock_gettime(int, struct timespec *);
83 static int _errno_to_libusb(int);
84 static int _cache_active_config_descriptor(struct libusb_device *);
85 static int _sync_control_transfer(struct usbi_transfer *);
86 static int _sync_gen_transfer(struct usbi_transfer *);
87 static int _access_endpoint(struct libusb_transfer *);
89 static int _bus_open(int);
92 const struct usbi_os_backend usbi_backend = {
93 .name = "Synchronous OpenBSD backend",
94 .get_device_list = obsd_get_device_list,
98 .get_device_descriptor = obsd_get_device_descriptor,
99 .get_active_config_descriptor = obsd_get_active_config_descriptor,
100 .get_config_descriptor = obsd_get_config_descriptor,
102 .get_configuration = obsd_get_configuration,
103 .set_configuration = obsd_set_configuration,
105 .claim_interface = obsd_claim_interface,
106 .release_interface = obsd_release_interface,
108 .set_interface_altsetting = obsd_set_interface_altsetting,
109 .clear_halt = obsd_clear_halt,
110 .reset_device = obsd_reset_device,
111 .destroy_device = obsd_destroy_device,
113 .submit_transfer = obsd_submit_transfer,
114 .cancel_transfer = obsd_cancel_transfer,
115 .clear_transfer_priv = obsd_clear_transfer_priv,
117 .handle_transfer_completion = obsd_handle_transfer_completion,
119 .clock_gettime = obsd_clock_gettime,
120 .device_priv_size = sizeof(struct device_priv),
121 .device_handle_priv_size = sizeof(struct handle_priv),
124 #define DEVPATH "/dev/"
125 #define USBDEV DEVPATH "usb"
128 obsd_get_device_list(struct libusb_context * ctx,
129 struct discovered_devs **discdevs)
131 struct discovered_devs *ddd;
132 struct libusb_device *dev;
133 struct device_priv *dpriv;
134 struct usb_device_info di;
135 struct usb_device_ddesc dd;
136 unsigned long session_id;
137 char devices[USB_MAX_DEVICES];
144 for (i = 0; i < 8; i++) {
145 snprintf(busnode, sizeof(busnode), USBDEV "%d", i);
147 if ((fd = open(busnode, O_RDWR)) < 0) {
148 if (errno != ENOENT && errno != ENXIO)
149 usbi_err(ctx, "could not open %s", busnode);
153 bzero(devices, sizeof(devices));
154 for (addr = 1; addr < USB_MAX_DEVICES; addr++) {
159 if (ioctl(fd, USB_DEVICEINFO, &di) < 0)
163 * XXX If ugen(4) is attached to the USB device
167 for (j = 0; j < USB_MAX_DEVNAMES; j++)
168 if (!strncmp("ugen", di.udi_devnames[j], 4)) {
169 udevname = strdup(di.udi_devnames[j]);
173 session_id = (di.udi_bus << 8 | di.udi_addr);
174 dev = usbi_get_device_by_session_id(ctx, session_id);
177 dev = usbi_alloc_device(ctx, session_id);
180 return (LIBUSB_ERROR_NO_MEM);
183 dev->bus_number = di.udi_bus;
184 dev->device_address = di.udi_addr;
185 dev->speed = di.udi_speed;
187 dpriv = (struct device_priv *)dev->os_priv;
190 dpriv->devname = udevname;
192 dd.udd_bus = di.udi_bus;
193 dd.udd_addr = di.udi_addr;
194 if (ioctl(fd, USB_DEVICE_GET_DDESC, &dd) < 0) {
195 libusb_unref_device(dev);
198 dpriv->ddesc = dd.udd_desc;
200 if (_cache_active_config_descriptor(dev)) {
201 libusb_unref_device(dev);
205 if (usbi_sanitize_device(dev)) {
206 libusb_unref_device(dev);
211 ddd = discovered_devs_append(*discdevs, dev);
214 return (LIBUSB_ERROR_NO_MEM);
216 libusb_unref_device(dev);
225 return (LIBUSB_SUCCESS);
229 obsd_open(struct libusb_device_handle *handle)
231 struct device_priv *dpriv = (struct device_priv *)handle->dev->os_priv;
234 if (dpriv->devname) {
236 * Only open ugen(4) attached devices read-write, all
237 * read-only operations are done through the bus node.
239 snprintf(devnode, sizeof(devnode), DEVPATH "%s.00",
241 dpriv->fd = open(devnode, O_RDWR);
243 return _errno_to_libusb(errno);
245 usbi_dbg("open %s: fd %d", devnode, dpriv->fd);
248 return (LIBUSB_SUCCESS);
252 obsd_close(struct libusb_device_handle *handle)
254 struct device_priv *dpriv = (struct device_priv *)handle->dev->os_priv;
256 if (dpriv->devname) {
257 usbi_dbg("close: fd %d", dpriv->fd);
265 obsd_get_device_descriptor(struct libusb_device *dev, unsigned char *buf,
268 struct device_priv *dpriv = (struct device_priv *)dev->os_priv;
272 memcpy(buf, &dpriv->ddesc, DEVICE_DESC_LENGTH);
276 return (LIBUSB_SUCCESS);
280 obsd_get_active_config_descriptor(struct libusb_device *dev,
281 unsigned char *buf, size_t len, int *host_endian)
283 struct device_priv *dpriv = (struct device_priv *)dev->os_priv;
284 usb_config_descriptor_t *ucd = (usb_config_descriptor_t *)dpriv->cdesc;
286 len = MIN(len, UGETW(ucd->wTotalLength));
288 usbi_dbg("len %zu", len);
290 memcpy(buf, dpriv->cdesc, len);
298 obsd_get_config_descriptor(struct libusb_device *dev, uint8_t idx,
299 unsigned char *buf, size_t len, int *host_endian)
301 struct usb_device_fdesc udf;
304 if ((fd = _bus_open(dev->bus_number)) < 0)
305 return _errno_to_libusb(errno);
307 udf.udf_bus = dev->bus_number;
308 udf.udf_addr = dev->device_address;
309 udf.udf_config_index = idx;
313 usbi_dbg("index %d, len %zu", udf.udf_config_index, len);
315 if (ioctl(fd, USB_DEVICE_GET_FDESC, &udf) < 0) {
318 return _errno_to_libusb(err);
328 obsd_get_configuration(struct libusb_device_handle *handle, int *config)
330 struct device_priv *dpriv = (struct device_priv *)handle->dev->os_priv;
331 usb_config_descriptor_t *ucd = (usb_config_descriptor_t *)dpriv->cdesc;
333 *config = ucd->bConfigurationValue;
335 usbi_dbg("bConfigurationValue %d", *config);
337 return (LIBUSB_SUCCESS);
341 obsd_set_configuration(struct libusb_device_handle *handle, int config)
343 struct device_priv *dpriv = (struct device_priv *)handle->dev->os_priv;
345 if (dpriv->devname == NULL)
346 return (LIBUSB_ERROR_NOT_SUPPORTED);
348 usbi_dbg("bConfigurationValue %d", config);
350 if (ioctl(dpriv->fd, USB_SET_CONFIG, &config) < 0)
351 return _errno_to_libusb(errno);
353 return _cache_active_config_descriptor(handle->dev);
357 obsd_claim_interface(struct libusb_device_handle *handle, int iface)
359 struct handle_priv *hpriv = (struct handle_priv *)handle->os_priv;
362 for (i = 0; i < USB_MAX_ENDPOINTS; i++)
363 hpriv->endpoints[i] = -1;
365 return (LIBUSB_SUCCESS);
369 obsd_release_interface(struct libusb_device_handle *handle, int iface)
371 struct handle_priv *hpriv = (struct handle_priv *)handle->os_priv;
374 for (i = 0; i < USB_MAX_ENDPOINTS; i++)
375 if (hpriv->endpoints[i] >= 0)
376 close(hpriv->endpoints[i]);
378 return (LIBUSB_SUCCESS);
382 obsd_set_interface_altsetting(struct libusb_device_handle *handle, int iface,
385 struct device_priv *dpriv = (struct device_priv *)handle->dev->os_priv;
386 struct usb_alt_interface intf;
388 if (dpriv->devname == NULL)
389 return (LIBUSB_ERROR_NOT_SUPPORTED);
391 usbi_dbg("iface %d, setting %d", iface, altsetting);
393 memset(&intf, 0, sizeof(intf));
395 intf.uai_interface_index = iface;
396 intf.uai_alt_no = altsetting;
398 if (ioctl(dpriv->fd, USB_SET_ALTINTERFACE, &intf) < 0)
399 return _errno_to_libusb(errno);
401 return (LIBUSB_SUCCESS);
405 obsd_clear_halt(struct libusb_device_handle *handle, unsigned char endpoint)
407 struct usb_ctl_request req;
410 if ((fd = _bus_open(handle->dev->bus_number)) < 0)
411 return _errno_to_libusb(errno);
415 req.ucr_addr = handle->dev->device_address;
416 req.ucr_request.bmRequestType = UT_WRITE_ENDPOINT;
417 req.ucr_request.bRequest = UR_CLEAR_FEATURE;
418 USETW(req.ucr_request.wValue, UF_ENDPOINT_HALT);
419 USETW(req.ucr_request.wIndex, endpoint);
420 USETW(req.ucr_request.wLength, 0);
422 if (ioctl(fd, USB_REQUEST, &req) < 0) {
425 return _errno_to_libusb(err);
429 return (LIBUSB_SUCCESS);
433 obsd_reset_device(struct libusb_device_handle *handle)
437 return (LIBUSB_ERROR_NOT_SUPPORTED);
441 obsd_destroy_device(struct libusb_device *dev)
443 struct device_priv *dpriv = (struct device_priv *)dev->os_priv;
448 free(dpriv->devname);
452 obsd_submit_transfer(struct usbi_transfer *itransfer)
454 struct libusb_transfer *transfer;
455 struct handle_priv *hpriv;
460 transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
461 hpriv = (struct handle_priv *)transfer->dev_handle->os_priv;
463 switch (transfer->type) {
464 case LIBUSB_TRANSFER_TYPE_CONTROL:
465 err = _sync_control_transfer(itransfer);
467 case LIBUSB_TRANSFER_TYPE_ISOCHRONOUS:
468 if (IS_XFEROUT(transfer)) {
469 /* Isochronous write is not supported */
470 err = LIBUSB_ERROR_NOT_SUPPORTED;
473 err = _sync_gen_transfer(itransfer);
475 case LIBUSB_TRANSFER_TYPE_BULK:
476 case LIBUSB_TRANSFER_TYPE_INTERRUPT:
477 if (IS_XFEROUT(transfer) &&
478 transfer->flags & LIBUSB_TRANSFER_ADD_ZERO_PACKET) {
479 err = LIBUSB_ERROR_NOT_SUPPORTED;
482 err = _sync_gen_transfer(itransfer);
484 case LIBUSB_TRANSFER_TYPE_BULK_STREAM:
485 err = LIBUSB_ERROR_NOT_SUPPORTED;
492 usbi_signal_transfer_completion(itransfer);
494 return (LIBUSB_SUCCESS);
498 obsd_cancel_transfer(struct usbi_transfer *itransfer)
502 return (LIBUSB_ERROR_NOT_SUPPORTED);
506 obsd_clear_transfer_priv(struct usbi_transfer *itransfer)
514 obsd_handle_transfer_completion(struct usbi_transfer *itransfer)
516 return usbi_handle_transfer_completion(itransfer, LIBUSB_TRANSFER_COMPLETED);
520 obsd_clock_gettime(int clkid, struct timespec *tp)
522 if (clkid == USBI_CLOCK_REALTIME)
523 return clock_gettime(CLOCK_REALTIME, tp);
525 if (clkid == USBI_CLOCK_MONOTONIC)
526 return clock_gettime(CLOCK_MONOTONIC, tp);
528 return (LIBUSB_ERROR_INVALID_PARAM);
532 _errno_to_libusb(int err)
534 usbi_dbg("error: %s (%d)", strerror(err), err);
538 return (LIBUSB_ERROR_IO);
540 return (LIBUSB_ERROR_ACCESS);
542 return (LIBUSB_ERROR_NO_DEVICE);
544 return (LIBUSB_ERROR_NO_MEM);
546 return (LIBUSB_ERROR_TIMEOUT);
549 return (LIBUSB_ERROR_OTHER);
553 _cache_active_config_descriptor(struct libusb_device *dev)
555 struct device_priv *dpriv = (struct device_priv *)dev->os_priv;
556 struct usb_device_cdesc udc;
557 struct usb_device_fdesc udf;
561 if ((fd = _bus_open(dev->bus_number)) < 0)
562 return _errno_to_libusb(errno);
564 usbi_dbg("fd %d, addr %d", fd, dev->device_address);
566 udc.udc_bus = dev->bus_number;
567 udc.udc_addr = dev->device_address;
568 udc.udc_config_index = USB_CURRENT_CONFIG_INDEX;
569 if (ioctl(fd, USB_DEVICE_GET_CDESC, &udc) < 0) {
572 return _errno_to_libusb(errno);
575 usbi_dbg("active bLength %d", udc.udc_desc.bLength);
577 len = UGETW(udc.udc_desc.wTotalLength);
580 return (LIBUSB_ERROR_NO_MEM);
582 udf.udf_bus = dev->bus_number;
583 udf.udf_addr = dev->device_address;
584 udf.udf_config_index = udc.udc_config_index;
588 usbi_dbg("index %d, len %d", udf.udf_config_index, len);
590 if (ioctl(fd, USB_DEVICE_GET_FDESC, &udf) < 0) {
594 return _errno_to_libusb(err);
602 return (LIBUSB_SUCCESS);
606 _sync_control_transfer(struct usbi_transfer *itransfer)
608 struct libusb_transfer *transfer;
609 struct libusb_control_setup *setup;
610 struct device_priv *dpriv;
611 struct usb_ctl_request req;
613 transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
614 dpriv = (struct device_priv *)transfer->dev_handle->dev->os_priv;
615 setup = (struct libusb_control_setup *)transfer->buffer;
617 usbi_dbg("type %x request %x value %x index %d length %d timeout %d",
618 setup->bmRequestType, setup->bRequest,
619 libusb_le16_to_cpu(setup->wValue),
620 libusb_le16_to_cpu(setup->wIndex),
621 libusb_le16_to_cpu(setup->wLength), transfer->timeout);
623 req.ucr_addr = transfer->dev_handle->dev->device_address;
624 req.ucr_request.bmRequestType = setup->bmRequestType;
625 req.ucr_request.bRequest = setup->bRequest;
626 /* Don't use USETW, libusb already deals with the endianness */
627 (*(uint16_t *)req.ucr_request.wValue) = setup->wValue;
628 (*(uint16_t *)req.ucr_request.wIndex) = setup->wIndex;
629 (*(uint16_t *)req.ucr_request.wLength) = setup->wLength;
630 req.ucr_data = transfer->buffer + LIBUSB_CONTROL_SETUP_SIZE;
632 if ((transfer->flags & LIBUSB_TRANSFER_SHORT_NOT_OK) == 0)
633 req.ucr_flags = USBD_SHORT_XFER_OK;
635 if (dpriv->devname == NULL) {
637 * XXX If the device is not attached to ugen(4) it is
638 * XXX still possible to submit a control transfer but
639 * XXX with the default timeout only.
643 if ((fd = _bus_open(transfer->dev_handle->dev->bus_number)) < 0)
644 return _errno_to_libusb(errno);
646 if ((ioctl(fd, USB_REQUEST, &req)) < 0) {
649 return _errno_to_libusb(err);
653 if ((ioctl(dpriv->fd, USB_SET_TIMEOUT, &transfer->timeout)) < 0)
654 return _errno_to_libusb(errno);
656 if ((ioctl(dpriv->fd, USB_DO_REQUEST, &req)) < 0)
657 return _errno_to_libusb(errno);
660 itransfer->transferred = req.ucr_actlen;
662 usbi_dbg("transferred %d", itransfer->transferred);
668 _access_endpoint(struct libusb_transfer *transfer)
670 struct handle_priv *hpriv;
671 struct device_priv *dpriv;
676 hpriv = (struct handle_priv *)transfer->dev_handle->os_priv;
677 dpriv = (struct device_priv *)transfer->dev_handle->dev->os_priv;
679 endpt = UE_GET_ADDR(transfer->endpoint);
680 mode = IS_XFERIN(transfer) ? O_RDONLY : O_WRONLY;
682 usbi_dbg("endpoint %d mode %d", endpt, mode);
684 if (hpriv->endpoints[endpt] < 0) {
685 /* Pick the right endpoint node */
686 snprintf(devnode, sizeof(devnode), DEVPATH "%s.%02d",
687 dpriv->devname, endpt);
689 /* We may need to read/write to the same endpoint later. */
690 if (((fd = open(devnode, O_RDWR)) < 0) && (errno == ENXIO))
691 if ((fd = open(devnode, mode)) < 0)
694 hpriv->endpoints[endpt] = fd;
697 return (hpriv->endpoints[endpt]);
701 _sync_gen_transfer(struct usbi_transfer *itransfer)
703 struct libusb_transfer *transfer;
704 struct device_priv *dpriv;
707 transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
708 dpriv = (struct device_priv *)transfer->dev_handle->dev->os_priv;
710 if (dpriv->devname == NULL)
711 return (LIBUSB_ERROR_NOT_SUPPORTED);
714 * Bulk, Interrupt or Isochronous transfer depends on the
715 * endpoint and thus the node to open.
717 if ((fd = _access_endpoint(transfer)) < 0)
718 return _errno_to_libusb(errno);
720 if ((ioctl(fd, USB_SET_TIMEOUT, &transfer->timeout)) < 0)
721 return _errno_to_libusb(errno);
723 if (IS_XFERIN(transfer)) {
724 if ((transfer->flags & LIBUSB_TRANSFER_SHORT_NOT_OK) == 0)
725 if ((ioctl(fd, USB_SET_SHORT_XFER, &nr)) < 0)
726 return _errno_to_libusb(errno);
728 nr = read(fd, transfer->buffer, transfer->length);
730 nr = write(fd, transfer->buffer, transfer->length);
734 return _errno_to_libusb(errno);
736 itransfer->transferred = nr;
742 _bus_open(int number)
746 snprintf(busnode, sizeof(busnode), USBDEV "%d", number);
748 return open(busnode, O_RDWR);