michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: shields: Add section on using Source Code

Browse source 
Providing guidance on how to add Source Code on Shields, as well as
clarifying the purpose.

Signed-off-by: Luis Ubieda <luisf@croxel.com>
This commit is contained in:
Luis Ubieda 2024-07-30 15:35:36 -04:00 • committed by Anas Nashif
commit 4b26f8616b
1 changed files with 17 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

17
doc/hardware/porting/shields.rst
View file

@ -48,6 +48,23 @@ to provide a device nodelabel is the form <device>_<shield>, for instance:
...
};
Adding Source Code
******************
It is possible to add source code to shields, as a way to meet configuration
requirements that are specific to the shield (e.g: initialization routines,
timing constraints, etc), in order to enable it for proper operation with the
different Zephyr components.
.. note::
Source code in shields shall not be used for purposes other than the
one described above. Generic functionalities that could be reused among
shields (and/or targets) shall not be captured here.
To effectively incorporate source code: add a :file:`CMakeLists.txt` file, as
well as the corresponding source files (referenced in CMake similar to other
areas of Zephyr, e.g: boards).
Board compatibility
*******************