usbdi_util.h (4036B) - Raw
1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause 3 * 4 * Copyright (c) 2009 Andrew Thompson 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 1. Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 18 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 25 */ 26 #ifndef _USB_USBDI_UTIL_H_ 27 #define _USB_USBDI_UTIL_H_ 28 29 struct cv; 30 31 /* structures */ 32 33 struct usb_idesc_parse_state { 34 struct usb_descriptor *desc; 35 uint8_t iface_index; /* current interface index */ 36 uint8_t iface_no_last; 37 uint8_t iface_index_alt; /* current alternate setting */ 38 }; 39 40 /* prototypes */ 41 42 usb_error_t usbd_do_request_proc(struct usb_device *udev, struct usb_process *pproc, 43 struct usb_device_request *req, void *data, uint16_t flags, 44 uint16_t *actlen, usb_timeout_t timeout); 45 46 struct usb_descriptor *usb_desc_foreach(struct usb_config_descriptor *cd, 47 struct usb_descriptor *desc); 48 struct usb_interface_descriptor *usb_idesc_foreach( 49 struct usb_config_descriptor *cd, 50 struct usb_idesc_parse_state *ps); 51 struct usb_endpoint_descriptor *usb_edesc_foreach( 52 struct usb_config_descriptor *cd, 53 struct usb_endpoint_descriptor *ped); 54 struct usb_endpoint_ss_comp_descriptor *usb_ed_comp_foreach( 55 struct usb_config_descriptor *cd, 56 struct usb_endpoint_ss_comp_descriptor *ped); 57 uint8_t usbd_get_no_descriptors(struct usb_config_descriptor *cd, 58 uint8_t type); 59 uint8_t usbd_get_no_alts(struct usb_config_descriptor *cd, 60 struct usb_interface_descriptor *id); 61 62 usb_error_t usbd_req_get_report(struct usb_device *udev, struct mtx *mtx, 63 void *data, uint16_t len, uint8_t iface_index, uint8_t type, 64 uint8_t id); 65 usb_error_t usbd_req_get_report_descriptor(struct usb_device *udev, 66 struct mtx *mtx, void *d, uint16_t size, 67 uint8_t iface_index); 68 usb_error_t usbd_req_get_string_any(struct usb_device *udev, struct mtx *mtx, 69 char *buf, uint16_t len, uint8_t string_index); 70 usb_error_t usbd_req_get_string_desc(struct usb_device *udev, struct mtx *mtx, 71 void *sdesc, uint16_t max_len, uint16_t lang_id, 72 uint8_t string_index); 73 usb_error_t usbd_req_set_config(struct usb_device *udev, struct mtx *mtx, 74 uint8_t conf); 75 usb_error_t usbd_req_set_alt_interface_no(struct usb_device *udev, 76 struct mtx *mtx, uint8_t iface_index, uint8_t alt_no); 77 usb_error_t usbd_req_set_idle(struct usb_device *udev, struct mtx *mtx, 78 uint8_t iface_index, uint8_t duration, uint8_t id); 79 usb_error_t usbd_req_set_protocol(struct usb_device *udev, struct mtx *mtx, 80 uint8_t iface_index, uint16_t report); 81 usb_error_t usbd_req_set_report(struct usb_device *udev, struct mtx *mtx, 82 void *data, uint16_t len, uint8_t iface_index, 83 uint8_t type, uint8_t id); 84 85 /* The following functions will not return NULL strings. */ 86 87 const char *usb_get_manufacturer(struct usb_device *); 88 const char *usb_get_product(struct usb_device *); 89 const char *usb_get_serial(struct usb_device *); 90 91 #endif /* _USB_USBDI_UTIL_H_ */