xref: /aosp_15_r20/external/flashrom/README.rst (revision 0d6140be3aa665ecc836e8907834fcd3e3b018fc)
1*0d6140beSAndroid Build Coastguard Workerflashrom README
2*0d6140beSAndroid Build Coastguard Worker===============
3*0d6140beSAndroid Build Coastguard Worker
4*0d6140beSAndroid Build Coastguard Workerflashrom is a utility for detecting, reading, writing, verifying and erasing
5*0d6140beSAndroid Build Coastguard Workerflash chips. It is often used to flash BIOS/EFI/coreboot/firmware images
6*0d6140beSAndroid Build Coastguard Workerin-system using a supported mainboard, but it also supports flashing of network
7*0d6140beSAndroid Build Coastguard Workercards (NICs), SATA controller cards, and other external devices which can
8*0d6140beSAndroid Build Coastguard Workerprogram flash chips.
9*0d6140beSAndroid Build Coastguard Worker
10*0d6140beSAndroid Build Coastguard WorkerIt supports a wide range of flash chips (most commonly found in SOIC8, DIP8,
11*0d6140beSAndroid Build Coastguard WorkerSOIC16, WSON8, PLCC32, DIP32, TSOP32, and TSOP40 packages), which use various
12*0d6140beSAndroid Build Coastguard Workerprotocols such as LPC, FWH, parallel flash, or SPI.
13*0d6140beSAndroid Build Coastguard Worker
14*0d6140beSAndroid Build Coastguard WorkerDo not use flashrom on laptops (yet)! The embedded controller (EC) present in
15*0d6140beSAndroid Build Coastguard Workermany laptops might interact badly with any attempts to communicate with the
16*0d6140beSAndroid Build Coastguard Workerflash chip and may brick your laptop.
17*0d6140beSAndroid Build Coastguard Worker
18*0d6140beSAndroid Build Coastguard WorkerPlease make a backup of your flash chip before writing to it.
19*0d6140beSAndroid Build Coastguard Worker
20*0d6140beSAndroid Build Coastguard WorkerPlease see the flashrom(8) manpage :doc:`classic_cli_manpage`.
21*0d6140beSAndroid Build Coastguard Worker
22*0d6140beSAndroid Build Coastguard Worker
23*0d6140beSAndroid Build Coastguard WorkerBuilding / installing / packaging
24*0d6140beSAndroid Build Coastguard Worker---------------------------------
25*0d6140beSAndroid Build Coastguard Worker
26*0d6140beSAndroid Build Coastguard Workerflashrom is built with **meson**. TLDR:
27*0d6140beSAndroid Build Coastguard Worker
28*0d6140beSAndroid Build Coastguard Worker::
29*0d6140beSAndroid Build Coastguard Worker
30*0d6140beSAndroid Build Coastguard Worker    meson setup builddir
31*0d6140beSAndroid Build Coastguard Worker    meson compile -C builddir
32*0d6140beSAndroid Build Coastguard Worker    meson test -C builddir
33*0d6140beSAndroid Build Coastguard Worker    meson install -C builddir
34*0d6140beSAndroid Build Coastguard Worker
35*0d6140beSAndroid Build Coastguard WorkerFor full detailed instructions, follow the information in
36*0d6140beSAndroid Build Coastguard Worker:doc:`dev_guide/building_from_source`
37*0d6140beSAndroid Build Coastguard Worker
38*0d6140beSAndroid Build Coastguard WorkerContact
39*0d6140beSAndroid Build Coastguard Worker-------
40*0d6140beSAndroid Build Coastguard Worker
41*0d6140beSAndroid Build Coastguard WorkerThe official flashrom website is:
42*0d6140beSAndroid Build Coastguard Worker
43*0d6140beSAndroid Build Coastguard Worker  https://www.flashrom.org/
44*0d6140beSAndroid Build Coastguard Worker
45*0d6140beSAndroid Build Coastguard WorkerFor available contact methods see :doc:`contact`
46