feat(ixgbe): add network driver for the Intel X550

The initialization sequence follows the ixy.rs user space driver and the
X550 datasheet. The driver operates a single receive and transmit queue.

It prefers MSI-X over the legacy interrupt, because a hypervisor is not
obliged to offer one for a passed-through device and QEMU in fact does
not, which leaves MSI-X as the only way to receive interrupts at all.
Should neither be available, the device still makes progress when the
kernel is built with the idle-poll feature. This makes the msix module
available outside of virtio.

Author: stlankes

.github/workflows/ci.yml

@@ -54,28 +54,34 @@ jobs:
       - run: cargo clippy --package xtask
       - name: cargo hack clippy (x86_64)
         run: |
-          cargo hack clippy --each-feature --no-dev-deps --target x86_64-unknown-none --exclude-features dhcpv4,dns,gem-net,net,rtl8139,virtio-net
-          cargo hack clippy --each-feature --no-dev-deps --target x86_64-unknown-none --exclude-features dhcpv4,dns,gem-net,net,rtl8139,virtio-net --features pci
-          cargo hack clippy --each-feature --no-dev-deps --target x86_64-unknown-none --exclude-features gem-net,rtl8139 --features tcp,virtio-net
-          cargo hack clippy --each-feature --no-dev-deps --target x86_64-unknown-none --exclude-features gem-net,rtl8139 --features pci,tcp,virtio-net
-          cargo hack clippy --each-feature --no-dev-deps --target x86_64-unknown-none --exclude-features gem-net,virtio-net --features tcp,rtl8139
-          cargo hack clippy --each-feature --no-dev-deps --target x86_64-unknown-none --exclude-features gem-net,virtio-net --features pci,tcp,rtl8139
+          cargo hack clippy --each-feature --no-dev-deps --target x86_64-unknown-none --exclude-features dhcpv4,dns,gem-net,net,rtl8139,virtio-net,ixgbe
+          cargo hack clippy --each-feature --no-dev-deps --target x86_64-unknown-none --exclude-features dhcpv4,dns,gem-net,net,rtl8139,virtio-net,ixgbe --features pci
+          cargo hack clippy --each-feature --no-dev-deps --target x86_64-unknown-none --exclude-features gem-net,rtl8139,ixgbe --features tcp,virtio-net
+          cargo hack clippy --each-feature --no-dev-deps --target x86_64-unknown-none --exclude-features gem-net,rtl8139,ixgbe --features pci,tcp,virtio-net
+          cargo hack clippy --each-feature --no-dev-deps --target x86_64-unknown-none --exclude-features gem-net,virtio-net,ixgbe --features tcp,rtl8139
+          cargo hack clippy --each-feature --no-dev-deps --target x86_64-unknown-none --exclude-features gem-net,virtio-net,ixgbe --features pci,tcp,rtl8139
+          cargo hack clippy --each-feature --no-dev-deps --target x86_64-unknown-none --exclude-features gem-net,rtl8139,virtio-net --features tcp,ixgbe
+          cargo hack clippy --each-feature --no-dev-deps --target x86_64-unknown-none --exclude-features gem-net,rtl8139,virtio-net --features pci,tcp,ixgbe
       - name: cargo hack clippy (aarch64)
         run: |
