xref: /OK3568_Linux_fs/kernel/include/linux/mmc/mmc.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /*
2*4882a593Smuzhiyun  * Header for MultiMediaCard (MMC)
3*4882a593Smuzhiyun  *
4*4882a593Smuzhiyun  * Copyright 2002 Hewlett-Packard Company
5*4882a593Smuzhiyun  *
6*4882a593Smuzhiyun  * Use consistent with the GNU GPL is permitted,
7*4882a593Smuzhiyun  * provided that this copyright notice is
8*4882a593Smuzhiyun  * preserved in its entirety in all copies and derived works.
9*4882a593Smuzhiyun  *
10*4882a593Smuzhiyun  * HEWLETT-PACKARD COMPANY MAKES NO WARRANTIES, EXPRESSED OR IMPLIED,
11*4882a593Smuzhiyun  * AS TO THE USEFULNESS OR CORRECTNESS OF THIS CODE OR ITS
12*4882a593Smuzhiyun  * FITNESS FOR ANY PARTICULAR PURPOSE.
13*4882a593Smuzhiyun  *
14*4882a593Smuzhiyun  * Many thanks to Alessandro Rubini and Jonathan Corbet!
15*4882a593Smuzhiyun  *
16*4882a593Smuzhiyun  * Based strongly on code by:
17*4882a593Smuzhiyun  *
18*4882a593Smuzhiyun  * Author: Yong-iL Joh <tolkien@mizi.com>
19*4882a593Smuzhiyun  *
20*4882a593Smuzhiyun  * Author:  Andrew Christian
21*4882a593Smuzhiyun  *          15 May 2002
22*4882a593Smuzhiyun  */
23*4882a593Smuzhiyun 
24*4882a593Smuzhiyun #ifndef LINUX_MMC_MMC_H
25*4882a593Smuzhiyun #define LINUX_MMC_MMC_H
26*4882a593Smuzhiyun 
27*4882a593Smuzhiyun #include <linux/types.h>
28*4882a593Smuzhiyun 
29*4882a593Smuzhiyun /* Standard MMC commands (4.1)           type  argument     response */
30*4882a593Smuzhiyun    /* class 1 */
31*4882a593Smuzhiyun #define MMC_GO_IDLE_STATE         0   /* bc                          */
32*4882a593Smuzhiyun #define MMC_SEND_OP_COND          1   /* bcr  [31:0] OCR         R3  */
33*4882a593Smuzhiyun #define MMC_ALL_SEND_CID          2   /* bcr                     R2  */
34*4882a593Smuzhiyun #define MMC_SET_RELATIVE_ADDR     3   /* ac   [31:16] RCA        R1  */
35*4882a593Smuzhiyun #define MMC_SET_DSR               4   /* bc   [31:16] RCA            */
36*4882a593Smuzhiyun #define MMC_SLEEP_AWAKE		  5   /* ac   [31:16] RCA 15:flg R1b */
37*4882a593Smuzhiyun #define MMC_SWITCH                6   /* ac   [31:0] See below   R1b */
38*4882a593Smuzhiyun #define MMC_SELECT_CARD           7   /* ac   [31:16] RCA        R1  */
39*4882a593Smuzhiyun #define MMC_SEND_EXT_CSD          8   /* adtc                    R1  */
40*4882a593Smuzhiyun #define MMC_SEND_CSD              9   /* ac   [31:16] RCA        R2  */
41*4882a593Smuzhiyun #define MMC_SEND_CID             10   /* ac   [31:16] RCA        R2  */
42*4882a593Smuzhiyun #define MMC_READ_DAT_UNTIL_STOP  11   /* adtc [31:0] dadr        R1  */
43*4882a593Smuzhiyun #define MMC_STOP_TRANSMISSION    12   /* ac                      R1b */
44*4882a593Smuzhiyun #define MMC_SEND_STATUS          13   /* ac   [31:16] RCA        R1  */
45*4882a593Smuzhiyun #define MMC_BUS_TEST_R           14   /* adtc                    R1  */
46*4882a593Smuzhiyun #define MMC_GO_INACTIVE_STATE    15   /* ac   [31:16] RCA            */
47*4882a593Smuzhiyun #define MMC_BUS_TEST_W           19   /* adtc                    R1  */
48*4882a593Smuzhiyun #define MMC_SPI_READ_OCR         58   /* spi                  spi_R3 */
49*4882a593Smuzhiyun #define MMC_SPI_CRC_ON_OFF       59   /* spi  [0:0] flag      spi_R1 */
50*4882a593Smuzhiyun 
51*4882a593Smuzhiyun   /* class 2 */
52*4882a593Smuzhiyun #define MMC_SET_BLOCKLEN         16   /* ac   [31:0] block len   R1  */
53*4882a593Smuzhiyun #define MMC_READ_SINGLE_BLOCK    17   /* adtc [31:0] data addr   R1  */
54*4882a593Smuzhiyun #define MMC_READ_MULTIPLE_BLOCK  18   /* adtc [31:0] data addr   R1  */
55*4882a593Smuzhiyun #define MMC_SEND_TUNING_BLOCK    19   /* adtc                    R1  */
56*4882a593Smuzhiyun #define MMC_SEND_TUNING_BLOCK_HS200	21	/* adtc R1  */
57*4882a593Smuzhiyun 
58*4882a593Smuzhiyun   /* class 3 */
59*4882a593Smuzhiyun #define MMC_WRITE_DAT_UNTIL_STOP 20   /* adtc [31:0] data addr   R1  */
60*4882a593Smuzhiyun 
61*4882a593Smuzhiyun   /* class 4 */
62*4882a593Smuzhiyun #define MMC_SET_BLOCK_COUNT      23   /* adtc [31:0] data addr   R1  */
63*4882a593Smuzhiyun #define MMC_WRITE_BLOCK          24   /* adtc [31:0] data addr   R1  */
64*4882a593Smuzhiyun #define MMC_WRITE_MULTIPLE_BLOCK 25   /* adtc                    R1  */
65*4882a593Smuzhiyun #define MMC_PROGRAM_CID          26   /* adtc                    R1  */
66*4882a593Smuzhiyun #define MMC_PROGRAM_CSD          27   /* adtc                    R1  */
67*4882a593Smuzhiyun 
68*4882a593Smuzhiyun   /* class 6 */
69*4882a593Smuzhiyun #define MMC_SET_WRITE_PROT       28   /* ac   [31:0] data addr   R1b */
70*4882a593Smuzhiyun #define MMC_CLR_WRITE_PROT       29   /* ac   [31:0] data addr   R1b */
71*4882a593Smuzhiyun #define MMC_SEND_WRITE_PROT      30   /* adtc [31:0] wpdata addr R1  */
72*4882a593Smuzhiyun 
73*4882a593Smuzhiyun   /* class 5 */
74*4882a593Smuzhiyun #define MMC_ERASE_GROUP_START    35   /* ac   [31:0] data addr   R1  */
75*4882a593Smuzhiyun #define MMC_ERASE_GROUP_END      36   /* ac   [31:0] data addr   R1  */
76*4882a593Smuzhiyun #define MMC_ERASE                38   /* ac                      R1b */
77*4882a593Smuzhiyun 
78*4882a593Smuzhiyun   /* class 9 */
79*4882a593Smuzhiyun #define MMC_FAST_IO              39   /* ac   <Complex>          R4  */
80*4882a593Smuzhiyun #define MMC_GO_IRQ_STATE         40   /* bcr                     R5  */
81*4882a593Smuzhiyun 
82*4882a593Smuzhiyun   /* class 7 */
83*4882a593Smuzhiyun #define MMC_LOCK_UNLOCK          42   /* adtc                    R1b */
84*4882a593Smuzhiyun 
85*4882a593Smuzhiyun   /* class 8 */
86*4882a593Smuzhiyun #define MMC_APP_CMD              55   /* ac   [31:16] RCA        R1  */
87*4882a593Smuzhiyun #define MMC_GEN_CMD              56   /* adtc [0] RD/WR          R1  */
88*4882a593Smuzhiyun 
89*4882a593Smuzhiyun   /* class 11 */
90*4882a593Smuzhiyun #define MMC_QUE_TASK_PARAMS      44   /* ac   [20:16] task id    R1  */
91*4882a593Smuzhiyun #define MMC_QUE_TASK_ADDR        45   /* ac   [31:0] data addr   R1  */
92*4882a593Smuzhiyun #define MMC_EXECUTE_READ_TASK    46   /* adtc [20:16] task id    R1  */
93*4882a593Smuzhiyun #define MMC_EXECUTE_WRITE_TASK   47   /* adtc [20:16] task id    R1  */
94*4882a593Smuzhiyun #define MMC_CMDQ_TASK_MGMT       48   /* ac   [20:16] task id    R1b */
95*4882a593Smuzhiyun 
mmc_op_multi(u32 opcode)96*4882a593Smuzhiyun static inline bool mmc_op_multi(u32 opcode)
97*4882a593Smuzhiyun {
98*4882a593Smuzhiyun 	return opcode == MMC_WRITE_MULTIPLE_BLOCK ||
99*4882a593Smuzhiyun 	       opcode == MMC_READ_MULTIPLE_BLOCK;
100*4882a593Smuzhiyun }
101*4882a593Smuzhiyun 
102*4882a593Smuzhiyun /*
103*4882a593Smuzhiyun  * MMC_SWITCH argument format:
104*4882a593Smuzhiyun  *
105*4882a593Smuzhiyun  *	[31:26] Always 0
106*4882a593Smuzhiyun  *	[25:24] Access Mode
107*4882a593Smuzhiyun  *	[23:16] Location of target Byte in EXT_CSD
108*4882a593Smuzhiyun  *	[15:08] Value Byte
109*4882a593Smuzhiyun  *	[07:03] Always 0
110*4882a593Smuzhiyun  *	[02:00] Command Set
111*4882a593Smuzhiyun  */
112*4882a593Smuzhiyun 
113*4882a593Smuzhiyun /*
114*4882a593Smuzhiyun   MMC status in R1, for native mode (SPI bits are different)
115*4882a593Smuzhiyun   Type
116*4882a593Smuzhiyun 	e : error bit
117*4882a593Smuzhiyun 	s : status bit
118*4882a593Smuzhiyun 	r : detected and set for the actual command response
119*4882a593Smuzhiyun 	x : detected and set during command execution. the host must poll
120*4882a593Smuzhiyun             the card by sending status command in order to read these bits.
121*4882a593Smuzhiyun   Clear condition
122*4882a593Smuzhiyun 	a : according to the card state
123*4882a593Smuzhiyun 	b : always related to the previous command. Reception of
124*4882a593Smuzhiyun             a valid command will clear it (with a delay of one command)
125*4882a593Smuzhiyun 	c : clear by read
126*4882a593Smuzhiyun  */
127*4882a593Smuzhiyun 
128*4882a593Smuzhiyun #define R1_OUT_OF_RANGE		(1 << 31)	/* er, c */
129*4882a593Smuzhiyun #define R1_ADDRESS_ERROR	(1 << 30)	/* erx, c */
130*4882a593Smuzhiyun #define R1_BLOCK_LEN_ERROR	(1 << 29)	/* er, c */
131*4882a593Smuzhiyun #define R1_ERASE_SEQ_ERROR      (1 << 28)	/* er, c */
132*4882a593Smuzhiyun #define R1_ERASE_PARAM		(1 << 27)	/* ex, c */
133*4882a593Smuzhiyun #define R1_WP_VIOLATION		(1 << 26)	/* erx, c */
134*4882a593Smuzhiyun #define R1_CARD_IS_LOCKED	(1 << 25)	/* sx, a */
135*4882a593Smuzhiyun #define R1_LOCK_UNLOCK_FAILED	(1 << 24)	/* erx, c */
136*4882a593Smuzhiyun #define R1_COM_CRC_ERROR	(1 << 23)	/* er, b */
137*4882a593Smuzhiyun #define R1_ILLEGAL_COMMAND	(1 << 22)	/* er, b */
138*4882a593Smuzhiyun #define R1_CARD_ECC_FAILED	(1 << 21)	/* ex, c */
139*4882a593Smuzhiyun #define R1_CC_ERROR		(1 << 20)	/* erx, c */
140*4882a593Smuzhiyun #define R1_ERROR		(1 << 19)	/* erx, c */
141*4882a593Smuzhiyun #define R1_UNDERRUN		(1 << 18)	/* ex, c */
142*4882a593Smuzhiyun #define R1_OVERRUN		(1 << 17)	/* ex, c */
143*4882a593Smuzhiyun #define R1_CID_CSD_OVERWRITE	(1 << 16)	/* erx, c, CID/CSD overwrite */
144*4882a593Smuzhiyun #define R1_WP_ERASE_SKIP	(1 << 15)	/* sx, c */
145*4882a593Smuzhiyun #define R1_CARD_ECC_DISABLED	(1 << 14)	/* sx, a */
146*4882a593Smuzhiyun #define R1_ERASE_RESET		(1 << 13)	/* sr, c */
147*4882a593Smuzhiyun #define R1_STATUS(x)            (x & 0xFFF9A000)
148*4882a593Smuzhiyun #define R1_CURRENT_STATE(x)	((x & 0x00001E00) >> 9)	/* sx, b (4 bits) */
149*4882a593Smuzhiyun #define R1_READY_FOR_DATA	(1 << 8)	/* sx, a */
150*4882a593Smuzhiyun #define R1_SWITCH_ERROR		(1 << 7)	/* sx, c */
151*4882a593Smuzhiyun #define R1_EXCEPTION_EVENT	(1 << 6)	/* sr, a */
152*4882a593Smuzhiyun #define R1_APP_CMD		(1 << 5)	/* sr, c */
153*4882a593Smuzhiyun 
154*4882a593Smuzhiyun #define R1_STATE_IDLE	0
155*4882a593Smuzhiyun #define R1_STATE_READY	1
156*4882a593Smuzhiyun #define R1_STATE_IDENT	2
157*4882a593Smuzhiyun #define R1_STATE_STBY	3
158*4882a593Smuzhiyun #define R1_STATE_TRAN	4
159*4882a593Smuzhiyun #define R1_STATE_DATA	5
160*4882a593Smuzhiyun #define R1_STATE_RCV	6
161*4882a593Smuzhiyun #define R1_STATE_PRG	7
162*4882a593Smuzhiyun #define R1_STATE_DIS	8
163*4882a593Smuzhiyun 
mmc_ready_for_data(u32 status)164*4882a593Smuzhiyun static inline bool mmc_ready_for_data(u32 status)
165*4882a593Smuzhiyun {
166*4882a593Smuzhiyun 	/*
167*4882a593Smuzhiyun 	 * Some cards mishandle the status bits, so make sure to check both the
168*4882a593Smuzhiyun 	 * busy indication and the card state.
169*4882a593Smuzhiyun 	 */
170*4882a593Smuzhiyun 	return status & R1_READY_FOR_DATA &&
171*4882a593Smuzhiyun 	       R1_CURRENT_STATE(status) == R1_STATE_TRAN;
172*4882a593Smuzhiyun }
173*4882a593Smuzhiyun 
174*4882a593Smuzhiyun /*
175*4882a593Smuzhiyun  * MMC/SD in SPI mode reports R1 status always, and R2 for SEND_STATUS
176*4882a593Smuzhiyun  * R1 is the low order byte; R2 is the next highest byte, when present.
177*4882a593Smuzhiyun  */
178*4882a593Smuzhiyun #define R1_SPI_IDLE		(1 << 0)
179*4882a593Smuzhiyun #define R1_SPI_ERASE_RESET	(1 << 1)
180*4882a593Smuzhiyun #define R1_SPI_ILLEGAL_COMMAND	(1 << 2)
181*4882a593Smuzhiyun #define R1_SPI_COM_CRC		(1 << 3)
182*4882a593Smuzhiyun #define R1_SPI_ERASE_SEQ	(1 << 4)
183*4882a593Smuzhiyun #define R1_SPI_ADDRESS		(1 << 5)
184*4882a593Smuzhiyun #define R1_SPI_PARAMETER	(1 << 6)
185*4882a593Smuzhiyun /* R1 bit 7 is always zero */
186*4882a593Smuzhiyun #define R2_SPI_CARD_LOCKED	(1 << 8)
187*4882a593Smuzhiyun #define R2_SPI_WP_ERASE_SKIP	(1 << 9)	/* or lock/unlock fail */
188*4882a593Smuzhiyun #define R2_SPI_LOCK_UNLOCK_FAIL	R2_SPI_WP_ERASE_SKIP
189*4882a593Smuzhiyun #define R2_SPI_ERROR		(1 << 10)
190*4882a593Smuzhiyun #define R2_SPI_CC_ERROR		(1 << 11)
191*4882a593Smuzhiyun #define R2_SPI_CARD_ECC_ERROR	(1 << 12)
192*4882a593Smuzhiyun #define R2_SPI_WP_VIOLATION	(1 << 13)
193*4882a593Smuzhiyun #define R2_SPI_ERASE_PARAM	(1 << 14)
194*4882a593Smuzhiyun #define R2_SPI_OUT_OF_RANGE	(1 << 15)	/* or CSD overwrite */
195*4882a593Smuzhiyun #define R2_SPI_CSD_OVERWRITE	R2_SPI_OUT_OF_RANGE
196*4882a593Smuzhiyun 
197*4882a593Smuzhiyun /*
198*4882a593Smuzhiyun  * OCR bits are mostly in host.h
199*4882a593Smuzhiyun  */
200*4882a593Smuzhiyun #define MMC_CARD_BUSY	0x80000000	/* Card Power up status bit */
201*4882a593Smuzhiyun 
202*4882a593Smuzhiyun /*
203*4882a593Smuzhiyun  * Card Command Classes (CCC)
204*4882a593Smuzhiyun  */
205*4882a593Smuzhiyun #define CCC_BASIC		(1<<0)	/* (0) Basic protocol functions */
206*4882a593Smuzhiyun 					/* (CMD0,1,2,3,4,7,9,10,12,13,15) */
207*4882a593Smuzhiyun 					/* (and for SPI, CMD58,59) */
208*4882a593Smuzhiyun #define CCC_STREAM_READ		(1<<1)	/* (1) Stream read commands */
209*4882a593Smuzhiyun 					/* (CMD11) */
210*4882a593Smuzhiyun #define CCC_BLOCK_READ		(1<<2)	/* (2) Block read commands */
211*4882a593Smuzhiyun 					/* (CMD16,17,18) */
212*4882a593Smuzhiyun #define CCC_STREAM_WRITE	(1<<3)	/* (3) Stream write commands */
213*4882a593Smuzhiyun 					/* (CMD20) */
214*4882a593Smuzhiyun #define CCC_BLOCK_WRITE		(1<<4)	/* (4) Block write commands */
215*4882a593Smuzhiyun 					/* (CMD16,24,25,26,27) */
216*4882a593Smuzhiyun #define CCC_ERASE		(1<<5)	/* (5) Ability to erase blocks */
217*4882a593Smuzhiyun 					/* (CMD32,33,34,35,36,37,38,39) */
218*4882a593Smuzhiyun #define CCC_WRITE_PROT		(1<<6)	/* (6) Able to write protect blocks */
219*4882a593Smuzhiyun 					/* (CMD28,29,30) */
220*4882a593Smuzhiyun #define CCC_LOCK_CARD		(1<<7)	/* (7) Able to lock down card */
221*4882a593Smuzhiyun 					/* (CMD16,CMD42) */
222*4882a593Smuzhiyun #define CCC_APP_SPEC		(1<<8)	/* (8) Application specific */
223*4882a593Smuzhiyun 					/* (CMD55,56,57,ACMD*) */
224*4882a593Smuzhiyun #define CCC_IO_MODE		(1<<9)	/* (9) I/O mode */
225*4882a593Smuzhiyun 					/* (CMD5,39,40,52,53) */
226*4882a593Smuzhiyun #define CCC_SWITCH		(1<<10)	/* (10) High speed switch */
227*4882a593Smuzhiyun 					/* (CMD6,34,35,36,37,50) */
228*4882a593Smuzhiyun 					/* (11) Reserved */
229*4882a593Smuzhiyun 					/* (CMD?) */
230*4882a593Smuzhiyun 
231*4882a593Smuzhiyun /*
232*4882a593Smuzhiyun  * CSD field definitions
233*4882a593Smuzhiyun  */
234*4882a593Smuzhiyun 
235*4882a593Smuzhiyun #define CSD_STRUCT_VER_1_0  0           /* Valid for system specification 1.0 - 1.2 */
236*4882a593Smuzhiyun #define CSD_STRUCT_VER_1_1  1           /* Valid for system specification 1.4 - 2.2 */
237*4882a593Smuzhiyun #define CSD_STRUCT_VER_1_2  2           /* Valid for system specification 3.1 - 3.2 - 3.31 - 4.0 - 4.1 */
238*4882a593Smuzhiyun #define CSD_STRUCT_EXT_CSD  3           /* Version is coded in CSD_STRUCTURE in EXT_CSD */
239*4882a593Smuzhiyun 
240*4882a593Smuzhiyun #define CSD_SPEC_VER_0      0           /* Implements system specification 1.0 - 1.2 */
241*4882a593Smuzhiyun #define CSD_SPEC_VER_1      1           /* Implements system specification 1.4 */
242*4882a593Smuzhiyun #define CSD_SPEC_VER_2      2           /* Implements system specification 2.0 - 2.2 */
243*4882a593Smuzhiyun #define CSD_SPEC_VER_3      3           /* Implements system specification 3.1 - 3.2 - 3.31 */
244*4882a593Smuzhiyun #define CSD_SPEC_VER_4      4           /* Implements system specification 4.0 - 4.1 */
245*4882a593Smuzhiyun 
246*4882a593Smuzhiyun /*
247*4882a593Smuzhiyun  * EXT_CSD fields
248*4882a593Smuzhiyun  */
249*4882a593Smuzhiyun 
250*4882a593Smuzhiyun #define EXT_CSD_CMDQ_MODE_EN		15	/* R/W */
251*4882a593Smuzhiyun #define EXT_CSD_FLUSH_CACHE		32      /* W */
252*4882a593Smuzhiyun #define EXT_CSD_CACHE_CTRL		33      /* R/W */
253*4882a593Smuzhiyun #define EXT_CSD_POWER_OFF_NOTIFICATION	34	/* R/W */
254*4882a593Smuzhiyun #define EXT_CSD_PACKED_FAILURE_INDEX	35	/* RO */
255*4882a593Smuzhiyun #define EXT_CSD_PACKED_CMD_STATUS	36	/* RO */
256*4882a593Smuzhiyun #define EXT_CSD_EXP_EVENTS_STATUS	54	/* RO, 2 bytes */
257*4882a593Smuzhiyun #define EXT_CSD_EXP_EVENTS_CTRL		56	/* R/W, 2 bytes */
258*4882a593Smuzhiyun #define EXT_CSD_DATA_SECTOR_SIZE	61	/* R */
259*4882a593Smuzhiyun #define EXT_CSD_GP_SIZE_MULT		143	/* R/W */
260*4882a593Smuzhiyun #define EXT_CSD_PARTITION_SETTING_COMPLETED 155	/* R/W */
261*4882a593Smuzhiyun #define EXT_CSD_PARTITION_ATTRIBUTE	156	/* R/W */
262*4882a593Smuzhiyun #define EXT_CSD_PARTITION_SUPPORT	160	/* RO */
263*4882a593Smuzhiyun #define EXT_CSD_HPI_MGMT		161	/* R/W */
264*4882a593Smuzhiyun #define EXT_CSD_RST_N_FUNCTION		162	/* R/W */
265*4882a593Smuzhiyun #define EXT_CSD_BKOPS_EN		163	/* R/W */
266*4882a593Smuzhiyun #define EXT_CSD_BKOPS_START		164	/* W */
267*4882a593Smuzhiyun #define EXT_CSD_SANITIZE_START		165     /* W */
268*4882a593Smuzhiyun #define EXT_CSD_WR_REL_PARAM		166	/* RO */
269*4882a593Smuzhiyun #define EXT_CSD_RPMB_MULT		168	/* RO */
270*4882a593Smuzhiyun #define EXT_CSD_FW_CONFIG		169	/* R/W */
271*4882a593Smuzhiyun #define EXT_CSD_BOOT_WP			173	/* R/W */
272*4882a593Smuzhiyun #define EXT_CSD_ERASE_GROUP_DEF		175	/* R/W */
273*4882a593Smuzhiyun #define EXT_CSD_PART_CONFIG		179	/* R/W */
274*4882a593Smuzhiyun #define EXT_CSD_ERASED_MEM_CONT		181	/* RO */
275*4882a593Smuzhiyun #define EXT_CSD_BUS_WIDTH		183	/* R/W */
276*4882a593Smuzhiyun #define EXT_CSD_STROBE_SUPPORT		184	/* RO */
277*4882a593Smuzhiyun #define EXT_CSD_HS_TIMING		185	/* R/W */
278*4882a593Smuzhiyun #define EXT_CSD_POWER_CLASS		187	/* R/W */
279*4882a593Smuzhiyun #define EXT_CSD_REV			192	/* RO */
280*4882a593Smuzhiyun #define EXT_CSD_STRUCTURE		194	/* RO */
281*4882a593Smuzhiyun #define EXT_CSD_CARD_TYPE		196	/* RO */
282*4882a593Smuzhiyun #define EXT_CSD_DRIVER_STRENGTH		197	/* RO */
283*4882a593Smuzhiyun #define EXT_CSD_OUT_OF_INTERRUPT_TIME	198	/* RO */
284*4882a593Smuzhiyun #define EXT_CSD_PART_SWITCH_TIME        199     /* RO */
285*4882a593Smuzhiyun #define EXT_CSD_PWR_CL_52_195		200	/* RO */
286*4882a593Smuzhiyun #define EXT_CSD_PWR_CL_26_195		201	/* RO */
287*4882a593Smuzhiyun #define EXT_CSD_PWR_CL_52_360		202	/* RO */
288*4882a593Smuzhiyun #define EXT_CSD_PWR_CL_26_360		203	/* RO */
289*4882a593Smuzhiyun #define EXT_CSD_SEC_CNT			212	/* RO, 4 bytes */
290*4882a593Smuzhiyun #define EXT_CSD_S_A_TIMEOUT		217	/* RO */
291*4882a593Smuzhiyun #define EXT_CSD_REL_WR_SEC_C		222	/* RO */
292*4882a593Smuzhiyun #define EXT_CSD_HC_WP_GRP_SIZE		221	/* RO */
293*4882a593Smuzhiyun #define EXT_CSD_ERASE_TIMEOUT_MULT	223	/* RO */
294*4882a593Smuzhiyun #define EXT_CSD_HC_ERASE_GRP_SIZE	224	/* RO */
295*4882a593Smuzhiyun #define EXT_CSD_BOOT_MULT		226	/* RO */
296*4882a593Smuzhiyun #define EXT_CSD_SEC_TRIM_MULT		229	/* RO */
297*4882a593Smuzhiyun #define EXT_CSD_SEC_ERASE_MULT		230	/* RO */
298*4882a593Smuzhiyun #define EXT_CSD_SEC_FEATURE_SUPPORT	231	/* RO */
299*4882a593Smuzhiyun #define EXT_CSD_TRIM_MULT		232	/* RO */
300*4882a593Smuzhiyun #define EXT_CSD_PWR_CL_200_195		236	/* RO */
301*4882a593Smuzhiyun #define EXT_CSD_PWR_CL_200_360		237	/* RO */
302*4882a593Smuzhiyun #define EXT_CSD_PWR_CL_DDR_52_195	238	/* RO */
303*4882a593Smuzhiyun #define EXT_CSD_PWR_CL_DDR_52_360	239	/* RO */
304*4882a593Smuzhiyun #define EXT_CSD_BKOPS_STATUS		246	/* RO */
305*4882a593Smuzhiyun #define EXT_CSD_POWER_OFF_LONG_TIME	247	/* RO */
306*4882a593Smuzhiyun #define EXT_CSD_GENERIC_CMD6_TIME	248	/* RO */
307*4882a593Smuzhiyun #define EXT_CSD_CACHE_SIZE		249	/* RO, 4 bytes */
308*4882a593Smuzhiyun #define EXT_CSD_PWR_CL_DDR_200_360	253	/* RO */
309*4882a593Smuzhiyun #define EXT_CSD_FIRMWARE_VERSION	254	/* RO, 8 bytes */
310*4882a593Smuzhiyun #define EXT_CSD_PRE_EOL_INFO		267	/* RO */
311*4882a593Smuzhiyun #define EXT_CSD_DEVICE_LIFE_TIME_EST_TYP_A	268	/* RO */
312*4882a593Smuzhiyun #define EXT_CSD_DEVICE_LIFE_TIME_EST_TYP_B	269	/* RO */
313*4882a593Smuzhiyun #define EXT_CSD_CMDQ_DEPTH		307	/* RO */
314*4882a593Smuzhiyun #define EXT_CSD_CMDQ_SUPPORT		308	/* RO */
315*4882a593Smuzhiyun #define EXT_CSD_SUPPORTED_MODE		493	/* RO */
316*4882a593Smuzhiyun #define EXT_CSD_TAG_UNIT_SIZE		498	/* RO */
317*4882a593Smuzhiyun #define EXT_CSD_DATA_TAG_SUPPORT	499	/* RO */
318*4882a593Smuzhiyun #define EXT_CSD_MAX_PACKED_WRITES	500	/* RO */
319*4882a593Smuzhiyun #define EXT_CSD_MAX_PACKED_READS	501	/* RO */
320*4882a593Smuzhiyun #define EXT_CSD_BKOPS_SUPPORT		502	/* RO */
321*4882a593Smuzhiyun #define EXT_CSD_HPI_FEATURES		503	/* RO */
322*4882a593Smuzhiyun 
323*4882a593Smuzhiyun /*
324*4882a593Smuzhiyun  * EXT_CSD field definitions
325*4882a593Smuzhiyun  */
326*4882a593Smuzhiyun 
327*4882a593Smuzhiyun #define EXT_CSD_WR_REL_PARAM_EN		(1<<2)
328*4882a593Smuzhiyun #define EXT_CSD_WR_REL_PARAM_EN_RPMB_REL_WR	(1<<4)
329*4882a593Smuzhiyun 
330*4882a593Smuzhiyun #define EXT_CSD_BOOT_WP_B_PWR_WP_DIS	(0x40)
331*4882a593Smuzhiyun #define EXT_CSD_BOOT_WP_B_PERM_WP_DIS	(0x10)
332*4882a593Smuzhiyun #define EXT_CSD_BOOT_WP_B_PERM_WP_EN	(0x04)
333*4882a593Smuzhiyun #define EXT_CSD_BOOT_WP_B_PWR_WP_EN	(0x01)
334*4882a593Smuzhiyun 
335*4882a593Smuzhiyun #define EXT_CSD_PART_CONFIG_ACC_MASK	(0x7)
336*4882a593Smuzhiyun #define EXT_CSD_PART_CONFIG_ACC_BOOT0	(0x1)
337*4882a593Smuzhiyun #define EXT_CSD_PART_CONFIG_ACC_RPMB	(0x3)
338*4882a593Smuzhiyun #define EXT_CSD_PART_CONFIG_ACC_GP0	(0x4)
339*4882a593Smuzhiyun 
340*4882a593Smuzhiyun #define EXT_CSD_PART_SETTING_COMPLETED	(0x1)
341*4882a593Smuzhiyun #define EXT_CSD_PART_SUPPORT_PART_EN	(0x1)
342*4882a593Smuzhiyun 
343*4882a593Smuzhiyun #define EXT_CSD_CMD_SET_NORMAL		(1<<0)
344*4882a593Smuzhiyun #define EXT_CSD_CMD_SET_SECURE		(1<<1)
345*4882a593Smuzhiyun #define EXT_CSD_CMD_SET_CPSECURE	(1<<2)
346*4882a593Smuzhiyun 
347*4882a593Smuzhiyun #define EXT_CSD_CARD_TYPE_HS_26	(1<<0)	/* Card can run at 26MHz */
348*4882a593Smuzhiyun #define EXT_CSD_CARD_TYPE_HS_52	(1<<1)	/* Card can run at 52MHz */
349*4882a593Smuzhiyun #define EXT_CSD_CARD_TYPE_HS	(EXT_CSD_CARD_TYPE_HS_26 | \
350*4882a593Smuzhiyun 				 EXT_CSD_CARD_TYPE_HS_52)
351*4882a593Smuzhiyun #define EXT_CSD_CARD_TYPE_DDR_1_8V  (1<<2)   /* Card can run at 52MHz */
352*4882a593Smuzhiyun 					     /* DDR mode @1.8V or 3V I/O */
353*4882a593Smuzhiyun #define EXT_CSD_CARD_TYPE_DDR_1_2V  (1<<3)   /* Card can run at 52MHz */
354*4882a593Smuzhiyun 					     /* DDR mode @1.2V I/O */
355*4882a593Smuzhiyun #define EXT_CSD_CARD_TYPE_DDR_52       (EXT_CSD_CARD_TYPE_DDR_1_8V  \
356*4882a593Smuzhiyun 					| EXT_CSD_CARD_TYPE_DDR_1_2V)
357*4882a593Smuzhiyun #define EXT_CSD_CARD_TYPE_HS200_1_8V	(1<<4)	/* Card can run at 200MHz */
358*4882a593Smuzhiyun #define EXT_CSD_CARD_TYPE_HS200_1_2V	(1<<5)	/* Card can run at 200MHz */
359*4882a593Smuzhiyun 						/* SDR mode @1.2V I/O */
360*4882a593Smuzhiyun #define EXT_CSD_CARD_TYPE_HS200		(EXT_CSD_CARD_TYPE_HS200_1_8V | \
361*4882a593Smuzhiyun 					 EXT_CSD_CARD_TYPE_HS200_1_2V)
362*4882a593Smuzhiyun #define EXT_CSD_CARD_TYPE_HS400_1_8V	(1<<6)	/* Card can run at 200MHz DDR, 1.8V */
363*4882a593Smuzhiyun #define EXT_CSD_CARD_TYPE_HS400_1_2V	(1<<7)	/* Card can run at 200MHz DDR, 1.2V */
364*4882a593Smuzhiyun #define EXT_CSD_CARD_TYPE_HS400		(EXT_CSD_CARD_TYPE_HS400_1_8V | \
365*4882a593Smuzhiyun 					 EXT_CSD_CARD_TYPE_HS400_1_2V)
366*4882a593Smuzhiyun #define EXT_CSD_CARD_TYPE_HS400ES	(1<<8)	/* Card can run at HS400ES */
367*4882a593Smuzhiyun 
368*4882a593Smuzhiyun #define EXT_CSD_BUS_WIDTH_1	0	/* Card is in 1 bit mode */
369*4882a593Smuzhiyun #define EXT_CSD_BUS_WIDTH_4	1	/* Card is in 4 bit mode */
370*4882a593Smuzhiyun #define EXT_CSD_BUS_WIDTH_8	2	/* Card is in 8 bit mode */
371*4882a593Smuzhiyun #define EXT_CSD_DDR_BUS_WIDTH_4	5	/* Card is in 4 bit DDR mode */
372*4882a593Smuzhiyun #define EXT_CSD_DDR_BUS_WIDTH_8	6	/* Card is in 8 bit DDR mode */
373*4882a593Smuzhiyun #define EXT_CSD_BUS_WIDTH_STROBE BIT(7)	/* Enhanced strobe mode */
374*4882a593Smuzhiyun 
375*4882a593Smuzhiyun #define EXT_CSD_TIMING_BC	0	/* Backwards compatility */
376*4882a593Smuzhiyun #define EXT_CSD_TIMING_HS	1	/* High speed */
377*4882a593Smuzhiyun #define EXT_CSD_TIMING_HS200	2	/* HS200 */
378*4882a593Smuzhiyun #define EXT_CSD_TIMING_HS400	3	/* HS400 */
379*4882a593Smuzhiyun #define EXT_CSD_DRV_STR_SHIFT	4	/* Driver Strength shift */
380*4882a593Smuzhiyun 
381*4882a593Smuzhiyun #define EXT_CSD_SEC_ER_EN	BIT(0)
382*4882a593Smuzhiyun #define EXT_CSD_SEC_BD_BLK_EN	BIT(2)
383*4882a593Smuzhiyun #define EXT_CSD_SEC_GB_CL_EN	BIT(4)
384*4882a593Smuzhiyun #define EXT_CSD_SEC_SANITIZE	BIT(6)  /* v4.5 only */
385*4882a593Smuzhiyun 
386*4882a593Smuzhiyun #define EXT_CSD_RST_N_EN_MASK	0x3
387*4882a593Smuzhiyun #define EXT_CSD_RST_N_ENABLED	1	/* RST_n is enabled on card */
388*4882a593Smuzhiyun 
389*4882a593Smuzhiyun #define EXT_CSD_NO_POWER_NOTIFICATION	0
390*4882a593Smuzhiyun #define EXT_CSD_POWER_ON		1
391*4882a593Smuzhiyun #define EXT_CSD_POWER_OFF_SHORT		2
392*4882a593Smuzhiyun #define EXT_CSD_POWER_OFF_LONG		3
393*4882a593Smuzhiyun 
394*4882a593Smuzhiyun #define EXT_CSD_PWR_CL_8BIT_MASK	0xF0	/* 8 bit PWR CLS */
395*4882a593Smuzhiyun #define EXT_CSD_PWR_CL_4BIT_MASK	0x0F	/* 8 bit PWR CLS */
396*4882a593Smuzhiyun #define EXT_CSD_PWR_CL_8BIT_SHIFT	4
397*4882a593Smuzhiyun #define EXT_CSD_PWR_CL_4BIT_SHIFT	0
398*4882a593Smuzhiyun 
399*4882a593Smuzhiyun #define EXT_CSD_PACKED_EVENT_EN	BIT(3)
400*4882a593Smuzhiyun 
401*4882a593Smuzhiyun /*
402*4882a593Smuzhiyun  * EXCEPTION_EVENT_STATUS field
403*4882a593Smuzhiyun  */
404*4882a593Smuzhiyun #define EXT_CSD_URGENT_BKOPS		BIT(0)
405*4882a593Smuzhiyun #define EXT_CSD_DYNCAP_NEEDED		BIT(1)
406*4882a593Smuzhiyun #define EXT_CSD_SYSPOOL_EXHAUSTED	BIT(2)
407*4882a593Smuzhiyun #define EXT_CSD_PACKED_FAILURE		BIT(3)
408*4882a593Smuzhiyun 
409*4882a593Smuzhiyun #define EXT_CSD_PACKED_GENERIC_ERROR	BIT(0)
410*4882a593Smuzhiyun #define EXT_CSD_PACKED_INDEXED_ERROR	BIT(1)
411*4882a593Smuzhiyun 
412*4882a593Smuzhiyun /*
413*4882a593Smuzhiyun  * BKOPS status level
414*4882a593Smuzhiyun  */
415*4882a593Smuzhiyun #define EXT_CSD_BKOPS_LEVEL_2		0x2
416*4882a593Smuzhiyun 
417*4882a593Smuzhiyun /*
418*4882a593Smuzhiyun  * BKOPS modes
419*4882a593Smuzhiyun  */
420*4882a593Smuzhiyun #define EXT_CSD_MANUAL_BKOPS_MASK	0x01
421*4882a593Smuzhiyun #define EXT_CSD_AUTO_BKOPS_MASK		0x02
422*4882a593Smuzhiyun 
423*4882a593Smuzhiyun /*
424*4882a593Smuzhiyun  * Command Queue
425*4882a593Smuzhiyun  */
426*4882a593Smuzhiyun #define EXT_CSD_CMDQ_MODE_ENABLED	BIT(0)
427*4882a593Smuzhiyun #define EXT_CSD_CMDQ_DEPTH_MASK		GENMASK(4, 0)
428*4882a593Smuzhiyun #define EXT_CSD_CMDQ_SUPPORTED		BIT(0)
429*4882a593Smuzhiyun 
430*4882a593Smuzhiyun /*
431*4882a593Smuzhiyun  * MMC_SWITCH access modes
432*4882a593Smuzhiyun  */
433*4882a593Smuzhiyun #define MMC_SWITCH_MODE_CMD_SET		0x00	/* Change the command set */
434*4882a593Smuzhiyun #define MMC_SWITCH_MODE_SET_BITS	0x01	/* Set bits which are 1 in value */
435*4882a593Smuzhiyun #define MMC_SWITCH_MODE_CLEAR_BITS	0x02	/* Clear bits which are 1 in value */
436*4882a593Smuzhiyun #define MMC_SWITCH_MODE_WRITE_BYTE	0x03	/* Set target to value */
437*4882a593Smuzhiyun 
438*4882a593Smuzhiyun /*
439*4882a593Smuzhiyun  * Erase/trim/discard
440*4882a593Smuzhiyun  */
441*4882a593Smuzhiyun #define MMC_ERASE_ARG			0x00000000
442*4882a593Smuzhiyun #define MMC_SECURE_ERASE_ARG		0x80000000
443*4882a593Smuzhiyun #define MMC_TRIM_ARG			0x00000001
444*4882a593Smuzhiyun #define MMC_DISCARD_ARG			0x00000003
445*4882a593Smuzhiyun #define MMC_SECURE_TRIM1_ARG		0x80000001
446*4882a593Smuzhiyun #define MMC_SECURE_TRIM2_ARG		0x80008000
447*4882a593Smuzhiyun #define MMC_SECURE_ARGS			0x80000000
448*4882a593Smuzhiyun #define MMC_TRIM_OR_DISCARD_ARGS	0x00008003
449*4882a593Smuzhiyun 
450*4882a593Smuzhiyun #define mmc_driver_type_mask(n)		(1 << (n))
451*4882a593Smuzhiyun 
452*4882a593Smuzhiyun struct mmc_card;
453*4882a593Smuzhiyun 
454*4882a593Smuzhiyun extern int mmc_select_bus_width(struct mmc_card *card);
455*4882a593Smuzhiyun extern int mmc_select_hs(struct mmc_card *card);
456*4882a593Smuzhiyun extern int mmc_select_hs_ddr(struct mmc_card *card);
457*4882a593Smuzhiyun extern int mmc_select_hs400(struct mmc_card *card);
458*4882a593Smuzhiyun extern int mmc_hs200_tuning(struct mmc_card *card);
459*4882a593Smuzhiyun extern int mmc_select_timing(struct mmc_card *card);
460*4882a593Smuzhiyun 
461*4882a593Smuzhiyun #endif /* LINUX_MMC_MMC_H */
462