]> git.proxmox.com Git - mirror_edk2.git/blame - EmbeddedPkg/Include/Protocol/MmcHost.h
ShellPkg: remove memory leak in file handle list
[mirror_edk2.git] / EmbeddedPkg / Include / Protocol / MmcHost.h
CommitLineData
1bfda055 1/** @file\r
2 Definition of the MMC Host Protocol\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_HOST_H__\r
17#define __MMC_HOST_H__\r
18\r
19///\r
20/// Global ID for the MMC Host Protocol\r
21///\r
22#define EFI_MMC_HOST_PROTOCOL_GUID \\r
23 { 0x3e591c00, 0x9e4a, 0x11df, {0x92, 0x44, 0x00, 0x02, 0xA5, 0xD5, 0xC5, 0x1B } }\r
24\r
25#define MMC_RESPONSE_TYPE_R1 0\r
26#define MMC_RESPONSE_TYPE_R1b 0\r
27#define MMC_RESPONSE_TYPE_R2 1\r
28#define MMC_RESPONSE_TYPE_R3 0\r
29#define MMC_RESPONSE_TYPE_R6 0\r
30#define MMC_RESPONSE_TYPE_R7 0\r
31#define MMC_RESPONSE_TYPE_OCR 0\r
32#define MMC_RESPONSE_TYPE_CID 1\r
33#define MMC_RESPONSE_TYPE_CSD 1\r
34#define MMC_RESPONSE_TYPE_RCA 0\r
35\r
36typedef UINT32 MMC_RESPONSE_TYPE;\r
37\r
38typedef UINT32 MMC_CMD;\r
39\r
40#define MMC_CMD_WAIT_RESPONSE (1 << 16)\r
41#define MMC_CMD_LONG_RESPONSE (1 << 17)\r
2b826e73 42#define MMC_CMD_NO_CRC_RESPONSE (1 << 18)\r
1bfda055 43\r
2b826e73 44#define MMC_INDX(Index) ((Index) & 0xFFFF)\r
45#define MMC_GET_INDX(MmcCmd) ((MmcCmd) & 0xFFFF)\r
1bfda055 46\r
2b826e73 47#define MMC_CMD0 (MMC_INDX(0) | MMC_CMD_NO_CRC_RESPONSE)\r
48#define MMC_CMD1 (MMC_INDX(1) | MMC_CMD_WAIT_RESPONSE | MMC_CMD_NO_CRC_RESPONSE)\r
1bfda055 49#define MMC_CMD2 (MMC_INDX(2) | MMC_CMD_WAIT_RESPONSE | MMC_CMD_LONG_RESPONSE)\r
50#define MMC_CMD3 (MMC_INDX(3) | MMC_CMD_WAIT_RESPONSE)\r
2b826e73 51#define MMC_CMD5 (MMC_INDX(5) | MMC_CMD_WAIT_RESPONSE | MMC_CMD_NO_CRC_RESPONSE)\r
1bfda055 52#define MMC_CMD7 (MMC_INDX(7) | MMC_CMD_WAIT_RESPONSE)\r
53#define MMC_CMD8 (MMC_INDX(8) | MMC_CMD_WAIT_RESPONSE)\r
54#define MMC_CMD9 (MMC_INDX(9) | MMC_CMD_WAIT_RESPONSE | MMC_CMD_LONG_RESPONSE)\r
55#define MMC_CMD11 (MMC_INDX(11) | MMC_CMD_WAIT_RESPONSE)\r
56#define MMC_CMD12 (MMC_INDX(12) | MMC_CMD_WAIT_RESPONSE)\r
57#define MMC_CMD13 (MMC_INDX(13) | MMC_CMD_WAIT_RESPONSE)\r
58#define MMC_CMD16 (MMC_INDX(16) | MMC_CMD_WAIT_RESPONSE)\r
59#define MMC_CMD17 (MMC_INDX(17) | MMC_CMD_WAIT_RESPONSE)\r
60#define MMC_CMD18 (MMC_INDX(18) | MMC_CMD_WAIT_RESPONSE)\r
61#define MMC_CMD20 (MMC_INDX(20) | MMC_CMD_WAIT_RESPONSE)\r
62#define MMC_CMD23 (MMC_INDX(23) | MMC_CMD_WAIT_RESPONSE)\r
63#define MMC_CMD24 (MMC_INDX(24) | MMC_CMD_WAIT_RESPONSE)\r
64#define MMC_CMD55 (MMC_INDX(55) | MMC_CMD_WAIT_RESPONSE)\r
2b826e73 65#define MMC_ACMD41 (MMC_INDX(41) | MMC_CMD_WAIT_RESPONSE | MMC_CMD_NO_CRC_RESPONSE)\r
1bfda055 66\r
67typedef enum _MMC_STATE {\r
68 MmcInvalidState = 0,\r
69 MmcHwInitializationState,\r
70 MmcIdleState,\r
71 MmcReadyState,\r
72 MmcIdentificationState,\r
73 MmcStandByState,\r
74 MmcTransferState,\r
75 MmcSendingDataState,\r
76 MmcReceiveDataState,\r
77 MmcProgrammingState,\r
78 MmcDisconnectState,\r
79} MMC_STATE;\r
80\r
16d88c2d 81///\r
82/// Forward declaration for EFI_MMC_HOST_PROTOCOL\r
83///\r
84typedef struct _EFI_MMC_HOST_PROTOCOL EFI_MMC_HOST_PROTOCOL;\r
85\r
86typedef BOOLEAN (EFIAPI *MMC_ISCARDPRESENT) (\r
87 IN EFI_MMC_HOST_PROTOCOL *This\r
88 );\r
89\r
90typedef BOOLEAN (EFIAPI *MMC_ISREADONLY) (\r
91 IN EFI_MMC_HOST_PROTOCOL *This\r
92 );\r
93\r
94typedef EFI_STATUS (EFIAPI *MMC_BUILDDEVICEPATH) (\r
95 IN EFI_MMC_HOST_PROTOCOL *This,\r
96 OUT EFI_DEVICE_PATH_PROTOCOL **DevicePath\r
97 );\r
98\r
99typedef EFI_STATUS (EFIAPI *MMC_NOTIFYSTATE) (\r
100 IN EFI_MMC_HOST_PROTOCOL *This,\r
101 IN MMC_STATE State\r
102 );\r
103\r
104typedef EFI_STATUS (EFIAPI *MMC_SENDCOMMAND) (\r
105 IN EFI_MMC_HOST_PROTOCOL *This,\r
106 IN MMC_CMD Cmd,\r
107 IN UINT32 Argument\r
108 );\r
109\r
110typedef EFI_STATUS (EFIAPI *MMC_RECEIVERESPONSE) (\r
111 IN EFI_MMC_HOST_PROTOCOL *This,\r
112 IN MMC_RESPONSE_TYPE Type,\r
113 IN UINT32 *Buffer\r
114 );\r
115\r
116typedef EFI_STATUS (EFIAPI *MMC_READBLOCKDATA) (\r
117 IN EFI_MMC_HOST_PROTOCOL *This,\r
118 IN EFI_LBA Lba,\r
119 IN UINTN Length,\r
120 OUT UINT32 *Buffer\r
121 );\r
122\r
123typedef EFI_STATUS (EFIAPI *MMC_WRITEBLOCKDATA) (\r
124 IN EFI_MMC_HOST_PROTOCOL *This,\r
125 IN EFI_LBA Lba,\r
126 IN UINTN Length,\r
127 IN UINT32 *Buffer\r
128 );\r
1bfda055 129\r
1bfda055 130\r
6b062a86 131struct _EFI_MMC_HOST_PROTOCOL {\r
1bfda055 132\r
16d88c2d 133 UINT32 Revision;\r
134 MMC_ISCARDPRESENT IsCardPresent;\r
135 MMC_ISREADONLY IsReadOnly;\r
136 MMC_BUILDDEVICEPATH BuildDevicePath;\r
1bfda055 137\r
16d88c2d 138 MMC_NOTIFYSTATE NotifyState;\r
1bfda055 139\r
16d88c2d 140 MMC_SENDCOMMAND SendCommand;\r
141 MMC_RECEIVERESPONSE ReceiveResponse;\r
1bfda055 142\r
16d88c2d 143 MMC_READBLOCKDATA ReadBlockData;\r
144 MMC_WRITEBLOCKDATA WriteBlockData;\r
1bfda055 145\r
6b062a86 146};\r
1bfda055 147\r
16d88c2d 148#define MMC_HOST_PROTOCOL_REVISION 0x00010001 // 1.1\r
149\r
1bfda055 150extern EFI_GUID gEfiMmcHostProtocolGuid;\r
151\r
152#endif\r
153\r