Ps2Mouse.h

Go to the documentation of this file.

 
#ifndef _PS2MOUSE_H_
#define _PS2MOUSE_H_
 
#include <Uefi.h>
 
#include <Protocol/SimplePointer.h>
#include <Protocol/SuperIo.h>
#include <Protocol/DevicePath.h>
 
#include <Library/DevicePathLib.h>
#include <Library/DebugLib.h>
#include <Library/UefiDriverEntryPoint.h>
#include <Library/UefiLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/ReportStatusCodeLib.h>
#include <Library/PcdLib.h>
#include <Library/IoLib.h>
 
//
// Global Variables
//
extern EFI_DRIVER_BINDING_PROTOCOL   gPS2MouseDriver;
extern EFI_COMPONENT_NAME_PROTOCOL   gPs2MouseComponentName;
extern EFI_COMPONENT_NAME2_PROTOCOL  gPs2MouseComponentName2;
 
//
// PS/2 mouse sample rate
//
typedef enum {
  SampleRate10,
  SampleRate20,
  SampleRate40,
  SampleRate60,
  SampleRate80,
  SampleRate100,
  SampleRate200,
  MaxSampleRate
} MOUSE_SR;
 
//
// PS/2 mouse resolution
//
typedef enum {
  MouseResolution1,
  MouseResolution2,
  MouseResolution4,
  MouseResolution8,
  MaxResolution
} MOUSE_RE;
 
//
// PS/2 mouse scaling
//
typedef enum {
  Scaling1,
  Scaling2
} MOUSE_SF;
 
//
// Driver Private Data
//
#define PS2_MOUSE_DEV_SIGNATURE  SIGNATURE_32 ('p', 's', '2', 'm')
 
typedef struct {
  UINTN                          Signature;
 
  EFI_HANDLE                     Handle;
  EFI_SIMPLE_POINTER_PROTOCOL    SimplePointerProtocol;
  EFI_SIMPLE_POINTER_STATE       State;
  EFI_SIMPLE_POINTER_MODE        Mode;
  BOOLEAN                        StateChanged;
 
  //
  // PS2 Mouse device specific information
  //
  MOUSE_SR                       SampleRate;
  MOUSE_RE                       Resolution;
  MOUSE_SF                       Scaling;
  UINT8                          DataPackageSize;
 
  EFI_EVENT                      TimerEvent;
 
  EFI_UNICODE_STRING_TABLE       *ControllerNameTable;
  EFI_DEVICE_PATH_PROTOCOL       *DevicePath;
} PS2_MOUSE_DEV;
 
#define PS2_MOUSE_DEV_FROM_THIS(a)  CR (a, PS2_MOUSE_DEV, SimplePointerProtocol, PS2_MOUSE_DEV_SIGNATURE)
 
//
// Function prototypes
//
 
EFI_STATUS
EFIAPI
PS2MouseDriverSupported (
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,
  IN EFI_HANDLE                   Controller,
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath
  );
 
EFI_STATUS
EFIAPI
PS2MouseDriverStart (
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,
  IN EFI_HANDLE                   Controller,
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath
  );
 
EFI_STATUS
EFIAPI
PS2MouseDriverStop (
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,
  IN EFI_HANDLE                   Controller,
  IN UINTN                        NumberOfChildren,
  IN EFI_HANDLE                   *ChildHandleBuffer
  );
 
//
// EFI Component Name Functions
//
 
EFI_STATUS
EFIAPI
Ps2MouseComponentNameGetDriverName (
  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,
  IN  CHAR8                        *Language,
  OUT CHAR16                       **DriverName
  );
 
EFI_STATUS
EFIAPI
Ps2MouseComponentNameGetControllerName (
  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,
  IN  EFI_HANDLE                   ControllerHandle,
  IN  EFI_HANDLE                   ChildHandle        OPTIONAL,
  IN  CHAR8                        *Language,
  OUT CHAR16                       **ControllerName
  );
 
EFI_STATUS
EFIAPI
MouseReset (
  IN EFI_SIMPLE_POINTER_PROTOCOL  *This,
  IN BOOLEAN                      ExtendedVerification
  );
 
EFI_STATUS
EFIAPI
MouseGetState (
  IN EFI_SIMPLE_POINTER_PROTOCOL   *This,
  IN OUT EFI_SIMPLE_POINTER_STATE  *State
  );
 
VOID
EFIAPI
MouseWaitForInput (
  IN  EFI_EVENT  Event,
  IN  VOID       *Context
  );
 
VOID
EFIAPI
PollMouse (
  IN EFI_EVENT  Event,
  IN VOID       *Context
  );
 
EFI_STATUS
In8042Data (
  IN OUT UINT8  *Data
  );
 
BOOLEAN
CheckMouseConnect (
  IN  PS2_MOUSE_DEV  *MouseDev
  );
 
#endif