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 #ifdef LIBUSB_GLOBAL_INCLUDE_FILE
28 #include LIBUSB_GLOBAL_INCLUDE_FILE
36 #include <sys/queue.h>
40 #include "libusb20_desc.h"
41 #include "libusb20_int.h"
46 return (LIBUSB20_ERROR_NOT_SUPPORTED);
56 dummy_callback(struct libusb20_transfer *xfer)
59 switch (libusb20_tr_get_status(xfer)) {
60 case LIBUSB20_TRANSFER_START:
61 libusb20_tr_submit(xfer);
64 /* complete or error */
70 #define dummy_get_config_desc_full (void *)dummy_int
71 #define dummy_get_config_index (void *)dummy_int
72 #define dummy_set_config_index (void *)dummy_int
73 #define dummy_set_alt_index (void *)dummy_int
74 #define dummy_reset_device (void *)dummy_int
75 #define dummy_check_connected (void *)dummy_int
76 #define dummy_set_power_mode (void *)dummy_int
77 #define dummy_get_power_mode (void *)dummy_int
78 #define dummy_get_power_usage (void *)dummy_int
79 #define dummy_kernel_driver_active (void *)dummy_int
80 #define dummy_detach_kernel_driver (void *)dummy_int
81 #define dummy_do_request_sync (void *)dummy_int
82 #define dummy_tr_open (void *)dummy_int
83 #define dummy_tr_close (void *)dummy_int
84 #define dummy_tr_clear_stall_sync (void *)dummy_int
85 #define dummy_process (void *)dummy_int
86 #define dummy_dev_info (void *)dummy_int
87 #define dummy_dev_get_iface_driver (void *)dummy_int
89 #define dummy_tr_submit (void *)dummy_void
90 #define dummy_tr_cancel_async (void *)dummy_void
92 static const struct libusb20_device_methods libusb20_dummy_methods = {
93 LIBUSB20_DEVICE(LIBUSB20_DECLARE, dummy)
97 libusb20_tr_callback_wrapper(struct libusb20_transfer *xfer)
103 if (!xfer->is_pending) {
104 xfer->status = LIBUSB20_TRANSFER_START;
106 xfer->is_pending = 0;
109 xfer->callback(xfer);
111 if (xfer->is_restart) {
112 xfer->is_restart = 0;
115 if (xfer->is_draining &&
116 (!xfer->is_pending)) {
117 xfer->is_draining = 0;
118 xfer->status = LIBUSB20_TRANSFER_DRAINED;
119 xfer->callback(xfer);
125 libusb20_tr_close(struct libusb20_transfer *xfer)
129 if (!xfer->is_opened) {
130 return (LIBUSB20_ERROR_OTHER);
132 error = xfer->pdev->methods->tr_close(xfer);
137 if (xfer->ppBuffer) {
138 free(xfer->ppBuffer);
140 /* reset variable fields in case the transfer is opened again */
144 xfer->is_pending = 0;
146 xfer->is_draining = 0;
147 xfer->is_restart = 0;
154 xfer->maxTotalLength = 0;
155 xfer->maxPacketLen = 0;
160 libusb20_tr_open(struct libusb20_transfer *xfer, uint32_t MaxBufSize,
161 uint32_t MaxFrameCount, uint8_t ep_no)
163 return (libusb20_tr_open_stream(xfer, MaxBufSize, MaxFrameCount, ep_no, 0));
167 libusb20_tr_open_stream(struct libusb20_transfer *xfer, uint32_t MaxBufSize,
168 uint32_t MaxFrameCount, uint8_t ep_no, uint16_t stream_id)
175 return (LIBUSB20_ERROR_BUSY);
176 if (MaxFrameCount & LIBUSB20_MAX_FRAME_PRE_SCALE) {
177 MaxFrameCount &= ~LIBUSB20_MAX_FRAME_PRE_SCALE;
182 if (MaxFrameCount == 0)
183 return (LIBUSB20_ERROR_INVALID_PARAM);
185 xfer->maxFrames = MaxFrameCount;
187 size = MaxFrameCount * sizeof(xfer->pLength[0]);
188 xfer->pLength = malloc(size);
189 if (xfer->pLength == NULL) {
190 return (LIBUSB20_ERROR_NO_MEM);
192 memset(xfer->pLength, 0, size);
194 size = MaxFrameCount * sizeof(xfer->ppBuffer[0]);
195 xfer->ppBuffer = malloc(size);
196 if (xfer->ppBuffer == NULL) {
198 return (LIBUSB20_ERROR_NO_MEM);
200 memset(xfer->ppBuffer, 0, size);
202 error = xfer->pdev->methods->tr_open(xfer, MaxBufSize,
203 MaxFrameCount, ep_no, stream_id, pre_scale);
206 free(xfer->ppBuffer);
214 struct libusb20_transfer *
215 libusb20_tr_get_pointer(struct libusb20_device *pdev, uint16_t trIndex)
217 if (trIndex >= pdev->nTransfer) {
220 return (pdev->pTransfer + trIndex);
224 libusb20_tr_get_actual_frames(struct libusb20_transfer *xfer)
226 return (xfer->aFrames);
230 libusb20_tr_get_time_complete(struct libusb20_transfer *xfer)
232 return (xfer->timeComplete);
236 libusb20_tr_get_actual_length(struct libusb20_transfer *xfer)
241 for (x = 0; x != xfer->aFrames; x++) {
242 actlen += xfer->pLength[x];
248 libusb20_tr_get_max_frames(struct libusb20_transfer *xfer)
250 return (xfer->maxFrames);
254 libusb20_tr_get_max_packet_length(struct libusb20_transfer *xfer)
257 * Special Case NOTE: If the packet multiplier is non-zero for
258 * High Speed USB, the value returned is equal to
259 * "wMaxPacketSize * multiplier" !
261 return (xfer->maxPacketLen);
265 libusb20_tr_get_max_total_length(struct libusb20_transfer *xfer)
267 return (xfer->maxTotalLength);
271 libusb20_tr_get_status(struct libusb20_transfer *xfer)
273 return (xfer->status);
277 libusb20_tr_pending(struct libusb20_transfer *xfer)
279 return (xfer->is_pending);
283 libusb20_tr_get_priv_sc0(struct libusb20_transfer *xfer)
285 return (xfer->priv_sc0);
289 libusb20_tr_get_priv_sc1(struct libusb20_transfer *xfer)
291 return (xfer->priv_sc1);
295 libusb20_tr_stop(struct libusb20_transfer *xfer)
297 if (!xfer->is_opened) {
298 /* transfer is not opened */
301 if (!xfer->is_pending) {
302 /* transfer not pending */
305 if (xfer->is_cancel) {
306 /* already cancelling */
309 xfer->is_cancel = 1; /* we are cancelling */
311 xfer->pdev->methods->tr_cancel_async(xfer);
316 libusb20_tr_drain(struct libusb20_transfer *xfer)
318 if (!xfer->is_opened) {
319 /* transfer is not opened */
322 /* make sure that we are cancelling */
323 libusb20_tr_stop(xfer);
325 if (xfer->is_pending) {
326 xfer->is_draining = 1;
332 libusb20_tr_clear_stall_sync(struct libusb20_transfer *xfer)
334 xfer->pdev->methods->tr_clear_stall_sync(xfer);
339 libusb20_tr_set_buffer(struct libusb20_transfer *xfer, void *buffer, uint16_t frIndex)
341 xfer->ppBuffer[frIndex] = libusb20_pass_ptr(buffer);
346 libusb20_tr_set_callback(struct libusb20_transfer *xfer, libusb20_tr_callback_t *cb)
353 libusb20_tr_set_flags(struct libusb20_transfer *xfer, uint8_t flags)
360 libusb20_tr_get_length(struct libusb20_transfer *xfer, uint16_t frIndex)
362 return (xfer->pLength[frIndex]);
366 libusb20_tr_set_length(struct libusb20_transfer *xfer, uint32_t length, uint16_t frIndex)
368 xfer->pLength[frIndex] = length;
373 libusb20_tr_set_priv_sc0(struct libusb20_transfer *xfer, void *sc0)
375 xfer->priv_sc0 = sc0;
380 libusb20_tr_set_priv_sc1(struct libusb20_transfer *xfer, void *sc1)
382 xfer->priv_sc1 = sc1;
387 libusb20_tr_set_timeout(struct libusb20_transfer *xfer, uint32_t timeout)
389 xfer->timeout = timeout;
394 libusb20_tr_set_total_frames(struct libusb20_transfer *xfer, uint32_t nFrames)
396 if (nFrames > xfer->maxFrames) {
397 /* should not happen */
398 nFrames = xfer->maxFrames;
400 xfer->nFrames = nFrames;
405 libusb20_tr_setup_bulk(struct libusb20_transfer *xfer, void *pBuf, uint32_t length, uint32_t timeout)
407 xfer->ppBuffer[0] = libusb20_pass_ptr(pBuf);
408 xfer->pLength[0] = length;
409 xfer->timeout = timeout;
415 libusb20_tr_setup_control(struct libusb20_transfer *xfer, void *psetup, void *pBuf, uint32_t timeout)
419 xfer->ppBuffer[0] = libusb20_pass_ptr(psetup);
420 xfer->pLength[0] = 8; /* fixed */
421 xfer->timeout = timeout;
423 len = ((uint8_t *)psetup)[6] | (((uint8_t *)psetup)[7] << 8);
427 xfer->ppBuffer[1] = libusb20_pass_ptr(pBuf);
428 xfer->pLength[1] = len;
436 libusb20_tr_setup_intr(struct libusb20_transfer *xfer, void *pBuf, uint32_t length, uint32_t timeout)
438 xfer->ppBuffer[0] = libusb20_pass_ptr(pBuf);
439 xfer->pLength[0] = length;
440 xfer->timeout = timeout;
446 libusb20_tr_setup_isoc(struct libusb20_transfer *xfer, void *pBuf, uint32_t length, uint16_t frIndex)
448 if (frIndex >= xfer->maxFrames) {
449 /* should not happen */
452 xfer->ppBuffer[frIndex] = libusb20_pass_ptr(pBuf);
453 xfer->pLength[frIndex] = length;
458 libusb20_tr_bulk_intr_sync(struct libusb20_transfer *xfer,
459 void *pbuf, uint32_t length, uint32_t *pactlen,
462 struct libusb20_device *pdev = xfer->pdev;
463 uint32_t transfer_max;
464 uint32_t transfer_act;
467 /* set some sensible default value */
471 /* check for error condition */
472 if (libusb20_tr_pending(xfer))
473 return (LIBUSB20_ERROR_OTHER);
476 /* compute maximum transfer length */
478 libusb20_tr_get_max_total_length(xfer);
480 if (transfer_max > length)
481 transfer_max = length;
483 /* setup bulk or interrupt transfer */
484 libusb20_tr_setup_bulk(xfer, pbuf,
485 transfer_max, timeout);
487 /* start the transfer */
488 libusb20_tr_start(xfer);
490 /* wait for transfer completion */
491 while (libusb20_dev_process(pdev) == 0) {
493 if (libusb20_tr_pending(xfer) == 0)
496 libusb20_dev_wait_process(pdev, -1);
499 transfer_act = libusb20_tr_get_actual_length(xfer);
501 /* update actual length, if any */
503 pactlen[0] += transfer_act;
505 /* check transfer status */
506 retval = libusb20_tr_get_status(xfer);
510 /* check for short transfer */
511 if (transfer_act != transfer_max)
514 /* update buffer pointer and length */
515 pbuf = ((uint8_t *)pbuf) + transfer_max;
516 length = length - transfer_max;
518 } while (length != 0);
524 libusb20_tr_submit(struct libusb20_transfer *xfer)
526 if (!xfer->is_opened) {
527 /* transfer is not opened */
530 if (xfer->is_pending) {
531 /* should not happen */
534 xfer->is_pending = 1; /* we are pending */
535 xfer->is_cancel = 0; /* not cancelling */
536 xfer->is_restart = 0; /* not restarting */
538 xfer->pdev->methods->tr_submit(xfer);
543 libusb20_tr_start(struct libusb20_transfer *xfer)
545 if (!xfer->is_opened) {
546 /* transfer is not opened */
549 if (xfer->is_pending) {
550 if (xfer->is_cancel) {
551 /* cancelling - restart */
552 xfer->is_restart = 1;
554 /* transfer not pending */
557 /* get into the callback */
558 libusb20_tr_callback_wrapper(xfer);
562 /* USB device operations */
565 libusb20_dev_close(struct libusb20_device *pdev)
567 struct libusb20_transfer *xfer;
571 if (!pdev->is_opened) {
572 return (LIBUSB20_ERROR_OTHER);
574 for (x = 0; x != pdev->nTransfer; x++) {
575 xfer = pdev->pTransfer + x;
577 if (!xfer->is_opened) {
578 /* transfer is not opened */
582 libusb20_tr_drain(xfer);
584 libusb20_tr_close(xfer);
587 if (pdev->pTransfer != NULL) {
588 free(pdev->pTransfer);
589 pdev->pTransfer = NULL;
591 error = pdev->beMethods->close_device(pdev);
593 pdev->methods = &libusb20_dummy_methods;
598 * The following variable is only used by the libusb v0.1
601 pdev->claimed_interface = 0;
607 libusb20_dev_detach_kernel_driver(struct libusb20_device *pdev, uint8_t ifaceIndex)
611 error = pdev->methods->detach_kernel_driver(pdev, ifaceIndex);
615 struct LIBUSB20_DEVICE_DESC_DECODED *
616 libusb20_dev_get_device_desc(struct libusb20_device *pdev)
618 return (&(pdev->ddesc));
622 libusb20_dev_get_fd(struct libusb20_device *pdev)
628 libusb20_dev_kernel_driver_active(struct libusb20_device *pdev, uint8_t ifaceIndex)
632 error = pdev->methods->kernel_driver_active(pdev, ifaceIndex);
637 libusb20_dev_open(struct libusb20_device *pdev, uint16_t nTransferMax)
639 struct libusb20_transfer *xfer;
644 if (pdev->is_opened) {
645 return (LIBUSB20_ERROR_BUSY);
647 if (nTransferMax >= 256) {
648 return (LIBUSB20_ERROR_INVALID_PARAM);
649 } else if (nTransferMax != 0) {
650 size = sizeof(pdev->pTransfer[0]) * nTransferMax;
651 pdev->pTransfer = malloc(size);
652 if (pdev->pTransfer == NULL) {
653 return (LIBUSB20_ERROR_NO_MEM);
655 memset(pdev->pTransfer, 0, size);
657 /* initialise all transfers */
658 for (x = 0; x != nTransferMax; x++) {
660 xfer = pdev->pTransfer + x;
664 xfer->callback = &dummy_callback;
667 /* set "nTransfer" early */
668 pdev->nTransfer = nTransferMax;
670 error = pdev->beMethods->open_device(pdev, nTransferMax);
673 if (pdev->pTransfer != NULL) {
674 free(pdev->pTransfer);
675 pdev->pTransfer = NULL;
678 pdev->file_ctrl = -1;
687 libusb20_dev_reset(struct libusb20_device *pdev)
691 error = pdev->methods->reset_device(pdev);
696 libusb20_dev_check_connected(struct libusb20_device *pdev)
700 error = pdev->methods->check_connected(pdev);
705 libusb20_dev_set_power_mode(struct libusb20_device *pdev, uint8_t power_mode)
709 error = pdev->methods->set_power_mode(pdev, power_mode);
714 libusb20_dev_get_power_mode(struct libusb20_device *pdev)
719 error = pdev->methods->get_power_mode(pdev, &power_mode);
721 power_mode = LIBUSB20_POWER_ON; /* fake power mode */
726 libusb20_dev_get_power_usage(struct libusb20_device *pdev)
729 uint16_t power_usage;
731 error = pdev->methods->get_power_usage(pdev, &power_usage);
734 return (power_usage);
738 libusb20_dev_set_alt_index(struct libusb20_device *pdev, uint8_t ifaceIndex, uint8_t altIndex)
742 error = pdev->methods->set_alt_index(pdev, ifaceIndex, altIndex);
747 libusb20_dev_set_config_index(struct libusb20_device *pdev, uint8_t configIndex)
751 error = pdev->methods->set_config_index(pdev, configIndex);
756 libusb20_dev_request_sync(struct libusb20_device *pdev,
757 struct LIBUSB20_CONTROL_SETUP_DECODED *setup, void *data,
758 uint16_t *pactlen, uint32_t timeout, uint8_t flags)
762 error = pdev->methods->do_request_sync(pdev,
763 setup, data, pactlen, timeout, flags);
768 libusb20_dev_req_string_sync(struct libusb20_device *pdev,
769 uint8_t str_index, uint16_t langid, void *ptr, uint16_t len)
771 struct LIBUSB20_CONTROL_SETUP_DECODED req;
774 /* make sure memory is initialised */
779 return (LIBUSB20_ERROR_INVALID_PARAM);
781 LIBUSB20_INIT(LIBUSB20_CONTROL_SETUP, &req);
784 * We need to read the USB string in two steps else some USB
785 * devices will complain.
788 LIBUSB20_REQUEST_TYPE_STANDARD |
789 LIBUSB20_RECIPIENT_DEVICE |
790 LIBUSB20_ENDPOINT_IN;
791 req.bRequest = LIBUSB20_REQUEST_GET_DESCRIPTOR;
792 req.wValue = (LIBUSB20_DT_STRING << 8) | str_index;
794 req.wLength = 4; /* bytes */
796 error = libusb20_dev_request_sync(pdev, &req,
797 ptr, NULL, 1000, LIBUSB20_TRANSFER_SINGLE_SHORT_NOT_OK);
801 req.wLength = *(uint8_t *)ptr; /* bytes */
802 if (req.wLength > len) {
803 /* partial string read */
806 error = libusb20_dev_request_sync(pdev, &req,
807 ptr, NULL, 1000, LIBUSB20_TRANSFER_SINGLE_SHORT_NOT_OK);
812 if (((uint8_t *)ptr)[1] != LIBUSB20_DT_STRING) {
813 return (LIBUSB20_ERROR_OTHER);
815 return (0); /* success */
819 libusb20_dev_req_string_simple_sync(struct libusb20_device *pdev,
820 uint8_t str_index, void *ptr, uint16_t len)
831 /* the following code derives from the FreeBSD USB kernel */
833 if ((len < 1) || (ptr == NULL)) {
834 /* too short buffer */
835 return (LIBUSB20_ERROR_INVALID_PARAM);
837 error = libusb20_dev_req_string_sync(pdev,
838 0, 0, temp, sizeof(temp));
840 *(uint8_t *)ptr = 0; /* zero terminate */
843 langid = temp[2] | (temp[3] << 8);
845 error = libusb20_dev_req_string_sync(pdev, str_index,
846 langid, temp, sizeof(temp));
848 *(uint8_t *)ptr = 0; /* zero terminate */
852 /* string length is too short */
853 *(uint8_t *)ptr = 0; /* zero terminate */
854 return (LIBUSB20_ERROR_OTHER);
856 /* reserve one byte for terminating zero */
859 /* find maximum length */
860 n = (temp[0] / 2) - 1;
864 /* reset swap state */
867 /* setup output buffer pointer */
870 /* convert and filter */
871 for (i = 0; (i != n); i++) {
872 c = temp[(2 * i) + 2] | (temp[(2 * i) + 3] << 8);
874 /* convert from Unicode, handle buggy strings */
875 if (((c & 0xff00) == 0) && (swap & 1)) {
876 /* Little Endian, default */
879 } else if (((c & 0x00ff) == 0) && (swap & 2)) {
884 /* skip invalid character */
888 * Filter by default - we don't allow greater and less than
889 * signs because they might confuse the dmesg printouts!
891 if ((*buf == '<') || (*buf == '>') || (!isprint(*buf))) {
892 /* skip invalid character */
897 *buf = 0; /* zero terminate string */
902 struct libusb20_config *
903 libusb20_dev_alloc_config(struct libusb20_device *pdev, uint8_t configIndex)
905 struct libusb20_config *retval = NULL;
911 if (!pdev->is_opened) {
912 error = libusb20_dev_open(pdev, 0);
920 error = pdev->methods->get_config_desc_full(pdev,
921 &ptr, &len, configIndex);
926 /* parse new config descriptor */
927 retval = libusb20_parse_config_desc(ptr);
929 /* free config descriptor */
934 error = libusb20_dev_close(pdev);
939 struct libusb20_device *
940 libusb20_dev_alloc(void)
942 struct libusb20_device *pdev;
944 pdev = malloc(sizeof(*pdev));
948 memset(pdev, 0, sizeof(*pdev));
951 pdev->file_ctrl = -1;
952 pdev->methods = &libusb20_dummy_methods;
957 libusb20_dev_get_config_index(struct libusb20_device *pdev)
963 if (!pdev->is_opened) {
964 error = libusb20_dev_open(pdev, 0);
974 error = pdev->methods->get_config_index(pdev, &cfg_index);
976 cfg_index = 0xFF; /* current config index */
978 if (libusb20_dev_close(pdev)) {
986 libusb20_dev_get_mode(struct libusb20_device *pdev)
988 return (pdev->usb_mode);
992 libusb20_dev_get_speed(struct libusb20_device *pdev)
994 return (pdev->usb_speed);
997 /* if this function returns an error, the device is gone */
999 libusb20_dev_process(struct libusb20_device *pdev)
1003 error = pdev->methods->process(pdev);
1008 libusb20_dev_wait_process(struct libusb20_device *pdev, int timeout)
1010 struct pollfd pfd[1];
1012 if (!pdev->is_opened) {
1015 pfd[0].fd = pdev->file;
1016 pfd[0].events = (POLLIN | POLLOUT | POLLRDNORM | POLLWRNORM);
1019 if (poll(pfd, 1, timeout)) {
1020 /* ignore any error */
1026 libusb20_dev_free(struct libusb20_device *pdev)
1032 if (pdev->is_opened) {
1033 if (libusb20_dev_close(pdev)) {
1034 /* ignore any errors */
1042 libusb20_dev_get_info(struct libusb20_device *pdev,
1043 struct usb_device_info *pinfo)
1046 return (LIBUSB20_ERROR_INVALID_PARAM);
1048 return (pdev->beMethods->dev_get_info(pdev, pinfo));
1052 libusb20_dev_get_backend_name(struct libusb20_device *pdev)
1054 return (pdev->beMethods->get_backend_name());
1058 libusb20_dev_get_desc(struct libusb20_device *pdev)
1060 return (pdev->usb_desc);
1064 libusb20_dev_set_debug(struct libusb20_device *pdev, int debug)
1066 pdev->debug = debug;
1071 libusb20_dev_get_debug(struct libusb20_device *pdev)
1073 return (pdev->debug);
1077 libusb20_dev_get_address(struct libusb20_device *pdev)
1079 return (pdev->device_address);
1083 libusb20_dev_get_parent_address(struct libusb20_device *pdev)
1085 return (pdev->parent_address);
1089 libusb20_dev_get_parent_port(struct libusb20_device *pdev)
1091 return (pdev->parent_port);
1095 libusb20_dev_get_bus_number(struct libusb20_device *pdev)
1097 return (pdev->bus_number);
1101 libusb20_dev_get_iface_desc(struct libusb20_device *pdev,
1102 uint8_t iface_index, char *buf, uint8_t len)
1104 if ((buf == NULL) || (len == 0))
1105 return (LIBUSB20_ERROR_INVALID_PARAM);
1107 buf[0] = 0; /* set default string value */
1109 return (pdev->beMethods->dev_get_iface_desc(
1110 pdev, iface_index, buf, len));
1113 /* USB backend operations */
1116 libusb20_be_get_dev_quirk(struct libusb20_backend *pbe,
1117 uint16_t quirk_index, struct libusb20_quirk *pq)
1119 return (pbe->methods->root_get_dev_quirk(pbe, quirk_index, pq));
1123 libusb20_be_get_quirk_name(struct libusb20_backend *pbe,
1124 uint16_t quirk_index, struct libusb20_quirk *pq)
1126 return (pbe->methods->root_get_quirk_name(pbe, quirk_index, pq));
1130 libusb20_be_add_dev_quirk(struct libusb20_backend *pbe,
1131 struct libusb20_quirk *pq)
1133 return (pbe->methods->root_add_dev_quirk(pbe, pq));
1137 libusb20_be_remove_dev_quirk(struct libusb20_backend *pbe,
1138 struct libusb20_quirk *pq)
1140 return (pbe->methods->root_remove_dev_quirk(pbe, pq));
1144 libusb20_be_set_template(struct libusb20_backend *pbe, int temp)
1146 return (pbe->methods->root_set_template(pbe, temp));
1150 libusb20_be_get_template(struct libusb20_backend *pbe, int *ptemp)
1157 return (pbe->methods->root_get_template(pbe, ptemp));
1160 struct libusb20_device *
1161 libusb20_be_device_foreach(struct libusb20_backend *pbe, struct libusb20_device *pdev)
1165 } else if (pdev == NULL) {
1166 pdev = TAILQ_FIRST(&(pbe->usb_devs));
1168 pdev = TAILQ_NEXT(pdev, dev_entry);
1173 struct libusb20_backend *
1174 libusb20_be_alloc(const struct libusb20_backend_methods *methods)
1176 struct libusb20_backend *pbe;
1178 pbe = malloc(sizeof(*pbe));
1182 memset(pbe, 0, sizeof(*pbe));
1184 TAILQ_INIT(&(pbe->usb_devs));
1186 pbe->methods = methods; /* set backend methods */
1188 /* do the initial device scan */
1189 if (pbe->methods->init_backend) {
1190 pbe->methods->init_backend(pbe);
1195 struct libusb20_backend *
1196 libusb20_be_alloc_linux(void)
1198 struct libusb20_backend *pbe;
1201 pbe = libusb20_be_alloc(&libusb20_linux_backend);
1208 struct libusb20_backend *
1209 libusb20_be_alloc_ugen20(void)
1211 struct libusb20_backend *pbe;
1213 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
1214 pbe = libusb20_be_alloc(&libusb20_ugen20_backend);
1221 struct libusb20_backend *
1222 libusb20_be_alloc_default(void)
1224 struct libusb20_backend *pbe;
1226 pbe = libusb20_be_alloc_linux();
1230 pbe = libusb20_be_alloc_ugen20();
1234 return (NULL); /* no backend found */
1238 libusb20_be_free(struct libusb20_backend *pbe)
1240 struct libusb20_device *pdev;
1246 while ((pdev = libusb20_be_device_foreach(pbe, NULL))) {
1247 libusb20_be_dequeue_device(pbe, pdev);
1248 libusb20_dev_free(pdev);
1250 if (pbe->methods->exit_backend) {
1251 pbe->methods->exit_backend(pbe);
1258 libusb20_be_enqueue_device(struct libusb20_backend *pbe, struct libusb20_device *pdev)
1260 pdev->beMethods = pbe->methods; /* copy backend methods */
1261 TAILQ_INSERT_TAIL(&(pbe->usb_devs), pdev, dev_entry);
1265 libusb20_be_dequeue_device(struct libusb20_backend *pbe,
1266 struct libusb20_device *pdev)
1268 TAILQ_REMOVE(&(pbe->usb_devs), pdev, dev_entry);
1272 libusb20_strerror(int code)
1275 case LIBUSB20_SUCCESS:
1277 case LIBUSB20_ERROR_IO:
1278 return ("I/O error");
1279 case LIBUSB20_ERROR_INVALID_PARAM:
1280 return ("Invalid parameter");
1281 case LIBUSB20_ERROR_ACCESS:
1282 return ("Permissions error");
1283 case LIBUSB20_ERROR_NO_DEVICE:
1284 return ("No device");
1285 case LIBUSB20_ERROR_NOT_FOUND:
1286 return ("Not found");
1287 case LIBUSB20_ERROR_BUSY:
1288 return ("Device busy");
1289 case LIBUSB20_ERROR_TIMEOUT:
1291 case LIBUSB20_ERROR_OVERFLOW:
1292 return ("Overflow");
1293 case LIBUSB20_ERROR_PIPE:
1294 return ("Pipe error");
1295 case LIBUSB20_ERROR_INTERRUPTED:
1296 return ("Interrupted");
1297 case LIBUSB20_ERROR_NO_MEM:
1298 return ("Out of memory");
1299 case LIBUSB20_ERROR_NOT_SUPPORTED:
1300 return ("Not supported");
1301 case LIBUSB20_ERROR_OTHER:
1302 return ("Other error");
1304 return ("Unknown error");
1309 libusb20_error_name(int code)
1312 case LIBUSB20_SUCCESS:
1313 return ("LIBUSB20_SUCCESS");
1314 case LIBUSB20_ERROR_IO:
1315 return ("LIBUSB20_ERROR_IO");
1316 case LIBUSB20_ERROR_INVALID_PARAM:
1317 return ("LIBUSB20_ERROR_INVALID_PARAM");
1318 case LIBUSB20_ERROR_ACCESS:
1319 return ("LIBUSB20_ERROR_ACCESS");
1320 case LIBUSB20_ERROR_NO_DEVICE:
1321 return ("LIBUSB20_ERROR_NO_DEVICE");
1322 case LIBUSB20_ERROR_NOT_FOUND:
1323 return ("LIBUSB20_ERROR_NOT_FOUND");
1324 case LIBUSB20_ERROR_BUSY:
1325 return ("LIBUSB20_ERROR_BUSY");
1326 case LIBUSB20_ERROR_TIMEOUT:
1327 return ("LIBUSB20_ERROR_TIMEOUT");
1328 case LIBUSB20_ERROR_OVERFLOW:
1329 return ("LIBUSB20_ERROR_OVERFLOW");
1330 case LIBUSB20_ERROR_PIPE:
1331 return ("LIBUSB20_ERROR_PIPE");
1332 case LIBUSB20_ERROR_INTERRUPTED:
1333 return ("LIBUSB20_ERROR_INTERRUPTED");
1334 case LIBUSB20_ERROR_NO_MEM:
1335 return ("LIBUSB20_ERROR_NO_MEM");
1336 case LIBUSB20_ERROR_NOT_SUPPORTED:
1337 return ("LIBUSB20_ERROR_NOT_SUPPORTED");
1338 case LIBUSB20_ERROR_OTHER:
1339 return ("LIBUSB20_ERROR_OTHER");
1341 return ("LIBUSB20_ERROR_UNKNOWN");