Struct Rtc

pub struct Rtc { /* private fields */ }

CMOS RTC device

Implementations

impl Rtc

pub fn new( real_time_source: Box<dyn InspectableLocalClock>, interrupt: LineInterrupt, vmtime_source: &VmTimeSource, century_reg_idx: u8, initial_cmos: Option<[u8; 256]>, enlightened_interrupts: bool, ) -> Self

Create a new CMOS RTC device

century_reg_idx sets which byte of CMOS RAM to use as the century byte. This index is not standard between different platforms. e.g: on modern x86 platforms, the presence / index of the century register is determined by an entry in the FADT ACPI table.

If enlightened_interrupts, then whenever a timer expires and the interrupt line would be set, pulse the interrupt line low then high to ensure an interrupt is delivered. This is used by older Windows guests to allow them to skip an extra PIO exit to clear the status C register. This behavior is indicated to the guest via an appropriate flag is set in the WAET ACPI table. See Windows ACPI Emulated Devices Table.

pub fn raw_cmos(&mut self) -> &mut [u8; 256]

(for use by wrapper devices) reference to the raw underlying CMOS data

pub fn set_cmos_byte(&mut self, addr: u8, data: u8)

Directly write a byte in the CMOS.

This method is marked pub to in order to implement wrapper devices that inject platform-specific CMOS memory contents. e.g: the AMI RTC device.

pub fn get_cmos_byte(&mut self, addr: u8) -> u8

Directly read a byte in the CMOS.

This method is marked pub to in order to implement wrapper devices that inject platform-specific CMOS memory contents. e.g: the AMI RTC device.

Trait Implementations

impl ChangeDeviceState for Rtc

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 Rtc

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

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

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

Optionally returns a trait object to send poll requests 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_line_interrupt_target( &mut self, ) -> Option<&mut dyn LineInterruptTarget>

Optionally returns a trait object to send interrupt line changes 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 Rtc

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

Inspects the object.

impl PollDevice for Rtc

fn poll_device(&mut self, cx: &mut Context<'_>)

Poll the device for asynchronous work.

impl PortIoIntercept for Rtc

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 Rtc

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.