include/mmc.h

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