]> git.proxmox.com Git - mirror_edk2.git/blame_incremental - Nt32Pkg/WinNtGopDxe/WinNtGop.h
projects / mirror_edk2.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
Update the description of Loaded Image Protocol Unload function to follow the UEFI2...
[mirror_edk2.git] / Nt32Pkg / WinNtGopDxe / WinNtGop.h
... / ...
CommitLineData
1/** @file\r
2\r
3Copyright (c) 2006, Intel Corporation. All rights reserved.<BR>\r
4This 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
26\r
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
45\r
46//\r
47// WM_SYSKEYDOWN/WM_SYSKEYUP Notification\r
48// lParam\r
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
52// The value is 1 if it is an extended key; otherwise, it is 0.\r
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
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
60\r
61#define MAX_Q 256\r
62\r
63typedef struct {\r
64 UINTN Front;\r
65 UINTN Rear;\r
66 UINTN Count;\r
67 EFI_INPUT_KEY Q[MAX_Q];\r
68} GOP_QUEUE_FIXED;\r
69\r
70#define WIN_NT_GOP_CLASS_NAME L"WinNtGopWindow"\r
71\r
72#define GOP_PRIVATE_DATA_SIGNATURE SIGNATURE_32 ('S', 'g', 'o', 'N')\r
73\r
74#define WIN_NT_GOP_SIMPLE_TEXTIN_EX_NOTIFY_SIGNATURE SIGNATURE_32 ('W', 'g', 'S', 'n')\r
75\r
76typedef struct _WIN_NT_GOP_SIMPLE_TEXTIN_EX_NOTIFY {\r
77 UINTN Signature;\r
78 EFI_HANDLE NotifyHandle;\r
79 EFI_KEY_DATA KeyData;\r
80 EFI_KEY_NOTIFY_FUNCTION KeyNotificationFn;\r
81 LIST_ENTRY NotifyEntry;\r
82} WIN_NT_GOP_SIMPLE_TEXTIN_EX_NOTIFY;\r
83\r
84#define GRAPHICS_OUTPUT_INVALIDE_MODE_NUMBER 0xffff\r
85\r
86typedef struct {\r
87 UINT32 HorizontalResolution;\r
88 UINT32 VerticalResolution;\r
89 UINT32 ColorDepth;\r
90 UINT32 RefreshRate;\r
91} GOP_MODE_DATA;\r
92\r
93typedef struct {\r
94 UINT64 Signature;\r
95\r
96 EFI_HANDLE Handle;\r
97 EFI_GRAPHICS_OUTPUT_PROTOCOL GraphicsOutput;\r
98 EFI_SIMPLE_TEXT_INPUT_PROTOCOL SimpleTextIn;\r
99\r
100 EFI_WIN_NT_THUNK_PROTOCOL *WinNtThunk;\r
101\r
102 EFI_UNICODE_STRING_TABLE *ControllerNameTable;\r
103\r
104 //\r
105 // GOP Private Data for QueryMode ()\r
106 //\r
107 GOP_MODE_DATA *ModeData;\r
108\r
109 //\r
110 // GOP Private Data knowing when to start hardware\r
111 //\r
112 BOOLEAN HardwareNeedsStarting;\r
113\r
114 CHAR16 *WindowName;\r
115 CHAR16 Buffer[160];\r
116\r
117 HANDLE ThreadInited; // Semaphore\r
118 HANDLE ThreadHandle; // Thread\r
119 DWORD ThreadId;\r
120\r
121 HWND WindowHandle;\r
122 WNDCLASSEX WindowsClass;\r
123\r
124 //\r
125 // This screen is used to redraw the scree when windows events happen. It's\r
126 // updated in the main thread and displayed in the windows thread.\r
127 //\r
128 BITMAPV4HEADER *VirtualScreenInfo;\r
129 RGBQUAD *VirtualScreen;\r
130\r
131 EFI_GRAPHICS_OUTPUT_BLT_PIXEL *FillLine;\r
132\r
133 //\r
134 // Keyboard Queue used by Simple Text In. WinProc thread adds, and main\r
135 // thread removes.\r
136 //\r
137 CRITICAL_SECTION QCriticalSection;\r
138 GOP_QUEUE_FIXED Queue;\r
139\r
140 EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL SimpleTextInEx;\r
141 EFI_KEY_STATE KeyState;\r
142 LIST_ENTRY NotifyList;\r
143 BOOLEAN LeftShift;\r
144 BOOLEAN RightShift; \r
145 BOOLEAN LeftAlt;\r
146 BOOLEAN RightAlt;\r
147 BOOLEAN LeftCtrl;\r
148 BOOLEAN RightCtrl;\r
149 BOOLEAN LeftLogo;\r
150 BOOLEAN RightLogo;\r
151 BOOLEAN Menu;\r
152 BOOLEAN SysReq; \r
153 BOOLEAN NumLock;\r
154 BOOLEAN ScrollLock;\r
155 BOOLEAN CapsLock; \r
156} GOP_PRIVATE_DATA;\r
157\r
158#define GOP_PRIVATE_DATA_FROM_THIS(a) \\r
159 CR(a, GOP_PRIVATE_DATA, GraphicsOutput, GOP_PRIVATE_DATA_SIGNATURE)\r
160\r
161#define GOP_PRIVATE_DATA_FROM_TEXT_IN_THIS(a) \\r
162 CR(a, GOP_PRIVATE_DATA, SimpleTextIn, GOP_PRIVATE_DATA_SIGNATURE)\r
163\r
164#define GOP_PRIVATE_DATA_FROM_TEXT_IN_EX_THIS(a) \\r
165 CR(a, GOP_PRIVATE_DATA, SimpleTextInEx, GOP_PRIVATE_DATA_SIGNATURE)\r
166\r
167//\r
168// Global Protocol Variables\r
169//\r
170extern EFI_DRIVER_BINDING_PROTOCOL gWinNtGopDriverBinding;\r
171extern EFI_COMPONENT_NAME_PROTOCOL gWinNtGopComponentName;\r
172extern EFI_COMPONENT_NAME2_PROTOCOL gWinNtGopComponentName2;\r
173\r
174\r
175//\r
176// Gop Hardware abstraction internal worker functions\r
177//\r
178\r
179/**\r
180 TODO: Add function description\r
181\r
182 @param WinNtIo TODO: add argument description\r
183\r
184 @return TODO: add return values\r
185\r
186**/\r
187EFI_STATUS\r
188WinNtGopSupported (\r
189 IN EFI_WIN_NT_IO_PROTOCOL *WinNtIo\r
190 );\r
191\r
192\r
193/**\r
194 TODO: Add function description\r
195\r
196 @param Private TODO: add argument description\r
197\r
198 @return TODO: add return values\r
199\r
200**/\r
201EFI_STATUS\r
202WinNtGopConstructor (\r
203 IN GOP_PRIVATE_DATA *Private\r
204 );\r
205\r
206\r
207/**\r
208 TODO: Add function description\r
209\r
210 @param Private TODO: add argument description\r
211\r
212 @return TODO: add return values\r
213\r
214**/\r
215EFI_STATUS\r
216WinNtGopDestructor (\r
217 IN GOP_PRIVATE_DATA *Private\r
218 );\r
219\r
220//\r
221// UEFI 2.0 driver model prototypes for Win NT GOP\r
222//\r
223\r
224\r
225/**\r
226 TODO: Add function description\r
227\r
228 @param ImageHandle TODO: add argument description\r
229 @param SystemTable TODO: add argument description\r
230\r
231 @return TODO: add return values\r
232\r
233**/\r
234EFI_STATUS\r
235EFIAPI\r
236WinNtGopInitialize (\r
237 IN EFI_HANDLE ImageHandle,\r
238 IN EFI_SYSTEM_TABLE *SystemTable\r
239 );\r
240\r
241\r
242/**\r
243 TODO: Add function description\r
244\r
245 @param This TODO: add argument description\r
246 @param Handle TODO: add argument description\r
247 @param RemainingDevicePath TODO: add argument description\r
248\r
249 @return TODO: add return values\r
250\r
251**/\r
252EFI_STATUS\r
253EFIAPI\r
254WinNtGopDriverBindingSupported (\r
255 IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
256 IN EFI_HANDLE Handle,\r
257 IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
258 );\r
259\r
260\r
261/**\r
262 TODO: Add function description\r
263\r
264 @param This TODO: add argument description\r
265 @param Handle TODO: add argument description\r
266 @param RemainingDevicePath TODO: add argument description\r
267\r
268 @return TODO: add return values\r
269\r
270**/\r
271EFI_STATUS\r
272EFIAPI\r
273WinNtGopDriverBindingStart (\r
274 IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
275 IN EFI_HANDLE Handle,\r
276 IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
277 );\r
278\r
279\r
280/**\r
281 TODO: Add function description\r
282\r
283 @param This TODO: add argument description\r
284 @param Handle TODO: add argument description\r
285 @param NumberOfChildren TODO: add argument description\r
286 @param ChildHandleBuffer TODO: add argument description\r
287\r
288 @return TODO: add return values\r
289\r
290**/\r
291EFI_STATUS\r
292EFIAPI\r
293WinNtGopDriverBindingStop (\r
294 IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
295 IN EFI_HANDLE Handle,\r
296 IN UINTN NumberOfChildren,\r
297 IN EFI_HANDLE *ChildHandleBuffer\r
298 );\r
299\r
300\r
301/**\r
302 TODO: Add function description\r
303\r
304 @param Private TODO: add argument description\r
305 @param Key TODO: add argument description\r
306\r
307 @return TODO: add return values\r
308\r
309**/\r
310EFI_STATUS\r
311GopPrivateAddQ (\r
312 IN GOP_PRIVATE_DATA *Private,\r
313 IN EFI_INPUT_KEY Key\r
314 );\r
315\r
316\r
317/**\r
318 TODO: Add function description\r
319\r
320 @param Private TODO: add argument description\r
321\r
322 @return TODO: add return values\r
323\r
324**/\r
325EFI_STATUS\r
326WinNtGopInitializeSimpleTextInForWindow (\r
327 IN GOP_PRIVATE_DATA *Private\r
328 );\r
329\r
330\r
331/**\r
332 TODO: Add function description\r
333\r
334 @param Private TODO: add argument description\r
335\r
336 @return TODO: add return values\r
337\r
338**/\r
339EFI_STATUS\r
340WinNtGopDestroySimpleTextInForWindow (\r
341 IN GOP_PRIVATE_DATA *Private\r
342 );\r
343\r
344\r
345\r
346#endif\r
EFI Development Kit II mirror for PVE