[mirror_edk2.git] / EmbeddedPkg / Universal / MmcDxe / Mmc.h

/** @file\r
  Main Header file for the MMC DXE driver\r
\r
  Copyright (c) 2011-2015, ARM Limited. All rights reserved.\r
\r
  This program and the accompanying materials\r
  are licensed and made available under the terms and conditions of the BSD License\r
  which accompanies this distribution.  The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.php\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#ifndef __MMC_H\r
#define __MMC_H\r
\r
#include <Uefi.h>\r
\r
#include <Protocol/DiskIo.h>\r
#include <Protocol/BlockIo.h>\r
#include <Protocol/DevicePath.h>\r
#include <Protocol/MmcHost.h>\r
\r
#include <Library/UefiLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
\r
#define MMC_TRACE(txt)  DEBUG((EFI_D_BLKIO, "MMC: " txt "\n"))\r
\r
#define MMC_IOBLOCKS_READ       0\r
#define MMC_IOBLOCKS_WRITE      1\r
\r
#define MMC_OCR_POWERUP             0x80000000\r
\r
#define MMC_CSD_GET_CCC(Response)    (Response[2] >> 20)\r
#define MMC_CSD_GET_TRANSPEED(Response)    (Response[3] & 0xFF)\r
#define MMC_CSD_GET_READBLLEN(Response)    ((Response[2] >> 16) & 0xF)\r
#define MMC_CSD_GET_WRITEBLLEN(Response)  ((Response[0] >> 22) & 0xF)\r
#define MMC_CSD_GET_FILEFORMAT(Response)  ((Response[0] >> 10) & 0x3)\r
#define MMC_CSD_GET_FILEFORMATGRP(Response)  ((Response[0] >> 15) & 0x1)\r
#define MMC_CSD_GET_DEVICESIZE(csd)         (((Response[1] >> 30) & 0x3) | ((Response[2] & 0x3FF) << 2))\r
#define HC_MMC_CSD_GET_DEVICESIZE(Response)    ((Response[1] >> 16) | ((Response[2] & 0x40) << 16));\r
#define MMC_CSD_GET_DEVICESIZEMULT(csd)     ((Response[1] >> 15) & 0x7)\r
\r
#define MMC_R0_READY_FOR_DATA               (1 << 8)\r
\r
#define MMC_R0_CURRENTSTATE(Response)       ((Response[0] >> 9) & 0xF)\r
\r
#define MMC_R0_STATE_IDLE       0\r
#define MMC_R0_STATE_READY      1\r
#define MMC_R0_STATE_IDENT      2\r
#define MMC_R0_STATE_STDBY      3\r
#define MMC_R0_STATE_TRAN       4\r
#define MMC_R0_STATE_DATA       5\r
\r
typedef enum {\r
  UNKNOWN_CARD,\r
  MMC_CARD,              //MMC card\r
  MMC_CARD_HIGH,         //MMC Card with High capacity\r
  EMMC_CARD,             //eMMC 4.41 card\r
  SD_CARD,               //SD 1.1 card\r
  SD_CARD_2,             //SD 2.0 or above standard card\r
  SD_CARD_2_HIGH         //SD 2.0 or above high capacity card\r
} CARD_TYPE;\r
\r
typedef struct {\r
  UINT32  Reserved0:   7; // 0\r
  UINT32  V170_V195:   1; // 1.70V - 1.95V\r
  UINT32  V200_V260:   7; // 2.00V - 2.60V\r
  UINT32  V270_V360:   9; // 2.70V - 3.60V\r
  UINT32  RESERVED_1:  5; // Reserved\r
  UINT32  AccessMode:  2; // 00b (byte mode), 10b (sector mode)\r
  UINT32  PowerUp:     1; // This bit is set to LOW if the card has not finished the power up routine\r
} OCR;\r
\r
typedef struct {\r
  UINT32  NOT_USED;   // 1 [0:0]\r
  UINT32  CRC;        // CRC7 checksum [7:1]\r
  UINT32  MDT;        // Manufacturing date [19:8]\r
  UINT32  RESERVED_1; // Reserved [23:20]\r
  UINT32  PSN;        // Product serial number [55:24]\r
  UINT8   PRV;        // Product revision [63:56]\r
  UINT8   PNM[5];     // Product name [64:103]\r
  UINT16  OID;        // OEM/Application ID [119:104]\r
  UINT8   MID;        // Manufacturer ID [127:120]\r
} CID;\r
\r
typedef struct {\r
  UINT8   NOT_USED:           1; // Not used, always 1 [0:0]\r
  UINT8   CRC:                7; // CRC [7:1]\r
\r
  UINT8   RESERVED_1:         2; // Reserved [9:8]\r
  UINT8   FILE_FORMAT:        2; // File format [11:10]\r
  UINT8   TMP_WRITE_PROTECT:  1; // Temporary write protection [12:12]\r
  UINT8   PERM_WRITE_PROTECT: 1; // Permanent write protection [13:13]\r
  UINT8   COPY:               1; // Copy flag (OTP) [14:14]\r
  UINT8   FILE_FORMAT_GRP:    1; // File format group [15:15]\r
\r
  UINT16  RESERVED_2:         5; // Reserved [20:16]\r
  UINT16  WRITE_BL_PARTIAL:   1; // Partial blocks for write allowed [21:21]\r
  UINT16  WRITE_BL_LEN:       4; // Max. write data block length [25:22]\r
  UINT16  R2W_FACTOR:         3; // Write speed factor [28:26]\r
  UINT16  RESERVED_3:         2; // Reserved [30:29]\r
  UINT16  WP_GRP_ENABLE:      1; // Write protect group enable [31:31]\r
\r
  UINT32  WP_GRP_SIZE:        7; // Write protect group size [38:32]\r
  UINT32  SECTOR_SIZE:        7; // Erase sector size [45:39]\r
  UINT32  ERASE_BLK_EN:       1; // Erase single block enable [46:46]\r
  UINT32  C_SIZE_MULT:        3; // Device size multiplier [49:47]\r
  UINT32  VDD_W_CURR_MAX:     3; // Max. write current @ VDD max [52:50]\r
  UINT32  VDD_W_CURR_MIN:     3; // Max. write current @ VDD min [55:53]\r
  UINT32  VDD_R_CURR_MAX:     3; // Max. read current @ VDD max [58:56]\r
  UINT32  VDD_R_CURR_MIN:     3; // Max. read current @ VDD min [61:59]\r
  UINT32  C_SIZELow2:         2; // Device size [63:62]\r
\r
  UINT32  C_SIZEHigh10:       10;// Device size [73:64]\r
  UINT32  RESERVED_4:         2; // Reserved [75:74]\r
  UINT32  DSR_IMP:            1; // DSR implemented [76:76]\r
  UINT32  READ_BLK_MISALIGN:  1; // Read block misalignment [77:77]\r
  UINT32  WRITE_BLK_MISALIGN: 1; // Write block misalignment [78:78]\r
  UINT32  READ_BL_PARTIAL:    1; // Partial blocks for read allowed [79:79]\r
  UINT32  READ_BL_LEN:        4; // Max. read data block length [83:80]\r
  UINT32  CCC:                12;// Card command classes [95:84]\r
\r
  UINT8   TRAN_SPEED          ;  // Max. bus clock frequency [103:96]\r
  UINT8   NSAC                ;  // Data read access-time 2 in CLK cycles (NSAC*100) [111:104]\r
  UINT8   TAAC                ;  // Data read access-time 1 [119:112]\r
\r
  UINT8   RESERVED_5:         6; // Reserved [125:120]\r
  UINT8   CSD_STRUCTURE:      2; // CSD structure [127:126]\r
} CSD;\r
\r
typedef struct  {\r
  UINT16    RCA;\r
  CARD_TYPE CardType;\r
  OCR       OCRData;\r
  CID       CIDData;\r
  CSD       CSDData;\r
} CARD_INFO;\r
\r
typedef struct _MMC_HOST_INSTANCE {\r
  UINTN                     Signature;\r
  LIST_ENTRY                Link;\r
  EFI_HANDLE                MmcHandle;\r
  EFI_DEVICE_PATH_PROTOCOL  *DevicePath;\r
\r
  MMC_STATE                 State;\r
  EFI_BLOCK_IO_PROTOCOL     BlockIo;\r
  CARD_INFO                 CardInfo;\r
  EFI_MMC_HOST_PROTOCOL     *MmcHost;\r
\r
  BOOLEAN                   Initialized;\r
} MMC_HOST_INSTANCE;\r
\r
#define MMC_HOST_INSTANCE_SIGNATURE                 SIGNATURE_32('m', 'm', 'c', 'h')\r
#define MMC_HOST_INSTANCE_FROM_BLOCK_IO_THIS(a)     CR (a, MMC_HOST_INSTANCE, BlockIo, MMC_HOST_INSTANCE_SIGNATURE)\r
#define MMC_HOST_INSTANCE_FROM_LINK(a)              CR (a, MMC_HOST_INSTANCE, Link, MMC_HOST_INSTANCE_SIGNATURE)\r
\r
\r
EFI_STATUS\r
EFIAPI\r
MmcGetDriverName (\r
  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,\r
  IN  CHAR8                        *Language,\r
  OUT CHAR16                       **DriverName\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
MmcGetControllerName (\r
  IN  EFI_COMPONENT_NAME_PROTOCOL                     *This,\r
  IN  EFI_HANDLE                                      ControllerHandle,\r
  IN  EFI_HANDLE                                      ChildHandle        OPTIONAL,\r
  IN  CHAR8                                           *Language,\r
  OUT CHAR16                                          **ControllerName\r
  );\r
\r
extern EFI_COMPONENT_NAME_PROTOCOL  gMmcComponentName;\r
extern EFI_COMPONENT_NAME2_PROTOCOL gMmcComponentName2;\r
\r
extern EFI_DRIVER_DIAGNOSTICS2_PROTOCOL gMmcDriverDiagnostics2;\r
\r
extern LIST_ENTRY mMmcHostPool;\r
\r
/**\r
  Reset the block device.\r
\r
  This function implements EFI_BLOCK_IO_PROTOCOL.Reset().\r
  It resets the block device hardware.\r
  ExtendedVerification is ignored in this implementation.\r
\r
  @param  This                   Indicates a pointer to the calling context.\r
  @param  ExtendedVerification   Indicates that the driver may perform a more exhaustive\r
                                 verification operation of the device during reset.\r
\r
  @retval EFI_SUCCESS            The block device was reset.\r
  @retval EFI_DEVICE_ERROR       The block device is not functioning correctly and could not be reset.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
MmcReset (\r
  IN EFI_BLOCK_IO_PROTOCOL    *This,\r
  IN BOOLEAN                  ExtendedVerification\r
  );\r
\r
/**\r
  Reads the requested number of blocks from the device.\r
\r
  This function implements EFI_BLOCK_IO_PROTOCOL.ReadBlocks().\r
  It reads the requested number of blocks from the device.\r
  All the blocks are read, or an error is returned.\r
\r
  @param  This                   Indicates a pointer to the calling context.\r
  @param  MediaId                The media ID that the read request is for.\r
  @param  Lba                    The starting logical block address to read from on the device.\r
  @param  BufferSize             The size of the Buffer in bytes.\r
                                 This must be a multiple of the intrinsic block size of the device.\r
  @param  Buffer                 A pointer to the destination buffer for the data. The caller is\r
                                 responsible for either having implicit or explicit ownership of the buffer.\r
\r
  @retval EFI_SUCCESS            The data was read correctly from the device.\r
  @retval EFI_DEVICE_ERROR       The device reported an error while attempting to perform the read operation.\r
  @retval EFI_NO_MEDIA           There is no media in the device.\r
  @retval EFI_MEDIA_CHANGED      The MediaId is not for the current media.\r
  @retval EFI_BAD_BUFFER_SIZE    The BufferSize parameter is not a multiple of the intrinsic block size of the device.\r
  @retval EFI_INVALID_PARAMETER  The read request contains LBAs that are not valid,\r
                                 or the buffer is not on proper alignment.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
MmcReadBlocks (\r
  IN EFI_BLOCK_IO_PROTOCOL    *This,\r
  IN UINT32                   MediaId,\r
  IN EFI_LBA                  Lba,\r
  IN UINTN                    BufferSize,\r
  OUT VOID                    *Buffer\r
  );\r
\r
/**\r
  Writes a specified number of blocks to the device.\r
\r
  This function implements EFI_BLOCK_IO_PROTOCOL.WriteBlocks().\r
  It writes a specified number of blocks to the device.\r
  All blocks are written, or an error is returned.\r
\r
  @param  This                   Indicates a pointer to the calling context.\r
  @param  MediaId                The media ID that the write request is for.\r
  @param  Lba                    The starting logical block address to be written.\r
  @param  BufferSize             The size of the Buffer in bytes.\r
                                 This must be a multiple of the intrinsic block size of the device.\r
  @param  Buffer                 Pointer to the source buffer for the data.\r
\r
  @retval EFI_SUCCESS            The data were written correctly to the device.\r
  @retval EFI_WRITE_PROTECTED    The device cannot be written to.\r
  @retval EFI_NO_MEDIA           There is no media in the device.\r
  @retval EFI_MEDIA_CHANGED      The MediaId is not for the current media.\r
  @retval EFI_DEVICE_ERROR       The device reported an error while attempting to perform the write operation.\r
  @retval EFI_BAD_BUFFER_SIZE    The BufferSize parameter is not a multiple of the intrinsic\r
                                 block size of the device.\r
  @retval EFI_INVALID_PARAMETER  The write request contains LBAs that are not valid,\r
                                 or the buffer is not on proper alignment.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
MmcWriteBlocks (\r
  IN EFI_BLOCK_IO_PROTOCOL    *This,\r
  IN UINT32                   MediaId,\r
  IN EFI_LBA                  Lba,\r
  IN UINTN                    BufferSize,\r
  IN VOID                     *Buffer\r
  );\r
\r
/**\r
  Flushes all modified data to a physical block device.\r
\r
  @param  This                   Indicates a pointer to the calling context.\r
\r
  @retval EFI_SUCCESS            All outstanding data were written correctly to the device.\r
  @retval EFI_DEVICE_ERROR       The device reported an error while attempting to write data.\r
  @retval EFI_NO_MEDIA           There is no media in the device.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
MmcFlushBlocks (\r
  IN EFI_BLOCK_IO_PROTOCOL  *This\r
  );\r
\r
EFI_STATUS\r
MmcNotifyState (\r
  IN MMC_HOST_INSTANCE      *MmcHostInstance,\r
  IN MMC_STATE               State\r
  );\r
\r
EFI_STATUS\r
InitializeMmcDevice (\r
  IN  MMC_HOST_INSTANCE     *MmcHost\r
  );\r
\r
VOID\r
EFIAPI\r
CheckCardsCallback (\r
  IN  EFI_EVENT   Event,\r
  IN  VOID        *Context\r
  );\r
\r
VOID\r
PrintCSD (\r
  IN UINT32* Csd\r
  );\r
\r
VOID\r
PrintRCA (\r
  IN UINT32 Rca\r
  );\r
\r
VOID\r
PrintOCR (\r
  IN UINT32 Ocr\r
  );\r
\r
VOID\r
PrintResponseR1 (\r
  IN  UINT32 Response\r
  );\r
\r
VOID\r
PrintCID (\r
  IN UINT32* Cid\r
  );\r
\r
#endif\r
Commit	Line	Data
1bfda055	1	/** @file\r
	2	Main Header file for the MMC DXE driver\r
	3	\r
eff98cf9	4	Copyright (c) 2011-2015, ARM Limited. All rights reserved.\r
1bfda055	5	\r
3402aac7 RC	6	This program and the accompanying materials\r
	7	are licensed and made available under the terms and conditions of the BSD License\r
	8	which accompanies this distribution. The full text of the license may be found at\r
	9	http://opensource.org/licenses/bsd-license.php\r
	10	\r
	11	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	12	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
1bfda055	13	\r
	14	**/\r
	15	\r
	16	#ifndef __MMC_H\r
	17	#define __MMC_H\r
	18	\r
