[deliverable/linux.git] / include / linux / mmc / mmc.h

/*
 * 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 MMC_MMC_H
#define 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  */

  /* 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  */

/*
 * 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 */

/*
 * 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_PARTITION_ATTRIBUTE	156	/* R/W */
#define EXT_CSD_PARTITION_SUPPORT	160	/* RO */
#define EXT_CSD_WR_REL_PARAM		166	/* RO */
#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_REV			192	/* RO */
#define EXT_CSD_STRUCTURE		194	/* RO */
#define EXT_CSD_CARD_TYPE		196	/* RO */
#define EXT_CSD_PART_SWITCH_TIME        199     /* 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 */

/*
 * EXT_CSD field definitions
 */

#define EXT_CSD_WR_REL_PARAM_EN		(1<<2)

#define EXT_CSD_PART_CONFIG_ACC_MASK	(0x7)
#define EXT_CSD_PART_CONFIG_ACC_BOOT0	(0x1)
#define EXT_CSD_PART_CONFIG_ACC_BOOT1	(0x2)

#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	0xF	/* 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_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)

/*
 * 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  /* MMC_MMC_PROTOCOL_H */
Commit	Line	Data
1da177e4 LT	1	/*
	2	* Header for MultiMediaCard (MMC)
	3	*
	4	* Copyright 2002 Hewlett-Packard Company
	5	*
	6	* Use consistent with the GNU GPL is permitted,
	7	* provided that this copyright notice is
	8	* preserved in its entirety in all copies and derived works.
	9	*
	10	* HEWLETT-PACKARD COMPANY MAKES NO WARRANTIES, EXPRESSED OR IMPLIED,
	11	* AS TO THE USEFULNESS OR CORRECTNESS OF THIS CODE OR ITS
	12	* FITNESS FOR ANY PARTICULAR PURPOSE.
	13	*
	14	* Many thanks to Alessandro Rubini and Jonathan Corbet!
	15	*
	16	* Based strongly on code by:
	17	*
	18	* Author: Yong-iL Joh <tolkien@mizi.com>
1da177e4 LT	19	*
	20	* Author: Andrew Christian
	21	* 15 May 2002
	22	*/
	23
da7fbe58 PO	24	#ifndef MMC_MMC_H
da7fbe58 PO	25	#define MMC_MMC_H
1da177e4	26
bce40a36	27	/* Standard MMC commands (4.1) type argument response */
1da177e4	28	/* class 1 */
97018580	29	#define MMC_GO_IDLE_STATE 0 /* bc */
1da177e4 LT	30	#define MMC_SEND_OP_COND 1 /* bcr [31:0] OCR R3 */
	31	#define MMC_ALL_SEND_CID 2 /* bcr R2 */
	32	#define MMC_SET_RELATIVE_ADDR 3 /* ac [31:16] RCA R1 */
	33	#define MMC_SET_DSR 4 /* bc [31:16] RCA */
b1ebe384	34	#define MMC_SLEEP_AWAKE 5 /* ac [31:16] RCA 15:flg R1b */
bce40a36	35	#define MMC_SWITCH 6 /* ac [31:0] See below R1b */
1da177e4	36	#define MMC_SELECT_CARD 7 /* ac [31:16] RCA R1 */
bce40a36	37	#define MMC_SEND_EXT_CSD 8 /* adtc R1 */
1da177e4 LT	38	#define MMC_SEND_CSD 9 /* ac [31:16] RCA R2 */
	39	#define MMC_SEND_CID 10 /* ac [31:16] RCA R2 */
	40	#define MMC_READ_DAT_UNTIL_STOP 11 /* adtc [31:0] dadr R1 */
	41	#define MMC_STOP_TRANSMISSION 12 /* ac R1b */
97018580	42	#define MMC_SEND_STATUS 13 /* ac [31:16] RCA R1 */
22113efd	43	#define MMC_BUS_TEST_R 14 /* adtc R1 */
1da177e4	44	#define MMC_GO_INACTIVE_STATE 15 /* ac [31:16] RCA */
22113efd	45	#define MMC_BUS_TEST_W 19 /* adtc R1 */
97018580 DB	46	#define MMC_SPI_READ_OCR 58 /* spi spi_R3 */
97018580 DB	47	#define MMC_SPI_CRC_ON_OFF 59 /* spi [0:0] flag spi_R1 */
1da177e4 LT	48
	49	/* class 2 */
	50	#define MMC_SET_BLOCKLEN 16 /* ac [31:0] block len R1 */
	51	#define MMC_READ_SINGLE_BLOCK 17 /* adtc [31:0] data addr R1 */
	52	#define MMC_READ_MULTIPLE_BLOCK 18 /* adtc [31:0] data addr R1 */
