app: initial application skeleton

initial application skeleton demonstrating:

- custom boards
- custom DT bindings
- Out-of-tree drivers

Signed-off-by: Gerard Marull-Paretas <[email protected]>

Author: gmarull

.gitignore

@@ -0,0 +1,10 @@
+# editors
+.vscode
+*.swp
+*~
+
+# python
+.venv
+
+# build
+/build*

CMakeLists.txt

@@ -0,0 +1,7 @@
+# Copyright (c) 2021 Nordic Semiconductor ASA
+# SPDX-License-Identifier: Apache-2.0
+#
+# This CMake file is picked by the Zephyr build system because it is defined
+# as the module CMake entry point (see zephyr/module.yml).
+
+add_subdirectory(drivers)

Kconfig

@@ -0,0 +1,8 @@
+# Copyright (c) 2021 Nordic Semiconductor ASA
+# SPDX-License-Identifier: Apache-2.0
+#
+# This Kconfig file is picked by the Zephyr build system because it is defined
+# as the module Kconfig entry point (see zephyr/module.yml). You can browse
+# module options by going to Zephyr -> Modules in Kconfig.
+
+rsource "drivers/Kconfig"

README.md

@@ -1,2 +1,58 @@
-# example-application
-Example out-of-tree application that is also a module
+# Zephyr Example Application
+
+This repository contains a Zephyr example application. The main purpose of this
+repository is to serve as a reference on how to structure Zephyr based
+applications. Some of the features demonstrated in this example are:
+
+- Basic application skeleton
+- [Custom boards][board_porting]
+- Custom [devicetree bindings][bindings]
+- Out-of-tree [drivers][drivers]
+- Documentation using Doxygen and Sphinx
+- Example CI configuration (using Github Actions)
+
+[board_porting]: https://docs.zephyrproject.org/latest/guides/porting/board_porting.html
+[bindings]: https://docs.zephyrproject.org/latest/guides/dts/bindings.html
+[drivers]: https://docs.zephyrproject.org/latest/reference/drivers/index.html
+
+## Getting Started
+
+Before getting started, make sure you have a proper Zephyr development
+environment. You can follow the official
+[Zephyr Getting Started Guide](https://docs.zephyrproject.org/latest/getting_started/index.html).
+
+### Initialization
+
+The first step is to initialize the workspace folder (``my-workspace``) where
+the ``example-application`` and all Zephyr modules will be cloned. You can do
+that by running:
+
+```shell
+# initialize my-workspace for the example-application (main branch)
+west init -m https://github.com/zephyrproject-rtos/example-application --mr main my-workspace
+# update Zephyr modules
+cd my-workspace
+west update
+```
+
+### Build & Run
+
+The application can be built by running:
+
+```shell
+west build -b $BOARD -s app
+```
+
+where `$BOARD` is the target board. A sample debug configuration is also
+provided. You can apply it by running:
+
+```shell
+west build -b $BOARD -s app -- -DOVERLAY_CONFIG=debug.conf
+```
+
+Note that you may also use it together with `rtt.conf` if using Segger RTT. Once
+you have built the application you can flash it by running:
+
+```shell
+west flash
+```

app/CMakeLists.txt

@@ -0,0 +1,15 @@
+#-------------------------------------------------------------------------------
+# Zephyr Example Application
+#
+# Copyright (c) 2021 Nordic Semiconductor ASA
+# SPDX-License-Identifier: Apache-2.0
+
+cmake_minimum_required(VERSION 3.13.1)
+find_package(Zephyr REQUIRED HINTS $ENV{ZEPHYR_BASE})
+
+project(app LANGUAGES C VERSION 1.0.0)
+
+configure_file(app_version.h.in ${CMAKE_BINARY_DIR}/app/include/app_version.h)
+target_include_directories(app PRIVATE ${CMAKE_BINARY_DIR}/app/include src)
+
+target_sources(app PRIVATE src/main.c src/foo.c)

app/Kconfig

@@ -0,0 +1,15 @@
+# Copyright (c) 2021 Nordic Semiconductor ASA
+# SPDX-License-Identifier: Apache-2.0
+#
+# This file is the application Kconfig entry point. All application Kconfig
+# options can be defined here or included via other application Kconfig files.
+# You can browse these options using the west targets menuconfig (terminal) or
+# guiconfig (GUI).
+
+menu "Zephyr"
+source "Kconfig.zephyr"
+endmenu
+
+module = APP
+module-str = APP
+source "subsys/logging/Kconfig.template.log_config"

app/app_version.h.in

@@ -0,0 +1,29 @@
+/**
+ * @file app_version.h
+ *
+ * Application version information.
+ *
+ * Copyright (c) 2021 Nordic Semiconductor ASA
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#ifndef APP_VERSION_H_
+#define APP_VERSION_H_
+
+/** Application major version. */
+#define APP_VERSION_MAJOR ${PROJECT_VERSION_MAJOR}
+/** Application minor version. */
+#define APP_VERSION_MINOR ${PROJECT_VERSION_MINOR}
+/** Application patch version. */
+#define APP_VERSION_PATCH ${PROJECT_VERSION_PATCH}
+
+/** Application version. */
+#define APP_VERSION \
+	((APP_VERSION_MAJOR << 16) + \
+	 (APP_VERSION_MINOR << 8) + \
+	  APP_VERSION_PATCH)
+
+/** Application version (string). */
+#define APP_VERSION_STR "${PROJECT_VERSION}"
+
+#endif /* APP_VERSION_H_ */

app/debug.conf

@@ -0,0 +1,19 @@
+# Copyright (c) 2021 Nordic Semiconductor ASA
+# SPDX-License-Identifier: Apache-2.0
+#
+# This is a Kconfig fragment which can be used to enable debug-related options
+# in the application. See the README for more details.
+
+# compiler
+CONFIG_DEBUG_OPTIMIZATIONS=y
+
+# console
+CONFIG_CONSOLE=y
+
+# UART console
+CONFIG_SERIAL=y
+CONFIG_UART_CONSOLE=y
+
+# logging
+CONFIG_LOG=y
+CONFIG_APP_LOG_LEVEL_DBG=y

app/prj.conf

@@ -0,0 +1,7 @@
+# Copyright (c) 2021 Nordic Semiconductor ASA
+# SPDX-License-Identifier: Apache-2.0
+#
+# This file contains selected Kconfig options for the application.
+
+CONFIG_SENSOR=y
+CONFIG_EXAMPLESENSOR=y

app/rtt.conf

@@ -0,0 +1,9 @@
+# Copyright (c) 2021 Nordic Semiconductor ASA
+# SPDX-License-Identifier: Apache-2.0
+#
+# This is a Kconfig fragment which can be used to enable Segger RTT options.
+# It should be used in conjunction with debug.conf.
+
+# segger RTT console
+CONFIG_USE_SEGGER_RTT=y
+CONFIG_RTT_CONSOLE=y