blob: 6c4b3c1af82e47e5c5bcad0957ef4e7d29606df3 [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
Pantelis Antoniou4b7cee52015-01-23 12:12:01 +020017/* SD/MMC version bits; 8 flags, 8 major, 8 minor, 8 change */
18#define SD_VERSION_SD (1U << 31)
19#define MMC_VERSION_MMC (1U << 30)
20
21#define MAKE_SDMMC_VERSION(a, b, c) \
22 ((((u32)(a)) << 16) | ((u32)(b) << 8) | (u32)(c))
23#define MAKE_SD_VERSION(a, b, c) \
24 (SD_VERSION_SD | MAKE_SDMMC_VERSION(a, b, c))
25#define MAKE_MMC_VERSION(a, b, c) \
26 (MMC_VERSION_MMC | MAKE_SDMMC_VERSION(a, b, c))
27
28#define EXTRACT_SDMMC_MAJOR_VERSION(x) \
29 (((u32)(x) >> 16) & 0xff)
30#define EXTRACT_SDMMC_MINOR_VERSION(x) \
31 (((u32)(x) >> 8) & 0xff)
32#define EXTRACT_SDMMC_CHANGE_VERSION(x) \
33 ((u32)(x) & 0xff)
34
35#define SD_VERSION_3 MAKE_SD_VERSION(3, 0, 0)
36#define SD_VERSION_2 MAKE_SD_VERSION(2, 0, 0)
37#define SD_VERSION_1_0 MAKE_SD_VERSION(1, 0, 0)
38#define SD_VERSION_1_10 MAKE_SD_VERSION(1, 10, 0)
39
40#define MMC_VERSION_UNKNOWN MAKE_MMC_VERSION(0, 0, 0)
41#define MMC_VERSION_1_2 MAKE_MMC_VERSION(1, 2, 0)
42#define MMC_VERSION_1_4 MAKE_MMC_VERSION(1, 4, 0)
43#define MMC_VERSION_2_2 MAKE_MMC_VERSION(2, 2, 0)
44#define MMC_VERSION_3 MAKE_MMC_VERSION(3, 0, 0)
45#define MMC_VERSION_4 MAKE_MMC_VERSION(4, 0, 0)
46#define MMC_VERSION_4_1 MAKE_MMC_VERSION(4, 1, 0)
47#define MMC_VERSION_4_2 MAKE_MMC_VERSION(4, 2, 0)
48#define MMC_VERSION_4_3 MAKE_MMC_VERSION(4, 3, 0)
49#define MMC_VERSION_4_41 MAKE_MMC_VERSION(4, 4, 1)
50#define MMC_VERSION_4_5 MAKE_MMC_VERSION(4, 5, 0)
51#define MMC_VERSION_5_0 MAKE_MMC_VERSION(5, 0, 0)
Stefan Wahrenb77ce142016-06-16 17:54:06 +000052#define MMC_VERSION_5_1 MAKE_MMC_VERSION(5, 1, 0)
Andy Fleming272cc702008-10-30 16:41:01 -050053
Jaehoon Chung8caf46d2014-05-16 13:59:53 +090054#define MMC_MODE_HS (1 << 0)
55#define MMC_MODE_HS_52MHz (1 << 1)
56#define MMC_MODE_4BIT (1 << 2)
57#define MMC_MODE_8BIT (1 << 3)
58#define MMC_MODE_SPI (1 << 4)
Rob Herring5a203972015-03-23 17:56:59 -050059#define MMC_MODE_DDR_52MHz (1 << 5)
Ɓukasz Majewski62722032012-03-12 22:07:18 +000060
Andy Fleming272cc702008-10-30 16:41:01 -050061#define SD_DATA_4BIT 0x00040000
62
Pantelis Antoniou4b7cee52015-01-23 12:12:01 +020063#define IS_SD(x) ((x)->version & SD_VERSION_SD)
Andrew Gabbasov3f2da752015-03-19 07:44:02 -050064#define IS_MMC(x) ((x)->version & MMC_VERSION_MMC)
Andy Fleming272cc702008-10-30 16:41:01 -050065
66#define MMC_DATA_READ 1
67#define MMC_DATA_WRITE 2
68
69#define NO_CARD_ERR -16 /* No SD/MMC card inserted */
70#define UNUSABLE_ERR -17 /* Unusable Card */
71#define COMM_ERR -18 /* Communications Error */
72#define TIMEOUT -19
Andrew Gabbasovbd47c132015-03-19 07:44:07 -050073#define SWITCH_ERR -20 /* Card reports failure to switch mode */
Andy Fleming272cc702008-10-30 16:41:01 -050074
Haavard Skinnemoen341188b2008-05-22 11:09:59 +020075#define MMC_CMD_GO_IDLE_STATE 0
76#define MMC_CMD_SEND_OP_COND 1
77#define MMC_CMD_ALL_SEND_CID 2
78#define MMC_CMD_SET_RELATIVE_ADDR 3
79#define MMC_CMD_SET_DSR 4
Andy Fleming272cc702008-10-30 16:41:01 -050080#define MMC_CMD_SWITCH 6
Haavard Skinnemoen341188b2008-05-22 11:09:59 +020081#define MMC_CMD_SELECT_CARD 7
Andy Fleming272cc702008-10-30 16:41:01 -050082#define MMC_CMD_SEND_EXT_CSD 8
Haavard Skinnemoen341188b2008-05-22 11:09:59 +020083#define MMC_CMD_SEND_CSD 9
84#define MMC_CMD_SEND_CID 10
Andy Fleming272cc702008-10-30 16:41:01 -050085#define MMC_CMD_STOP_TRANSMISSION 12
Haavard Skinnemoen341188b2008-05-22 11:09:59 +020086#define MMC_CMD_SEND_STATUS 13
87#define MMC_CMD_SET_BLOCKLEN 16
88#define MMC_CMD_READ_SINGLE_BLOCK 17
89#define MMC_CMD_READ_MULTIPLE_BLOCK 18
Pierre Aubert91fdabc2014-04-24 10:30:06 +020090#define MMC_CMD_SET_BLOCK_COUNT 23
Andy Fleming272cc702008-10-30 16:41:01 -050091#define MMC_CMD_WRITE_SINGLE_BLOCK 24
92#define MMC_CMD_WRITE_MULTIPLE_BLOCK 25
Gokul Sriram Palanisamy201def52017-10-26 16:44:16 +053093#define MMC_CMD_SET_WRITE_PROT 28
94#define MMC_CMD_CLR_WRITE_PROT 29
95#define MMC_CMD_SEND_WRITE_PROT 30
96#define MMC_CMD_SEND_WRITE_PROT_TYPE 31
Lei Wene6f99a52011-06-22 17:03:31 +000097#define MMC_CMD_ERASE_GROUP_START 35
98#define MMC_CMD_ERASE_GROUP_END 36
99#define MMC_CMD_ERASE 38
Haavard Skinnemoen341188b2008-05-22 11:09:59 +0200100#define MMC_CMD_APP_CMD 55
Thomas Choud52ebf12010-12-24 13:12:21 +0000101#define MMC_CMD_SPI_READ_OCR 58
102#define MMC_CMD_SPI_CRC_ON_OFF 59
Amar3690d6d2013-04-27 11:42:58 +0530103#define MMC_CMD_RES_MAN 62
104
105#define MMC_CMD62_ARG1 0xefac62ec
106#define MMC_CMD62_ARG2 0xcbaea7
107
Haavard Skinnemoen341188b2008-05-22 11:09:59 +0200108
Haavard Skinnemoen341188b2008-05-22 11:09:59 +0200109#define SD_CMD_SEND_RELATIVE_ADDR 3
Andy Fleming272cc702008-10-30 16:41:01 -0500110#define SD_CMD_SWITCH_FUNC 6
Haavard Skinnemoen341188b2008-05-22 11:09:59 +0200111#define SD_CMD_SEND_IF_COND 8
Otavio Salvadorf022d362015-02-17 10:42:43 -0200112#define SD_CMD_SWITCH_UHS18V 11
Haavard Skinnemoen341188b2008-05-22 11:09:59 +0200113
114#define SD_CMD_APP_SET_BUS_WIDTH 6
Lei Wene6f99a52011-06-22 17:03:31 +0000115#define SD_CMD_ERASE_WR_BLK_START 32
116#define SD_CMD_ERASE_WR_BLK_END 33
Haavard Skinnemoen341188b2008-05-22 11:09:59 +0200117#define SD_CMD_APP_SEND_OP_COND 41
Andy Fleming272cc702008-10-30 16:41:01 -0500118#define SD_CMD_APP_SEND_SCR 51
119
120/* SCR definitions in different words */
121#define SD_HIGHSPEED_BUSY 0x00020000
122#define SD_HIGHSPEED_SUPPORTED 0x00020000
123
Thomas Chouabe2c932011-04-19 03:48:31 +0000124#define OCR_BUSY 0x80000000
125#define OCR_HCS 0x40000000
Raffaele Recalcati31cacba2011-03-11 02:01:13 +0000126#define OCR_VOLTAGE_MASK 0x007FFF80
127#define OCR_ACCESS_MODE 0x60000000
Andy Fleming272cc702008-10-30 16:41:01 -0500128
Eric Nelson1aa2d072015-12-07 07:50:01 -0700129#define MMC_ERASE_ARG 0x00000000
130#define MMC_SECURE_ERASE_ARG 0x80000000
131#define MMC_TRIM_ARG 0x00000001
132#define MMC_DISCARD_ARG 0x00000003
133#define MMC_SECURE_TRIM1_ARG 0x80000001
134#define MMC_SECURE_TRIM2_ARG 0x80008000
Lei Wene6f99a52011-06-22 17:03:31 +0000135
Raffaele Recalcati5d4fc8d2011-03-11 02:01:12 +0000136#define MMC_STATUS_MASK (~0x0206BF7F)
Andrew Gabbasov6b2221b2014-04-03 04:34:32 -0500137#define MMC_STATUS_SWITCH_ERROR (1 << 7)
Thomas Chouabe2c932011-04-19 03:48:31 +0000138#define MMC_STATUS_RDY_FOR_DATA (1 << 8)
139#define MMC_STATUS_CURR_STATE (0xf << 9)
Thomas Choued018b22011-04-19 03:48:32 +0000140#define MMC_STATUS_ERROR (1 << 19)
Raffaele Recalcati5d4fc8d2011-03-11 02:01:12 +0000141
Jan Kloetzked617c422012-02-05 22:29:12 +0000142#define MMC_STATE_PRG (7 << 9)
143
Andy Fleming272cc702008-10-30 16:41:01 -0500144#define MMC_VDD_165_195 0x00000080 /* VDD voltage 1.65 - 1.95 */
145#define MMC_VDD_20_21 0x00000100 /* VDD voltage 2.0 ~ 2.1 */
146#define MMC_VDD_21_22 0x00000200 /* VDD voltage 2.1 ~ 2.2 */
147#define MMC_VDD_22_23 0x00000400 /* VDD voltage 2.2 ~ 2.3 */
148#define MMC_VDD_23_24 0x00000800 /* VDD voltage 2.3 ~ 2.4 */
149#define MMC_VDD_24_25 0x00001000 /* VDD voltage 2.4 ~ 2.5 */
150#define MMC_VDD_25_26 0x00002000 /* VDD voltage 2.5 ~ 2.6 */
151#define MMC_VDD_26_27 0x00004000 /* VDD voltage 2.6 ~ 2.7 */
152#define MMC_VDD_27_28 0x00008000 /* VDD voltage 2.7 ~ 2.8 */
153#define MMC_VDD_28_29 0x00010000 /* VDD voltage 2.8 ~ 2.9 */
154#define MMC_VDD_29_30 0x00020000 /* VDD voltage 2.9 ~ 3.0 */
155#define MMC_VDD_30_31 0x00040000 /* VDD voltage 3.0 ~ 3.1 */
156#define MMC_VDD_31_32 0x00080000 /* VDD voltage 3.1 ~ 3.2 */
157#define MMC_VDD_32_33 0x00100000 /* VDD voltage 3.2 ~ 3.3 */
158#define MMC_VDD_33_34 0x00200000 /* VDD voltage 3.3 ~ 3.4 */
159#define MMC_VDD_34_35 0x00400000 /* VDD voltage 3.4 ~ 3.5 */
160#define MMC_VDD_35_36 0x00800000 /* VDD voltage 3.5 ~ 3.6 */
161
162#define MMC_SWITCH_MODE_CMD_SET 0x00 /* Change the command set */
163#define MMC_SWITCH_MODE_SET_BITS 0x01 /* Set bits in EXT_CSD byte
164 addressed by index which are
165 1 in value field */
166#define MMC_SWITCH_MODE_CLEAR_BITS 0x02 /* Clear bits in EXT_CSD byte
167 addressed by index, which are
168 1 in value field */
169#define MMC_SWITCH_MODE_WRITE_BYTE 0x03 /* Set target byte to value */
170
171#define SD_SWITCH_CHECK 0
172#define SD_SWITCH_SWITCH 1
173
Gokul Sriram Palanisamy201def52017-10-26 16:44:16 +0530174#define MMC_RESP_TIMEOUT 2000
175#define MMC_ADDR_OUT_OF_RANGE(resp) ((resp >> 31) & 0x01)
176
177/*
178 * CSD fields
179*/
180#define WP_GRP_ENABLE(csd) ((csd[3] & 0x80000000) >> 31)
181#define WP_GRP_SIZE(csd) ((csd[2] & 0x0000001f))
182#define ERASE_GRP_MULT(csd) ((csd[2] & 0x000003e0) >> 5)
183#define ERASE_GRP_SIZE(csd) ((csd[2] & 0x00007c00) >> 10)
184
Andy Fleming272cc702008-10-30 16:41:01 -0500185/*
186 * EXT_CSD fields
187 */
Diego Santa Cruza7f852b2014-12-23 10:50:22 +0100188#define EXT_CSD_ENH_START_ADDR 136 /* R/W */
189#define EXT_CSD_ENH_SIZE_MULT 140 /* R/W */
Stephen Warrenf866a462013-06-11 15:14:01 -0600190#define EXT_CSD_GP_SIZE_MULT 143 /* R/W */
Markus Niebeld7b29122014-11-18 15:11:42 +0100191#define EXT_CSD_PARTITION_SETTING 155 /* R/W */
Oliver Metz1937e5a2013-10-01 20:32:07 +0200192#define EXT_CSD_PARTITIONS_ATTRIBUTE 156 /* R/W */
Diego Santa Cruzac9da0e2014-12-23 10:50:29 +0100193#define EXT_CSD_MAX_ENH_SIZE_MULT 157 /* R */
Lei Wen0560db12011-10-03 20:35:10 +0000194#define EXT_CSD_PARTITIONING_SUPPORT 160 /* RO */
Tom Rini33ace362014-02-07 14:15:20 -0500195#define EXT_CSD_RST_N_FUNCTION 162 /* R/W */
Diego Santa Cruz8dda5b02014-12-23 10:50:31 +0100196#define EXT_CSD_WR_REL_PARAM 166 /* R */
197#define EXT_CSD_WR_REL_SET 167 /* R/W */
Stephen Warrenf866a462013-06-11 15:14:01 -0600198#define EXT_CSD_RPMB_MULT 168 /* RO */
Gokul Sriram Palanisamy201def52017-10-26 16:44:16 +0530199#define EXT_CSD_USER_WP 171 /* R/W */
Lei Wen0560db12011-10-03 20:35:10 +0000200#define EXT_CSD_ERASE_GROUP_DEF 175 /* R/W */
Amar3690d6d2013-04-27 11:42:58 +0530201#define EXT_CSD_BOOT_BUS_WIDTH 177
Lei Wen0560db12011-10-03 20:35:10 +0000202#define EXT_CSD_PART_CONF 179 /* R/W */
203#define EXT_CSD_BUS_WIDTH 183 /* R/W */
204#define EXT_CSD_HS_TIMING 185 /* R/W */
205#define EXT_CSD_REV 192 /* RO */
206#define EXT_CSD_CARD_TYPE 196 /* RO */
207#define EXT_CSD_SEC_CNT 212 /* RO, 4 bytes */
Stephen Warrenf866a462013-06-11 15:14:01 -0600208#define EXT_CSD_HC_WP_GRP_SIZE 221 /* RO */
Lei Wen0560db12011-10-03 20:35:10 +0000209#define EXT_CSD_HC_ERASE_GRP_SIZE 224 /* RO */
Stephen Warren8948ea82012-07-30 10:55:43 +0000210#define EXT_CSD_BOOT_MULT 226 /* RO */
Sham Muthayyancad4eba2017-03-09 19:52:24 +0530211#define EXT_CSD_SEC_FEATURE_SUPPORT 231 /* RO */
Rajkumar Ayyasamyfb0e42b2017-11-28 15:17:37 +0530212#define EXT_CSD_TRIM_MULT 232 /* RO */
Andy Fleming272cc702008-10-30 16:41:01 -0500213
Sham Muthayyancad4eba2017-03-09 19:52:24 +0530214#define EXT_CSD_SEC_ER_EN (1 << 0)
215#define EXT_CSD_SEC_GB_CL_EN (1 << 4)
Andy Fleming272cc702008-10-30 16:41:01 -0500216/*
217 * EXT_CSD field definitions
218 */
219
Thomas Chouabe2c932011-04-19 03:48:31 +0000220#define EXT_CSD_CMD_SET_NORMAL (1 << 0)
221#define EXT_CSD_CMD_SET_SECURE (1 << 1)
222#define EXT_CSD_CMD_SET_CPSECURE (1 << 2)
Andy Fleming272cc702008-10-30 16:41:01 -0500223
Thomas Chouabe2c932011-04-19 03:48:31 +0000224#define EXT_CSD_CARD_TYPE_26 (1 << 0) /* Card can run at 26MHz */
225#define EXT_CSD_CARD_TYPE_52 (1 << 1) /* Card can run at 52MHz */
Jaehoon Chungd22e3d42014-05-16 13:59:54 +0900226#define EXT_CSD_CARD_TYPE_DDR_1_8V (1 << 2)
227#define EXT_CSD_CARD_TYPE_DDR_1_2V (1 << 3)
228#define EXT_CSD_CARD_TYPE_DDR_52 (EXT_CSD_CARD_TYPE_DDR_1_8V \
229 | EXT_CSD_CARD_TYPE_DDR_1_2V)
Andy Fleming272cc702008-10-30 16:41:01 -0500230
231#define EXT_CSD_BUS_WIDTH_1 0 /* Card is in 1 bit mode */
232#define EXT_CSD_BUS_WIDTH_4 1 /* Card is in 4 bit mode */
233#define EXT_CSD_BUS_WIDTH_8 2 /* Card is in 8 bit mode */
Jaehoon Chungd22e3d42014-05-16 13:59:54 +0900234#define EXT_CSD_DDR_BUS_WIDTH_4 5 /* Card is in 4 bit DDR mode */
235#define EXT_CSD_DDR_BUS_WIDTH_8 6 /* Card is in 8 bit DDR mode */
Haavard Skinnemoen341188b2008-05-22 11:09:59 +0200236
Amar3690d6d2013-04-27 11:42:58 +0530237#define EXT_CSD_BOOT_ACK_ENABLE (1 << 6)
238#define EXT_CSD_BOOT_PARTITION_ENABLE (1 << 3)
239#define EXT_CSD_PARTITION_ACCESS_ENABLE (1 << 0)
240#define EXT_CSD_PARTITION_ACCESS_DISABLE (0 << 0)
241
242#define EXT_CSD_BOOT_ACK(x) (x << 6)
243#define EXT_CSD_BOOT_PART_NUM(x) (x << 3)
244#define EXT_CSD_PARTITION_ACCESS(x) (x << 0)
245
Tom Rini5a99b9d2014-02-05 10:24:22 -0500246#define EXT_CSD_BOOT_BUS_WIDTH_MODE(x) (x << 3)
247#define EXT_CSD_BOOT_BUS_WIDTH_RESET(x) (x << 2)
248#define EXT_CSD_BOOT_BUS_WIDTH_WIDTH(x) (x)
Amar3690d6d2013-04-27 11:42:58 +0530249
Markus Niebeld7b29122014-11-18 15:11:42 +0100250#define EXT_CSD_PARTITION_SETTING_COMPLETED (1 << 0)
251
Diego Santa Cruzc3dbb4f2014-12-23 10:50:17 +0100252#define EXT_CSD_ENH_USR (1 << 0) /* user data area is enhanced */
253#define EXT_CSD_ENH_GP(x) (1 << ((x)+1)) /* GP part (x+1) is enhanced */
254
Diego Santa Cruz8dda5b02014-12-23 10:50:31 +0100255#define EXT_CSD_HS_CTRL_REL (1 << 0) /* host controlled WR_REL_SET */
256
257#define EXT_CSD_WR_DATA_REL_USR (1 << 0) /* user data area WR_REL */
258#define EXT_CSD_WR_DATA_REL_GP(x) (1 << ((x)+1)) /* GP part (x+1) WR_REL */
259
Gokul Sriram Palanisamy201def52017-10-26 16:44:16 +0530260#define EXT_CSD_US_PERM_WP_DIS (1 << 4)
261#define EXT_CSD_US_PWR_WP_DIS (1 << 3)
262#define EXT_CSD_US_PERM_WP_EN (1 << 2)
263#define EXT_CSD_US_PWR_WP_EN (1 << 0)
264
Andy Fleming1de97f92008-10-30 16:31:39 -0500265#define R1_ILLEGAL_COMMAND (1 << 22)
266#define R1_APP_CMD (1 << 5)
267
Andy Fleming272cc702008-10-30 16:41:01 -0500268#define MMC_RSP_PRESENT (1 << 0)
Thomas Chouabe2c932011-04-19 03:48:31 +0000269#define MMC_RSP_136 (1 << 1) /* 136 bit response */
270#define MMC_RSP_CRC (1 << 2) /* expect valid crc */
271#define MMC_RSP_BUSY (1 << 3) /* card may send busy */
272#define MMC_RSP_OPCODE (1 << 4) /* response contains opcode */
Andy Fleming272cc702008-10-30 16:41:01 -0500273
Thomas Chouabe2c932011-04-19 03:48:31 +0000274#define MMC_RSP_NONE (0)
275#define MMC_RSP_R1 (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
Andy Fleming272cc702008-10-30 16:41:01 -0500276#define MMC_RSP_R1b (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE| \
277 MMC_RSP_BUSY)
Thomas Chouabe2c932011-04-19 03:48:31 +0000278#define MMC_RSP_R2 (MMC_RSP_PRESENT|MMC_RSP_136|MMC_RSP_CRC)
279#define MMC_RSP_R3 (MMC_RSP_PRESENT)
280#define MMC_RSP_R4 (MMC_RSP_PRESENT)
281#define MMC_RSP_R5 (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
282#define MMC_RSP_R6 (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
283#define MMC_RSP_R7 (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
Andy Fleming272cc702008-10-30 16:41:01 -0500284
Lei Wenbc897b12011-05-02 16:26:26 +0000285#define MMCPART_NOAVAILABLE (0xff)
286#define PART_ACCESS_MASK (0x7)
287#define PART_SUPPORT (0x1)
Diego Santa Cruzc3dbb4f2014-12-23 10:50:17 +0100288#define ENHNCD_SUPPORT (0x2)
Oliver Metz1937e5a2013-10-01 20:32:07 +0200289#define PART_ENH_ATTRIB (0x1f)
wdenk71f95112003-06-15 22:40:42 +0000290
Simon Glass8bfa1952013-04-03 08:54:30 +0000291/* Maximum block size for MMC */
292#define MMC_MAX_BLOCK_LEN 512
293
Amar3690d6d2013-04-27 11:42:58 +0530294/* The number of MMC physical partitions. These consist of:
295 * boot partitions (2), general purpose partitions (4) in MMC v4.4.
296 */
297#define MMC_NUM_BOOT_PARTITION 2
Pierre Aubert91fdabc2014-04-24 10:30:06 +0200298#define MMC_PART_RPMB 3 /* RPMB partition number */
Amar3690d6d2013-04-27 11:42:58 +0530299
Simon Glasse7ecf7c2015-06-23 15:38:48 -0600300/* Driver model support */
301
302/**
303 * struct mmc_uclass_priv - Holds information about a device used by the uclass
304 */
305struct mmc_uclass_priv {
306 struct mmc *mmc;
307};
308
309/**
310 * mmc_get_mmc_dev() - get the MMC struct pointer for a device
311 *
312 * Provided that the device is already probed and ready for use, this value
313 * will be available.
314 *
315 * @dev: Device
316 * @return associated mmc struct pointer if available, else NULL
317 */
318struct mmc *mmc_get_mmc_dev(struct udevice *dev);
319
320/* End of driver model support */
321
Sham Muthayyancad4eba2017-03-09 19:52:24 +0530322#define MMC_SECURE_TRIM1_ARG 0x80000001
323#define MMC_SECURE_TRIM2_ARG 0x80008000
324
325
Andy Fleming1de97f92008-10-30 16:31:39 -0500326struct mmc_cid {
327 unsigned long psn;
328 unsigned short oid;
329 unsigned char mid;
330 unsigned char prv;
331 unsigned char mdt;
332 char pnm[7];
333};
334
Andy Fleming272cc702008-10-30 16:41:01 -0500335struct mmc_cmd {
336 ushort cmdidx;
337 uint resp_type;
338 uint cmdarg;
Rabin Vincent0b453ff2009-04-05 13:30:55 +0530339 uint response[4];
Andy Fleming272cc702008-10-30 16:41:01 -0500340};
341
342struct mmc_data {
343 union {
344 char *dest;
345 const char *src; /* src buffers don't get written to */
346 };
347 uint flags;
348 uint blocks;
349 uint blocksize;
350};
351
Pantelis Antoniouab769f22014-02-26 19:28:45 +0200352/* forward decl. */
353struct mmc;
354
355struct mmc_ops {
356 int (*send_cmd)(struct mmc *mmc,
357 struct mmc_cmd *cmd, struct mmc_data *data);
358 void (*set_ios)(struct mmc *mmc);
359 int (*init)(struct mmc *mmc);
360 int (*getcd)(struct mmc *mmc);
361 int (*getwp)(struct mmc *mmc);
362};
363
Pantelis Antoniou93bfd612014-03-11 19:34:20 +0200364struct mmc_config {
365 const char *name;
366 const struct mmc_ops *ops;
367 uint host_caps;
Andy Fleming272cc702008-10-30 16:41:01 -0500368 uint voltages;
Andy Fleming272cc702008-10-30 16:41:01 -0500369 uint f_min;
370 uint f_max;
Pantelis Antoniou93bfd612014-03-11 19:34:20 +0200371 uint b_max;
372 unsigned char part_type;
373};
374
375/* TODO struct mmc should be in mmc_private but it's hard to fix right now */
376struct mmc {
377 struct list_head link;
378 const struct mmc_config *cfg; /* provided configuration */
379 uint version;
380 void *priv;
381 uint has_init;
Andy Fleming272cc702008-10-30 16:41:01 -0500382 int high_capacity;
383 uint bus_width;
384 uint clock;
385 uint card_caps;
Andy Fleming272cc702008-10-30 16:41:01 -0500386 uint ocr;
Markus Niebelab711882013-12-16 13:40:46 +0100387 uint dsr;
388 uint dsr_imp;
Andy Fleming272cc702008-10-30 16:41:01 -0500389 uint scr[2];
390 uint csd[4];
Rabin Vincent0b453ff2009-04-05 13:30:55 +0530391 uint cid[4];
Andy Fleming272cc702008-10-30 16:41:01 -0500392 ushort rca;
Diego Santa Cruzc3dbb4f2014-12-23 10:50:17 +0100393 u8 part_support;
394 u8 part_attr;
Diego Santa Cruz9e41a002014-12-23 10:50:33 +0100395 u8 wr_rel_set;
Lei Wenbc897b12011-05-02 16:26:26 +0000396 char part_config;
397 char part_num;
Andy Fleming272cc702008-10-30 16:41:01 -0500398 uint tran_speed;
399 uint read_bl_len;
400 uint write_bl_len;
Diego Santa Cruza4ff9f82014-12-23 10:50:24 +0100401 uint erase_grp_size; /* in 512-byte sectors */
Diego Santa Cruz037dc0a2014-12-23 10:50:25 +0100402 uint hc_wp_grp_size; /* in 512-byte sectors */
Gokul Sriram Palanisamy201def52017-10-26 16:44:16 +0530403 uint wp_grp_size;
404 uint wp_grp_enable;
Andy Fleming272cc702008-10-30 16:41:01 -0500405 u64 capacity;
Stephen Warrenf866a462013-06-11 15:14:01 -0600406 u64 capacity_user;
407 u64 capacity_boot;
408 u64 capacity_rpmb;
409 u64 capacity_gp[4];
Diego Santa Cruza7f852b2014-12-23 10:50:22 +0100410 u64 enh_user_start;
411 u64 enh_user_size;
Andy Fleming272cc702008-10-30 16:41:01 -0500412 block_dev_desc_t block_dev;
Che-Liang Chioue9550442012-11-28 15:21:13 +0000413 char op_cond_pending; /* 1 if we are waiting on an op_cond command */
414 char init_in_progress; /* 1 if we have done mmc_start_init() */
415 char preinit; /* start init as early as possible */
Andrew Gabbasov786e8f82014-12-01 06:59:09 -0600416 int ddr_mode;
Sham Muthayyancad4eba2017-03-09 19:52:24 +0530417 uchar sec_feature_support;
Rajkumar Ayyasamyfb0e42b2017-11-28 15:17:37 +0530418 unsigned int trim_timeout; /* In milliseconds */
Andy Fleming272cc702008-10-30 16:41:01 -0500419};
420
Diego Santa Cruzac9da0e2014-12-23 10:50:29 +0100421struct mmc_hwpart_conf {
422 struct {
423 uint enh_start; /* in 512-byte sectors */
424 uint enh_size; /* in 512-byte sectors, if 0 no enh area */
Diego Santa Cruz8dda5b02014-12-23 10:50:31 +0100425 unsigned wr_rel_change : 1;
426 unsigned wr_rel_set : 1;
Diego Santa Cruzac9da0e2014-12-23 10:50:29 +0100427 } user;
428 struct {
429 uint size; /* in 512-byte sectors */
Diego Santa Cruz8dda5b02014-12-23 10:50:31 +0100430 unsigned enhanced : 1;
431 unsigned wr_rel_change : 1;
432 unsigned wr_rel_set : 1;
Diego Santa Cruzac9da0e2014-12-23 10:50:29 +0100433 } gp_part[4];
434};
435
436enum mmc_hwpart_conf_mode {
437 MMC_HWPART_CONF_CHECK,
438 MMC_HWPART_CONF_SET,
439 MMC_HWPART_CONF_COMPLETE,
440};
441
Andy Fleming272cc702008-10-30 16:41:01 -0500442int mmc_register(struct mmc *mmc);
Pantelis Antoniou93bfd612014-03-11 19:34:20 +0200443struct mmc *mmc_create(const struct mmc_config *cfg, void *priv);
444void mmc_destroy(struct mmc *mmc);
Andy Fleming272cc702008-10-30 16:41:01 -0500445int mmc_initialize(bd_t *bis);
446int mmc_init(struct mmc *mmc);
447int mmc_read(struct mmc *mmc, u64 src, uchar *dst, int size);
Jerry Huang4a6ee172010-11-25 17:06:07 +0000448void mmc_set_clock(struct mmc *mmc, uint clock);
Andy Fleming272cc702008-10-30 16:41:01 -0500449struct mmc *find_mmc_device(int dev_num);
Steve Sakoman89716962010-07-01 12:12:42 -0700450int mmc_set_dev(int dev_num);
Andy Fleming272cc702008-10-30 16:41:01 -0500451void print_mmc_devices(char separator);
Lei Wenea6ebe22011-05-02 16:26:25 +0000452int get_mmc_num(void);
Lei Wenbc897b12011-05-02 16:26:26 +0000453int mmc_switch_part(int dev_num, unsigned int part_num);
Diego Santa Cruzac9da0e2014-12-23 10:50:29 +0100454int mmc_hwpart_config(struct mmc *mmc, const struct mmc_hwpart_conf *conf,
455 enum mmc_hwpart_conf_mode mode);
Thierry Reding48972d92012-01-02 01:15:37 +0000456int mmc_getcd(struct mmc *mmc);
Jeroen Hofstee750121c2014-07-12 21:24:08 +0200457int board_mmc_getcd(struct mmc *mmc);
Nikita Kiryanovd23d8d72012-12-03 02:19:46 +0000458int mmc_getwp(struct mmc *mmc);
Jeroen Hofstee750121c2014-07-12 21:24:08 +0200459int board_mmc_getwp(struct mmc *mmc);
Markus Niebelab711882013-12-16 13:40:46 +0100460int mmc_set_dsr(struct mmc *mmc, u16 val);
Amar3690d6d2013-04-27 11:42:58 +0530461/* Function to change the size of boot partition and rpmb partitions */
462int mmc_boot_partition_size_change(struct mmc *mmc, unsigned long bootsize,
463 unsigned long rpmbsize);
Tom Rini792970b2014-02-05 10:24:21 -0500464/* Function to modify the PARTITION_CONFIG field of EXT_CSD */
465int mmc_set_part_conf(struct mmc *mmc, u8 ack, u8 part_num, u8 access);
Tom Rini5a99b9d2014-02-05 10:24:22 -0500466/* Function to modify the BOOT_BUS_WIDTH field of EXT_CSD */
467int mmc_set_boot_bus_width(struct mmc *mmc, u8 width, u8 reset, u8 mode);
Tom Rini33ace362014-02-07 14:15:20 -0500468/* Function to modify the RST_n_FUNCTION field of EXT_CSD */
469int mmc_set_rst_n_function(struct mmc *mmc, u8 enable);
Pierre Aubert91fdabc2014-04-24 10:30:06 +0200470/* Functions to read / write the RPMB partition */
471int mmc_rpmb_set_key(struct mmc *mmc, void *key);
472int mmc_rpmb_get_counter(struct mmc *mmc, unsigned long *counter);
473int mmc_rpmb_read(struct mmc *mmc, void *addr, unsigned short blk,
474 unsigned short cnt, unsigned char *key);
475int mmc_rpmb_write(struct mmc *mmc, void *addr, unsigned short blk,
476 unsigned short cnt, unsigned char *key);
Che-Liang Chioue9550442012-11-28 15:21:13 +0000477/**
478 * Start device initialization and return immediately; it does not block on
479 * polling OCR (operation condition register) status. Then you should call
480 * mmc_init, which would block on polling OCR status and complete the device
481 * initializatin.
482 *
483 * @param mmc Pointer to a MMC device struct
484 * @return 0 on success, IN_PROGRESS on waiting for OCR status, <0 on error.
485 */
486int mmc_start_init(struct mmc *mmc);
487
488/**
489 * Set preinit flag of mmc device.
490 *
491 * This will cause the device to be pre-inited during mmc_initialize(),
492 * which may save boot time if the device is not accessed until later.
493 * Some eMMC devices take 200-300ms to init, but unfortunately they
494 * must be sent a series of commands to even get them to start preparing
495 * for operation.
496 *
497 * @param mmc Pointer to a MMC device struct
498 * @param preinit preinit flag value
499 */
500void mmc_set_preinit(struct mmc *mmc, int preinit);
501
Reinhard Meyer1592ef82010-08-13 10:31:06 +0200502#ifdef CONFIG_GENERIC_MMC
Paul Burton8687d5c2013-09-04 16:12:26 +0100503#ifdef CONFIG_MMC_SPI
Tom Rini0b2da7e2014-03-28 16:55:29 -0400504#define mmc_host_is_spi(mmc) ((mmc)->cfg->host_caps & MMC_MODE_SPI)
Paul Burton8687d5c2013-09-04 16:12:26 +0100505#else
506#define mmc_host_is_spi(mmc) 0
507#endif
Thomas Choud52ebf12010-12-24 13:12:21 +0000508struct mmc *mmc_spi_init(uint bus, uint cs, uint speed, uint mode);
Reinhard Meyer1592ef82010-08-13 10:31:06 +0200509#else
Andy Fleming272cc702008-10-30 16:41:01 -0500510int mmc_legacy_init(int verbose);
511#endif
Reinhard Meyer1592ef82010-08-13 10:31:06 +0200512
Paul Kocialkowski95de9ab2014-11-08 20:55:45 +0100513void board_mmc_power_init(void);
Fabio Estevam3c7ca962014-02-15 14:51:59 -0200514int board_mmc_init(bd_t *bis);
Jeroen Hofstee750121c2014-07-12 21:24:08 +0200515int cpu_mmc_init(bd_t *bis);
Jeroen Hofsteeaeb80552014-10-08 22:58:05 +0200516int mmc_get_env_addr(struct mmc *mmc, int copy, u32 *env_addr);
Fabio Estevam3c7ca962014-02-15 14:51:59 -0200517
Simon Glass91785f72015-01-27 22:13:39 -0700518struct pci_device_id;
519
520/**
521 * pci_mmc_init() - set up PCI MMC devices
522 *
523 * This finds all the matching PCI IDs and sets them up as MMC devices.
524 *
525 * @name: Name to use for devices
526 * @mmc_supported: PCI IDs to search for
527 * @num_ids: Number of elements in @mmc_supported
528 */
529int pci_mmc_init(const char *name, struct pci_device_id *mmc_supported,
530 int num_ids);
531
Gokul Sriram Palanisamy201def52017-10-26 16:44:16 +0530532int mmc_write_protect(struct mmc *mmc, unsigned int start_blk,
533 unsigned int cnt_blk, int set_clr);
534
Pantelis Antoniou93bfd612014-03-11 19:34:20 +0200535/* Set block count limit because of 16 bit register limit on some hardware*/
536#ifndef CONFIG_SYS_MMC_MAX_BLK_COUNT
537#define CONFIG_SYS_MMC_MAX_BLK_COUNT 65535
538#endif
539
wdenk71f95112003-06-15 22:40:42 +0000540#endif /* _MMC_H_ */