tables.h

Go to the documentation of this file.

#pragma once
 
#include <uacpi/types.h>
#include <uacpi/status.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
// Forward-declared to avoid including the entire acpi.h here
struct acpi_fadt;
struct acpi_entry_hdr;
struct acpi_sdt_hdr;
 
typedef struct uacpi_table_identifiers {
    uacpi_object_name signature;
 
    // if oemid[0] == 0 this field is ignored
    char oemid[6];
 
    // if oem_table_id[0] == 0 this field is ignored
    char oem_table_id[8];
} uacpi_table_identifiers;
 
typedef struct uacpi_table {
    union {
        uacpi_virt_addr virt_addr;
        void *ptr;
        struct acpi_sdt_hdr *hdr;
    };
 
     // Index number used to identify this table internally
    uacpi_size index;
} uacpi_table;
 
uacpi_size uacpi_table_count(void);
 
uacpi_status uacpi_table_install(
    void*, uacpi_table *out_table
);
uacpi_status uacpi_table_install_physical(
    uacpi_phys_addr, uacpi_table *out_table
);
 
#ifndef UACPI_BAREBONES_MODE
uacpi_status uacpi_table_load(uacpi_size index);
#endif // !UACPI_BAREBONES_MODE
 
uacpi_status uacpi_table_find_by_signature(
    const uacpi_char *signature, uacpi_table *out_table
);
uacpi_status uacpi_table_find_by_signature_at(
    const uacpi_char *signature, uacpi_size offset, uacpi_table *out_table
);
uacpi_status uacpi_table_find_nth_by_signature(
    const uacpi_char *signature, uacpi_size nth, uacpi_table *out_table
);
 
uacpi_status uacpi_table_find_next_with_same_signature(
    uacpi_table *in_out_table
);
uacpi_status uacpi_table_find(
    const uacpi_table_identifiers *id, uacpi_table *out_table
);
 
uacpi_status uacpi_table_get_by_index(uacpi_size, uacpi_table *out_table);
 
uacpi_status uacpi_table_ref(uacpi_table*);
uacpi_status uacpi_table_ref_by_index(uacpi_size);
uacpi_status uacpi_table_unref(uacpi_table*);
uacpi_status uacpi_table_unref_by_index(uacpi_size);
 
uacpi_status uacpi_table_fadt(struct acpi_fadt**);
 
typedef enum uacpi_table_installation_disposition {
    // Allow the table to be installed as-is
    UACPI_TABLE_INSTALLATION_DISPOSITON_ALLOW = 0,
 
    UACPI_TABLE_INSTALLATION_DISPOSITON_DENY,
 
    UACPI_TABLE_INSTALLATION_DISPOSITON_VIRTUAL_OVERRIDE,
 
    UACPI_TABLE_INSTALLATION_DISPOSITON_PHYSICAL_OVERRIDE,
} uacpi_table_installation_disposition;
 
typedef uacpi_table_installation_disposition (*uacpi_table_installation_handler)
    (struct acpi_sdt_hdr *hdr, uacpi_u64 *out_override_address);
 
uacpi_status uacpi_set_table_installation_handler(
    uacpi_table_installation_handler handler
);
 
typedef enum uacpi_table_origin {
    UACPI_TABLE_ORIGIN_FIRMWARE_PHYSICAL = 1 << 0,
 
    UACPI_TABLE_ORIGIN_FIRMWARE_VIRTUAL = 1 << 1,
 
    UACPI_TABLE_ORIGIN_HOST_PHYSICAL = 1 << 2,
 
    UACPI_TABLE_ORIGIN_HOST_VIRTUAL = 1 << 3,
} uacpi_table_origin;
 
typedef struct uacpi_table_info {
    uacpi_size idx;
 
    uacpi_size size;
 
    union {
        uacpi_phys_addr phys_addr;
 
        void *virt_addr;
    };
 
    uacpi_char signature[4];
 
    uacpi_u8 origin;
 
#define UACPI_TABLE_LOADED (1 << 0)
 
#define UACPI_TABLE_CSUM_CHECKED (1 << 1)
 
#define UACPI_TABLE_CSUM_BAD (1 << 2)
 
    uacpi_u8 flags;
 
    uacpi_u16 reference_count;
} uacpi_table_info;
 
typedef uacpi_iteration_decision (*uacpi_table_iteration_callback)
    (uacpi_handle, uacpi_table_info *info);
 
uacpi_status uacpi_for_each_table(
    uacpi_table_iteration_callback, void *user
);
 
/*
 * Retrieve information about the table installed internally at 'idx'.
 *
 * The number of available tables can be retrieved via uacpi_table_count().
 */
uacpi_status uacpi_table_info_get_by_index(
    uacpi_size idx, uacpi_table_info *out_info
);
 
typedef uacpi_iteration_decision (*uacpi_subtable_iteration_callback)
    (uacpi_handle, struct acpi_entry_hdr*);
 
uacpi_status uacpi_for_each_subtable(
    struct acpi_sdt_hdr *hdr, size_t hdr_size,
    uacpi_subtable_iteration_callback cb, void *user
);
 
#ifdef __cplusplus
}
#endif