AcpiViewConfig.h File Reference

Go to the source code of this file.

Data Structures
struct	SELECTED_ACPI_TABLE

Enumerations
enum	EREPORT_OPTION {   ReportAll , ReportSelected , ReportTableList , ReportDumpBinFile ,   ReportMax }

Functions
BOOLEAN EFIAPI	GetColourHighlighting (VOID)
VOID EFIAPI	SetColourHighlighting (BOOLEAN Highlight)
BOOLEAN EFIAPI	GetConsistencyChecking (VOID)
VOID EFIAPI	SetConsistencyChecking (BOOLEAN ConsistencyChecking)
BOOLEAN EFIAPI	GetMandatoryTableValidate (VOID)
VOID EFIAPI	SetMandatoryTableValidate (BOOLEAN Validate)
UINTN EFIAPI	GetMandatoryTableSpec (VOID)
VOID EFIAPI	SetMandatoryTableSpec (UINTN Spec)
EREPORT_OPTION EFIAPI	GetReportOption (VOID)
VOID EFIAPI	SetReportOption (EREPORT_OPTION ReportType)
VOID EFIAPI	GetSelectedAcpiTable (OUT SELECTED_ACPI_TABLE **SelectedAcpiTable)
VOID EFIAPI	SelectAcpiTable (CONST CHAR16 *TableName)
VOID EFIAPI	AcpiConfigSetDefaults (VOID)

Detailed Description

Header file for 'acpiview' configuration.

Copyright (c) 2016 - 2020, ARM Limited. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file AcpiViewConfig.h.

Enumeration Type Documentation

EREPORT_OPTION

enum EREPORT_OPTION

The EREPORT_OPTION enum describes ACPI table Reporting options.

Enumerator
ReportAll	Report All tables.
ReportSelected	Report Selected table.
ReportTableList	Report List of tables.
ReportDumpBinFile	Dump selected table to a file.

Definition at line 104 of file AcpiViewConfig.h.

Function Documentation

AcpiConfigSetDefaults()

VOID EFIAPI AcpiConfigSetDefaults

(

VOID

)

Reset the AcpiView user configuration to defaults.

Reset the AcpiView user configuration to defaults

Definition at line 28 of file AcpiViewConfig.c.

GetColourHighlighting()

BOOLEAN EFIAPI GetColourHighlighting

(

VOID

)

This function returns the colour highlighting status.

Return values

TRUE	Colour highlighting is enabled.

Definition at line 115 of file AcpiViewConfig.c.

GetConsistencyChecking()

BOOLEAN EFIAPI GetConsistencyChecking

(

VOID

)

This function returns the consistency checking status.

Return values

TRUE	Consistency checking is enabled.

Definition at line 143 of file AcpiViewConfig.c.

GetMandatoryTableSpec()

UINTN EFIAPI GetMandatoryTableSpec

(

VOID

)

This function returns the identifier of specification to validate ACPI table requirements against.

Returns

ID of specification listing mandatory tables.

Definition at line 228 of file AcpiViewConfig.c.

GetMandatoryTableValidate()

BOOLEAN EFIAPI GetMandatoryTableValidate

(

VOID

)

This function returns the ACPI table requirements validation flag.

Return values

TRUE	Check for mandatory table presence should be performed.

Definition at line 199 of file AcpiViewConfig.c.

GetReportOption()

EREPORT_OPTION EFIAPI GetReportOption

(

VOID

)

This function returns the report options.

Returns

The current report option.

Definition at line 171 of file AcpiViewConfig.c.

GetSelectedAcpiTable()

VOID EFIAPI GetSelectedAcpiTable

(

OUT SELECTED_ACPI_TABLE **

SelectedAcpiTable

)

This function returns the selected ACPI table.

Parameters

[out]

SelectedAcpiTable

Pointer that will contain the returned struct.

Definition at line 101 of file AcpiViewConfig.c.

SelectAcpiTable()

VOID EFIAPI SelectAcpiTable

(

CONST CHAR16 *

TableName

)

This function selects an ACPI table in current context. The string name of the table is converted into UINT32 table signature.

Parameters

[in]

TableName

The name of the ACPI table to select.

SetColourHighlighting()

VOID EFIAPI SetColourHighlighting

(

BOOLEAN

Highlight

)

This function sets the colour highlighting status.

Parameters

[in]

Highlight

The highlight status.

Definition at line 129 of file AcpiViewConfig.c.

SetConsistencyChecking()

VOID EFIAPI SetConsistencyChecking

(

BOOLEAN

ConsistencyChecking

)

This function sets the consistency checking status.

Parameters

[in]

ConsistencyChecking

The consistency checking status.

Definition at line 157 of file AcpiViewConfig.c.

SetMandatoryTableSpec()

VOID EFIAPI SetMandatoryTableSpec

(

UINTN

Spec

)

This function sets the identifier of specification to validate ACPI table requirements against.

Parameters

[in]

Spec

ID of specification listing mandatory tables.

Definition at line 243 of file AcpiViewConfig.c.

SetMandatoryTableValidate()

VOID EFIAPI SetMandatoryTableValidate

(

BOOLEAN

Validate

)

This function sets the ACPI table requirements validation flag.

Parameters

[in]

Validate

Enable/Disable ACPI table requirements validation.

Definition at line 213 of file AcpiViewConfig.c.

SetReportOption()

VOID EFIAPI SetReportOption

(

EREPORT_OPTION

ReportType

)

This function sets the report options.

Parameters

[in]

ReportType

The report option to set.

Definition at line 185 of file AcpiViewConfig.c.