xref: /arm-trusted-firmware/drivers/renesas/common/emmc/emmc_std.h (revision 91f16700b400a8c0651d24a598fc48ee2997a0d7)
1*91f16700Schasinglulu /*
2*91f16700Schasinglulu  * Copyright (c) 2015-2020, Renesas Electronics Corporation. All rights reserved.
3*91f16700Schasinglulu  *
4*91f16700Schasinglulu  * SPDX-License-Identifier: BSD-3-Clause
5*91f16700Schasinglulu  */
6*91f16700Schasinglulu 
7*91f16700Schasinglulu #ifndef EMMC_STD_H
8*91f16700Schasinglulu #define EMMC_STD_H
9*91f16700Schasinglulu 
10*91f16700Schasinglulu #include "emmc_hal.h"
11*91f16700Schasinglulu 
12*91f16700Schasinglulu #ifndef FALSE
13*91f16700Schasinglulu #define FALSE	0U
14*91f16700Schasinglulu #endif
15*91f16700Schasinglulu #ifndef TRUE
16*91f16700Schasinglulu #define TRUE	1U
17*91f16700Schasinglulu #endif
18*91f16700Schasinglulu 
19*91f16700Schasinglulu /* 64bit registers */
20*91f16700Schasinglulu #define SETR_64(r, v)			(*(volatile uint64_t *)(r) = (v))
21*91f16700Schasinglulu #define GETR_64(r)			(*(volatile uint64_t *)(r))
22*91f16700Schasinglulu 
23*91f16700Schasinglulu /* 32bit registers */
24*91f16700Schasinglulu #define SETR_32(r, v)			(*(volatile uint32_t *)(r) = (v))
25*91f16700Schasinglulu #define GETR_32(r)			(*(volatile uint32_t *)(r))
26*91f16700Schasinglulu 
27*91f16700Schasinglulu /* 16bit registers */
28*91f16700Schasinglulu #define SETR_16(r, v)			(*(volatile uint16_t *)(r) = (v))
29*91f16700Schasinglulu #define GETR_16(r)			(*(volatile uint16_t *)(r))
30*91f16700Schasinglulu 
31*91f16700Schasinglulu /* 8bit registers */
32*91f16700Schasinglulu #define SETR_8(r, v)			(*(volatile uint8_t *)(r) = (v))
33*91f16700Schasinglulu #define GETR_8(r)			(*(volatile uint8_t *)(r))
34*91f16700Schasinglulu 
35*91f16700Schasinglulu /* CSD register Macros */
36*91f16700Schasinglulu #define EMMC_GET_CID(x, y)	(emmc_bit_field(mmc_drv_obj.cid_data, (x), (y)))
37*91f16700Schasinglulu 
38*91f16700Schasinglulu #define EMMC_CID_MID()			(EMMC_GET_CID(127, 120))
39*91f16700Schasinglulu #define EMMC_CID_CBX()			(EMMC_GET_CID(113, 112))
40*91f16700Schasinglulu #define EMMC_CID_OID()			(EMMC_GET_CID(111, 104))
41*91f16700Schasinglulu #define EMMC_CID_PNM1()			(EMMC_GET_CID(103, 88))
42*91f16700Schasinglulu #define EMMC_CID_PNM2()			(EMMC_GET_CID(87, 56))
43*91f16700Schasinglulu #define EMMC_CID_PRV()			(EMMC_GET_CID(55, 48))
44*91f16700Schasinglulu #define EMMC_CID_PSN()			(EMMC_GET_CID(47, 16))
45*91f16700Schasinglulu #define EMMC_CID_MDT()			(EMMC_GET_CID(15, 8))
46*91f16700Schasinglulu #define EMMC_CID_CRC()			(EMMC_GET_CID(7, 1))
47*91f16700Schasinglulu 
48*91f16700Schasinglulu /* CSD register Macros */
49*91f16700Schasinglulu #define EMMC_GET_CSD(x, y)	(emmc_bit_field(mmc_drv_obj.csd_data, (x), (y)))
50*91f16700Schasinglulu 
51*91f16700Schasinglulu #define EMMC_CSD_CSD_STRUCTURE()	(EMMC_GET_CSD(127, 126))
52*91f16700Schasinglulu #define EMMC_CSD_SPEC_VARS()		(EMMC_GET_CSD(125, 122))
53*91f16700Schasinglulu #define EMMC_CSD_TAAC()			(EMMC_GET_CSD(119, 112))
54*91f16700Schasinglulu #define EMMC_CSD_NSAC()			(EMMC_GET_CSD(111, 104))
55*91f16700Schasinglulu #define EMMC_CSD_TRAN_SPEED()		(EMMC_GET_CSD(103, 96))
56*91f16700Schasinglulu #define EMMC_CSD_CCC()			(EMMC_GET_CSD(95, 84))
57*91f16700Schasinglulu #define EMMC_CSD_READ_BL_LEN()		(EMMC_GET_CSD(83, 80))
58*91f16700Schasinglulu #define EMMC_CSD_READ_BL_PARTIAL()	(EMMC_GET_CSD(79, 79))
59*91f16700Schasinglulu #define EMMC_CSD_WRITE_BLK_MISALIGN()	(EMMC_GET_CSD(78, 78))
60*91f16700Schasinglulu #define EMMC_CSD_READ_BLK_MISALIGN()	(EMMC_GET_CSD(77, 77))
61*91f16700Schasinglulu #define EMMC_CSD_DSR_IMP()		(EMMC_GET_CSD(76, 76))
62*91f16700Schasinglulu #define EMMC_CSD_C_SIZE()		(EMMC_GET_CSD(73, 62))
63*91f16700Schasinglulu #define EMMC_CSD_VDD_R_CURR_MIN()	(EMMC_GET_CSD(61, 59))
64*91f16700Schasinglulu #define EMMC_CSD_VDD_R_CURR_MAX()	(EMMC_GET_CSD(58, 56))
65*91f16700Schasinglulu #define EMMC_CSD_VDD_W_CURR_MIN()	(EMMC_GET_CSD(55, 53))
66*91f16700Schasinglulu #define EMMC_CSD_VDD_W_CURR_MAX()	(EMMC_GET_CSD(52, 50))
67*91f16700Schasinglulu #define EMMC_CSD_C_SIZE_MULT()		(EMMC_GET_CSD(49, 47))
68*91f16700Schasinglulu #define EMMC_CSD_ERASE_GRP_SIZE()	(EMMC_GET_CSD(46, 42))
69*91f16700Schasinglulu #define EMMC_CSD_ERASE_GRP_MULT()	(EMMC_GET_CSD(41, 37))
70*91f16700Schasinglulu #define EMMC_CSD_WP_GRP_SIZE()		(EMMC_GET_CSD(36, 32))
71*91f16700Schasinglulu #define EMMC_CSD_WP_GRP_ENABLE()	(EMMC_GET_CSD(31, 31))
72*91f16700Schasinglulu #define EMMC_CSD_DEFALT_ECC()		(EMMC_GET_CSD(30, 29))
73*91f16700Schasinglulu #define EMMC_CSD_R2W_FACTOR()		(EMMC_GET_CSD(28, 26))
74*91f16700Schasinglulu #define EMMC_CSD_WRITE_BL_LEN()		(EMMC_GET_CSD(25, 22))
75*91f16700Schasinglulu #define EMMC_CSD_WRITE_BL_PARTIAL()	(EMMC_GET_CSD(21, 21))
76*91f16700Schasinglulu #define EMMC_CSD_CONTENT_PROT_APP()	(EMMC_GET_CSD(16, 16))
77*91f16700Schasinglulu #define EMMC_CSD_FILE_FORMAT_GRP()	(EMMC_GET_CSD(15, 15))
78*91f16700Schasinglulu #define EMMC_CSD_COPY()			(EMMC_GET_CSD(14, 14))
79*91f16700Schasinglulu #define EMMC_CSD_PERM_WRITE_PROTECT()	(EMMC_GET_CSD(13, 13))
80*91f16700Schasinglulu #define EMMC_CSD_TMP_WRITE_PROTECT()	(EMMC_GET_CSD(12, 12))
81*91f16700Schasinglulu #define EMMC_CSD_FILE_FORMAT()		(EMMC_GET_CSD(11, 10))
82*91f16700Schasinglulu #define EMMC_CSD_ECC()			(EMMC_GET_CSD(9, 8))
83*91f16700Schasinglulu #define EMMC_CSD_CRC()			(EMMC_GET_CSD(7, 1))
84*91f16700Schasinglulu 
85*91f16700Schasinglulu /* sector access */
86*91f16700Schasinglulu #define EMMC_4B_BOUNDARY_CHECK_MASK	0x00000003
87*91f16700Schasinglulu #define EMMC_SECTOR_SIZE_SHIFT		9U	/* 512 = 2^9 */
88*91f16700Schasinglulu #define EMMC_SECTOR_SIZE		512
89*91f16700Schasinglulu #define EMMC_BLOCK_LENGTH		512
90*91f16700Schasinglulu #define EMMC_BLOCK_LENGTH_DW		128
91*91f16700Schasinglulu #define EMMC_BUF_SIZE_SHIFT		3U	/* 8byte = 2^3 */
92*91f16700Schasinglulu 
93*91f16700Schasinglulu /* eMMC specification clock */
94*91f16700Schasinglulu #define EMMC_CLOCK_SPEC_400K		400000UL	 /* initialize clock 400KHz */
95*91f16700Schasinglulu #define EMMC_CLOCK_SPEC_20M		20000000UL	 /* normal speed 20MHz */
96*91f16700Schasinglulu #define EMMC_CLOCK_SPEC_26M		26000000UL	 /* high speed 26MHz */
97*91f16700Schasinglulu #define EMMC_CLOCK_SPEC_52M		52000000UL	 /* high speed 52MHz */
98*91f16700Schasinglulu #define EMMC_CLOCK_SPEC_100M		100000000UL	 /* high speed 100MHz */
99*91f16700Schasinglulu 
100*91f16700Schasinglulu /* EMMC driver error code. (extended HAL_MEMCARD_RETURN) */
101*91f16700Schasinglulu typedef enum {
102*91f16700Schasinglulu 	EMMC_ERR = 0,				/* unknown error */
103*91f16700Schasinglulu 	EMMC_SUCCESS,				/* OK */
104*91f16700Schasinglulu 	EMMC_ERR_FROM_DMAC,			/* DMAC allocation error */
105*91f16700Schasinglulu 	EMMC_ERR_FROM_DMAC_TRANSFER,		/* DMAC transfer error */
106*91f16700Schasinglulu 	EMMC_ERR_CARD_STATUS_BIT,		/* card status error */
107*91f16700Schasinglulu 	EMMC_ERR_CMD_TIMEOUT,			/* command timeout error */
108*91f16700Schasinglulu 	EMMC_ERR_DATA_TIMEOUT,			/* data timeout error */
109*91f16700Schasinglulu 	EMMC_ERR_CMD_CRC,			/* command CRC error */
110*91f16700Schasinglulu 	EMMC_ERR_DATA_CRC,			/* data CRC error */
111*91f16700Schasinglulu 	EMMC_ERR_PARAM,				/* parameter error */
112*91f16700Schasinglulu 	EMMC_ERR_RESPONSE,			/* response error */
113*91f16700Schasinglulu 	EMMC_ERR_RESPONSE_BUSY,			/* response busy error */
114*91f16700Schasinglulu 	EMMC_ERR_TRANSFER,			/* data transfer error */
115*91f16700Schasinglulu 	EMMC_ERR_READ_SECTOR,			/* read sector error */
116*91f16700Schasinglulu 	EMMC_ERR_WRITE_SECTOR,			/* write sector error */
117*91f16700Schasinglulu 	EMMC_ERR_STATE,				/* state error */
118*91f16700Schasinglulu 	EMMC_ERR_TIMEOUT,			/* timeout error */
119*91f16700Schasinglulu 	EMMC_ERR_ILLEGAL_CARD,			/* illegal card */
120*91f16700Schasinglulu 	EMMC_ERR_CARD_BUSY,			/* Busy state */
121*91f16700Schasinglulu 	EMMC_ERR_CARD_STATE,			/* card state error */
122*91f16700Schasinglulu 	EMMC_ERR_SET_TRACE,			/* trace information error */
123*91f16700Schasinglulu 	EMMC_ERR_FROM_TIMER,			/* Timer error */
124*91f16700Schasinglulu 	EMMC_ERR_FORCE_TERMINATE,		/* Force terminate */
125*91f16700Schasinglulu 	EMMC_ERR_CARD_POWER,			/* card power fail */
126*91f16700Schasinglulu 	EMMC_ERR_ERASE_SECTOR,			/* erase sector error */
127*91f16700Schasinglulu 	EMMC_ERR_INFO2				/* exec cmd error info2 */
128*91f16700Schasinglulu } EMMC_ERROR_CODE;
129*91f16700Schasinglulu 
130*91f16700Schasinglulu /* Function number */
131*91f16700Schasinglulu #define EMMC_FUNCNO_NONE				0U
132*91f16700Schasinglulu #define EMMC_FUNCNO_DRIVER_INIT				1U
133*91f16700Schasinglulu #define EMMC_FUNCNO_CARD_POWER_ON			2U
134*91f16700Schasinglulu #define EMMC_FUNCNO_MOUNT				3U
135*91f16700Schasinglulu #define EMMC_FUNCNO_CARD_INIT				4U
136*91f16700Schasinglulu #define EMMC_FUNCNO_HIGH_SPEED				5U
137*91f16700Schasinglulu #define EMMC_FUNCNO_BUS_WIDTH				6U
138*91f16700Schasinglulu #define EMMC_FUNCNO_MULTI_BOOT_SELECT_PARTITION		7U
139*91f16700Schasinglulu #define EMMC_FUNCNO_MULTI_BOOT_READ_SECTOR		8U
140*91f16700Schasinglulu #define EMMC_FUNCNO_TRANS_DATA_READ_SECTOR		9U
141*91f16700Schasinglulu #define EMMC_FUNCNO_UBOOT_IMAGE_SELECT_PARTITION	10U
142*91f16700Schasinglulu #define EMMC_FUNCNO_UBOOT_IMAGE_READ_SECTOR		11U
143*91f16700Schasinglulu #define EMMC_FUNCNO_SET_CLOCK				12U
144*91f16700Schasinglulu #define EMMC_FUNCNO_EXEC_CMD				13U
145*91f16700Schasinglulu #define EMMC_FUNCNO_READ_SECTOR				14U
146*91f16700Schasinglulu #define EMMC_FUNCNO_WRITE_SECTOR			15U
147*91f16700Schasinglulu #define EMMC_FUNCNO_ERASE_SECTOR			16U
148*91f16700Schasinglulu #define EMMC_FUNCNO_GET_PERTITION_ACCESS		17U
149*91f16700Schasinglulu /*
150*91f16700Schasinglulu  * Response
151*91f16700Schasinglulu  * R1
152*91f16700Schasinglulu  * Type 'E' bit and bit14(must be 0). ignore bit22
153*91f16700Schasinglulu  */
154*91f16700Schasinglulu #define EMMC_R1_ERROR_MASK			0xFDBFE080U
155*91f16700Schasinglulu /* Ignore bit23 (Not check CRC error) */
156*91f16700Schasinglulu #define EMMC_R1_ERROR_MASK_WITHOUT_CRC		(0xFD3FE080U)
157*91f16700Schasinglulu #define EMMC_R1_STATE_MASK			0x00001E00U	/* [12:9] */
158*91f16700Schasinglulu #define EMMC_R1_READY				0x00000100U	/* bit8 */
159*91f16700Schasinglulu #define EMMC_R1_STATE_SHIFT			9
160*91f16700Schasinglulu 
161*91f16700Schasinglulu /* R4 */
162*91f16700Schasinglulu #define EMMC_R4_RCA_MASK			0xFFFF0000UL
163*91f16700Schasinglulu #define EMMC_R4_STATUS				0x00008000UL
164*91f16700Schasinglulu 
165*91f16700Schasinglulu /* CSD */
166*91f16700Schasinglulu #define EMMC_TRANSPEED_FREQ_UNIT_MASK		0x07	/* bit[2:0] */
167*91f16700Schasinglulu #define EMMC_TRANSPEED_FREQ_UNIT_SHIFT		0
168*91f16700Schasinglulu #define EMMC_TRANSPEED_MULT_MASK		0x78	/* bit[6:3] */
169*91f16700Schasinglulu #define EMMC_TRANSPEED_MULT_SHIFT		3
170*91f16700Schasinglulu 
171*91f16700Schasinglulu /* OCR */
172*91f16700Schasinglulu #define EMMC_HOST_OCR_VALUE			0x40FF8080
173*91f16700Schasinglulu #define EMMC_OCR_STATUS_BIT			0x80000000L	/* Card power up status bit */
174*91f16700Schasinglulu #define EMMC_OCR_ACCESS_MODE_MASK		0x60000000L	/* bit[30:29] */
175*91f16700Schasinglulu #define EMMC_OCR_ACCESS_MODE_SECT		0x40000000L
176*91f16700Schasinglulu #define EMMC_OCR_ACCESS_MODE_BYTE		0x00000000L
177*91f16700Schasinglulu 
178*91f16700Schasinglulu /* EXT_CSD */
179*91f16700Schasinglulu #define EMMC_EXT_CSD_S_CMD_SET				504
180*91f16700Schasinglulu #define EMMC_EXT_CSD_INI_TIMEOUT_AP			241
181*91f16700Schasinglulu #define EMMC_EXT_CSD_PWR_CL_DDR_52_360			239
182*91f16700Schasinglulu #define EMMC_EXT_CSD_PWR_CL_DDR_52_195			238
183*91f16700Schasinglulu #define EMMC_EXT_CSD_MIN_PERF_DDR_W_8_52		235
184*91f16700Schasinglulu #define EMMC_EXT_CSD_MIN_PERF_DDR_R_8_52		234
185*91f16700Schasinglulu #define EMMC_EXT_CSD_TRIM_MULT				232
186*91f16700Schasinglulu #define EMMC_EXT_CSD_SEC_FEATURE_SUPPORT		231
187*91f16700Schasinglulu #define EMMC_EXT_CSD_SEC_ERASE_MULT			229
188*91f16700Schasinglulu #define EMMC_EXT_CSD_BOOT_INFO				228
189*91f16700Schasinglulu #define EMMC_EXT_CSD_BOOT_SIZE_MULTI			226
190*91f16700Schasinglulu #define EMMC_EXT_CSD_ACC_SIZE				225
191*91f16700Schasinglulu #define EMMC_EXT_CSD_HC_ERASE_GRP_SIZE			224
192*91f16700Schasinglulu #define EMMC_EXT_CSD_ERASE_TIMEOUT_MULT			223
193*91f16700Schasinglulu #define EMMC_EXT_CSD_PEL_WR_SEC_C			222
194*91f16700Schasinglulu #define EMMC_EXT_CSD_HC_WP_GRP_SIZE			221
195*91f16700Schasinglulu #define EMMC_EXT_CSD_S_C_VCC				220
196*91f16700Schasinglulu #define EMMC_EXT_CSD_S_C_VCCQ				219
197*91f16700Schasinglulu #define EMMC_EXT_CSD_S_A_TIMEOUT			217
198*91f16700Schasinglulu #define EMMC_EXT_CSD_SEC_COUNT				215
199*91f16700Schasinglulu #define EMMC_EXT_CSD_MIN_PERF_W_8_52			210
200*91f16700Schasinglulu #define EMMC_EXT_CSD_MIN_PERF_R_8_52			209
201*91f16700Schasinglulu #define EMMC_EXT_CSD_MIN_PERF_W_8_26_4_52		208
202*91f16700Schasinglulu #define EMMC_EXT_CSD_MIN_PERF_R_8_26_4_52		207
203*91f16700Schasinglulu #define EMMC_EXT_CSD_MIN_PERF_W_4_26			206
204*91f16700Schasinglulu #define EMMC_EXT_CSD_MIN_PERF_R_4_26			205
205*91f16700Schasinglulu #define EMMC_EXT_CSD_PWR_CL_26_360			203
206*91f16700Schasinglulu #define EMMC_EXT_CSD_PWR_CL_52_360			202
207*91f16700Schasinglulu #define EMMC_EXT_CSD_PWR_CL_26_195			201
208*91f16700Schasinglulu #define EMMC_EXT_CSD_PWR_CL_52_195			200
209*91f16700Schasinglulu #define EMMC_EXT_CSD_CARD_TYPE				196
210*91f16700Schasinglulu #define EMMC_EXT_CSD_CSD_STRUCTURE			194
211*91f16700Schasinglulu #define EMMC_EXT_CSD_EXT_CSD_REV			192
212*91f16700Schasinglulu #define EMMC_EXT_CSD_CMD_SET				191
213*91f16700Schasinglulu #define EMMC_EXT_CSD_CMD_SET_REV			189
214*91f16700Schasinglulu #define EMMC_EXT_CSD_POWER_CLASS			187
215*91f16700Schasinglulu #define EMMC_EXT_CSD_HS_TIMING				185
216*91f16700Schasinglulu #define EMMC_EXT_CSD_BUS_WIDTH				183
217*91f16700Schasinglulu #define EMMC_EXT_CSD_ERASED_MEM_CONT			181
218*91f16700Schasinglulu #define EMMC_EXT_CSD_PARTITION_CONFIG			179
219*91f16700Schasinglulu #define EMMC_EXT_CSD_BOOT_CONFIG_PROT			178
220*91f16700Schasinglulu #define EMMC_EXT_CSD_BOOT_BUS_WIDTH			177
221*91f16700Schasinglulu #define EMMC_EXT_CSD_ERASE_GROUP_DEF			175
222*91f16700Schasinglulu #define EMMC_EXT_CSD_BOOT_WP				173
223*91f16700Schasinglulu #define EMMC_EXT_CSD_USER_WP				171
224*91f16700Schasinglulu #define EMMC_EXT_CSD_FW_CONFIG				169
225*91f16700Schasinglulu #define EMMC_EXT_CSD_RPMB_SIZE_MULT			168
226*91f16700Schasinglulu #define EMMC_EXT_CSD_RST_n_FUNCTION			162
227*91f16700Schasinglulu #define EMMC_EXT_CSD_PARTITIONING_SUPPORT		160
228*91f16700Schasinglulu #define EMMC_EXT_CSD_MAX_ENH_SIZE_MULT			159
229*91f16700Schasinglulu #define EMMC_EXT_CSD_PARTITIONS_ATTRIBUTE		156
230*91f16700Schasinglulu #define EMMC_EXT_CSD_PARTITION_SETTING_COMPLETED	155
231*91f16700Schasinglulu #define EMMC_EXT_CSD_GP_SIZE_MULT			154
232*91f16700Schasinglulu #define EMMC_EXT_CSD_ENH_SIZE_MULT			142
233*91f16700Schasinglulu #define EMMC_EXT_CSD_ENH_START_ADDR			139
234*91f16700Schasinglulu #define EMMC_EXT_CSD_SEC_BAD_BLK_MGMNT			134
235*91f16700Schasinglulu 
236*91f16700Schasinglulu #define EMMC_EXT_CSD_CARD_TYPE_26MHZ			0x01
237*91f16700Schasinglulu #define EMMC_EXT_CSD_CARD_TYPE_52MHZ			0x02
238*91f16700Schasinglulu #define EMMC_EXT_CSD_CARD_TYPE_DDR_52MHZ_12V		0x04
239*91f16700Schasinglulu #define EMMC_EXT_CSD_CARD_TYPE_DDR_52MHZ_18V		0x08
240*91f16700Schasinglulu #define EMMC_EXT_CSD_CARD_TYPE_52MHZ_MASK		0x0e
241*91f16700Schasinglulu 
242*91f16700Schasinglulu /* SWITCH (CMD6) argument */
243*91f16700Schasinglulu #define EXTCSD_ACCESS_BYTE	(BIT25 | BIT24)
244*91f16700Schasinglulu #define EXTCSD_SET_BITS		BIT24
245*91f16700Schasinglulu 
246*91f16700Schasinglulu #define HS_TIMING_ADD		(185 << 16)	/* H'b9 */
247*91f16700Schasinglulu #define HS_TIMING_1		(1 << 8)
248*91f16700Schasinglulu #define HS_TIMING_HS200		(2 << 8)
249*91f16700Schasinglulu #define HS_TIMING_HS400		(3 << 8)
250*91f16700Schasinglulu 
251*91f16700Schasinglulu #define BUS_WIDTH_ADD		(183 << 16)	/* H'b7 */
252*91f16700Schasinglulu #define BUS_WIDTH_1		(0 << 8)
253*91f16700Schasinglulu #define BUS_WIDTH_4		(1 << 8)
254*91f16700Schasinglulu #define BUS_WIDTH_8		(2 << 8)
255*91f16700Schasinglulu #define BUS_WIDTH_4DDR		(5 << 8)
256*91f16700Schasinglulu #define BUS_WIDTH_8DDR		(6 << 8)
257*91f16700Schasinglulu 
258*91f16700Schasinglulu #define EMMC_SWITCH_HS_TIMING		(EXTCSD_ACCESS_BYTE | HS_TIMING_ADD |\
259*91f16700Schasinglulu 					 HS_TIMING_1)		/* H'03b90100 */
260*91f16700Schasinglulu #define EMMC_SWITCH_HS_TIMING_OFF	(EXTCSD_ACCESS_BYTE |\
261*91f16700Schasinglulu 					 HS_TIMING_ADD)		/* H'03b90000 */
262*91f16700Schasinglulu 
263*91f16700Schasinglulu #define EMMC_SWITCH_BUS_WIDTH_1		(EXTCSD_ACCESS_BYTE | BUS_WIDTH_ADD |\
264*91f16700Schasinglulu 					 BUS_WIDTH_1)		/* H'03b70000 */
265*91f16700Schasinglulu #define EMMC_SWITCH_BUS_WIDTH_4		(EXTCSD_ACCESS_BYTE | BUS_WIDTH_ADD |\
266*91f16700Schasinglulu 					 BUS_WIDTH_4)		/* H'03b70100 */
267*91f16700Schasinglulu #define EMMC_SWITCH_BUS_WIDTH_8		(EXTCSD_ACCESS_BYTE | BUS_WIDTH_ADD |\
268*91f16700Schasinglulu 					 BUS_WIDTH_8)		/* H'03b70200 */
269*91f16700Schasinglulu #define EMMC_SWITCH_BUS_WIDTH_4DDR	(EXTCSD_ACCESS_BYTE | BUS_WIDTH_ADD |\
270*91f16700Schasinglulu 					 BUS_WIDTH_4DDR)	/* H'03b70500 */
271*91f16700Schasinglulu #define EMMC_SWITCH_BUS_WIDTH_8DDR	(EXTCSD_ACCESS_BYTE | BUS_WIDTH_ADD |\
272*91f16700Schasinglulu 					 BUS_WIDTH_8DDR)	/* H'03b70600 */
273*91f16700Schasinglulu /* Partition config = 0x00 */
274*91f16700Schasinglulu #define EMMC_SWITCH_PARTITION_CONFIG	0x03B30000UL
275*91f16700Schasinglulu 
276*91f16700Schasinglulu #define TIMING_HIGH_SPEED		1UL
277*91f16700Schasinglulu #define EMMC_BOOT_PARTITION_EN_MASK	0x38U
278*91f16700Schasinglulu #define EMMC_BOOT_PARTITION_EN_SHIFT	3U
279*91f16700Schasinglulu 
280*91f16700Schasinglulu /* Bus width */
281*91f16700Schasinglulu #define EMMC_BUSWIDTH_1BIT		CE_CMD_SET_DATW_1BIT
282*91f16700Schasinglulu #define EMMC_BUSWIDTH_4BIT		CE_CMD_SET_DATW_4BIT
283*91f16700Schasinglulu #define EMMC_BUSWIDTH_8BIT		CE_CMD_SET_DATW_8BIT
284*91f16700Schasinglulu 
285*91f16700Schasinglulu /* for st_mmc_base */
286*91f16700Schasinglulu #define EMMC_MAX_RESPONSE_LENGTH	17
287*91f16700Schasinglulu #define EMMC_MAX_CID_LENGTH		16
288*91f16700Schasinglulu #define EMMC_MAX_CSD_LENGTH		16
289*91f16700Schasinglulu #define EMMC_MAX_EXT_CSD_LENGTH		512U
290*91f16700Schasinglulu #define EMMC_RES_REG_ALIGNED		4U
291*91f16700Schasinglulu #define EMMC_BUF_REG_ALIGNED		8U
292*91f16700Schasinglulu 
293*91f16700Schasinglulu /* TAAC mask */
294*91f16700Schasinglulu #define TAAC_TIME_UNIT_MASK		(0x07)
295*91f16700Schasinglulu #define TAAC_MULTIPLIER_FACTOR_MASK	(0x0F)
296*91f16700Schasinglulu 
297*91f16700Schasinglulu /* Partition id */
298*91f16700Schasinglulu typedef enum {
299*91f16700Schasinglulu 	PARTITION_ID_USER = 0x0,	/* User Area */
300*91f16700Schasinglulu 	PARTITION_ID_BOOT_1 = 0x1,	/* boot partition 1 */
301*91f16700Schasinglulu 	PARTITION_ID_BOOT_2 = 0x2,	/* boot partition 2 */
302*91f16700Schasinglulu 	PARTITION_ID_RPMB = 0x3,	/* Replay Protected Memory Block */
303*91f16700Schasinglulu 	PARTITION_ID_GP_1 = 0x4,	/* General Purpose partition 1 */
304*91f16700Schasinglulu 	PARTITION_ID_GP_2 = 0x5,	/* General Purpose partition 2 */
305*91f16700Schasinglulu 	PARTITION_ID_GP_3 = 0x6,	/* General Purpose partition 3 */
306*91f16700Schasinglulu 	PARTITION_ID_GP_4 = 0x7,	/* General Purpose partition 4 */
307*91f16700Schasinglulu 	PARTITION_ID_MASK = 0x7		/* [2:0] */
308*91f16700Schasinglulu } EMMC_PARTITION_ID;
309*91f16700Schasinglulu 
310*91f16700Schasinglulu /* card state in R1 response [12:9] */
311*91f16700Schasinglulu typedef enum {
312*91f16700Schasinglulu 	EMMC_R1_STATE_IDLE = 0,
313*91f16700Schasinglulu 	EMMC_R1_STATE_READY,
314*91f16700Schasinglulu 	EMMC_R1_STATE_IDENT,
315*91f16700Schasinglulu 	EMMC_R1_STATE_STBY,
316*91f16700Schasinglulu 	EMMC_R1_STATE_TRAN,
317*91f16700Schasinglulu 	EMMC_R1_STATE_DATA,
318*91f16700Schasinglulu 	EMMC_R1_STATE_RCV,
319*91f16700Schasinglulu 	EMMC_R1_STATE_PRG,
320*91f16700Schasinglulu 	EMMC_R1_STATE_DIS,
321*91f16700Schasinglulu 	EMMC_R1_STATE_BTST,
322*91f16700Schasinglulu 	EMMC_R1_STATE_SLEP
323*91f16700Schasinglulu } EMMC_R1_STATE;
324*91f16700Schasinglulu 
325*91f16700Schasinglulu typedef enum {
326*91f16700Schasinglulu 	ESTATE_BEGIN = 0,
327*91f16700Schasinglulu 	ESTATE_ISSUE_CMD,
328*91f16700Schasinglulu 	ESTATE_NON_RESP_CMD,
329*91f16700Schasinglulu 	ESTATE_RCV_RESP,
330*91f16700Schasinglulu 	ESTATE_RCV_RESPONSE_BUSY,
331*91f16700Schasinglulu 	ESTATE_CHECK_RESPONSE_COMPLETE,
332*91f16700Schasinglulu 	ESTATE_DATA_TRANSFER,
333*91f16700Schasinglulu 	ESTATE_DATA_TRANSFER_COMPLETE,
334*91f16700Schasinglulu 	ESTATE_ACCESS_END,
335*91f16700Schasinglulu 	ESTATE_TRANSFER_ERROR,
336*91f16700Schasinglulu 	ESTATE_ERROR,
337*91f16700Schasinglulu 	ESTATE_END
338*91f16700Schasinglulu } EMMC_INT_STATE;
339*91f16700Schasinglulu 
340*91f16700Schasinglulu /* eMMC boot driver error information */
341*91f16700Schasinglulu typedef struct {
342*91f16700Schasinglulu 	uint16_t num;			/* error no */
343*91f16700Schasinglulu 	uint16_t code;			/* error code */
344*91f16700Schasinglulu 
345*91f16700Schasinglulu 	volatile uint32_t info1;	/* SD_INFO1. (hw dependent) */
346*91f16700Schasinglulu 	volatile uint32_t info2;	/* SD_INFO2. (hw dependent) */
347*91f16700Schasinglulu 	volatile uint32_t status1;	/* SD_ERR_STS1. (hw dependent) */
348*91f16700Schasinglulu 	volatile uint32_t status2;	/* SD_ERR_STS2. (hw dependent) */
349*91f16700Schasinglulu 	volatile uint32_t dm_info1;	/* DM_CM_INFO1. (hw dependent) */
350*91f16700Schasinglulu 	volatile uint32_t dm_info2;	/* DM_CM_INFO2. (hw dependent) */
351*91f16700Schasinglulu } st_error_info;
352*91f16700Schasinglulu 
353*91f16700Schasinglulu /* Command information */
354*91f16700Schasinglulu typedef struct {
355*91f16700Schasinglulu 	HAL_MEMCARD_COMMAND cmd;	/* Command information */
356*91f16700Schasinglulu 	uint32_t arg;			/* argument */
357*91f16700Schasinglulu 	HAL_MEMCARD_OPERATION dir;	/* direction */
358*91f16700Schasinglulu 	uint32_t hw;			/* SD_CMD register value. */
359*91f16700Schasinglulu } st_command_info;
360*91f16700Schasinglulu 
361*91f16700Schasinglulu /* MMC driver base */
362*91f16700Schasinglulu typedef struct {
363*91f16700Schasinglulu 	st_error_info error_info;	/* error information */
364*91f16700Schasinglulu 	st_command_info cmd_info;	/* command information */
365*91f16700Schasinglulu 
366*91f16700Schasinglulu 	/* for data transfer */
367*91f16700Schasinglulu 	uint32_t *buff_address_virtual;		/* Dest or Src buff */
368*91f16700Schasinglulu 	uint32_t *buff_address_physical;	/* Dest or Src buff */
369*91f16700Schasinglulu 	HAL_MEMCARD_DATA_WIDTH bus_width;	/* bus width */
370*91f16700Schasinglulu 
371*91f16700Schasinglulu 	uint32_t trans_size;		/* transfer size for this command */
372*91f16700Schasinglulu 	uint32_t remain_size;		/* remain size for this command */
373*91f16700Schasinglulu 	uint32_t response_length;	/* response length for this command */
374*91f16700Schasinglulu 	uint32_t sector_size;		/* sector_size */
375*91f16700Schasinglulu 
376*91f16700Schasinglulu 	/* clock */
377*91f16700Schasinglulu 	uint32_t base_clock;		/* MMC host controller clock */
378*91f16700Schasinglulu 	/*
379*91f16700Schasinglulu 	 * Max freq (Card Spec)[Hz]. It changes dynamically by CSD and
380*91f16700Schasinglulu 	 * EXT_CSD.
381*91f16700Schasinglulu 	 */
382*91f16700Schasinglulu 	uint32_t max_freq;
383*91f16700Schasinglulu 	/* request freq [Hz] (400K, 26MHz, 52MHz, etc) */
384*91f16700Schasinglulu 	uint32_t request_freq;
385*91f16700Schasinglulu 	/* current MMC clock[Hz] (the closest frequency supported by HW) */
386*91f16700Schasinglulu 	uint32_t current_freq;
387*91f16700Schasinglulu 
388*91f16700Schasinglulu 	/* state flag */
389*91f16700Schasinglulu 	/* presence status of the memory card */
390*91f16700Schasinglulu 	HAL_MEMCARD_PRESENCE_STATUS card_present;
391*91f16700Schasinglulu 
392*91f16700Schasinglulu 	uint32_t card_power_enable;
393*91f16700Schasinglulu 	uint32_t clock_enable;
394*91f16700Schasinglulu 	/* True : initialize complete. */
395*91f16700Schasinglulu 	uint32_t initialize;
396*91f16700Schasinglulu 	/* True : sector access, FALSE : byte access */
397*91f16700Schasinglulu 	uint32_t access_mode;
398*91f16700Schasinglulu 	/* True : mount complete. */
399*91f16700Schasinglulu 	uint32_t mount;
400*91f16700Schasinglulu 	/* True : selected card. */
401*91f16700Schasinglulu 	uint32_t selected;
402*91f16700Schasinglulu 	/* 0: DMA, 1:PIO */
403*91f16700Schasinglulu 	HAL_MEMCARD_DATA_TRANSFER_MODE transfer_mode;
404*91f16700Schasinglulu 
405*91f16700Schasinglulu 	/* loaded ISSW image No. ISSW have copy image. */
406*91f16700Schasinglulu 	uint32_t image_num;
407*91f16700Schasinglulu 	/* card state */
408*91f16700Schasinglulu 	EMMC_R1_STATE current_state;
409*91f16700Schasinglulu 	/* True : during command processing */
410*91f16700Schasinglulu 	volatile uint32_t during_cmd_processing;
411*91f16700Schasinglulu 	/* True : during transfer */
412*91f16700Schasinglulu 	volatile uint32_t during_transfer;
413*91f16700Schasinglulu 	/* True : during transfer (DMA) */
414*91f16700Schasinglulu 	volatile uint32_t during_dma_transfer;
415*91f16700Schasinglulu 	/* True : occurred DMAC error */
416*91f16700Schasinglulu 	volatile uint32_t dma_error_flag;
417*91f16700Schasinglulu 	/* force terminate flag */
418*91f16700Schasinglulu 	volatile uint32_t force_terminate;
419*91f16700Schasinglulu 	/* state machine blocking flag : True or False */
420*91f16700Schasinglulu 	volatile uint32_t state_machine_blocking;
421*91f16700Schasinglulu 	/* True : get partition access processing */
422*91f16700Schasinglulu 	volatile uint32_t get_partition_access_flag;
423*91f16700Schasinglulu 
424*91f16700Schasinglulu 	EMMC_PARTITION_ID boot_partition_en;	/* Boot partition */
425*91f16700Schasinglulu 	EMMC_PARTITION_ID partition_access;	/* Current access partition */
426*91f16700Schasinglulu 
427*91f16700Schasinglulu 	/* timeout */
428*91f16700Schasinglulu 	uint32_t hs_timing;
429*91f16700Schasinglulu 
430*91f16700Schasinglulu 	/* read and write data timeout */
431*91f16700Schasinglulu 	uint32_t data_timeout;
432*91f16700Schasinglulu 
433*91f16700Schasinglulu 	/* retry */
434*91f16700Schasinglulu 	uint32_t retries_after_fail;
435*91f16700Schasinglulu 
436*91f16700Schasinglulu 	/* interrupt */
437*91f16700Schasinglulu 	volatile uint32_t int_event1;	/* interrupt SD_INFO1 Event */
438*91f16700Schasinglulu 	volatile uint32_t int_event2;	/* interrupt SD_INFO2 Event */
439*91f16700Schasinglulu 	volatile uint32_t dm_event1;	/* interrupt DM_CM_INFO1 Event */
440*91f16700Schasinglulu 	volatile uint32_t dm_event2;	/* interrupt DM_CM_INFO2 Event */
441*91f16700Schasinglulu 
442*91f16700Schasinglulu 	/* response */
443*91f16700Schasinglulu 	uint32_t *response;		/* buffer ptr for executing command. */
444*91f16700Schasinglulu 	uint32_t r1_card_status;	/* R1 response data */
445*91f16700Schasinglulu 	uint32_t r3_ocr;		/* R3 response data */
446*91f16700Schasinglulu 	uint32_t r4_resp;		/* R4 response data */
447*91f16700Schasinglulu 	uint32_t r5_resp;		/* R5 response data */
448*91f16700Schasinglulu 
449*91f16700Schasinglulu 	/* True : clock mode is low. (MMC clock = Max26MHz) */
450*91f16700Schasinglulu 	uint32_t low_clock_mode_enable;
451*91f16700Schasinglulu 
452*91f16700Schasinglulu 	uint32_t reserved2;
453*91f16700Schasinglulu 	uint32_t reserved3;
454*91f16700Schasinglulu 	uint32_t reserved4;
455*91f16700Schasinglulu 
456*91f16700Schasinglulu 	/* CSD registers (4byte align) */
457*91f16700Schasinglulu 	uint8_t csd_data[EMMC_MAX_CSD_LENGTH]			/* CSD */
458*91f16700Schasinglulu 	    __attribute__ ((aligned(EMMC_RES_REG_ALIGNED)));
459*91f16700Schasinglulu 	/* CID registers (4byte align) */
460*91f16700Schasinglulu 	uint8_t cid_data[EMMC_MAX_CID_LENGTH]			/* CID */
461*91f16700Schasinglulu 	    __attribute__ ((aligned(EMMC_RES_REG_ALIGNED)));
462*91f16700Schasinglulu 	/* EXT CSD registers (8byte align) */
463*91f16700Schasinglulu 	uint8_t ext_csd_data[EMMC_MAX_EXT_CSD_LENGTH]		/* EXT_CSD */
464*91f16700Schasinglulu 	    __attribute__ ((aligned(EMMC_BUF_REG_ALIGNED)));
465*91f16700Schasinglulu 	/* Response registers (4byte align) */
466*91f16700Schasinglulu 	uint8_t response_data[EMMC_MAX_RESPONSE_LENGTH]		/* other response */
467*91f16700Schasinglulu 	    __attribute__ ((aligned(EMMC_RES_REG_ALIGNED)));
468*91f16700Schasinglulu } st_mmc_base;
469*91f16700Schasinglulu 
470*91f16700Schasinglulu typedef int (*func) (void);
471*91f16700Schasinglulu 
472*91f16700Schasinglulu uint32_t emmc_get_csd_time(void);
473*91f16700Schasinglulu 
474*91f16700Schasinglulu #define MMC_DEBUG
475*91f16700Schasinglulu #endif /* EMMC_STD_H */
476