samples: i2c: add i2c_shell sample

Add i2c_shell sample to check i2c slave devices

Signed-off-by: Biwen Li <[email protected]>

Author: biwenli

samples/i2c/i2c.rst

@@ -0,0 +1,5 @@
+.. zephyr:code-sample-category:: i2c
+   :name: I2c
+   :show-listing:
+
+   These samples demonstrate how to use i2c supported by Zephyr.

samples/i2c/i2c_shell/CMakeLists.txt

@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: Apache-2.0
+
+cmake_minimum_required(VERSION 3.20.0)
+
+find_package(Zephyr REQUIRED HINTS $ENV{ZEPHYR_BASE})
+project(i2c_shell)
+
+target_sources(app PRIVATE src/main.c)

samples/i2c/i2c_shell/Kconfig

@@ -0,0 +1,4 @@
+# Copyright 2025 NXP
+# SPDX-License-Identifier: Apache-2.0
+
+source "Kconfig.zephyr"

samples/i2c/i2c_shell/README.rst

@@ -0,0 +1,86 @@
+.. zephyr:code-sample:: i2c_shell
+   :name: I2c shell
+   :relevant-api: i2c_interface
+
+   Interact with i2c using the shell module.
+
+Overview
+********
+This is a simple shell module to test i2c slave devices via i2c commands in the system.
+
+Building and Running
+********************
+
+Build the sample app by choosing the target board that has i2c driver
+enabled, for example:
+
+.. zephyr-app-commands::
+   :zephyr-app: samples/i2c/i2c_shell
+   :board: imx943_evk/mimx94398/m33
+   :goals: build flash
+
+Shell Module Command Help
+=========================
+
+.. code-block:: console
+
+   i2c - I2c commands
+   Subcommands:
+     scan        :Scan I2C devices.
+     recover     :Recover I2C bus.
+     read        :Read bytes from an I2C device.
+     read_byte   :Read a byte from an I2C device.
+     direct_read :Read byte stream directly from an I2C device without
+                  writing a register address first.
+     write       :Write bytes to an I2C device.
+     write_byte  :Write a byte to an I2C device.
+     speed       :Configure I2C bus speed.
+
+Output example (imx943_evk/mimx94398/m33):
+
+.. code-block:: console
+
+   uart:~$ i2c
+   i2c - I2C commands
+   Subcommands:
+     scan         : Scan I2C devices
+                    Usage: scan <device>
+     recover      : Recover I2C bus
+                    Usage: recover <device>
+     read         : Read bytes from an I2C device
+                    Usage: read <device> <addr> <reg> [<bytes>]
+     read_byte    : Read a byte from an I2C device
+                    Usage: read_byte <device> <addr> <reg>
+     direct_read  : Read byte stream directly from an I2C device without writing a
+                    register address first
+                    Usage: direct_read <device> <addr> [<bytes>]
+     write        : Write bytes to an I2C device
+                    Usage: write <device> <addr> <reg> [<byte1>, ...]
+     write_byte   : Write a byte to an I2C device
+                    Usage: write_byte <device> <addr> <reg> <value>
+     speed        : Configure I2C bus speed
+                    Usage: speed <device> <speed>
+
+   uart:~$ i2c scan
+   scan: wrong parameter count
+   scan - Scan I2C devices
+          Usage: scan <device>
+   Subcommands:
+     i2c@426c0000
+   uart:~$ i2c scan i2c@426c0000
+        0  1  2  3  4  5  6  7  8  9  a  b  c  d  e  f
+   00:             -- -- -- -- -- -- -- -- -- -- -- --
+   10: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
+   20: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
+   30: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
+   40: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
+   50: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
+   60: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
+   70: -- -- -- -- -- -- -- 77
+   1 devices found on i2c@426c0000
+
+   uart:~$ i2c speed i2c@426c0000 1
+
+   uart:~$ i2c write_byte i2c@426c0000 0x77 0 0x1
+   uart:~$ i2c read_byte i2c@426c0000 0x77 0
+   Output: 0x1

samples/i2c/i2c_shell/prj.conf

@@ -0,0 +1,3 @@
+CONFIG_SHELL=y
+CONFIG_I2C=y
+CONFIG_I2C_SHELL=y

samples/i2c/i2c_shell/sample.yaml

@@ -0,0 +1,15 @@
+sample:
+  name: Shell I2c Module Sample
+common:
+  tags:
+    - i2c
+    - shell
+
+tests:
+  sample.i2c.shell:
+    integration_platforms:
+      - imx943_evk/mimx94398/m33
+    filter: ( CONFIG_UART_CONSOLE and CONFIG_SERIAL_SUPPORT_INTERRUPT )
+    harness: keyboard
+    min_ram: 20
+    min_flash: 33

samples/i2c/i2c_shell/src/main.c

@@ -0,0 +1,15 @@
+/*
+ * Copyright 2025 NXP
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/*
+ * This sample app launches a shell. Interact with it using the `i2c` command. See
+ * `drivers/i2c/i2c_shell.c`. There is nothing to do in the main thread.
+ */
+
+int main(void)
+{
+	return 0;
+}