ehci.h 25.4 KB
Newer Older
L
Linus Torvalds 已提交
1 2
/*
 * Copyright (c) 2001-2002 by David Brownell
3
 *
L
Linus Torvalds 已提交
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation; either version 2 of the License, or (at your
 * option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

#ifndef __LINUX_EHCI_HCD_H
#define __LINUX_EHCI_HCD_H

/* definitions used for the EHCI driver */

24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39
/*
 * __hc32 and __hc16 are "Host Controller" types, they may be equivalent to
 * __leXX (normally) or __beXX (given EHCI_BIG_ENDIAN_DESC), depending on
 * the host controller implementation.
 *
 * To facilitate the strongest possible byte-order checking from "sparse"
 * and so on, we use __leXX unless that's not practical.
 */
#ifdef CONFIG_USB_EHCI_BIG_ENDIAN_DESC
typedef __u32 __bitwise __hc32;
typedef __u16 __bitwise __hc16;
#else
#define __hc32	__le32
#define __hc16	__le16
#endif

40
/* statistics can be kept for tuning/monitoring */
41 42 43 44
#ifdef DEBUG
#define EHCI_STATS
#endif

L
Linus Torvalds 已提交
45 46 47 48
struct ehci_stats {
	/* irq usage */
	unsigned long		normal;
	unsigned long		error;
A
Alan Stern 已提交
49
	unsigned long		iaa;
L
Linus Torvalds 已提交
50 51 52 53 54 55 56 57
	unsigned long		lost_iaa;

	/* termination of urbs from core */
	unsigned long		complete;
	unsigned long		unlink;
};

/* ehci_hcd->lock guards shared data against other CPUs:
A
Alan Stern 已提交
58
 *   ehci_hcd:	async, unlink, periodic (and shadow), ...
L
Linus Torvalds 已提交
59 60 61 62 63 64 65 66 67 68
 *   usb_host_endpoint: hcpriv
 *   ehci_qh:	qh_next, qtd_list
 *   ehci_qtd:	qtd_list
 *
 * Also, hold this lock when talking to HC registers or
 * when updating hw_* fields in shared qh/qtd/... structures.
 */

#define	EHCI_MAX_ROOT_PORTS	15		/* see HCS_N_PORTS */

69 70 71 72
/*
 * ehci_rh_state values of EHCI_RH_RUNNING or above mean that the
 * controller may be doing DMA.  Lower values mean there's no DMA.
 */
73 74 75
enum ehci_rh_state {
	EHCI_RH_HALTED,
	EHCI_RH_SUSPENDED,
76 77
	EHCI_RH_RUNNING,
	EHCI_RH_STOPPING
78 79
};

A
Alan Stern 已提交
80 81 82 83 84 85
/*
 * Timer events, ordered by increasing delay length.
 * Always update event_delays_ns[] and event_handlers[] (defined in
 * ehci-timer.c) in parallel with this list.
 */
enum ehci_hrtimer_event {
86
	EHCI_HRTIMER_POLL_ASS,		/* Poll for async schedule off */
87
	EHCI_HRTIMER_POLL_PSS,		/* Poll for periodic schedule off */
88
	EHCI_HRTIMER_POLL_DEAD,		/* Wait for dead controller to stop */
89
	EHCI_HRTIMER_UNLINK_INTR,	/* Wait for interrupt QH unlink */
90
	EHCI_HRTIMER_FREE_ITDS,		/* Wait for unused iTDs and siTDs */
91
	EHCI_HRTIMER_ASYNC_UNLINKS,	/* Unlink empty async QHs */
92
	EHCI_HRTIMER_IAA_WATCHDOG,	/* Handle lost IAA interrupts */
93
	EHCI_HRTIMER_DISABLE_PERIODIC,	/* Wait to disable periodic sched */
94
	EHCI_HRTIMER_DISABLE_ASYNC,	/* Wait to disable async sched */
95
	EHCI_HRTIMER_IO_WATCHDOG,	/* Check for missing IRQs */
A
Alan Stern 已提交
96 97 98 99
	EHCI_HRTIMER_NUM_EVENTS		/* Must come last */
};
#define EHCI_HRTIMER_NO_EVENT	99

L
Linus Torvalds 已提交
100
struct ehci_hcd {			/* one per controller */
A
Alan Stern 已提交
101 102 103 104 105 106
	/* timing support */
	enum ehci_hrtimer_event	next_hrtimer_event;
	unsigned		enabled_hrtimer_events;
	ktime_t			hr_timeouts[EHCI_HRTIMER_NUM_EVENTS];
	struct hrtimer		hrtimer;

107
	int			PSS_poll_count;
108
	int			ASS_poll_count;
109
	int			died_poll_count;
110

D
David Brownell 已提交
111 112 113 114 115 116
	/* glue to PCI and HCD framework */
	struct ehci_caps __iomem *caps;
	struct ehci_regs __iomem *regs;
	struct ehci_dbg_port __iomem *debug;

