EmbeddedPkg: MmcDxe: move ECSD into CardInfo structure
[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
3402aac7
RC
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
1bfda055 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
4ca3c688 27#include <Library/DebugLib.h>\r
eff98cf9 28#include <Library/UefiBootServicesTableLib.h>\r
1bfda055 29\r
30#define MMC_TRACE(txt) DEBUG((EFI_D_BLKIO, "MMC: " txt "\n"))\r
31\r
32#define MMC_IOBLOCKS_READ 0\r
33#define MMC_IOBLOCKS_WRITE 1\r
34\r
35#define MMC_OCR_POWERUP 0x80000000\r
36\r
bb0f9e9b 37#define MMC_CSD_GET_CCC(Response) (Response[2] >> 20)\r
38#define MMC_CSD_GET_TRANSPEED(Response) (Response[3] & 0xFF)\r
39#define MMC_CSD_GET_READBLLEN(Response) ((Response[2] >> 16) & 0xF)\r
40#define MMC_CSD_GET_WRITEBLLEN(Response) ((Response[0] >> 22) & 0xF)\r
41#define MMC_CSD_GET_FILEFORMAT(Response) ((Response[0] >> 10) & 0x3)\r
42#define MMC_CSD_GET_FILEFORMATGRP(Response) ((Response[0] >> 15) & 0x1)\r
43#define MMC_CSD_GET_DEVICESIZE(csd) (((Response[1] >> 30) & 0x3) | ((Response[2] & 0x3FF) << 2))\r
36aa5611 44#define HC_MMC_CSD_GET_DEVICESIZE(Response) ((Response[1] >> 16) | ((Response[2] & 0x40) << 16));\r
bb0f9e9b 45#define MMC_CSD_GET_DEVICESIZEMULT(csd) ((Response[1] >> 15) & 0x7)\r
1bfda055 46\r
b9d5fe03 47#define MMC_R0_READY_FOR_DATA (1 << 8)\r
48\r
1bfda055 49#define MMC_R0_CURRENTSTATE(Response) ((Response[0] >> 9) & 0xF)\r
50\r
51#define MMC_R0_STATE_IDLE 0\r
52#define MMC_R0_STATE_READY 1\r
53#define MMC_R0_STATE_IDENT 2\r
54#define MMC_R0_STATE_STDBY 3\r
55#define MMC_R0_STATE_TRAN 4\r
56#define MMC_R0_STATE_DATA 5\r
57\r
58typedef enum {\r
59 UNKNOWN_CARD,\r
60 MMC_CARD, //MMC card\r
61 MMC_CARD_HIGH, //MMC Card with High capacity\r
b4fdedc2 62 EMMC_CARD, //eMMC 4.41 card\r
1bfda055 63 SD_CARD, //SD 1.1 card\r
64 SD_CARD_2, //SD 2.0 or above standard card\r
65 SD_CARD_2_HIGH //SD 2.0 or above high capacity card\r
66} CARD_TYPE;\r
67\r
68typedef struct {\r
3402aac7 69 UINT32 Reserved0: 7; // 0\r
1bfda055 70 UINT32 V170_V195: 1; // 1.70V - 1.95V\r
71 UINT32 V200_V260: 7; // 2.00V - 2.60V\r
72 UINT32 V270_V360: 9; // 2.70V - 3.60V\r
73 UINT32 RESERVED_1: 5; // Reserved\r
3402aac7 74 UINT32 AccessMode: 2; // 00b (byte mode), 10b (sector mode)\r
492e34a5 75 UINT32 PowerUp: 1; // This bit is set to LOW if the card has not finished the power up routine\r
1bfda055 76} OCR;\r
77\r
78typedef struct {\r
79 UINT32 NOT_USED; // 1 [0:0]\r
80 UINT32 CRC; // CRC7 checksum [7:1]\r
81 UINT32 MDT; // Manufacturing date [19:8]\r
82 UINT32 RESERVED_1; // Reserved [23:20]\r
83 UINT32 PSN; // Product serial number [55:24]\r
84 UINT8 PRV; // Product revision [63:56]\r
85 UINT8 PNM[5]; // Product name [64:103]\r
86 UINT16 OID; // OEM/Application ID [119:104]\r
87 UINT8 MID; // Manufacturer ID [127:120]\r
88} CID;\r
89\r
90typedef struct {\r
91 UINT8 NOT_USED: 1; // Not used, always 1 [0:0]\r
92 UINT8 CRC: 7; // CRC [7:1]\r
93\r
94 UINT8 RESERVED_1: 2; // Reserved [9:8]\r
95 UINT8 FILE_FORMAT: 2; // File format [11:10]\r
96 UINT8 TMP_WRITE_PROTECT: 1; // Temporary write protection [12:12]\r
97 UINT8 PERM_WRITE_PROTECT: 1; // Permanent write protection [13:13]\r
98 UINT8 COPY: 1; // Copy flag (OTP) [14:14]\r
99 UINT8 FILE_FORMAT_GRP: 1; // File format group [15:15]\r
3402aac7 100\r
1bfda055 101 UINT16 RESERVED_2: 5; // Reserved [20:16]\r
102 UINT16 WRITE_BL_PARTIAL: 1; // Partial blocks for write allowed [21:21]\r
103 UINT16 WRITE_BL_LEN: 4; // Max. write data block length [25:22]\r
104 UINT16 R2W_FACTOR: 3; // Write speed factor [28:26]\r
105 UINT16 RESERVED_3: 2; // Reserved [30:29]\r
106 UINT16 WP_GRP_ENABLE: 1; // Write protect group enable [31:31]\r
3402aac7 107\r
1bfda055 108 UINT32 WP_GRP_SIZE: 7; // Write protect group size [38:32]\r
109 UINT32 SECTOR_SIZE: 7; // Erase sector size [45:39]\r
110 UINT32 ERASE_BLK_EN: 1; // Erase single block enable [46:46]\r
111 UINT32 C_SIZE_MULT: 3; // Device size multiplier [49:47]\r
112 UINT32 VDD_W_CURR_MAX: 3; // Max. write current @ VDD max [52:50]\r
113 UINT32 VDD_W_CURR_MIN: 3; // Max. write current @ VDD min [55:53]\r
114 UINT32 VDD_R_CURR_MAX: 3; // Max. read current @ VDD max [58:56]\r
115 UINT32 VDD_R_CURR_MIN: 3; // Max. read current @ VDD min [61:59]\r
116 UINT32 C_SIZELow2: 2; // Device size [63:62]\r
3402aac7 117\r
1bfda055 118 UINT32 C_SIZEHigh10: 10;// Device size [73:64]\r
119 UINT32 RESERVED_4: 2; // Reserved [75:74]\r
120 UINT32 DSR_IMP: 1; // DSR implemented [76:76]\r
121 UINT32 READ_BLK_MISALIGN: 1; // Read block misalignment [77:77]\r
122 UINT32 WRITE_BLK_MISALIGN: 1; // Write block misalignment [78:78]\r
123 UINT32 READ_BL_PARTIAL: 1; // Partial blocks for read allowed [79:79]\r
124 UINT32 READ_BL_LEN: 4; // Max. read data block length [83:80]\r
125 UINT32 CCC: 12;// Card command classes [95:84]\r
126\r
127 UINT8 TRAN_SPEED ; // Max. bus clock frequency [103:96]\r
128 UINT8 NSAC ; // Data read access-time 2 in CLK cycles (NSAC*100) [111:104]\r
129 UINT8 TAAC ; // Data read access-time 1 [119:112]\r
3402aac7 130\r
1bfda055 131 UINT8 RESERVED_5: 6; // Reserved [125:120]\r
132 UINT8 CSD_STRUCTURE: 2; // CSD structure [127:126]\r
133} CSD;\r
134\r
135typedef struct {\r
136 UINT16 RCA;\r
137 CARD_TYPE CardType;\r
138 OCR OCRData;\r
139 CID CIDData;\r
140 CSD CSDData;\r
36bec33a 141 UINT32 ECSD[128]; // MMC V4 extended card specific\r
1bfda055 142} CARD_INFO;\r
143\r
144typedef struct _MMC_HOST_INSTANCE {\r
145 UINTN Signature;\r
146 LIST_ENTRY Link;\r
147 EFI_HANDLE MmcHandle;\r
148 EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
149\r
150 MMC_STATE State;\r
151 EFI_BLOCK_IO_PROTOCOL BlockIo;\r
152 CARD_INFO CardInfo;\r
153 EFI_MMC_HOST_PROTOCOL *MmcHost;\r
3402aac7 154\r
3de99375 155 BOOLEAN Initialized;\r
1bfda055 156} MMC_HOST_INSTANCE;\r
157\r
158#define MMC_HOST_INSTANCE_SIGNATURE SIGNATURE_32('m', 'm', 'c', 'h')\r
159#define MMC_HOST_INSTANCE_FROM_BLOCK_IO_THIS(a) CR (a, MMC_HOST_INSTANCE, BlockIo, MMC_HOST_INSTANCE_SIGNATURE)\r
160#define MMC_HOST_INSTANCE_FROM_LINK(a) CR (a, MMC_HOST_INSTANCE, Link, MMC_HOST_INSTANCE_SIGNATURE)\r
161\r
162\r
163EFI_STATUS\r
164EFIAPI\r
165MmcGetDriverName (\r
166 IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
167 IN CHAR8 *Language,\r
168 OUT CHAR16 **DriverName\r
169 );\r
170\r
171EFI_STATUS\r
172EFIAPI\r
173MmcGetControllerName (\r
174 IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
175 IN EFI_HANDLE ControllerHandle,\r
176 IN EFI_HANDLE ChildHandle OPTIONAL,\r
177 IN CHAR8 *Language,\r
178 OUT CHAR16 **ControllerName\r
179 );\r
180\r
181extern EFI_COMPONENT_NAME_PROTOCOL gMmcComponentName;\r
182extern EFI_COMPONENT_NAME2_PROTOCOL gMmcComponentName2;\r
183\r
184extern EFI_DRIVER_DIAGNOSTICS2_PROTOCOL gMmcDriverDiagnostics2;\r
185\r
186extern LIST_ENTRY mMmcHostPool;\r
187\r
188/**\r
189 Reset the block device.\r
190\r
3402aac7 191 This function implements EFI_BLOCK_IO_PROTOCOL.Reset().\r
1bfda055 192 It resets the block device hardware.\r
193 ExtendedVerification is ignored in this implementation.\r
194\r
195 @param This Indicates a pointer to the calling context.\r
196 @param ExtendedVerification Indicates that the driver may perform a more exhaustive\r
197 verification operation of the device during reset.\r
198\r
199 @retval EFI_SUCCESS The block device was reset.\r
200 @retval EFI_DEVICE_ERROR The block device is not functioning correctly and could not be reset.\r
201\r
202**/\r
203EFI_STATUS\r
204EFIAPI\r
205MmcReset (\r
206 IN EFI_BLOCK_IO_PROTOCOL *This,\r
207 IN BOOLEAN ExtendedVerification\r
208 );\r
209\r
210/**\r
211 Reads the requested number of blocks from the device.\r
212\r
3402aac7 213 This function implements EFI_BLOCK_IO_PROTOCOL.ReadBlocks().\r
1bfda055 214 It reads the requested number of blocks from the device.\r
215 All the blocks are read, or an error is returned.\r
216\r
217 @param This Indicates a pointer to the calling context.\r
218 @param MediaId The media ID that the read request is for.\r
219 @param Lba The starting logical block address to read from on the device.\r
220 @param BufferSize The size of the Buffer in bytes.\r
221 This must be a multiple of the intrinsic block size of the device.\r
222 @param Buffer A pointer to the destination buffer for the data. The caller is\r
223 responsible for either having implicit or explicit ownership of the buffer.\r
224\r
225 @retval EFI_SUCCESS The data was read correctly from the device.\r
226 @retval EFI_DEVICE_ERROR The device reported an error while attempting to perform the read operation.\r
227 @retval EFI_NO_MEDIA There is no media in the device.\r
228 @retval EFI_MEDIA_CHANGED The MediaId is not for the current media.\r
229 @retval EFI_BAD_BUFFER_SIZE The BufferSize parameter is not a multiple of the intrinsic block size of the device.\r
230 @retval EFI_INVALID_PARAMETER The read request contains LBAs that are not valid,\r
231 or the buffer is not on proper alignment.\r
232\r
233**/\r
234EFI_STATUS\r
235EFIAPI\r
236MmcReadBlocks (\r
237 IN EFI_BLOCK_IO_PROTOCOL *This,\r
238 IN UINT32 MediaId,\r
239 IN EFI_LBA Lba,\r
240 IN UINTN BufferSize,\r
241 OUT VOID *Buffer\r
242 );\r
243\r
244/**\r
245 Writes a specified number of blocks to the device.\r
246\r
3402aac7 247 This function implements EFI_BLOCK_IO_PROTOCOL.WriteBlocks().\r
1bfda055 248 It writes a specified number of blocks to the device.\r
249 All blocks are written, or an error is returned.\r
250\r
251 @param This Indicates a pointer to the calling context.\r
252 @param MediaId The media ID that the write request is for.\r
253 @param Lba The starting logical block address to be written.\r
254 @param BufferSize The size of the Buffer in bytes.\r
255 This must be a multiple of the intrinsic block size of the device.\r
256 @param Buffer Pointer to the source buffer for the data.\r
257\r
258 @retval EFI_SUCCESS The data were written correctly to the device.\r
259 @retval EFI_WRITE_PROTECTED The device cannot be written to.\r
260 @retval EFI_NO_MEDIA There is no media in the device.\r
261 @retval EFI_MEDIA_CHANGED The MediaId is not for the current media.\r
262 @retval EFI_DEVICE_ERROR The device reported an error while attempting to perform the write operation.\r
263 @retval EFI_BAD_BUFFER_SIZE The BufferSize parameter is not a multiple of the intrinsic\r
264 block size of the device.\r
265 @retval EFI_INVALID_PARAMETER The write request contains LBAs that are not valid,\r
266 or the buffer is not on proper alignment.\r
267\r
268**/\r
269EFI_STATUS\r
270EFIAPI\r
271MmcWriteBlocks (\r
272 IN EFI_BLOCK_IO_PROTOCOL *This,\r
273 IN UINT32 MediaId,\r
274 IN EFI_LBA Lba,\r
275 IN UINTN BufferSize,\r
276 IN VOID *Buffer\r
277 );\r
278\r
279/**\r
280 Flushes all modified data to a physical block device.\r
281\r
282 @param This Indicates a pointer to the calling context.\r
283\r
284 @retval EFI_SUCCESS All outstanding data were written correctly to the device.\r
285 @retval EFI_DEVICE_ERROR The device reported an error while attempting to write data.\r
286 @retval EFI_NO_MEDIA There is no media in the device.\r
287\r
288**/\r
289EFI_STATUS\r
290EFIAPI\r
291MmcFlushBlocks (\r
292 IN EFI_BLOCK_IO_PROTOCOL *This\r
293 );\r
294\r
b4fdedc2
OM
295EFI_STATUS\r
296MmcNotifyState (\r
297 IN MMC_HOST_INSTANCE *MmcHostInstance,\r
298 IN MMC_STATE State\r
299 );\r
300\r
301EFI_STATUS\r
302InitializeMmcDevice (\r
303 IN MMC_HOST_INSTANCE *MmcHost\r
40842a5e 304 );\r
305\r
306VOID\r
307EFIAPI\r
308CheckCardsCallback (\r
309 IN EFI_EVENT Event,\r
310 IN VOID *Context\r
311 );\r
312\r
4ca3c688
OM
313VOID\r
314PrintCSD (\r
315 IN UINT32* Csd\r
316 );\r
317\r
318VOID\r
319PrintRCA (\r
320 IN UINT32 Rca\r
321 );\r
322\r
323VOID\r
324PrintOCR (\r
325 IN UINT32 Ocr\r
326 );\r
327\r
328VOID\r
329PrintResponseR1 (\r
330 IN UINT32 Response\r
331 );\r
332\r
333VOID\r
334PrintCID (\r
335 IN UINT32* Cid\r
336 );\r
337\r
1bfda055 338#endif\r