xref: /netbsd-src/sys/dev/usb/usbdi_util.h (revision 8b0f9554ff8762542c4defc4f70e1eb76fb508fa)
1 /*	$NetBSD: usbdi_util.h,v 1.36 2007/02/26 13:50:06 drochner 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  * 3. All advertising materials mentioning features or use of this software
20  *    must display the following acknowledgement:
21  *        This product includes software developed by the NetBSD
22  *        Foundation, Inc. and its contributors.
23  * 4. Neither the name of The NetBSD Foundation nor the names of its
24  *    contributors may be used to endorse or promote products derived
25  *    from this software without specific prior written permission.
26  *
27  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
28  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
29  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
31  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
32  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
33  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
34  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
35  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
36  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
37  * POSSIBILITY OF SUCH DAMAGE.
38  */
39 
40 usbd_status	usbd_get_desc(usbd_device_handle dev, int type,
41 			      int index, int len, void *desc);
42 usbd_status	usbd_get_config_desc(usbd_device_handle, int,
43 				     usb_config_descriptor_t *);
44 usbd_status	usbd_get_config_desc_full(usbd_device_handle, int, void *, int);
45 usbd_status	usbd_get_device_desc(usbd_device_handle dev,
46 				     usb_device_descriptor_t *d);
47 usbd_status	usbd_set_address(usbd_device_handle dev, int addr);
48 usbd_status	usbd_get_port_status(usbd_device_handle,
49 				     int, usb_port_status_t *);
50 usbd_status	usbd_set_hub_feature(usbd_device_handle dev, int);
51 usbd_status	usbd_clear_hub_feature(usbd_device_handle, int);
52 usbd_status	usbd_set_port_feature(usbd_device_handle dev, int, int);
53 usbd_status	usbd_clear_port_feature(usbd_device_handle, int, int);
54 usbd_status	usbd_get_device_status(usbd_device_handle, usb_status_t *);
55 usbd_status	usbd_get_hub_status(usbd_device_handle, usb_hub_status_t *);
56 usbd_status	usbd_get_protocol(usbd_interface_handle dev, u_int8_t *report);
57 usbd_status	usbd_set_protocol(usbd_interface_handle dev, int report);
58 usbd_status	usbd_get_report_descriptor(usbd_device_handle dev, int ifcno,
59 					   int size, void *d);
60 struct usb_hid_descriptor *usbd_get_hid_descriptor(usbd_interface_handle ifc);
61 usbd_status	usbd_set_report(usbd_interface_handle iface, int type, int id,
62 				void *data,int len);
63 usbd_status	usbd_set_report_async(usbd_interface_handle iface, int type,
64 				      int id, void *data, int len);
65 usbd_status	usbd_get_report(usbd_interface_handle iface, int type, int id,
66 				void *data, int len);
67 usbd_status	usbd_set_idle(usbd_interface_handle iface, int duration,int id);
68 usbd_status	usbd_read_report_desc(usbd_interface_handle ifc, void **descp,
69 				       int *sizep, usb_malloc_type mem);
70 usbd_status	usbd_get_config(usbd_device_handle dev, u_int8_t *conf);
71 usbd_status	usbd_get_string_desc(usbd_device_handle dev, int sindex,
72 				     int langid,usb_string_descriptor_t *sdesc,
73 				     int *sizep);
74 void		usbd_delay_ms(usbd_device_handle, u_int);
75 
76 
77 usbd_status usbd_set_config_no(usbd_device_handle, int, int);
78 usbd_status usbd_set_config_index(usbd_device_handle, int, int);
79 
80 usbd_status usbd_bulk_transfer(usbd_xfer_handle, usbd_pipe_handle,
81 			       u_int16_t, u_int32_t, void *,
82 			       u_int32_t *, const char *);
83 
84 usbd_status usbd_intr_transfer(usbd_xfer_handle, usbd_pipe_handle,
85  			       u_int16_t, u_int32_t, void *,
86  			       u_int32_t *, const char *);
87 
88 void usb_detach_wait(device_ptr_t);
89 void usb_detach_wakeup(device_ptr_t);
90 
91 
92 typedef struct {
93 	uByte		bLength;
94 	uByte		bDescriptorType;
95 	uByte		bDescriptorSubtype;
96 } UPACKED usb_cdc_descriptor_t;
97 
98 const usb_cdc_descriptor_t *usb_find_desc(usbd_device_handle dev, int type,
99 				      int subtype);
100 const usb_cdc_descriptor_t *usb_find_desc_if(usbd_device_handle dev, int type,
101 					 int subtype,
102 					 usb_interface_descriptor_t *id);
103 #define USBD_CDCSUBTYPE_ANY (~0)
104 
105