ShellPkg: elevate DumpHex() from Debug1-internal to generic-internal

The UEFI Shell specification classifies shell commands into various shell
levels / profiles.

Currently the DumpHex() internal function is only used by commands that
belong to the Debug1 profile exclusively (i.e., they are not required to
be present in other than Debug1 profiles):
- SMBIOSVIEW
- PCI
- DMPSTORE
- DMEM
- DBLK

In the next patch, we'd like to call DumpHex() from BCFG as well. However,
BCFG is not only required to be present in the Debug1 profile; the
Install1 profile contains BCFG as well. For this reason, move DumpHex()
from UefiShellDebug1CommandsLib to the more generic UefiShellCommandLib,
which "Provides interface to shell internal functions for shell commands".
The matching header file is "ShellPkg/Include/Library/ShellCommandLib.h".

Cc: Jaben Carsey <jaben.carsey@intel.com>
Cc: Ryan Harkin <ryan.harkin@linaro.org>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Laszlo Ersek <lersek@redhat.com>
Reviewed-by: Jaben Carsey <jaben.carsey@intel.com>

git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@19717 6f19259b-4bc3-4df7-8a09-765794883524
(cherry picked from commit 3bd89603625eb451b166ee64676c2b31818d1a1f)

6 files changed, 87 insertions, 88 deletions

diff --git a/ShellPkg/Include/Library/ShellCommandLib.h b/ShellPkg/Include/Library/ShellCommandLib.h
index 53a56ae5e4..0dd66c2fbc 100644
--- a/ShellPkg/Include/Library/ShellCommandLib.h
+++ b/ShellPkg/Include/Library/ShellCommandLib.h
@@ -685,4 +685,20 @@ FreeBufferList (
   IN BUFFER_LIST *List

   );

 

+/**

+  Function printing hex output to the console.

+

+  @param[in] Indent       Number of spaces to indent.

+  @param[in] Offset       Offset to start with.

+  @param[in] DataSize     Length of data.

+  @param[in] UserData     Pointer to some data.

+**/

+VOID

+DumpHex (

+  IN UINTN        Indent,

+  IN UINTN        Offset,

+  IN UINTN        DataSize,

+  IN VOID         *UserData

+  );

+

 #endif //_SHELL_COMMAND_LIB_

diff --git a/ShellPkg/Library/UefiShellCommandLib/UefiShellCommandLib.c b/ShellPkg/Library/UefiShellCommandLib/UefiShellCommandLib.c
index ceda7ab81e..92a88d18a0 100644
--- a/ShellPkg/Library/UefiShellCommandLib/UefiShellCommandLib.c
+++ b/ShellPkg/Library/UefiShellCommandLib/UefiShellCommandLib.c
@@ -29,6 +29,25 @@ STATIC UINTN                              mFsMaxCount = 0;
 STATIC UINTN                              mBlkMaxCount = 0;

 STATIC BUFFER_LIST                        mFileHandleList;

 

+STATIC CONST CHAR8 Hex[] = {

+  '0',

+  '1',

+  '2',

+  '3',

+  '4',

+  '5',

+  '6',

+  '7',

+  '8',

+  '9',

+  'A',

+  'B',

+  'C',

+  'D',

+  'E',

+  'F'

+};

+

 // global variables required by library class.

 EFI_UNICODE_COLLATION_PROTOCOL    *gUnicodeCollation            = NULL;

 SHELL_MAP_LIST                    gShellMapList;

@@ -1673,3 +1692,53 @@ FreeBufferList (
   }

 }

 

+/**

+  Dump some hexadecimal data to the screen.

+

+  @param[in] Indent     How many spaces to indent the output.

+  @param[in] Offset     The offset of the printing.

+  @param[in] DataSize   The size in bytes of UserData.

+  @param[in] UserData   The data to print out.

+**/

+VOID

+DumpHex (

+  IN UINTN        Indent,

+  IN UINTN        Offset,

+  IN UINTN        DataSize,

+  IN VOID         *UserData

+  )

+{

+  UINT8 *Data;

+

+  CHAR8 Val[50];

+

+  CHAR8 Str[20];

+

+  UINT8 TempByte;

+  UINTN Size;

+  UINTN Index;

+

+  Data = UserData;

+  while (DataSize != 0) {

+    Size = 16;

+    if (Size > DataSize) {

+      Size = DataSize;

+    }

+

+    for (Index = 0; Index < Size; Index += 1) {

+      TempByte            = Data[Index];

+      Val[Index * 3 + 0]  = Hex[TempByte >> 4];

+      Val[Index * 3 + 1]  = Hex[TempByte & 0xF];

+      Val[Index * 3 + 2]  = (CHAR8) ((Index == 7) ? '-' : ' ');

+      Str[Index]          = (CHAR8) ((TempByte < ' ' || TempByte > 'z') ? '.' : TempByte);

+    }

+

+    Val[Index * 3]  = 0;

+    Str[Index]      = 0;

+    ShellPrintEx(-1, -1, L"%*a%08X: %-48a *%a*\r\n", Indent, "", Offset, Val, Str);

+

+    Data += Size;

+    Offset += Size;

+    DataSize -= Size;

+  }

+}

