Struct devices::bat::GoldfishBattery

pub struct GoldfishBattery {
    state: Arc<Mutex<GoldfishBatteryState>>,
    mmio_base: u32,
    irq_num: u32,
    irq_evt: IrqLevelEvent,
    activated: bool,
    monitor_thread: Option<WorkerThread<()>>,
    tube: Option<Tube>,
    create_power_monitor: Option<Box<dyn CreatePowerMonitorFn>>,
    create_powerd_client: Option<Box<dyn CreatePowerClientFn>>,
}

GoldFish Battery state

Fields

state: Arc<Mutex<GoldfishBatteryState>>

mmio_base: u32

irq_num: u32

irq_evt: IrqLevelEvent

activated: bool

monitor_thread: Option<WorkerThread<()>>

tube: Option<Tube>

create_power_monitor: Option<Box<dyn CreatePowerMonitorFn>>

create_powerd_client: Option<Box<dyn CreatePowerClientFn>>

Implementations

impl GoldfishBattery

pub fn new( mmio_base: u64, irq_num: u32, irq_evt: IrqLevelEvent, tube: Tube, create_power_monitor: Option<Box<dyn CreatePowerMonitorFn>>, create_powerd_client: Option<Box<dyn CreatePowerClientFn>> ) -> Result<Self, BatteryError>

Create GoldfishBattery device model

• mmio_base - The 32-bit mmio base address.
• irq_num - The corresponding interrupt number of the irq_evt which will be put into the ACPI DSDT.
• irq_evt - The interrupt event used to notify driver about the battery properties changing.
• socket - Battery control socket

pub fn keep_rds(&self) -> Vec<RawDescriptor>

return the descriptors used by this device

fn start_monitor(&mut self)

start a monitor thread to monitor the events from host

fn initialize_battery_state(&mut self) -> Result<()>

Trait Implementations

impl Aml for GoldfishBattery

fn to_aml_bytes(&self, bytes: &mut Vec<u8>)

Translate an ACPI object into AML code and append to the vector buffer.

impl BusDevice for GoldfishBattery

fn device_id(&self) -> DeviceId

Returns a unique id per device type suitable for metrics gathering.

fn debug_label(&self) -> String

Returns a label suitable for debug output.

fn read(&mut self, info: BusAccessInfo, data: &mut [u8])

Reads at offset from this device

fn write(&mut self, info: BusAccessInfo, data: &[u8])

Writes at offset into this device

fn config_register_write( &mut self, reg_idx: usize, offset: u64, data: &[u8] ) -> ConfigWriteResult

Sets a register in the configuration space. Only used by PCI.

fn config_register_read(&self, reg_idx: usize) -> u32

Gets a register from the configuration space. Only used by PCI.

fn init_pci_config_mapping( &mut self, shmem: &SharedMemory, base: usize, len: usize ) -> bool

Provides a memory region to back MMIO access to the configuration space. If the device can keep the memory region up to date, then it should return true, after which no more calls to config_register_read will be made. Otherwise the device should return false.

fn virtual_config_register_write(&mut self, reg_idx: usize, value: u32)

Sets a register in the virtual config space. Only used by PCI.

fn virtual_config_register_read(&self, reg_idx: usize) -> u32

Gets a register from the virtual config space. Only used by PCI.

fn on_sandboxed(&mut self)

Invoked when the device is sandboxed.

fn get_ranges(&self) -> Vec<(BusRange, BusType)>

Gets a list of all ranges registered by this BusDevice.

fn destroy_device(&mut self)

Invoked when the device is destroyed

fn is_bridge(&self) -> Option<u8>

Returns the secondary bus number if this bus device is pci bridge

impl Drop for GoldfishBattery

fn drop(&mut self)

Executes the destructor for this type.

impl Suspendable for GoldfishBattery

fn sleep(&mut self) -> Result<()>

Stop all threads related to the device. Sleep should be idempotent.

fn wake(&mut self) -> Result<()>

Create/Resume all threads related to the device. Wake should be idempotent.

fn snapshot(&mut self) -> Result<Value>

Save the device state in an image that can be restored.

fn restore(&mut self, data: Value) -> Result<()>

Load a saved snapshot of an image.