	__u32			hcs_params;	/* cached register copy */
L
Linus Torvalds 已提交
117
	spinlock_t		lock;
118
	enum ehci_rh_state	rh_state;
L
Linus Torvalds 已提交
119

120
	/* general schedule support */
121 122
	bool			scanning:1;
	bool			need_rescan:1;
123
	bool			intr_unlinking:1;
124
	bool			iaa_in_progress:1;
125
	bool			async_unlinking:1;
126
	bool			shutdown:1;
127
	struct ehci_qh		*qh_scan_next;
128

L
Linus Torvalds 已提交
129 130
	/* async schedule support */
	struct ehci_qh		*async;
131
	struct ehci_qh		*dummy;		/* For AMD quirk use */
132
	struct list_head	async_unlink;
133
	struct list_head	async_idle;
134
	unsigned		async_unlink_cycle;
135
	unsigned		async_count;	/* async activity count */
L
Linus Torvalds 已提交
136 137 138 139

	/* periodic schedule support */
#define	DEFAULT_I_TDPS		1024		/* some HCs can do less */
	unsigned		periodic_size;
140
	__hc32			*periodic;	/* hw periodic table */
L
Linus Torvalds 已提交
141
	dma_addr_t		periodic_dma;
142
	struct list_head	intr_qh_list;
L
Linus Torvalds 已提交
143 144 145
	unsigned		i_thresh;	/* uframes HC might cache */

	union ehci_shadow	*pshadow;	/* mirror hw periodic table */
146
	struct list_head	intr_unlink;
147
	unsigned		intr_unlink_cycle;
148
	unsigned		now_frame;	/* frame from HC hardware */
149
	unsigned		last_iso_frame;	/* last frame scanned for iso */
150 151
	unsigned		intr_count;	/* intr activity count */
	unsigned		isoc_count;	/* isoc activity count */
152
	unsigned		periodic_count;	/* periodic activity count */
153 154
	unsigned		uframe_periodic_max; /* max periodic time per uframe */

L
Linus Torvalds 已提交
155

156
	/* list of itds & sitds completed while now_frame was still active */
K
Karsten Wiese 已提交
157
	struct list_head	cached_itd_list;
158
	struct ehci_itd		*last_itd_to_free;
159
	struct list_head	cached_sitd_list;
160
	struct ehci_sitd	*last_sitd_to_free;
K
Karsten Wiese 已提交
161

L
Linus Torvalds 已提交
162 163
	/* per root hub port */
	unsigned long		reset_done [EHCI_MAX_ROOT_PORTS];
A
Alan Stern 已提交
164

165 166 167 168 169
	/* bit vectors (one bit per port) */
	unsigned long		bus_suspended;		/* which ports were
			already suspended at the start of a bus suspend */
	unsigned long		companion_ports;	/* which ports are
			dedicated to the companion controller */
A
Alan Stern 已提交
170 171
	unsigned long		owned_ports;		/* which ports are
			owned by the companion during a bus suspend */
172 173
	unsigned long		port_c_suspend;		/* which ports have
			the change-suspend feature turned on */
174 175
	unsigned long		suspended_ports;	/* which ports are
			suspended */
176 177
	unsigned long		resuming_ports;		/* which ports have
			started to resume */
L
Linus Torvalds 已提交
178 179 180 181 182 183 184

	/* per-HC memory pools (could be per-bus, but ...) */
	struct dma_pool		*qh_pool;	/* qh per active urb */
	struct dma_pool		*qtd_pool;	/* one or more per qh */
	struct dma_pool		*itd_pool;	/* itd per iso urb */
	struct dma_pool		*sitd_pool;	/* sitd per split iso urb */

185
	unsigned		random_frame;
L
Linus Torvalds 已提交
186
	unsigned long		next_statechange;
187
	ktime_t			last_periodic_enable;
L
Linus Torvalds 已提交
188 189
	u32			command;

190
	/* SILICON QUIRKS */
D
David Brownell 已提交
191
	unsigned		no_selective_suspend:1;
192
	unsigned		has_fsl_port_bug:1; /* FreeScale */
193
	unsigned		big_endian_mmio:1;
194
	unsigned		big_endian_desc:1;
195
	unsigned		big_endian_capbase:1;
196
	unsigned		has_amcc_usb23:1;
197
	unsigned		need_io_watchdog:1;
198
	unsigned		amd_pll_fix:1;
199
	unsigned		use_dummy_qh:1;	/* AMD Frame List table quirk*/
200
	unsigned		has_synopsys_hc_bug:1; /* Synopsys HC */
201
	unsigned		frame_index_bug:1; /* MosChip (AKA NetMos) */
202 203 204 205 206 207 208 209 210

	/* required for usb32 quirk */
	#define OHCI_CTRL_HCFS          (3 << 6)
	#define OHCI_USB_OPER           (2 << 6)
	#define OHCI_USB_SUSPEND        (3 << 6)

