Attention is currently required from: Thomas Heijligen.
Anastasia Klimchuk has uploaded this change for review. ( https://review.coreboot.org/c/flashrom/+/82271?usp=email )
Change subject: doc: Add doc for supported boards and laptops ......................................................................
doc: Add doc for supported boards and laptops
Change-Id: Iaae05ccd138fd8f7760823f867f3c7799018dc2e Signed-off-by: Anastasia Klimchuk aklm@flashrom.org --- M doc/supported_hw/index.rst A doc/supported_hw/supported_boards.rst 2 files changed, 20 insertions(+), 0 deletions(-)
git pull ssh://review.coreboot.org:29418/flashrom refs/changes/71/82271/1
diff --git a/doc/supported_hw/index.rst b/doc/supported_hw/index.rst index ba77132..eebf394 100644 --- a/doc/supported_hw/index.rst +++ b/doc/supported_hw/index.rst @@ -8,3 +8,4 @@ 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 0000000..91b2899 --- /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 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``.