TianoCore EDK2 master
Loading...
Searching...
No Matches
Data Structures | Macros | Typedefs | Variables
DynamicTableFactoryProtocol.h File Reference
#include <AcpiTableGenerator.h>
#include <SmbiosTableGenerator.h>
#include <DeviceTreeTableGenerator.h>

Go to the source code of this file.

Data Structures

struct  DynamicTableFactoryProtocol
 

Macros

#define EDKII_DYNAMIC_TABLE_FACTORY_PROTOCOL_GUID
 
#define EDKII_DYNAMIC_TABLE_FACTORY_PROTOCOL_REVISION   CREATE_REVISION (1, 0)
 

Typedefs

typedef struct DynamicTableFactoryProtocol EDKII_DYNAMIC_TABLE_FACTORY_PROTOCOL
 
typedef struct DynamicTableFactoryInfo EDKII_DYNAMIC_TABLE_FACTORY_INFO
 
typedef EFI_STATUS(EFIAPI * EDKII_DYNAMIC_TABLE_FACTORY_GET_ACPI_TABLE_GENERATOR) (IN CONST EDKII_DYNAMIC_TABLE_FACTORY_PROTOCOL *CONST This, IN CONST ACPI_TABLE_GENERATOR_ID GeneratorId, OUT CONST ACPI_TABLE_GENERATOR **CONST Generator)
 
typedef EFI_STATUS(EFIAPI * EDKII_DYNAMIC_TABLE_FACTORY_REGISTER_ACPI_TABLE_GENERATOR) (IN CONST ACPI_TABLE_GENERATOR *CONST Generator)
 
typedef EFI_STATUS(EFIAPI * EDKII_DYNAMIC_TABLE_FACTORY_DEREGISTER_ACPI_TABLE_GENERATOR) (IN CONST ACPI_TABLE_GENERATOR *CONST Generator)
 
typedef EFI_STATUS(EFIAPI * EDKII_DYNAMIC_TABLE_FACTORY_GET_SMBIOS_TABLE_GENERATOR) (IN CONST EDKII_DYNAMIC_TABLE_FACTORY_PROTOCOL *CONST This, IN CONST SMBIOS_TABLE_GENERATOR_ID GeneratorId, OUT CONST SMBIOS_TABLE_GENERATOR **CONST Generator)
 
typedef EFI_STATUS(EFIAPI * EDKII_DYNAMIC_TABLE_FACTORY_REGISTER_SMBIOS_TABLE_GENERATOR) (IN CONST SMBIOS_TABLE_GENERATOR *CONST Generator)
 
typedef EFI_STATUS(EFIAPI * EDKII_DYNAMIC_TABLE_FACTORY_DEREGISTER_SMBIOS_TABLE_GENERATOR) (IN CONST SMBIOS_TABLE_GENERATOR *CONST Generator)
 
typedef EFI_STATUS(EFIAPI * EDKII_DYNAMIC_TABLE_FACTORY_GET_DT_TABLE_GENERATOR) (IN CONST EDKII_DYNAMIC_TABLE_FACTORY_PROTOCOL *CONST This, IN CONST DT_TABLE_GENERATOR_ID GeneratorId, OUT CONST DT_TABLE_GENERATOR **CONST Generator)
 
typedef EFI_STATUS(EFIAPI * EDKII_DYNAMIC_TABLE_FACTORY_REGISTER_DT_TABLE_GENERATOR) (IN CONST DT_TABLE_GENERATOR *CONST Generator)
 
typedef EFI_STATUS(EFIAPI * EDKII_DYNAMIC_TABLE_FACTORY_DEREGISTER_DT_TABLE_GENERATOR) (IN CONST DT_TABLE_GENERATOR *CONST Generator)
 

Variables

EFI_GUID gEdkiiDynamicTableFactoryProtocolGuid
 

Detailed Description

Copyright (c) 2017 - 2019, ARM Limited. All rights reserved.

SPDX-License-Identifier: BSD-2-Clause-Patent

Glossary:
  • ACPI - Advanced Configuration and Power Interface
  • SMBIOS - System Management BIOS
  • DT - Device Tree

Definition in file DynamicTableFactoryProtocol.h.

Macro Definition Documentation

◆ EDKII_DYNAMIC_TABLE_FACTORY_PROTOCOL_GUID

#define EDKII_DYNAMIC_TABLE_FACTORY_PROTOCOL_GUID
Value:
{ 0x91d1e327, 0xfe5a, 0x49b8, \
{ 0xab, 0x65, 0xe, 0xce, 0x2d, 0xdb, 0x45, 0xec } \
};

This macro defines the Dynamic Table Factory Protocol GUID.

