jcs.org
jcs's openbsd hax
openbsd
1/* $OpenBSD: usbdivar.h,v 1.85 2025/03/01 14:43:03 kirill 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 */
46struct usb_dma_block;
47struct usb_dma {
48 struct usb_dma_block *block;
49 u_int offs;
50#define USB_DMA_COHERENT (1 << 0)
51};
52
53struct usbd_xfer;
54struct usbd_pipe;
55
56struct usbd_endpoint {
57 usb_endpoint_descriptor_t *edesc;
58 usb_endpoint_ss_comp_descriptor_t *esscd;
59 int refcnt;
60 int savedtoggle;
61};
62
63struct usbd_bus_methods {
64 usbd_status (*open_pipe)(struct usbd_pipe *);
65 int (*dev_setaddr)(struct usbd_device *, int);
66 void (*soft_intr)(void *);
67 void (*do_poll)(struct usbd_bus *);
68 struct usbd_xfer * (*allocx)(struct usbd_bus *);
69 void (*freex)(struct usbd_bus *, struct usbd_xfer *);
70};
71
72struct usbd_pipe_methods {
73 usbd_status (*transfer)(struct usbd_xfer *);
74 usbd_status (*start)(struct usbd_xfer *);
75 void (*abort)(struct usbd_xfer *);
76 void (*close)(struct usbd_pipe *);
77 void (*cleartoggle)(struct usbd_pipe *);
78 void (*done)(struct usbd_xfer *);
79};
80
81struct usbd_tt {
82 struct usbd_hub *hub;
83 void *hcpriv;
84};
85
86struct usbd_port {
87 usb_port_status_t status;
88 u_int16_t power; /* mA of current on port */
89 u_int8_t portno;
90 u_int8_t restartcnt;
91#define USBD_RESTART_MAX 5
92 u_int8_t reattach;
93 struct usbd_device *device; /* Connected device */
94 struct usbd_device *parent; /* The ports hub */
95 struct usbd_tt *tt; /* Transaction translator (if any) */
96};
97
98struct usbd_hub {
99 int (*explore)(struct usbd_device *);
100 void *hubsoftc;
101 struct usbd_port *ports;
102 int nports;
103 u_int8_t powerdelay;
104 u_int8_t ttthink;
105 u_int8_t multi;
106};
107
108struct usbd_bus {
109 /* Filled by HC driver */
110 struct device bdev; /* base device, host adapter */
111 const struct usbd_bus_methods *methods;
112#if NBPFILTER > 0
113 void *bpfif;
114 caddr_t bpf;
115#endif
116 u_int32_t pipe_size; /* size of a pipe struct */
117 /* Filled by usb driver */
118 struct usbd_device *root_hub;
119 struct usbd_device *devices[USB_MAX_DEVICES];
120 char use_polling;
121 char dying;
122 int flags;
123#define USB_BUS_CONFIG_PENDING 0x01
124#define USB_BUS_DISCONNECTING 0x02
125 struct device *usbctl;
126 struct usb_device_stats stats;
127 int intr_context;
128 u_int no_intrs;
129 int usbrev; /* USB revision */
130#define USBREV_UNKNOWN 0
131#define USBREV_PRE_1_0 1
132#define USBREV_1_0 2
133#define USBREV_1_1 3
134#define USBREV_2_0 4
135#define USBREV_3_0 5
136#define USBREV_STR { "unknown", "pre 1.0", "1.0", "1.1", "2.0", "3.0" }
137 void *soft; /* soft interrupt cookie */
138 bus_dma_tag_t dmatag; /* DMA tag */
139 int dmaflags;
140};
141
142struct usbd_device {
143 struct usbd_bus *bus; /* our controller */
144 struct usbd_pipe *default_pipe; /* pipe 0 */
145 u_int8_t dying; /* hardware removed */
146 u_int8_t ref_cnt; /* # of procs using device */
147 u_int8_t address; /* device address */
148 u_int8_t config; /* current configuration # */
149 u_int8_t depth; /* distance from root hub */
150 u_int8_t speed; /* low/full/high speed */
151 u_int8_t self_powered; /* flag for self powered */
152 u_int16_t power; /* mA the device uses */
153 int16_t langid; /* language for strings */
154#define USBD_NOLANG (-1)
155 struct usbd_port *powersrc; /* upstream hub port, or 0 */
156 struct usbd_device *myhub; /* upstream hub */
157 struct usbd_port *myhsport; /* closest high speed port */
158 struct usbd_endpoint def_ep; /* for pipe 0 */
159 usb_endpoint_descriptor_t def_ep_desc; /* for pipe 0 */
160 struct usbd_interface *ifaces; /* array of all interfaces */
161 usb_device_descriptor_t ddesc; /* device descriptor */
162 usb_config_descriptor_t *cdesc; /* full config descr */
163 const struct usbd_quirks *quirks; /* device quirks, always set */
164 struct usbd_hub *hub; /* only if this is a hub */
165 struct device **subdevs; /* sub-devices, 0 terminated */
166 int nsubdev; /* size of the `subdevs' array */
167 int ndevs; /* # of subdevs */
168
169 char *serial; /* serial number, can be NULL */
170 char *vendor; /* vendor string, can be NULL */
171 char *product; /* product string, can be NULL */
172};
173
174struct usbd_interface {
175 struct usbd_device *device;
176 usb_interface_descriptor_t *idesc;
177 int index;
178 int altindex;
179 struct usbd_endpoint *endpoints;
180 void *priv;
181 LIST_HEAD(, usbd_pipe) pipes;
182 uint8_t claimed;
183 uint8_t nendpt;
184};
185
186struct usbd_pipe {
187 struct usbd_interface *iface;
188 struct usbd_device *device;
189 struct usbd_endpoint *endpoint;
190 size_t pipe_size;
191 char running;
192 char aborting;
193 SIMPLEQ_HEAD(, usbd_xfer) queue;
194 LIST_ENTRY(usbd_pipe) next;
195
196 struct usbd_xfer *intrxfer; /* used for repeating requests */
197 char repeat;
198 int interval;
199
200 /* Filled by HC driver. */
201 const struct usbd_pipe_methods *methods;
202};
203
204struct usbd_xfer {
205 struct usbd_pipe *pipe;
206 void *priv;
207 char *buffer;
208 u_int32_t length;
209 u_int32_t actlen;
210 u_int16_t flags;
211 u_int32_t timeout;
212 usbd_status status;
213 usbd_callback callback;
214 volatile char done;
215#ifdef DIAGNOSTIC
216 u_int32_t busy_free;
217#define XFER_FREE 0x42555359
218#define XFER_ONQU 0x4f4e5155
219#endif
220
221 /* For control pipe */
222 usb_device_request_t request;
223
224 /* For isoc */
225 u_int16_t *frlengths;
226 int nframes;
227
228 /* For memory allocation */
229 struct usbd_device *device;
230 struct usb_dma dmabuf;
231
232 int rqflags;
233#define URQ_REQUEST 0x01
234#define URQ_AUTO_DMABUF 0x10
235#define URQ_DEV_DMABUF 0x20
236
237 SIMPLEQ_ENTRY(usbd_xfer) next;
238
239 void *hcpriv; /* private use by the HC driver */
240
241 struct usb_task abort_task;
242 struct timeout timeout_handle;
243};
244
245void usbd_dump_iface(struct usbd_interface *);
246void usbd_dump_device(struct usbd_device *);
247void usbd_dump_endpoint(struct usbd_endpoint *);
248void usbd_dump_queue(struct usbd_pipe *);
249void usbd_dump_pipe(struct usbd_pipe *);
250
251/* Routines from usb_subr.c */
252int usbctlprint(void *, const char *);
253void usb_delay_ms(struct usbd_bus *, u_int);
254usbd_status usbd_port_disown_to_1_1(struct usbd_device *, int);
255int usbd_reset_port(struct usbd_device *, int);
256usbd_status usbd_setup_pipe(struct usbd_device *,
257 struct usbd_interface *, struct usbd_endpoint *, int,
258 struct usbd_pipe **);
259int usbd_set_address(struct usbd_device *, int);
260usbd_status usbd_new_device(struct device *, struct usbd_bus *,
261 int, int, int, struct usbd_port *);
262usbd_status usbd_fill_iface_data(struct usbd_device *, int, int);
263
264usbd_status usb_insert_transfer(struct usbd_xfer *);
265void usb_transfer_complete(struct usbd_xfer *);
266int usbd_detach(struct usbd_device *, struct device *);
267
268/* Routines from usb.c */
269void usb_needs_explore(struct usbd_device *, int);
270void usb_needs_reattach(struct usbd_device *);
271void usb_schedsoftintr(struct usbd_bus *);
272void usb_tap(struct usbd_bus *, struct usbd_xfer *, uint8_t);
273
274#define USBTAP_DIR_OUT 0
275#define USBTAP_DIR_IN 1
276
277#define UHUB_UNK_CONFIGURATION -1
278#define UHUB_UNK_INTERFACE -1
279
280static inline int
281usbd_xfer_isread(struct usbd_xfer *xfer)
282{
283 if (xfer->rqflags & URQ_REQUEST)
284 return (xfer->request.bmRequestType & UT_READ);
285
286 return (xfer->pipe->endpoint->edesc->bEndpointAddress & UE_DIR_IN);
287}
288
289#endif /* _USBDIVAR_H_ */