	#define OHCI_HCCTRL_OFFSET      0x4
	#define OHCI_HCCTRL_LEN         0x4
	__hc32			*ohci_hcctrl_reg;
211
	unsigned		has_hostpc:1;
212
	unsigned		has_ppcd:1; /* support per-port change bits */
D
David Brownell 已提交
213
	u8			sbrn;		/* packed release number */
L
Linus Torvalds 已提交
214 215 216 217 218 219 220

	/* irq statistics */
#ifdef EHCI_STATS
	struct ehci_stats	stats;
#	define COUNT(x) do { (x)++; } while (0)
#else
#	define COUNT(x) do {} while (0)
221 222 223 224 225
#endif

	/* debug files */
#ifdef DEBUG
	struct dentry		*debug_dir;
L
Linus Torvalds 已提交
226
#endif
227 228 229

	/* platform-specific data -- must come last */
	unsigned long		priv[0] __aligned(sizeof(s64));
L
Linus Torvalds 已提交
230 231
};

232
/* convert between an HCD pointer and the corresponding EHCI_HCD */
L
Linus Torvalds 已提交
233 234 235 236 237 238 239 240 241 242 243
static inline struct ehci_hcd *hcd_to_ehci (struct usb_hcd *hcd)
{
	return (struct ehci_hcd *) (hcd->hcd_priv);
}
static inline struct usb_hcd *ehci_to_hcd (struct ehci_hcd *ehci)
{
	return container_of ((void *) ehci, struct usb_hcd, hcd_priv);
}

/*-------------------------------------------------------------------------*/

Y
Yinghai Lu 已提交
244
#include <linux/usb/ehci_def.h>
L
Linus Torvalds 已提交
245 246 247

/*-------------------------------------------------------------------------*/

248
#define	QTD_NEXT(ehci, dma)	cpu_to_hc32(ehci, (u32)dma)
L
Linus Torvalds 已提交
249 250 251

/*
 * EHCI Specification 0.95 Section 3.5
252
 * QTD: describe data transfer components (buffer, direction, ...)
L
Linus Torvalds 已提交
253 254 255 256 257 258 259
 * See Fig 3-6 "Queue Element Transfer Descriptor Block Diagram".
 *
 * These are associated only with "QH" (Queue Head) structures,
 * used with control, bulk, and interrupt transfers.
 */
struct ehci_qtd {
	/* first part defined by EHCI spec */
260 261 262
	__hc32			hw_next;	/* see EHCI 3.5.1 */
	__hc32			hw_alt_next;    /* see EHCI 3.5.2 */
	__hc32			hw_token;       /* see EHCI 3.5.3 */
L
Linus Torvalds 已提交
263 264 265 266 267 268 269 270 271 272 273 274 275
#define	QTD_TOGGLE	(1 << 31)	/* data toggle */
#define	QTD_LENGTH(tok)	(((tok)>>16) & 0x7fff)
#define	QTD_IOC		(1 << 15)	/* interrupt on complete */
#define	QTD_CERR(tok)	(((tok)>>10) & 0x3)
#define	QTD_PID(tok)	(((tok)>>8) & 0x3)
#define	QTD_STS_ACTIVE	(1 << 7)	/* HC may execute this */
#define	QTD_STS_HALT	(1 << 6)	/* halted on error */
#define	QTD_STS_DBE	(1 << 5)	/* data buffer error (in HC) */
#define	QTD_STS_BABBLE	(1 << 4)	/* device was babbling (qtd halted) */
#define	QTD_STS_XACT	(1 << 3)	/* device gave illegal response */
#define	QTD_STS_MMF	(1 << 2)	/* incomplete split transaction */
#define	QTD_STS_STS	(1 << 1)	/* split transaction state */
#define	QTD_STS_PING	(1 << 0)	/* issue PING? */
276 277 278 279 280 281 282

#define ACTIVE_BIT(ehci)	cpu_to_hc32(ehci, QTD_STS_ACTIVE)
#define HALT_BIT(ehci)		cpu_to_hc32(ehci, QTD_STS_HALT)
#define STATUS_BIT(ehci)	cpu_to_hc32(ehci, QTD_STS_STS)

	__hc32			hw_buf [5];        /* see EHCI 3.5.4 */
	__hc32			hw_buf_hi [5];        /* Appendix B */
L
Linus Torvalds 已提交
283 284 285 286 287 288 289 290 291

	/* the rest is HCD-private */
	dma_addr_t		qtd_dma;		/* qtd address */
	struct list_head	qtd_list;		/* sw qtd list */
	struct urb		*urb;			/* qtd's urb */
	size_t			length;			/* length of buffer */
} __attribute__ ((aligned (32)));

/* mask NakCnt+T in qh->hw_alt_next */
292
#define QTD_MASK(ehci)	cpu_to_hc32 (ehci, ~0x1f)
L
Linus Torvalds 已提交
293 294 295 296 297 298

#define IS_SHORT_READ(token) (QTD_LENGTH (token) != 0 && QTD_PID (token) == 1)

