Clean up to fix build break.

[mirror_edk2.git] / MdeModulePkg / Bus / Usb / UsbMouseDxe / UsbMouse.h

/** @file\r
\r
  Helper routine and corrsponding data struct used by USB Mouse Driver.\r
\r
Copyright (c) 2004 - 2008, 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
**/\r
\r
#ifndef _EFI_USB_MOUSE_H_\r
#define _EFI_USB_MOUSE_H_\r
\r
\r
#include <Uefi.h>\r
\r
#include <Protocol/SimplePointer.h>\r
#include <Protocol/UsbIo.h>\r
#include <Protocol/DevicePath.h>\r
\r
#include <Library/ReportStatusCodeLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/UefiDriverEntryPoint.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/UefiLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/PcdLib.h>\r
#include <Library/UefiUsbLib.h>\r
\r
#include <IndustryStandard/Usb.h>\r
\r
#define CLASS_HID               3\r
#define SUBCLASS_BOOT           1\r
#define PROTOCOL_MOUSE          2\r
\r
#define BOOT_PROTOCOL           0\r
#define REPORT_PROTOCOL         1\r
\r
#define USB_MOUSE_DEV_SIGNATURE EFI_SIGNATURE_32 ('u', 'm', 'o', 'u')\r
\r
typedef struct {\r
  BOOLEAN ButtonDetected;\r
  UINT8   ButtonMinIndex;\r
  UINT8   ButtonMaxIndex;\r
  UINT8   Reserved;\r
} PRIVATE_DATA;\r
\r
typedef struct {\r
  UINTN                         Signature;\r
  EFI_DEVICE_PATH_PROTOCOL      *DevicePath;\r
  EFI_EVENT                     DelayedRecoveryEvent;\r
  EFI_USB_IO_PROTOCOL           *UsbIo;\r
  EFI_USB_INTERFACE_DESCRIPTOR  *InterfaceDescriptor;\r
  EFI_USB_ENDPOINT_DESCRIPTOR   *IntEndpointDescriptor;\r
  UINT8                         NumberOfButtons;\r
  INT32                         XLogicMax;\r
  INT32                         XLogicMin;\r
  INT32                         YLogicMax;\r
  INT32                         YLogicMin;\r
  EFI_SIMPLE_POINTER_PROTOCOL   SimplePointerProtocol;\r
  EFI_SIMPLE_POINTER_STATE      State;\r
  EFI_SIMPLE_POINTER_MODE       Mode;\r
  BOOLEAN                       StateChanged;\r
  PRIVATE_DATA                  PrivateData;\r
  EFI_UNICODE_STRING_TABLE      *ControllerNameTable;\r
} USB_MOUSE_DEV;\r
\r
#define USB_MOUSE_DEV_FROM_MOUSE_PROTOCOL(a) \\r
    CR(a, USB_MOUSE_DEV, SimplePointerProtocol, USB_MOUSE_DEV_SIGNATURE)\r
\r
\r
/**\r
  Timer handler for Delayed Recovery timer.\r
\r
  @param  Event                 The Delayed Recovery event.\r
  @param  Context               Points to the USB_KB_DEV instance.\r
\r
\r
**/\r
VOID\r
EFIAPI\r
USBMouseRecoveryHandler (\r
  IN    EFI_EVENT    Event,\r
  IN    VOID         *Context\r
  );\r
\r
//\r
// Global Variables\r
//\r
extern EFI_DRIVER_BINDING_PROTOCOL   gUsbMouseDriverBinding;\r
extern EFI_COMPONENT_NAME_PROTOCOL   gUsbMouseComponentName;\r
extern EFI_COMPONENT_NAME2_PROTOCOL  gUsbMouseComponentName2;\r
extern EFI_GUID                      gEfiUsbMouseDriverGuid;\r
\r
\r
/**\r
  Report Status Code in Usb Bot Driver.\r
\r
  @param  DevicePath            Use this to get Device Path\r
  @param  CodeType              Status Code Type\r
  @param  CodeValue             Status Code Value\r
\r
  @return None\r
\r
**/\r
VOID\r
MouseReportStatusCode (\r
  IN EFI_DEVICE_PATH_PROTOCOL  *DevicePath,\r
  IN EFI_STATUS_CODE_TYPE      CodeType,\r
  IN EFI_STATUS_CODE_VALUE     Value\r
  );\r
\r
#endif\r