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 netbsd_backend = {
90 "Synchronous NetBSD backend",
94 netbsd_get_device_list,
95 NULL, /* hotplug_poll */
99 netbsd_get_device_descriptor,
100 netbsd_get_active_config_descriptor,
101 netbsd_get_config_descriptor,
102 NULL, /* get_config_descriptor_by_value() */
104 netbsd_get_configuration,
105 netbsd_set_configuration,
107 netbsd_claim_interface,
108 netbsd_release_interface,
110 netbsd_set_interface_altsetting,
114 NULL, /* alloc_streams */
115 NULL, /* free_streams */
117 NULL, /* kernel_driver_active() */
118 NULL, /* detach_kernel_driver() */
119 NULL, /* attach_kernel_driver() */
121 netbsd_destroy_device,
123 netbsd_submit_transfer,
124 netbsd_cancel_transfer,
125 netbsd_clear_transfer_priv,
127 NULL, /* handle_events() */
128 netbsd_handle_transfer_completion,
130 netbsd_clock_gettime,
131 sizeof(struct device_priv),
132 sizeof(struct handle_priv),
133 0, /* transfer_priv_size */
134 0, /* add_iso_packet_size */
138 netbsd_get_device_list(struct libusb_context * ctx,
139 struct discovered_devs **discdevs)
141 struct libusb_device *dev;
142 struct device_priv *dpriv;
143 struct usb_device_info di;
144 unsigned long session_id;
150 /* Only ugen(4) is supported */
151 for (i = 0; i < USB_MAX_DEVICES; i++) {
152 /* Control endpoint is always .00 */
153 snprintf(devnode, sizeof(devnode), "/dev/ugen%d.00", i);
155 if ((fd = open(devnode, O_RDONLY)) < 0) {
156 if (errno != ENOENT && errno != ENXIO)
157 usbi_err(ctx, "could not open %s", devnode);
161 if (ioctl(fd, USB_GET_DEVICEINFO, &di) < 0)
164 session_id = (di.udi_bus << 8 | di.udi_addr);
165 dev = usbi_get_device_by_session_id(ctx, session_id);
168 dev = usbi_alloc_device(ctx, session_id);
170 return (LIBUSB_ERROR_NO_MEM);
172 dev->bus_number = di.udi_bus;
173 dev->device_address = di.udi_addr;
174 dev->speed = di.udi_speed;
176 dpriv = (struct device_priv *)dev->os_priv;
177 strlcpy(dpriv->devnode, devnode, sizeof(devnode));
180 if (ioctl(fd, USB_GET_DEVICE_DESC, &dpriv->ddesc) < 0) {
186 if (_cache_active_config_descriptor(dev, fd)) {
191 if ((err = usbi_sanitize_device(dev)))
196 if (discovered_devs_append(*discdevs, dev) == NULL)
197 return (LIBUSB_ERROR_NO_MEM);
199 libusb_unref_device(dev);
202 return (LIBUSB_SUCCESS);
206 libusb_unref_device(dev);
207 return _errno_to_libusb(err);
211 netbsd_open(struct libusb_device_handle *handle)
213 struct handle_priv *hpriv = (struct handle_priv *)handle->os_priv;
214 struct device_priv *dpriv = (struct device_priv *)handle->dev->os_priv;
216 dpriv->fd = open(dpriv->devnode, O_RDWR);
218 dpriv->fd = open(dpriv->devnode, O_RDONLY);
220 return _errno_to_libusb(errno);
223 usbi_dbg("open %s: fd %d", dpriv->devnode, dpriv->fd);
225 return (LIBUSB_SUCCESS);
229 netbsd_close(struct libusb_device_handle *handle)
231 struct handle_priv *hpriv = (struct handle_priv *)handle->os_priv;
232 struct device_priv *dpriv = (struct device_priv *)handle->dev->os_priv;
234 usbi_dbg("close: fd %d", dpriv->fd);
241 netbsd_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 netbsd_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);
275 netbsd_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);
313 netbsd_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 netbsd_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 netbsd_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 netbsd_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 netbsd_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 netbsd_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 netbsd_reset_device(struct libusb_device_handle *handle)
410 return (LIBUSB_ERROR_NOT_SUPPORTED);
414 netbsd_destroy_device(struct libusb_device *dev)
416 struct device_priv *dpriv = (struct device_priv *)dev->os_priv;
424 netbsd_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);
456 case LIBUSB_TRANSFER_TYPE_BULK_STREAM:
457 err = LIBUSB_ERROR_NOT_SUPPORTED;
464 usbi_signal_transfer_completion(itransfer);
466 return (LIBUSB_SUCCESS);
470 netbsd_cancel_transfer(struct usbi_transfer *itransfer)
474 return (LIBUSB_ERROR_NOT_SUPPORTED);
478 netbsd_clear_transfer_priv(struct usbi_transfer *itransfer)
486 netbsd_handle_transfer_completion(struct usbi_transfer *itransfer)
488 return usbi_handle_transfer_completion(itransfer, LIBUSB_TRANSFER_COMPLETED);
492 netbsd_clock_gettime(int clkid, struct timespec *tp)
494 usbi_dbg("clock %d", clkid);
496 if (clkid == USBI_CLOCK_REALTIME)
497 return clock_gettime(CLOCK_REALTIME, tp);
499 if (clkid == USBI_CLOCK_MONOTONIC)
500 return clock_gettime(CLOCK_MONOTONIC, tp);
502 return (LIBUSB_ERROR_INVALID_PARAM);
506 _errno_to_libusb(int err)
510 return (LIBUSB_ERROR_IO);
512 return (LIBUSB_ERROR_ACCESS);
514 return (LIBUSB_ERROR_NO_DEVICE);
516 return (LIBUSB_ERROR_NO_MEM);
519 usbi_dbg("error: %s", strerror(err));
521 return (LIBUSB_ERROR_OTHER);
525 _cache_active_config_descriptor(struct libusb_device *dev, int fd)
527 struct device_priv *dpriv = (struct device_priv *)dev->os_priv;
528 struct usb_config_desc ucd;
529 struct usb_full_desc ufd;
533 usbi_dbg("fd %d", fd);
535 ucd.ucd_config_index = USB_CURRENT_CONFIG_INDEX;
537 if ((ioctl(fd, USB_GET_CONFIG_DESC, &ucd)) < 0)
538 return _errno_to_libusb(errno);
540 usbi_dbg("active bLength %d", ucd.ucd_desc.bLength);
542 len = UGETW(ucd.ucd_desc.wTotalLength);
545 return (LIBUSB_ERROR_NO_MEM);
547 ufd.ufd_config_index = ucd.ucd_config_index;
551 usbi_dbg("index %d, len %d", ufd.ufd_config_index, len);
553 if ((ioctl(fd, USB_GET_FULL_DESC, &ufd)) < 0) {
555 return _errno_to_libusb(errno);
566 _sync_control_transfer(struct usbi_transfer *itransfer)
568 struct libusb_transfer *transfer;
569 struct libusb_control_setup *setup;
570 struct device_priv *dpriv;
571 struct usb_ctl_request req;
573 transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
574 dpriv = (struct device_priv *)transfer->dev_handle->dev->os_priv;
575 setup = (struct libusb_control_setup *)transfer->buffer;
577 usbi_dbg("type %d request %d value %d index %d length %d timeout %d",
578 setup->bmRequestType, setup->bRequest,
579 libusb_le16_to_cpu(setup->wValue),
580 libusb_le16_to_cpu(setup->wIndex),
581 libusb_le16_to_cpu(setup->wLength), transfer->timeout);
583 req.ucr_request.bmRequestType = setup->bmRequestType;
584 req.ucr_request.bRequest = setup->bRequest;
585 /* Don't use USETW, libusb already deals with the endianness */
586 (*(uint16_t *)req.ucr_request.wValue) = setup->wValue;
587 (*(uint16_t *)req.ucr_request.wIndex) = setup->wIndex;
588 (*(uint16_t *)req.ucr_request.wLength) = setup->wLength;
589 req.ucr_data = transfer->buffer + LIBUSB_CONTROL_SETUP_SIZE;
591 if ((transfer->flags & LIBUSB_TRANSFER_SHORT_NOT_OK) == 0)
592 req.ucr_flags = USBD_SHORT_XFER_OK;
594 if ((ioctl(dpriv->fd, USB_SET_TIMEOUT, &transfer->timeout)) < 0)
595 return _errno_to_libusb(errno);
597 if ((ioctl(dpriv->fd, USB_DO_REQUEST, &req)) < 0)
598 return _errno_to_libusb(errno);
600 itransfer->transferred = req.ucr_actlen;
602 usbi_dbg("transferred %d", itransfer->transferred);
608 _access_endpoint(struct libusb_transfer *transfer)
610 struct handle_priv *hpriv;
611 struct device_priv *dpriv;
612 char *s, devnode[16];
616 hpriv = (struct handle_priv *)transfer->dev_handle->os_priv;
617 dpriv = (struct device_priv *)transfer->dev_handle->dev->os_priv;
619 endpt = UE_GET_ADDR(transfer->endpoint);
620 mode = IS_XFERIN(transfer) ? O_RDONLY : O_WRONLY;
622 usbi_dbg("endpoint %d mode %d", endpt, mode);
624 if (hpriv->endpoints[endpt] < 0) {
625 /* Pick the right node given the control one */
626 strlcpy(devnode, dpriv->devnode, sizeof(devnode));
627 s = strchr(devnode, '.');
628 snprintf(s, 4, ".%02d", endpt);
630 /* We may need to read/write to the same endpoint later. */
631 if (((fd = open(devnode, O_RDWR)) < 0) && (errno == ENXIO))
632 if ((fd = open(devnode, mode)) < 0)
635 hpriv->endpoints[endpt] = fd;
638 return (hpriv->endpoints[endpt]);
642 _sync_gen_transfer(struct usbi_transfer *itransfer)
644 struct libusb_transfer *transfer;
647 transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
650 * Bulk, Interrupt or Isochronous transfer depends on the
651 * endpoint and thus the node to open.
653 if ((fd = _access_endpoint(transfer)) < 0)
654 return _errno_to_libusb(errno);
656 if ((ioctl(fd, USB_SET_TIMEOUT, &transfer->timeout)) < 0)
657 return _errno_to_libusb(errno);
659 if (IS_XFERIN(transfer)) {
660 if ((transfer->flags & LIBUSB_TRANSFER_SHORT_NOT_OK) == 0)
661 if ((ioctl(fd, USB_SET_SHORT_XFER, &nr)) < 0)
662 return _errno_to_libusb(errno);
664 nr = read(fd, transfer->buffer, transfer->length);
666 nr = write(fd, transfer->buffer, transfer->length);
670 return _errno_to_libusb(errno);
672 itransfer->transferred = nr;