patrick/zephyr
1
0
Fork 0
Code Issues Pull requests Actions 8 Packages Projects Releases Wiki Activity

boards: shields: atmel_rf2xx: Improve documentation

Browse source 
Removes redundancy on atmel_rf2xx.overlay message. Clarifies supported
variations section and notes about network on index.rst.

Signed-off-by: Gerson Fernando Budke <nandojve@gmail.com>
This commit is contained in:
Gerson Fernando Budke 2020-07-25 23:57:00 -03:00 committed by Anas Nashif
parent 4bd247af70
commit 36f2d64f73
2 changed files with 13 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
boards/shields/atmel_rf2xx/atmel_rf2xx.overlay
View file

@ -5,8 +5,6 @@
*/
/*
* This file is intentionally empty. This shield target all board with a free
* SPI port. This type of boards should define a board overlay. If you board
* have Arduino, MikroBus, Xplained, Xplained Pro or any other standard header
* you must use the generic overlay accordingly.
* This file is intentionally empty. Please confer with shield documentation
* for instructions to use this shield.
*/

23
boards/shields/atmel_rf2xx/doc/index.rst
View file

@ -227,9 +227,12 @@ Supported variations
====================
The below table suggests shield variation accordingly with end user
application. The default shield atmel_rf2xx expects a board overlay. The
remaining configurations should be used based on the board standard headers
available.
application. When a standard connector (arduino, mikrobus, xplained,
xplained-pro) is available on board, user should select the matching shield
configuration. When atmel_rf2xx shield is used with a board that doesn't
feature a standard connector, a dedicated <board>.overlay file should be
provided. The remaining configurations should be used based on the board
standard headers available.
+-----------------------------+------------------------------+-----------+
| Connector Standard | Shield Designation | Variation |
@ -255,15 +258,11 @@ SPI interface, an interrupt signal and two GPIO. (see :ref:`shields` for more
details).
.. note::
The shield configuration was designed to be used with multiple network
interfaces. This means, boards with any other network interface can
be simultaneous enabled. User must be check network documentation to
avoid problem when running samples. For instance, boards with ethernet
automatically define that interface as default. Make sure to select
IEEE 802.15.4 interface as the default interface when build examples.
As general rule, keep only IEEE 802.15.4 interface enabled at
Networking -> Link Layer Options. This will ensure samples works as
expected.
Boards that already have a network interface: Check network
documentation to understand how properly configure both interfaces.
To keep simple, make sure IEEE 802.15.4 is the only interface enabled
at Networking -> Link Layer Options. This will avoid problems running
Zephyr samples.
Tested Boards
=============