Mmc.h 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529
  1. /** @file
  2. Main Header file for the MMC DXE driver
  3. Copyright (c) 2011-2015, ARM Limited. All rights reserved.
  4. SPDX-License-Identifier: BSD-2-Clause-Patent
  5. **/
  6. #ifndef __MMC_H
  7. #define __MMC_H
  8. #include <Uefi.h>
  9. #include <Protocol/DiskIo.h>
  10. #include <Protocol/BlockIo.h>
  11. #include <Protocol/DevicePath.h>
  12. #include <Protocol/MmcHost.h>
  13. #include <Library/UefiLib.h>
  14. #include <Library/DebugLib.h>
  15. #include <Library/UefiBootServicesTableLib.h>
  16. #define MMC_TRACE(txt) DEBUG((DEBUG_BLKIO, "MMC: " txt "\n"))
  17. #define MMC_IOBLOCKS_READ 0
  18. #define MMC_IOBLOCKS_WRITE 1
  19. #define MMC_OCR_POWERUP 0x80000000
  20. #define MMC_OCR_ACCESS_MASK 0x3 /* bit[30-29] */
  21. #define MMC_OCR_ACCESS_BYTE 0x1 /* bit[29] */
  22. #define MMC_OCR_ACCESS_SECTOR 0x2 /* bit[30] */
  23. #define MMC_CSD_GET_CCC(Response) (Response[2] >> 20)
  24. #define MMC_CSD_GET_TRANSPEED(Response) (Response[3] & 0xFF)
  25. #define MMC_CSD_GET_READBLLEN(Response) ((Response[2] >> 16) & 0xF)
  26. #define MMC_CSD_GET_WRITEBLLEN(Response) ((Response[0] >> 22) & 0xF)
  27. #define MMC_CSD_GET_FILEFORMAT(Response) ((Response[0] >> 10) & 0x3)
  28. #define MMC_CSD_GET_FILEFORMATGRP(Response) ((Response[0] >> 15) & 0x1)
  29. #define MMC_CSD_GET_DEVICESIZE(csd) (((Response[1] >> 30) & 0x3) | ((Response[2] & 0x3FF) << 2))
  30. #define HC_MMC_CSD_GET_DEVICESIZE(Response) ((Response[1] >> 16) | ((Response[2] & 0x40) << 16));
  31. #define MMC_CSD_GET_DEVICESIZEMULT(csd) ((Response[1] >> 15) & 0x7)
  32. #define MMC_R0_READY_FOR_DATA (1 << 8)
  33. #define MMC_R0_CURRENTSTATE(Response) ((Response[0] >> 9) & 0xF)
  34. #define MMC_R0_STATE_IDLE 0
  35. #define MMC_R0_STATE_READY 1
  36. #define MMC_R0_STATE_IDENT 2
  37. #define MMC_R0_STATE_STDBY 3
  38. #define MMC_R0_STATE_TRAN 4
  39. #define MMC_R0_STATE_DATA 5
  40. #define EMMC_CMD6_ARG_ACCESS(x) (((x) & 0x3) << 24)
  41. #define EMMC_CMD6_ARG_INDEX(x) (((x) & 0xFF) << 16)
  42. #define EMMC_CMD6_ARG_VALUE(x) (((x) & 0xFF) << 8)
  43. #define EMMC_CMD6_ARG_CMD_SET(x) (((x) & 0x7) << 0)
  44. #define SWITCH_CMD_DATA_LENGTH 64
  45. #define SD_HIGH_SPEED_SUPPORTED 0x20000
  46. #define SD_DEFAULT_SPEED 25000000
  47. #define SD_HIGH_SPEED 50000000
  48. #define SWITCH_CMD_SUCCESS_MASK 0x0f000000
  49. #define SD_CARD_CAPACITY 0x00000002
  50. #define BUSWIDTH_4 4
  51. typedef enum {
  52. UNKNOWN_CARD,
  53. MMC_CARD, // MMC card
  54. MMC_CARD_HIGH, // MMC Card with High capacity
  55. EMMC_CARD, // eMMC 4.41 card
  56. SD_CARD, // SD 1.1 card
  57. SD_CARD_2, // SD 2.0 or above standard card
  58. SD_CARD_2_HIGH // SD 2.0 or above high capacity card
  59. } CARD_TYPE;
  60. typedef struct {
  61. UINT32 Reserved0 : 7; // 0
  62. UINT32 V170_V195 : 1; // 1.70V - 1.95V
  63. UINT32 V200_V260 : 7; // 2.00V - 2.60V
  64. UINT32 V270_V360 : 9; // 2.70V - 3.60V
  65. UINT32 RESERVED_1 : 5; // Reserved
  66. UINT32 AccessMode : 2; // 00b (byte mode), 10b (sector mode)
  67. UINT32 PowerUp : 1; // This bit is set to LOW if the card has not finished the power up routine
  68. } OCR;
  69. typedef struct {
  70. UINT8 SD_SPEC : 4; // SD Memory Card - Spec. Version [59:56]
  71. UINT8 SCR_STRUCTURE : 4; // SCR Structure [63:60]
  72. UINT8 SD_BUS_WIDTHS : 4; // DAT Bus widths supported [51:48]
  73. UINT8 DATA_STAT_AFTER_ERASE : 1; // Data Status after erases [55]
  74. UINT8 SD_SECURITY : 3; // CPRM Security Support [54:52]
  75. UINT8 EX_SECURITY_1 : 1; // Extended Security Support [43]
  76. UINT8 SD_SPEC4 : 1; // Spec. Version 4.00 or higher [42]
  77. UINT8 RESERVED_1 : 2; // Reserved [41:40]
  78. UINT8 SD_SPEC3 : 1; // Spec. Version 3.00 or higher [47]
  79. UINT8 EX_SECURITY_2 : 3; // Extended Security Support [46:44]
  80. UINT8 CMD_SUPPORT : 4; // Command Support bits [35:32]
  81. UINT8 RESERVED_2 : 4; // Reserved [39:36]
  82. UINT32 RESERVED_3; // Manufacturer Usage [31:0]
  83. } SCR;
  84. typedef struct {
  85. UINT32 NOT_USED; // 1 [0:0]
  86. UINT32 CRC; // CRC7 checksum [7:1]
  87. UINT32 MDT; // Manufacturing date [19:8]
  88. UINT32 RESERVED_1; // Reserved [23:20]
  89. UINT32 PSN; // Product serial number [55:24]
  90. UINT8 PRV; // Product revision [63:56]
  91. UINT8 PNM[5]; // Product name [64:103]
  92. UINT16 OID; // OEM/Application ID [119:104]
  93. UINT8 MID; // Manufacturer ID [127:120]
  94. } CID;
  95. typedef struct {
  96. UINT8 NOT_USED : 1; // Not used, always 1 [0:0]
  97. UINT8 CRC : 7; // CRC [7:1]
  98. UINT8 RESERVED_1 : 2; // Reserved [9:8]
  99. UINT8 FILE_FORMAT : 2; // File format [11:10]
  100. UINT8 TMP_WRITE_PROTECT : 1; // Temporary write protection [12:12]
  101. UINT8 PERM_WRITE_PROTECT : 1; // Permanent write protection [13:13]
  102. UINT8 COPY : 1; // Copy flag (OTP) [14:14]
  103. UINT8 FILE_FORMAT_GRP : 1; // File format group [15:15]
  104. UINT16 RESERVED_2 : 5; // Reserved [20:16]
  105. UINT16 WRITE_BL_PARTIAL : 1; // Partial blocks for write allowed [21:21]
  106. UINT16 WRITE_BL_LEN : 4; // Max. write data block length [25:22]
  107. UINT16 R2W_FACTOR : 3; // Write speed factor [28:26]
  108. UINT16 RESERVED_3 : 2; // Reserved [30:29]
  109. UINT16 WP_GRP_ENABLE : 1; // Write protect group enable [31:31]
  110. UINT32 WP_GRP_SIZE : 7; // Write protect group size [38:32]
  111. UINT32 SECTOR_SIZE : 7; // Erase sector size [45:39]
  112. UINT32 ERASE_BLK_EN : 1; // Erase single block enable [46:46]
  113. UINT32 C_SIZE_MULT : 3; // Device size multiplier [49:47]
  114. UINT32 VDD_W_CURR_MAX : 3; // Max. write current @ VDD max [52:50]
  115. UINT32 VDD_W_CURR_MIN : 3; // Max. write current @ VDD min [55:53]
  116. UINT32 VDD_R_CURR_MAX : 3; // Max. read current @ VDD max [58:56]
  117. UINT32 VDD_R_CURR_MIN : 3; // Max. read current @ VDD min [61:59]
  118. UINT32 C_SIZELow2 : 2; // Device size [63:62]
  119. UINT32 C_SIZEHigh10 : 10; // Device size [73:64]
  120. UINT32 RESERVED_4 : 2; // Reserved [75:74]
  121. UINT32 DSR_IMP : 1; // DSR implemented [76:76]
  122. UINT32 READ_BLK_MISALIGN : 1; // Read block misalignment [77:77]
  123. UINT32 WRITE_BLK_MISALIGN : 1; // Write block misalignment [78:78]
  124. UINT32 READ_BL_PARTIAL : 1; // Partial blocks for read allowed [79:79]
  125. UINT32 READ_BL_LEN : 4; // Max. read data block length [83:80]
  126. UINT32 CCC : 12; // Card command classes [95:84]
  127. UINT8 TRAN_SPEED; // Max. bus clock frequency [103:96]
  128. UINT8 NSAC; // Data read access-time 2 in CLK cycles (NSAC*100) [111:104]
  129. UINT8 TAAC; // Data read access-time 1 [119:112]
  130. UINT8 RESERVED_5 : 2; // Reserved [121:120]
  131. UINT8 SPEC_VERS : 4; // System specification version [125:122]
  132. UINT8 CSD_STRUCTURE : 2; // CSD structure [127:126]
  133. } CSD;
  134. typedef struct {
  135. UINT8 RESERVED_1[16]; // Reserved [15:0]
  136. UINT8 SECURE_REMOVAL_TYPE; // Secure Removal Type [16:16]
  137. UINT8 PRODUCT_STATE_AWARENESS_ENABLEMENT; // Product state awareness enablement [17:17]
  138. UINT8 MAX_PRE_LOADING_DATA_SIZE[4]; // MAX pre loading data size [21:18]
  139. UINT8 PRE_LOADING_DATA_SIZE[4]; // Pre loading data size [25:22]
  140. UINT8 FFU_STATUS; // FFU Status [26:26]
  141. UINT8 RESERVED_2[2]; // Reserved [28:27]
  142. UINT8 MODE_OPERATION_CODES; // Mode operation codes [29:29]
  143. UINT8 MODE_CONFIG; // Mode config [30:30]
  144. UINT8 RESERVED_3; // Reserved [31:31]
  145. UINT8 FLUSH_CACHE; // Flushing of the cache [32:32]
  146. UINT8 CACHE_CTRL; // Control to turn the cache ON/OFF [33:33]
  147. UINT8 POWER_OFF_NOTIFICATION; // Power Off Notification [34:34]
  148. UINT8 PACKED_FAILURE_INDEX; // Packed command failure index [35:35]
  149. UINT8 PACKED_COMMAND_STATUS; // Packed command status [36:36]
  150. UINT8 CONTEXT_CONF[15]; // Context configuration [51:37]
  151. UINT8 EXT_PARTITIONS_ATTRIBUTE[2]; // Extended partitions attribute [53:52]
  152. UINT8 EXCEPTION_EVENTS_STATUS[2]; // Exception events status [55:54]
  153. UINT8 EXCEPTION_EVENTS_CTRL[2]; // Exception events control [57:56]
  154. UINT8 DYNCAP_NEEDED; // Number of addressed group to be released [58:58]
  155. UINT8 CLASS_6_CTRL; // Class 6 commands control [59:59]
  156. UINT8 INI_TIMEOUT_EMU; // 1st initialization after disabling sector size emulation [60:60]
  157. UINT8 DATA_SECTOR_SIZE; // Sector size [61:61]
  158. UINT8 USE_NATIVE_SECTOR; // Sector size emulation [62:62]
  159. UINT8 NATIVE_SECTOR_SIZE; // Native sector size [63:63]
  160. UINT8 VENDOR_SPECIFIC_FIELD[64]; // Vendor specific fields [127:64]
  161. UINT8 RESERVED_4[2]; // Reserved [129:128]
  162. UINT8 PROGRAM_CID_CSD_DDR_SUPPORT; // Program CID/CSD in DDR mode support [130:130]
  163. UINT8 PERIODIC_WAKEUP; // Periodic wake-up [131:131]
  164. UINT8 TCASE_SUPPORT; // Package case temperature is controlled [132:132]
  165. UINT8 PRODUCTION_STATE_AWARENESS; // Production state awareness [133:133]
  166. UINT8 SECTOR_BAD_BLK_MGMNT; // Bad block management mode [134:134]
  167. UINT8 RESERVED_5; // Reserved [135:135]
  168. UINT8 ENH_START_ADDR[4]; // Enhanced user data start address [139:136]
  169. UINT8 ENH_SIZE_MULT[3]; // Enhanced user data area size [142:140]
  170. UINT8 GP_SIZE_MULT[12]; // General purpose partition size [154:143]
  171. UINT8 PARTITION_SETTING_COMPLETED; // Partitioning setting [155:155]
  172. UINT8 PARTITIONS_ATTRIBUTE; // Partitions attribute [156:156]
  173. UINT8 MAX_ENH_SIZE_MULT[3]; // Max enhanced area size [159:157]
  174. UINT8 PARTITIONING_SUPPORT; // Partitioning [160:160]
  175. UINT8 HPI_MGMT; // HPI management [161:161]
  176. UINT8 RST_N_FUNCTION; // H/W reset function [162:162]
  177. UINT8 BKOPS_EN; // Enable background operations handshake [163:163]
  178. UINT8 BKOPS_START; // Manually start background operations [164:164]
  179. UINT8 SANITIZE_START; // Start sanitize operation [165:165]
  180. UINT8 WR_REL_PARAM; // Write reliability parameter register [166:166]
  181. UINT8 WR_REL_SET; // Write reliability setting register [167:167]
  182. UINT8 RPMB_SIZE_MULT; // RPMB size [168:168]
  183. UINT8 FW_CONFIG; // FW configuration [169:169]
  184. UINT8 RESERVED_6; // Reserved [170:170]
  185. UINT8 USER_WP; // User area write protection register [171:171]
  186. UINT8 RESERVED_7; // Reserved [172:172]
  187. UINT8 BOOT_WP; // Boot area write protection register [173:173]
  188. UINT8 BOOT_WP_STATUS; // Boot write protection register [174:174]
  189. UINT8 ERASE_GROUP_DEF; // High-density erase group definition [175:175]
  190. UINT8 RESERVED_8; // Reserved [176:176]
  191. UINT8 BOOT_BUS_CONDITIONS; // Boot bus conditions [177:177]
  192. UINT8 BOOT_CONFIG_PROT; // Boot config protection [178:178]
  193. UINT8 PARTITION_CONFIG; // Partition config [179:179]
  194. UINT8 RESERVED_9; // Reserved [180:180]
  195. UINT8 ERASED_MEM_CONT; // Erased memory content [181:181]
  196. UINT8 RESERVED_10; // Reserved [182:182]
  197. UINT8 BUS_WIDTH; // Bus width mode [183:183]
  198. UINT8 RESERVED_11; // Reserved [184:184]
  199. UINT8 HS_TIMING; // High-speed interface timing [185:185]
  200. UINT8 RESERVED_12; // Reserved [186:186]
  201. UINT8 POWER_CLASS; // Power class [187:187]
  202. UINT8 RESERVED_13; // Reserved [188:188]
  203. UINT8 CMD_SET_REV; // Command set revision [189:189]
  204. UINT8 RESERVED_14; // Reserved [190:190]
  205. UINT8 CMD_SET; // Command set [191:191]
  206. UINT8 EXT_CSD_REV; // Extended CSD revision [192:192]
  207. UINT8 RESERVED_15; // Reserved [193:193]
  208. UINT8 CSD_STRUCTURE; // CSD Structure [194:194]
  209. UINT8 RESERVED_16; // Reserved [195:195]
  210. UINT8 DEVICE_TYPE; // Device type [196:196]
  211. UINT8 DRIVER_STRENGTH; // I/O Driver strength [197:197]
  212. UINT8 OUT_OF_INTERRUPT_TIME; // Out-of-interrupt busy timing [198:198]
  213. UINT8 PARTITION_SWITCH_TIME; // Partition switching timing [199:199]
  214. UINT8 PWR_CL_52_195; // Power class for 52MHz at 1.95V 1 R [200:200]
  215. UINT8 PWR_CL_26_195; // Power class for 26MHz at 1.95V 1 R [201:201]
  216. UINT8 PWR_CL_52_360; // Power class for 52MHz at 3.6V 1 R [202:202]
  217. UINT8 PWR_CL_26_360; // Power class for 26MHz at 3.6V 1 R [203:203]
  218. UINT8 RESERVED_17; // Reserved [204:204]
  219. UINT8 MIN_PERF_R_4_26; // Minimum read performance for 4bit at 26MHz [205:205]
  220. UINT8 MIN_PERF_W_4_26; // Minimum write performance for 4bit at 26MHz [206:206]
  221. UINT8 MIN_PERF_R_8_26_4_52; // Minimum read performance for 8bit at 26MHz, for 4bit at 52MHz [207:207]
  222. UINT8 MIN_PERF_W_8_26_4_52; // Minimum write performance for 8bit at 26MHz, for 4bit at 52MHz [208:208]
  223. UINT8 MIN_PERF_R_8_52; // Minimum read performance for 8bit at 52MHz [209:209]
  224. UINT8 MIN_PERF_W_8_52; // Minimum write performance for 8bit at 52MHz [210:210]
  225. UINT8 RESERVED_18; // Reserved [211:211]
  226. UINT32 SECTOR_COUNT; // Sector count [215:212]
  227. UINT8 SLEEP_NOTIFICATION_TIME; // Sleep notification timeout [216:216]
  228. UINT8 S_A_TIMEOUT; // Sleep/awake timeout [217:217]
  229. UINT8 PRODUCTION_STATE_AWARENESS_TIMEOUT; // Production state awareness timeout [218:218]
  230. UINT8 S_C_VCCQ; // Sleep current (VCCQ) [219:219]
  231. UINT8 S_C_VCC; // Sleep current (VCC) [220:220]
  232. UINT8 HC_WP_GRP_SIZE; // High-capacity write protect group size [221:221]
  233. UINT8 REL_WR_SECTOR_C; // Reliable write sector count [222:222]
  234. UINT8 ERASE_TIMEOUT_MULT; // High-capacity erase timeout [223:223]
  235. UINT8 HC_ERASE_GRP_SIZE; // High-capacity erase unit size [224:224]
  236. UINT8 ACC_SIZE; // Access size [225:225]
  237. UINT8 BOOT_SIZE_MULTI; // Boot partition size [226:226]
  238. UINT8 RESERVED_19; // Reserved [227:227]
  239. UINT8 BOOT_INFO; // Boot information [228:228]
  240. UINT8 SECURE_TRIM_MULT; // Secure TRIM Multiplier [229:229]
  241. UINT8 SECURE_ERASE_MULT; // Secure Erase Multiplier [230:230]
  242. UINT8 SECURE_FEATURE_SUPPORT; // Secure Feature Support [231:231]
  243. UINT8 TRIM_MULT; // TRIM Multiplier [232:232]
  244. UINT8 RESERVED_20; // Reserved [233:233]
  245. UINT8 MIN_PREF_DDR_R_8_52; // Minimum read performance for 8bit at 52MHz in DDR mode [234:234]
  246. UINT8 MIN_PREF_DDR_W_8_52; // Minimum write performance for 8bit at 52MHz in DDR mode [235:235]
  247. UINT8 PWR_CL_200_130; // Power class for 200MHz at VCCQ=1.3V, VCC=3.6V [236:236]
  248. UINT8 PWR_CL_200_195; // Power class for 200MHz at VCCQ=1.95V, VCC=3.6V [237:237]
  249. UINT8 PWR_CL_DDR_52_195; // Power class for 52MHz, DDR at 1.95V [238:238]
  250. UINT8 PWR_CL_DDR_52_360; // Power class for 52Mhz, DDR at 3.6V [239:239]
  251. UINT8 RESERVED_21; // Reserved [240:240]
  252. UINT8 INI_TIMEOUT_AP; // 1st initialization time after partitioning [241:241]
  253. UINT8 CORRECTLY_PRG_SECTORS_NUM[4]; // Number of correctly programmed sectors [245:242]
  254. UINT8 BKOPS_STATUS; // Background operations status [246:246]
  255. UINT8 POWER_OFF_LONG_TIME; // Power off notification (long) timeout [247:247]
  256. UINT8 GENERIC_CMD6_TIME; // Generic CMD6 timeout [248:248]
  257. UINT8 CACHE_SIZE[4]; // Cache size [252:249]
  258. UINT8 PWR_CL_DDR_200_360; // Power class for 200MHz, DDR at VCC=3.6V [253:253]
  259. UINT8 FIRMWARE_VERSION[8]; // Firmware version [261:254]
  260. UINT8 DEVICE_VERSION[2]; // Device version [263:262]
  261. UINT8 OPTIMAL_TRIM_UNIT_SIZE; // Optimal trim unit size [264:264]
  262. UINT8 OPTIMAL_WRITE_SIZE; // Optimal write size [265:265]
  263. UINT8 OPTIMAL_READ_SIZE; // Optimal read size [266:266]
  264. UINT8 PRE_EOL_INFO; // Pre EOL information [267:267]
  265. UINT8 DEVICE_LIFE_TIME_EST_TYP_A; // Device life time estimation type A [268:268]
  266. UINT8 DEVICE_LIFE_TIME_EST_TYP_B; // Device life time estimation type B [269:269]
  267. UINT8 VENDOR_PROPRIETARY_HEALTH_REPORT[32]; // Vendor proprietary health report [301:270]
  268. UINT8 NUMBER_OF_FW_SECTORS_CORRECTLY_PROGRAMMED[4]; // Number of FW sectors correctly programmed [305:302]
  269. UINT8 RESERVED_22[181]; // Reserved [486:306]
  270. UINT8 FFU_ARG[4]; // FFU argument [490:487]
  271. UINT8 OPERATION_CODE_TIMEOUT; // Operation codes timeout [491:491]
  272. UINT8 FFU_FEATURES; // FFU features [492:492]
  273. UINT8 SUPPORTED_MODES; // Supported modes [493:493]
  274. UINT8 EXT_SUPPORT; // Extended partitions attribute support [494:494]
  275. UINT8 LARGE_UNIT_SIZE_M1; // Large unit size [495:495]
  276. UINT8 CONTEXT_CAPABILITIES; // Context management capabilities [496:496]
  277. UINT8 TAG_RES_SIZE; // Tag resource size [497:497]
  278. UINT8 TAG_UNIT_SIZE; // Tag unit size [498:498]
  279. UINT8 DATA_TAG_SUPPORT; // Data tag support [499:499]
  280. UINT8 MAX_PACKED_WRITES; // Max packed write commands [500:500]
  281. UINT8 MAX_PACKED_READS; // Max packed read commands [501:501]
  282. UINT8 BKOPS_SUPPORT; // Background operations support [502:502]
  283. UINT8 HPI_FEATURES; // HPI features [503:503]
  284. UINT8 S_CMD_SET; // Supported command sets [504:504]
  285. UINT8 EXT_SECURITY_ERR; // Extended security commands error [505:505]
  286. UINT8 RESERVED_23[6]; // Reserved [511:506]
  287. } ECSD;
  288. typedef struct {
  289. UINT16 RCA;
  290. CARD_TYPE CardType;
  291. OCR OCRData;
  292. CID CIDData;
  293. CSD CSDData;
  294. ECSD *ECSDData; // MMC V4 extended card specific
  295. } CARD_INFO;
  296. typedef struct _MMC_HOST_INSTANCE {
  297. UINTN Signature;
  298. LIST_ENTRY Link;
  299. EFI_HANDLE MmcHandle;
  300. EFI_DEVICE_PATH_PROTOCOL *DevicePath;
  301. MMC_STATE State;
  302. EFI_BLOCK_IO_PROTOCOL BlockIo;
  303. CARD_INFO CardInfo;
  304. EFI_MMC_HOST_PROTOCOL *MmcHost;
  305. BOOLEAN Initialized;
  306. } MMC_HOST_INSTANCE;
  307. #define MMC_HOST_INSTANCE_SIGNATURE SIGNATURE_32('m', 'm', 'c', 'h')
  308. #define MMC_HOST_INSTANCE_FROM_BLOCK_IO_THIS(a) CR (a, MMC_HOST_INSTANCE, BlockIo, MMC_HOST_INSTANCE_SIGNATURE)
  309. #define MMC_HOST_INSTANCE_FROM_LINK(a) CR (a, MMC_HOST_INSTANCE, Link, MMC_HOST_INSTANCE_SIGNATURE)
  310. EFI_STATUS
  311. EFIAPI
  312. MmcGetDriverName (
  313. IN EFI_COMPONENT_NAME_PROTOCOL *This,
  314. IN CHAR8 *Language,
  315. OUT CHAR16 **DriverName
  316. );
  317. EFI_STATUS
  318. EFIAPI
  319. MmcGetControllerName (
  320. IN EFI_COMPONENT_NAME_PROTOCOL *This,
  321. IN EFI_HANDLE ControllerHandle,
  322. IN EFI_HANDLE ChildHandle OPTIONAL,
  323. IN CHAR8 *Language,
  324. OUT CHAR16 **ControllerName
  325. );
  326. extern EFI_COMPONENT_NAME_PROTOCOL gMmcComponentName;
  327. extern EFI_COMPONENT_NAME2_PROTOCOL gMmcComponentName2;
  328. extern EFI_DRIVER_DIAGNOSTICS2_PROTOCOL gMmcDriverDiagnostics2;
  329. extern LIST_ENTRY mMmcHostPool;
  330. /**
  331. Reset the block device.
  332. This function implements EFI_BLOCK_IO_PROTOCOL.Reset().
  333. It resets the block device hardware.
  334. ExtendedVerification is ignored in this implementation.
  335. @param This Indicates a pointer to the calling context.
  336. @param ExtendedVerification Indicates that the driver may perform a more exhaustive
  337. verification operation of the device during reset.
  338. @retval EFI_SUCCESS The block device was reset.
  339. @retval EFI_DEVICE_ERROR The block device is not functioning correctly and could not be reset.
  340. **/
  341. EFI_STATUS
  342. EFIAPI
  343. MmcReset (
  344. IN EFI_BLOCK_IO_PROTOCOL *This,
  345. IN BOOLEAN ExtendedVerification
  346. );
  347. /**
  348. Reads the requested number of blocks from the device.
  349. This function implements EFI_BLOCK_IO_PROTOCOL.ReadBlocks().
  350. It reads the requested number of blocks from the device.
  351. All the blocks are read, or an error is returned.
  352. @param This Indicates a pointer to the calling context.
  353. @param MediaId The media ID that the read request is for.
  354. @param Lba The starting logical block address to read from on the device.
  355. @param BufferSize The size of the Buffer in bytes.
  356. This must be a multiple of the intrinsic block size of the device.
  357. @param Buffer A pointer to the destination buffer for the data. The caller is
  358. responsible for either having implicit or explicit ownership of the buffer.
  359. @retval EFI_SUCCESS The data was read correctly from the device.
  360. @retval EFI_DEVICE_ERROR The device reported an error while attempting to perform the read operation.
  361. @retval EFI_NO_MEDIA There is no media in the device.
  362. @retval EFI_MEDIA_CHANGED The MediaId is not for the current media.
  363. @retval EFI_BAD_BUFFER_SIZE The BufferSize parameter is not a multiple of the intrinsic block size of the device.
  364. @retval EFI_INVALID_PARAMETER The read request contains LBAs that are not valid,
  365. or the buffer is not on proper alignment.
  366. **/
  367. EFI_STATUS
  368. EFIAPI
  369. MmcReadBlocks (
  370. IN EFI_BLOCK_IO_PROTOCOL *This,
  371. IN UINT32 MediaId,
  372. IN EFI_LBA Lba,
  373. IN UINTN BufferSize,
  374. OUT VOID *Buffer
  375. );
  376. /**
  377. Writes a specified number of blocks to the device.
  378. This function implements EFI_BLOCK_IO_PROTOCOL.WriteBlocks().
  379. It writes a specified number of blocks to the device.
  380. All blocks are written, or an error is returned.
  381. @param This Indicates a pointer to the calling context.
  382. @param MediaId The media ID that the write request is for.
  383. @param Lba The starting logical block address to be written.
  384. @param BufferSize The size of the Buffer in bytes.
  385. This must be a multiple of the intrinsic block size of the device.
  386. @param Buffer Pointer to the source buffer for the data.
  387. @retval EFI_SUCCESS The data were written correctly to the device.
  388. @retval EFI_WRITE_PROTECTED The device cannot be written to.
  389. @retval EFI_NO_MEDIA There is no media in the device.
  390. @retval EFI_MEDIA_CHANGED The MediaId is not for the current media.
  391. @retval EFI_DEVICE_ERROR The device reported an error while attempting to perform the write operation.
  392. @retval EFI_BAD_BUFFER_SIZE The BufferSize parameter is not a multiple of the intrinsic
  393. block size of the device.
  394. @retval EFI_INVALID_PARAMETER The write request contains LBAs that are not valid,
  395. or the buffer is not on proper alignment.
  396. **/
  397. EFI_STATUS
  398. EFIAPI
  399. MmcWriteBlocks (
  400. IN EFI_BLOCK_IO_PROTOCOL *This,
  401. IN UINT32 MediaId,
  402. IN EFI_LBA Lba,
  403. IN UINTN BufferSize,
  404. IN VOID *Buffer
  405. );
  406. /**
  407. Flushes all modified data to a physical block device.
  408. @param This Indicates a pointer to the calling context.
  409. @retval EFI_SUCCESS All outstanding data were written correctly to the device.
  410. @retval EFI_DEVICE_ERROR The device reported an error while attempting to write data.
  411. @retval EFI_NO_MEDIA There is no media in the device.
  412. **/
  413. EFI_STATUS
  414. EFIAPI
  415. MmcFlushBlocks (
  416. IN EFI_BLOCK_IO_PROTOCOL *This
  417. );
  418. EFI_STATUS
  419. MmcNotifyState (
  420. IN MMC_HOST_INSTANCE *MmcHostInstance,
  421. IN MMC_STATE State
  422. );
  423. EFI_STATUS
  424. InitializeMmcDevice (
  425. IN MMC_HOST_INSTANCE *MmcHost
  426. );
  427. VOID
  428. EFIAPI
  429. CheckCardsCallback (
  430. IN EFI_EVENT Event,
  431. IN VOID *Context
  432. );
  433. VOID
  434. PrintCSD (
  435. IN UINT32 *Csd
  436. );
  437. VOID
  438. PrintRCA (
  439. IN UINT32 Rca
  440. );
  441. VOID
  442. PrintOCR (
  443. IN UINT32 Ocr
  444. );
  445. VOID
  446. PrintResponseR1 (
  447. IN UINT32 Response
  448. );
  449. VOID
  450. PrintCID (
  451. IN UINT32 *Cid
  452. );
  453. #define __be32_to_cpu(x) \
  454. ((UINT32)( \
  455. (((UINT32)(x) & (UINT32)0x000000ffUL) << 24) | \
  456. (((UINT32)(x) & (UINT32)0x0000ff00UL) << 8) | \
  457. (((UINT32)(x) & (UINT32)0x00ff0000UL) >> 8) | \
  458. (((UINT32)(x) & (UINT32)0xff000000UL) >> 24) ))
  459. #endif