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.
22 #include <Library/DebugLib.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 UsbMouseComponentNameGetDriverName (
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 UsbMouseComponentNameGetControllerName (
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 gUsbMouseComponentName
= {
158 UsbMouseComponentNameGetDriverName
,
159 UsbMouseComponentNameGetControllerName
,
164 // EFI Component Name 2 Protocol
166 GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL gUsbMouseComponentName2
= {
167 (EFI_COMPONENT_NAME2_GET_DRIVER_NAME
) UsbMouseComponentNameGetDriverName
,
168 (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME
) UsbMouseComponentNameGetControllerName
,
174 GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mUsbMouseDriverNameTable
[] = {
175 { "eng;en", L
"Usb Mouse Driver" },
181 Retrieves a Unicode string that is the user readable name of the driver.
183 This function retrieves the user readable name of a driver in the form of a
184 Unicode string. If the driver specified by This has a user readable name in
185 the language specified by Language, then a pointer to the driver name is
186 returned in DriverName, and EFI_SUCCESS is returned. If the driver specified
187 by This does not support the language specified by Language,
188 then EFI_UNSUPPORTED is returned.
190 @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
191 EFI_COMPONENT_NAME_PROTOCOL instance.
193 @param Language[in] A pointer to a Null-terminated ASCII string
194 array indicating the language. This is the
195 language of the driver name that the caller is
196 requesting, and it must match one of the
197 languages specified in SupportedLanguages. The
198 number of languages supported by a driver is up
199 to the driver writer. Language is specified
200 in RFC 3066 or ISO 639-2 language code format.
202 @param DriverName[out] A pointer to the Unicode string to return.
203 This Unicode string is the name of the
204 driver specified by This in the language
205 specified by Language.
207 @retval EFI_SUCCESS The Unicode string for the Driver specified by
208 This and the language specified by Language was
209 returned in DriverName.
211 @retval EFI_INVALID_PARAMETER Language is NULL.
213 @retval EFI_INVALID_PARAMETER DriverName is NULL.
215 @retval EFI_UNSUPPORTED The driver specified by This does not support
216 the language specified by Language.
221 UsbMouseComponentNameGetDriverName (
222 IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
224 OUT CHAR16
**DriverName
227 return LookupUnicodeString2 (
229 This
->SupportedLanguages
,
230 mUsbMouseDriverNameTable
,
232 (BOOLEAN
)(This
== &gUsbMouseComponentName
)
237 Retrieves a Unicode string that is the user readable name of the controller
238 that is being managed by a driver.
240 This function retrieves the user readable name of the controller specified by
241 ControllerHandle and ChildHandle in the form of a Unicode string. If the
242 driver specified by This has a user readable name in the language specified by
243 Language, then a pointer to the controller name is returned in ControllerName,
244 and EFI_SUCCESS is returned. If the driver specified by This is not currently
245 managing the controller specified by ControllerHandle and ChildHandle,
246 then EFI_UNSUPPORTED is returned. If the driver specified by This does not
247 support the language specified by Language, then EFI_UNSUPPORTED is returned.
249 @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
250 EFI_COMPONENT_NAME_PROTOCOL instance.
252 @param ControllerHandle[in] The handle of a controller that the driver
253 specified by This is managing. This handle
254 specifies the controller whose name is to be
257 @param ChildHandle[in] The handle of the child controller to retrieve
258 the name of. This is an optional parameter that
259 may be NULL. It will be NULL for device
260 drivers. It will also be NULL for a bus drivers
261 that wish to retrieve the name of the bus
262 controller. It will not be NULL for a bus
263 driver that wishes to retrieve the name of a
266 @param Language[in] A pointer to a Null-terminated ASCII string
267 array indicating the language. This is the
268 language of the driver name that the caller is
269 requesting, and it must match one of the
270 languages specified in SupportedLanguages. The
271 number of languages supported by a driver is up
272 to the driver writer. Language is specified in
273 RFC 3066 or ISO 639-2 language code format.
275 @param ControllerName[out] A pointer to the Unicode string to return.
276 This Unicode string is the name of the
277 controller specified by ControllerHandle and
278 ChildHandle in the language specified by
279 Language from the point of view of the driver
282 @retval EFI_SUCCESS The Unicode string for the user readable name in
283 the language specified by Language for the
284 driver specified by This was returned in
287 @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.
289 @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid
292 @retval EFI_INVALID_PARAMETER Language is NULL.
294 @retval EFI_INVALID_PARAMETER ControllerName is NULL.
296 @retval EFI_UNSUPPORTED The driver specified by This is not currently
297 managing the controller specified by
298 ControllerHandle and ChildHandle.
300 @retval EFI_UNSUPPORTED The driver specified by This does not support
301 the language specified by Language.
306 UsbMouseComponentNameGetControllerName (
307 IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
308 IN EFI_HANDLE ControllerHandle
,
309 IN EFI_HANDLE ChildHandle OPTIONAL
,
311 OUT CHAR16
**ControllerName
315 USB_MOUSE_DEV
*UsbMouseDev
;
316 EFI_SIMPLE_POINTER_PROTOCOL
*SimplePointerProtocol
;
317 EFI_USB_IO_PROTOCOL
*UsbIoProtocol
;
320 // This is a device driver, so ChildHandle must be NULL.
322 if (ChildHandle
!= NULL
) {
323 return EFI_UNSUPPORTED
;
327 // Check Controller's handle
329 Status
= gBS
->OpenProtocol (
331 &gEfiUsbIoProtocolGuid
,
332 (VOID
**) &UsbIoProtocol
,
333 gUsbMouseDriverBinding
.DriverBindingHandle
,
335 EFI_OPEN_PROTOCOL_BY_DRIVER
337 if (!EFI_ERROR (Status
)) {
340 &gEfiUsbIoProtocolGuid
,
341 gUsbMouseDriverBinding
.DriverBindingHandle
,
345 return EFI_UNSUPPORTED
;
348 if (Status
!= EFI_ALREADY_STARTED
) {
349 return EFI_UNSUPPORTED
;
352 // Get the device context
354 Status
= gBS
->OpenProtocol (
356 &gEfiSimplePointerProtocolGuid
,
357 (VOID
**) &SimplePointerProtocol
,
358 gUsbMouseDriverBinding
.DriverBindingHandle
,
360 EFI_OPEN_PROTOCOL_GET_PROTOCOL
363 if (EFI_ERROR (Status
)) {
367 UsbMouseDev
= USB_MOUSE_DEV_FROM_MOUSE_PROTOCOL (SimplePointerProtocol
);
369 return LookupUnicodeString2 (
371 This
->SupportedLanguages
,
372 UsbMouseDev
->ControllerNameTable
,
374 (BOOLEAN
)(This
== &gUsbMouseComponentName
)