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 endpoints[USB_MAX_ENDPOINTS];
50 static int netbsd_get_device_list(struct libusb_context *,
51 struct discovered_devs **);
52 static int netbsd_open(struct libusb_device_handle *);
53 static void netbsd_close(struct libusb_device_handle *);
55 static int netbsd_get_device_descriptor(struct libusb_device *, unsigned char *,
57 static int netbsd_get_active_config_descriptor(struct libusb_device *,
58 unsigned char *, size_t, int *);
59 static int netbsd_get_config_descriptor(struct libusb_device *, uint8_t,
60 unsigned char *, size_t, int *);
62 static int netbsd_get_configuration(struct libusb_device_handle *, int *);
63 static int netbsd_set_configuration(struct libusb_device_handle *, int);
65 static int netbsd_claim_interface(struct libusb_device_handle *, int);
66 static int netbsd_release_interface(struct libusb_device_handle *, int);
68 static int netbsd_set_interface_altsetting(struct libusb_device_handle *, int,
70 static int netbsd_clear_halt(struct libusb_device_handle *, unsigned char);
71 static int netbsd_reset_device(struct libusb_device_handle *);
72 static void netbsd_destroy_device(struct libusb_device *);
74 static int netbsd_submit_transfer(struct usbi_transfer *);
75 static int netbsd_cancel_transfer(struct usbi_transfer *);
76 static void netbsd_clear_transfer_priv(struct usbi_transfer *);
77 static int netbsd_handle_transfer_completion(struct usbi_transfer *);
78 static int netbsd_clock_gettime(int, struct timespec *);
83 static int _errno_to_libusb(int);
84 static int _cache_active_config_descriptor(struct libusb_device *, int);
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 const struct usbi_os_backend usbi_backend = {
90 "Synchronous NetBSD backend",
94 NULL, /* set_option() */
95 netbsd_get_device_list,
96 NULL, /* hotplug_poll */
100 netbsd_get_device_descriptor,
101 netbsd_get_active_config_descriptor,
102 netbsd_get_config_descriptor,
103 NULL, /* get_config_descriptor_by_value() */
105 netbsd_get_configuration,
106 netbsd_set_configuration,
108 netbsd_claim_interface,
109 netbsd_release_interface,
111 netbsd_set_interface_altsetting,
115 NULL, /* alloc_streams */
116 NULL, /* free_streams */
118 NULL, /* dev_mem_alloc() */
119 NULL, /* dev_mem_free() */
121 NULL, /* kernel_driver_active() */
122 NULL, /* detach_kernel_driver() */
123 NULL, /* attach_kernel_driver() */
125 netbsd_destroy_device,
127 netbsd_submit_transfer,
128 netbsd_cancel_transfer,
129 netbsd_clear_transfer_priv,
131 NULL, /* handle_events() */
132 netbsd_handle_transfer_completion,
134 netbsd_clock_gettime,
135 0, /* context_priv_size */
136 sizeof(struct device_priv),
137 sizeof(struct handle_priv),
138 0, /* transfer_priv_size */
142 netbsd_get_device_list(struct libusb_context * ctx,
143 struct discovered_devs **discdevs)
145 struct libusb_device *dev;
146 struct device_priv *dpriv;
147 struct usb_device_info di;
148 unsigned long session_id;
154 /* Only ugen(4) is supported */
155 for (i = 0; i < USB_MAX_DEVICES; i++) {
156 /* Control endpoint is always .00 */
157 snprintf(devnode, sizeof(devnode), "/dev/ugen%d.00", i);
159 if ((fd = open(devnode, O_RDONLY)) < 0) {
160 if (errno != ENOENT && errno != ENXIO)
161 usbi_err(ctx, "could not open %s", devnode);
165 if (ioctl(fd, USB_GET_DEVICEINFO, &di) < 0)
168 session_id = (di.udi_bus << 8 | di.udi_addr);
169 dev = usbi_get_device_by_session_id(ctx, session_id);
172 dev = usbi_alloc_device(ctx, session_id);
174 return (LIBUSB_ERROR_NO_MEM);
176 dev->bus_number = di.udi_bus;
177 dev->device_address = di.udi_addr;
178 dev->speed = di.udi_speed;
180 dpriv = (struct device_priv *)dev->os_priv;
181 strlcpy(dpriv->devnode, devnode, sizeof(devnode));
184 if (ioctl(fd, USB_GET_DEVICE_DESC, &dpriv->ddesc) < 0) {
190 if (_cache_active_config_descriptor(dev, fd)) {
195 if ((err = usbi_sanitize_device(dev)))
200 if (discovered_devs_append(*discdevs, dev) == NULL)
201 return (LIBUSB_ERROR_NO_MEM);
203 libusb_unref_device(dev);
206 return (LIBUSB_SUCCESS);
210 libusb_unref_device(dev);
211 return _errno_to_libusb(err);
215 netbsd_open(struct libusb_device_handle *handle)
217 struct device_priv *dpriv = (struct device_priv *)handle->dev->os_priv;
218 struct handle_priv *hpriv = (struct handle_priv *)handle->os_priv;
221 dpriv->fd = open(dpriv->devnode, O_RDWR);
223 dpriv->fd = open(dpriv->devnode, O_RDONLY);
225 return _errno_to_libusb(errno);
228 for (i = 0; i < USB_MAX_ENDPOINTS; i++)
229 hpriv->endpoints[i] = -1;
231 usbi_dbg("open %s: fd %d", dpriv->devnode, dpriv->fd);
233 return (LIBUSB_SUCCESS);
237 netbsd_close(struct libusb_device_handle *handle)
239 struct device_priv *dpriv = (struct device_priv *)handle->dev->os_priv;
241 usbi_dbg("close: fd %d", dpriv->fd);
248 netbsd_get_device_descriptor(struct libusb_device *dev, unsigned char *buf,
251 struct device_priv *dpriv = (struct device_priv *)dev->os_priv;
255 memcpy(buf, &dpriv->ddesc, DEVICE_DESC_LENGTH);
259 return (LIBUSB_SUCCESS);
263 netbsd_get_active_config_descriptor(struct libusb_device *dev,
264 unsigned char *buf, size_t len, int *host_endian)
266 struct device_priv *dpriv = (struct device_priv *)dev->os_priv;
267 usb_config_descriptor_t *ucd;
269 ucd = (usb_config_descriptor_t *) dpriv->cdesc;
270 len = MIN(len, UGETW(ucd->wTotalLength));
272 usbi_dbg("len %d", len);
274 memcpy(buf, dpriv->cdesc, len);
282 netbsd_get_config_descriptor(struct libusb_device *dev, uint8_t idx,
283 unsigned char *buf, size_t len, int *host_endian)
285 struct device_priv *dpriv = (struct device_priv *)dev->os_priv;
286 struct usb_full_desc ufd;
289 usbi_dbg("index %d, len %d", idx, len);
291 /* A config descriptor may be requested before opening the device */
292 if (dpriv->fd >= 0) {
295 fd = open(dpriv->devnode, O_RDONLY);
297 return _errno_to_libusb(errno);
300 ufd.ufd_config_index = idx;
304 if ((ioctl(fd, USB_GET_FULL_DESC, &ufd)) < 0) {
308 return _errno_to_libusb(err);
320 netbsd_get_configuration(struct libusb_device_handle *handle, int *config)
322 struct device_priv *dpriv = (struct device_priv *)handle->dev->os_priv;
326 if (ioctl(dpriv->fd, USB_GET_CONFIG, config) < 0)
327 return _errno_to_libusb(errno);
329 usbi_dbg("configuration %d", *config);
331 return (LIBUSB_SUCCESS);
335 netbsd_set_configuration(struct libusb_device_handle *handle, int config)
337 struct device_priv *dpriv = (struct device_priv *)handle->dev->os_priv;
339 usbi_dbg("configuration %d", config);
341 if (ioctl(dpriv->fd, USB_SET_CONFIG, &config) < 0)
342 return _errno_to_libusb(errno);
344 return _cache_active_config_descriptor(handle->dev, dpriv->fd);
348 netbsd_claim_interface(struct libusb_device_handle *handle, int iface)
350 struct handle_priv *hpriv = (struct handle_priv *)handle->os_priv;
353 for (i = 0; i < USB_MAX_ENDPOINTS; i++)
354 hpriv->endpoints[i] = -1;
356 return (LIBUSB_SUCCESS);
360 netbsd_release_interface(struct libusb_device_handle *handle, int iface)
362 struct handle_priv *hpriv = (struct handle_priv *)handle->os_priv;
365 for (i = 0; i < USB_MAX_ENDPOINTS; i++)
366 if (hpriv->endpoints[i] >= 0)
367 close(hpriv->endpoints[i]);
369 return (LIBUSB_SUCCESS);
373 netbsd_set_interface_altsetting(struct libusb_device_handle *handle, int iface,
376 struct device_priv *dpriv = (struct device_priv *)handle->dev->os_priv;
377 struct usb_alt_interface intf;
379 usbi_dbg("iface %d, setting %d", iface, altsetting);
381 memset(&intf, 0, sizeof(intf));
383 intf.uai_interface_index = iface;
384 intf.uai_alt_no = altsetting;
386 if (ioctl(dpriv->fd, USB_SET_ALTINTERFACE, &intf) < 0)
387 return _errno_to_libusb(errno);
389 return (LIBUSB_SUCCESS);
393 netbsd_clear_halt(struct libusb_device_handle *handle, unsigned char endpoint)
395 struct device_priv *dpriv = (struct device_priv *)handle->dev->os_priv;
396 struct usb_ctl_request req;
400 req.ucr_request.bmRequestType = UT_WRITE_ENDPOINT;
401 req.ucr_request.bRequest = UR_CLEAR_FEATURE;
402 USETW(req.ucr_request.wValue, UF_ENDPOINT_HALT);
403 USETW(req.ucr_request.wIndex, endpoint);
404 USETW(req.ucr_request.wLength, 0);
406 if (ioctl(dpriv->fd, USB_DO_REQUEST, &req) < 0)
407 return _errno_to_libusb(errno);
409 return (LIBUSB_SUCCESS);
413 netbsd_reset_device(struct libusb_device_handle *handle)
417 return (LIBUSB_ERROR_NOT_SUPPORTED);
421 netbsd_destroy_device(struct libusb_device *dev)
423 struct device_priv *dpriv = (struct device_priv *)dev->os_priv;
431 netbsd_submit_transfer(struct usbi_transfer *itransfer)
433 struct libusb_transfer *transfer;
434 struct handle_priv *hpriv;
439 transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
440 hpriv = (struct handle_priv *)transfer->dev_handle->os_priv;
442 switch (transfer->type) {
443 case LIBUSB_TRANSFER_TYPE_CONTROL:
444 err = _sync_control_transfer(itransfer);
446 case LIBUSB_TRANSFER_TYPE_ISOCHRONOUS:
447 if (IS_XFEROUT(transfer)) {
448 /* Isochronous write is not supported */
449 err = LIBUSB_ERROR_NOT_SUPPORTED;
452 err = _sync_gen_transfer(itransfer);
454 case LIBUSB_TRANSFER_TYPE_BULK:
455 case LIBUSB_TRANSFER_TYPE_INTERRUPT:
456 if (IS_XFEROUT(transfer) &&
457 transfer->flags & LIBUSB_TRANSFER_ADD_ZERO_PACKET) {
458 err = LIBUSB_ERROR_NOT_SUPPORTED;
461 err = _sync_gen_transfer(itransfer);
463 case LIBUSB_TRANSFER_TYPE_BULK_STREAM:
464 err = LIBUSB_ERROR_NOT_SUPPORTED;
471 usbi_signal_transfer_completion(itransfer);
473 return (LIBUSB_SUCCESS);
477 netbsd_cancel_transfer(struct usbi_transfer *itransfer)
481 return (LIBUSB_ERROR_NOT_SUPPORTED);
485 netbsd_clear_transfer_priv(struct usbi_transfer *itransfer)
493 netbsd_handle_transfer_completion(struct usbi_transfer *itransfer)
495 return usbi_handle_transfer_completion(itransfer, LIBUSB_TRANSFER_COMPLETED);
499 netbsd_clock_gettime(int clkid, struct timespec *tp)
501 usbi_dbg("clock %d", clkid);
503 if (clkid == USBI_CLOCK_REALTIME)
504 return clock_gettime(CLOCK_REALTIME, tp);
506 if (clkid == USBI_CLOCK_MONOTONIC)
507 return clock_gettime(CLOCK_MONOTONIC, tp);
509 return (LIBUSB_ERROR_INVALID_PARAM);
513 _errno_to_libusb(int err)
517 return (LIBUSB_ERROR_IO);
519 return (LIBUSB_ERROR_ACCESS);
521 return (LIBUSB_ERROR_NO_DEVICE);
523 return (LIBUSB_ERROR_NO_MEM);
526 usbi_dbg("error: %s", strerror(err));
528 return (LIBUSB_ERROR_OTHER);
532 _cache_active_config_descriptor(struct libusb_device *dev, int fd)
534 struct device_priv *dpriv = (struct device_priv *)dev->os_priv;
535 struct usb_config_desc ucd;
536 struct usb_full_desc ufd;
540 usbi_dbg("fd %d", fd);
542 ucd.ucd_config_index = USB_CURRENT_CONFIG_INDEX;
544 if ((ioctl(fd, USB_GET_CONFIG_DESC, &ucd)) < 0)
545 return _errno_to_libusb(errno);
547 usbi_dbg("active bLength %d", ucd.ucd_desc.bLength);
549 len = UGETW(ucd.ucd_desc.wTotalLength);
552 return (LIBUSB_ERROR_NO_MEM);
554 ufd.ufd_config_index = ucd.ucd_config_index;
558 usbi_dbg("index %d, len %d", ufd.ufd_config_index, len);
560 if ((ioctl(fd, USB_GET_FULL_DESC, &ufd)) < 0) {
562 return _errno_to_libusb(errno);
573 _sync_control_transfer(struct usbi_transfer *itransfer)
575 struct libusb_transfer *transfer;
576 struct libusb_control_setup *setup;
577 struct device_priv *dpriv;
578 struct usb_ctl_request req;
580 transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
581 dpriv = (struct device_priv *)transfer->dev_handle->dev->os_priv;
582 setup = (struct libusb_control_setup *)transfer->buffer;
584 usbi_dbg("type %d request %d value %d index %d length %d timeout %d",
585 setup->bmRequestType, setup->bRequest,
586 libusb_le16_to_cpu(setup->wValue),
587 libusb_le16_to_cpu(setup->wIndex),
588 libusb_le16_to_cpu(setup->wLength), transfer->timeout);
590 req.ucr_request.bmRequestType = setup->bmRequestType;
591 req.ucr_request.bRequest = setup->bRequest;
592 /* Don't use USETW, libusb already deals with the endianness */
593 (*(uint16_t *)req.ucr_request.wValue) = setup->wValue;
594 (*(uint16_t *)req.ucr_request.wIndex) = setup->wIndex;
595 (*(uint16_t *)req.ucr_request.wLength) = setup->wLength;
596 req.ucr_data = transfer->buffer + LIBUSB_CONTROL_SETUP_SIZE;
598 if ((transfer->flags & LIBUSB_TRANSFER_SHORT_NOT_OK) == 0)
599 req.ucr_flags = USBD_SHORT_XFER_OK;
601 if ((ioctl(dpriv->fd, USB_SET_TIMEOUT, &transfer->timeout)) < 0)
602 return _errno_to_libusb(errno);
604 if ((ioctl(dpriv->fd, USB_DO_REQUEST, &req)) < 0)
605 return _errno_to_libusb(errno);
607 itransfer->transferred = req.ucr_actlen;
609 usbi_dbg("transferred %d", itransfer->transferred);
615 _access_endpoint(struct libusb_transfer *transfer)
617 struct handle_priv *hpriv;
618 struct device_priv *dpriv;
619 char *s, devnode[16];
623 hpriv = (struct handle_priv *)transfer->dev_handle->os_priv;
624 dpriv = (struct device_priv *)transfer->dev_handle->dev->os_priv;
626 endpt = UE_GET_ADDR(transfer->endpoint);
627 mode = IS_XFERIN(transfer) ? O_RDONLY : O_WRONLY;
629 usbi_dbg("endpoint %d mode %d", endpt, mode);
631 if (hpriv->endpoints[endpt] < 0) {
632 /* Pick the right node given the control one */
633 strlcpy(devnode, dpriv->devnode, sizeof(devnode));
634 s = strchr(devnode, '.');
635 snprintf(s, 4, ".%02d", endpt);
637 /* We may need to read/write to the same endpoint later. */
638 if (((fd = open(devnode, O_RDWR)) < 0) && (errno == ENXIO))
639 if ((fd = open(devnode, mode)) < 0)
642 hpriv->endpoints[endpt] = fd;
645 return (hpriv->endpoints[endpt]);
649 _sync_gen_transfer(struct usbi_transfer *itransfer)
651 struct libusb_transfer *transfer;
654 transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
657 * Bulk, Interrupt or Isochronous transfer depends on the
658 * endpoint and thus the node to open.
660 if ((fd = _access_endpoint(transfer)) < 0)
661 return _errno_to_libusb(errno);
663 if ((ioctl(fd, USB_SET_TIMEOUT, &transfer->timeout)) < 0)
664 return _errno_to_libusb(errno);
666 if (IS_XFERIN(transfer)) {
667 if ((transfer->flags & LIBUSB_TRANSFER_SHORT_NOT_OK) == 0)
668 if ((ioctl(fd, USB_SET_SHORT_XFER, &nr)) < 0)
669 return _errno_to_libusb(errno);
671 nr = read(fd, transfer->buffer, transfer->length);
673 nr = write(fd, transfer->buffer, transfer->length);
677 return _errno_to_libusb(errno);
679 itransfer->transferred = nr;