xref: /aosp_15_r20/external/flashrom/doc/intro.rst (revision 0d6140be3aa665ecc836e8907834fcd3e3b018fc)
1*0d6140beSAndroid Build Coastguard Worker**flashrom** is a utility for identifying, reading, writing, verifying and erasing flash
2*0d6140beSAndroid Build Coastguard Workerchips. It is designed to flash BIOS/EFI/coreboot/firmware/optionROM images on mainboards,
3*0d6140beSAndroid Build Coastguard Workernetwork/graphics/storage controller cards, and various other programmer devices.
4*0d6140beSAndroid Build Coastguard Worker
5*0d6140beSAndroid Build Coastguard Worker* Supports more than 627 flash chips, 407 chipsets, 539 mainboards, 94 PCI devices,
6*0d6140beSAndroid Build Coastguard Worker  30 USB devices and various parallel/serial port-based programmers.
7*0d6140beSAndroid Build Coastguard Worker  For more information, see the pages under :doc:`/supported_hw/index`.
8*0d6140beSAndroid Build Coastguard Worker
9*0d6140beSAndroid Build Coastguard Worker* Supports parallel, LPC, FWH and SPI flash interfaces and various chip packages (DIP32,
10*0d6140beSAndroid Build Coastguard Worker  PLCC32, DIP8, SO8/SOIC8, TSOP32, TSOP40, TSOP48, BGA and more), see :doc:`user_docs/overview`.
11*0d6140beSAndroid Build Coastguard Worker
12*0d6140beSAndroid Build Coastguard Worker* No physical access needed, root access is sufficient (not needed for some programmers).
13*0d6140beSAndroid Build Coastguard Worker
14*0d6140beSAndroid Build Coastguard Worker* No bootable floppy disk, bootable CD-ROM or other media needed.
15*0d6140beSAndroid Build Coastguard Worker
16*0d6140beSAndroid Build Coastguard Worker* No keyboard or monitor needed. Simply reflash remotely via SSH.
17*0d6140beSAndroid Build Coastguard Worker
18*0d6140beSAndroid Build Coastguard Worker* No instant reboot needed. Reflash your chip in a running system, verify it, be happy.
19*0d6140beSAndroid Build Coastguard Worker  The new firmware will be present next time you boot.
20*0d6140beSAndroid Build Coastguard Worker
21*0d6140beSAndroid Build Coastguard Worker* Crossflashing and hotflashing is possible as long as the flash chips are electrically
22*0d6140beSAndroid Build Coastguard Worker  and logically compatible (same protocol). Great for recovery.
23*0d6140beSAndroid Build Coastguard Worker
24*0d6140beSAndroid Build Coastguard Worker* Scriptability. Reflash a whole pool of identical machines at the same time from the
25*0d6140beSAndroid Build Coastguard Worker  command line. It is recommended to check flashrom output and error codes.
26*0d6140beSAndroid Build Coastguard Worker
27*0d6140beSAndroid Build Coastguard Worker* Speed. flashrom is often much faster than most vendor flash tools.
28*0d6140beSAndroid Build Coastguard Worker
29*0d6140beSAndroid Build Coastguard Worker* Portability. Supports DOS, Linux, FreeBSD (including Debian/kFreeBSD), NetBSD, OpenBSD,
30*0d6140beSAndroid Build Coastguard Worker  DragonFlyBSD, anything Solaris-like, Mac OS X, and other Unix-like OSes as well as GNU Hurd.
31*0d6140beSAndroid Build Coastguard Worker  Partial Windows support is available (no internal programmer support at the moment, hence
32*0d6140beSAndroid Build Coastguard Worker  no "BIOS flashing").
33*0d6140beSAndroid Build Coastguard Worker
34*0d6140beSAndroid Build Coastguard Worker.. todo:: Convert Technology page and add links here
35*0d6140beSAndroid Build Coastguard Worker
36*0d6140beSAndroid Build Coastguard Worker.. container:: danger, admonition
37*0d6140beSAndroid Build Coastguard Worker
38*0d6140beSAndroid Build Coastguard Worker   **Emergency help**
39*0d6140beSAndroid Build Coastguard Worker
40*0d6140beSAndroid Build Coastguard Worker   IMPORTANT: If something went wrong during flashing, do NOT turn off/reboot your computer.
41*0d6140beSAndroid Build Coastguard Worker   Instead, let us help you recover. We can be contacted via `IRC <https://www.flashrom.org/contact.html#irc>`_
42*0d6140beSAndroid Build Coastguard Worker   (#flashrom on `libera.chat <irc://irc.libera.chat/#flashrom>`_, `webchat <https://web.libera.chat/#flashrom>`_),
43*0d6140beSAndroid Build Coastguard Worker   `Discord <https://www.flashrom.org/contact.html#discord>`_, or `email <https://www.flashrom.org/contact.html#mailing-list-1>`_.
44*0d6140beSAndroid Build Coastguard Worker   Please allow some time until someone responds, we're all volunteers.
45