/****************************************Copyright (c)**************************************************
**                               Guangzhou ZLG-MCU Development Co.,LTD.
**                                      graduate school
**                                 http://www.zlgmcu.com
**
**--------------File Info-------------------------------------------------------------------------------
** File name:			sdcmd.h
** Last modified Date:	2005-3-11
** Last Version:		V2.0
** Descriptions:		SD/MMC 讀寫模塊: 物理層 ---- SD/MMC 卡SPI模式支持的命令(頭文件) 
**						Soft Packet of SD/MMC Card : commands that SD/MMC card supported 
**						in spi mode(header file)
**------------------------------------------------------------------------------------------------------
** Created by:			Ming Yuan Zheng
** Created date:		2005-1-6
** Version:				V1.0
** Descriptions:		SD/MMC 讀寫模塊: 物理層 ---- SD卡SPI模式支持的命令 
**
**------------------------------------------------------------------------------------------------------
** Modified by:			Ming Yuan Zheng
** Modified date:		2005-3-11
** Version:				V2.0
** Descriptions:		增加了對MMC卡的支持,并使用本模塊既可以運行于前后臺系統,也可運行于uCOS-II中.
**
**------------------------------------------------------------------------------------------------------
** Modified by: 
** Modified date:
** Version:	
** Descriptions: 
**
********************************************************************************************************/

#ifndef __SDCMD_H__
#define __SDCMD_H__

/*
 *******************************************************
	
		SD/MMC 卡的相關命令與響應宏定義
	
 *******************************************************
*/

/* 命令響應定義 define command's response */
#define R1 1
#define R1B 2
#define R2 3
#define R3 4

/* R1和R2高字節錯誤碼 R1 and upper byte of R2 error code */
#define MSK_IDLE          		  0x01
#define MSK_ERASE_RST     		  0x02
#define MSK_ILL_CMD       		  0x04
#define MSK_CRC_ERR       		  0x08
#define MSK_ERASE_SEQ_ERR 		  0x10
#define MSK_ADDR_ERR      		  0x20
#define MSK_PARAM_ERR     		  0x40

/* R2低字節錯誤碼 lower byte of R2 error code */
#define MSK_TOK_ERROR             0x01
#define MSK_TOK_CC_ERROR          0x02
#define MSK_TOK_ECC_FAILED        0x04
#define MSK_TOK_CC_OUTOFRANGE     0x08
#define MSK_TOK_CC_LOCKED         0x10



/* 數據令牌 Data Tokens */
#define SD_TOK_READ_STARTBLOCK    0xFE
#define SD_TOK_WRITE_STARTBLOCK   0xFE
#define SD_TOK_READ_STARTBLOCK_M  0xFE
#define SD_TOK_WRITE_STARTBLOCK_M 0xFC
#define SD_TOK_STOP_MULTI         0xFD

/* 數據響應令牌 Data Response Tokens */
#define SD_RESP_DATA_MSK		  0x0F		//數據響應掩碼
#define SD_RESP_DATA_ACCETPTED	  0x05		//數據被接受
#define SD_RESP_DATA_REJECT_CRC	  0x0B      //由于CRC錯誤而被拒絕
#define SD_RESP_DATA_REJECT_WRITE 0x0D		//由于寫錯誤而被拒絕

/* 等待類型 Wait Type */
#define SD_WAIT_READ			  0x00		//讀等待
#define SD_WAIT_WRITE			  0x01		//寫等待
#define SD_WAIT_ERASE		 	  0x02		//擦除等待


/*
*********************************************

     SD卡SPI模式下命令集

*********************************************
*/

/******************************** 基本命令集 Basic command set **************************/
/* 復位SD 卡 Reset cards to idle state */
#define CMD0 0
#define CMD0_R R1

/* 讀OCR寄存器 Read the OCR (MMC mode, do not use for SD cards) */
#define CMD1 1
#define CMD1_R R1

/* 讀CSD寄存器 Card sends the CSD */
#define CMD9 9
#define CMD9_R R1

/* 讀CID寄存器 Card sends CID */
#define CMD10 10
#define CMD10_R R1

/* 停止讀多塊時的數據傳輸 Stop a multiple block (stream) read/write operation */
#define CMD12 12
#define CMD12_R R1B

/* 讀 Card_Status 寄存器 Get the addressed card's status register */
#define CMD13 13
#define CMD13_R R2

/***************************** 塊讀命令集 Block read commands **************************/

/* 設置塊的長度 Set the block length */
#define CMD16 16
#define CMD16_R R1

/* 讀單塊 Read a single block */
#define CMD17 17
#define CMD17_R R1

/* 讀多塊,直至主機發送CMD12為止 Read multiple blocks until a CMD12 */
#define CMD18 18
#define CMD18_R R1

/***************************** 塊寫命令集 Block write commands *************************/
/* 寫單塊 Write a block of the size selected with CMD16 */
#define CMD24 24
#define CMD24_R R1

/* 寫多塊 Multiple block write until a CMD12 */
#define CMD25 25
#define CMD25_R R1

/* 寫CSD寄存器 Program the programmable bits of the CSD */
#define CMD27 27
#define CMD27_R R1

/***************************** 寫保護 Write protection *****************************/
/* Set the write protection bit of the addressed group */
#define CMD28 28
#define CMD28_R R1B

/* Clear the write protection bit of the addressed group */
#define CMD29 29
#define CMD29_R R1B

/* Ask the card for the status of the write protection bits */
#define CMD30 30
#define CMD30_R R1

/***************************** 擦除命令 Erase commands *******************************/
/* 設置擦除塊的起始地址(只用于SD卡) Set the address of the first write block to be erased(only for SD) */
#define CMD32 32
#define CMD32_R R1

