samples: boards: stm32 hello_word application running in XiP mode

Samples to demonstrate the XiP mode when using an external NOR flash
in MemoryMapped mode

Signed-off-by: Francois Ramu <[email protected]>

Author: FRASTM

samples/boards/st/hello_world_xip/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(hello_world_xip)
+
+target_sources(app PRIVATE src/main.c)

samples/boards/st/hello_world_xip/README.rst

@@ -0,0 +1,61 @@
+.. _hello_world_xip:
+
+Hello World in XiP
+##################
+
+Overview
+********
+
+A simple sample that can be used with any :ref:`supported board <boards>`
+which has an external NOR octo- or quad- flash and
+prints "Hello World from external flash" to the console.
+The application is built and linked and downloaded in the external flash
+while the mcuboot is built and downloaded for the internal flash
+There is an overlay to set the partition in the external flash
+
+.. code-block:: console
+
+    chosen {
+        zephyr,flash = &mx25uw25645;
+        zephyr,code-partition = &slot0_partition;
+    };
+
+
+Building and Running
+********************
+
+This application can be built with 
+west build -p always -b nucleo_h7s3l8 samples/boards/stm32/hello_world_xip/ --sysbuild -- -DSB_CONFIG_BOOTLOADER_MCUBOOT=y
+Download the build/mcuboot/zephyr/zephyr.bin at internal flash adress 0x08000000
+Download the build/hello_world_xip/zephyr/zephyr.signed.bin at internal flash adress 0x70000000 (chosen zephyr,code-partition)
+and executed on nucleo_h7s3l8 as follows:
+
+.. zephyr-app-commands::
+   :zephyr-app: samples/boards/stm32/hello_world_xip
+   :host-os: unix
+   :board: nucleo_h7s3l8
+   :goals: run
+   :compact:
+
+To build for another board, change "nucleo_h7s3l8" above to that board's name.
+
+Sample Output
+=============
+
+.. code-block:: console
+
+    Hello World! from external flash b_u585i_iot02a
+    *** Booting MCUboot v2.1.0-rc1-275-g6d34ca2cfe4d ***
+    *** Using Zephyr OS build v4.1.0-1733-ge706fceff985 ***
+    I: Starting bootloader                                                                                                                         
+    I: Primary image: magic=unset, swap_type=0x1, copy_done=0x3, image_ok=0x3                                                                      
+    I: Secondary image: magic=unset, swap_type=0x1, copy_done=0x3, image_ok=0x3                                                                    
+    I: Boot source: none                                                                                                                           
+    I: Image index: 0, Swap type: none                                                                                                             
+    I: Bootloader chainload address offset: 0x0                                                                                                    
+    I: Image version: v0.0.0                                                                                                                       
+    I: Jumping to the first image slot                                                                                                             
+    *** Booting Zephyr OS build v4.1.0-1733-ge706fceff985 ***                                                                                      
+    Hello World! from external flash  nucleo_h7s3l8  
+
+Exit QEMU by pressing :kbd:`CTRL+A` :kbd:`x`.

samples/boards/st/hello_world_xip/boards/nucleo_h7s3l8.overlay

@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) 2025 STMicroelectronics
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/*
+ * Define the device, controller and partition to be the external memory
+ * for running the application in external NOR from MCUboot
+ */
+/ {
+	chosen {
+		zephyr,flash = &mx25uw25645;
+		zephyr,code-partition = &slot0_partition;
+	};
+};

samples/boards/st/hello_world_xip/boards/stm32h7s78_dk.overlay

@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) 2025 STMicroelectronics
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/*
+ * Define the device, controller and partition to be the external memory
+ * for running the application in external NOR from MCUboot
+ */
+/ {
+	chosen {
+		zephyr,flash = &mx66uw1g45;
+		zephyr,code-partition = &slot0_partition;
+	};
+};

samples/boards/st/hello_world_xip/prj.conf

@@ -0,0 +1 @@
+#CONFIG_XIP=y

samples/boards/st/hello_world_xip/sample.yaml

@@ -0,0 +1,16 @@
+sample:
+  description: Hello World sample, the simplest Zephyr from external flash
+    application
+  name: hello world
+common:
+  tags: introduction
+  integration_platforms:
+    - native_posix
+  harness: console
+  harness_config:
+    type: one_line
+    regex:
+      - "Hello World! (.*)"
+tests:
+  sample.basic.helloworld:
+    tags: introduction

samples/boards/st/hello_world_xip/src/main.c

@@ -0,0 +1,75 @@
+/*
+ * Copyright (c) 2016 Intel Corporation
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include <stdio.h>
+#include <zephyr/kernel.h>
+#include <zephyr/drivers/gpio.h>
+
+/* 1000 msec = 1 sec */
+#define SLEEP_TIME_MS   1000
+
+/* The devicetree node identifier for the "led0" alias. */
+#define LED0_NODE DT_ALIAS(led0)
+#define LED1_NODE DT_ALIAS(led1)
+#define LED2_NODE DT_ALIAS(led2)
+
+/*
+ * A build error on this line means your board is unsupported.
+ * See the sample documentation for information on how to fix this.
+ */
+static const struct gpio_dt_spec led0 = GPIO_DT_SPEC_GET(LED0_NODE, gpios);
+static const struct gpio_dt_spec led1 = GPIO_DT_SPEC_GET(LED1_NODE, gpios);
+static const struct gpio_dt_spec led2 = GPIO_DT_SPEC_GET(LED2_NODE, gpios);
+
+int main(void)
+{
+	int ret;
+
+	printk("Hello World! from external flash  %s\n", CONFIG_BOARD);
+
+	if (!gpio_is_ready_dt(&led0)) {
+		return 0;
+	}
+	if (!gpio_is_ready_dt(&led1)) {
+		return 0;
+	}
+	if (!gpio_is_ready_dt(&led2)) {
+		return 0;
+	}
+
+	ret = gpio_pin_configure_dt(&led0, GPIO_OUTPUT_ACTIVE);
+	if (ret < 0) {
+		return 0;
+	}
+	ret = gpio_pin_configure_dt(&led1, GPIO_OUTPUT_ACTIVE);
+	if (ret < 0) {
+		return 0;
+	}
+	ret = gpio_pin_configure_dt(&led2, GPIO_OUTPUT_ACTIVE);
+	if (ret < 0) {
+		return 0;
+	}
+
+	while (1) {
+		ret = gpio_pin_toggle_dt(&led0);
+		if (ret < 0) {
+			return 0;
+		}
+		k_msleep(200);
+		ret = gpio_pin_toggle_dt(&led1);
+		if (ret < 0) {
+			return 0;
+		}
+		k_msleep(300);
+		ret = gpio_pin_toggle_dt(&led2);
+		if (ret < 0) {
+			return 0;
+		}
+
+		k_msleep(SLEEP_TIME_MS);
+	}
+	return 0;
+}