rust: pci: normalise spelling of PCI BAR
Consistently refer to PCI base address register as PCI BAR. Fix spelling mistake "Mapps" -> "Maps". Link: https://lore.kernel.org/rust-for-linux/20251015225827.GA960157@bhelgaas/ Link: https://github.com/Rust-for-Linux/linux/issues/1196 Suggested-by: Bjorn Helgaas <helgaas@kernel.org> Signed-off-by: Peter Colberg <pcolberg@redhat.com> Signed-off-by: Danilo Krummrich <dakr@kernel.org>
This commit is contained in:
committed by
Danilo Krummrich
parent
c7f6d5380f
commit
26c1a20bf7
@@ -377,7 +377,7 @@ impl Device {
|
||||
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 @@ impl Device {
|
||||
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);
|
||||
|
||||
@@ -18,7 +18,7 @@ use kernel::prelude::*;
|
||||
/// # 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 @@ impl<const SIZE: usize> Bar<SIZE> {
|
||||
|
||||
/// # 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 @@ impl<const SIZE: usize> Deref for Bar<SIZE> {
|
||||
}
|
||||
|
||||
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 @@ impl Device<device::Bound> {
|
||||
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,
|
||||
|
||||
Reference in New Issue
Block a user