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

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