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