2 PS/2 Mouse driver header file.
4 Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>
5 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.
20 #include <Protocol/SimplePointer.h>
21 #include <Protocol/SuperIo.h>
22 #include <Protocol/DevicePath.h>
24 #include <Library/DevicePathLib.h>
25 #include <Library/DebugLib.h>
26 #include <Library/UefiDriverEntryPoint.h>
27 #include <Library/UefiLib.h>
28 #include <Library/BaseMemoryLib.h>
29 #include <Library/MemoryAllocationLib.h>
30 #include <Library/UefiBootServicesTableLib.h>
31 #include <Library/ReportStatusCodeLib.h>
32 #include <Library/PcdLib.h>
33 #include <Library/IoLib.h>
38 extern EFI_DRIVER_BINDING_PROTOCOL gPS2MouseDriver
;
39 extern EFI_COMPONENT_NAME_PROTOCOL gPs2MouseComponentName
;
40 extern EFI_COMPONENT_NAME2_PROTOCOL gPs2MouseComponentName2
;
43 // PS/2 mouse sample rate
57 // PS/2 mouse resolution
76 // Driver Private Data
78 #define PS2_MOUSE_DEV_SIGNATURE SIGNATURE_32 ('p', 's', '2', 'm')
84 EFI_SIMPLE_POINTER_PROTOCOL SimplePointerProtocol
;
85 EFI_SIMPLE_POINTER_STATE State
;
86 EFI_SIMPLE_POINTER_MODE Mode
;
90 // PS2 Mouse device specific information
95 UINT8 DataPackageSize
;
99 EFI_UNICODE_STRING_TABLE
*ControllerNameTable
;
100 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
103 #define PS2_MOUSE_DEV_FROM_THIS(a) CR (a, PS2_MOUSE_DEV, SimplePointerProtocol, PS2_MOUSE_DEV_SIGNATURE)
106 // Function prototypes
109 Test to see if this driver supports ControllerHandle. Any ControllerHandle
110 than contains a IsaIo protocol can be supported.
112 @param This Protocol instance pointer.
113 @param ControllerHandle Handle of device to test
114 @param RemainingDevicePath Optional parameter use to pick a specific child
117 @retval EFI_SUCCESS This driver supports this device
118 @retval EFI_ALREADY_STARTED This driver is already running on this device
119 @retval other This driver does not support this device
124 PS2MouseDriverSupported (
125 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
126 IN EFI_HANDLE Controller
,
127 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
131 Start this driver on ControllerHandle by opening a IsaIo
132 protocol, creating PS2_MOUSE_ABSOLUTE_POINTER_DEV device and install gEfiAbsolutePointerProtocolGuid
135 @param This Protocol instance pointer.
136 @param ControllerHandle Handle of device to bind driver to
137 @param RemainingDevicePath Optional parameter use to pick a specific child
140 @retval EFI_SUCCESS This driver is added to ControllerHandle
141 @retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle
142 @retval other This driver does not support this device
147 PS2MouseDriverStart (
148 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
149 IN EFI_HANDLE Controller
,
150 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
154 Stop this driver on ControllerHandle. Support stopping any child handles
155 created by this driver.
157 @param This Protocol instance pointer.
158 @param ControllerHandle Handle of device to stop driver on
159 @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
160 children is zero stop the entire bus driver.
161 @param ChildHandleBuffer List of Child Handles to Stop.
163 @retval EFI_SUCCESS This driver is removed ControllerHandle
164 @retval other This driver was not removed from this device
170 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
171 IN EFI_HANDLE Controller
,
172 IN UINTN NumberOfChildren
,
173 IN EFI_HANDLE
*ChildHandleBuffer
177 // EFI Component Name Functions
180 Retrieves a Unicode string that is the user readable name of the driver.
182 This function retrieves the user readable name of a driver in the form of a
183 Unicode string. If the driver specified by This has a user readable name in
184 the language specified by Language, then a pointer to the driver name is
185 returned in DriverName, and EFI_SUCCESS is returned. If the driver specified
186 by This does not support the language specified by Language,
187 then EFI_UNSUPPORTED is returned.
189 @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
190 EFI_COMPONENT_NAME_PROTOCOL instance.
192 @param Language[in] A pointer to a Null-terminated ASCII string
193 array indicating the language. This is the
194 language of the driver name that the caller is
195 requesting, and it must match one of the
196 languages specified in SupportedLanguages. The
197 number of languages supported by a driver is up
198 to the driver writer. Language is specified
199 in RFC 4646 or ISO 639-2 language code format.
201 @param DriverName[out] A pointer to the Unicode string to return.
202 This Unicode string is the name of the
203 driver specified by This in the language
204 specified by Language.
206 @retval EFI_SUCCESS The Unicode string for the Driver specified by
207 This and the language specified by Language was
208 returned in DriverName.
210 @retval EFI_INVALID_PARAMETER Language is NULL.
212 @retval EFI_INVALID_PARAMETER DriverName is NULL.
214 @retval EFI_UNSUPPORTED The driver specified by This does not support
215 the language specified by Language.
220 Ps2MouseComponentNameGetDriverName (
221 IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
223 OUT CHAR16
**DriverName
228 Retrieves a Unicode string that is the user readable name of the controller
229 that is being managed by a driver.
231 This function retrieves the user readable name of the controller specified by
232 ControllerHandle and ChildHandle in the form of a Unicode string. If the
233 driver specified by This has a user readable name in the language specified by
234 Language, then a pointer to the controller name is returned in ControllerName,
235 and EFI_SUCCESS is returned. If the driver specified by This is not currently
236 managing the controller specified by ControllerHandle and ChildHandle,
237 then EFI_UNSUPPORTED is returned. If the driver specified by This does not
238 support the language specified by Language, then EFI_UNSUPPORTED is returned.
240 @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
241 EFI_COMPONENT_NAME_PROTOCOL instance.
243 @param ControllerHandle[in] The handle of a controller that the driver
244 specified by This is managing. This handle
245 specifies the controller whose name is to be
248 @param ChildHandle[in] The handle of the child controller to retrieve
249 the name of. This is an optional parameter that
250 may be NULL. It will be NULL for device
251 drivers. It will also be NULL for a bus drivers
252 that wish to retrieve the name of the bus
253 controller. It will not be NULL for a bus
254 driver that wishes to retrieve the name of a
257 @param Language[in] A pointer to a Null-terminated ASCII string
258 array indicating the language. This is the
259 language of the driver name that the caller is
260 requesting, and it must match one of the
261 languages specified in SupportedLanguages. The
262 number of languages supported by a driver is up
263 to the driver writer. Language is specified in
264 RFC 4646 or ISO 639-2 language code format.
266 @param ControllerName[out] A pointer to the Unicode string to return.
267 This Unicode string is the name of the
268 controller specified by ControllerHandle and
269 ChildHandle in the language specified by
270 Language from the point of view of the driver
273 @retval EFI_SUCCESS The Unicode string for the user readable name in
274 the language specified by Language for the
275 driver specified by This was returned in
278 @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.
280 @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid
283 @retval EFI_INVALID_PARAMETER Language is NULL.
285 @retval EFI_INVALID_PARAMETER ControllerName is NULL.
287 @retval EFI_UNSUPPORTED The driver specified by This is not currently
288 managing the controller specified by
289 ControllerHandle and ChildHandle.
291 @retval EFI_UNSUPPORTED The driver specified by This does not support
292 the language specified by Language.
297 Ps2MouseComponentNameGetControllerName (
298 IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
299 IN EFI_HANDLE ControllerHandle
,
300 IN EFI_HANDLE ChildHandle OPTIONAL
,
302 OUT CHAR16
**ControllerName
306 Reset the Mouse and do BAT test for it, if ExtendedVerification is TRUE and
307 there is a mouse device connected to system.
309 @param This - Pointer of simple pointer Protocol.
310 @param ExtendedVerification - Whether configure mouse parameters. True: do; FALSE: skip.
313 @retval EFI_SUCCESS - The command byte is written successfully.
314 @retval EFI_DEVICE_ERROR - Errors occurred during resetting keyboard.
320 IN EFI_SIMPLE_POINTER_PROTOCOL
*This
,
321 IN BOOLEAN ExtendedVerification
325 Get and Clear mouse status.
327 @param This - Pointer of simple pointer Protocol.
328 @param State - Output buffer holding status.
330 @retval EFI_INVALID_PARAMETER Output buffer is invalid.
331 @retval EFI_NOT_READY Mouse is not changed status yet.
332 @retval EFI_SUCCESS Mouse status is changed and get successful.
337 IN EFI_SIMPLE_POINTER_PROTOCOL
*This
,
338 IN OUT EFI_SIMPLE_POINTER_STATE
*State
343 Event notification function for SIMPLE_POINTER.WaitForInput event.
344 Signal the event if there is input from mouse.
346 @param Event event object
347 @param Context event context
358 Event notification function for TimerEvent event.
359 If mouse device is connected to system, try to get the mouse packet data.
361 @param Event - TimerEvent in PS2_MOUSE_DEV
362 @param Context - Pointer to PS2_MOUSE_DEV structure
373 I/O work flow of in 8042 data.
375 @param Data Data value
377 @retval EFI_SUCCESS Success to execute I/O work flow
378 @retval EFI_TIMEOUT Keyboard controller time out.
386 Check whether there is Ps/2 mouse device in system
388 @param MouseDev - Mouse Private Data Structure
390 @retval TRUE - Keyboard in System.
391 @retval FALSE - Keyboard not in System.
396 IN PS2_MOUSE_DEV
*MouseDev