UsbMouse.h

Go to the documentation of this file.

 
#ifndef _EFI_USB_MOUSE_H_
#define _EFI_USB_MOUSE_H_
 
#include <Uefi.h>
 
#include <Protocol/SimplePointer.h>
#include <Protocol/UsbIo.h>
#include <Protocol/DevicePath.h>
 
#include <Library/ReportStatusCodeLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/UefiDriverEntryPoint.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/UefiLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/UefiUsbLib.h>
#include <Library/DebugLib.h>
 
#include <IndustryStandard/Usb.h>
 
#define CLASS_HID       3
#define SUBCLASS_BOOT   1
#define PROTOCOL_MOUSE  2
 
#define BOOT_PROTOCOL    0
#define REPORT_PROTOCOL  1
 
#define USB_MOUSE_DEV_SIGNATURE  SIGNATURE_32 ('u', 'm', 'o', 'u')
 
//
// A common header for usb standard descriptor.
// Each stand descriptor has a length and type.
//
#pragma pack(1)
typedef struct {
  UINT8    Len;
  UINT8    Type;
} USB_DESC_HEAD;
#pragma pack()
 
typedef struct {
  BOOLEAN    ButtonDetected;
  UINT8      ButtonMinIndex;
  UINT8      ButtonMaxIndex;
  UINT8      Reserved;
} USB_MOUSE_BUTTON_DATA;
 
typedef struct {
  UINTN                           Signature;
  EFI_DEVICE_PATH_PROTOCOL        *DevicePath;
  EFI_EVENT                       DelayedRecoveryEvent;
  EFI_USB_IO_PROTOCOL             *UsbIo;
  EFI_USB_INTERFACE_DESCRIPTOR    InterfaceDescriptor;
  EFI_USB_ENDPOINT_DESCRIPTOR     IntEndpointDescriptor;
  UINT8                           NumberOfButtons;
  INT32                           XLogicMax;
  INT32                           XLogicMin;
  INT32                           YLogicMax;
  INT32                           YLogicMin;
  EFI_SIMPLE_POINTER_PROTOCOL     SimplePointerProtocol;
  EFI_SIMPLE_POINTER_STATE        State;
  EFI_SIMPLE_POINTER_MODE         Mode;
  BOOLEAN                         StateChanged;
  USB_MOUSE_BUTTON_DATA           PrivateData;
  EFI_UNICODE_STRING_TABLE        *ControllerNameTable;
} USB_MOUSE_DEV;
 
 
typedef union {
  UINT8     Uint8;
  UINT16    Uint16;
  UINT32    Uint32;
  INT8      Int8;
  INT16     Int16;
  INT32     Int32;
  UINT8     *LongData;
} HID_DATA;
 
typedef struct {
  UINT16      Format;
  UINT8       Size;
  UINT8       Type;
  UINT8       Tag;
  HID_DATA    Data;
} HID_ITEM;
 
#define USB_MOUSE_DEV_FROM_MOUSE_PROTOCOL(a) \
    CR(a, USB_MOUSE_DEV, SimplePointerProtocol, USB_MOUSE_DEV_SIGNATURE)
 
//
// Global Variables
//
extern EFI_DRIVER_BINDING_PROTOCOL   gUsbMouseDriverBinding;
extern EFI_COMPONENT_NAME_PROTOCOL   gUsbMouseComponentName;
extern EFI_COMPONENT_NAME2_PROTOCOL  gUsbMouseComponentName2;
 
//
// Functions of Driver Binding Protocol
//
 
EFI_STATUS
EFIAPI
USBMouseDriverBindingSupported (
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,
  IN EFI_HANDLE                   Controller,
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath
  );
 
EFI_STATUS
EFIAPI
USBMouseDriverBindingStart (
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,
  IN EFI_HANDLE                   Controller,
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath
  );
 
EFI_STATUS
EFIAPI
USBMouseDriverBindingStop (
  IN  EFI_DRIVER_BINDING_PROTOCOL  *This,
  IN  EFI_HANDLE                   Controller,
  IN  UINTN                        NumberOfChildren,
  IN  EFI_HANDLE                   *ChildHandleBuffer
  );
 
//
// EFI Component Name Functions
//
 
EFI_STATUS
EFIAPI
UsbMouseComponentNameGetDriverName (
  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,
  IN  CHAR8                        *Language,
  OUT CHAR16                       **DriverName
  );
 
EFI_STATUS
EFIAPI
UsbMouseComponentNameGetControllerName (
  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,
  IN  EFI_HANDLE                   ControllerHandle,
  IN  EFI_HANDLE                   ChildHandle        OPTIONAL,
  IN  CHAR8                        *Language,
  OUT CHAR16                       **ControllerName
  );
 
//
// Functions of EFI_SIMPLE_POINTER_PROTOCOL
//
 
EFI_STATUS
EFIAPI
GetMouseState (
  IN   EFI_SIMPLE_POINTER_PROTOCOL  *This,
  OUT  EFI_SIMPLE_POINTER_STATE     *MouseState
  );
 
EFI_STATUS
EFIAPI
UsbMouseReset (
  IN EFI_SIMPLE_POINTER_PROTOCOL  *This,
  IN BOOLEAN                      ExtendedVerification
  );
 
VOID
EFIAPI
UsbMouseWaitForInput (
  IN  EFI_EVENT  Event,
  IN  VOID       *Context
  );
 
//
// Internal worker functions
//
 
BOOLEAN
IsUsbMouse (
  IN  EFI_USB_IO_PROTOCOL  *UsbIo
  );
 
EFI_STATUS
InitializeUsbMouseDevice (
  IN OUT USB_MOUSE_DEV  *UsbMouseDev
  );
 
EFI_STATUS
EFIAPI
OnMouseInterruptComplete (
  IN  VOID    *Data,
  IN  UINTN   DataLength,
  IN  VOID    *Context,
  IN  UINT32  Result
  );
 
VOID
EFIAPI
USBMouseRecoveryHandler (
  IN    EFI_EVENT  Event,
  IN    VOID       *Context
  );
 
EFI_STATUS
ParseMouseReportDescriptor (
  OUT USB_MOUSE_DEV  *UsbMouse,
  IN  UINT8          *ReportDescriptor,
  IN  UINTN          ReportSize
  );
 
#endif