tables.h

Go to the documentation of this file.

#pragma once
 
#include <modules/acpi/acpi.h>
 
/**
 * @brief System Description Tables
 * @defgroup modules_acpi_tables Tables
 * @ingroup modules_acpi
 *
 * This module defines the ACPI tables found in the ACPI specification, tables defined outside of the specification, for
 * example, MCFG is defined in their own files.
 *
 * @{
 */
 
/**
 * @brief Enum for the `fadt_t::bootArchFlags` field.
 */
typedef enum
{
    FADT_BOOT_ARCH_PS2_EXISTS = (1 << 1)
} fadt_boot_arch_flags_t;
 
/**
 * @brief FADT generic Address
 * @struct fadt_gas_t
 *
 */
typedef struct PACKED
{
    uint8_t addressSpace;
    uint8_t bitWidth;
    uint8_t bitOffset;
    uint8_t accessSize;
    uint64_t address;
} fadt_gas_t;
 
/**
 * @brief Fixed ACPI Description Table
 * @struct fadt_t
 *
 * @see Section 5.2.9 table 5.9 of the ACPI specification for more details.
 */
typedef struct PACKED
{
    sdt_header_t header;
    uint32_t firmwareControl;
    uint32_t dsdt;
    uint8_t reserved;
    uint8_t preferredPowerManagementProfile;
    uint16_t sciInterrupt;
    uint32_t smiCommandPort;
    uint8_t acpiEnable;
    uint8_t acpiDisable;
    uint8_t s4BiosReq;
    uint8_t pstateControl;
    uint32_t pm1aEventBlock;
    uint32_t pm1bEventBlock;
    uint32_t pm1aControlBlock;
    uint32_t pm1bControlBlock;
    uint32_t pm2ControlBlock;
    uint32_t pmTimerBlock;
    uint32_t gpe0Block;
    uint32_t gpe1Block;
    uint8_t pm1EventLength;
    uint8_t pm1ControlLength;
    uint8_t pm2ControlLength;
    uint8_t pmTimerLength;
    uint8_t gpe0Length;
    uint8_t gpe1Length;
    uint8_t gpe1Base;
    uint8_t cStateControl;
    uint16_t worstC2Latency;
    uint16_t worstC3Latency;
    uint16_t flushSize;
    uint16_t flushStride;
    uint8_t dutyOffset;
    uint8_t dutyWidth;
    uint8_t dayAlarm;
    uint8_t monthAlarm;
    uint8_t century;
    uint16_t bootArchFlags;
    uint8_t reserved2;
    uint32_t flags;
    fadt_gas_t resetReg;
    uint8_t resetValue;
    uint8_t reserved3[3];
    uint64_t xFirmwareControl;
    uint64_t xDsdt; ///< Extended pointer to dsdt, should be used if `dsdt` is 0.
    fadt_gas_t xPm1aEventBlock;
    fadt_gas_t xPm1bEventBlock;
    fadt_gas_t xPm1aControlBlock;
    fadt_gas_t xPm1bControlBlock;
    fadt_gas_t xPm2ControlBlock;
    fadt_gas_t xPmTimerBlock;
    fadt_gas_t xGpe0Block;
    fadt_gas_t xGpe1Block;
} fadt_t;
 
/**
 * @brief FADT table signature
 */
#define FADT_SIGNATURE "FACP"
 
/**
 * @brief Multiple APIC Description Table flags.
 *
 * @see Section 5.2.12 table 5.20 of the ACPI specification for more details.
 */
typedef uint32_t madt_flags_t;
 
#define MADT_FLAG_PCAT_COMPAT ((madt_flags_t)(1 << 0))
 
/**
 * @brief MADT Interrupt Controller Types.
 *
 * @see Section 5.2.12 table 5.21 of the ACPI specification for more details.
 */
typedef uint8_t interrupt_controller_type_t;
 
#define INTERRUPT_CONTROLLER_PROCESSOR_LOCAL_APIC ((interrupt_controller_type_t)0)
#define INTERRUPT_CONTROLLER_IO_APIC ((interrupt_controller_type_t)1)
 
/**
 * @brief MADT Interrupt Controller Header
 * @struct madt_interrupt_controller_header_t
 */
typedef struct PACKED
{
    interrupt_controller_type_t type;
    uint8_t length;
} interrupt_controller_header_t;
 
/**
 * @brief MADT Processor Local APIC flags
 *
 * @see Section 5.2.12.2 table 5.23 of the ACPI specification for more details.
 */
typedef uint32_t processor_local_apic_flags_t;
 
