]> git.proxmox.com Git - mirror_edk2.git/blame - Nt32Pkg/WinNtGopDxe/WinNtGop.h
Update to fix several ECC warning
[mirror_edk2.git] / Nt32Pkg / WinNtGopDxe / WinNtGop.h
CommitLineData
c9fc89a3 1/** @file\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
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
67252d9f 37#include <Protocol/SimpleTextInExNotify.h>\r
62cf113f 38\r
39#include <Library/DebugLib.h>\r
40#include <Library/BaseLib.h>\r
41#include <Library/UefiDriverEntryPoint.h>\r
42#include <Library/UefiLib.h>\r
43#include <Library/BaseMemoryLib.h>\r
44#include <Library/UefiBootServicesTableLib.h>\r
45#include <Library/MemoryAllocationLib.h>\r
c9fc89a3 46\r
47//\r
62cf113f 48// WM_SYSKEYDOWN/WM_SYSKEYUP Notification\r
49// lParam\r
50// bit 24: Specifies whether the key is an extended key, \r
51// such as the right-hand ALT and CTRL keys that appear on \r
52// an enhanced 101- or 102-key keyboard. \r
53// The value is 1 if it is an extended key; otherwise, it is 0.\r
54// bit 29:Specifies the context code. \r
55// The value is 1 if the ALT key is down while the key is pressed/released; \r
56// it is 0 if the WM_SYSKEYDOWN message is posted to the active window \r
57// because no window has the keyboard focus.\r
58#define GOP_EXTENDED_KEY (0x1 << 24)\r
59#define GOP_ALT_KEY_PRESSED (0x1 << 29)\r
60\r
c9fc89a3 61\r
62#define MAX_Q 256\r
63\r
64typedef struct {\r
65 UINTN Front;\r
66 UINTN Rear;\r
67 UINTN Count;\r
68 EFI_INPUT_KEY Q[MAX_Q];\r
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
135 // Keyboard Queue used by Simple Text In. WinProc thread adds, and main\r
136 // thread removes.\r
137 //\r
138 CRITICAL_SECTION QCriticalSection;\r
139 GOP_QUEUE_FIXED Queue;\r
140\r
62cf113f 141 EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL SimpleTextInEx;\r
142 EFI_KEY_STATE KeyState;\r
143 LIST_ENTRY NotifyList;\r
144 BOOLEAN LeftShift;\r
145 BOOLEAN RightShift; \r
146 BOOLEAN LeftAlt;\r
147 BOOLEAN RightAlt;\r
148 BOOLEAN LeftCtrl;\r
149 BOOLEAN RightCtrl;\r
150 BOOLEAN LeftLogo;\r
151 BOOLEAN RightLogo;\r
152 BOOLEAN Menu;\r
153 BOOLEAN SysReq; \r
154 BOOLEAN NumLock;\r
155 BOOLEAN ScrollLock;\r
156 BOOLEAN CapsLock; \r
c9fc89a3 157} GOP_PRIVATE_DATA;\r
158\r
159#define GOP_PRIVATE_DATA_FROM_THIS(a) \\r
160 CR(a, GOP_PRIVATE_DATA, GraphicsOutput, GOP_PRIVATE_DATA_SIGNATURE)\r
161\r
162#define GOP_PRIVATE_DATA_FROM_TEXT_IN_THIS(a) \\r
163 CR(a, GOP_PRIVATE_DATA, SimpleTextIn, GOP_PRIVATE_DATA_SIGNATURE)\r
164\r
62cf113f 165#define GOP_PRIVATE_DATA_FROM_TEXT_IN_EX_THIS(a) \\r
166 CR(a, GOP_PRIVATE_DATA, SimpleTextInEx, GOP_PRIVATE_DATA_SIGNATURE)\r
167\r
c9fc89a3 168//\r
169// Global Protocol Variables\r
170//\r
e6e53c97 171extern EFI_DRIVER_BINDING_PROTOCOL gWinNtGopDriverBinding;\r
172extern EFI_COMPONENT_NAME_PROTOCOL gWinNtGopComponentName;\r
173extern EFI_COMPONENT_NAME2_PROTOCOL gWinNtGopComponentName2;\r
c9fc89a3 174\r
62cf113f 175\r
c9fc89a3 176//\r
177// Gop Hardware abstraction internal worker functions\r
178//\r
179\r
180/**\r
181 TODO: Add function description\r
182\r
183 @param WinNtIo TODO: add argument description\r
184\r
185 @return TODO: add return values\r
186\r
187**/\r
188EFI_STATUS\r
189WinNtGopSupported (\r
190 IN EFI_WIN_NT_IO_PROTOCOL *WinNtIo\r
ed66e1bc 191 );\r
c9fc89a3 192\r
193\r
194/**\r
195 TODO: Add function description\r
196\r
197 @param Private TODO: add argument description\r
198\r
199 @return TODO: add return values\r
200\r
201**/\r
202EFI_STATUS\r
203WinNtGopConstructor (\r
204 IN GOP_PRIVATE_DATA *Private\r
ed66e1bc 205 );\r
c9fc89a3 206\r
207\r
208/**\r
209 TODO: Add function description\r
210\r
211 @param Private TODO: add argument description\r
212\r
213 @return TODO: add return values\r
214\r
215**/\r
216EFI_STATUS\r
217WinNtGopDestructor (\r
218 IN GOP_PRIVATE_DATA *Private\r
ed66e1bc 219 );\r
c9fc89a3 220\r
221//\r
8a7d75b0 222// UEFI 2.0 driver model prototypes for Win NT GOP\r
c9fc89a3 223//\r
224\r
225\r
226/**\r
227 TODO: Add function description\r
228\r
229 @param ImageHandle TODO: add argument description\r
230 @param SystemTable TODO: add argument description\r
231\r
232 @return TODO: add return values\r
233\r
234**/\r
235EFI_STATUS\r
236EFIAPI\r
237WinNtGopInitialize (\r
238 IN EFI_HANDLE ImageHandle,\r
239 IN EFI_SYSTEM_TABLE *SystemTable\r
ed66e1bc 240 );\r
c9fc89a3 241\r
242\r
243/**\r
244 TODO: Add function description\r
245\r
246 @param This TODO: add argument description\r
247 @param Handle TODO: add argument description\r
248 @param RemainingDevicePath TODO: add argument description\r
249\r
250 @return TODO: add return values\r
251\r
252**/\r
253EFI_STATUS\r
254EFIAPI\r
255WinNtGopDriverBindingSupported (\r
256 IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
257 IN EFI_HANDLE Handle,\r
258 IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
ed66e1bc 259 );\r
c9fc89a3 260\r
261\r
262/**\r
263 TODO: Add function description\r
264\r
265 @param This TODO: add argument description\r
266 @param Handle TODO: add argument description\r
267 @param RemainingDevicePath TODO: add argument description\r
268\r
269 @return TODO: add return values\r
270\r
271**/\r
272EFI_STATUS\r
273EFIAPI\r
274WinNtGopDriverBindingStart (\r
275 IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
276 IN EFI_HANDLE Handle,\r
277 IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
ed66e1bc 278 );\r
c9fc89a3 279\r
280\r
281/**\r
282 TODO: Add function description\r
283\r
284 @param This TODO: add argument description\r
285 @param Handle TODO: add argument description\r
286 @param NumberOfChildren TODO: add argument description\r
287 @param ChildHandleBuffer TODO: add argument description\r
288\r
289 @return TODO: add return values\r
290\r
291**/\r
292EFI_STATUS\r
293EFIAPI\r
294WinNtGopDriverBindingStop (\r
295 IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
296 IN EFI_HANDLE Handle,\r
297 IN UINTN NumberOfChildren,\r
298 IN EFI_HANDLE *ChildHandleBuffer\r
ed66e1bc 299 );\r
c9fc89a3 300\r
301\r
302/**\r
303 TODO: Add function description\r
304\r
305 @param Private TODO: add argument description\r
306 @param Key TODO: add argument description\r
307\r
308 @return TODO: add return values\r
309\r
310**/\r
311EFI_STATUS\r
312GopPrivateAddQ (\r
313 IN GOP_PRIVATE_DATA *Private,\r
314 IN EFI_INPUT_KEY Key\r
ed66e1bc 315 );\r
c9fc89a3 316\r
317\r
318/**\r
319 TODO: Add function description\r
320\r
321 @param Private TODO: add argument description\r
322\r
323 @return TODO: add return values\r
324\r
325**/\r
326EFI_STATUS\r
327WinNtGopInitializeSimpleTextInForWindow (\r
328 IN GOP_PRIVATE_DATA *Private\r
ed66e1bc 329 );\r
c9fc89a3 330\r
331\r
332/**\r
333 TODO: Add function description\r
334\r
335 @param Private TODO: add argument description\r
336\r
337 @return TODO: add return values\r
338\r
339**/\r
340EFI_STATUS\r
341WinNtGopDestroySimpleTextInForWindow (\r
342 IN GOP_PRIVATE_DATA *Private\r
ed66e1bc 343 );\r
c9fc89a3 344\r
345\r
c9fc89a3 346\r
347#endif\r