raw-acpi 0.0.2

Simply ACPI, in Rust.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

pub mod affinity;

use crate::SDTHeader;

#[derive(Copy, Clone)]
#[repr(C, packed)]
/// ## Device Handle - ACPI
pub struct ACPIDeviceHandle {
    /// The _HID value
    pub acpi_hid: u64,
    /// The _UID value
    pub acpi_uid: u32,
    reserved: u32,
}

#[derive(Copy, Clone)]
#[repr(C, packed)]
/// ## Device Handle - PCI
pub struct PCIDeviceHandle {
    /// PCI segment number.
    ///
    /// For systems with fewer than 255 PCI buses, this number must be 0.
    pub pci_segment: u16,
    /// PCI Bus Number (Bits 7:0 of Byte 2)<br>
    /// PCI Device Number (Bits 7:3 of Byte 3)<br>
    /// PCI Function Number (Bits 2:0 of Byte 3)
    pub pci_bdf_number: u16,
    reserved: [u8; 12],
}

#[derive(Copy, Clone)]
/// ## Device Handle
pub union DeviceHandle {
    pub acpi: ACPIDeviceHandle,
    pub pci: PCIDeviceHandle,
}

#[derive(Copy, Clone)]
#[repr(C, packed)]
/// ## System Resource Affinity Table (SRAT)
///
/// This optional table provides information that allows OSPM to associate the following types of devices with system locality / proximity domains and clock domains:
///
/// - Processors
/// - Memory ranges (including those provided by hot-added memory devices)
/// - Generic initiators (e.g. heterogeneous processors and accelerators, GPUs, and I/O devices with integrated compute or DMA engines)
/// - Generic ports (e.g. host bridges that can dynamically discover new initiators and instantiate new memory range targets)
///
/// On NUMA platforms, SRAT information enables OSPM to optimally configure the operating system
/// during a point in OS initialization when evaluation of objects in the ACPI Namespace is not yet possible.
///
/// OSPM evaluates the SRAT only during OS initialization.
/// The Local APIC ID / Local SAPIC ID / Local x2APIC ID or the GICC ACPI Processor UID of all processors started at boot time must be present in the SRAT.
/// If the Local APIC ID / Local SAPIC ID / Local x2APIC ID or the GICC ACPI Processor UID of a dynamically added processor is not present in the SRAT,
/// a _PXM object must exist for the processor’s device or one of its ancestors in the ACPI Namespace.
///
/// Note: SRAT is the place where proximity domains are defined, and _PXM provides a mechanism to associate a device object (and its children) to an SRAT-defined proximity domain.
pub struct SRAT {
    /// - **Signature** - "SRAT"
    pub header: SDTHeader,
    /// **JJ's Note: History indicates that these were gonna be used for describing NUMA topology, but NUMA turned out to be static, making these fields useless.
    /// The System Locality Information Table was introduced not too long after SRAT, which removed the need for global SRAT-level metadata and runtime interpretation hints.**
    ///
    /// **From that point on, firmware vendors decided never to implement it.**
    ///
    /// **The ACPI spec in uefi.org does state that the 32-bit field is reserved to be 1 for backwards compatibility.**
    reserved0: u32,
    reserved1: u64,
    /// A list of static resource allocation structures for the platform.
    pub static_resource_allocation_structure: [u8; 0],
}