Gop.h 4.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182
  1. /*++ @file
  2. Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>
  3. Portions copyright (c) 2010,Apple Inc. All rights reserved.<BR>
  4. SPDX-License-Identifier: BSD-2-Clause-Patent
  5. **/
  6. #ifndef __UGA_H_
  7. #define __UGA_H_
  8. #include <PiDxe.h>
  9. #include <Protocol/GraphicsOutput.h>
  10. #include <Protocol/SimpleTextIn.h>
  11. #include <Protocol/SimpleTextInEx.h>
  12. #include <Protocol/SimplePointer.h>
  13. #include <Protocol/EmuIoThunk.h>
  14. #include <Protocol/EmuGraphicsWindow.h>
  15. #include <Guid/EventGroup.h>
  16. #include <Library/DebugLib.h>
  17. #include <Library/BaseLib.h>
  18. #include <Library/UefiDriverEntryPoint.h>
  19. #include <Library/UefiLib.h>
  20. #include <Library/BaseMemoryLib.h>
  21. #include <Library/MemoryAllocationLib.h>
  22. #include <Library/UefiBootServicesTableLib.h>
  23. #include <Library/KeyMapLib.h>
  24. #define MAX_Q 256
  25. typedef struct {
  26. UINTN Front;
  27. UINTN Rear;
  28. UINTN Count;
  29. EFI_INPUT_KEY Q[MAX_Q];
  30. } GOP_QUEUE_FIXED;
  31. #define EMU_GOP_SIMPLE_TEXTIN_EX_NOTIFY_SIGNATURE SIGNATURE_32 ('U', 'g', 'S', 'n')
  32. typedef struct _EMU_GOP_SIMPLE_TEXTIN_EX_NOTIFY {
  33. UINTN Signature;
  34. EFI_HANDLE NotifyHandle;
  35. EFI_KEY_DATA KeyData;
  36. EFI_KEY_NOTIFY_FUNCTION KeyNotificationFn;
  37. EFI_EVENT Event;
  38. LIST_ENTRY NotifyEntry;
  39. } EMU_GOP_SIMPLE_TEXTIN_EX_NOTIFY;
  40. #define GRAPHICS_OUTPUT_INVALIDE_MODE_NUMBER 0xffff
  41. typedef struct {
  42. UINT32 HorizontalResolution;
  43. UINT32 VerticalResolution;
  44. UINT32 ColorDepth;
  45. UINT32 RefreshRate;
  46. } GOP_MODE_DATA;
  47. extern EFI_DRIVER_BINDING_PROTOCOL gEmuGopDriverBinding;
  48. extern EFI_COMPONENT_NAME_PROTOCOL gEmuGopComponentName;
  49. #define EMU_UGA_CLASS_NAME L"EmuGopWindow"
  50. #define GOP_PRIVATE_DATA_SIGNATURE SIGNATURE_32 ('G', 'o', 'p', 'N')
  51. typedef struct {
  52. UINT64 Signature;
  53. EFI_HANDLE Handle;
  54. EFI_GRAPHICS_OUTPUT_PROTOCOL GraphicsOutput;
  55. EFI_SIMPLE_TEXT_INPUT_PROTOCOL SimpleTextIn;
  56. EFI_SIMPLE_POINTER_PROTOCOL SimplePointer;
  57. EMU_IO_THUNK_PROTOCOL *EmuIoThunk;
  58. EMU_GRAPHICS_WINDOW_PROTOCOL *EmuGraphicsWindow;
  59. EFI_UNICODE_STRING_TABLE *ControllerNameTable;
  60. EFI_SIMPLE_POINTER_MODE PointerMode;
  61. //
  62. // GOP Private Data for QueryMode ()
  63. //
  64. GOP_MODE_DATA *ModeData;
  65. //
  66. // UGA Private Data knowing when to start hardware
  67. //
  68. BOOLEAN HardwareNeedsStarting;
  69. CHAR16 *WindowName;
  70. GOP_QUEUE_FIXED Queue;
  71. EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL SimpleTextInEx;
  72. EFI_KEY_STATE KeyState;
  73. LIST_ENTRY NotifyList;
  74. } GOP_PRIVATE_DATA;
  75. #define GOP_PRIVATE_DATA_FROM_THIS(a) \
  76. CR(a, GOP_PRIVATE_DATA, GraphicsOutput, GOP_PRIVATE_DATA_SIGNATURE)
  77. #define GOP_PRIVATE_DATA_FROM_TEXT_IN_THIS(a) \
  78. CR(a, GOP_PRIVATE_DATA, SimpleTextIn, GOP_PRIVATE_DATA_SIGNATURE)
  79. #define GOP_PRIVATE_DATA_FROM_TEXT_IN_EX_THIS(a) \
  80. CR(a, GOP_PRIVATE_DATA, SimpleTextInEx, GOP_PRIVATE_DATA_SIGNATURE)
  81. #define GOP_PRIVATE_DATA_FROM_POINTER_MODE_THIS(a) \
  82. CR(a, GOP_PRIVATE_DATA, SimplePointer, GOP_PRIVATE_DATA_SIGNATURE)
  83. //
  84. // Global Protocol Variables
  85. //
  86. extern EFI_DRIVER_BINDING_PROTOCOL gEmuGopDriverBinding;
  87. extern EFI_COMPONENT_NAME_PROTOCOL gEmuGopComponentName;
  88. extern EFI_COMPONENT_NAME2_PROTOCOL gEmuGopComponentName2;
  89. //
  90. // Gop Hardware abstraction internal worker functions
  91. //
  92. EFI_STATUS
  93. EmuGopSupported (
  94. IN EMU_IO_THUNK_PROTOCOL *EmuIoThunk
  95. );
  96. EFI_STATUS
  97. EmuGopConstructor (
  98. IN GOP_PRIVATE_DATA *Private
  99. );
  100. EFI_STATUS
  101. EmuGopDestructor (
  102. IN GOP_PRIVATE_DATA *Private
  103. );
  104. EFI_STATUS
  105. GopPrivateAddQ (
  106. IN GOP_PRIVATE_DATA *Private,
  107. IN EFI_INPUT_KEY Key
  108. );
  109. EFI_STATUS
  110. EmuGopInitializeSimpleTextInForWindow (
  111. IN GOP_PRIVATE_DATA *Private
  112. );
  113. EFI_STATUS
  114. EmuGopInitializeSimplePointerForWindow (
  115. IN GOP_PRIVATE_DATA *Private
  116. );
  117. EFI_STATUS
  118. EmuGopStartWindow (
  119. IN GOP_PRIVATE_DATA *Private,
  120. IN UINT32 HorizontalResolution,
  121. IN UINT32 VerticalResolution,
  122. IN UINT32 ColorDepth,
  123. IN UINT32 RefreshRate
  124. );
  125. VOID
  126. EFIAPI
  127. ShutdownGopEvent (
  128. IN EFI_EVENT Event,
  129. IN VOID *Context
  130. );
  131. VOID
  132. EFIAPI
  133. GopPrivateMakeCallbackFunction (
  134. IN VOID *Context,
  135. IN EFI_KEY_DATA *KeyData
  136. );
  137. VOID
  138. EFIAPI
  139. GopPrivateBreakCallbackFunction (
  140. IN VOID *Context,
  141. IN EFI_KEY_DATA *KeyData
  142. );
  143. #endif