]> git.ipfire.org Git - people/ms/u-boot.git/blame - include/mmc.h
add a git mailrc file for maintainers
[people/ms/u-boot.git] / include / mmc.h
CommitLineData
71f95118 1/*
4a6ee172 2 * Copyright 2008,2010 Freescale Semiconductor, Inc
272cc70b
AF
3 * Andy Fleming
4 *
5 * Based (loosely) on the Linux code
71f95118
WD
6 *
7 * See file CREDITS for list of people who contributed to this
8 * project.
9 *
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public License as
12 * published by the Free Software Foundation; either version 2 of
13 * the License, or (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
abe2c93f 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
71f95118
WD
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
23 * MA 02111-1307 USA
24 */
25
26#ifndef _MMC_H_
27#define _MMC_H_
71f95118 28
272cc70b
AF
29#include <linux/list.h>
30
31#define SD_VERSION_SD 0x20000
32#define SD_VERSION_2 (SD_VERSION_SD | 0x20)
33#define SD_VERSION_1_0 (SD_VERSION_SD | 0x10)
34#define SD_VERSION_1_10 (SD_VERSION_SD | 0x1a)
35#define MMC_VERSION_MMC 0x10000
36#define MMC_VERSION_UNKNOWN (MMC_VERSION_MMC)
37#define MMC_VERSION_1_2 (MMC_VERSION_MMC | 0x12)
38#define MMC_VERSION_1_4 (MMC_VERSION_MMC | 0x14)
39#define MMC_VERSION_2_2 (MMC_VERSION_MMC | 0x22)
40#define MMC_VERSION_3 (MMC_VERSION_MMC | 0x30)
41#define MMC_VERSION_4 (MMC_VERSION_MMC | 0x40)
42
43#define MMC_MODE_HS 0x001
44#define MMC_MODE_HS_52MHz 0x010
45#define MMC_MODE_4BIT 0x100
46#define MMC_MODE_8BIT 0x200
d52ebf10 47#define MMC_MODE_SPI 0x400
b1f1e821 48#define MMC_MODE_HC 0x800
272cc70b
AF
49
50#define SD_DATA_4BIT 0x00040000
51
79b91de9 52#define IS_SD(x) (x->version & SD_VERSION_SD)
272cc70b
AF
53
54#define MMC_DATA_READ 1
55#define MMC_DATA_WRITE 2
56
57#define NO_CARD_ERR -16 /* No SD/MMC card inserted */
58#define UNUSABLE_ERR -17 /* Unusable Card */
59#define COMM_ERR -18 /* Communications Error */
60#define TIMEOUT -19
61
341188b9
HS
62#define MMC_CMD_GO_IDLE_STATE 0
63#define MMC_CMD_SEND_OP_COND 1
64#define MMC_CMD_ALL_SEND_CID 2
65#define MMC_CMD_SET_RELATIVE_ADDR 3
66#define MMC_CMD_SET_DSR 4
272cc70b 67#define MMC_CMD_SWITCH 6
341188b9 68#define MMC_CMD_SELECT_CARD 7
272cc70b 69#define MMC_CMD_SEND_EXT_CSD 8
341188b9
HS
70#define MMC_CMD_SEND_CSD 9
71#define MMC_CMD_SEND_CID 10
272cc70b 72#define MMC_CMD_STOP_TRANSMISSION 12
341188b9
HS
73#define MMC_CMD_SEND_STATUS 13
74#define MMC_CMD_SET_BLOCKLEN 16
75#define MMC_CMD_READ_SINGLE_BLOCK 17
76#define MMC_CMD_READ_MULTIPLE_BLOCK 18
272cc70b
AF
77#define MMC_CMD_WRITE_SINGLE_BLOCK 24
78#define MMC_CMD_WRITE_MULTIPLE_BLOCK 25
e6f99a56
LW
79#define MMC_CMD_ERASE_GROUP_START 35
80#define MMC_CMD_ERASE_GROUP_END 36
81#define MMC_CMD_ERASE 38
341188b9 82#define MMC_CMD_APP_CMD 55
d52ebf10
TC
83#define MMC_CMD_SPI_READ_OCR 58
84#define MMC_CMD_SPI_CRC_ON_OFF 59
341188b9 85
341188b9 86#define SD_CMD_SEND_RELATIVE_ADDR 3
272cc70b 87#define SD_CMD_SWITCH_FUNC 6
341188b9
HS
88#define SD_CMD_SEND_IF_COND 8
89
90#define SD_CMD_APP_SET_BUS_WIDTH 6
e6f99a56
LW
91#define SD_CMD_ERASE_WR_BLK_START 32
92#define SD_CMD_ERASE_WR_BLK_END 33
341188b9 93#define SD_CMD_APP_SEND_OP_COND 41
272cc70b
AF
94#define SD_CMD_APP_SEND_SCR 51
95
96/* SCR definitions in different words */
97#define SD_HIGHSPEED_BUSY 0x00020000
98#define SD_HIGHSPEED_SUPPORTED 0x00020000
99
100#define MMC_HS_TIMING 0x00000100
101#define MMC_HS_52MHZ 0x2
102
abe2c93f
TC
103#define OCR_BUSY 0x80000000
104#define OCR_HCS 0x40000000
31cacbab
RR
105#define OCR_VOLTAGE_MASK 0x007FFF80
106#define OCR_ACCESS_MODE 0x60000000
272cc70b 107
e6f99a56
LW
108#define SECURE_ERASE 0x80000000
109
5d4fc8d9 110#define MMC_STATUS_MASK (~0x0206BF7F)
abe2c93f
TC
111#define MMC_STATUS_RDY_FOR_DATA (1 << 8)
112#define MMC_STATUS_CURR_STATE (0xf << 9)
ed018b21 113#define MMC_STATUS_ERROR (1 << 19)
5d4fc8d9 114
272cc70b
AF
115#define MMC_VDD_165_195 0x00000080 /* VDD voltage 1.65 - 1.95 */
116#define MMC_VDD_20_21 0x00000100 /* VDD voltage 2.0 ~ 2.1 */
117#define MMC_VDD_21_22 0x00000200 /* VDD voltage 2.1 ~ 2.2 */
118#define MMC_VDD_22_23 0x00000400 /* VDD voltage 2.2 ~ 2.3 */
119#define MMC_VDD_23_24 0x00000800 /* VDD voltage 2.3 ~ 2.4 */
120#define MMC_VDD_24_25 0x00001000 /* VDD voltage 2.4 ~ 2.5 */
121#define MMC_VDD_25_26 0x00002000 /* VDD voltage 2.5 ~ 2.6 */
122#define MMC_VDD_26_27 0x00004000 /* VDD voltage 2.6 ~ 2.7 */
123#define MMC_VDD_27_28 0x00008000 /* VDD voltage 2.7 ~ 2.8 */
124#define MMC_VDD_28_29 0x00010000 /* VDD voltage 2.8 ~ 2.9 */
125#define MMC_VDD_29_30 0x00020000 /* VDD voltage 2.9 ~ 3.0 */
126#define MMC_VDD_30_31 0x00040000 /* VDD voltage 3.0 ~ 3.1 */
127#define MMC_VDD_31_32 0x00080000 /* VDD voltage 3.1 ~ 3.2 */
128#define MMC_VDD_32_33 0x00100000 /* VDD voltage 3.2 ~ 3.3 */
129#define MMC_VDD_33_34 0x00200000 /* VDD voltage 3.3 ~ 3.4 */
130#define MMC_VDD_34_35 0x00400000 /* VDD voltage 3.4 ~ 3.5 */
131#define MMC_VDD_35_36 0x00800000 /* VDD voltage 3.5 ~ 3.6 */
132
133#define MMC_SWITCH_MODE_CMD_SET 0x00 /* Change the command set */
134#define MMC_SWITCH_MODE_SET_BITS 0x01 /* Set bits in EXT_CSD byte
135 addressed by index which are
136 1 in value field */
137#define MMC_SWITCH_MODE_CLEAR_BITS 0x02 /* Clear bits in EXT_CSD byte
138 addressed by index, which are
139 1 in value field */
140#define MMC_SWITCH_MODE_WRITE_BYTE 0x03 /* Set target byte to value */
141
142#define SD_SWITCH_CHECK 0
143#define SD_SWITCH_SWITCH 1
144
145/*
146 * EXT_CSD fields
147 */
0560db18
LW
148#define EXT_CSD_PARTITIONING_SUPPORT 160 /* RO */
149#define EXT_CSD_ERASE_GROUP_DEF 175 /* R/W */
150#define EXT_CSD_PART_CONF 179 /* R/W */
151#define EXT_CSD_BUS_WIDTH 183 /* R/W */
152#define EXT_CSD_HS_TIMING 185 /* R/W */
153#define EXT_CSD_REV 192 /* RO */
154#define EXT_CSD_CARD_TYPE 196 /* RO */
155#define EXT_CSD_SEC_CNT 212 /* RO, 4 bytes */
156#define EXT_CSD_HC_ERASE_GRP_SIZE 224 /* RO */
272cc70b
AF
157
158/*
159 * EXT_CSD field definitions
160 */
161
abe2c93f
TC
162#define EXT_CSD_CMD_SET_NORMAL (1 << 0)
163#define EXT_CSD_CMD_SET_SECURE (1 << 1)
164#define EXT_CSD_CMD_SET_CPSECURE (1 << 2)
272cc70b 165
abe2c93f
TC
166#define EXT_CSD_CARD_TYPE_26 (1 << 0) /* Card can run at 26MHz */
167#define EXT_CSD_CARD_TYPE_52 (1 << 1) /* Card can run at 52MHz */
272cc70b
AF
168
169#define EXT_CSD_BUS_WIDTH_1 0 /* Card is in 1 bit mode */
170#define EXT_CSD_BUS_WIDTH_4 1 /* Card is in 4 bit mode */
171#define EXT_CSD_BUS_WIDTH_8 2 /* Card is in 8 bit mode */
341188b9 172
1de97f98
AF
173#define R1_ILLEGAL_COMMAND (1 << 22)
174#define R1_APP_CMD (1 << 5)
175
272cc70b 176#define MMC_RSP_PRESENT (1 << 0)
abe2c93f
TC
177#define MMC_RSP_136 (1 << 1) /* 136 bit response */
178#define MMC_RSP_CRC (1 << 2) /* expect valid crc */
179#define MMC_RSP_BUSY (1 << 3) /* card may send busy */
180#define MMC_RSP_OPCODE (1 << 4) /* response contains opcode */
272cc70b 181
abe2c93f
TC
182#define MMC_RSP_NONE (0)
183#define MMC_RSP_R1 (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
272cc70b
AF
184#define MMC_RSP_R1b (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE| \
185 MMC_RSP_BUSY)
abe2c93f
TC
186#define MMC_RSP_R2 (MMC_RSP_PRESENT|MMC_RSP_136|MMC_RSP_CRC)
187#define MMC_RSP_R3 (MMC_RSP_PRESENT)
188#define MMC_RSP_R4 (MMC_RSP_PRESENT)
189#define MMC_RSP_R5 (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
190#define MMC_RSP_R6 (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
191#define MMC_RSP_R7 (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
272cc70b 192
bc897b1d
LW
193#define MMCPART_NOAVAILABLE (0xff)
194#define PART_ACCESS_MASK (0x7)
195#define PART_SUPPORT (0x1)
71f95118 196
1de97f98
AF
197struct mmc_cid {
198 unsigned long psn;
199 unsigned short oid;
200 unsigned char mid;
201 unsigned char prv;
202 unsigned char mdt;
203 char pnm[7];
204};
205
1592ef85
RM
206/*
207 * WARNING!
208 *
209 * This structure is used by atmel_mci.c only.
210 * It works for the AVR32 architecture but NOT
211 * for ARM/AT91 architectures.
212 * Its use is highly depreciated.
213 * After the atmel_mci.c driver for AVR32 has
214 * been replaced this structure will be removed.
215 */
1de97f98
AF
216struct mmc_csd
217{
218 u8 csd_structure:2,
219 spec_vers:4,
220 rsvd1:2;
221 u8 taac;
222 u8 nsac;
223 u8 tran_speed;
224 u16 ccc:12,
225 read_bl_len:4;
226 u64 read_bl_partial:1,
227 write_blk_misalign:1,
228 read_blk_misalign:1,
229 dsr_imp:1,
230 rsvd2:2,
231 c_size:12,
232 vdd_r_curr_min:3,
233 vdd_r_curr_max:3,
234 vdd_w_curr_min:3,
235 vdd_w_curr_max:3,
236 c_size_mult:3,
237 sector_size:5,
238 erase_grp_size:5,
239 wp_grp_size:5,
240 wp_grp_enable:1,
241 default_ecc:2,
242 r2w_factor:3,
243 write_bl_len:4,
244 write_bl_partial:1,
245 rsvd3:5;
246 u8 file_format_grp:1,
247 copy:1,
248 perm_write_protect:1,
249 tmp_write_protect:1,
250 file_format:2,
251 ecc:2;
252 u8 crc:7;
253 u8 one:1;
254};
255
272cc70b
AF
256struct mmc_cmd {
257 ushort cmdidx;
258 uint resp_type;
259 uint cmdarg;
0b453ffe 260 uint response[4];
272cc70b
AF
261 uint flags;
262};
263
264struct mmc_data {
265 union {
266 char *dest;
267 const char *src; /* src buffers don't get written to */
268 };
269 uint flags;
270 uint blocks;
271 uint blocksize;
272};
273
274struct mmc {
275 struct list_head link;
276 char name[32];
277 void *priv;
278 uint voltages;
279 uint version;
bc897b1d 280 uint has_init;
272cc70b
AF
281 uint f_min;
282 uint f_max;
283 int high_capacity;
284 uint bus_width;
285 uint clock;
286 uint card_caps;
287 uint host_caps;
288 uint ocr;
289 uint scr[2];
290 uint csd[4];
0b453ffe 291 uint cid[4];
272cc70b 292 ushort rca;
bc897b1d
LW
293 char part_config;
294 char part_num;
272cc70b
AF
295 uint tran_speed;
296 uint read_bl_len;
297 uint write_bl_len;
e6f99a56 298 uint erase_grp_size;
272cc70b
AF
299 u64 capacity;
300 block_dev_desc_t block_dev;
301 int (*send_cmd)(struct mmc *mmc,
302 struct mmc_cmd *cmd, struct mmc_data *data);
303 void (*set_ios)(struct mmc *mmc);
304 int (*init)(struct mmc *mmc);
57418d21 305 uint b_max;
272cc70b
AF
306};
307
308int mmc_register(struct mmc *mmc);
309int mmc_initialize(bd_t *bis);
310int mmc_init(struct mmc *mmc);
311int mmc_read(struct mmc *mmc, u64 src, uchar *dst, int size);
4a6ee172 312void mmc_set_clock(struct mmc *mmc, uint clock);
272cc70b 313struct mmc *find_mmc_device(int dev_num);
89716964 314int mmc_set_dev(int dev_num);
272cc70b 315void print_mmc_devices(char separator);
ea6ebe21 316int get_mmc_num(void);
11fdade2 317int board_mmc_getcd(u8 *cd, struct mmc *mmc);
bc897b1d 318int mmc_switch_part(int dev_num, unsigned int part_num);
272cc70b 319
1592ef85
RM
320#ifdef CONFIG_GENERIC_MMC
321int atmel_mci_init(void *regs);
d52ebf10
TC
322#define mmc_host_is_spi(mmc) ((mmc)->host_caps & MMC_MODE_SPI)
323struct mmc *mmc_spi_init(uint bus, uint cs, uint speed, uint mode);
1592ef85 324#else
272cc70b
AF
325int mmc_legacy_init(int verbose);
326#endif
1592ef85 327
71f95118 328#endif /* _MMC_H_ */