libs/libvmbase/src/virtio/pci.rs

// Copyright 2022, The Android Open Source Project
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//! Functions to scan the PCI bus for VirtIO devices.

use crate::{
    fdt::pci::PciInfo,
    memory::{map_device, MemoryTrackerError},
};
use alloc::boxed::Box;
use core::fmt;
use core::marker::PhantomData;
use log::debug;
use once_cell::race::OnceBox;
use virtio_drivers::{
    device::{blk, socket},
    transport::pci::{
        bus::{BusDeviceIterator, ConfigurationAccess, PciRoot},
        virtio_device_type, PciTransport,
    },
    Hal,
};

pub(super) static PCI_INFO: OnceBox<PciInfo> = OnceBox::new();

/// PCI errors.
#[derive(Debug, Clone)]
pub enum PciError {
    /// Attempted to initialize the PCI more than once.
    DuplicateInitialization,
    /// Failed to map PCI CAM.
    CamMapFailed(MemoryTrackerError),
    /// Failed to map PCI BAR.
    BarMapFailed(MemoryTrackerError),
}

impl fmt::Display for PciError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match self {
            Self::DuplicateInitialization => {
                write!(f, "Attempted to initialize the PCI more than once.")
            }
            Self::CamMapFailed(e) => write!(f, "Failed to map PCI CAM: {e}"),
            Self::BarMapFailed(e) => write!(f, "Failed to map PCI BAR: {e}"),
        }
    }
}

/// Prepares to use VirtIO PCI devices.
///
/// In particular:
///
/// 1. Maps the PCI CAM and BAR range in the page table and MMIO guard.
/// 2. Stores the `PciInfo` for the VirtIO HAL to use later.
/// 3. Creates and returns a `PciRoot`.
///
/// This must only be called once and after having switched to the dynamic page tables.
pub fn initialize(pci_info: PciInfo) -> Result<PciRoot<impl ConfigurationAccess>, PciError> {
    PCI_INFO.set(Box::new(pci_info.clone())).map_err(|_| PciError::DuplicateInitialization)?;

    let cam_start = pci_info.cam_range.start;
    let cam_size = pci_info.cam_range.len().try_into().unwrap();
    map_device(cam_start, cam_size).map_err(PciError::CamMapFailed)?;

    let bar_start = pci_info.bar_range.start.try_into().unwrap();
    let bar_size = pci_info.bar_range.len().try_into().unwrap();
    map_device(bar_start, bar_size).map_err(PciError::BarMapFailed)?;

    // SAFETY: This is the only place where we call make_pci_root, validated by `PCI_INFO.set`.
    Ok(unsafe { pci_info.make_pci_root() })
}

/// Virtio Block device.
pub type VirtIOBlk<T> = blk::VirtIOBlk<T, PciTransport>;

/// Virtio Socket device.
///
/// Spec: https://docs.oasis-open.org/virtio/virtio/v1.2/csd01/virtio-v1.2-csd01.html 5.10
pub type VirtIOSocket<T> = socket::VirtIOSocket<T, PciTransport>;

/// An iterator that iterates over the PCI transport for each device.
pub struct PciTransportIterator<'a, T: Hal, C: ConfigurationAccess> {
    pci_root: &'a mut PciRoot<C>,
    bus: BusDeviceIterator<C>,
    _hal: PhantomData<T>,
}

impl<'a, T: Hal, C: ConfigurationAccess> PciTransportIterator<'a, T, C> {
    /// Creates a new iterator.
    pub fn new(pci_root: &'a mut PciRoot<C>) -> Self {
        let bus = pci_root.enumerate_bus(0);
        Self { pci_root, bus, _hal: PhantomData }
    }
}

impl<T: Hal, C: ConfigurationAccess> Iterator for PciTransportIterator<'_, T, C> {
    type Item = PciTransport;

    fn next(&mut self) -> Option<Self::Item> {
        loop {
            let (device_function, info) = self.bus.next()?;
            let (status, command) = self.pci_root.get_status_command(device_function);
            debug!(
                "Found PCI device {} at {}, status {:?} command {:?}",
                info, device_function, status, command
            );

            let Some(virtio_type) = virtio_device_type(&info) else {
                continue;
            };
            debug!("  VirtIO {:?}", virtio_type);

            return PciTransport::new::<T, C>(self.pci_root, device_function).ok();
        }
    }
}