TianoCore EDK2 master
Loading...
Searching...
No Matches
UefiShellDebug1CommandsLib.h File Reference

Go to the source code of this file.

Functions

EFI_STATUS GetSystemConfigurationTable (IN EFI_GUID *TableGuid, IN OUT VOID **Table)
 
SHELL_STATUS EFIAPI ShellCommandRunSetSize (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)
 
SHELL_STATUS EFIAPI ShellCommandRunComp (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)
 
SHELL_STATUS EFIAPI ShellCommandRunMode (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)
 
SHELL_STATUS EFIAPI ShellCommandRunMemMap (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)
 
SHELL_STATUS EFIAPI ShellCommandRunEfiCompress (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)
 
SHELL_STATUS EFIAPI ShellCommandRunEfiDecompress (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)
 
SHELL_STATUS EFIAPI ShellCommandRunDmem (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)
 
SHELL_STATUS EFIAPI ShellCommandRunLoadPciRom (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)
 
SHELL_STATUS EFIAPI ShellCommandRunMm (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)
 
SHELL_STATUS EFIAPI ShellCommandRunSetVar (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)
 
SHELL_STATUS EFIAPI ShellCommandRunSerMode (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)
 
SHELL_STATUS EFIAPI ShellCommandRunBcfg (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)
 
SHELL_STATUS EFIAPI ShellCommandRunPci (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)
 
SHELL_STATUS EFIAPI ShellCommandRunSmbiosView (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)
 
SHELL_STATUS EFIAPI ShellCommandRunDmpStore (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)
 
SHELL_STATUS EFIAPI ShellCommandRunDblk (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)
 
SHELL_STATUS EFIAPI ShellCommandRunEdit (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)
 
SHELL_STATUS EFIAPI ShellCommandRunHexEdit (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)
 
VOID EditorClearLine (IN UINTN Row, IN UINTN LastCol, IN UINTN LastRow)
 
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

EFI_HII_HANDLE gShellDebug1HiiHandle
 

Detailed Description

Main file for NULL named library for Profile1 shell command functions.

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

Definition in file UefiShellDebug1CommandsLib.h.

Function Documentation

◆ EditGetDefaultFileName()

CHAR16 * EditGetDefaultFileName ( IN CONST CHAR16 *  Extension)

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

Parameters
[in]ExtensionThe file extension.
Return values
NULLSomething 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]RowThe row number to be cleared ( start from 1 )
[in]LastColThe last printable column.
[in]LastRowThe 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]TableGuidA pointer to the table's GUID type.
[in,out]TableOn exit, a pointer to a system configuration table.
Return values
EFI_SUCCESSA configuration table matching TableGuid was found.
EFI_NOT_FOUNDA 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
NameThe filename to check.
Return values
TRUEThe filename is ok.
FALSEThe filename is not ok.

Definition at line 219 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]FileNameThe filename of the file to open.
[out]BufferUpon successful return, the pointer to the address of the allocated buffer.
[out]BufferSizeIf not NULL, then the pointer to the size of the allocated buffer.
[out]ReadOnlyUpon successful return TRUE if the file is read only. FALSE otherwise.
Return values
EFI_NOT_FOUNDThe filename did not represent a file in the file system. Directories cannot be read with this method.
EFI_SUCCESSThe file was read into the buffer.
EFI_OUT_OF_RESOURCESA memory allocation failed.
EFI_LOAD_ERRORThe file read operation failed.
EFI_INVALID_PARAMETERA parameter was invalid.
EFI_INVALID_PARAMETERFileName was NULL.
EFI_INVALID_PARAMETERFileName was a directory.

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

Parameters
[in]FileNameThe filename of the file to open.
[out]BufferUpon successful return, the pointer to the address of the allocated buffer.
[out]BufferSizeIf not NULL, then the pointer to the size of the allocated buffer.
[out]ReadOnlyUpon successful return TRUE if the file is read only. FALSE otherwise.
Return values
EFI_NOT_FOUNDThe filename did not represent a file in the file system.
EFI_SUCCESSThe file was read into the buffer.
EFI_OUT_OF_RESOURCESA memory allocation failed.
EFI_LOAD_ERRORThe file read operation failed.
EFI_INVALID_PARAMETERA parameter was invalid.
EFI_INVALID_PARAMETERFileName was NULL.
EFI_INVALID_PARAMETERFileName was a directory.