GUID: {91D1E327-FE5A-49B8-AB65-0ECE2DDB45EC}

Definition at line 24 of file DynamicTableFactoryProtocol.h.

◆ EDKII_DYNAMIC_TABLE_FACTORY_PROTOCOL_REVISION

#define EDKII_DYNAMIC_TABLE_FACTORY_PROTOCOL_REVISION   CREATE_REVISION (1, 0)

This macro defines the Configuration Manager Protocol Revision.

Definition at line 31 of file DynamicTableFactoryProtocol.h.

Typedef Documentation

◆ EDKII_DYNAMIC_TABLE_FACTORY_DEREGISTER_ACPI_TABLE_GENERATOR

typedef EFI_STATUS(EFIAPI * EDKII_DYNAMIC_TABLE_FACTORY_DEREGISTER_ACPI_TABLE_GENERATOR) (IN CONST ACPI_TABLE_GENERATOR *CONST Generator)

Deregister an ACPI table generator.

Parameters
[in]GeneratorPointer to the ACPI table generator.
Return values
EFI_SUCCESSSuccess.
EFI_INVALID_PARAMETERThe generator is invalid.
EFI_NOT_FOUNDThe requested generator is not found in the list of registered generators.

Definition at line 89 of file DynamicTableFactoryProtocol.h.

◆ EDKII_DYNAMIC_TABLE_FACTORY_DEREGISTER_DT_TABLE_GENERATOR

typedef EFI_STATUS(EFIAPI * EDKII_DYNAMIC_TABLE_FACTORY_DEREGISTER_DT_TABLE_GENERATOR) (IN CONST DT_TABLE_GENERATOR *CONST Generator)

Deregister a DT table generator.

This function is called by the DT table generator to deregister itself from the DT table factory.

Parameters
[in]GeneratorPointer to the DT table generator.
Return values
EFI_SUCCESSSuccess.
EFI_INVALID_PARAMETERThe generator is invalid.
EFI_NOT_FOUNDThe requested generator is not found in the list of registered generators.

Definition at line 198 of file DynamicTableFactoryProtocol.h.

◆ EDKII_DYNAMIC_TABLE_FACTORY_DEREGISTER_SMBIOS_TABLE_GENERATOR

typedef EFI_STATUS(EFIAPI * EDKII_DYNAMIC_TABLE_FACTORY_DEREGISTER_SMBIOS_TABLE_GENERATOR) (IN CONST SMBIOS_TABLE_GENERATOR *CONST Generator)

Deregister a SMBIOS table generator.

Parameters
[in]GeneratorPointer to the SMBIOS table generator.
Return values
EFI_SUCCESSSuccess.
EFI_INVALID_PARAMETERThe generator is invalid.
EFI_NOT_FOUNDThe requested generator is not found in the list of registered generators.

Definition at line 142 of file DynamicTableFactoryProtocol.h.

◆ EDKII_DYNAMIC_TABLE_FACTORY_GET_ACPI_TABLE_GENERATOR

typedef EFI_STATUS(EFIAPI * EDKII_DYNAMIC_TABLE_FACTORY_GET_ACPI_TABLE_GENERATOR) (IN CONST EDKII_DYNAMIC_TABLE_FACTORY_PROTOCOL *CONST This, IN CONST ACPI_TABLE_GENERATOR_ID GeneratorId, OUT CONST ACPI_TABLE_GENERATOR **CONST Generator)

Return a pointer to the ACPI table generator.

Parameters
[in]ThisPointer to the Dynamic Table Factory Protocol.
[in]TableIdThe ACPI table generator ID for the requested generator.
[out]GeneratorPointer to the requested ACPI table generator.
Return values
EFI_SUCCESSSuccess.
EFI_INVALID_PARAMETERA parameter is invalid.
EFI_NOT_FOUNDThe requested generator is not found in the list of registered generators.

Definition at line 55 of file DynamicTableFactoryProtocol.h.

◆ EDKII_DYNAMIC_TABLE_FACTORY_GET_DT_TABLE_GENERATOR

typedef EFI_STATUS(EFIAPI * EDKII_DYNAMIC_TABLE_FACTORY_GET_DT_TABLE_GENERATOR) (IN CONST EDKII_DYNAMIC_TABLE_FACTORY_PROTOCOL *CONST This, IN CONST DT_TABLE_GENERATOR_ID GeneratorId, OUT CONST DT_TABLE_GENERATOR **CONST Generator)

Return a pointer to the Device Tree table generator.

