tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

ShellPkg/AcpiView: Move parameter parsing 

Parsing command line parameters is done in the shell
command wrapper. This declutters the core code and improves
modular design.

Cc: Ray Ni <ray.ni@intel.com>
Cc: Zhichao Gao <zhichao.gao@intel.com>
Reviewed-by: Zhichao Gao <zhichao.gao@intel.com>
Signed-off-by: Tomas Pilar <tomas.pilar@arm.com>
This commit is contained in:
Tomas Pilar 2020-06-19 12:59:54 +01:00 committed by mergify[bot]
parent e46e3040fc
commit 422fe85cc3
4 changed files with 240 additions and 211 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

205
ShellPkg/Library/UefiShellAcpiViewCommandLib/AcpiView.c
View File

@ -32,19 +32,6 @@ EFI_HII_HANDLE gShellAcpiViewHiiHandle = NULL;
STATIC UINT32 mTableCount;
STATIC UINT32 mBinTableCount;
/**
An array of acpiview command line parameters.
**/
STATIC CONST SHELL_PARAM_ITEM ParamList[] = {
{L"-q", TypeFlag},
{L"-d", TypeFlag},
{L"-h", TypeFlag},
{L"-l", TypeFlag},
{L"-s", TypeValue},
{L"-r", TypeValue},
{NULL, TypeMax}
};
/**
This function dumps the ACPI table to a file.
@ -228,7 +215,6 @@ ProcessTableReportOptions (
Returns EFI_UNSUPPORTED if the RSDP version is less than 2.
Returns EFI_SUCCESS if successful.
**/
STATIC
EFI_STATUS
EFIAPI
AcpiView (
@ -372,194 +358,3 @@ AcpiView (
}
return EFI_SUCCESS;
}
/**
Function for 'acpiview' 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
ShellCommandRunAcpiView (
IN EFI_HANDLE ImageHandle,
IN EFI_SYSTEM_TABLE* SystemTable
)
{
EFI_STATUS Status;
SHELL_STATUS ShellStatus;
LIST_ENTRY* Package;
CHAR16* ProblemParam;
SHELL_FILE_HANDLE TmpDumpFileHandle;
CONST CHAR16* MandatoryTableSpecStr;
CONST CHAR16 *SelectedTableName;
// Set configuration defaults
AcpiConfigSetDefaults ();
ShellStatus = SHELL_SUCCESS;
Package = NULL;
TmpDumpFileHandle = NULL;
Status = ShellCommandLineParse (ParamList, &Package, &ProblemParam, TRUE);
if (EFI_ERROR (Status)) {
if (Status == EFI_VOLUME_CORRUPTED && ProblemParam != NULL) {
ShellPrintHiiEx (
-1,
-1,
NULL,
STRING_TOKEN (STR_GEN_PROBLEM),
gShellAcpiViewHiiHandle,
L"acpiview",
ProblemParam
);
FreePool (ProblemParam);
} else {
Print (L"acpiview: Error processing input parameter(s)\n");
}
ShellStatus = SHELL_INVALID_PARAMETER;
} else {
if (ShellCommandLineGetCount (Package) > 1) {
ShellPrintHiiEx (
-1,
-1,
NULL,
STRING_TOKEN (STR_GEN_TOO_MANY),
gShellAcpiViewHiiHandle,
L"acpiview"
);
ShellStatus = SHELL_INVALID_PARAMETER;
} else if (ShellCommandLineGetFlag (Package, L"-?")) {
ShellPrintHiiEx (
-1,
-1,
NULL,
STRING_TOKEN (STR_GET_HELP_ACPIVIEW),
gShellAcpiViewHiiHandle,
L"acpiview"
);
} else if (ShellCommandLineGetFlag (Package, L"-s") &&
ShellCommandLineGetValue (Package, L"-s") == NULL) {
ShellPrintHiiEx (
-1,
-1,
NULL,
STRING_TOKEN (STR_GEN_NO_VALUE),
gShellAcpiViewHiiHandle,
L"acpiview",
L"-s"
);
ShellStatus = SHELL_INVALID_PARAMETER;
} else if (ShellCommandLineGetFlag (Package, L"-r") &&
ShellCommandLineGetValue (Package, L"-r") == NULL) {
ShellPrintHiiEx (
-1,
-1,
NULL,
STRING_TOKEN (STR_GEN_NO_VALUE),
gShellAcpiViewHiiHandle,
L"acpiview",
L"-r"
);
ShellStatus = SHELL_INVALID_PARAMETER;
} else if ((ShellCommandLineGetFlag (Package, L"-s") &&
ShellCommandLineGetFlag (Package, L"-l"))) {
ShellPrintHiiEx (
-1,
-1,
NULL,
STRING_TOKEN (STR_GEN_TOO_MANY),
gShellAcpiViewHiiHandle,
L"acpiview"
);
ShellStatus = SHELL_INVALID_PARAMETER;
} else if (ShellCommandLineGetFlag (Package, L"-d") &&
!ShellCommandLineGetFlag (Package, L"-s")) {
ShellPrintHiiEx (
-1,
-1,
NULL,
STRING_TOKEN (STR_GEN_MISSING_OPTION),
gShellAcpiViewHiiHandle,
L"acpiview",
L"-s",
L"-d"
);
ShellStatus = SHELL_INVALID_PARAMETER;
} else {
// Turn on colour highlighting if requested
SetColourHighlighting (ShellCommandLineGetFlag (Package, L"-h"));
// Surpress consistency checking if requested
SetConsistencyChecking (!ShellCommandLineGetFlag (Package, L"-q"));
// Evaluate the parameters for mandatory ACPI table presence checks
SetMandatoryTableValidate (ShellCommandLineGetFlag (Package, L"-r"));
MandatoryTableSpecStr = ShellCommandLineGetValue (Package, L"-r");
if (MandatoryTableSpecStr != NULL) {
SetMandatoryTableSpec (ShellHexStrToUintn (MandatoryTableSpecStr));
}
if (ShellCommandLineGetFlag (Package, L"-l")) {
SetReportOption (ReportTableList);
} else {
SelectedTableName = ShellCommandLineGetValue (Package, L"-s");
if (SelectedTableName != NULL) {
SelectAcpiTable (SelectedTableName);
SetReportOption (ReportSelected);
if (ShellCommandLineGetFlag (Package, L"-d")) {
// Create a temporary file to check if the media is writable.
CHAR16 FileNameBuffer[MAX_FILE_NAME_LEN];
SetReportOption (ReportDumpBinFile);
UnicodeSPrint (
FileNameBuffer,
sizeof (FileNameBuffer),
L".\\%s%04d.tmp",
SelectedTableName,
mBinTableCount
);
Status = ShellOpenFileByName (
FileNameBuffer,
&TmpDumpFileHandle,
EFI_FILE_MODE_READ | EFI_FILE_MODE_WRITE |
EFI_FILE_MODE_CREATE,
0
);
if (EFI_ERROR (Status)) {
ShellStatus = SHELL_INVALID_PARAMETER;
TmpDumpFileHandle = NULL;
ShellPrintHiiEx (
-1,
-1,
NULL,
STRING_TOKEN (STR_GEN_READONLY_MEDIA),
gShellAcpiViewHiiHandle,
L"acpiview"
);
goto Done;
}
// Delete Temporary file.
ShellDeleteFile (&TmpDumpFileHandle);
} // -d
} // -s
}
// Parse ACPI Table information
Status = AcpiView (SystemTable);
if (EFI_ERROR (Status)) {
ShellStatus = SHELL_NOT_FOUND;
}
}
}
Done:
if (Package != NULL) {
ShellCommandLineFreeVarList (Package);
}
return ShellStatus;
}

18
ShellPkg/Library/UefiShellAcpiViewCommandLib/AcpiView.h
View File

@ -64,7 +64,7 @@ GetWarningCount (
@param [in] Signature The ACPI table Signature.
@param [in] TablePtr Pointer to the ACPI table data.
@param [in] Length The length fo the ACPI table.
@param [in] Length The length of the ACPI table.
@retval Returns TRUE if the ACPI table should be traced.
**/
@ -75,4 +75,20 @@ ProcessTableReportOptions (
IN CONST UINT32 Length
);
/**
This function iterates the configuration table entries in the
system table, retrieves the RSDP pointer and starts parsing the ACPI tables.
@param [in] SystemTable Pointer to the EFI system table.
@retval EFI_NOT_FOUND The RSDP pointer was not found.
@retval EFI_UNSUPPORTED The RSDP version was less than 2.
@retval EFI_SUCCESS The command was successful.
**/
EFI_STATUS
EFIAPI
AcpiView (
IN EFI_SYSTEM_TABLE* SystemTable
);
#endif // ACPIVIEW_H_

