summaryrefslogtreecommitdiff
path: root/sys/dev/usb/usbdivar.h
blob: 2ff3cbe6cfbd8e6339b1d77aa1c25fc97584d33d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
/*	$NetBSD: usbdivar.h,v 1.137 2022/03/13 11:28:52 riastradh Exp $	*/

/*
 * Copyright (c) 1998, 2012 The NetBSD Foundation, Inc.
 * All rights reserved.
 *
 * This code is derived from software contributed to The NetBSD Foundation
 * by Lennart Augustsson (lennart@augustsson.net) at
 * Carlstedt Research & Technology and Matthew R. Green (mrg@eterna.com.au).
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef	_DEV_USB_USBDIVAR_H_
#define	_DEV_USB_USBDIVAR_H_

/*
 * Discussion about locking in the USB code:
 *
 * The host controller presents one lock at IPL_SOFTUSB (aka IPL_SOFTNET).
 *
 * List of hardware interface methods, and whether the lock is held
 * when each is called by this module:
 *
 *	BUS METHOD		LOCK	NOTES
 *	----------------------- -------	-------------------------
 *	ubm_open		-	might want to take lock?
 *	ubm_softint		x	may release/reacquire lock
 *	ubm_dopoll		-	might want to take lock?
 *	ubm_allocx		-
 *	ubm_freex		-
 *	ubm_abortx		x	must not release/reacquire lock
 *	ubm_getlock 		-	Called at attach time
 *	ubm_newdev		-	Will take lock
 *	ubm_rhctrl              -
 *
 *	PIPE METHOD		LOCK	NOTES
 *	----------------------- -------	-------------------------
 *	upm_init		-
 *	upm_fini		-
 *	upm_transfer		x
 *	upm_start		x
 *	upm_abort		x
 *	upm_close		x
 *	upm_cleartoggle		-
 *	upm_done		x
 *
 * The above semantics are likely to change.  Little performance
 * evaluation has been done on this code and the locking strategy.
 *
 * USB functions known to expect the lock taken include (this list is
 * probably not exhaustive):
 *    usb_transfer_complete()
 *    usb_start_next()
 *
 */

#include <sys/callout.h>
#include <sys/mutex.h>
#include <sys/bus.h>

/* From usb_mem.h */
struct usb_dma_block;
typedef struct {
	struct usb_dma_block *udma_block;
	u_int udma_offs;
} usb_dma_t;

struct usbd_xfer;
struct usbd_pipe;
struct usbd_port;

struct usbd_endpoint {
	usb_endpoint_descriptor_t *ue_edesc;
	int			ue_refcnt;
	int			ue_toggle;
};

struct usbd_bus_methods {
	usbd_status	      (*ubm_open)(struct usbd_pipe *);
	void		      (*ubm_softint)(void *);
	void		      (*ubm_dopoll)(struct usbd_bus *);
	struct usbd_xfer     *(*ubm_allocx)(struct usbd_bus *, unsigned int);
	void		      (*ubm_freex)(struct usbd_bus *, struct usbd_xfer *);
	void		      (*ubm_abortx)(struct usbd_xfer *);
	bool		      (*ubm_dying)(struct usbd_bus *);
	void		      (*ubm_getlock)(struct usbd_bus *, kmutex_t **);
	usbd_status	      (*ubm_newdev)(device_t, struct usbd_bus *, int,
					    int, int, struct usbd_port *);

	int			(*ubm_rhctrl)(struct usbd_bus *,
				    usb_device_request_t *, void *, int);
};

struct usbd_pipe_methods {
	int		      (*upm_init)(struct usbd_xfer *);
	void		      (*upm_fini)(struct usbd_xfer *);
	usbd_status	      (*upm_transfer)(struct usbd_xfer *);
	usbd_status	      (*upm_start)(struct usbd_xfer *);
	void		      (*upm_abort)(struct usbd_xfer *);
	void		      (*upm_close)(struct usbd_pipe *);
	void		      (*upm_cleartoggle)(struct usbd_pipe *);
	void		      (*upm_done)(struct usbd_xfer *);
};