/*-------------------------------------------------------------------------*/

/* type tag from {qh,itd,sitd,fstn}->hw_next */
299
#define Q_NEXT_TYPE(ehci,dma)	((dma) & cpu_to_hc32(ehci, 3 << 1))
L
Linus Torvalds 已提交
300

301 302
/*
 * Now the following defines are not converted using the
303
 * cpu_to_le32() macro anymore, since we have to support
304 305 306 307
 * "dynamic" switching between be and le support, so that the driver
 * can be used on one system with SoC EHCI controller using big-endian
 * descriptors as well as a normal little-endian PCI EHCI controller.
 */
L
Linus Torvalds 已提交
308
/* values for that type tag */
309 310 311 312
#define Q_TYPE_ITD	(0 << 1)
#define Q_TYPE_QH	(1 << 1)
#define Q_TYPE_SITD	(2 << 1)
#define Q_TYPE_FSTN	(3 << 1)
L
Linus Torvalds 已提交
313 314

/* next async queue entry, or pointer to interrupt/periodic QH */
315
#define QH_NEXT(ehci,dma)	(cpu_to_hc32(ehci, (((u32)dma)&~0x01f)|Q_TYPE_QH))
L
Linus Torvalds 已提交
316 317

/* for periodic/async schedules and qtd lists, mark end of list */
318
#define EHCI_LIST_END(ehci)	cpu_to_hc32(ehci, 1) /* "null pointer" to hw */
L
Linus Torvalds 已提交
319 320 321 322 323 324 325 326 327 328

/*
 * Entries in periodic shadow table are pointers to one of four kinds
 * of data structure.  That's dictated by the hardware; a type tag is
 * encoded in the low bits of the hardware's periodic schedule.  Use
 * Q_NEXT_TYPE to get the tag.
 *
 * For entries in the async schedule, the type tag always says "qh".
 */
union ehci_shadow {
329
	struct ehci_qh		*qh;		/* Q_TYPE_QH */
L
Linus Torvalds 已提交
330 331 332
	struct ehci_itd		*itd;		/* Q_TYPE_ITD */
	struct ehci_sitd	*sitd;		/* Q_TYPE_SITD */
	struct ehci_fstn	*fstn;		/* Q_TYPE_FSTN */
333
	__hc32			*hw_next;	/* (all types) */
L
Linus Torvalds 已提交
334 335 336 337 338 339 340 341 342 343 344 345 346
	void			*ptr;
};

/*-------------------------------------------------------------------------*/

/*
 * EHCI Specification 0.95 Section 3.6
 * QH: describes control/bulk/interrupt endpoints
 * See Fig 3-7 "Queue Head Structure Layout".
 *
 * These appear in both the async and (for interrupt) periodic schedules.
 */

347 348
/* first part defined by EHCI spec */
struct ehci_qh_hw {
349 350
	__hc32			hw_next;	/* see EHCI 3.6.1 */
	__hc32			hw_info1;       /* see EHCI 3.6.2 */
351 352 353 354 355 356 357
#define	QH_CONTROL_EP	(1 << 27)	/* FS/LS control endpoint */
#define	QH_HEAD		(1 << 15)	/* Head of async reclamation list */
#define	QH_TOGGLE_CTL	(1 << 14)	/* Data toggle control */
#define	QH_HIGH_SPEED	(2 << 12)	/* Endpoint speed */
#define	QH_LOW_SPEED	(1 << 12)
#define	QH_FULL_SPEED	(0 << 12)
#define	QH_INACTIVATE	(1 << 7)	/* Inactivate on next transaction */
358
	__hc32			hw_info2;        /* see EHCI 3.6.2 */
359 360 361 362 363
#define	QH_SMASK	0x000000ff
#define	QH_CMASK	0x0000ff00
#define	QH_HUBADDR	0x007f0000
#define	QH_HUBPORT	0x3f800000
#define	QH_MULT		0xc0000000
364
	__hc32			hw_current;	/* qtd list - see EHCI 3.6.4 */
365

L
Linus Torvalds 已提交
366
	/* qtd overlay (hardware parts of a struct ehci_qtd) */
367 368 369 370 371
	__hc32			hw_qtd_next;
	__hc32			hw_alt_next;
	__hc32			hw_token;
	__hc32			hw_buf [5];
	__hc32			hw_buf_hi [5];
372
} __attribute__ ((aligned(32)));
L
Linus Torvalds 已提交
373

374
struct ehci_qh {
375
	struct ehci_qh_hw	*hw;		/* Must come first */
L
Linus Torvalds 已提交
376 377 378 379
	/* the rest is HCD-private */
	dma_addr_t		qh_dma;		/* address of qh */
	union ehci_shadow	qh_next;	/* ptr to qh; or periodic */
	struct list_head	qtd_list;	/* sw qtd list */
380
	struct list_head	intr_node;	/* list of intr QHs */
L
Linus Torvalds 已提交
381
	struct ehci_qtd		*dummy;
382
	struct list_head	unlink_node;
L
Linus Torvalds 已提交
383

384
	unsigned		unlink_cycle;
L
Linus Torvalds 已提交
385 386 387 388 389

