ShellPkg: Add comment that ItemPtr is set after validation

[mirror_edk2.git] / ShellPkg / Library / UefiShellAcpiViewCommandLib / AcpiViewConfig.c

/** @file\r
  State and accessors for 'acpiview' configuration.\r
\r
  Copyright (c) 2016 - 2020, ARM Limited. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
**/\r
\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/DebugLib.h>\r
\r
#include "AcpiViewConfig.h"\r
\r
// Report variables\r
STATIC BOOLEAN        mConsistencyCheck;\r
STATIC BOOLEAN        mColourHighlighting;\r
STATIC EREPORT_OPTION mReportType;\r
STATIC BOOLEAN        mMandatoryTableValidate;\r
STATIC UINTN          mMandatoryTableSpec;\r
\r
// User selection of which ACPI table should be checked\r
SELECTED_ACPI_TABLE mSelectedAcpiTable;\r
\r
/**\r
 Reset the AcpiView user configuration to defaults\r
**/\r
VOID\r
EFIAPI\r
AcpiConfigSetDefaults (\r
  VOID\r
  )\r
{\r
  mReportType = ReportAll;\r
  mSelectedAcpiTable.Type = 0;\r
  mSelectedAcpiTable.Name = NULL;\r
  mSelectedAcpiTable.Found = FALSE;\r
  mConsistencyCheck = TRUE;\r
  mMandatoryTableValidate = FALSE;\r
  mMandatoryTableSpec = 0;\r
}\r
\r
/**\r
  This function converts a string to ACPI table signature.\r
\r
  @param [in] Str   Pointer to the string to be converted to the\r
                    ACPI table signature.\r
\r
  @retval The ACPI table signature.\r
**/\r
STATIC\r
UINT32\r
ConvertStrToAcpiSignature (\r
  IN CONST CHAR16 *Str\r
  )\r
{\r
  UINT8 Index;\r
  CHAR8 Ptr[4];\r
\r
  ZeroMem (Ptr, sizeof (Ptr));\r
  Index = 0;\r
\r
  // Convert to Upper case and convert to ASCII\r
  while ((Index < 4) && (Str[Index] != 0)) {\r
    if (Str[Index] >= L'a' && Str[Index] <= L'z') {\r
      Ptr[Index] = (CHAR8)(Str[Index] - (L'a' - L'A'));\r
    } else {\r
      Ptr[Index] = (CHAR8)Str[Index];\r
    }\r
    Index++;\r
  }\r
  return *(UINT32 *) Ptr;\r
}\r
\r
/**\r
  This function selects an ACPI table in current context.\r
  The string name of the table is converted into UINT32\r
  table signature.\r
\r
  @param [in] TableName The name of the ACPI table to select.\r
**/\r
VOID\r
EFIAPI\r
SelectAcpiTable (\r
  IN CONST CHAR16 *TableName\r
  )\r
{\r
  ASSERT (TableName != NULL);\r
\r
  mSelectedAcpiTable.Name = TableName;\r
  mSelectedAcpiTable.Type = ConvertStrToAcpiSignature (mSelectedAcpiTable.Name);\r
}\r
\r
/**\r
  This function returns the selected ACPI table.\r
\r
  @param [out] SelectedAcpiTable Pointer that will contain the returned struct.\r
**/\r
VOID\r
EFIAPI\r
GetSelectedAcpiTable (\r
  OUT SELECTED_ACPI_TABLE **SelectedAcpiTable\r
  )\r
{\r
  *SelectedAcpiTable = &mSelectedAcpiTable;\r
}\r
\r
/**\r
  This function returns the colour highlighting status.\r
\r
  @retval TRUE Colour highlighting is enabled.\r
**/\r
BOOLEAN\r
EFIAPI\r
GetColourHighlighting (\r
  VOID\r
  )\r
{\r
  return mColourHighlighting;\r
}\r
\r
/**\r
  This function sets the colour highlighting status.\r
\r
  @param [in] Highlight The highlight status.\r
**/\r
VOID\r
EFIAPI\r
SetColourHighlighting (\r
  BOOLEAN Highlight\r
  )\r
{\r
  mColourHighlighting = Highlight;\r
}\r
\r
/**\r
  This function returns the consistency checking status.\r
\r
  @retval TRUE Consistency checking is enabled.\r
**/\r
BOOLEAN\r
EFIAPI\r
GetConsistencyChecking (\r
  VOID\r
  )\r
{\r
  return mConsistencyCheck;\r
}\r
\r
/**\r
  This function sets the consistency checking status.\r
\r
  @param [in] ConsistencyChecking   The consistency checking status.\r
**/\r
VOID\r
EFIAPI\r
SetConsistencyChecking (\r
  BOOLEAN ConsistencyChecking\r
  )\r
{\r
  mConsistencyCheck = ConsistencyChecking;\r
}\r
\r
/**\r
  This function returns the report options.\r
\r
  @return The current report option.\r
**/\r
EREPORT_OPTION\r
EFIAPI\r
GetReportOption (\r
  VOID\r
  )\r
{\r
  return mReportType;\r
}\r
\r
/**\r
  This function sets the report options.\r
\r
  @param [in] ReportType The report option to set.\r
**/\r
VOID\r
EFIAPI\r
SetReportOption (\r
  EREPORT_OPTION ReportType\r
  )\r
{\r
  mReportType = ReportType;\r
}\r
\r
/**\r
  This function returns the ACPI table requirements validation flag.\r
\r
  @retval TRUE Check for mandatory table presence should be performed.\r
**/\r
BOOLEAN\r
EFIAPI\r
GetMandatoryTableValidate (\r
  VOID\r
  )\r
{\r
  return mMandatoryTableValidate;\r
}\r
\r
/**\r
  This function sets the ACPI table requirements validation flag.\r
\r
  @param [in] Validate Enable/Disable ACPI table requirements validation.\r
**/\r
VOID\r
EFIAPI\r
SetMandatoryTableValidate (\r
  BOOLEAN Validate\r
  )\r
{\r
  mMandatoryTableValidate = Validate;\r
}\r
\r
/**\r
  This function returns the identifier of specification to validate ACPI table\r
  requirements against.\r
\r
  @return ID of specification listing mandatory tables.\r
**/\r
UINTN\r
EFIAPI\r
GetMandatoryTableSpec (\r
  VOID\r
  )\r
{\r
  return mMandatoryTableSpec;\r
}\r
\r
/**\r
  This function sets the identifier of specification to validate ACPI table\r
  requirements against.\r
\r
  @param [in] Spec ID of specification listing mandatory tables.\r
**/\r
VOID\r
EFIAPI\r
SetMandatoryTableSpec (\r
  UINTN Spec\r
  )\r
{\r
  mMandatoryTableSpec = Spec;\r
}\r