xref: /netbsd-src/sys/dev/usb/usbdi_util.h (revision 404fbe5fb94ca1e054339640cabb2801ce52dd30)
1 /*	$NetBSD: usbdi_util.h,v 1.37 2008/04/28 20:24:01 martin 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 usbd_status	usbd_get_desc(usbd_device_handle dev, int type,
34 			      int index, int len, void *desc);
35 usbd_status	usbd_get_config_desc(usbd_device_handle, int,
36 				     usb_config_descriptor_t *);
37 usbd_status	usbd_get_config_desc_full(usbd_device_handle, int, void *, int);
38 usbd_status	usbd_get_device_desc(usbd_device_handle dev,
39 				     usb_device_descriptor_t *d);
40 usbd_status	usbd_set_address(usbd_device_handle dev, int addr);
41 usbd_status	usbd_get_port_status(usbd_device_handle,
42 				     int, usb_port_status_t *);
43 usbd_status	usbd_set_hub_feature(usbd_device_handle dev, int);
44 usbd_status	usbd_clear_hub_feature(usbd_device_handle, int);
45 usbd_status	usbd_set_port_feature(usbd_device_handle dev, int, int);
46 usbd_status	usbd_clear_port_feature(usbd_device_handle, int, int);
47 usbd_status	usbd_get_device_status(usbd_device_handle, usb_status_t *);
48 usbd_status	usbd_get_hub_status(usbd_device_handle, usb_hub_status_t *);
49 usbd_status	usbd_get_protocol(usbd_interface_handle dev, u_int8_t *report);
50 usbd_status	usbd_set_protocol(usbd_interface_handle dev, int report);
51 usbd_status	usbd_get_report_descriptor(usbd_device_handle dev, int ifcno,
52 					   int size, void *d);
53 struct usb_hid_descriptor *usbd_get_hid_descriptor(usbd_interface_handle ifc);
54 usbd_status	usbd_set_report(usbd_interface_handle iface, int type, int id,
55 				void *data,int len);
56 usbd_status	usbd_set_report_async(usbd_interface_handle iface, int type,
57 				      int id, void *data, int len);
58 usbd_status	usbd_get_report(usbd_interface_handle iface, int type, int id,
59 				void *data, int len);
60 usbd_status	usbd_set_idle(usbd_interface_handle iface, int duration,int id);
61 usbd_status	usbd_read_report_desc(usbd_interface_handle ifc, void **descp,
62 				       int *sizep, usb_malloc_type mem);
63 usbd_status	usbd_get_config(usbd_device_handle dev, u_int8_t *conf);
64 usbd_status	usbd_get_string_desc(usbd_device_handle dev, int sindex,
65 				     int langid,usb_string_descriptor_t *sdesc,
66 				     int *sizep);
67 void		usbd_delay_ms(usbd_device_handle, u_int);
68 
69 
70 usbd_status usbd_set_config_no(usbd_device_handle, int, int);
71 usbd_status usbd_set_config_index(usbd_device_handle, int, int);
72 
73 usbd_status usbd_bulk_transfer(usbd_xfer_handle, usbd_pipe_handle,
74 			       u_int16_t, u_int32_t, void *,
75 			       u_int32_t *, const char *);
76 
77 usbd_status usbd_intr_transfer(usbd_xfer_handle, usbd_pipe_handle,
78  			       u_int16_t, u_int32_t, void *,
79  			       u_int32_t *, const char *);
80 
81 void usb_detach_wait(device_ptr_t);
82 void usb_detach_wakeup(device_ptr_t);
83 
84 
85 typedef struct {
86 	uByte		bLength;
87 	uByte		bDescriptorType;
88 	uByte		bDescriptorSubtype;
89 } UPACKED usb_cdc_descriptor_t;
90 
91 const usb_cdc_descriptor_t *usb_find_desc(usbd_device_handle dev, int type,
92 				      int subtype);
93 const usb_cdc_descriptor_t *usb_find_desc_if(usbd_device_handle dev, int type,
94 					 int subtype,
95 					 usb_interface_descriptor_t *id);
96 #define USBD_CDCSUBTYPE_ANY (~0)
97 
98