	u8			qh_state;
#define	QH_STATE_LINKED		1		/* HC sees this */
#define	QH_STATE_UNLINK		2		/* HC may still see this */
#define	QH_STATE_IDLE		3		/* HC doesn't see this */
A
Alan Stern 已提交
390
#define	QH_STATE_UNLINK_WAIT	4		/* LINKED and on unlink q */
L
Linus Torvalds 已提交
391 392
#define	QH_STATE_COMPLETING	5		/* don't touch token.HALT */

393 394 395
	u8			xacterrs;	/* XactErr retry counter */
#define	QH_XACTERR_MAX		32		/* XactErr retry limit */

L
Linus Torvalds 已提交
396 397 398 399
	/* periodic schedule info */
	u8			usecs;		/* intr bandwidth */
	u8			gap_uf;		/* uframes split/csplit gap */
	u8			c_usecs;	/* ... split completion bw */
D
david-b@pacbell.net 已提交
400
	u16			tt_usecs;	/* tt downstream bandwidth */
L
Linus Torvalds 已提交
401 402 403
	unsigned short		period;		/* polling interval */
	unsigned short		start;		/* where polling starts */
#define NO_FRAME ((unsigned short)~0)			/* pick new start */
404

L
Linus Torvalds 已提交
405
	struct usb_device	*dev;		/* access to TT */
406
	unsigned		is_out:1;	/* bulk or intr OUT */
407
	unsigned		clearing_tt:1;	/* Clear-TT-Buf in progress */
408 409 410
	unsigned		dequeue_during_giveback:1;
	unsigned		exception:1;	/* got a fault, or an unlink
						   was requested */
411
};
L
Linus Torvalds 已提交
412 413 414 415 416 417 418

/*-------------------------------------------------------------------------*/

/* description of one iso transaction (up to 3 KB data if highspeed) */
struct ehci_iso_packet {
	/* These will be copied to iTD when scheduling */
	u64			bufp;		/* itd->hw_bufp{,_hi}[pg] |= */
419
	__hc32			transaction;	/* itd->hw_transaction[i] |= */
L
Linus Torvalds 已提交
420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439
	u8			cross;		/* buf crosses pages */
	/* for full speed OUT splits */
	u32			buf1;
};

/* temporary schedule data for packets from iso urbs (both speeds)
 * each packet is one logical usb transaction to the device (not TT),
 * beginning at stream->next_uframe
 */
struct ehci_iso_sched {
	struct list_head	td_list;
	unsigned		span;
	struct ehci_iso_packet	packet [0];
};

/*
 * ehci_iso_stream - groups all (s)itds for this endpoint.
 * acts like a qh would, if EHCI had them for ISO.
 */
struct ehci_iso_stream {
440 441
	/* first field matches ehci_hq, but is NULL */
	struct ehci_qh_hw	*hw;
L
Linus Torvalds 已提交
442 443 444 445 446 447

	u8			bEndpointAddress;
	u8			highspeed;
	struct list_head	td_list;	/* queued itds/sitds */
	struct list_head	free_list;	/* list of unused itds/sitds */
	struct usb_device	*udev;
448
	struct usb_host_endpoint *ep;
L
Linus Torvalds 已提交
449 450 451

	/* output of (re)scheduling */
	int			next_uframe;
452
	__hc32			splits;
L
Linus Torvalds 已提交
453 454 455 456 457 458

	/* the rest is derived from the endpoint descriptor,
	 * trusting urb->interval == f(epdesc->bInterval) and
	 * including the extra info for hw_bufp[0..2]
	 */
	u8			usecs, c_usecs;
459
	u16			interval;
D
david-b@pacbell.net 已提交
460
	u16			tt_usecs;
L
Linus Torvalds 已提交
461 462 463 464 465
	u16			maxp;
	u16			raw_mask;
	unsigned		bandwidth;

	/* This is used to initialize iTD's hw_bufp fields */
466 467 468
	__hc32			buf0;
	__hc32			buf1;
	__hc32			buf2;
L
Linus Torvalds 已提交
469 470

	/* this is used to initialize sITD's tt info */
471
	__hc32			address;
L
Linus Torvalds 已提交
472 473 474 475 476 477 478 479 480 481 482 483
};

/*-------------------------------------------------------------------------*/

/*
 * EHCI Specification 0.95 Section 3.3
 * Fig 3-4 "Isochronous Transaction Descriptor (iTD)"
 *
 * Schedule records for high speed iso xfers
 */