a1ab9143	19	#include <Uefi.h>\r
a1ab9143	20	\r
1bfda055	21	#include <Protocol/DiskIo.h>\r
	22	#include <Protocol/BlockIo.h>\r
	23	#include <Protocol/DevicePath.h>\r
	24	#include <Protocol/MmcHost.h>\r
	25	\r
	26	#include <Library/UefiLib.h>\r
4ca3c688	27	#include <Library/DebugLib.h>\r
eff98cf9	28	#include <Library/UefiBootServicesTableLib.h>\r
1bfda055	29	\r
	30	#define MMC_TRACE(txt) DEBUG((EFI_D_BLKIO, "MMC: " txt "\n"))\r
	31	\r
	32	#define MMC_IOBLOCKS_READ 0\r
	33	#define MMC_IOBLOCKS_WRITE 1\r
	34	\r
	35	#define MMC_OCR_POWERUP 0x80000000\r
	36	\r
bb0f9e9b	37	#define MMC_CSD_GET_CCC(Response) (Response[2] >> 20)\r
	38	#define MMC_CSD_GET_TRANSPEED(Response) (Response[3] & 0xFF)\r
	39	#define MMC_CSD_GET_READBLLEN(Response) ((Response[2] >> 16) & 0xF)\r
	40	#define MMC_CSD_GET_WRITEBLLEN(Response) ((Response[0] >> 22) & 0xF)\r
	41	#define MMC_CSD_GET_FILEFORMAT(Response) ((Response[0] >> 10) & 0x3)\r
	42	#define MMC_CSD_GET_FILEFORMATGRP(Response) ((Response[0] >> 15) & 0x1)\r
	43	#define MMC_CSD_GET_DEVICESIZE(csd) (((Response[1] >> 30) & 0x3) \| ((Response[2] & 0x3FF) << 2))\r
