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
22 #include <sys/types.h>
31 #include <dev/usb/usb.h>
39 unsigned char *cdesc; /* active config descriptor */
40 usb_device_descriptor_t ddesc; /* usb device descriptor */
44 int pipe[2]; /* for event notification */
45 int endpoints[USB_MAX_ENDPOINTS];
51 static int netbsd_get_device_list(struct libusb_context *,
52 struct discovered_devs **);
53 static int netbsd_open(struct libusb_device_handle *);
54 static void netbsd_close(struct libusb_device_handle *);
56 static int netbsd_get_device_descriptor(struct libusb_device *, unsigned char *,
58 static int netbsd_get_active_config_descriptor(struct libusb_device *,
59 unsigned char *, size_t, int *);
60 static int netbsd_get_config_descriptor(struct libusb_device *, uint8_t,
61 unsigned char *, size_t, int *);
63 static int netbsd_get_configuration(struct libusb_device_handle *, int *);
64 static int netbsd_set_configuration(struct libusb_device_handle *, int);
66 static int netbsd_claim_interface(struct libusb_device_handle *, int);
67 static int netbsd_release_interface(struct libusb_device_handle *, int);
69 static int netbsd_set_interface_altsetting(struct libusb_device_handle *, int,
71 static int netbsd_clear_halt(struct libusb_device_handle *, unsigned char);
72 static int netbsd_reset_device(struct libusb_device_handle *);
73 static void netbsd_destroy_device(struct libusb_device *);
75 static int netbsd_submit_transfer(struct usbi_transfer *);
76 static int netbsd_cancel_transfer(struct usbi_transfer *);
77 static void netbsd_clear_transfer_priv(struct usbi_transfer *);
78 static int netbsd_handle_events(struct libusb_context *ctx, struct pollfd *,
80 static int netbsd_clock_gettime(int, struct timespec *);
85 static int _errno_to_libusb(int);
86 static int _cache_active_config_descriptor(struct libusb_device *, int);
87 static int _sync_control_transfer(struct usbi_transfer *);
88 static int _sync_gen_transfer(struct usbi_transfer *);
89 static int _access_endpoint(struct libusb_transfer *);
91 const struct usbi_os_backend netbsd_backend = {
92 "Synchronous NetBSD backend",
96 netbsd_get_device_list,
97 NULL, /* hotplug_poll */
101 netbsd_get_device_descriptor,
102 netbsd_get_active_config_descriptor,
103 netbsd_get_config_descriptor,
104 NULL, /* get_config_descriptor_by_value() */
106 netbsd_get_configuration,
107 netbsd_set_configuration,
109 netbsd_claim_interface,
110 netbsd_release_interface,
112 netbsd_set_interface_altsetting,
116 NULL, /* alloc_streams */
117 NULL, /* free_streams */
119 NULL, /* kernel_driver_active() */
120 NULL, /* detach_kernel_driver() */
121 NULL, /* attach_kernel_driver() */
123 netbsd_destroy_device,
125 netbsd_submit_transfer,
126 netbsd_cancel_transfer,
127 netbsd_clear_transfer_priv,
129 netbsd_handle_events,
130 NULL, /* handle_transfer_completion() */
132 netbsd_clock_gettime,
133 sizeof(struct device_priv),
134 sizeof(struct handle_priv),
135 0, /* transfer_priv_size */
136 0, /* add_iso_packet_size */
140 netbsd_get_device_list(struct libusb_context * ctx,
141 struct discovered_devs **discdevs)
143 struct libusb_device *dev;
144 struct device_priv *dpriv;
145 struct usb_device_info di;
146 unsigned long session_id;
152 /* Only ugen(4) is supported */
153 for (i = 0; i < USB_MAX_DEVICES; i++) {
154 /* Control endpoint is always .00 */
155 snprintf(devnode, sizeof(devnode), "/dev/ugen%d.00", i);
157 if ((fd = open(devnode, O_RDONLY)) < 0) {
158 if (errno != ENOENT && errno != ENXIO)
159 usbi_err(ctx, "could not open %s", devnode);
163 if (ioctl(fd, USB_GET_DEVICEINFO, &di) < 0)
166 session_id = (di.udi_bus << 8 | di.udi_addr);
167 dev = usbi_get_device_by_session_id(ctx, session_id);
170 dev = usbi_alloc_device(ctx, session_id);
172 return (LIBUSB_ERROR_NO_MEM);
174 dev->bus_number = di.udi_bus;
175 dev->device_address = di.udi_addr;
176 dev->speed = di.udi_speed;
178 dpriv = (struct device_priv *)dev->os_priv;
179 strlcpy(dpriv->devnode, devnode, sizeof(devnode));
182 if (ioctl(fd, USB_GET_DEVICE_DESC, &dpriv->ddesc) < 0) {
188 if (_cache_active_config_descriptor(dev, fd)) {
193 if ((err = usbi_sanitize_device(dev)))
198 if (discovered_devs_append(*discdevs, dev) == NULL)
199 return (LIBUSB_ERROR_NO_MEM);
201 libusb_unref_device(dev);
204 return (LIBUSB_SUCCESS);
208 libusb_unref_device(dev);
209 return _errno_to_libusb(err);
213 netbsd_open(struct libusb_device_handle *handle)
215 struct handle_priv *hpriv = (struct handle_priv *)handle->os_priv;
216 struct device_priv *dpriv = (struct device_priv *)handle->dev->os_priv;
218 dpriv->fd = open(dpriv->devnode, O_RDWR);
220 dpriv->fd = open(dpriv->devnode, O_RDONLY);
222 return _errno_to_libusb(errno);
225 usbi_dbg("open %s: fd %d", dpriv->devnode, dpriv->fd);
227 if (pipe(hpriv->pipe) < 0)
228 return _errno_to_libusb(errno);
230 return usbi_add_pollfd(HANDLE_CTX(handle), hpriv->pipe[0], POLLIN);
234 netbsd_close(struct libusb_device_handle *handle)
236 struct handle_priv *hpriv = (struct handle_priv *)handle->os_priv;
237 struct device_priv *dpriv = (struct device_priv *)handle->dev->os_priv;
239 usbi_dbg("close: fd %d", dpriv->fd);
244 usbi_remove_pollfd(HANDLE_CTX(handle), hpriv->pipe[0]);
246 close(hpriv->pipe[0]);
247 close(hpriv->pipe[1]);
251 netbsd_get_device_descriptor(struct libusb_device *dev, unsigned char *buf,
254 struct device_priv *dpriv = (struct device_priv *)dev->os_priv;
258 memcpy(buf, &dpriv->ddesc, DEVICE_DESC_LENGTH);
262 return (LIBUSB_SUCCESS);
266 netbsd_get_active_config_descriptor(struct libusb_device *dev,
267 unsigned char *buf, size_t len, int *host_endian)
269 struct device_priv *dpriv = (struct device_priv *)dev->os_priv;
270 usb_config_descriptor_t *ucd;
272 ucd = (usb_config_descriptor_t *) dpriv->cdesc;
273 len = MIN(len, UGETW(ucd->wTotalLength));
275 usbi_dbg("len %d", len);
277 memcpy(buf, dpriv->cdesc, len);
285 netbsd_get_config_descriptor(struct libusb_device *dev, uint8_t idx,
286 unsigned char *buf, size_t len, int *host_endian)
288 struct device_priv *dpriv = (struct device_priv *)dev->os_priv;
289 struct usb_full_desc ufd;
292 usbi_dbg("index %d, len %d", idx, len);
294 /* A config descriptor may be requested before opening the device */
295 if (dpriv->fd >= 0) {
298 fd = open(dpriv->devnode, O_RDONLY);
300 return _errno_to_libusb(errno);
303 ufd.ufd_config_index = idx;
307 if ((ioctl(fd, USB_GET_FULL_DESC, &ufd)) < 0) {
311 return _errno_to_libusb(err);
323 netbsd_get_configuration(struct libusb_device_handle *handle, int *config)
325 struct device_priv *dpriv = (struct device_priv *)handle->dev->os_priv;
329 if (ioctl(dpriv->fd, USB_GET_CONFIG, config) < 0)
330 return _errno_to_libusb(errno);
332 usbi_dbg("configuration %d", *config);
334 return (LIBUSB_SUCCESS);
338 netbsd_set_configuration(struct libusb_device_handle *handle, int config)
340 struct device_priv *dpriv = (struct device_priv *)handle->dev->os_priv;
342 usbi_dbg("configuration %d", config);
344 if (ioctl(dpriv->fd, USB_SET_CONFIG, &config) < 0)
345 return _errno_to_libusb(errno);
347 return _cache_active_config_descriptor(handle->dev, dpriv->fd);
351 netbsd_claim_interface(struct libusb_device_handle *handle, int iface)
353 struct handle_priv *hpriv = (struct handle_priv *)handle->os_priv;
356 for (i = 0; i < USB_MAX_ENDPOINTS; i++)
357 hpriv->endpoints[i] = -1;
359 return (LIBUSB_SUCCESS);
363 netbsd_release_interface(struct libusb_device_handle *handle, int iface)
365 struct handle_priv *hpriv = (struct handle_priv *)handle->os_priv;
368 for (i = 0; i < USB_MAX_ENDPOINTS; i++)
369 if (hpriv->endpoints[i] >= 0)
370 close(hpriv->endpoints[i]);
372 return (LIBUSB_SUCCESS);
376 netbsd_set_interface_altsetting(struct libusb_device_handle *handle, int iface,
379 struct device_priv *dpriv = (struct device_priv *)handle->dev->os_priv;
380 struct usb_alt_interface intf;
382 usbi_dbg("iface %d, setting %d", iface, altsetting);
384 memset(&intf, 0, sizeof(intf));
386 intf.uai_interface_index = iface;
387 intf.uai_alt_no = altsetting;
389 if (ioctl(dpriv->fd, USB_SET_ALTINTERFACE, &intf) < 0)
390 return _errno_to_libusb(errno);
392 return (LIBUSB_SUCCESS);
396 netbsd_clear_halt(struct libusb_device_handle *handle, unsigned char endpoint)
398 struct device_priv *dpriv = (struct device_priv *)handle->dev->os_priv;
399 struct usb_ctl_request req;
403 req.ucr_request.bmRequestType = UT_WRITE_ENDPOINT;
404 req.ucr_request.bRequest = UR_CLEAR_FEATURE;
405 USETW(req.ucr_request.wValue, UF_ENDPOINT_HALT);
406 USETW(req.ucr_request.wIndex, endpoint);
407 USETW(req.ucr_request.wLength, 0);
409 if (ioctl(dpriv->fd, USB_DO_REQUEST, &req) < 0)
410 return _errno_to_libusb(errno);
412 return (LIBUSB_SUCCESS);
416 netbsd_reset_device(struct libusb_device_handle *handle)
420 return (LIBUSB_ERROR_NOT_SUPPORTED);
424 netbsd_destroy_device(struct libusb_device *dev)
426 struct device_priv *dpriv = (struct device_priv *)dev->os_priv;
434 netbsd_submit_transfer(struct usbi_transfer *itransfer)
436 struct libusb_transfer *transfer;
437 struct handle_priv *hpriv;
442 transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
443 hpriv = (struct handle_priv *)transfer->dev_handle->os_priv;
445 switch (transfer->type) {
446 case LIBUSB_TRANSFER_TYPE_CONTROL:
447 err = _sync_control_transfer(itransfer);
449 case LIBUSB_TRANSFER_TYPE_ISOCHRONOUS:
450 if (IS_XFEROUT(transfer)) {
451 /* Isochronous write is not supported */
452 err = LIBUSB_ERROR_NOT_SUPPORTED;
455 err = _sync_gen_transfer(itransfer);
457 case LIBUSB_TRANSFER_TYPE_BULK:
458 case LIBUSB_TRANSFER_TYPE_INTERRUPT:
459 if (IS_XFEROUT(transfer) &&
460 transfer->flags & LIBUSB_TRANSFER_ADD_ZERO_PACKET) {
461 err = LIBUSB_ERROR_NOT_SUPPORTED;
464 err = _sync_gen_transfer(itransfer);
466 case LIBUSB_TRANSFER_TYPE_BULK_STREAM:
467 err = LIBUSB_ERROR_NOT_SUPPORTED;
474 if (write(hpriv->pipe[1], &itransfer, sizeof(itransfer)) < 0)
475 return _errno_to_libusb(errno);
477 return (LIBUSB_SUCCESS);
481 netbsd_cancel_transfer(struct usbi_transfer *itransfer)
485 return (LIBUSB_ERROR_NOT_SUPPORTED);
489 netbsd_clear_transfer_priv(struct usbi_transfer *itransfer)
497 netbsd_handle_events(struct libusb_context *ctx, struct pollfd *fds, nfds_t nfds,
500 struct libusb_device_handle *handle;
501 struct handle_priv *hpriv = NULL;
502 struct usbi_transfer *itransfer;
503 struct pollfd *pollfd;
508 pthread_mutex_lock(&ctx->open_devs_lock);
509 for (i = 0; i < nfds && num_ready > 0; i++) {
512 if (!pollfd->revents)
517 list_for_each_entry(handle, &ctx->open_devs, list,
518 struct libusb_device_handle) {
519 hpriv = (struct handle_priv *)handle->os_priv;
521 if (hpriv->pipe[0] == pollfd->fd)
528 usbi_dbg("fd %d is not an event pipe!", pollfd->fd);
533 if (pollfd->revents & POLLERR) {
534 usbi_remove_pollfd(HANDLE_CTX(handle), hpriv->pipe[0]);
535 usbi_handle_disconnect(handle);
539 if (read(hpriv->pipe[0], &itransfer, sizeof(itransfer)) < 0) {
544 if ((err = usbi_handle_transfer_completion(itransfer,
545 LIBUSB_TRANSFER_COMPLETED)))
548 pthread_mutex_unlock(&ctx->open_devs_lock);
551 return _errno_to_libusb(err);
553 return (LIBUSB_SUCCESS);
557 netbsd_clock_gettime(int clkid, struct timespec *tp)
559 usbi_dbg("clock %d", clkid);
561 if (clkid == USBI_CLOCK_REALTIME)
562 return clock_gettime(CLOCK_REALTIME, tp);
564 if (clkid == USBI_CLOCK_MONOTONIC)
565 return clock_gettime(CLOCK_MONOTONIC, tp);
567 return (LIBUSB_ERROR_INVALID_PARAM);
571 _errno_to_libusb(int err)
575 return (LIBUSB_ERROR_IO);
577 return (LIBUSB_ERROR_ACCESS);
579 return (LIBUSB_ERROR_NO_DEVICE);
581 return (LIBUSB_ERROR_NO_MEM);
584 usbi_dbg("error: %s", strerror(err));
586 return (LIBUSB_ERROR_OTHER);
590 _cache_active_config_descriptor(struct libusb_device *dev, int fd)
592 struct device_priv *dpriv = (struct device_priv *)dev->os_priv;
593 struct usb_config_desc ucd;
594 struct usb_full_desc ufd;
598 usbi_dbg("fd %d", fd);
600 ucd.ucd_config_index = USB_CURRENT_CONFIG_INDEX;
602 if ((ioctl(fd, USB_GET_CONFIG_DESC, &ucd)) < 0)
603 return _errno_to_libusb(errno);
605 usbi_dbg("active bLength %d", ucd.ucd_desc.bLength);
607 len = UGETW(ucd.ucd_desc.wTotalLength);
610 return (LIBUSB_ERROR_NO_MEM);
612 ufd.ufd_config_index = ucd.ucd_config_index;
616 usbi_dbg("index %d, len %d", ufd.ufd_config_index, len);
618 if ((ioctl(fd, USB_GET_FULL_DESC, &ufd)) < 0) {
620 return _errno_to_libusb(errno);
631 _sync_control_transfer(struct usbi_transfer *itransfer)
633 struct libusb_transfer *transfer;
634 struct libusb_control_setup *setup;
635 struct device_priv *dpriv;
636 struct usb_ctl_request req;
638 transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
639 dpriv = (struct device_priv *)transfer->dev_handle->dev->os_priv;
640 setup = (struct libusb_control_setup *)transfer->buffer;
642 usbi_dbg("type %d request %d value %d index %d length %d timeout %d",
643 setup->bmRequestType, setup->bRequest,
644 libusb_le16_to_cpu(setup->wValue),
645 libusb_le16_to_cpu(setup->wIndex),
646 libusb_le16_to_cpu(setup->wLength), transfer->timeout);
648 req.ucr_request.bmRequestType = setup->bmRequestType;
649 req.ucr_request.bRequest = setup->bRequest;
650 /* Don't use USETW, libusb already deals with the endianness */
651 (*(uint16_t *)req.ucr_request.wValue) = setup->wValue;
652 (*(uint16_t *)req.ucr_request.wIndex) = setup->wIndex;
653 (*(uint16_t *)req.ucr_request.wLength) = setup->wLength;
654 req.ucr_data = transfer->buffer + LIBUSB_CONTROL_SETUP_SIZE;
656 if ((transfer->flags & LIBUSB_TRANSFER_SHORT_NOT_OK) == 0)
657 req.ucr_flags = USBD_SHORT_XFER_OK;
659 if ((ioctl(dpriv->fd, USB_SET_TIMEOUT, &transfer->timeout)) < 0)
660 return _errno_to_libusb(errno);
662 if ((ioctl(dpriv->fd, USB_DO_REQUEST, &req)) < 0)
663 return _errno_to_libusb(errno);
665 itransfer->transferred = req.ucr_actlen;
667 usbi_dbg("transferred %d", itransfer->transferred);
673 _access_endpoint(struct libusb_transfer *transfer)
675 struct handle_priv *hpriv;
676 struct device_priv *dpriv;
677 char *s, devnode[16];
681 hpriv = (struct handle_priv *)transfer->dev_handle->os_priv;
682 dpriv = (struct device_priv *)transfer->dev_handle->dev->os_priv;
684 endpt = UE_GET_ADDR(transfer->endpoint);
685 mode = IS_XFERIN(transfer) ? O_RDONLY : O_WRONLY;
687 usbi_dbg("endpoint %d mode %d", endpt, mode);
689 if (hpriv->endpoints[endpt] < 0) {
690 /* Pick the right node given the control one */
691 strlcpy(devnode, dpriv->devnode, sizeof(devnode));
692 s = strchr(devnode, '.');
693 snprintf(s, 4, ".%02d", endpt);
695 /* We may need to read/write to the same endpoint later. */
696 if (((fd = open(devnode, O_RDWR)) < 0) && (errno == ENXIO))
697 if ((fd = open(devnode, mode)) < 0)
700 hpriv->endpoints[endpt] = fd;
703 return (hpriv->endpoints[endpt]);
707 _sync_gen_transfer(struct usbi_transfer *itransfer)
709 struct libusb_transfer *transfer;
712 transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
715 * Bulk, Interrupt or Isochronous transfer depends on the
716 * endpoint and thus the node to open.
718 if ((fd = _access_endpoint(transfer)) < 0)
719 return _errno_to_libusb(errno);
721 if ((ioctl(fd, USB_SET_TIMEOUT, &transfer->timeout)) < 0)
722 return _errno_to_libusb(errno);
724 if (IS_XFERIN(transfer)) {
725 if ((transfer->flags & LIBUSB_TRANSFER_SHORT_NOT_OK) == 0)
726 if ((ioctl(fd, USB_SET_SHORT_XFER, &nr)) < 0)
727 return _errno_to_libusb(errno);
729 nr = read(fd, transfer->buffer, transfer->length);
731 nr = write(fd, transfer->buffer, transfer->length);
735 return _errno_to_libusb(errno);
737 itransfer->transferred = nr;