/* 設置擦除塊的終止地址(只用于SD卡) Set the address of the last write block to be erased(only for SD) */
#define CMD33 33
#define CMD33_R R1

/* 設置擦除塊的起始地址(只用于MMC卡) Set the address of the first write block to be erased(only for MMC) */
#define CMD35 35
#define CMD35_R R1

/* 設置擦除塊的終止地址(只用于MMC卡) Set the address of the last write block to be erased(only for MMC) */
#define CMD36 36
#define CMD36_R R1

/* 擦除所選擇的塊 Erase the selected write blocks */
#define CMD38 38
#define CMD38_R R1B

/***************************** 鎖卡命令 Lock Card commands ***************************/
/* 設置/復位密碼或上鎖/解鎖卡 Set/reset the password or lock/unlock the card */
#define CMD42 42
#define CMD42_R	R1B
/* Commands from 42 to 54, not defined here */

/***************************** 應用命令 Application-specific commands ****************/
/* 禁止下一個命令為應用命令  Flag that the next command is application-specific */
#define CMD55 55
#define CMD55_R R1

/* 應用命令的通用I/O  General purpose I/O for application-specific commands */
#define CMD56 56
#define CMD56_R R1

/* 讀OCR寄存器  Read the OCR (SPI mode only) */
#define CMD58 58
#define CMD58_R R3

/* 使能或禁止 CRC Turn CRC on or off */
#define CMD59 59
#define CMD59_R R1

/***************************** 應用命令 Application-specific commands ***************/
/* 獲取 SD Status寄存器 Get the SD card's status */
#define ACMD13 13
#define ACMD13_R R2

/* 得到已寫入卡中的塊的個數 Get the number of written write blocks (Minus errors ) */
#define ACMD22 22
#define ACMD22_R R1

/* 在寫之前,設置預先擦除的塊的個數 Set the number of write blocks to be pre-erased before writing */
#define ACMD23 23
#define ACMD23_R R1

/* 讀取OCR寄存器 Get the card's OCR (SD mode) */
#define ACMD41 41
#define ACMD41_R R1

/* 連接/斷開CD/DATA[3]引腳上的上拉電阻 Connect or disconnect the 50kOhm internal pull-up on CD/DAT[3] */
#define ACMD42 42
#define ACMD42_R R1

/* 讀取SCR寄存器 Get the SD configuration register */
#define ACMD51 51
#define ACMD51_R R1



extern INT8U SD_SendCmd(INT8U cmd, INT8U *param, INT8U resptype, INT8U *resp);  // 一個SPI命令   a SPI command
extern void SD_PackParam(INT8U *parameter, INT32U value);						// 封裝參數	  	 pack the parameter
extern INT8U SD_BlockCommand(INT8U cmd, INT8U resptype, INT32U parameter);		// 塊命令 		 block command 

	
extern INT8U SD_ResetSD(void);											// 復位SD卡			reset SD Card

extern INT8U SD_ReadCSD(INT8U csdlen, INT8U *recbuf);					// 讀CSD 			read CSD register
extern INT8U SD_ReadCID(INT8U cidlen, INT8U *recbuf);					// 讀CID			read CID register
extern INT8U SD_StopTransmission(void);									// 停止傳輸			stop transmission

extern INT8U SD_ReadCard_Status(INT8U len, INT8U *buffer);				// 讀Card Status	read Card Status register
extern INT8U SD_SetBlockLen(INT32U length);								// 設置塊長度		set block length

extern INT8U SD_ReadSingleBlock(INT32U blockaddr);						// 讀單塊			read a single block
extern INT8U SD_ReadMultipleBlock(INT32U blockaddr);					// 讀多塊			read multiple block

extern INT8U SD_WriteSingleBlock(INT32U blockaddr);						// 寫單塊			write a single block
extern INT8U SD_WriteMultipleBlock(INT32U blockaddr);					// 寫多塊 			write multiple block


extern INT8U SD_ProgramCSD(INT8U len, INT8U *buff);						// 寫CSD寄存器  	write CSD register 

extern INT8U SD_EraseStartBlock(INT32U startblock);						// 擦塊起始地址		erase start address
extern INT8U SD_EraseEndBlock(INT32U endblock);							// 擦塊終止地址		erase end address
extern INT8U SD_EraseSelectedBlock(void);								// 擦除所選的塊		erase selected address


extern INT8U SD_ReadOCR(INT8U ocrlen,INT8U *recbuf);					// 讀OCR			read OCR register
extern INT8U SD_EnableCRC(INT8U bEnable);								// 使能CRC校驗		enable CRC


// 特殊應用命令
extern INT8U SD_ReadSD_Status(INT8U sdslen, INT8U *recbuf);				// 讀SD_Status		read SD_Status 
extern INT8U SD_GetNumWRBlcoks(INT32U *blocknum);						// 得到正確寫入塊數 get block numbers that writed well
extern INT8U SD_ReadSCR(INT8U scrlen, INT8U *recbuf);					// 讀SCR 			read SCR register


// 數據流函數
extern INT8U SD_ReadRegister(INT32U len, INT8U *recbuf);						// 讀寄存器  read register 
extern INT8U SD_ReadBlockData(INT32U len, INT8U *recbuf);						// 讀塊數據	 read block data 
extern INT8U SD_WriteBlockData(INT8U bmulti, INT32U len, INT8U *sendbuf);		// 寫塊數據	 write block data

// 其它函數
extern void SD_StopMultiToken(void);									// 停止多塊寫令牌	 stop token when write multiple block
extern INT8U SD_WaitBusy(INT8U waittype);								// 忙				 busy
extern void SD_SPIDelay(INT8U value);									// 發生SPI時鐘		 send SPI clock


#endif