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