Struct devices::fw_cfg::FwCfgDevice

pub struct FwCfgDevice {
    file_slots: usize,
    entries: [Vec<FwCfgEntry>; 2],
    files: Vec<FwCfgFile>,
    cur_item_type: FwCfgItemType,
    cur_entry: u16,
    cur_offset: usize,
    file_names: HashSet<String>,
}

Fields

file_slots: usize

entries: [Vec<FwCfgEntry>; 2]

files: Vec<FwCfgFile>

cur_item_type: FwCfgItemType

cur_entry: u16

cur_offset: usize

file_names: HashSet<String>

Implementations

impl FwCfgDevice

pub fn new( file_slots: usize, fw_cfg_parameters: Vec<FwCfgParameters>, ) -> Result<FwCfgDevice, Error>

pub fn add_file( &mut self, filename: &str, data: Vec<u8>, item_type: FwCfgItemType, ) -> Result<(), Error>

Adds a file to the device.

Arguments

• filename: Name of file. Must be valid a Unix-style filename
• data: File data as bytes

fn add_bytes(&mut self, data: Vec<u8>, item_type: FwCfgItemType)

fn update_file_dir_entry(&mut self)

Trait Implementations

impl BusDevice for FwCfgDevice

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 Suspendable for FwCfgDevice

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<AnySnapshot>

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

fn restore(&mut self, _data: AnySnapshot) -> Result<()>

Load a saved snapshot of an image.