3 Copyright (c) 2004 - 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.
24 // EFI Component Name Functions
27 Retrieves a Unicode string that is the user readable name of the driver.
29 This function retrieves the user readable name of a driver in the form of a
30 Unicode string. If the driver specified by This has a user readable name in
31 the language specified by Language, then a pointer to the driver name is
32 returned in DriverName, and EFI_SUCCESS is returned. If the driver specified
33 by This does not support the language specified by Language,
34 then EFI_UNSUPPORTED is returned.
36 @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
37 EFI_COMPONENT_NAME_PROTOCOL instance.
39 @param Language[in] A pointer to a Null-terminated ASCII string
40 array indicating the language. This is the
41 language of the driver name that the caller is
42 requesting, and it must match one of the
43 languages specified in SupportedLanguages. The
44 number of languages supported by a driver is up
45 to the driver writer. Language is specified
46 in RFC 3066 or ISO 639-2 language code format.
48 @param DriverName[out] A pointer to the Unicode string to return.
49 This Unicode string is the name of the
50 driver specified by This in the language
51 specified by Language.
53 @retval EFI_SUCCESS The Unicode string for the Driver specified by
54 This and the language specified by Language was
55 returned in DriverName.
57 @retval EFI_INVALID_PARAMETER Language is NULL.
59 @retval EFI_INVALID_PARAMETER DriverName is NULL.
61 @retval EFI_UNSUPPORTED The driver specified by This does not support
62 the language specified by Language.
67 UhciComponentNameGetDriverName (
68 IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
70 OUT CHAR16
**DriverName
75 Retrieves a Unicode string that is the user readable name of the controller
76 that is being managed by a driver.
78 This function retrieves the user readable name of the controller specified by
79 ControllerHandle and ChildHandle in the form of a Unicode string. If the
80 driver specified by This has a user readable name in the language specified by
81 Language, then a pointer to the controller name is returned in ControllerName,
82 and EFI_SUCCESS is returned. If the driver specified by This is not currently
83 managing the controller specified by ControllerHandle and ChildHandle,
84 then EFI_UNSUPPORTED is returned. If the driver specified by This does not
85 support the language specified by Language, then EFI_UNSUPPORTED is returned.
87 @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
88 EFI_COMPONENT_NAME_PROTOCOL instance.
90 @param ControllerHandle[in] The handle of a controller that the driver
91 specified by This is managing. This handle
92 specifies the controller whose name is to be
95 @param ChildHandle[in] The handle of the child controller to retrieve
96 the name of. This is an optional parameter that
97 may be NULL. It will be NULL for device
98 drivers. It will also be NULL for a bus drivers
99 that wish to retrieve the name of the bus
100 controller. It will not be NULL for a bus
101 driver that wishes to retrieve the name of a
104 @param Language[in] A pointer to a Null-terminated ASCII string
105 array indicating the language. This is the
106 language of the driver name that the caller is
107 requesting, and it must match one of the
108 languages specified in SupportedLanguages. The
109 number of languages supported by a driver is up
110 to the driver writer. Language is specified in
111 RFC 3066 or ISO 639-2 language code format.
113 @param ControllerName[out] A pointer to the Unicode string to return.
114 This Unicode string is the name of the
115 controller specified by ControllerHandle and
116 ChildHandle in the language specified by
117 Language from the point of view of the driver
120 @retval EFI_SUCCESS The Unicode string for the user readable name in
121 the language specified by Language for the
122 driver specified by This was returned in
125 @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.
127 @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid
130 @retval EFI_INVALID_PARAMETER Language is NULL.
132 @retval EFI_INVALID_PARAMETER ControllerName is NULL.
134 @retval EFI_UNSUPPORTED The driver specified by This is not currently
135 managing the controller specified by
136 ControllerHandle and ChildHandle.
138 @retval EFI_UNSUPPORTED The driver specified by This does not support
139 the language specified by Language.
144 UhciComponentNameGetControllerName (
145 IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
146 IN EFI_HANDLE ControllerHandle
,
147 IN EFI_HANDLE ChildHandle OPTIONAL
,
149 OUT CHAR16
**ControllerName
154 // EFI Component Name Protocol
156 GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL gUhciComponentName
= {
157 UhciComponentNameGetDriverName
,
158 UhciComponentNameGetControllerName
,
163 // EFI Component Name 2 Protocol
165 GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL gUhciComponentName2
= {
166 (EFI_COMPONENT_NAME2_GET_DRIVER_NAME
) UhciComponentNameGetDriverName
,
167 (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME
) UhciComponentNameGetControllerName
,
172 GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mUhciDriverNameTable
[] = {
173 { "eng;en", L
"Usb Uhci Driver" },
178 Retrieves a Unicode string that is the user readable name of the driver.
180 This function retrieves the user readable name of a driver in the form of a
181 Unicode string. If the driver specified by This has a user readable name in
182 the language specified by Language, then a pointer to the driver name is
183 returned in DriverName, and EFI_SUCCESS is returned. If the driver specified
184 by This does not support the language specified by Language,
185 then EFI_UNSUPPORTED is returned.
187 @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
188 EFI_COMPONENT_NAME_PROTOCOL instance.
190 @param Language[in] A pointer to a Null-terminated ASCII string
191 array indicating the language. This is the
192 language of the driver name that the caller is
193 requesting, and it must match one of the
194 languages specified in SupportedLanguages. The
195 number of languages supported by a driver is up
196 to the driver writer. Language is specified
197 in RFC 3066 or ISO 639-2 language code format.
199 @param DriverName[out] A pointer to the Unicode string to return.
200 This Unicode string is the name of the
201 driver specified by This in the language
202 specified by Language.
204 @retval EFI_SUCCESS The Unicode string for the Driver specified by
205 This and the language specified by Language was
206 returned in DriverName.
208 @retval EFI_INVALID_PARAMETER Language is NULL.
210 @retval EFI_INVALID_PARAMETER DriverName is NULL.
212 @retval EFI_UNSUPPORTED The driver specified by This does not support
213 the language specified by Language.
218 UhciComponentNameGetDriverName (
219 IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
221 OUT CHAR16
**DriverName
224 return LookupUnicodeString2 (
226 This
->SupportedLanguages
,
227 mUhciDriverNameTable
,
229 (BOOLEAN
)(This
== &gUhciComponentName
)
234 Retrieves a Unicode string that is the user readable name of the controller
235 that is being managed by a driver.
237 This function retrieves the user readable name of the controller specified by
238 ControllerHandle and ChildHandle in the form of a Unicode string. If the
239 driver specified by This has a user readable name in the language specified by
240 Language, then a pointer to the controller name is returned in ControllerName,
241 and EFI_SUCCESS is returned. If the driver specified by This is not currently
242 managing the controller specified by ControllerHandle and ChildHandle,
243 then EFI_UNSUPPORTED is returned. If the driver specified by This does not
244 support the language specified by Language, then EFI_UNSUPPORTED is returned.
246 @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
247 EFI_COMPONENT_NAME_PROTOCOL instance.
249 @param ControllerHandle[in] The handle of a controller that the driver
250 specified by This is managing. This handle
251 specifies the controller whose name is to be
254 @param ChildHandle[in] The handle of the child controller to retrieve
255 the name of. This is an optional parameter that
256 may be NULL. It will be NULL for device
257 drivers. It will also be NULL for a bus drivers
258 that wish to retrieve the name of the bus
259 controller. It will not be NULL for a bus
260 driver that wishes to retrieve the name of a
263 @param Language[in] A pointer to a Null-terminated ASCII string
264 array indicating the language. This is the
265 language of the driver name that the caller is
266 requesting, and it must match one of the
267 languages specified in SupportedLanguages. The
268 number of languages supported by a driver is up
269 to the driver writer. Language is specified in
270 RFC 3066 or ISO 639-2 language code format.
272 @param ControllerName[out] A pointer to the Unicode string to return.
273 This Unicode string is the name of the
274 controller specified by ControllerHandle and
275 ChildHandle in the language specified by
276 Language from the point of view of the driver
279 @retval EFI_SUCCESS The Unicode string for the user readable name in
280 the language specified by Language for the
281 driver specified by This was returned in
284 @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.
286 @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid
289 @retval EFI_INVALID_PARAMETER Language is NULL.
291 @retval EFI_INVALID_PARAMETER ControllerName is NULL.
293 @retval EFI_UNSUPPORTED The driver specified by This is not currently
294 managing the controller specified by
295 ControllerHandle and ChildHandle.
297 @retval EFI_UNSUPPORTED The driver specified by This does not support
298 the language specified by Language.
303 UhciComponentNameGetControllerName (
304 IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
305 IN EFI_HANDLE ControllerHandle
,
306 IN EFI_HANDLE ChildHandle OPTIONAL
,
308 OUT CHAR16
**ControllerName
313 EFI_USB2_HC_PROTOCOL
*Usb2Hc
;
316 // This is a device driver, so ChildHandle must be NULL.
318 if (ChildHandle
!= NULL
) {
319 return EFI_UNSUPPORTED
;
323 // Make sure this driver is currently managing ControllerHandle
325 Status
= EfiTestManagedDevice (
327 gUhciDriverBinding
.DriverBindingHandle
,
328 &gEfiPciIoProtocolGuid
330 if (EFI_ERROR (Status
)) {
335 // Get the device context
337 Status
= gBS
->OpenProtocol (
339 &gEfiUsb2HcProtocolGuid
,
341 gUhciDriverBinding
.DriverBindingHandle
,
343 EFI_OPEN_PROTOCOL_GET_PROTOCOL
346 if (EFI_ERROR (Status
)) {
350 UhciDev
= UHC_FROM_USB2_HC_PROTO (Usb2Hc
);
352 return LookupUnicodeString2 (
354 This
->SupportedLanguages
,
355 UhciDev
->CtrlNameTable
,
357 (BOOLEAN
)(This
== &gUhciComponentName
)