struct ehci_itd {
	/* first part defined by EHCI spec */
484 485
	__hc32			hw_next;           /* see EHCI 3.3.1 */
	__hc32			hw_transaction [8]; /* see EHCI 3.3.2 */
L
Linus Torvalds 已提交
486 487 488 489 490 491 492
#define EHCI_ISOC_ACTIVE        (1<<31)        /* activate transfer this slot */
#define EHCI_ISOC_BUF_ERR       (1<<30)        /* Data buffer error */
#define EHCI_ISOC_BABBLE        (1<<29)        /* babble detected */
#define EHCI_ISOC_XACTERR       (1<<28)        /* XactErr - transaction error */
#define	EHCI_ITD_LENGTH(tok)	(((tok)>>16) & 0x0fff)
#define	EHCI_ITD_IOC		(1 << 15)	/* interrupt on complete */

493
#define ITD_ACTIVE(ehci)	cpu_to_hc32(ehci, EHCI_ISOC_ACTIVE)
L
Linus Torvalds 已提交
494

495 496
	__hc32			hw_bufp [7];	/* see EHCI 3.3.3 */
	__hc32			hw_bufp_hi [7];	/* Appendix B */
L
Linus Torvalds 已提交
497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514

	/* the rest is HCD-private */
	dma_addr_t		itd_dma;	/* for this itd */
	union ehci_shadow	itd_next;	/* ptr to periodic q entry */

	struct urb		*urb;
	struct ehci_iso_stream	*stream;	/* endpoint's queue */
	struct list_head	itd_list;	/* list of stream's itds */

	/* any/all hw_transactions here may be used by that urb */
	unsigned		frame;		/* where scheduled */
	unsigned		pg;
	unsigned		index[8];	/* in urb->iso_frame_desc */
} __attribute__ ((aligned (32)));

/*-------------------------------------------------------------------------*/

/*
515
 * EHCI Specification 0.95 Section 3.4
L
Linus Torvalds 已提交
516 517 518 519 520 521
 * siTD, aka split-transaction isochronous Transfer Descriptor
 *       ... describe full speed iso xfers through TT in hubs
 * see Figure 3-5 "Split-transaction Isochronous Transaction Descriptor (siTD)
 */
struct ehci_sitd {
	/* first part defined by EHCI spec */
522
	__hc32			hw_next;
L
Linus Torvalds 已提交
523
/* uses bit field macros above - see EHCI 0.95 Table 3-8 */
524 525 526
	__hc32			hw_fullspeed_ep;	/* EHCI table 3-9 */
	__hc32			hw_uframe;		/* EHCI table 3-10 */
	__hc32			hw_results;		/* EHCI table 3-11 */
L
Linus Torvalds 已提交
527 528 529 530 531 532 533 534 535 536 537
#define	SITD_IOC	(1 << 31)	/* interrupt on completion */
#define	SITD_PAGE	(1 << 30)	/* buffer 0/1 */
#define	SITD_LENGTH(x)	(0x3ff & ((x)>>16))
#define	SITD_STS_ACTIVE	(1 << 7)	/* HC may execute this */
#define	SITD_STS_ERR	(1 << 6)	/* error from TT */
#define	SITD_STS_DBE	(1 << 5)	/* data buffer error (in HC) */
#define	SITD_STS_BABBLE	(1 << 4)	/* device was babbling */
#define	SITD_STS_XACT	(1 << 3)	/* illegal IN response */
#define	SITD_STS_MMF	(1 << 2)	/* incomplete split transaction */
#define	SITD_STS_STS	(1 << 1)	/* split transaction state */

538
#define SITD_ACTIVE(ehci)	cpu_to_hc32(ehci, SITD_STS_ACTIVE)
L
Linus Torvalds 已提交
539

540 541 542
	__hc32			hw_buf [2];		/* EHCI table 3-12 */
	__hc32			hw_backpointer;		/* EHCI table 3-13 */
	__hc32			hw_buf_hi [2];		/* Appendix B */
L
Linus Torvalds 已提交
543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566

	/* the rest is HCD-private */
	dma_addr_t		sitd_dma;
	union ehci_shadow	sitd_next;	/* ptr to periodic q entry */

	struct urb		*urb;
	struct ehci_iso_stream	*stream;	/* endpoint's queue */
	struct list_head	sitd_list;	/* list of stream's sitds */
	unsigned		frame;
	unsigned		index;
} __attribute__ ((aligned (32)));

/*-------------------------------------------------------------------------*/

/*
 * EHCI Specification 0.96 Section 3.7
 * Periodic Frame Span Traversal Node (FSTN)
 *
 * Manages split interrupt transactions (using TT) that span frame boundaries
 * into uframes 0/1; see 4.12.2.2.  In those uframes, a "save place" FSTN
 * makes the HC jump (back) to a QH to scan for fs/ls QH completions until
 * it hits a "restore" FSTN; then it returns to finish other uframe 0/1 work.
 */
struct ehci_fstn {
567 568
	__hc32			hw_next;	/* any periodic q entry */
	__hc32			hw_prev;	/* qh or EHCI_LIST_END */
L
Linus Torvalds 已提交
569 570 571 572 573 574 575 576

	/* the rest is HCD-private */
	dma_addr_t		fstn_dma;
	union ehci_shadow	fstn_next;	/* ptr to periodic q entry */
} __attribute__ ((aligned (32)));

