3 Copyright (c) 2006 - 2011, 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
{
79 EFI_HANDLE NotifyHandle
;
81 EFI_KEY_NOTIFY_FUNCTION KeyNotificationFn
;
82 LIST_ENTRY NotifyEntry
;
83 } WIN_NT_GOP_SIMPLE_TEXTIN_EX_NOTIFY
;
85 #define GRAPHICS_OUTPUT_INVALIDE_MODE_NUMBER 0xffff
88 UINT32 HorizontalResolution
;
89 UINT32 VerticalResolution
;
98 EFI_GRAPHICS_OUTPUT_PROTOCOL GraphicsOutput
;
99 EFI_SIMPLE_TEXT_INPUT_PROTOCOL SimpleTextIn
;
101 EFI_WIN_NT_THUNK_PROTOCOL
*WinNtThunk
;
103 EFI_UNICODE_STRING_TABLE
*ControllerNameTable
;
106 // GOP Private Data for QueryMode ()
108 GOP_MODE_DATA
*ModeData
;
111 // GOP Private Data knowing when to start hardware
113 BOOLEAN HardwareNeedsStarting
;
118 HANDLE ThreadInited
; // Semaphore
119 HANDLE ThreadHandle
; // Thread
123 WNDCLASSEX WindowsClass
;
126 // This screen is used to redraw the scree when windows events happen. It's
127 // updated in the main thread and displayed in the windows thread.
129 BITMAPV4HEADER
*VirtualScreenInfo
;
130 RGBQUAD
*VirtualScreen
;
132 EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*FillLine
;
135 // Keyboard Queue used by Simple Text In.
136 // QueueForRead: WinProc thread adds, and main thread removes.
137 // QueueForNotify: WinProc thread adds, and timer thread removes.
139 GOP_QUEUE_FIXED QueueForRead
;
140 GOP_QUEUE_FIXED QueueForNotify
;
142 EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL SimpleTextInEx
;
143 EFI_KEY_STATE KeyState
;
144 LIST_ENTRY NotifyList
;
158 BOOLEAN IsPartialKeySupport
;
159 EFI_EVENT TimerEvent
;
162 #define GOP_PRIVATE_DATA_FROM_THIS(a) \
163 CR(a, GOP_PRIVATE_DATA, GraphicsOutput, GOP_PRIVATE_DATA_SIGNATURE)
165 #define GOP_PRIVATE_DATA_FROM_TEXT_IN_THIS(a) \
166 CR(a, GOP_PRIVATE_DATA, SimpleTextIn, GOP_PRIVATE_DATA_SIGNATURE)
168 #define GOP_PRIVATE_DATA_FROM_TEXT_IN_EX_THIS(a) \
169 CR(a, GOP_PRIVATE_DATA, SimpleTextInEx, GOP_PRIVATE_DATA_SIGNATURE)
172 // Global Protocol Variables
174 extern EFI_DRIVER_BINDING_PROTOCOL gWinNtGopDriverBinding
;
175 extern EFI_COMPONENT_NAME_PROTOCOL gWinNtGopComponentName
;
176 extern EFI_COMPONENT_NAME2_PROTOCOL gWinNtGopComponentName2
;
180 // Gop Hardware abstraction internal worker functions
184 TODO: Add function description
186 @param WinNtIo TODO: add argument description
188 @return TODO: add return values
193 IN EFI_WIN_NT_IO_PROTOCOL
*WinNtIo
198 TODO: Add function description
200 @param Private TODO: add argument description
202 @return TODO: add return values
206 WinNtGopConstructor (
207 IN GOP_PRIVATE_DATA
*Private
212 TODO: Add function description
214 @param Private TODO: add argument description
216 @return TODO: add return values
221 IN GOP_PRIVATE_DATA
*Private
225 // UEFI 2.0 driver model prototypes for Win NT GOP
230 TODO: Add function description
232 @param ImageHandle TODO: add argument description
233 @param SystemTable TODO: add argument description
235 @return TODO: add return values
241 IN EFI_HANDLE ImageHandle
,
242 IN EFI_SYSTEM_TABLE
*SystemTable
247 TODO: Add function description
249 @param This TODO: add argument description
250 @param Handle TODO: add argument description
251 @param RemainingDevicePath TODO: add argument description
253 @return TODO: add return values
258 WinNtGopDriverBindingSupported (
259 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
260 IN EFI_HANDLE Handle
,
261 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
266 TODO: Add function description
268 @param This TODO: add argument description
269 @param Handle TODO: add argument description
270 @param RemainingDevicePath TODO: add argument description
272 @return TODO: add return values
277 WinNtGopDriverBindingStart (
278 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
279 IN EFI_HANDLE Handle
,
280 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
285 TODO: Add function description
287 @param This TODO: add argument description
288 @param Handle TODO: add argument description
289 @param NumberOfChildren TODO: add argument description
290 @param ChildHandleBuffer TODO: add argument description
292 @return TODO: add return values
297 WinNtGopDriverBindingStop (
298 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
299 IN EFI_HANDLE Handle
,
300 IN UINTN NumberOfChildren
,
301 IN EFI_HANDLE
*ChildHandleBuffer
306 TODO: Add function description
308 @param Private TODO: add argument description
309 @param Key TODO: add argument description
311 @return TODO: add return values
316 IN GOP_PRIVATE_DATA
*Private
,
322 TODO: Add function description
324 @param Private TODO: add argument description
326 @return TODO: add return values
330 WinNtGopInitializeSimpleTextInForWindow (
331 IN GOP_PRIVATE_DATA
*Private
336 TODO: Add function description
338 @param Private TODO: add argument description
340 @return TODO: add return values
344 WinNtGopDestroySimpleTextInForWindow (
345 IN GOP_PRIVATE_DATA
*Private