b513ea25	53	#define MMC_SEND_TUNING_BLOCK 19 /* adtc R1 */
1da177e4 LT	54
	55	/* class 3 */
	56	#define MMC_WRITE_DAT_UNTIL_STOP 20 /* adtc [31:0] data addr R1 */
	57
	58	/* class 4 */
	59	#define MMC_SET_BLOCK_COUNT 23 /* adtc [31:0] data addr R1 */
	60	#define MMC_WRITE_BLOCK 24 /* adtc [31:0] data addr R1 */
	61	#define MMC_WRITE_MULTIPLE_BLOCK 25 /* adtc R1 */
	62	#define MMC_PROGRAM_CID 26 /* adtc R1 */
	63	#define MMC_PROGRAM_CSD 27 /* adtc R1 */
	64
	65	/* class 6 */
	66	#define MMC_SET_WRITE_PROT 28 /* ac [31:0] data addr R1b */
	67	#define MMC_CLR_WRITE_PROT 29 /* ac [31:0] data addr R1b */
	68	#define MMC_SEND_WRITE_PROT 30 /* adtc [31:0] wpdata addr R1 */
	69
	70	/* class 5 */
	71	#define MMC_ERASE_GROUP_START 35 /* ac [31:0] data addr R1 */
	72	#define MMC_ERASE_GROUP_END 36 /* ac [31:0] data addr R1 */
24117def	73	#define MMC_ERASE 38 /* ac R1b */
1da177e4 LT	74
	75	/* class 9 */
	76	#define MMC_FAST_IO 39 /* ac <Complex> R4 */
	77	#define MMC_GO_IRQ_STATE 40 /* bcr R5 */
	78
	79	/* class 7 */
	80	#define MMC_LOCK_UNLOCK 42 /* adtc R1b */
	81
	82	/* class 8 */
	83	#define MMC_APP_CMD 55 /* ac [31:16] RCA R1 */
24117def	84	#define MMC_GEN_CMD 56 /* adtc [0] RD/WR R1 */
1da177e4	85
bce40a36 PL	86	/*
	87	* MMC_SWITCH argument format:
	88	*
	89	* [31:26] Always 0
	90	* [25:24] Access Mode
	91	* [23:16] Location of target Byte in EXT_CSD
	92	* [15:08] Value Byte
	93	* [07:03] Always 0
	94	* [02:00] Command Set
	95	*/
	96
1da177e4	97	/*
97018580	98	MMC status in R1, for native mode (SPI bits are different)
1da177e4	99	Type
97018580	100	e : error bit
1da177e4 LT	101	s : status bit
	102	r : detected and set for the actual command response
	103	x : detected and set during command execution. the host must poll
	104	the card by sending status command in order to read these bits.
	105	Clear condition
97018580	106	a : according to the card state
1da177e4 LT	107	b : always related to the previous command. Reception of
	108	a valid command will clear it (with a delay of one command)
	109	c : clear by read
	110	*/
	111
	112	#define R1_OUT_OF_RANGE (1 << 31) /* er, c */
	113	#define R1_ADDRESS_ERROR (1 << 30) /* erx, c */
	114	#define R1_BLOCK_LEN_ERROR (1 << 29) /* er, c */
	115	#define R1_ERASE_SEQ_ERROR (1 << 28) /* er, c */
	116	#define R1_ERASE_PARAM (1 << 27) /* ex, c */
	117	#define R1_WP_VIOLATION (1 << 26) /* erx, c */
	118	#define R1_CARD_IS_LOCKED (1 << 25) /* sx, a */
	119	#define R1_LOCK_UNLOCK_FAILED (1 << 24) /* erx, c */
	120	#define R1_COM_CRC_ERROR (1 << 23) /* er, b */
	121	#define R1_ILLEGAL_COMMAND (1 << 22) /* er, b */
	122	#define R1_CARD_ECC_FAILED (1 << 21) /* ex, c */
	123	#define R1_CC_ERROR (1 << 20) /* erx, c */
	124	#define R1_ERROR (1 << 19) /* erx, c */
	125	#define R1_UNDERRUN (1 << 18) /* ex, c */
	126	#define R1_OVERRUN (1 << 17) /* ex, c */
	127	#define R1_CID_CSD_OVERWRITE (1 << 16) /* erx, c, CID/CSD overwrite */
	128	#define R1_WP_ERASE_SKIP (1 << 15) /* sx, c */
	129	#define R1_CARD_ECC_DISABLED (1 << 14) /* sx, a */
	130	#define R1_ERASE_RESET (1 << 13) /* sr, c */
	131	#define R1_STATUS(x) (x & 0xFFFFE000)