36aa5611	44	#define HC_MMC_CSD_GET_DEVICESIZE(Response) ((Response[1] >> 16) \| ((Response[2] & 0x40) << 16));\r
bb0f9e9b	45	#define MMC_CSD_GET_DEVICESIZEMULT(csd) ((Response[1] >> 15) & 0x7)\r
1bfda055	46	\r
b9d5fe03	47	#define MMC_R0_READY_FOR_DATA (1 << 8)\r
b9d5fe03	48	\r
1bfda055	49	#define MMC_R0_CURRENTSTATE(Response) ((Response[0] >> 9) & 0xF)\r
	50	\r
	51	#define MMC_R0_STATE_IDLE 0\r
	52	#define MMC_R0_STATE_READY 1\r
	53	#define MMC_R0_STATE_IDENT 2\r
	54	#define MMC_R0_STATE_STDBY 3\r
	55	#define MMC_R0_STATE_TRAN 4\r
	56	#define MMC_R0_STATE_DATA 5\r
	57	\r
	58	typedef enum {\r
	59	UNKNOWN_CARD,\r
	60	MMC_CARD, //MMC card\r
	61	MMC_CARD_HIGH, //MMC Card with High capacity\r
b4fdedc2	62	EMMC_CARD, //eMMC 4.41 card\r
1bfda055	63	SD_CARD, //SD 1.1 card\r
	64	SD_CARD_2, //SD 2.0 or above standard card\r
	65	SD_CARD_2_HIGH //SD 2.0 or above high capacity card\r
	66	} CARD_TYPE;\r
	67	\r
	68	typedef struct {\r
3402aac7	69	UINT32 Reserved0: 7; // 0\r
1bfda055	70	UINT32 V170_V195: 1; // 1.70V - 1.95V\r
	71	UINT32 V200_V260: 7; // 2.00V - 2.60V\r
	72	UINT32 V270_V360: 9; // 2.70V - 3.60V\r
	73	UINT32 RESERVED_1: 5; // Reserved\r
3402aac7	74	UINT32 AccessMode: 2; // 00b (byte mode), 10b (sector mode)\r
492e34a5	75	UINT32 PowerUp: 1; // This bit is set to LOW if the card has not finished the power up routine\r
1bfda055	76	} OCR;\r
	77	\r
	78	typedef struct {\r
	79	UINT32 NOT_USED; // 1 [0:0]\r
	80	UINT32 CRC; // CRC7 checksum [7:1]\r
	81	UINT32 MDT; // Manufacturing date [19:8]\r
	82	UINT32 RESERVED_1; // Reserved [23:20]\r
	83	UINT32 PSN; // Product serial number [55:24]\r
	84	UINT8 PRV; // Product revision [63:56]\r
	85	UINT8 PNM[5]; // Product name [64:103]\r
	86	UINT16 OID; // OEM/Application ID [119:104]\r
	87	UINT8 MID; // Manufacturer ID [127:120]\r
	88	} CID;\r
	89	\r
	90	typedef struct {\r
	91	UINT8 NOT_USED: 1; // Not used, always 1 [0:0]\r
	92	UINT8 CRC: 7; // CRC [7:1]\r
	93	\r
	94	UINT8 RESERVED_1: 2; // Reserved [9:8]\r
	95	UINT8 FILE_FORMAT: 2; // File format [11:10]\r
	96	UINT8 TMP_WRITE_PROTECT: 1; // Temporary write protection [12:12]\r
	97	UINT8 PERM_WRITE_PROTECT: 1; // Permanent write protection [13:13]\r
	98	UINT8 COPY: 1; // Copy flag (OTP) [14:14]\r
	99	UINT8 FILE_FORMAT_GRP: 1; // File format group [15:15]\r
3402aac7	100	\r
1bfda055	101	UINT16 RESERVED_2: 5; // Reserved [20:16]\r
	102	UINT16 WRITE_BL_PARTIAL: 1; // Partial blocks for write allowed [21:21]\r
	103	UINT16 WRITE_BL_LEN: 4; // Max. write data block length [25:22]\r
	104	UINT16 R2W_FACTOR: 3; // Write speed factor [28:26]\r
	105	UINT16 RESERVED_3: 2; // Reserved [30:29]\r
	106	UINT16 WP_GRP_ENABLE: 1; // Write protect group enable [31:31]\r
3402aac7	107	\r
1bfda055	108	UINT32 WP_GRP_SIZE: 7; // Write protect group size [38:32]\r
	109	UINT32 SECTOR_SIZE: 7; // Erase sector size [45:39]\r
	110	UINT32 ERASE_BLK_EN: 1; // Erase single block enable [46:46]\r
	111	UINT32 C_SIZE_MULT: 3; // Device size multiplier [49:47]\r
	112	UINT32 VDD_W_CURR_MAX: 3; // Max. write current @ VDD max [52:50]\r
	113	UINT32 VDD_W_CURR_MIN: 3; // Max. write current @ VDD min [55:53]\r
	114	UINT32 VDD_R_CURR_MAX: 3; // Max. read current @ VDD max [58:56]\r
	115	UINT32 VDD_R_CURR_MIN: 3; // Max. read current @ VDD min [61:59]\r
	116	UINT32 C_SIZELow2: 2; // Device size [63:62]\r
3402aac7	117	\r
1bfda055	118	UINT32 C_SIZEHigh10: 10;// Device size [73:64]\r
	119	UINT32 RESERVED_4: 2; // Reserved [75:74]\r
	120	UINT32 DSR_IMP: 1; // DSR implemented [76:76]\r
	121	UINT32 READ_BLK_MISALIGN: 1; // Read block misalignment [77:77]\r
	122	UINT32 WRITE_BLK_MISALIGN: 1; // Write block misalignment [78:78]\r
	123	UINT32 READ_BL_PARTIAL: 1; // Partial blocks for read allowed [79:79]\r
	124	UINT32 READ_BL_LEN: 4; // Max. read data block length [83:80]\r
	125	UINT32 CCC: 12;// Card command classes [95:84]\r
	126	\r
	127	UINT8 TRAN_SPEED ; // Max. bus clock frequency [103:96]\r
	128	UINT8 NSAC ; // Data read access-time 2 in CLK cycles (NSAC*100) [111:104]\r
	129	UINT8 TAAC ; // Data read access-time 1 [119:112]\r
3402aac7	130	\r
1bfda055	131	UINT8 RESERVED_5: 6; // Reserved [125:120]\r
	132	UINT8 CSD_STRUCTURE: 2; // CSD structure [127:126]\r
	133	} CSD;\r
	134	\r
	135	typedef struct {\r
	136	UINT16 RCA;\r
	137	CARD_TYPE CardType;\r
	138	OCR OCRData;\r
	139	CID CIDData;\r
	140	CSD CSDData;\r
	141	} CARD_INFO;\r
	142	\r
	143	typedef struct _MMC_HOST_INSTANCE {\r
	144	UINTN Signature;\r
	145	LIST_ENTRY Link;\r
	146	EFI_HANDLE MmcHandle;\r
	147	EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
	148	\r
	149	MMC_STATE State;\r
	150	EFI_BLOCK_IO_PROTOCOL BlockIo;\r
	151	CARD_INFO CardInfo;\r
	152	EFI_MMC_HOST_PROTOCOL *MmcHost;\r
3402aac7	153	\r
3de99375	154	BOOLEAN Initialized;\r
1bfda055	155	} MMC_HOST_INSTANCE;\r
	156	\r
	157	#define MMC_HOST_INSTANCE_SIGNATURE SIGNATURE_32('m', 'm', 'c', 'h')\r
	158	#define MMC_HOST_INSTANCE_FROM_BLOCK_IO_THIS(a) CR (a, MMC_HOST_INSTANCE, BlockIo, MMC_HOST_INSTANCE_SIGNATURE)\r
	159	#define MMC_HOST_INSTANCE_FROM_LINK(a) CR (a, MMC_HOST_INSTANCE, Link, MMC_HOST_INSTANCE_SIGNATURE)\r
	160	\r
	161	\r
	162	EFI_STATUS\r
	163	EFIAPI\r
	164	MmcGetDriverName (\r
	165	IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
	166	IN CHAR8 *Language,\r
	167	OUT CHAR16 **DriverName\r
	168	);\r
	169	\r
	170	EFI_STATUS\r
	171	EFIAPI\r
	172	MmcGetControllerName (\r
	173	IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
	174	IN EFI_HANDLE ControllerHandle,\r
	175	IN EFI_HANDLE ChildHandle OPTIONAL,\r
	176	IN CHAR8 *Language,\r
	177	OUT CHAR16 **ControllerName\r
	178	);\r
	179	\r
	180	extern EFI_COMPONENT_NAME_PROTOCOL gMmcComponentName;\r
	181	extern EFI_COMPONENT_NAME2_PROTOCOL gMmcComponentName2;\r
	182	\r
	183	extern EFI_DRIVER_DIAGNOSTICS2_PROTOCOL gMmcDriverDiagnostics2;\r
	184	\r
	185	extern LIST_ENTRY mMmcHostPool;\r
	186	\r
	187	/**\r
	188	Reset the block device.\r
	189	\r
3402aac7	190	This function implements EFI_BLOCK_IO_PROTOCOL.Reset().\r
1bfda055	191	It resets the block device hardware.\r
	192	ExtendedVerification is ignored in this implementation.\r
	193	\r
	194	@param This Indicates a pointer to the calling context.\r
	195	@param ExtendedVerification Indicates that the driver may perform a more exhaustive\r
	196	verification operation of the device during reset.\r
	197	\r
	198	@retval EFI_SUCCESS The block device was reset.\r
	199	@retval EFI_DEVICE_ERROR The block device is not functioning correctly and could not be reset.\r
	200	\r
	201	**/\r
	202	EFI_STATUS\r
	203	EFIAPI\r
	204	MmcReset (\r
	205	IN EFI_BLOCK_IO_PROTOCOL *This,\r
	206	IN BOOLEAN ExtendedVerification\r
	207	);\r
	208	\r
	209	/**\r
	210	Reads the requested number of blocks from the device.\r
	211	\r
3402aac7	212	This function implements EFI_BLOCK_IO_PROTOCOL.ReadBlocks().\r
1bfda055	213	It reads the requested number of blocks from the device.\r
	214	All the blocks are read, or an error is returned.\r
	215	\r
	216	@param This Indicates a pointer to the calling context.\r
	217	@param MediaId The media ID that the read request is for.\r
	218	@param Lba The starting logical block address to read from on the device.\r
	219	@param BufferSize The size of the Buffer in bytes.\r
	220	This must be a multiple of the intrinsic block size of the device.\r
	221	@param Buffer A pointer to the destination buffer for the data. The caller is\r
	222	responsible for either having implicit or explicit ownership of the buffer.\r
	223	\r
	224	@retval EFI_SUCCESS The data was read correctly from the device.\r
	225	@retval EFI_DEVICE_ERROR The device reported an error while attempting to perform the read operation.\r
	226	@retval EFI_NO_MEDIA There is no media in the device.\r
	227	@retval EFI_MEDIA_CHANGED The MediaId is not for the current media.\r
	228	@retval EFI_BAD_BUFFER_SIZE The BufferSize parameter is not a multiple of the intrinsic block size of the device.\r
	229	@retval EFI_INVALID_PARAMETER The read request contains LBAs that are not valid,\r
	230	or the buffer is not on proper alignment.\r
	231	\r
	232	**/\r
	233	EFI_STATUS\r
	234	EFIAPI\r
	235	MmcReadBlocks (\r
	236	IN EFI_BLOCK_IO_PROTOCOL *This,\r
	237	IN UINT32 MediaId,\r
	238	IN EFI_LBA Lba,\r
	239	IN UINTN BufferSize,\r
	240	OUT VOID *Buffer\r
	241	);\r
	242	\r
	243	/**\r
	244	Writes a specified number of blocks to the device.\r
	245	\r
3402aac7	246	This function implements EFI_BLOCK_IO_PROTOCOL.WriteBlocks().\r
1bfda055	247	It writes a specified number of blocks to the device.\r
	248	All blocks are written, or an error is returned.\r
	249	\r
	250	@param This Indicates a pointer to the calling context.\r
	251	@param MediaId The media ID that the write request is for.\r
	252	@param Lba The starting logical block address to be written.\r
	253	@param BufferSize The size of the Buffer in bytes.\r
	254	This must be a multiple of the intrinsic block size of the device.\r
	255	@param Buffer Pointer to the source buffer for the data.\r
	256	\r
	257	@retval EFI_SUCCESS The data were written correctly to the device.\r
	258	@retval EFI_WRITE_PROTECTED The device cannot be written to.\r
	259	@retval EFI_NO_MEDIA There is no media in the device.\r
	260	@retval EFI_MEDIA_CHANGED The MediaId is not for the current media.\r
	261	@retval EFI_DEVICE_ERROR The device reported an error while attempting to perform the write operation.\r
	262	@retval EFI_BAD_BUFFER_SIZE The BufferSize parameter is not a multiple of the intrinsic\r
	263	block size of the device.\r
	264	@retval EFI_INVALID_PARAMETER The write request contains LBAs that are not valid,\r
	265	or the buffer is not on proper alignment.\r
	266	\r
	267	**/\r
	268	EFI_STATUS\r
	269	EFIAPI\r
	270	MmcWriteBlocks (\r
	271	IN EFI_BLOCK_IO_PROTOCOL *This,\r
	272	IN UINT32 MediaId,\r
	273	IN EFI_LBA Lba,\r
	274	IN UINTN BufferSize,\r
	275	IN VOID *Buffer\r
	276	);\r
	277	\r
	278	/**\r
	279	Flushes all modified data to a physical block device.\r
	280	\r
	281	@param This Indicates a pointer to the calling context.\r
	282	\r
	283	@retval EFI_SUCCESS All outstanding data were written correctly to the device.\r
	284	@retval EFI_DEVICE_ERROR The device reported an error while attempting to write data.\r
	285	@retval EFI_NO_MEDIA There is no media in the device.\r
	286	\r
	287	**/\r
	288	EFI_STATUS\r
	289	EFIAPI\r
	290	MmcFlushBlocks (\r
	291	IN EFI_BLOCK_IO_PROTOCOL *This\r
	292	);\r
	293	\r