Parameters
[in]ThisPointer to the Dynamic Table Factory Protocol.
[in]TableIdThe Device Tree table generator ID for the requested generator.
[out]GeneratorPointer to the requested Device Tree table generator.
Return values
EFI_SUCCESSSuccess.
EFI_INVALID_PARAMETERA parameter is invalid.
EFI_NOT_FOUNDThe requested generator is not found in the list of registered generators.

Definition at line 161 of file DynamicTableFactoryProtocol.h.

◆ EDKII_DYNAMIC_TABLE_FACTORY_GET_SMBIOS_TABLE_GENERATOR

typedef EFI_STATUS(EFIAPI * EDKII_DYNAMIC_TABLE_FACTORY_GET_SMBIOS_TABLE_GENERATOR) (IN CONST EDKII_DYNAMIC_TABLE_FACTORY_PROTOCOL *CONST This, IN CONST SMBIOS_TABLE_GENERATOR_ID GeneratorId, OUT CONST SMBIOS_TABLE_GENERATOR **CONST Generator)

Return a pointer to the SMBIOS table generator.

Parameters
[in]ThisPointer to the Dynamic Table Factory Protocol.
[in]TableIdThe SMBIOS table generator ID for the requested generator.
[out]GeneratorPointer to the requested SMBIOS table generator.
Return values
EFI_SUCCESSSuccess.
EFI_INVALID_PARAMETERA parameter is invalid.
EFI_NOT_FOUNDThe requested generator is not found in the list of registered generators.

Definition at line 108 of file DynamicTableFactoryProtocol.h.

◆ EDKII_DYNAMIC_TABLE_FACTORY_INFO

typedef struct DynamicTableFactoryInfo EDKII_DYNAMIC_TABLE_FACTORY_INFO

Definition at line 39 of file DynamicTableFactoryProtocol.h.

◆ EDKII_DYNAMIC_TABLE_FACTORY_PROTOCOL

typedef struct DynamicTableFactoryProtocol EDKII_DYNAMIC_TABLE_FACTORY_PROTOCOL

Forward declarations:

A structure describing the Dynamic Table Factory Protocol interface.

Definition at line 38 of file DynamicTableFactoryProtocol.h.

◆ EDKII_DYNAMIC_TABLE_FACTORY_REGISTER_ACPI_TABLE_GENERATOR

typedef EFI_STATUS(EFIAPI * EDKII_DYNAMIC_TABLE_FACTORY_REGISTER_ACPI_TABLE_GENERATOR) (IN CONST ACPI_TABLE_GENERATOR *CONST Generator)

Registers an ACPI table generator.

Parameters
[in]GeneratorPointer to the ACPI table generator.
Return values
EFI_SUCCESSThe Generator was registered successfully.
EFI_INVALID_PARAMETERThe Generator ID is invalid or the Generator pointer is NULL.
EFI_ALREADY_STARTEDThe Generator for the Table ID is already registered.

Definition at line 74 of file DynamicTableFactoryProtocol.h.

◆ EDKII_DYNAMIC_TABLE_FACTORY_REGISTER_DT_TABLE_GENERATOR

typedef EFI_STATUS(EFIAPI * EDKII_DYNAMIC_TABLE_FACTORY_REGISTER_DT_TABLE_GENERATOR) (IN CONST DT_TABLE_GENERATOR *CONST Generator)

Register a DT table generator.

Parameters
[in]GeneratorPointer to the DT table generator.
Return values
EFI_SUCCESSThe Generator was registered successfully.
EFI_INVALID_PARAMETERThe Generator ID is invalid or the Generator pointer is NULL.
EFI_ALREADY_STARTEDThe Generator for the Table ID is already registered.

Definition at line 180 of file DynamicTableFactoryProtocol.h.

◆ EDKII_DYNAMIC_TABLE_FACTORY_REGISTER_SMBIOS_TABLE_GENERATOR

typedef EFI_STATUS(EFIAPI * EDKII_DYNAMIC_TABLE_FACTORY_REGISTER_SMBIOS_TABLE_GENERATOR) (IN CONST SMBIOS_TABLE_GENERATOR *CONST Generator)

Register a SMBIOS table generator.

Parameters
[in]GeneratorPointer to the SMBIOS table generator.
Return values
EFI_SUCCESSThe Generator was registered successfully.
EFI_INVALID_PARAMETERThe Generator ID is invalid or the Generator pointer is NULL.
EFI_ALREADY_STARTEDThe Generator for the Table ID is already registered.

Definition at line 127 of file DynamicTableFactoryProtocol.h.

Variable Documentation

◆ gEdkiiDynamicTableFactoryProtocolGuid

EFI_GUID gEdkiiDynamicTableFactoryProtocolGuid
extern

The Dynamic Table Factory Protocol GUID.