-          cargo hack clippy --each-feature --no-dev-deps --target aarch64-unknown-none-softfloat --exclude-features dhcpv4,dns,gem-net,net,rtl8139,virtio-net
-          cargo hack clippy --each-feature --no-dev-deps --target aarch64-unknown-none-softfloat --exclude-features dhcpv4,dns,gem-net,net,rtl8139,virtio-net --features pci
-          cargo hack clippy --each-feature --no-dev-deps --target aarch64-unknown-none-softfloat --exclude-features gem-net,rtl8139 --features tcp,virtio-net
-          cargo hack clippy --each-feature --no-dev-deps --target aarch64-unknown-none-softfloat --exclude-features gem-net,rtl8139 --features pci,tcp,virtio-net
-          cargo hack clippy --each-feature --no-dev-deps --target aarch64-unknown-none-softfloat --exclude-features gem-net,virtio-net --features tcp,rtl8139
-          cargo hack clippy --each-feature --no-dev-deps --target aarch64-unknown-none-softfloat --exclude-features gem-net,virtio-net --features pci,tcp,rtl8139
+          cargo hack clippy --each-feature --no-dev-deps --target aarch64-unknown-none-softfloat --exclude-features dhcpv4,dns,gem-net,net,rtl8139,virtio-net,ixgbe
+          cargo hack clippy --each-feature --no-dev-deps --target aarch64-unknown-none-softfloat --exclude-features dhcpv4,dns,gem-net,net,rtl8139,virtio-net,ixgbe --features pci
+          cargo hack clippy --each-feature --no-dev-deps --target aarch64-unknown-none-softfloat --exclude-features gem-net,rtl8139,ixgbe --features tcp,virtio-net
+          cargo hack clippy --each-feature --no-dev-deps --target aarch64-unknown-none-softfloat --exclude-features gem-net,rtl8139,ixgbe --features pci,tcp,virtio-net
+          cargo hack clippy --each-feature --no-dev-deps --target aarch64-unknown-none-softfloat --exclude-features gem-net,virtio-net,ixgbe --features tcp,rtl8139
+          cargo hack clippy --each-feature --no-dev-deps --target aarch64-unknown-none-softfloat --exclude-features gem-net,virtio-net,ixgbe --features pci,tcp,rtl8139
+          cargo hack clippy --each-feature --no-dev-deps --target aarch64-unknown-none-softfloat --exclude-features gem-net,rtl8139,virtio-net --features tcp,ixgbe
+          cargo hack clippy --each-feature --no-dev-deps --target aarch64-unknown-none-softfloat --exclude-features gem-net,rtl8139,virtio-net --features pci,tcp,ixgbe
       - name: cargo hack clippy (riscv64)
         run: |
-          cargo hack clippy --each-feature --no-dev-deps --target riscv64gc-unknown-none-elf --exclude-features dhcpv4,dns,gem-net,net,rtl8139,virtio-net
-          cargo hack clippy --each-feature --no-dev-deps --target riscv64gc-unknown-none-elf --exclude-features dhcpv4,dns,gem-net,net,rtl8139,virtio-net --features pci
-          cargo hack clippy --each-feature --no-dev-deps --target riscv64gc-unknown-none-elf --exclude-features gem-net,rtl8139 --features tcp,virtio-net
-          cargo hack clippy --each-feature --no-dev-deps --target riscv64gc-unknown-none-elf --exclude-features gem-net,rtl8139 --features pci,tcp,virtio-net
-          cargo hack clippy --each-feature --no-dev-deps --target riscv64gc-unknown-none-elf --exclude-features rtl8139,virtio-net --features tcp,gem-net
-          cargo hack clippy --each-feature --no-dev-deps --target riscv64gc-unknown-none-elf --exclude-features rtl8139,virtio-net --features pci,tcp,gem-net
+          cargo hack clippy --each-feature --no-dev-deps --target riscv64gc-unknown-none-elf --exclude-features dhcpv4,dns,gem-net,net,rtl8139,virtio-net,ixgbe
+          cargo hack clippy --each-feature --no-dev-deps --target riscv64gc-unknown-none-elf --exclude-features dhcpv4,dns,gem-net,net,rtl8139,virtio-net,ixgbe --features pci
+          cargo hack clippy --each-feature --no-dev-deps --target riscv64gc-unknown-none-elf --exclude-features gem-net,rtl8139,ixgbe --features tcp,virtio-net
+          cargo hack clippy --each-feature --no-dev-deps --target riscv64gc-unknown-none-elf --exclude-features gem-net,rtl8139,ixgbe --features pci,tcp,virtio-net
+          cargo hack clippy --each-feature --no-dev-deps --target riscv64gc-unknown-none-elf --exclude-features rtl8139,virtio-net,ixgbe --features tcp,gem-net
+          cargo hack clippy --each-feature --no-dev-deps --target riscv64gc-unknown-none-elf --exclude-features rtl8139,virtio-net,ixgbe --features pci,tcp,gem-net
+          cargo hack clippy --each-feature --no-dev-deps --target riscv64gc-unknown-none-elf --exclude-features gem-net,rtl8139,virtio-net --features tcp,ixgbe
+          cargo hack clippy --each-feature --no-dev-deps --target riscv64gc-unknown-none-elf --exclude-features gem-net,rtl8139,virtio-net --features pci,tcp,ixgbe
 
   format:
     name: Format