struct usbd_tt {
	struct usbd_hub	       *utt_hub;
};

struct usbd_port {
	usb_port_status_t	up_status;
	uint16_t		up_power;	/* mA of current on port */
	uint8_t			up_portno;
	uint8_t			up_restartcnt;
#define USBD_RESTART_MAX 5
	uint8_t			up_reattach;
	struct usbd_device     *up_dev;		/* Connected device */
	struct usbd_device     *up_parent;	/* The ports hub */
	struct usbd_tt	       *up_tt;	/* Transaction translator (if any) */
};

struct usbd_hub {
	usbd_status	      (*uh_explore)(struct usbd_device *hub);
	void		       *uh_hubsoftc;
	usb_hub_descriptor_t	uh_hubdesc;
	struct usbd_port        uh_ports[1];
};

/*****/
/* 0, root, and 1->127 */
#define USB_ROOTHUB_INDEX	1
#define USB_TOTAL_DEVICES	(USB_MAX_DEVICES + 1)

struct usbd_bus {
	/* Filled by HC driver */
	void			*ub_hcpriv;
	int			ub_revision;	/* USB revision */
#define USBREV_UNKNOWN	0
#define USBREV_PRE_1_0	1
#define USBREV_1_0	2
#define USBREV_1_1	3
#define USBREV_2_0	4
#define USBREV_3_0	5
#define USBREV_3_1	6
#define USBREV_STR { "unknown", "pre 1.0", "1.0", "1.1", "2.0", "3.0", "3.1" }
	int			ub_hctype;
#define USBHCTYPE_UNKNOWN	0
#define USBHCTYPE_MOTG		1
#define USBHCTYPE_OHCI		2
#define USBHCTYPE_UHCI		3
#define USBHCTYPE_EHCI		4
#define USBHCTYPE_XHCI		5
#define USBHCTYPE_VHCI		6
	int			ub_busnum;
	const struct usbd_bus_methods
			       *ub_methods;
	uint32_t		ub_pipesize;	/* size of a pipe struct */
	bool			ub_usedma;	/* Does this HC support DMA */
	int			ub_dmaflags;
	bus_dma_tag_t		ub_dmatag;	/* DMA tag */

	/* Filled by usb driver */
	kmutex_t	       *ub_lock;
	struct usbd_device     *ub_roothub;
	struct usbd_xfer       *ub_rhxfer;	/* roothub xfer in progress */
	kcondvar_t		ub_rhxfercv;
	uint8_t			ub_rhaddr;	/* roothub address */
	uint8_t			ub_rhconf;	/* roothub configuration */
	struct usbd_device     *ub_devices[USB_TOTAL_DEVICES];
	kcondvar_t              ub_needsexplore_cv;
	char			ub_needsexplore;/* a hub a signalled a change */
	char			ub_usepolling;
	device_t		ub_usbctl;
	struct usb_device_stats	ub_stats;

	void		       *ub_soft; /* soft interrupt cookie */
};