/*-------------------------------------------------------------------------*/

577 578
/* Prepare the PORTSC wakeup flags during controller suspend/resume */

579 580
#define ehci_prepare_ports_for_controller_suspend(ehci, do_wakeup)	\
		ehci_adjust_port_wakeup_flags(ehci, true, do_wakeup);
581

582 583
#define ehci_prepare_ports_for_controller_resume(ehci)			\
		ehci_adjust_port_wakeup_flags(ehci, false, false);
584 585 586

/*-------------------------------------------------------------------------*/

L
Linus Torvalds 已提交
587 588 589 590 591 592 593 594 595
#ifdef CONFIG_USB_EHCI_ROOT_HUB_TT

/*
 * Some EHCI controllers have a Transaction Translator built into the
 * root hub. This is a non-standard feature.  Each controller will need
 * to add code to the following inline functions, and call them as
 * needed (mostly in root hub code).
 */

A
Alan Stern 已提交
596
#define	ehci_is_TDI(e)			(ehci_to_hcd(e)->has_tt)
L
Linus Torvalds 已提交
597 598 599 600 601 602

/* Returns the speed of a device attached to a port on the root hub. */
static inline unsigned int
ehci_port_speed(struct ehci_hcd *ehci, unsigned int portsc)
{
	if (ehci_is_TDI(ehci)) {
603
		switch ((portsc >> (ehci->has_hostpc ? 25 : 26)) & 3) {
L
Linus Torvalds 已提交
604 605 606
		case 0:
			return 0;
		case 1:
607
			return USB_PORT_STAT_LOW_SPEED;
L
Linus Torvalds 已提交
608 609
		case 2:
		default:
610
			return USB_PORT_STAT_HIGH_SPEED;
L
Linus Torvalds 已提交
611 612
		}
	}
613
	return USB_PORT_STAT_HIGH_SPEED;
L
Linus Torvalds 已提交
614 615 616 617 618 619
}

#else

#define	ehci_is_TDI(e)			(0)

620
#define	ehci_port_speed(ehci, portsc)	USB_PORT_STAT_HIGH_SPEED
L
Linus Torvalds 已提交
621 622
#endif

623 624 625 626 627 628 629 630 631 632 633
/*-------------------------------------------------------------------------*/

#ifdef CONFIG_PPC_83xx
/* Some Freescale processors have an erratum in which the TT
 * port number in the queue head was 0..N-1 instead of 1..N.
 */
#define	ehci_has_fsl_portno_bug(e)		((e)->has_fsl_port_bug)
#else
#define	ehci_has_fsl_portno_bug(e)		(0)
#endif

634 635 636 637 638 639 640 641
/*
 * While most USB host controllers implement their registers in
 * little-endian format, a minority (celleb companion chip) implement
 * them in big endian format.
 *
 * This attempts to support either format at compile time without a
 * runtime penalty, or both formats with the additional overhead
 * of checking a flag bit.
642 643 644 645
 *
 * ehci_big_endian_capbase is a special quirk for controllers that
 * implement the HC capability registers as separate registers and not
 * as fields of a 32-bit register.
646 647 648 649
 */

#ifdef CONFIG_USB_EHCI_BIG_ENDIAN_MMIO
#define ehci_big_endian_mmio(e)		((e)->big_endian_mmio)
650
#define ehci_big_endian_capbase(e)	((e)->big_endian_capbase)
651 652
#else
#define ehci_big_endian_mmio(e)		0
653
#define ehci_big_endian_capbase(e)	0
654 655
#endif

656 657 658 659
/*
 * Big-endian read/write functions are arch-specific.
 * Other arches can be added if/when they're needed.
 */
V
Vladimir Barinov 已提交
660 661 662 663 664
#if defined(CONFIG_ARM) && defined(CONFIG_ARCH_IXP4XX)
#define readl_be(addr)		__raw_readl((__force unsigned *)addr)
#define writel_be(val, addr)	__raw_writel(val, (__force unsigned *)addr)
#endif

665 666
static inline unsigned int ehci_readl(const struct ehci_hcd *ehci,
		__u32 __iomem * regs)
667
{
B
Benjamin Herrenschmidt 已提交
668
#ifdef CONFIG_USB_EHCI_BIG_ENDIAN_MMIO
669
	return ehci_big_endian_mmio(ehci) ?
670 671
		readl_be(regs) :
		readl(regs);
B
Benjamin Herrenschmidt 已提交
672
#else
673
	return readl(regs);
B
Benjamin Herrenschmidt 已提交
674
#endif
675 676
}

677 678
static inline void ehci_writel(const struct ehci_hcd *ehci,
		const unsigned int val, __u32 __iomem *regs)
