openwrt/flashrom
1
0
Fork 0
mirror of https://review.coreboot.org/flashrom.git synced 2025-04-27 07:02:34 +02:00
Code Issues Releases Wiki Activity
3,715 Commits 9 Branches 44 Tags
Go to file
Clone
Open with VS Code Open with VSCodium Open with Intellij IDEA
Download ZIP Download TAR.GZ Download BUNDLE
Anastasia Klimchuk 49fbdc7dd6 doc: Clarify that adding docs follows dev process and add into howtos 
Also add link to "How to add new doc" into a collection of
Contributors howtos.

The doc stays in root of docs, and also in the main left-side
menu on the website, so that it is very easy to discover. Everyone
who has even the slightest motivation to update the docs, should
be able to find instructions easily.

Change-Id: I882de0614ab76b8e83b0fafa67296526fecd8a16
Signed-off-by: Anastasia Klimchuk <aklm@flashrom.org>
Reviewed-on: https://review.coreboot.org/c/flashrom/+/80631
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Stefan Reinauer <stefan.reinauer@coreboot.org>
2024-02-23 01:44:26 +00:00
.github/workflows
website/gh workflow: Resolve 404 links
2023-08-03 23:04:56 +00:00
bindings/rust
flashrom_tester: Fix partial_lock_test on libflashrom
2024-02-03 07:43:35 +00:00
doc
doc: Clarify that adding docs follows dev process and add into howtos
2024-02-23 01:44:26 +00:00
Documentation
doc: Convert build documentation to sphinx
2023-04-27 09:41:58 +00:00
include
flashchips: Add Macronix MX25R1635F
2024-02-07 06:16:49 +00:00
Makefile.d
Remove dependency on C23 __has_include()
2023-11-28 23:26:01 +00:00
meson_cross
meson_cross: Introduce meson cross file for DJGPP/DOS
2023-04-27 09:41:27 +00:00
platform
meson: Refactor the programmer selection
2022-09-12 07:15:03 +00:00
scripts
tests: Add llvm-cov option and run target for code coverage
2022-12-11 21:27:27 +00:00
subprojects
Revert "cmocka: Drop as meson subproject"
2022-09-08 06:27:10 +00:00
tests
tests: Add test cases for erasing/writing unaligned layout regions
2024-01-15 02:01:54 +00:00
util
flashrom_tester: Fix partial_lock_test on libflashrom
2024-02-03 07:43:35 +00:00
.gitattributes
bindings/rust/libflashrom-sys: Create thin rust bindgen binding
2022-08-19 04:37:21 +00:00
.gitignore
move manpage to sphinx
2023-03-01 09:40:52 +00:00
82802ab.c
tree/: Convert unlock func ptr into enumerate values
2023-03-20 00:36:56 +00:00
amd_imc.c
amd_imc.c: Fix unusual typo in log message
2022-12-22 14:03:37 +00:00
asm106x.c
tree/: Drop default_spi_probe_opcode for NULL case
2023-03-03 17:35:50 +00:00
at45db.c
tree/: Case write_granularity enum values
2023-04-06 05:15:03 +00:00
atahpt.c
parallel: Drop explicit fallback_chip_X boilerplate
2023-01-11 22:51:35 +00:00
atapromise.c
parallel: Drop explicit fallback_chip_X boilerplate
2023-01-11 22:51:35 +00:00
atavia.c
printf: Use inttype.h macros for format strings
2023-04-27 09:36:46 +00:00
bitbang_spi.c
tree/: Drop default_spi_probe_opcode for NULL case
2023-03-03 17:35:50 +00:00
board_enable.c
printf: Use inttype.h macros for format strings
2023-04-27 09:36:46 +00:00
buspirate_spi.c
buspirate_spi: add support for hiz output with pullups=off
2023-12-10 21:47:27 +00:00
cbtable.c
printf: Use inttype.h macros for format strings
2023-04-27 09:36:46 +00:00
ch341a_spi.c
ch341a_spi: drop validation of handle in routines
2023-04-13 09:33:29 +00:00
ch347_spi.c
tree/: Drop default_spi_probe_opcode for NULL case
2023-03-03 17:35:50 +00:00
chipset_enable.c
ichspi: Add support for C740 PCH
2023-10-25 10:03:31 +00:00
cli_classic.c
printf: Use inttype.h macros for format strings
2023-04-27 09:36:46 +00:00
cli_common.c
flash.h: extend struct tested with .wp field
2022-10-23 22:00:23 +00:00
cli_getopt.c
cli_classic: include a fallback inplementation of getopt
2023-04-27 09:31:49 +00:00
cli_output.c
libflashrom: Return progress state to the library user
2022-05-25 08:08:13 +00:00
COPYING
Add a dedicated license
2007-09-08 14:36:01 +00:00
custom_baud_darwin.c
serial: Add Darwin/macOS support for custom and >230400 baudrates
2023-02-16 17:29:58 +00:00
custom_baud_linux.c
serial: Call set_custom_baudrate() thrice
2023-02-16 17:29:21 +00:00
custom_baud.c
serial: Call set_custom_baudrate() thrice
2023-02-16 17:29:21 +00:00
dediprog.c
tree/: Drop default_spi_probe_opcode for NULL case
2023-03-03 17:35:50 +00:00
developerbox_spi.c
drivers/: Make 'fallback_{un}map' the default unless defined
2022-10-08 18:36:21 +00:00
digilent_spi.c
tree/: Drop default_spi_probe_opcode for NULL case
2023-03-03 17:35:50 +00:00
dirtyjtag_spi.c
tree/: Drop default_spi_probe_opcode for NULL case
2023-03-03 17:35:50 +00:00
dmi.c
dmi.c: Pass is_laptop by ref into dmi
2023-03-28 00:36:36 +00:00
Doxyfile
libflashrom: Move documentation to header
2022-05-06 01:00:37 +00:00
drkaiser.c
parallel: Drop explicit fallback_chip_X boilerplate
2023-01-11 22:51:35 +00:00
dummyflasher.c
printf: Use inttype.h macros for format strings
2023-04-27 09:36:46 +00:00
edi.c
tree: provide flashrom context into programmer_delay()
2022-10-17 01:00:35 +00:00
en29lv640b.c
tree: provide flashrom context into programmer_delay()
2022-10-17 01:00:35 +00:00
erasure_layout.c
erasure_layout: Fix unaligned region end offset by 1
2024-01-15 02:01:31 +00:00
flashchips.c
flashchips: Add Macronix MX25R1635F
2024-02-07 06:16:49 +00:00
flashrom.c
flashrom: only perform WP unlock for write/erase operations
2023-08-31 02:57:34 +00:00
fmap.c
tree/: Convert flashchip read func ptr to enumerate
2022-11-01 01:16:26 +00:00
ft2232_spi.c
tree/: Drop default_spi_probe_opcode for NULL case
2023-03-03 17:35:50 +00:00
gfxnvidia.c
printf: Use inttype.h macros for format strings
2023-04-27 09:36:46 +00:00
helpers_fileio.c
flashrom.c: Move write_buf_to_file() to helpers_fileio.c
2022-08-25 00:25:41 +00:00
helpers.c
helpers.c: use unsigned int for bit shifts (ASAN)
2022-03-21 02:11:02 +00:00
hwaccess_physmap.c
libpayload: Fix compiling bugs
2022-11-23 06:53:09 +00:00
hwaccess_x86_io.c
hwaccess_x86_io: Improve IO permission error messages
2023-05-29 00:35:53 +00:00
hwaccess_x86_msr.c
hwaccess_x86_msr: drop outdated comment
2022-04-13 11:47:25 +00:00
i2c_helper_linux.c
tree: Port programmers to pass programmer_cfg to extractors
2022-09-07 01:56:58 +00:00
ich_descriptors.c
ichspi: Add support for C740 PCH
2023-10-25 10:03:31 +00:00
ichspi.c
ichspi: Add support for C740 PCH
2023-10-25 10:03:31 +00:00
internal_par.c
internal: Move parallel logic into internal_par implementation
2023-02-15 06:28:41 +00:00
internal.c
internal: Move laptop_ok into board_cfg
2023-04-06 04:43:29 +00:00
it87spi.c
tree/: Drop default_spi_probe_opcode for NULL case
2023-03-03 17:35:50 +00:00
it8212.c
parallel: Drop explicit fallback_chip_X boilerplate
2023-01-11 22:51:35 +00:00
jedec.c
printf: Use inttype.h macros for format strings
2023-04-27 09:36:46 +00:00
jlink_spi.c
jlink_spi: add cs=tms option to jlink_spi programmer
2023-05-14 07:25:25 +00:00
known_boards.c
print.c: Move list of known boards to known_boards.c
2022-08-29 00:21:48 +00:00
layout.c
libflashrom: Add layout "exclude" API
2023-07-18 01:17:04 +00:00
libflashrom.c
fmap: ignore areas with zero size
2023-03-14 10:40:02 +00:00
libflashrom.map
libflashrom: Add layout "exclude" API
2023-07-18 01:17:04 +00:00
linux_mtd.c
linux_mtd: Mark Opaque chip as tested for WP
2022-11-21 01:27:03 +00:00
linux_spi.c
tree/: Drop default_spi_probe_opcode for NULL case
2023-03-03 17:35:50 +00:00
MAINTAINERS
MAINTAINERS: Add Hsuan Ting Chen for flashrom_tester
2023-12-08 22:36:20 +00:00
Makefile
Makefile,meson.build: Add support for Sphinx versions prior to 4.x
2024-02-21 11:07:24 +00:00
Makefile.include
Makefile: Build man-page only when sphinx is available
2023-05-10 03:02:07 +00:00
mcp6x_spi.c
printf: Use inttype.h macros for format strings
2023-04-27 09:36:46 +00:00
mediatek_i2c_spi.c
tree/: Drop default_spi_probe_opcode for NULL case
2023-03-03 17:35:50 +00:00
meson_options.txt
meson: Add support for ni845x_spi on Windows
2023-07-13 09:29:14 +00:00
meson.build
Remove dependency on C23 __has_include()
2023-11-28 23:26:01 +00:00
mstarddc_spi.c
tree/: Drop default_spi_probe_opcode for NULL case
2023-03-03 17:35:50 +00:00
ni845x_spi.c
ni845x_spi: refactor singleton states into reentrant pattern
2023-07-19 02:23:21 +00:00
nic3com.c
parallel: Drop explicit fallback_chip_X boilerplate
2023-01-11 22:51:35 +00:00
nicintel_eeprom.c
printf: Use inttype.h macros for format strings
2023-04-27 09:36:46 +00:00
nicintel_spi.c
drivers/: Make 'fallback_{un}map' the default unless defined
2022-10-08 18:36:21 +00:00
nicintel.c
parallel: Drop explicit fallback_chip_X boilerplate
2023-01-11 22:51:35 +00:00
nicnatsemi.c
parallel: Drop explicit fallback_chip_X boilerplate
2023-01-11 22:51:35 +00:00
nicrealtek.c
parallel: Drop explicit fallback_chip_X boilerplate
2023-01-11 22:51:35 +00:00
ogp_spi.c
drivers/: Make 'fallback_{un}map' the default unless defined
2022-10-08 18:36:21 +00:00
opaque.c
opaque_master: Add shutdown function in opaque_master struct
2021-08-17 16:30:46 +00:00
parade_lspcon.c
tree/: Drop default_spi_probe_opcode for NULL case
2023-03-03 17:35:50 +00:00
parallel.c
parallel: Drop explicit fallback_chip_X boilerplate
2023-01-11 22:51:35 +00:00
pcidev.c
Revert "pcidev: remove pcidev_getdevfn() function"
2023-03-20 14:36:27 +00:00
pickit2_spi.c
tree/: Drop default_spi_probe_opcode for NULL case
2023-03-03 17:35:50 +00:00
pony_spi.c
tree/: Rename 'internal_delay()' to 'default_delay()'
2022-12-12 23:00:58 +00:00
print_wiki.c
flashrom: rewrite flashbuses_to_text()
2023-04-24 13:30:12 +00:00
print.c
flashrom: rewrite flashbuses_to_text()
2023-04-24 13:30:12 +00:00
printlock.c
tree/: Convert unlock func ptr into enumerate values
2023-03-20 00:36:56 +00:00
processor_enable.c
Remove address from GPLv2 headers
2018-04-24 20:21:41 +00:00
programmer_table.c
ch347_spi: Add initial support for the WCH CH347
2023-02-27 10:13:01 +00:00
programmer.c
parallel: Drop explicit fallback_chip_X boilerplate
2023-01-11 22:51:35 +00:00
raiden_debug_spi.c
raiden: Support target index with generic REQ_ENABLE
2023-11-03 05:59:53 +00:00
rayer_spi.c
rayer_spi.c: Get rid of temporary prog_type string
2022-10-22 00:45:30 +00:00
README.rst
doc: Add meson test command to TLDR for meson instructions
2023-11-02 06:56:29 +00:00
realtek_mst_i2c_spi.c
tree/: Drop default_spi_probe_opcode for NULL case
2023-03-03 17:35:50 +00:00
s25f.c
printf: Use inttype.h macros for format strings
2023-04-27 09:36:46 +00:00
satamv.c
printf: Use inttype.h macros for format strings
2023-04-27 09:36:46 +00:00
satasii.c
printf: Use inttype.h macros for format strings
2023-04-27 09:36:46 +00:00
sb600spi.c
printf: Use inttype.h macros for format strings
2023-04-27 09:36:46 +00:00
serial.c
serial: Fix sp_flush_incoming for serprog TCP connections
2023-11-27 09:09:35 +00:00
serprog.c
tree/: Drop default_spi_probe_opcode for NULL case
2023-03-03 17:35:50 +00:00
sfdp.c
printf: Use inttype.h macros for format strings
2023-04-27 09:36:46 +00:00
spi25_statusreg.c
spi25_statusreg: rename amic_a25l032 print to a generic name
2023-11-18 20:52:05 +00:00
spi25.c
printf: Use inttype.h macros for format strings
2023-04-27 09:36:46 +00:00
spi95.c
printf: Use inttype.h macros for format strings
2023-04-27 09:36:46 +00:00
spi.c
tree/: Drop default_spi_probe_opcode for NULL case
2023-03-03 17:35:50 +00:00
sst28sf040.c
tree: provide flashrom context into programmer_delay()
2022-10-17 01:00:35 +00:00
sst49lfxxxc.c
Remove address from GPLv2 headers
2018-04-24 20:21:41 +00:00
sst_fwhub.c
Fix -Wsign-compare trouble
2019-07-31 08:26:59 +00:00
stlinkv3_spi.c
tree/: Drop default_spi_probe_opcode for NULL case
2023-03-03 17:35:50 +00:00
stm50.c
tree: provide flashrom context into programmer_delay()
2022-10-17 01:00:35 +00:00
superio.c
internal.c: Move sio register to own object
2023-02-04 04:09:04 +00:00
test_build.sh
ch347_spi: Add initial support for the WCH CH347
2023-02-27 10:13:01 +00:00
udelay.c
tree/: Rename 'internal_delay()' to 'default_delay()'
2022-12-12 23:00:58 +00:00
usb_device.c
usb_device.c: remove LIBUSB() wrapper around call that may fail
2023-04-23 12:29:05 +00:00
usbblaster_spi.c
tree/: Drop default_spi_probe_opcode for NULL case
2023-03-03 17:35:50 +00:00
usbdev.c
usbdev.c: Add missing <inttypes.h> include
2019-10-22 23:24:16 +00:00
VERSION
meson make: use VERSION file
2023-05-07 08:36:39 +00:00
w29ee011.c
flashrom.c: Make 'chip_to_probe' a param to probe_flash()
2022-11-06 23:30:33 +00:00
w39.c
tree: provide flashrom context into programmer_delay()
2022-10-17 01:00:35 +00:00
wbsio_spi.c
board_enables: Allow for prog cfg coupling with board cfg
2023-04-02 01:00:13 +00:00
writeprotect_ranges.c
writeprotect_ranges.c: add more range functions
2022-11-19 06:59:30 +00:00
writeprotect.c
writeprotect: Add function to get register values and WP bit masks
2023-03-03 05:52:20 +00:00

README.rst 

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`
Description
No description provided
Readme 75 MiB
Languages
C 90.2%
Rust 5%
Shell 2%
Makefile 1.6%
Meson 1.2%