SbbrValidator.c File Reference

#include <Library/DebugLib.h>
#include <Library/UefiLib.h>
#include "AcpiParser.h"
#include "Arm/SbbrValidator.h"

Go to the source code of this file.

Functions
VOID EFIAPI	ArmSbbrResetTableCounts (VOID)
BOOLEAN EFIAPI	ArmSbbrIncrementTableCount (UINT32 Signature)
EFI_STATUS EFIAPI	ArmSbbrReqsValidate (ARM_SBBR_VERSION Version)

Variables
STATIC CONST CHAR8 *	ArmSbbrVersions [ArmSbbrVersionMax]
STATIC CONST UINT32	ArmSbbr10Mandatory []
STATIC CONST UINT32	ArmSbbr11Mandatory []
STATIC CONST UINT32	ArmSbbr12Mandatory []
STATIC CONST ACPI_SBBR_REQ	ArmSbbrReqs [ArmSbbrVersionMax]
STATIC ACPI_TABLE_COUNTER	ArmSbbrTableCounts []

Detailed Description

Arm Server Base Boot Requirements ACPI table requirement validator.

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

Glossary:

• Sbbr or SBBR - Server Base Boot Requirements
• Sbsa or SBSA - Server Base System Architecture

Reference(s):

• Arm Server Base Boot Requirements 1.2, September 2019
• Arm Server Base Boot Requirements 1.1, May 2018
• Arm Server Base Boot Requirements 1.0, March 2016
• Arm Server Base System Architecture 6.0

Definition in file SbbrValidator.c.

Function Documentation

ArmSbbrIncrementTableCount()

BOOLEAN EFIAPI ArmSbbrIncrementTableCount

(

UINT32

Signature

)

Increment instance count for SBBR-mandatory ACPI table with the given signature.

Parameters

[in]

Signature

ACPI table signature.

Return values

TRUE	Count incremented successfully.
FALSE	Table with the input signature not found.

Definition at line 126 of file SbbrValidator.c.

ArmSbbrReqsValidate()

EFI_STATUS EFIAPI ArmSbbrReqsValidate

(

ARM_SBBR_VERSION

Version

)

Validate that all ACPI tables required by the given SBBR specification version are installed on the platform.

Parameters

[in]

Version

SBBR spec version to validate against.

Return values

EFI_SUCCESS	All required tables are present.
EFI_INVALID_PARAMETER	Invalid SBBR version.
EFI_NOT_FOUND	One or more mandatory tables are missing.
EFI_UNSUPPORTED	Mandatory ACPI table does not have its instance count tracked.

Definition at line 156 of file SbbrValidator.c.

ArmSbbrResetTableCounts()

VOID EFIAPI ArmSbbrResetTableCounts

(

VOID

)

Reset the platform ACPI table instance count for all SBBR-mandatory tables.

Definition at line 104 of file SbbrValidator.c.

Variable Documentation

ArmSbbr10Mandatory

STATIC CONST UINT32 ArmSbbr10Mandatory[]

Initial value:

= {
  EFI_ACPI_6_3_EXTENDED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE,
  EFI_ACPI_6_3_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE,
  EFI_ACPI_6_3_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE,
  EFI_ACPI_6_3_MULTIPLE_APIC_DESCRIPTION_TABLE_SIGNATURE,
  EFI_ACPI_6_3_GENERIC_TIMER_DESCRIPTION_TABLE_SIGNATURE,
  EFI_ACPI_6_3_DEBUG_PORT_2_TABLE_SIGNATURE,
  EFI_ACPI_6_3_SERIAL_PORT_CONSOLE_REDIRECTION_TABLE_SIGNATURE
}

SBBR 1.0 mandatory ACPI tables

Definition at line 35 of file SbbrValidator.c.

ArmSbbr11Mandatory

STATIC CONST UINT32 ArmSbbr11Mandatory[]

Initial value:

= {
  EFI_ACPI_6_3_EXTENDED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE,
  EFI_ACPI_6_3_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE,
  EFI_ACPI_6_3_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE,
  EFI_ACPI_6_3_MULTIPLE_APIC_DESCRIPTION_TABLE_SIGNATURE,
  EFI_ACPI_6_3_GENERIC_TIMER_DESCRIPTION_TABLE_SIGNATURE,
  EFI_ACPI_6_3_DEBUG_PORT_2_TABLE_SIGNATURE,
  EFI_ACPI_6_3_SERIAL_PORT_CONSOLE_REDIRECTION_TABLE_SIGNATURE,
  EFI_ACPI_6_3_PCI_EXPRESS_MEMORY_MAPPED_CONFIGURATION_SPACE_BASE_ADDRESS_DESCRIPTION_TABLE_SIGNATURE
}

SBBR 1.1 mandatory ACPI tables

Definition at line 48 of file SbbrValidator.c.

ArmSbbr12Mandatory

STATIC CONST UINT32 ArmSbbr12Mandatory[]

Initial value:

= {
  EFI_ACPI_6_3_EXTENDED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE,
  EFI_ACPI_6_3_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE,
  EFI_ACPI_6_3_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE,
  EFI_ACPI_6_3_MULTIPLE_APIC_DESCRIPTION_TABLE_SIGNATURE,
  EFI_ACPI_6_3_GENERIC_TIMER_DESCRIPTION_TABLE_SIGNATURE,
  EFI_ACPI_6_3_DEBUG_PORT_2_TABLE_SIGNATURE,
  EFI_ACPI_6_3_SERIAL_PORT_CONSOLE_REDIRECTION_TABLE_SIGNATURE,
  EFI_ACPI_6_3_PCI_EXPRESS_MEMORY_MAPPED_CONFIGURATION_SPACE_BASE_ADDRESS_DESCRIPTION_TABLE_SIGNATURE,
  EFI_ACPI_6_3_PROCESSOR_PROPERTIES_TOPOLOGY_TABLE_STRUCTURE_SIGNATURE
}

SBBR 1.2 mandatory ACPI tables

Definition at line 62 of file SbbrValidator.c.

ArmSbbrReqs

STATIC CONST ACPI_SBBR_REQ ArmSbbrReqs[ArmSbbrVersionMax]

Initial value:

= {
  { ArmSbbr10Mandatory, ARRAY_SIZE (ArmSbbr10Mandatory) },    
  { ArmSbbr11Mandatory, ARRAY_SIZE (ArmSbbr11Mandatory) },    
  { ArmSbbr12Mandatory, ARRAY_SIZE (ArmSbbr12Mandatory) }     
}

Mandatory ACPI tables for every SBBR specification version.

Definition at line 77 of file SbbrValidator.c.

ArmSbbrTableCounts

STATIC ACPI_TABLE_COUNTER ArmSbbrTableCounts[]

Initial value:

= {
  { EFI_ACPI_6_3_EXTENDED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE,                                            0 },
  { EFI_ACPI_6_3_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE,                                                 0 },
  { EFI_ACPI_6_3_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE,                                      0 },
  { EFI_ACPI_6_3_MULTIPLE_APIC_DESCRIPTION_TABLE_SIGNATURE,                                              0 },
  { EFI_ACPI_6_3_GENERIC_TIMER_DESCRIPTION_TABLE_SIGNATURE,                                              0 },
  { EFI_ACPI_6_3_DEBUG_PORT_2_TABLE_SIGNATURE,                                                           0 },
  { EFI_ACPI_6_3_SERIAL_PORT_CONSOLE_REDIRECTION_TABLE_SIGNATURE,                                        0 },
  { EFI_ACPI_6_3_PCI_EXPRESS_MEMORY_MAPPED_CONFIGURATION_SPACE_BASE_ADDRESS_DESCRIPTION_TABLE_SIGNATURE, 0 },
  { EFI_ACPI_6_3_PROCESSOR_PROPERTIES_TOPOLOGY_TABLE_STRUCTURE_SIGNATURE,                                0 }
}

Data structure to track instance counts for all ACPI tables which are defined as 'mandatory' in any SBBR version.

Definition at line 87 of file SbbrValidator.c.

ArmSbbrVersions

STATIC CONST CHAR8* ArmSbbrVersions[ArmSbbrVersionMax]

Initial value:

= {
  "1.0",     
  "1.1",     
  "1.2"      
}

SBBR specification version strings

Definition at line 26 of file SbbrValidator.c.