#define PROCESSOR_LOCAL_APIC_ENABLED (1 << 0)
#define PROCESSOR_LOCAL_APIC_ONLINE_CAPABLE (1 << 1)
 
/**
 * @brief Processor Local APIC
 * @struct processor_local_apic_t
 *
 * @see Section 5.2.12.2 table 5.22 of the ACPI specification for more details.
 */
typedef struct PACKED
{
    interrupt_controller_header_t header;
    uint8_t acpiProcessorUid;
    uint8_t apicId;
    uint32_t flags;
} processor_local_apic_t;
 
/**
 * @brief IO APIC
 * @struct ioapic_t
 *
 * @see Section 5.2.12.3 table 5.24 of the ACPI specification for more details.
 */
typedef struct PACKED
{
    interrupt_controller_header_t header;
    uint8_t ioApicId;
    uint8_t reserved;
    uint32_t ioApicAddress;
    uint32_t globalSystemInterruptBase;
} ioapic_t;
 
/**
 * @brief Multiple APIC Description Table
 * @struct madt_t
 *
 * @see Section 5.2.12 table 5.19 of the ACPI specification for more details.
 */
typedef struct PACKED
{
    sdt_header_t header;
    uint32_t localInterruptControllerAddress;
    madt_flags_t flags;
    interrupt_controller_header_t interruptControllers[];
} madt_t;
 
/**
 * @brief Iterate over all MADT interrupt controllers
 *
 * @param madt The MADT table to iterate over.
 * @param ic A pointer to a madt_interrupt_controller_header_t* that will be set to the current interrupt controller.
 */
#define MADT_FOR_EACH(madt, ic) \
    for (ic = (typeof(ic))madt->interruptControllers; (uint8_t*)ic < (uint8_t*)madt + madt->header.length && \
        (uint8_t*)ic + sizeof(interrupt_controller_header_t) <= (uint8_t*)madt + madt->header.length && \
        (uint8_t*)ic + ic->header.length <= (uint8_t*)madt + madt->header.length; \
        ic = (typeof(ic))((uint8_t*)ic + ic->header.length))
 
/**
 * @brief MADT table signature
 */
#define MADT_SIGNATURE "APIC"
 
/**
 * @brief Differentiated System Description Table
 * @struct dsdt_t
 *
 * @see Section 5.2.11.1 table 5.17 of the ACPI specification for more details.
 */
typedef struct PACKED
{
    sdt_header_t header;
    uint8_t definitionBlock[];
} dsdt_t;
 
/**
 * @brief DSDT table signature
 */
#define DSDT_SIGNATURE "DSDT"
 
/**
 * @brief Secondary System Description Table
 * @struct ssdt_t
 *
 * @see Section 5.2.11.2 table 5.18 of the ACPI specification for more details.
 */
typedef struct PACKED
{
    sdt_header_t header;
    uint8_t definitionBlock[];
} ssdt_t;
 
/**
 * @brief SSDT table signature
 *
 * Note that there might be multiple SSDT tables.
 */
#define SSDT_SIGNATURE "SSDT"
 
/**
 * @brief Cached ACPI table
 * @struct acpi_cached_table_t
 *
 * This structure is used to cache ACPI tables that have been loaded.
 */
typedef struct
{
    sdt_header_t* table;
    dentry_t* file; ///< The sysfs file representing the table.
} acpi_cached_table_t;
 
/**
 * @brief Initialize ACPI tables and call their init handlers.
 *
 * @param rsdp Pointer to the RSDP structure.
 * @return On success, `0`. On failure, `ERR`.
 */
uint64_t acpi_tables_init(rsdp_t* rsdp);
 
/**
 * @brief Expose ACPI tables to sysfs.
 *
 * @return On success, `0`. On failure, `ERR`.
 */
uint64_t acpi_tables_expose(void);
 
/**
 * @brief Lookup the n'th table matching the signature.
 *
 * @param signature The signature of the table to look up.
 * @param minSize The minimum size of the table to look up, should usually be `sizeof()` of the table struct.
 * @param n The index of the table to look up (0 indexed).
 * @return On success, a pointer to the table. On error, `NULL` and `errno` is set to:
 * - `EINVAL`: Invalid parameters.
 * - `ENOENT`: No table matching the signature was found.
 * - `ERANGE`: A table was found, but not enough matching tables to satisfy `n`.
 * - `EILSEQ`: The table found was smaller than `minSize`.
 */
sdt_header_t* acpi_tables_lookup(const char* signature, uint64_t minSize, uint64_t n);
 
/** @} */