Struct Serial

pub struct Serial {

    interrupt_enable: Arc<AtomicU8>,
    interrupt_identification: u8,
    interrupt_evt: Event,
    line_control: u8,
    line_status: u8,
    modem_control: u8,
    modem_status: u8,
    scratch: u8,
    baud_divisor: u16,
    in_buffer: VecDeque<u8>,
    in_channel: Option<Receiver<u8>>,
    input: Option<Box<dyn SerialInput>>,
    out: Option<Box<dyn Write + Send>>,
    out_timestamp: bool,
    last_write_was_newline: bool,
    device_state: DeviceState,
    worker: Option<WorkerThread<Box<dyn SerialInput>>>,
}

Emulates serial COM ports commonly seen on x86 I/O ports 0x3f8/0x2f8/0x3e8/0x2e8.

This can optionally write the guest’s output to a Write trait object. To send input to the guest, use queue_input_bytes directly, or give a Read trait object which will be used queue bytes when used_command is called.

Fields

interrupt_enable: Arc<AtomicU8>

interrupt_identification: u8

interrupt_evt: Event

line_control: u8

line_status: u8

modem_control: u8

modem_status: u8

scratch: u8

baud_divisor: u16

in_buffer: VecDeque<u8>

in_channel: Option<Receiver<u8>>

input: Option<Box<dyn SerialInput>>

out: Option<Box<dyn Write + Send>>

out_timestamp: bool

last_write_was_newline: bool

device_state: DeviceState

worker: Option<WorkerThread<Box<dyn SerialInput>>>

Implementations

impl Serial

fn new_common( interrupt_evt: Event, input: Option<Box<dyn SerialInput>>, out: Option<Box<dyn Write + Send>>, out_timestamp: bool, ) -> Serial

pub fn device_id() -> DeviceId

Returns a unique ID for the serial device.

pub fn debug_label() -> String

Returns a debug label for the serial device. Used when setting up IrqEventSource.

pub fn queue_input_bytes(&mut self, c: &[u8]) -> Result<()>

Queues raw bytes for the guest to read and signals the interrupt if the line status would change. These bytes will be read by the guest before any bytes from the input stream that have not already been queued.

fn spawn_input_thread(&mut self)

fn drain_in_channel(&mut self)

pub fn interrupt_event(&self) -> &Event

Gets the interrupt event used to interrupt the driver when it needs to respond to this device.

fn is_dlab_set(&self) -> bool

fn is_recv_intr_enabled(&self) -> bool

fn is_thr_intr_enabled(&self) -> bool

fn is_thr_intr_changed(&self, bit: u8) -> bool

fn is_loop(&self) -> bool

fn add_intr_bit(&mut self, bit: u8)

fn del_intr_bit(&mut self, bit: u8)

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

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

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

fn set_data_bit(&mut self)

fn is_data_avaiable(&self) -> bool

fn iir_reset(&mut self)

fn handle_write(&mut self, offset: u8, v: u8) -> Result<()>

fn handle_write_data(&mut self, v: u8) -> Result<()>

Trait Implementations

impl BusDevice for Serial

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 write(&mut self, info: BusAccessInfo, data: &[u8])

Performs a write access to this device, based on info.

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

Performs a read access to this device, based on info.

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 supports_power_management(&self) -> Result<bool>

Supports runtime power_on()/power_off()

fn initial_power_state(&self) -> bool

Returns whether the device starts powered on.

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

Powers the device on.

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

Powers the device off.

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

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

fn handle_hypercall(&self, abi: &mut HypercallAbi) -> Result<()>

Handles a hypercall. Only used by hypercall-based devices.

impl SerialDevice for Serial

fn new( _protection_type: ProtectionType, interrupt_evt: Event, input: Option<Box<dyn SerialInput>>, out: Option<Box<dyn Write + Send>>, _sync: Option<Box<dyn FileSync + Send>>, options: SerialOptions, _keep_rds: Vec<RawDescriptor>, ) -> Serial

Constructs a Serial device ready for input and output.

The stream input should not block, instead returning 0 bytes if are no bytes available.

impl Suspendable for Serial

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.

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.