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",
99 obsd_get_device_descriptor,
100 obsd_get_active_config_descriptor,
101 obsd_get_config_descriptor,
102 NULL, /* get_config_descriptor_by_value() */
104 obsd_get_configuration,
105 obsd_set_configuration,
107 obsd_claim_interface,
108 obsd_release_interface,
110 obsd_set_interface_altsetting,
114 NULL, /* kernel_driver_active() */
115 NULL, /* detach_kernel_driver() */
116 NULL, /* attach_kernel_driver() */
120 obsd_submit_transfer,
121 obsd_cancel_transfer,
122 obsd_clear_transfer_priv,
127 sizeof(struct device_priv),
128 sizeof(struct handle_priv),
129 0, /* transfer_priv_size */
130 0, /* add_iso_packet_size */
134 obsd_get_device_list(struct libusb_context * ctx,
135 struct discovered_devs **discdevs)
137 struct libusb_device *dev;
138 struct device_priv *dpriv;
139 struct usb_device_info di;
140 unsigned long session_id;
146 /* Only ugen(4) is supported */
147 for (i = 0; i < USB_MAX_DEVICES; i++) {
148 /* Control endpoint is always .00 */
149 snprintf(devnode, sizeof(devnode), "/dev/ugen%d.00", i);
151 if ((fd = open(devnode, O_RDONLY)) < 0) {
152 if (errno != ENOENT && errno != ENXIO)
153 usbi_err(ctx, "could not open %s", devnode);
157 if (ioctl(fd, USB_GET_DEVICEINFO, &di) < 0)
160 session_id = (di.udi_bus << 8 | di.udi_addr);
161 dev = usbi_get_device_by_session_id(ctx, session_id);
164 dev = usbi_alloc_device(ctx, session_id);
166 return (LIBUSB_ERROR_NO_MEM);
168 dev->bus_number = di.udi_bus;
169 dev->device_address = di.udi_addr;
170 dev->speed = di.udi_speed;
172 dpriv = (struct device_priv *)dev->os_priv;
173 strlcpy(dpriv->devnode, devnode, sizeof(devnode));
176 if (ioctl(fd, USB_GET_DEVICE_DESC, &dpriv->ddesc) < 0) {
182 if (_cache_active_config_descriptor(dev, fd)) {
187 if ((err = usbi_sanitize_device(dev)))
192 if (discovered_devs_append(*discdevs, dev) == NULL)
193 return (LIBUSB_ERROR_NO_MEM);
196 return (LIBUSB_SUCCESS);
200 libusb_unref_device(dev);
201 return _errno_to_libusb(err);
205 obsd_open(struct libusb_device_handle *handle)
207 struct handle_priv *hpriv = (struct handle_priv *)handle->os_priv;
208 struct device_priv *dpriv = (struct device_priv *)handle->dev->os_priv;
210 dpriv->fd = open(dpriv->devnode, O_RDWR);
212 dpriv->fd = open(dpriv->devnode, O_RDONLY);
214 return _errno_to_libusb(errno);
217 usbi_dbg("open %s: fd %d", dpriv->devnode, dpriv->fd);
219 if (pipe(hpriv->pipe) < 0)
220 return _errno_to_libusb(errno);
222 return usbi_add_pollfd(HANDLE_CTX(handle), hpriv->pipe[0], POLLIN);
226 obsd_close(struct libusb_device_handle *handle)
228 struct handle_priv *hpriv = (struct handle_priv *)handle->os_priv;
229 struct device_priv *dpriv = (struct device_priv *)handle->dev->os_priv;
231 usbi_dbg("close: fd %d", dpriv->fd);
236 usbi_remove_pollfd(HANDLE_CTX(handle), hpriv->pipe[0]);
238 close(hpriv->pipe[0]);
239 close(hpriv->pipe[1]);
243 obsd_get_device_descriptor(struct libusb_device *dev, unsigned char *buf,
246 struct device_priv *dpriv = (struct device_priv *)dev->os_priv;
250 memcpy(buf, &dpriv->ddesc, DEVICE_DESC_LENGTH);
254 return (LIBUSB_SUCCESS);
258 obsd_get_active_config_descriptor(struct libusb_device *dev,
259 unsigned char *buf, size_t len, int *host_endian)
261 struct device_priv *dpriv = (struct device_priv *)dev->os_priv;
262 usb_config_descriptor_t *ucd;
264 ucd = (usb_config_descriptor_t *) dpriv->cdesc;
265 len = MIN(len, UGETW(ucd->wTotalLength));
267 usbi_dbg("len %d", len);
269 memcpy(buf, dpriv->cdesc, len);
277 obsd_get_config_descriptor(struct libusb_device *dev, uint8_t idx,
278 unsigned char *buf, size_t len, int *host_endian)
280 struct device_priv *dpriv = (struct device_priv *)dev->os_priv;
281 struct usb_full_desc ufd;
284 usbi_dbg("index %d, len %d", idx, len);
286 /* A config descriptor may be requested before opening the device */
287 if (dpriv->fd >= 0) {
290 fd = open(dpriv->devnode, O_RDONLY);
292 return _errno_to_libusb(errno);
295 ufd.ufd_config_index = idx;
299 if ((ioctl(fd, USB_GET_FULL_DESC, &ufd)) < 0) {
303 return _errno_to_libusb(err);
315 obsd_get_configuration(struct libusb_device_handle *handle, int *config)
317 struct device_priv *dpriv = (struct device_priv *)handle->dev->os_priv;
321 if (ioctl(dpriv->fd, USB_GET_CONFIG, config) < 0)
322 return _errno_to_libusb(errno);
324 usbi_dbg("configuration %d", *config);
326 return (LIBUSB_SUCCESS);
330 obsd_set_configuration(struct libusb_device_handle *handle, int config)
332 struct device_priv *dpriv = (struct device_priv *)handle->dev->os_priv;
334 usbi_dbg("configuration %d", config);
336 if (ioctl(dpriv->fd, USB_SET_CONFIG, &config) < 0)
337 return _errno_to_libusb(errno);
339 return _cache_active_config_descriptor(handle->dev, dpriv->fd);
343 obsd_claim_interface(struct libusb_device_handle *handle, int iface)
345 struct handle_priv *hpriv = (struct handle_priv *)handle->os_priv;
348 for (i = 0; i < USB_MAX_ENDPOINTS; i++)
349 hpriv->endpoints[i] = -1;
351 return (LIBUSB_SUCCESS);
355 obsd_release_interface(struct libusb_device_handle *handle, int iface)
357 struct handle_priv *hpriv = (struct handle_priv *)handle->os_priv;
360 for (i = 0; i < USB_MAX_ENDPOINTS; i++)
361 if (hpriv->endpoints[i] >= 0)
362 close(hpriv->endpoints[i]);
364 return (LIBUSB_SUCCESS);
368 obsd_set_interface_altsetting(struct libusb_device_handle *handle, int iface,
371 struct device_priv *dpriv = (struct device_priv *)handle->dev->os_priv;
372 struct usb_alt_interface intf;
374 usbi_dbg("iface %d, setting %d", iface, altsetting);
376 memset(&intf, 0, sizeof(intf));
378 intf.uai_interface_index = iface;
379 intf.uai_alt_no = altsetting;
381 if (ioctl(dpriv->fd, USB_SET_ALTINTERFACE, &intf) < 0)
382 return _errno_to_libusb(errno);
384 return (LIBUSB_SUCCESS);
388 obsd_clear_halt(struct libusb_device_handle *handle, unsigned char endpoint)
390 struct device_priv *dpriv = (struct device_priv *)handle->dev->os_priv;
391 struct usb_ctl_request req;
395 req.ucr_request.bmRequestType = UT_WRITE_ENDPOINT;
396 req.ucr_request.bRequest = UR_CLEAR_FEATURE;
397 USETW(req.ucr_request.wValue, UF_ENDPOINT_HALT);
398 USETW(req.ucr_request.wIndex, endpoint);
399 USETW(req.ucr_request.wLength, 0);
401 if (ioctl(dpriv->fd, USB_DO_REQUEST, &req) < 0)
402 return _errno_to_libusb(errno);
404 return (LIBUSB_SUCCESS);
408 obsd_reset_device(struct libusb_device_handle *handle)
412 return (LIBUSB_ERROR_NOT_SUPPORTED);
416 obsd_destroy_device(struct libusb_device *dev)
418 struct device_priv *dpriv = (struct device_priv *)dev->os_priv;
426 obsd_submit_transfer(struct usbi_transfer *itransfer)
428 struct libusb_transfer *transfer;
429 struct handle_priv *hpriv;
434 transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
435 hpriv = (struct handle_priv *)transfer->dev_handle->os_priv;
437 switch (transfer->type) {
438 case LIBUSB_TRANSFER_TYPE_CONTROL:
439 err = _sync_control_transfer(itransfer);
441 case LIBUSB_TRANSFER_TYPE_ISOCHRONOUS:
442 if (IS_XFEROUT(transfer)) {
443 /* Isochronous write is not supported */
444 err = LIBUSB_ERROR_NOT_SUPPORTED;
447 err = _sync_gen_transfer(itransfer);
449 case LIBUSB_TRANSFER_TYPE_BULK:
450 case LIBUSB_TRANSFER_TYPE_INTERRUPT:
451 if (IS_XFEROUT(transfer) &&
452 transfer->flags & LIBUSB_TRANSFER_ADD_ZERO_PACKET) {
453 err = LIBUSB_ERROR_NOT_SUPPORTED;
456 err = _sync_gen_transfer(itransfer);
463 if (write(hpriv->pipe[1], &itransfer, sizeof(itransfer)) < 0)
464 return _errno_to_libusb(errno);
466 return (LIBUSB_SUCCESS);
470 obsd_cancel_transfer(struct usbi_transfer *itransfer)
474 return (LIBUSB_ERROR_NOT_SUPPORTED);
478 obsd_clear_transfer_priv(struct usbi_transfer *itransfer)
486 obsd_handle_events(struct libusb_context *ctx, struct pollfd *fds, nfds_t nfds,
489 struct libusb_device_handle *handle;
490 struct handle_priv *hpriv = NULL;
491 struct usbi_transfer *itransfer;
492 struct pollfd *pollfd;
497 pthread_mutex_lock(&ctx->open_devs_lock);
498 for (i = 0; i < nfds && num_ready > 0; i++) {
501 if (!pollfd->revents)
506 list_for_each_entry(handle, &ctx->open_devs, list,
507 struct libusb_device_handle) {
508 hpriv = (struct handle_priv *)handle->os_priv;
510 if (hpriv->pipe[0] == pollfd->fd)
517 usbi_dbg("fd %d is not an event pipe!", pollfd->fd);
522 if (pollfd->revents & POLLERR) {
523 usbi_remove_pollfd(HANDLE_CTX(handle), hpriv->pipe[0]);
524 usbi_handle_disconnect(handle);
528 if (read(hpriv->pipe[0], &itransfer, sizeof(itransfer)) < 0) {
533 if ((err = usbi_handle_transfer_completion(itransfer,
534 LIBUSB_TRANSFER_COMPLETED)))
537 pthread_mutex_unlock(&ctx->open_devs_lock);
540 return _errno_to_libusb(err);
542 return (LIBUSB_SUCCESS);
546 obsd_clock_gettime(int clkid, struct timespec *tp)
548 usbi_dbg("clock %d", clkid);
550 if (clkid == USBI_CLOCK_REALTIME)
551 return clock_gettime(CLOCK_REALTIME, tp);
553 if (clkid == USBI_CLOCK_MONOTONIC)
554 return clock_gettime(CLOCK_MONOTONIC, tp);
556 return (LIBUSB_ERROR_INVALID_PARAM);
560 _errno_to_libusb(int err)
564 return (LIBUSB_ERROR_IO);
566 return (LIBUSB_ERROR_ACCESS);
568 return (LIBUSB_ERROR_NO_DEVICE);
570 return (LIBUSB_ERROR_NO_MEM);
573 usbi_dbg("error: %s", strerror(err));
575 return (LIBUSB_ERROR_OTHER);
579 _cache_active_config_descriptor(struct libusb_device *dev, int fd)
581 struct device_priv *dpriv = (struct device_priv *)dev->os_priv;
582 struct usb_config_desc ucd;
583 struct usb_full_desc ufd;
587 usbi_dbg("fd %d", fd);
589 ucd.ucd_config_index = USB_CURRENT_CONFIG_INDEX;
591 if ((ioctl(fd, USB_GET_CONFIG_DESC, &ucd)) < 0)
592 return _errno_to_libusb(errno);
594 usbi_dbg("active bLength %d", ucd.ucd_desc.bLength);
596 len = UGETW(ucd.ucd_desc.wTotalLength);
599 return (LIBUSB_ERROR_NO_MEM);
601 ufd.ufd_config_index = ucd.ucd_config_index;
605 usbi_dbg("index %d, len %d", ufd.ufd_config_index, len);
607 if ((ioctl(fd, USB_GET_FULL_DESC, &ufd)) < 0) {
609 return _errno_to_libusb(errno);
620 _sync_control_transfer(struct usbi_transfer *itransfer)
622 struct libusb_transfer *transfer;
623 struct libusb_control_setup *setup;
624 struct device_priv *dpriv;
625 struct usb_ctl_request req;
627 transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
628 dpriv = (struct device_priv *)transfer->dev_handle->dev->os_priv;
629 setup = (struct libusb_control_setup *)transfer->buffer;
631 usbi_dbg("type %d request %d value %d index %d length %d timeout %d",
632 setup->bmRequestType, setup->bRequest,
633 libusb_le16_to_cpu(setup->wValue),
634 libusb_le16_to_cpu(setup->wIndex),
635 libusb_le16_to_cpu(setup->wLength), transfer->timeout);
637 req.ucr_request.bmRequestType = setup->bmRequestType;
638 req.ucr_request.bRequest = setup->bRequest;
639 /* Don't use USETW, libusbx already deals with the endianness */
640 (*(uint16_t *)req.ucr_request.wValue) = setup->wValue;
641 (*(uint16_t *)req.ucr_request.wIndex) = setup->wIndex;
642 (*(uint16_t *)req.ucr_request.wLength) = setup->wLength;
643 req.ucr_data = transfer->buffer + LIBUSB_CONTROL_SETUP_SIZE;
645 if ((transfer->flags & LIBUSB_TRANSFER_SHORT_NOT_OK) == 0)
646 req.ucr_flags = USBD_SHORT_XFER_OK;
648 if ((ioctl(dpriv->fd, USB_SET_TIMEOUT, &transfer->timeout)) < 0)
649 return _errno_to_libusb(errno);
651 if ((ioctl(dpriv->fd, USB_DO_REQUEST, &req)) < 0)
652 return _errno_to_libusb(errno);
654 itransfer->transferred = req.ucr_actlen;
656 usbi_dbg("transferred %d", itransfer->transferred);
662 _access_endpoint(struct libusb_transfer *transfer)
664 struct handle_priv *hpriv;
665 struct device_priv *dpriv;
666 char *s, devnode[16];
670 hpriv = (struct handle_priv *)transfer->dev_handle->os_priv;
671 dpriv = (struct device_priv *)transfer->dev_handle->dev->os_priv;
673 endpt = UE_GET_ADDR(transfer->endpoint);
674 mode = IS_XFERIN(transfer) ? O_RDONLY : O_WRONLY;
676 usbi_dbg("endpoint %d mode %d", endpt, mode);
678 if (hpriv->endpoints[endpt] < 0) {
679 /* Pick the right node given the control one */
680 strlcpy(devnode, dpriv->devnode, sizeof(devnode));
681 s = strchr(devnode, '.');
682 snprintf(s, 4, ".%02d", endpt);
684 /* We may need to read/write to the same endpoint later. */
685 if (((fd = open(devnode, O_RDWR)) < 0) && (errno == ENXIO))
686 if ((fd = open(devnode, mode)) < 0)
689 hpriv->endpoints[endpt] = fd;
692 return (hpriv->endpoints[endpt]);
696 _sync_gen_transfer(struct usbi_transfer *itransfer)
698 struct libusb_transfer *transfer;
701 transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
704 * Bulk, Interrupt or Isochronous transfer depends on the
705 * endpoint and thus the node to open.
707 if ((fd = _access_endpoint(transfer)) < 0)
708 return _errno_to_libusb(errno);
710 if ((ioctl(fd, USB_SET_TIMEOUT, &transfer->timeout)) < 0)
711 return _errno_to_libusb(errno);
713 if (IS_XFERIN(transfer)) {
714 if ((transfer->flags & LIBUSB_TRANSFER_SHORT_NOT_OK) == 0)
715 if ((ioctl(fd, USB_SET_SHORT_XFER, &nr)) < 0)
716 return _errno_to_libusb(errno);
718 nr = read(fd, transfer->buffer, transfer->length);
720 nr = write(fd, transfer->buffer, transfer->length);
724 return _errno_to_libusb(errno);
726 itransfer->transferred = nr;