Definition at line 317 of file UefiShellDebug1CommandsLib.c.

◆ ShellCommandRunBcfg()

SHELL_STATUS EFIAPI ShellCommandRunBcfg ( IN EFI_HANDLE  ImageHandle,
IN EFI_SYSTEM_TABLE SystemTable 
)

Function for 'bcfg' command.

Parameters
[in]ImageHandleHandle to the Image (NULL if Internal).
[in]SystemTablePointer to the System Table (NULL if Internal).

Definition at line 1521 of file UefiShellBcfgCommandLib.c.

◆ ShellCommandRunComp()

SHELL_STATUS EFIAPI ShellCommandRunComp ( IN EFI_HANDLE  ImageHandle,
IN EFI_SYSTEM_TABLE SystemTable 
)

Function for 'comp' command.

Parameters
[in]ImageHandleHandle to the Image (NULL if Internal).
[in]SystemTablePointer to the System Table (NULL if Internal).

Definition at line 202 of file Comp.c.

◆ ShellCommandRunDblk()

SHELL_STATUS EFIAPI ShellCommandRunDblk ( IN EFI_HANDLE  ImageHandle,
IN EFI_SYSTEM_TABLE SystemTable 
)

Function for 'dblk' command.

Parameters
[in]ImageHandleHandle to the Image (NULL if Internal).
[in]SystemTablePointer to the System Table (NULL if Internal).

Definition at line 98 of file Dblk.c.

◆ ShellCommandRunDmem()

SHELL_STATUS EFIAPI ShellCommandRunDmem ( IN EFI_HANDLE  ImageHandle,
IN EFI_SYSTEM_TABLE SystemTable 
)

Function for 'dmem' command.

Parameters
[in]ImageHandleHandle to the Image (NULL if Internal).
[in]SystemTablePointer to the System Table (NULL if Internal).

Definition at line 359 of file Dmem.c.

◆ ShellCommandRunDmpStore()

SHELL_STATUS EFIAPI ShellCommandRunDmpStore ( IN EFI_HANDLE  ImageHandle,
IN EFI_SYSTEM_TABLE SystemTable 
)

Function for 'dmpstore' command.

Parameters
[in]ImageHandleHandle to the Image (NULL if Internal).
[in]SystemTablePointer to the System Table (NULL if Internal).

Definition at line 747 of file DmpStore.c.

◆ ShellCommandRunEdit()

SHELL_STATUS EFIAPI ShellCommandRunEdit ( IN EFI_HANDLE  ImageHandle,
IN EFI_SYSTEM_TABLE SystemTable 
)

Function for 'edit' command.

Parameters
[in]ImageHandleHandle to the Image (NULL if Internal).
[in]SystemTablePointer to the System Table (NULL if Internal).

Definition at line 21 of file Edit.c.

◆ ShellCommandRunEfiCompress()

SHELL_STATUS EFIAPI ShellCommandRunEfiCompress ( IN EFI_HANDLE  ImageHandle,
IN EFI_SYSTEM_TABLE SystemTable 
)

Function for 'compress' command.

Parameters
[in]ImageHandleHandle to the Image (NULL if Internal).
[in]SystemTablePointer to the System Table (NULL if Internal).

Definition at line 21 of file EfiCompress.c.

◆ ShellCommandRunEfiDecompress()

SHELL_STATUS EFIAPI ShellCommandRunEfiDecompress ( IN EFI_HANDLE  ImageHandle,
IN EFI_SYSTEM_TABLE SystemTable 
)

Function for 'decompress' command.

Parameters
[in]ImageHandleHandle to the Image (NULL if Internal).
[in]SystemTablePointer to the System Table (NULL if Internal).

Definition at line 21 of file EfiDecompress.c.

◆ ShellCommandRunHexEdit()

SHELL_STATUS EFIAPI ShellCommandRunHexEdit ( IN EFI_HANDLE  ImageHandle,
IN EFI_SYSTEM_TABLE SystemTable 
)

Function for 'hexedit' command.

Parameters
[in]ImageHandleHandle to the Image (NULL if Internal).
[in]SystemTablePointer to the System Table (NULL if Internal).

Definition at line 31 of file HexEdit.c.

