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 "Synchronous OpenBSD backend",
97 NULL, /* set_option() */
99 NULL, /* hotplug_poll */
103 obsd_get_device_descriptor,
104 obsd_get_active_config_descriptor,
105 obsd_get_config_descriptor,
106 NULL, /* get_config_descriptor_by_value() */
108 obsd_get_configuration,
109 obsd_set_configuration,
111 obsd_claim_interface,
112 obsd_release_interface,
114 obsd_set_interface_altsetting,
118 NULL, /* alloc_streams */
119 NULL, /* free_streams */
121 NULL, /* dev_mem_alloc() */
122 NULL, /* dev_mem_free() */
124 NULL, /* kernel_driver_active() */
125 NULL, /* detach_kernel_driver() */
126 NULL, /* attach_kernel_driver() */
130 obsd_submit_transfer,
131 obsd_cancel_transfer,
132 obsd_clear_transfer_priv,
134 NULL, /* handle_events() */
135 obsd_handle_transfer_completion,
138 0, /* context_priv_size */
139 sizeof(struct device_priv),
140 sizeof(struct handle_priv),
141 0, /* transfer_priv_size */
144 #define DEVPATH "/dev/"
145 #define USBDEV DEVPATH "usb"
148 obsd_get_device_list(struct libusb_context * ctx,
149 struct discovered_devs **discdevs)
151 struct discovered_devs *ddd;
152 struct libusb_device *dev;
153 struct device_priv *dpriv;
154 struct usb_device_info di;
155 struct usb_device_ddesc dd;
156 unsigned long session_id;
157 char devices[USB_MAX_DEVICES];
164 for (i = 0; i < 8; i++) {
165 snprintf(busnode, sizeof(busnode), USBDEV "%d", i);
167 if ((fd = open(busnode, O_RDWR)) < 0) {
168 if (errno != ENOENT && errno != ENXIO)
169 usbi_err(ctx, "could not open %s", busnode);
173 bzero(devices, sizeof(devices));
174 for (addr = 1; addr < USB_MAX_DEVICES; addr++) {
179 if (ioctl(fd, USB_DEVICEINFO, &di) < 0)
183 * XXX If ugen(4) is attached to the USB device
187 for (j = 0; j < USB_MAX_DEVNAMES; j++)
188 if (!strncmp("ugen", di.udi_devnames[j], 4)) {
189 udevname = strdup(di.udi_devnames[j]);
193 session_id = (di.udi_bus << 8 | di.udi_addr);
194 dev = usbi_get_device_by_session_id(ctx, session_id);
197 dev = usbi_alloc_device(ctx, session_id);
200 return (LIBUSB_ERROR_NO_MEM);
203 dev->bus_number = di.udi_bus;
204 dev->device_address = di.udi_addr;
205 dev->speed = di.udi_speed;
207 dpriv = (struct device_priv *)dev->os_priv;
210 dpriv->devname = udevname;
212 dd.udd_bus = di.udi_bus;
213 dd.udd_addr = di.udi_addr;
214 if (ioctl(fd, USB_DEVICE_GET_DDESC, &dd) < 0) {
215 libusb_unref_device(dev);
218 dpriv->ddesc = dd.udd_desc;
220 if (_cache_active_config_descriptor(dev)) {
221 libusb_unref_device(dev);
225 if (usbi_sanitize_device(dev)) {
226 libusb_unref_device(dev);
231 ddd = discovered_devs_append(*discdevs, dev);
234 return (LIBUSB_ERROR_NO_MEM);
236 libusb_unref_device(dev);
245 return (LIBUSB_SUCCESS);
249 obsd_open(struct libusb_device_handle *handle)
251 struct device_priv *dpriv = (struct device_priv *)handle->dev->os_priv;
254 if (dpriv->devname) {
256 * Only open ugen(4) attached devices read-write, all
257 * read-only operations are done through the bus node.
259 snprintf(devnode, sizeof(devnode), DEVPATH "%s.00",
261 dpriv->fd = open(devnode, O_RDWR);
263 return _errno_to_libusb(errno);
265 usbi_dbg("open %s: fd %d", devnode, dpriv->fd);
268 return (LIBUSB_SUCCESS);
272 obsd_close(struct libusb_device_handle *handle)
274 struct device_priv *dpriv = (struct device_priv *)handle->dev->os_priv;
276 if (dpriv->devname) {
277 usbi_dbg("close: fd %d", dpriv->fd);
285 obsd_get_device_descriptor(struct libusb_device *dev, unsigned char *buf,
288 struct device_priv *dpriv = (struct device_priv *)dev->os_priv;
292 memcpy(buf, &dpriv->ddesc, DEVICE_DESC_LENGTH);
296 return (LIBUSB_SUCCESS);
300 obsd_get_active_config_descriptor(struct libusb_device *dev,
301 unsigned char *buf, size_t len, int *host_endian)
303 struct device_priv *dpriv = (struct device_priv *)dev->os_priv;
304 usb_config_descriptor_t *ucd = (usb_config_descriptor_t *)dpriv->cdesc;
306 len = MIN(len, UGETW(ucd->wTotalLength));
308 usbi_dbg("len %d", len);
310 memcpy(buf, dpriv->cdesc, len);
318 obsd_get_config_descriptor(struct libusb_device *dev, uint8_t idx,
319 unsigned char *buf, size_t len, int *host_endian)
321 struct usb_device_fdesc udf;
324 if ((fd = _bus_open(dev->bus_number)) < 0)
325 return _errno_to_libusb(errno);
327 udf.udf_bus = dev->bus_number;
328 udf.udf_addr = dev->device_address;
329 udf.udf_config_index = idx;
333 usbi_dbg("index %d, len %d", udf.udf_config_index, len);
335 if (ioctl(fd, USB_DEVICE_GET_FDESC, &udf) < 0) {
338 return _errno_to_libusb(err);
348 obsd_get_configuration(struct libusb_device_handle *handle, int *config)
350 struct device_priv *dpriv = (struct device_priv *)handle->dev->os_priv;
351 usb_config_descriptor_t *ucd = (usb_config_descriptor_t *)dpriv->cdesc;
353 *config = ucd->bConfigurationValue;
355 usbi_dbg("bConfigurationValue %d", *config);
357 return (LIBUSB_SUCCESS);
361 obsd_set_configuration(struct libusb_device_handle *handle, int config)
363 struct device_priv *dpriv = (struct device_priv *)handle->dev->os_priv;
365 if (dpriv->devname == NULL)
366 return (LIBUSB_ERROR_NOT_SUPPORTED);
368 usbi_dbg("bConfigurationValue %d", config);
370 if (ioctl(dpriv->fd, USB_SET_CONFIG, &config) < 0)
371 return _errno_to_libusb(errno);
373 return _cache_active_config_descriptor(handle->dev);
377 obsd_claim_interface(struct libusb_device_handle *handle, int iface)
379 struct handle_priv *hpriv = (struct handle_priv *)handle->os_priv;
382 for (i = 0; i < USB_MAX_ENDPOINTS; i++)
383 hpriv->endpoints[i] = -1;
385 return (LIBUSB_SUCCESS);
389 obsd_release_interface(struct libusb_device_handle *handle, int iface)
391 struct handle_priv *hpriv = (struct handle_priv *)handle->os_priv;
394 for (i = 0; i < USB_MAX_ENDPOINTS; i++)
395 if (hpriv->endpoints[i] >= 0)
396 close(hpriv->endpoints[i]);
398 return (LIBUSB_SUCCESS);
402 obsd_set_interface_altsetting(struct libusb_device_handle *handle, int iface,
405 struct device_priv *dpriv = (struct device_priv *)handle->dev->os_priv;
406 struct usb_alt_interface intf;
408 if (dpriv->devname == NULL)
409 return (LIBUSB_ERROR_NOT_SUPPORTED);
411 usbi_dbg("iface %d, setting %d", iface, altsetting);
413 memset(&intf, 0, sizeof(intf));
415 intf.uai_interface_index = iface;
416 intf.uai_alt_no = altsetting;
418 if (ioctl(dpriv->fd, USB_SET_ALTINTERFACE, &intf) < 0)
419 return _errno_to_libusb(errno);
421 return (LIBUSB_SUCCESS);
425 obsd_clear_halt(struct libusb_device_handle *handle, unsigned char endpoint)
427 struct usb_ctl_request req;
430 if ((fd = _bus_open(handle->dev->bus_number)) < 0)
431 return _errno_to_libusb(errno);
435 req.ucr_addr = handle->dev->device_address;
436 req.ucr_request.bmRequestType = UT_WRITE_ENDPOINT;
437 req.ucr_request.bRequest = UR_CLEAR_FEATURE;
438 USETW(req.ucr_request.wValue, UF_ENDPOINT_HALT);
439 USETW(req.ucr_request.wIndex, endpoint);
440 USETW(req.ucr_request.wLength, 0);
442 if (ioctl(fd, USB_REQUEST, &req) < 0) {
445 return _errno_to_libusb(err);
449 return (LIBUSB_SUCCESS);
453 obsd_reset_device(struct libusb_device_handle *handle)
457 return (LIBUSB_ERROR_NOT_SUPPORTED);
461 obsd_destroy_device(struct libusb_device *dev)
463 struct device_priv *dpriv = (struct device_priv *)dev->os_priv;
468 free(dpriv->devname);
472 obsd_submit_transfer(struct usbi_transfer *itransfer)
474 struct libusb_transfer *transfer;
475 struct handle_priv *hpriv;
480 transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
481 hpriv = (struct handle_priv *)transfer->dev_handle->os_priv;
483 switch (transfer->type) {
484 case LIBUSB_TRANSFER_TYPE_CONTROL:
485 err = _sync_control_transfer(itransfer);
487 case LIBUSB_TRANSFER_TYPE_ISOCHRONOUS:
488 if (IS_XFEROUT(transfer)) {
489 /* Isochronous write is not supported */
490 err = LIBUSB_ERROR_NOT_SUPPORTED;
493 err = _sync_gen_transfer(itransfer);
495 case LIBUSB_TRANSFER_TYPE_BULK:
496 case LIBUSB_TRANSFER_TYPE_INTERRUPT:
497 if (IS_XFEROUT(transfer) &&
498 transfer->flags & LIBUSB_TRANSFER_ADD_ZERO_PACKET) {
499 err = LIBUSB_ERROR_NOT_SUPPORTED;
502 err = _sync_gen_transfer(itransfer);
504 case LIBUSB_TRANSFER_TYPE_BULK_STREAM:
505 err = LIBUSB_ERROR_NOT_SUPPORTED;
512 usbi_signal_transfer_completion(itransfer);
514 return (LIBUSB_SUCCESS);
518 obsd_cancel_transfer(struct usbi_transfer *itransfer)
522 return (LIBUSB_ERROR_NOT_SUPPORTED);
526 obsd_clear_transfer_priv(struct usbi_transfer *itransfer)
534 obsd_handle_transfer_completion(struct usbi_transfer *itransfer)
536 return usbi_handle_transfer_completion(itransfer, LIBUSB_TRANSFER_COMPLETED);
540 obsd_clock_gettime(int clkid, struct timespec *tp)
542 usbi_dbg("clock %d", clkid);
544 if (clkid == USBI_CLOCK_REALTIME)
545 return clock_gettime(CLOCK_REALTIME, tp);
547 if (clkid == USBI_CLOCK_MONOTONIC)
548 return clock_gettime(CLOCK_MONOTONIC, tp);
550 return (LIBUSB_ERROR_INVALID_PARAM);
554 _errno_to_libusb(int err)
556 usbi_dbg("error: %s (%d)", strerror(err), err);
560 return (LIBUSB_ERROR_IO);
562 return (LIBUSB_ERROR_ACCESS);
564 return (LIBUSB_ERROR_NO_DEVICE);
566 return (LIBUSB_ERROR_NO_MEM);
568 return (LIBUSB_ERROR_TIMEOUT);
571 return (LIBUSB_ERROR_OTHER);
575 _cache_active_config_descriptor(struct libusb_device *dev)
577 struct device_priv *dpriv = (struct device_priv *)dev->os_priv;
578 struct usb_device_cdesc udc;
579 struct usb_device_fdesc udf;
583 if ((fd = _bus_open(dev->bus_number)) < 0)
584 return _errno_to_libusb(errno);
586 usbi_dbg("fd %d, addr %d", fd, dev->device_address);
588 udc.udc_bus = dev->bus_number;
589 udc.udc_addr = dev->device_address;
590 udc.udc_config_index = USB_CURRENT_CONFIG_INDEX;
591 if (ioctl(fd, USB_DEVICE_GET_CDESC, &udc) < 0) {
594 return _errno_to_libusb(errno);
597 usbi_dbg("active bLength %d", udc.udc_desc.bLength);
599 len = UGETW(udc.udc_desc.wTotalLength);
602 return (LIBUSB_ERROR_NO_MEM);
604 udf.udf_bus = dev->bus_number;
605 udf.udf_addr = dev->device_address;
606 udf.udf_config_index = udc.udc_config_index;
610 usbi_dbg("index %d, len %d", udf.udf_config_index, len);
612 if (ioctl(fd, USB_DEVICE_GET_FDESC, &udf) < 0) {
616 return _errno_to_libusb(err);
624 return (LIBUSB_SUCCESS);
628 _sync_control_transfer(struct usbi_transfer *itransfer)
630 struct libusb_transfer *transfer;
631 struct libusb_control_setup *setup;
632 struct device_priv *dpriv;
633 struct usb_ctl_request req;
635 transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
636 dpriv = (struct device_priv *)transfer->dev_handle->dev->os_priv;
637 setup = (struct libusb_control_setup *)transfer->buffer;
639 usbi_dbg("type %x request %x value %x index %d length %d timeout %d",
640 setup->bmRequestType, setup->bRequest,
641 libusb_le16_to_cpu(setup->wValue),
642 libusb_le16_to_cpu(setup->wIndex),
643 libusb_le16_to_cpu(setup->wLength), transfer->timeout);
645 req.ucr_addr = transfer->dev_handle->dev->device_address;
646 req.ucr_request.bmRequestType = setup->bmRequestType;
647 req.ucr_request.bRequest = setup->bRequest;
648 /* Don't use USETW, libusb already deals with the endianness */
649 (*(uint16_t *)req.ucr_request.wValue) = setup->wValue;
650 (*(uint16_t *)req.ucr_request.wIndex) = setup->wIndex;
651 (*(uint16_t *)req.ucr_request.wLength) = setup->wLength;
652 req.ucr_data = transfer->buffer + LIBUSB_CONTROL_SETUP_SIZE;
654 if ((transfer->flags & LIBUSB_TRANSFER_SHORT_NOT_OK) == 0)
655 req.ucr_flags = USBD_SHORT_XFER_OK;
657 if (dpriv->devname == NULL) {
659 * XXX If the device is not attached to ugen(4) it is
660 * XXX still possible to submit a control transfer but
661 * XXX with the default timeout only.
665 if ((fd = _bus_open(transfer->dev_handle->dev->bus_number)) < 0)
666 return _errno_to_libusb(errno);
668 if ((ioctl(fd, USB_REQUEST, &req)) < 0) {
671 return _errno_to_libusb(err);
675 if ((ioctl(dpriv->fd, USB_SET_TIMEOUT, &transfer->timeout)) < 0)
676 return _errno_to_libusb(errno);
678 if ((ioctl(dpriv->fd, USB_DO_REQUEST, &req)) < 0)
679 return _errno_to_libusb(errno);
682 itransfer->transferred = req.ucr_actlen;
684 usbi_dbg("transferred %d", itransfer->transferred);
690 _access_endpoint(struct libusb_transfer *transfer)
692 struct handle_priv *hpriv;
693 struct device_priv *dpriv;
698 hpriv = (struct handle_priv *)transfer->dev_handle->os_priv;
699 dpriv = (struct device_priv *)transfer->dev_handle->dev->os_priv;
701 endpt = UE_GET_ADDR(transfer->endpoint);
702 mode = IS_XFERIN(transfer) ? O_RDONLY : O_WRONLY;
704 usbi_dbg("endpoint %d mode %d", endpt, mode);
706 if (hpriv->endpoints[endpt] < 0) {
707 /* Pick the right endpoint node */
708 snprintf(devnode, sizeof(devnode), DEVPATH "%s.%02d",
709 dpriv->devname, endpt);
711 /* We may need to read/write to the same endpoint later. */
712 if (((fd = open(devnode, O_RDWR)) < 0) && (errno == ENXIO))
713 if ((fd = open(devnode, mode)) < 0)
716 hpriv->endpoints[endpt] = fd;
719 return (hpriv->endpoints[endpt]);
723 _sync_gen_transfer(struct usbi_transfer *itransfer)
725 struct libusb_transfer *transfer;
726 struct device_priv *dpriv;
729 transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
730 dpriv = (struct device_priv *)transfer->dev_handle->dev->os_priv;
732 if (dpriv->devname == NULL)
733 return (LIBUSB_ERROR_NOT_SUPPORTED);
736 * Bulk, Interrupt or Isochronous transfer depends on the
737 * endpoint and thus the node to open.
739 if ((fd = _access_endpoint(transfer)) < 0)
740 return _errno_to_libusb(errno);
742 if ((ioctl(fd, USB_SET_TIMEOUT, &transfer->timeout)) < 0)
743 return _errno_to_libusb(errno);
745 if (IS_XFERIN(transfer)) {
746 if ((transfer->flags & LIBUSB_TRANSFER_SHORT_NOT_OK) == 0)
747 if ((ioctl(fd, USB_SET_SHORT_XFER, &nr)) < 0)
748 return _errno_to_libusb(errno);
750 nr = read(fd, transfer->buffer, transfer->length);
752 nr = write(fd, transfer->buffer, transfer->length);
756 return _errno_to_libusb(errno);
758 itransfer->transferred = nr;
764 _bus_open(int number)
768 snprintf(busnode, sizeof(busnode), USBDEV "%d", number);
770 return open(busnode, O_RDWR);