xref: /freebsd/sys/dev/usb/usbdi_util.h (revision 1e413cf93298b5b97441a21d9a50fdcd0ee9945e)
1 /*	$NetBSD: usbdi_util.h,v 1.31 2004/12/03 08:53:40 augustss Exp $	*/
2 /*	$FreeBSD$	*/
3 
4 /*-
5  * Copyright (c) 1998 The NetBSD Foundation, Inc.
6  * All rights reserved.
7  *
8  * This code is derived from software contributed to The NetBSD Foundation
9  * by Lennart Augustsson (lennart@augustsson.net) at
10  * Carlstedt Research & Technology.
11  *
12  * Redistribution and use in source and binary forms, with or without
13  * modification, are permitted provided that the following conditions
14  * are met:
15  * 1. Redistributions of source code must retain the above copyright
16  *    notice, this list of conditions and the following disclaimer.
17  * 2. Redistributions in binary form must reproduce the above copyright
18  *    notice, this list of conditions and the following disclaimer in the
19  *    documentation and/or other materials provided with the distribution.
20  * 3. All advertising materials mentioning features or use of this software
21  *    must display the following acknowledgement:
22  *        This product includes software developed by the NetBSD
23  *        Foundation, Inc. and its contributors.
24  * 4. Neither the name of The NetBSD Foundation nor the names of its
25  *    contributors may be used to endorse or promote products derived
26  *    from this software without specific prior written permission.
27  *
28  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
29  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
30  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
31  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
32  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
33  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
34  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
35  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
36  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
37  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
38  * POSSIBILITY OF SUCH DAMAGE.
39  */
40 
41 #ifndef _USBI_UTIL_H_
42 #define _USBI_UTIL_H_
43 usbd_status	usbd_get_desc(usbd_device_handle dev, int type,
44 			      int index, int len, void *desc);
45 usbd_status	usbd_get_config_desc(usbd_device_handle, int,
46 				     usb_config_descriptor_t *);
47 usbd_status	usbd_get_config_desc_full(usbd_device_handle, int, void *, int);
48 usbd_status	usbd_get_device_desc(usbd_device_handle dev,
49 				     usb_device_descriptor_t *d);
50 usbd_status	usbd_set_address(usbd_device_handle dev, int addr);
51 usbd_status	usbd_get_port_status(usbd_device_handle,
52 				     int, usb_port_status_t *);
53 usbd_status	usbd_set_hub_feature(usbd_device_handle dev, int);
54 usbd_status	usbd_clear_hub_feature(usbd_device_handle, int);
55 usbd_status	usbd_set_port_feature(usbd_device_handle dev, int, int);
56 usbd_status	usbd_clear_port_feature(usbd_device_handle, int, int);
57 usbd_status	usbd_get_device_status(usbd_device_handle, usb_status_t *);
58 usbd_status	usbd_get_hub_status(usbd_device_handle, usb_hub_status_t *);
59 usbd_status	usbd_get_protocol(usbd_interface_handle dev, u_int8_t *report);
60 usbd_status	usbd_set_protocol(usbd_interface_handle dev, int report);
61 usbd_status	usbd_get_report_descriptor(usbd_device_handle dev, int ifcno,
62 					   int size, void *d);
63 struct usb_hid_descriptor *usbd_get_hid_descriptor(usbd_interface_handle ifc);
64 usbd_status	usbd_set_report(usbd_interface_handle iface, int type, int id,
65 				void *data,int len);
66 usbd_status	usbd_set_report_async(usbd_interface_handle iface, int type,
67 				      int id, void *data, int len);
68 usbd_status	usbd_get_report(usbd_interface_handle iface, int type, int id,
69 				void *data, int len);
70 usbd_status	usbd_set_idle(usbd_interface_handle iface, int duration, int id);
71 usbd_status	usbd_read_report_desc(usbd_interface_handle ifc, void **descp,
72 				      int *sizep, struct malloc_type *mem);
73 usbd_status	usbd_get_config(usbd_device_handle dev, u_int8_t *conf);
74 usbd_status	usbd_get_string_desc(usbd_device_handle dev, int sindex,
75 				     int langid,usb_string_descriptor_t *sdesc,
76 				     int *sizep);
77 void		usbd_delay_ms(usbd_device_handle, u_int);
78 
79 
80 usbd_status usbd_set_config_no(usbd_device_handle dev, int no, int msg);
81 usbd_status usbd_set_config_index(usbd_device_handle dev, int index, int msg);
82 
83 usbd_status usbd_bulk_transfer(usbd_xfer_handle xfer, usbd_pipe_handle pipe,
84 			       u_int16_t flags, u_int32_t timeout, void *buf,
85 			       u_int32_t *size, char *lbl);
86 
87 usbd_status usbd_intr_transfer(usbd_xfer_handle xfer, usbd_pipe_handle pipe,
88 			       u_int16_t flags, u_int32_t timeout, void *buf,
89 			       u_int32_t *size, char *lbl);
90 
91 void usb_detach_wait(device_t);
92 void usb_detach_wakeup(device_t);
93 
94 const usb_descriptor_t *usb_find_desc(usbd_device_handle dev, int type,
95 				      int subtype);
96 #define USBD_SUBTYPE_ANY (~0)
97 
98 #endif	/* _USBI_UTIL_H_ */
99