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