218
ShellPkg/Library/UefiShellAcpiViewCommandLib/UefiShellAcpiViewCommandLib.c
View File

@ -1,24 +1,44 @@
/** @file
Main file for 'acpiview' Shell command function.
Copyright (c) 2016 - 2019, ARM Limited. All rights reserved.<BR>
Copyright (c) 2016 - 2020, ARM Limited. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#include <Guid/ShellLibHiiGuid.h>
#include <IndustryStandard/Acpi.h>
#include <Library/BaseMemoryLib.h>
#include <Library/HiiLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/PrintLib.h>
#include <Library/ShellCommandLib.h>
#include <Library/UefiLib.h>
#include <Library/ShellLib.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/UefiLib.h>
#include <Uefi.h>
#include "AcpiParser.h"
#include "AcpiTableParser.h"
#include "AcpiView.h"
#include "AcpiViewConfig.h"
#include "UefiShellAcpiViewCommandLib.h"
CONST CHAR16 gShellAcpiViewFileName[] = L"ShellCommand";
/**
An array of acpiview command line parameters.
**/
STATIC CONST SHELL_PARAM_ITEM ParamList[] = {
{L"-q", TypeFlag},
{L"-d", TypeFlag},
{L"-h", TypeFlag},
{L"-l", TypeFlag},
{L"-s", TypeValue},
{L"-r", TypeValue},
{NULL, TypeMax}
};
/**
A list of available table parsers.
*/
@ -92,6 +112,200 @@ ShellCommandGetManFileNameAcpiView (
return gShellAcpiViewFileName;
}
/**
Function for 'acpiview' command.
@param[in] ImageHandle Handle to the Image (NULL if internal).
@param[in] SystemTable Pointer to the System Table (NULL if internal).
@retval SHELL_INVALID_PARAMETER The command line invocation could not be parsed
@retval SHELL_NOT_FOUND The command failed
@retval SHELL_SUCCESS The command was successful
**/
SHELL_STATUS
EFIAPI
ShellCommandRunAcpiView (
IN EFI_HANDLE ImageHandle,
IN EFI_SYSTEM_TABLE* SystemTable
)
{
EFI_STATUS Status;
SHELL_STATUS ShellStatus;
LIST_ENTRY* Package;
CHAR16* ProblemParam;
SHELL_FILE_HANDLE TmpDumpFileHandle;
CONST CHAR16* MandatoryTableSpecStr;
CONST CHAR16* SelectedTableName;
// Set configuration defaults
AcpiConfigSetDefaults ();
ShellStatus = SHELL_SUCCESS;
Package = NULL;
TmpDumpFileHandle = NULL;
Status = ShellCommandLineParse (ParamList, &Package, &ProblemParam, TRUE);
if (EFI_ERROR (Status)) {
if (Status == EFI_VOLUME_CORRUPTED && ProblemParam != NULL) {
ShellPrintHiiEx (
-1,
-1,
NULL,
STRING_TOKEN (STR_GEN_PROBLEM),
gShellAcpiViewHiiHandle,
L"acpiview",
ProblemParam
);
FreePool (ProblemParam);
} else {
Print (L"acpiview: Error processing input parameter(s)\n");
}
ShellStatus = SHELL_INVALID_PARAMETER;
} else {
if (ShellCommandLineGetCount (Package) > 1) {
ShellPrintHiiEx (
-1,
-1,
NULL,
STRING_TOKEN (STR_GEN_TOO_MANY),
gShellAcpiViewHiiHandle,
L"acpiview"
);
ShellStatus = SHELL_INVALID_PARAMETER;
} else if (ShellCommandLineGetFlag (Package, L"-?")) {
ShellPrintHiiEx (
-1,
-1,
NULL,
STRING_TOKEN (STR_GET_HELP_ACPIVIEW),
gShellAcpiViewHiiHandle,
L"acpiview"
);
} else if (ShellCommandLineGetFlag (Package, L"-s") &&
ShellCommandLineGetValue (Package, L"-s") == NULL) {
ShellPrintHiiEx (
-1,
-1,
NULL,
STRING_TOKEN (STR_GEN_NO_VALUE),
gShellAcpiViewHiiHandle,
L"acpiview",
L"-s"
);
ShellStatus = SHELL_INVALID_PARAMETER;
} else if (ShellCommandLineGetFlag (Package, L"-r") &&
ShellCommandLineGetValue (Package, L"-r") == NULL) {
ShellPrintHiiEx (
-1,
-1,
NULL,
STRING_TOKEN (STR_GEN_NO_VALUE),
gShellAcpiViewHiiHandle,
L"acpiview",
L"-r"
);
ShellStatus = SHELL_INVALID_PARAMETER;
} else if ((ShellCommandLineGetFlag (Package, L"-s") &&
ShellCommandLineGetFlag (Package, L"-l"))) {
ShellPrintHiiEx (
-1,
-1,
NULL,
STRING_TOKEN (STR_GEN_TOO_MANY),
gShellAcpiViewHiiHandle,
L"acpiview"
);
ShellStatus = SHELL_INVALID_PARAMETER;
} else if (ShellCommandLineGetFlag (Package, L"-d") &&
!ShellCommandLineGetFlag (Package, L"-s")) {
ShellPrintHiiEx (
-1,
-1,
NULL,
STRING_TOKEN (STR_GEN_MISSING_OPTION),
gShellAcpiViewHiiHandle,
L"acpiview",
L"-s",
L"-d"
);
ShellStatus = SHELL_INVALID_PARAMETER;
} else {
// Turn on colour highlighting if requested
SetColourHighlighting (ShellCommandLineGetFlag (Package, L"-h"));
// Surpress consistency checking if requested
SetConsistencyChecking (!ShellCommandLineGetFlag (Package, L"-q"));
// Evaluate the parameters for mandatory ACPI table presence checks
SetMandatoryTableValidate (ShellCommandLineGetFlag (Package, L"-r"));
MandatoryTableSpecStr = ShellCommandLineGetValue (Package, L"-r");
if (MandatoryTableSpecStr != NULL) {
SetMandatoryTableSpec (ShellHexStrToUintn (MandatoryTableSpecStr));
}
if (ShellCommandLineGetFlag (Package, L"-l")) {
SetReportOption (ReportTableList);
} else {
SelectedTableName = ShellCommandLineGetValue (Package, L"-s");
if (SelectedTableName != NULL) {
SelectAcpiTable (SelectedTableName);
SetReportOption (ReportSelected);
if (ShellCommandLineGetFlag (Package, L"-d")) {
// Create a temporary file to check if the media is writable.
CHAR16 FileNameBuffer[MAX_FILE_NAME_LEN];
SetReportOption (ReportDumpBinFile);
UnicodeSPrint (
FileNameBuffer,
sizeof (FileNameBuffer),
L".\\%s0000.tmp",
SelectedTableName
);
Status = ShellOpenFileByName (
FileNameBuffer,
&TmpDumpFileHandle,
EFI_FILE_MODE_READ | EFI_FILE_MODE_WRITE |
EFI_FILE_MODE_CREATE,
0
);
if (EFI_ERROR (Status)) {
ShellStatus = SHELL_INVALID_PARAMETER;
TmpDumpFileHandle = NULL;
ShellPrintHiiEx (
-1,
-1,
NULL,
STRING_TOKEN (STR_GEN_READONLY_MEDIA),
gShellAcpiViewHiiHandle,
L"acpiview"
);
goto Done;
}
// Delete Temporary file.
ShellDeleteFile (&TmpDumpFileHandle);
} // -d
} // -s
}
// Parse ACPI Table information
Status = AcpiView (SystemTable);
if (EFI_ERROR (Status)) {
ShellStatus = SHELL_NOT_FOUND;
}
}
}
Done:
if (Package != NULL) {
ShellCommandLineFreeVarList (Package);
}
return ShellStatus;
}
/**
Constructor for the Shell AcpiView Command library.

10
ShellPkg/Library/UefiShellAcpiViewCommandLib/UefiShellAcpiViewCommandLib.h
View File

@ -1,7 +1,7 @@
/** @file
Header file for 'acpiview' Shell command functions.
Copyright (c) 2016 - 2017, ARM Limited. All rights reserved.<BR>
Copyright (c) 2016 - 2020, ARM Limited. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
@ -13,8 +13,12 @@ extern EFI_HII_HANDLE gShellAcpiViewHiiHandle;
/**
Function for 'acpiview' command.
@param[in] ImageHandle Handle to the Image (NULL if Internal).
@param[in] SystemTable Pointer to the System Table (NULL if Internal).
@param[in] ImageHandle Handle to the Image (NULL if internal).
@param[in] SystemTable Pointer to the System Table (NULL if internal).
@retval SHELL_INVALID_PARAMETER The command line invocation could not be parsed
@retval SHELL_NOT_FOUND The command failed
@retval SHELL_SUCCESS The command was successful
**/
SHELL_STATUS
EFIAPI