Re: [PATCH v15 2/3] rust: io: mem: add a generic iomem abstraction

["Danilo Krummrich" <dakr@kernel.org>]

On Thu Jul 17, 2025 at 5:55 PM CEST, Daniel Almeida wrote:
> +    /// Maps an [`IoRequest`] where the size is known at compile time.
> +    ///
> +    /// This uses the [`ioremap()`] C API.
> +    ///
> +    /// [`ioremap()`]: https://docs.kernel.org/driver-api/device-io.html#getting-access-to-the-device
> +    ///
> +    /// # Examples
> +    ///
> +    /// The following example uses a [`platform::Device`] for illustration
> +    /// purposes.
> +    ///
> +    /// ```no_run
> +    /// use kernel::{bindings, c_str, platform, of, device::Core};
> +    /// struct SampleDriver;
> +    ///
> +    /// impl platform::Driver for SampleDriver {
> +    ///    # type IdInfo = ();
> +    ///    # const OF_ID_TABLE: Option<of::IdTable<Self::IdInfo>> = None;
> +    ///
> +    ///    fn probe(
> +    ///       pdev: &platform::Device<Core>,
> +    ///       info: Option<&Self::IdInfo>,
> +    ///    ) -> Result<Pin<KBox<Self>>> {
> +    ///       let offset = 0; // Some offset.
> +    ///
> +    ///       // If the size is known at compile time, use [`Self::iomap_sized`].
> +    ///       //
> +    ///       // No runtime checks will apply when reading and writing.
> +    ///       let request = pdev.io_request_by_index(0).ok_or(ENODEV)?;
> +    ///       let iomem = request.iomap_sized::<42>();
> +    ///       let iomem = KBox::pin_init(iomem, GFP_KERNEL)?;
> +    ///
> +    ///       let io = iomem.access(pdev.as_ref())?;
> +    ///
> +    ///       // Read and write a 32-bit value at `offset`.
> +    ///       let data = io.read32_relaxed(offset);
> +    ///
> +    ///       io.write32_relaxed(data, offset);
> +    ///
> +    ///       # Ok(KBox::new(SampleDriver, GFP_KERNEL)?.into())
> +    ///     }
> +    /// }
> +    /// ```
> +    pub fn iomap_sized<const SIZE: usize>(self) -> impl PinInit<Devres<IoMem<SIZE>>, Error> + 'a {
> +        IoMem::new(self)
> +    }

This doc-test and the one below break the build, since the used platform device
infrastructure is introduced with the next patch.

I can set them to `ignore` and we turn them into `no_run` with a subsequent
patch.

> +    /// Maps an [`IoRequest`] where the size is not known at compile time,
> +    ///
> +    /// This uses the [`ioremap()`] C API.
> +    ///
> +    /// [`ioremap()`]: https://docs.kernel.org/driver-api/device-io.html#getting-access-to-the-device
> +    ///
> +    /// # Examples
> +    ///
> +    /// The following example uses a [`platform::Device`] for illustration
> +    /// purposes.
> +    ///
> +    /// ```no_run
> +    /// use kernel::{bindings, c_str, platform, of, device::Core};
> +    /// struct SampleDriver;
> +    ///
> +    /// impl platform::Driver for SampleDriver {
> +    ///    # type IdInfo = ();
> +    ///    # const OF_ID_TABLE: Option<of::IdTable<Self::IdInfo>> = None;
> +    ///
> +    ///    fn probe(
> +    ///       pdev: &platform::Device<Core>,
> +    ///       info: Option<&Self::IdInfo>,
> +    ///    ) -> Result<Pin<KBox<Self>>> {
> +    ///       let offset = 0; // Some offset.
> +    ///
> +    ///       // Unlike [`Self::iomap_sized`], here the size of the memory region
> +    ///       // is not known at compile time, so only the `try_read*` and `try_write*`
> +    ///       // family of functions should be used, leading to runtime checks on every
> +    ///       // access.
> +    ///       let request = pdev.io_request_by_index(0).ok_or(ENODEV)?;
> +    ///       let iomem = request.iomap();
> +    ///       let iomem = KBox::pin_init(iomem, GFP_KERNEL)?;
> +    ///
> +    ///       let io = iomem.access(pdev.as_ref())?;
> +    ///
> +    ///       let data = io.try_read32_relaxed(offset)?;
> +    ///
> +    ///       io.try_write32_relaxed(data, offset)?;
> +    ///
> +    ///       # Ok(KBox::new(SampleDriver, GFP_KERNEL)?.into())
> +    ///     }
> +    /// }
> +    /// ```
> +    pub fn iomap(self) -> impl PinInit<Devres<IoMem<0>>, Error> + 'a {
> +        Self::iomap_sized::<0>(self)
> +    }
> +
> +    /// Same as [`Self::iomap`] but with exclusive access to the underlying
> +    /// region.
> +    pub fn iomap_exclusive(self) -> impl PinInit<Devres<ExclusiveIoMem<0>>, Error> + 'a {
> +        Self::iomap_exclusive_sized::<0>(self)
> +    }
> +}