Cargo.toml

@@ -208,6 +208,9 @@ virtio-net = ["net", "virtio"]
 ## Enables the RTL8139 network driver.
 rtl8139 = ["net", "pci", "volatile/derive", "endian-num"]
 
+## Enables the ixgbe network driver for the Intel X550.
+ixgbe = ["net", "pci", "volatile/derive"]
+
 ## Enables the Cadence Gigabit Ethernet MAC (GEM) network driver.
 gem-net = ["net", "dep:tock-registers"]
 

src/arch/aarch64/kernel/processor.rs

@@ -256,6 +256,17 @@ pub fn get_timestamp() -> u64 {
 	CNTVCT_EL0.get() - BOOT_COUNTER.get().unwrap()
 }
 
+#[cfg(feature = "ixgbe")]
+#[inline]
+pub fn udelay(usecs: u64) {
+	let khz: u64 = CPU_FREQUENCY.get().into();
+	let ticks = (khz * usecs).div_ceil(1_000).max(1);
+	let end = get_timestamp() + ticks;
+	while get_timestamp() < end {
+		core::hint::spin_loop();
+	}
+}
+
 #[inline]
 #[allow(dead_code)]
 pub fn supports_1gib_pages() -> bool {

src/arch/riscv64/kernel/processor.rs

@@ -262,6 +262,17 @@ pub fn get_timestamp() -> u64 {
 	time::read64()
 }
 
+#[cfg(feature = "ixgbe")]
+#[inline]
+pub fn udelay(usecs: u64) {
+	// Round up so that even sub-tick delays wait at least one tick.
+	let ticks = (get_timebase_freq() * usecs).div_ceil(1_000_000).max(1);
+	let end = get_timestamp() + ticks;
+	while get_timestamp() < end {
+		core::hint::spin_loop();
+	}
+}
+
 pub fn supports_1gib_pages() -> bool {
 	true
 }

src/drivers/mod.rs

@@ -35,12 +35,15 @@ pub mod error {
 	#[cfg(any(
 		feature = "virtio",
 		all(target_arch = "riscv64", feature = "gem-net", not(feature = "pci")),
+		feature = "ixgbe",
 		feature = "rtl8139",
 	))]
 	use thiserror::Error;
 
 	#[cfg(all(target_arch = "riscv64", feature = "gem-net", not(feature = "pci")))]
 	use crate::drivers::net::gem::GEMError;
+	#[cfg(feature = "ixgbe")]
+	use crate::drivers::net::ixgbe::IxgbeError;
 	#[cfg(feature = "rtl8139")]
 	use crate::drivers::net::rtl8139::RTL8139Error;
 	#[cfg(feature = "virtio")]
@@ -49,6 +52,7 @@ pub mod error {
 	#[cfg(any(
 		feature = "virtio",
 		all(target_arch = "riscv64", feature = "gem-net", not(feature = "pci")),
+		feature = "ixgbe",
 		feature = "rtl8139",
 	))]
 	#[derive(Error, Debug)]
@@ -57,6 +61,10 @@ pub mod error {
 		#[error("Virtio driver failed: {0:?}")]
 		InitVirtioDevFail(#[from] VirtioError),
 
+		#[cfg(feature = "ixgbe")]
+		#[error("ixgbe driver failed: {0:?}")]
+		InitIxgbeDevFail(#[from] IxgbeError),
+
 		#[cfg(feature = "rtl8139")]
 		#[error("RTL8139 driver failed: {0:?}")]
 		InitRTL8139DevFail(#[from] RTL8139Error),