]> git.proxmox.com Git - mirror_edk2.git/blame - NetworkPkg/Udp6Dxe/ComponentName.c
projects / mirror_edk2.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Refine name definition for better user experience.
[mirror_edk2.git] / NetworkPkg / Udp6Dxe / ComponentName.c
CommitLineData
a3bcde70
HT		 1/** @file\r
2 UEFI Component Name(2) protocol implementation for UDP6 driver.\r
3\r
4 Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>\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#include "Udp6Impl.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[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
32 EFI_COMPONENT_NAME_PROTOCOL instance.\r
33\r
34 @param[in] Language 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[out] DriverName 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
62Udp6ComponentNameGetDriverName (\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[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
83 EFI_COMPONENT_NAME_PROTOCOL instance.\r
84\r
85 @param[in] ControllerHandle 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[in] ChildHandle 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[in] Language 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[out] ControllerName 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 not a valid EFI_HANDLE.\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
139Udp6ComponentNameGetControllerName (\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// EFI Component Name Protocol\r
149//\r
150GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL gUdp6ComponentName = {\r
151 Udp6ComponentNameGetDriverName,\r
152 Udp6ComponentNameGetControllerName,\r
153 "eng"\r
154};\r
155\r
156//\r
157// EFI Component Name 2 Protocol\r
158//\r
159GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL gUdp6ComponentName2 = {\r
160 (EFI_COMPONENT_NAME2_GET_DRIVER_NAME) Udp6ComponentNameGetDriverName,\r
161 (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) Udp6ComponentNameGetControllerName,\r
162 "en"\r
163};\r
164\r
165\r
166GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mUdp6DriverNameTable[] = {\r
167 {\r
168 "eng;en",\r
169 L"UDP6 Network Service Driver"\r
170 },\r
171 {\r
172 NULL,\r
173 NULL\r
174 }\r
175};\r
176\r
177/**\r
178 Retrieves a Unicode string that is the user-readable name of the driver.\r
179\r
180 This function retrieves the user-readable name of a driver in the form of a\r
181 Unicode string. If the driver specified by This has a user-readable name in\r
182 the language specified by Language, then a pointer to the driver name is\r
183 returned in DriverName, and EFI_SUCCESS is returned. If the driver specified\r
184 by This does not support the language specified by Language,\r
185 then EFI_UNSUPPORTED is returned.\r
186\r
187 @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
188 EFI_COMPONENT_NAME_PROTOCOL instance.\r
189\r
190 @param[in] Language A pointer to a Null-terminated ASCII string\r
191 array indicating the language. This is the\r
192 language of the driver name that the caller is\r
193 requesting, and it must match one of the\r
194 languages specified in SupportedLanguages. The\r
195 number of languages supported by a driver is up\r
196 to the driver writer. Language is specified\r
197 in RFC 4646 or ISO 639-2 language code format.\r
198\r
199 @param[out] DriverName A pointer to the Unicode string to return.\r
200 This Unicode string is the name of the\r
201 driver specified by This in the language\r
202 specified by Language.\r
203\r
204 @retval EFI_SUCCESS The Unicode string for the Driver specified by\r
205 This and the language specified by Language was\r
206 returned in DriverName.\r
207\r
208 @retval EFI_INVALID_PARAMETER Language is NULL.\r
209\r
210 @retval EFI_INVALID_PARAMETER DriverName is NULL.\r
211\r
212 @retval EFI_UNSUPPORTED The driver specified by This does not support\r
213 the language specified by Language.\r
214\r
215**/\r
216EFI_STATUS\r
217EFIAPI\r
218Udp6ComponentNameGetDriverName (\r
219 IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
220 IN CHAR8 *Language,\r
221 OUT CHAR16 **DriverName\r
222 )\r
223{\r
224 return LookupUnicodeString2 (\r
225 Language,\r
226 This->SupportedLanguages,\r
227 mUdp6DriverNameTable,\r
228 DriverName,\r
229 (BOOLEAN) (This == &gUdp6ComponentName)\r
230 );\r
231}\r
232\r
233/**\r
234 Retrieves a Unicode string that is the user-readable name of the controller\r
235 that is being managed by a driver.\r
236\r
237 This function retrieves the user-readable name of the controller specified by\r
238 ControllerHandle and ChildHandle in the form of a Unicode string. If the\r
239 driver specified by This has a user-readable name in the language specified by\r
240 Language, then a pointer to the controller name is returned in ControllerName,\r
241 and EFI_SUCCESS is returned. If the driver specified by This is not currently\r
242 managing the controller specified by ControllerHandle and ChildHandle,\r
243 then EFI_UNSUPPORTED is returned. If the driver specified by This does not\r
244 support the language specified by Language, then EFI_UNSUPPORTED is returned.\r
245\r
246 @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
247 EFI_COMPONENT_NAME_PROTOCOL instance.\r
248\r
249 @param[in] ControllerHandle The handle of a controller that the driver\r
250 specified by This is managing. This handle\r
251 specifies the controller whose name is to be\r
252 returned.\r
253\r
254 @param[in] ChildHandle The handle of the child controller to retrieve\r
255 the name of. This is an optional parameter that\r
256 may be NULL. It will be NULL for device\r
257 drivers. It will also be NULL for a bus drivers\r
258 that wish to retrieve the name of the bus\r
259 controller. It will not be NULL for a bus\r
260 driver that wishes to retrieve the name of a\r
261 child controller.\r
262\r
263 @param[in] Language A pointer to a Null-terminated ASCII string\r
264 array indicating the language. This is the\r
265 language of the driver name that the caller is\r
266 requesting, and it must match one of the\r
267 languages specified in SupportedLanguages. The\r
268 number of languages supported by a driver is up\r
269 to the driver writer. Language is specified in\r
270 RFC 4646 or ISO 639-2 language code format.\r
271\r
272 @param[out] ControllerName A pointer to the Unicode string to return.\r
273 This Unicode string is the name of the\r
274 controller specified by ControllerHandle and\r
275 ChildHandle in the language specified by\r
276 Language from the point of view of the driver\r
277 specified by This.\r
278\r
279 @retval EFI_SUCCESS The Unicode string for the user-readable name in\r
280 the language specified by Language for the\r
281 driver specified by This was returned in\r
282 DriverName.\r
283\r
284 @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.\r
285\r
286 @retval EFI_INVALID_PARAMETER ChildHandle is not NULL, and it is not a valid\r
287 EFI_HANDLE.\r
288\r
289 @retval EFI_INVALID_PARAMETER Language is NULL.\r
290\r
291 @retval EFI_INVALID_PARAMETER ControllerName is NULL.\r
292\r
293 @retval EFI_UNSUPPORTED The driver specified by This is not currently\r
294 managing the controller specified by\r
295 ControllerHandle and ChildHandle.\r
296\r
297 @retval EFI_UNSUPPORTED The driver specified by This does not support\r
298 the language specified by Language.\r
299\r
300**/\r
301EFI_STATUS\r
302EFIAPI\r
303Udp6ComponentNameGetControllerName (\r
304 IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
305 IN EFI_HANDLE ControllerHandle,\r
306 IN EFI_HANDLE ChildHandle OPTIONAL,\r
307 IN CHAR8 *Language,\r
308 OUT CHAR16 **ControllerName\r
309 )\r
310{\r
311 return EFI_UNSUPPORTED;\r
312}\r
313\r
EFI Development Kit II mirror for PVE