xref: /freebsd/sys/dev/usb/usb_request.h (revision 315ee00f)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2008 Hans Petter Selasky. All rights reserved.
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 AND CONTRIBUTORS ``AS IS'' AND
16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  */
27 
28 #ifndef _USB_REQUEST_H_
29 #define	_USB_REQUEST_H_
30 
31 struct usb_process;
32 
33 usb_error_t usbd_req_clear_hub_feature(struct usb_device *udev,
34 		    struct mtx *mtx, uint16_t sel);
35 usb_error_t usbd_req_clear_port_feature(struct usb_device *udev,
36 		    struct mtx *mtx, uint8_t port, uint16_t sel);
37 usb_error_t usbd_req_get_alt_interface_no(struct usb_device *udev,
38 		    struct mtx *mtx, uint8_t *alt_iface_no,
39 		    uint8_t iface_index);
40 usb_error_t usbd_req_get_config(struct usb_device *udev, struct mtx *mtx,
41 		    uint8_t *pconf);
42 usb_error_t usbd_req_get_descriptor_ptr(struct usb_device *udev,
43 		    struct usb_config_descriptor **ppcd, uint16_t wValue);
44 usb_error_t usbd_req_get_config_desc(struct usb_device *udev, struct mtx *mtx,
45 		    struct usb_config_descriptor *d, uint8_t conf_index);
46 usb_error_t usbd_req_get_config_desc_full(struct usb_device *udev,
47 		    struct mtx *mtx, struct usb_config_descriptor **ppcd,
48 		    uint8_t conf_index);
49 usb_error_t usbd_req_get_desc(struct usb_device *udev, struct mtx *mtx,
50 		    uint16_t *actlen, void *desc, uint16_t min_len,
51 		    uint16_t max_len, uint16_t id, uint8_t type,
52 		    uint8_t index, uint8_t retries);
53 usb_error_t usbd_req_get_device_desc(struct usb_device *udev, struct mtx *mtx,
54 		    struct usb_device_descriptor *d);
55 usb_error_t usbd_req_get_device_status(struct usb_device *udev,
56 		    struct mtx *mtx, struct usb_status *st);
57 usb_error_t usbd_req_get_hub_descriptor(struct usb_device *udev,
58 		    struct mtx *mtx, struct usb_hub_descriptor *hd,
59 		    uint8_t nports);
60 usb_error_t usbd_req_get_ss_hub_descriptor(struct usb_device *udev,
61 		    struct mtx *mtx, struct usb_hub_ss_descriptor *hd,
62 		    uint8_t nports);
63 usb_error_t usbd_req_get_hub_status(struct usb_device *udev, struct mtx *mtx,
64 		    struct usb_hub_status *st);
65 usb_error_t usbd_req_get_port_status(struct usb_device *udev, struct mtx *mtx,
66 		    struct usb_port_status *ps, uint8_t port);
67 usb_error_t usbd_req_reset_port(struct usb_device *udev, struct mtx *mtx,
68 		    uint8_t port);
69 usb_error_t usbd_req_warm_reset_port(struct usb_device *udev,
70 		    struct mtx *mtx, uint8_t port);
71 usb_error_t usbd_req_set_address(struct usb_device *udev, struct mtx *mtx,
72 		    uint16_t addr);
73 usb_error_t usbd_req_set_hub_feature(struct usb_device *udev, struct mtx *mtx,
74 		    uint16_t sel);
75 usb_error_t usbd_req_set_port_feature(struct usb_device *udev,
76 		    struct mtx *mtx, uint8_t port, uint16_t sel);
77 usb_error_t usbd_setup_device_desc(struct usb_device *udev, struct mtx *mtx);
78 usb_error_t usbd_req_re_enumerate(struct usb_device *udev, struct mtx *mtx);
79 usb_error_t usbd_req_clear_device_feature(struct usb_device *udev,
80 		    struct mtx *mtx, uint16_t sel);
81 usb_error_t usbd_req_set_device_feature(struct usb_device *udev,
82 		    struct mtx *mtx, uint16_t sel);
83 usb_error_t usbd_req_set_hub_u1_timeout(struct usb_device *udev,
84 		    struct mtx *mtx, uint8_t port, uint8_t timeout);
85 usb_error_t usbd_req_set_hub_u2_timeout(struct usb_device *udev,
86 		    struct mtx *mtx, uint8_t port, uint8_t timeout);
87 usb_error_t usbd_req_set_hub_depth(struct usb_device *udev,
88 		    struct mtx *mtx, uint16_t depth);
89 usb_error_t usbd_req_reset_tt(struct usb_device *udev, struct mtx *mtx,
90 		    uint8_t port);
91 usb_error_t usbd_req_clear_tt_buffer(struct usb_device *udev, struct mtx *mtx,
92 		    uint8_t port, uint8_t addr, uint8_t type, uint8_t endpoint);
93 usb_error_t usbd_req_set_port_link_state(struct usb_device *udev,
94 		    struct mtx *mtx, uint8_t port, uint8_t link_state);
95 usb_error_t usbd_req_set_lpm_info(struct usb_device *udev, struct mtx *mtx,
96 		    uint8_t port, uint8_t besl, uint8_t addr, uint8_t rwe);
97 
98 void *	usbd_alloc_config_desc(struct usb_device *, uint32_t);
99 void	usbd_free_config_desc(struct usb_device *, void *);
100 
101 #endif					/* _USB_REQUEST_H_ */
102