ehci.h 10.4 KB
Newer Older
1
/* SPDX-License-Identifier: GPL-2.0 */
Michael Trimarchi's avatar
Michael Trimarchi committed
2
3
/*-
 * Copyright (c) 2007-2008, Juniper Networks, Inc.
Remy Böhmer's avatar
Remy Böhmer committed
4
 * Copyright (c) 2008, Michael Trimarchi <trimarchimichael@yahoo.it>
Michael Trimarchi's avatar
Michael Trimarchi committed
5
6
7
8
9
10
 * All rights reserved.
 */

#ifndef USB_EHCI_H
#define USB_EHCI_H

11
#include <stdbool.h>
12
#include <usb.h>
13
#include <generic-phy.h>
14

15
16
/* Section 2.2.3 - N_PORTS */
#define MAX_HC_PORTS		15
Remy Böhmer's avatar
Remy Böhmer committed
17

Michael Trimarchi's avatar
Michael Trimarchi committed
18
19
20
21
/*
 * Register Space.
 */
struct ehci_hccr {
22
23
24
	uint32_t cr_capbase;
#define HC_LENGTH(p)		(((p) >> 0) & 0x00ff)
#define HC_VERSION(p)		(((p) >> 16) & 0xffff)
Michael Trimarchi's avatar
Michael Trimarchi committed
25
	uint32_t cr_hcsparams;
Remy Böhmer's avatar
Remy Böhmer committed
26
27
#define HCS_PPC(p)		((p) & (1 << 4))
#define HCS_INDICATOR(p)	((p) & (1 << 16)) /* Port indicators */
28
#define HCS_N_PORTS(p)		(((p) >> 0) & 0xf)
Michael Trimarchi's avatar
Michael Trimarchi committed
29
30
	uint32_t cr_hccparams;
	uint8_t cr_hcsp_portrt[8];
31
} __attribute__ ((packed, aligned(4)));
Michael Trimarchi's avatar
Michael Trimarchi committed
32
33
34

struct ehci_hcor {
	uint32_t or_usbcmd;
35
36
37
#define CMD_PARK	(1 << 11)		/* enable "park" */
#define CMD_PARK_CNT(c)	(((c) >> 8) & 3)	/* how many transfers to park */
#define CMD_LRESET	(1 << 7)		/* partial reset */
38
39
#define CMD_IAAD	(1 << 6)		/* "doorbell" interrupt */
#define CMD_ASE		(1 << 5)		/* async schedule enable */
40
41
42
#define CMD_PSE		(1 << 4)		/* periodic schedule enable */
#define CMD_RESET	(1 << 1)		/* reset HC not bus */
#define CMD_RUN		(1 << 0)		/* start/stop HC */
Michael Trimarchi's avatar
Michael Trimarchi committed
43
	uint32_t or_usbsts;
44
#define STS_ASS		(1 << 15)
45
#define	STS_PSS		(1 << 14)
46
#define STS_HALT	(1 << 12)
47
#define STS_IAA		(1 << 5)
Michael Trimarchi's avatar
Michael Trimarchi committed
48
	uint32_t or_usbintr;
Damien Dusha's avatar
Damien Dusha committed
49
50
51
52
53
#define INTR_UE         (1 << 0)                /* USB interrupt enable */
#define INTR_UEE        (1 << 1)                /* USB error interrupt enable */
#define INTR_PCE        (1 << 2)                /* Port change detect enable */
#define INTR_SEE        (1 << 4)                /* system error enable */
#define INTR_AAE        (1 << 5)                /* Interrupt on async adavance enable */
Michael Trimarchi's avatar
Michael Trimarchi committed
54
55
56
57
	uint32_t or_frindex;
	uint32_t or_ctrldssegment;
	uint32_t or_periodiclistbase;
	uint32_t or_asynclistaddr;
58
59
60
	uint32_t _reserved_0_;
	uint32_t or_burstsize;
	uint32_t or_txfilltuning;
61
#define TXFIFO_THRESH_MASK		(0x3f << 16)
62
63
#define TXFIFO_THRESH(p)		((p & 0x3f) << 16)
	uint32_t _reserved_1_[6];
Michael Trimarchi's avatar
Michael Trimarchi committed
64
	uint32_t or_configflag;
65
#define FLAG_CF		(1 << 0)	/* true:  we'll support "high speed" */
66
	uint32_t or_portsc[MAX_HC_PORTS];
67
68
69
70
#define PORTSC_PSPD(x)		(((x) >> 26) & 0x3)
#define PORTSC_PSPD_FS			0x0
#define PORTSC_PSPD_LS			0x1
#define PORTSC_PSPD_HS			0x2
71
72
#define PORTSC_FSL_PFSC		BIT(24) /* PFSC bit to disable HS chirping */

Michael Trimarchi's avatar
Michael Trimarchi committed
73
	uint32_t or_systune;
74
} __attribute__ ((packed, aligned(4)));
Michael Trimarchi's avatar
Michael Trimarchi committed
75

