EdkModulePkg/Bus/Usb/UsbMouse/Dxe/usbmouse.h

   1 /*++
   2
   3 Copyright (c) 2006, 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     UsbMouse.h
  15
  16   Abstract:
  17
  18 --*/
  19
  20 #ifndef _USB_MOUSE_H
  21 #define _USB_MOUSE_H
  22
  23 #include <IndustryStandard/Usb.h>
  24
  25 #define CLASS_HID               3
  26 #define SUBCLASS_BOOT           1
  27 #define PROTOCOL_MOUSE          2
  28
  29 #define BOOT_PROTOCOL           0
  30 #define REPORT_PROTOCOL         1
  31
  32 #define USB_MOUSE_DEV_SIGNATURE EFI_SIGNATURE_32 ('u', 'm', 'o', 'u')
  33
  34 typedef struct {
  35   BOOLEAN ButtonDetected;
  36   UINT8   ButtonMinIndex;
  37   UINT8   ButtonMaxIndex;
  38   UINT8   Reserved;
  39 } PRIVATE_DATA;
  40
  41 typedef struct {
  42   UINTN                         Signature;
  43   EFI_DEVICE_PATH_PROTOCOL      *DevicePath;
  44   EFI_EVENT                     DelayedRecoveryEvent;
  45   EFI_USB_IO_PROTOCOL           *UsbIo;
  46   EFI_USB_INTERFACE_DESCRIPTOR  *InterfaceDescriptor;
  47   EFI_USB_ENDPOINT_DESCRIPTOR   *IntEndpointDescriptor;
  48   UINT8                         NumberOfButtons;
  49   INT32                         XLogicMax;
  50   INT32                         XLogicMin;
  51   INT32                         YLogicMax;
  52   INT32                         YLogicMin;
  53   EFI_SIMPLE_POINTER_PROTOCOL   SimplePointerProtocol;
  54   EFI_SIMPLE_POINTER_STATE      State;
  55   EFI_SIMPLE_POINTER_MODE       Mode;
  56   BOOLEAN                       StateChanged;
  57   PRIVATE_DATA                  PrivateData;
  58   EFI_UNICODE_STRING_TABLE      *ControllerNameTable;
  59 } USB_MOUSE_DEV;
  60
  61 #define USB_MOUSE_DEV_FROM_MOUSE_PROTOCOL(a) \
  62     CR(a, USB_MOUSE_DEV, SimplePointerProtocol, USB_MOUSE_DEV_SIGNATURE)
  63
  64 VOID
  65 EFIAPI
  66 USBMouseRecoveryHandler (
  67   IN    EFI_EVENT    Event,
  68   IN    VOID         *Context
  69   );
  70
  71 //
  72 // Global Variables
  73 //
  74 extern EFI_DRIVER_BINDING_PROTOCOL  gUsbMouseDriverBinding;
  75 extern EFI_COMPONENT_NAME_PROTOCOL  gUsbMouseComponentName;
  76 extern EFI_GUID                     gEfiUsbMouseDriverGuid;
  77
  78 VOID
  79 MouseReportStatusCode (
  80   IN EFI_DEVICE_PATH_PROTOCOL  *DevicePath,
  81   IN EFI_STATUS_CODE_TYPE      CodeType,
  82   IN EFI_STATUS_CODE_VALUE     Value
  83   );
  84
  85 //
  86 // Prototypes
  87 // Driver model protocol interface
  88 //
  89 EFI_STATUS
  90 EFIAPI
  91 USBMouseDriverBindingSupported (
  92   IN EFI_DRIVER_BINDING_PROTOCOL    *This,
  93   IN EFI_HANDLE                     Controller,
  94   IN EFI_DEVICE_PATH_PROTOCOL       *RemainingDevicePath
  95   );
  96
  97 EFI_STATUS
  98 EFIAPI
  99 USBMouseDriverBindingStart (
 100   IN EFI_DRIVER_BINDING_PROTOCOL    *This,
 101   IN EFI_HANDLE                     Controller,
 102   IN EFI_DEVICE_PATH_PROTOCOL       *RemainingDevicePath
 103   );
 104
 105 EFI_STATUS
 106 EFIAPI
 107 USBMouseDriverBindingStop (
 108   IN  EFI_DRIVER_BINDING_PROTOCOL   *This,
 109   IN  EFI_HANDLE                    Controller,
 110   IN  UINTN                         NumberOfChildren,
 111   IN  EFI_HANDLE                    *ChildHandleBuffer
 112   );
 113
 114 //
 115 // EFI Component Name Functions
 116 //
 117 EFI_STATUS
 118 EFIAPI
 119 UsbMouseComponentNameGetDriverName (
 120   IN  EFI_COMPONENT_NAME_PROTOCOL  *This,
 121   IN  CHAR8                        *Language,
 122   OUT CHAR16                       **DriverName
 123   );
 124
 125 EFI_STATUS
 126 EFIAPI
 127 UsbMouseComponentNameGetControllerName (
 128   IN  EFI_COMPONENT_NAME_PROTOCOL                     *This,
 129   IN  EFI_HANDLE                                      ControllerHandle,
 130   IN  EFI_HANDLE                                      ChildHandle        OPTIONAL,
 131   IN  CHAR8                                           *Language,
 132   OUT CHAR16                                          **ControllerName
 133   );
 134
 135 #endif