rust: pci: consistently use INTx and PCI BAR in comments
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.
Peter Colberg (2):
rust: pci: refer to legacy as INTx interrupts
rust: pci: normalise spelling of PCI BAR
rust/kernel/pci.rs | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-)
Signature · 1 line
2.51.0
PATCH 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#.
--- rust/kernel/pci.rs | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-)
rust/kernel/pci.rs +5 -5
@@ -56,7 +56,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 ) }
@@ -66,7 +66,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);
@@ -722,9 +722,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.
@@ -748,7 +748,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 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".
--- rust/kernel/pci.rs | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-)
rust/kernel/pci.rs +6 -6
@@ -363,7 +363,7 @@ pub struct Device<Ctx: device::DeviceContext = device::Normal>(/// # 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 >,
@@ -423,7 +423,7 @@ 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`.
@@ -537,7 +537,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 );
@@ -549,7 +549,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 );
@@ -656,7 +656,7 @@ fn drop(&mut self) { }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,
@@ -666,7 +666,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
Danilo Krummrich
maintainerHi Peter,
Quoted 3 lines · Peter Colberg
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.
That's great to hear! :)
Can you please rebase the two patches on driver-core-testing [1]?
Quoted 10 lines · Danilo Krummrich
Quoted 3 lines · Peter Colberg
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.
That's great to hear! :)
Can you please rebase the two patches on driver-core-testing [1]?
Thanks Danilo, I have sent a v2 [2] rebased onto your "Rust PCI housekeeping" patch series in driver-core-testing.
[2] https://lore.kernel.org/rust-for-linux/[email protected]/
Peter
Danilo Krummrich
maintainerQuoted 3 lines · Peter Colberg
Peter Colberg (2):
rust: pci: refer to legacy as INTx interrupts
rust: pci: normalise spelling of PCI BAR
Applied to driver-core-testing, thanks!