mirror of
https://review.coreboot.org/flashrom.git
synced 2025-04-27 15:12:36 +02:00
4fbb152402
This patch extracts building/installing/packaging documentation for meson and make into two separate doc files, and then links these files from README. Re-structure README so that it gives only a brief overview of build instructions and links to full instructions for meson and make. Ticket: https://ticket.coreboot.org/issues/489 Change-Id: I2d5900538d54c43efcc8c5b7010df5d867f3b190 Signed-off-by: Anastasia Klimchuk <aklm@chromium.org> Reviewed-on: https://review.coreboot.org/c/flashrom/+/75125 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Peter Marheine <pmarheine@chromium.org>
61 lines
1.5 KiB
ReStructuredText
61 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 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/
|
|
|
|
Available contact methods are
|
|
|
|
https://www.flashrom.org/Contact
|