michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: provide board porting guidelines

Browse source 
Provide board porting guidelines to help achieving a coherent
board library to ease work for people developing application
not board specific and define clear objective to help board
porting reviews.

Signed-off-by: Erwan Gouriou <erwan.gouriou@linaro.org>
This commit is contained in:
Erwan Gouriou 2018-04-06 10:28:50 +02:00 • committed by Anas Nashif
commit 9708372080
1 changed files with 27 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

27
doc/porting/board_porting.rst
View file

@ -120,3 +120,30 @@ Board
A board implements an SoC with all its features, together with peripherals
available on the board that differentiates the board with additional interfaces
and features not available in the SoC.
Default board configuration
***************************
When porting Zephyr to a board, you must provide the board's default
Kconfig configuration, which is used in application builds unless explicitly
overridden.
In order to provide consistency across the various boards and ease the work of
users providing applications that are not board specific, the following
guidelines should be followed when porting a board:
- Provide pin and driver configuration that matches the board's valuable
components such as sensors, buttons or LEDs, and communication interfaces
such as USB, Ethernet connector, or Bluetooth/WiFi chip.
- When a well-known connector is present (such as used on an Arduino or
96board), configure pins to fit this connector.
- Configure components that enable the use of these pins, such as
configuring and SPI instance for Arduino SPI.
- Configure an output for the console.
- Propose and configure a default network interface.
- Enable all GPIO ports.