Skip to content

Commit

Permalink
refactor(virtio/pci): migrate IsrStatusRaw to virtio-spec
Browse files Browse the repository at this point in the history
Signed-off-by: Martin Kröning <martin.kroening@eonerc.rwth-aachen.de>
  • Loading branch information
mkroening committed Jun 2, 2024
1 parent 7f86dce commit a34b006
Showing 1 changed file with 20 additions and 43 deletions.
63 changes: 20 additions & 43 deletions src/drivers/virtio/transport/pci.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,10 @@ use core::ptr::NonNull;
use core::sync::atomic::{fence, Ordering};
use core::{mem, ptr};

use virtio_spec::pci::{CommonCfg, CommonCfgVolatileFieldAccess, CommonCfgVolatileWideFieldAccess};
use virtio_spec::pci::{
CommonCfg, CommonCfgVolatileFieldAccess, CommonCfgVolatileWideFieldAccess,
IsrStatus as IsrStatusRaw,
};
use virtio_spec::DeviceStatus;
use volatile::VolatileRef;

Expand Down Expand Up @@ -250,7 +253,7 @@ impl PciCap {
Some(com_cfg_raw)
}

fn map_isr_status(&self) -> Option<&'static mut IsrStatusRaw> {
fn map_isr_status(&self) -> Option<VolatileRef<'static, IsrStatusRaw>> {
if self.bar.length < u64::from(self.length + self.offset) {
error!("ISR status config with id {} of device {:x}, does not fit into memory specified by bar {:x}!",
self.id,
Expand All @@ -261,10 +264,13 @@ impl PciCap {
}

let virt_addr_raw: VirtMemAddr = self.bar.mem_addr + self.offset;
let ptr = NonNull::new(ptr::with_exposed_provenance_mut::<IsrStatusRaw>(
virt_addr_raw.into(),
))
.unwrap();

// Create mutable reference to the PCI structure in the devices memory area
let isr_stat_raw: &mut IsrStatusRaw =
unsafe { &mut *(ptr::with_exposed_provenance_mut(virt_addr_raw.into())) };
let isr_stat_raw = unsafe { VolatileRef::new(ptr) };

Some(isr_stat_raw)
}
Expand Down Expand Up @@ -813,67 +819,38 @@ impl NotifCtrl {
pub struct IsrStatus {
/// References the raw structure in PCI memory space. Is static as
/// long as the device is present, which is mandatory in order to let this code work.
isr_stat: &'static mut IsrStatusRaw,
isr_stat: VolatileRef<'static, IsrStatusRaw>,
/// Preferences of the device for this config. From 1 (highest) to 2^7-1 (lowest)
rank: u8,
}

impl IsrStatus {
fn new(raw: &'static mut IsrStatusRaw, rank: u8) -> Self {
fn new(raw: VolatileRef<'static, IsrStatusRaw>, rank: u8) -> Self {
IsrStatus {
isr_stat: raw,
rank,
}
}

pub fn is_interrupt(&self) -> bool {
self.isr_stat.flags & 1 << 0 == 1
self.isr_stat
.as_ptr()
.read()
.contains(IsrStatusRaw::QUEUE_INTERRUPT)
}

pub fn is_cfg_change(&self) -> bool {
self.isr_stat.flags & 1 << 1 == 1 << 1
self.isr_stat
.as_ptr()
.read()
.contains(IsrStatusRaw::DEVICE_CONFIGURATION_INTERRUPT)
}

pub fn acknowledge(&mut self) {
// nothing to do
}
}

/// ISR status structure of Virtio PCI devices.
/// See Virtio specification v1.1. - 4.1.4.5
///
/// Contains a single byte, containing the interrupt numbers used
/// for handling interrupts.
/// The 8-bit field is read as an bitmap and allows to distinguish between
/// interrupts triggered by changes in the configuration and interrupts
/// triggered by events of a virtqueue.
///
/// Bitmap layout (from least to most significant bit in the byte):
///
/// 0 : Queue interrupt
///
/// 1 : Device configuration interrupt
///
/// 2 - 31 : Reserved
#[repr(C)]
struct IsrStatusRaw {
flags: u8,
}

impl IsrStatusRaw {
// returns true if second bit, from left is 1.
// read DOES reset flag
fn cfg_event() -> bool {
unimplemented!();
}

// returns true if first bit, from left is 1.
// read DOES reset flag
fn vqueue_event() -> bool {
unimplemented!();
}
}

/// PCI configuration access structure of Virtio PCI devices.
/// See Virtio specification v1.1. - 4.1.4.8
///
Expand Down

0 comments on commit a34b006

Please sign in to comment.