1 /** @file
2 UEFI Component Name(2) protocol implementation for EmmcDxe driver.
3
4 Copyright (c) 2015 - 2016, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
9
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
12
13 **/
14
15 #include "EmmcDxe.h"
16
17 //
18 // Driver name table
19 //
20 GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mEmmcDxeDriverNameTable[] = {
21 { "eng;en", L"Edkii Emmc Device Driver" },
22 { NULL , NULL }
23 };
24
25 //
26 // Controller name table
27 //
28 GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mEmmcDxeControllerNameTable[] = {
29 { "eng;en", L"Edkii Emmc Host Controller" },
30 { NULL , NULL }
31 };
32
33 //
34 // EFI Component Name Protocol
35 //
36 GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL gEmmcDxeComponentName = {
37 EmmcDxeComponentNameGetDriverName,
38 EmmcDxeComponentNameGetControllerName,
39 "eng"
40 };
41
42 //
43 // EFI Component Name 2 Protocol
44 //
45 GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL gEmmcDxeComponentName2 = {
46 (EFI_COMPONENT_NAME2_GET_DRIVER_NAME) EmmcDxeComponentNameGetDriverName,
47 (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) EmmcDxeComponentNameGetControllerName,
48 "en"
49 };
50
51 /**
52 Retrieves a Unicode string that is the user readable name of the driver.
53
54 This function retrieves the user readable name of a driver in the form of a
55 Unicode string. If the driver specified by This has a user readable name in
56 the language specified by Language, then a pointer to the driver name is
57 returned in DriverName, and EFI_SUCCESS is returned. If the driver specified
58 by This does not support the language specified by Language,
59 then EFI_UNSUPPORTED is returned.
60
61 @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
62 EFI_COMPONENT_NAME_PROTOCOL instance.
63
64 @param Language[in] A pointer to a Null-terminated ASCII string
65 array indicating the language. This is the
66 language of the driver name that the caller is
67 requesting, and it must match one of the
68 languages specified in SupportedLanguages. The
69 number of languages supported by a driver is up
70 to the driver writer. Language is specified
71 in RFC 4646 or ISO 639-2 language code format.
72
73 @param DriverName[out] A pointer to the Unicode string to return.
74 This Unicode string is the name of the
75 driver specified by This in the language
76 specified by Language.
77
78 @retval EFI_SUCCESS The Unicode string for the Driver specified by
79 This and the language specified by Language was
80 returned in DriverName.
81
82 @retval EFI_INVALID_PARAMETER Language is NULL.
83
84 @retval EFI_INVALID_PARAMETER DriverName is NULL.
85
86 @retval EFI_UNSUPPORTED The driver specified by This does not support
87 the language specified by Language.
88
89 **/
90 EFI_STATUS
91 EFIAPI
EmmcDxeComponentNameGetDriverName(IN EFI_COMPONENT_NAME_PROTOCOL * This,IN CHAR8 * Language,OUT CHAR16 ** DriverName)92 EmmcDxeComponentNameGetDriverName (
93 IN EFI_COMPONENT_NAME_PROTOCOL *This,
94 IN CHAR8 *Language,
95 OUT CHAR16 **DriverName
96 )
97 {
98 return LookupUnicodeString2 (
99 Language,
100 This->SupportedLanguages,
101 mEmmcDxeDriverNameTable,
102 DriverName,
103 (BOOLEAN)(This == &gEmmcDxeComponentName)
104 );
105
106 }
107
108 /**
109 Retrieves a Unicode string that is the user readable name of the controller
110 that is being managed by a driver.
111
112 This function retrieves the user readable name of the controller specified by
113 ControllerHandle and ChildHandle in the form of a Unicode string. If the
114 driver specified by This has a user readable name in the language specified by
115 Language, then a pointer to the controller name is returned in ControllerName,
116 and EFI_SUCCESS is returned. If the driver specified by This is not currently
117 managing the controller specified by ControllerHandle and ChildHandle,
118 then EFI_UNSUPPORTED is returned. If the driver specified by This does not
119 support the language specified by Language, then EFI_UNSUPPORTED is returned.
120
121 @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
122 EFI_COMPONENT_NAME_PROTOCOL instance.
123
124 @param ControllerHandle[in] The handle of a controller that the driver
125 specified by This is managing. This handle
126 specifies the controller whose name is to be
127 returned.
128
129 @param ChildHandle[in] The handle of the child controller to retrieve
130 the name of. This is an optional parameter that
131 may be NULL. It will be NULL for device
132 drivers. It will also be NULL for a bus drivers
133 that wish to retrieve the name of the bus
134 controller. It will not be NULL for a bus
135 driver that wishes to retrieve the name of a
136 child controller.
137
138 @param Language[in] A pointer to a Null-terminated ASCII string
139 array indicating the language. This is the
140 language of the driver name that the caller is
141 requesting, and it must match one of the
142 languages specified in SupportedLanguages. The
143 number of languages supported by a driver is up
144 to the driver writer. Language is specified in
145 RFC 4646 or ISO 639-2 language code format.
146
147 @param ControllerName[out] A pointer to the Unicode string to return.
148 This Unicode string is the name of the
149 controller specified by ControllerHandle and
150 ChildHandle in the language specified by
151 Language from the point of view of the driver
152 specified by This.
153
154 @retval EFI_SUCCESS The Unicode string for the user readable name in
155 the language specified by Language for the
156 driver specified by This was returned in
157 DriverName.
158
159 @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.
160
161 @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid
162 EFI_HANDLE.
163
164 @retval EFI_INVALID_PARAMETER Language is NULL.
165
166 @retval EFI_INVALID_PARAMETER ControllerName is NULL.
167
168 @retval EFI_UNSUPPORTED The driver specified by This is not currently
169 managing the controller specified by
170 ControllerHandle and ChildHandle.
171
172 @retval EFI_UNSUPPORTED The driver specified by This does not support
173 the language specified by Language.
174
175 **/
176 EFI_STATUS
177 EFIAPI
EmmcDxeComponentNameGetControllerName(IN EFI_COMPONENT_NAME_PROTOCOL * This,IN EFI_HANDLE ControllerHandle,IN EFI_HANDLE ChildHandle OPTIONAL,IN CHAR8 * Language,OUT CHAR16 ** ControllerName)178 EmmcDxeComponentNameGetControllerName (
179 IN EFI_COMPONENT_NAME_PROTOCOL *This,
180 IN EFI_HANDLE ControllerHandle,
181 IN EFI_HANDLE ChildHandle OPTIONAL,
182 IN CHAR8 *Language,
183 OUT CHAR16 **ControllerName
184 )
185 {
186 EFI_STATUS Status;
187 EFI_BLOCK_IO_PROTOCOL *BlockIo;
188 EMMC_DEVICE *Device;
189 EMMC_PARTITION *Partition;
190 EFI_UNICODE_STRING_TABLE *ControllerNameTable;
191
192 //
193 // Make sure this driver is currently managing ControllHandle
194 //
195 Status = EfiTestManagedDevice (
196 ControllerHandle,
197 gEmmcDxeDriverBinding.DriverBindingHandle,
198 &gEfiSdMmcPassThruProtocolGuid
199 );
200 if (EFI_ERROR (Status)) {
201 return Status;
202 }
203
204 ControllerNameTable = mEmmcDxeControllerNameTable;
205 if (ChildHandle != NULL) {
206 Status = EfiTestChildHandle (
207 ControllerHandle,
208 ChildHandle,
209 &gEfiSdMmcPassThruProtocolGuid
210 );
211 if (EFI_ERROR (Status)) {
212 return Status;
213 }
214 //
215 // Get the child context
216 //
217 Status = gBS->OpenProtocol (
218 ChildHandle,
219 &gEfiBlockIoProtocolGuid,
220 (VOID **) &BlockIo,
221 gEmmcDxeDriverBinding.DriverBindingHandle,
222 ChildHandle,
223 EFI_OPEN_PROTOCOL_GET_PROTOCOL
224 );
225 if (EFI_ERROR (Status)) {
226 return EFI_UNSUPPORTED;
227 }
228
229 Partition = EMMC_PARTITION_DATA_FROM_BLKIO (BlockIo);
230 Device = Partition->Device;
231 ControllerNameTable = Device->ControllerNameTable;
232 }
233
234 return LookupUnicodeString2 (
235 Language,
236 This->SupportedLanguages,
237 ControllerNameTable,
238 ControllerName,
239 (BOOLEAN)(This == &gEmmcDxeComponentName)
240 );
241 }
242
243