xref: /netbsd-src/sys/dev/usb/usbdi_util.h (revision 6a493d6bc668897c91594964a732d38505b70cbb)
1 /*	$NetBSD: usbdi_util.h,v 1.45 2013/09/26 07:25:31 skrll Exp $	*/
2 
3 /*
4  * Copyright (c) 1998, 2004 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Lennart Augustsson (lennart@augustsson.net) at
9  * Carlstedt Research & Technology.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
24  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 #ifndef _USBDI_UTIL_H_
34 #define _USBDI_UTIL_H_
35 
36 #include <dev/usb/usbhid.h>
37 
38 usbd_status	usbd_get_desc(usbd_device_handle dev, int type,
39 			      int index, int len, void *desc);
40 usbd_status	usbd_get_config_desc(usbd_device_handle, int,
41 				     usb_config_descriptor_t *);
42 usbd_status	usbd_get_config_desc_full(usbd_device_handle, int, void *, int);
43 usbd_status	usbd_get_device_desc(usbd_device_handle dev,
44 				     usb_device_descriptor_t *d);
45 usbd_status	usbd_set_address(usbd_device_handle dev, int addr);
46 usbd_status	usbd_get_port_status(usbd_device_handle,
47 				     int, usb_port_status_t *);
48 usbd_status	usbd_set_hub_feature(usbd_device_handle dev, int);
49 usbd_status	usbd_clear_hub_feature(usbd_device_handle, int);
50 usbd_status	usbd_set_port_feature(usbd_device_handle dev, int, int);
51 usbd_status	usbd_clear_port_feature(usbd_device_handle, int, int);
52 usbd_status	usbd_get_device_status(usbd_device_handle, usb_status_t *);
53 usbd_status	usbd_get_hub_status(usbd_device_handle, usb_hub_status_t *);
54 usbd_status	usbd_get_protocol(usbd_interface_handle dev, u_int8_t *report);
55 usbd_status	usbd_set_protocol(usbd_interface_handle dev, int report);
56 usbd_status	usbd_get_report_descriptor(usbd_device_handle dev, int ifcno,
57 					   int size, void *d);
58 usb_hid_descriptor_t *usbd_get_hid_descriptor(usbd_interface_handle ifc);
59 usbd_status	usbd_set_report(usbd_interface_handle iface, int type, int id,
60 				void *data,int len);
61 usbd_status	usbd_get_report(usbd_interface_handle iface, int type, int id,
62 				void *data, int len);
63 usbd_status	usbd_set_idle(usbd_interface_handle iface, int duration,int id);
64 usbd_status	usbd_read_report_desc(usbd_interface_handle ifc, void **descp,
65 				      int *sizep, struct malloc_type *mem);
66 usbd_status	usbd_get_config(usbd_device_handle dev, u_int8_t *conf);
67 usbd_status	usbd_get_string_desc(usbd_device_handle dev, int sindex,
68 				     int langid,usb_string_descriptor_t *sdesc,
69 				     int *sizep);
70 
71 
72 usbd_status usbd_set_config_no(usbd_device_handle, int, int);
73 usbd_status usbd_set_config_index(usbd_device_handle, int, int);
74 
75 usbd_status usbd_bulk_transfer(usbd_xfer_handle, usbd_pipe_handle,
76 			       u_int16_t, u_int32_t, void *,
77 			       u_int32_t *, const char *);
78 
79 usbd_status usbd_intr_transfer(usbd_xfer_handle, usbd_pipe_handle,
80  			       u_int16_t, u_int32_t, void *,
81  			       u_int32_t *, const char *);
82 
83 void usb_detach_waitold(device_t);
84 void usb_detach_wakeupold(device_t);
85 
86 /*
87  * MPSAFE versions - mutex must be at IPL_USB.
88  */
89 void usb_detach_wait(device_t dv, kcondvar_t *, kmutex_t *);
90 void usb_detach_broadcast(device_t, kcondvar_t *);
91 
92 
93 typedef struct {
94 	uByte		bLength;
95 	uByte		bDescriptorType;
96 	uByte		bDescriptorSubtype;
97 } UPACKED usb_cdc_descriptor_t;
98 
99 const usb_cdc_descriptor_t *usb_find_desc(usbd_device_handle dev, int type,
100 				      int subtype);
101 const usb_cdc_descriptor_t *usb_find_desc_if(usbd_device_handle dev, int type,
102 					 int subtype,
103 					 usb_interface_descriptor_t *id);
104 #define USBD_CDCSUBTYPE_ANY (~0)
105 
106 #endif /* _USBDI_UTIL_H_ */
107