diff options
| author | Anastasia Klimchuk <aklm@chromium.org> | 2023-06-08 18:44:42 +1000 |
|---|---|---|
| committer | Anastasia Klimchuk <aklm@chromium.org> | 2023-06-11 09:33:17 +0000 |
| commit | 3239be535d16b10881513c0e97500cbd110426ab (patch) | |
| tree | a4e3c625c3d96d67baf5aadc7ef60b4826c68eb9 | |
| parent | 5dabb7c423f188e143eb1e32c7a8fc781f308d9b (diff) | |
| download | flashrom-3239be535d16b10881513c0e97500cbd110426ab.tar.gz flashrom-3239be535d16b10881513c0e97500cbd110426ab.tar.bz2 flashrom-3239be535d16b10881513c0e97500cbd110426ab.zip | |
doc: Add intro to the home page
The intro text is converted from wiki home page.
Change-Id: I2bf0d8a3b2e16c9bb7e6fbde5931ff816aede14a
Signed-off-by: Anastasia Klimchuk <aklm@chromium.org>
Reviewed-on: https://review.coreboot.org/c/flashrom/+/75723
Reviewed-by: Stefan Reinauer <stefan.reinauer@coreboot.org>
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
| -rw-r--r-- | doc/index.rst | 2 | ||||
| -rw-r--r-- | doc/intro.rst | 24 |
2 files changed, 26 insertions, 0 deletions
diff --git a/doc/index.rst b/doc/index.rst index e6dcc4d3f..f48a214bf 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -11,4 +11,6 @@ contact how_to_add_docs +.. include:: intro.rst + .. include:: ../README.rst diff --git a/doc/intro.rst b/doc/intro.rst new file mode 100644 index 000000000..254555a01 --- /dev/null +++ b/doc/intro.rst @@ -0,0 +1,24 @@ +**flashrom** is a utility for identifying, reading, writing, verifying and erasing flash +chips. It is designed to flash BIOS/EFI/coreboot/firmware/optionROM images on mainboards, +network/graphics/storage controller cards, and various other programmer devices. + +* Supports more than 476 flash chips, 291 chipsets, 500 mainboards, 79 PCI devices, + 17 USB devices and various parallel/serial port-based programmers. +* Supports parallel, LPC, FWH and SPI flash interfaces and various chip packages (DIP32, + PLCC32, DIP8, SO8/SOIC8, TSOP32, TSOP40, TSOP48, BGA and more). +* No physical access needed, root access is sufficient (not needed for some programmers). +* No bootable floppy disk, bootable CD-ROM or other media needed. +* No keyboard or monitor needed. Simply reflash remotely via SSH. +* No instant reboot needed. Reflash your chip in a running system, verify it, be happy. + The new firmware will be present next time you boot. +* Crossflashing and hotflashing is possible as long as the flash chips are electrically + and logically compatible (same protocol). Great for recovery. +* Scriptability. Reflash a whole pool of identical machines at the same time from the + command line. It is recommended to check flashrom output and error codes. +* Speed. flashrom is often much faster than most vendor flash tools. +* Portability. Supports DOS, Linux, FreeBSD (including Debian/kFreeBSD), NetBSD, OpenBSD, + DragonFlyBSD, anything Solaris-like, Mac OS X, and other Unix-like OSes as well as GNU Hurd. + Partial Windows support is available (no internal programmer support at the moment, hence + no "BIOS flashing"). + +.. todo:: Convert Technology page and add links here |