/** @file\r
Main file for NULL named library for debug1 profile shell command functions.\r
\r
- Copyright (c) 2010 - 2017, Intel Corporation. All rights reserved.<BR>\r
- This program and the accompanying materials\r
- are licensed and made available under the terms and conditions of the BSD License\r
- which accompanies this distribution. The full text of the license may be found at\r
- http://opensource.org/licenses/bsd-license.php\r
-\r
- THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
- WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+ Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.<BR>\r
+ SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "UefiShellDebug1CommandsLib.h"\r
#include <Library/BcfgCommandLib.h>\r
\r
-STATIC CONST CHAR16 mFileName[] = L"Debug1Commands";\r
-EFI_HANDLE gShellDebug1HiiHandle = NULL;\r
+STATIC CONST CHAR16 mFileName[] = L"Debug1Commands";\r
+EFI_HII_HANDLE gShellDebug1HiiHandle = NULL;\r
\r
/**\r
Gets the debug file name. This will be used if HII is not working.\r
@retval NULL No file is available.\r
@return The NULL-terminated filename to get help from.\r
**/\r
-CONST CHAR16*\r
+CONST CHAR16 *\r
EFIAPI\r
ShellCommandGetManFileNameDebug1 (\r
VOID\r
//\r
// check our bit of the profiles mask\r
//\r
- if ((PcdGet8(PcdShellProfileMask) & BIT1) == 0) {\r
+ if ((PcdGet8 (PcdShellProfileMask) & BIT1) == 0) {\r
return (EFI_SUCCESS);\r
}\r
\r
//\r
// install our shell command handlers that are always installed\r
//\r
- ShellCommandRegisterCommandName(L"setsize", ShellCommandRunSetSize , ShellCommandGetManFileNameDebug1, 0, L"Debug1", TRUE, gShellDebug1HiiHandle, STRING_TOKEN(STR_GET_HELP_SETSIZE) );\r
- ShellCommandRegisterCommandName(L"comp", ShellCommandRunComp , ShellCommandGetManFileNameDebug1, 0, L"Debug1", TRUE, gShellDebug1HiiHandle, STRING_TOKEN(STR_GET_HELP_COMP) );\r
- ShellCommandRegisterCommandName(L"mode", ShellCommandRunMode , ShellCommandGetManFileNameDebug1, 0, L"Debug1", TRUE, gShellDebug1HiiHandle, STRING_TOKEN(STR_GET_HELP_MODE) );\r
- ShellCommandRegisterCommandName(L"memmap", ShellCommandRunMemMap , ShellCommandGetManFileNameDebug1, 0, L"Debug1", TRUE, gShellDebug1HiiHandle, STRING_TOKEN(STR_GET_HELP_MEMMAP) );\r
- ShellCommandRegisterCommandName(L"eficompress", ShellCommandRunEfiCompress , ShellCommandGetManFileNameDebug1, 0, L"Debug1", TRUE, gShellDebug1HiiHandle, STRING_TOKEN(STR_GET_HELP_EFICOMPRESS) );\r
- ShellCommandRegisterCommandName(L"efidecompress", ShellCommandRunEfiDecompress , ShellCommandGetManFileNameDebug1, 0, L"Debug1", TRUE, gShellDebug1HiiHandle, STRING_TOKEN(STR_GET_HELP_EFIDCOMPRESS) );\r
- ShellCommandRegisterCommandName(L"dmem", ShellCommandRunDmem , ShellCommandGetManFileNameDebug1, 0, L"Debug1", TRUE, gShellDebug1HiiHandle, STRING_TOKEN(STR_GET_HELP_DMEM) );\r
- ShellCommandRegisterCommandName(L"loadpcirom", ShellCommandRunLoadPciRom , ShellCommandGetManFileNameDebug1, 0, L"Debug1", TRUE, gShellDebug1HiiHandle, STRING_TOKEN(STR_GET_HELP_LOAD_PCI_ROM) );\r
- ShellCommandRegisterCommandName(L"mm", ShellCommandRunMm , ShellCommandGetManFileNameDebug1, 0, L"Debug1", TRUE, gShellDebug1HiiHandle, STRING_TOKEN(STR_GET_HELP_MM) );\r
- ShellCommandRegisterCommandName(L"setvar", ShellCommandRunSetVar , ShellCommandGetManFileNameDebug1, 0, L"Debug1", TRUE, gShellDebug1HiiHandle, STRING_TOKEN(STR_GET_HELP_SETVAR) );\r
- ShellCommandRegisterCommandName(L"sermode", ShellCommandRunSerMode , ShellCommandGetManFileNameDebug1, 0, L"Debug1", TRUE, gShellDebug1HiiHandle, STRING_TOKEN(STR_GET_HELP_SERMODE) );\r
- ShellCommandRegisterCommandName(L"pci", ShellCommandRunPci , ShellCommandGetManFileNameDebug1, 0, L"Debug1", TRUE, gShellDebug1HiiHandle, STRING_TOKEN(STR_GET_HELP_PCI) );\r
- ShellCommandRegisterCommandName(L"smbiosview", ShellCommandRunSmbiosView , ShellCommandGetManFileNameDebug1, 0, L"Debug1", TRUE, gShellDebug1HiiHandle, STRING_TOKEN(STR_GET_HELP_SMBIOSVIEW) );\r
- ShellCommandRegisterCommandName(L"dmpstore", ShellCommandRunDmpStore , ShellCommandGetManFileNameDebug1, 0, L"Debug1", TRUE, gShellDebug1HiiHandle, STRING_TOKEN(STR_GET_HELP_DMPSTORE) );\r
- ShellCommandRegisterCommandName(L"dblk", ShellCommandRunDblk , ShellCommandGetManFileNameDebug1, 0, L"Debug1", TRUE, gShellDebug1HiiHandle, STRING_TOKEN(STR_GET_HELP_DBLK) );\r
- ShellCommandRegisterCommandName(L"edit", ShellCommandRunEdit , ShellCommandGetManFileNameDebug1, 0, L"Debug1", TRUE, gShellDebug1HiiHandle, STRING_TOKEN(STR_GET_HELP_EDIT) );\r
- ShellCommandRegisterCommandName(L"hexedit", ShellCommandRunHexEdit , ShellCommandGetManFileNameDebug1, 0, L"Debug1", TRUE, gShellDebug1HiiHandle, STRING_TOKEN(STR_GET_HELP_HEXEDIT) );\r
-\r
- ShellCommandRegisterAlias(L"dmem", L"mem");\r
-\r
- BcfgLibraryRegisterBcfgCommand(ImageHandle, SystemTable, L"Debug1");\r
+ ShellCommandRegisterCommandName (L"setsize", ShellCommandRunSetSize, ShellCommandGetManFileNameDebug1, 0, L"Debug1", TRUE, gShellDebug1HiiHandle, STRING_TOKEN (STR_GET_HELP_SETSIZE));\r
+ ShellCommandRegisterCommandName (L"comp", ShellCommandRunComp, ShellCommandGetManFileNameDebug1, 0, L"Debug1", TRUE, gShellDebug1HiiHandle, STRING_TOKEN (STR_GET_HELP_COMP));\r
+ ShellCommandRegisterCommandName (L"mode", ShellCommandRunMode, ShellCommandGetManFileNameDebug1, 0, L"Debug1", TRUE, gShellDebug1HiiHandle, STRING_TOKEN (STR_GET_HELP_MODE));\r
+ ShellCommandRegisterCommandName (L"memmap", ShellCommandRunMemMap, ShellCommandGetManFileNameDebug1, 0, L"Debug1", TRUE, gShellDebug1HiiHandle, STRING_TOKEN (STR_GET_HELP_MEMMAP));\r
+ ShellCommandRegisterCommandName (L"eficompress", ShellCommandRunEfiCompress, ShellCommandGetManFileNameDebug1, 0, L"Debug1", TRUE, gShellDebug1HiiHandle, STRING_TOKEN (STR_GET_HELP_EFICOMPRESS));\r
+ ShellCommandRegisterCommandName (L"efidecompress", ShellCommandRunEfiDecompress, ShellCommandGetManFileNameDebug1, 0, L"Debug1", TRUE, gShellDebug1HiiHandle, STRING_TOKEN (STR_GET_HELP_EFIDCOMPRESS));\r
+ ShellCommandRegisterCommandName (L"dmem", ShellCommandRunDmem, ShellCommandGetManFileNameDebug1, 0, L"Debug1", TRUE, gShellDebug1HiiHandle, STRING_TOKEN (STR_GET_HELP_DMEM));\r
+ ShellCommandRegisterCommandName (L"loadpcirom", ShellCommandRunLoadPciRom, ShellCommandGetManFileNameDebug1, 0, L"Debug1", TRUE, gShellDebug1HiiHandle, STRING_TOKEN (STR_GET_HELP_LOAD_PCI_ROM));\r
+ ShellCommandRegisterCommandName (L"mm", ShellCommandRunMm, ShellCommandGetManFileNameDebug1, 0, L"Debug1", TRUE, gShellDebug1HiiHandle, STRING_TOKEN (STR_GET_HELP_MM));\r
+ ShellCommandRegisterCommandName (L"setvar", ShellCommandRunSetVar, ShellCommandGetManFileNameDebug1, 0, L"Debug1", TRUE, gShellDebug1HiiHandle, STRING_TOKEN (STR_GET_HELP_SETVAR));\r
+ ShellCommandRegisterCommandName (L"sermode", ShellCommandRunSerMode, ShellCommandGetManFileNameDebug1, 0, L"Debug1", TRUE, gShellDebug1HiiHandle, STRING_TOKEN (STR_GET_HELP_SERMODE));\r
+ ShellCommandRegisterCommandName (L"pci", ShellCommandRunPci, ShellCommandGetManFileNameDebug1, 0, L"Debug1", TRUE, gShellDebug1HiiHandle, STRING_TOKEN (STR_GET_HELP_PCI));\r
+ ShellCommandRegisterCommandName (L"smbiosview", ShellCommandRunSmbiosView, ShellCommandGetManFileNameDebug1, 0, L"Debug1", TRUE, gShellDebug1HiiHandle, STRING_TOKEN (STR_GET_HELP_SMBIOSVIEW));\r
+ ShellCommandRegisterCommandName (L"dmpstore", ShellCommandRunDmpStore, ShellCommandGetManFileNameDebug1, 0, L"Debug1", TRUE, gShellDebug1HiiHandle, STRING_TOKEN (STR_GET_HELP_DMPSTORE));\r
+ ShellCommandRegisterCommandName (L"dblk", ShellCommandRunDblk, ShellCommandGetManFileNameDebug1, 0, L"Debug1", TRUE, gShellDebug1HiiHandle, STRING_TOKEN (STR_GET_HELP_DBLK));\r
+ ShellCommandRegisterCommandName (L"edit", ShellCommandRunEdit, ShellCommandGetManFileNameDebug1, 0, L"Debug1", TRUE, gShellDebug1HiiHandle, STRING_TOKEN (STR_GET_HELP_EDIT));\r
+ ShellCommandRegisterCommandName (L"hexedit", ShellCommandRunHexEdit, ShellCommandGetManFileNameDebug1, 0, L"Debug1", TRUE, gShellDebug1HiiHandle, STRING_TOKEN (STR_GET_HELP_HEXEDIT));\r
+\r
+ ShellCommandRegisterAlias (L"dmem", L"mem");\r
+\r
+ BcfgLibraryRegisterBcfgCommand (ImageHandle, SystemTable, L"Debug1");\r
\r
return (EFI_SUCCESS);\r
}\r
)\r
{\r
if (gShellDebug1HiiHandle != NULL) {\r
- HiiRemovePackages(gShellDebug1HiiHandle);\r
+ HiiRemovePackages (gShellDebug1HiiHandle);\r
}\r
\r
- BcfgLibraryUnregisterBcfgCommand(ImageHandle, SystemTable);\r
+ BcfgLibraryUnregisterBcfgCommand (ImageHandle, SystemTable);\r
return (EFI_SUCCESS);\r
}\r
\r
-/**\r
- Convert a Unicode character to upper case only if\r
- it maps to a valid small-case ASCII character.\r
-\r
- This internal function only deal with Unicode character\r
- which maps to a valid small-case ASCII character, i.e.\r
- L'a' to L'z'. For other Unicode character, the input character\r
- is returned directly.\r
-\r
- @param Char The character to convert.\r
-\r
- @retval LowerCharacter If the Char is with range L'a' to L'z'.\r
- @retval Unchanged Otherwise.\r
-\r
-\r
- //Stolen from MdePkg Baselib\r
-**/\r
-CHAR16\r
-CharToUpper (\r
- IN CHAR16 Char\r
- )\r
-{\r
- if (Char >= L'a' && Char <= L'z') {\r
- return (CHAR16) (Char - (L'a' - L'A'));\r
- }\r
-\r
- return Char;\r
-}\r
-\r
/**\r
Function returns a system configuration table that is stored in the\r
EFI System Table based on the provided GUID.\r
**/\r
EFI_STATUS\r
GetSystemConfigurationTable (\r
- IN EFI_GUID *TableGuid,\r
- IN OUT VOID **Table\r
+ IN EFI_GUID *TableGuid,\r
+ IN OUT VOID **Table\r
)\r
{\r
- UINTN Index;\r
+ UINTN Index;\r
+\r
ASSERT (Table != NULL);\r
\r
for (Index = 0; Index < gST->NumberOfTableEntries; Index++) {\r
\r
/**\r
Clear the line at the specified Row.\r
- \r
+\r
@param[in] Row The row number to be cleared ( start from 1 )\r
@param[in] LastCol The last printable column.\r
@param[in] LastRow The last printable row.\r
**/\r
VOID\r
EditorClearLine (\r
- IN UINTN Row,\r
- IN UINTN LastCol,\r
- IN UINTN LastRow\r
+ IN UINTN Row,\r
+ IN UINTN LastCol,\r
+ IN UINTN LastRow\r
)\r
{\r
- CHAR16 Line[200];\r
+ UINTN Col;\r
+ CHAR16 Line[200];\r
\r
if (Row == 0) {\r
Row = 1;\r
\r
//\r
// prepare a blank line\r
+ // If max column is larger, split to multiple prints.\r
//\r
- SetMem16(Line, LastCol*sizeof(CHAR16), L' ');\r
+ SetMem16 (Line, sizeof (Line), L' ');\r
+ Line[ARRAY_SIZE (Line) - 1] = CHAR_NULL;\r
+\r
+ for (Col = 1; Col <= LastCol; Col += ARRAY_SIZE (Line) - 1) {\r
+ if (Col + ARRAY_SIZE (Line) - 1 > LastCol) {\r
+ if (Row == LastRow) {\r
+ //\r
+ // if CHAR_NULL is still at position LastCol, it will cause first line error\r
+ //\r
+ Line[(LastCol - 1) % (ARRAY_SIZE (Line) - 1)] = CHAR_NULL;\r
+ } else {\r
+ Line[LastCol % (ARRAY_SIZE (Line) - 1)] = CHAR_NULL;\r
+ }\r
+ }\r
\r
- if (Row == LastRow) {\r
//\r
- // if CHAR_NULL is still at position 80, it will cause first line error\r
+ // print out the blank line\r
//\r
- Line[LastCol - 1] = CHAR_NULL;\r
- } else {\r
- Line[LastCol] = CHAR_NULL;\r
+ ShellPrintEx ((INT32)Col - 1, (INT32)Row - 1, Line);\r
}\r
-\r
- //\r
- // print out the blank line\r
- //\r
- ShellPrintEx (0, ((INT32)Row) - 1, Line);\r
}\r
\r
/**\r
**/\r
BOOLEAN\r
IsValidFileNameChar (\r
- IN CONST CHAR16 Ch\r
+ IN CONST CHAR16 Ch\r
)\r
{\r
//\r
// See if there are any illegal characters within the name\r
//\r
- if (Ch < 0x20 || Ch == L'\"' || Ch == L'*' || Ch == L'/' || Ch == L'<' || Ch == L'>' || Ch == L'?' || Ch == L'|') {\r
+ if ((Ch < 0x20) || (Ch == L'\"') || (Ch == L'*') || (Ch == L'/') || (Ch == L'<') || (Ch == L'>') || (Ch == L'?') || (Ch == L'|')) {\r
return FALSE;\r
}\r
\r
\r
/**\r
Check if file name has illegal characters.\r
- \r
+\r
@param Name The filename to check.\r
\r
@retval TRUE The filename is ok.\r
**/\r
BOOLEAN\r
IsValidFileName (\r
- IN CONST CHAR16 *Name\r
+ IN CONST CHAR16 *Name\r
)\r
{\r
-\r
- UINTN Index;\r
- UINTN Len;\r
+ UINTN Index;\r
+ UINTN Len;\r
\r
//\r
// check the length of Name\r
//\r
for (Len = 0, Index = StrLen (Name) - 1; Index + 1 != 0; Index--, Len++) {\r
- if (Name[Index] == '\\' || Name[Index] == ':') {\r
+ if ((Name[Index] == '\\') || (Name[Index] == ':')) {\r
break;\r
}\r
}\r
\r
- if (Len == 0 || Len > 255) {\r
+ if ((Len == 0) || (Len > 255)) {\r
return FALSE;\r
}\r
+\r
//\r
// check whether any char in Name not appears in valid file name char\r
//\r
**/\r
CHAR16 *\r
EditGetDefaultFileName (\r
- IN CONST CHAR16 *Extension\r
+ IN CONST CHAR16 *Extension\r
)\r
{\r
- EFI_STATUS Status;\r
- UINTN Suffix;\r
- CHAR16 *FileNameTmp;\r
+ EFI_STATUS Status;\r
+ UINTN Suffix;\r
+ CHAR16 *FileNameTmp;\r
\r
- Suffix = 0;\r
+ Suffix = 0;\r
\r
do {\r
FileNameTmp = CatSPrint (NULL, L"NewFile%d.%s", Suffix, Extension);\r
}\r
\r
/**\r
- Read a file into an allocated buffer. The buffer is the responsibility \r
+ Read a file into an allocated buffer. The buffer is the responsibility\r
of the caller to free.\r
\r
@param[in] FileName The filename of the file to open.\r
- @param[out] Buffer Upon successful return, the pointer to the \r
- address of the allocated buffer. \r
+ @param[out] Buffer Upon successful return, the pointer to the\r
+ address of the allocated buffer.\r
@param[out] BufferSize If not NULL, then the pointer to the size\r
of the allocated buffer.\r
@param[out] ReadOnly Upon successful return TRUE if the file is\r
read only. FALSE otherwise.\r
\r
- @retval EFI_NOT_FOUND The filename did not represent a file in the \r
+ @retval EFI_NOT_FOUND The filename did not represent a file in the\r
file system.\r
@retval EFI_SUCCESS The file was read into the buffer.\r
@retval EFI_OUT_OF_RESOURCES A memory allocation failed.\r
**/\r
EFI_STATUS\r
ReadFileIntoBuffer (\r
- IN CONST CHAR16 *FileName,\r
- OUT VOID **Buffer,\r
- OUT UINTN *BufferSize OPTIONAL,\r
- OUT BOOLEAN *ReadOnly\r
+ IN CONST CHAR16 *FileName,\r
+ OUT VOID **Buffer,\r
+ OUT UINTN *BufferSize OPTIONAL,\r
+ OUT BOOLEAN *ReadOnly\r
)\r
{\r
- VOID *InternalBuffer;\r
- UINTN FileSize;\r
- SHELL_FILE_HANDLE FileHandle;\r
- BOOLEAN CreateFile;\r
- EFI_STATUS Status;\r
- EFI_FILE_INFO *Info;\r
-\r
- InternalBuffer = NULL;\r
- FileSize = 0;\r
- FileHandle = NULL;\r
- CreateFile = FALSE;\r
- Status = EFI_SUCCESS;\r
- Info = NULL;\r
-\r
- if (FileName == NULL || Buffer == NULL || ReadOnly == NULL) {\r
+ VOID *InternalBuffer;\r
+ UINTN FileSize;\r
+ SHELL_FILE_HANDLE FileHandle;\r
+ BOOLEAN CreateFile;\r
+ EFI_STATUS Status;\r
+ EFI_FILE_INFO *Info;\r
+\r
+ InternalBuffer = NULL;\r
+ FileSize = 0;\r
+ FileHandle = NULL;\r
+ CreateFile = FALSE;\r
+ Status = EFI_SUCCESS;\r
+ Info = NULL;\r
+\r
+ if ((FileName == NULL) || (Buffer == NULL) || (ReadOnly == NULL)) {\r
return (EFI_INVALID_PARAMETER);\r
}\r
\r
//\r
Status = ShellOpenFileByName (FileName, &FileHandle, EFI_FILE_MODE_READ, 0);\r
\r
- if (!EFI_ERROR(Status)) {\r
- ASSERT(CreateFile == FALSE);\r
+ if (!EFI_ERROR (Status)) {\r
+ ASSERT (CreateFile == FALSE);\r
if (FileHandle == NULL) {\r
return EFI_LOAD_ERROR;\r
}\r
\r
- Info = ShellGetFileInfo(FileHandle);\r
- \r
+ Info = ShellGetFileInfo (FileHandle);\r
+\r
if (Info->Attribute & EFI_FILE_DIRECTORY) {\r
FreePool (Info);\r
return EFI_INVALID_PARAMETER;\r
} else {\r
*ReadOnly = FALSE;\r
}\r
+\r
//\r
// get file size\r
//\r
- FileSize = (UINTN) Info->FileSize;\r
+ FileSize = (UINTN)Info->FileSize;\r
\r
FreePool (Info);\r
} else if (Status == EFI_NOT_FOUND) {\r
if (Status == EFI_WARN_DELETE_FAILURE) {\r
Status = EFI_ACCESS_DENIED;\r
}\r
+\r
if (EFI_ERROR (Status)) {\r
return Status;\r
}\r
}\r
+\r
//\r
// file doesn't exist, so set CreateFile to TRUE and can't be read-only\r
//\r
if (InternalBuffer == NULL) {\r
return EFI_OUT_OF_RESOURCES;\r
}\r
+\r
//\r
// read file into InternalBuffer\r
//\r
Status = ShellReadFile (FileHandle, &FileSize, InternalBuffer);\r
- ShellCloseFile(&FileHandle);\r
+ ShellCloseFile (&FileHandle);\r
FileHandle = NULL;\r
if (EFI_ERROR (Status)) {\r
SHELL_FREE_NON_NULL (InternalBuffer);\r
return EFI_LOAD_ERROR;\r
}\r
}\r
+\r
*Buffer = InternalBuffer;\r
if (BufferSize != NULL) {\r
*BufferSize = FileSize;\r
}\r
- return (EFI_SUCCESS);\r
\r
+ return (EFI_SUCCESS);\r
}\r
projects / mirror_edk2.git / blobdiff