MmcHost.h 6.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183
  1. /** @file
  2. Definition of the MMC Host Protocol
  3. Copyright (c) 2011-2014, ARM Limited. All rights reserved.
  4. SPDX-License-Identifier: BSD-2-Clause-Patent
  5. **/
  6. #ifndef __MMC_HOST_H__
  7. #define __MMC_HOST_H__
  8. ///
  9. /// Global ID for the MMC Host Protocol
  10. ///
  11. #define EMBEDDED_MMC_HOST_PROTOCOL_GUID \
  12. { 0x3e591c00, 0x9e4a, 0x11df, {0x92, 0x44, 0x00, 0x02, 0xA5, 0xD5, 0xC5, 0x1B } }
  13. #define MMC_RESPONSE_TYPE_R1 0
  14. #define MMC_RESPONSE_TYPE_R1b 0
  15. #define MMC_RESPONSE_TYPE_R2 1
  16. #define MMC_RESPONSE_TYPE_R3 0
  17. #define MMC_RESPONSE_TYPE_R6 0
  18. #define MMC_RESPONSE_TYPE_R7 0
  19. #define MMC_RESPONSE_TYPE_OCR 0
  20. #define MMC_RESPONSE_TYPE_CID 1
  21. #define MMC_RESPONSE_TYPE_CSD 1
  22. #define MMC_RESPONSE_TYPE_RCA 0
  23. typedef UINT32 MMC_RESPONSE_TYPE;
  24. typedef UINT32 MMC_CMD;
  25. #define MMC_CMD_WAIT_RESPONSE (1 << 16)
  26. #define MMC_CMD_LONG_RESPONSE (1 << 17)
  27. #define MMC_CMD_NO_CRC_RESPONSE (1 << 18)
  28. #define SD_CMD (1 << 31)
  29. #define MMC_INDX(Index) ((Index) & 0xFFFF)
  30. #define MMC_GET_INDX(MmcCmd) ((MmcCmd) & 0xFFFF)
  31. #define MMC_CMD0 (MMC_INDX(0) | MMC_CMD_NO_CRC_RESPONSE)
  32. #define MMC_CMD1 (MMC_INDX(1) | MMC_CMD_WAIT_RESPONSE | MMC_CMD_NO_CRC_RESPONSE)
  33. #define MMC_CMD2 (MMC_INDX(2) | MMC_CMD_WAIT_RESPONSE | MMC_CMD_LONG_RESPONSE)
  34. #define MMC_CMD3 (MMC_INDX(3) | MMC_CMD_WAIT_RESPONSE)
  35. #define MMC_CMD5 (MMC_INDX(5) | MMC_CMD_WAIT_RESPONSE | MMC_CMD_NO_CRC_RESPONSE)
  36. #define MMC_CMD6 (MMC_INDX(6) | MMC_CMD_WAIT_RESPONSE)
  37. #define SD_CMD6 (MMC_INDX(6) | MMC_CMD_WAIT_RESPONSE | SD_CMD)
  38. #define MMC_CMD7 (MMC_INDX(7) | MMC_CMD_WAIT_RESPONSE)
  39. #define MMC_CMD8 (MMC_INDX(8) | MMC_CMD_WAIT_RESPONSE)
  40. #define MMC_CMD9 (MMC_INDX(9) | MMC_CMD_WAIT_RESPONSE | MMC_CMD_LONG_RESPONSE)
  41. #define MMC_CMD11 (MMC_INDX(11) | MMC_CMD_WAIT_RESPONSE)
  42. #define MMC_CMD12 (MMC_INDX(12) | MMC_CMD_WAIT_RESPONSE)
  43. #define MMC_CMD13 (MMC_INDX(13) | MMC_CMD_WAIT_RESPONSE)
  44. #define MMC_CMD16 (MMC_INDX(16) | MMC_CMD_WAIT_RESPONSE)
  45. #define MMC_CMD17 (MMC_INDX(17) | MMC_CMD_WAIT_RESPONSE)
  46. #define MMC_CMD18 (MMC_INDX(18) | MMC_CMD_WAIT_RESPONSE)
  47. #define MMC_CMD20 (MMC_INDX(20) | MMC_CMD_WAIT_RESPONSE)
  48. #define MMC_CMD23 (MMC_INDX(23) | MMC_CMD_WAIT_RESPONSE)
  49. #define MMC_CMD24 (MMC_INDX(24) | MMC_CMD_WAIT_RESPONSE)
  50. #define MMC_CMD25 (MMC_INDX(25) | MMC_CMD_WAIT_RESPONSE)
  51. #define MMC_CMD55 (MMC_INDX(55) | MMC_CMD_WAIT_RESPONSE)
  52. #define MMC_ACMD41 (MMC_INDX(41) | MMC_CMD_WAIT_RESPONSE | MMC_CMD_NO_CRC_RESPONSE)
  53. #define MMC_ACMD51 (MMC_INDX(51) | MMC_CMD_WAIT_RESPONSE)
  54. // Valid responses for CMD1 in eMMC
  55. #define EMMC_CMD1_CAPACITY_LESS_THAN_2GB 0x00FF8080 // Capacity <= 2GB, byte addressing used
  56. #define EMMC_CMD1_CAPACITY_GREATER_THAN_2GB 0x40FF8080 // Capacity > 2GB, 512-byte sector addressing used
  57. #define MMC_STATUS_APP_CMD (1 << 5)
  58. typedef enum _MMC_STATE {
  59. MmcInvalidState = 0,
  60. MmcHwInitializationState,
  61. MmcIdleState,
  62. MmcReadyState,
  63. MmcIdentificationState,
  64. MmcStandByState,
  65. MmcTransferState,
  66. MmcSendingDataState,
  67. MmcReceiveDataState,
  68. MmcProgrammingState,
  69. MmcDisconnectState,
  70. } MMC_STATE;
  71. #define EMMCBACKWARD (0)
  72. #define EMMCHS26 (1 << 0) // High-Speed @26MHz at rated device voltages
  73. #define EMMCHS52 (1 << 1) // High-Speed @52MHz at rated device voltages
  74. #define EMMCHS52DDR1V8 (1 << 2) // High-Speed Dual Data Rate @52MHz 1.8V or 3V I/O
  75. #define EMMCHS52DDR1V2 (1 << 3) // High-Speed Dual Data Rate @52MHz 1.2V I/O
  76. #define EMMCHS200SDR1V8 (1 << 4) // HS200 Single Data Rate @200MHz 1.8V I/O
  77. #define EMMCHS200SDR1V2 (1 << 5) // HS200 Single Data Rate @200MHz 1.2V I/O
  78. #define EMMCHS400DDR1V8 (1 << 6) // HS400 Dual Data Rate @400MHz 1.8V I/O
  79. #define EMMCHS400DDR1V2 (1 << 7) // HS400 Dual Data Rate @400MHz 1.2V I/O
  80. ///
  81. /// Forward declaration for EFI_MMC_HOST_PROTOCOL
  82. ///
  83. typedef struct _EFI_MMC_HOST_PROTOCOL EFI_MMC_HOST_PROTOCOL;
  84. typedef BOOLEAN (EFIAPI *MMC_ISCARDPRESENT)(
  85. IN EFI_MMC_HOST_PROTOCOL *This
  86. );
  87. typedef BOOLEAN (EFIAPI *MMC_ISREADONLY)(
  88. IN EFI_MMC_HOST_PROTOCOL *This
  89. );
  90. typedef EFI_STATUS (EFIAPI *MMC_BUILDDEVICEPATH)(
  91. IN EFI_MMC_HOST_PROTOCOL *This,
  92. OUT EFI_DEVICE_PATH_PROTOCOL **DevicePath
  93. );
  94. typedef EFI_STATUS (EFIAPI *MMC_NOTIFYSTATE)(
  95. IN EFI_MMC_HOST_PROTOCOL *This,
  96. IN MMC_STATE State
  97. );
  98. typedef EFI_STATUS (EFIAPI *MMC_SENDCOMMAND)(
  99. IN EFI_MMC_HOST_PROTOCOL *This,
  100. IN MMC_CMD Cmd,
  101. IN UINT32 Argument
  102. );
  103. typedef EFI_STATUS (EFIAPI *MMC_RECEIVERESPONSE)(
  104. IN EFI_MMC_HOST_PROTOCOL *This,
  105. IN MMC_RESPONSE_TYPE Type,
  106. IN UINT32 *Buffer
  107. );
  108. typedef EFI_STATUS (EFIAPI *MMC_READBLOCKDATA)(
  109. IN EFI_MMC_HOST_PROTOCOL *This,
  110. IN EFI_LBA Lba,
  111. IN UINTN Length,
  112. OUT UINT32 *Buffer
  113. );
  114. typedef EFI_STATUS (EFIAPI *MMC_WRITEBLOCKDATA)(
  115. IN EFI_MMC_HOST_PROTOCOL *This,
  116. IN EFI_LBA Lba,
  117. IN UINTN Length,
  118. IN UINT32 *Buffer
  119. );
  120. typedef EFI_STATUS (EFIAPI *MMC_SETIOS)(
  121. IN EFI_MMC_HOST_PROTOCOL *This,
  122. IN UINT32 BusClockFreq,
  123. IN UINT32 BusWidth,
  124. IN UINT32 TimingMode
  125. );
  126. typedef BOOLEAN (EFIAPI *MMC_ISMULTIBLOCK)(
  127. IN EFI_MMC_HOST_PROTOCOL *This
  128. );
  129. struct _EFI_MMC_HOST_PROTOCOL {
  130. UINT32 Revision;
  131. MMC_ISCARDPRESENT IsCardPresent;
  132. MMC_ISREADONLY IsReadOnly;
  133. MMC_BUILDDEVICEPATH BuildDevicePath;
  134. MMC_NOTIFYSTATE NotifyState;
  135. MMC_SENDCOMMAND SendCommand;
  136. MMC_RECEIVERESPONSE ReceiveResponse;
  137. MMC_READBLOCKDATA ReadBlockData;
  138. MMC_WRITEBLOCKDATA WriteBlockData;
  139. MMC_SETIOS SetIos;
  140. MMC_ISMULTIBLOCK IsMultiBlock;
  141. };
  142. #define MMC_HOST_PROTOCOL_REVISION 0x00010002 // 1.2
  143. #define MMC_HOST_HAS_SETIOS(Host) (Host->Revision >= MMC_HOST_PROTOCOL_REVISION &&\
  144. Host->SetIos != NULL)
  145. #define MMC_HOST_HAS_ISMULTIBLOCK(Host) (Host->Revision >= MMC_HOST_PROTOCOL_REVISION &&\
  146. Host->IsMultiBlock != NULL)
  147. extern EFI_GUID gEmbeddedMmcHostProtocolGuid;
  148. #endif