]>
Commit | Line | Data |
---|---|---|
ed838d0c | 1 | /** @file\r |
b4e73a63 | 2 | UEFI Component Name(2) protocol implementation for USB Keyboard driver.\r |
a7022cec | 3 | \r |
284ee2e8 | 4 | Copyright (c) 2004 - 2011, Intel Corporation. All rights reserved.<BR>\r |
cd5ebaa0 | 5 | This program and the accompanying materials\r |
ed838d0c | 6 | are licensed and made available under the terms and conditions of the BSD License\r |
7 | which accompanies this distribution. The full text of the license may be found at\r | |
8 | http://opensource.org/licenses/bsd-license.php\r | |
9 | \r | |
10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
12 | \r | |
ed838d0c | 13 | **/\r |
14 | \r | |
15 | \r | |
a7022cec | 16 | #include "KeyBoard.h"\r |
ed838d0c | 17 | \r |
ed838d0c | 18 | //\r |
19 | // EFI Component Name Protocol\r | |
20 | //\r | |
1307dcd7 | 21 | GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL gUsbKeyboardComponentName = {\r |
ed838d0c | 22 | UsbKeyboardComponentNameGetDriverName,\r |
23 | UsbKeyboardComponentNameGetControllerName,\r | |
24 | "eng"\r | |
1307dcd7 | 25 | };\r |
62b9bb55 | 26 | \r |
27 | //\r | |
28 | // EFI Component Name 2 Protocol\r | |
29 | //\r | |
1307dcd7 | 30 | GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL gUsbKeyboardComponentName2 = {\r |
62b9bb55 | 31 | (EFI_COMPONENT_NAME2_GET_DRIVER_NAME) UsbKeyboardComponentNameGetDriverName,\r |
32 | (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) UsbKeyboardComponentNameGetControllerName,\r | |
33 | "en"\r | |
1307dcd7 | 34 | };\r |
62b9bb55 | 35 | \r |
ed838d0c | 36 | \r |
d1aeb0bd | 37 | GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mUsbKeyboardDriverNameTable[] = {\r |
62b9bb55 | 38 | { "eng;en", L"Usb Keyboard Driver" },\r |
ed838d0c | 39 | { NULL , NULL }\r |
40 | };\r | |
41 | \r | |
62b9bb55 | 42 | /**\r |
43 | Retrieves a Unicode string that is the user readable name of the driver.\r | |
44 | \r | |
45 | This function retrieves the user readable name of a driver in the form of a\r | |
46 | Unicode string. If the driver specified by This has a user readable name in\r | |
47 | the language specified by Language, then a pointer to the driver name is\r | |
48 | returned in DriverName, and EFI_SUCCESS is returned. If the driver specified\r | |
49 | by This does not support the language specified by Language,\r | |
50 | then EFI_UNSUPPORTED is returned.\r | |
51 | \r | |
b4e73a63 | 52 | @param This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r |
62b9bb55 | 53 | EFI_COMPONENT_NAME_PROTOCOL instance.\r |
b4e73a63 | 54 | @param Language A pointer to a Null-terminated ASCII string\r |
62b9bb55 | 55 | array indicating the language. This is the\r |
56 | language of the driver name that the caller is\r | |
57 | requesting, and it must match one of the\r | |
58 | languages specified in SupportedLanguages. The\r | |
59 | number of languages supported by a driver is up\r | |
60 | to the driver writer. Language is specified\r | |
0254efc0 | 61 | in RFC 4646 or ISO 639-2 language code format.\r |
b4e73a63 | 62 | @param DriverName A pointer to the Unicode string to return.\r |
62b9bb55 | 63 | This Unicode string is the name of the\r |
64 | driver specified by This in the language\r | |
65 | specified by Language.\r | |
66 | \r | |
67 | @retval EFI_SUCCESS The Unicode string for the Driver specified by\r | |
68 | This and the language specified by Language was\r | |
69 | returned in DriverName.\r | |
62b9bb55 | 70 | @retval EFI_INVALID_PARAMETER Language is NULL.\r |
62b9bb55 | 71 | @retval EFI_INVALID_PARAMETER DriverName is NULL.\r |
62b9bb55 | 72 | @retval EFI_UNSUPPORTED The driver specified by This does not support\r |
73 | the language specified by Language.\r | |
74 | \r | |
75 | **/\r | |
ed838d0c | 76 | EFI_STATUS\r |
77 | EFIAPI\r | |
78 | UsbKeyboardComponentNameGetDriverName (\r | |
79 | IN EFI_COMPONENT_NAME_PROTOCOL *This,\r | |
80 | IN CHAR8 *Language,\r | |
81 | OUT CHAR16 **DriverName\r | |
82 | )\r | |
ed838d0c | 83 | {\r |
62b9bb55 | 84 | return LookupUnicodeString2 (\r |
85 | Language,\r | |
86 | This->SupportedLanguages,\r | |
87 | mUsbKeyboardDriverNameTable,\r | |
88 | DriverName,\r | |
89 | (BOOLEAN)(This == &gUsbKeyboardComponentName)\r | |
90 | );\r | |
ed838d0c | 91 | }\r |
92 | \r | |
62b9bb55 | 93 | /**\r |
94 | Retrieves a Unicode string that is the user readable name of the controller\r | |
95 | that is being managed by a driver.\r | |
96 | \r | |
97 | This function retrieves the user readable name of the controller specified by\r | |
98 | ControllerHandle and ChildHandle in the form of a Unicode string. If the\r | |
99 | driver specified by This has a user readable name in the language specified by\r | |
100 | Language, then a pointer to the controller name is returned in ControllerName,\r | |
101 | and EFI_SUCCESS is returned. If the driver specified by This is not currently\r | |
102 | managing the controller specified by ControllerHandle and ChildHandle,\r | |
103 | then EFI_UNSUPPORTED is returned. If the driver specified by This does not\r | |
104 | support the language specified by Language, then EFI_UNSUPPORTED is returned.\r | |
105 | \r | |
b4e73a63 | 106 | @param This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r |
62b9bb55 | 107 | EFI_COMPONENT_NAME_PROTOCOL instance.\r |
b4e73a63 | 108 | @param ControllerHandle The handle of a controller that the driver\r |
62b9bb55 | 109 | specified by This is managing. This handle\r |
110 | specifies the controller whose name is to be\r | |
111 | returned.\r | |
b4e73a63 | 112 | @param ChildHandle The handle of the child controller to retrieve\r |
62b9bb55 | 113 | the name of. This is an optional parameter that\r |
114 | may be NULL. It will be NULL for device\r | |
115 | drivers. It will also be NULL for a bus drivers\r | |
116 | that wish to retrieve the name of the bus\r | |
117 | controller. It will not be NULL for a bus\r | |
118 | driver that wishes to retrieve the name of a\r | |
119 | child controller.\r | |
b4e73a63 | 120 | @param Language A pointer to a Null-terminated ASCII string\r |
62b9bb55 | 121 | array indicating the language. This is the\r |
122 | language of the driver name that the caller is\r | |
123 | requesting, and it must match one of the\r | |
124 | languages specified in SupportedLanguages. The\r | |
125 | number of languages supported by a driver is up\r | |
126 | to the driver writer. Language is specified in\r | |
0254efc0 | 127 | RFC 4646 or ISO 639-2 language code format.\r |
b4e73a63 | 128 | @param ControllerName A pointer to the Unicode string to return.\r |
62b9bb55 | 129 | This Unicode string is the name of the\r |
130 | controller specified by ControllerHandle and\r | |
131 | ChildHandle in the language specified by\r | |
132 | Language from the point of view of the driver\r | |
133 | specified by This.\r | |
134 | \r | |
135 | @retval EFI_SUCCESS The Unicode string for the user readable name in\r | |
136 | the language specified by Language for the\r | |
137 | driver specified by This was returned in\r | |
138 | DriverName.\r | |
284ee2e8 | 139 | @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.\r |
62b9bb55 | 140 | @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid\r |
141 | EFI_HANDLE.\r | |
62b9bb55 | 142 | @retval EFI_INVALID_PARAMETER Language is NULL.\r |
62b9bb55 | 143 | @retval EFI_INVALID_PARAMETER ControllerName is NULL.\r |
62b9bb55 | 144 | @retval EFI_UNSUPPORTED The driver specified by This is not currently\r |
145 | managing the controller specified by\r | |
146 | ControllerHandle and ChildHandle.\r | |
62b9bb55 | 147 | @retval EFI_UNSUPPORTED The driver specified by This does not support\r |
148 | the language specified by Language.\r | |
149 | \r | |
150 | **/\r | |
ed838d0c | 151 | EFI_STATUS\r |
152 | EFIAPI\r | |
153 | UsbKeyboardComponentNameGetControllerName (\r | |
154 | IN EFI_COMPONENT_NAME_PROTOCOL *This,\r | |
155 | IN EFI_HANDLE ControllerHandle,\r | |
156 | IN EFI_HANDLE ChildHandle OPTIONAL,\r | |
157 | IN CHAR8 *Language,\r | |
158 | OUT CHAR16 **ControllerName\r | |
159 | )\r | |
ed838d0c | 160 | {\r |
161 | EFI_STATUS Status;\r | |
162 | USB_KB_DEV *UsbKbDev;\r | |
163 | EFI_SIMPLE_TEXT_INPUT_PROTOCOL *SimpleTxtIn;\r | |
164 | EFI_USB_IO_PROTOCOL *UsbIoProtocol;\r | |
165 | //\r | |
166 | // This is a device driver, so ChildHandle must be NULL.\r | |
167 | //\r | |
168 | if (ChildHandle != NULL) {\r | |
169 | return EFI_UNSUPPORTED;\r | |
170 | }\r | |
171 | \r | |
172 | //\r | |
173 | // Check Controller's handle\r | |
174 | //\r | |
175 | Status = gBS->OpenProtocol (\r | |
176 | ControllerHandle,\r | |
177 | &gEfiUsbIoProtocolGuid,\r | |
178 | (VOID **) &UsbIoProtocol,\r | |
179 | gUsbKeyboardDriverBinding.DriverBindingHandle,\r | |
180 | ControllerHandle,\r | |
181 | EFI_OPEN_PROTOCOL_BY_DRIVER\r | |
182 | );\r | |
183 | if (!EFI_ERROR (Status)) {\r | |
184 | gBS->CloseProtocol (\r | |
b4e73a63 | 185 | ControllerHandle,\r |
186 | &gEfiUsbIoProtocolGuid,\r | |
187 | gUsbKeyboardDriverBinding.DriverBindingHandle,\r | |
188 | ControllerHandle\r | |
189 | );\r | |
ed838d0c | 190 | \r |
191 | return EFI_UNSUPPORTED;\r | |
192 | }\r | |
193 | \r | |
194 | if (Status != EFI_ALREADY_STARTED) {\r | |
195 | return EFI_UNSUPPORTED;\r | |
196 | }\r | |
197 | //\r | |
198 | // Get the device context\r | |
199 | //\r | |
200 | Status = gBS->OpenProtocol (\r | |
201 | ControllerHandle,\r | |
202 | &gEfiSimpleTextInProtocolGuid,\r | |
203 | (VOID **) &SimpleTxtIn,\r | |
204 | gUsbKeyboardDriverBinding.DriverBindingHandle,\r | |
205 | ControllerHandle,\r | |
206 | EFI_OPEN_PROTOCOL_GET_PROTOCOL\r | |
207 | );\r | |
208 | \r | |
209 | if (EFI_ERROR (Status)) {\r | |
210 | return Status;\r | |
211 | }\r | |
212 | \r | |
213 | UsbKbDev = USB_KB_DEV_FROM_THIS (SimpleTxtIn);\r | |
214 | \r | |
62b9bb55 | 215 | return LookupUnicodeString2 (\r |
216 | Language,\r | |
217 | This->SupportedLanguages,\r | |
218 | UsbKbDev->ControllerNameTable,\r | |
219 | ControllerName,\r | |
220 | (BOOLEAN)(This == &gUsbKeyboardComponentName)\r | |
221 | );\r | |
ed838d0c | 222 | \r |
223 | }\r |