]> git.proxmox.com Git - mirror_edk2.git/blame - Nt32Pkg/WinNtGopDxe/WinNtGop.h
Fix some typo and coding style issues in BaseCryptLib instances.
[mirror_edk2.git] / Nt32Pkg / WinNtGopDxe / WinNtGop.h
CommitLineData
c9fc89a3 1/** @file\r
2\r
66fe7146 3Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r
8f2a5f80 4This program and the accompanying materials\r
c9fc89a3 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
12Module Name:\r
13\r
14 WinNtGop.h\r
15\r
16Abstract:\r
17\r
18 Private data for the Gop driver that is bound to the WinNt Thunk protocol\r
19\r
20\r
21**/\r
22\r
23#ifndef _WIN_NT_GOP_H_\r
24#define _WIN_NT_GOP_H_\r
25\r
c9fc89a3 26\r
62cf113f 27#include <Uefi.h>\r
28#include <WinNtDxe.h>\r
29\r
30#include <Guid/EventGroup.h>\r
31#include <Protocol/WinNtIo.h>\r
32#include <Protocol/ComponentName.h>\r
33#include <Protocol/SimpleTextIn.h>\r
34#include <Protocol/SimpleTextInEx.h>\r
35#include <Protocol/DriverBinding.h>\r
36#include <Protocol/GraphicsOutput.h>\r
37\r
38#include <Library/DebugLib.h>\r
39#include <Library/BaseLib.h>\r
40#include <Library/UefiDriverEntryPoint.h>\r
41#include <Library/UefiLib.h>\r
42#include <Library/BaseMemoryLib.h>\r
43#include <Library/UefiBootServicesTableLib.h>\r
44#include <Library/MemoryAllocationLib.h>\r
c9fc89a3 45\r
46//\r
62cf113f 47// WM_SYSKEYDOWN/WM_SYSKEYUP Notification\r
48// lParam\r
df7499fc 49// bit 24: Specifies whether the key is an extended key,\r
50// such as the right-hand ALT and CTRL keys that appear on\r
51// an enhanced 101- or 102-key keyboard.\r
62cf113f 52// The value is 1 if it is an extended key; otherwise, it is 0.\r
df7499fc 53// bit 29:Specifies the context code.\r
54// The value is 1 if the ALT key is down while the key is pressed/released;\r
55// it is 0 if the WM_SYSKEYDOWN message is posted to the active window\r
62cf113f 56// because no window has the keyboard focus.\r
57#define GOP_EXTENDED_KEY (0x1 << 24)\r
58#define GOP_ALT_KEY_PRESSED (0x1 << 29)\r
59\r
66fe7146 60#define KEYBOARD_TIMER_INTERVAL 200000 // 0.02s\r
c9fc89a3 61\r
62#define MAX_Q 256\r
63\r
64typedef struct {\r
66fe7146
RN
65 UINTN Front;\r
66 UINTN Rear;\r
67 EFI_KEY_DATA Q[MAX_Q];\r
68 CRITICAL_SECTION Cs;\r
c9fc89a3 69} GOP_QUEUE_FIXED;\r
70\r
71#define WIN_NT_GOP_CLASS_NAME L"WinNtGopWindow"\r
72\r
99e1dd89 73#define GOP_PRIVATE_DATA_SIGNATURE SIGNATURE_32 ('S', 'g', 'o', 'N')\r
c9fc89a3 74\r
99e1dd89 75#define WIN_NT_GOP_SIMPLE_TEXTIN_EX_NOTIFY_SIGNATURE SIGNATURE_32 ('W', 'g', 'S', 'n')\r
62cf113f 76\r
77typedef struct _WIN_NT_GOP_SIMPLE_TEXTIN_EX_NOTIFY {\r
78 UINTN Signature;\r
79 EFI_HANDLE NotifyHandle;\r
80 EFI_KEY_DATA KeyData;\r
81 EFI_KEY_NOTIFY_FUNCTION KeyNotificationFn;\r
82 LIST_ENTRY NotifyEntry;\r
83} WIN_NT_GOP_SIMPLE_TEXTIN_EX_NOTIFY;\r
84\r
c9fc89a3 85#define GRAPHICS_OUTPUT_INVALIDE_MODE_NUMBER 0xffff\r
86\r
87typedef struct {\r
88 UINT32 HorizontalResolution;\r
89 UINT32 VerticalResolution;\r
90 UINT32 ColorDepth;\r
91 UINT32 RefreshRate;\r
92} GOP_MODE_DATA;\r
93\r
94typedef struct {\r
95 UINT64 Signature;\r
96\r
97 EFI_HANDLE Handle;\r
98 EFI_GRAPHICS_OUTPUT_PROTOCOL GraphicsOutput;\r
99 EFI_SIMPLE_TEXT_INPUT_PROTOCOL SimpleTextIn;\r
100\r
101 EFI_WIN_NT_THUNK_PROTOCOL *WinNtThunk;\r
102\r
103 EFI_UNICODE_STRING_TABLE *ControllerNameTable;\r
104\r
105 //\r
106 // GOP Private Data for QueryMode ()\r
107 //\r
108 GOP_MODE_DATA *ModeData;\r
109\r
110 //\r
111 // GOP Private Data knowing when to start hardware\r
112 //\r
113 BOOLEAN HardwareNeedsStarting;\r
114\r
115 CHAR16 *WindowName;\r
116 CHAR16 Buffer[160];\r
117\r
118 HANDLE ThreadInited; // Semaphore\r
119 HANDLE ThreadHandle; // Thread\r
120 DWORD ThreadId;\r
121\r
122 HWND WindowHandle;\r
123 WNDCLASSEX WindowsClass;\r
124\r
125 //\r
126 // This screen is used to redraw the scree when windows events happen. It's\r
127 // updated in the main thread and displayed in the windows thread.\r
128 //\r
129 BITMAPV4HEADER *VirtualScreenInfo;\r
130 RGBQUAD *VirtualScreen;\r
131\r
132 EFI_GRAPHICS_OUTPUT_BLT_PIXEL *FillLine;\r
133\r
134 //\r
df7499fc 135 // Keyboard Queue used by Simple Text In.\r
66fe7146
RN
136 // QueueForRead: WinProc thread adds, and main thread removes.\r
137 // QueueForNotify: WinProc thread adds, and timer thread removes.\r
c9fc89a3 138 //\r
66fe7146
RN
139 GOP_QUEUE_FIXED QueueForRead;\r
140 GOP_QUEUE_FIXED QueueForNotify;\r
c9fc89a3 141\r
62cf113f 142 EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL SimpleTextInEx;\r
143 EFI_KEY_STATE KeyState;\r
144 LIST_ENTRY NotifyList;\r
145 BOOLEAN LeftShift;\r
df7499fc 146 BOOLEAN RightShift;\r
62cf113f 147 BOOLEAN LeftAlt;\r
148 BOOLEAN RightAlt;\r
149 BOOLEAN LeftCtrl;\r
150 BOOLEAN RightCtrl;\r
151 BOOLEAN LeftLogo;\r
152 BOOLEAN RightLogo;\r
153 BOOLEAN Menu;\r
df7499fc 154 BOOLEAN SysReq;\r
62cf113f 155 BOOLEAN NumLock;\r
156 BOOLEAN ScrollLock;\r
66fe7146 157 BOOLEAN CapsLock;\r
df7499fc 158 BOOLEAN IsPartialKeySupport;\r
66fe7146 159 EFI_EVENT TimerEvent;\r
c9fc89a3 160} GOP_PRIVATE_DATA;\r
161\r
162#define GOP_PRIVATE_DATA_FROM_THIS(a) \\r
163 CR(a, GOP_PRIVATE_DATA, GraphicsOutput, GOP_PRIVATE_DATA_SIGNATURE)\r
164\r
165#define GOP_PRIVATE_DATA_FROM_TEXT_IN_THIS(a) \\r
166 CR(a, GOP_PRIVATE_DATA, SimpleTextIn, GOP_PRIVATE_DATA_SIGNATURE)\r
167\r
62cf113f 168#define GOP_PRIVATE_DATA_FROM_TEXT_IN_EX_THIS(a) \\r
169 CR(a, GOP_PRIVATE_DATA, SimpleTextInEx, GOP_PRIVATE_DATA_SIGNATURE)\r
170\r
c9fc89a3 171//\r
172// Global Protocol Variables\r
173//\r
e6e53c97 174extern EFI_DRIVER_BINDING_PROTOCOL gWinNtGopDriverBinding;\r
175extern EFI_COMPONENT_NAME_PROTOCOL gWinNtGopComponentName;\r
176extern EFI_COMPONENT_NAME2_PROTOCOL gWinNtGopComponentName2;\r
c9fc89a3 177\r
62cf113f 178\r
c9fc89a3 179//\r
180// Gop Hardware abstraction internal worker functions\r
181//\r
182\r
183/**\r
184 TODO: Add function description\r
185\r
186 @param WinNtIo TODO: add argument description\r
187\r
188 @return TODO: add return values\r
189\r
190**/\r
191EFI_STATUS\r
192WinNtGopSupported (\r
193 IN EFI_WIN_NT_IO_PROTOCOL *WinNtIo\r
ed66e1bc 194 );\r
c9fc89a3 195\r
196\r
197/**\r
198 TODO: Add function description\r
199\r
200 @param Private TODO: add argument description\r
201\r
202 @return TODO: add return values\r
203\r
204**/\r
205EFI_STATUS\r
206WinNtGopConstructor (\r
207 IN GOP_PRIVATE_DATA *Private\r
ed66e1bc 208 );\r
c9fc89a3 209\r
210\r
211/**\r
212 TODO: Add function description\r
213\r
214 @param Private TODO: add argument description\r
215\r
216 @return TODO: add return values\r
217\r
218**/\r
219EFI_STATUS\r
220WinNtGopDestructor (\r
221 IN GOP_PRIVATE_DATA *Private\r
ed66e1bc 222 );\r
c9fc89a3 223\r
224//\r
8a7d75b0 225// UEFI 2.0 driver model prototypes for Win NT GOP\r
c9fc89a3 226//\r
227\r
228\r
229/**\r
230 TODO: Add function description\r
231\r
232 @param ImageHandle TODO: add argument description\r
233 @param SystemTable TODO: add argument description\r
234\r
235 @return TODO: add return values\r
236\r
237**/\r
238EFI_STATUS\r
239EFIAPI\r
240WinNtGopInitialize (\r
241 IN EFI_HANDLE ImageHandle,\r
242 IN EFI_SYSTEM_TABLE *SystemTable\r
ed66e1bc 243 );\r
c9fc89a3 244\r
245\r
246/**\r
247 TODO: Add function description\r
248\r
249 @param This TODO: add argument description\r
250 @param Handle TODO: add argument description\r
251 @param RemainingDevicePath TODO: add argument description\r
252\r
253 @return TODO: add return values\r
254\r
255**/\r
256EFI_STATUS\r
257EFIAPI\r
258WinNtGopDriverBindingSupported (\r
259 IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
260 IN EFI_HANDLE Handle,\r
261 IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
ed66e1bc 262 );\r
c9fc89a3 263\r
264\r
265/**\r
266 TODO: Add function description\r
267\r
268 @param This TODO: add argument description\r
269 @param Handle TODO: add argument description\r
270 @param RemainingDevicePath TODO: add argument description\r
271\r
272 @return TODO: add return values\r
273\r
274**/\r
275EFI_STATUS\r
276EFIAPI\r
277WinNtGopDriverBindingStart (\r
278 IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
279 IN EFI_HANDLE Handle,\r
280 IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
ed66e1bc 281 );\r
c9fc89a3 282\r
283\r
284/**\r
285 TODO: Add function description\r
286\r
287 @param This TODO: add argument description\r
288 @param Handle TODO: add argument description\r
289 @param NumberOfChildren TODO: add argument description\r
290 @param ChildHandleBuffer TODO: add argument description\r
291\r
292 @return TODO: add return values\r
293\r
294**/\r
295EFI_STATUS\r
296EFIAPI\r
297WinNtGopDriverBindingStop (\r
298 IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
299 IN EFI_HANDLE Handle,\r
300 IN UINTN NumberOfChildren,\r
301 IN EFI_HANDLE *ChildHandleBuffer\r
ed66e1bc 302 );\r
c9fc89a3 303\r
304\r
305/**\r
306 TODO: Add function description\r
307\r
308 @param Private TODO: add argument description\r
309 @param Key TODO: add argument description\r
310\r
311 @return TODO: add return values\r
312\r
313**/\r
314EFI_STATUS\r
66fe7146 315GopPrivateAddKey (\r
c9fc89a3 316 IN GOP_PRIVATE_DATA *Private,\r
317 IN EFI_INPUT_KEY Key\r
ed66e1bc 318 );\r
c9fc89a3 319\r
320\r
321/**\r
322 TODO: Add function description\r
323\r
324 @param Private TODO: add argument description\r
325\r
326 @return TODO: add return values\r
327\r
328**/\r
329EFI_STATUS\r
330WinNtGopInitializeSimpleTextInForWindow (\r
331 IN GOP_PRIVATE_DATA *Private\r
ed66e1bc 332 );\r
c9fc89a3 333\r
334\r
335/**\r
336 TODO: Add function description\r
337\r
338 @param Private TODO: add argument description\r
339\r
340 @return TODO: add return values\r
341\r
342**/\r
343EFI_STATUS\r
344WinNtGopDestroySimpleTextInForWindow (\r
345 IN GOP_PRIVATE_DATA *Private\r
ed66e1bc 346 );\r
c9fc89a3 347\r
348\r
c9fc89a3 349\r
350#endif\r