Home | History | Annotate | Download | only in usb
      1 /* SPDX-License-Identifier: GPL-2.0+ */
      2 /*
      3  * Copyright (c) 2005, 2009 Freescale Semiconductor, Inc
      4  * Copyright (c) 2005 MontaVista Software
      5  * Copyright (c) 2008 Excito Elektronik i Sk=E5ne AB
      6  */
      7 
      8 #ifndef _EHCI_CI_H
      9 #define _EHCI_CI_H
     10 
     11 #include <asm/processor.h>
     12 
     13 #define CONTROL_REGISTER_W1C_MASK       0x00020000  /* W1C: PHY_CLK_VALID */
     14 
     15 /* Global offsets */
     16 #define FSL_SKIP_PCI		0x100
     17 
     18 /* offsets for the non-ehci registers in the FSL SOC USB controller */
     19 #define FSL_SOC_USB_ULPIVP	0x170
     20 #define FSL_SOC_USB_PORTSC1	0x184
     21 #define PORT_PTS_MSK		(3 << 30)
     22 #define PORT_PTS_UTMI		(0 << 30)
     23 #define PORT_PTS_ULPI		(2 << 30)
     24 #define PORT_PTS_SERIAL		(3 << 30)
     25 #define PORT_PTS_PTW		(1 << 28)
     26 #define PORT_PFSC		(1 << 24) /* Defined on Page 39-44 of the mpc5151 ERM */
     27 #define PORT_PTS_PHCD		(1 << 23)
     28 #define PORT_PP			(1 << 12)
     29 #define PORT_PR			(1 << 8)
     30 
     31 /* USBMODE Register bits */
     32 #define CM_IDLE			(0 << 0)
     33 #define CM_RESERVED		(1 << 0)
     34 #define CM_DEVICE		(2 << 0)
     35 #define CM_HOST			(3 << 0)
     36 #define ES_BE			(1 << 2)	/* Big Endian Select, default is LE */
     37 #define USBMODE_RESERVED_2	(0 << 2)
     38 #define SLOM			(1 << 3)
     39 #define SDIS			(1 << 4)
     40 
     41 /* CONTROL Register bits */
     42 #define ULPI_INT_EN		(1 << 0)
     43 #define WU_INT_EN		(1 << 1)
     44 #define USB_EN			(1 << 2)
     45 #define LSF_EN			(1 << 3)
     46 #define KEEP_OTG_ON		(1 << 4)
     47 #define OTG_PORT		(1 << 5)
     48 #define REFSEL_12MHZ		(0 << 6)
     49 #define REFSEL_16MHZ		(1 << 6)
     50 #define REFSEL_48MHZ		(2 << 6)
     51 #define PLL_RESET		(1 << 8)
     52 #define UTMI_PHY_EN		(1 << 9)
     53 #define PHY_CLK_SEL_UTMI	(0 << 10)
     54 #define PHY_CLK_SEL_ULPI	(1 << 10)
     55 #define CLKIN_SEL_USB_CLK	(0 << 11)
     56 #define CLKIN_SEL_USB_CLK2	(1 << 11)
     57 #define CLKIN_SEL_SYS_CLK	(2 << 11)
     58 #define CLKIN_SEL_SYS_CLK2	(3 << 11)
     59 #define RESERVED_18		(0 << 13)
     60 #define RESERVED_17		(0 << 14)
     61 #define RESERVED_16		(0 << 15)
     62 #define WU_INT			(1 << 16)
     63 #define PHY_CLK_VALID		(1 << 17)
     64 
     65 #define FSL_SOC_USB_PORTSC2	0x188
     66 
     67 /* OTG Status Control Register bits */
     68 #define FSL_SOC_USB_OTGSC	0x1a4
     69 #define CTRL_VBUS_DISCHARGE	(0x1<<0)
     70 #define CTRL_VBUS_CHARGE	(0x1<<1)
     71 #define CTRL_OTG_TERMINATION	(0x1<<3)
     72 #define CTRL_DATA_PULSING	(0x1<<4)
     73 #define CTRL_ID_PULL_EN		(0x1<<5)
     74 #define HA_DATA_PULSE		(0x1<<6)
     75 #define HA_BA			(0x1<<7)
     76 #define STS_USB_ID		(0x1<<8)
     77 #define STS_A_VBUS_VALID	(0x1<<9)
     78 #define STS_A_SESSION_VALID	(0x1<<10)
     79 #define STS_B_SESSION_VALID	(0x1<<11)
     80 #define STS_B_SESSION_END	(0x1<<12)
     81 #define STS_1MS_TOGGLE		(0x1<<13)
     82 #define STS_DATA_PULSING	(0x1<<14)
     83 #define INTSTS_USB_ID		(0x1<<16)
     84 #define INTSTS_A_VBUS_VALID	(0x1<<17)
     85 #define INTSTS_A_SESSION_VALID	(0x1<<18)
     86 #define INTSTS_B_SESSION_VALID	(0x1<<19)
     87 #define INTSTS_B_SESSION_END	(0x1<<20)
     88 #define INTSTS_1MS		(0x1<<21)
     89 #define INTSTS_DATA_PULSING	(0x1<<22)
     90 #define INTR_USB_ID_EN		(0x1<<24)
     91 #define INTR_A_VBUS_VALID_EN	(0x1<<25)
     92 #define INTR_A_SESSION_VALID_EN (0x1<<26)
     93 #define INTR_B_SESSION_VALID_EN (0x1<<27)
     94 #define INTR_B_SESSION_END_EN	(0x1<<28)
     95 #define INTR_1MS_TIMER_EN	(0x1<<29)
     96 #define INTR_DATA_PULSING_EN	(0x1<<30)
     97 #define INTSTS_MASK		(0x00ff0000)
     98 
     99 #define  INTERRUPT_ENABLE_BITS_MASK  \
    100 		(INTR_USB_ID_EN		| \
    101 		INTR_1MS_TIMER_EN	| \
    102 		INTR_A_VBUS_VALID_EN	| \
    103 		INTR_A_SESSION_VALID_EN | \
    104 		INTR_B_SESSION_VALID_EN | \
    105 		INTR_B_SESSION_END_EN	| \
    106 		INTR_DATA_PULSING_EN)
    107 
    108 #define  INTERRUPT_STATUS_BITS_MASK  \
    109 		(INTSTS_USB_ID		| \
    110 		INTR_1MS_TIMER_EN	| \
    111 		INTSTS_A_VBUS_VALID	| \
    112 		INTSTS_A_SESSION_VALID  | \
    113 		INTSTS_B_SESSION_VALID  | \
    114 		INTSTS_B_SESSION_END	| \
    115 		INTSTS_DATA_PULSING)
    116 
    117 #define FSL_SOC_USB_USBMODE	0x1a8
    118 
    119 #define USBGENCTRL		0x200		/* NOTE: big endian */
    120 #define GC_WU_INT_CLR		(1 << 5)	/* Wakeup int clear */
    121 #define GC_ULPI_SEL		(1 << 4)	/* ULPI i/f select (usb0 only)*/
    122 #define GC_PPP			(1 << 3)	/* Port Power Polarity */
    123 #define GC_PFP			(1 << 2)	/* Power Fault Polarity */
    124 #define GC_WU_ULPI_EN		(1 << 1)	/* Wakeup on ULPI event */
    125 #define GC_WU_IE		(1 << 1)	/* Wakeup interrupt enable */
    126 
    127 #define ISIPHYCTRL		0x204		/* NOTE: big endian */
    128 #define PHYCTRL_PHYE		(1 << 4)	/* On-chip UTMI PHY enable */
    129 #define PHYCTRL_BSENH		(1 << 3)	/* Bit Stuff Enable High */
    130 #define PHYCTRL_BSEN		(1 << 2)	/* Bit Stuff Enable */
    131 #define PHYCTRL_LSFE		(1 << 1)	/* Line State Filter Enable */
    132 #define PHYCTRL_PXE		(1 << 0)	/* PHY oscillator enable */
    133 
    134 #define FSL_SOC_USB_SNOOP1	0x400	/* NOTE: big-endian */
    135 #define FSL_SOC_USB_SNOOP2	0x404	/* NOTE: big-endian */
    136 #define FSL_SOC_USB_AGECNTTHRSH	0x408	/* NOTE: big-endian */
    137 #define FSL_SOC_USB_PRICTRL	0x40c	/* NOTE: big-endian */
    138 #define FSL_SOC_USB_SICTRL	0x410	/* NOTE: big-endian */
    139 #define FSL_SOC_USB_CTRL	0x500	/* NOTE: big-endian */
    140 #define SNOOP_SIZE_2GB		0x1e
    141 
    142 /* System Clock Control Register */
    143 #define MPC83XX_SCCR_USB_MASK		0x00f00000
    144 #define MPC83XX_SCCR_USB_DRCM_11	0x00300000
    145 #define MPC83XX_SCCR_USB_DRCM_01	0x00100000
    146 #define MPC83XX_SCCR_USB_DRCM_10	0x00200000
    147 
    148 #if defined(CONFIG_MPC83xx)
    149 #define CONFIG_SYS_FSL_USB1_ADDR CONFIG_SYS_MPC83xx_USB1_ADDR
    150 #if defined(CONFIG_MPC834x)
    151 #define CONFIG_SYS_FSL_USB2_ADDR CONFIG_SYS_MPC83xx_USB2_ADDR
    152 #else
    153 #define CONFIG_SYS_FSL_USB2_ADDR	0
    154 #endif
    155 #elif defined(CONFIG_MPC85xx)
    156 #define CONFIG_SYS_FSL_USB1_ADDR CONFIG_SYS_MPC85xx_USB1_ADDR
    157 #define CONFIG_SYS_FSL_USB2_ADDR CONFIG_SYS_MPC85xx_USB2_ADDR
    158 #elif defined(CONFIG_ARCH_LS1021A) || defined(CONFIG_ARCH_LS1012A)
    159 #define CONFIG_SYS_FSL_USB1_ADDR CONFIG_SYS_EHCI_USB1_ADDR
    160 #define CONFIG_SYS_FSL_USB2_ADDR        0
    161 #endif
    162 
    163 /*
    164  * Increasing TX FIFO threshold value from 2 to 4 decreases
    165  * data burst rate with which data packets are posted from the TX
    166  * latency FIFO to compensate for latencies in DDR pipeline during DMA
    167  */
    168 #define TXFIFOTHRESH		4
    169 
    170 /*
    171  * USB Registers
    172  */
    173 struct usb_ehci {
    174 	u32	id;		/* 0x000 - Identification register */
    175 	u32	hwgeneral;	/* 0x004 - General hardware parameters */
    176 	u32	hwhost;		/* 0x008 - Host hardware parameters */
    177 	u32	hwdevice;	/* 0x00C - Device hardware parameters  */
    178 	u32	hwtxbuf;	/* 0x010 - TX buffer hardware parameters */
    179 	u32	hwrxbuf;	/* 0x014 - RX buffer hardware parameters */
    180 	u8	res1[0x68];
    181 	u32	gptimer0_ld;	/* 0x080 - General Purpose Timer 0 load value */
    182 	u32	gptimer0_ctrl;	/* 0x084 - General Purpose Timer 0 control */
    183 	u32     gptimer1_ld;	/* 0x088 - General Purpose Timer 1 load value */
    184 	u32     gptimer1_ctrl;	/* 0x08C - General Purpose Timer 1 control */
    185 	u32	sbuscfg;	/* 0x090 - System Bus Interface Control */
    186 	u32	sbusstatus;	/* 0x094 - System Bus Interface Status */
    187 	u32	sbusmode;	/* 0x098 - System Bus Interface Mode */
    188 	u32	genconfig;	/* 0x09C - USB Core Configuration */
    189 	u32	genconfig2;	/* 0x0A0 - USB Core Configuration 2 */
    190 	u8	res2[0x5c];
    191 	u8	caplength;	/* 0x100 - Capability Register Length */
    192 	u8	res3[0x1];
    193 	u16	hciversion;	/* 0x102 - Host Interface Version */
    194 	u32	hcsparams;	/* 0x104 - Host Structural Parameters */
    195 	u32	hccparams;	/* 0x108 - Host Capability Parameters */
    196 	u8	res4[0x14];
    197 	u32	dciversion;	/* 0x120 - Device Interface Version */
    198 	u32	dciparams;	/* 0x124 - Device Controller Params */
    199 	u8	res5[0x18];
    200 	u32	usbcmd;		/* 0x140 - USB Command */
    201 	u32	usbsts;		/* 0x144 - USB Status */
    202 	u32	usbintr;	/* 0x148 - USB Interrupt Enable */
    203 	u32	frindex;	/* 0x14C - USB Frame Index */
    204 	u8	res6[0x4];
    205 	u32	perlistbase;	/* 0x154 - Periodic List Base
    206 					 - USB Device Address */
    207 	u32	ep_list_addr;	/* 0x158 - Next Asynchronous List
    208 					 - End Point Address */
    209 	u8	res7[0x4];
    210 	u32	burstsize;	/* 0x160 - Programmable Burst Size */
    211 #define FSL_EHCI_TXPBURST(X)	((X) << 8)
    212 #define FSL_EHCI_RXPBURST(X)	(X)
    213 	u32	txfilltuning;	/* 0x164 - Host TT Transmit
    214 					   pre-buffer packet tuning */
    215 	u8	res8[0x8];
    216 	u32	ulpi_viewpoint;	/* 0x170 - ULPI Reister Access */
    217 	u8	res9[0xc];
    218 	u32	config_flag;	/* 0x180 - Configured Flag Register */
    219 	u32	portsc;		/* 0x184 - Port status/control */
    220 	u8	res10[0x1C];
    221 	u32	otgsc;		/* 0x1a4 - Oo-The-Go status and control */
    222 	u32	usbmode;	/* 0x1a8 - USB Device Mode */
    223 	u32	epsetupstat;	/* 0x1ac - End Point Setup Status */
    224 	u32	epprime;	/* 0x1b0 - End Point Init Status */
    225 	u32	epflush;	/* 0x1b4 - End Point De-initlialize */
    226 	u32	epstatus;	/* 0x1b8 - End Point Status */
    227 	u32	epcomplete;	/* 0x1bc - End Point Complete */
    228 	u32	epctrl0;	/* 0x1c0 - End Point Control 0 */
    229 	u32	epctrl1;	/* 0x1c4 - End Point Control 1 */
    230 	u32	epctrl2;	/* 0x1c8 - End Point Control 2 */
    231 	u32	epctrl3;	/* 0x1cc - End Point Control 3 */
    232 	u32	epctrl4;	/* 0x1d0 - End Point Control 4 */
    233 	u32	epctrl5;	/* 0x1d4 - End Point Control 5 */
    234 	u8	res11[0x28];
    235 	u32	usbgenctrl;	/* 0x200 - USB General Control */
    236 	u32	isiphyctrl;	/* 0x204 - On-Chip PHY Control */
    237 	u8	res12[0x1F8];
    238 	u32	snoop1;		/* 0x400 - Snoop 1 */
    239 	u32	snoop2;		/* 0x404 - Snoop 2 */
    240 	u32	age_cnt_limit;	/* 0x408 - Age Count Threshold */
    241 	u32	prictrl;	/* 0x40c - Priority Control */
    242 	u32	sictrl;		/* 0x410 - System Interface Control */
    243 	u8	res13[0xEC];
    244 	u32	control;	/* 0x500 - Control */
    245 	u8	res14[0xafc];
    246 };
    247 
    248 /*
    249  * For MXC SOCs
    250  */
    251 
    252 /* values for portsc field */
    253 #define MXC_EHCI_PHY_LOW_POWER_SUSPEND	(1 << 23)
    254 #define MXC_EHCI_FORCE_FS		(1 << 24)
    255 #define MXC_EHCI_UTMI_8BIT		(0 << 28)
    256 #define MXC_EHCI_UTMI_16BIT		(1 << 28)
    257 #define MXC_EHCI_SERIAL			(1 << 29)
    258 #define MXC_EHCI_MODE_UTMI		(0 << 30)
    259 #define MXC_EHCI_MODE_PHILIPS		(1 << 30)
    260 #define MXC_EHCI_MODE_ULPI		(2 << 30)
    261 #define MXC_EHCI_MODE_SERIAL		(3 << 30)
    262 
    263 /* values for flags field */
    264 #define MXC_EHCI_INTERFACE_DIFF_UNI	(0 << 0)
    265 #define MXC_EHCI_INTERFACE_DIFF_BI	(1 << 0)
    266 #define MXC_EHCI_INTERFACE_SINGLE_UNI	(2 << 0)
    267 #define MXC_EHCI_INTERFACE_SINGLE_BI	(3 << 0)
    268 #define MXC_EHCI_INTERFACE_MASK		(0xf)
    269 
    270 #define MXC_EHCI_POWER_PINS_ENABLED	(1 << 5)
    271 #define MXC_EHCI_PWR_PIN_ACTIVE_HIGH	(1 << 6)
    272 #define MXC_EHCI_OC_PIN_ACTIVE_LOW	(1 << 7)
    273 #define MXC_EHCI_TTL_ENABLED		(1 << 8)
    274 
    275 #define MXC_EHCI_INTERNAL_PHY		(1 << 9)
    276 #define MXC_EHCI_IPPUE_DOWN		(1 << 10)
    277 #define MXC_EHCI_IPPUE_UP		(1 << 11)
    278 
    279 int usb_phy_mode(int port);
    280 /* Board-specific initialization */
    281 int board_ehci_hcd_init(int port);
    282 int board_ehci_power(int port, int on);
    283 int board_usb_phy_mode(int port);
    284 
    285 #endif /* _EHCI_CI_H */
    286