97018580	132	#define R1_CURRENT_STATE(x) ((x & 0x00001E00) >> 9) /* sx, b (4 bits) */
1da177e4	133	#define R1_READY_FOR_DATA (1 << 8) /* sx, a */
ef0b27d4	134	#define R1_SWITCH_ERROR (1 << 7) /* sx, c */
1da177e4 LT	135	#define R1_APP_CMD (1 << 5) /* sr, c */
1da177e4 LT	136
97018580 DB	137	/*
	138	* MMC/SD in SPI mode reports R1 status always, and R2 for SEND_STATUS
	139	* R1 is the low order byte; R2 is the next highest byte, when present.
	140	*/
	141	#define R1_SPI_IDLE (1 << 0)
	142	#define R1_SPI_ERASE_RESET (1 << 1)
	143	#define R1_SPI_ILLEGAL_COMMAND (1 << 2)
	144	#define R1_SPI_COM_CRC (1 << 3)
	145	#define R1_SPI_ERASE_SEQ (1 << 4)
	146	#define R1_SPI_ADDRESS (1 << 5)
	147	#define R1_SPI_PARAMETER (1 << 6)
	148	/* R1 bit 7 is always zero */
	149	#define R2_SPI_CARD_LOCKED (1 << 8)
	150	#define R2_SPI_WP_ERASE_SKIP (1 << 9) /* or lock/unlock fail */
	151	#define R2_SPI_LOCK_UNLOCK_FAIL R2_SPI_WP_ERASE_SKIP
	152	#define R2_SPI_ERROR (1 << 10)
	153	#define R2_SPI_CC_ERROR (1 << 11)
	154	#define R2_SPI_CARD_ECC_ERROR (1 << 12)
	155	#define R2_SPI_WP_VIOLATION (1 << 13)
	156	#define R2_SPI_ERASE_PARAM (1 << 14)
	157	#define R2_SPI_OUT_OF_RANGE (1 << 15) /* or CSD overwrite */
	158	#define R2_SPI_CSD_OVERWRITE R2_SPI_OUT_OF_RANGE
	159
1da177e4 LT	160	/* These are unpacked versions of the actual responses */
	161
	162	struct _mmc_csd {
	163	u8 csd_structure;
	164	u8 spec_vers;
	165	u8 taac;
	166	u8 nsac;
	167	u8 tran_speed;
	168	u16 ccc;
	169	u8 read_bl_len;
	170	u8 read_bl_partial;
	171	u8 write_blk_misalign;
	172	u8 read_blk_misalign;
	173	u8 dsr_imp;
	174	u16 c_size;
	175	u8 vdd_r_curr_min;
	176	u8 vdd_r_curr_max;
	177	u8 vdd_w_curr_min;
	178	u8 vdd_w_curr_max;
	179	u8 c_size_mult;
	180	union {
	181	struct { /* MMC system specification version 3.1 */
	182	u8 erase_grp_size;
	183	u8 erase_grp_mult;
	184	} v31;
	185	struct { /* MMC system specification version 2.2 */
	186	u8 sector_size;
	187	u8 erase_grp_size;
	188	} v22;
	189	} erase;
	190	u8 wp_grp_size;
	191	u8 wp_grp_enable;
	192	u8 default_ecc;
	193	u8 r2w_factor;
	194	u8 write_bl_len;
	195	u8 write_bl_partial;
	196	u8 file_format_grp;
	197	u8 copy;
	198	u8 perm_write_protect;
	199	u8 tmp_write_protect;
	200	u8 file_format;
	201	u8 ecc;
	202	};
	203
f74d132c PO	204	/*
	205	* OCR bits are mostly in host.h
	206	*/
