2 PS/2 Mouse driver header file.
4 Copyright (c) 2006 - 2007, 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.
18 #include <FrameworkDxe.h>
20 #include <Protocol/SimplePointer.h>
21 #include <Protocol/IsaIo.h>
22 #include <Protocol/DevicePath.h>
24 #include <Library/DebugLib.h>
25 #include <Library/UefiDriverEntryPoint.h>
26 #include <Library/UefiLib.h>
27 #include <Library/BaseMemoryLib.h>
28 #include <Library/MemoryAllocationLib.h>
29 #include <Library/UefiBootServicesTableLib.h>
30 #include <Library/ReportStatusCodeLib.h>
35 extern EFI_DRIVER_BINDING_PROTOCOL gPS2MouseDriver
;
36 extern EFI_COMPONENT_NAME_PROTOCOL gPs2MouseComponentName
;
37 extern EFI_COMPONENT_NAME2_PROTOCOL gPs2MouseComponentName2
;
40 // PS/2 mouse sample rate
54 // PS/2 mouse resolution
73 // Driver Private Data
75 #define PS2_MOUSE_DEV_SIGNATURE SIGNATURE_32 ('p', 's', '2', 'm')
81 EFI_SIMPLE_POINTER_PROTOCOL SimplePointerProtocol
;
82 EFI_SIMPLE_POINTER_STATE State
;
83 EFI_SIMPLE_POINTER_MODE Mode
;
87 // PS2 Mouse device specific information
92 UINT8 DataPackageSize
;
94 EFI_ISA_IO_PROTOCOL
*IsaIo
;
98 EFI_UNICODE_STRING_TABLE
*ControllerNameTable
;
99 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
102 #define PS2_MOUSE_DEV_FROM_THIS(a) CR (a, PS2_MOUSE_DEV, SimplePointerProtocol, PS2_MOUSE_DEV_SIGNATURE)
105 // Function prototypes
108 Test to see if this driver supports ControllerHandle. Any ControllerHandle
109 than contains a IsaIo protocol can be supported.
111 @param This Protocol instance pointer.
112 @param ControllerHandle Handle of device to test
113 @param RemainingDevicePath Optional parameter use to pick a specific child
116 @retval EFI_SUCCESS This driver supports this device
117 @retval EFI_ALREADY_STARTED This driver is already running on this device
118 @retval other This driver does not support this device
123 PS2MouseDriverSupported (
124 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
125 IN EFI_HANDLE Controller
,
126 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
130 Start this driver on ControllerHandle by opening a IsaIo
131 protocol, creating PS2_MOUSE_ABSOLUTE_POINTER_DEV device and install gEfiAbsolutePointerProtocolGuid
134 @param This Protocol instance pointer.
135 @param ControllerHandle Handle of device to bind driver to
136 @param RemainingDevicePath Optional parameter use to pick a specific child
139 @retval EFI_SUCCESS This driver is added to ControllerHandle
140 @retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle
141 @retval other This driver does not support this device
146 PS2MouseDriverStart (
147 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
148 IN EFI_HANDLE Controller
,
149 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
153 Stop this driver on ControllerHandle. Support stoping any child handles
154 created by this driver.
156 @param This Protocol instance pointer.
157 @param ControllerHandle Handle of device to stop driver on
158 @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
159 children is zero stop the entire bus driver.
160 @param ChildHandleBuffer List of Child Handles to Stop.
162 @retval EFI_SUCCESS This driver is removed ControllerHandle
163 @retval other This driver was not removed from this device
169 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
170 IN EFI_HANDLE Controller
,
171 IN UINTN NumberOfChildren
,
172 IN EFI_HANDLE
*ChildHandleBuffer
176 // EFI Component Name Functions
179 Retrieves a Unicode string that is the user readable name of the driver.
181 This function retrieves the user readable name of a driver in the form of a
182 Unicode string. If the driver specified by This has a user readable name in
183 the language specified by Language, then a pointer to the driver name is
184 returned in DriverName, and EFI_SUCCESS is returned. If the driver specified
185 by This does not support the language specified by Language,
186 then EFI_UNSUPPORTED is returned.
188 @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
189 EFI_COMPONENT_NAME_PROTOCOL instance.
191 @param Language[in] A pointer to a Null-terminated ASCII string
192 array indicating the language. This is the
193 language of the driver name that the caller is
194 requesting, and it must match one of the
195 languages specified in SupportedLanguages. The
196 number of languages supported by a driver is up
197 to the driver writer. Language is specified
198 in RFC 4646 or ISO 639-2 language code format.
200 @param DriverName[out] A pointer to the Unicode string to return.
201 This Unicode string is the name of the
202 driver specified by This in the language
203 specified by Language.
205 @retval EFI_SUCCESS The Unicode string for the Driver specified by
206 This and the language specified by Language was
207 returned in DriverName.
209 @retval EFI_INVALID_PARAMETER Language is NULL.
211 @retval EFI_INVALID_PARAMETER DriverName is NULL.
213 @retval EFI_UNSUPPORTED The driver specified by This does not support
214 the language specified by Language.
219 Ps2MouseComponentNameGetDriverName (
220 IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
222 OUT CHAR16
**DriverName
227 Retrieves a Unicode string that is the user readable name of the controller
228 that is being managed by a driver.
230 This function retrieves the user readable name of the controller specified by
231 ControllerHandle and ChildHandle in the form of a Unicode string. If the
232 driver specified by This has a user readable name in the language specified by
233 Language, then a pointer to the controller name is returned in ControllerName,
234 and EFI_SUCCESS is returned. If the driver specified by This is not currently
235 managing the controller specified by ControllerHandle and ChildHandle,
236 then EFI_UNSUPPORTED is returned. If the driver specified by This does not
237 support the language specified by Language, then EFI_UNSUPPORTED is returned.
239 @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
240 EFI_COMPONENT_NAME_PROTOCOL instance.
242 @param ControllerHandle[in] The handle of a controller that the driver
243 specified by This is managing. This handle
244 specifies the controller whose name is to be
247 @param ChildHandle[in] The handle of the child controller to retrieve
248 the name of. This is an optional parameter that
249 may be NULL. It will be NULL for device
250 drivers. It will also be NULL for a bus drivers
251 that wish to retrieve the name of the bus
252 controller. It will not be NULL for a bus
253 driver that wishes to retrieve the name of a
256 @param Language[in] A pointer to a Null-terminated ASCII string
257 array indicating the language. This is the
258 language of the driver name that the caller is
259 requesting, and it must match one of the
260 languages specified in SupportedLanguages. The
261 number of languages supported by a driver is up
262 to the driver writer. Language is specified in
263 RFC 4646 or ISO 639-2 language code format.
265 @param ControllerName[out] A pointer to the Unicode string to return.
266 This Unicode string is the name of the
267 controller specified by ControllerHandle and
268 ChildHandle in the language specified by
269 Language from the point of view of the driver
272 @retval EFI_SUCCESS The Unicode string for the user readable name in
273 the language specified by Language for the
274 driver specified by This was returned in
277 @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.
279 @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid
282 @retval EFI_INVALID_PARAMETER Language is NULL.
284 @retval EFI_INVALID_PARAMETER ControllerName is NULL.
286 @retval EFI_UNSUPPORTED The driver specified by This is not currently
287 managing the controller specified by
288 ControllerHandle and ChildHandle.
290 @retval EFI_UNSUPPORTED The driver specified by This does not support
291 the language specified by Language.
296 Ps2MouseComponentNameGetControllerName (
297 IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
298 IN EFI_HANDLE ControllerHandle
,
299 IN EFI_HANDLE ChildHandle OPTIONAL
,
301 OUT CHAR16
**ControllerName
305 Reset the Mouse and do BAT test for it, if ExtendedVerification isTRUE and there is a mouse device connectted to system
307 @param This - Pointer of simple pointer Protocol.
308 @param ExtendedVerification - Whether configure mouse parameters. True: do; FALSE: skip.
311 @retval EFI_SUCCESS - The command byte is written successfully.
312 @retval EFI_DEVICE_ERROR - Errors occurred during reseting keyboard.
318 IN EFI_SIMPLE_POINTER_PROTOCOL
*This
,
319 IN BOOLEAN ExtendedVerification
323 Get and Clear mouse status.
325 @param This - Pointer of simple pointer Protocol.
326 @param State - Output buffer holding status.
328 @retval EFI_INVALID_PARAMETER Output buffer is invalid.
329 @retval EFI_NOT_READY Mouse is not changed status yet.
330 @retval EFI_SUCCESS Mouse status is changed and get successful.
335 IN EFI_SIMPLE_POINTER_PROTOCOL
*This
,
336 IN OUT EFI_SIMPLE_POINTER_STATE
*State
341 Event notification function for SIMPLE_POINTER.WaitForInput event.
342 Signal the event if there is input from mouse.
344 @param Event event object
345 @param Context event context
356 Event notification function for TimerEvent event.
357 If mouse device is connected to system, try to get the mouse packet data.
359 @param Event - TimerEvent in PS2_MOUSE_DEV
360 @param Context - Pointer to PS2_MOUSE_DEV structure
371 I/O work flow of in 8042 data.
373 @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL
374 @param Data Data value
376 @retval EFI_SUCCESS Success to excute I/O work flow
377 @retval EFI_TIMEOUT Keyboard controller time out.
381 IN EFI_ISA_IO_PROTOCOL
*IsaIo
,
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