Attention is currently required from: Thomas Heijligen.
Anastasia Klimchuk has uploaded this change for review. ( https://review.coreboot.org/c/flashrom/+/82198?usp=email )
Change subject: doc: Add doc for supported chipsets ......................................................................
doc: Add doc for supported chipsets
Change-Id: I9c9edc7deeeb7a783e2ba2fc6b372edb9c61609e Signed-off-by: Anastasia Klimchuk aklm@flashrom.org --- M doc/supported_hw/index.rst A doc/supported_hw/supported_chipsets.rst 2 files changed, 18 insertions(+), 0 deletions(-)
git pull ssh://review.coreboot.org:29418/flashrom refs/changes/98/82198/1
diff --git a/doc/supported_hw/index.rst b/doc/supported_hw/index.rst index cc0f9de..18f3d26 100644 --- a/doc/supported_hw/index.rst +++ b/doc/supported_hw/index.rst @@ -8,6 +8,8 @@
supported_flashchips supported_prog/index + supported_chipsets
* :doc:`supported_flashchips` * :doc:`supported_prog/index` +* :doc:`supported_chipsets` diff --git a/doc/supported_hw/supported_chipsets.rst b/doc/supported_hw/supported_chipsets.rst new file mode 100644 index 0000000..ba4de72 --- /dev/null +++ b/doc/supported_hw/supported_chipsets.rst @@ -0,0 +1,16 @@ +================== +Supported chipsets +================== + +To see the list of all supported chipsets, check the ``const struct penable chipset_enables[]`` in ``chipset_enable.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/chipset_enable.c#L1768`_. + +Each chipset entry is described by ``struct penable`` 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#L149`_. + +Note the ``enum test_state status`` of the chipset. ``OK`` means chipset is tested, ``NT`` means not tested, to see all possible +test states check the ``enum test_state`` definition in ``include/flash.h``. + +Also note that macros for supported buses are defined in ``chipset_enable.c`` right before ``chipset_enables[]`` array. +For example ``B_S`` means ``BUS_SPI``, check the ``chipset_enable.c`` source code for the rest of macro definitions.
-
Anastasia Klimchuk (Code Review)