xref: /freebsd/sys/dev/usb/usb_request.h (revision a98ff317388a00b992f1bf8404dee596f9383f5e)
1 /* $FreeBSD$ */
2 /*-
3  * Copyright (c) 2008 Hans Petter Selasky. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
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.
13  *
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
24  * SUCH DAMAGE.
25  */
26 
27 #ifndef _USB_REQUEST_H_
28 #define	_USB_REQUEST_H_
29 
30 struct usb_process;
31 
32 usb_error_t usbd_req_clear_hub_feature(struct usb_device *udev,
33 		    struct mtx *mtx, uint16_t sel);
34 usb_error_t usbd_req_clear_port_feature(struct usb_device *udev,
35 		    struct mtx *mtx, uint8_t port, uint16_t sel);
36 usb_error_t usbd_req_get_alt_interface_no(struct usb_device *udev,
37 		    struct mtx *mtx, uint8_t *alt_iface_no,
38 		    uint8_t iface_index);
39 usb_error_t usbd_req_get_config(struct usb_device *udev, struct mtx *mtx,
40 		    uint8_t *pconf);
41 usb_error_t usbd_req_get_descriptor_ptr(struct usb_device *udev,
42 		    struct usb_config_descriptor **ppcd, uint16_t wValue);
43 usb_error_t usbd_req_get_config_desc(struct usb_device *udev, struct mtx *mtx,
44 		    struct usb_config_descriptor *d, uint8_t conf_index);
45 usb_error_t usbd_req_get_config_desc_full(struct usb_device *udev,
46 		    struct mtx *mtx, struct usb_config_descriptor **ppcd,
47 		    uint8_t conf_index);
48 usb_error_t usbd_req_get_desc(struct usb_device *udev, struct mtx *mtx,
49 		    uint16_t *actlen, void *desc, uint16_t min_len,
50 		    uint16_t max_len, uint16_t id, uint8_t type,
51 		    uint8_t index, uint8_t retries);
52 usb_error_t usbd_req_get_device_desc(struct usb_device *udev, struct mtx *mtx,
53 		    struct usb_device_descriptor *d);
54 usb_error_t usbd_req_get_device_status(struct usb_device *udev,
55 		    struct mtx *mtx, struct usb_status *st);
56 usb_error_t usbd_req_get_hub_descriptor(struct usb_device *udev,
57 		    struct mtx *mtx, struct usb_hub_descriptor *hd,
58 		    uint8_t nports);
59 usb_error_t usbd_req_get_ss_hub_descriptor(struct usb_device *udev,
60 		    struct mtx *mtx, struct usb_hub_ss_descriptor *hd,
61 		    uint8_t nports);
62 usb_error_t usbd_req_get_hub_status(struct usb_device *udev, struct mtx *mtx,
63 		    struct usb_hub_status *st);
64 usb_error_t usbd_req_get_port_status(struct usb_device *udev, struct mtx *mtx,
65 		    struct usb_port_status *ps, uint8_t port);
66 usb_error_t usbd_req_reset_port(struct usb_device *udev, struct mtx *mtx,
67 		    uint8_t port);
68 usb_error_t usbd_req_warm_reset_port(struct usb_device *udev,
69 		    struct mtx *mtx, uint8_t port);
70 usb_error_t usbd_req_set_address(struct usb_device *udev, struct mtx *mtx,
71 		    uint16_t addr);
72 usb_error_t usbd_req_set_hub_feature(struct usb_device *udev, struct mtx *mtx,
73 		    uint16_t sel);
74 usb_error_t usbd_req_set_port_feature(struct usb_device *udev,
75 		    struct mtx *mtx, uint8_t port, uint16_t sel);
76 usb_error_t usbd_setup_device_desc(struct usb_device *udev, struct mtx *mtx);
77 usb_error_t usbd_req_re_enumerate(struct usb_device *udev, struct mtx *mtx);
78 usb_error_t usbd_req_clear_device_feature(struct usb_device *udev,
79 		    struct mtx *mtx, uint16_t sel);
80 usb_error_t usbd_req_set_device_feature(struct usb_device *udev,
81 		    struct mtx *mtx, uint16_t sel);
82 usb_error_t usbd_req_set_hub_u1_timeout(struct usb_device *udev,
83 		    struct mtx *mtx, uint8_t port, uint8_t timeout);
84 usb_error_t usbd_req_set_hub_u2_timeout(struct usb_device *udev,
85 		    struct mtx *mtx, uint8_t port, uint8_t timeout);
86 usb_error_t usbd_req_set_hub_depth(struct usb_device *udev,
87 		    struct mtx *mtx, uint16_t depth);
88 usb_error_t usbd_req_reset_tt(struct usb_device *udev, struct mtx *mtx,
89 		    uint8_t port);
90 usb_error_t usbd_req_clear_tt_buffer(struct usb_device *udev, struct mtx *mtx,
91 		    uint8_t port, uint8_t addr, uint8_t type, uint8_t endpoint);
92 usb_error_t usbd_req_set_port_link_state(struct usb_device *udev,
93 		    struct mtx *mtx, uint8_t port, uint8_t link_state);
94 usb_error_t usbd_req_set_lpm_info(struct usb_device *udev, struct mtx *mtx,
95 		    uint8_t port, uint8_t besl, uint8_t addr, uint8_t rwe);
96 
97 void *	usbd_alloc_config_desc(struct usb_device *, uint32_t);
98 void	usbd_free_config_desc(struct usb_device *, void *);
99 
100 #endif					/* _USB_REQUEST_H_ */
101