96cf5f02ae
Current implementation decides the card type exclusively. Even though eMMC device can support both HS200 and DDR mode, card type will be set only for HS200. If the host doesn't support HS200 but has DDR capability, then DDR mode can't be selected. Signed-off-by: Seungwon Jeon <tgih.jun@samsung.com> Reviewed-by: Subhash Jadavani <subhashj@codeaurora.org> Signed-off-by: Chris Ball <cjb@laptop.org>
390 lines
14 KiB
C
390 lines
14 KiB
C
/*
|
|
* Header for MultiMediaCard (MMC)
|
|
*
|
|
* Copyright 2002 Hewlett-Packard Company
|
|
*
|
|
* Use consistent with the GNU GPL is permitted,
|
|
* provided that this copyright notice is
|
|
* preserved in its entirety in all copies and derived works.
|
|
*
|
|
* HEWLETT-PACKARD COMPANY MAKES NO WARRANTIES, EXPRESSED OR IMPLIED,
|
|
* AS TO THE USEFULNESS OR CORRECTNESS OF THIS CODE OR ITS
|
|
* FITNESS FOR ANY PARTICULAR PURPOSE.
|
|
*
|
|
* Many thanks to Alessandro Rubini and Jonathan Corbet!
|
|
*
|
|
* Based strongly on code by:
|
|
*
|
|
* Author: Yong-iL Joh <tolkien@mizi.com>
|
|
*
|
|
* Author: Andrew Christian
|
|
* 15 May 2002
|
|
*/
|
|
|
|
#ifndef LINUX_MMC_MMC_H
|
|
#define LINUX_MMC_MMC_H
|
|
|
|
/* Standard MMC commands (4.1) type argument response */
|
|
/* class 1 */
|
|
#define MMC_GO_IDLE_STATE 0 /* bc */
|
|
#define MMC_SEND_OP_COND 1 /* bcr [31:0] OCR R3 */
|
|
#define MMC_ALL_SEND_CID 2 /* bcr R2 */
|
|
#define MMC_SET_RELATIVE_ADDR 3 /* ac [31:16] RCA R1 */
|
|
#define MMC_SET_DSR 4 /* bc [31:16] RCA */
|
|
#define MMC_SLEEP_AWAKE 5 /* ac [31:16] RCA 15:flg R1b */
|
|
#define MMC_SWITCH 6 /* ac [31:0] See below R1b */
|
|
#define MMC_SELECT_CARD 7 /* ac [31:16] RCA R1 */
|
|
#define MMC_SEND_EXT_CSD 8 /* adtc R1 */
|
|
#define MMC_SEND_CSD 9 /* ac [31:16] RCA R2 */
|
|
#define MMC_SEND_CID 10 /* ac [31:16] RCA R2 */
|
|
#define MMC_READ_DAT_UNTIL_STOP 11 /* adtc [31:0] dadr R1 */
|
|
#define MMC_STOP_TRANSMISSION 12 /* ac R1b */
|
|
#define MMC_SEND_STATUS 13 /* ac [31:16] RCA R1 */
|
|
#define MMC_BUS_TEST_R 14 /* adtc R1 */
|
|
#define MMC_GO_INACTIVE_STATE 15 /* ac [31:16] RCA */
|
|
#define MMC_BUS_TEST_W 19 /* adtc R1 */
|
|
#define MMC_SPI_READ_OCR 58 /* spi spi_R3 */
|
|
#define MMC_SPI_CRC_ON_OFF 59 /* spi [0:0] flag spi_R1 */
|
|
|
|
/* class 2 */
|
|
#define MMC_SET_BLOCKLEN 16 /* ac [31:0] block len R1 */
|
|
#define MMC_READ_SINGLE_BLOCK 17 /* adtc [31:0] data addr R1 */
|
|
#define MMC_READ_MULTIPLE_BLOCK 18 /* adtc [31:0] data addr R1 */
|
|
#define MMC_SEND_TUNING_BLOCK 19 /* adtc R1 */
|
|
#define MMC_SEND_TUNING_BLOCK_HS200 21 /* adtc R1 */
|
|
|
|
/* class 3 */
|
|
#define MMC_WRITE_DAT_UNTIL_STOP 20 /* adtc [31:0] data addr R1 */
|
|
|
|
/* class 4 */
|
|
#define MMC_SET_BLOCK_COUNT 23 /* adtc [31:0] data addr R1 */
|
|
#define MMC_WRITE_BLOCK 24 /* adtc [31:0] data addr R1 */
|
|
#define MMC_WRITE_MULTIPLE_BLOCK 25 /* adtc R1 */
|
|
#define MMC_PROGRAM_CID 26 /* adtc R1 */
|
|
#define MMC_PROGRAM_CSD 27 /* adtc R1 */
|
|
|
|
/* class 6 */
|
|
#define MMC_SET_WRITE_PROT 28 /* ac [31:0] data addr R1b */
|
|
#define MMC_CLR_WRITE_PROT 29 /* ac [31:0] data addr R1b */
|
|
#define MMC_SEND_WRITE_PROT 30 /* adtc [31:0] wpdata addr R1 */
|
|
|
|
/* class 5 */
|
|
#define MMC_ERASE_GROUP_START 35 /* ac [31:0] data addr R1 */
|
|
#define MMC_ERASE_GROUP_END 36 /* ac [31:0] data addr R1 */
|
|
#define MMC_ERASE 38 /* ac R1b */
|
|
|
|
/* class 9 */
|
|
#define MMC_FAST_IO 39 /* ac <Complex> R4 */
|
|
#define MMC_GO_IRQ_STATE 40 /* bcr R5 */
|
|
|
|
/* class 7 */
|
|
#define MMC_LOCK_UNLOCK 42 /* adtc R1b */
|
|
|
|
/* class 8 */
|
|
#define MMC_APP_CMD 55 /* ac [31:16] RCA R1 */
|
|
#define MMC_GEN_CMD 56 /* adtc [0] RD/WR R1 */
|
|
|
|
static inline bool mmc_op_multi(u32 opcode)
|
|
{
|
|
return opcode == MMC_WRITE_MULTIPLE_BLOCK ||
|
|
opcode == MMC_READ_MULTIPLE_BLOCK;
|
|
}
|
|
|
|
/*
|
|
* MMC_SWITCH argument format:
|
|
*
|
|
* [31:26] Always 0
|
|
* [25:24] Access Mode
|
|
* [23:16] Location of target Byte in EXT_CSD
|
|
* [15:08] Value Byte
|
|
* [07:03] Always 0
|
|
* [02:00] Command Set
|
|
*/
|
|
|
|
/*
|
|
MMC status in R1, for native mode (SPI bits are different)
|
|
Type
|
|
e : error bit
|
|
s : status bit
|
|
r : detected and set for the actual command response
|
|
x : detected and set during command execution. the host must poll
|
|
the card by sending status command in order to read these bits.
|
|
Clear condition
|
|
a : according to the card state
|
|
b : always related to the previous command. Reception of
|
|
a valid command will clear it (with a delay of one command)
|
|
c : clear by read
|
|
*/
|
|
|
|
#define R1_OUT_OF_RANGE (1 << 31) /* er, c */
|
|
#define R1_ADDRESS_ERROR (1 << 30) /* erx, c */
|
|
#define R1_BLOCK_LEN_ERROR (1 << 29) /* er, c */
|
|
#define R1_ERASE_SEQ_ERROR (1 << 28) /* er, c */
|
|
#define R1_ERASE_PARAM (1 << 27) /* ex, c */
|
|
#define R1_WP_VIOLATION (1 << 26) /* erx, c */
|
|
#define R1_CARD_IS_LOCKED (1 << 25) /* sx, a */
|
|
#define R1_LOCK_UNLOCK_FAILED (1 << 24) /* erx, c */
|
|
#define R1_COM_CRC_ERROR (1 << 23) /* er, b */
|
|
#define R1_ILLEGAL_COMMAND (1 << 22) /* er, b */
|
|
#define R1_CARD_ECC_FAILED (1 << 21) /* ex, c */
|
|
#define R1_CC_ERROR (1 << 20) /* erx, c */
|
|
#define R1_ERROR (1 << 19) /* erx, c */
|
|
#define R1_UNDERRUN (1 << 18) /* ex, c */
|
|
#define R1_OVERRUN (1 << 17) /* ex, c */
|
|
#define R1_CID_CSD_OVERWRITE (1 << 16) /* erx, c, CID/CSD overwrite */
|
|
#define R1_WP_ERASE_SKIP (1 << 15) /* sx, c */
|
|
#define R1_CARD_ECC_DISABLED (1 << 14) /* sx, a */
|
|
#define R1_ERASE_RESET (1 << 13) /* sr, c */
|
|
#define R1_STATUS(x) (x & 0xFFFFE000)
|
|
#define R1_CURRENT_STATE(x) ((x & 0x00001E00) >> 9) /* sx, b (4 bits) */
|
|
#define R1_READY_FOR_DATA (1 << 8) /* sx, a */
|
|
#define R1_SWITCH_ERROR (1 << 7) /* sx, c */
|
|
#define R1_APP_CMD (1 << 5) /* sr, c */
|
|
|
|
#define R1_STATE_IDLE 0
|
|
#define R1_STATE_READY 1
|
|
#define R1_STATE_IDENT 2
|
|
#define R1_STATE_STBY 3
|
|
#define R1_STATE_TRAN 4
|
|
#define R1_STATE_DATA 5
|
|
#define R1_STATE_RCV 6
|
|
#define R1_STATE_PRG 7
|
|
#define R1_STATE_DIS 8
|
|
|
|
/*
|
|
* MMC/SD in SPI mode reports R1 status always, and R2 for SEND_STATUS
|
|
* R1 is the low order byte; R2 is the next highest byte, when present.
|
|
*/
|
|
#define R1_SPI_IDLE (1 << 0)
|
|
#define R1_SPI_ERASE_RESET (1 << 1)
|
|
#define R1_SPI_ILLEGAL_COMMAND (1 << 2)
|
|
#define R1_SPI_COM_CRC (1 << 3)
|
|
#define R1_SPI_ERASE_SEQ (1 << 4)
|
|
#define R1_SPI_ADDRESS (1 << 5)
|
|
#define R1_SPI_PARAMETER (1 << 6)
|
|
/* R1 bit 7 is always zero */
|
|
#define R2_SPI_CARD_LOCKED (1 << 8)
|
|
#define R2_SPI_WP_ERASE_SKIP (1 << 9) /* or lock/unlock fail */
|
|
#define R2_SPI_LOCK_UNLOCK_FAIL R2_SPI_WP_ERASE_SKIP
|
|
#define R2_SPI_ERROR (1 << 10)
|
|
#define R2_SPI_CC_ERROR (1 << 11)
|
|
#define R2_SPI_CARD_ECC_ERROR (1 << 12)
|
|
#define R2_SPI_WP_VIOLATION (1 << 13)
|
|
#define R2_SPI_ERASE_PARAM (1 << 14)
|
|
#define R2_SPI_OUT_OF_RANGE (1 << 15) /* or CSD overwrite */
|
|
#define R2_SPI_CSD_OVERWRITE R2_SPI_OUT_OF_RANGE
|
|
|
|
/* These are unpacked versions of the actual responses */
|
|
|
|
struct _mmc_csd {
|
|
u8 csd_structure;
|
|
u8 spec_vers;
|
|
u8 taac;
|
|
u8 nsac;
|
|
u8 tran_speed;
|
|
u16 ccc;
|
|
u8 read_bl_len;
|
|
u8 read_bl_partial;
|
|
u8 write_blk_misalign;
|
|
u8 read_blk_misalign;
|
|
u8 dsr_imp;
|
|
u16 c_size;
|
|
u8 vdd_r_curr_min;
|
|
u8 vdd_r_curr_max;
|
|
u8 vdd_w_curr_min;
|
|
u8 vdd_w_curr_max;
|
|
u8 c_size_mult;
|
|
union {
|
|
struct { /* MMC system specification version 3.1 */
|
|
u8 erase_grp_size;
|
|
u8 erase_grp_mult;
|
|
} v31;
|
|
struct { /* MMC system specification version 2.2 */
|
|
u8 sector_size;
|
|
u8 erase_grp_size;
|
|
} v22;
|
|
} erase;
|
|
u8 wp_grp_size;
|
|
u8 wp_grp_enable;
|
|
u8 default_ecc;
|
|
u8 r2w_factor;
|
|
u8 write_bl_len;
|
|
u8 write_bl_partial;
|
|
u8 file_format_grp;
|
|
u8 copy;
|
|
u8 perm_write_protect;
|
|
u8 tmp_write_protect;
|
|
u8 file_format;
|
|
u8 ecc;
|
|
};
|
|
|
|
/*
|
|
* OCR bits are mostly in host.h
|
|
*/
|
|
#define MMC_CARD_BUSY 0x80000000 /* Card Power up status bit */
|
|
|
|
/*
|
|
* Card Command Classes (CCC)
|
|
*/
|
|
#define CCC_BASIC (1<<0) /* (0) Basic protocol functions */
|
|
/* (CMD0,1,2,3,4,7,9,10,12,13,15) */
|
|
/* (and for SPI, CMD58,59) */
|
|
#define CCC_STREAM_READ (1<<1) /* (1) Stream read commands */
|
|
/* (CMD11) */
|
|
#define CCC_BLOCK_READ (1<<2) /* (2) Block read commands */
|
|
/* (CMD16,17,18) */
|
|
#define CCC_STREAM_WRITE (1<<3) /* (3) Stream write commands */
|
|
/* (CMD20) */
|
|
#define CCC_BLOCK_WRITE (1<<4) /* (4) Block write commands */
|
|
/* (CMD16,24,25,26,27) */
|
|
#define CCC_ERASE (1<<5) /* (5) Ability to erase blocks */
|
|
/* (CMD32,33,34,35,36,37,38,39) */
|
|
#define CCC_WRITE_PROT (1<<6) /* (6) Able to write protect blocks */
|
|
/* (CMD28,29,30) */
|
|
#define CCC_LOCK_CARD (1<<7) /* (7) Able to lock down card */
|
|
/* (CMD16,CMD42) */
|
|
#define CCC_APP_SPEC (1<<8) /* (8) Application specific */
|
|
/* (CMD55,56,57,ACMD*) */
|
|
#define CCC_IO_MODE (1<<9) /* (9) I/O mode */
|
|
/* (CMD5,39,40,52,53) */
|
|
#define CCC_SWITCH (1<<10) /* (10) High speed switch */
|
|
/* (CMD6,34,35,36,37,50) */
|
|
/* (11) Reserved */
|
|
/* (CMD?) */
|
|
|
|
/*
|
|
* CSD field definitions
|
|
*/
|
|
|
|
#define CSD_STRUCT_VER_1_0 0 /* Valid for system specification 1.0 - 1.2 */
|
|
#define CSD_STRUCT_VER_1_1 1 /* Valid for system specification 1.4 - 2.2 */
|
|
#define CSD_STRUCT_VER_1_2 2 /* Valid for system specification 3.1 - 3.2 - 3.31 - 4.0 - 4.1 */
|
|
#define CSD_STRUCT_EXT_CSD 3 /* Version is coded in CSD_STRUCTURE in EXT_CSD */
|
|
|
|
#define CSD_SPEC_VER_0 0 /* Implements system specification 1.0 - 1.2 */
|
|
#define CSD_SPEC_VER_1 1 /* Implements system specification 1.4 */
|
|
#define CSD_SPEC_VER_2 2 /* Implements system specification 2.0 - 2.2 */
|
|
#define CSD_SPEC_VER_3 3 /* Implements system specification 3.1 - 3.2 - 3.31 */
|
|
#define CSD_SPEC_VER_4 4 /* Implements system specification 4.0 - 4.1 */
|
|
|
|
/*
|
|
* EXT_CSD fields
|
|
*/
|
|
|
|
#define EXT_CSD_FLUSH_CACHE 32 /* W */
|
|
#define EXT_CSD_CACHE_CTRL 33 /* R/W */
|
|
#define EXT_CSD_POWER_OFF_NOTIFICATION 34 /* R/W */
|
|
#define EXT_CSD_DATA_SECTOR_SIZE 61 /* R */
|
|
#define EXT_CSD_GP_SIZE_MULT 143 /* R/W */
|
|
#define EXT_CSD_PARTITION_ATTRIBUTE 156 /* R/W */
|
|
#define EXT_CSD_PARTITION_SUPPORT 160 /* RO */
|
|
#define EXT_CSD_HPI_MGMT 161 /* R/W */
|
|
#define EXT_CSD_RST_N_FUNCTION 162 /* R/W */
|
|
#define EXT_CSD_SANITIZE_START 165 /* W */
|
|
#define EXT_CSD_WR_REL_PARAM 166 /* RO */
|
|
#define EXT_CSD_BOOT_WP 173 /* R/W */
|
|
#define EXT_CSD_ERASE_GROUP_DEF 175 /* R/W */
|
|
#define EXT_CSD_PART_CONFIG 179 /* R/W */
|
|
#define EXT_CSD_ERASED_MEM_CONT 181 /* RO */
|
|
#define EXT_CSD_BUS_WIDTH 183 /* R/W */
|
|
#define EXT_CSD_HS_TIMING 185 /* R/W */
|
|
#define EXT_CSD_POWER_CLASS 187 /* R/W */
|
|
#define EXT_CSD_REV 192 /* RO */
|
|
#define EXT_CSD_STRUCTURE 194 /* RO */
|
|
#define EXT_CSD_CARD_TYPE 196 /* RO */
|
|
#define EXT_CSD_OUT_OF_INTERRUPT_TIME 198 /* RO */
|
|
#define EXT_CSD_PART_SWITCH_TIME 199 /* RO */
|
|
#define EXT_CSD_PWR_CL_52_195 200 /* RO */
|
|
#define EXT_CSD_PWR_CL_26_195 201 /* RO */
|
|
#define EXT_CSD_PWR_CL_52_360 202 /* RO */
|
|
#define EXT_CSD_PWR_CL_26_360 203 /* RO */
|
|
#define EXT_CSD_SEC_CNT 212 /* RO, 4 bytes */
|
|
#define EXT_CSD_S_A_TIMEOUT 217 /* RO */
|
|
#define EXT_CSD_REL_WR_SEC_C 222 /* RO */
|
|
#define EXT_CSD_HC_WP_GRP_SIZE 221 /* RO */
|
|
#define EXT_CSD_ERASE_TIMEOUT_MULT 223 /* RO */
|
|
#define EXT_CSD_HC_ERASE_GRP_SIZE 224 /* RO */
|
|
#define EXT_CSD_BOOT_MULT 226 /* RO */
|
|
#define EXT_CSD_SEC_TRIM_MULT 229 /* RO */
|
|
#define EXT_CSD_SEC_ERASE_MULT 230 /* RO */
|
|
#define EXT_CSD_SEC_FEATURE_SUPPORT 231 /* RO */
|
|
#define EXT_CSD_TRIM_MULT 232 /* RO */
|
|
#define EXT_CSD_PWR_CL_200_195 236 /* RO */
|
|
#define EXT_CSD_PWR_CL_200_360 237 /* RO */
|
|
#define EXT_CSD_PWR_CL_DDR_52_195 238 /* RO */
|
|
#define EXT_CSD_PWR_CL_DDR_52_360 239 /* RO */
|
|
#define EXT_CSD_POWER_OFF_LONG_TIME 247 /* RO */
|
|
#define EXT_CSD_GENERIC_CMD6_TIME 248 /* RO */
|
|
#define EXT_CSD_CACHE_SIZE 249 /* RO, 4 bytes */
|
|
#define EXT_CSD_TAG_UNIT_SIZE 498 /* RO */
|
|
#define EXT_CSD_DATA_TAG_SUPPORT 499 /* RO */
|
|
#define EXT_CSD_HPI_FEATURES 503 /* RO */
|
|
|
|
/*
|
|
* EXT_CSD field definitions
|
|
*/
|
|
|
|
#define EXT_CSD_WR_REL_PARAM_EN (1<<2)
|
|
|
|
#define EXT_CSD_BOOT_WP_B_PWR_WP_DIS (0x40)
|
|
#define EXT_CSD_BOOT_WP_B_PERM_WP_DIS (0x10)
|
|
#define EXT_CSD_BOOT_WP_B_PERM_WP_EN (0x04)
|
|
#define EXT_CSD_BOOT_WP_B_PWR_WP_EN (0x01)
|
|
|
|
#define EXT_CSD_PART_CONFIG_ACC_MASK (0x7)
|
|
#define EXT_CSD_PART_CONFIG_ACC_BOOT0 (0x1)
|
|
#define EXT_CSD_PART_CONFIG_ACC_GP0 (0x4)
|
|
|
|
#define EXT_CSD_PART_SUPPORT_PART_EN (0x1)
|
|
|
|
#define EXT_CSD_CMD_SET_NORMAL (1<<0)
|
|
#define EXT_CSD_CMD_SET_SECURE (1<<1)
|
|
#define EXT_CSD_CMD_SET_CPSECURE (1<<2)
|
|
|
|
#define EXT_CSD_CARD_TYPE_26 (1<<0) /* Card can run at 26MHz */
|
|
#define EXT_CSD_CARD_TYPE_52 (1<<1) /* Card can run at 52MHz */
|
|
#define EXT_CSD_CARD_TYPE_MASK 0x3F /* Mask out reserved bits */
|
|
#define EXT_CSD_CARD_TYPE_DDR_1_8V (1<<2) /* Card can run at 52MHz */
|
|
/* DDR mode @1.8V or 3V I/O */
|
|
#define EXT_CSD_CARD_TYPE_DDR_1_2V (1<<3) /* Card can run at 52MHz */
|
|
/* DDR mode @1.2V I/O */
|
|
#define EXT_CSD_CARD_TYPE_DDR_52 (EXT_CSD_CARD_TYPE_DDR_1_8V \
|
|
| EXT_CSD_CARD_TYPE_DDR_1_2V)
|
|
#define EXT_CSD_CARD_TYPE_SDR_1_8V (1<<4) /* Card can run at 200MHz */
|
|
#define EXT_CSD_CARD_TYPE_SDR_1_2V (1<<5) /* Card can run at 200MHz */
|
|
/* SDR mode @1.2V I/O */
|
|
|
|
#define EXT_CSD_BUS_WIDTH_1 0 /* Card is in 1 bit mode */
|
|
#define EXT_CSD_BUS_WIDTH_4 1 /* Card is in 4 bit mode */
|
|
#define EXT_CSD_BUS_WIDTH_8 2 /* Card is in 8 bit mode */
|
|
#define EXT_CSD_DDR_BUS_WIDTH_4 5 /* Card is in 4 bit DDR mode */
|
|
#define EXT_CSD_DDR_BUS_WIDTH_8 6 /* Card is in 8 bit DDR mode */
|
|
|
|
#define EXT_CSD_SEC_ER_EN BIT(0)
|
|
#define EXT_CSD_SEC_BD_BLK_EN BIT(2)
|
|
#define EXT_CSD_SEC_GB_CL_EN BIT(4)
|
|
#define EXT_CSD_SEC_SANITIZE BIT(6) /* v4.5 only */
|
|
|
|
#define EXT_CSD_RST_N_EN_MASK 0x3
|
|
#define EXT_CSD_RST_N_ENABLED 1 /* RST_n is enabled on card */
|
|
|
|
#define EXT_CSD_NO_POWER_NOTIFICATION 0
|
|
#define EXT_CSD_POWER_ON 1
|
|
#define EXT_CSD_POWER_OFF_SHORT 2
|
|
#define EXT_CSD_POWER_OFF_LONG 3
|
|
|
|
#define EXT_CSD_PWR_CL_8BIT_MASK 0xF0 /* 8 bit PWR CLS */
|
|
#define EXT_CSD_PWR_CL_4BIT_MASK 0x0F /* 8 bit PWR CLS */
|
|
#define EXT_CSD_PWR_CL_8BIT_SHIFT 4
|
|
#define EXT_CSD_PWR_CL_4BIT_SHIFT 0
|
|
/*
|
|
* MMC_SWITCH access modes
|
|
*/
|
|
|
|
#define MMC_SWITCH_MODE_CMD_SET 0x00 /* Change the command set */
|
|
#define MMC_SWITCH_MODE_SET_BITS 0x01 /* Set bits which are 1 in value */
|
|
#define MMC_SWITCH_MODE_CLEAR_BITS 0x02 /* Clear bits which are 1 in value */
|
|
#define MMC_SWITCH_MODE_WRITE_BYTE 0x03 /* Set target to value */
|
|
|
|
#endif /* LINUX_MMC_MMC_H */
|