mirror of
https://review.coreboot.org/flashrom.git
synced 2025-10-24 02:58:18 +02:00
c54d068418
This is especially important for manpage, but also any other document which has examples of command-line usage. On the actual command line the options are with -- and so it should be in documentation. The option also disables smart quotes, but this doesn't matter for flashrom documentation. Change-Id: I94531c9b7471c5c26dd92ddcce5b0588af9207fd Signed-off-by: Anastasia Klimchuk <aklm@flashrom.org> Reviewed-on: https://review.coreboot.org/c/flashrom/+/89633 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Peter Marheine <pmarheine@chromium.org>
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`