679
{
B
Benjamin Herrenschmidt 已提交
680
#ifdef CONFIG_USB_EHCI_BIG_ENDIAN_MMIO
681
	ehci_big_endian_mmio(ehci) ?
682 683
		writel_be(val, regs) :
		writel(val, regs);
B
Benjamin Herrenschmidt 已提交
684
#else
685
	writel(val, regs);
B
Benjamin Herrenschmidt 已提交
686
#endif
687
}
688

689 690 691
/*
 * On certain ppc-44x SoC there is a HW issue, that could only worked around with
 * explicit suspend/operate of OHCI. This function hereby makes sense only on that arch.
L
Lucas De Marchi 已提交
692
 * Other common bits are dependent on has_amcc_usb23 quirk flag.
693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712
 */
#ifdef CONFIG_44x
static inline void set_ohci_hcfs(struct ehci_hcd *ehci, int operational)
{
	u32 hc_control;

	hc_control = (readl_be(ehci->ohci_hcctrl_reg) & ~OHCI_CTRL_HCFS);
	if (operational)
		hc_control |= OHCI_USB_OPER;
	else
		hc_control |= OHCI_USB_SUSPEND;

	writel_be(hc_control, ehci->ohci_hcctrl_reg);
	(void) readl_be(ehci->ohci_hcctrl_reg);
}
#else
static inline void set_ohci_hcfs(struct ehci_hcd *ehci, int operational)
{ }
#endif

L
Linus Torvalds 已提交
713 714
/*-------------------------------------------------------------------------*/

715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770
/*
 * The AMCC 440EPx not only implements its EHCI registers in big-endian
 * format, but also its DMA data structures (descriptors).
 *
 * EHCI controllers accessed through PCI work normally (little-endian
 * everywhere), so we won't bother supporting a BE-only mode for now.
 */
#ifdef CONFIG_USB_EHCI_BIG_ENDIAN_DESC
#define ehci_big_endian_desc(e)		((e)->big_endian_desc)

/* cpu to ehci */
static inline __hc32 cpu_to_hc32 (const struct ehci_hcd *ehci, const u32 x)
{
	return ehci_big_endian_desc(ehci)
		? (__force __hc32)cpu_to_be32(x)
		: (__force __hc32)cpu_to_le32(x);
}

/* ehci to cpu */
static inline u32 hc32_to_cpu (const struct ehci_hcd *ehci, const __hc32 x)
{
	return ehci_big_endian_desc(ehci)
		? be32_to_cpu((__force __be32)x)
		: le32_to_cpu((__force __le32)x);
}

static inline u32 hc32_to_cpup (const struct ehci_hcd *ehci, const __hc32 *x)
{
	return ehci_big_endian_desc(ehci)
		? be32_to_cpup((__force __be32 *)x)
		: le32_to_cpup((__force __le32 *)x);
}

#else

/* cpu to ehci */
static inline __hc32 cpu_to_hc32 (const struct ehci_hcd *ehci, const u32 x)
{
	return cpu_to_le32(x);
}

/* ehci to cpu */
static inline u32 hc32_to_cpu (const struct ehci_hcd *ehci, const __hc32 x)
{
	return le32_to_cpu(x);
}

static inline u32 hc32_to_cpup (const struct ehci_hcd *ehci, const __hc32 *x)
{
	return le32_to_cpup(x);
}

#endif

/*-------------------------------------------------------------------------*/

771 772 773 774 775 776 777 778 779 780 781 782 783 784 785
#define ehci_dbg(ehci, fmt, args...) \
	dev_dbg(ehci_to_hcd(ehci)->self.controller , fmt , ## args)
#define ehci_err(ehci, fmt, args...) \
	dev_err(ehci_to_hcd(ehci)->self.controller , fmt , ## args)
#define ehci_info(ehci, fmt, args...) \
	dev_info(ehci_to_hcd(ehci)->self.controller , fmt , ## args)
#define ehci_warn(ehci, fmt, args...) \
	dev_warn(ehci_to_hcd(ehci)->self.controller , fmt , ## args)

#ifdef VERBOSE_DEBUG
#	define ehci_vdbg ehci_dbg
#else
	static inline void ehci_vdbg(struct ehci_hcd *ehci, ...) {}
#endif

L
Linus Torvalds 已提交
786 787 788 789 790 791
#ifndef DEBUG
#define STUB_DEBUG_FILES
#endif	/* DEBUG */

/*-------------------------------------------------------------------------*/

792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807
/* Declarations of things exported for use by ehci platform drivers */

struct ehci_driver_overrides {
	size_t		extra_priv_size;
	int		(*reset)(struct usb_hcd *hcd);
};

extern void	ehci_init_driver(struct hc_driver *drv,
				const struct ehci_driver_overrides *over);
extern int	ehci_setup(struct usb_hcd *hcd);

#ifdef CONFIG_PM
extern int	ehci_suspend(struct usb_hcd *hcd, bool do_wakeup);
extern int	ehci_resume(struct usb_hcd *hcd, bool hibernated);
#endif	/* CONFIG_PM */

L
Linus Torvalds 已提交
808
#endif /* __LINUX_EHCI_HCD_H */