Pkg-Module: CorebootPayloadPkg
[mirror_edk2.git] / CorebootPayloadPkg / FbGop / ComponentName.c
CommitLineData
9c228fb0
MM
1/** @file\r
2\r
3Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r
4\r
5This program and the accompanying materials\r
6are licensed and made available under the terms and conditions\r
7of the BSD License which accompanies this distribution. The\r
8full text of the license may be found at\r
9http://opensource.org/licenses/bsd-license.php\r
10\r
11THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
12WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
13\r
14**/\r
15\r
16#include "FbGop.h"\r
17\r
18//\r
19// EFI Component Name Functions\r
20//\r
21/**\r
22 Retrieves a Unicode string that is the user readable name of the driver.\r
23\r
24 This function retrieves the user readable name of a driver in the form of a\r
25 Unicode string. If the driver specified by This has a user readable name in\r
26 the language specified by Language, then a pointer to the driver name is\r
27 returned in DriverName, and EFI_SUCCESS is returned. If the driver specified\r
28 by This does not support the language specified by Language,\r
29 then EFI_UNSUPPORTED is returned.\r
30\r
31 @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
32 EFI_COMPONENT_NAME_PROTOCOL instance.\r
33\r
34 @param Language[in] A pointer to a Null-terminated ASCII string\r
35 array indicating the language. This is the\r
36 language of the driver name that the caller is\r
37 requesting, and it must match one of the\r
38 languages specified in SupportedLanguages. The\r
39 number of languages supported by a driver is up\r
40 to the driver writer. Language is specified\r
41 in RFC 4646 or ISO 639-2 language code format.\r
42\r
43 @param DriverName[out] A pointer to the Unicode string to return.\r
44 This Unicode string is the name of the\r
45 driver specified by This in the language\r
46 specified by Language.\r
47\r
48 @retval EFI_SUCCESS The Unicode string for the Driver specified by\r
49 This and the language specified by Language was\r
50 returned in DriverName.\r
51\r
52 @retval EFI_INVALID_PARAMETER Language is NULL.\r
53\r
54 @retval EFI_INVALID_PARAMETER DriverName is NULL.\r
55\r
56 @retval EFI_UNSUPPORTED The driver specified by This does not support\r
57 the language specified by Language.\r
58\r
59**/\r
60EFI_STATUS\r
61EFIAPI\r
62FbGopComponentNameGetDriverName (\r
63 IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
64 IN CHAR8 *Language,\r
65 OUT CHAR16 **DriverName\r
66 );\r
67\r
68\r
69/**\r
70 Retrieves a Unicode string that is the user readable name of the controller\r
71 that is being managed by a driver.\r
72\r
73 This function retrieves the user readable name of the controller specified by\r
74 ControllerHandle and ChildHandle in the form of a Unicode string. If the\r
75 driver specified by This has a user readable name in the language specified by\r
76 Language, then a pointer to the controller name is returned in ControllerName,\r
77 and EFI_SUCCESS is returned. If the driver specified by This is not currently\r
78 managing the controller specified by ControllerHandle and ChildHandle,\r
79 then EFI_UNSUPPORTED is returned. If the driver specified by This does not\r
80 support the language specified by Language, then EFI_UNSUPPORTED is returned.\r
81\r
82 @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
83 EFI_COMPONENT_NAME_PROTOCOL instance.\r
84\r
85 @param ControllerHandle[in] The handle of a controller that the driver\r
86 specified by This is managing. This handle\r
87 specifies the controller whose name is to be\r
88 returned.\r
89\r
90 @param ChildHandle[in] The handle of the child controller to retrieve\r
91 the name of. This is an optional parameter that\r
92 may be NULL. It will be NULL for device\r
93 drivers. It will also be NULL for a bus drivers\r
94 that wish to retrieve the name of the bus\r
95 controller. It will not be NULL for a bus\r
96 driver that wishes to retrieve the name of a\r
97 child controller.\r
98\r
99 @param Language[in] A pointer to a Null-terminated ASCII string\r
100 array indicating the language. This is the\r
101 language of the driver name that the caller is\r
102 requesting, and it must match one of the\r
103 languages specified in SupportedLanguages. The\r
104 number of languages supported by a driver is up\r
105 to the driver writer. Language is specified in\r
106 RFC 4646 or ISO 639-2 language code format.\r
107\r
108 @param ControllerName[out] A pointer to the Unicode string to return.\r
109 This Unicode string is the name of the\r
110 controller specified by ControllerHandle and\r
111 ChildHandle in the language specified by\r
112 Language from the point of view of the driver\r
113 specified by This.\r
114\r
115 @retval EFI_SUCCESS The Unicode string for the user readable name in\r
116 the language specified by Language for the\r
117 driver specified by This was returned in\r
118 DriverName.\r
119\r
120 @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.\r
121\r
122 @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid\r
123 EFI_HANDLE.\r
124\r
125 @retval EFI_INVALID_PARAMETER Language is NULL.\r
126\r
127 @retval EFI_INVALID_PARAMETER ControllerName is NULL.\r
128\r
129 @retval EFI_UNSUPPORTED The driver specified by This is not currently\r
130 managing the controller specified by\r
131 ControllerHandle and ChildHandle.\r
132\r
133 @retval EFI_UNSUPPORTED The driver specified by This does not support\r
134 the language specified by Language.\r
135\r
136**/\r
137EFI_STATUS\r
138EFIAPI\r
139FbGopComponentNameGetControllerName (\r
140 IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
141 IN EFI_HANDLE ControllerHandle,\r
142 IN EFI_HANDLE ChildHandle OPTIONAL,\r
143 IN CHAR8 *Language,\r
144 OUT CHAR16 **ControllerName\r
145 );\r
146\r
147\r
148//\r
149// EFI Component Name Protocol\r
150//\r
151GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL gFbGopComponentName = {\r
152 FbGopComponentNameGetDriverName,\r
153 FbGopComponentNameGetControllerName,\r
154 "eng"\r
155};\r
156\r
157//\r
158// EFI Component Name 2 Protocol\r
159//\r
160GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL gFbGopComponentName2 = {\r
161 (EFI_COMPONENT_NAME2_GET_DRIVER_NAME) FbGopComponentNameGetDriverName,\r
162 (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) FbGopComponentNameGetControllerName,\r
163 "en"\r
164};\r
165\r
166\r
167GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mFbGopDriverNameTable[] = {\r
168 {\r
169 "eng;en",\r
170 L"FB GOP Video Driver"\r
171 },\r
172 {\r
173 NULL,\r
174 NULL\r
175 }\r
176};\r
177\r
178/**\r
179 Retrieves a Unicode string that is the user readable name of the driver.\r
180\r
181 This function retrieves the user readable name of a driver in the form of a\r
182 Unicode string. If the driver specified by This has a user readable name in\r
183 the language specified by Language, then a pointer to the driver name is\r
184 returned in DriverName, and EFI_SUCCESS is returned. If the driver specified\r
185 by This does not support the language specified by Language,\r
186 then EFI_UNSUPPORTED is returned.\r
187\r
188 @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
189 EFI_COMPONENT_NAME_PROTOCOL instance.\r
190\r
191 @param Language[in] A pointer to a Null-terminated ASCII string\r
192 array indicating the language. This is the\r
193 language of the driver name that the caller is\r
194 requesting, and it must match one of the\r
195 languages specified in SupportedLanguages. The\r
196 number of languages supported by a driver is up\r
197 to the driver writer. Language is specified\r
198 in RFC 4646 or ISO 639-2 language code format.\r
199\r
200 @param DriverName[out] A pointer to the Unicode string to return.\r
201 This Unicode string is the name of the\r
202 driver specified by This in the language\r
203 specified by Language.\r
204\r
205 @retval EFI_SUCCESS The Unicode string for the Driver specified by\r
206 This and the language specified by Language was\r
207 returned in DriverName.\r
208\r
209 @retval EFI_INVALID_PARAMETER Language is NULL.\r
210\r
211 @retval EFI_INVALID_PARAMETER DriverName is NULL.\r
212\r
213 @retval EFI_UNSUPPORTED The driver specified by This does not support\r
214 the language specified by Language.\r
215\r
216**/\r
217EFI_STATUS\r
218EFIAPI\r
219FbGopComponentNameGetDriverName (\r
220 IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
221 IN CHAR8 *Language,\r
222 OUT CHAR16 **DriverName\r
223 )\r
224{\r
225 return LookupUnicodeString2 (\r
226 Language,\r
227 This->SupportedLanguages,\r
228 mFbGopDriverNameTable,\r
229 DriverName,\r
230 (BOOLEAN)(This == &gFbGopComponentName)\r
231 );\r
232}\r
233\r
234/**\r
235 Retrieves a Unicode string that is the user readable name of the controller\r
236 that is being managed by a driver.\r
237\r
238 This function retrieves the user readable name of the controller specified by\r
239 ControllerHandle and ChildHandle in the form of a Unicode string. If the\r
240 driver specified by This has a user readable name in the language specified by\r
241 Language, then a pointer to the controller name is returned in ControllerName,\r
242 and EFI_SUCCESS is returned. If the driver specified by This is not currently\r
243 managing the controller specified by ControllerHandle and ChildHandle,\r
244 then EFI_UNSUPPORTED is returned. If the driver specified by This does not\r
245 support the language specified by Language, then EFI_UNSUPPORTED is returned.\r
246\r
247 @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
248 EFI_COMPONENT_NAME_PROTOCOL instance.\r
249\r
250 @param ControllerHandle[in] The handle of a controller that the driver\r
251 specified by This is managing. This handle\r
252 specifies the controller whose name is to be\r
253 returned.\r
254\r
255 @param ChildHandle[in] The handle of the child controller to retrieve\r
256 the name of. This is an optional parameter that\r
257 may be NULL. It will be NULL for device\r
258 drivers. It will also be NULL for a bus drivers\r
259 that wish to retrieve the name of the bus\r
260 controller. It will not be NULL for a bus\r
261 driver that wishes to retrieve the name of a\r
262 child controller.\r
263\r
264 @param Language[in] A pointer to a Null-terminated ASCII string\r
265 array indicating the language. This is the\r
266 language of the driver name that the caller is\r
267 requesting, and it must match one of the\r
268 languages specified in SupportedLanguages. The\r
269 number of languages supported by a driver is up\r
270 to the driver writer. Language is specified in\r
271 RFC 4646 or ISO 639-2 language code format.\r
272\r
273 @param ControllerName[out] A pointer to the Unicode string to return.\r
274 This Unicode string is the name of the\r
275 controller specified by ControllerHandle and\r
276 ChildHandle in the language specified by\r
277 Language from the point of view of the driver\r
278 specified by This.\r
279\r
280 @retval EFI_SUCCESS The Unicode string for the user readable name in\r
281 the language specified by Language for the\r
282 driver specified by This was returned in\r
283 DriverName.\r
284\r
285 @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.\r
286\r
287 @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid\r
288 EFI_HANDLE.\r
289\r
290 @retval EFI_INVALID_PARAMETER Language is NULL.\r
291\r
292 @retval EFI_INVALID_PARAMETER ControllerName is NULL.\r
293\r
294 @retval EFI_UNSUPPORTED The driver specified by This is not currently\r
295 managing the controller specified by\r
296 ControllerHandle and ChildHandle.\r
297\r
298 @retval EFI_UNSUPPORTED The driver specified by This does not support\r
299 the language specified by Language.\r
300\r
301**/\r
302EFI_STATUS\r
303EFIAPI\r
304FbGopComponentNameGetControllerName (\r
305 IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
306 IN EFI_HANDLE ControllerHandle,\r
307 IN EFI_HANDLE ChildHandle OPTIONAL,\r
308 IN CHAR8 *Language,\r
309 OUT CHAR16 **ControllerName\r
310 )\r
311{\r
312 return EFI_UNSUPPORTED;\r
313}\r