summaryrefslogtreecommitdiffstats
path: root/samples/rust/rust_soc.rs
diff options
context:
space:
mode:
authorNiklas Cassel <cassel@kernel.org>2026-09-16 15:00:32 +0200
committerNiklas Cassel <cassel@kernel.org>2026-09-16 16:18:00 +0200
commit8d836581f9b1f57ceaa2b47654754ef1260b410b (patch)
tree1dbd4d0dfb99c2e238356cbe947e5b0be3e3a571 /samples/rust/rust_soc.rs
downloadlinux-stable-8d836581f9b1f57ceaa2b47654754ef1260b410b.tar.gz
linux-stable-8d836581f9b1f57ceaa2b47654754ef1260b410b.zip
ata: libata-scsi: fix ata_dsm_trim_pages() kernel-docgrafted
make htmldocs fails with: Documentation/driver-api/libata:604: ./drivers/ata/libata-scsi.c:2301: ERROR: Unexpected indentation. [docutils] The Return: section of ata_dsm_trim_pages() ends its first sentence with a colon and continues with an indented bullet list. reStructuredText requires a blank line before an indented block, so docutils chokes on the list. Simply adding the missing blank line does not work either: Return: is a kernel-doc "special section", which is terminated by the first blank line, so the bullet list would end up in the Description section, detached from the sentence introducing it. Spell the two bounds out as prose instead, so that the Return: section stays self-contained. Documentation-only change. Fixes: e64e6b5dc867 ("ata: libata-scsi: scale DSM TRIM payload by MAX PAGES PER DSM COMMAND") Reported-by: Thomas Huth <thuth@redhat.com> Closes: https://lore.kernel.org/linux-ide/b0a0b8e8-cc4f-4c7b-8bc5-fee0712d405a@redhat.com/ Reviewed-by: Damien Le Moal <dlemoal@kernel.org> Reviewed-by: Thomas Huth <thuth@redhat.com> Link: https://lore.kernel.org/r/20260916130031.29990-2-cassel@kernel.org Signed-off-by: Niklas Cassel <cassel@kernel.org>
Diffstat (limited to 'samples/rust/rust_soc.rs')
-rw-r--r--samples/rust/rust_soc.rs78
1 files changed, 78 insertions, 0 deletions
diff --git a/samples/rust/rust_soc.rs b/samples/rust/rust_soc.rs
new file mode 100644
index 000000000..f5e5f2f9a
--- /dev/null
+++ b/samples/rust/rust_soc.rs
@@ -0,0 +1,78 @@
+// SPDX-License-Identifier: GPL-2.0
+
+//! Rust SoC Platform driver sample.
+
+use kernel::{
+ acpi,
+ device::Core,
+ of,
+ platform,
+ prelude::*,
+ soc,
+ str::CString,
+ sync::aref::ARef, //
+};
+use pin_init::pin_init_scope;
+
+#[pin_data]
+struct SampleSocDriver {
+ pdev: ARef<platform::Device>,
+ #[pin]
+ _dev_reg: soc::Registration,
+}
+
+kernel::of_device_table!(
+ OF_TABLE,
+ <SampleSocDriver as platform::Driver>::IdInfo,
+ [(of::DeviceId::new(c"test,rust-device"), ())]
+);
+
+kernel::acpi_device_table!(
+ ACPI_TABLE,
+ <SampleSocDriver as platform::Driver>::IdInfo,
+ [(acpi::DeviceId::new(c"LNUXBEEF"), ())]
+);
+
+impl platform::Driver for SampleSocDriver {
+ type IdInfo = ();
+ type Data<'bound> = Self;
+ const OF_ID_TABLE: Option<of::IdTable<Self::IdInfo>> = Some(&OF_TABLE);
+ const ACPI_ID_TABLE: Option<acpi::IdTable<Self::IdInfo>> = Some(&ACPI_TABLE);
+
+ fn probe<'bound>(
+ pdev: &'bound platform::Device<Core<'_>>,
+ _info: Option<&'bound Self::IdInfo>,
+ ) -> impl PinInit<Self, Error> + 'bound {
+ dev_dbg!(pdev, "Probe Rust SoC driver sample.\n");
+
+ let pdev = pdev.into();
+ pin_init_scope(move || {
+ let machine = CString::try_from(c"My cool ACME15 dev board")?;
+ let family = CString::try_from(c"ACME")?;
+ let revision = CString::try_from(c"1.2")?;
+ let serial_number = CString::try_from(c"12345")?;
+ let soc_id = CString::try_from(c"ACME15")?;
+
+ let attr = soc::Attributes {
+ machine: Some(machine),
+ family: Some(family),
+ revision: Some(revision),
+ serial_number: Some(serial_number),
+ soc_id: Some(soc_id),
+ };
+
+ Ok(try_pin_init!(SampleSocDriver {
+ pdev: pdev,
+ _dev_reg <- soc::Registration::new(attr),
+ }? Error))
+ })
+ }
+}
+
+kernel::module_platform_driver! {
+ type: SampleSocDriver,
+ name: "rust_soc",
+ authors: ["Matthew Maurer"],
+ description: "Rust SoC Driver",
+ license: "GPL",
+}