Struct AcpicaOperation

pub struct AcpicaOperation<const TABLES_INITIALIZED: bool, const TABLES_LOADED: bool, const SUBSYSTEM_ENABLED: bool, const OBJECTS_INITIALIZED: bool>;

The interface to ACPICA functions. The state of ACPICA’s initialization is tracked using const generics on this type.

ACPICA is not initialized all at once - it has multiple initialization functions for different systems. This struct keeps track of the calling of these functions using the type parameters T, for whether ACPICA tables are initialized, and S for whether the ACPICA subsystem is enabled. An AcpiOperation<false, false> can be obtained from register_interface, which also calls AcpiInitializeSubsystem.

Subsystem initialization code could look like the following:

    let interface = todo!(); // In real code this would be an object implementing the AcpiHandler trait

    let initialization = register_interface(interface)?;
    let initialization = initialization.load_tables()?;
    let initialization = initialization.enable_subsystem()?;
    let initialization = initialization.initialize_objects()?;

Implementations

impl<const TI: bool, const TL: bool, const E: bool, const I: bool> AcpicaOperation<TI, TL, E, I>

pub fn debug_trace( &self, name: &str, level: u32, layer: u32, flags: u32, ) -> Result<(), AcpiError>

Rust binding to the ACPICA AcpiDebugTrace function.

Panics

• If the OS interface has not been set up using register_interface
• If name contains null bytes, including at the end.

TODO: Find enums for layer, level, and flags

impl AcpicaOperation<true, true, true, true>

pub unsafe fn enter_sleep_state_prep( &mut self, state: u8, ) -> Result<(), AcpiError>

TODO: docs

pub unsafe fn enter_sleep_state(&mut self, state: u8) -> Result<(), AcpiError>

TODO: docs

pub fn get_timer(&mut self) -> u32

TODO: docs

impl AcpicaOperation<true, true, true, true>

pub fn scan_devices<F: Fn(AcpiHandle, u32) -> Option<T>, T>( &self, function: F, ) -> Option<T>

Calls a callback for each device in the AML namespace

impl<const TL: bool, const E: bool, const I: bool> AcpicaOperation<true, TL, E, I>

pub fn table(&self, signature: [u8; 4]) -> Option<AcpiTableHeader<'_>>

Gets a table by its signature, if it is present on the system.

pub fn tables(&self) -> impl Iterator<Item = AcpiTableHeader<'_>>

Returns an iterator over all the tables detected by ACPICA. If you want to find a specific common table, there may be a dedicated method for finding it instead, for instance dsdt, madt, fadt, etc.

pub fn ssdt_tables(&self) -> impl Iterator<Item = AcpiTableHeader<'_>>

Gets an iterator over all of the loaded SSDT tables.

pub fn uefi_tables(&self) -> impl Iterator<Item = Uefi<'_>>

Gets an iterator over all of the loaded UEFI tables.

pub fn dsdt(&self) -> AcpiTableHeader<'_>

Gets the DSDT

pub fn madt(&self) -> Madt<'_>

Gets the MADT

pub fn fadt(&self) -> Fadt<'_>

Gets the FADT

pub fn mcfg(&self) -> Option<Mcfg<'_>>

Gets the MCFG

impl AcpicaOperation<false, false, false, false>

pub fn initialize_tables( self, ) -> Result<AcpicaOperation<true, false, false, false>, AcpiError>

Calls the ACPICA function AcpiInitializeTables.

This function causes ACPICA to parse all the tables pointed to by the RSDT/XSDT

impl AcpicaOperation<true, false, false, false>

pub fn load_tables( self, ) -> Result<AcpicaOperation<true, true, false, false>, AcpiError>

Calls the ACPICA function AcpiLoadTables.

This function causes ACPICA to parse and execute AML code in order to build the AML namespace.

impl AcpicaOperation<true, true, false, false>

pub fn enable_subsystem( self, ) -> Result<AcpicaOperation<true, true, true, false>, AcpiError>

Calls the ACPICA function AcpiEnableSubsystem.

This function causes ACPICA to enter ACPI mode and start receiving ACPI interrupts.

impl AcpicaOperation<true, true, true, false>

pub fn initialize_objects( self, ) -> Result<AcpicaOperationFullyInitialized, AcpiError>

Calls the ACPICA function AcpiEnableSubsystem.

This function causes ACPICA to enter ACPI mode and start receiving ACPI interrupts.

Trait Implementations

impl<const TABLES_INITIALIZED: bool, const TABLES_LOADED: bool, const SUBSYSTEM_ENABLED: bool, const OBJECTS_INITIALIZED: bool> Debug for AcpicaOperation<TABLES_INITIALIZED, TABLES_LOADED, SUBSYSTEM_ENABLED, OBJECTS_INITIALIZED>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.