OcConsoleLib.h

Go to the documentation of this file.

 
#ifndef OC_CONSOLE_LIB_H
#define OC_CONSOLE_LIB_H
 
#include <Protocol/AppleFramebufferInfo.h>
#include <Protocol/AppleEg2Info.h>
#include <Protocol/ConsoleControl.h>
#include <Protocol/GraphicsOutput.h>
 
#include <Library/OcBootManagementLib.h>
#include <Library/OcFileLib.h>
 
typedef enum {
  OcConsoleRendererBuiltinGraphics,
  OcConsoleRendererBuiltinText,
  OcConsoleRendererSystemGraphics,
  OcConsoleRendererSystemText,
  OcConsoleRendererSystemGeneric
} OC_CONSOLE_RENDERER;
 
#define OC_CONSOLE_MARK_UNCONTROLLED  L"MarkUncontrolled"
 
#define ISO_CHAR_WIDTH   (8u)
#define ISO_CHAR_HEIGHT  (16u)
 
#define OC_CONSOLE_FONT_FALLBACK_CHAR  (L'_')
 
typedef struct _OC_CONSOLE_FONT_PAGE {
  UINT8      *Glyphs;
  UINT8      *GlyphOffsets;
  UINT8      CharMin;
  UINT8      CharMax;
  UINT8      FontHead : 4;
  UINT8      FontTail : 4;
  BOOLEAN    LeftToRight;
} OC_CONSOLE_FONT_PAGE;
 
typedef struct _OC_CONSOLE_FONT {
  OC_CONSOLE_FONT_PAGE    *Pages;
  UINT16                  *PageOffsets;
  UINT16                  PageMin;
  UINT16                  PageMax;
} OC_CONSOLE_FONT;
 
typedef struct _OC_CONSOLE_FONT_RANGE {
  CHAR16    Start;
  UINT16    Length;
} OC_CONSOLE_FONT_RANGE;
 
extern OC_CONSOLE_FONT  gDefaultConsoleFont;
 
extern OC_CONSOLE_FONT_RANGE  gEfiRequiredUnicodeChars[];
 
extern OC_CONSOLE_FONT_RANGE  gExtendedUnicodeChars[];
 
VOID
OcSetupConsole (
  IN EFI_CONSOLE_CONTROL_SCREEN_MODE  InitialMode,
  IN OC_CONSOLE_RENDERER              Renderer,
  IN OC_STORAGE_CONTEXT               *Storage  OPTIONAL,
  IN CONST CHAR8                      *Font     OPTIONAL,
  IN BOOLEAN                          IgnoreTextOutput,
  IN BOOLEAN                          SanitiseClearScreen,
  IN BOOLEAN                          ClearScreenOnModeSwitch,
  IN BOOLEAN                          ReplaceTabWithSpace,
  IN UINT32                           Width,
  IN UINT32                           Height
  );
 
EFI_CONSOLE_CONTROL_SCREEN_MODE
OcConsoleControlSetMode (
  IN EFI_CONSOLE_CONTROL_SCREEN_MODE  Mode
  );
 
EFI_CONSOLE_CONTROL_SCREEN_MODE
OcConsoleControlGetMode (
  VOID
  );
 
VOID
OcParseScreenResolution (
  IN  CONST CHAR8  *String,
  OUT UINT32       *Width,
  OUT UINT32       *Height,
  OUT UINT32       *Bpp,
  OUT BOOLEAN      *Max
  );
 
VOID
OcParseConsoleMode (
  IN  CONST CHAR8  *String,
  OUT UINT32       *Width,
  OUT UINT32       *Height,
  OUT BOOLEAN      *Max
  );
 
EFI_STATUS
OcSetGopBurstMode (
  VOID
  );
 
EFI_STATUS
OcGopModeBytesPerPixel (
  IN  EFI_GRAPHICS_OUTPUT_PROTOCOL_MODE  *Mode,
  OUT UINTN                              *BytesPerPixel
  );
 
EFI_STATUS
OcGopModeSafeFrameBufferSize (
  IN  EFI_GRAPHICS_OUTPUT_PROTOCOL_MODE  *Mode,
  OUT UINTN                              *FrameBufferSize
  );
 
EFI_STATUS
OcSetConsoleResolution (
  IN  UINT32   Width  OPTIONAL,
  IN  UINT32   Height OPTIONAL,
  IN  UINT32   Bpp    OPTIONAL,
  IN  BOOLEAN  Force
  );
 
EFI_STATUS
OcSetConsoleMode (
  IN  UINT32  Width,
  IN  UINT32  Height
  );
 
EFI_STATUS
OcProvideConsoleGop (
  IN BOOLEAN  Route
  );
 
VOID
OcReconnectConsole (
  VOID
  );
 
EFI_STATUS
OcUseDirectGop (
  IN INT32  CacheType
  );
 
EFI_SYSTEM_TABLE *
AllocateNullTextOutSystemTable (
  IN EFI_SYSTEM_TABLE  *SystemTable
  );
 
EFI_STATUS
OcProvideUgaPassThrough (
  VOID
  );
 
EFI_STATUS
OcProvideGopPassThrough (
  IN BOOLEAN  ForAll
  );
 
APPLE_FRAMEBUFFER_INFO_PROTOCOL *
OcAppleFbInfoInstallProtocol (
  IN BOOLEAN  Reinstall
  );
 
APPLE_EG2_INFO_PROTOCOL *
OcAppleEg2InfoInstallProtocol (
  IN BOOLEAN  Reinstall
  );
 
EFI_STATUS
OcGopInfoDump (
  IN EFI_FILE_PROTOCOL  *Root
  );
 
#endif // OC_CONSOLE_LIB_H