Initial import.

[mirror_edk2.git] / EdkModulePkg / Bus / Usb / UsbMouse / Dxe / usbmouse.h

/*++\r
\r
Copyright (c) 2006, 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
    UsbMouse.h\r
\r
  Abstract:\r
\r
--*/\r
\r
#ifndef _USB_MOUSE_H\r
#define _USB_MOUSE_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
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_GUID                     gEfiUsbMouseDriverGuid;\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