Skip to content

Commit 435c9af

Browse files
masz-nordicjukkar
authored andcommitted
applications: sdp: gpio: add README
Add simple readme for SDP GPIO application. Signed-off-by: Marcin Szymczyk <[email protected]>
1 parent 7dfab1d commit 435c9af

File tree

2 files changed

+36
-0
lines changed

2 files changed

+36
-0
lines changed

applications/sdp/gpio/README.rst

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
.. _sdp_gpio:
2+
3+
SDP GPIO
4+
########
5+
6+
This application demonstrates how to create SDP on FLPR in Zephyr threadless mode by implementing a subset of Zephyr GPIO API.
7+
It is intended for use with Zephyr's :zephyr:code-sample:`blinky` sample.
8+
9+
You can use the following IPC backends:
10+
11+
* mbox (:kconfig:option:`SB_CONFIG_SDP_GPIO_BACKEND_MBOX`)
12+
* icmsg (:kconfig:option:`SB_CONFIG_SDP_GPIO_BACKEND_ICMSG`)
13+
* icbmsg (:kconfig:option:`SB_CONFIG_SDP_GPIO_BACKEND_ICBMSG`)
14+
15+
Requirements
16+
************
17+
18+
The firmware supports the following development kit:
19+
20+
.. table-from-sample-yaml::
21+
22+
Building and running
23+
********************
24+
25+
You must include code for both the application core and FLPR core.
26+
The recommended method is to build the :zephyr:code-sample:`blinky` with the necessary sysbuild configuration.
27+
28+
For example, to build with icmsg backend, run the following commands:
29+
30+
.. code-block:: console
31+
32+
west build -b nrf54l15dk/nrf54l15/cpuapp -- -DSB_CONFIG_PARTITION_MANAGER=n -DSB_CONFIG_SDP=y -DSB_CONFIG_SDP_GPIO=y -DSB_CONFIG_SDP_GPIO_BACKEND_ICMSG=y -DEXTRA_DTC_OVERLAY_FILE="./boards/nrf54l15dk_nrf54l15_cpuapp_egpio.overlay"
33+
west flash
34+
35+
Upon successful execution, **LED0** will start flashing.

doc/nrf/applications.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ If you want to list applications available for one or more specific boards, `use
2424
../../applications/nrf5340_audio/index
2525
../../applications/nrf_desktop/README
2626
../../applications/machine_learning/README
27+
../../applications/sdp/gpio/README
2728
../../applications/serial_lte_modem/README
2829
../../applications/matter_weather_station/README
2930
../../applications/zigbee_weather_station/README

0 commit comments

Comments
 (0)