mirror of
https://github.com/cloud-hypervisor/cloud-hypervisor.git
synced 2024-12-22 05:35:20 +00:00
virtio-devices: fix documentation formatting
Signed-off-by: Wei Liu <liuwe@microsoft.com>
This commit is contained in:
parent
9cd214b0a1
commit
b3a73d6634
@ -32,24 +32,26 @@ pub struct VirtioPciCommonConfigState {
|
|||||||
/// device.
|
/// device.
|
||||||
///
|
///
|
||||||
/// * Registers:
|
/// * Registers:
|
||||||
|
///
|
||||||
/// ** About the whole device.
|
/// ** About the whole device.
|
||||||
/// le32 device_feature_select; // 0x00 // read-write
|
/// le32 device_feature_select; // 0x00 // read-write
|
||||||
/// le32 device_feature; // 0x04 // read-only for driver
|
/// le32 device_feature; // 0x04 // read-only for driver
|
||||||
/// le32 driver_feature_select; // 0x08 // read-write
|
/// le32 driver_feature_select; // 0x08 // read-write
|
||||||
/// le32 driver_feature; // 0x0C // read-write
|
/// le32 driver_feature; // 0x0C // read-write
|
||||||
/// le16 msix_config; // 0x10 // read-write
|
/// le16 msix_config; // 0x10 // read-write
|
||||||
/// le16 num_queues; // 0x12 // read-only for driver
|
/// le16 num_queues; // 0x12 // read-only for driver
|
||||||
/// u8 device_status; // 0x14 // read-write (driver_status)
|
/// u8 device_status; // 0x14 // read-write (driver_status)
|
||||||
/// u8 config_generation; // 0x15 // read-only for driver
|
/// u8 config_generation; // 0x15 // read-only for driver
|
||||||
|
///
|
||||||
/// ** About a specific virtqueue.
|
/// ** About a specific virtqueue.
|
||||||
/// le16 queue_select; // 0x16 // read-write
|
/// le16 queue_select; // 0x16 // read-write
|
||||||
/// le16 queue_size; // 0x18 // read-write, power of 2, or 0.
|
/// le16 queue_size; // 0x18 // read-write, power of 2, or 0.
|
||||||
/// le16 queue_msix_vector; // 0x1A // read-write
|
/// le16 queue_msix_vector; // 0x1A // read-write
|
||||||
/// le16 queue_enable; // 0x1C // read-write (Ready)
|
/// le16 queue_enable; // 0x1C // read-write (Ready)
|
||||||
/// le16 queue_notify_off; // 0x1E // read-only for driver
|
/// le16 queue_notify_off; // 0x1E // read-only for driver
|
||||||
/// le64 queue_desc; // 0x20 // read-write
|
/// le64 queue_desc; // 0x20 // read-write
|
||||||
/// le64 queue_avail; // 0x28 // read-write
|
/// le64 queue_avail; // 0x28 // read-write
|
||||||
/// le64 queue_used; // 0x30 // read-write
|
/// le64 queue_used; // 0x30 // read-write
|
||||||
pub struct VirtioPciCommonConfig {
|
pub struct VirtioPciCommonConfig {
|
||||||
pub access_platform: Option<Arc<dyn AccessPlatform>>,
|
pub access_platform: Option<Arc<dyn AccessPlatform>>,
|
||||||
pub driver_status: u8,
|
pub driver_status: u8,
|
||||||
|
@ -7,6 +7,7 @@
|
|||||||
//! virtio queue:
|
//! virtio queue:
|
||||||
//! - the packet header; and
|
//! - the packet header; and
|
||||||
//! - the packet data/buffer.
|
//! - the packet data/buffer.
|
||||||
|
//!
|
||||||
//! There is a 1:1 relation between descriptor chains and packets: the first (chain head) holds
|
//! There is a 1:1 relation between descriptor chains and packets: the first (chain head) holds
|
||||||
//! the header, and an optional second descriptor holds the data. The second descriptor is only
|
//! the header, and an optional second descriptor holds the data. The second descriptor is only
|
||||||
//! present for data packets (VSOCK_OP_RW).
|
//! present for data packets (VSOCK_OP_RW).
|
||||||
|
@ -71,6 +71,7 @@ impl MuxerRxQ {
|
|||||||
/// A push will fail when:
|
/// A push will fail when:
|
||||||
/// - trying to push a connection key onto an out-of-sync, or full queue; or
|
/// - trying to push a connection key onto an out-of-sync, or full queue; or
|
||||||
/// - trying to push an RST onto a queue already full of RSTs.
|
/// - trying to push an RST onto a queue already full of RSTs.
|
||||||
|
///
|
||||||
/// RSTs take precedence over connections, because connections can always be queried for
|
/// RSTs take precedence over connections, because connections can always be queried for
|
||||||
/// pending RX data later. Aside from this queue, there is no other storage for RSTs, so
|
/// pending RX data later. Aside from this queue, there is no other storage for RSTs, so
|
||||||
/// failing to push one means that we have to drop the packet.
|
/// failing to push one means that we have to drop the packet.
|
||||||
|
Loading…
Reference in New Issue
Block a user