add support of console

Add structs and constants, which are derived from
the specification Virtual I/O Device (VIRTIO), Version 1.2

Author: stlankes

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "virtio-spec"
-version = "0.2.0"
+version = "0.2.1"
 authors = ["Martin Kröning <mkroening@posteo.net>"]
 edition = "2021"
 description = "Definitions from the Virtual I/O Device (VIRTIO) specification."

Cargo.toml

@@ -0,0 +1,83 @@
+//! Console Device
+
+use volatile::access::ReadOnly;
+use volatile_macro::VolatileFieldAccess;
+
+pub use super::features::console::F;
+use crate::{le16, le32};
+
+/// Conspole Device Configuration Layout
+///
+/// Use [`ConfigVolatileFieldAccess`] to work with this struct.
+#[doc(alias = "virtio_console_config")]
+#[cfg_attr(
+    feature = "zerocopy",
+    derive(
+        zerocopy_derive::KnownLayout,
+        zerocopy_derive::Immutable,
+        zerocopy_derive::FromBytes,
+    )
+)]
+#[derive(VolatileFieldAccess)]
+#[repr(C)]
+pub struct Config {
+    #[access(ReadOnly)]
+    cols: le16,
+    #[access(ReadOnly)]
+    rows: le16,
+    #[access(ReadOnly)]
+    max_nr_ports: le16,
+    #[access(ReadOnly)]
+    emerg_wr: le32,
+}
+
+/// The layout of the console control message
+#[doc(alias = "virtio_console_control")]
+#[cfg_attr(
+    feature = "zerocopy",
+    derive(
+        zerocopy_derive::KnownLayout,
+        zerocopy_derive::Immutable,
+        zerocopy_derive::FromBytes,
+        zerocopy_derive::IntoBytes,
+    )
+)]
+#[derive(Clone, Copy, Debug)]
+#[repr(C)]
+pub struct ConsoleControl {
+    /// Port number
+    pub id: le32,
+    /// The kind of control event
+    pub event: Event,
+    /// Extra information for the event
+    pub value: le16,
+}
+
+endian_bitflags! {
+    #[doc(alias = "VIRTIO_CONSOLE")]
+    pub struct Event: le16 {
+        #[doc(alias = "VIRTIO_CONSOLE_DEVICE_READY")]
+        const DEVICE_READY = 0;
+
+        #[doc(alias = "VIRTIO_CONSOLE_DEVICE_ADD")]
+        const DEVICE_ADD = 1;
+
+         #[doc(alias = "VIRTIO_CONSOLE_DEVICE_REMOVE")]
+        const DEVICE_REMOVE = 2;
+
+        #[doc(alias = "VIRTIO_CONSOLE_PORT_READY")]
+        const PORT_READY = 3;
+
+        #[doc(alias = "VIRTIO_CONSOLE_CONSOLE_PORT")]
+        const CONSOLE_PORT = 4;
+
+        #[doc(alias = "VIRTIO_CONSOLE_RESIZE")]
+        const CONSOLE_RESIZE = 5;
+
+        #[doc(alias = "VIRTIO_CONSOLE_PORT_OPEN")]
+        const PORT_OPEN = 6;
+
+        #[doc(alias = "VIRTIO_CONSOLE_PORT_NAME")]
+        const PORT_NAME = 7;
+    }
+}

src/console.rs

@@ -289,6 +289,30 @@ macro_rules! feature_bits {
     () => {};
 }
 
+pub mod console {
+    use crate::le128;
+
+    feature_bits! {
+        /// Console Device Feature Bits
+        #[doc(alias = "VIRTIO_CONSOLE_F")]
+        pub struct F: le128 {
+            /// Configuration cols and rows are valid.
+            #[doc(alias = "VIRTIO_CONSOLE_F_SIZE")]
+            const SIZE = 1 << 0;
+
+            /// Device has support for multiple ports; max_nr_ports is valid and control virtqueues will be used.
+            #[doc(alias = "VIRTIO_CONSOLE_F_MULTIPORT")]
+            const MULTIPORT = 1 << 1;
+
+            /// Device has support for emergency write. Configuration field emerg_wr is valid.
+            #[doc(alias = "VIRTIO_CONSOLE_F_EMERG_WRITE")]
+            const EMERG_WRITE = 1 << 2;
+        }
+    }
+
+    impl crate::FeatureBits for F {}
+}
+
 pub mod net {
     use crate::le128;
 

src/features.rs

@@ -61,27 +61,27 @@
 //!
 //! ## Device Types
 //!
-//! | Device Type                       | Available | Module    |
-//! | --------------------------------- | --------- | --------- |
-//! | Network Device                    | ✅        | [`net`]   |
-//! | Block Device                      | ❌        |           |
-//! | Console Device                    | ❌        |           |
-//! | Entropy Device                    | ❌        |           |
-//! | Traditional Memory Balloon Device | ❌        |           |
-//! | SCSI Host Device                  | ❌        |           |
-//! | GPU Device                        | ❌        |           |
-//! | Input Device                      | ❌        |           |
-//! | Crypto Device                     | ❌        |           |
-//! | Socket Device                     | ✅        | [`vsock`] |
-//! | File System Device                | ✅        | [`fs`]    |
-//! | RPMB Device                       | ❌        |           |
-//! | IOMMU Device                      | ❌        |           |
-//! | Sound Device                      | ❌        |           |
-//! | Memory Device                     | ❌        |           |
-//! | I2C Adapter Device                | ❌        |           |
-//! | SCMI Device                       | ❌        |           |
-//! | GPIO Device                       | ❌        |           |
-//! | PMEM Device                       | ❌        |           |
+//! | Device Type                       | Available | Module      |
+//! | --------------------------------- | --------- | ----------- |
+//! | Network Device                    | ✅        | [`net`]     |
+//! | Block Device                      | ❌        |             |
+//! | Console Device                    | ✅        | [`console`] |
+//! | Entropy Device                    | ❌        |             |
+//! | Traditional Memory Balloon Device | ❌        |             |
+//! | SCSI Host Device                  | ❌        |             |
+//! | GPU Device                        | ❌        |             |
+//! | Input Device                      | ❌        |             |
+//! | Crypto Device                     | ❌        |             |
+//! | Socket Device                     | ✅        | [`vsock`]   |
+//! | File System Device                | ✅        | [`fs`]      |
+//! | RPMB Device                       | ❌        |             |
+//! | IOMMU Device                      | ❌        |             |
+//! | Sound Device                      | ❌        |             |
+//! | Memory Device                     | ❌        |             |
+//! | I2C Adapter Device                | ❌        |             |
+//! | SCMI Device                       | ❌        |             |
+//! | GPIO Device                       | ❌        |             |
+//! | PMEM Device                       | ❌        |             |
 
 #![cfg_attr(not(test), no_std)]
 #![cfg_attr(docsrs, feature(doc_auto_cfg))]
@@ -94,6 +94,7 @@ extern crate alloc;
 mod bitflags;
 #[macro_use]
 pub mod volatile;
+pub mod console;
 #[cfg(any(feature = "mmio", feature = "pci"))]
 mod driver_notifications;
 mod features;