rust: pci: consistently use INTx and PCI BAR in comments
v2 cover rust: pci: consistently use INTx and PCI BAR in comments
This patch series normalises the comments of the Rust PCI abstractions to consistently refer to legacy as INTx interrupts and use the spelling PCI BAR, as a way to familiarise myself with the Rust for Linux project.
v2:
- Rebase onto driver-core-testing to follow "Rust PCI housekeeping" patches, which move I/O and IRQ specific code into sub-modules.
Peter Colberg (2):
rust: pci: refer to legacy as INTx interrupts
rust: pci: normalise spelling of PCI BAR
rust/kernel/pci.rs | 4 ++-- rust/kernel/pci/io.rs | 8 ++++---- rust/kernel/pci/irq.rs | 10 +++++----- 3 files changed, 11 insertions(+), 11 deletions(-)
Signature · 1 line
2.51.0
PATCH v2 1/2 rust: pci: refer to legacy as INTx interrupts
Consistently use INTx, as in the description of IrqType::Intx, to refer to the four legacy PCI interrupts, INTA#, INTB#, INTC#, and INTD#.
---
v2:
- Rebase onto driver-core-testing to follow "Rust PCI housekeeping" patches, which move I/O and IRQ specific code into sub-modules.
--- rust/kernel/pci/irq.rs | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-)
rust/kernel/pci/irq.rs +5 -5
@@ -42,7 +42,7 @@ const fn as_raw(self) -> u32 {pub struct IrqTypes (u32 );impl IrqTypes { -/// Create a set containing all IRQ types (MSI-X, MSI, and Legacy). +/// Create a set containing all IRQ types (MSI-X, MSI, and INTx). pub const fn all () ->Self {Self (bindings::PCI_IRQ_ALL_TYPES ) }
@@ -52,7 +52,7 @@ pub const fn all() -> Self {/// # Examples /// /// ```ignore -/// // Create a set with only MSI and MSI-X (no legacy interrupts). +/// // Create a set with only MSI and MSI-X (no INTx interrupts). /// let msi_only = IrqTypes::default() /// .with(IrqType::Msi) /// .with(IrqType::MsiX);
@@ -199,9 +199,9 @@ pub fn request_threaded_irq<'a, T: crate::irq::ThreadedHandler + 'static>(/// Allocate IRQ vectors for this PCI device with automatic cleanup. /// /// Allocates between `min_vecs` and `max_vecs` interrupt vectors for the device. -/// The allocation will use MSI-X, MSI, or legacy interrupts based on the `irq_types` +/// The allocation will use MSI-X, MSI, or INTx interrupts based on the `irq_types` /// parameter and hardware capabilities. When multiple types are specified, the kernel -/// will try them in order of preference: MSI-X first, then MSI, then legacy interrupts. +/// will try them in order of preference: MSI-X first, then MSI, then INTx interrupts. /// /// The allocated vectors are automatically freed when the device is unbound, using the /// devres (device resource management) system.
@@ -225,7 +225,7 @@ pub fn request_threaded_irq<'a, T: crate::irq::ThreadedHandler + 'static>(/// // Allocate using any available interrupt type in the order mentioned above. /// let vectors = dev.alloc_irq_vectors(1, 32, pci::IrqTypes::all())?; /// -/// // Allocate MSI or MSI-X only (no legacy interrupts). +/// // Allocate MSI or MSI-X only (no INTx interrupts). /// let msi_only = pci::IrqTypes::default() /// .with(pci::IrqType::Msi) /// .with(pci::IrqType::MsiX);
Signature · 1 line
2.51.0
PATCH v2 2/2 rust: pci: normalise spelling of PCI BAR
In reply to Peter ColbergConsistently refer to PCI base address register as PCI BAR. Fix spelling mistake "Mapps" -> "Maps".
---
v2:
- Rebase onto driver-core-testing to follow "Rust PCI housekeeping" patches, which move I/O and IRQ specific code into sub-modules.
--- rust/kernel/pci.rs | 4 ++-- rust/kernel/pci/io.rs | 8 ++++---- 2 files changed, 6 insertions(+), 6 deletions(-)
rust/kernel/pci.rs +2 -2
@@ -377,7 +377,7 @@ pub fn subsystem_device_id(&self) -> u16 {unsafe { (*self.as_raw ()).subsystem_device } } -/// Returns the start of the given PCI bar resource. +/// Returns the start of the given PCI BAR resource. pub fn resource_start (&self, bar:u32 ) ->Result <bindings::resource_size_t > {if !Bar ::index_is_valid (bar) {return Err (EINVAL );
@@ -389,7 +389,7 @@ pub fn resource_start(&self, bar: u32) -> Result<bindings::resource_size_t> {Ok (unsafe { bindings::pci_resource_start (self.as_raw (), bar.try_into ()?) }) } -/// Returns the size of the given PCI bar resource. +/// Returns the size of the given PCI BAR resource. pub fn resource_len (&self, bar:u32 ) ->Result <bindings::resource_size_t > {if !Bar ::index_is_valid (bar) {return Err (EINVAL );
rust/kernel/pci/io.rs +4 -4
@@ -18,7 +18,7 @@/// # Invariants /// /// `Bar` always holds an `IoRaw` inststance that holds a valid pointer to the start of the I/O -/// memory mapped PCI bar and its size. +/// memory mapped PCI BAR and its size. pub struct Bar <const SIZE :usize =0 > { pdev:ARef <Device >, io:IoRaw <SIZE >,
@@ -78,7 +78,7 @@ pub(super) fn new(pdev: &Device, num: u32, name: &CStr) -> Result<Self> {/// # Safety /// -/// `ioptr` must be a valid pointer to the memory mapped PCI bar number `num`. +/// `ioptr` must be a valid pointer to the memory mapped PCI BAR number `num`. unsafe fn do_release (pdev: &Device , ioptr:usize , num:i32 ) {// SAFETY: // `pdev` is valid by the invariants of `Device`.
@@ -120,7 +120,7 @@ fn deref(&self) -> &Self::Target { }impl Device <device::Bound > { -/// Mapps an entire PCI-BAR after performing a region-request on it. I/O operation bound checks +/// Maps an entire PCI BAR after performing a region-request on it. I/O operation bound checks /// can be performed on compile time for offsets (plus the requested type size) < SIZE. pub fn iomap_region_sized <'a,const SIZE :usize >( &'a self,
@@ -130,7 +130,7 @@ pub fn iomap_region_sized<'a, const SIZE: usize>(Devres ::new (self.as_ref (),Bar ::<SIZE >::new (self, bar, name)) } -/// Mapps an entire PCI-BAR after performing a region-request on it. +/// Maps an entire PCI BAR after performing a region-request on it. pub fn iomap_region <'a>( &'a self, bar: u32,
Signature · 1 line
2.51.0