mirror of
https://review.coreboot.org/flashrom.git
synced 2025-04-26 22:52:34 +02:00

Change-Id: Ib231150acd8aa911d534f67ff1ce937c6963812c Signed-off-by: Anastasia Klimchuk <aklm@flashrom.org> Reviewed-on: https://review.coreboot.org/c/flashrom/+/86430 Reviewed-by: Stefan Reinauer <stefan.reinauer@coreboot.org> Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
51 lines
1.6 KiB
ReStructuredText
51 lines
1.6 KiB
ReStructuredText
flashrom README
|
|
===============
|
|
|
|
flashrom is a utility for detecting, reading, writing, verifying and erasing
|
|
flash chips. It is often used to flash BIOS/EFI/coreboot/firmware images
|
|
in-system using a supported mainboard, but it also supports flashing of network
|
|
cards (NICs), SATA controller cards, and other external devices which can
|
|
program flash chips.
|
|
|
|
It supports a wide range of flash chips (most commonly found in SOIC8, DIP8,
|
|
SOIC16, WSON8, PLCC32, DIP32, TSOP32, and TSOP40 packages), which use various
|
|
protocols such as LPC, FWH, parallel flash, or SPI.
|
|
|
|
Do not use flashrom on laptops (yet)! The embedded controller (EC) present in
|
|
many laptops might interact badly with any attempts to communicate with the
|
|
flash chip and may brick your laptop.
|
|
|
|
Please make a backup of your flash chip before writing to it.
|
|
|
|
Please see the flashrom(8) manpage :doc:`classic_cli_manpage`.
|
|
|
|
The list of platforms that package flashrom can be found on `repology.org <https://repology.org/project/flashrom/versions>`_.
|
|
|
|
Information about recent releases can be found in :doc:`/release_notes/index`.
|
|
|
|
Building / installing / packaging
|
|
---------------------------------
|
|
|
|
flashrom is built with **meson**. TLDR:
|
|
|
|
::
|
|
|
|
meson setup builddir
|
|
meson compile -C builddir
|
|
meson test -C builddir
|
|
meson install -C builddir
|
|
|
|
For full detailed instructions, follow the information in
|
|
:doc:`dev_guide/building_from_source`.
|
|
|
|
If you are interested in development, have a look at :doc:`dev_guide/development_guide`.
|
|
|
|
Contact
|
|
-------
|
|
|
|
The official flashrom website is:
|
|
|
|
https://www.flashrom.org/
|
|
|
|
For available contact methods see :doc:`contact`
|