#include "UefiShellDebug1CommandsLib.h"
#include <Library/BcfgCommandLib.h>

Functions
CONST CHAR16 *EFIAPI	ShellCommandGetManFileNameDebug1 (VOID)

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

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

EFI_STATUS	GetSystemConfigurationTable (IN EFI_GUID TableGuid, IN OUT VOID *Table)

VOID	EditorClearLine (IN UINTN Row, IN UINTN LastCol, IN UINTN LastRow)

BOOLEAN	IsValidFileNameChar (IN CONST CHAR16 Ch)

BOOLEAN	IsValidFileName (IN CONST CHAR16 *Name)

CHAR16 *	EditGetDefaultFileName (IN CONST CHAR16 *Extension)

EFI_STATUS	ReadFileIntoBuffer (IN CONST CHAR16 FileName, OUT VOID Buffer, OUT UINTN BufferSize OPTIONAL, OUT BOOLEAN *ReadOnly)

Variables
STATIC CONST CHAR16	mFileName [] = L"Debug1Commands"

EFI_HII_HANDLE	gShellDebug1HiiHandle = NULL

Detailed Description

Main file for NULL named library for debug1 profile shell command functions.

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

Definition in file UefiShellDebug1CommandsLib.c.

Function Documentation

◆ EditGetDefaultFileName()

CHAR16 * EditGetDefaultFileName ( IN CONST CHAR16 * Extension )

Find a filename that is valid (not taken) with the given extension.

Parameters

[in] Extension The file extension.

Return values

NULL	Something went wrong.

Returns: the valid filename.

Definition at line 260 of file UefiShellDebug1CommandsLib.c.

◆ EditorClearLine()

VOID EditorClearLine	(	IN UINTN	Row,
		IN UINTN	LastCol,
		IN UINTN	LastRow
	)

Clear the line at the specified Row.

Parameters

[in]	Row	The row number to be cleared ( start from 1 )
[in]	LastCol	The last printable column.
[in]	LastRow	The last printable row.

Definition at line 148 of file UefiShellDebug1CommandsLib.c.

◆ GetSystemConfigurationTable()

EFI_STATUS GetSystemConfigurationTable	(	IN EFI_GUID *	TableGuid,
		IN OUT VOID **	Table
	)

Function returns a system configuration table that is stored in the EFI System Table based on the provided GUID.

Parameters

[in]	TableGuid	A pointer to the table's GUID type.
[in,out]	Table	On exit, a pointer to a system configuration table.

Return values

EFI_SUCCESS	A configuration table matching TableGuid was found.
EFI_NOT_FOUND	A configuration table matching TableGuid was not found.

Definition at line 121 of file UefiShellDebug1CommandsLib.c.

◆ IsValidFileName()

BOOLEAN IsValidFileName ( IN CONST CHAR16 * Name )

Check if file name has illegal characters.

Parameters

Name	The filename to check.

Return values

TRUE	The filename is ok.
FALSE	The filename is not ok.

Definition at line 219 of file UefiShellDebug1CommandsLib.c.

◆ IsValidFileNameChar()

BOOLEAN IsValidFileNameChar ( IN CONST CHAR16 Ch )

Determine if the character is valid for a filename.

Parameters

[in] Ch The character to test.

Return values

TRUE	The character is valid.
FALSE	The character is not valid.

Definition at line 196 of file UefiShellDebug1CommandsLib.c.

◆ ReadFileIntoBuffer()

EFI_STATUS ReadFileIntoBuffer	(	IN CONST CHAR16 *	FileName,
		OUT VOID **	Buffer,
		OUT UINTN *BufferSize	OPTIONAL,
		OUT BOOLEAN *	ReadOnly
	)

Read a file into an allocated buffer. The buffer is the responsibility of the caller to free.

Parameters

[in]	FileName	The filename of the file to open.
[out]	Buffer	Upon successful return, the pointer to the address of the allocated buffer.
[out]	BufferSize	If not NULL, then the pointer to the size of the allocated buffer.
[out]	ReadOnly	Upon successful return TRUE if the file is read only. FALSE otherwise.

Return values

EFI_NOT_FOUND	The filename did not represent a file in the file system.
EFI_SUCCESS	The file was read into the buffer.
EFI_OUT_OF_RESOURCES	A memory allocation failed.
EFI_LOAD_ERROR	The file read operation failed.
EFI_INVALID_PARAMETER	A parameter was invalid.
EFI_INVALID_PARAMETER	FileName was NULL.
EFI_INVALID_PARAMETER	FileName was a directory.

Definition at line 317 of file UefiShellDebug1CommandsLib.c.

◆ ShellCommandGetManFileNameDebug1()

CONST CHAR16 *EFIAPI ShellCommandGetManFileNameDebug1 ( VOID )

Gets the debug file name. This will be used if HII is not working.

Return values

NULL	No file is available.

Returns: The NULL-terminated filename to get help from.

Definition at line 23 of file UefiShellDebug1CommandsLib.c.

◆ UefiShellDebug1CommandsLibConstructor()

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

Constructor for the Shell Debug1 Commands library.

Parameters

ImageHandle	the image handle of the process
SystemTable	the EFI System Table pointer

Return values

EFI_SUCCESS	the shell command handlers were installed successfully
EFI_UNSUPPORTED	the shell level required was not found.

Definition at line 41 of file UefiShellDebug1CommandsLib.c.

◆ UefiShellDebug1CommandsLibDestructor()

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

Destructor for the library. free any resources.

Parameters

ImageHandle	The image handle of the process.
SystemTable	The EFI System Table pointer.

Definition at line 97 of file UefiShellDebug1CommandsLib.c.

Variable Documentation

◆ gShellDebug1HiiHandle

EFI_HII_HANDLE gShellDebug1HiiHandle = NULL

Definition at line 13 of file UefiShellDebug1CommandsLib.c.

◆ mFileName

STATIC CONST CHAR16 mFileName[] = L"Debug1Commands"

Definition at line 12 of file UefiShellDebug1CommandsLib.c.

Functions

Variables

Detailed Description

Function Documentation

◆ EditGetDefaultFileName()

◆ EditorClearLine()

◆ GetSystemConfigurationTable()

◆ IsValidFileName()

◆ IsValidFileNameChar()

◆ ReadFileIntoBuffer()

◆ ShellCommandGetManFileNameDebug1()

◆ UefiShellDebug1CommandsLibConstructor()

◆ UefiShellDebug1CommandsLibDestructor()

Variable Documentation

◆ gShellDebug1HiiHandle

◆ mFileName