b4fdedc2 OM	294	EFI_STATUS\r
	295	MmcNotifyState (\r
	296	IN MMC_HOST_INSTANCE *MmcHostInstance,\r
	297	IN MMC_STATE State\r
	298	);\r
	299	\r
	300	EFI_STATUS\r
	301	InitializeMmcDevice (\r
	302	IN MMC_HOST_INSTANCE *MmcHost\r
40842a5e	303	);\r
	304	\r
	305	VOID\r
	306	EFIAPI\r
	307	CheckCardsCallback (\r
	308	IN EFI_EVENT Event,\r
	309	IN VOID *Context\r
	310	);\r
	311	\r
4ca3c688 OM	312	VOID\r
	313	PrintCSD (\r
	314	IN UINT32* Csd\r
	315	);\r
	316	\r
	317	VOID\r
	318	PrintRCA (\r
	319	IN UINT32 Rca\r
	320	);\r
	321	\r
	322	VOID\r
	323	PrintOCR (\r
	324	IN UINT32 Ocr\r
	325	);\r
	326	\r
	327	VOID\r
	328	PrintResponseR1 (\r
	329	IN UINT32 Response\r
	330	);\r
	331	\r
	332	VOID\r
	333	PrintCID (\r
	334	IN UINT32* Cid\r
	335	);\r
	336	\r
1bfda055	337	#endif\r