2 Main Header file for the MMC DXE driver
4 Copyright (c) 2011-2013, ARM Limited. All rights reserved.
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
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.
21 #include <Protocol/DiskIo.h>
22 #include <Protocol/BlockIo.h>
23 #include <Protocol/DevicePath.h>
24 #include <Protocol/MmcHost.h>
26 #include <Library/UefiLib.h>
27 #include <Library/DebugLib.h>
29 #define MMC_TRACE(txt) DEBUG((EFI_D_BLKIO, "MMC: " txt "\n"))
31 #define MMC_IOBLOCKS_READ 0
32 #define MMC_IOBLOCKS_WRITE 1
34 #define MMC_OCR_POWERUP 0x80000000
36 #define MMC_CSD_GET_CCC(Response) (Response[2] >> 20)
37 #define MMC_CSD_GET_TRANSPEED(Response) (Response[3] & 0xFF)
38 #define MMC_CSD_GET_READBLLEN(Response) ((Response[2] >> 16) & 0xF)
39 #define MMC_CSD_GET_WRITEBLLEN(Response) ((Response[0] >> 22) & 0xF)
40 #define MMC_CSD_GET_FILEFORMAT(Response) ((Response[0] >> 10) & 0x3)
41 #define MMC_CSD_GET_FILEFORMATGRP(Response) ((Response[0] >> 15) & 0x1)
42 #define MMC_CSD_GET_DEVICESIZE(csd) (((Response[1] >> 30) & 0x3) | ((Response[2] & 0x3FF) << 2))
43 #define HC_MMC_CSD_GET_DEVICESIZE(Response) ((Response[1] >> 16) | ((Response[2] & 0x40) << 16));
44 #define MMC_CSD_GET_DEVICESIZEMULT(csd) ((Response[1] >> 15) & 0x7)
46 #define MMC_R0_READY_FOR_DATA (1 << 8)
48 #define MMC_R0_CURRENTSTATE(Response) ((Response[0] >> 9) & 0xF)
50 #define MMC_R0_STATE_IDLE 0
51 #define MMC_R0_STATE_READY 1
52 #define MMC_R0_STATE_IDENT 2
53 #define MMC_R0_STATE_STDBY 3
54 #define MMC_R0_STATE_TRAN 4
55 #define MMC_R0_STATE_DATA 5
60 MMC_CARD_HIGH
, //MMC Card with High capacity
61 SD_CARD
, //SD 1.1 card
62 SD_CARD_2
, //SD 2.0 or above standard card
63 SD_CARD_2_HIGH
//SD 2.0 or above high capacity card
67 UINT32 Reserved0
: 7; // 0
68 UINT32 V170_V195
: 1; // 1.70V - 1.95V
69 UINT32 V200_V260
: 7; // 2.00V - 2.60V
70 UINT32 V270_V360
: 9; // 2.70V - 3.60V
71 UINT32 RESERVED_1
: 5; // Reserved
72 UINT32 AccessMode
: 2; // 00b (byte mode), 10b (sector mode)
73 UINT32 PowerUp
: 1; // This bit is set to LOW if the card has not finished the power up routine
77 UINT32 NOT_USED
; // 1 [0:0]
78 UINT32 CRC
; // CRC7 checksum [7:1]
79 UINT32 MDT
; // Manufacturing date [19:8]
80 UINT32 RESERVED_1
; // Reserved [23:20]
81 UINT32 PSN
; // Product serial number [55:24]
82 UINT8 PRV
; // Product revision [63:56]
83 UINT8 PNM
[5]; // Product name [64:103]
84 UINT16 OID
; // OEM/Application ID [119:104]
85 UINT8 MID
; // Manufacturer ID [127:120]
89 UINT8 NOT_USED
: 1; // Not used, always 1 [0:0]
90 UINT8 CRC
: 7; // CRC [7:1]
92 UINT8 RESERVED_1
: 2; // Reserved [9:8]
93 UINT8 FILE_FORMAT
: 2; // File format [11:10]
94 UINT8 TMP_WRITE_PROTECT
: 1; // Temporary write protection [12:12]
95 UINT8 PERM_WRITE_PROTECT
: 1; // Permanent write protection [13:13]
96 UINT8 COPY
: 1; // Copy flag (OTP) [14:14]
97 UINT8 FILE_FORMAT_GRP
: 1; // File format group [15:15]
99 UINT16 RESERVED_2
: 5; // Reserved [20:16]
100 UINT16 WRITE_BL_PARTIAL
: 1; // Partial blocks for write allowed [21:21]
101 UINT16 WRITE_BL_LEN
: 4; // Max. write data block length [25:22]
102 UINT16 R2W_FACTOR
: 3; // Write speed factor [28:26]
103 UINT16 RESERVED_3
: 2; // Reserved [30:29]
104 UINT16 WP_GRP_ENABLE
: 1; // Write protect group enable [31:31]
106 UINT32 WP_GRP_SIZE
: 7; // Write protect group size [38:32]
107 UINT32 SECTOR_SIZE
: 7; // Erase sector size [45:39]
108 UINT32 ERASE_BLK_EN
: 1; // Erase single block enable [46:46]
109 UINT32 C_SIZE_MULT
: 3; // Device size multiplier [49:47]
110 UINT32 VDD_W_CURR_MAX
: 3; // Max. write current @ VDD max [52:50]
111 UINT32 VDD_W_CURR_MIN
: 3; // Max. write current @ VDD min [55:53]
112 UINT32 VDD_R_CURR_MAX
: 3; // Max. read current @ VDD max [58:56]
113 UINT32 VDD_R_CURR_MIN
: 3; // Max. read current @ VDD min [61:59]
114 UINT32 C_SIZELow2
: 2; // Device size [63:62]
116 UINT32 C_SIZEHigh10
: 10;// Device size [73:64]
117 UINT32 RESERVED_4
: 2; // Reserved [75:74]
118 UINT32 DSR_IMP
: 1; // DSR implemented [76:76]
119 UINT32 READ_BLK_MISALIGN
: 1; // Read block misalignment [77:77]
120 UINT32 WRITE_BLK_MISALIGN
: 1; // Write block misalignment [78:78]
121 UINT32 READ_BL_PARTIAL
: 1; // Partial blocks for read allowed [79:79]
122 UINT32 READ_BL_LEN
: 4; // Max. read data block length [83:80]
123 UINT32 CCC
: 12;// Card command classes [95:84]
125 UINT8 TRAN_SPEED
; // Max. bus clock frequency [103:96]
126 UINT8 NSAC
; // Data read access-time 2 in CLK cycles (NSAC*100) [111:104]
127 UINT8 TAAC
; // Data read access-time 1 [119:112]
129 UINT8 RESERVED_5
: 6; // Reserved [125:120]
130 UINT8 CSD_STRUCTURE
: 2; // CSD structure [127:126]
141 typedef struct _MMC_HOST_INSTANCE
{
144 EFI_HANDLE MmcHandle
;
145 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
148 EFI_BLOCK_IO_PROTOCOL BlockIo
;
150 EFI_MMC_HOST_PROTOCOL
*MmcHost
;
155 #define MMC_HOST_INSTANCE_SIGNATURE SIGNATURE_32('m', 'm', 'c', 'h')
156 #define MMC_HOST_INSTANCE_FROM_BLOCK_IO_THIS(a) CR (a, MMC_HOST_INSTANCE, BlockIo, MMC_HOST_INSTANCE_SIGNATURE)
157 #define MMC_HOST_INSTANCE_FROM_LINK(a) CR (a, MMC_HOST_INSTANCE, Link, MMC_HOST_INSTANCE_SIGNATURE)
163 IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
165 OUT CHAR16
**DriverName
170 MmcGetControllerName (
171 IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
172 IN EFI_HANDLE ControllerHandle
,
173 IN EFI_HANDLE ChildHandle OPTIONAL
,
175 OUT CHAR16
**ControllerName
178 extern EFI_COMPONENT_NAME_PROTOCOL gMmcComponentName
;
179 extern EFI_COMPONENT_NAME2_PROTOCOL gMmcComponentName2
;
181 extern EFI_DRIVER_DIAGNOSTICS2_PROTOCOL gMmcDriverDiagnostics2
;
183 extern LIST_ENTRY mMmcHostPool
;
186 Reset the block device.
188 This function implements EFI_BLOCK_IO_PROTOCOL.Reset().
189 It resets the block device hardware.
190 ExtendedVerification is ignored in this implementation.
192 @param This Indicates a pointer to the calling context.
193 @param ExtendedVerification Indicates that the driver may perform a more exhaustive
194 verification operation of the device during reset.
196 @retval EFI_SUCCESS The block device was reset.
197 @retval EFI_DEVICE_ERROR The block device is not functioning correctly and could not be reset.
203 IN EFI_BLOCK_IO_PROTOCOL
*This
,
204 IN BOOLEAN ExtendedVerification
208 Reads the requested number of blocks from the device.
210 This function implements EFI_BLOCK_IO_PROTOCOL.ReadBlocks().
211 It reads the requested number of blocks from the device.
212 All the blocks are read, or an error is returned.
214 @param This Indicates a pointer to the calling context.
215 @param MediaId The media ID that the read request is for.
216 @param Lba The starting logical block address to read from on the device.
217 @param BufferSize The size of the Buffer in bytes.
218 This must be a multiple of the intrinsic block size of the device.
219 @param Buffer A pointer to the destination buffer for the data. The caller is
220 responsible for either having implicit or explicit ownership of the buffer.
222 @retval EFI_SUCCESS The data was read correctly from the device.
223 @retval EFI_DEVICE_ERROR The device reported an error while attempting to perform the read operation.
224 @retval EFI_NO_MEDIA There is no media in the device.
225 @retval EFI_MEDIA_CHANGED The MediaId is not for the current media.
226 @retval EFI_BAD_BUFFER_SIZE The BufferSize parameter is not a multiple of the intrinsic block size of the device.
227 @retval EFI_INVALID_PARAMETER The read request contains LBAs that are not valid,
228 or the buffer is not on proper alignment.
234 IN EFI_BLOCK_IO_PROTOCOL
*This
,
242 Writes a specified number of blocks to the device.
244 This function implements EFI_BLOCK_IO_PROTOCOL.WriteBlocks().
245 It writes a specified number of blocks to the device.
246 All blocks are written, or an error is returned.
248 @param This Indicates a pointer to the calling context.
249 @param MediaId The media ID that the write request is for.
250 @param Lba The starting logical block address to be written.
251 @param BufferSize The size of the Buffer in bytes.
252 This must be a multiple of the intrinsic block size of the device.
253 @param Buffer Pointer to the source buffer for the data.
255 @retval EFI_SUCCESS The data were written correctly to the device.
256 @retval EFI_WRITE_PROTECTED The device cannot be written to.
257 @retval EFI_NO_MEDIA There is no media in the device.
258 @retval EFI_MEDIA_CHANGED The MediaId is not for the current media.
259 @retval EFI_DEVICE_ERROR The device reported an error while attempting to perform the write operation.
260 @retval EFI_BAD_BUFFER_SIZE The BufferSize parameter is not a multiple of the intrinsic
261 block size of the device.
262 @retval EFI_INVALID_PARAMETER The write request contains LBAs that are not valid,
263 or the buffer is not on proper alignment.
269 IN EFI_BLOCK_IO_PROTOCOL
*This
,
277 Flushes all modified data to a physical block device.
279 @param This Indicates a pointer to the calling context.
281 @retval EFI_SUCCESS All outstanding data were written correctly to the device.
282 @retval EFI_DEVICE_ERROR The device reported an error while attempting to write data.
283 @retval EFI_NO_MEDIA There is no media in the device.
289 IN EFI_BLOCK_IO_PROTOCOL
*This
292 EFI_STATUS
InitializeMmcDevice (
293 IN MMC_HOST_INSTANCE
*MmcHost