xref: /freebsd/sys/dev/usb/usb_request.h (revision aa79fe245de7616cda41b69a296a5ce209c95c45)
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_do_request_flags(struct usb_device *udev, struct mtx *mtx,
33 		    struct usb_device_request *req, void *data, uint16_t flags,
34 		    uint16_t *actlen, usb_timeout_t timeout);
35 usb_error_t usbd_do_request_proc(struct usb_device *udev, struct usb_process *pproc,
36 		    struct usb_device_request *req, void *data, uint16_t flags,
37 		    uint16_t *actlen, usb_timeout_t timeout);
38 usb_error_t usbd_req_clear_hub_feature(struct usb_device *udev,
39 		    struct mtx *mtx, uint16_t sel);
40 usb_error_t usbd_req_clear_port_feature(struct usb_device *udev,
41 		    struct mtx *mtx, uint8_t port, uint16_t sel);
42 usb_error_t usbd_req_get_alt_interface_no(struct usb_device *udev,
43 		    struct mtx *mtx, uint8_t *alt_iface_no,
44 		    uint8_t iface_index);
45 usb_error_t usbd_req_get_config(struct usb_device *udev, struct mtx *mtx,
46 		    uint8_t *pconf);
47 usb_error_t usbd_req_get_descriptor_ptr(struct usb_device *udev,
48 		    struct usb_config_descriptor **ppcd, uint16_t wValue);
49 usb_error_t usbd_req_get_config_desc(struct usb_device *udev, struct mtx *mtx,
50 		    struct usb_config_descriptor *d, uint8_t conf_index);
51 usb_error_t usbd_req_get_config_desc_full(struct usb_device *udev,
52 		    struct mtx *mtx, struct usb_config_descriptor **ppcd,
53 		    struct malloc_type *mtype, uint8_t conf_index);
54 usb_error_t usbd_req_get_desc(struct usb_device *udev, struct mtx *mtx,
55 		    uint16_t *actlen, void *desc, uint16_t min_len,
56 		    uint16_t max_len, uint16_t id, uint8_t type,
57 		    uint8_t index, uint8_t retries);
58 usb_error_t usbd_req_get_device_desc(struct usb_device *udev, struct mtx *mtx,
59 		    struct usb_device_descriptor *d);
60 usb_error_t usbd_req_get_device_status(struct usb_device *udev,
61 		    struct mtx *mtx, struct usb_status *st);
62 usb_error_t usbd_req_get_hub_descriptor(struct usb_device *udev,
63 		    struct mtx *mtx, struct usb_hub_descriptor *hd,
64 		    uint8_t nports);
65 usb_error_t usbd_req_get_hub_status(struct usb_device *udev, struct mtx *mtx,
66 		    struct usb_hub_status *st);
67 usb_error_t usbd_req_get_port_status(struct usb_device *udev, struct mtx *mtx,
68 		    struct usb_port_status *ps, uint8_t port);
69 usb_error_t usbd_req_get_report(struct usb_device *udev, struct mtx *mtx,
70 		    void *data, uint16_t len, uint8_t iface_index, uint8_t type,
71 		    uint8_t id);
72 usb_error_t usbd_req_get_report_descriptor(struct usb_device *udev,
73 		    struct mtx *mtx, void *d, uint16_t size,
74 		    uint8_t iface_index);
75 usb_error_t usbd_req_get_string_any(struct usb_device *udev, struct mtx *mtx,
76 		    char *buf, uint16_t len, uint8_t string_index);
77 usb_error_t usbd_req_get_string_desc(struct usb_device *udev, struct mtx *mtx,
78 		    void *sdesc, uint16_t max_len, uint16_t lang_id,
79 		    uint8_t string_index);
80 usb_error_t usbd_req_reset_port(struct usb_device *udev, struct mtx *mtx,
81 		    uint8_t port);
82 usb_error_t usbd_req_set_address(struct usb_device *udev, struct mtx *mtx,
83 		    uint16_t addr);
84 usb_error_t usbd_req_set_alt_interface_no(struct usb_device *udev,
85 		    struct mtx *mtx, uint8_t iface_index, uint8_t alt_no);
86 usb_error_t usbd_req_set_config(struct usb_device *udev, struct mtx *mtx,
87 		    uint8_t conf);
88 usb_error_t usbd_req_set_hub_feature(struct usb_device *udev, struct mtx *mtx,
89 		    uint16_t sel);
90 usb_error_t usbd_req_set_idle(struct usb_device *udev, struct mtx *mtx,
91 		    uint8_t iface_index, uint8_t duration, uint8_t id);
92 usb_error_t usbd_req_set_port_feature(struct usb_device *udev,
93 		    struct mtx *mtx, uint8_t port, uint16_t sel);
94 usb_error_t usbd_req_set_protocol(struct usb_device *udev, struct mtx *mtx,
95 		    uint8_t iface_index, uint16_t report);
96 usb_error_t usbd_req_set_report(struct usb_device *udev, struct mtx *mtx,
97 		    void *data, uint16_t len, uint8_t iface_index,
98 		    uint8_t type, uint8_t id);
99 usb_error_t usbd_req_re_enumerate(struct usb_device *udev, struct mtx *mtx);
100 usb_error_t usbd_req_clear_device_feature(struct usb_device *udev, struct mtx *mtx, uint16_t sel);
101 usb_error_t usbd_req_set_device_feature(struct usb_device *udev, struct mtx *mtx, uint16_t sel);
102 
103 #define	usbd_do_request(u,m,r,d) \
104   usbd_do_request_flags(u,m,r,d,0,NULL,USB_DEFAULT_TIMEOUT)
105 
106 #endif					/* _USB_REQUEST_H_ */
107