From 22e5d4a419dcf9188835aa8556b471d754778a75 Mon Sep 17 00:00:00 2001 From: Anastasia Klimchuk Date: Fri, 17 May 2024 23:53:34 +1000 Subject: [PATCH] doc: Add doc for dummyflasher Change-Id: I1e2039a3dcb958e96c4f1ff7b99a5629c3e83ed1 Signed-off-by: Anastasia Klimchuk Reviewed-on: https://review.coreboot.org/c/flashrom/+/82482 Reviewed-by: Sergii Dmytruk Tested-by: build bot (Jenkins) --- doc/supported_hw/supported_prog/dummyflasher.rst | 14 ++++++++++++++ doc/supported_hw/supported_prog/index.rst | 1 + 2 files changed, 15 insertions(+) create mode 100644 doc/supported_hw/supported_prog/dummyflasher.rst diff --git a/doc/supported_hw/supported_prog/dummyflasher.rst b/doc/supported_hw/supported_prog/dummyflasher.rst new file mode 100644 index 000000000..d11f59c50 --- /dev/null +++ b/doc/supported_hw/supported_prog/dummyflasher.rst @@ -0,0 +1,14 @@ +============ +Dummyflasher +============ + +Dummyflasher programmer is software-only implementation of a flashrom programmer. In other words, +it is an emulator which operates on in-memory arrays of bytes instead of a real chip. Dummyflasher does not interact with any hardware. + +This programmer is actively used in unit tests. + +Also, since dummyflasher implements all of the programmers APIs, it can be used as an example or as a starting point for implementing a new programmer. + +Related documents: + +* :doc:`/contrib_howtos/how_to_add_unit_test` diff --git a/doc/supported_hw/supported_prog/index.rst b/doc/supported_hw/supported_prog/index.rst index d8131a634..3f05c25d6 100644 --- a/doc/supported_hw/supported_prog/index.rst +++ b/doc/supported_hw/supported_prog/index.rst @@ -13,4 +13,5 @@ Patches to add/update documentation, or migrate docs from `old wiki website