adafruit-mirror/zephyr
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 9

doc: boards: silabs: Document board naming scheme

Browse source 
Update Sphinx documentation to explain how Silicon Labs boards
are named in Zephyr, now that all boards are consistently
named.

Signed-off-by: Aksel Skauge Mellbye <aksel.mellbye@silabs.com>
This commit is contained in:
Aksel Skauge Mellbye 2024-06-10 09:06:50 +02:00 committed by Anas Nashif
parent 45e49aaca2
commit 09a6849a1b
1 changed files with 18 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
boards/silabs/index.rst
View file

@ -9,3 +9,21 @@ Silicon Labs
:glob:
*/*
Silicon Labs development hardware is represented in Zephyr by mapping
Silicon Labs *kits* to Zephyr *boards*. The name used is the orderable product
number (OPN) of the kit, as found on the packaging and on the Silicon Labs
website. The board name in Zephyr is created by normalizing the OPN to lowercase
and replacing dashes with underscores.
You may find multiple other number and letter sequences silk-screened or lasered
onto Silicon Labs boards, including a PCB* number and a BRD* number. In most
cases, the digits of these sequences correspond to the numerical part of the kit
OPN. For instance, the kit ``xg24_dk2601b``, which is a Dev Kit for the
EFR32xG24 SoC, uses board BRD2601B, which again uses PCB2601A. It is possible to
use the ``west boards`` command to search for board names if you have a PCB and
you don't know what board name to use:
.. code-block:: console
west boards -n 2601