76
77
78
79
80
81
#define USBMODE		0x68		/* USB Device mode */
#define USBMODE_SDIS	(1 << 3)	/* Stream disable */
#define USBMODE_BE	(1 << 2)	/* BE/LE endiannes select */
#define USBMODE_CM_HC	(3 << 0)	/* host controller mode */
#define USBMODE_CM_IDLE	(0 << 0)	/* idle state */

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
/* Interface descriptor */
struct usb_linux_interface_descriptor {
	unsigned char	bLength;
	unsigned char	bDescriptorType;
	unsigned char	bInterfaceNumber;
	unsigned char	bAlternateSetting;
	unsigned char	bNumEndpoints;
	unsigned char	bInterfaceClass;
	unsigned char	bInterfaceSubClass;
	unsigned char	bInterfaceProtocol;
	unsigned char	iInterface;
} __attribute__ ((packed));

/* Configuration descriptor information.. */
struct usb_linux_config_descriptor {
	unsigned char	bLength;
	unsigned char	bDescriptorType;
	unsigned short	wTotalLength;
	unsigned char	bNumInterfaces;
	unsigned char	bConfigurationValue;
	unsigned char	iConfiguration;
	unsigned char	bmAttributes;
	unsigned char	MaxPower;
} __attribute__ ((packed));

#if defined CONFIG_EHCI_DESC_BIG_ENDIAN
108
109
#define ehci_readl(x)		be32_to_cpu(__raw_readl(x))
#define ehci_writel(a, b)	__raw_writel(cpu_to_be32(b), a)
110
#else
111
112
#define ehci_readl(x)		readl(x)
#define ehci_writel(a, b)	writel(b, a)
113
114
115
116
117
118
119
120
121
122
#endif

#if defined CONFIG_EHCI_MMIO_BIG_ENDIAN
#define hc32_to_cpu(x)		be32_to_cpu((x))
#define cpu_to_hc32(x)		cpu_to_be32((x))
#else
#define hc32_to_cpu(x)		le32_to_cpu((x))
#define cpu_to_hc32(x)		cpu_to_le32((x))
#endif

Remy Böhmer's avatar
Remy Böhmer committed
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
#define EHCI_PS_WKOC_E		(1 << 22)	/* RW wake on over current */
#define EHCI_PS_WKDSCNNT_E	(1 << 21)	/* RW wake on disconnect */
#define EHCI_PS_WKCNNT_E	(1 << 20)	/* RW wake on connect */
#define EHCI_PS_PO		(1 << 13)	/* RW port owner */
#define EHCI_PS_PP		(1 << 12)	/* RW,RO port power */
#define EHCI_PS_LS		(3 << 10)	/* RO line status */
#define EHCI_PS_PR		(1 << 8)	/* RW port reset */
#define EHCI_PS_SUSP		(1 << 7)	/* RW suspend */
#define EHCI_PS_FPR		(1 << 6)	/* RW force port resume */
#define EHCI_PS_OCC		(1 << 5)	/* RWC over current change */
#define EHCI_PS_OCA		(1 << 4)	/* RO over current active */
#define EHCI_PS_PEC		(1 << 3)	/* RWC port enable change */
#define EHCI_PS_PE		(1 << 2)	/* RW port enable */
#define EHCI_PS_CSC		(1 << 1)	/* RWC connect status change */
#define EHCI_PS_CS		(1 << 0)	/* RO connect status */
Michael Trimarchi's avatar
Michael Trimarchi committed
138
139
#define EHCI_PS_CLEAR		(EHCI_PS_OCC | EHCI_PS_PEC | EHCI_PS_CSC)

Remy Böhmer's avatar
Remy Böhmer committed
140
#define EHCI_PS_IS_LOWSPEED(x)	(((x) & EHCI_PS_LS) == (1 << 10))
Michael Trimarchi's avatar
Michael Trimarchi committed
141
142
143
144
145
146
147
148
149
150
151
152
153

/*
 * Schedule Interface Space.
 *
 * IMPORTANT: Software must ensure that no interface data structure
 * reachable by the EHCI host controller spans a 4K page boundary!
 *
 * Periodic transfers (i.e. isochronous and interrupt transfers) are
 * not supported.
 */