struct usbd_device {
	struct usbd_bus	       *ud_bus;		/* our controller */
	struct usbd_pipe       *ud_pipe0;	/* pipe 0 */
	uint8_t			ud_addr;	/* device address */
	uint8_t			ud_config;	/* current configuration # */
	uint8_t			ud_depth;	/* distance from root hub */
	uint8_t			ud_speed;	/* low/full/high speed */
	uint8_t			ud_selfpowered;	/* flag for self powered */
	uint16_t		ud_power;	/* mA the device uses */
	int16_t			ud_langid;	/* language for strings */
#define USBD_NOLANG (-1)
	usb_event_cookie_t	ud_cookie;	/* unique connection id */
	struct usbd_port       *ud_powersrc;	/* upstream hub port, or 0 */
	struct usbd_device     *ud_myhub;	/* upstream hub */
	struct usbd_port       *ud_myhsport;	/* closest high speed port */
	struct usbd_endpoint	ud_ep0;		/* for pipe 0 */
	usb_endpoint_descriptor_t
				ud_ep0desc;	/* for pipe 0 */
	struct usbd_interface  *ud_ifaces;	/* array of all interfaces */
	usb_device_descriptor_t ud_ddesc;	/* device descriptor */
	usb_config_descriptor_t *ud_cdesc;	/* full config descr */
	usb_bos_descriptor_t	*ud_bdesc;	/* full BOS descr */
	const struct usbd_quirks
			       *ud_quirks;	/* device quirks, always set */
	struct usbd_hub	       *ud_hub;		/* only if this is a hub */
	u_int			ud_subdevlen;	/* array length of following */
	device_t	       *ud_subdevs;	/* sub-devices */
	int			ud_nifaces_claimed; /* number of ifaces in use */
	void		       *ud_hcpriv;

	char		       *ud_serial;	/* serial number, can be NULL */
	char		       *ud_vendor;	/* vendor string, can be NULL */
	char		       *ud_product;	/* product string can be NULL */
};

struct usbd_interface {
	struct usbd_device     *ui_dev;
	usb_interface_descriptor_t
			       *ui_idesc;
	int			ui_index;
	int			ui_altindex;
	struct usbd_endpoint   *ui_endpoints;
	int64_t			ui_busy;	/* #pipes, or -1 if setting */
};

struct usbd_pipe {
	struct usbd_interface  *up_iface;
	struct usbd_device     *up_dev;
	struct usbd_endpoint   *up_endpoint;
	char			up_running;
	char			up_aborting;
	bool			up_serialise;
	SIMPLEQ_HEAD(, usbd_xfer)
			        up_queue;
	struct usb_task		up_async_task;

	struct usbd_xfer       *up_intrxfer; /* used for repeating requests */
	char			up_repeat;
	int			up_interval;
	uint8_t			up_flags;

	struct usbd_xfer       *up_callingxfer; /* currently in callback */
	kcondvar_t		up_callingcv;

	struct lwp	       *up_abortlwp;	/* lwp currently aborting */

	/* Filled by HC driver. */
	const struct usbd_pipe_methods
			       *up_methods;
};

struct usbd_xfer {
	struct usbd_pipe       *ux_pipe;
	void		       *ux_priv;
	void		       *ux_buffer;
	kcondvar_t		ux_cv;
	uint32_t		ux_length;
	uint32_t		ux_actlen;
	uint16_t		ux_flags;
	uint32_t		ux_timeout;
	usbd_status		ux_status;
	usbd_callback		ux_callback;
	volatile uint8_t	ux_done;
	uint8_t			ux_state;	/* used for DIAGNOSTIC */
#define XFER_FREE 0x46
#define XFER_BUSY 0x55
#define XFER_ONQU 0x9e

	/* For control pipe */
	usb_device_request_t	ux_request;

	/* For isoc */
	uint16_t	       *ux_frlengths;
	int			ux_nframes;

	const struct usbd_pipe_methods *ux_methods;

	/* For memory allocation and softc */
	struct usbd_bus        *ux_bus;
	usb_dma_t		ux_dmabuf;
	void		       *ux_buf;
	uint32_t		ux_bufsize;

	uint8_t			ux_rqflags;
#define URQ_REQUEST	0x01

	SIMPLEQ_ENTRY(usbd_xfer)
				ux_next;

	void		       *ux_hcpriv;	/* private use by the HC driver */

	struct usb_task		ux_aborttask;
	struct callout		ux_callout;

