Patch from open source community for CryptoPkg to allow it to build for ARM using...
[mirror_edk2.git] / ArmPkg / Universal / MmcDxe / Mmc.h
CommitLineData
1bfda055 1/** @file\r
2 Main Header file for the MMC DXE driver\r
3\r
4 Copyright (c) 2011, ARM Limited. All rights reserved.\r
5 \r
6 This program and the accompanying materials \r
7 are licensed and made available under the terms and conditions of the BSD License \r
8 which accompanies this distribution. The full text of the license may be found at \r
9 http://opensource.org/licenses/bsd-license.php \r
10\r
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
13\r
14**/\r
15\r
16#ifndef __MMC_H\r
17#define __MMC_H\r
18\r
a1ab9143 19#include <Uefi.h>\r
20\r
1bfda055 21#include <Protocol/DiskIo.h>\r
22#include <Protocol/BlockIo.h>\r
23#include <Protocol/DevicePath.h>\r
24#include <Protocol/MmcHost.h>\r
25\r
26#include <Library/UefiLib.h>\r
27\r
28#define MMC_TRACE(txt) DEBUG((EFI_D_BLKIO, "MMC: " txt "\n"))\r
29\r
30#define MMC_IOBLOCKS_READ 0\r
31#define MMC_IOBLOCKS_WRITE 1\r
32\r
33#define MMC_OCR_POWERUP 0x80000000\r
34\r
2ac288f9 35#define MMC_CSD_GET_CCC(Response) (Response[1] >> 20)\r
36#define MMC_CSD_GET_TRANSPEED(Response) (Response[0] & 0xFF)\r
37#define MMC_CSD_GET_READBLLEN(Response) ((Response[1] >> 16) & 0xF)\r
38#define MMC_CSD_GET_WRITEBLLEN(Response) ((Response[3] >> 22) & 0xF)\r
39#define MMC_CSD_GET_FILEFORMAT(Response) ((Response[3] >> 10) & 0x3)\r
40#define MMC_CSD_GET_FILEFORMATGRP(Response) ((Response[3] >> 15) & 0x1)\r
1bfda055 41#define MMC_CSD_GET_DEVICESIZE(csd) (((Response[2] >> 30) & 0x3) | ((Response[1] & 0x3FF) << 2))\r
42#define MMC_CSD_GET_DEVICESIZEMULT(csd) ((Response[2] >> 15) & 0x7)\r
43\r
44#define MMC_R0_CURRENTSTATE(Response) ((Response[0] >> 9) & 0xF)\r
45\r
46#define MMC_R0_STATE_IDLE 0\r
47#define MMC_R0_STATE_READY 1\r
48#define MMC_R0_STATE_IDENT 2\r
49#define MMC_R0_STATE_STDBY 3\r
50#define MMC_R0_STATE_TRAN 4\r
51#define MMC_R0_STATE_DATA 5\r
52\r
53typedef enum {\r
54 UNKNOWN_CARD,\r
55 MMC_CARD, //MMC card\r
56 MMC_CARD_HIGH, //MMC Card with High capacity\r
57 SD_CARD, //SD 1.1 card\r
58 SD_CARD_2, //SD 2.0 or above standard card\r
59 SD_CARD_2_HIGH //SD 2.0 or above high capacity card\r
60} CARD_TYPE;\r
61\r
62typedef struct {\r
63 UINT32 Reserved0: 7; // 0 \r
64 UINT32 V170_V195: 1; // 1.70V - 1.95V\r
65 UINT32 V200_V260: 7; // 2.00V - 2.60V\r
66 UINT32 V270_V360: 9; // 2.70V - 3.60V\r
67 UINT32 RESERVED_1: 5; // Reserved\r
68 UINT32 AccessMode: 2; // 00b (byte mode), 10b (sector mode) \r
69 UINT32 Busy: 1; // This bit is set to LOW if the card has not finished the power up routine\r
70} OCR;\r
71\r
72typedef struct {\r
73 UINT32 NOT_USED; // 1 [0:0]\r
74 UINT32 CRC; // CRC7 checksum [7:1]\r
75 UINT32 MDT; // Manufacturing date [19:8]\r
76 UINT32 RESERVED_1; // Reserved [23:20]\r
77 UINT32 PSN; // Product serial number [55:24]\r
78 UINT8 PRV; // Product revision [63:56]\r
79 UINT8 PNM[5]; // Product name [64:103]\r
80 UINT16 OID; // OEM/Application ID [119:104]\r
81 UINT8 MID; // Manufacturer ID [127:120]\r
82} CID;\r
83\r
84typedef struct {\r
85 UINT8 NOT_USED: 1; // Not used, always 1 [0:0]\r
86 UINT8 CRC: 7; // CRC [7:1]\r
87\r
88 UINT8 RESERVED_1: 2; // Reserved [9:8]\r
89 UINT8 FILE_FORMAT: 2; // File format [11:10]\r
90 UINT8 TMP_WRITE_PROTECT: 1; // Temporary write protection [12:12]\r
91 UINT8 PERM_WRITE_PROTECT: 1; // Permanent write protection [13:13]\r
92 UINT8 COPY: 1; // Copy flag (OTP) [14:14]\r
93 UINT8 FILE_FORMAT_GRP: 1; // File format group [15:15]\r
94 \r
95 UINT16 RESERVED_2: 5; // Reserved [20:16]\r
96 UINT16 WRITE_BL_PARTIAL: 1; // Partial blocks for write allowed [21:21]\r
97 UINT16 WRITE_BL_LEN: 4; // Max. write data block length [25:22]\r
98 UINT16 R2W_FACTOR: 3; // Write speed factor [28:26]\r
99 UINT16 RESERVED_3: 2; // Reserved [30:29]\r
100 UINT16 WP_GRP_ENABLE: 1; // Write protect group enable [31:31]\r
101 \r
102 UINT32 WP_GRP_SIZE: 7; // Write protect group size [38:32]\r
103 UINT32 SECTOR_SIZE: 7; // Erase sector size [45:39]\r
104 UINT32 ERASE_BLK_EN: 1; // Erase single block enable [46:46]\r
105 UINT32 C_SIZE_MULT: 3; // Device size multiplier [49:47]\r
106 UINT32 VDD_W_CURR_MAX: 3; // Max. write current @ VDD max [52:50]\r
107 UINT32 VDD_W_CURR_MIN: 3; // Max. write current @ VDD min [55:53]\r
108 UINT32 VDD_R_CURR_MAX: 3; // Max. read current @ VDD max [58:56]\r
109 UINT32 VDD_R_CURR_MIN: 3; // Max. read current @ VDD min [61:59]\r
110 UINT32 C_SIZELow2: 2; // Device size [63:62]\r
111 \r
112 UINT32 C_SIZEHigh10: 10;// Device size [73:64]\r
113 UINT32 RESERVED_4: 2; // Reserved [75:74]\r
114 UINT32 DSR_IMP: 1; // DSR implemented [76:76]\r
115 UINT32 READ_BLK_MISALIGN: 1; // Read block misalignment [77:77]\r
116 UINT32 WRITE_BLK_MISALIGN: 1; // Write block misalignment [78:78]\r
117 UINT32 READ_BL_PARTIAL: 1; // Partial blocks for read allowed [79:79]\r
118 UINT32 READ_BL_LEN: 4; // Max. read data block length [83:80]\r
119 UINT32 CCC: 12;// Card command classes [95:84]\r
120\r
121 UINT8 TRAN_SPEED ; // Max. bus clock frequency [103:96]\r
122 UINT8 NSAC ; // Data read access-time 2 in CLK cycles (NSAC*100) [111:104]\r
123 UINT8 TAAC ; // Data read access-time 1 [119:112]\r
124 \r
125 UINT8 RESERVED_5: 6; // Reserved [125:120]\r
126 UINT8 CSD_STRUCTURE: 2; // CSD structure [127:126]\r
127} CSD;\r
128\r
129typedef struct {\r
130 UINT16 RCA;\r
131 CARD_TYPE CardType;\r
132 OCR OCRData;\r
133 CID CIDData;\r
134 CSD CSDData;\r
135} CARD_INFO;\r
136\r
137typedef struct _MMC_HOST_INSTANCE {\r
138 UINTN Signature;\r
139 LIST_ENTRY Link;\r
140 EFI_HANDLE MmcHandle;\r
141 EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
142\r
143 MMC_STATE State;\r
144 EFI_BLOCK_IO_PROTOCOL BlockIo;\r
145 CARD_INFO CardInfo;\r
146 EFI_MMC_HOST_PROTOCOL *MmcHost;\r
147} MMC_HOST_INSTANCE;\r
148\r
149#define MMC_HOST_INSTANCE_SIGNATURE SIGNATURE_32('m', 'm', 'c', 'h')\r
150#define MMC_HOST_INSTANCE_FROM_BLOCK_IO_THIS(a) CR (a, MMC_HOST_INSTANCE, BlockIo, MMC_HOST_INSTANCE_SIGNATURE)\r
151#define MMC_HOST_INSTANCE_FROM_LINK(a) CR (a, MMC_HOST_INSTANCE, Link, MMC_HOST_INSTANCE_SIGNATURE)\r
152\r
153\r
154EFI_STATUS\r
155EFIAPI\r
156MmcGetDriverName (\r
157 IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
158 IN CHAR8 *Language,\r
159 OUT CHAR16 **DriverName\r
160 );\r
161\r
162EFI_STATUS\r
163EFIAPI\r
164MmcGetControllerName (\r
165 IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
166 IN EFI_HANDLE ControllerHandle,\r
167 IN EFI_HANDLE ChildHandle OPTIONAL,\r
168 IN CHAR8 *Language,\r
169 OUT CHAR16 **ControllerName\r
170 );\r
171\r
172extern EFI_COMPONENT_NAME_PROTOCOL gMmcComponentName;\r
173extern EFI_COMPONENT_NAME2_PROTOCOL gMmcComponentName2;\r
174\r
175extern EFI_DRIVER_DIAGNOSTICS2_PROTOCOL gMmcDriverDiagnostics2;\r
176\r
177extern LIST_ENTRY mMmcHostPool;\r
178\r
179/**\r
180 Reset the block device.\r
181\r
182 This function implements EFI_BLOCK_IO_PROTOCOL.Reset(). \r
183 It resets the block device hardware.\r
184 ExtendedVerification is ignored in this implementation.\r
185\r
186 @param This Indicates a pointer to the calling context.\r
187 @param ExtendedVerification Indicates that the driver may perform a more exhaustive\r
188 verification operation of the device during reset.\r
189\r
190 @retval EFI_SUCCESS The block device was reset.\r
191 @retval EFI_DEVICE_ERROR The block device is not functioning correctly and could not be reset.\r
192\r
193**/\r
194EFI_STATUS\r
195EFIAPI\r
196MmcReset (\r
197 IN EFI_BLOCK_IO_PROTOCOL *This,\r
198 IN BOOLEAN ExtendedVerification\r
199 );\r
200\r
201/**\r
202 Reads the requested number of blocks from the device.\r
203\r
204 This function implements EFI_BLOCK_IO_PROTOCOL.ReadBlocks(). \r
205 It reads the requested number of blocks from the device.\r
206 All the blocks are read, or an error is returned.\r
207\r
208 @param This Indicates a pointer to the calling context.\r
209 @param MediaId The media ID that the read request is for.\r
210 @param Lba The starting logical block address to read from on the device.\r
211 @param BufferSize The size of the Buffer in bytes.\r
212 This must be a multiple of the intrinsic block size of the device.\r
213 @param Buffer A pointer to the destination buffer for the data. The caller is\r
214 responsible for either having implicit or explicit ownership of the buffer.\r
215\r
216 @retval EFI_SUCCESS The data was read correctly from the device.\r
217 @retval EFI_DEVICE_ERROR The device reported an error while attempting to perform the read operation.\r
218 @retval EFI_NO_MEDIA There is no media in the device.\r
219 @retval EFI_MEDIA_CHANGED The MediaId is not for the current media.\r
220 @retval EFI_BAD_BUFFER_SIZE The BufferSize parameter is not a multiple of the intrinsic block size of the device.\r
221 @retval EFI_INVALID_PARAMETER The read request contains LBAs that are not valid,\r
222 or the buffer is not on proper alignment.\r
223\r
224**/\r
225EFI_STATUS\r
226EFIAPI\r
227MmcReadBlocks (\r
228 IN EFI_BLOCK_IO_PROTOCOL *This,\r
229 IN UINT32 MediaId,\r
230 IN EFI_LBA Lba,\r
231 IN UINTN BufferSize,\r
232 OUT VOID *Buffer\r
233 );\r
234\r
235/**\r
236 Writes a specified number of blocks to the device.\r
237\r
238 This function implements EFI_BLOCK_IO_PROTOCOL.WriteBlocks(). \r
239 It writes a specified number of blocks to the device.\r
240 All blocks are written, or an error is returned.\r
241\r
242 @param This Indicates a pointer to the calling context.\r
243 @param MediaId The media ID that the write request is for.\r
244 @param Lba The starting logical block address to be written.\r
245 @param BufferSize The size of the Buffer in bytes.\r
246 This must be a multiple of the intrinsic block size of the device.\r
247 @param Buffer Pointer to the source buffer for the data.\r
248\r
249 @retval EFI_SUCCESS The data were written correctly to the device.\r
250 @retval EFI_WRITE_PROTECTED The device cannot be written to.\r
251 @retval EFI_NO_MEDIA There is no media in the device.\r
252 @retval EFI_MEDIA_CHANGED The MediaId is not for the current media.\r
253 @retval EFI_DEVICE_ERROR The device reported an error while attempting to perform the write operation.\r
254 @retval EFI_BAD_BUFFER_SIZE The BufferSize parameter is not a multiple of the intrinsic\r
255 block size of the device.\r
256 @retval EFI_INVALID_PARAMETER The write request contains LBAs that are not valid,\r
257 or the buffer is not on proper alignment.\r
258\r
259**/\r
260EFI_STATUS\r
261EFIAPI\r
262MmcWriteBlocks (\r
263 IN EFI_BLOCK_IO_PROTOCOL *This,\r
264 IN UINT32 MediaId,\r
265 IN EFI_LBA Lba,\r
266 IN UINTN BufferSize,\r
267 IN VOID *Buffer\r
268 );\r
269\r
270/**\r
271 Flushes all modified data to a physical block device.\r
272\r
273 @param This Indicates a pointer to the calling context.\r
274\r
275 @retval EFI_SUCCESS All outstanding data were written correctly to the device.\r
276 @retval EFI_DEVICE_ERROR The device reported an error while attempting to write data.\r
277 @retval EFI_NO_MEDIA There is no media in the device.\r
278\r
279**/\r
280EFI_STATUS\r
281EFIAPI\r
282MmcFlushBlocks (\r
283 IN EFI_BLOCK_IO_PROTOCOL *This\r
284 );\r
285\r
286#endif\r