usb_request.h revision 188411 
1/* $FreeBSD: head/sys/dev/usb2/core/usb2_request.h 188411 2009-02-09 21:56:33Z thompsa $ */
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 _USB2_REQUEST_H_
28#define	_USB2_REQUEST_H_
29
30struct usb2_process;
31
32usb2_error_t usb2_do_request_flags(struct usb2_device *udev, struct mtx *mtx,
33		    struct usb2_device_request *req, void *data, uint32_t flags,
34		    uint16_t *actlen, uint32_t timeout);
35usb2_error_t usb2_do_request_proc(struct usb2_device *udev, struct usb2_process *pproc,
36		    struct usb2_device_request *req, void *data, uint32_t flags,
37		    uint16_t *actlen, uint32_t timeout);
38usb2_error_t usb2_req_clear_hub_feature(struct usb2_device *udev,
39		    struct mtx *mtx, uint16_t sel);
40usb2_error_t usb2_req_clear_port_feature(struct usb2_device *udev,
41		    struct mtx *mtx, uint8_t port, uint16_t sel);
42usb2_error_t usb2_req_get_alt_interface_no(struct usb2_device *udev,
43		    struct mtx *mtx, uint8_t *alt_iface_no,
44		    uint8_t iface_index);
45usb2_error_t usb2_req_get_config(struct usb2_device *udev, struct mtx *mtx,
46		    uint8_t *pconf);
47usb2_error_t usb2_req_get_config_desc(struct usb2_device *udev, struct mtx *mtx,
48		    struct usb2_config_descriptor *d, uint8_t conf_index);
49usb2_error_t usb2_req_get_config_desc_full(struct usb2_device *udev,
50		    struct mtx *mtx, struct usb2_config_descriptor **ppcd,
51		    struct malloc_type *mtype, uint8_t conf_index);
52usb2_error_t usb2_req_get_desc(struct usb2_device *udev, struct mtx *mtx,
53		    void *desc, uint16_t min_len, uint16_t max_len, uint16_t id,
54		    uint8_t type, uint8_t index, uint8_t retries);
55usb2_error_t usb2_req_get_device_desc(struct usb2_device *udev, struct mtx *mtx,
56		    struct usb2_device_descriptor *d);
57usb2_error_t usb2_req_get_device_status(struct usb2_device *udev,
58		    struct mtx *mtx, struct usb2_status *st);
59usb2_error_t usb2_req_get_hub_descriptor(struct usb2_device *udev,
60		    struct mtx *mtx, struct usb2_hub_descriptor *hd,
61		    uint8_t nports);
62usb2_error_t usb2_req_get_hub_status(struct usb2_device *udev, struct mtx *mtx,
63		    struct usb2_hub_status *st);
64usb2_error_t usb2_req_get_port_status(struct usb2_device *udev, struct mtx *mtx,
65		    struct usb2_port_status *ps, uint8_t port);
66usb2_error_t usb2_req_get_report(struct usb2_device *udev, struct mtx *mtx,
67		    void *data, uint16_t len, uint8_t iface_index, uint8_t type,
68		    uint8_t id);
69usb2_error_t usb2_req_get_report_descriptor(struct usb2_device *udev,
70		    struct mtx *mtx, void *d, uint16_t size,
71		    uint8_t iface_index);
72usb2_error_t usb2_req_get_string_any(struct usb2_device *udev, struct mtx *mtx,
73		    char *buf, uint16_t len, uint8_t string_index);
74usb2_error_t usb2_req_get_string_desc(struct usb2_device *udev, struct mtx *mtx,
75		    void *sdesc, uint16_t max_len, uint16_t lang_id,
76		    uint8_t string_index);
77usb2_error_t usb2_req_reset_port(struct usb2_device *udev, struct mtx *mtx,
78		    uint8_t port);
79usb2_error_t usb2_req_set_address(struct usb2_device *udev, struct mtx *mtx,
80		    uint16_t addr);
81usb2_error_t usb2_req_set_alt_interface_no(struct usb2_device *udev,
82		    struct mtx *mtx, uint8_t iface_index, uint8_t alt_no);
83usb2_error_t usb2_req_set_config(struct usb2_device *udev, struct mtx *mtx,
84		    uint8_t conf);
85usb2_error_t usb2_req_set_hub_feature(struct usb2_device *udev, struct mtx *mtx,
86		    uint16_t sel);
87usb2_error_t usb2_req_set_idle(struct usb2_device *udev, struct mtx *mtx,
88		    uint8_t iface_index, uint8_t duration, uint8_t id);
89usb2_error_t usb2_req_set_port_feature(struct usb2_device *udev,
90		    struct mtx *mtx, uint8_t port, uint16_t sel);
91usb2_error_t usb2_req_set_protocol(struct usb2_device *udev, struct mtx *mtx,
92		    uint8_t iface_index, uint16_t report);
93usb2_error_t usb2_req_set_report(struct usb2_device *udev, struct mtx *mtx,
94		    void *data, uint16_t len, uint8_t iface_index,
95		    uint8_t type, uint8_t id);
96usb2_error_t usb2_req_re_enumerate(struct usb2_device *udev, struct mtx *mtx);
97usb2_error_t usb2_req_clear_device_feature(struct usb2_device *udev, struct mtx *mtx, uint16_t sel);
98usb2_error_t usb2_req_set_device_feature(struct usb2_device *udev, struct mtx *mtx, uint16_t sel);
99
100#define	usb2_do_request(u,m,r,d) \
101  usb2_do_request_flags(u,m,r,d,0,NULL,USB_DEFAULT_TIMEOUT)
102
103#endif					/* _USB2_REQUEST_H_ */
104