AcpiView.h File Reference

Go to the source code of this file.

Macros
#define	MAX_FILE_NAME_LEN   128
#define	RSDP_REVISION_OFFSET   15
#define	RSDP_LENGTH_OFFSET   20

Functions
VOID	ResetErrorCount (VOID)
UINT32	GetErrorCount (VOID)
VOID	ResetWarningCount (VOID)
UINT32	GetWarningCount (VOID)
BOOLEAN	ProcessTableReportOptions (IN CONST UINT32 Signature, IN CONST UINT8 *TablePtr, IN CONST UINT32 Length)
EFI_STATUS EFIAPI	AcpiView (IN EFI_SYSTEM_TABLE *SystemTable)

Detailed Description

Header file for AcpiView

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

Definition in file AcpiView.h.

Macro Definition Documentation

MAX_FILE_NAME_LEN

#define MAX_FILE_NAME_LEN   128

A macro to define the max file name length

Definition at line 14 of file AcpiView.h.

RSDP_LENGTH_OFFSET

#define RSDP_LENGTH_OFFSET   20

Offset to the RSDP length from the start of the RSDP

Definition at line 24 of file AcpiView.h.

RSDP_REVISION_OFFSET

#define RSDP_REVISION_OFFSET   15

Offset to the RSDP revision from the start of the RSDP

Definition at line 19 of file AcpiView.h.

Function Documentation

AcpiView()

EFI_STATUS EFIAPI AcpiView

(

IN EFI_SYSTEM_TABLE *

SystemTable

)

This function iterates the configuration table entries in the system table, retrieves the RSDP pointer and starts parsing the ACPI tables.

Parameters

[in]

SystemTable

Pointer to the EFI system table.

Return values

EFI_NOT_FOUND	The RSDP pointer was not found.
EFI_UNSUPPORTED	The RSDP version was less than 2.
EFI_SUCCESS	The command was successful.

This function iterates the configuration table entries in the system table, retrieves the RSDP pointer and starts parsing the ACPI tables.

Parameters

[in]

SystemTable

Pointer to the EFI system table.

Return values

Returns

EFI_NOT_FOUND if the RSDP pointer is not found. Returns EFI_UNSUPPORTED if the RSDP version is less than 2. Returns EFI_SUCCESS if successful.

Definition at line 191 of file AcpiView.c.

GetErrorCount()

UINT32 GetErrorCount

(

VOID

)

This function returns the ACPI table error count.

Return values

Returns

the count of errors detected in the ACPI tables.

Definition at line 47 of file AcpiParser.c.

GetWarningCount()

UINT32 GetWarningCount

(

VOID

)

This function returns the ACPI table warning count.

Return values

Returns

the count of warning detected in the ACPI tables.

Definition at line 71 of file AcpiParser.c.

ProcessTableReportOptions()

BOOLEAN ProcessTableReportOptions	(	IN CONST UINT32	Signature,
		IN CONST UINT8 *	TablePtr,
		IN CONST UINT32	Length
	)

This function processes the table reporting options for the ACPI table.

Parameters

[in]	Signature	The ACPI table Signature.
[in]	TablePtr	Pointer to the ACPI table data.
[in]	Length	The length of the ACPI table.

Return values

Returns

TRUE if the ACPI table should be traced.

This function processes the table reporting options for the ACPI table.

Parameters

[in]	Signature	The ACPI table Signature.
[in]	TablePtr	Pointer to the ACPI table data.
[in]	Length	The length fo the ACPI table.

Return values

Returns

TRUE if the ACPI table should be traced.

Definition at line 79 of file AcpiView.c.

ResetErrorCount()

VOID ResetErrorCount

(

VOID

)

This function resets the ACPI table error counter to Zero.

Definition at line 34 of file AcpiParser.c.

ResetWarningCount()

VOID ResetWarningCount

(

VOID

)

This function resets the ACPI table warning counter to Zero.

Definition at line 58 of file AcpiParser.c.