ax-driver 0.5.11

ArceOS device drivers
Documentation
use ax_driver_pci::{
    BarInfo, Cam, Command, ConfigurationAccess, DeviceFunction, HeaderType, MemoryBarType, MmioCam,
    PciRangeAllocator, PciRoot,
};
use ax_hal::mem::phys_to_virt;

use crate::{AllDevices, prelude::*};

const PCI_BAR_NUM: u8 = 6;

fn config_pci_device<C: ConfigurationAccess>(
    root: &mut PciRoot<C>,
    bdf: DeviceFunction,
    allocator: &mut Option<PciRangeAllocator>,
) -> DevResult {
    let mut bar = 0;
    while bar < PCI_BAR_NUM {
        let info = root.bar_info(bdf, bar).map_err(|err| {
            warn!("failed to read PCI BAR {bar} info for {bdf}: {err:?}");
            DevError::Io
        })?;
        if let Some(BarInfo::Memory {
            address_type,
            address,
            size,
            ..
        }) = info
        {
            // if the BAR address is not assigned, call the allocator and assign it.
            if size > 0 && address == 0 {
                let new_addr = allocator
                    .as_mut()
                    .expect("No memory ranges available for PCI BARs!")
                    .alloc(size as _)
                    .ok_or(DevError::NoMemory)?;
                if address_type == MemoryBarType::Width32 {
                    root.set_bar_32(bdf, bar, new_addr as _);
                } else if address_type == MemoryBarType::Width64 {
                    root.set_bar_64(bdf, bar, new_addr);
                }
            }
        }

        // read the BAR info again after assignment.
        let info = root.bar_info(bdf, bar).map_err(|err| {
            warn!("failed to re-read PCI BAR {bar} info for {bdf}: {err:?}");
            DevError::Io
        })?;
        match info {
            Some(BarInfo::IO { address, size }) if address > 0 && size > 0 => {
                debug!("  BAR {}: IO  [{:#x}, {:#x})", bar, address, address + size);
            }
            Some(BarInfo::Memory {
                address_type,
                prefetchable,
                address,
                size,
            }) if address > 0 && size > 0 => {
                debug!(
                    "  BAR {}: MEM [{:#x}, {:#x}){}{}",
                    bar,
                    address,
                    address + size,
                    if address_type == MemoryBarType::Width64 {
                        " 64bit"
                    } else {
                        ""
                    },
                    if prefetchable { " pref" } else { "" },
                );
            }
            None => {}
            Some(_) => {}
        }

        bar += 1;
        if info.as_ref().is_some_and(BarInfo::takes_two_entries) {
            bar += 1;
        }
    }

    // Enable the device.
    let (_status, cmd) = root.get_status_command(bdf);
    root.set_command(
        bdf,
        cmd | Command::IO_SPACE | Command::MEMORY_SPACE | Command::BUS_MASTER,
    );
    Ok(())
}

impl AllDevices {
    pub(crate) fn probe_bus_devices(&mut self) {
        let base_vaddr = phys_to_virt(ax_config::devices::PCI_ECAM_BASE.into());
        let mut root = PciRoot::new(unsafe { MmioCam::new(base_vaddr.as_mut_ptr(), Cam::Ecam) });

        // PCI 32-bit MMIO space
        let mut allocator = ax_config::devices::PCI_RANGES
            .get(1)
            .map(|range| PciRangeAllocator::new(range.0 as u64, range.1 as u64));

        for bus in 0..=ax_config::devices::PCI_BUS_END as u8 {
            for (bdf, dev_info) in root.enumerate_bus(bus) {
                debug!("PCI {bdf}: {dev_info}");
                if dev_info.header_type != HeaderType::Standard {
                    continue;
                }
                match config_pci_device(&mut root, bdf, &mut allocator) {
                    Ok(_) => for_each_drivers!(type Driver, {
                        if let Some(dev) = Driver::probe_pci(&mut root, bdf, &dev_info) {
                            info!(
                                "registered a new {:?} device at {}: {:?}",
                                dev.device_type(),
                                bdf,
                                dev.device_name(),
                            );
                            self.add_device(dev);
                            continue; // skip to the next device
                        }
                    }),
                    Err(e) => warn!("failed to enable PCI device at {bdf}({dev_info}): {e:?}"),
                }
            }
        }
    }
}