MdeModulePkg/Bus/Usb/UsbMouseAbsolutePointerDxe/UsbMouseAbsolutePointer.h

   1 /** @file
   2
   3 Copyright (c) 2004 - 2007, Intel Corporation
   4 All rights reserved. This program and the accompanying materials
   5 are licensed and made available under the terms and conditions of the BSD License
   6 which accompanies this distribution.  The full text of the license may be found at
   7 http://opensource.org/licenses/bsd-license.php
   8
   9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  11
  12   Module Name:
  13
  14     UsbMouseAbsolutePointer.h
  15
  16   Abstract:
  17
  18
  19 **/
  20
  21 #ifndef _USB_MOUSE_ABSOLUTE_POINTER_H
  22 #define _USB_MOUSE_ABSOLUTE_POINTER_H
  23
  24
  25 #include <Uefi.h>
  26
  27 #include <Protocol/AbsolutePointer.h>
  28 #include <Protocol/UsbIo.h>
  29 #include <Protocol/DevicePath.h>
  30
  31 #include <Library/ReportStatusCodeLib.h>
  32 #include <Library/BaseMemoryLib.h>
  33 #include <Library/UefiDriverEntryPoint.h>
  34 #include <Library/UefiBootServicesTableLib.h>
  35 #include <Library/UefiLib.h>
  36 #include <Library/BaseLib.h>
  37 #include <Library/MemoryAllocationLib.h>
  38 #include <Library/PcdLib.h>
  39 #include <Library/UefiUsbLib.h>
  40
  41 #include <IndustryStandard/Usb.h>
  42
  43 #define CLASS_HID               3
  44 #define SUBCLASS_BOOT           1
  45 #define PROTOCOL_MOUSE          2
  46
  47 #define BOOT_PROTOCOL           0
  48 #define REPORT_PROTOCOL         1
  49
  50 #define USB_MOUSE_ABSOLUTE_POINTER_DEV_SIGNATURE EFI_SIGNATURE_32 ('u', 'm', 's', 't')
  51
  52 typedef struct {
  53   BOOLEAN ButtonDetected;
  54   UINT8   ButtonMinIndex;
  55   UINT8   ButtonMaxIndex;
  56   UINT8   Reserved;
  57 } PRIVATE_DATA;
  58
  59 typedef struct {
  60   UINTN                         Signature;
  61   EFI_DEVICE_PATH_PROTOCOL      *DevicePath;
  62   EFI_EVENT                     DelayedRecoveryEvent;
  63   EFI_USB_IO_PROTOCOL           *UsbIo;
  64   EFI_USB_INTERFACE_DESCRIPTOR  *InterfaceDescriptor;
  65   EFI_USB_ENDPOINT_DESCRIPTOR   *IntEndpointDescriptor;
  66   UINT8                         NumberOfButtons;
  67   INT32                         XLogicMax;
  68   INT32                         XLogicMin;
  69   INT32                         YLogicMax;
  70   INT32                         YLogicMin;
  71
  72   EFI_ABSOLUTE_POINTER_PROTOCOL AbsolutePointerProtocol;
  73   EFI_ABSOLUTE_POINTER_STATE    AbsolutePointerState;
  74   EFI_ABSOLUTE_POINTER_MODE             AbsolutePointerMode;
  75   BOOLEAN                                               AbsolutePointerStateChanged;
  76
  77   PRIVATE_DATA                  PrivateData;
  78   EFI_UNICODE_STRING_TABLE      *ControllerNameTable;
  79 } USB_MOUSE_ABSOLUTE_POINTER_DEV;
  80
  81 #define USB_MOUSE_ABSOLUTE_POINTER_DEV_FROM_MOUSE_PROTOCOL(a) \
  82     CR(a, USB_MOUSE_ABSOLUTE_POINTER_DEV, AbsolutePointerProtocol, USB_MOUSE_ABSOLUTE_POINTER_DEV_SIGNATURE)
  83
  84 VOID
  85 EFIAPI
  86 USBMouseAbsolutePointerRecoveryHandler (
  87   IN    EFI_EVENT    Event,
  88   IN    VOID         *Context
  89   );
  90
  91 //
  92 // Global Variables
  93 //
  94 extern EFI_DRIVER_BINDING_PROTOCOL   gUsbMouseAbsolutePointerDriverBinding;
  95 extern EFI_COMPONENT_NAME_PROTOCOL   gUsbMouseAbsolutePointerComponentName;
  96 extern EFI_COMPONENT_NAME2_PROTOCOL  gUsbMouseAbsolutePointerComponentName2;
  97 extern EFI_GUID                      gEfiUsbMouseAbsolutePointerDriverGuid;
  98
  99 VOID
 100 MouseAbsolutePointerReportStatusCode (
 101   IN EFI_DEVICE_PATH_PROTOCOL  *DevicePath,
 102   IN EFI_STATUS_CODE_TYPE      CodeType,
 103   IN EFI_STATUS_CODE_VALUE     Value
 104   );
 105
 106 //
 107 // Prototypes
 108 // Driver model protocol interface
 109 //
 110 EFI_STATUS
 111 EFIAPI
 112 USBMouseAbsolutePointerDriverBindingEntryPoint (
 113   IN EFI_HANDLE           ImageHandle,
 114   IN EFI_SYSTEM_TABLE     *SystemTable
 115   );
 116
 117 EFI_STATUS
 118 EFIAPI
 119 USBMouseAbsolutePointerDriverBindingSupported (
 120   IN EFI_DRIVER_BINDING_PROTOCOL    *This,
 121   IN EFI_HANDLE                     Controller,
 122   IN EFI_DEVICE_PATH_PROTOCOL       *RemainingDevicePath
 123   );
 124
 125 EFI_STATUS
 126 EFIAPI
 127 USBMouseAbsolutePointerDriverBindingStart (
 128   IN EFI_DRIVER_BINDING_PROTOCOL    *This,
 129   IN EFI_HANDLE                     Controller,
 130   IN EFI_DEVICE_PATH_PROTOCOL       *RemainingDevicePath
 131   );
 132
 133 EFI_STATUS
 134 EFIAPI
 135 USBMouseAbsolutePointerDriverBindingStop (
 136   IN  EFI_DRIVER_BINDING_PROTOCOL   *This,
 137   IN  EFI_HANDLE                    Controller,
 138   IN  UINTN                         NumberOfChildren,
 139   IN  EFI_HANDLE                    *ChildHandleBuffer
 140   );
 141
 142
 143 #endif