zephyr/samples/basic/minimal
Anas Nashif 1fbbfc819a tests/samples: add tags to some tests
Some tests/samples had no tags, fill those..

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2020-07-20 17:44:16 -04:00
..
src samples: basic: Add a minimal sample 2019-05-15 10:44:59 +02:00
arm.conf samples: basic: Add a minimal sample 2019-05-15 10:44:59 +02:00
CMakeLists.txt samples: make find_package(Zephyr...) REQUIRED 2020-05-29 10:47:25 +02:00
common.conf kconfig: Rename CONFIG_FLOAT to CONFIG_FPU 2020-04-27 19:03:44 +02:00
mt.conf samples: basic: Add a minimal sample 2019-05-15 10:44:59 +02:00
no-mt.conf samples: basic: Add a minimal sample 2019-05-15 10:44:59 +02:00
no-preempt.conf samples: basic: Add a minimal sample 2019-05-15 10:44:59 +02:00
no-timers.conf kernel: Crank up default tick rate 2019-07-02 22:52:29 -04:00
README.rst samples: minimal: cleanups 2020-05-13 19:51:01 +02:00
sample.yaml tests/samples: add tags to some tests 2020-07-20 17:44:16 -04:00
x86.conf samples: basic: Add a minimal sample 2019-05-15 10:44:59 +02:00

.. _minimal_sample:

Minimal footprint
#################

Overview
********

This sample provides an empty ``main()`` and various configuration files that
can be used to measure Zephyr's minimal ROM footprint in different
configurations.

The following configuration files are available:

* :file:`mt.conf`: Enable multithreading
* :file:`no-mt.conf`: Disable multithreading
* :file:`no-preempt.conf`: Disable preemption
* :file:`no-timers.conf`: Disable timers
* :file:`arm.conf`: Arm-specific disabling of features

Building and measuring ROM size
*******************************

The following combinations are suggested for comparing ROM sizes in different
configurations. They all target the :ref:`reel_board` (Arm Aarch32 architecture).

* Multithreading enabled

  * Reference ROM size: 7-8KB

  .. zephyr-app-commands::
     :zephyr-app: samples/basic/minimal
     :host-os: unix
     :board: reel_board
     :build-dir: reel_board/mt/
     :conf: "common.conf mt.conf arm.conf"
     :goals: rom_report
     :compact:

* Multithreading enabled, no preemption

  * Reference ROM size: 7-8KB

  .. zephyr-app-commands::
     :zephyr-app: samples/basic/minimal
     :host-os: unix
     :board: reel_board
     :build-dir: reel_board/mt-no-preempt/
     :conf: "common.conf mt.conf no-preempt.conf arm.conf"
     :goals: rom_report
     :compact:

* Multithreading enabled, no preemption, timers disabled

  * Reference ROM size: 3-4KB

  .. zephyr-app-commands::
     :zephyr-app: samples/basic/minimal
     :host-os: unix
     :board: reel_board
     :build-dir: reel_board/mt-no-preempt-no-timers/
     :conf: "common.conf mt.conf no-preempt.conf no-timers.conf arm.conf"
     :goals: rom_report
     :compact:

* Multithreading disabled, timers enabled

  * Reference ROM size: 4-5KB

  .. zephyr-app-commands::
     :zephyr-app: samples/basic/minimal
     :host-os: unix
     :board: reel_board
     :build-dir: reel_board/no-mt/
     :conf: "common.conf no-mt.conf arm.conf"
     :goals: rom_report
     :compact:

* Multithreading disabled, timers disabled

  * Reference ROM size: 2-3KB

  .. zephyr-app-commands::
     :zephyr-app: samples/basic/minimal
     :host-os: unix
     :board: reel_board
     :build-dir: reel_board/no-mt-no-timers/
     :conf: "common.conf no-mt.conf no-timers.conf arm.conf"
     :goals: rom_report
     :compact: