Updated modules to not depend on the IntelFrameworkPkg.

[mirror_edk2.git] / MdeModulePkg / Universal / Console / GraphicsConsoleDxe / GraphicsConsole.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
  GraphicsConsole.h\r
\r
Abstract:\r
\r
  \r
Revision History\r
\r
--*/\r
\r
#ifndef _GRAPHICS_CONSOLE_H\r
#define _GRAPHICS_CONSOLE_H\r
\r
#include <PiDxe.h>\r
#include <Protocol/FrameworkHii.h>\r
#include <Protocol/SimpleTextOut.h>\r
#include <Protocol/GraphicsOutput.h>\r
#include <Protocol/UgaDraw.h>\r
#include <Protocol/DevicePath.h>\r
#include <Library/DebugLib.h>\r
#include <Library/UefiDriverEntryPoint.h>\r
#include <Library/UefiLib.h>\r
#include <Library/HiiLibFramework.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
\r
\r
extern EFI_COMPONENT_NAME_PROTOCOL  gGraphicsConsoleComponentName;\r
\r
//\r
// EFI Component Name Functions\r
//\r
EFI_STATUS\r
EFIAPI\r
GraphicsConsoleComponentNameGetDriverName (\r
  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,\r
  IN  CHAR8                        *Language,\r
  OUT CHAR16                       **DriverName\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
GraphicsConsoleComponentNameGetControllerName (\r
  IN  EFI_COMPONENT_NAME_PROTOCOL                     *This,\r
  IN  EFI_HANDLE                                      ControllerHandle,\r
  IN  EFI_HANDLE                                      ChildHandle        OPTIONAL,\r
  IN  CHAR8                                           *Language,\r
  OUT CHAR16                                          **ControllerName\r
  );\r
\r
//\r
// Glyph database\r
//\r
#define GLYPH_WIDTH   8\r
#define GLYPH_HEIGHT  19\r
\r
typedef union {\r
  EFI_NARROW_GLYPH  NarrowGlyph;\r
  EFI_WIDE_GLYPH    WideGlyph;\r
} GLYPH_UNION;\r
\r
extern EFI_NARROW_GLYPH UsStdNarrowGlyphData[];\r
extern EFI_WIDE_GLYPH   UsStdWideGlyphData[];\r
\r
//\r
// Device Structure\r
//\r
#define GRAPHICS_CONSOLE_DEV_SIGNATURE  EFI_SIGNATURE_32 ('g', 's', 't', 'o')\r
\r
typedef struct {\r
  UINTN   Columns;\r
  UINTN   Rows;\r
  INTN    DeltaX;\r
  INTN    DeltaY;\r
  UINT32  GopWidth;\r
  UINT32  GopHeight;\r
  UINT32  GopModeNumber;\r
} GRAPHICS_CONSOLE_MODE_DATA;\r
\r
#define GRAPHICS_MAX_MODE 3\r
\r
typedef struct {\r
  UINTN                            Signature;\r
  EFI_GRAPHICS_OUTPUT_PROTOCOL     *GraphicsOutput;\r
  EFI_UGA_DRAW_PROTOCOL            *UgaDraw;\r
  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  SimpleTextOutput;\r
  EFI_SIMPLE_TEXT_OUTPUT_MODE      SimpleTextOutputMode;\r
  GRAPHICS_CONSOLE_MODE_DATA       ModeData[GRAPHICS_MAX_MODE];\r
  EFI_GRAPHICS_OUTPUT_BLT_PIXEL    *LineBuffer;\r
  EFI_HII_HANDLE                   HiiHandle;\r
} GRAPHICS_CONSOLE_DEV;\r
\r
#define GRAPHICS_CONSOLE_CON_OUT_DEV_FROM_THIS(a) \\r
  CR (a, GRAPHICS_CONSOLE_DEV, SimpleTextOutput, GRAPHICS_CONSOLE_DEV_SIGNATURE)\r
\r
//\r
// Global Variables\r
//\r
extern EFI_DRIVER_BINDING_PROTOCOL  gGraphicsConsoleDriverBinding;\r
\r
//\r
// Prototypes\r
//\r
UINTN\r
ReturnNarrowFontSize (\r
  VOID\r
  );\r
\r
UINTN\r
ReturnWideFontSize (\r
  VOID\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
GraphicsConsoleConOutReset (\r
  IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL    *This,\r
  IN  BOOLEAN                            ExtendedVerification\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
GraphicsConsoleConOutOutputString (\r
  IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,\r
  IN  CHAR16                           *WString\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
GraphicsConsoleConOutTestString (\r
  IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,\r
  IN  CHAR16                           *WString\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
GraphicsConsoleConOutQueryMode (\r
  IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,\r
  IN  UINTN                            ModeNumber,\r
  OUT UINTN                            *Columns,\r
  OUT UINTN                            *Rows\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
GraphicsConsoleConOutSetMode (\r
  IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,\r
  IN  UINTN                            ModeNumber\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
GraphicsConsoleConOutSetAttribute (\r
  IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,\r
  IN  UINTN                            Attribute\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
GraphicsConsoleConOutClearScreen (\r
  IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
GraphicsConsoleConOutSetCursorPosition (\r
  IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,\r
  IN  UINTN                            Column,\r
  IN  UINTN                            Row\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
GraphicsConsoleConOutEnableCursor (\r
  IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,\r
  IN  BOOLEAN                          Visible\r
  );\r
\r
EFI_STATUS\r
EfiLocateHiiProtocol (\r
  VOID\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
GraphicsConsoleControllerDriverSupported (\r
  IN EFI_DRIVER_BINDING_PROTOCOL    *This,\r
  IN EFI_HANDLE                     Controller,\r
  IN EFI_DEVICE_PATH_PROTOCOL       *RemainingDevicePath\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
GraphicsConsoleControllerDriverStart (\r
  IN EFI_DRIVER_BINDING_PROTOCOL    *This,\r
  IN EFI_HANDLE                     Controller,\r
  IN EFI_DEVICE_PATH_PROTOCOL       *RemainingDevicePath\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
GraphicsConsoleControllerDriverStop (\r
  IN  EFI_DRIVER_BINDING_PROTOCOL    *This,\r
  IN  EFI_HANDLE                     Controller,\r
  IN  UINTN                          NumberOfChildren,\r
  IN  EFI_HANDLE                     *ChildHandleBuffer\r
  );\r
\r
#endif\r