SimpleTextInOut.c File Reference

#include <PiDxe.h>
#include <Library/UefiLib.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/BaseLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/DebugLib.h>
#include <Library/SerialPortLib.h>
#include <Library/PcdLib.h>
#include <Protocol/SerialIo.h>
#include <Protocol/SimpleTextIn.h>
#include <Protocol/SimpleTextOut.h>
#include <Protocol/DevicePath.h>

Go to the source code of this file.

Data Structures
struct	SIMPLE_TEXT_OUT_DEVICE_PATH

Macros
#define	MODE0_COLUMN_COUNT   80
#define	MODE0_ROW_COUNT   25

Functions
EFI_STATUS EFIAPI	TextInReset (IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *This, IN BOOLEAN ExtendedVerification)
EFI_STATUS EFIAPI	ReadKeyStroke (IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *This, OUT EFI_INPUT_KEY *Key)
EFI_STATUS EFIAPI	TextOutReset (IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This, IN BOOLEAN ExtendedVerification)
CHAR8 *EFIAPI	SafeUnicodeStrToAsciiStr (IN CONST CHAR16 *Source, OUT CHAR8 *Destination)
EFI_STATUS EFIAPI	OutputString (IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This, IN CHAR16 *String)
EFI_STATUS EFIAPI	TestString (IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This, IN CHAR16 *String)
EFI_STATUS EFIAPI	QueryMode (IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This, IN UINTN ModeNumber, OUT UINTN *Columns, OUT UINTN *Rows)
EFI_STATUS EFIAPI	SetMode (IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This, IN UINTN ModeNumber)
EFI_STATUS EFIAPI	SetAttribute (IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This, IN UINTN Attribute)
EFI_STATUS EFIAPI	ClearScreen (IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This)
EFI_STATUS EFIAPI	SetCursorPosition (IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This, IN UINTN Column, IN UINTN Row)
EFI_STATUS EFIAPI	EnableCursor (IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This, IN BOOLEAN Enable)
BOOLEAN	TextOutIsValidAscii (IN CHAR16 Ascii)
BOOLEAN	TextOutIsValidEfiCntlChar (IN CHAR16 Char)
VOID EFIAPI	WaitForKeyEvent (IN EFI_EVENT Event, IN VOID *Context)
EFI_STATUS EFIAPI	SimpleTextInOutEntryPoint (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)

Variables
EFI_SIMPLE_TEXT_INPUT_PROTOCOL	mSimpleTextIn
EFI_SIMPLE_TEXT_OUTPUT_MODE	mSimpleTextOutMode
EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL	mSimpleTextOut
EFI_HANDLE	mInstallHandle = NULL
SIMPLE_TEXT_OUT_DEVICE_PATH	mDevicePath

Detailed Description

Simple Console that sits on a SerialLib.

Copyright (c) 2008 - 2009, Apple Inc. All rights reserved.

SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file SimpleTextInOut.c.

Macro Definition Documentation

MODE0_COLUMN_COUNT

#define MODE0_COLUMN_COUNT   80

Definition at line 68 of file SimpleTextInOut.c.

MODE0_ROW_COUNT

#define MODE0_ROW_COUNT   25

Definition at line 69 of file SimpleTextInOut.c.

Function Documentation

ClearScreen()

EFI_STATUS EFIAPI ClearScreen

(

IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *

This

)

Definition at line 642 of file SimpleTextInOut.c.

EnableCursor()

EFI_STATUS EFIAPI EnableCursor	(	IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *	This,
		IN BOOLEAN	Enable
	)

Definition at line 689 of file SimpleTextInOut.c.

OutputString()

EFI_STATUS EFIAPI OutputString	(	IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *	This,
		IN CHAR16 *	String
	)

Definition at line 493 of file SimpleTextInOut.c.

QueryMode()

EFI_STATUS EFIAPI QueryMode	(	IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *	This,
		IN UINTN	ModeNumber,
		OUT UINTN *	Columns,
		OUT UINTN *	Rows
	)

Definition at line 593 of file SimpleTextInOut.c.

ReadKeyStroke()

EFI_STATUS EFIAPI ReadKeyStroke	(	IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *	This,
		OUT EFI_INPUT_KEY *	Key
	)

Definition at line 271 of file SimpleTextInOut.c.

SafeUnicodeStrToAsciiStr()

CHAR8 *EFIAPI SafeUnicodeStrToAsciiStr	(	IN CONST CHAR16 *	Source,
		OUT CHAR8 *	Destination
	)

