diff options
| author | Anastasia Klimchuk <aklm@flashrom.org> | 2024-05-10 19:54:06 +1000 |
|---|---|---|
| committer | Anastasia Klimchuk <aklm@flashrom.org> | 2024-06-12 11:40:38 +0000 |
| commit | 9048085a5330e4d21ef22fd127960162cb41de9d (patch) | |
| tree | 2b8011c951c141e46bcf11c5769e6ff05c5c6b3b /doc | |
| parent | ad10d8c4b9016e24cf9052b0556aa5acdee01a38 (diff) | |
| download | flashrom-9048085a5330e4d21ef22fd127960162cb41de9d.tar.gz flashrom-9048085a5330e4d21ef22fd127960162cb41de9d.tar.bz2 flashrom-9048085a5330e4d21ef22fd127960162cb41de9d.zip | |
doc: Add doc for supported boards and laptops
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>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/supported_hw/index.rst | 1 | ||||
| -rw-r--r-- | doc/supported_hw/supported_boards.rst | 19 |
2 files changed, 20 insertions, 0 deletions
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 <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``. |