2 UEFI Component Name(2) protocol implementation.
4 Copyright (c) 2004 - 2007, Intel Corporation
5 All rights reserved. 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
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.
26 #include <Library/UefiLib.h>
29 // EFI Component Name Functions
32 Retrieves a Unicode string that is the user readable name of the driver.
34 This function retrieves the user readable name of a driver in the form of a
35 Unicode string. If the driver specified by This has a user readable name in
36 the language specified by Language, then a pointer to the driver name is
37 returned in DriverName, and EFI_SUCCESS is returned. If the driver specified
38 by This does not support the language specified by Language,
39 then EFI_UNSUPPORTED is returned.
41 @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
42 EFI_COMPONENT_NAME_PROTOCOL instance.
44 @param Language[in] A pointer to a Null-terminated ASCII string
45 array indicating the language. This is the
46 language of the driver name that the caller is
47 requesting, and it must match one of the
48 languages specified in SupportedLanguages. The
49 number of languages supported by a driver is up
50 to the driver writer. Language is specified
51 in RFC 3066 or ISO 639-2 language code format.
53 @param DriverName[out] A pointer to the Unicode string to return.
54 This Unicode string is the name of the
55 driver specified by This in the language
56 specified by Language.
58 @retval EFI_SUCCESS The Unicode string for the Driver specified by
59 This and the language specified by Language was
60 returned in DriverName.
62 @retval EFI_INVALID_PARAMETER Language is NULL.
64 @retval EFI_INVALID_PARAMETER DriverName is NULL.
66 @retval EFI_UNSUPPORTED The driver specified by This does not support
67 the language specified by Language.
72 UsbMassStorageGetDriverName (
73 IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
75 OUT CHAR16
**DriverName
80 Retrieves a Unicode string that is the user readable name of the controller
81 that is being managed by a driver.
83 This function retrieves the user readable name of the controller specified by
84 ControllerHandle and ChildHandle in the form of a Unicode string. If the
85 driver specified by This has a user readable name in the language specified by
86 Language, then a pointer to the controller name is returned in ControllerName,
87 and EFI_SUCCESS is returned. If the driver specified by This is not currently
88 managing the controller specified by ControllerHandle and ChildHandle,
89 then EFI_UNSUPPORTED is returned. If the driver specified by This does not
90 support the language specified by Language, then EFI_UNSUPPORTED is returned.
92 @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
93 EFI_COMPONENT_NAME_PROTOCOL instance.
95 @param ControllerHandle[in] The handle of a controller that the driver
96 specified by This is managing. This handle
97 specifies the controller whose name is to be
100 @param ChildHandle[in] The handle of the child controller to retrieve
101 the name of. This is an optional parameter that
102 may be NULL. It will be NULL for device
103 drivers. It will also be NULL for a bus drivers
104 that wish to retrieve the name of the bus
105 controller. It will not be NULL for a bus
106 driver that wishes to retrieve the name of a
109 @param Language[in] A pointer to a Null-terminated ASCII string
110 array indicating the language. This is the
111 language of the driver name that the caller is
112 requesting, and it must match one of the
113 languages specified in SupportedLanguages. The
114 number of languages supported by a driver is up
115 to the driver writer. Language is specified in
116 RFC 3066 or ISO 639-2 language code format.
118 @param ControllerName[out] A pointer to the Unicode string to return.
119 This Unicode string is the name of the
120 controller specified by ControllerHandle and
121 ChildHandle in the language specified by
122 Language from the point of view of the driver
125 @retval EFI_SUCCESS The Unicode string for the user readable name in
126 the language specified by Language for the
127 driver specified by This was returned in
130 @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.
132 @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid
135 @retval EFI_INVALID_PARAMETER Language is NULL.
137 @retval EFI_INVALID_PARAMETER ControllerName is NULL.
139 @retval EFI_UNSUPPORTED The driver specified by This is not currently
140 managing the controller specified by
141 ControllerHandle and ChildHandle.
143 @retval EFI_UNSUPPORTED The driver specified by This does not support
144 the language specified by Language.
149 UsbMassStorageGetControllerName (
150 IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
151 IN EFI_HANDLE ControllerHandle
,
152 IN EFI_HANDLE ChildHandle OPTIONAL
,
154 OUT CHAR16
**ControllerName
159 // EFI Component Name Protocol
161 GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL gUsbMassStorageComponentName
= {
162 UsbMassStorageGetDriverName
,
163 UsbMassStorageGetControllerName
,
168 // EFI Component Name 2 Protocol
170 GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL gUsbMassStorageComponentName2
= {
171 (EFI_COMPONENT_NAME2_GET_DRIVER_NAME
) UsbMassStorageGetDriverName
,
172 (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME
) UsbMassStorageGetControllerName
,
177 GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE
178 mUsbMassStorageDriverNameTable
[] = {
179 {"eng;en", L
"Usb Mass Storage Driver"},
184 Retrieves a Unicode string that is the user readable name of the driver.
186 This function retrieves the user readable name of a driver in the form of a
187 Unicode string. If the driver specified by This has a user readable name in
188 the language specified by Language, then a pointer to the driver name is
189 returned in DriverName, and EFI_SUCCESS is returned. If the driver specified
190 by This does not support the language specified by Language,
191 then EFI_UNSUPPORTED is returned.
193 @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
194 EFI_COMPONENT_NAME_PROTOCOL instance.
196 @param Language[in] A pointer to a Null-terminated ASCII string
197 array indicating the language. This is the
198 language of the driver name that the caller is
199 requesting, and it must match one of the
200 languages specified in SupportedLanguages. The
201 number of languages supported by a driver is up
202 to the driver writer. Language is specified
203 in RFC 3066 or ISO 639-2 language code format.
205 @param DriverName[out] A pointer to the Unicode string to return.
206 This Unicode string is the name of the
207 driver specified by This in the language
208 specified by Language.
210 @retval EFI_SUCCESS The Unicode string for the Driver specified by
211 This and the language specified by Language was
212 returned in DriverName.
214 @retval EFI_INVALID_PARAMETER Language is NULL.
216 @retval EFI_INVALID_PARAMETER DriverName is NULL.
218 @retval EFI_UNSUPPORTED The driver specified by This does not support
219 the language specified by Language.
224 UsbMassStorageGetDriverName (
225 IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
227 OUT CHAR16
**DriverName
230 return LookupUnicodeString2 (
232 This
->SupportedLanguages
,
233 mUsbMassStorageDriverNameTable
,
235 (BOOLEAN
)(This
== &gUsbMassStorageComponentName
)
240 Retrieves a Unicode string that is the user readable name of the controller
241 that is being managed by a driver.
243 This function retrieves the user readable name of the controller specified by
244 ControllerHandle and ChildHandle in the form of a Unicode string. If the
245 driver specified by This has a user readable name in the language specified by
246 Language, then a pointer to the controller name is returned in ControllerName,
247 and EFI_SUCCESS is returned. If the driver specified by This is not currently
248 managing the controller specified by ControllerHandle and ChildHandle,
249 then EFI_UNSUPPORTED is returned. If the driver specified by This does not
250 support the language specified by Language, then EFI_UNSUPPORTED is returned.
252 @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
253 EFI_COMPONENT_NAME_PROTOCOL instance.
255 @param ControllerHandle[in] The handle of a controller that the driver
256 specified by This is managing. This handle
257 specifies the controller whose name is to be
260 @param ChildHandle[in] The handle of the child controller to retrieve
261 the name of. This is an optional parameter that
262 may be NULL. It will be NULL for device
263 drivers. It will also be NULL for a bus drivers
264 that wish to retrieve the name of the bus
265 controller. It will not be NULL for a bus
266 driver that wishes to retrieve the name of a
269 @param Language[in] A pointer to a Null-terminated ASCII string
270 array indicating the language. This is the
271 language of the driver name that the caller is
272 requesting, and it must match one of the
273 languages specified in SupportedLanguages. The
274 number of languages supported by a driver is up
275 to the driver writer. Language is specified in
276 RFC 3066 or ISO 639-2 language code format.
278 @param ControllerName[out] A pointer to the Unicode string to return.
279 This Unicode string is the name of the
280 controller specified by ControllerHandle and
281 ChildHandle in the language specified by
282 Language from the point of view of the driver
285 @retval EFI_SUCCESS The Unicode string for the user readable name in
286 the language specified by Language for the
287 driver specified by This was returned in
290 @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.
292 @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid
295 @retval EFI_INVALID_PARAMETER Language is NULL.
297 @retval EFI_INVALID_PARAMETER ControllerName is NULL.
299 @retval EFI_UNSUPPORTED The driver specified by This is not currently
300 managing the controller specified by
301 ControllerHandle and ChildHandle.
303 @retval EFI_UNSUPPORTED The driver specified by This does not support
304 the language specified by Language.
309 UsbMassStorageGetControllerName (
310 IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
311 IN EFI_HANDLE ControllerHandle
,
312 IN EFI_HANDLE ChildHandle OPTIONAL
,
314 OUT CHAR16
**ControllerName
317 return EFI_UNSUPPORTED
;