Attention is currently required from: Thomas Heijligen.
Anastasia Klimchuk has uploaded this change for review. ( https://review.coreboot.org/c/flashrom/+/82197?usp=email )
Change subject: doc: Add doc for supported flash chips ......................................................................
doc: Add doc for supported flash chips
Change-Id: I05fb60a4caf2cfb30586fa482687b10638996395 Signed-off-by: Anastasia Klimchuk aklm@flashrom.org --- M doc/supported_hw/index.rst A doc/supported_hw/supported_flashchips.rst 2 files changed, 22 insertions(+), 0 deletions(-)
git pull ssh://review.coreboot.org:29418/flashrom refs/changes/97/82197/1
diff --git a/doc/supported_hw/index.rst b/doc/supported_hw/index.rst index 5b3305c..cc0f9de 100644 --- a/doc/supported_hw/index.rst +++ b/doc/supported_hw/index.rst @@ -6,6 +6,8 @@ :maxdepth: 3 :hidden:
+ supported_flashchips supported_prog/index
+* :doc:`supported_flashchips` * :doc:`supported_prog/index` diff --git a/doc/supported_hw/supported_flashchips.rst b/doc/supported_hw/supported_flashchips.rst new file mode 100644 index 0000000..d7128e0 --- /dev/null +++ b/doc/supported_hw/supported_flashchips.rst @@ -0,0 +1,20 @@ +===================== +Supported flash chips +===================== + +The list of all supported flash chips is in ``flashchips.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/flashchips.c`_. + +If you want to check whether a flash chip is supported in the given release, you can rebase your local +repo at the release tag, alternatively select a tag/branch in GitHub web UI (dropdown on the top-left). + +Each chip definition is described by a ``struct flashchip`` in ``include/flash.h``, which you can inspect in the same way, +either in local source tree or on GitHub web UI. + +Note the ``.tested`` status of the chip. If the status is ``TEST_UNTESTED`` this means chip definition has been added purely based on +datasheet, but without testing on real hardware. + +Instructions how to update tested status of the chip are here: :doc:`/contrib_howtos/how_to_mark_chip_tested`. + +Instructions how to add support for a chip are here: :doc:`/contrib_howtos/how_to_add_new_chip`.