1 /* $OpenBSD: usbdivar.h,v 1.83 2022/09/04 08:42:39 mglocker Exp $ */
2 /* $NetBSD: usbdivar.h,v 1.70 2002/07/11 21:14:36 augustss Exp $ */
3 /* $FreeBSD: src/sys/dev/usb/usbdivar.h,v 1.11 1999/11/17 22:33:51 n_hibma Exp $ */
4
5 /*
6 * Copyright (c) 1998 The NetBSD Foundation, Inc.
7 * All rights reserved.
8 *
9 * This code is derived from software contributed to The NetBSD Foundation
10 * by Lennart Augustsson (lennart@augustsson.net) at
11 * Carlstedt Research & Technology.
12 *
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
15 * are met:
16 * 1. Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 * 2. Redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution.
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
23 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
24 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
25 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
26 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
27 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
28 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
30 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
31 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32 * POSSIBILITY OF SUCH DAMAGE.
33 */
34
35 #ifndef _USBDIVAR_H_
36 #define _USBDIVAR_H_
37
38 #include "bpfilter.h"
39 #if NBPFILTER > 0
40 #include <net/bpf.h>
41 #endif
42
43 #include <sys/timeout.h>
44
45 /* From usb_mem.h */
46 struct usb_dma_block;
47 struct usb_dma {
48 struct usb_dma_block *block;
49 u_int offs;
50 #define USB_DMA_COHERENT (1 << 0)
51 };
52
53 struct usbd_xfer;
54 struct usbd_pipe;
55
56 struct usbd_endpoint {
57 usb_endpoint_descriptor_t *edesc;
58 int refcnt;
59 int savedtoggle;
60 };
61
62 struct usbd_bus_methods {
63 usbd_status (*open_pipe)(struct usbd_pipe *);
64 int (*dev_setaddr)(struct usbd_device *, int);
65 void (*soft_intr)(void *);
66 void (*do_poll)(struct usbd_bus *);
67 struct usbd_xfer * (*allocx)(struct usbd_bus *);
68 void (*freex)(struct usbd_bus *, struct usbd_xfer *);
69 };
70
71 struct usbd_pipe_methods {
72 usbd_status (*transfer)(struct usbd_xfer *);
73 usbd_status (*start)(struct usbd_xfer *);
74 void (*abort)(struct usbd_xfer *);
75 void (*close)(struct usbd_pipe *);
76 void (*cleartoggle)(struct usbd_pipe *);
77 void (*done)(struct usbd_xfer *);
78 };
79
80 struct usbd_tt {
81 struct usbd_hub *hub;
82 void *hcpriv;
83 };
84
85 struct usbd_port {
86 usb_port_status_t status;
87 u_int16_t power; /* mA of current on port */
88 u_int8_t portno;
89 u_int8_t restartcnt;
90 #define USBD_RESTART_MAX 5
91 u_int8_t reattach;
92 struct usbd_device *device; /* Connected device */
93 struct usbd_device *parent; /* The ports hub */
94 struct usbd_tt *tt; /* Transaction translator (if any) */
95 };
96
97 struct usbd_hub {
98 int (*explore)(struct usbd_device *);
99 void *hubsoftc;
100 struct usbd_port *ports;
101 int nports;
102 u_int8_t powerdelay;
103 u_int8_t ttthink;
104 u_int8_t multi;
105 };
106
107 struct usbd_bus {
108 /* Filled by HC driver */
109 struct device bdev; /* base device, host adapter */
110 const struct usbd_bus_methods *methods;
111 #if NBPFILTER > 0
112 void *bpfif;
113 caddr_t bpf;
114 #endif
115 u_int32_t pipe_size; /* size of a pipe struct */
116 /* Filled by usb driver */
117 struct usbd_device *root_hub;
118 struct usbd_device *devices[USB_MAX_DEVICES];
119 char use_polling;
120 char dying;
121 int flags;
122 #define USB_BUS_CONFIG_PENDING 0x01
123 #define USB_BUS_DISCONNECTING 0x02
124 struct device *usbctl;
125 struct usb_device_stats stats;
126 int intr_context;
127 u_int no_intrs;
128 int usbrev; /* USB revision */
129 #define USBREV_UNKNOWN 0
130 #define USBREV_PRE_1_0 1
131 #define USBREV_1_0 2
132 #define USBREV_1_1 3
133 #define USBREV_2_0 4
134 #define USBREV_3_0 5
135 #define USBREV_STR { "unknown", "pre 1.0", "1.0", "1.1", "2.0", "3.0" }
136 void *soft; /* soft interrupt cookie */
137 bus_dma_tag_t dmatag; /* DMA tag */
138 };
139
140 struct usbd_device {
141 struct usbd_bus *bus; /* our controller */
142 struct usbd_pipe *default_pipe; /* pipe 0 */
143 u_int8_t dying; /* hardware removed */
144 u_int8_t ref_cnt; /* # of procs using device */
145 u_int8_t address; /* device address */
146 u_int8_t config; /* current configuration # */
147 u_int8_t depth; /* distance from root hub */
148 u_int8_t speed; /* low/full/high speed */
149 u_int8_t self_powered; /* flag for self powered */
150 u_int16_t power; /* mA the device uses */
151 int16_t langid; /* language for strings */
152 #define USBD_NOLANG (-1)
153 struct usbd_port *powersrc; /* upstream hub port, or 0 */
154 struct usbd_device *myhub; /* upstream hub */
155 struct usbd_port *myhsport; /* closest high speed port */
156 struct usbd_endpoint def_ep; /* for pipe 0 */
157 usb_endpoint_descriptor_t def_ep_desc; /* for pipe 0 */
158 struct usbd_interface *ifaces; /* array of all interfaces */
159 usb_device_descriptor_t ddesc; /* device descriptor */
160 usb_config_descriptor_t *cdesc; /* full config descr */
161 const struct usbd_quirks *quirks; /* device quirks, always set */
162 struct usbd_hub *hub; /* only if this is a hub */
163 struct device **subdevs; /* sub-devices, 0 terminated */
164 int nsubdev; /* size of the `subdevs' array */
165 int ndevs; /* # of subdevs */
166
167 char *serial; /* serial number, can be NULL */
168 char *vendor; /* vendor string, can be NULL */
169 char *product; /* product string, can be NULL */
170 };
171
172 struct usbd_interface {
173 struct usbd_device *device;
174 usb_interface_descriptor_t *idesc;
175 int index;
176 int altindex;
177 struct usbd_endpoint *endpoints;
178 void *priv;
179 LIST_HEAD(, usbd_pipe) pipes;
180 uint8_t claimed;
181 uint8_t nendpt;
182 };
183
184 struct usbd_pipe {
185 struct usbd_interface *iface;
186 struct usbd_device *device;
187 struct usbd_endpoint *endpoint;
188 size_t pipe_size;
189 char running;
190 char aborting;
191 SIMPLEQ_HEAD(, usbd_xfer) queue;
192 LIST_ENTRY(usbd_pipe) next;
193
194 struct usbd_xfer *intrxfer; /* used for repeating requests */
195 char repeat;
196 int interval;
197
198 /* Filled by HC driver. */
199 const struct usbd_pipe_methods *methods;
200 };
201
202 struct usbd_xfer {
203 struct usbd_pipe *pipe;
204 void *priv;
205 char *buffer;
206 u_int32_t length;
207 u_int32_t actlen;
208 u_int16_t flags;
209 u_int32_t timeout;
210 usbd_status status;
211 usbd_callback callback;
212 volatile char done;
213 #ifdef DIAGNOSTIC
214 u_int32_t busy_free;
215 #define XFER_FREE 0x42555359
216 #define XFER_ONQU 0x4f4e5155
217 #endif
218
219 /* For control pipe */
220 usb_device_request_t request;
221
222 /* For isoc */
223 u_int16_t *frlengths;
224 int nframes;
225
226 /* For memory allocation */
227 struct usbd_device *device;
228 struct usb_dma dmabuf;
229
230 int rqflags;
231 #define URQ_REQUEST 0x01
232 #define URQ_AUTO_DMABUF 0x10
233 #define URQ_DEV_DMABUF 0x20
234
235 SIMPLEQ_ENTRY(usbd_xfer) next;
236
237 void *hcpriv; /* private use by the HC driver */
238
239 struct usb_task abort_task;
240 struct timeout timeout_handle;
241 };
242
243 void usbd_dump_iface(struct usbd_interface *);
244 void usbd_dump_device(struct usbd_device *);
245 void usbd_dump_endpoint(struct usbd_endpoint *);
246 void usbd_dump_queue(struct usbd_pipe *);
247 void usbd_dump_pipe(struct usbd_pipe *);
248
249 /* Routines from usb_subr.c */
250 int usbctlprint(void *, const char *);
251 void usb_delay_ms(struct usbd_bus *, u_int);
252 usbd_status usbd_port_disown_to_1_1(struct usbd_device *, int);
253 int usbd_reset_port(struct usbd_device *, int);
254 usbd_status usbd_setup_pipe(struct usbd_device *,
255 struct usbd_interface *, struct usbd_endpoint *, int,
256 struct usbd_pipe **);
257 int usbd_set_address(struct usbd_device *, int);
258 usbd_status usbd_new_device(struct device *, struct usbd_bus *,
259 int, int, int, struct usbd_port *);
260 usbd_status usbd_fill_iface_data(struct usbd_device *, int, int);
261
262 usbd_status usb_insert_transfer(struct usbd_xfer *);
263 void usb_transfer_complete(struct usbd_xfer *);
264 int usbd_detach(struct usbd_device *, struct device *);
265
266 /* Routines from usb.c */
267 void usb_needs_explore(struct usbd_device *, int);
268 void usb_needs_reattach(struct usbd_device *);
269 void usb_schedsoftintr(struct usbd_bus *);
270 void usb_tap(struct usbd_bus *, struct usbd_xfer *, uint8_t);
271
272 #define USBTAP_DIR_OUT 0
273 #define USBTAP_DIR_IN 1
274
275 #define UHUB_UNK_CONFIGURATION -1
276 #define UHUB_UNK_INTERFACE -1
277
278 static inline int
usbd_xfer_isread(struct usbd_xfer * xfer)279 usbd_xfer_isread(struct usbd_xfer *xfer)
280 {
281 if (xfer->rqflags & URQ_REQUEST)
282 return (xfer->request.bmRequestType & UT_READ);
283
284 return (xfer->pipe->endpoint->edesc->bEndpointAddress & UE_DIR_IN);
285 }
286
287 #endif /* _USBDIVAR_H_ */
288