1da177e4 LT	207	#define MMC_CARD_BUSY 0x80000000 /* Card Power up status bit */
1da177e4 LT	208
912490db PO	209	/*
	210	* Card Command Classes (CCC)
	211	*/
	212	#define CCC_BASIC (1<<0) /* (0) Basic protocol functions */
	213	/* (CMD0,1,2,3,4,7,9,10,12,13,15) */
97018580	214	/* (and for SPI, CMD58,59) */
912490db PO	215	#define CCC_STREAM_READ (1<<1) /* (1) Stream read commands */
	216	/* (CMD11) */
	217	#define CCC_BLOCK_READ (1<<2) /* (2) Block read commands */
	218	/* (CMD16,17,18) */
	219	#define CCC_STREAM_WRITE (1<<3) /* (3) Stream write commands */
	220	/* (CMD20) */
	221	#define CCC_BLOCK_WRITE (1<<4) /* (4) Block write commands */
	222	/* (CMD16,24,25,26,27) */
	223	#define CCC_ERASE (1<<5) /* (5) Ability to erase blocks */
	224	/* (CMD32,33,34,35,36,37,38,39) */
	225	#define CCC_WRITE_PROT (1<<6) /* (6) Able to write protect blocks */
	226	/* (CMD28,29,30) */
	227	#define CCC_LOCK_CARD (1<<7) /* (7) Able to lock down card */
	228	/* (CMD16,CMD42) */
	229	#define CCC_APP_SPEC (1<<8) /* (8) Application specific */
	230	/* (CMD55,56,57,ACMD) /
	231	#define CCC_IO_MODE (1<<9) /* (9) I/O mode */
	232	/* (CMD5,39,40,52,53) */
	233	#define CCC_SWITCH (1<<10) /* (10) High speed switch */
	234	/* (CMD6,34,35,36,37,50) */
	235	/* (11) Reserved */
	236	/* (CMD?) */
1da177e4 LT	237
	238	/*
	239	* CSD field definitions
	240	*/
	241
	242	#define CSD_STRUCT_VER_1_0 0 /* Valid for system specification 1.0 - 1.2 */
	243	#define CSD_STRUCT_VER_1_1 1 /* Valid for system specification 1.4 - 2.2 */
bce40a36 PL	244	#define CSD_STRUCT_VER_1_2 2 /* Valid for system specification 3.1 - 3.2 - 3.31 - 4.0 - 4.1 */
bce40a36 PL	245	#define CSD_STRUCT_EXT_CSD 3 /* Version is coded in CSD_STRUCTURE in EXT_CSD */
1da177e4 LT	246
	247	#define CSD_SPEC_VER_0 0 /* Implements system specification 1.0 - 1.2 */
	248	#define CSD_SPEC_VER_1 1 /* Implements system specification 1.4 */
	249	#define CSD_SPEC_VER_2 2 /* Implements system specification 2.0 - 2.2 */
bce40a36 PL	250	#define CSD_SPEC_VER_3 3 /* Implements system specification 3.1 - 3.2 - 3.31 */
	251	#define CSD_SPEC_VER_4 4 /* Implements system specification 4.0 - 4.1 */
	252
	253	/*
	254	* EXT_CSD fields
	255	*/
	256
709de99d CD	257	#define EXT_CSD_PARTITION_ATTRIBUTE 156 /* R/W */
709de99d CD	258	#define EXT_CSD_PARTITION_SUPPORT 160 /* RO */
f4c5522b	259	#define EXT_CSD_WR_REL_PARAM 166 /* RO */
dfe86cba	260	#define EXT_CSD_ERASE_GROUP_DEF 175 /* R/W */
371a689f	261	#define EXT_CSD_PART_CONFIG 179 /* R/W */
dfe86cba AH	262	#define EXT_CSD_ERASED_MEM_CONT 181 /* RO */
	263	#define EXT_CSD_BUS_WIDTH 183 /* R/W */
	264	#define EXT_CSD_HS_TIMING 185 /* R/W */
	265	#define EXT_CSD_REV 192 /* RO */
	266	#define EXT_CSD_STRUCTURE 194 /* RO */
	267	#define EXT_CSD_CARD_TYPE 196 /* RO */