diff --git a/ShellPkg/Library/UefiShellCommandLib/UefiShellCommandLib.inf b/ShellPkg/Library/UefiShellCommandLib/UefiShellCommandLib.inf
index 1de52991bf..e111e8d56f 100644
--- a/ShellPkg/Library/UefiShellCommandLib/UefiShellCommandLib.inf
+++ b/ShellPkg/Library/UefiShellCommandLib/UefiShellCommandLib.inf
@@ -18,7 +18,7 @@
   BASE_NAME                      = UefiShellCommandLib

   FILE_GUID                      = 5C12F31F-EBAC-466e-A400-FCA8C9EA3A05

   MODULE_TYPE                    = UEFI_DRIVER

-  VERSION_STRING                 = 1.0

+  VERSION_STRING                 = 1.1

   LIBRARY_CLASS                  = ShellCommandLib|UEFI_APPLICATION UEFI_DRIVER DXE_RUNTIME_DRIVER

   CONSTRUCTOR                    = ShellCommandLibConstructor

   DESTRUCTOR                     = ShellCommandLibDestructor

diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/UefiShellDebug1CommandsLib.c b/ShellPkg/Library/UefiShellDebug1CommandsLib/UefiShellDebug1CommandsLib.c
index 5f8f8a9dd9..1814564c12 100644
--- a/ShellPkg/Library/UefiShellDebug1CommandsLib/UefiShellDebug1CommandsLib.c
+++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/UefiShellDebug1CommandsLib.c
@@ -113,76 +113,6 @@ UefiShellDebug1CommandsLibDestructor (
   return (EFI_SUCCESS);

 }

 

-STATIC CONST CHAR8 Hex[] = {

-  '0',

-  '1',

-  '2',

-  '3',

-  '4',

-  '5',

-  '6',

-  '7',

-  '8',

-  '9',

-  'A',

-  'B',

-  'C',

-  'D',

-  'E',

-  'F'

-};

-

-/**

-  Dump some hexadecimal data to the screen.

-

-  @param[in] Indent     How many spaces to indent the output.

-  @param[in] Offset     The offset of the printing.

-  @param[in] DataSize   The size in bytes of UserData.

-  @param[in] UserData   The data to print out.

-**/

-VOID

-DumpHex (

-  IN UINTN        Indent,

-  IN UINTN        Offset,

-  IN UINTN        DataSize,

-  IN VOID         *UserData

-  )

-{

-  UINT8 *Data;

-

-  CHAR8 Val[50];

-

-  CHAR8 Str[20];

-

-  UINT8 TempByte;

-  UINTN Size;

-  UINTN Index;

-

-  Data = UserData;

-  while (DataSize != 0) {

-    Size = 16;

-    if (Size > DataSize) {

-      Size = DataSize;

-    }

-

-    for (Index = 0; Index < Size; Index += 1) {

-      TempByte            = Data[Index];

-      Val[Index * 3 + 0]  = Hex[TempByte >> 4];

-      Val[Index * 3 + 1]  = Hex[TempByte & 0xF];

-      Val[Index * 3 + 2]  = (CHAR8) ((Index == 7) ? '-' : ' ');

-      Str[Index]          = (CHAR8) ((TempByte < ' ' || TempByte > 'z') ? '.' : TempByte);

-    }

-

-    Val[Index * 3]  = 0;

-    Str[Index]      = 0;

-    ShellPrintEx(-1, -1, L"%*a%08X: %-48a *%a*\r\n", Indent, "", Offset, Val, Str);

-

-    Data += Size;

-    Offset += Size;

-    DataSize -= Size;

-  }

-}

-

 /**

   Convert a Unicode character to upper case only if

   it maps to a valid small-case ASCII character.

diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/UefiShellDebug1CommandsLib.h b/ShellPkg/Library/UefiShellDebug1CommandsLib/UefiShellDebug1CommandsLib.h
index ec15155a07..6e018a6a81 100644
--- a/ShellPkg/Library/UefiShellDebug1CommandsLib/UefiShellDebug1CommandsLib.h
+++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/UefiShellDebug1CommandsLib.h
@@ -62,22 +62,6 @@
 extern        EFI_HANDLE                        gShellDebug1HiiHandle;

 

 /**

-  Function printing hex output to the console.

-

-  @param[in] Indent       Number of spaces to indent.

-  @param[in] Offset       Offset to start with.

-  @param[in] DataSize     Length of data.

-  @param[in] UserData     Pointer to some data.

-**/

-VOID

-DumpHex (

-  IN UINTN        Indent,

-  IN UINTN        Offset,

-  IN UINTN        DataSize,

-  IN VOID         *UserData

-  );

-

-/**

   Function returns a system configuration table that is stored in the

   EFI System Table based on the provided GUID.

 

diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/UefiShellDebug1CommandsLib.inf b/ShellPkg/Library/UefiShellDebug1CommandsLib/UefiShellDebug1CommandsLib.inf
index cfbf001bcb..8104b9a1d5 100644
--- a/ShellPkg/Library/UefiShellDebug1CommandsLib/UefiShellDebug1CommandsLib.inf
+++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/UefiShellDebug1CommandsLib.inf
@@ -17,7 +17,7 @@
   BASE_NAME                      = UefiShellDebug1CommandsLib

   FILE_GUID                      = 90330D51-A99B-4cc8-A2EB-AE22542A3F45

   MODULE_TYPE                    = UEFI_APPLICATION

-  VERSION_STRING                 = 1.1

+  VERSION_STRING                 = 1.2

   LIBRARY_CLASS                  = NULL|UEFI_APPLICATION UEFI_DRIVER

   CONSTRUCTOR                    = UefiShellDebug1CommandsLibConstructor

   DESTRUCTOR                     = UefiShellDebug1CommandsLibDestructor