1
0
mirror of https://review.coreboot.org/flashrom.git synced 2025-04-26 22:52:34 +02:00
flashrom/doc/intro.rst
Anastasia Klimchuk f1ddf46820 doc: Add overview doc for user_docs
This document is converted from Technology page on wiki
https://wiki.flashrom.org/Technology

Change-Id: I93107d6b5530c301dd90f7177758632d9d1810eb
Signed-off-by: Anastasia Klimchuk <aklm@flashrom.org>
Reviewed-on: https://review.coreboot.org/c/flashrom/+/83584
Reviewed-by: Stefan Reinauer <stefan.reinauer@coreboot.org>
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
2024-08-03 08:52:13 +00:00

45 lines
2.3 KiB
ReStructuredText

**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 627 flash chips, 407 chipsets, 539 mainboards, 94 PCI devices,
30 USB devices and various parallel/serial port-based programmers.
For more information, see the pages under :doc:`/supported_hw/index`.
* Supports parallel, LPC, FWH and SPI flash interfaces and various chip packages (DIP32,
PLCC32, DIP8, SO8/SOIC8, TSOP32, TSOP40, TSOP48, BGA and more), see :doc:`user_docs/overview`.
* 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
.. container:: danger, admonition
**Emergency help**
IMPORTANT: If something went wrong during flashing, do NOT turn off/reboot your computer.
Instead, let us help you recover. We can be contacted via `IRC <https://www.flashrom.org/contact.html#irc>`_
(#flashrom on `libera.chat <irc://irc.libera.chat/#flashrom>`_, `webchat <https://web.libera.chat/#flashrom>`_),
`Discord <https://www.flashrom.org/contact.html#discord>`_, or `email <https://www.flashrom.org/contact.html#mailing-list-1>`_.
Please allow some time until someone responds, we're all volunteers.