371a689f	268	#define EXT_CSD_PART_SWITCH_TIME 199 /* RO */
dfe86cba AH	269	#define EXT_CSD_SEC_CNT 212 /* RO, 4 bytes */
dfe86cba AH	270	#define EXT_CSD_S_A_TIMEOUT 217 /* RO */
f4c5522b	271	#define EXT_CSD_REL_WR_SEC_C 222 /* RO */
709de99d	272	#define EXT_CSD_HC_WP_GRP_SIZE 221 /* RO */
dfe86cba AH	273	#define EXT_CSD_ERASE_TIMEOUT_MULT 223 /* RO */
dfe86cba AH	274	#define EXT_CSD_HC_ERASE_GRP_SIZE 224 /* RO */
371a689f	275	#define EXT_CSD_BOOT_MULT 226 /* RO */
dfe86cba AH	276	#define EXT_CSD_SEC_TRIM_MULT 229 /* RO */
	277	#define EXT_CSD_SEC_ERASE_MULT 230 /* RO */
	278	#define EXT_CSD_SEC_FEATURE_SUPPORT 231 /* RO */
	279	#define EXT_CSD_TRIM_MULT 232 /* RO */
bce40a36 PL	280
	281	/*
	282	* EXT_CSD field definitions
	283	*/
	284
f4c5522b AW	285	#define EXT_CSD_WR_REL_PARAM_EN (1<<2)
f4c5522b AW	286
371a689f AW	287	#define EXT_CSD_PART_CONFIG_ACC_MASK (0x7)
	288	#define EXT_CSD_PART_CONFIG_ACC_BOOT0 (0x1)
	289	#define EXT_CSD_PART_CONFIG_ACC_BOOT1 (0x2)
	290
bce40a36 PL	291	#define EXT_CSD_CMD_SET_NORMAL (1<<0)
	292	#define EXT_CSD_CMD_SET_SECURE (1<<1)
	293	#define EXT_CSD_CMD_SET_CPSECURE (1<<2)
	294
	295	#define EXT_CSD_CARD_TYPE_26 (1<<0) /* Card can run at 26MHz */
	296	#define EXT_CSD_CARD_TYPE_52 (1<<1) /* Card can run at 52MHz */
dfc13e84 HP	297	#define EXT_CSD_CARD_TYPE_MASK 0xF /* Mask out reserved bits */
	298	#define EXT_CSD_CARD_TYPE_DDR_1_8V (1<<2) /* Card can run at 52MHz */
	299	/* DDR mode @1.8V or 3V I/O */
	300	#define EXT_CSD_CARD_TYPE_DDR_1_2V (1<<3) /* Card can run at 52MHz */
	301	/* DDR mode @1.2V I/O */
	302	#define EXT_CSD_CARD_TYPE_DDR_52 (EXT_CSD_CARD_TYPE_DDR_1_8V \
	303	\| EXT_CSD_CARD_TYPE_DDR_1_2V)
bce40a36	304
e45a1bd2 PL	305	#define EXT_CSD_BUS_WIDTH_1 0 /* Card is in 1 bit mode */
	306	#define EXT_CSD_BUS_WIDTH_4 1 /* Card is in 4 bit mode */
	307	#define EXT_CSD_BUS_WIDTH_8 2 /* Card is in 8 bit mode */
dfc13e84 HP	308	#define EXT_CSD_DDR_BUS_WIDTH_4 5 /* Card is in 4 bit DDR mode */
dfc13e84 HP	309	#define EXT_CSD_DDR_BUS_WIDTH_8 6 /* Card is in 8 bit DDR mode */
e45a1bd2	310
dfe86cba AH	311	#define EXT_CSD_SEC_ER_EN BIT(0)
	312	#define EXT_CSD_SEC_BD_BLK_EN BIT(2)
	313	#define EXT_CSD_SEC_GB_CL_EN BIT(4)
	314
bce40a36 PL	315	/*
	316	* MMC_SWITCH access modes
	317	*/
1da177e4	318
bce40a36 PL	319	#define MMC_SWITCH_MODE_CMD_SET 0x00 /* Change the command set */
	320	#define MMC_SWITCH_MODE_SET_BITS 0x01 /* Set bits which are 1 in value */
	321	#define MMC_SWITCH_MODE_CLEAR_BITS 0x02 /* Clear bits which are 1 in value */
	322	#define MMC_SWITCH_MODE_WRITE_BYTE 0x03 /* Set target to value */
f218278a	323
1da177e4 LT	324	#endif /* MMC_MMC_PROTOCOL_H */
1da177e4 LT	325