include/mmc.h

   1 /*
   2  * Copyright 2008,2010 Freescale Semiconductor, Inc
   3  * Andy Fleming
   4  *
   5  * Based (loosely) on the Linux code
   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
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  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_
  28
  29 #include <linux/list.h>
  30 #include <linux/compiler.h>
  31
  32 #define SD_VERSION_SD   0x20000
  33 #define SD_VERSION_3    (SD_VERSION_SD | 0x300)
  34 #define SD_VERSION_2    (SD_VERSION_SD | 0x200)
  35 #define SD_VERSION_1_0  (SD_VERSION_SD | 0x100)
  36 #define SD_VERSION_1_10 (SD_VERSION_SD | 0x10a)
  37 #define MMC_VERSION_MMC         0x10000
  38 #define MMC_VERSION_UNKNOWN     (MMC_VERSION_MMC)
  39 #define MMC_VERSION_1_2         (MMC_VERSION_MMC | 0x102)
  40 #define MMC_VERSION_1_4         (MMC_VERSION_MMC | 0x104)
  41 #define MMC_VERSION_2_2         (MMC_VERSION_MMC | 0x202)
  42 #define MMC_VERSION_3           (MMC_VERSION_MMC | 0x300)
  43 #define MMC_VERSION_4           (MMC_VERSION_MMC | 0x400)
  44 #define MMC_VERSION_4_1         (MMC_VERSION_MMC | 0x401)
  45 #define MMC_VERSION_4_2         (MMC_VERSION_MMC | 0x402)
  46 #define MMC_VERSION_4_3         (MMC_VERSION_MMC | 0x403)
  47 #define MMC_VERSION_4_41        (MMC_VERSION_MMC | 0x429)
  48 #define MMC_VERSION_4_5         (MMC_VERSION_MMC | 0x405)
  49
  50 #define MMC_MODE_HS             0x001
  51 #define MMC_MODE_HS_52MHz       0x010
  52 #define MMC_MODE_4BIT           0x100
  53 #define MMC_MODE_8BIT           0x200
  54 #define MMC_MODE_SPI            0x400
  55 #define MMC_MODE_HC             0x800
  56
  57 #define MMC_MODE_MASK_WIDTH_BITS (MMC_MODE_4BIT | MMC_MODE_8BIT)
  58 #define MMC_MODE_WIDTH_BITS_SHIFT 8
  59
  60 #define SD_DATA_4BIT    0x00040000
  61
  62 #define IS_SD(x) (x->version & SD_VERSION_SD)
  63
  64 #define MMC_DATA_READ           1
  65 #define MMC_DATA_WRITE          2
  66
  67 #define NO_CARD_ERR             -16 /* No SD/MMC card inserted */
  68 #define UNUSABLE_ERR            -17 /* Unusable Card */
  69 #define COMM_ERR                -18 /* Communications Error */
  70 #define TIMEOUT                 -19
  71 #define IN_PROGRESS             -20 /* operation is in progress */
  72
  73 #define MMC_CMD_GO_IDLE_STATE           0
  74 #define MMC_CMD_SEND_OP_COND            1
  75 #define MMC_CMD_ALL_SEND_CID            2
  76 #define MMC_CMD_SET_RELATIVE_ADDR       3
  77 #define MMC_CMD_SET_DSR                 4
  78 #define MMC_CMD_SWITCH                  6
  79 #define MMC_CMD_SELECT_CARD             7
  80 #define MMC_CMD_SEND_EXT_CSD            8
  81 #define MMC_CMD_SEND_CSD                9
  82 #define MMC_CMD_SEND_CID                10
  83 #define MMC_CMD_STOP_TRANSMISSION       12
  84 #define MMC_CMD_SEND_STATUS             13
  85 #define MMC_CMD_SET_BLOCKLEN            16
  86 #define MMC_CMD_READ_SINGLE_BLOCK       17
  87 #define MMC_CMD_READ_MULTIPLE_BLOCK     18
  88 #define MMC_CMD_WRITE_SINGLE_BLOCK      24
  89 #define MMC_CMD_WRITE_MULTIPLE_BLOCK    25
  90 #define MMC_CMD_ERASE_GROUP_START       35
  91 #define MMC_CMD_ERASE_GROUP_END         36
  92 #define MMC_CMD_ERASE                   38
  93 #define MMC_CMD_APP_CMD                 55
  94 #define MMC_CMD_SPI_READ_OCR            58
  95 #define MMC_CMD_SPI_CRC_ON_OFF          59
  96
  97 #define SD_CMD_SEND_RELATIVE_ADDR       3
  98 #define SD_CMD_SWITCH_FUNC              6
  99 #define SD_CMD_SEND_IF_COND             8
 100
 101 #define SD_CMD_APP_SET_BUS_WIDTH        6
 102 #define SD_CMD_ERASE_WR_BLK_START       32
 103 #define SD_CMD_ERASE_WR_BLK_END         33
 104 #define SD_CMD_APP_SEND_OP_COND         41
 105 #define SD_CMD_APP_SEND_SCR             51
 106
 107 /* SCR definitions in different words */
 108 #define SD_HIGHSPEED_BUSY       0x00020000
 109 #define SD_HIGHSPEED_SUPPORTED  0x00020000
 110
 111 #define MMC_HS_TIMING           0x00000100
 112 #define MMC_HS_52MHZ            0x2
 113
 114 #define OCR_BUSY                0x80000000
 115 #define OCR_HCS                 0x40000000
 116 #define OCR_VOLTAGE_MASK        0x007FFF80
 117 #define OCR_ACCESS_MODE         0x60000000
 118
 119 #define SECURE_ERASE            0x80000000
 120
 121 #define MMC_STATUS_MASK         (~0x0206BF7F)
 122 #define MMC_STATUS_RDY_FOR_DATA (1 << 8)
 123 #define MMC_STATUS_CURR_STATE   (0xf << 9)
 124 #define MMC_STATUS_ERROR        (1 << 19)
 125
 126 #define MMC_STATE_PRG           (7 << 9)
 127
 128 #define MMC_VDD_165_195         0x00000080      /* VDD voltage 1.65 - 1.95 */
 129 #define MMC_VDD_20_21           0x00000100      /* VDD voltage 2.0 ~ 2.1 */
 130 #define MMC_VDD_21_22           0x00000200      /* VDD voltage 2.1 ~ 2.2 */
 131 #define MMC_VDD_22_23           0x00000400      /* VDD voltage 2.2 ~ 2.3 */
 132 #define MMC_VDD_23_24           0x00000800      /* VDD voltage 2.3 ~ 2.4 */
 133 #define MMC_VDD_24_25           0x00001000      /* VDD voltage 2.4 ~ 2.5 */
 134 #define MMC_VDD_25_26           0x00002000      /* VDD voltage 2.5 ~ 2.6 */
 135 #define MMC_VDD_26_27           0x00004000      /* VDD voltage 2.6 ~ 2.7 */
 136 #define MMC_VDD_27_28           0x00008000      /* VDD voltage 2.7 ~ 2.8 */
 137 #define MMC_VDD_28_29           0x00010000      /* VDD voltage 2.8 ~ 2.9 */
 138 #define MMC_VDD_29_30           0x00020000      /* VDD voltage 2.9 ~ 3.0 */
 139 #define MMC_VDD_30_31           0x00040000      /* VDD voltage 3.0 ~ 3.1 */
 140 #define MMC_VDD_31_32           0x00080000      /* VDD voltage 3.1 ~ 3.2 */
 141 #define MMC_VDD_32_33           0x00100000      /* VDD voltage 3.2 ~ 3.3 */
 142 #define MMC_VDD_33_34           0x00200000      /* VDD voltage 3.3 ~ 3.4 */
 143 #define MMC_VDD_34_35           0x00400000      /* VDD voltage 3.4 ~ 3.5 */
 144 #define MMC_VDD_35_36           0x00800000      /* VDD voltage 3.5 ~ 3.6 */
 145
 146 #define MMC_SWITCH_MODE_CMD_SET         0x00 /* Change the command set */
 147 #define MMC_SWITCH_MODE_SET_BITS        0x01 /* Set bits in EXT_CSD byte
 148                                                 addressed by index which are
 149                                                 1 in value field */
 150 #define MMC_SWITCH_MODE_CLEAR_BITS      0x02 /* Clear bits in EXT_CSD byte
 151                                                 addressed by index, which are
 152                                                 1 in value field */
 153 #define MMC_SWITCH_MODE_WRITE_BYTE      0x03 /* Set target byte to value */
 154
 155 #define SD_SWITCH_CHECK         0
 156 #define SD_SWITCH_SWITCH        1
 157
 158 /*
 159  * EXT_CSD fields
 160  */
 161 #define EXT_CSD_GP_SIZE_MULT            143     /* R/W */
 162 #define EXT_CSD_PARTITIONING_SUPPORT    160     /* RO */
 163 #define EXT_CSD_RPMB_MULT               168     /* RO */
 164 #define EXT_CSD_ERASE_GROUP_DEF         175     /* R/W */
 165 #define EXT_CSD_PART_CONF               179     /* R/W */
 166 #define EXT_CSD_BUS_WIDTH               183     /* R/W */
 167 #define EXT_CSD_HS_TIMING               185     /* R/W */
 168 #define EXT_CSD_REV                     192     /* RO */
 169 #define EXT_CSD_CARD_TYPE               196     /* RO */
 170 #define EXT_CSD_SEC_CNT                 212     /* RO, 4 bytes */
 171 #define EXT_CSD_HC_WP_GRP_SIZE          221     /* RO */
 172 #define EXT_CSD_HC_ERASE_GRP_SIZE       224     /* RO */
 173 #define EXT_CSD_BOOT_MULT               226     /* RO */
 174
 175 /*
 176  * EXT_CSD field definitions
 177  */
 178
 179 #define EXT_CSD_CMD_SET_NORMAL          (1 << 0)
 180 #define EXT_CSD_CMD_SET_SECURE          (1 << 1)
 181 #define EXT_CSD_CMD_SET_CPSECURE        (1 << 2)
 182
 183 #define EXT_CSD_CARD_TYPE_26    (1 << 0)        /* Card can run at 26MHz */
 184 #define EXT_CSD_CARD_TYPE_52    (1 << 1)        /* Card can run at 52MHz */
 185
 186 #define EXT_CSD_BUS_WIDTH_1     0       /* Card is in 1 bit mode */
 187 #define EXT_CSD_BUS_WIDTH_4     1       /* Card is in 4 bit mode */
 188 #define EXT_CSD_BUS_WIDTH_8     2       /* Card is in 8 bit mode */
 189
 190 #define R1_ILLEGAL_COMMAND              (1 << 22)
 191 #define R1_APP_CMD                      (1 << 5)
 192
 193 #define MMC_RSP_PRESENT (1 << 0)
 194 #define MMC_RSP_136     (1 << 1)                /* 136 bit response */
 195 #define MMC_RSP_CRC     (1 << 2)                /* expect valid crc */
 196 #define MMC_RSP_BUSY    (1 << 3)                /* card may send busy */
 197 #define MMC_RSP_OPCODE  (1 << 4)                /* response contains opcode */
 198
 199 #define MMC_RSP_NONE    (0)
 200 #define MMC_RSP_R1      (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
 201 #define MMC_RSP_R1b     (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE| \
 202                         MMC_RSP_BUSY)
 203 #define MMC_RSP_R2      (MMC_RSP_PRESENT|MMC_RSP_136|MMC_RSP_CRC)
 204 #define MMC_RSP_R3      (MMC_RSP_PRESENT)
 205 #define MMC_RSP_R4      (MMC_RSP_PRESENT)
 206 #define MMC_RSP_R5      (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
 207 #define MMC_RSP_R6      (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
 208 #define MMC_RSP_R7      (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
 209
 210 #define MMCPART_NOAVAILABLE     (0xff)
 211 #define PART_ACCESS_MASK        (0x7)
 212 #define PART_SUPPORT            (0x1)
 213
 214 /* Maximum block size for MMC */
 215 #define MMC_MAX_BLOCK_LEN       512
 216
 217 struct mmc_cid {
 218         unsigned long psn;
 219         unsigned short oid;
 220         unsigned char mid;
 221         unsigned char prv;
 222         unsigned char mdt;
 223         char pnm[7];
 224 };
 225
 226 struct mmc_cmd {
 227         ushort cmdidx;
 228         uint resp_type;
 229         uint cmdarg;
 230         uint response[4];
 231 };
 232
 233 struct mmc_data {
 234         union {
 235                 char *dest;
 236                 const char *src; /* src buffers don't get written to */
 237         };
 238         uint flags;
 239         uint blocks;
 240         uint blocksize;
 241 };
 242
 243 struct mmc {
 244         struct list_head link;
 245         char name[32];
 246         void *priv;
 247         uint voltages;
 248         uint version;
 249         uint has_init;
 250         uint f_min;
 251         uint f_max;
 252         int high_capacity;
 253         uint bus_width;
 254         uint clock;
 255         uint card_caps;
 256         uint host_caps;
 257         uint ocr;
 258         uint scr[2];
 259         uint csd[4];
 260         uint cid[4];
 261         ushort rca;
 262         char part_config;
 263         char part_num;
 264         uint tran_speed;
 265         uint read_bl_len;
 266         uint write_bl_len;
 267         uint erase_grp_size;
 268         u64 capacity;
 269         u64 capacity_user;
 270         u64 capacity_boot;
 271         u64 capacity_rpmb;
 272         u64 capacity_gp[4];
 273         block_dev_desc_t block_dev;
 274         int (*send_cmd)(struct mmc *mmc,
 275                         struct mmc_cmd *cmd, struct mmc_data *data);
 276         void (*set_ios)(struct mmc *mmc);
 277         int (*init)(struct mmc *mmc);
 278         int (*getcd)(struct mmc *mmc);
 279         int (*getwp)(struct mmc *mmc);
 280         uint b_max;
 281         char op_cond_pending;   /* 1 if we are waiting on an op_cond command */
 282         char init_in_progress;  /* 1 if we have done mmc_start_init() */
 283         char preinit;           /* start init as early as possible */
 284         uint op_cond_response;  /* the response byte from the last op_cond */
 285 };
 286
 287 int mmc_register(struct mmc *mmc);
 288 int mmc_initialize(bd_t *bis);
 289 int mmc_init(struct mmc *mmc);
 290 int mmc_read(struct mmc *mmc, u64 src, uchar *dst, int size);
 291 void mmc_set_clock(struct mmc *mmc, uint clock);
 292 struct mmc *find_mmc_device(int dev_num);
 293 int mmc_set_dev(int dev_num);
 294 void print_mmc_devices(char separator);
 295 int get_mmc_num(void);
 296 int board_mmc_getcd(struct mmc *mmc);
 297 int mmc_switch_part(int dev_num, unsigned int part_num);
 298 int mmc_getcd(struct mmc *mmc);
 299 int mmc_getwp(struct mmc *mmc);
 300 void spl_mmc_load(void) __noreturn;
 301
 302 /**
 303  * Start device initialization and return immediately; it does not block on
 304  * polling OCR (operation condition register) status.  Then you should call
 305  * mmc_init, which would block on polling OCR status and complete the device
 306  * initializatin.
 307  *
 308  * @param mmc   Pointer to a MMC device struct
 309  * @return 0 on success, IN_PROGRESS on waiting for OCR status, <0 on error.
 310  */
 311 int mmc_start_init(struct mmc *mmc);
 312
 313 /**
 314  * Set preinit flag of mmc device.
 315  *
 316  * This will cause the device to be pre-inited during mmc_initialize(),
 317  * which may save boot time if the device is not accessed until later.
 318  * Some eMMC devices take 200-300ms to init, but unfortunately they
 319  * must be sent a series of commands to even get them to start preparing
 320  * for operation.
 321  *
 322  * @param mmc           Pointer to a MMC device struct
 323  * @param preinit       preinit flag value
 324  */
 325 void mmc_set_preinit(struct mmc *mmc, int preinit);
 326
 327 #ifdef CONFIG_GENERIC_MMC
 328 #define mmc_host_is_spi(mmc)    ((mmc)->host_caps & MMC_MODE_SPI)
 329 struct mmc *mmc_spi_init(uint bus, uint cs, uint speed, uint mode);
 330 #else
 331 int mmc_legacy_init(int verbose);
 332 #endif
 333
 334 #endif /* _MMC_H_ */