From 9048085a5330e4d21ef22fd127960162cb41de9d Mon Sep 17 00:00:00 2001 From: Anastasia Klimchuk Date: Fri, 10 May 2024 19:54:06 +1000 Subject: [PATCH] doc: Add doc for supported boards and laptops Change-Id: Iaae05ccd138fd8f7760823f867f3c7799018dc2e Signed-off-by: Anastasia Klimchuk Reviewed-on: https://review.coreboot.org/c/flashrom/+/82271 Reviewed-by: Peter Marheine Tested-by: build bot (Jenkins) --- doc/supported_hw/index.rst | 1 + doc/supported_hw/supported_boards.rst | 19 +++++++++++++++++++ 2 files changed, 20 insertions(+) create mode 100644 doc/supported_hw/supported_boards.rst diff --git a/doc/supported_hw/index.rst b/doc/supported_hw/index.rst index ba7713280..eebf39406 100644 --- a/doc/supported_hw/index.rst +++ b/doc/supported_hw/index.rst @@ -8,3 +8,4 @@ Supported hardware supported_flashchips supported_prog/index supported_chipsets + supported_boards diff --git a/doc/supported_hw/supported_boards.rst b/doc/supported_hw/supported_boards.rst new file mode 100644 index 000000000..91b2899df --- /dev/null +++ b/doc/supported_hw/supported_boards.rst @@ -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 `_. + +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 `_. + +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``.