2 * Copyright © 2011 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
20 #include <sys/types.h>
29 #include <dev/usb/usb.h>
38 unsigned char *cdesc; /* active config descriptor */
39 usb_device_descriptor_t ddesc; /* usb device descriptor */
43 int pipe[2]; /* for event notification */
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_events(struct libusb_context *ctx, struct pollfd *,
79 static int obsd_clock_gettime(int, struct timespec *);
84 static int _errno_to_libusb(int);
85 static int _cache_active_config_descriptor(struct libusb_device *, int);
86 static int _sync_control_transfer(struct usbi_transfer *);
87 static int _sync_gen_transfer(struct usbi_transfer *);
88 static int _access_endpoint(struct libusb_transfer *);
90 const struct usbi_os_backend openbsd_backend = {
91 "Synchronous OpenBSD backend",
98 obsd_get_device_descriptor,
99 obsd_get_active_config_descriptor,
100 obsd_get_config_descriptor,
102 obsd_get_configuration,
103 obsd_set_configuration,
105 obsd_claim_interface,
106 obsd_release_interface,
108 obsd_set_interface_altsetting,
112 NULL, /* kernel_driver_active() */
113 NULL, /* detach_kernel_driver() */
114 NULL, /* attach_kernel_driver() */
118 obsd_submit_transfer,
119 obsd_cancel_transfer,
120 obsd_clear_transfer_priv,
125 sizeof(struct device_priv),
126 sizeof(struct handle_priv),
127 0, /* transfer_priv_size */
128 0, /* add_iso_packet_size */
132 obsd_get_device_list(struct libusb_context * ctx,
133 struct discovered_devs **discdevs)
135 struct libusb_device *dev;
136 struct device_priv *dpriv;
137 struct usb_device_info di;
138 unsigned long session_id;
144 /* Only ugen(4) is supported */
145 for (i = 0; i < USB_MAX_DEVICES; i++) {
146 /* Control endpoint is always .00 */
147 snprintf(devnode, sizeof(devnode), "/dev/ugen%d.00", i);
149 if ((fd = open(devnode, O_RDONLY)) < 0) {
150 if (errno != ENOENT && errno != ENXIO)
151 usbi_err(ctx, "could not open %s", devnode);
155 if (ioctl(fd, USB_GET_DEVICEINFO, &di) < 0)
158 session_id = (di.udi_bus << 8 | di.udi_addr);
159 dev = usbi_get_device_by_session_id(ctx, session_id);
162 dev = usbi_alloc_device(ctx, session_id);
164 return (LIBUSB_ERROR_NO_MEM);
166 dev->bus_number = di.udi_bus;
167 dev->device_address = di.udi_addr;
168 dev->speed = di.udi_speed;
170 dpriv = (struct device_priv *)dev->os_priv;
171 strlcpy(dpriv->devnode, devnode, sizeof(devnode));
174 if (ioctl(fd, USB_GET_DEVICE_DESC, &dpriv->ddesc) < 0) {
180 if (_cache_active_config_descriptor(dev, fd)) {
185 if ((err = usbi_sanitize_device(dev)))
190 if (discovered_devs_append(*discdevs, dev) == NULL)
191 return (LIBUSB_ERROR_NO_MEM);
194 return (LIBUSB_SUCCESS);
198 libusb_unref_device(dev);
199 return _errno_to_libusb(err);
203 obsd_open(struct libusb_device_handle *handle)
205 struct handle_priv *hpriv = (struct handle_priv *)handle->os_priv;
206 struct device_priv *dpriv = (struct device_priv *)handle->dev->os_priv;
208 dpriv->fd = open(dpriv->devnode, O_RDWR);
210 dpriv->fd = open(dpriv->devnode, O_RDONLY);
212 return _errno_to_libusb(errno);
215 usbi_dbg("open %s: fd %d", dpriv->devnode, dpriv->fd);
217 if (pipe(hpriv->pipe) < 0)
218 return _errno_to_libusb(errno);
220 return usbi_add_pollfd(HANDLE_CTX(handle), hpriv->pipe[0], POLLIN);
224 obsd_close(struct libusb_device_handle *handle)
226 struct handle_priv *hpriv = (struct handle_priv *)handle->os_priv;
227 struct device_priv *dpriv = (struct device_priv *)handle->dev->os_priv;
229 usbi_dbg("close: fd %d", dpriv->fd);
234 usbi_remove_pollfd(HANDLE_CTX(handle), hpriv->pipe[0]);
236 close(hpriv->pipe[0]);
237 close(hpriv->pipe[1]);
241 obsd_get_device_descriptor(struct libusb_device *dev, unsigned char *buf,
244 struct device_priv *dpriv = (struct device_priv *)dev->os_priv;
248 memcpy(buf, &dpriv->ddesc, DEVICE_DESC_LENGTH);
252 return (LIBUSB_SUCCESS);
256 obsd_get_active_config_descriptor(struct libusb_device *dev,
257 unsigned char *buf, size_t len, int *host_endian)
259 struct device_priv *dpriv = (struct device_priv *)dev->os_priv;
260 usb_config_descriptor_t *ucd;
262 ucd = (usb_config_descriptor_t *) dpriv->cdesc;
263 len = MIN(len, UGETW(ucd->wTotalLength));
265 usbi_dbg("len %d", len);
267 memcpy(buf, dpriv->cdesc, len);
271 return (LIBUSB_SUCCESS);
275 obsd_get_config_descriptor(struct libusb_device *dev, uint8_t idx,
276 unsigned char *buf, size_t len, int *host_endian)
278 struct device_priv *dpriv = (struct device_priv *)dev->os_priv;
279 struct usb_full_desc ufd;
282 usbi_dbg("index %d, len %d", idx, len);
284 /* A config descriptor may be requested before opening the device */
285 if (dpriv->fd >= 0) {
288 fd = open(dpriv->devnode, O_RDONLY);
290 return _errno_to_libusb(errno);
293 ufd.ufd_config_index = idx;
297 if ((ioctl(fd, USB_GET_FULL_DESC, &ufd)) < 0) {
301 return _errno_to_libusb(err);
309 return (LIBUSB_SUCCESS);
313 obsd_get_configuration(struct libusb_device_handle *handle, int *config)
315 struct device_priv *dpriv = (struct device_priv *)handle->dev->os_priv;
319 if (ioctl(dpriv->fd, USB_GET_CONFIG, config) < 0)
320 return _errno_to_libusb(errno);
322 usbi_dbg("configuration %d", *config);
324 return (LIBUSB_SUCCESS);
328 obsd_set_configuration(struct libusb_device_handle *handle, int config)
330 struct device_priv *dpriv = (struct device_priv *)handle->dev->os_priv;
332 usbi_dbg("configuration %d", config);
334 if (ioctl(dpriv->fd, USB_SET_CONFIG, &config) < 0)
335 return _errno_to_libusb(errno);
337 return _cache_active_config_descriptor(handle->dev, dpriv->fd);
341 obsd_claim_interface(struct libusb_device_handle *handle, int iface)
343 struct handle_priv *hpriv = (struct handle_priv *)handle->os_priv;
346 for (i = 0; i < USB_MAX_ENDPOINTS; i++)
347 hpriv->endpoints[i] = -1;
349 return (LIBUSB_SUCCESS);
353 obsd_release_interface(struct libusb_device_handle *handle, int iface)
355 struct handle_priv *hpriv = (struct handle_priv *)handle->os_priv;
358 for (i = 0; i < USB_MAX_ENDPOINTS; i++)
359 if (hpriv->endpoints[i] >= 0)
360 close(hpriv->endpoints[i]);
362 return (LIBUSB_SUCCESS);
366 obsd_set_interface_altsetting(struct libusb_device_handle *handle, int iface,
369 struct device_priv *dpriv = (struct device_priv *)handle->dev->os_priv;
370 struct usb_alt_interface intf;
372 usbi_dbg("iface %d, setting %d", iface, altsetting);
374 memset(&intf, 0, sizeof(intf));
376 intf.uai_interface_index = iface;
377 intf.uai_alt_no = altsetting;
379 if (ioctl(dpriv->fd, USB_SET_ALTINTERFACE, &intf) < 0)
380 return _errno_to_libusb(errno);
382 return (LIBUSB_SUCCESS);
386 obsd_clear_halt(struct libusb_device_handle *handle, unsigned char endpoint)
388 struct device_priv *dpriv = (struct device_priv *)handle->dev->os_priv;
389 struct usb_ctl_request req;
393 req.ucr_request.bmRequestType = UT_WRITE_ENDPOINT;
394 req.ucr_request.bRequest = UR_CLEAR_FEATURE;
395 USETW(req.ucr_request.wValue, UF_ENDPOINT_HALT);
396 USETW(req.ucr_request.wIndex, endpoint);
397 USETW(req.ucr_request.wLength, 0);
399 if (ioctl(dpriv->fd, USB_DO_REQUEST, &req) < 0)
400 return _errno_to_libusb(errno);
402 return (LIBUSB_SUCCESS);
406 obsd_reset_device(struct libusb_device_handle *handle)
410 return (LIBUSB_ERROR_NOT_SUPPORTED);
414 obsd_destroy_device(struct libusb_device *dev)
416 struct device_priv *dpriv = (struct device_priv *)dev->os_priv;
424 obsd_submit_transfer(struct usbi_transfer *itransfer)
426 struct libusb_transfer *transfer;
427 struct handle_priv *hpriv;
432 transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
433 hpriv = (struct handle_priv *)transfer->dev_handle->os_priv;
435 switch (transfer->type) {
436 case LIBUSB_TRANSFER_TYPE_CONTROL:
437 err = _sync_control_transfer(itransfer);
439 case LIBUSB_TRANSFER_TYPE_ISOCHRONOUS:
440 if (IS_XFEROUT(transfer)) {
441 /* Isochronous write is not supported */
442 err = LIBUSB_ERROR_NOT_SUPPORTED;
445 err = _sync_gen_transfer(itransfer);
447 case LIBUSB_TRANSFER_TYPE_BULK:
448 case LIBUSB_TRANSFER_TYPE_INTERRUPT:
449 if (IS_XFEROUT(transfer) &&
450 transfer->flags & LIBUSB_TRANSFER_ADD_ZERO_PACKET) {
451 err = LIBUSB_ERROR_NOT_SUPPORTED;
454 err = _sync_gen_transfer(itransfer);
461 if (write(hpriv->pipe[1], &itransfer, sizeof(itransfer)) < 0)
462 return _errno_to_libusb(errno);
464 return (LIBUSB_SUCCESS);
468 obsd_cancel_transfer(struct usbi_transfer *itransfer)
472 return (LIBUSB_ERROR_NOT_SUPPORTED);
476 obsd_clear_transfer_priv(struct usbi_transfer *itransfer)
484 obsd_handle_events(struct libusb_context *ctx, struct pollfd *fds, nfds_t nfds,
487 struct libusb_device_handle *handle;
488 struct handle_priv *hpriv = NULL;
489 struct usbi_transfer *itransfer;
490 struct pollfd *pollfd;
495 pthread_mutex_lock(&ctx->open_devs_lock);
496 for (i = 0; i < nfds && num_ready > 0; i++) {
499 if (!pollfd->revents)
504 list_for_each_entry(handle, &ctx->open_devs, list,
505 struct libusb_device_handle) {
506 hpriv = (struct handle_priv *)handle->os_priv;
508 if (hpriv->pipe[0] == pollfd->fd)
515 usbi_dbg("fd %d is not an event pipe!", pollfd->fd);
520 if (pollfd->revents & POLLERR) {
521 usbi_remove_pollfd(HANDLE_CTX(handle), hpriv->pipe[0]);
522 usbi_handle_disconnect(handle);
526 if (read(hpriv->pipe[0], &itransfer, sizeof(itransfer)) < 0) {
531 if ((err = usbi_handle_transfer_completion(itransfer,
532 LIBUSB_TRANSFER_COMPLETED)))
535 pthread_mutex_unlock(&ctx->open_devs_lock);
538 return _errno_to_libusb(err);
540 return (LIBUSB_SUCCESS);
544 obsd_clock_gettime(int clkid, struct timespec *tp)
546 usbi_dbg("clock %d", clkid);
548 if (clkid == USBI_CLOCK_REALTIME)
549 return clock_gettime(CLOCK_REALTIME, tp);
551 if (clkid == USBI_CLOCK_MONOTONIC)
552 return clock_gettime(CLOCK_MONOTONIC, tp);
554 return (LIBUSB_ERROR_INVALID_PARAM);
558 _errno_to_libusb(int err)
562 return (LIBUSB_ERROR_IO);
564 return (LIBUSB_ERROR_ACCESS);
566 return (LIBUSB_ERROR_NO_DEVICE);
568 return (LIBUSB_ERROR_NO_MEM);
571 usbi_dbg("error: %s", strerror(err));
573 return (LIBUSB_ERROR_OTHER);
577 _cache_active_config_descriptor(struct libusb_device *dev, int fd)
579 struct device_priv *dpriv = (struct device_priv *)dev->os_priv;
580 struct usb_config_desc ucd;
581 struct usb_full_desc ufd;
585 usbi_dbg("fd %d", fd);
587 ucd.ucd_config_index = USB_CURRENT_CONFIG_INDEX;
589 if ((ioctl(fd, USB_GET_CONFIG_DESC, &ucd)) < 0)
590 return _errno_to_libusb(errno);
592 usbi_dbg("active bLength %d", ucd.ucd_desc.bLength);
594 len = UGETW(ucd.ucd_desc.wTotalLength);
597 return (LIBUSB_ERROR_NO_MEM);
599 ufd.ufd_config_index = ucd.ucd_config_index;
603 usbi_dbg("index %d, len %d", ufd.ufd_config_index, len);
605 if ((ioctl(fd, USB_GET_FULL_DESC, &ufd)) < 0) {
607 return _errno_to_libusb(errno);
618 _sync_control_transfer(struct usbi_transfer *itransfer)
620 struct libusb_transfer *transfer;
621 struct libusb_control_setup *setup;
622 struct device_priv *dpriv;
623 struct usb_ctl_request req;
625 transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
626 dpriv = (struct device_priv *)transfer->dev_handle->dev->os_priv;
627 setup = (struct libusb_control_setup *)transfer->buffer;
629 usbi_dbg("type %d request %d value %d index %d length %d timeout %d",
630 setup->bmRequestType, setup->bRequest,
631 libusb_le16_to_cpu(setup->wValue),
632 libusb_le16_to_cpu(setup->wIndex),
633 libusb_le16_to_cpu(setup->wLength), transfer->timeout);
635 req.ucr_request.bmRequestType = setup->bmRequestType;
636 req.ucr_request.bRequest = setup->bRequest;
637 /* Don't use USETW, libusbx already deals with the endianness */
638 (*(uint16_t *)req.ucr_request.wValue) = setup->wValue;
639 (*(uint16_t *)req.ucr_request.wIndex) = setup->wIndex;
640 (*(uint16_t *)req.ucr_request.wLength) = setup->wLength;
641 req.ucr_data = transfer->buffer + LIBUSB_CONTROL_SETUP_SIZE;
643 if ((transfer->flags & LIBUSB_TRANSFER_SHORT_NOT_OK) == 0)
644 req.ucr_flags = USBD_SHORT_XFER_OK;
646 if ((ioctl(dpriv->fd, USB_SET_TIMEOUT, &transfer->timeout)) < 0)
647 return _errno_to_libusb(errno);
649 if ((ioctl(dpriv->fd, USB_DO_REQUEST, &req)) < 0)
650 return _errno_to_libusb(errno);
652 itransfer->transferred = req.ucr_actlen;
654 usbi_dbg("transferred %d", itransfer->transferred);
660 _access_endpoint(struct libusb_transfer *transfer)
662 struct handle_priv *hpriv;
663 struct device_priv *dpriv;
664 char *s, devnode[16];
668 hpriv = (struct handle_priv *)transfer->dev_handle->os_priv;
669 dpriv = (struct device_priv *)transfer->dev_handle->dev->os_priv;
671 endpt = UE_GET_ADDR(transfer->endpoint);
672 mode = IS_XFERIN(transfer) ? O_RDONLY : O_WRONLY;
674 usbi_dbg("endpoint %d mode %d", endpt, mode);
676 if (hpriv->endpoints[endpt] < 0) {
677 /* Pick the right node given the control one */
678 strlcpy(devnode, dpriv->devnode, sizeof(devnode));
679 s = strchr(devnode, '.');
680 snprintf(s, 4, ".%02d", endpt);
682 /* We may need to read/write to the same endpoint later. */
683 if (((fd = open(devnode, O_RDWR)) < 0) && (errno == ENXIO))
684 if ((fd = open(devnode, mode)) < 0)
687 hpriv->endpoints[endpt] = fd;
690 return (hpriv->endpoints[endpt]);
694 _sync_gen_transfer(struct usbi_transfer *itransfer)
696 struct libusb_transfer *transfer;
699 transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
702 * Bulk, Interrupt or Isochronous transfer depends on the
703 * endpoint and thus the node to open.
705 if ((fd = _access_endpoint(transfer)) < 0)
706 return _errno_to_libusb(errno);
708 if ((ioctl(fd, USB_SET_TIMEOUT, &transfer->timeout)) < 0)
709 return _errno_to_libusb(errno);
711 if (IS_XFERIN(transfer)) {
712 if ((transfer->flags & LIBUSB_TRANSFER_SHORT_NOT_OK) == 0)
713 if ((ioctl(fd, USB_SET_SHORT_XFER, &nr)) < 0)
714 return _errno_to_libusb(errno);
716 nr = read(fd, transfer->buffer, transfer->length);
718 nr = write(fd, transfer->buffer, transfer->length);
722 return _errno_to_libusb(errno);
724 itransfer->transferred = nr;