/* Queue Element Transfer Descriptor (qTD). */
struct qTD {
154
	/* this part defined by EHCI spec */
155
	uint32_t qt_next;			/* see EHCI 3.5.1 */
Michael Trimarchi's avatar
Michael Trimarchi committed
156
#define	QT_NEXT_TERMINATE	1
157
158
	uint32_t qt_altnext;			/* see EHCI 3.5.2 */
	uint32_t qt_token;			/* see EHCI 3.5.3 */
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
#define QT_TOKEN_DT(x)		(((x) & 0x1) << 31)	/* Data Toggle */
#define QT_TOKEN_GET_DT(x)		(((x) >> 31) & 0x1)
#define QT_TOKEN_TOTALBYTES(x)	(((x) & 0x7fff) << 16)	/* Total Bytes to Transfer */
#define QT_TOKEN_GET_TOTALBYTES(x)	(((x) >> 16) & 0x7fff)
#define QT_TOKEN_IOC(x)		(((x) & 0x1) << 15)	/* Interrupt On Complete */
#define QT_TOKEN_CPAGE(x)	(((x) & 0x7) << 12)	/* Current Page */
#define QT_TOKEN_CERR(x)	(((x) & 0x3) << 10)	/* Error Counter */
#define QT_TOKEN_PID(x)		(((x) & 0x3) << 8)	/* PID Code */
#define QT_TOKEN_PID_OUT		0x0
#define QT_TOKEN_PID_IN			0x1
#define QT_TOKEN_PID_SETUP		0x2
#define QT_TOKEN_STATUS(x)	(((x) & 0xff) << 0)	/* Status */
#define QT_TOKEN_GET_STATUS(x)		(((x) >> 0) & 0xff)
#define QT_TOKEN_STATUS_ACTIVE		0x80
#define QT_TOKEN_STATUS_HALTED		0x40
#define QT_TOKEN_STATUS_DATBUFERR	0x20
#define QT_TOKEN_STATUS_BABBLEDET	0x10
#define QT_TOKEN_STATUS_XACTERR		0x08
#define QT_TOKEN_STATUS_MISSEDUFRAME	0x04
#define QT_TOKEN_STATUS_SPLITXSTATE	0x02
#define QT_TOKEN_STATUS_PERR		0x01
180
181
182
#define QT_BUFFER_CNT		5
	uint32_t qt_buffer[QT_BUFFER_CNT];	/* see EHCI 3.5.4 */
	uint32_t qt_buffer_hi[QT_BUFFER_CNT];	/* Appendix B */
183
184
	/* pad struct for 32 byte alignment */
	uint32_t unused[3];
185
};
Michael Trimarchi's avatar
Michael Trimarchi committed
186

187
188
#define EHCI_PAGE_SIZE		4096

Michael Trimarchi's avatar
Michael Trimarchi committed
189
190
191
192
193
194
195
196
197
/* Queue Head (QH). */
struct QH {
	uint32_t qh_link;
#define	QH_LINK_TERMINATE	1
#define	QH_LINK_TYPE_ITD	0
#define	QH_LINK_TYPE_QH		2
#define	QH_LINK_TYPE_SITD	4
#define	QH_LINK_TYPE_FSTN	6
	uint32_t qh_endpt1;
198
199
200
201
202
203
204
205
206
207
208
209
210
211
#define QH_ENDPT1_RL(x)		(((x) & 0xf) << 28)	/* NAK Count Reload */
#define QH_ENDPT1_C(x)		(((x) & 0x1) << 27)	/* Control Endpoint Flag */
#define QH_ENDPT1_MAXPKTLEN(x)	(((x) & 0x7ff) << 16)	/* Maximum Packet Length */
#define QH_ENDPT1_H(x)		(((x) & 0x1) << 15)	/* Head of Reclamation List Flag */
#define QH_ENDPT1_DTC(x)	(((x) & 0x1) << 14)	/* Data Toggle Control */
#define QH_ENDPT1_DTC_IGNORE_QTD_TD	0x0
#define QH_ENDPT1_DTC_DT_FROM_QTD	0x1
#define QH_ENDPT1_EPS(x)	(((x) & 0x3) << 12)	/* Endpoint Speed */
#define QH_ENDPT1_EPS_FS		0x0
#define QH_ENDPT1_EPS_LS		0x1
#define QH_ENDPT1_EPS_HS		0x2
#define QH_ENDPT1_ENDPT(x)	(((x) & 0xf) << 8)	/* Endpoint Number */
#define QH_ENDPT1_I(x)		(((x) & 0x1) << 7)	/* Inactivate on Next Transaction */
#define QH_ENDPT1_DEVADDR(x)	(((x) & 0x7f) << 0)	/* Device Address */
Michael Trimarchi's avatar
Michael Trimarchi committed
212
	uint32_t qh_endpt2;
213
214
215
216
217
#define QH_ENDPT2_MULT(x)	(((x) & 0x3) << 30)	/* High-Bandwidth Pipe Multiplier */
#define QH_ENDPT2_PORTNUM(x)	(((x) & 0x7f) << 23)	/* Port Number */
#define QH_ENDPT2_HUBADDR(x)	(((x) & 0x7f) << 16)	/* Hub Address */
#define QH_ENDPT2_UFCMASK(x)	(((x) & 0xff) << 8)	/* Split Completion Mask */
#define QH_ENDPT2_UFSMASK(x)	(((x) & 0xff) << 0)	/* Interrupt Schedule Mask */
Michael Trimarchi's avatar
Michael Trimarchi committed
218
219
	uint32_t qh_curtd;
	struct qTD qh_overlay;
220
221
222
223
	/*
	 * Add dummy fill value to make the size of this struct
	 * aligned to 32 bytes
	 */
224
	union {
225
		uint32_t fill[4];
226
227
		void *buffer;
	};
Michael Trimarchi's avatar
Michael Trimarchi committed
228
229
};

