OrgZephyr/zephyr
OrgZephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity
zephyr/samples/basic/minimal/README.rst

91 lines
2.3 KiB
ReStructuredText
Raw Normal View History

samples: basic: Add a minimal sample Add a minimal sample that showcases minimal ROM sizes. It can be built in several configurations, all very restrictive when it comes to features enabled in order to verify the fact that we can fit in small devices and to be able to accurately measure the sizes of the kernel's basic features. Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2019-05-10 01:48:17 +08:00
.. _minimal_sample:
samples: minimal: cleanups Touch up the README while we're looking at the basic samples. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-05-05 03:07:26 +08:00
Minimal footprint
#################
samples: basic: Add a minimal sample Add a minimal sample that showcases minimal ROM sizes. It can be built in several configurations, all very restrictive when it comes to features enabled in order to verify the fact that we can fit in small devices and to be able to accurately measure the sizes of the kernel's basic features. Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2019-05-10 01:48:17 +08:00
Overview
********
samples: minimal: cleanups Touch up the README while we're looking at the basic samples. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-05-05 03:07:26 +08:00
This sample provides an empty ``main()`` and various configuration files that
can be used to measure Zephyr's minimal ROM footprint in different
configurations.
samples: basic: Add a minimal sample Add a minimal sample that showcases minimal ROM sizes. It can be built in several configurations, all very restrictive when it comes to features enabled in order to verify the fact that we can fit in small devices and to be able to accurately measure the sizes of the kernel's basic features. Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2019-05-10 01:48:17 +08:00
The following configuration files are available:
* :file:`mt.conf`: Enable multithreading
* :file:`no-mt.conf`: Disable multithreading
* :file:`no-preempt.conf`: Disable preemption
samples: minimal: cleanups Touch up the README while we're looking at the basic samples. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-05-05 03:07:26 +08:00
* :file:`no-timers.conf`: Disable timers
samples: basic: Add a minimal sample Add a minimal sample that showcases minimal ROM sizes. It can be built in several configurations, all very restrictive when it comes to features enabled in order to verify the fact that we can fit in small devices and to be able to accurately measure the sizes of the kernel's basic features. Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2019-05-10 01:48:17 +08:00
* :file:`arm.conf`: Arm-specific disabling of features
Building and measuring ROM size
*******************************
samples: minimal: cleanups Touch up the README while we're looking at the basic samples. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-05-05 03:07:26 +08:00
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: