EdbSupportUI.c File Reference

#include "Edb.h"

Go to the source code of this file.

Functions
VOID EFIAPI	SetCursorPosition (IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *ConOut, IN UINTN Column, IN INTN Row, IN UINTN LineLength, IN UINTN TotalRow, IN CHAR16 *Str, IN UINTN StrPos, IN UINTN Len)
EFI_STATUS EFIAPI	WaitForSingleEvent (IN EFI_EVENT Event, IN UINT64 Timeout OPTIONAL)
VOID EFIAPI	ConMoveCursorBackward (IN UINTN LineLength, IN OUT UINTN *Column, IN OUT UINTN *Row)
VOID EFIAPI	ConMoveCursorForward (IN UINTN LineLength, IN UINTN TotalRow, IN OUT UINTN *Column, IN OUT UINTN *Row)
VOID EFIAPI	Input (IN CHAR16 *Prompt OPTIONAL, OUT CHAR16 *InStr, IN UINTN StrLength)
BOOLEAN EFIAPI	SetPageBreak (VOID)
UINTN EFIAPI	EDBPrint (IN CONST CHAR16 *Format,...)
UINTN EFIAPI	EDBSPrint (OUT CHAR16 *Buffer, IN INTN BufferSize, IN CONST CHAR16 *Format,...)
UINTN EFIAPI	EDBSPrintWithOffset (OUT CHAR16 *Buffer, IN INTN BufferSize, IN UINTN Offset, IN CONST CHAR16 *Format,...)

Variables
CHAR16	mBackupSpace [EFI_DEBUG_INPUS_BUFFER_SIZE]
CHAR16	mInputBufferHistory [EFI_DEBUG_INPUS_BUFFER_SIZE]

Detailed Description

Copyright (c) 2007, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file EdbSupportUI.c.

Function Documentation

ConMoveCursorBackward()

VOID EFIAPI ConMoveCursorBackward	(	IN UINTN	LineLength,
		IN OUT UINTN *	Column,
		IN OUT UINTN *	Row
	)

Move the cursor position one character backward.

Parameters

LineLength	Length of a line. Get it by calling QueryMode
Column	Current column of the cursor position
Row	Current row of the cursor position

Definition at line 113 of file EdbSupportUI.c.

ConMoveCursorForward()

VOID EFIAPI ConMoveCursorForward	(	IN UINTN	LineLength,
		IN UINTN	TotalRow,
		IN OUT UINTN *	Column,
		IN OUT UINTN *	Row
	)

Move the cursor position one character backward.

Parameters

LineLength	Length of a line. Get it by calling QueryMode
TotalRow	Total row of a screen, get by calling QueryMode
Column	Current column of the cursor position
Row	Current row of the cursor position

Definition at line 151 of file EdbSupportUI.c.

EDBPrint()

UINTN EFIAPI EDBPrint	(	IN CONST CHAR16 *	Format,
			...
	)

Print a Unicode string to the output device.

Parameters

Format	A Null-terminated Unicode format string.
...	The variable argument list that contains pointers to Null- terminated Unicode strings to be printed

Definition at line 683 of file EdbSupportUI.c.

EDBSPrint()

UINTN EFIAPI EDBSPrint	(	OUT CHAR16 *	Buffer,
		IN INTN	BufferSize,
		IN CONST CHAR16 *	Format,
			...
	)

Print a Unicode string to the output buffer.

Parameters

Buffer	A pointer to the output buffer for the produced Null-terminated Unicode string.
BufferSize	The size, in bytes, of the output buffer specified by StartOfBuffer.
Format	A Null-terminated Unicode format string.
...	The variable argument list that contains pointers to Null- terminated Unicode strings to be printed

Definition at line 719 of file EdbSupportUI.c.

EDBSPrintWithOffset()

UINTN EFIAPI EDBSPrintWithOffset	(	OUT CHAR16 *	Buffer,
		IN INTN	BufferSize,
		IN UINTN	Offset,
		IN CONST CHAR16 *	Format,
			...
	)

Print a Unicode string to the output buffer with specified offset..

Parameters

Buffer	A pointer to the output buffer for the produced Null-terminated Unicode string.
BufferSize	The size, in bytes, of the output buffer specified by StartOfBuffer.
Offset	The offset of the buffer.
Format	A Null-terminated Unicode format string.
...	The variable argument list that contains pointers to Null- terminated Unicode strings to be printed

Definition at line 752 of file EdbSupportUI.c.

Input()

VOID EFIAPI Input	(	IN CHAR16 *Prompt	OPTIONAL,
		OUT CHAR16 *	InStr,
		IN UINTN	StrLength
	)

Get user input.

Parameters

Prompt	The prompt string.
InStr	Point to the input string.
StrLength	The max length of string user can input.

Definition at line 187 of file EdbSupportUI.c.

SetCursorPosition()

VOID EFIAPI SetCursorPosition	(	IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *	ConOut,
		IN UINTN	Column,
		IN INTN	Row,
		IN UINTN	LineLength,
		IN UINTN	TotalRow,
		IN CHAR16 *	Str,
		IN UINTN	StrPos,
		IN UINTN	Len
	)

Set the current coordinates of the cursor position.

Parameters

ConOut	Point to EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.
Column	The position to set the cursor to.
Row	The position to set the cursor to.
LineLength	Length of a line.
TotalRow	Total row of a screen.
Str	Point to the string.
StrPos	The position of the string.
Len	The length of the string.

Definition at line 563 of file EdbSupportUI.c.

SetPageBreak()

BOOLEAN EFIAPI SetPageBreak

(

VOID

)

SetPageBreak.

Definition at line 605 of file EdbSupportUI.c.

WaitForSingleEvent()

EFI_STATUS EFIAPI WaitForSingleEvent	(	IN EFI_EVENT	Event,
		IN UINT64 Timeout	OPTIONAL
	)

Function waits for a given event to fire, or for an optional timeout to expire.

Parameters

Event	- The event to wait for
Timeout	- An optional timeout value in 100 ns units.

Return values

EFI_SUCCESS	- Event fired before Timeout expired.
EFI_TIME_OUT	- Timout expired before Event fired..

Definition at line 50 of file EdbSupportUI.c.

Variable Documentation

mBackupSpace

CHAR16 mBackupSpace[EFI_DEBUG_INPUS_BUFFER_SIZE]

Definition at line 173 of file EdbSupportUI.c.

mInputBufferHistory

CHAR16 mInputBufferHistory[EFI_DEBUG_INPUS_BUFFER_SIZE]

Definition at line 174 of file EdbSupportUI.c.