Commit 9f92d7d1 authored by Marko Turk's avatar Marko Turk Committed by Danilo Krummrich
Browse files

rust: pci: fix typos in Bar struct's comments 



Fix a typo in the doc-comment of the Bar structure: 'inststance ->
instance'.

Add also 'is' to the comment inside Bar's `new()` function (suggested
by Dirk):
// `pdev` is valid by the invariants of `Device`.

Fixes: bf9651f8 ("rust: pci: implement I/O mappable `pci::Bar`")
Suggested-by: default avatarDirk Behme <dirk.behme@de.bosch.com>
Signed-off-by: default avatarMarko Turk <mt@markoturk.info>
Reviewed-by: default avatarDirk Behme <dirk.behme@de.bosch.com>
Link: https://patch.msgid.link/20260105213726.73000-2-mt@markoturk.info


Signed-off-by: default avatarDanilo Krummrich <dakr@kernel.org>
parent a9a42f07

rust/kernel/pci/io.rs

+2 −2
Original line number Diff line number Diff line
@@ -20,7 +20,7 @@ 
///

/// # Invariants

///

/// `Bar` always holds an `IoRaw` inststance that holds a valid pointer to the start of the I/O

/// `Bar` always holds an `IoRaw` instance that holds a valid pointer to the start of the I/O

/// memory mapped PCI BAR and its size.

pub struct Bar<const SIZE: usize = 0> {

    pdev: ARef<Device>,
@@ -54,7 +54,7 @@ pub(super) fn new(pdev: &Device, num: u32, name: &CStr) -> Result<Self> { 
        let ioptr: usize = unsafe { bindings::pci_iomap(pdev.as_raw(), num, 0) } as usize;

        if ioptr == 0 {

            // SAFETY:

            // `pdev` valid by the invariants of `Device`.

            // `pdev` is valid by the invariants of `Device`.

            // `num` is checked for validity by a previous call to `Device::resource_len`.

            unsafe { bindings::pci_release_region(pdev.as_raw(), num) };

            return Err(ENOMEM);