Updated MSA by putting Specification element at the end of the header section

[mirror_edk2.git] / EdkNt32Pkg / Dxe / WinNtThunk / Bus / Uga / WinNtUga.h

/*++\r
\r
Copyright (c) 2006, Intel Corporation                                                         \r
All rights reserved. This program and the accompanying materials                          \r
are licensed and made available under the terms and conditions of the BSD License         \r
which accompanies this distribution.  The full text of the license may be found at        \r
http://opensource.org/licenses/bsd-license.php                                            \r
                                                                                          \r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
\r
Module Name:\r
\r
  WinNtUga.h\r
\r
Abstract:\r
\r
  Private data for the Uga driver that is bound to the WinNt Thunk protocol \r
\r
--*/\r
\r
#ifndef _WIN_NT_UGA_H_\r
#define _WIN_NT_UGA_H_\r
\r
\r
\r
#define MAX_Q 256\r
\r
typedef struct {\r
  UINTN         Front;\r
  UINTN         Rear;\r
  UINTN         Count;\r
  EFI_INPUT_KEY Q[MAX_Q];\r
} UGA_QUEUE_FIXED;\r
\r
#define WIN_NT_UGA_CLASS_NAME       L"WinNtUgaWindow"\r
\r
#define UGA_PRIVATE_DATA_SIGNATURE  EFI_SIGNATURE_32 ('S', 'g', 'o', 'N')\r
typedef struct {\r
  UINT64                      Signature;\r
\r
  EFI_HANDLE                  Handle;\r
  EFI_UGA_DRAW_PROTOCOL       UgaDraw;\r
  EFI_SIMPLE_TEXT_IN_PROTOCOL SimpleTextIn;\r
\r
  EFI_WIN_NT_THUNK_PROTOCOL   *WinNtThunk;\r
\r
  EFI_UNICODE_STRING_TABLE    *ControllerNameTable;\r
\r
  //\r
  // UGA Private Data for GetMode ()\r
  //\r
  UINT32                      HorizontalResolution;\r
  UINT32                      VerticalResolution;\r
  UINT32                      ColorDepth;\r
  UINT32                      RefreshRate;\r
\r
  //\r
  // UGA Private Data knowing when to start hardware\r
  //\r
  BOOLEAN                     HardwareNeedsStarting;\r
\r
  CHAR16                      *WindowName;\r
  CHAR16                      Buffer[160];\r
\r
  HANDLE                      ThreadInited; // Semaphore\r
  HANDLE                      ThreadHandle; // Thread\r
  DWORD                       ThreadId;\r
\r
  HWND                        WindowHandle;\r
  WNDCLASSEX                  WindowsClass;\r
\r
  //\r
  // This screen is used to redraw the scree when windows events happen. It's\r
  // updated in the main thread and displayed in the windows thread.\r
  //\r
  BITMAPV4HEADER              *VirtualScreenInfo;\r
  RGBQUAD                     *VirtualScreen;\r
\r
  EFI_UGA_PIXEL               *FillLine;\r
\r
  //\r
  // Keyboard Queue used by Simple Text In. WinProc thread adds, and main\r
  // thread removes.\r
  //\r
  CRITICAL_SECTION            QCriticalSection;\r
  UGA_QUEUE_FIXED             Queue;\r
\r
} UGA_PRIVATE_DATA;\r
\r
#define UGA_DRAW_PRIVATE_DATA_FROM_THIS(a)  \\r
         CR(a, UGA_PRIVATE_DATA, UgaDraw, UGA_PRIVATE_DATA_SIGNATURE)\r
\r
#define UGA_PRIVATE_DATA_FROM_TEXT_IN_THIS(a)  \\r
         CR(a, UGA_PRIVATE_DATA, SimpleTextIn, UGA_PRIVATE_DATA_SIGNATURE)\r
\r
//\r
// Global Protocol Variables\r
//\r
extern EFI_DRIVER_BINDING_PROTOCOL  gWinNtUgaDriverBinding;\r
extern EFI_COMPONENT_NAME_PROTOCOL  gWinNtUgaComponentName;\r
\r
//\r
// Uga Hardware abstraction internal worker functions\r
//\r
EFI_STATUS\r
WinNtUgaSupported (\r
  IN  EFI_WIN_NT_IO_PROTOCOL  *WinNtIo\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  WinNtIo - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
WinNtUgaConstructor (\r
  IN  UGA_PRIVATE_DATA    *Private\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  Private - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
WinNtUgaDestructor (\r
  IN  UGA_PRIVATE_DATA    *Private\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  Private - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
//\r
// EFI 1.1 driver model prototypes for Win NT UGA\r
//\r
\r
EFI_STATUS\r
EFIAPI\r
WinNtUgaInitialize (\r
  IN EFI_HANDLE            ImageHandle,\r
  IN EFI_SYSTEM_TABLE      *SystemTable\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  ImageHandle - TODO: add argument description\r
  SystemTable - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
WinNtUgaDriverBindingSupported (\r
  IN  EFI_DRIVER_BINDING_PROTOCOL     *This,\r
  IN  EFI_HANDLE                      Handle,\r
  IN  EFI_DEVICE_PATH_PROTOCOL        *RemainingDevicePath\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  This                - TODO: add argument description\r
  Handle              - TODO: add argument description\r
  RemainingDevicePath - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
WinNtUgaDriverBindingStart (\r
  IN  EFI_DRIVER_BINDING_PROTOCOL     *This,\r
  IN  EFI_HANDLE                      Handle,\r
  IN  EFI_DEVICE_PATH_PROTOCOL        *RemainingDevicePath\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  This                - TODO: add argument description\r
  Handle              - TODO: add argument description\r
  RemainingDevicePath - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
WinNtUgaDriverBindingStop (\r
  IN  EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN  EFI_HANDLE                   Handle,\r
  IN  UINTN                        NumberOfChildren,\r
  IN  EFI_HANDLE                   *ChildHandleBuffer\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  This              - TODO: add argument description\r
  Handle            - TODO: add argument description\r
  NumberOfChildren  - TODO: add argument description\r
  ChildHandleBuffer - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
UgaPrivateAddQ (\r
  IN  UGA_PRIVATE_DATA    *Private,\r
  IN  EFI_INPUT_KEY       Key\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  Private - TODO: add argument description\r
  Key     - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
WinNtUgaInitializeSimpleTextInForWindow (\r
  IN  UGA_PRIVATE_DATA    *Private\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  Private - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
WinNtUgaDestroySimpleTextInForWindow (\r
  IN  UGA_PRIVATE_DATA    *Private\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  Private - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
UINTN\r
Atoi (\r
  IN  CHAR16  *String\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  String  - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
#endif\r