From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from sender4-pp-f112.zoho.com (sender4-pp-f112.zoho.com [136.143.188.112]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 7A2AA25F7B3; Fri, 9 May 2025 20:30:48 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=pass smtp.client-ip=136.143.188.112 ARC-Seal:i=2; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1746822650; cv=pass; b=KfzGGE5rnXzQ0hAYvElcMoGIPMTys9Vy+5NzAm0J+ItZBbOzO+tcdqCX08xvJZGfGzX4+PxU7b9AUSQrmPrdM4AAuMZ9WVya7k4bJ3OWUQlt5AWZR+wDzA3PuhiF+1sB6vkSelidE+1Cm79inyXQgXGcpgwKNnLcJ6g1v+rpevY= ARC-Message-Signature:i=2; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1746822650; c=relaxed/simple; bh=n6iBZEKC7b1A19dgwBZKq3eENbDYxbgNt8NmamepdVg=; h=From:Date:Subject:MIME-Version:Content-Type:Message-Id:References: In-Reply-To:To:Cc; b=lZkxjOKrLCQBe79URouUmuF6DL1vWcu73PJtoJrsNvfe+zrrRx/ls/c/IiAa/lfrwCGppqhZhJdrNVVG4B2pQwI4TLitZy07i4X0feMRDFnxnw3lZcqkEAvMk6fWYYTtdlWkvxLRJosvZ1JQk3iEWikPR3l8Rthr53hFJaNBqTs= ARC-Authentication-Results:i=2; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=collabora.com; spf=pass smtp.mailfrom=collabora.com; dkim=pass (1024-bit key) header.d=collabora.com header.i=daniel.almeida@collabora.com header.b=VSWL4Skz; arc=pass smtp.client-ip=136.143.188.112 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=collabora.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=collabora.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (1024-bit key) header.d=collabora.com header.i=daniel.almeida@collabora.com header.b="VSWL4Skz" ARC-Seal: i=1; a=rsa-sha256; t=1746822624; cv=none; d=zohomail.com; s=zohoarc; b=R93zAo16M3KcGcnftAiWN9CtHwaLDaFG5Xj4mEM1xgCfbIw+jwFJ06kHWVKZmzSeXxfGRfQ5ag5c/WNuhPQfITrDKjOfQx2YiAm+Uzj+qNKBoJssNexzezdKM7on+O3yq+PgnwAtyERFQyVC4gEZWsrCnRGRddfKWAGCiR/4IhE= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1746822624; h=Content-Type:Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:In-Reply-To:MIME-Version:Message-ID:References:Subject:Subject:To:To:Message-Id:Reply-To; bh=IHNnTNoRHEhViDIcNzcdIZD2pLEPrg3khBgSs7hvQLI=; b=id+iw5TZVBO6tLfqpz4AZb7rZ1bRaQoVNvLXkO9tbHe8lHYeXMVPpzVce3vOsiTXEKTLQt4Wz/CKMvJYBQOUzJTdF3RR4Re7f/NNQx+I/LQ4bjbVbI9nmk725WG5kmhZe+yk5PorJFgqzmGnKmCBNfMPMysgHAcAqMl85tqtZO0= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass header.i=collabora.com; spf=pass smtp.mailfrom=daniel.almeida@collabora.com; dmarc=pass header.from= DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; t=1746822624; s=zohomail; d=collabora.com; i=daniel.almeida@collabora.com; h=From:From:Date:Date:Subject:Subject:MIME-Version:Content-Type:Content-Transfer-Encoding:Message-Id:Message-Id:References:In-Reply-To:To:To:Cc:Cc:Reply-To; bh=IHNnTNoRHEhViDIcNzcdIZD2pLEPrg3khBgSs7hvQLI=; b=VSWL4SkzXajuvmvs/GkhU5XltpfszkQalFaKuxGOSC4Z7tPCzAOja4I6AMnuTS5g MhDGvl5hm5d9jUT5qRzgzV+0npAYnklKw8gfTHGs0Vq/EmFhreq09bc86Qpp+gI2MaW dIVNPU443IigSGAtp/3KOQO5/8FjOeU+2pNg2tz8= Received: by mx.zohomail.com with SMTPS id 1746822622373541.8068002187404; Fri, 9 May 2025 13:30:22 -0700 (PDT) From: Daniel Almeida Date: Fri, 09 May 2025 17:29:46 -0300 Subject: [PATCH v8 1/3] rust: io: add resource abstraction Precedence: bulk X-Mailing-List: rust-for-linux@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: 7bit Message-Id: <20250509-topics-tyr-platform_iomem-v8-1-e9f1725a40da@collabora.com> References: <20250509-topics-tyr-platform_iomem-v8-0-e9f1725a40da@collabora.com> In-Reply-To: <20250509-topics-tyr-platform_iomem-v8-0-e9f1725a40da@collabora.com> To: Miguel Ojeda , Alex Gaynor , Boqun Feng , Gary Guo , =?utf-8?q?Bj=C3=B6rn_Roy_Baron?= , Benno Lossin , Andreas Hindborg , Alice Ryhl , Trevor Gross , Danilo Krummrich , Greg Kroah-Hartman , "Rafael J. Wysocki" , Andrew Morton , Andy Shevchenko , =?utf-8?q?Ilpo_J=C3=A4rvinen?= , Bjorn Helgaas , Mika Westerberg , Ying Huang Cc: linux-kernel@vger.kernel.org, rust-for-linux@vger.kernel.org, Fiona Behrens , Daniel Almeida X-Mailer: b4 0.14.2 X-ZohoMailClient: External In preparation for ioremap support, add a Rust abstraction for struct resource. A future commit will introduce the Rust API to ioremap a resource from a platform device. The current abstraction, therefore, adds only the minimum API needed to get that done. Co-developed-by: Fiona Behrens Signed-off-by: Fiona Behrens Signed-off-by: Daniel Almeida --- rust/bindings/bindings_helper.h | 1 + rust/helpers/io.c | 36 +++++++ rust/kernel/io.rs | 2 + rust/kernel/io/resource.rs | 222 ++++++++++++++++++++++++++++++++++++++++ 4 files changed, 261 insertions(+) diff --git a/rust/bindings/bindings_helper.h b/rust/bindings/bindings_helper.h index ab37e1d35c70d52e69b754bf855bc19911d156d8..b0c1a7ec3ef6f64834dc0e8c07931b7d40c975a9 100644 --- a/rust/bindings/bindings_helper.h +++ b/rust/bindings/bindings_helper.h @@ -19,6 +19,7 @@ #include #include #include +#include #include #include #include diff --git a/rust/helpers/io.c b/rust/helpers/io.c index 4c2401ccd72078af4e6901f4cd95f9070522f396..939ab38ca61dac4cf884677a20edc760094d5812 100644 --- a/rust/helpers/io.c +++ b/rust/helpers/io.c @@ -1,6 +1,7 @@ // SPDX-License-Identifier: GPL-2.0 #include +#include void __iomem *rust_helper_ioremap(phys_addr_t offset, size_t size) { @@ -99,3 +100,38 @@ void rust_helper_writeq_relaxed(u64 value, volatile void __iomem *addr) writeq_relaxed(value, addr); } #endif + +resource_size_t rust_helper_resource_size(struct resource *res) +{ + return resource_size(res); +} + +struct resource *rust_helper_request_mem_region(resource_size_t start, + resource_size_t n, + const char *name) +{ + return request_mem_region(start, n, name); +} + +void rust_helper_release_mem_region(resource_size_t start, resource_size_t n) +{ + release_mem_region(start, n); +} + +struct resource *rust_helper_request_region(resource_size_t start, + resource_size_t n, const char *name) +{ + return request_region(start, n, name); +} + +struct resource *rust_helper_request_muxed_region(resource_size_t start, + resource_size_t n, + const char *name) +{ + return request_muxed_region(start, n, name); +} + +void rust_helper_release_region(resource_size_t start, resource_size_t n) +{ + release_region(start, n); +} diff --git a/rust/kernel/io.rs b/rust/kernel/io.rs index 72d80a6f131e3e826ecd9d2c3bcf54e89aa60cc3..1da447078633e058000953a581b59d3ed5eb0e69 100644 --- a/rust/kernel/io.rs +++ b/rust/kernel/io.rs @@ -7,6 +7,8 @@ use crate::error::{code::EINVAL, Result}; use crate::{bindings, build_assert}; +pub mod resource; + /// Raw representation of an MMIO region. /// /// By itself, the existence of an instance of this structure does not provide any guarantees that diff --git a/rust/kernel/io/resource.rs b/rust/kernel/io/resource.rs new file mode 100644 index 0000000000000000000000000000000000000000..3eb5c8ef585078398551fe8189fd96c1b6c1eeff --- /dev/null +++ b/rust/kernel/io/resource.rs @@ -0,0 +1,222 @@ +// SPDX-License-Identifier: GPL-2.0 + +//! Abstraction for system resources. +//! +//! C header: [`include/linux/ioport.h`](srctree/include/linux/ioport.h) + +use core::ops::Deref; +use core::ptr::NonNull; + +use crate::str::CStr; +use crate::types::Opaque; + +#[cfg(CONFIG_HAS_IOPORT)] +/// Returns a reference to the global `ioport_resource` variable. +pub fn ioport_resource() -> &'static Resource { + // SAFETY: `bindings::ioport_resoure` has global lifetime and is of type Resource. + unsafe { Resource::from_ptr(core::ptr::addr_of_mut!(bindings::ioport_resource)) } +} + +#[cfg(CONFIG_HAS_IOMEM)] +/// Returns a reference to the global `iomem_resource` variable. +pub fn iomem_resource() -> &'static Resource { + // SAFETY: `bindings::iomem_resoure` has global lifetime and is of type Resource. + unsafe { Resource::from_ptr(core::ptr::addr_of_mut!(bindings::iomem_resource)) } +} + +/// Resource Size type. +/// +/// This is a type alias to `u64` depending on the config option +/// `CONFIG_PHYS_ADDR_T_64BIT`. +#[cfg(CONFIG_PHYS_ADDR_T_64BIT)] +pub type ResourceSize = u64; + +/// Resource Size type. +/// +/// This is a type alias to `u32` depending on the config option +/// `CONFIG_PHYS_ADDR_T_64BIT`. +#[cfg(not(CONFIG_PHYS_ADDR_T_64BIT))] +pub type ResourceSize = u32; + +/// A region allocated from a parent resource. +/// +/// # Invariants +/// +/// - `self.0` points to a valid `bindings::resource` that was obtained through +/// `__request_region`. +pub struct Region(NonNull); + +impl Deref for Region { + type Target = Resource; + + fn deref(&self) -> &Self::Target { + // SAFETY: Safe as per the invariant of `Region` + unsafe { Resource::from_ptr(self.0.as_ptr()) } + } +} + +impl Drop for Region { + fn drop(&mut self) { + // SAFETY: Safe as per the invariant of `Region` + let res = unsafe { Resource::from_ptr(self.0.as_ptr()) }; + let flags = res.flags(); + + let release_fn = if flags.contains(flags::IORESOURCE_MEM) { + bindings::release_mem_region + } else { + bindings::release_region + }; + + // SAFETY: Safe as per the invariant of `Region` + unsafe { release_fn(res.start(), res.size()) }; + } +} + +// SAFETY: `Region` only holds a pointer to a C `struct resource`, which is safe to be used from +// any thread. +unsafe impl Send for Region {} + +// SAFETY: `Region` only holds a pointer to a C `struct resource`, references to which are +// safe to be used from any thread. +unsafe impl Sync for Region {} + +/// A resource abstraction. +/// +/// # Invariants +/// +/// `Resource` is a transparent wrapper around a valid `bindings::resource`. +#[repr(transparent)] +pub struct Resource(Opaque); + +impl Resource { + /// Creates a reference to a [`Resource`] from a valid pointer. + /// + /// # Safety + /// + /// The caller must ensure that for the duration of 'a, the pointer will + /// point at a valid `bindings::resource` + /// + /// The caller must also ensure that the `Resource` is only accessed via the + /// returned reference for the duration of 'a. + pub(crate) const unsafe fn from_ptr<'a>(ptr: *mut bindings::resource) -> &'a Self { + // SAFETY: Self is a transparent wrapper around `Opaque`. + unsafe { &*ptr.cast() } + } + + /// Requests a resource region. + /// + /// Exclusive access will be given and the region will be marked as busy. + /// Further calls to `request_region` will return `None` if the region, or a + /// part of it, is already in use. + pub fn request_region( + &self, + start: ResourceSize, + size: ResourceSize, + name: &'static CStr, + flags: Flags, + ) -> Option { + // SAFETY: Safe as per the invariant of `Resource` + let region = unsafe { + bindings::__request_region( + self.0.get(), + start, + size, + name.as_char_ptr(), + flags.0 as i32, + ) + }; + + Some(Region(NonNull::new(region)?)) + } + + /// Returns the size of the resource. + pub fn size(&self) -> ResourceSize { + let inner = self.0.get(); + // SAFETY: safe as per the invariants of `Resource` + unsafe { bindings::resource_size(inner) } + } + + /// Returns the start address of the resource. + pub fn start(&self) -> u64 { + let inner = self.0.get(); + // SAFETY: safe as per the invariants of `Resource` + unsafe { *inner }.start + } + + /// Returns the name of the resource. + pub fn name(&self) -> &'static CStr { + let inner = self.0.get(); + // SAFETY: safe as per the invariants of `Resource` + unsafe { CStr::from_char_ptr((*inner).name) } + } + + /// Returns the flags associated with the resource. + pub fn flags(&self) -> Flags { + let inner = self.0.get(); + // SAFETY: safe as per the invariants of `Resource` + let flags = unsafe { *inner }.flags; + + Flags(flags) + } +} + +// SAFETY: `Resource` only holds a pointer to a C `struct resource`, which is safe to be used from +// any thead. +unsafe impl Send for Resource {} + +// SAFETY: `Resource` only holds a pointer to a C `struct resource`, references to which are +// safe to be used from any thead. +unsafe impl Sync for Resource {} + +/// Resource flags as stored in the C `struct resource::flags` field. +/// +/// They can be combined with the operators `|`, `&`, and `!`. +/// +/// Values can be used from the [`flags`] module. +#[derive(Clone, Copy, PartialEq)] +pub struct Flags(usize); + +impl Flags { + /// Check whether `flags` is contained in `self`. + pub fn contains(self, flags: Flags) -> bool { + (self & flags) == flags + } +} + +impl core::ops::BitOr for Flags { + type Output = Self; + fn bitor(self, rhs: Self) -> Self::Output { + Self(self.0 | rhs.0) + } +} + +impl core::ops::BitAnd for Flags { + type Output = Self; + fn bitand(self, rhs: Self) -> Self::Output { + Self(self.0 & rhs.0) + } +} + +impl core::ops::Not for Flags { + type Output = Self; + fn not(self) -> Self::Output { + Self(!self.0) + } +} + +/// Resource flags as stored in the `struct resource::flags` field. +pub mod flags { + use super::Flags; + + /// PCI/ISA I/O ports. + pub const IORESOURCE_IO: Flags = Flags(bindings::IORESOURCE_IO as usize); + + /// Resource is software muxed. + pub const IORESOURCE_MUXED: Flags = Flags(bindings::IORESOURCE_MUXED as usize); + + /// Resource represents a memory region. + pub const IORESOURCE_MEM: Flags = Flags(bindings::IORESOURCE_MEM as usize); + + /// Resource represents a memory region that must be ioremaped using `ioremap_np`. + pub const IORESOURCE_MEM_NONPOSTED: Flags = Flags(bindings::IORESOURCE_MEM_NONPOSTED as usize); +} -- 2.49.0