3 Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.<BR>
4 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
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.
18 Private data for the Gop driver that is bound to the WinNt Thunk protocol
23 #ifndef _WIN_NT_GOP_H_
24 #define _WIN_NT_GOP_H_
30 #include <Guid/EventGroup.h>
31 #include <Protocol/WinNtIo.h>
32 #include <Protocol/ComponentName.h>
33 #include <Protocol/SimpleTextIn.h>
34 #include <Protocol/SimpleTextInEx.h>
35 #include <Protocol/DriverBinding.h>
36 #include <Protocol/GraphicsOutput.h>
38 #include <Library/DebugLib.h>
39 #include <Library/BaseLib.h>
40 #include <Library/UefiDriverEntryPoint.h>
41 #include <Library/UefiLib.h>
42 #include <Library/BaseMemoryLib.h>
43 #include <Library/UefiBootServicesTableLib.h>
44 #include <Library/MemoryAllocationLib.h>
47 // WM_SYSKEYDOWN/WM_SYSKEYUP Notification
49 // bit 24: Specifies whether the key is an extended key,
50 // such as the right-hand ALT and CTRL keys that appear on
51 // an enhanced 101- or 102-key keyboard.
52 // The value is 1 if it is an extended key; otherwise, it is 0.
53 // bit 29:Specifies the context code.
54 // The value is 1 if the ALT key is down while the key is pressed/released;
55 // it is 0 if the WM_SYSKEYDOWN message is posted to the active window
56 // because no window has the keyboard focus.
57 #define GOP_EXTENDED_KEY (0x1 << 24)
58 #define GOP_ALT_KEY_PRESSED (0x1 << 29)
60 #define KEYBOARD_TIMER_INTERVAL 200000 // 0.02s
67 EFI_KEY_DATA Q
[MAX_Q
];
71 #define WIN_NT_GOP_CLASS_NAME L"WinNtGopWindow"
73 #define GOP_PRIVATE_DATA_SIGNATURE SIGNATURE_32 ('S', 'g', 'o', 'N')
75 #define WIN_NT_GOP_SIMPLE_TEXTIN_EX_NOTIFY_SIGNATURE SIGNATURE_32 ('W', 'g', 'S', 'n')
77 typedef struct _WIN_NT_GOP_SIMPLE_TEXTIN_EX_NOTIFY
{
80 EFI_KEY_NOTIFY_FUNCTION KeyNotificationFn
;
81 LIST_ENTRY NotifyEntry
;
82 } WIN_NT_GOP_SIMPLE_TEXTIN_EX_NOTIFY
;
84 #define GRAPHICS_OUTPUT_INVALIDE_MODE_NUMBER 0xffff
87 UINT32 HorizontalResolution
;
88 UINT32 VerticalResolution
;
97 EFI_GRAPHICS_OUTPUT_PROTOCOL GraphicsOutput
;
98 EFI_SIMPLE_TEXT_INPUT_PROTOCOL SimpleTextIn
;
100 EFI_WIN_NT_THUNK_PROTOCOL
*WinNtThunk
;
102 EFI_UNICODE_STRING_TABLE
*ControllerNameTable
;
105 // GOP Private Data for QueryMode ()
107 GOP_MODE_DATA
*ModeData
;
110 // GOP Private Data knowing when to start hardware
112 BOOLEAN HardwareNeedsStarting
;
117 HANDLE ThreadInited
; // Semaphore
118 HANDLE ThreadHandle
; // Thread
122 WNDCLASSEX WindowsClass
;
125 // This screen is used to redraw the scree when windows events happen. It's
126 // updated in the main thread and displayed in the windows thread.
128 BITMAPV4HEADER
*VirtualScreenInfo
;
129 RGBQUAD
*VirtualScreen
;
131 EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*FillLine
;
134 // Keyboard Queue used by Simple Text In.
135 // QueueForRead: WinProc thread adds, and main thread removes.
136 // QueueForNotify: WinProc thread adds, and timer thread removes.
138 GOP_QUEUE_FIXED QueueForRead
;
139 GOP_QUEUE_FIXED QueueForNotify
;
141 EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL SimpleTextInEx
;
142 EFI_KEY_STATE KeyState
;
143 LIST_ENTRY NotifyList
;
157 BOOLEAN IsPartialKeySupport
;
158 EFI_EVENT TimerEvent
;
161 #define GOP_PRIVATE_DATA_FROM_THIS(a) \
162 CR(a, GOP_PRIVATE_DATA, GraphicsOutput, GOP_PRIVATE_DATA_SIGNATURE)
164 #define GOP_PRIVATE_DATA_FROM_TEXT_IN_THIS(a) \
165 CR(a, GOP_PRIVATE_DATA, SimpleTextIn, GOP_PRIVATE_DATA_SIGNATURE)
167 #define GOP_PRIVATE_DATA_FROM_TEXT_IN_EX_THIS(a) \
168 CR(a, GOP_PRIVATE_DATA, SimpleTextInEx, GOP_PRIVATE_DATA_SIGNATURE)
171 // Global Protocol Variables
173 extern EFI_DRIVER_BINDING_PROTOCOL gWinNtGopDriverBinding
;
174 extern EFI_COMPONENT_NAME_PROTOCOL gWinNtGopComponentName
;
175 extern EFI_COMPONENT_NAME2_PROTOCOL gWinNtGopComponentName2
;
179 // Gop Hardware abstraction internal worker functions
183 TODO: Add function description
185 @param WinNtIo TODO: add argument description
187 @return TODO: add return values
192 IN EFI_WIN_NT_IO_PROTOCOL
*WinNtIo
197 TODO: Add function description
199 @param Private TODO: add argument description
201 @return TODO: add return values
205 WinNtGopConstructor (
206 IN GOP_PRIVATE_DATA
*Private
211 TODO: Add function description
213 @param Private TODO: add argument description
215 @return TODO: add return values
220 IN GOP_PRIVATE_DATA
*Private
224 // UEFI 2.0 driver model prototypes for Win NT GOP
229 TODO: Add function description
231 @param ImageHandle TODO: add argument description
232 @param SystemTable TODO: add argument description
234 @return TODO: add return values
240 IN EFI_HANDLE ImageHandle
,
241 IN EFI_SYSTEM_TABLE
*SystemTable
246 TODO: Add function description
248 @param This TODO: add argument description
249 @param Handle TODO: add argument description
250 @param RemainingDevicePath TODO: add argument description
252 @return TODO: add return values
257 WinNtGopDriverBindingSupported (
258 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
259 IN EFI_HANDLE Handle
,
260 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
265 TODO: Add function description
267 @param This TODO: add argument description
268 @param Handle TODO: add argument description
269 @param RemainingDevicePath TODO: add argument description
271 @return TODO: add return values
276 WinNtGopDriverBindingStart (
277 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
278 IN EFI_HANDLE Handle
,
279 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
284 TODO: Add function description
286 @param This TODO: add argument description
287 @param Handle TODO: add argument description
288 @param NumberOfChildren TODO: add argument description
289 @param ChildHandleBuffer TODO: add argument description
291 @return TODO: add return values
296 WinNtGopDriverBindingStop (
297 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
298 IN EFI_HANDLE Handle
,
299 IN UINTN NumberOfChildren
,
300 IN EFI_HANDLE
*ChildHandleBuffer
305 TODO: Add function description
307 @param Private TODO: add argument description
308 @param Key TODO: add argument description
310 @return TODO: add return values
315 IN GOP_PRIVATE_DATA
*Private
,
321 TODO: Add function description
323 @param Private TODO: add argument description
325 @return TODO: add return values
329 WinNtGopInitializeSimpleTextInForWindow (
330 IN GOP_PRIVATE_DATA
*Private
335 TODO: Add function description
337 @param Private TODO: add argument description
339 @return TODO: add return values
343 WinNtGopDestroySimpleTextInForWindow (
344 IN GOP_PRIVATE_DATA
*Private