3 * Copyright (c) 2008-2009 Hans Petter Selasky. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 #include <sys/queue.h>
36 #include "libusb20_desc.h"
37 #include "libusb20_int.h"
42 return (LIBUSB20_ERROR_NOT_SUPPORTED);
52 dummy_callback(struct libusb20_transfer *xfer)
55 switch (libusb20_tr_get_status(xfer)) {
56 case LIBUSB20_TRANSFER_START:
57 libusb20_tr_submit(xfer);
60 /* complete or error */
66 #define dummy_get_config_desc_full (void *)dummy_int
67 #define dummy_get_config_index (void *)dummy_int
68 #define dummy_set_config_index (void *)dummy_int
69 #define dummy_set_alt_index (void *)dummy_int
70 #define dummy_reset_device (void *)dummy_int
71 #define dummy_check_connected (void *)dummy_int
72 #define dummy_set_power_mode (void *)dummy_int
73 #define dummy_get_power_mode (void *)dummy_int
74 #define dummy_get_power_usage (void *)dummy_int
75 #define dummy_kernel_driver_active (void *)dummy_int
76 #define dummy_detach_kernel_driver (void *)dummy_int
77 #define dummy_do_request_sync (void *)dummy_int
78 #define dummy_tr_open (void *)dummy_int
79 #define dummy_tr_close (void *)dummy_int
80 #define dummy_tr_clear_stall_sync (void *)dummy_int
81 #define dummy_process (void *)dummy_int
82 #define dummy_dev_info (void *)dummy_int
83 #define dummy_dev_get_iface_driver (void *)dummy_int
85 #define dummy_tr_submit (void *)dummy_void
86 #define dummy_tr_cancel_async (void *)dummy_void
88 static const struct libusb20_device_methods libusb20_dummy_methods = {
89 LIBUSB20_DEVICE(LIBUSB20_DECLARE, dummy)
93 libusb20_tr_callback_wrapper(struct libusb20_transfer *xfer)
99 if (!xfer->is_pending) {
100 xfer->status = LIBUSB20_TRANSFER_START;
102 xfer->is_pending = 0;
105 xfer->callback(xfer);
107 if (xfer->is_restart) {
108 xfer->is_restart = 0;
111 if (xfer->is_draining &&
112 (!xfer->is_pending)) {
113 xfer->is_draining = 0;
114 xfer->status = LIBUSB20_TRANSFER_DRAINED;
115 xfer->callback(xfer);
121 libusb20_tr_close(struct libusb20_transfer *xfer)
125 if (!xfer->is_opened) {
126 return (LIBUSB20_ERROR_OTHER);
128 error = xfer->pdev->methods->tr_close(xfer);
133 if (xfer->ppBuffer) {
134 free(xfer->ppBuffer);
136 /* reset variable fields in case the transfer is opened again */
140 xfer->is_pending = 0;
142 xfer->is_draining = 0;
143 xfer->is_restart = 0;
150 xfer->maxTotalLength = 0;
151 xfer->maxPacketLen = 0;
156 libusb20_tr_open(struct libusb20_transfer *xfer, uint32_t MaxBufSize,
157 uint32_t MaxFrameCount, uint8_t ep_no)
159 return (libusb20_tr_open_stream(xfer, MaxBufSize, MaxFrameCount, ep_no, 0));
163 libusb20_tr_open_stream(struct libusb20_transfer *xfer, uint32_t MaxBufSize,
164 uint32_t MaxFrameCount, uint8_t ep_no, uint16_t stream_id)
171 return (LIBUSB20_ERROR_BUSY);
172 if (MaxFrameCount & LIBUSB20_MAX_FRAME_PRE_SCALE) {
173 MaxFrameCount &= ~LIBUSB20_MAX_FRAME_PRE_SCALE;
178 if (MaxFrameCount == 0)
179 return (LIBUSB20_ERROR_INVALID_PARAM);
181 xfer->maxFrames = MaxFrameCount;
183 size = MaxFrameCount * sizeof(xfer->pLength[0]);
184 xfer->pLength = malloc(size);
185 if (xfer->pLength == NULL) {
186 return (LIBUSB20_ERROR_NO_MEM);
188 memset(xfer->pLength, 0, size);
190 size = MaxFrameCount * sizeof(xfer->ppBuffer[0]);
191 xfer->ppBuffer = malloc(size);
192 if (xfer->ppBuffer == NULL) {
194 return (LIBUSB20_ERROR_NO_MEM);
196 memset(xfer->ppBuffer, 0, size);
198 error = xfer->pdev->methods->tr_open(xfer, MaxBufSize,
199 MaxFrameCount, ep_no, stream_id, pre_scale);
202 free(xfer->ppBuffer);
210 struct libusb20_transfer *
211 libusb20_tr_get_pointer(struct libusb20_device *pdev, uint16_t trIndex)
213 if (trIndex >= pdev->nTransfer) {
216 return (pdev->pTransfer + trIndex);
220 libusb20_tr_get_actual_frames(struct libusb20_transfer *xfer)
222 return (xfer->aFrames);
226 libusb20_tr_get_time_complete(struct libusb20_transfer *xfer)
228 return (xfer->timeComplete);
232 libusb20_tr_get_actual_length(struct libusb20_transfer *xfer)
237 for (x = 0; x != xfer->aFrames; x++) {
238 actlen += xfer->pLength[x];
244 libusb20_tr_get_max_frames(struct libusb20_transfer *xfer)
246 return (xfer->maxFrames);
250 libusb20_tr_get_max_packet_length(struct libusb20_transfer *xfer)
253 * Special Case NOTE: If the packet multiplier is non-zero for
254 * High Speed USB, the value returned is equal to
255 * "wMaxPacketSize * multiplier" !
257 return (xfer->maxPacketLen);
261 libusb20_tr_get_max_total_length(struct libusb20_transfer *xfer)
263 return (xfer->maxTotalLength);
267 libusb20_tr_get_status(struct libusb20_transfer *xfer)
269 return (xfer->status);
273 libusb20_tr_pending(struct libusb20_transfer *xfer)
275 return (xfer->is_pending);
279 libusb20_tr_get_priv_sc0(struct libusb20_transfer *xfer)
281 return (xfer->priv_sc0);
285 libusb20_tr_get_priv_sc1(struct libusb20_transfer *xfer)
287 return (xfer->priv_sc1);
291 libusb20_tr_stop(struct libusb20_transfer *xfer)
293 if (!xfer->is_opened) {
294 /* transfer is not opened */
297 if (!xfer->is_pending) {
298 /* transfer not pending */
301 if (xfer->is_cancel) {
302 /* already cancelling */
305 xfer->is_cancel = 1; /* we are cancelling */
307 xfer->pdev->methods->tr_cancel_async(xfer);
312 libusb20_tr_drain(struct libusb20_transfer *xfer)
314 if (!xfer->is_opened) {
315 /* transfer is not opened */
318 /* make sure that we are cancelling */
319 libusb20_tr_stop(xfer);
321 if (xfer->is_pending) {
322 xfer->is_draining = 1;
328 libusb20_tr_clear_stall_sync(struct libusb20_transfer *xfer)
330 xfer->pdev->methods->tr_clear_stall_sync(xfer);
335 libusb20_tr_set_buffer(struct libusb20_transfer *xfer, void *buffer, uint16_t frIndex)
337 xfer->ppBuffer[frIndex] = libusb20_pass_ptr(buffer);
342 libusb20_tr_set_callback(struct libusb20_transfer *xfer, libusb20_tr_callback_t *cb)
349 libusb20_tr_set_flags(struct libusb20_transfer *xfer, uint8_t flags)
356 libusb20_tr_get_length(struct libusb20_transfer *xfer, uint16_t frIndex)
358 return (xfer->pLength[frIndex]);
362 libusb20_tr_set_length(struct libusb20_transfer *xfer, uint32_t length, uint16_t frIndex)
364 xfer->pLength[frIndex] = length;
369 libusb20_tr_set_priv_sc0(struct libusb20_transfer *xfer, void *sc0)
371 xfer->priv_sc0 = sc0;
376 libusb20_tr_set_priv_sc1(struct libusb20_transfer *xfer, void *sc1)
378 xfer->priv_sc1 = sc1;
383 libusb20_tr_set_timeout(struct libusb20_transfer *xfer, uint32_t timeout)
385 xfer->timeout = timeout;
390 libusb20_tr_set_total_frames(struct libusb20_transfer *xfer, uint32_t nFrames)
392 if (nFrames > xfer->maxFrames) {
393 /* should not happen */
394 nFrames = xfer->maxFrames;
396 xfer->nFrames = nFrames;
401 libusb20_tr_setup_bulk(struct libusb20_transfer *xfer, void *pBuf, uint32_t length, uint32_t timeout)
403 xfer->ppBuffer[0] = libusb20_pass_ptr(pBuf);
404 xfer->pLength[0] = length;
405 xfer->timeout = timeout;
411 libusb20_tr_setup_control(struct libusb20_transfer *xfer, void *psetup, void *pBuf, uint32_t timeout)
415 xfer->ppBuffer[0] = libusb20_pass_ptr(psetup);
416 xfer->pLength[0] = 8; /* fixed */
417 xfer->timeout = timeout;
419 len = ((uint8_t *)psetup)[6] | (((uint8_t *)psetup)[7] << 8);
423 xfer->ppBuffer[1] = libusb20_pass_ptr(pBuf);
424 xfer->pLength[1] = len;
432 libusb20_tr_setup_intr(struct libusb20_transfer *xfer, void *pBuf, uint32_t length, uint32_t timeout)
434 xfer->ppBuffer[0] = libusb20_pass_ptr(pBuf);
435 xfer->pLength[0] = length;
436 xfer->timeout = timeout;
442 libusb20_tr_setup_isoc(struct libusb20_transfer *xfer, void *pBuf, uint32_t length, uint16_t frIndex)
444 if (frIndex >= xfer->maxFrames) {
445 /* should not happen */
448 xfer->ppBuffer[frIndex] = libusb20_pass_ptr(pBuf);
449 xfer->pLength[frIndex] = length;
454 libusb20_tr_bulk_intr_sync(struct libusb20_transfer *xfer,
455 void *pbuf, uint32_t length, uint32_t *pactlen,
458 struct libusb20_device *pdev = xfer->pdev;
459 uint32_t transfer_max;
460 uint32_t transfer_act;
463 /* set some sensible default value */
467 /* check for error condition */
468 if (libusb20_tr_pending(xfer))
469 return (LIBUSB20_ERROR_OTHER);
472 /* compute maximum transfer length */
474 libusb20_tr_get_max_total_length(xfer);
476 if (transfer_max > length)
477 transfer_max = length;
479 /* setup bulk or interrupt transfer */
480 libusb20_tr_setup_bulk(xfer, pbuf,
481 transfer_max, timeout);
483 /* start the transfer */
484 libusb20_tr_start(xfer);
486 /* wait for transfer completion */
487 while (libusb20_dev_process(pdev) == 0) {
489 if (libusb20_tr_pending(xfer) == 0)
492 libusb20_dev_wait_process(pdev, -1);
495 transfer_act = libusb20_tr_get_actual_length(xfer);
497 /* update actual length, if any */
499 pactlen[0] += transfer_act;
501 /* check transfer status */
502 retval = libusb20_tr_get_status(xfer);
506 /* check for short transfer */
507 if (transfer_act != transfer_max)
510 /* update buffer pointer and length */
511 pbuf = ((uint8_t *)pbuf) + transfer_max;
512 length = length - transfer_max;
514 } while (length != 0);
520 libusb20_tr_submit(struct libusb20_transfer *xfer)
522 if (!xfer->is_opened) {
523 /* transfer is not opened */
526 if (xfer->is_pending) {
527 /* should not happen */
530 xfer->is_pending = 1; /* we are pending */
531 xfer->is_cancel = 0; /* not cancelling */
532 xfer->is_restart = 0; /* not restarting */
534 xfer->pdev->methods->tr_submit(xfer);
539 libusb20_tr_start(struct libusb20_transfer *xfer)
541 if (!xfer->is_opened) {
542 /* transfer is not opened */
545 if (xfer->is_pending) {
546 if (xfer->is_cancel) {
547 /* cancelling - restart */
548 xfer->is_restart = 1;
550 /* transfer not pending */
553 /* get into the callback */
554 libusb20_tr_callback_wrapper(xfer);
558 /* USB device operations */
561 libusb20_dev_close(struct libusb20_device *pdev)
563 struct libusb20_transfer *xfer;
567 if (!pdev->is_opened) {
568 return (LIBUSB20_ERROR_OTHER);
570 for (x = 0; x != pdev->nTransfer; x++) {
571 xfer = pdev->pTransfer + x;
573 if (!xfer->is_opened) {
574 /* transfer is not opened */
578 libusb20_tr_drain(xfer);
580 libusb20_tr_close(xfer);
583 if (pdev->pTransfer != NULL) {
584 free(pdev->pTransfer);
585 pdev->pTransfer = NULL;
587 error = pdev->beMethods->close_device(pdev);
589 pdev->methods = &libusb20_dummy_methods;
594 * The following variable is only used by the libusb v0.1
597 pdev->claimed_interface = 0;
603 libusb20_dev_detach_kernel_driver(struct libusb20_device *pdev, uint8_t ifaceIndex)
607 error = pdev->methods->detach_kernel_driver(pdev, ifaceIndex);
611 struct LIBUSB20_DEVICE_DESC_DECODED *
612 libusb20_dev_get_device_desc(struct libusb20_device *pdev)
614 return (&(pdev->ddesc));
618 libusb20_dev_get_fd(struct libusb20_device *pdev)
624 libusb20_dev_kernel_driver_active(struct libusb20_device *pdev, uint8_t ifaceIndex)
628 error = pdev->methods->kernel_driver_active(pdev, ifaceIndex);
633 libusb20_dev_open(struct libusb20_device *pdev, uint16_t nTransferMax)
635 struct libusb20_transfer *xfer;
640 if (pdev->is_opened) {
641 return (LIBUSB20_ERROR_BUSY);
643 if (nTransferMax >= 256) {
644 return (LIBUSB20_ERROR_INVALID_PARAM);
645 } else if (nTransferMax != 0) {
646 size = sizeof(pdev->pTransfer[0]) * nTransferMax;
647 pdev->pTransfer = malloc(size);
648 if (pdev->pTransfer == NULL) {
649 return (LIBUSB20_ERROR_NO_MEM);
651 memset(pdev->pTransfer, 0, size);
653 /* initialise all transfers */
654 for (x = 0; x != nTransferMax; x++) {
656 xfer = pdev->pTransfer + x;
660 xfer->callback = &dummy_callback;
663 /* set "nTransfer" early */
664 pdev->nTransfer = nTransferMax;
666 error = pdev->beMethods->open_device(pdev, nTransferMax);
669 if (pdev->pTransfer != NULL) {
670 free(pdev->pTransfer);
671 pdev->pTransfer = NULL;
674 pdev->file_ctrl = -1;
683 libusb20_dev_reset(struct libusb20_device *pdev)
687 error = pdev->methods->reset_device(pdev);
692 libusb20_dev_check_connected(struct libusb20_device *pdev)
696 error = pdev->methods->check_connected(pdev);
701 libusb20_dev_set_power_mode(struct libusb20_device *pdev, uint8_t power_mode)
705 error = pdev->methods->set_power_mode(pdev, power_mode);
710 libusb20_dev_get_power_mode(struct libusb20_device *pdev)
715 error = pdev->methods->get_power_mode(pdev, &power_mode);
717 power_mode = LIBUSB20_POWER_ON; /* fake power mode */
722 libusb20_dev_get_power_usage(struct libusb20_device *pdev)
725 uint16_t power_usage;
727 error = pdev->methods->get_power_usage(pdev, &power_usage);
730 return (power_usage);
734 libusb20_dev_set_alt_index(struct libusb20_device *pdev, uint8_t ifaceIndex, uint8_t altIndex)
738 error = pdev->methods->set_alt_index(pdev, ifaceIndex, altIndex);
743 libusb20_dev_set_config_index(struct libusb20_device *pdev, uint8_t configIndex)
747 error = pdev->methods->set_config_index(pdev, configIndex);
752 libusb20_dev_request_sync(struct libusb20_device *pdev,
753 struct LIBUSB20_CONTROL_SETUP_DECODED *setup, void *data,
754 uint16_t *pactlen, uint32_t timeout, uint8_t flags)
758 error = pdev->methods->do_request_sync(pdev,
759 setup, data, pactlen, timeout, flags);
764 libusb20_dev_req_string_sync(struct libusb20_device *pdev,
765 uint8_t str_index, uint16_t langid, void *ptr, uint16_t len)
767 struct LIBUSB20_CONTROL_SETUP_DECODED req;
770 /* make sure memory is initialised */
775 return (LIBUSB20_ERROR_INVALID_PARAM);
777 LIBUSB20_INIT(LIBUSB20_CONTROL_SETUP, &req);
780 * We need to read the USB string in two steps else some USB
781 * devices will complain.
784 LIBUSB20_REQUEST_TYPE_STANDARD |
785 LIBUSB20_RECIPIENT_DEVICE |
786 LIBUSB20_ENDPOINT_IN;
787 req.bRequest = LIBUSB20_REQUEST_GET_DESCRIPTOR;
788 req.wValue = (LIBUSB20_DT_STRING << 8) | str_index;
790 req.wLength = 4; /* bytes */
792 error = libusb20_dev_request_sync(pdev, &req,
793 ptr, NULL, 1000, LIBUSB20_TRANSFER_SINGLE_SHORT_NOT_OK);
797 req.wLength = *(uint8_t *)ptr; /* bytes */
798 if (req.wLength > len) {
799 /* partial string read */
802 error = libusb20_dev_request_sync(pdev, &req,
803 ptr, NULL, 1000, LIBUSB20_TRANSFER_SINGLE_SHORT_NOT_OK);
808 if (((uint8_t *)ptr)[1] != LIBUSB20_DT_STRING) {
809 return (LIBUSB20_ERROR_OTHER);
811 return (0); /* success */
815 libusb20_dev_req_string_simple_sync(struct libusb20_device *pdev,
816 uint8_t str_index, void *ptr, uint16_t len)
827 /* the following code derives from the FreeBSD USB kernel */
829 if ((len < 1) || (ptr == NULL)) {
830 /* too short buffer */
831 return (LIBUSB20_ERROR_INVALID_PARAM);
833 error = libusb20_dev_req_string_sync(pdev,
834 0, 0, temp, sizeof(temp));
836 *(uint8_t *)ptr = 0; /* zero terminate */
839 langid = temp[2] | (temp[3] << 8);
841 error = libusb20_dev_req_string_sync(pdev, str_index,
842 langid, temp, sizeof(temp));
844 *(uint8_t *)ptr = 0; /* zero terminate */
848 /* string length is too short */
849 *(uint8_t *)ptr = 0; /* zero terminate */
850 return (LIBUSB20_ERROR_OTHER);
852 /* reserve one byte for terminating zero */
855 /* find maximum length */
856 n = (temp[0] / 2) - 1;
860 /* reset swap state */
863 /* setup output buffer pointer */
866 /* convert and filter */
867 for (i = 0; (i != n); i++) {
868 c = temp[(2 * i) + 2] | (temp[(2 * i) + 3] << 8);
870 /* convert from Unicode, handle buggy strings */
871 if (((c & 0xff00) == 0) && (swap & 1)) {
872 /* Little Endian, default */
875 } else if (((c & 0x00ff) == 0) && (swap & 2)) {
880 /* skip invalid character */
884 * Filter by default - we don't allow greater and less than
885 * signs because they might confuse the dmesg printouts!
887 if ((*buf == '<') || (*buf == '>') || (!isprint(*buf))) {
888 /* skip invalid character */
893 *buf = 0; /* zero terminate string */
898 struct libusb20_config *
899 libusb20_dev_alloc_config(struct libusb20_device *pdev, uint8_t configIndex)
901 struct libusb20_config *retval = NULL;
907 if (!pdev->is_opened) {
908 error = libusb20_dev_open(pdev, 0);
916 error = pdev->methods->get_config_desc_full(pdev,
917 &ptr, &len, configIndex);
922 /* parse new config descriptor */
923 retval = libusb20_parse_config_desc(ptr);
925 /* free config descriptor */
930 error = libusb20_dev_close(pdev);
935 struct libusb20_device *
936 libusb20_dev_alloc(void)
938 struct libusb20_device *pdev;
940 pdev = malloc(sizeof(*pdev));
944 memset(pdev, 0, sizeof(*pdev));
947 pdev->file_ctrl = -1;
948 pdev->methods = &libusb20_dummy_methods;
953 libusb20_dev_get_config_index(struct libusb20_device *pdev)
959 if (!pdev->is_opened) {
960 error = libusb20_dev_open(pdev, 0);
970 error = pdev->methods->get_config_index(pdev, &cfg_index);
972 cfg_index = 0xFF; /* current config index */
974 if (libusb20_dev_close(pdev)) {
982 libusb20_dev_get_mode(struct libusb20_device *pdev)
984 return (pdev->usb_mode);
988 libusb20_dev_get_speed(struct libusb20_device *pdev)
990 return (pdev->usb_speed);
993 /* if this function returns an error, the device is gone */
995 libusb20_dev_process(struct libusb20_device *pdev)
999 error = pdev->methods->process(pdev);
1004 libusb20_dev_wait_process(struct libusb20_device *pdev, int timeout)
1006 struct pollfd pfd[1];
1008 if (!pdev->is_opened) {
1011 pfd[0].fd = pdev->file;
1012 pfd[0].events = (POLLIN | POLLOUT | POLLRDNORM | POLLWRNORM);
1015 if (poll(pfd, 1, timeout)) {
1016 /* ignore any error */
1022 libusb20_dev_free(struct libusb20_device *pdev)
1028 if (pdev->is_opened) {
1029 if (libusb20_dev_close(pdev)) {
1030 /* ignore any errors */
1038 libusb20_dev_get_info(struct libusb20_device *pdev,
1039 struct usb_device_info *pinfo)
1042 return (LIBUSB20_ERROR_INVALID_PARAM);
1044 return (pdev->beMethods->dev_get_info(pdev, pinfo));
1048 libusb20_dev_get_backend_name(struct libusb20_device *pdev)
1050 return (pdev->beMethods->get_backend_name());
1054 libusb20_dev_get_desc(struct libusb20_device *pdev)
1056 return (pdev->usb_desc);
1060 libusb20_dev_set_debug(struct libusb20_device *pdev, int debug)
1062 pdev->debug = debug;
1067 libusb20_dev_get_debug(struct libusb20_device *pdev)
1069 return (pdev->debug);
1073 libusb20_dev_get_address(struct libusb20_device *pdev)
1075 return (pdev->device_address);
1079 libusb20_dev_get_parent_address(struct libusb20_device *pdev)
1081 return (pdev->parent_address);
1085 libusb20_dev_get_parent_port(struct libusb20_device *pdev)
1087 return (pdev->parent_port);
1091 libusb20_dev_get_bus_number(struct libusb20_device *pdev)
1093 return (pdev->bus_number);
1097 libusb20_dev_get_iface_desc(struct libusb20_device *pdev,
1098 uint8_t iface_index, char *buf, uint8_t len)
1100 if ((buf == NULL) || (len == 0))
1101 return (LIBUSB20_ERROR_INVALID_PARAM);
1103 buf[0] = 0; /* set default string value */
1105 return (pdev->beMethods->dev_get_iface_desc(
1106 pdev, iface_index, buf, len));
1109 /* USB backend operations */
1112 libusb20_be_get_dev_quirk(struct libusb20_backend *pbe,
1113 uint16_t quirk_index, struct libusb20_quirk *pq)
1115 return (pbe->methods->root_get_dev_quirk(pbe, quirk_index, pq));
1119 libusb20_be_get_quirk_name(struct libusb20_backend *pbe,
1120 uint16_t quirk_index, struct libusb20_quirk *pq)
1122 return (pbe->methods->root_get_quirk_name(pbe, quirk_index, pq));
1126 libusb20_be_add_dev_quirk(struct libusb20_backend *pbe,
1127 struct libusb20_quirk *pq)
1129 return (pbe->methods->root_add_dev_quirk(pbe, pq));
1133 libusb20_be_remove_dev_quirk(struct libusb20_backend *pbe,
1134 struct libusb20_quirk *pq)
1136 return (pbe->methods->root_remove_dev_quirk(pbe, pq));
1140 libusb20_be_set_template(struct libusb20_backend *pbe, int temp)
1142 return (pbe->methods->root_set_template(pbe, temp));
1146 libusb20_be_get_template(struct libusb20_backend *pbe, int *ptemp)
1153 return (pbe->methods->root_get_template(pbe, ptemp));
1156 struct libusb20_device *
1157 libusb20_be_device_foreach(struct libusb20_backend *pbe, struct libusb20_device *pdev)
1161 } else if (pdev == NULL) {
1162 pdev = TAILQ_FIRST(&(pbe->usb_devs));
1164 pdev = TAILQ_NEXT(pdev, dev_entry);
1169 struct libusb20_backend *
1170 libusb20_be_alloc(const struct libusb20_backend_methods *methods)
1172 struct libusb20_backend *pbe;
1174 pbe = malloc(sizeof(*pbe));
1178 memset(pbe, 0, sizeof(*pbe));
1180 TAILQ_INIT(&(pbe->usb_devs));
1182 pbe->methods = methods; /* set backend methods */
1184 /* do the initial device scan */
1185 if (pbe->methods->init_backend) {
1186 pbe->methods->init_backend(pbe);
1191 struct libusb20_backend *
1192 libusb20_be_alloc_linux(void)
1194 struct libusb20_backend *pbe;
1197 pbe = libusb20_be_alloc(&libusb20_linux_backend);
1204 struct libusb20_backend *
1205 libusb20_be_alloc_ugen20(void)
1207 struct libusb20_backend *pbe;
1209 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
1210 pbe = libusb20_be_alloc(&libusb20_ugen20_backend);
1217 struct libusb20_backend *
1218 libusb20_be_alloc_default(void)
1220 struct libusb20_backend *pbe;
1222 pbe = libusb20_be_alloc_linux();
1226 pbe = libusb20_be_alloc_ugen20();
1230 return (NULL); /* no backend found */
1234 libusb20_be_free(struct libusb20_backend *pbe)
1236 struct libusb20_device *pdev;
1242 while ((pdev = libusb20_be_device_foreach(pbe, NULL))) {
1243 libusb20_be_dequeue_device(pbe, pdev);
1244 libusb20_dev_free(pdev);
1246 if (pbe->methods->exit_backend) {
1247 pbe->methods->exit_backend(pbe);
1254 libusb20_be_enqueue_device(struct libusb20_backend *pbe, struct libusb20_device *pdev)
1256 pdev->beMethods = pbe->methods; /* copy backend methods */
1257 TAILQ_INSERT_TAIL(&(pbe->usb_devs), pdev, dev_entry);
1261 libusb20_be_dequeue_device(struct libusb20_backend *pbe,
1262 struct libusb20_device *pdev)
1264 TAILQ_REMOVE(&(pbe->usb_devs), pdev, dev_entry);
1268 libusb20_strerror(int code)
1271 case LIBUSB20_SUCCESS:
1273 case LIBUSB20_ERROR_IO:
1274 return ("I/O error");
1275 case LIBUSB20_ERROR_INVALID_PARAM:
1276 return ("Invalid parameter");
1277 case LIBUSB20_ERROR_ACCESS:
1278 return ("Permissions error");
1279 case LIBUSB20_ERROR_NO_DEVICE:
1280 return ("No device");
1281 case LIBUSB20_ERROR_NOT_FOUND:
1282 return ("Not found");
1283 case LIBUSB20_ERROR_BUSY:
1284 return ("Device busy");
1285 case LIBUSB20_ERROR_TIMEOUT:
1287 case LIBUSB20_ERROR_OVERFLOW:
1288 return ("Overflow");
1289 case LIBUSB20_ERROR_PIPE:
1290 return ("Pipe error");
1291 case LIBUSB20_ERROR_INTERRUPTED:
1292 return ("Interrupted");
1293 case LIBUSB20_ERROR_NO_MEM:
1294 return ("Out of memory");
1295 case LIBUSB20_ERROR_NOT_SUPPORTED:
1296 return ("Not supported");
1297 case LIBUSB20_ERROR_OTHER:
1298 return ("Other error");
1300 return ("Unknown error");
1305 libusb20_error_name(int code)
1308 case LIBUSB20_SUCCESS:
1309 return ("LIBUSB20_SUCCESS");
1310 case LIBUSB20_ERROR_IO:
1311 return ("LIBUSB20_ERROR_IO");
1312 case LIBUSB20_ERROR_INVALID_PARAM:
1313 return ("LIBUSB20_ERROR_INVALID_PARAM");
1314 case LIBUSB20_ERROR_ACCESS:
1315 return ("LIBUSB20_ERROR_ACCESS");
1316 case LIBUSB20_ERROR_NO_DEVICE:
1317 return ("LIBUSB20_ERROR_NO_DEVICE");
1318 case LIBUSB20_ERROR_NOT_FOUND:
1319 return ("LIBUSB20_ERROR_NOT_FOUND");
1320 case LIBUSB20_ERROR_BUSY:
1321 return ("LIBUSB20_ERROR_BUSY");
1322 case LIBUSB20_ERROR_TIMEOUT:
1323 return ("LIBUSB20_ERROR_TIMEOUT");
1324 case LIBUSB20_ERROR_OVERFLOW:
1325 return ("LIBUSB20_ERROR_OVERFLOW");
1326 case LIBUSB20_ERROR_PIPE:
1327 return ("LIBUSB20_ERROR_PIPE");
1328 case LIBUSB20_ERROR_INTERRUPTED:
1329 return ("LIBUSB20_ERROR_INTERRUPTED");
1330 case LIBUSB20_ERROR_NO_MEM:
1331 return ("LIBUSB20_ERROR_NO_MEM");
1332 case LIBUSB20_ERROR_NOT_SUPPORTED:
1333 return ("LIBUSB20_ERROR_NOT_SUPPORTED");
1334 case LIBUSB20_ERROR_OTHER:
1335 return ("LIBUSB20_ERROR_OTHER");
1337 return ("LIBUSB20_ERROR_UNKNOWN");