3 Copyright (c) 2005 - 2007, Intel Corporation
4 All rights reserved. This program and the accompanying materials
5 are licensed and made available under the terms and conditions of the BSD License
6 which accompanies this distribution. The full text of the license may be found at
7 http://opensource.org/licenses/bsd-license.php
9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
22 #include "MnpDriver.h"
25 // EFI Component Name Functions
28 Retrieves a Unicode string that is the user readable name of the driver.
30 This function retrieves the user readable name of a driver in the form of a
31 Unicode string. If the driver specified by This has a user readable name in
32 the language specified by Language, then a pointer to the driver name is
33 returned in DriverName, and EFI_SUCCESS is returned. If the driver specified
34 by This does not support the language specified by Language,
35 then EFI_UNSUPPORTED is returned.
37 @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
38 EFI_COMPONENT_NAME_PROTOCOL instance.
40 @param Language[in] A pointer to a Null-terminated ASCII string
41 array indicating the language. This is the
42 language of the driver name that the caller is
43 requesting, and it must match one of the
44 languages specified in SupportedLanguages. The
45 number of languages supported by a driver is up
46 to the driver writer. Language is specified
47 in RFC 3066 or ISO 639-2 language code format.
49 @param DriverName[out] A pointer to the Unicode string to return.
50 This Unicode string is the name of the
51 driver specified by This in the language
52 specified by Language.
54 @retval EFI_SUCCESS The Unicode string for the Driver specified by
55 This and the language specified by Language was
56 returned in DriverName.
58 @retval EFI_INVALID_PARAMETER Language is NULL.
60 @retval EFI_INVALID_PARAMETER DriverName is NULL.
62 @retval EFI_UNSUPPORTED The driver specified by This does not support
63 the language specified by Language.
68 MnpComponentNameGetDriverName (
69 IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
71 OUT CHAR16
**DriverName
76 Retrieves a Unicode string that is the user readable name of the controller
77 that is being managed by a driver.
79 This function retrieves the user readable name of the controller specified by
80 ControllerHandle and ChildHandle in the form of a Unicode string. If the
81 driver specified by This has a user readable name in the language specified by
82 Language, then a pointer to the controller name is returned in ControllerName,
83 and EFI_SUCCESS is returned. If the driver specified by This is not currently
84 managing the controller specified by ControllerHandle and ChildHandle,
85 then EFI_UNSUPPORTED is returned. If the driver specified by This does not
86 support the language specified by Language, then EFI_UNSUPPORTED is returned.
88 @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
89 EFI_COMPONENT_NAME_PROTOCOL instance.
91 @param ControllerHandle[in] The handle of a controller that the driver
92 specified by This is managing. This handle
93 specifies the controller whose name is to be
96 @param ChildHandle[in] The handle of the child controller to retrieve
97 the name of. This is an optional parameter that
98 may be NULL. It will be NULL for device
99 drivers. It will also be NULL for a bus drivers
100 that wish to retrieve the name of the bus
101 controller. It will not be NULL for a bus
102 driver that wishes to retrieve the name of a
105 @param Language[in] A pointer to a Null-terminated ASCII string
106 array indicating the language. This is the
107 language of the driver name that the caller is
108 requesting, and it must match one of the
109 languages specified in SupportedLanguages. The
110 number of languages supported by a driver is up
111 to the driver writer. Language is specified in
112 RFC 3066 or ISO 639-2 language code format.
114 @param ControllerName[out] A pointer to the Unicode string to return.
115 This Unicode string is the name of the
116 controller specified by ControllerHandle and
117 ChildHandle in the language specified by
118 Language from the point of view of the driver
121 @retval EFI_SUCCESS The Unicode string for the user readable name in
122 the language specified by Language for the
123 driver specified by This was returned in
126 @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.
128 @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid
131 @retval EFI_INVALID_PARAMETER Language is NULL.
133 @retval EFI_INVALID_PARAMETER ControllerName is NULL.
135 @retval EFI_UNSUPPORTED The driver specified by This is not currently
136 managing the controller specified by
137 ControllerHandle and ChildHandle.
139 @retval EFI_UNSUPPORTED The driver specified by This does not support
140 the language specified by Language.
145 MnpComponentNameGetControllerName (
146 IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
147 IN EFI_HANDLE ControllerHandle
,
148 IN EFI_HANDLE ChildHandle OPTIONAL
,
150 OUT CHAR16
**ControllerName
155 // EFI Component Name Protocol
157 GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL gMnpComponentName
= {
158 MnpComponentNameGetDriverName
,
159 MnpComponentNameGetControllerName
,
164 // EFI Component Name 2 Protocol
166 GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL gMnpComponentName2
= {
167 (EFI_COMPONENT_NAME2_GET_DRIVER_NAME
) MnpComponentNameGetDriverName
,
168 (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME
) MnpComponentNameGetControllerName
,
173 GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mMnpDriverNameTable
[] = {
176 L
"MNP Network Service Driver"
185 Retrieves a Unicode string that is the user readable name of the driver.
187 This function retrieves the user readable name of a driver in the form of a
188 Unicode string. If the driver specified by This has a user readable name in
189 the language specified by Language, then a pointer to the driver name is
190 returned in DriverName, and EFI_SUCCESS is returned. If the driver specified
191 by This does not support the language specified by Language,
192 then EFI_UNSUPPORTED is returned.
194 @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
195 EFI_COMPONENT_NAME_PROTOCOL instance.
197 @param Language[in] A pointer to a Null-terminated ASCII string
198 array indicating the language. This is the
199 language of the driver name that the caller is
200 requesting, and it must match one of the
201 languages specified in SupportedLanguages. The
202 number of languages supported by a driver is up
203 to the driver writer. Language is specified
204 in RFC 3066 or ISO 639-2 language code format.
206 @param DriverName[out] A pointer to the Unicode string to return.
207 This Unicode string is the name of the
208 driver specified by This in the language
209 specified by Language.
211 @retval EFI_SUCCESS The Unicode string for the Driver specified by
212 This and the language specified by Language was
213 returned in DriverName.
215 @retval EFI_INVALID_PARAMETER Language is NULL.
217 @retval EFI_INVALID_PARAMETER DriverName is NULL.
219 @retval EFI_UNSUPPORTED The driver specified by This does not support
220 the language specified by Language.
225 MnpComponentNameGetDriverName (
226 IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
228 OUT CHAR16
**DriverName
231 return LookupUnicodeString2 (
233 This
->SupportedLanguages
,
236 (BOOLEAN
)(This
== &gMnpComponentName
)
241 Retrieves a Unicode string that is the user readable name of the controller
242 that is being managed by a driver.
244 This function retrieves the user readable name of the controller specified by
245 ControllerHandle and ChildHandle in the form of a Unicode string. If the
246 driver specified by This has a user readable name in the language specified by
247 Language, then a pointer to the controller name is returned in ControllerName,
248 and EFI_SUCCESS is returned. If the driver specified by This is not currently
249 managing the controller specified by ControllerHandle and ChildHandle,
250 then EFI_UNSUPPORTED is returned. If the driver specified by This does not
251 support the language specified by Language, then EFI_UNSUPPORTED is returned.
253 @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
254 EFI_COMPONENT_NAME_PROTOCOL instance.
256 @param ControllerHandle[in] The handle of a controller that the driver
257 specified by This is managing. This handle
258 specifies the controller whose name is to be
261 @param ChildHandle[in] The handle of the child controller to retrieve
262 the name of. This is an optional parameter that
263 may be NULL. It will be NULL for device
264 drivers. It will also be NULL for a bus drivers
265 that wish to retrieve the name of the bus
266 controller. It will not be NULL for a bus
267 driver that wishes to retrieve the name of a
270 @param Language[in] A pointer to a Null-terminated ASCII string
271 array indicating the language. This is the
272 language of the driver name that the caller is
273 requesting, and it must match one of the
274 languages specified in SupportedLanguages. The
275 number of languages supported by a driver is up
276 to the driver writer. Language is specified in
277 RFC 3066 or ISO 639-2 language code format.
279 @param ControllerName[out] A pointer to the Unicode string to return.
280 This Unicode string is the name of the
281 controller specified by ControllerHandle and
282 ChildHandle in the language specified by
283 Language from the point of view of the driver
286 @retval EFI_SUCCESS The Unicode string for the user readable name in
287 the language specified by Language for the
288 driver specified by This was returned in
291 @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.
293 @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid
296 @retval EFI_INVALID_PARAMETER Language is NULL.
298 @retval EFI_INVALID_PARAMETER ControllerName is NULL.
300 @retval EFI_UNSUPPORTED The driver specified by This is not currently
301 managing the controller specified by
302 ControllerHandle and ChildHandle.
304 @retval EFI_UNSUPPORTED The driver specified by This does not support
305 the language specified by Language.
310 MnpComponentNameGetControllerName (
311 IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
312 IN EFI_HANDLE ControllerHandle
,
313 IN EFI_HANDLE ChildHandle OPTIONAL
,
315 OUT CHAR16
**ControllerName
318 return EFI_UNSUPPORTED
;