blob: 8b706bc8f15fe43e423bc5201d722421c72bb7a1 [file] [log] [blame]
wdenk71f95112003-06-15 22:40:42 +00001/*
Jerry Huang4a6ee172010-11-25 17:06:07 +00002 * Copyright 2008,2010 Freescale Semiconductor, Inc
Andy Fleming272cc702008-10-30 16:41:01 -05003 * Andy Fleming
4 *
5 * Based (loosely) on the Linux code
wdenk71f95112003-06-15 22:40:42 +00006 *
Wolfgang Denk1a459662013-07-08 09:37:19 +02007 * SPDX-License-Identifier: GPL-2.0+
wdenk71f95112003-06-15 22:40:42 +00008 */
9
10#ifndef _MMC_H_
11#define _MMC_H_
wdenk71f95112003-06-15 22:40:42 +000012
Andy Fleming272cc702008-10-30 16:41:01 -050013#include <linux/list.h>
Lad, Prabhakar0d986e62012-06-24 21:35:20 +000014#include <linux/compiler.h>
Mateusz Zalega07a2d422014-04-30 13:04:15 +020015#include <part.h>
Andy Fleming272cc702008-10-30 16:41:01 -050016
Vinoth Gnanasekaranc99a4a22018-11-12 15:20:51 +053017#define MMC_GET_MID(CID0) (CID0 >> 24)
18#define MMC_GET_PNM(CID0, CID1, CID2) (((long long int)(CID0 & 0xff) << 40) | \
19 ((long long int)CID1 << 8) | \
20 (CID2 >> 24))
21
22#define MMC_MID_MICRON 0xFE
23#define MMC_PNM_MICRON 0x4D4D43333247 // MMC32G
24
Pantelis Antoniou4b7cee52015-01-23 12:12:01 +020025/* SD/MMC version bits; 8 flags, 8 major, 8 minor, 8 change */
26#define SD_VERSION_SD (1U << 31)
27#define MMC_VERSION_MMC (1U << 30)
28
29#define MAKE_SDMMC_VERSION(a, b, c) \
30 ((((u32)(a)) << 16) | ((u32)(b) << 8) | (u32)(c))
31#define MAKE_SD_VERSION(a, b, c) \
32 (SD_VERSION_SD | MAKE_SDMMC_VERSION(a, b, c))
33#define MAKE_MMC_VERSION(a, b, c) \
34 (MMC_VERSION_MMC | MAKE_SDMMC_VERSION(a, b, c))
35
36#define EXTRACT_SDMMC_MAJOR_VERSION(x) \
37 (((u32)(x) >> 16) & 0xff)
38#define EXTRACT_SDMMC_MINOR_VERSION(x) \
39 (((u32)(x) >> 8) & 0xff)
40#define EXTRACT_SDMMC_CHANGE_VERSION(x) \
41 ((u32)(x) & 0xff)
42
43#define SD_VERSION_3 MAKE_SD_VERSION(3, 0, 0)
44#define SD_VERSION_2 MAKE_SD_VERSION(2, 0, 0)
45#define SD_VERSION_1_0 MAKE_SD_VERSION(1, 0, 0)
46#define SD_VERSION_1_10 MAKE_SD_VERSION(1, 10, 0)
47
48#define MMC_VERSION_UNKNOWN MAKE_MMC_VERSION(0, 0, 0)
49#define MMC_VERSION_1_2 MAKE_MMC_VERSION(1, 2, 0)
50#define MMC_VERSION_1_4 MAKE_MMC_VERSION(1, 4, 0)
51#define MMC_VERSION_2_2 MAKE_MMC_VERSION(2, 2, 0)
52#define MMC_VERSION_3 MAKE_MMC_VERSION(3, 0, 0)
53#define MMC_VERSION_4 MAKE_MMC_VERSION(4, 0, 0)
54#define MMC_VERSION_4_1 MAKE_MMC_VERSION(4, 1, 0)
55#define MMC_VERSION_4_2 MAKE_MMC_VERSION(4, 2, 0)
56#define MMC_VERSION_4_3 MAKE_MMC_VERSION(4, 3, 0)
57#define MMC_VERSION_4_41 MAKE_MMC_VERSION(4, 4, 1)
58#define MMC_VERSION_4_5 MAKE_MMC_VERSION(4, 5, 0)
59#define MMC_VERSION_5_0 MAKE_MMC_VERSION(5, 0, 0)
Stefan Wahrenb77ce142016-06-16 17:54:06 +000060#define MMC_VERSION_5_1 MAKE_MMC_VERSION(5, 1, 0)
Andy Fleming272cc702008-10-30 16:41:01 -050061
Jaehoon Chung8caf46d2014-05-16 13:59:53 +090062#define MMC_MODE_HS (1 << 0)
63#define MMC_MODE_HS_52MHz (1 << 1)
64#define MMC_MODE_4BIT (1 << 2)
65#define MMC_MODE_8BIT (1 << 3)
66#define MMC_MODE_SPI (1 << 4)
Rob Herring5a203972015-03-23 17:56:59 -050067#define MMC_MODE_DDR_52MHz (1 << 5)
Ɓukasz Majewski62722032012-03-12 22:07:18 +000068
Andy Fleming272cc702008-10-30 16:41:01 -050069#define SD_DATA_4BIT 0x00040000
70
Pantelis Antoniou4b7cee52015-01-23 12:12:01 +020071#define IS_SD(x) ((x)->version & SD_VERSION_SD)
Andrew Gabbasov3f2da752015-03-19 07:44:02 -050072#define IS_MMC(x) ((x)->version & MMC_VERSION_MMC)
Andy Fleming272cc702008-10-30 16:41:01 -050073
74#define MMC_DATA_READ 1
75#define MMC_DATA_WRITE 2
76
77#define NO_CARD_ERR -16 /* No SD/MMC card inserted */
78#define UNUSABLE_ERR -17 /* Unusable Card */
79#define COMM_ERR -18 /* Communications Error */
80#define TIMEOUT -19
Andrew Gabbasovbd47c132015-03-19 07:44:07 -050081#define SWITCH_ERR -20 /* Card reports failure to switch mode */
Andy Fleming272cc702008-10-30 16:41:01 -050082
Haavard Skinnemoen341188b2008-05-22 11:09:59 +020083#define MMC_CMD_GO_IDLE_STATE 0
84#define MMC_CMD_SEND_OP_COND 1
85#define MMC_CMD_ALL_SEND_CID 2
86#define MMC_CMD_SET_RELATIVE_ADDR 3
87#define MMC_CMD_SET_DSR 4
Andy Fleming272cc702008-10-30 16:41:01 -050088#define MMC_CMD_SWITCH 6
Haavard Skinnemoen341188b2008-05-22 11:09:59 +020089#define MMC_CMD_SELECT_CARD 7
Andy Fleming272cc702008-10-30 16:41:01 -050090#define MMC_CMD_SEND_EXT_CSD 8
Haavard Skinnemoen341188b2008-05-22 11:09:59 +020091#define MMC_CMD_SEND_CSD 9
92#define MMC_CMD_SEND_CID 10
Andy Fleming272cc702008-10-30 16:41:01 -050093#define MMC_CMD_STOP_TRANSMISSION 12
Haavard Skinnemoen341188b2008-05-22 11:09:59 +020094#define MMC_CMD_SEND_STATUS 13
95#define MMC_CMD_SET_BLOCKLEN 16
96#define MMC_CMD_READ_SINGLE_BLOCK 17
97#define MMC_CMD_READ_MULTIPLE_BLOCK 18
Pierre Aubert91fdabc2014-04-24 10:30:06 +020098#define MMC_CMD_SET_BLOCK_COUNT 23
Andy Fleming272cc702008-10-30 16:41:01 -050099#define MMC_CMD_WRITE_SINGLE_BLOCK 24
100#define MMC_CMD_WRITE_MULTIPLE_BLOCK 25
Gokul Sriram Palanisamy201def52017-10-26 16:44:16 +0530101#define MMC_CMD_SET_WRITE_PROT 28
102#define MMC_CMD_CLR_WRITE_PROT 29
103#define MMC_CMD_SEND_WRITE_PROT 30
104#define MMC_CMD_SEND_WRITE_PROT_TYPE 31
Lei Wene6f99a52011-06-22 17:03:31 +0000105#define MMC_CMD_ERASE_GROUP_START 35
106#define MMC_CMD_ERASE_GROUP_END 36
107#define MMC_CMD_ERASE 38
Haavard Skinnemoen341188b2008-05-22 11:09:59 +0200108#define MMC_CMD_APP_CMD 55
Thomas Choud52ebf12010-12-24 13:12:21 +0000109#define MMC_CMD_SPI_READ_OCR 58
110#define MMC_CMD_SPI_CRC_ON_OFF 59
Amar3690d6d2013-04-27 11:42:58 +0530111#define MMC_CMD_RES_MAN 62
112
113#define MMC_CMD62_ARG1 0xefac62ec
114#define MMC_CMD62_ARG2 0xcbaea7
115
Haavard Skinnemoen341188b2008-05-22 11:09:59 +0200116
Haavard Skinnemoen341188b2008-05-22 11:09:59 +0200117#define SD_CMD_SEND_RELATIVE_ADDR 3
Andy Fleming272cc702008-10-30 16:41:01 -0500118#define SD_CMD_SWITCH_FUNC 6
Haavard Skinnemoen341188b2008-05-22 11:09:59 +0200119#define SD_CMD_SEND_IF_COND 8
Otavio Salvadorf022d362015-02-17 10:42:43 -0200120#define SD_CMD_SWITCH_UHS18V 11
Haavard Skinnemoen341188b2008-05-22 11:09:59 +0200121
122#define SD_CMD_APP_SET_BUS_WIDTH 6
Lei Wene6f99a52011-06-22 17:03:31 +0000123#define SD_CMD_ERASE_WR_BLK_START 32
124#define SD_CMD_ERASE_WR_BLK_END 33
Haavard Skinnemoen341188b2008-05-22 11:09:59 +0200125#define SD_CMD_APP_SEND_OP_COND 41
Andy Fleming272cc702008-10-30 16:41:01 -0500126#define SD_CMD_APP_SEND_SCR 51
127
128/* SCR definitions in different words */
129#define SD_HIGHSPEED_BUSY 0x00020000
130#define SD_HIGHSPEED_SUPPORTED 0x00020000
131
Thomas Chouabe2c932011-04-19 03:48:31 +0000132#define OCR_BUSY 0x80000000
133#define OCR_HCS 0x40000000
Raffaele Recalcati31cacba2011-03-11 02:01:13 +0000134#define OCR_VOLTAGE_MASK 0x007FFF80
135#define OCR_ACCESS_MODE 0x60000000
Andy Fleming272cc702008-10-30 16:41:01 -0500136
Eric Nelson1aa2d072015-12-07 07:50:01 -0700137#define MMC_ERASE_ARG 0x00000000
138#define MMC_SECURE_ERASE_ARG 0x80000000
139#define MMC_TRIM_ARG 0x00000001
140#define MMC_DISCARD_ARG 0x00000003
141#define MMC_SECURE_TRIM1_ARG 0x80000001
142#define MMC_SECURE_TRIM2_ARG 0x80008000
Lei Wene6f99a52011-06-22 17:03:31 +0000143
Raffaele Recalcati5d4fc8d2011-03-11 02:01:12 +0000144#define MMC_STATUS_MASK (~0x0206BF7F)
Andrew Gabbasov6b2221b2014-04-03 04:34:32 -0500145#define MMC_STATUS_SWITCH_ERROR (1 << 7)
Thomas Chouabe2c932011-04-19 03:48:31 +0000146#define MMC_STATUS_RDY_FOR_DATA (1 << 8)
147#define MMC_STATUS_CURR_STATE (0xf << 9)
Thomas Choued018b22011-04-19 03:48:32 +0000148#define MMC_STATUS_ERROR (1 << 19)
Raffaele Recalcati5d4fc8d2011-03-11 02:01:12 +0000149
Jan Kloetzked617c422012-02-05 22:29:12 +0000150#define MMC_STATE_PRG (7 << 9)
151
Andy Fleming272cc702008-10-30 16:41:01 -0500152#define MMC_VDD_165_195 0x00000080 /* VDD voltage 1.65 - 1.95 */
153#define MMC_VDD_20_21 0x00000100 /* VDD voltage 2.0 ~ 2.1 */
154#define MMC_VDD_21_22 0x00000200 /* VDD voltage 2.1 ~ 2.2 */
155#define MMC_VDD_22_23 0x00000400 /* VDD voltage 2.2 ~ 2.3 */
156#define MMC_VDD_23_24 0x00000800 /* VDD voltage 2.3 ~ 2.4 */
157#define MMC_VDD_24_25 0x00001000 /* VDD voltage 2.4 ~ 2.5 */
158#define MMC_VDD_25_26 0x00002000 /* VDD voltage 2.5 ~ 2.6 */
159#define MMC_VDD_26_27 0x00004000 /* VDD voltage 2.6 ~ 2.7 */
160#define MMC_VDD_27_28 0x00008000 /* VDD voltage 2.7 ~ 2.8 */
161#define MMC_VDD_28_29 0x00010000 /* VDD voltage 2.8 ~ 2.9 */
162#define MMC_VDD_29_30 0x00020000 /* VDD voltage 2.9 ~ 3.0 */
163#define MMC_VDD_30_31 0x00040000 /* VDD voltage 3.0 ~ 3.1 */
164#define MMC_VDD_31_32 0x00080000 /* VDD voltage 3.1 ~ 3.2 */
165#define MMC_VDD_32_33 0x00100000 /* VDD voltage 3.2 ~ 3.3 */
166#define MMC_VDD_33_34 0x00200000 /* VDD voltage 3.3 ~ 3.4 */
167#define MMC_VDD_34_35 0x00400000 /* VDD voltage 3.4 ~ 3.5 */
168#define MMC_VDD_35_36 0x00800000 /* VDD voltage 3.5 ~ 3.6 */
169
170#define MMC_SWITCH_MODE_CMD_SET 0x00 /* Change the command set */
171#define MMC_SWITCH_MODE_SET_BITS 0x01 /* Set bits in EXT_CSD byte
172 addressed by index which are
173 1 in value field */
174#define MMC_SWITCH_MODE_CLEAR_BITS 0x02 /* Clear bits in EXT_CSD byte
175 addressed by index, which are
176 1 in value field */
177#define MMC_SWITCH_MODE_WRITE_BYTE 0x03 /* Set target byte to value */
178
179#define SD_SWITCH_CHECK 0
180#define SD_SWITCH_SWITCH 1
181
Gokul Sriram Palanisamy201def52017-10-26 16:44:16 +0530182#define MMC_RESP_TIMEOUT 2000
183#define MMC_ADDR_OUT_OF_RANGE(resp) ((resp >> 31) & 0x01)
184
185/*
186 * CSD fields
187*/
188#define WP_GRP_ENABLE(csd) ((csd[3] & 0x80000000) >> 31)
189#define WP_GRP_SIZE(csd) ((csd[2] & 0x0000001f))
190#define ERASE_GRP_MULT(csd) ((csd[2] & 0x000003e0) >> 5)
191#define ERASE_GRP_SIZE(csd) ((csd[2] & 0x00007c00) >> 10)
192
Andy Fleming272cc702008-10-30 16:41:01 -0500193/*
194 * EXT_CSD fields
195 */
Diego Santa Cruza7f852b2014-12-23 10:50:22 +0100196#define EXT_CSD_ENH_START_ADDR 136 /* R/W */
197#define EXT_CSD_ENH_SIZE_MULT 140 /* R/W */
Stephen Warrenf866a462013-06-11 15:14:01 -0600198#define EXT_CSD_GP_SIZE_MULT 143 /* R/W */
Markus Niebeld7b29122014-11-18 15:11:42 +0100199#define EXT_CSD_PARTITION_SETTING 155 /* R/W */
Oliver Metz1937e5a2013-10-01 20:32:07 +0200200#define EXT_CSD_PARTITIONS_ATTRIBUTE 156 /* R/W */
Diego Santa Cruzac9da0e2014-12-23 10:50:29 +0100201#define EXT_CSD_MAX_ENH_SIZE_MULT 157 /* R */
Lei Wen0560db12011-10-03 20:35:10 +0000202#define EXT_CSD_PARTITIONING_SUPPORT 160 /* RO */
Tom Rini33ace362014-02-07 14:15:20 -0500203#define EXT_CSD_RST_N_FUNCTION 162 /* R/W */
Diego Santa Cruz8dda5b02014-12-23 10:50:31 +0100204#define EXT_CSD_WR_REL_PARAM 166 /* R */
205#define EXT_CSD_WR_REL_SET 167 /* R/W */
Stephen Warrenf866a462013-06-11 15:14:01 -0600206#define EXT_CSD_RPMB_MULT 168 /* RO */
Gokul Sriram Palanisamy201def52017-10-26 16:44:16 +0530207#define EXT_CSD_USER_WP 171 /* R/W */
Lei Wen0560db12011-10-03 20:35:10 +0000208#define EXT_CSD_ERASE_GROUP_DEF 175 /* R/W */
Amar3690d6d2013-04-27 11:42:58 +0530209#define EXT_CSD_BOOT_BUS_WIDTH 177
Lei Wen0560db12011-10-03 20:35:10 +0000210#define EXT_CSD_PART_CONF 179 /* R/W */
211#define EXT_CSD_BUS_WIDTH 183 /* R/W */
212#define EXT_CSD_HS_TIMING 185 /* R/W */
213#define EXT_CSD_REV 192 /* RO */
214#define EXT_CSD_CARD_TYPE 196 /* RO */
215#define EXT_CSD_SEC_CNT 212 /* RO, 4 bytes */
Stephen Warrenf866a462013-06-11 15:14:01 -0600216#define EXT_CSD_HC_WP_GRP_SIZE 221 /* RO */
Lei Wen0560db12011-10-03 20:35:10 +0000217#define EXT_CSD_HC_ERASE_GRP_SIZE 224 /* RO */
Stephen Warren8948ea82012-07-30 10:55:43 +0000218#define EXT_CSD_BOOT_MULT 226 /* RO */
Sham Muthayyancad4eba2017-03-09 19:52:24 +0530219#define EXT_CSD_SEC_FEATURE_SUPPORT 231 /* RO */
Rajkumar Ayyasamyfb0e42b2017-11-28 15:17:37 +0530220#define EXT_CSD_TRIM_MULT 232 /* RO */
Andy Fleming272cc702008-10-30 16:41:01 -0500221
Sham Muthayyancad4eba2017-03-09 19:52:24 +0530222#define EXT_CSD_SEC_ER_EN (1 << 0)
223#define EXT_CSD_SEC_GB_CL_EN (1 << 4)
Andy Fleming272cc702008-10-30 16:41:01 -0500224/*
225 * EXT_CSD field definitions
226 */
227
Thomas Chouabe2c932011-04-19 03:48:31 +0000228#define EXT_CSD_CMD_SET_NORMAL (1 << 0)
229#define EXT_CSD_CMD_SET_SECURE (1 << 1)
230#define EXT_CSD_CMD_SET_CPSECURE (1 << 2)
Andy Fleming272cc702008-10-30 16:41:01 -0500231
Thomas Chouabe2c932011-04-19 03:48:31 +0000232#define EXT_CSD_CARD_TYPE_26 (1 << 0) /* Card can run at 26MHz */
233#define EXT_CSD_CARD_TYPE_52 (1 << 1) /* Card can run at 52MHz */
Jaehoon Chungd22e3d42014-05-16 13:59:54 +0900234#define EXT_CSD_CARD_TYPE_DDR_1_8V (1 << 2)
235#define EXT_CSD_CARD_TYPE_DDR_1_2V (1 << 3)
236#define EXT_CSD_CARD_TYPE_DDR_52 (EXT_CSD_CARD_TYPE_DDR_1_8V \
237 | EXT_CSD_CARD_TYPE_DDR_1_2V)
Andy Fleming272cc702008-10-30 16:41:01 -0500238
239#define EXT_CSD_BUS_WIDTH_1 0 /* Card is in 1 bit mode */
240#define EXT_CSD_BUS_WIDTH_4 1 /* Card is in 4 bit mode */
241#define EXT_CSD_BUS_WIDTH_8 2 /* Card is in 8 bit mode */
Jaehoon Chungd22e3d42014-05-16 13:59:54 +0900242#define EXT_CSD_DDR_BUS_WIDTH_4 5 /* Card is in 4 bit DDR mode */
243#define EXT_CSD_DDR_BUS_WIDTH_8 6 /* Card is in 8 bit DDR mode */
Haavard Skinnemoen341188b2008-05-22 11:09:59 +0200244
Amar3690d6d2013-04-27 11:42:58 +0530245#define EXT_CSD_BOOT_ACK_ENABLE (1 << 6)
246#define EXT_CSD_BOOT_PARTITION_ENABLE (1 << 3)
247#define EXT_CSD_PARTITION_ACCESS_ENABLE (1 << 0)
248#define EXT_CSD_PARTITION_ACCESS_DISABLE (0 << 0)
249
250#define EXT_CSD_BOOT_ACK(x) (x << 6)
251#define EXT_CSD_BOOT_PART_NUM(x) (x << 3)
252#define EXT_CSD_PARTITION_ACCESS(x) (x << 0)
253
Tom Rini5a99b9d2014-02-05 10:24:22 -0500254#define EXT_CSD_BOOT_BUS_WIDTH_MODE(x) (x << 3)
255#define EXT_CSD_BOOT_BUS_WIDTH_RESET(x) (x << 2)
256#define EXT_CSD_BOOT_BUS_WIDTH_WIDTH(x) (x)
Amar3690d6d2013-04-27 11:42:58 +0530257
Markus Niebeld7b29122014-11-18 15:11:42 +0100258#define EXT_CSD_PARTITION_SETTING_COMPLETED (1 << 0)
259
Diego Santa Cruzc3dbb4f2014-12-23 10:50:17 +0100260#define EXT_CSD_ENH_USR (1 << 0) /* user data area is enhanced */
261#define EXT_CSD_ENH_GP(x) (1 << ((x)+1)) /* GP part (x+1) is enhanced */
262
Diego Santa Cruz8dda5b02014-12-23 10:50:31 +0100263#define EXT_CSD_HS_CTRL_REL (1 << 0) /* host controlled WR_REL_SET */
264
265#define EXT_CSD_WR_DATA_REL_USR (1 << 0) /* user data area WR_REL */
266#define EXT_CSD_WR_DATA_REL_GP(x) (1 << ((x)+1)) /* GP part (x+1) WR_REL */
267
Gokul Sriram Palanisamy201def52017-10-26 16:44:16 +0530268#define EXT_CSD_US_PERM_WP_DIS (1 << 4)
269#define EXT_CSD_US_PWR_WP_DIS (1 << 3)
270#define EXT_CSD_US_PERM_WP_EN (1 << 2)
271#define EXT_CSD_US_PWR_WP_EN (1 << 0)
272
Andy Fleming1de97f92008-10-30 16:31:39 -0500273#define R1_ILLEGAL_COMMAND (1 << 22)
274#define R1_APP_CMD (1 << 5)
275
Andy Fleming272cc702008-10-30 16:41:01 -0500276#define MMC_RSP_PRESENT (1 << 0)
Thomas Chouabe2c932011-04-19 03:48:31 +0000277#define MMC_RSP_136 (1 << 1) /* 136 bit response */
278#define MMC_RSP_CRC (1 << 2) /* expect valid crc */
279#define MMC_RSP_BUSY (1 << 3) /* card may send busy */
280#define MMC_RSP_OPCODE (1 << 4) /* response contains opcode */
Andy Fleming272cc702008-10-30 16:41:01 -0500281
Thomas Chouabe2c932011-04-19 03:48:31 +0000282#define MMC_RSP_NONE (0)
283#define MMC_RSP_R1 (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
Andy Fleming272cc702008-10-30 16:41:01 -0500284#define MMC_RSP_R1b (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE| \
285 MMC_RSP_BUSY)
Thomas Chouabe2c932011-04-19 03:48:31 +0000286#define MMC_RSP_R2 (MMC_RSP_PRESENT|MMC_RSP_136|MMC_RSP_CRC)
287#define MMC_RSP_R3 (MMC_RSP_PRESENT)
288#define MMC_RSP_R4 (MMC_RSP_PRESENT)
289#define MMC_RSP_R5 (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
290#define MMC_RSP_R6 (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
291#define MMC_RSP_R7 (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
Andy Fleming272cc702008-10-30 16:41:01 -0500292
Lei Wenbc897b12011-05-02 16:26:26 +0000293#define MMCPART_NOAVAILABLE (0xff)
294#define PART_ACCESS_MASK (0x7)
295#define PART_SUPPORT (0x1)
Diego Santa Cruzc3dbb4f2014-12-23 10:50:17 +0100296#define ENHNCD_SUPPORT (0x2)
Oliver Metz1937e5a2013-10-01 20:32:07 +0200297#define PART_ENH_ATTRIB (0x1f)
wdenk71f95112003-06-15 22:40:42 +0000298
Simon Glass8bfa1952013-04-03 08:54:30 +0000299/* Maximum block size for MMC */
300#define MMC_MAX_BLOCK_LEN 512
301
Amar3690d6d2013-04-27 11:42:58 +0530302/* The number of MMC physical partitions. These consist of:
303 * boot partitions (2), general purpose partitions (4) in MMC v4.4.
304 */
305#define MMC_NUM_BOOT_PARTITION 2
Pierre Aubert91fdabc2014-04-24 10:30:06 +0200306#define MMC_PART_RPMB 3 /* RPMB partition number */
Amar3690d6d2013-04-27 11:42:58 +0530307
Simon Glasse7ecf7c2015-06-23 15:38:48 -0600308/* Driver model support */
309
Pradeep Dasdc6c6752018-05-14 12:29:59 +0530310#define MMC_MID_MASK (0xFF << 24)
311#define MMC_MID_SANDISK (0x45 << 24)
Vinoth Gnanasekaran4dc439f2018-05-31 19:48:39 +0530312#define MMC_MID_TOSHIBA (0x11 << 24)
Pradeep Dasdc6c6752018-05-14 12:29:59 +0530313
314/*
315 * Quirks
316 */
317/* Some of Sandisk eMMC seeing more delay for secure trim,
318 * below quirk will use trim instead secure trim for erase */
319#define MMC_QUIRK_SECURE_TRIM (1 << 0)
320
Simon Glasse7ecf7c2015-06-23 15:38:48 -0600321/**
322 * struct mmc_uclass_priv - Holds information about a device used by the uclass
323 */
324struct mmc_uclass_priv {
325 struct mmc *mmc;
326};
327
328/**
329 * mmc_get_mmc_dev() - get the MMC struct pointer for a device
330 *
331 * Provided that the device is already probed and ready for use, this value
332 * will be available.
333 *
334 * @dev: Device
335 * @return associated mmc struct pointer if available, else NULL
336 */
337struct mmc *mmc_get_mmc_dev(struct udevice *dev);
338
339/* End of driver model support */
340
Sham Muthayyancad4eba2017-03-09 19:52:24 +0530341#define MMC_SECURE_TRIM1_ARG 0x80000001
342#define MMC_SECURE_TRIM2_ARG 0x80008000
343
344
Andy Fleming1de97f92008-10-30 16:31:39 -0500345struct mmc_cid {
346 unsigned long psn;
347 unsigned short oid;
348 unsigned char mid;
349 unsigned char prv;
350 unsigned char mdt;
351 char pnm[7];
352};
353
Andy Fleming272cc702008-10-30 16:41:01 -0500354struct mmc_cmd {
355 ushort cmdidx;
356 uint resp_type;
357 uint cmdarg;
Rabin Vincent0b453ff2009-04-05 13:30:55 +0530358 uint response[4];
Andy Fleming272cc702008-10-30 16:41:01 -0500359};
360
361struct mmc_data {
362 union {
363 char *dest;
364 const char *src; /* src buffers don't get written to */
365 };
366 uint flags;
367 uint blocks;
368 uint blocksize;
369};
370
Pantelis Antoniouab769f22014-02-26 19:28:45 +0200371/* forward decl. */
372struct mmc;
373
374struct mmc_ops {
375 int (*send_cmd)(struct mmc *mmc,
376 struct mmc_cmd *cmd, struct mmc_data *data);
377 void (*set_ios)(struct mmc *mmc);
378 int (*init)(struct mmc *mmc);
379 int (*getcd)(struct mmc *mmc);
380 int (*getwp)(struct mmc *mmc);
381};
382
Pantelis Antoniou93bfd612014-03-11 19:34:20 +0200383struct mmc_config {
384 const char *name;
385 const struct mmc_ops *ops;
386 uint host_caps;
Andy Fleming272cc702008-10-30 16:41:01 -0500387 uint voltages;
Andy Fleming272cc702008-10-30 16:41:01 -0500388 uint f_min;
389 uint f_max;
Pantelis Antoniou93bfd612014-03-11 19:34:20 +0200390 uint b_max;
391 unsigned char part_type;
392};
393
394/* TODO struct mmc should be in mmc_private but it's hard to fix right now */
395struct mmc {
396 struct list_head link;
397 const struct mmc_config *cfg; /* provided configuration */
398 uint version;
399 void *priv;
400 uint has_init;
Andy Fleming272cc702008-10-30 16:41:01 -0500401 int high_capacity;
402 uint bus_width;
403 uint clock;
404 uint card_caps;
Andy Fleming272cc702008-10-30 16:41:01 -0500405 uint ocr;
Markus Niebelab711882013-12-16 13:40:46 +0100406 uint dsr;
407 uint dsr_imp;
Andy Fleming272cc702008-10-30 16:41:01 -0500408 uint scr[2];
409 uint csd[4];
Rabin Vincent0b453ff2009-04-05 13:30:55 +0530410 uint cid[4];
Andy Fleming272cc702008-10-30 16:41:01 -0500411 ushort rca;
Diego Santa Cruzc3dbb4f2014-12-23 10:50:17 +0100412 u8 part_support;
413 u8 part_attr;
Diego Santa Cruz9e41a002014-12-23 10:50:33 +0100414 u8 wr_rel_set;
Lei Wenbc897b12011-05-02 16:26:26 +0000415 char part_config;
416 char part_num;
Andy Fleming272cc702008-10-30 16:41:01 -0500417 uint tran_speed;
418 uint read_bl_len;
419 uint write_bl_len;
Diego Santa Cruza4ff9f82014-12-23 10:50:24 +0100420 uint erase_grp_size; /* in 512-byte sectors */
Diego Santa Cruz037dc0a2014-12-23 10:50:25 +0100421 uint hc_wp_grp_size; /* in 512-byte sectors */
Gokul Sriram Palanisamy201def52017-10-26 16:44:16 +0530422 uint wp_grp_size;
423 uint wp_grp_enable;
Andy Fleming272cc702008-10-30 16:41:01 -0500424 u64 capacity;
Stephen Warrenf866a462013-06-11 15:14:01 -0600425 u64 capacity_user;
426 u64 capacity_boot;
427 u64 capacity_rpmb;
428 u64 capacity_gp[4];
Diego Santa Cruza7f852b2014-12-23 10:50:22 +0100429 u64 enh_user_start;
430 u64 enh_user_size;
Andy Fleming272cc702008-10-30 16:41:01 -0500431 block_dev_desc_t block_dev;
Che-Liang Chioue9550442012-11-28 15:21:13 +0000432 char op_cond_pending; /* 1 if we are waiting on an op_cond command */
433 char init_in_progress; /* 1 if we have done mmc_start_init() */
434 char preinit; /* start init as early as possible */
Andrew Gabbasov786e8f82014-12-01 06:59:09 -0600435 int ddr_mode;
Sham Muthayyancad4eba2017-03-09 19:52:24 +0530436 uchar sec_feature_support;
Rajkumar Ayyasamyfb0e42b2017-11-28 15:17:37 +0530437 unsigned int trim_timeout; /* In milliseconds */
Pradeep Dasdc6c6752018-05-14 12:29:59 +0530438 u32 quirks;
Andy Fleming272cc702008-10-30 16:41:01 -0500439};
440
Diego Santa Cruzac9da0e2014-12-23 10:50:29 +0100441struct mmc_hwpart_conf {
442 struct {
443 uint enh_start; /* in 512-byte sectors */
444 uint enh_size; /* in 512-byte sectors, if 0 no enh area */
Diego Santa Cruz8dda5b02014-12-23 10:50:31 +0100445 unsigned wr_rel_change : 1;
446 unsigned wr_rel_set : 1;
Diego Santa Cruzac9da0e2014-12-23 10:50:29 +0100447 } user;
448 struct {
449 uint size; /* in 512-byte sectors */
Diego Santa Cruz8dda5b02014-12-23 10:50:31 +0100450 unsigned enhanced : 1;
451 unsigned wr_rel_change : 1;
452 unsigned wr_rel_set : 1;
Diego Santa Cruzac9da0e2014-12-23 10:50:29 +0100453 } gp_part[4];
454};
455
456enum mmc_hwpart_conf_mode {
457 MMC_HWPART_CONF_CHECK,
458 MMC_HWPART_CONF_SET,
459 MMC_HWPART_CONF_COMPLETE,
460};
461
Andy Fleming272cc702008-10-30 16:41:01 -0500462int mmc_register(struct mmc *mmc);
Pantelis Antoniou93bfd612014-03-11 19:34:20 +0200463struct mmc *mmc_create(const struct mmc_config *cfg, void *priv);
464void mmc_destroy(struct mmc *mmc);
Andy Fleming272cc702008-10-30 16:41:01 -0500465int mmc_initialize(bd_t *bis);
466int mmc_init(struct mmc *mmc);
467int mmc_read(struct mmc *mmc, u64 src, uchar *dst, int size);
Jerry Huang4a6ee172010-11-25 17:06:07 +0000468void mmc_set_clock(struct mmc *mmc, uint clock);
Andy Fleming272cc702008-10-30 16:41:01 -0500469struct mmc *find_mmc_device(int dev_num);
Steve Sakoman89716962010-07-01 12:12:42 -0700470int mmc_set_dev(int dev_num);
Andy Fleming272cc702008-10-30 16:41:01 -0500471void print_mmc_devices(char separator);
Lei Wenea6ebe22011-05-02 16:26:25 +0000472int get_mmc_num(void);
Lei Wenbc897b12011-05-02 16:26:26 +0000473int mmc_switch_part(int dev_num, unsigned int part_num);
Diego Santa Cruzac9da0e2014-12-23 10:50:29 +0100474int mmc_hwpart_config(struct mmc *mmc, const struct mmc_hwpart_conf *conf,
475 enum mmc_hwpart_conf_mode mode);
Thierry Reding48972d92012-01-02 01:15:37 +0000476int mmc_getcd(struct mmc *mmc);
Jeroen Hofstee750121c2014-07-12 21:24:08 +0200477int board_mmc_getcd(struct mmc *mmc);
Nikita Kiryanovd23d8d72012-12-03 02:19:46 +0000478int mmc_getwp(struct mmc *mmc);
Jeroen Hofstee750121c2014-07-12 21:24:08 +0200479int board_mmc_getwp(struct mmc *mmc);
Markus Niebelab711882013-12-16 13:40:46 +0100480int mmc_set_dsr(struct mmc *mmc, u16 val);
Amar3690d6d2013-04-27 11:42:58 +0530481/* Function to change the size of boot partition and rpmb partitions */
482int mmc_boot_partition_size_change(struct mmc *mmc, unsigned long bootsize,
483 unsigned long rpmbsize);
Tom Rini792970b2014-02-05 10:24:21 -0500484/* Function to modify the PARTITION_CONFIG field of EXT_CSD */
485int mmc_set_part_conf(struct mmc *mmc, u8 ack, u8 part_num, u8 access);
Tom Rini5a99b9d2014-02-05 10:24:22 -0500486/* Function to modify the BOOT_BUS_WIDTH field of EXT_CSD */
487int mmc_set_boot_bus_width(struct mmc *mmc, u8 width, u8 reset, u8 mode);
Tom Rini33ace362014-02-07 14:15:20 -0500488/* Function to modify the RST_n_FUNCTION field of EXT_CSD */
489int mmc_set_rst_n_function(struct mmc *mmc, u8 enable);
Pierre Aubert91fdabc2014-04-24 10:30:06 +0200490/* Functions to read / write the RPMB partition */
491int mmc_rpmb_set_key(struct mmc *mmc, void *key);
492int mmc_rpmb_get_counter(struct mmc *mmc, unsigned long *counter);
493int mmc_rpmb_read(struct mmc *mmc, void *addr, unsigned short blk,
494 unsigned short cnt, unsigned char *key);
495int mmc_rpmb_write(struct mmc *mmc, void *addr, unsigned short blk,
496 unsigned short cnt, unsigned char *key);
Che-Liang Chioue9550442012-11-28 15:21:13 +0000497/**
498 * Start device initialization and return immediately; it does not block on
499 * polling OCR (operation condition register) status. Then you should call
500 * mmc_init, which would block on polling OCR status and complete the device
501 * initializatin.
502 *
503 * @param mmc Pointer to a MMC device struct
504 * @return 0 on success, IN_PROGRESS on waiting for OCR status, <0 on error.
505 */
506int mmc_start_init(struct mmc *mmc);
507
508/**
509 * Set preinit flag of mmc device.
510 *
511 * This will cause the device to be pre-inited during mmc_initialize(),
512 * which may save boot time if the device is not accessed until later.
513 * Some eMMC devices take 200-300ms to init, but unfortunately they
514 * must be sent a series of commands to even get them to start preparing
515 * for operation.
516 *
517 * @param mmc Pointer to a MMC device struct
518 * @param preinit preinit flag value
519 */
520void mmc_set_preinit(struct mmc *mmc, int preinit);
521
Reinhard Meyer1592ef82010-08-13 10:31:06 +0200522#ifdef CONFIG_GENERIC_MMC
Paul Burton8687d5c2013-09-04 16:12:26 +0100523#ifdef CONFIG_MMC_SPI
Tom Rini0b2da7e2014-03-28 16:55:29 -0400524#define mmc_host_is_spi(mmc) ((mmc)->cfg->host_caps & MMC_MODE_SPI)
Paul Burton8687d5c2013-09-04 16:12:26 +0100525#else
526#define mmc_host_is_spi(mmc) 0
527#endif
Thomas Choud52ebf12010-12-24 13:12:21 +0000528struct mmc *mmc_spi_init(uint bus, uint cs, uint speed, uint mode);
Reinhard Meyer1592ef82010-08-13 10:31:06 +0200529#else
Andy Fleming272cc702008-10-30 16:41:01 -0500530int mmc_legacy_init(int verbose);
531#endif
Reinhard Meyer1592ef82010-08-13 10:31:06 +0200532
Paul Kocialkowski95de9ab2014-11-08 20:55:45 +0100533void board_mmc_power_init(void);
Fabio Estevam3c7ca962014-02-15 14:51:59 -0200534int board_mmc_init(bd_t *bis);
Jeroen Hofstee750121c2014-07-12 21:24:08 +0200535int cpu_mmc_init(bd_t *bis);
Jeroen Hofsteeaeb80552014-10-08 22:58:05 +0200536int mmc_get_env_addr(struct mmc *mmc, int copy, u32 *env_addr);
Fabio Estevam3c7ca962014-02-15 14:51:59 -0200537
Simon Glass91785f72015-01-27 22:13:39 -0700538struct pci_device_id;
539
540/**
541 * pci_mmc_init() - set up PCI MMC devices
542 *
543 * This finds all the matching PCI IDs and sets them up as MMC devices.
544 *
545 * @name: Name to use for devices
546 * @mmc_supported: PCI IDs to search for
547 * @num_ids: Number of elements in @mmc_supported
548 */
549int pci_mmc_init(const char *name, struct pci_device_id *mmc_supported,
550 int num_ids);
551
Gokul Sriram Palanisamy201def52017-10-26 16:44:16 +0530552int mmc_write_protect(struct mmc *mmc, unsigned int start_blk,
553 unsigned int cnt_blk, int set_clr);
554
Pantelis Antoniou93bfd612014-03-11 19:34:20 +0200555/* Set block count limit because of 16 bit register limit on some hardware*/
556#ifndef CONFIG_SYS_MMC_MAX_BLK_COUNT
557#define CONFIG_SYS_MMC_MAX_BLK_COUNT 65535
558#endif
559
wdenk71f95112003-06-15 22:40:42 +0000560#endif /* _MMC_H_ */