mass cleanup inf name

[mirror_edk2.git] / IntelFrameworkModulePkg / Bus / Isa / Ps2MouseDxe / Ps2Mouse.h

/*++\r
\r
Copyright (c) 2006 - 2007, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution.  The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
Module Name:\r
\r
  Ps2Mouse.h\r
\r
Abstract:\r
\r
  PS/2 Mouse driver header file\r
\r
Revision History\r
\r
--*/\r
\r
#ifndef _PS2MOUSE_H\r
#define _PS2MOUSE_H\r
\r
#include <PiDxe.h>\r
#include <Framework/StatusCode.h>\r
\r
#include <Protocol/SimplePointer.h>\r
#include <Protocol/IsaIo.h>\r
#include <Protocol/DevicePath.h>\r
\r
#include <Library/DebugLib.h>\r
#include <Library/UefiDriverEntryPoint.h>\r
#include <Library/UefiLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/ReportStatusCodeLib.h>\r
\r
//\r
// PS/2 mouse sample rate\r
//\r
typedef enum {\r
  SSR_10,\r
  SSR_20,\r
  SSR_40,\r
  SSR_60,\r
  SSR_80,\r
  SSR_100,\r
  SSR_200,\r
  MAX_SR\r
} MOUSE_SR;\r
\r
//\r
// PS/2 mouse resolution\r
//\r
typedef enum {\r
  CMR1,\r
  CMR2,\r
  CMR4,\r
  CMR8,\r
  MAX_CMR\r
} MOUSE_RE;\r
\r
//\r
// PS/2 mouse scaling\r
//\r
typedef enum {\r
  SF1,\r
  SF2\r
} MOUSE_SF;\r
\r
//\r
// Driver Private Data\r
//\r
#define PS2_MOUSE_DEV_SIGNATURE EFI_SIGNATURE_32 ('p', 's', '2', 'm')\r
\r
typedef struct {\r
  UINTN                               Signature;\r
\r
  EFI_HANDLE                          Handle;\r
  EFI_SIMPLE_POINTER_PROTOCOL         SimplePointerProtocol;\r
  EFI_SIMPLE_POINTER_STATE            State;\r
  EFI_SIMPLE_POINTER_MODE             Mode;\r
  BOOLEAN                             StateChanged;\r
\r
  //\r
  // PS2 Mouse device specific information\r
  //\r
  MOUSE_SR                            SampleRate;\r
  MOUSE_RE                            Resolution;\r
  MOUSE_SF                            Scaling;\r
  UINT8                               DataPackageSize;\r
\r
  EFI_ISA_IO_PROTOCOL                 *IsaIo;\r
\r
  EFI_EVENT                           TimerEvent;\r
\r
  EFI_UNICODE_STRING_TABLE            *ControllerNameTable;\r
  EFI_DEVICE_PATH_PROTOCOL            *DevicePath;\r
} PS2_MOUSE_DEV;\r
\r
#define PS2_MOUSE_DEV_FROM_THIS(a)  CR (a, PS2_MOUSE_DEV, SimplePointerProtocol, PS2_MOUSE_DEV_SIGNATURE)\r
\r
//\r
// Global Variables\r
//\r
extern EFI_DRIVER_BINDING_PROTOCOL  gPS2MouseDriver;\r
extern EFI_COMPONENT_NAME_PROTOCOL  gPs2MouseComponentName;\r
\r
//\r
// Function prototypes\r
//\r
EFI_STATUS\r
EFIAPI\r
PS2MouseDriverSupported (\r
  IN EFI_DRIVER_BINDING_PROTOCOL    *This,\r
  IN EFI_HANDLE                     Controller,\r
  IN EFI_DEVICE_PATH_PROTOCOL       *RemainingDevicePath\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
PS2MouseDriverStart (\r
  IN EFI_DRIVER_BINDING_PROTOCOL    *This,\r
  IN EFI_HANDLE                     Controller,\r
  IN EFI_DEVICE_PATH_PROTOCOL       *RemainingDevicePath\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
PS2MouseDriverStop (\r
  IN EFI_DRIVER_BINDING_PROTOCOL   *This,\r
  IN EFI_HANDLE                    Controller,\r
  IN UINTN                         NumberOfChildren,\r
  IN EFI_HANDLE                    *ChildHandleBuffer\r
  );\r
\r
//\r
// EFI Component Name Functions\r
//\r
EFI_STATUS\r
EFIAPI\r
Ps2MouseComponentNameGetDriverName (\r
  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,\r
  IN  CHAR8                        *Language,\r
  OUT CHAR16                       **DriverName\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
Ps2MouseComponentNameGetControllerName (\r
  IN  EFI_COMPONENT_NAME_PROTOCOL                     *This,\r
  IN  EFI_HANDLE                                      ControllerHandle,\r
  IN  EFI_HANDLE                                      ChildHandle        OPTIONAL,\r
  IN  CHAR8                                           *Language,\r
  OUT CHAR16                                          **ControllerName\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
MouseReset (\r
  IN EFI_SIMPLE_POINTER_PROTOCOL    *This,\r
  IN BOOLEAN                        ExtendedVerification\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
MouseGetState (\r
  IN EFI_SIMPLE_POINTER_PROTOCOL    *This,\r
  IN OUT EFI_SIMPLE_POINTER_STATE   *State\r
  );\r
\r
VOID\r
EFIAPI\r
MouseWaitForInput (\r
  IN  EFI_EVENT               Event,\r
  IN  VOID                    *Context\r
  );\r
\r
VOID\r
EFIAPI\r
PollMouse (\r
  IN EFI_EVENT  Event,\r
  IN VOID       *Context\r
  );\r
\r
EFI_STATUS\r
In8042Data (\r
  IN EFI_ISA_IO_PROTOCOL                  *IsaIo,\r
  IN OUT UINT8                            *Data\r
  );\r
BOOLEAN\r
CheckMouseConnect (\r
  IN  PS2_MOUSE_DEV     *MouseDev\r
  );\r
\r
#endif\r