openwrt/flashrom
1
0
Fork 0
mirror of https://review.coreboot.org/flashrom.git synced 2025-04-26 22:52:34 +02:00
Code Issues Releases Wiki Activity

doc: Add doc for supported boards and laptops

Browse Source 
Change-Id: Iaae05ccd138fd8f7760823f867f3c7799018dc2e
Signed-off-by: Anastasia Klimchuk <aklm@flashrom.org>
Reviewed-on: https://review.coreboot.org/c/flashrom/+/82271
Reviewed-by: Peter Marheine <pmarheine@chromium.org>
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
This commit is contained in:
Anastasia Klimchuk 2024-05-10 19:54:06 +10:00
parent ad10d8c4b9
commit 9048085a53
2 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/supported_hw/index.rst
View File

@ -8,3 +8,4 @@ Supported hardware
supported_flashchips
supported_prog/index
supported_chipsets
supported_boards

19
doc/supported_hw/supported_boards.rst Normal file
View File

@ -0,0 +1,19 @@
========================
Supported boards/laptops
========================
To see the list of all supported boards or laptops, check either ``struct board_info boards_known[]`` or ``struct board_info laptops_known[]``
in the ``known_boards.c`` file in the source tree.
If you have a flashrom repo cloned locally, you can look at the file in your repo, alternatively inspect the file
`on the web UI of our GitHub mirror <https://github.com/flashrom/flashrom/blob/main/known_boards.c#L29>`_.
If you can run flashrom locally, the command ``flashrom -L`` prints the list of all supported boards and laptops
(see :doc:`/classic_cli_manpage` for more details on command line options). The output of this command is long, so you might
want to save it to file or grep.
Each board entry is described by the ``struct board_info`` in ``include/programmer.h`` which you can inspect in the same way, either in the local source tree or
`in the GitHub web UI <https://github.com/flashrom/flashrom/blob/main/include/programmer.h#L207>`_.
Note the ``enum test_state status`` of the board. ``OK`` means board is tested, ``NT`` means not tested, to see all possible
test states check the ``enum test_state`` definition in ``include/flash.h``.