◆ ShellCommandRunLoadPciRom()

SHELL_STATUS EFIAPI ShellCommandRunLoadPciRom ( IN EFI_HANDLE  ImageHandle,
IN EFI_SYSTEM_TABLE SystemTable 
)

Function for 'loadpcirom' command.

Parameters
[in]ImageHandleHandle to the Image (NULL if Internal).
[in]SystemTablePointer to the System Table (NULL if Internal).

Definition at line 60 of file LoadPciRom.c.

◆ ShellCommandRunMemMap()

SHELL_STATUS EFIAPI ShellCommandRunMemMap ( IN EFI_HANDLE  ImageHandle,
IN EFI_SYSTEM_TABLE SystemTable 
)

Function for 'memmap' command.

Parameters
[in]ImageHandleHandle to the Image (NULL if Internal).
[in]SystemTablePointer to the System Table (NULL if Internal).

Definition at line 110 of file MemMap.c.

◆ ShellCommandRunMm()

SHELL_STATUS EFIAPI ShellCommandRunMm ( IN EFI_HANDLE  ImageHandle,
IN EFI_SYSTEM_TABLE SystemTable 
)

Function for 'mm' command.

Parameters
[in]ImageHandleHandle to the Image (NULL if Internal).
[in]SystemTablePointer to the System Table (NULL if Internal).

Definition at line 417 of file Mm.c.

◆ ShellCommandRunMode()

SHELL_STATUS EFIAPI ShellCommandRunMode ( IN EFI_HANDLE  ImageHandle,
IN EFI_SYSTEM_TABLE SystemTable 
)

Function for 'mode' command.

Parameters
[in]ImageHandleHandle to the Image (NULL if Internal).
[in]SystemTablePointer to the System Table (NULL if Internal).

Definition at line 20 of file Mode.c.

◆ ShellCommandRunPci()

SHELL_STATUS EFIAPI ShellCommandRunPci ( IN EFI_HANDLE  ImageHandle,
IN EFI_SYSTEM_TABLE SystemTable 
)

Function for 'pci' command.

Parameters
[in]ImageHandleHandle to the Image (NULL if Internal).
[in]SystemTablePointer to the System Table (NULL if Internal).

Definition at line 2435 of file Pci.c.

◆ ShellCommandRunSerMode()

SHELL_STATUS EFIAPI ShellCommandRunSerMode ( IN EFI_HANDLE  ImageHandle,
IN EFI_SYSTEM_TABLE SystemTable 
)

Function for 'sermode' command.

Parameters
[in]ImageHandleHandle to the Image (NULL if Internal).
[in]SystemTablePointer to the System Table (NULL if Internal).

Definition at line 164 of file SerMode.c.

◆ ShellCommandRunSetSize()

SHELL_STATUS EFIAPI ShellCommandRunSetSize ( IN EFI_HANDLE  ImageHandle,
IN EFI_SYSTEM_TABLE SystemTable 
)

Function for 'setsize' command.

Parameters
[in]ImageHandleHandle to the Image (NULL if Internal).
[in]SystemTablePointer to the System Table (NULL if Internal).

Definition at line 20 of file SetSize.c.

◆ ShellCommandRunSetVar()

SHELL_STATUS EFIAPI ShellCommandRunSetVar ( IN EFI_HANDLE  ImageHandle,
IN EFI_SYSTEM_TABLE SystemTable 
)

Function for 'setvar' command.

Parameters
[in]ImageHandleHandle to the Image (NULL if Internal).
[in]SystemTablePointer to the System Table (NULL if Internal).

Definition at line 352 of file SetVar.c.

◆ ShellCommandRunSmbiosView()

SHELL_STATUS EFIAPI ShellCommandRunSmbiosView ( IN EFI_HANDLE  ImageHandle,
IN EFI_SYSTEM_TABLE SystemTable 
)

Function for 'smbiosview' command.

Parameters
[in]ImageHandleHandle to the Image (NULL if Internal).
[in]SystemTablePointer to the System Table (NULL if Internal).

Definition at line 43 of file SmbiosView.c.

Variable Documentation

◆ gShellDebug1HiiHandle

EFI_HII_HANDLE gShellDebug1HiiHandle
extern

Definition at line 13 of file UefiShellDebug1CommandsLib.c.