	/*
	 * Protected by bus lock.
	 *
	 * - ux_timeout_set: The timeout is scheduled as a callout or
	 *   usb task, and has not yet acquired the bus lock.
	 *
	 * - ux_timeout_reset: The xfer completed, and was resubmitted
	 *   before the callout or task was able to acquire the bus
	 *   lock, so one or the other needs to schedule a new callout.
	 */
	bool			ux_timeout_set;
	bool			ux_timeout_reset;
};

void usbd_init(void);
void usbd_finish(void);

#if defined(USB_DEBUG)
void usbd_dump_iface(struct usbd_interface *);
void usbd_dump_device(struct usbd_device *);
void usbd_dump_endpoint(struct usbd_endpoint *);
void usbd_dump_queue(struct usbd_pipe *);
void usbd_dump_pipe(struct usbd_pipe *);
#endif

/* Routines from usb_subr.c */
int		usbctlprint(void *, const char *);
void		usbd_get_device_strings(struct usbd_device *);
void		usb_delay_ms_locked(struct usbd_bus *, u_int, kmutex_t *);
void		usb_delay_ms(struct usbd_bus *, u_int);
void		usbd_delay_ms_locked(struct usbd_device *, u_int, kmutex_t *);
void		usbd_delay_ms(struct usbd_device *, u_int);
usbd_status	usbd_reset_port(struct usbd_device *, int, usb_port_status_t *);
usbd_status	usbd_setup_pipe(struct usbd_device *,
				struct usbd_interface *,
				struct usbd_endpoint *, int,
				struct usbd_pipe **);
usbd_status	usbd_setup_pipe_flags(struct usbd_device *,
				      struct usbd_interface *,
				      struct usbd_endpoint *, int,
				      struct usbd_pipe **,
				      uint8_t);
usbd_status	usbd_new_device(device_t, struct usbd_bus *, int, int, int,
				struct usbd_port *);
usbd_status	usbd_reattach_device(device_t, struct usbd_device *,
				     int, const int *);

void		usbd_remove_device(struct usbd_device *, struct usbd_port *);
bool		usbd_iface_locked(struct usbd_interface *);
usbd_status	usbd_iface_lock(struct usbd_interface *);
void		usbd_iface_unlock(struct usbd_interface *);
usbd_status	usbd_iface_piperef(struct usbd_interface *);
void		usbd_iface_pipeunref(struct usbd_interface *);
usbd_status	usbd_fill_iface_data(struct usbd_device *, int, int);
void		usb_free_device(struct usbd_device *);

void		usb_transfer_complete(struct usbd_xfer *);
int		usb_disconnect_port(struct usbd_port *, device_t, int);

usbd_status	usbd_endpoint_acquire(struct usbd_device *,
		    struct usbd_endpoint *, int);
void		usbd_endpoint_release(struct usbd_device *,
		    struct usbd_endpoint *);

void		usbd_kill_pipe(struct usbd_pipe *);
usbd_status	usbd_attach_roothub(device_t, struct usbd_device *);
usbd_status	usbd_probe_and_attach(device_t, struct usbd_device *, int, int);

/* Routines from usb.c */
void		usb_needs_explore(struct usbd_device *);
void		usb_needs_reattach(struct usbd_device *);
void		usb_schedsoftintr(struct usbd_bus *);

static __inline int
usbd_xfer_isread(struct usbd_xfer *xfer)
{
	if (xfer->ux_rqflags & URQ_REQUEST)
		return xfer->ux_request.bmRequestType & UT_READ;

	return xfer->ux_pipe->up_endpoint->ue_edesc->bEndpointAddress &
	   UE_DIR_IN;
}

static __inline size_t
usb_addr2dindex(int addr)
{

	return USB_ROOTHUB_INDEX + addr;
}

/*
 * These macros reflect the current locking scheme.  They might change.
 */

#define usbd_lock_pipe(p)	mutex_enter((p)->up_dev->ud_bus->ub_lock)
#define usbd_unlock_pipe(p)	mutex_exit((p)->up_dev->ud_bus->ub_lock)

#endif	/* _DEV_USB_USBDIVAR_H_ */