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