Commit d05b8e97 authored by Igor Korotin's avatar Igor Korotin Committed by Danilo Krummrich
Browse files

samples: rust: add Rust I2C sample driver 



Add a new `rust_driver_i2c` sample, showing how to create a new
i2c driver using ACPI/OF/Legacy ID tables.

Acked-by: default avatarWolfram Sang <wsa+renesas@sang-engineering.com>
Signed-off-by: default avatarIgor Korotin <igor.korotin.linux@gmail.com>
Link: https://patch.msgid.link/20251116162204.171518-1-igor.korotin.linux@gmail.com


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

MAINTAINERS

+1 −0
Original line number Diff line number Diff line
@@ -11750,6 +11750,7 @@ R: Daniel Almeida <daniel.almeida@collabora.com> 
L:	rust-for-linux@vger.kernel.org

S:	Maintained

F:	rust/kernel/i2c.rs

F:	samples/rust/rust_driver_i2c.rs









I2C SUBSYSTEM HOST DRIVERS









M:	Andi Shyti <andi.shyti@kernel.org>
































samples/rust/Kconfig



+11
−0






























Original line number
Diff line number
Diff line







@@ -84,6 +84,17 @@ config SAMPLE_RUST_DEBUGFS_SCOPED

















	  If unsure, say N.



















config SAMPLE_RUST_DRIVER_I2C









	tristate "I2C Driver"









	depends on I2C=y









	help









	  This option builds the Rust I2C driver sample.



















	  To compile this as a module, choose M here:









	  the module will be called rust_driver_i2c.



















	  If unsure, say N.



















config SAMPLE_RUST_DRIVER_PCI









	tristate "PCI Driver"









	depends on PCI
































samples/rust/Makefile



+1
−0






























Original line number
Diff line number
Diff line







@@ -7,6 +7,7 @@ obj-$(CONFIG_SAMPLE_RUST_PRINT)			+= rust_print.o







obj-$(CONFIG_SAMPLE_RUST_DEBUGFS)		+= rust_debugfs.o









obj-$(CONFIG_SAMPLE_RUST_DEBUGFS_SCOPED)	+= rust_debugfs_scoped.o









obj-$(CONFIG_SAMPLE_RUST_DMA)			+= rust_dma.o









obj-$(CONFIG_SAMPLE_RUST_DRIVER_I2C)		+= rust_driver_i2c.o









obj-$(CONFIG_SAMPLE_RUST_DRIVER_PCI)		+= rust_driver_pci.o









obj-$(CONFIG_SAMPLE_RUST_DRIVER_PLATFORM)	+= rust_driver_platform.o









obj-$(CONFIG_SAMPLE_RUST_DRIVER_USB)		+= rust_driver_usb.o
































samples/rust/rust_driver_i2c.rs
0 → 100644



+74
−0






























Original line number
Diff line number
Diff line









// SPDX-License-Identifier: GPL-2.0



















//! Rust I2C driver sample.



















use kernel::{









    acpi,









    c_str,









    device::Core,









    i2c,









    of,









    prelude::*, //









};



















struct SampleDriver;



















kernel::acpi_device_table! {









    ACPI_TABLE,









    MODULE_ACPI_TABLE,









    <SampleDriver as i2c::Driver>::IdInfo,









    [(acpi::DeviceId::new(c_str!("LNUXBEEF")), 0)]









}



















kernel::i2c_device_table! {









    I2C_TABLE,









    MODULE_I2C_TABLE,









    <SampleDriver as i2c::Driver>::IdInfo,









    [(i2c::DeviceId::new(c_str!("rust_driver_i2c")), 0)]









}



















kernel::of_device_table! {









    OF_TABLE,









    MODULE_OF_TABLE,









    <SampleDriver as i2c::Driver>::IdInfo,









    [(of::DeviceId::new(c_str!("test,rust_driver_i2c")), 0)]









}



















impl i2c::Driver for SampleDriver {









    type IdInfo = u32;



















    const ACPI_ID_TABLE: Option<acpi::IdTable<Self::IdInfo>> = Some(&ACPI_TABLE);









    const I2C_ID_TABLE: Option<i2c::IdTable<Self::IdInfo>> = Some(&I2C_TABLE);









    const OF_ID_TABLE: Option<of::IdTable<Self::IdInfo>> = Some(&OF_TABLE);



















    fn probe(









        idev: &i2c::I2cClient<Core>,









        info: Option<&Self::IdInfo>,









    ) -> impl PinInit<Self, Error> {









        let dev = idev.as_ref();



















        dev_info!(dev, "Probe Rust I2C driver sample.\n");



















        if let Some(info) = info {









            dev_info!(dev, "Probed with info: '{}'.\n", info);









        }



















        Ok(Self)









    }



















    fn shutdown(idev: &i2c::I2cClient<Core>, _this: Pin<&Self>) {









        dev_info!(idev.as_ref(), "Shutdown Rust I2C driver sample.\n");









    }



















    fn unbind(idev: &i2c::I2cClient<Core>, _this: Pin<&Self>) {









        dev_info!(idev.as_ref(), "Unbind Rust I2C driver sample.\n");









    }









}



















kernel::module_i2c_driver! {









    type: SampleDriver,









    name: "rust_driver_i2c",









    authors: ["Igor Korotin"],









    description: "Rust I2C driver",









    license: "GPL v2",









}