/** @file | |
Main file for NULL named library for Profile1 shell command functions. | |
Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.<BR> | |
SPDX-License-Identifier: BSD-2-Clause-Patent | |
**/ | |
#ifndef _UEFI_SHELL_DEBUG1_COMMANDS_LIB_H_ | |
#define _UEFI_SHELL_DEBUG1_COMMANDS_LIB_H_ | |
#include <Uefi.h> | |
#include <Guid/GlobalVariable.h> | |
#include <Guid/ConsoleInDevice.h> | |
#include <Guid/ConsoleOutDevice.h> | |
#include <Guid/FileSystemInfo.h> | |
#include <Guid/ShellLibHiiGuid.h> | |
#include <Protocol/Shell.h> | |
#include <Protocol/ShellParameters.h> | |
#include <Protocol/DevicePath.h> | |
#include <Protocol/LoadedImage.h> | |
#include <Protocol/UnicodeCollation.h> | |
#include <Protocol/DriverDiagnostics2.h> | |
#include <Protocol/DriverDiagnostics.h> | |
#include <Protocol/PlatformDriverOverride.h> | |
#include <Protocol/BusSpecificDriverOverride.h> | |
#include <Protocol/PlatformToDriverConfiguration.h> | |
#include <Protocol/DriverSupportedEfiVersion.h> | |
#include <Protocol/DriverFamilyOverride.h> | |
#include <Protocol/DriverHealth.h> | |
#include <Protocol/SimplePointer.h> | |
#include <Protocol/CpuIo2.h> | |
#include <Protocol/PciRootBridgeIo.h> | |
#include <Library/BaseLib.h> | |
#include <Library/BaseMemoryLib.h> | |
#include <Library/DebugLib.h> | |
#include <Library/MemoryAllocationLib.h> | |
#include <Library/PcdLib.h> | |
#include <Library/ShellCommandLib.h> | |
#include <Library/ShellLib.h> | |
#include <Library/SortLib.h> | |
#include <Library/UefiLib.h> | |
#include <Library/UefiRuntimeServicesTableLib.h> | |
#include <Library/UefiBootServicesTableLib.h> | |
#include <Library/HiiLib.h> | |
#include <Library/FileHandleLib.h> | |
#include <Library/DevicePathLib.h> | |
#include <Library/PrintLib.h> | |
#include <Library/HandleParsingLib.h> | |
extern EFI_HII_HANDLE gShellDebug1HiiHandle; | |
/** | |
Function returns a system configuration table that is stored in the | |
EFI System Table based on the provided GUID. | |
@param[in] TableGuid A pointer to the table's GUID type. | |
@param[in, out] Table On exit, a pointer to a system configuration table. | |
@retval EFI_SUCCESS A configuration table matching TableGuid was found. | |
@retval EFI_NOT_FOUND A configuration table matching TableGuid was not found. | |
**/ | |
EFI_STATUS | |
GetSystemConfigurationTable ( | |
IN EFI_GUID *TableGuid, | |
IN OUT VOID **Table | |
); | |
/** | |
Function for 'setsize' command. | |
@param[in] ImageHandle Handle to the Image (NULL if Internal). | |
@param[in] SystemTable Pointer to the System Table (NULL if Internal). | |
**/ | |
SHELL_STATUS | |
EFIAPI | |
ShellCommandRunSetSize ( | |
IN EFI_HANDLE ImageHandle, | |
IN EFI_SYSTEM_TABLE *SystemTable | |
); | |
/** | |
Function for 'comp' command. | |
@param[in] ImageHandle Handle to the Image (NULL if Internal). | |
@param[in] SystemTable Pointer to the System Table (NULL if Internal). | |
**/ | |
SHELL_STATUS | |
EFIAPI | |
ShellCommandRunComp ( | |
IN EFI_HANDLE ImageHandle, | |
IN EFI_SYSTEM_TABLE *SystemTable | |
); | |
/** | |
Function for 'mode' command. | |
@param[in] ImageHandle Handle to the Image (NULL if Internal). | |
@param[in] SystemTable Pointer to the System Table (NULL if Internal). | |
**/ | |
SHELL_STATUS | |
EFIAPI | |
ShellCommandRunMode ( | |
IN EFI_HANDLE ImageHandle, | |
IN EFI_SYSTEM_TABLE *SystemTable | |
); | |
/** | |
Function for 'memmap' command. | |
@param[in] ImageHandle Handle to the Image (NULL if Internal). | |
@param[in] SystemTable Pointer to the System Table (NULL if Internal). | |
**/ | |
SHELL_STATUS | |
EFIAPI | |
ShellCommandRunMemMap ( | |
IN EFI_HANDLE ImageHandle, | |
IN EFI_SYSTEM_TABLE *SystemTable | |
); | |
/** | |
Function for 'compress' command. | |
@param[in] ImageHandle Handle to the Image (NULL if Internal). | |
@param[in] SystemTable Pointer to the System Table (NULL if Internal). | |
**/ | |
SHELL_STATUS | |
EFIAPI | |
ShellCommandRunEfiCompress ( | |
IN EFI_HANDLE ImageHandle, | |
IN EFI_SYSTEM_TABLE *SystemTable | |
); | |
/** | |
Function for 'decompress' command. | |
@param[in] ImageHandle Handle to the Image (NULL if Internal). | |
@param[in] SystemTable Pointer to the System Table (NULL if Internal). | |
**/ | |
SHELL_STATUS | |
EFIAPI | |
ShellCommandRunEfiDecompress ( | |
IN EFI_HANDLE ImageHandle, | |
IN EFI_SYSTEM_TABLE *SystemTable | |
); | |
/** | |
Function for 'dmem' command. | |
@param[in] ImageHandle Handle to the Image (NULL if Internal). | |
@param[in] SystemTable Pointer to the System Table (NULL if Internal). | |
**/ | |
SHELL_STATUS | |
EFIAPI | |
ShellCommandRunDmem ( | |
IN EFI_HANDLE ImageHandle, | |
IN EFI_SYSTEM_TABLE *SystemTable | |
); | |
/** | |
Function for 'loadpcirom' command. | |
@param[in] ImageHandle Handle to the Image (NULL if Internal). | |
@param[in] SystemTable Pointer to the System Table (NULL if Internal). | |
**/ | |
SHELL_STATUS | |
EFIAPI | |
ShellCommandRunLoadPciRom ( | |
IN EFI_HANDLE ImageHandle, | |
IN EFI_SYSTEM_TABLE *SystemTable | |
); | |
/** | |
Function for 'mm' command. | |
@param[in] ImageHandle Handle to the Image (NULL if Internal). | |
@param[in] SystemTable Pointer to the System Table (NULL if Internal). | |
**/ | |
SHELL_STATUS | |
EFIAPI | |
ShellCommandRunMm ( | |
IN EFI_HANDLE ImageHandle, | |
IN EFI_SYSTEM_TABLE *SystemTable | |
); | |
/** | |
Function for 'setvar' command. | |
@param[in] ImageHandle Handle to the Image (NULL if Internal). | |
@param[in] SystemTable Pointer to the System Table (NULL if Internal). | |
**/ | |
SHELL_STATUS | |
EFIAPI | |
ShellCommandRunSetVar ( | |
IN EFI_HANDLE ImageHandle, | |
IN EFI_SYSTEM_TABLE *SystemTable | |
); | |
/** | |
Function for 'sermode' command. | |
@param[in] ImageHandle Handle to the Image (NULL if Internal). | |
@param[in] SystemTable Pointer to the System Table (NULL if Internal). | |
**/ | |
SHELL_STATUS | |
EFIAPI | |
ShellCommandRunSerMode ( | |
IN EFI_HANDLE ImageHandle, | |
IN EFI_SYSTEM_TABLE *SystemTable | |
); | |
/** | |
Function for 'bcfg' command. | |
@param[in] ImageHandle Handle to the Image (NULL if Internal). | |
@param[in] SystemTable Pointer to the System Table (NULL if Internal). | |
**/ | |
SHELL_STATUS | |
EFIAPI | |
ShellCommandRunBcfg ( | |
IN EFI_HANDLE ImageHandle, | |
IN EFI_SYSTEM_TABLE *SystemTable | |
); | |
/** | |
Function for 'pci' command. | |
@param[in] ImageHandle Handle to the Image (NULL if Internal). | |
@param[in] SystemTable Pointer to the System Table (NULL if Internal). | |
**/ | |
SHELL_STATUS | |
EFIAPI | |
ShellCommandRunPci ( | |
IN EFI_HANDLE ImageHandle, | |
IN EFI_SYSTEM_TABLE *SystemTable | |
); | |
/** | |
Function for 'smbiosview' command. | |
@param[in] ImageHandle Handle to the Image (NULL if Internal). | |
@param[in] SystemTable Pointer to the System Table (NULL if Internal). | |
**/ | |
SHELL_STATUS | |
EFIAPI | |
ShellCommandRunSmbiosView ( | |
IN EFI_HANDLE ImageHandle, | |
IN EFI_SYSTEM_TABLE *SystemTable | |
); | |
/** | |
Function for 'dmpstore' command. | |
@param[in] ImageHandle Handle to the Image (NULL if Internal). | |
@param[in] SystemTable Pointer to the System Table (NULL if Internal). | |
**/ | |
SHELL_STATUS | |
EFIAPI | |
ShellCommandRunDmpStore ( | |
IN EFI_HANDLE ImageHandle, | |
IN EFI_SYSTEM_TABLE *SystemTable | |
); | |
/** | |
Function for 'dblk' command. | |
@param[in] ImageHandle Handle to the Image (NULL if Internal). | |
@param[in] SystemTable Pointer to the System Table (NULL if Internal). | |
**/ | |
SHELL_STATUS | |
EFIAPI | |
ShellCommandRunDblk ( | |
IN EFI_HANDLE ImageHandle, | |
IN EFI_SYSTEM_TABLE *SystemTable | |
); | |
/** | |
Function for 'edit' command. | |
@param[in] ImageHandle Handle to the Image (NULL if Internal). | |
@param[in] SystemTable Pointer to the System Table (NULL if Internal). | |
**/ | |
SHELL_STATUS | |
EFIAPI | |
ShellCommandRunEdit ( | |
IN EFI_HANDLE ImageHandle, | |
IN EFI_SYSTEM_TABLE *SystemTable | |
); | |
/** | |
Function for 'hexedit' command. | |
@param[in] ImageHandle Handle to the Image (NULL if Internal). | |
@param[in] SystemTable Pointer to the System Table (NULL if Internal). | |
**/ | |
SHELL_STATUS | |
EFIAPI | |
ShellCommandRunHexEdit ( | |
IN EFI_HANDLE ImageHandle, | |
IN EFI_SYSTEM_TABLE *SystemTable | |
); | |
/** | |
Clear the line at the specified Row. | |
@param[in] Row The row number to be cleared ( start from 1 ) | |
@param[in] LastCol The last printable column. | |
@param[in] LastRow The last printable row. | |
**/ | |
VOID | |
EditorClearLine ( | |
IN UINTN Row, | |
IN UINTN LastCol, | |
IN UINTN LastRow | |
); | |
/** | |
Check if file name has illegal characters. | |
@param Name The filename to check. | |
@retval TRUE The filename is ok. | |
@retval FALSE The filename is not ok. | |
**/ | |
BOOLEAN | |
IsValidFileName ( | |
IN CONST CHAR16 *Name | |
); | |
/** | |
Find a filename that is valid (not taken) with the given extension. | |
@param[in] Extension The file extension. | |
@retval NULL Something went wrong. | |
@return the valid filename. | |
**/ | |
CHAR16 * | |
EditGetDefaultFileName ( | |
IN CONST CHAR16 *Extension | |
); | |
/** | |
Read a file into an allocated buffer. The buffer is the responsibility | |
of the caller to free. | |
@param[in] FileName The filename of the file to open. | |
@param[out] Buffer Upon successful return, the pointer to the | |
address of the allocated buffer. | |
@param[out] BufferSize If not NULL, then the pointer to the size | |
of the allocated buffer. | |
@param[out] ReadOnly Upon successful return TRUE if the file is | |
read only. FALSE otherwise. | |
@retval EFI_NOT_FOUND The filename did not represent a file in the | |
file system. Directories cannot be read with | |
this method. | |
@retval EFI_SUCCESS The file was read into the buffer. | |
@retval EFI_OUT_OF_RESOURCES A memory allocation failed. | |
@retval EFI_LOAD_ERROR The file read operation failed. | |
@retval EFI_INVALID_PARAMETER A parameter was invalid. | |
@retval EFI_INVALID_PARAMETER FileName was NULL. | |
@retval EFI_INVALID_PARAMETER FileName was a directory. | |
**/ | |
EFI_STATUS | |
ReadFileIntoBuffer ( | |
IN CONST CHAR16 *FileName, | |
OUT VOID **Buffer, | |
OUT UINTN *BufferSize OPTIONAL, | |
OUT BOOLEAN *ReadOnly | |
); | |
#endif |