Simon Glass's avatar
Simon Glass committed
230
231
232
233
234
235
/* Tweak flags for EHCI, used to control operation */
enum {
	/* don't use or_configflag in init */
	EHCI_TWEAK_NO_INIT_CF		= 1 << 0,
};

236
237
238
239
240
241
242
243
struct ehci_ctrl;

struct ehci_ops {
	void (*set_usb_mode)(struct ehci_ctrl *ctrl);
	int (*get_port_speed)(struct ehci_ctrl *ctrl, uint32_t reg);
	void (*powerup_fixup)(struct ehci_ctrl *ctrl, uint32_t *status_reg,
			      uint32_t *reg);
	uint32_t *(*get_portsc_register)(struct ehci_ctrl *ctrl, int port);
244
	int (*init_after_reset)(struct ehci_ctrl *ctrl);
245
246
};

247
struct ehci_ctrl {
Stephen Warren's avatar
Stephen Warren committed
248
	enum usb_init_type init;
249
250
251
252
253
254
255
	struct ehci_hccr *hccr;	/* R/O registers, not need for volatile */
	struct ehci_hcor *hcor;
	int rootdev;
	uint16_t portreset;
	struct QH qh_list __aligned(USB_DMA_MINALIGN);
	struct QH periodic_queue __aligned(USB_DMA_MINALIGN);
	uint32_t *periodic_list;
256
	int periodic_schedules;
257
	int ntds;
258
	bool has_fsl_erratum_a005275;	/* Freescale HS silicon quirk */
259
	bool async_locked;
260
	struct ehci_ops ops;
261
	void *priv;	/* client's private data */
262
263
};

264
/**
265
 * ehci_set_controller_info() - Set up private data for the controller
266
267
268
 *
 * This function can be called in ehci_hcd_init() to tell the EHCI layer
 * about the controller's private data pointer. Then in the above functions
269
270
 * this can be accessed given the struct ehci_ctrl pointer. Also special
 * EHCI operation methods can be provided if required
271
272
273
 *
 * @index:	Controller number to set
 * @priv:	Controller pointer
274
 * @ops:	Controller operations, or NULL to use default
275
 */
276
277
void ehci_set_controller_priv(int index, void *priv,
			      const struct ehci_ops *ops);
278
279
280
281
282
283
284
285
286

/**
 * ehci_get_controller_priv() - Get controller private data
 *
 * @index	Controller number to get
 * @return controller pointer for this index
 */
void *ehci_get_controller_priv(int index);

Remy Böhmer's avatar
Remy Böhmer committed
287
/* Low level init functions */
288
289
int ehci_hcd_init(int index, enum usb_init_type init,
		struct ehci_hccr **hccr, struct ehci_hcor **hcor);
290
int ehci_hcd_stop(int index);
Remy Böhmer's avatar
Remy Böhmer committed
291

292
293
294
295
296
297
int ehci_register(struct udevice *dev, struct ehci_hccr *hccr,
		  struct ehci_hcor *hcor, const struct ehci_ops *ops,
		  uint tweaks, enum usb_init_type init);
int ehci_deregister(struct udevice *dev);
extern struct dm_usb_ops ehci_usb_ops;

298
299
300
301
/* EHCI PHY functions */
int ehci_setup_phy(struct udevice *dev, struct phy *phy, int index);
int ehci_shutdown_phy(struct udevice *dev, struct phy *phy);

302
#include <linux/bitops.h>
Michael Trimarchi's avatar
Michael Trimarchi committed
303
#endif /* USB_EHCI_H */