1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
|
/** @file
Copyright (c) 2006 - 2007, Intel Corporation
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Module Name:
WinNtGopScreen.c
Abstract:
This file produces the graphics abstration of GOP. It is called by
WinNtGopDriver.c file which deals with the UEFI 2.0 driver model.
This file just does graphics.
**/
#include "WinNtGop.h"
EFI_WIN_NT_THUNK_PROTOCOL *mWinNt;
DWORD mTlsIndex = TLS_OUT_OF_INDEXES;
DWORD mTlsIndexUseCount = 0; // lets us know when we can free mTlsIndex.
static EFI_EVENT mGopScreenExitBootServicesEvent;
GOP_MODE_DATA mGopModeData[] = {
{800, 600, 0, 0},
{640, 480, 0, 0},
{720, 400, 0, 0},
{1024, 768, 0, 0},
{1280, 1024, 0, 0}
};
EFI_STATUS
WinNtGopStartWindow (
IN GOP_PRIVATE_DATA *Private,
IN UINT32 HorizontalResolution,
IN UINT32 VerticalResolution,
IN UINT32 ColorDepth,
IN UINT32 RefreshRate
);
STATIC
VOID
EFIAPI
KillNtGopThread (
IN EFI_EVENT Event,
IN VOID *Context
);
STATIC
VOID
WinNtGopConvertParamToEfiKeyShiftState (
IN GOP_PRIVATE_DATA *Private,
IN WPARAM *wParam,
IN BOOLEAN Flag
)
{
switch (*wParam) {
//
// BUGBUG: Only GetAsyncKeyState() and GetKeyState() can distinguish
// left and right Ctrl, and Shift key.
// Neither of the two is defined in EFI_WIN_NT_THUNK_PROTOCOL.
// Therefor, we can not set the correct Shift state here.
//
case VK_SHIFT:
Private->LeftShift = Flag;
break;
case VK_CONTROL:
Private->LeftCtrl = Flag;
break;
case VK_LWIN:
Private->LeftLogo = Flag;
break;
case VK_RWIN:
Private->RightLogo = Flag;
break;
case VK_APPS:
Private->Menu = Flag;
break;
//
// BUGBUG: PrintScreen/SysRq can not trigger WM_KEYDOWN message,
// so SySReq shift state is not supported here.
//
case VK_PRINT:
Private->SysReq = Flag;
break;
}
}
STATIC
VOID
WinNtGopConvertParamToEfiKey (
IN GOP_PRIVATE_DATA *Private,
IN WPARAM *wParam,
IN EFI_INPUT_KEY *Key
)
{
switch (*wParam) {
case VK_HOME: Key->ScanCode = SCAN_HOME; break;
case VK_END: Key->ScanCode = SCAN_END; break;
case VK_LEFT: Key->ScanCode = SCAN_LEFT; break;
case VK_RIGHT: Key->ScanCode = SCAN_RIGHT; break;
case VK_UP: Key->ScanCode = SCAN_UP; break;
case VK_DOWN: Key->ScanCode = SCAN_DOWN; break;
case VK_DELETE: Key->ScanCode = SCAN_DELETE; break;
case VK_INSERT: Key->ScanCode = SCAN_INSERT; break;
case VK_PRIOR: Key->ScanCode = SCAN_PAGE_UP; break;
case VK_NEXT: Key->ScanCode = SCAN_PAGE_DOWN; break;
case VK_ESCAPE: Key->ScanCode = SCAN_ESC; break;
case VK_F1: Key->ScanCode = SCAN_F1; break;
case VK_F2: Key->ScanCode = SCAN_F2; break;
case VK_F3: Key->ScanCode = SCAN_F3; break;
case VK_F4: Key->ScanCode = SCAN_F4; break;
case VK_F5: Key->ScanCode = SCAN_F5; break;
case VK_F6: Key->ScanCode = SCAN_F6; break;
case VK_F7: Key->ScanCode = SCAN_F7; break;
case VK_F8: Key->ScanCode = SCAN_F8; break;
case VK_F9: Key->ScanCode = SCAN_F9; break;
case VK_F11: Key->ScanCode = SCAN_F11; break;
case VK_F12: Key->ScanCode = SCAN_F12; break;
case VK_F13: Key->ScanCode = SCAN_F13; break;
case VK_F14: Key->ScanCode = SCAN_F14; break;
case VK_F15: Key->ScanCode = SCAN_F15; break;
case VK_F16: Key->ScanCode = SCAN_F16; break;
case VK_F17: Key->ScanCode = SCAN_F17; break;
case VK_F18: Key->ScanCode = SCAN_F18; break;
case VK_F19: Key->ScanCode = SCAN_F19; break;
case VK_F20: Key->ScanCode = SCAN_F20; break;
case VK_F21: Key->ScanCode = SCAN_F21; break;
case VK_F22: Key->ScanCode = SCAN_F22; break;
case VK_F23: Key->ScanCode = SCAN_F23; break;
case VK_F24: Key->ScanCode = SCAN_F24; break;
//
// Set toggle state
//
case VK_NUMLOCK:
Private->NumLock = !Private->NumLock;
break;
case VK_SCROLL:
Private->ScrollLock = !Private->ScrollLock;
break;
case VK_CAPITAL:
Private->CapsLock = !Private->CapsLock;
break;
}
WinNtGopConvertParamToEfiKeyShiftState (Private, wParam, TRUE);
}
//
// GOP Protocol Member Functions
//
/**
Graphics Output protocol interface to get video mode
@param This Protocol instance pointer.
@param ModeNumber The mode number to return information on.
@param Info Caller allocated buffer that returns information
about ModeNumber.
@param SizeOfInfo A pointer to the size, in bytes, of the Info
buffer.
@retval EFI_SUCCESS Mode information returned.
@retval EFI_BUFFER_TOO_SMALL The Info buffer was too small.
@retval EFI_DEVICE_ERROR A hardware error occurred trying to retrieve the
video mode.
@retval EFI_NOT_STARTED Video display is not initialized. Call SetMode ()
@retval EFI_INVALID_PARAMETER One of the input args was NULL.
**/
EFI_STATUS
EFIAPI
WinNtGopQuerytMode (
IN EFI_GRAPHICS_OUTPUT_PROTOCOL *This,
IN UINT32 ModeNumber,
OUT UINTN *SizeOfInfo,
OUT EFI_GRAPHICS_OUTPUT_MODE_INFORMATION **Info
)
{
GOP_PRIVATE_DATA *Private;
Private = GOP_PRIVATE_DATA_FROM_THIS (This);
if (Info == NULL || SizeOfInfo == NULL || (UINTN) ModeNumber >= This->Mode->MaxMode) {
return EFI_INVALID_PARAMETER;
}
*Info = AllocatePool (sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION));
if (*Info == NULL) {
return EFI_OUT_OF_RESOURCES;
}
*SizeOfInfo = sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION);
(*Info)->Version = 0;
(*Info)->HorizontalResolution = Private->ModeData[ModeNumber].HorizontalResolution;
(*Info)->VerticalResolution = Private->ModeData[ModeNumber].VerticalResolution;
(*Info)->PixelFormat = PixelBltOnly;
(*Info)->PixelsPerScanLine = (*Info)->HorizontalResolution;
return EFI_SUCCESS;
}
/**
Graphics Output protocol interface to set video mode
@param This Protocol instance pointer.
@param ModeNumber The mode number to be set.
@retval EFI_SUCCESS Graphics mode was changed.
@retval EFI_DEVICE_ERROR The device had an error and could not complete the
request.
@retval EFI_UNSUPPORTED ModeNumber is not supported by this device.
**/
EFI_STATUS
EFIAPI
WinNtGopSetMode (
IN EFI_GRAPHICS_OUTPUT_PROTOCOL * This,
IN UINT32 ModeNumber
)
{
EFI_STATUS Status;
GOP_PRIVATE_DATA *Private;
GOP_MODE_DATA *ModeData;
EFI_GRAPHICS_OUTPUT_BLT_PIXEL Fill;
EFI_GRAPHICS_OUTPUT_BLT_PIXEL *NewFillLine;
RECT Rect;
UINTN Size;
UINTN Width;
UINTN Height;
Private = GOP_PRIVATE_DATA_FROM_THIS (This);
if (ModeNumber >= This->Mode->MaxMode) {
return EFI_UNSUPPORTED;
}
if (ModeNumber == This->Mode->Mode) {
return EFI_SUCCESS;
}
ModeData = &Private->ModeData[ModeNumber];
This->Mode->Mode = ModeNumber;
Private->GraphicsOutput.Mode->Info->HorizontalResolution = ModeData->HorizontalResolution;
Private->GraphicsOutput.Mode->Info->VerticalResolution = ModeData->VerticalResolution;
Private->GraphicsOutput.Mode->Info->PixelsPerScanLine = ModeData->HorizontalResolution;
if (Private->HardwareNeedsStarting) {
Status = WinNtGopStartWindow (
Private,
ModeData->HorizontalResolution,
ModeData->VerticalResolution,
ModeData->ColorDepth,
ModeData->RefreshRate
);
if (EFI_ERROR (Status)) {
return EFI_DEVICE_ERROR;
}
Private->HardwareNeedsStarting = FALSE;
} else {
//
// Change the resolution and resize of the window
//
//
// Free the old buffer. We do not save the content of the old buffer since the
// screen is to be cleared anyway. Clearing the screen is required by the EFI spec.
// See UEFI spec -EFI_GRAPHICS_OUTPUT_PROTOCOL.SetMode()
//
Private->WinNtThunk->HeapFree (Private->WinNtThunk->GetProcessHeap (), 0, Private->VirtualScreenInfo);
//
// Allocate DIB frame buffer directly from NT for performance enhancement
// This buffer is the virtual screen/frame buffer. This buffer is not the
// same a a frame buffer. The first row of this buffer will be the bottom
// line of the image. This is an artifact of the way we draw to the screen.
//
Size = ModeData->HorizontalResolution * ModeData->VerticalResolution * sizeof (RGBQUAD) + sizeof (BITMAPV4HEADER);
Private->VirtualScreenInfo = Private->WinNtThunk->HeapAlloc (
Private->WinNtThunk->GetProcessHeap (),
HEAP_ZERO_MEMORY,
Size
);
//
// Update the virtual screen info data structure
//
Private->VirtualScreenInfo->bV4Size = sizeof (BITMAPV4HEADER);
Private->VirtualScreenInfo->bV4Width = ModeData->HorizontalResolution;
Private->VirtualScreenInfo->bV4Height = ModeData->VerticalResolution;
Private->VirtualScreenInfo->bV4Planes = 1;
Private->VirtualScreenInfo->bV4BitCount = 32;
//
// uncompressed
//
Private->VirtualScreenInfo->bV4V4Compression = BI_RGB;
//
// The rest of the allocated memory block is the virtual screen buffer
//
Private->VirtualScreen = (RGBQUAD *) (Private->VirtualScreenInfo + 1);
//
// Use the AdjuctWindowRect fuction to calculate the real width and height
// of the new window including the border and caption
//
Rect.left = 0;
Rect.top = 0;
Rect.right = ModeData->HorizontalResolution;
Rect.bottom = ModeData->VerticalResolution;
Private->WinNtThunk->AdjustWindowRect (&Rect, WS_OVERLAPPEDWINDOW, 0);
Width = Rect.right - Rect.left;
Height = Rect.bottom - Rect.top;
//
// Retrieve the original window position information
//
Private->WinNtThunk->GetWindowRect (Private->WindowHandle, &Rect);
//
// Adjust the window size
//
Private->WinNtThunk->MoveWindow (Private->WindowHandle, Rect.left, Rect.top, Width, Height, TRUE);
}
NewFillLine = AllocatePool (sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL) * ModeData->HorizontalResolution);
if (NewFillLine == NULL) {
return EFI_DEVICE_ERROR;
}
if (Private->FillLine != NULL) {
FreePool (Private->FillLine);
}
Private->FillLine = NewFillLine;
Fill.Red = 0x00;
Fill.Green = 0x00;
Fill.Blue = 0x00;
This->Blt (
This,
&Fill,
EfiBltVideoFill,
0,
0,
0,
0,
ModeData->HorizontalResolution,
ModeData->VerticalResolution,
ModeData->HorizontalResolution * sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL)
);
return EFI_SUCCESS;
}
/**
Blt pixels from the rectangle (Width X Height) formed by the BltBuffer
onto the graphics screen starting a location (X, Y). (0, 0) is defined as
the upper left hand side of the screen. (X, Y) can be outside of the
current screen geometry and the BltBuffer will be cliped when it is
displayed. X and Y can be negative or positive. If Width or Height is
bigger than the current video screen the image will be clipped.
@param This Protocol instance pointer.
@param X X location on graphics screen.
@param Y Y location on the graphics screen.
@param Width Width of BltBuffer.
@param Height Hight of BltBuffer
@param BltOperation Operation to perform on BltBuffer and video memory
@param BltBuffer Buffer containing data to blt into video buffer.
This buffer has a size of
Width*Height*sizeof(EFI_GRAPHICS_OUTPUT_BLT_PIXEL)
@param SourceX If the BltOperation is a EfiCopyBlt this is the
source of the copy. For other BLT operations this
argument is not used.
@param SourceX If the BltOperation is a EfiCopyBlt this is the
source of the copy. For other BLT operations this
argument is not used.
@retval EFI_SUCCESS The palette is updated with PaletteArray.
@retval EFI_INVALID_PARAMETER BltOperation is not valid.
@retval EFI_DEVICE_ERROR A hardware error occured writting to the video
buffer.
**/
// TODO: SourceY - add argument and description to function comment
// TODO: DestinationX - add argument and description to function comment
// TODO: DestinationY - add argument and description to function comment
// TODO: Delta - add argument and description to function comment
EFI_STATUS
EFIAPI
WinNtGopBlt (
IN EFI_GRAPHICS_OUTPUT_PROTOCOL *This,
IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer, OPTIONAL
IN EFI_GRAPHICS_OUTPUT_BLT_OPERATION BltOperation,
IN UINTN SourceX,
IN UINTN SourceY,
IN UINTN DestinationX,
IN UINTN DestinationY,
IN UINTN Width,
IN UINTN Height,
IN UINTN Delta OPTIONAL
)
{
GOP_PRIVATE_DATA *Private;
EFI_TPL OriginalTPL;
UINTN DstY;
UINTN SrcY;
RGBQUAD *VScreen;
RGBQUAD *VScreenSrc;
EFI_GRAPHICS_OUTPUT_BLT_PIXEL *Blt;
UINTN Index;
RECT Rect;
EFI_GRAPHICS_OUTPUT_BLT_PIXEL *FillPixel;
UINT32 VerticalResolution;
UINT32 HorizontalResolution;
Private = GOP_PRIVATE_DATA_FROM_THIS (This);
if ((BltOperation < 0) || (BltOperation >= EfiGraphicsOutputBltOperationMax)) {
return EFI_INVALID_PARAMETER;
}
if (Width == 0 || Height == 0) {
return EFI_INVALID_PARAMETER;
}
//
// If Delta is zero, then the entire BltBuffer is being used, so Delta
// is the number of bytes in each row of BltBuffer. Since BltBuffer is Width pixels size,
// the number of bytes in each row can be computed.
//
if (Delta == 0) {
Delta = Width * sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL);
}
//
// We need to fill the Virtual Screen buffer with the blt data.
// The virtual screen is upside down, as the first row is the bootom row of
// the image.
//
VerticalResolution = This->Mode->Info->VerticalResolution;
HorizontalResolution = This->Mode->Info->HorizontalResolution;
if (BltOperation == EfiBltVideoToBltBuffer) {
//
// Video to BltBuffer: Source is Video, destination is BltBuffer
//
if (SourceY + Height > VerticalResolution) {
return EFI_INVALID_PARAMETER;
}
if (SourceX + Width > HorizontalResolution) {
return EFI_INVALID_PARAMETER;
}
//
// We have to raise to TPL Notify, so we make an atomic write the frame buffer.
// We would not want a timer based event (Cursor, ...) to come in while we are
// doing this operation.
//
OriginalTPL = gBS->RaiseTPL (TPL_NOTIFY);
for (SrcY = SourceY, DstY = DestinationY; DstY < (Height + DestinationY); SrcY++, DstY++) {
Blt = (EFI_GRAPHICS_OUTPUT_BLT_PIXEL *) ((UINT8 *) BltBuffer + (DstY * Delta) + DestinationX * sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL));
VScreen = &Private->VirtualScreen[(VerticalResolution - SrcY - 1) * HorizontalResolution + SourceX];
CopyMem (Blt, VScreen, sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL) * Width);
}
} else {
//
// BltBuffer to Video: Source is BltBuffer, destination is Video
//
if (DestinationY + Height > VerticalResolution) {
return EFI_INVALID_PARAMETER;
}
if (DestinationX + Width > HorizontalResolution) {
return EFI_INVALID_PARAMETER;
}
//
// We have to raise to TPL Notify, so we make an atomic write the frame buffer.
// We would not want a timer based event (Cursor, ...) to come in while we are
// doing this operation.
//
OriginalTPL = gBS->RaiseTPL (TPL_NOTIFY);
if (BltOperation == EfiBltVideoFill) {
FillPixel = BltBuffer;
for (Index = 0; Index < Width; Index++) {
Private->FillLine[Index] = *FillPixel;
}
}
for (Index = 0; Index < Height; Index++) {
if (DestinationY <= SourceY) {
SrcY = SourceY + Index;
DstY = DestinationY + Index;
} else {
SrcY = SourceY + Height - Index - 1;
DstY = DestinationY + Height - Index - 1;
}
VScreen = &Private->VirtualScreen[(VerticalResolution - DstY - 1) * HorizontalResolution + DestinationX];
switch (BltOperation) {
case EfiBltBufferToVideo:
Blt = (EFI_GRAPHICS_OUTPUT_BLT_PIXEL *) ((UINT8 *) BltBuffer + (SrcY * Delta) + SourceX * sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL));
CopyMem (VScreen, Blt, Width * sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL));
break;
case EfiBltVideoToVideo:
VScreenSrc = &Private->VirtualScreen[(VerticalResolution - SrcY - 1) * HorizontalResolution + SourceX];
CopyMem (VScreen, VScreenSrc, Width * sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL));
break;
case EfiBltVideoFill:
CopyMem (VScreen, Private->FillLine, Width * sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL));
break;
}
}
}
if (BltOperation != EfiBltVideoToBltBuffer) {
//
// Mark the area we just blted as Invalid so WM_PAINT will update.
//
Rect.left = DestinationX;
Rect.top = DestinationY;
Rect.right = DestinationX + Width;
Rect.bottom = DestinationY + Height;
Private->WinNtThunk->InvalidateRect (Private->WindowHandle, &Rect, FALSE);
//
// Send the WM_PAINT message to the thread that is drawing the window. We
// are in the main thread and the window drawing is in a child thread.
// There is a child thread per window. We have no CriticalSection or Mutex
// since we write the data and the other thread displays the data. While
// we may miss some data for a short period of time this is no different than
// a write combining on writes to a frame buffer.
//
Private->WinNtThunk->UpdateWindow (Private->WindowHandle);
}
gBS->RestoreTPL (OriginalTPL);
return EFI_SUCCESS;
}
//
// Construction and Destruction functions
//
/**
@return None
**/
// TODO: WinNtIo - add argument and description to function comment
// TODO: EFI_UNSUPPORTED - add return value to function comment
// TODO: EFI_SUCCESS - add return value to function comment
EFI_STATUS
WinNtGopSupported (
IN EFI_WIN_NT_IO_PROTOCOL *WinNtIo
)
{
//
// Check to see if the IO abstraction represents a device type we support.
//
// This would be replaced a check of PCI subsystem ID, etc.
//
if (!CompareGuid (WinNtIo->TypeGuid, &gEfiWinNtGopGuid)) {
return EFI_UNSUPPORTED;
}
return EFI_SUCCESS;
}
/**
Win32 Windows event handler.
See Win32 Book
@return See Win32 Book
**/
// TODO: hwnd - add argument and description to function comment
// TODO: iMsg - add argument and description to function comment
// TODO: wParam - add argument and description to function comment
// TODO: lParam - add argument and description to function comment
LRESULT
CALLBACK
WinNtGopThreadWindowProc (
IN HWND hwnd,
IN UINT iMsg,
IN WPARAM wParam,
IN LPARAM lParam
)
{
GOP_PRIVATE_DATA *Private;
UINTN Size;
HDC Handle;
PAINTSTRUCT PaintStruct;
LPARAM Index;
EFI_INPUT_KEY Key;
//
// BugBug - if there are two instances of this DLL in memory (such as is
// the case for ERM), the correct instance of this function may not be called.
// This also means that the address of the mTlsIndex value will be wrong, and
// the value may be wrong too.
//
//
// Use mTlsIndex global to get a Thread Local Storage version of Private.
// This works since each Gop protocol has a unique Private data instance and
// a unique thread.
//
Private = mWinNt->TlsGetValue (mTlsIndex);
ASSERT (NULL != Private);
switch (iMsg) {
case WM_CREATE:
Size = Private->GraphicsOutput.Mode->Info->HorizontalResolution * Private->GraphicsOutput.Mode->Info->VerticalResolution * sizeof (RGBQUAD);
//
// Allocate DIB frame buffer directly from NT for performance enhancement
// This buffer is the virtual screen/frame buffer. This buffer is not the
// same a a frame buffer. The first fow of this buffer will be the bottom
// line of the image. This is an artifact of the way we draw to the screen.
//
Private->VirtualScreenInfo = Private->WinNtThunk->HeapAlloc (
Private->WinNtThunk->GetProcessHeap (),
HEAP_ZERO_MEMORY,
Size
);
Private->VirtualScreenInfo->bV4Size = sizeof (BITMAPV4HEADER);
Private->VirtualScreenInfo->bV4Width = Private->GraphicsOutput.Mode->Info->HorizontalResolution;
Private->VirtualScreenInfo->bV4Height = Private->GraphicsOutput.Mode->Info->VerticalResolution;
Private->VirtualScreenInfo->bV4Planes = 1;
Private->VirtualScreenInfo->bV4BitCount = 32;
//
// uncompressed
//
Private->VirtualScreenInfo->bV4V4Compression = BI_RGB;
Private->VirtualScreen = (RGBQUAD *) (Private->VirtualScreenInfo + 1);
return 0;
case WM_PAINT:
//
// I have not found a way to convert hwnd into a Private context. So for
// now we use this API to convert hwnd to Private data.
//
Handle = mWinNt->BeginPaint (hwnd, &PaintStruct);
mWinNt->SetDIBitsToDevice (
Handle, // Destination Device Context
0, // Destination X - 0
0, // Destination Y - 0
Private->GraphicsOutput.Mode->Info->HorizontalResolution, // Width
Private->GraphicsOutput.Mode->Info->VerticalResolution, // Height
0, // Source X
0, // Source Y
0, // DIB Start Scan Line
Private->GraphicsOutput.Mode->Info->VerticalResolution, // Number of scan lines
Private->VirtualScreen, // Address of array of DIB bits
(BITMAPINFO *) Private->VirtualScreenInfo, // Address of structure with bitmap info
DIB_RGB_COLORS // RGB or palette indexes
);
mWinNt->EndPaint (hwnd, &PaintStruct);
return 0;
//
// F10 and the ALT key do not create a WM_KEYDOWN message, thus this special case
// WM_SYSKEYDOWN is posted when F10 is pressed or
// holds down ALT key and then presses another key.
//
case WM_SYSKEYDOWN:
Key.ScanCode = 0;
switch (wParam) {
case VK_F10:
Key.ScanCode = SCAN_F10;
Key.UnicodeChar = 0;
GopPrivateAddQ (Private, Key);
return 0;
}
if ((lParam & GOP_ALT_KEY_PRESSED) == GOP_ALT_KEY_PRESSED) {
//
// ALT is pressed with another key pressed
//
WinNtGopConvertParamToEfiKey (Private, &wParam, &Key);
if ((lParam & GOP_EXTENDED_KEY) == GOP_EXTENDED_KEY) {
Private->RightAlt = TRUE;
} else {
Private->LeftAlt = TRUE;
}
if (Private->RightAlt && Private->LeftAlt) {
Private->LeftAlt = FALSE;
}
}
if (Key.ScanCode != 0) {
Key.UnicodeChar = 0;
GopPrivateAddQ (Private, Key);
}
return 0;
case WM_SYSKEYUP:
if ((lParam & GOP_ALT_KEY_PRESSED) == GOP_ALT_KEY_PRESSED) {
//
// ALT is pressed with another key released
//
WinNtGopConvertParamToEfiKeyShiftState (Private, &wParam, FALSE);
//
// Actually ALT key is still held down here.
// Change the ALT key state when another key is released
// by user because we did not find a better solution to
// get a released ALT key.
//
Private->RightAlt = FALSE;
Private->LeftAlt = FALSE;
}
return 0;
case WM_KEYDOWN:
Key.ScanCode = 0;
WinNtGopConvertParamToEfiKey (Private, &wParam, &Key);
if (Key.ScanCode != 0) {
Key.UnicodeChar = 0;
GopPrivateAddQ (Private, Key);
}
return 0;
case WM_KEYUP:
WinNtGopConvertParamToEfiKeyShiftState (Private, &wParam, FALSE);
return 0;
case WM_CHAR:
//
// The ESC key also generate WM_CHAR.
//
if (wParam == 0x1B) {
return 0;
}
for (Index = 0; Index < (lParam & 0xffff); Index++) {
if (wParam != 0) {
Key.UnicodeChar = (CHAR16) wParam;
Key.ScanCode = 0;
GopPrivateAddQ (Private, Key);
}
}
return 0;
case WM_CLOSE:
//
// This close message is issued by user, core is not aware of this,
// so don't release the window display resource, just hide the window.
//
Private->WinNtThunk->ShowWindow (Private->WindowHandle, SW_HIDE);
return 0;
case WM_DESTROY:
mWinNt->DestroyWindow (hwnd);
mWinNt->PostQuitMessage (0);
mWinNt->HeapFree (Private->WinNtThunk->GetProcessHeap (), 0, Private->VirtualScreenInfo);
mWinNt->ExitThread (0);
return 0;
default:
break;
};
return mWinNt->DefWindowProc (hwnd, iMsg, wParam, lParam);
}
/**
This thread simulates the end of WinMain () aplication. Each Winow nededs
to process it's events. The messages are dispatched to
WinNtGopThreadWindowProc ().
Be very careful sine WinNtGopThreadWinMain () and WinNtGopThreadWindowProc ()
are running in a seperate thread. We have to do this to process the events.
@param lpParameter Handle of window to manage.
@return if a WM_QUIT message is returned exit.
**/
DWORD
WINAPI
WinNtGopThreadWinMain (
LPVOID lpParameter
)
{
MSG Message;
GOP_PRIVATE_DATA *Private;
ATOM Atom;
RECT Rect;
Private = (GOP_PRIVATE_DATA *) lpParameter;
ASSERT (NULL != Private);
//
// Since each thread has unique private data, save the private data in Thread
// Local Storage slot. Then the shared global mTlsIndex can be used to get
// thread specific context.
//
Private->WinNtThunk->TlsSetValue (mTlsIndex, Private);
Private->ThreadId = Private->WinNtThunk->GetCurrentThreadId ();
Private->WindowsClass.cbSize = sizeof (WNDCLASSEX);
Private->WindowsClass.style = CS_HREDRAW | CS_VREDRAW | CS_OWNDC;
Private->WindowsClass.lpfnWndProc = WinNtGopThreadWindowProc;
Private->WindowsClass.cbClsExtra = 0;
Private->WindowsClass.cbWndExtra = 0;
Private->WindowsClass.hInstance = NULL;
Private->WindowsClass.hIcon = Private->WinNtThunk->LoadIcon (NULL, IDI_APPLICATION);
Private->WindowsClass.hCursor = Private->WinNtThunk->LoadCursor (NULL, IDC_ARROW);
Private->WindowsClass.hbrBackground = (HBRUSH) COLOR_WINDOW;
Private->WindowsClass.lpszMenuName = NULL;
Private->WindowsClass.lpszClassName = WIN_NT_GOP_CLASS_NAME;
Private->WindowsClass.hIconSm = Private->WinNtThunk->LoadIcon (NULL, IDI_APPLICATION);
//
// This call will fail after the first time, but thats O.K. since we only need
// WIN_NT_GOP_CLASS_NAME to exist to create the window.
//
// Note: Multiple instances of this DLL will use the same instance of this
// Class, including the callback function, unless the Class is unregistered and
// successfully registered again.
//
Atom = Private->WinNtThunk->RegisterClassEx (&Private->WindowsClass);
//
// Setting Rect values to allow for the AdjustWindowRect to provide
// us the correct sizes for the client area when doing the CreateWindowEx
//
Rect.top = 0;
Rect.bottom = Private->GraphicsOutput.Mode->Info->VerticalResolution;
Rect.left = 0;
Rect.right = Private->GraphicsOutput.Mode->Info->HorizontalResolution;
Private->WinNtThunk->AdjustWindowRect (&Rect, WS_OVERLAPPEDWINDOW, 0);
Private->WindowHandle = Private->WinNtThunk->CreateWindowEx (
0,
WIN_NT_GOP_CLASS_NAME,
Private->WindowName,
WS_OVERLAPPEDWINDOW,
CW_USEDEFAULT,
CW_USEDEFAULT,
Rect.right - Rect.left,
Rect.bottom - Rect.top,
NULL,
NULL,
NULL,
&Private
);
//
// The reset of this thread is the standard winows program. We need a sperate
// thread since we must process the message loop to make windows act like
// windows.
//
Private->WinNtThunk->ShowWindow (Private->WindowHandle, SW_SHOW);
Private->WinNtThunk->UpdateWindow (Private->WindowHandle);
//
// Let the main thread get some work done
//
Private->WinNtThunk->ReleaseSemaphore (Private->ThreadInited, 1, NULL);
//
// This is the message loop that all Windows programs need.
//
while (Private->WinNtThunk->GetMessage (&Message, Private->WindowHandle, 0, 0)) {
Private->WinNtThunk->TranslateMessage (&Message);
Private->WinNtThunk->DispatchMessage (&Message);
}
return Message.wParam;
}
/**
TODO: Add function description
@param Private TODO: add argument description
@param HorizontalResolution TODO: add argument description
@param VerticalResolution TODO: add argument description
@param ColorDepth TODO: add argument description
@param RefreshRate TODO: add argument description
@return TODO: add return values
**/
EFI_STATUS
WinNtGopStartWindow (
IN GOP_PRIVATE_DATA *Private,
IN UINT32 HorizontalResolution,
IN UINT32 VerticalResolution,
IN UINT32 ColorDepth,
IN UINT32 RefreshRate
)
{
EFI_STATUS Status;
DWORD NewThreadId;
mWinNt = Private->WinNtThunk;
//
// Initialize a Thread Local Storge variable slot. We use TLS to get the
// correct Private data instance into the windows thread.
//
if (mTlsIndex == TLS_OUT_OF_INDEXES) {
ASSERT (0 == mTlsIndexUseCount);
mTlsIndex = Private->WinNtThunk->TlsAlloc ();
}
//
// always increase the use count!
//
mTlsIndexUseCount++;
//
// Register to be notified on exit boot services so we can destroy the window.
//
Status = gBS->CreateEvent (
EVT_SIGNAL_EXIT_BOOT_SERVICES,
TPL_CALLBACK,
KillNtGopThread,
Private,
&mGopScreenExitBootServicesEvent
);
Private->ThreadInited = Private->WinNtThunk->CreateSemaphore (NULL, 0, 1, NULL);
Private->ThreadHandle = Private->WinNtThunk->CreateThread (
NULL,
0,
WinNtGopThreadWinMain,
(VOID *) Private,
0,
&NewThreadId
);
//
// The other thread has entered the windows message loop so we can
// continue our initialization.
//
Private->WinNtThunk->WaitForSingleObject (Private->ThreadInited, INFINITE);
Private->WinNtThunk->CloseHandle (Private->ThreadInited);
return Status;
}
/**
@return None
**/
// TODO: Private - add argument and description to function comment
// TODO: EFI_SUCCESS - add return value to function comment
EFI_STATUS
WinNtGopConstructor (
GOP_PRIVATE_DATA *Private
)
{
Private->ModeData = mGopModeData;
Private->GraphicsOutput.QueryMode = WinNtGopQuerytMode;
Private->GraphicsOutput.SetMode = WinNtGopSetMode;
Private->GraphicsOutput.Blt = WinNtGopBlt;
//
// Allocate buffer for Graphics Output Protocol mode information
//
Private->GraphicsOutput.Mode = AllocatePool (sizeof (EFI_GRAPHICS_OUTPUT_PROTOCOL_MODE));
if (Private->GraphicsOutput.Mode == NULL) {
return EFI_OUT_OF_RESOURCES;
}
Private->GraphicsOutput.Mode->Info = AllocatePool (sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION));
if (Private->GraphicsOutput.Mode->Info == NULL) {
return EFI_OUT_OF_RESOURCES;
}
Private->GraphicsOutput.Mode->MaxMode = sizeof(mGopModeData) / sizeof(GOP_MODE_DATA);
//
// Till now, we have no idea about the window size.
//
Private->GraphicsOutput.Mode->Mode = GRAPHICS_OUTPUT_INVALIDE_MODE_NUMBER;
Private->GraphicsOutput.Mode->Info->Version = 0;
Private->GraphicsOutput.Mode->Info->HorizontalResolution = 0;
Private->GraphicsOutput.Mode->Info->VerticalResolution = 0;
Private->GraphicsOutput.Mode->Info->PixelFormat = PixelBltOnly;
Private->GraphicsOutput.Mode->SizeOfInfo = sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION);
Private->GraphicsOutput.Mode->FrameBufferBase = (EFI_PHYSICAL_ADDRESS) NULL;
Private->GraphicsOutput.Mode->FrameBufferSize = 0;
Private->HardwareNeedsStarting = TRUE;
Private->FillLine = NULL;
WinNtGopInitializeSimpleTextInForWindow (Private);
return EFI_SUCCESS;
}
/**
@return None
**/
// TODO: Private - add argument and description to function comment
// TODO: EFI_SUCCESS - add return value to function comment
EFI_STATUS
WinNtGopDestructor (
GOP_PRIVATE_DATA *Private
)
{
UINT32 UnregisterReturn;
if (!Private->HardwareNeedsStarting) {
//
// BugBug: Shutdown GOP Hardware and any child devices.
//
Private->WinNtThunk->SendMessage (Private->WindowHandle, WM_DESTROY, 0, 0);
Private->WinNtThunk->CloseHandle (Private->ThreadHandle);
mTlsIndexUseCount--;
//
// The callback function for another window could still be called,
// so we need to make sure there are no more users of mTlsIndex.
//
if (0 == mTlsIndexUseCount) {
ASSERT (TLS_OUT_OF_INDEXES != mTlsIndex);
Private->WinNtThunk->TlsFree (mTlsIndex);
mTlsIndex = TLS_OUT_OF_INDEXES;
UnregisterReturn = Private->WinNtThunk->UnregisterClass (
Private->WindowsClass.lpszClassName,
Private->WindowsClass.hInstance
);
}
WinNtGopDestroySimpleTextInForWindow (Private);
}
//
// Free graphics output protocol occupied resource
//
if (Private->GraphicsOutput.Mode != NULL) {
if (Private->GraphicsOutput.Mode->Info != NULL) {
FreePool (Private->GraphicsOutput.Mode->Info);
}
FreePool (Private->GraphicsOutput.Mode);
}
return EFI_SUCCESS;
}
/**
This is the GOP screen's callback notification function for exit-boot-services.
All we do here is call WinNtGopDestructor().
@param Event not used
@param Context pointer to the Private structure.
@return None.
**/
STATIC
VOID
EFIAPI
KillNtGopThread (
IN EFI_EVENT Event,
IN VOID *Context
)
{
EFI_STATUS Status;
Status = WinNtGopDestructor (Context);
}
|