Struct PowerManagementDevice

pub struct PowerManagementDevice { /* private fields */ }

A power management + ACPI device.

See the module level docs for more details.

Implementations

impl PowerManagementDevice

pub fn new( action: PowerActionFn, acpi_interrupt: LineInterrupt, register_pio: &mut dyn RegisterPortIoIntercept, vmtime: VmTimeAccess, enable_acpi_mode: Option<EnableAcpiMode>, pm_timer_assist: Option<Box<dyn PmTimerAssist>>, ) -> Self

Create a new PowerManagementDevice.

Most arguments to this constructor are self describing, though there are some that merit additional explanation:

• action: a callback invoked whenever the PM initiates a power event
• pio_control and pio_status: define where in the port IO space the control/status registers get mapped to.
• enable_acpi_mode: see the docs for EnableAcpiMode

pub fn check_interrupt_assertion(&self)

(used by the PIIX4 wrapper device)

Evaluates whether the power management (ACPI) interrupt should be asserted or de-asserted

If the state is out of sync with what it should be, this function will either assert or de-assert the interrupt. The logic for whether an ACPI interrupt should be sent is covered in various parts of Chapter 4 of any version of the ACPI spec.

reSearch query: CheckInterruptAssertion

pub fn update_dynamic_pio_mappings(&mut self, pio_dynamic_addr: Option<u16>)

(used by the PIIX4 wrapper device)

Remap dynamic registers based on config in the PCI config space

pub fn pcat_facp_acpi_enable(&mut self, enable: bool)

(used by the PIIX4 wrapper device)

See calling code in piix4_pm.rs for details on what this does.

pub fn power_action(&mut self) -> &mut PowerActionFn

(used by the PIIX4 wrapper device)

Get a mutable reference to the provided PowerActionFn

Trait Implementations

impl ChangeDeviceState for PowerManagementDevice

fn start(&mut self)

Starts a device, allowing it to interact with the guest asynchronously.

async fn stop(&mut self)

Stops a device’s asynchronous work.

async fn reset(&mut self)

Resets the device state to its initial state, for a fresh boot.

impl ChipsetDevice for PowerManagementDevice

fn supports_pio(&mut self) -> Option<&mut dyn PortIoIntercept>

Optionally returns a trait object to send IO port intercepts to.

fn supports_line_interrupt_target( &mut self, ) -> Option<&mut dyn LineInterruptTarget>

Optionally returns a trait object to send interrupt line changes to.

fn supports_mmio(&mut self) -> Option<&mut (dyn MmioIntercept + 'static)>

Optionally returns a trait object to send MMIO port intercepts to.

fn supports_pci(&mut self) -> Option<&mut (dyn PciConfigSpace + 'static)>

Optionally returns a trait object to send PCI config space accesses to.

fn supports_poll_device(&mut self) -> Option<&mut dyn PollDevice>

Optionally returns a trait object to send poll requests to.

fn supports_handle_eoi(&mut self) -> Option<&mut dyn HandleEoi>

Optionally returns a trait object to send EOI requests to.

fn supports_acknowledge_pic_interrupt( &mut self, ) -> Option<&mut dyn AcknowledgePicInterrupt>

Optionally returns a trait object with which to acknowledge PIC interrupts.

impl InspectMut for PowerManagementDevice

fn inspect_mut(&mut self, req: Request<'_>)

Inspects the object.

impl LineInterruptTarget for PowerManagementDevice

Target for lines corresponding to bits in General Purpose Event Block 0.

For a full general description of this register, see the ACPI Spec. See section 4.7.1 in the ACPI 2.0 spec.

fn set_irq(&mut self, vector: u32, high: bool)

Set an interrupt line state.

fn valid_lines(&self) -> &[RangeInclusive<u32>]

Returns the valid vector ranges for this target.

impl PortIoIntercept for PowerManagementDevice

fn io_read(&mut self, io_port: u16, data: &mut [u8]) -> IoResult

Dispatch an IO port read to the device with the given address.

fn io_write(&mut self, io_port: u16, data: &[u8]) -> IoResult

Dispatch an IO port write to the device with the given address.

fn get_static_regions(&mut self) -> &[(&str, RangeInclusive<u16>)]

Report a set of static io port regions (region_name, port_range) that cannot be remapped at runtime and are always registered.

impl SaveRestore for PowerManagementDevice

type SavedState = SavedState

The concrete saved state type.

fn save(&mut self) -> Result<Self::SavedState, SaveError>

Saves the object’s state.

fn restore(&mut self, state: Self::SavedState) -> Result<(), RestoreError>

Restores the object’s state.