Commit graph

8 commits

Author SHA1 Message Date
Jamie McCrae
d1c0f18e50 doc: board porting: Add runner requirements note
Add a note on requirements for runners that they be OS agnostic
and not assume a specific device or udev rule determines one
exact device.

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2023-01-27 16:12:39 -08:00
Declan Snyder
62abf16530 doc: board porting: Add clarifications
Clarify:
- Board directory name does not need to match board name
- Give example of multi board directory

Signed-off-by: Declan Snyder <declan.snyder@nxp.com>
2022-12-07 14:23:32 +00:00
Erwan Gouriou
bd6a25a661 doc: porting: shields: Provide guidelines for nodelabel
In order to avoid device definitions conflicts when compiling shields
description with boards embedding similar devices, nodelabels of devices
in shield's devicetree file should differ from the nodelabels used in
board's devicetree file.
The form to be used was discussed in #50040 and agreed to be as
<device>_<shield_name>.

Update shields documentation to make it an explicit rule.

Signed-off-by: Erwan Gouriou <erwan.gouriou@linaro.org>
2022-10-03 10:16:57 +02:00
Erwan Gouriou
656382e7a4 doc: porting: shields: Update instructions for nodelabel definitions
Update requirements regarding board connectors compatibility now that
dtc versions prior to 1.4.2 can't be used anymore (current required
version is 1.4.6).

Signed-off-by: Erwan Gouriou <erwan.gouriou@linaro.org>
2022-10-03 10:16:57 +02:00
Daniel Leung
fa79a7b1df doc: porting/arch: add two funcs for MMU enabling
Two more functions are needed for MMU enabling on a new
architecture, so add them to the porting guide.

Signed-off-by: Daniel Leung <daniel.leung@intel.com>
2022-08-09 12:27:21 +02:00
Gerard Marull-Paretas
c62e5bc4fc doc: board_porting: remove pinmux example
Pinmux should no longer happen in board C files since the addition of
the pinctrl API, so remove such guidelines from the board porting
guidelines.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-06-06 15:39:50 -07:00
Aleksandar Markovic
7af3b8cbb3 doc: Fix links to Zephyr include directory on Github
At some recent point, directory <zephyr-root>/include was moved to
<zephyr-root>/include/zephyr. However, links from documentation to
Zephyr source on Github were not updated. Update them now.

Signed-off-by: Aleksandar Markovic <aleksandar.markovic.sa@gmail.com>
2022-04-21 18:35:16 -04:00
Anas Nashif
7ad2f76720 doc: remove guides and split content
Remove the old guides section and move all remaining items into new
sections.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-04-07 16:35:19 +02:00