Definition at line 439 of file SimpleTextInOut.c.

SetAttribute()

EFI_STATUS EFIAPI SetAttribute	(	IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *	This,
		IN UINTN	Attribute
	)

Definition at line 631 of file SimpleTextInOut.c.

SetCursorPosition()

EFI_STATUS EFIAPI SetCursorPosition	(	IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *	This,
		IN UINTN	Column,
		IN UINTN	Row
	)

Definition at line 654 of file SimpleTextInOut.c.

SetMode()

EFI_STATUS EFIAPI SetMode	(	IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *	This,
		IN UINTN	ModeNumber
	)

Definition at line 615 of file SimpleTextInOut.c.

SimpleTextInOutEntryPoint()

EFI_STATUS EFIAPI SimpleTextInOutEntryPoint	(	IN EFI_HANDLE	ImageHandle,
		IN EFI_SYSTEM_TABLE *	SystemTable
	)

Definition at line 703 of file SimpleTextInOut.c.

TestString()

EFI_STATUS EFIAPI TestString	(	IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *	This,
		IN CHAR16 *	String
	)

Definition at line 574 of file SimpleTextInOut.c.

TextInReset()

EFI_STATUS EFIAPI TextInReset	(	IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *	This,
		IN BOOLEAN	ExtendedVerification
	)

Definition at line 261 of file SimpleTextInOut.c.

TextOutIsValidAscii()

BOOLEAN TextOutIsValidAscii

(

IN CHAR16

Ascii

)

Definition at line 213 of file SimpleTextInOut.c.

TextOutIsValidEfiCntlChar()

BOOLEAN TextOutIsValidEfiCntlChar

(

IN CHAR16

Char

)

Definition at line 228 of file SimpleTextInOut.c.

TextOutReset()

EFI_STATUS EFIAPI TextOutReset	(	IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *	This,
		IN BOOLEAN	ExtendedVerification
	)

Definition at line 420 of file SimpleTextInOut.c.

WaitForKeyEvent()

VOID EFIAPI WaitForKeyEvent	(	IN EFI_EVENT	Event,
		IN VOID *	Context
	)

Definition at line 249 of file SimpleTextInOut.c.

Variable Documentation

mDevicePath

SIMPLE_TEXT_OUT_DEVICE_PATH mDevicePath

Initial value:

= {
  {
    { HARDWARE_DEVICE_PATH,  HW_VENDOR_DP,                   { sizeof (VENDOR_DEVICE_PATH),       0 }
    },
    EFI_CALLER_ID_GUID
  },
  {
    { MESSAGING_DEVICE_PATH, MSG_UART_DP,                    { sizeof (UART_DEVICE_PATH),         0 }
    },
    0,                                      
    FixedPcdGet64 (PcdUartDefaultBaudRate), 
    FixedPcdGet8 (PcdUartDefaultDataBits),  
    FixedPcdGet8 (PcdUartDefaultParity),    
    FixedPcdGet8 (PcdUartDefaultStopBits)   
  },
  { END_DEVICE_PATH_TYPE,  END_ENTIRE_DEVICE_PATH_SUBTYPE, { sizeof (EFI_DEVICE_PATH_PROTOCOL), 0 }
  }
}

Definition at line 193 of file SimpleTextInOut.c.

mInstallHandle

EFI_HANDLE mInstallHandle = NULL

Definition at line 185 of file SimpleTextInOut.c.

mSimpleTextIn

EFI_SIMPLE_TEXT_INPUT_PROTOCOL mSimpleTextIn

Initial value:

= {
  TextInReset,
  ReadKeyStroke,
  NULL
}

Definition at line 157 of file SimpleTextInOut.c.

mSimpleTextOut

EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL mSimpleTextOut

Initial value:

= {
  TextOutReset,
  OutputString,
  TestString,
  QueryMode,
  SetMode,
  SetAttribute,
  ClearScreen,
  SetCursorPosition,
  EnableCursor,
  &mSimpleTextOutMode
}

Definition at line 172 of file SimpleTextInOut.c.

mSimpleTextOutMode

EFI_SIMPLE_TEXT_OUTPUT_MODE mSimpleTextOutMode

Initial value:

= {
  1,
  0,
  EFI_TEXT_ATTR (EFI_LIGHTGRAY,EFI_BLACK),
  0,
  0,
  TRUE
}

Definition at line 163 of file SimpleTextInOut.c.