Go to file
2024-11-16 15:54:40 +01:00
.github github/workflows: add PR size labeler 2024-09-23 08:33:33 +08:00
audioutils lame: update CMakeLists.txt 2024-08-27 22:08:13 +08:00
benchmarks cmake:port benchmarks to CMake build for testing 2024-09-13 23:16:26 +08:00
boot mcuboot: Ignore mcuboot compile warnings 2024-05-14 22:07:09 +08:00
builtin Revert "cmake:builtin register support NONE srcs target" 2024-08-16 15:21:50 +08:00
canutils canutils/libobd2: replace field ch_unused with ch_tcf 2024-10-09 22:50:40 +08:00
cmake cmake:implement CMake build for NuttX Lua interpreter 2024-09-13 12:31:10 +08:00
crypto mbedtls/psa: provides PSA method for using hardware random driver 2024-09-19 08:36:46 +08:00
database database: fix compile failure 2024-03-05 13:46:01 +08:00
examples gpio:add example for wakeup gpio type 2024-10-25 16:13:30 +02:00
fsutils fsutils/mkmbr/mkmbr.c: fix null pointer access when not all device space is defined in mbr 2024-10-10 16:47:04 +08:00
games apps/games: Rename Shift game to Brickmatch 2023-10-24 13:53:51 +08:00
graphics lvgl: upgrade to release/v9.2.1 2024-10-25 17:21:00 +02:00
import build/import: matching nuttx/pull/12201 2024-04-25 00:55:45 +02:00
include app/netstatistics: Add net statistics api for user 2024-09-12 13:38:38 +08:00
industry industrial/foc: add dependences to Kconfig 2024-06-06 03:21:19 +08:00
inertial Fix Kconfig style 2023-11-16 20:31:08 -08:00
interpreters Changing js-root. 2024-11-16 15:54:40 +01:00
logging logging/embedlog: update to version v0.7.0 2024-03-03 12:03:54 +08:00
lte net: Remove IFF_DOWN flag to compatible with Linux/*BSD 2024-10-09 18:19:23 +08:00
math Makefile:complete missing DEPPATH 2024-09-23 08:41:29 +08:00
mlearning add initial cmake build system 2023-07-08 13:52:02 +08:00
modbus Minor code style fixes 2024-09-15 02:27:41 +08:00
netutils net: Remove IFF_DOWN flag to compatible with Linux/*BSD 2024-10-09 18:19:23 +08:00
nshlib resetcause:restore to factory, factory to factory_inquiry 2024-10-25 16:13:30 +02:00
platform add initial cmake build system 2023-07-08 13:52:02 +08:00
sdr cmake: port nxscope and foc and add missing directories 2023-07-14 22:04:35 +08:00
system batterydump:move to system dir 2024-10-25 16:13:30 +02:00
testing drivertest:add include file depended by cmocka 2024-10-25 16:13:30 +02:00
tools tools/mksymtab.sh: Support symbol name overriding 2024-09-19 03:46:46 +08:00
videoutils videoutils/x264: clone from github if no x264 source 2024-07-17 12:06:51 -03:00
wireless [wireless] add set/get pmksa api for fast-auth 2024-09-12 12:43:52 +08:00
.asf.yaml .asf.yaml: Disable squash and merge option 2020-05-01 23:13:22 -07:00
Application.mk module build:replace BUILD_LOADABLE with MODULES 2024-09-19 08:32:26 +08:00
CMakeLists.txt cmake:implement CMake build for NuttX Lua interpreter 2024-09-13 12:31:10 +08:00
config.nims config.nims: fix NimSuggest crash. 2024-01-23 04:03:59 -08:00
Directory.mk apps/build: Restore ARLOCK to improve compile speed in incremental case 2023-09-12 21:55:39 +08:00
LICENSE testing/sd_bench: Port sdbench testing utility for PX4-Autopilot. 2023-10-30 16:58:10 +08:00
Make.defs hello_swift added 2024-08-23 09:04:31 +08:00
Makefile module build:replace BUILD_LOADABLE with MODULES 2024-09-19 08:32:26 +08:00
NOTICE Add DISCLAIMER, LICENSE and NOTICE files. 2020-03-07 16:14:29 -06:00
README.md README.md: Update NuttX Porting Guide Online links 2022-10-26 21:57:30 +08:00

Application Folder

Contents

  • General
  • Directory Location
  • Built-In Applications
  • NuttShell (NSH) Built-In Commands
  • Synchronous Built-In Commands
  • Application Configuration File
  • Example Built-In Application
  • Building NuttX with Board-Specific Pieces Outside the Source Tree

General

This folder provides various applications found in sub-directories. These applications are not inherently a part of NuttX but are provided to help you develop your own applications. The apps/ directory is a break away part of the configuration that you may choose to use or not.

Directory Location

The default application directory used by the NuttX build should be named apps/ (or apps-x.y.z/ where x.y.z is the NuttX version number). This apps/ directory should appear in the directory tree at the same level as the NuttX directory. Like:

 .
 |- nuttx
 |
 `- apps

If all of the above conditions are TRUE, then NuttX will be able to find the application directory. If your application directory has a different name or is location at a different position, then you will have to inform the NuttX build system of that location. There are several ways to do that:

  1. You can define CONFIG_APPS_DIR to be the full path to your application directory in the NuttX configuration file.
  2. You can provide the path to the application directory on the command line like: make APPDIR=<path> or make CONFIG_APPS_DIR=<path>
  3. When you configure NuttX using tools/configure.sh, you can provide that path to the application directory on the configuration command line like: ./configure.sh -a <app-dir> <board-name>:<config-name>

Built-In Applications

NuttX also supports applications that can be started using a name string. In this case, application entry points with their requirements are gathered together in two files:

  • builtin/builtin_proto.h Entry points, prototype function
  • builtin/builtin_list.h Application specific information and requirements

The build occurs in several phases as different build targets are executed: (1) context, (2) depend, and (3) default (all). Application information is collected during the make context build phase.

To execute an application function:

exec_builtin() is defined in the apps/include/builtin/builtin.h.

NuttShell (NSH) Built-In Commands

One use of builtin applications is to provide a way of invoking your custom application through the NuttShell (NSH) command line. NSH will support a seamless method invoking the applications, when the following option is enabled in the NuttX configuration file:

CONFIG_NSH_BUILTIN_APPS=y

Applications registered in the apps/builtin/builtin_list.h file will then be accessible from the NSH command line. If you type help at the NSH prompt, you will see a list of the registered commands.

Synchronous Built-In Commands

By default, built-in commands started from the NSH command line will run asynchronously with NSH. If you want to force NSH to execute commands then wait for the command to execute, you can enable that feature by adding the following to the NuttX configuration file:

CONFIG_SCHED_WAITPID=y

The configuration option enables support for the waitpid() RTOS interface. When that interface is enabled, NSH will use it to wait, sleeping until the built-in command executes to completion.

Of course, even with CONFIG_SCHED_WAITPID=y defined, specific commands can still be forced to run asynchronously by adding the ampersand (&) after the NSH command.

Application Configuration File

The NuttX configuration uses kconfig-frontends tools and the NuttX configuration file (.config) file. For example, the NuttX .config may have:

CONFIG_EXAMPLES_HELLO=y

This will select the apps/examples/hello in the following way:

  • The top-level make will include apps/examples/Make.defs
  • apps/examples/Make.defs will set CONFIGURED_APPS += $(APPDIR)/examples/hello like this:
  ifneq ($(CONFIG_EXAMPLES_HELLO),)
  CONFIGURED_APPS += $(APPDIR)/examples/hello
  endif

Example Built-In Application

An example application skeleton can be found under the examples/hello sub-directory. This example shows how a builtin application can be added to the project. One must:

  1. Create sub-directory as: progname

  2. In this directory there should be:

    • A Make.defs file that would be included by the apps/Makefile
    • A Kconfig file that would be used by the configuration tool (see the file kconfig-language.txt in the NuttX tools repository). This Kconfig file should be included by the apps/Kconfig file
    • A Makefile, and
    • The application source code.
  3. The application source code should provide the entry point:

    main()
    
  4. Set the requirements in the file: Makefile, specially the lines:

    PROGNAME   = progname
    PRIORITY   = SCHED_PRIORITY_DEFAULT
    STACKSIZE  = 768
    ASRCS      = asm source file list as a.asm b.asm ...
    CSRCS      = C source file list as foo1.c foo2.c ..
    
  5. The Make.defs file should include a line like:

    ifneq ($(CONFIG_PROGNAME),)
    CONFIGURED_APPS += progname
    endif
    

Building NuttX with Board-Specific Pieces Outside the Source Tree

Q: Has anyone come up with a tidy way to build NuttX with board- specific pieces outside the source tree?

A: Here are three:

  1. There is a make target called make export. It will build NuttX, then bundle all of the header files, libraries, startup objects, and other build components into a .zip file. You can move that .zip file into any build environment you want. You can even build NuttX under a DOS CMD window.

    This make target is documented in the top level nuttx/README.txt.

  2. You can replace the entire apps/ directory. If there is nothing in the apps/ directory that you need, you can define CONFIG_APPS_DIR in your .config file so that it points to a different, custom application directory.

    You can copy any pieces that you like from the old apps/directory to your custom apps directory as necessary.

    This is documented in NuttX/boards/README.txt and NuttX Porting Guide online at https://cwiki.apache.org/confluence/display/NUTTX/Porting+Guide.

  3. If you like the random collection of stuff in the apps/ directory but just want to expand the existing components with your own, external sub-directory then there is an easy way to that too: You just create a symbolic link in the apps/ directory that redirects to your application sub-directory.

    In order to be incorporated into the build, the directory that you link under the apps/ directory should contain (1) a Makefile that supports the clean and distclean targets (see other Makefiles for examples), and (2) a tiny Make.defs file that simply adds the custom build directories to the variable CONFIGURED_APPS like:

    CONFIGURED_APPS += my_directory1 my_directory2
    

    The apps/Makefile will always automatically check for the existence of subdirectories containing a Makefile and a Make.defs file. The Makefile will be used only to support cleaning operations. The Make.defs file provides the set of directories to be built; these directories must also contain a Makefile. That Makefile must be able to build the sources and add the objects to the apps/libapps.a archive. (see other Makefiles for examples). It should support the all, install, context, and depend targets.

    apps/Makefile does not depend on any hardcoded lists of directories. Instead, it does a wildcard search to find all appropriate directories. This means that to install a new application, you simply have to copy the directory (or link it) into the apps/ directory. If the new directory includes a Makefile and Make.defs file, then it will automatically be included in the build.

    If the directory that you add also includes a Kconfig file, then it will automatically be included in the NuttX configuration system as well. apps/Makefile uses a tool at apps/tools/mkkconfig.sh that dynamically builds the apps/Kconfig file at pre-configuration time.

    You could, for example, create a script called install.sh that installs a custom application, configuration, and board specific directory:

    a) Copy MyBoard directory to boards/MyBoard. b) Add a symbolic link to MyApplication at apps/external. c) Configure NuttX, usually by:

    tools/configure.sh MyBoard:MyConfiguration
    

    Use of the name apps/external is suggested because that name is included in the .gitignore file and will save you some nuisance when working with GIT.

Export restrictions

This distribution includes cryptographic software. The country in which you currently reside may have restrictions on the import, possession, use, and/or re-export to another country, of encryption software. BEFORE using any encryption software, please check your country's laws, regulations and policies concerning the import, possession, or use, and re-export of encryption software, to see if this is permitted. See http://www.wassenaar.org/ for more information.

The U.S. Government Department of Commerce, Bureau of Industry and Security (BIS), has classified this software as Export Commodity Control Number (ECCN) 5D002.C.1, which includes information security software using or performing cryptographic functions with asymmetric algorithms. The form and manner of this Apache Software Foundation distribution makes it eligible for export under the License Exception ENC Technology Software Unrestricted (TSU) exception (see the BIS Export Administration Regulations, Section 740.13) for both object code and source code.

The following provides more details on the included cryptographic software: https://tls.mbed.org/supported-ssl-ciphersuites. https://github.com/intel/tinycrypt