]> git.proxmox.com Git - mirror_edk2.git/blame - EdkModulePkg/Bus/Usb/UsbMouse/Dxe/usbmouse.h
Clean up MSA file of the checked in modules which include:
[mirror_edk2.git] / EdkModulePkg / Bus / Usb / UsbMouse / Dxe / usbmouse.h
CommitLineData
878ddf1f 1/*++\r
2\r
3Copyright (c) 2006, Intel Corporation \r
4All rights reserved. This program and the accompanying materials \r
5are licensed and made available under the terms and conditions of the BSD License \r
6which accompanies this distribution. The full text of the license may be found at \r
7http://opensource.org/licenses/bsd-license.php \r
8 \r
9THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
10WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
11\r
12 Module Name:\r
13\r
14 UsbMouse.h\r
15\r
16 Abstract:\r
17\r
18--*/\r
19\r
20#ifndef _USB_MOUSE_H\r
21#define _USB_MOUSE_H\r
22\r
f0ec738d 23#include <IndustryStandard/Usb.h>\r
878ddf1f 24\r
25#define CLASS_HID 3\r
26#define SUBCLASS_BOOT 1\r
27#define PROTOCOL_MOUSE 2\r
28\r
29#define BOOT_PROTOCOL 0\r
30#define REPORT_PROTOCOL 1\r
31\r
32#define USB_MOUSE_DEV_SIGNATURE EFI_SIGNATURE_32 ('u', 'm', 'o', 'u')\r
33\r
34typedef struct {\r
35 BOOLEAN ButtonDetected;\r
36 UINT8 ButtonMinIndex;\r
37 UINT8 ButtonMaxIndex;\r
38 UINT8 Reserved;\r
39} PRIVATE_DATA;\r
40\r
41typedef struct {\r
42 UINTN Signature;\r
43 EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
44 EFI_EVENT DelayedRecoveryEvent;\r
45 EFI_USB_IO_PROTOCOL *UsbIo;\r
46 EFI_USB_INTERFACE_DESCRIPTOR *InterfaceDescriptor;\r
47 EFI_USB_ENDPOINT_DESCRIPTOR *IntEndpointDescriptor;\r
48 UINT8 NumberOfButtons;\r
49 INT32 XLogicMax;\r
50 INT32 XLogicMin;\r
51 INT32 YLogicMax;\r
52 INT32 YLogicMin;\r
53 EFI_SIMPLE_POINTER_PROTOCOL SimplePointerProtocol;\r
54 EFI_SIMPLE_POINTER_STATE State;\r
55 EFI_SIMPLE_POINTER_MODE Mode;\r
56 BOOLEAN StateChanged;\r
57 PRIVATE_DATA PrivateData;\r
58 EFI_UNICODE_STRING_TABLE *ControllerNameTable;\r
59} USB_MOUSE_DEV;\r
60\r
61#define USB_MOUSE_DEV_FROM_MOUSE_PROTOCOL(a) \\r
62 CR(a, USB_MOUSE_DEV, SimplePointerProtocol, USB_MOUSE_DEV_SIGNATURE)\r
63\r
64VOID\r
65EFIAPI\r
66USBMouseRecoveryHandler (\r
67 IN EFI_EVENT Event,\r
68 IN VOID *Context\r
69 );\r
70\r
71//\r
72// Global Variables\r
73//\r
74extern EFI_DRIVER_BINDING_PROTOCOL gUsbMouseDriverBinding;\r
75extern EFI_COMPONENT_NAME_PROTOCOL gUsbMouseComponentName;\r
878ddf1f 76\r
77VOID\r
78MouseReportStatusCode (\r
79 IN EFI_DEVICE_PATH_PROTOCOL *DevicePath,\r
80 IN EFI_STATUS_CODE_TYPE CodeType,\r
81 IN EFI_STATUS_CODE_VALUE Value\r
82 );\r
83\r
92dda53e 84//\r
85// Prototypes\r
86// Driver model protocol interface\r
87//\r
88EFI_STATUS\r
89EFIAPI\r
90USBMouseDriverBindingSupported (\r
91 IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
92 IN EFI_HANDLE Controller,\r
93 IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
94 );\r
95\r
96EFI_STATUS\r
97EFIAPI\r
98USBMouseDriverBindingStart (\r
99 IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
100 IN EFI_HANDLE Controller,\r
101 IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
102 );\r
103\r
104EFI_STATUS\r
105EFIAPI\r
106USBMouseDriverBindingStop (\r
107 IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
108 IN EFI_HANDLE Controller,\r
109 IN UINTN NumberOfChildren,\r
110 IN EFI_HANDLE *ChildHandleBuffer\r
111 );\r
112\r
113//\r
114// EFI Component Name Functions\r
115//\r
116EFI_STATUS\r
117EFIAPI\r
118UsbMouseComponentNameGetDriverName (\r
119 IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
120 IN CHAR8 *Language,\r
121 OUT CHAR16 **DriverName\r
122 );\r
123\r
124EFI_STATUS\r
125EFIAPI\r
126UsbMouseComponentNameGetControllerName (\r
127 IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
128 IN EFI_HANDLE ControllerHandle,\r
129 IN EFI_HANDLE ChildHandle OPTIONAL,\r
130 IN CHAR8 *Language,\r
131 OUT CHAR16 **ControllerName\r
132 );\r
133\r
878ddf1f 134#endif\r