blob: dd47f34e9de09c6b516c1baadfbf57f645606925 [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 Wahren1a3619c2016-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
Lei Wene6f99a52011-06-22 17:03:31 +000093#define MMC_CMD_ERASE_GROUP_START 35
94#define MMC_CMD_ERASE_GROUP_END 36
95#define MMC_CMD_ERASE 38
Haavard Skinnemoen341188b2008-05-22 11:09:59 +020096#define MMC_CMD_APP_CMD 55
Thomas Choud52ebf12010-12-24 13:12:21 +000097#define MMC_CMD_SPI_READ_OCR 58
98#define MMC_CMD_SPI_CRC_ON_OFF 59
Amar3690d6d2013-04-27 11:42:58 +053099#define MMC_CMD_RES_MAN 62
100
101#define MMC_CMD62_ARG1 0xefac62ec
102#define MMC_CMD62_ARG2 0xcbaea7
103
Haavard Skinnemoen341188b2008-05-22 11:09:59 +0200104
Haavard Skinnemoen341188b2008-05-22 11:09:59 +0200105#define SD_CMD_SEND_RELATIVE_ADDR 3
Andy Fleming272cc702008-10-30 16:41:01 -0500106#define SD_CMD_SWITCH_FUNC 6
Haavard Skinnemoen341188b2008-05-22 11:09:59 +0200107#define SD_CMD_SEND_IF_COND 8
Otavio Salvadorf022d362015-02-17 10:42:43 -0200108#define SD_CMD_SWITCH_UHS18V 11
Haavard Skinnemoen341188b2008-05-22 11:09:59 +0200109
110#define SD_CMD_APP_SET_BUS_WIDTH 6
Lei Wene6f99a52011-06-22 17:03:31 +0000111#define SD_CMD_ERASE_WR_BLK_START 32
112#define SD_CMD_ERASE_WR_BLK_END 33
Haavard Skinnemoen341188b2008-05-22 11:09:59 +0200113#define SD_CMD_APP_SEND_OP_COND 41
Andy Fleming272cc702008-10-30 16:41:01 -0500114#define SD_CMD_APP_SEND_SCR 51
115
116/* SCR definitions in different words */
117#define SD_HIGHSPEED_BUSY 0x00020000
118#define SD_HIGHSPEED_SUPPORTED 0x00020000
119
Thomas Chouabe2c932011-04-19 03:48:31 +0000120#define OCR_BUSY 0x80000000
121#define OCR_HCS 0x40000000
Raffaele Recalcati31cacba2011-03-11 02:01:13 +0000122#define OCR_VOLTAGE_MASK 0x007FFF80
123#define OCR_ACCESS_MODE 0x60000000
Andy Fleming272cc702008-10-30 16:41:01 -0500124
Eric Nelson1aa2d072015-12-07 07:50:01 -0700125#define MMC_ERASE_ARG 0x00000000
126#define MMC_SECURE_ERASE_ARG 0x80000000
127#define MMC_TRIM_ARG 0x00000001
128#define MMC_DISCARD_ARG 0x00000003
129#define MMC_SECURE_TRIM1_ARG 0x80000001
130#define MMC_SECURE_TRIM2_ARG 0x80008000
Lei Wene6f99a52011-06-22 17:03:31 +0000131
Raffaele Recalcati5d4fc8d2011-03-11 02:01:12 +0000132#define MMC_STATUS_MASK (~0x0206BF7F)
Andrew Gabbasov6b2221b2014-04-03 04:34:32 -0500133#define MMC_STATUS_SWITCH_ERROR (1 << 7)
Thomas Chouabe2c932011-04-19 03:48:31 +0000134#define MMC_STATUS_RDY_FOR_DATA (1 << 8)
135#define MMC_STATUS_CURR_STATE (0xf << 9)
Thomas Choued018b22011-04-19 03:48:32 +0000136#define MMC_STATUS_ERROR (1 << 19)
Raffaele Recalcati5d4fc8d2011-03-11 02:01:12 +0000137
Jan Kloetzked617c422012-02-05 22:29:12 +0000138#define MMC_STATE_PRG (7 << 9)
139
Andy Fleming272cc702008-10-30 16:41:01 -0500140#define MMC_VDD_165_195 0x00000080 /* VDD voltage 1.65 - 1.95 */
141#define MMC_VDD_20_21 0x00000100 /* VDD voltage 2.0 ~ 2.1 */
142#define MMC_VDD_21_22 0x00000200 /* VDD voltage 2.1 ~ 2.2 */
143#define MMC_VDD_22_23 0x00000400 /* VDD voltage 2.2 ~ 2.3 */
144#define MMC_VDD_23_24 0x00000800 /* VDD voltage 2.3 ~ 2.4 */
145#define MMC_VDD_24_25 0x00001000 /* VDD voltage 2.4 ~ 2.5 */
146#define MMC_VDD_25_26 0x00002000 /* VDD voltage 2.5 ~ 2.6 */
147#define MMC_VDD_26_27 0x00004000 /* VDD voltage 2.6 ~ 2.7 */
148#define MMC_VDD_27_28 0x00008000 /* VDD voltage 2.7 ~ 2.8 */
149#define MMC_VDD_28_29 0x00010000 /* VDD voltage 2.8 ~ 2.9 */
150#define MMC_VDD_29_30 0x00020000 /* VDD voltage 2.9 ~ 3.0 */
151#define MMC_VDD_30_31 0x00040000 /* VDD voltage 3.0 ~ 3.1 */
152#define MMC_VDD_31_32 0x00080000 /* VDD voltage 3.1 ~ 3.2 */
153#define MMC_VDD_32_33 0x00100000 /* VDD voltage 3.2 ~ 3.3 */
154#define MMC_VDD_33_34 0x00200000 /* VDD voltage 3.3 ~ 3.4 */
155#define MMC_VDD_34_35 0x00400000 /* VDD voltage 3.4 ~ 3.5 */
156#define MMC_VDD_35_36 0x00800000 /* VDD voltage 3.5 ~ 3.6 */
157
158#define MMC_SWITCH_MODE_CMD_SET 0x00 /* Change the command set */
159#define MMC_SWITCH_MODE_SET_BITS 0x01 /* Set bits in EXT_CSD byte
160 addressed by index which are
161 1 in value field */
162#define MMC_SWITCH_MODE_CLEAR_BITS 0x02 /* Clear bits in EXT_CSD byte
163 addressed by index, which are
164 1 in value field */
165#define MMC_SWITCH_MODE_WRITE_BYTE 0x03 /* Set target byte to value */
166
167#define SD_SWITCH_CHECK 0
168#define SD_SWITCH_SWITCH 1
169
170/*
171 * EXT_CSD fields
172 */
Diego Santa Cruza7f852b2014-12-23 10:50:22 +0100173#define EXT_CSD_ENH_START_ADDR 136 /* R/W */
174#define EXT_CSD_ENH_SIZE_MULT 140 /* R/W */
Stephen Warrenf866a462013-06-11 15:14:01 -0600175#define EXT_CSD_GP_SIZE_MULT 143 /* R/W */
Markus Niebeld7b29122014-11-18 15:11:42 +0100176#define EXT_CSD_PARTITION_SETTING 155 /* R/W */
Oliver Metz1937e5a2013-10-01 20:32:07 +0200177#define EXT_CSD_PARTITIONS_ATTRIBUTE 156 /* R/W */
Diego Santa Cruzac9da0e2014-12-23 10:50:29 +0100178#define EXT_CSD_MAX_ENH_SIZE_MULT 157 /* R */
Lei Wen0560db12011-10-03 20:35:10 +0000179#define EXT_CSD_PARTITIONING_SUPPORT 160 /* RO */
Tom Rini33ace362014-02-07 14:15:20 -0500180#define EXT_CSD_RST_N_FUNCTION 162 /* R/W */
Diego Santa Cruz8dda5b0e2014-12-23 10:50:31 +0100181#define EXT_CSD_WR_REL_PARAM 166 /* R */
182#define EXT_CSD_WR_REL_SET 167 /* R/W */
Stephen Warrenf866a462013-06-11 15:14:01 -0600183#define EXT_CSD_RPMB_MULT 168 /* RO */
Lei Wen0560db12011-10-03 20:35:10 +0000184#define EXT_CSD_ERASE_GROUP_DEF 175 /* R/W */
Amar3690d6d2013-04-27 11:42:58 +0530185#define EXT_CSD_BOOT_BUS_WIDTH 177
Lei Wen0560db12011-10-03 20:35:10 +0000186#define EXT_CSD_PART_CONF 179 /* R/W */
187#define EXT_CSD_BUS_WIDTH 183 /* R/W */
188#define EXT_CSD_HS_TIMING 185 /* R/W */
189#define EXT_CSD_REV 192 /* RO */
190#define EXT_CSD_CARD_TYPE 196 /* RO */
191#define EXT_CSD_SEC_CNT 212 /* RO, 4 bytes */
Stephen Warrenf866a462013-06-11 15:14:01 -0600192#define EXT_CSD_HC_WP_GRP_SIZE 221 /* RO */
Lei Wen0560db12011-10-03 20:35:10 +0000193#define EXT_CSD_HC_ERASE_GRP_SIZE 224 /* RO */
Stephen Warren8948ea82012-07-30 10:55:43 +0000194#define EXT_CSD_BOOT_MULT 226 /* RO */
Andy Fleming272cc702008-10-30 16:41:01 -0500195
196/*
197 * EXT_CSD field definitions
198 */
199
Thomas Chouabe2c932011-04-19 03:48:31 +0000200#define EXT_CSD_CMD_SET_NORMAL (1 << 0)
201#define EXT_CSD_CMD_SET_SECURE (1 << 1)
202#define EXT_CSD_CMD_SET_CPSECURE (1 << 2)
Andy Fleming272cc702008-10-30 16:41:01 -0500203
Thomas Chouabe2c932011-04-19 03:48:31 +0000204#define EXT_CSD_CARD_TYPE_26 (1 << 0) /* Card can run at 26MHz */
205#define EXT_CSD_CARD_TYPE_52 (1 << 1) /* Card can run at 52MHz */
Jaehoon Chungd22e3d42014-05-16 13:59:54 +0900206#define EXT_CSD_CARD_TYPE_DDR_1_8V (1 << 2)
207#define EXT_CSD_CARD_TYPE_DDR_1_2V (1 << 3)
208#define EXT_CSD_CARD_TYPE_DDR_52 (EXT_CSD_CARD_TYPE_DDR_1_8V \
209 | EXT_CSD_CARD_TYPE_DDR_1_2V)
Andy Fleming272cc702008-10-30 16:41:01 -0500210
211#define EXT_CSD_BUS_WIDTH_1 0 /* Card is in 1 bit mode */
212#define EXT_CSD_BUS_WIDTH_4 1 /* Card is in 4 bit mode */
213#define EXT_CSD_BUS_WIDTH_8 2 /* Card is in 8 bit mode */
Jaehoon Chungd22e3d42014-05-16 13:59:54 +0900214#define EXT_CSD_DDR_BUS_WIDTH_4 5 /* Card is in 4 bit DDR mode */
215#define EXT_CSD_DDR_BUS_WIDTH_8 6 /* Card is in 8 bit DDR mode */
Haavard Skinnemoen341188b2008-05-22 11:09:59 +0200216
Amar3690d6d2013-04-27 11:42:58 +0530217#define EXT_CSD_BOOT_ACK_ENABLE (1 << 6)
218#define EXT_CSD_BOOT_PARTITION_ENABLE (1 << 3)
219#define EXT_CSD_PARTITION_ACCESS_ENABLE (1 << 0)
220#define EXT_CSD_PARTITION_ACCESS_DISABLE (0 << 0)
221
222#define EXT_CSD_BOOT_ACK(x) (x << 6)
223#define EXT_CSD_BOOT_PART_NUM(x) (x << 3)
224#define EXT_CSD_PARTITION_ACCESS(x) (x << 0)
225
Tom Rini5a99b9d2014-02-05 10:24:22 -0500226#define EXT_CSD_BOOT_BUS_WIDTH_MODE(x) (x << 3)
227#define EXT_CSD_BOOT_BUS_WIDTH_RESET(x) (x << 2)
228#define EXT_CSD_BOOT_BUS_WIDTH_WIDTH(x) (x)
Amar3690d6d2013-04-27 11:42:58 +0530229
Markus Niebeld7b29122014-11-18 15:11:42 +0100230#define EXT_CSD_PARTITION_SETTING_COMPLETED (1 << 0)
231
Diego Santa Cruzc3dbb4f2014-12-23 10:50:17 +0100232#define EXT_CSD_ENH_USR (1 << 0) /* user data area is enhanced */
233#define EXT_CSD_ENH_GP(x) (1 << ((x)+1)) /* GP part (x+1) is enhanced */
234
Diego Santa Cruz8dda5b0e2014-12-23 10:50:31 +0100235#define EXT_CSD_HS_CTRL_REL (1 << 0) /* host controlled WR_REL_SET */
236
237#define EXT_CSD_WR_DATA_REL_USR (1 << 0) /* user data area WR_REL */
238#define EXT_CSD_WR_DATA_REL_GP(x) (1 << ((x)+1)) /* GP part (x+1) WR_REL */
239
Andy Fleming1de97f92008-10-30 16:31:39 -0500240#define R1_ILLEGAL_COMMAND (1 << 22)
241#define R1_APP_CMD (1 << 5)
242
Andy Fleming272cc702008-10-30 16:41:01 -0500243#define MMC_RSP_PRESENT (1 << 0)
Thomas Chouabe2c932011-04-19 03:48:31 +0000244#define MMC_RSP_136 (1 << 1) /* 136 bit response */
245#define MMC_RSP_CRC (1 << 2) /* expect valid crc */
246#define MMC_RSP_BUSY (1 << 3) /* card may send busy */
247#define MMC_RSP_OPCODE (1 << 4) /* response contains opcode */
Andy Fleming272cc702008-10-30 16:41:01 -0500248
Thomas Chouabe2c932011-04-19 03:48:31 +0000249#define MMC_RSP_NONE (0)
250#define MMC_RSP_R1 (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
Andy Fleming272cc702008-10-30 16:41:01 -0500251#define MMC_RSP_R1b (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE| \
252 MMC_RSP_BUSY)
Thomas Chouabe2c932011-04-19 03:48:31 +0000253#define MMC_RSP_R2 (MMC_RSP_PRESENT|MMC_RSP_136|MMC_RSP_CRC)
254#define MMC_RSP_R3 (MMC_RSP_PRESENT)
255#define MMC_RSP_R4 (MMC_RSP_PRESENT)
256#define MMC_RSP_R5 (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
257#define MMC_RSP_R6 (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
258#define MMC_RSP_R7 (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
Andy Fleming272cc702008-10-30 16:41:01 -0500259
Lei Wenbc897b12011-05-02 16:26:26 +0000260#define MMCPART_NOAVAILABLE (0xff)
261#define PART_ACCESS_MASK (0x7)
262#define PART_SUPPORT (0x1)
Diego Santa Cruzc3dbb4f2014-12-23 10:50:17 +0100263#define ENHNCD_SUPPORT (0x2)
Oliver Metz1937e5a2013-10-01 20:32:07 +0200264#define PART_ENH_ATTRIB (0x1f)
wdenk71f95112003-06-15 22:40:42 +0000265
Simon Glass8bfa1952013-04-03 08:54:30 +0000266/* Maximum block size for MMC */
267#define MMC_MAX_BLOCK_LEN 512
268
Amar3690d6d2013-04-27 11:42:58 +0530269/* The number of MMC physical partitions. These consist of:
270 * boot partitions (2), general purpose partitions (4) in MMC v4.4.
271 */
272#define MMC_NUM_BOOT_PARTITION 2
Pierre Aubert91fdabc2014-04-24 10:30:06 +0200273#define MMC_PART_RPMB 3 /* RPMB partition number */
Amar3690d6d2013-04-27 11:42:58 +0530274
Simon Glasse7ecf7c2015-06-23 15:38:48 -0600275/* Driver model support */
276
277/**
278 * struct mmc_uclass_priv - Holds information about a device used by the uclass
279 */
280struct mmc_uclass_priv {
281 struct mmc *mmc;
282};
283
284/**
285 * mmc_get_mmc_dev() - get the MMC struct pointer for a device
286 *
287 * Provided that the device is already probed and ready for use, this value
288 * will be available.
289 *
290 * @dev: Device
291 * @return associated mmc struct pointer if available, else NULL
292 */
293struct mmc *mmc_get_mmc_dev(struct udevice *dev);
294
295/* End of driver model support */
296
Andy Fleming1de97f92008-10-30 16:31:39 -0500297struct mmc_cid {
298 unsigned long psn;
299 unsigned short oid;
300 unsigned char mid;
301 unsigned char prv;
302 unsigned char mdt;
303 char pnm[7];
304};
305
Andy Fleming272cc702008-10-30 16:41:01 -0500306struct mmc_cmd {
307 ushort cmdidx;
308 uint resp_type;
309 uint cmdarg;
Rabin Vincent0b453ff2009-04-05 13:30:55 +0530310 uint response[4];
Andy Fleming272cc702008-10-30 16:41:01 -0500311};
312
313struct mmc_data {
314 union {
315 char *dest;
316 const char *src; /* src buffers don't get written to */
317 };
318 uint flags;
319 uint blocks;
320 uint blocksize;
321};
322
Pantelis Antoniouab769f22014-02-26 19:28:45 +0200323/* forward decl. */
324struct mmc;
325
Simon Glass8ca51e52016-06-12 23:30:22 -0600326#ifdef CONFIG_DM_MMC_OPS
327struct dm_mmc_ops {
328 /**
329 * send_cmd() - Send a command to the MMC device
330 *
331 * @dev: Device to receive the command
332 * @cmd: Command to send
333 * @data: Additional data to send/receive
334 * @return 0 if OK, -ve on error
335 */
336 int (*send_cmd)(struct udevice *dev, struct mmc_cmd *cmd,
337 struct mmc_data *data);
338
339 /**
340 * set_ios() - Set the I/O speed/width for an MMC device
341 *
342 * @dev: Device to update
343 * @return 0 if OK, -ve on error
344 */
345 int (*set_ios)(struct udevice *dev);
346
347 /**
348 * get_cd() - See whether a card is present
349 *
350 * @dev: Device to check
351 * @return 0 if not present, 1 if present, -ve on error
352 */
353 int (*get_cd)(struct udevice *dev);
354
355 /**
356 * get_wp() - See whether a card has write-protect enabled
357 *
358 * @dev: Device to check
359 * @return 0 if write-enabled, 1 if write-protected, -ve on error
360 */
361 int (*get_wp)(struct udevice *dev);
362};
363
364#define mmc_get_ops(dev) ((struct dm_mmc_ops *)(dev)->driver->ops)
365
366int dm_mmc_send_cmd(struct udevice *dev, struct mmc_cmd *cmd,
367 struct mmc_data *data);
368int dm_mmc_set_ios(struct udevice *dev);
369int dm_mmc_get_cd(struct udevice *dev);
370int dm_mmc_get_wp(struct udevice *dev);
371
372/* Transition functions for compatibility */
373int mmc_set_ios(struct mmc *mmc);
374int mmc_getcd(struct mmc *mmc);
375int mmc_getwp(struct mmc *mmc);
376
377#else
Pantelis Antoniouab769f22014-02-26 19:28:45 +0200378struct mmc_ops {
379 int (*send_cmd)(struct mmc *mmc,
380 struct mmc_cmd *cmd, struct mmc_data *data);
381 void (*set_ios)(struct mmc *mmc);
382 int (*init)(struct mmc *mmc);
383 int (*getcd)(struct mmc *mmc);
384 int (*getwp)(struct mmc *mmc);
385};
Simon Glass8ca51e52016-06-12 23:30:22 -0600386#endif
Pantelis Antoniouab769f22014-02-26 19:28:45 +0200387
Pantelis Antoniou93bfd612014-03-11 19:34:20 +0200388struct mmc_config {
389 const char *name;
Simon Glass8ca51e52016-06-12 23:30:22 -0600390#ifndef CONFIG_DM_MMC_OPS
Pantelis Antoniou93bfd612014-03-11 19:34:20 +0200391 const struct mmc_ops *ops;
Simon Glass8ca51e52016-06-12 23:30:22 -0600392#endif
Pantelis Antoniou93bfd612014-03-11 19:34:20 +0200393 uint host_caps;
Andy Fleming272cc702008-10-30 16:41:01 -0500394 uint voltages;
Andy Fleming272cc702008-10-30 16:41:01 -0500395 uint f_min;
396 uint f_max;
Pantelis Antoniou93bfd612014-03-11 19:34:20 +0200397 uint b_max;
398 unsigned char part_type;
399};
400
Simon Glass8ca51e52016-06-12 23:30:22 -0600401/*
402 * With CONFIG_DM_MMC enabled, struct mmc can be accessed from the MMC device
403 * with mmc_get_mmc_dev().
404 *
405 * TODO struct mmc should be in mmc_private but it's hard to fix right now
406 */
Pantelis Antoniou93bfd612014-03-11 19:34:20 +0200407struct mmc {
Simon Glass33fb2112016-05-01 13:52:41 -0600408#ifndef CONFIG_BLK
Pantelis Antoniou93bfd612014-03-11 19:34:20 +0200409 struct list_head link;
Simon Glass33fb2112016-05-01 13:52:41 -0600410#endif
Pantelis Antoniou93bfd612014-03-11 19:34:20 +0200411 const struct mmc_config *cfg; /* provided configuration */
412 uint version;
413 void *priv;
414 uint has_init;
Andy Fleming272cc702008-10-30 16:41:01 -0500415 int high_capacity;
416 uint bus_width;
417 uint clock;
418 uint card_caps;
Andy Fleming272cc702008-10-30 16:41:01 -0500419 uint ocr;
Markus Niebelab711882013-12-16 13:40:46 +0100420 uint dsr;
421 uint dsr_imp;
Andy Fleming272cc702008-10-30 16:41:01 -0500422 uint scr[2];
423 uint csd[4];
Rabin Vincent0b453ff2009-04-05 13:30:55 +0530424 uint cid[4];
Andy Fleming272cc702008-10-30 16:41:01 -0500425 ushort rca;
Diego Santa Cruzc3dbb4f2014-12-23 10:50:17 +0100426 u8 part_support;
427 u8 part_attr;
Diego Santa Cruz9e41a002014-12-23 10:50:33 +0100428 u8 wr_rel_set;
Lei Wenbc897b12011-05-02 16:26:26 +0000429 char part_config;
Andy Fleming272cc702008-10-30 16:41:01 -0500430 uint tran_speed;
431 uint read_bl_len;
432 uint write_bl_len;
Diego Santa Cruza4ff9f82014-12-23 10:50:24 +0100433 uint erase_grp_size; /* in 512-byte sectors */
Diego Santa Cruz037dc0a2014-12-23 10:50:25 +0100434 uint hc_wp_grp_size; /* in 512-byte sectors */
Andy Fleming272cc702008-10-30 16:41:01 -0500435 u64 capacity;
Stephen Warrenf866a462013-06-11 15:14:01 -0600436 u64 capacity_user;
437 u64 capacity_boot;
438 u64 capacity_rpmb;
439 u64 capacity_gp[4];
Diego Santa Cruza7f852b2014-12-23 10:50:22 +0100440 u64 enh_user_start;
441 u64 enh_user_size;
Simon Glass33fb2112016-05-01 13:52:41 -0600442#ifndef CONFIG_BLK
Simon Glass4101f682016-02-29 15:25:34 -0700443 struct blk_desc block_dev;
Simon Glass33fb2112016-05-01 13:52:41 -0600444#endif
Che-Liang Chioue9550442012-11-28 15:21:13 +0000445 char op_cond_pending; /* 1 if we are waiting on an op_cond command */
446 char init_in_progress; /* 1 if we have done mmc_start_init() */
447 char preinit; /* start init as early as possible */
Andrew Gabbasov786e8f82014-12-01 06:59:09 -0600448 int ddr_mode;
Simon Glasscffe5d82016-05-01 13:52:34 -0600449#ifdef CONFIG_DM_MMC
450 struct udevice *dev; /* Device for this MMC controller */
451#endif
Andy Fleming272cc702008-10-30 16:41:01 -0500452};
453
Diego Santa Cruzac9da0e2014-12-23 10:50:29 +0100454struct mmc_hwpart_conf {
455 struct {
456 uint enh_start; /* in 512-byte sectors */
457 uint enh_size; /* in 512-byte sectors, if 0 no enh area */
Diego Santa Cruz8dda5b0e2014-12-23 10:50:31 +0100458 unsigned wr_rel_change : 1;
459 unsigned wr_rel_set : 1;
Diego Santa Cruzac9da0e2014-12-23 10:50:29 +0100460 } user;
461 struct {
462 uint size; /* in 512-byte sectors */
Diego Santa Cruz8dda5b0e2014-12-23 10:50:31 +0100463 unsigned enhanced : 1;
464 unsigned wr_rel_change : 1;
465 unsigned wr_rel_set : 1;
Diego Santa Cruzac9da0e2014-12-23 10:50:29 +0100466 } gp_part[4];
467};
468
469enum mmc_hwpart_conf_mode {
470 MMC_HWPART_CONF_CHECK,
471 MMC_HWPART_CONF_SET,
472 MMC_HWPART_CONF_COMPLETE,
473};
474
Pantelis Antoniou93bfd612014-03-11 19:34:20 +0200475struct mmc *mmc_create(const struct mmc_config *cfg, void *priv);
Simon Glassad27dd52016-05-01 13:52:40 -0600476
477/**
478 * mmc_bind() - Set up a new MMC device ready for probing
479 *
480 * A child block device is bound with the IF_TYPE_MMC interface type. This
481 * allows the device to be used with CONFIG_BLK
482 *
483 * @dev: MMC device to set up
484 * @mmc: MMC struct
485 * @cfg: MMC configuration
486 * @return 0 if OK, -ve on error
487 */
488int mmc_bind(struct udevice *dev, struct mmc *mmc,
489 const struct mmc_config *cfg);
Pantelis Antoniou93bfd612014-03-11 19:34:20 +0200490void mmc_destroy(struct mmc *mmc);
Simon Glassad27dd52016-05-01 13:52:40 -0600491
492/**
493 * mmc_unbind() - Unbind a MMC device's child block device
494 *
495 * @dev: MMC device
496 * @return 0 if OK, -ve on error
497 */
498int mmc_unbind(struct udevice *dev);
Andy Fleming272cc702008-10-30 16:41:01 -0500499int mmc_initialize(bd_t *bis);
500int mmc_init(struct mmc *mmc);
501int mmc_read(struct mmc *mmc, u64 src, uchar *dst, int size);
Jerry Huang4a6ee172010-11-25 17:06:07 +0000502void mmc_set_clock(struct mmc *mmc, uint clock);
Andy Fleming272cc702008-10-30 16:41:01 -0500503struct mmc *find_mmc_device(int dev_num);
Steve Sakoman89716962010-07-01 12:12:42 -0700504int mmc_set_dev(int dev_num);
Andy Fleming272cc702008-10-30 16:41:01 -0500505void print_mmc_devices(char separator);
Kever Yang46683f32016-07-22 17:22:50 +0800506
507/**
508 * get_mmc_num() - get the total MMC device number
509 *
510 * @return 0 if there is no MMC device, else the number of devices
511 */
Lei Wenea6ebe22011-05-02 16:26:25 +0000512int get_mmc_num(void);
Diego Santa Cruzac9da0e2014-12-23 10:50:29 +0100513int mmc_hwpart_config(struct mmc *mmc, const struct mmc_hwpart_conf *conf,
514 enum mmc_hwpart_conf_mode mode);
Simon Glass8ca51e52016-06-12 23:30:22 -0600515
516#ifndef CONFIG_DM_MMC_OPS
Thierry Reding48972d92012-01-02 01:15:37 +0000517int mmc_getcd(struct mmc *mmc);
Jeroen Hofstee750121c2014-07-12 21:24:08 +0200518int board_mmc_getcd(struct mmc *mmc);
Nikita Kiryanovd23d8d72012-12-03 02:19:46 +0000519int mmc_getwp(struct mmc *mmc);
Jeroen Hofstee750121c2014-07-12 21:24:08 +0200520int board_mmc_getwp(struct mmc *mmc);
Simon Glass8ca51e52016-06-12 23:30:22 -0600521#endif
522
Markus Niebelab711882013-12-16 13:40:46 +0100523int mmc_set_dsr(struct mmc *mmc, u16 val);
Amar3690d6d2013-04-27 11:42:58 +0530524/* Function to change the size of boot partition and rpmb partitions */
525int mmc_boot_partition_size_change(struct mmc *mmc, unsigned long bootsize,
526 unsigned long rpmbsize);
Tom Rini792970b2014-02-05 10:24:21 -0500527/* Function to modify the PARTITION_CONFIG field of EXT_CSD */
528int mmc_set_part_conf(struct mmc *mmc, u8 ack, u8 part_num, u8 access);
Tom Rini5a99b9d2014-02-05 10:24:22 -0500529/* Function to modify the BOOT_BUS_WIDTH field of EXT_CSD */
530int mmc_set_boot_bus_width(struct mmc *mmc, u8 width, u8 reset, u8 mode);
Tom Rini33ace362014-02-07 14:15:20 -0500531/* Function to modify the RST_n_FUNCTION field of EXT_CSD */
532int mmc_set_rst_n_function(struct mmc *mmc, u8 enable);
Pierre Aubert91fdabc2014-04-24 10:30:06 +0200533/* Functions to read / write the RPMB partition */
534int mmc_rpmb_set_key(struct mmc *mmc, void *key);
535int mmc_rpmb_get_counter(struct mmc *mmc, unsigned long *counter);
536int mmc_rpmb_read(struct mmc *mmc, void *addr, unsigned short blk,
537 unsigned short cnt, unsigned char *key);
538int mmc_rpmb_write(struct mmc *mmc, void *addr, unsigned short blk,
539 unsigned short cnt, unsigned char *key);
Che-Liang Chioue9550442012-11-28 15:21:13 +0000540/**
541 * Start device initialization and return immediately; it does not block on
542 * polling OCR (operation condition register) status. Then you should call
543 * mmc_init, which would block on polling OCR status and complete the device
544 * initializatin.
545 *
546 * @param mmc Pointer to a MMC device struct
547 * @return 0 on success, IN_PROGRESS on waiting for OCR status, <0 on error.
548 */
549int mmc_start_init(struct mmc *mmc);
550
551/**
552 * Set preinit flag of mmc device.
553 *
554 * This will cause the device to be pre-inited during mmc_initialize(),
555 * which may save boot time if the device is not accessed until later.
556 * Some eMMC devices take 200-300ms to init, but unfortunately they
557 * must be sent a series of commands to even get them to start preparing
558 * for operation.
559 *
560 * @param mmc Pointer to a MMC device struct
561 * @param preinit preinit flag value
562 */
563void mmc_set_preinit(struct mmc *mmc, int preinit);
564
Paul Burton8687d5c2013-09-04 16:12:26 +0100565#ifdef CONFIG_MMC_SPI
Tom Rini0b2da7e2014-03-28 16:55:29 -0400566#define mmc_host_is_spi(mmc) ((mmc)->cfg->host_caps & MMC_MODE_SPI)
Paul Burton8687d5c2013-09-04 16:12:26 +0100567#else
568#define mmc_host_is_spi(mmc) 0
569#endif
Thomas Choud52ebf12010-12-24 13:12:21 +0000570struct mmc *mmc_spi_init(uint bus, uint cs, uint speed, uint mode);
Reinhard Meyer1592ef82010-08-13 10:31:06 +0200571
Paul Kocialkowski95de9ab2014-11-08 20:55:45 +0100572void board_mmc_power_init(void);
Fabio Estevam3c7ca962014-02-15 14:51:59 -0200573int board_mmc_init(bd_t *bis);
Jeroen Hofstee750121c2014-07-12 21:24:08 +0200574int cpu_mmc_init(bd_t *bis);
Jeroen Hofsteeaeb80552014-10-08 22:58:05 +0200575int mmc_get_env_addr(struct mmc *mmc, int copy, u32 *env_addr);
Clemens Gruberaa844fe2016-01-26 16:20:38 +0100576int mmc_get_env_dev(void);
Fabio Estevam3c7ca962014-02-15 14:51:59 -0200577
Simon Glass91785f72015-01-27 22:13:39 -0700578struct pci_device_id;
579
580/**
581 * pci_mmc_init() - set up PCI MMC devices
582 *
583 * This finds all the matching PCI IDs and sets them up as MMC devices.
584 *
585 * @name: Name to use for devices
Simon Glass4abe8e42015-11-29 13:18:08 -0700586 * @mmc_supported: PCI IDs to search for, terminated by {0, 0}
Simon Glass91785f72015-01-27 22:13:39 -0700587 */
Simon Glass4abe8e42015-11-29 13:18:08 -0700588int pci_mmc_init(const char *name, struct pci_device_id *mmc_supported);
Simon Glass91785f72015-01-27 22:13:39 -0700589
Pantelis Antoniou93bfd612014-03-11 19:34:20 +0200590/* Set block count limit because of 16 bit register limit on some hardware*/
591#ifndef CONFIG_SYS_MMC_MAX_BLK_COUNT
592#define CONFIG_SYS_MMC_MAX_BLK_COUNT 65535
593#endif
594
Simon Glasscb5ec332016-05-01 13:52:27 -0600595/**
596 * mmc_get_blk_desc() - Get the block descriptor for an MMC device
597 *
598 * @mmc: MMC device
599 * @return block device if found, else NULL
600 */
601struct blk_desc *mmc_get_blk_desc(struct mmc *mmc);
602
wdenk71f95112003-06-15 22:40:42 +0000603#endif /* _MMC_H_ */