mirror of
https://review.coreboot.org/flashrom.git
synced 2025-04-26 22:52:34 +02:00
86110b4077
Running tests is one of the regular things to do in dev process, same as compile, so it should be highlighted in the TLDR section of the document. The patch adds test command to TLDR version in README file, and in dedicated meson instructions doc. Change-Id: I67d5f4decdac15e6a72f4372135dab7d44396594 Signed-off-by: Anastasia Klimchuk <aklm@flashrom.org> Reviewed-on: https://review.coreboot.org/c/flashrom/+/78689 Reviewed-by: Jes Klinke <jbk@chromium.org> Reviewed-by: Alexander Goncharov <chat@joursoir.net> Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Peter Marheine <pmarheine@chromium.org>
60 lines
1.5 KiB
ReStructuredText
60 lines
1.5 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`.
|
|
|
|
|
|
Building / installing / packaging
|
|
---------------------------------
|
|
|
|
flashrom supports building with **make** and **meson**.
|
|
|
|
TLDR, building with meson
|
|
"""""""""""""""""""""""""
|
|
|
|
::
|
|
|
|
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`
|
|
|
|
TLDR, building with make
|
|
""""""""""""""""""""""""
|
|
|
|
::
|
|
|
|
make
|
|
make install
|
|
|
|
For full detailed instructions, follow the information in
|
|
:doc:`dev_guide/building_with_make`
|
|
|
|
Contact
|
|
-------
|
|
|
|
The official flashrom website is:
|
|
|
|
https://www.flashrom.org/
|
|
|
|
For available contact methods see :doc:`contact`
|