usbdi_util.h revision 1.54 1 /* $NetBSD: usbdi_util.h,v 1.54 2020/06/16 17:25:56 maxv 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 (at) 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(struct usbd_device *, int, int, int, void *);
39 usbd_status usbd_get_config_desc(struct usbd_device *, int,
40 usb_config_descriptor_t *);
41 usbd_status usbd_get_config_desc_full(struct usbd_device *, int, void *,
42 int);
43 usbd_status usbd_get_bos_desc(struct usbd_device *, int,
44 usb_bos_descriptor_t *);
45 usbd_status usbd_get_device_desc(struct usbd_device *,
46 usb_device_descriptor_t *);
47 usbd_status usbd_get_initial_ddesc(struct usbd_device *,
48 usb_device_descriptor_t *);
49 usbd_status usbd_get_string_desc(struct usbd_device *, int, int,
50 usb_string_descriptor_t *, int *);
51
52 usbd_status usbd_get_device_status(struct usbd_device *, usb_status_t *);
53 usbd_status usbd_get_hub_status(struct usbd_device *, usb_hub_status_t *);
54 usbd_status usbd_get_port_status(struct usbd_device *, int,
55 usb_port_status_t *);
56 usbd_status usbd_get_port_status_ext(struct usbd_device *, int,
57 usb_port_status_ext_t *);
58
59 usbd_status usbd_get_desc_fake(struct usbd_device *, int, int, int, void *);
60
61 usbd_status usbd_clear_hub_feature(struct usbd_device *, int);
62 usbd_status usbd_set_hub_feature(struct usbd_device *, int);
63 usbd_status usbd_clear_port_feature(struct usbd_device *, int, int);
64 usbd_status usbd_set_port_feature(struct usbd_device *, int, int);
65 usbd_status usbd_set_port_u1_timeout(struct usbd_device *, int, int);
66 usbd_status usbd_set_port_u2_timeout(struct usbd_device *, int, int);
67 usbd_status usbd_clear_endpoint_feature(struct usbd_device *, int, int);
68
69 usbd_status usbd_get_config(struct usbd_device *, uint8_t *);
70 usbd_status usbd_set_config(struct usbd_device *, int);
71 usbd_status usbd_set_address(struct usbd_device *, int);
72 usbd_status usbd_set_idle(struct usbd_interface *, int, int);
73
74 usbd_status usbd_get_protocol(struct usbd_interface *, uint8_t *);
75 usbd_status usbd_set_protocol(struct usbd_interface *, int);
76
77 usbd_status usbd_set_report(struct usbd_interface *, int, int, void *, int);
78 usbd_status usbd_get_report(struct usbd_interface *, int, int, void *, int);
79 usbd_status usbd_get_report_descriptor(struct usbd_device *, int, int,
80 void *);
81
82 usb_hid_descriptor_t *usbd_get_hid_descriptor(struct usbd_interface *);
83 usbd_status usbd_read_report_desc(struct usbd_interface *, void **, int *);
84
85 usbd_status usbd_set_config_no(struct usbd_device *, int, int);
86 usbd_status usbd_set_config_index(struct usbd_device *, int, int);
87
88 usbd_status usbd_bulk_transfer(struct usbd_xfer *, struct usbd_pipe *,
89 uint16_t, uint32_t, void *, uint32_t *);
90 usbd_status usbd_intr_transfer(struct usbd_xfer *, struct usbd_pipe *,
91 uint16_t, uint32_t, void *, uint32_t *);
92
93 void usb_detach_waitold(device_t);
94 void usb_detach_wakeupold(device_t);
95
96 typedef struct {
97 uByte bLength;
98 uByte bDescriptorType;
99 uByte bDescriptorSubtype;
100 } UPACKED usb_cdc_descriptor_t;
101
102 /* An iterator for descriptors. */
103 typedef struct {
104 const uByte *cur;
105 const uByte *end;
106 } usbd_desc_iter_t;
107 void usb_desc_iter_init(struct usbd_device *, usbd_desc_iter_t *);
108 const usb_descriptor_t *usb_desc_iter_peek(usbd_desc_iter_t *);
109 const usb_descriptor_t *usb_desc_iter_next(usbd_desc_iter_t *);
110 const usb_interface_descriptor_t *usb_desc_iter_next_interface(usbd_desc_iter_t *);
111 const usb_descriptor_t *usb_desc_iter_next_non_interface(usbd_desc_iter_t *);
112
113 const usb_cdc_descriptor_t *usb_find_desc(struct usbd_device *, int,
114 int);
115 const usb_cdc_descriptor_t *usb_find_desc_if(struct usbd_device *, int,
116 int,
117 usb_interface_descriptor_t *);
118 #define USBD_CDCSUBTYPE_ANY (~0)
119
120 #endif /* _USBDI_UTIL_H_ */
121