Merge tag 'efi-2023-01-rc1-4' of https://source.denx.de/u-boot/custodians/u-boot-efi
[platform/kernel/u-boot.git] / include / fsl_esdhc.h
1 /* SPDX-License-Identifier: GPL-2.0+ */
2 /*
3  * FSL SD/MMC Defines
4  *-------------------------------------------------------------------
5  *
6  * Copyright 2007-2008,2010-2011 Freescale Semiconductor, Inc
7  * Copyright 2020 NXP
8  */
9
10 #ifndef  __FSL_ESDHC_H__
11 #define __FSL_ESDHC_H__
12
13 #include <linux/errno.h>
14 #include <asm/byteorder.h>
15
16 /* needed for the mmc_cfg definition */
17 #include <mmc.h>
18
19 /* FSL eSDHC-specific constants */
20 #define SYSCTL                  0x0002e02c
21 #define SYSCTL_INITA            0x08000000
22 #define SYSCTL_TIMEOUT_MASK     0x000f0000
23 #define SYSCTL_CLOCK_MASK       0x0000fff0
24 #define SYSCTL_CKEN             0x00000008
25 #define SYSCTL_PEREN            0x00000004
26 #define SYSCTL_HCKEN            0x00000002
27 #define SYSCTL_IPGEN            0x00000001
28 #define SYSCTL_RSTA             0x01000000
29 #define SYSCTL_RSTC             0x02000000
30 #define SYSCTL_RSTD             0x04000000
31
32 #define IRQSTAT                 0x0002e030
33 #define IRQSTAT_DMAE            (0x10000000)
34 #define IRQSTAT_AC12E           (0x01000000)
35 #define IRQSTAT_DEBE            (0x00400000)
36 #define IRQSTAT_DCE             (0x00200000)
37 #define IRQSTAT_DTOE            (0x00100000)
38 #define IRQSTAT_CIE             (0x00080000)
39 #define IRQSTAT_CEBE            (0x00040000)
40 #define IRQSTAT_CCE             (0x00020000)
41 #define IRQSTAT_CTOE            (0x00010000)
42 #define IRQSTAT_CINT            (0x00000100)
43 #define IRQSTAT_CRM             (0x00000080)
44 #define IRQSTAT_CINS            (0x00000040)
45 #define IRQSTAT_BRR             (0x00000020)
46 #define IRQSTAT_BWR             (0x00000010)
47 #define IRQSTAT_DINT            (0x00000008)
48 #define IRQSTAT_BGE             (0x00000004)
49 #define IRQSTAT_TC              (0x00000002)
50 #define IRQSTAT_CC              (0x00000001)
51
52 #define CMD_ERR         (IRQSTAT_CIE | IRQSTAT_CEBE | IRQSTAT_CCE)
53 #define DATA_ERR        (IRQSTAT_DEBE | IRQSTAT_DCE | IRQSTAT_DTOE | \
54                                 IRQSTAT_DMAE)
55 #define DATA_COMPLETE   (IRQSTAT_TC | IRQSTAT_DINT)
56
57 #define IRQSTATEN               0x0002e034
58 #define IRQSTATEN_DMAE          (0x10000000)
59 #define IRQSTATEN_AC12E         (0x01000000)
60 #define IRQSTATEN_DEBE          (0x00400000)
61 #define IRQSTATEN_DCE           (0x00200000)
62 #define IRQSTATEN_DTOE          (0x00100000)
63 #define IRQSTATEN_CIE           (0x00080000)
64 #define IRQSTATEN_CEBE          (0x00040000)
65 #define IRQSTATEN_CCE           (0x00020000)
66 #define IRQSTATEN_CTOE          (0x00010000)
67 #define IRQSTATEN_CINT          (0x00000100)
68 #define IRQSTATEN_CRM           (0x00000080)
69 #define IRQSTATEN_CINS          (0x00000040)
70 #define IRQSTATEN_BRR           (0x00000020)
71 #define IRQSTATEN_BWR           (0x00000010)
72 #define IRQSTATEN_DINT          (0x00000008)
73 #define IRQSTATEN_BGE           (0x00000004)
74 #define IRQSTATEN_TC            (0x00000002)
75 #define IRQSTATEN_CC            (0x00000001)
76
77 /* eSDHC control register */
78 #define ESDHCCTL                0x0002e40c
79 #define ESDHCCTL_SNOOP          (0x00000040)
80 #define ESDHCCTL_PCS            (0x00080000)
81 #define ESDHCCTL_FAF            (0x00040000)
82
83 #define PRSSTAT                 0x0002e024
84 #define PRSSTAT_DAT0            (0x01000000)
85 #define PRSSTAT_CLSL            (0x00800000)
86 #define PRSSTAT_WPSPL           (0x00080000)
87 #define PRSSTAT_CDPL            (0x00040000)
88 #define PRSSTAT_CINS            (0x00010000)
89 #define PRSSTAT_BREN            (0x00000800)
90 #define PRSSTAT_BWEN            (0x00000400)
91 #define PRSSTAT_SDSTB           (0X00000008)
92 #define PRSSTAT_DLA             (0x00000004)
93 #define PRSSTAT_CICHB           (0x00000002)
94 #define PRSSTAT_CIDHB           (0x00000001)
95
96 #define PROCTL                  0x0002e028
97 #define PROCTL_INIT             0x00000020
98 #define PROCTL_DTW_4            0x00000002
99 #define PROCTL_DTW_8            0x00000004
100 #define PROCTL_D3CD             0x00000008
101 #define PROCTL_DMAS_MASK        0x00000300
102 #define PROCTL_DMAS_SDMA        0x00000000
103 #define PROCTL_DMAS_ADMA1       0x00000100
104 #define PROCTL_DMAS_ADMA2       0x00000300
105 #define PROCTL_VOLT_SEL         0x00000400
106
107 #define CMDARG                  0x0002e008
108
109 #define XFERTYP                 0x0002e00c
110 #define XFERTYP_CMD(x)          ((x & 0x3f) << 24)
111 #define XFERTYP_CMDTYP_NORMAL   0x0
112 #define XFERTYP_CMDTYP_SUSPEND  0x00400000
113 #define XFERTYP_CMDTYP_RESUME   0x00800000
114 #define XFERTYP_CMDTYP_ABORT    0x00c00000
115 #define XFERTYP_DPSEL           0x00200000
116 #define XFERTYP_CICEN           0x00100000
117 #define XFERTYP_CCCEN           0x00080000
118 #define XFERTYP_RSPTYP_NONE     0
119 #define XFERTYP_RSPTYP_136      0x00010000
120 #define XFERTYP_RSPTYP_48       0x00020000
121 #define XFERTYP_RSPTYP_48_BUSY  0x00030000
122 #define XFERTYP_MSBSEL          0x00000020
123 #define XFERTYP_DTDSEL          0x00000010
124 #define XFERTYP_DDREN           0x00000008
125 #define XFERTYP_AC12EN          0x00000004
126 #define XFERTYP_BCEN            0x00000002
127 #define XFERTYP_DMAEN           0x00000001
128
129 #define CINS_TIMEOUT            1000
130 #define PIO_TIMEOUT             500
131
132 #define DSADDR          0x2e004
133
134 #define CMDRSP0         0x2e010
135 #define CMDRSP1         0x2e014
136 #define CMDRSP2         0x2e018
137 #define CMDRSP3         0x2e01c
138
139 #define DATPORT         0x2e020
140
141 #define WML             0x2e044
142 #define WML_WRITE       0x00010000
143 #ifdef CONFIG_FSL_SDHC_V2_3
144 #define WML_RD_WML_MAX          0x80
145 #define WML_WR_WML_MAX          0x80
146 #define WML_RD_WML_MAX_VAL      0x0
147 #define WML_WR_WML_MAX_VAL      0x0
148 #define WML_RD_WML_MASK         0x7f
149 #define WML_WR_WML_MASK         0x7f0000
150 #else
151 #define WML_RD_WML_MAX          0x10
152 #define WML_WR_WML_MAX          0x80
153 #define WML_RD_WML_MAX_VAL      0x10
154 #define WML_WR_WML_MAX_VAL      0x80
155 #define WML_RD_WML_MASK 0xff
156 #define WML_WR_WML_MASK 0xff0000
157 #endif
158
159 #define BLKATTR         0x2e004
160 #define BLKATTR_CNT(x)  ((x & 0xffff) << 16)
161 #define BLKATTR_SIZE(x) (x & 0x1fff)
162 #define MAX_BLK_CNT     0x7fff  /* so malloc will have enough room with 32M */
163
164 /* Auto CMD error status register / system control 2 register */
165 #define EXECUTE_TUNING          0x00400000
166 #define SMPCLKSEL               0x00800000
167 #define UHSM_MASK               0x00070000
168 #define UHSM_SDR104_HS200       0x00030000
169
170 /* Host controller capabilities register */
171 #define HOSTCAPBLT_VS18         0x04000000
172 #define HOSTCAPBLT_VS30         0x02000000
173 #define HOSTCAPBLT_VS33         0x01000000
174 #define HOSTCAPBLT_SRS          0x00800000
175 #define HOSTCAPBLT_DMAS         0x00400000
176 #define HOSTCAPBLT_HSS          0x00200000
177
178 /* Tuning block control register */
179 #define TBCTL_TB_EN             0x00000004
180 #define HS400_MODE              0x00000010
181 #define HS400_WNDW_ADJUST       0x00000040
182
183 /* SD clock control register */
184 #define CMD_CLK_CTL             0x00008000
185
186 /* SD timing control register */
187 #define FLW_CTL_BG              0x00008000
188
189 /* DLL config 0 register */
190 #define DLL_ENABLE              0x80000000
191 #define DLL_RESET               0x40000000
192 #define DLL_FREQ_SEL            0x08000000
193
194 /* DLL config 1 register */
195 #define DLL_PD_PULSE_STRETCH_SEL 0x80000000
196
197 /* DLL status 0 register */
198 #define DLL_STS_SLV_LOCK        0x08000000
199
200 #define MAX_TUNING_LOOP         40
201
202 #define HOSTVER_VENDOR(x)       (((x) >> 8) & 0xff)
203 #define VENDOR_V_10             0x00
204 #define VENDOR_V_20             0x10
205 #define VENDOR_V_21             0x11
206 #define VENDOR_V_22             0x12
207 #define VENDOR_V_23             0x13
208 #define VENDOR_V_30             0x20
209 #define VENDOR_V_31             0x21
210 #define VENDOR_V_32             0x22
211
212 struct fsl_esdhc_cfg {
213         phys_addr_t esdhc_base;
214         u32     sdhc_clk;
215         u8      max_bus_width;
216         int     vs18_enable; /* Use 1.8V if set to 1 */
217         struct mmc_config cfg;
218 };
219
220 /* Select the correct accessors depending on endianess */
221 #if defined CONFIG_SYS_FSL_ESDHC_LE
222 #define esdhc_read32            in_le32
223 #define esdhc_write32           out_le32
224 #define esdhc_clrsetbits32      clrsetbits_le32
225 #define esdhc_clrbits32         clrbits_le32
226 #define esdhc_setbits32         setbits_le32
227 #elif defined(CONFIG_SYS_FSL_ESDHC_BE)
228 #define esdhc_read32            in_be32
229 #define esdhc_write32           out_be32
230 #define esdhc_clrsetbits32      clrsetbits_be32
231 #define esdhc_clrbits32         clrbits_be32
232 #define esdhc_setbits32         setbits_be32
233 #elif __BYTE_ORDER == __LITTLE_ENDIAN
234 #define esdhc_read32            in_le32
235 #define esdhc_write32           out_le32
236 #define esdhc_clrsetbits32      clrsetbits_le32
237 #define esdhc_clrbits32         clrbits_le32
238 #define esdhc_setbits32         setbits_le32
239 #elif __BYTE_ORDER == __BIG_ENDIAN
240 #define esdhc_read32            in_be32
241 #define esdhc_write32           out_be32
242 #define esdhc_clrsetbits32      clrsetbits_be32
243 #define esdhc_clrbits32         clrbits_be32
244 #define esdhc_setbits32         setbits_be32
245 #else
246 #error "Endianess is not defined: please fix to continue"
247 #endif
248
249 #ifdef CONFIG_FSL_ESDHC
250 int fsl_esdhc_mmc_init(struct bd_info *bis);
251 int fsl_esdhc_initialize(struct bd_info *bis, struct fsl_esdhc_cfg *cfg);
252 void fdt_fixup_esdhc(void *blob, struct bd_info *bd);
253 #else
254 static inline int fsl_esdhc_mmc_init(struct bd_info *bis) { return -ENOSYS; }
255 static inline void fdt_fixup_esdhc(void *blob, struct bd_info *bd) {}
256 #endif /* CONFIG_FSL_ESDHC */
257 void __noreturn mmc_boot(void);
258 void mmc_spl_load_image(uint32_t offs, unsigned int size, void *vdst);
259
260 #endif  /* __FSL_ESDHC_H__ */