February 2025 - flashrom-gerrit

Change in ...flashrom[master]: Add support for security register and SBULK command on Macronix chips
by vl_sk (Code Review) Jan. 13, 2026

Jan. 13, 2026

vl_sk has uploaded this change for review. ( https://review.coreboot.org/c/flashrom/+/32034 Change subject: Add support for security register and SBULK command on Macronix chips ...................................................................... Add support for security register and SBULK command on Macronix chips Signed-off-by: Vladimir Skokov <vl_sk(a)mail.ru> Change-Id: I6b3d7bd2625dec5fda7b85f421d40c49bbc528a6 --- M chipdrivers.h M flashchips.c M spi.h M spi25_statusreg.c 4 files changed, 78 insertions(+), 24 deletions(-) git pull ssh://review.coreboot.org:29418/flashrom refs/changes/34/32034/1 diff --git a/chipdrivers.h b/chipdrivers.h index 134ed26..54288cd 100644 --- a/chipdrivers.h +++ b/chipdrivers.h @@ -102,7 +102,9 @@ int spi_prettyprint_status_register_sst25(struct flashctx *flash); int spi_prettyprint_status_register_sst25vf016(struct flashctx *flash); int spi_prettyprint_status_register_sst25vf040b(struct flashctx *flash); +int spi_prettyprint_security_register_mx25(struct flashctx *flash); int spi_disable_blockprotect_sst26_global_unprotect(struct flashctx *flash); +int spi_disable_blockprotect_mx25_global_unprotect(struct flashctx *flash); /* sfdp.c */ int probe_spi_sfdp(struct flashctx *flash); diff --git a/flashchips.c b/flashchips.c index d85ea74..2c662e9 100644 --- a/flashchips.c +++ b/flashchips.c @@ -8555,9 +8555,8 @@ .block_erase = spi_block_erase_c7, } }, - /* TODO: security register and SBLK/SBULK; MX25L12835F: configuration register */ - .printlock = spi_prettyprint_status_register_bp3_srwd, /* bit6 is quad enable */ - .unlock = spi_disable_blockprotect_bp3_srwd, + .printlock = spi_prettyprint_security_register_mx25, + .unlock = spi_disable_blockprotect_mx25_global_unprotect, .write = spi_chip_write_256, .read = spi_chip_read, /* Fast read (0x0B) supported */ .voltage = {2700, 3600}, @@ -8604,9 +8603,8 @@ .block_erase = spi_block_erase_c7, } }, - /* TODO: security register and SBLK/SBULK; MX25L12835F: configuration register */ - .printlock = spi_prettyprint_status_register_bp3_srwd, /* bit6 is quad enable */ - .unlock = spi_disable_blockprotect_bp3_srwd, + .printlock = spi_prettyprint_security_register_mx25, + .unlock = spi_disable_blockprotect_mx25_global_unprotect, .write = spi_chip_write_256, .read = spi_chip_read, /* Fast read (0x0B) supported */ .voltage = {2700, 3600}, @@ -8693,9 +8691,8 @@ .block_erase = spi_block_erase_c7, } }, - /* TODO: security register */ - .printlock = spi_prettyprint_status_register_bp3_srwd, /* bit6 is quad enable */ - .unlock = spi_disable_blockprotect_bp3_srwd, + .printlock = spi_prettyprint_security_register_mx25, + .unlock = spi_disable_blockprotect_mx25_global_unprotect, .write = spi_chip_write_256, .read = spi_chip_read, /* Fast read (0x0B) and multi I/O supported */ .voltage = {1650, 2000}, @@ -8734,9 +8731,8 @@ .block_erase = spi_block_erase_c7, } }, - /* TODO: security register */ - .printlock = spi_prettyprint_status_register_bp3_srwd, /* bit6 is quad enable */ - .unlock = spi_disable_blockprotect_bp3_srwd, + .printlock = spi_prettyprint_security_register_mx25, + .unlock = spi_disable_blockprotect_mx25_global_unprotect, .write = spi_chip_write_256, .read = spi_chip_read, /* Fast read (0x0B) and multi I/O supported */ .voltage = {1650, 2000}, @@ -8776,9 +8772,8 @@ .block_erase = spi_block_erase_c7, } }, - /* TODO: security register */ - .printlock = spi_prettyprint_status_register_bp3_srwd, /* bit6 is quad enable */ - .unlock = spi_disable_blockprotect_bp3_srwd, + .printlock = spi_prettyprint_security_register_mx25, + .unlock = spi_disable_blockprotect_mx25_global_unprotect, .write = spi_chip_write_256, .read = spi_chip_read, /* Fast read (0x0B) and multi I/O supported */ .voltage = {1650, 2000}, @@ -8818,9 +8813,8 @@ .block_erase = spi_block_erase_c7, } }, - /* TODO: security register */ - .printlock = spi_prettyprint_status_register_bp3_srwd, /* bit6 is quad enable */ - .unlock = spi_disable_blockprotect_bp3_srwd, + .printlock = spi_prettyprint_security_register_mx25, + .unlock = spi_disable_blockprotect_mx25_global_unprotect, .write = spi_chip_write_256, .read = spi_chip_read, /* Fast read (0x0B) and multi I/O supported */ .voltage = {1650, 2000}, @@ -8858,9 +8852,8 @@ .block_erase = spi_block_erase_c7, } }, - /* TODO: security register */ - .printlock = spi_prettyprint_status_register_bp3_srwd, /* bit6 is quad enable */ - .unlock = spi_disable_blockprotect_bp3_srwd, + .printlock = spi_prettyprint_security_register_mx25, + .unlock = spi_disable_blockprotect_mx25_global_unprotect, .write = spi_chip_write_256, /* Multi I/O supported */ .read = spi_chip_read, /* Fast read (0x0B) and multi I/O supported */ .voltage = {1650, 2000}, @@ -8907,9 +8900,8 @@ .block_erase = spi_block_erase_c7, } }, - /* TODO: security register */ - .printlock = spi_prettyprint_status_register_bp3_srwd, /* bit6 is quad enable */ - .unlock = spi_disable_blockprotect_bp3_srwd, + .printlock = spi_prettyprint_security_register_mx25, + .unlock = spi_disable_blockprotect_mx25_global_unprotect, .write = spi_chip_write_256, /* Multi I/O supported */ .read = spi_chip_read, /* Fast read (0x0B) and multi I/O supported */ .voltage = {1650, 2000}, diff --git a/spi.h b/spi.h index 422e6a0..456d894 100644 --- a/spi.h +++ b/spi.h @@ -170,6 +170,15 @@ From ANY mode (3-bytes or 4-bytes) it works with 4-byte address */ #define JEDEC_BYTE_PROGRAM_4BA 0x12 +/* Read Security Register */ +#define JEDEC_RDSCUR 0x2B +#define JEDEC_RDSCUR_OUTSIZE 0x01 +#define JEDEC_RDSCUR_INSIZE 0x01 + +/* Do GBULK (gang block unlock) */ +#define JEDEC_GBULK 0x98 +#define JEDEC_GBULK_OUTSIZE 0x01 + /* Error codes */ #define SPI_GENERIC_ERROR -1 #define SPI_INVALID_OPCODE -2 diff --git a/spi25_statusreg.c b/spi25_statusreg.c index 4cf7023..4cdf800 100644 --- a/spi25_statusreg.c +++ b/spi25_statusreg.c @@ -237,6 +237,28 @@ return spi_disable_blockprotect_generic(flash, 0x7C, 1 << 7, 0, 0xFF); } +int spi_disable_blockprotect_mx25_global_unprotect(struct flashctx *flash) +{ + static const unsigned char cmd[JEDEC_GBULK_OUTSIZE] = { JEDEC_GBULK }; + int ret; + + ret = spi_write_enable(flash); + if (ret) { + msg_cerr("Set WREN failed!\n"); + return -1; + } + + /* Send GBULK cmd to device. */ + ret = spi_send_command(flash, sizeof(cmd), 0, cmd, NULL); + if (ret) { + msg_cerr("GBULK failed!\n"); + return -1; + } + + /* Disable standard blockprotect */ + return spi_disable_blockprotect_bp3_srwd(flash); +} + static void spi_prettyprint_status_register_hex(uint8_t status) { msg_cdbg("Chip status register is 0x%02x.\n", status); @@ -751,3 +773,32 @@ msg_cdbg("Resulting block protection : %s\n", bpt[(status & 0x1c) >> 2]); return 0; } + +/* === Macronix chips with Security Register === */ + +int spi_read_security_register(struct flashctx *flash) +{ + static const unsigned char cmd[JEDEC_RDSCUR_OUTSIZE] = { JEDEC_RDSCUR }; + unsigned char readarr[JEDEC_RDSCUR_INSIZE]; + int ret; + + ret = spi_send_command(flash, sizeof(cmd), sizeof(readarr), cmd, readarr); + if (ret) { + msg_cerr("RDSCUR failed!\n"); + return 0; + } + + return readarr[0]; +} + +int spi_prettyprint_security_register_mx25(struct flashctx *flash) +{ + int security_register = spi_read_security_register(flash); + int wpsel = !!(security_register & (1 << 7)); + + msg_cdbg("Chip security register: 0x%02X\n", security_register); + msg_cdbg("\tWPSEL is %s\n", wpsel ? "ON" : "OFF"); + + /* Print standard blockprotect info */ + return spi_prettyprint_status_register_bp3_srwd(flash); +} \ No newline at end of file -- To view, visit https://review.coreboot.org/c/flashrom/+/32034 To unsubscribe, or for help writing mail filters, visit https://review.coreboot.org/settings Gerrit-Project: flashrom Gerrit-Branch: master Gerrit-Change-Id: I6b3d7bd2625dec5fda7b85f421d40c49bbc528a6 Gerrit-Change-Number: 32034 Gerrit-PatchSet: 1 Gerrit-Owner: vl_sk Gerrit-MessageType: newchange

4 6

Change in flashrom[master]: pcidev: On arm64 we are not getting a valid BAR0 address
by Martijn Berger (Code Review) Sept. 13, 2025

Sept. 13, 2025

Martijn Berger has uploaded this change for review. ( https://review.coreboot.org/c/flashrom/+/39965 ) Change subject: pcidev: On arm64 we are not getting a valid BAR0 address ...................................................................... pcidev: On arm64 we are not getting a valid BAR0 address It seems that there is some code to work around a possible bug in old versions of libpci. This trusts libpci if it is new enough Change-Id: I8bd32c6344b0831a949c3853abeb84905420922a Signed-off-by: Martijn Berger <martijn.berger(a)gmail.com> --- M pcidev.c M programmer.h 2 files changed, 30 insertions(+), 2 deletions(-) git pull ssh://review.coreboot.org:29418/flashrom refs/changes/65/39965/1 diff --git a/pcidev.c b/pcidev.c index 54c1fd3..973acde 100644 --- a/pcidev.c +++ b/pcidev.c @@ -30,20 +30,47 @@ TYPE_UNKNOWN }; +int pci_bar_nuber_from_offset(int offset) +{ + switch (offset) { + case PCI_BASE_ADDRESS_0: + return 0; + case PCI_BASE_ADDRESS_1: + return 1; + case PCI_BASE_ADDRESS_2: + return 2; + case PCI_BASE_ADDRESS_3: + return 3; + case PCI_BASE_ADDRESS_4: + return 4; + case PCI_BASE_ADDRESS_5: + return 5; + default: + return -1; + } + return -1; +} + uintptr_t pcidev_readbar(struct pci_dev *dev, int bar) { uint64_t addr; uint32_t upperaddr; uint8_t headertype; uint16_t supported_cycles; + int bar_number; enum pci_bartype bartype = TYPE_UNKNOWN; headertype = pci_read_byte(dev, PCI_HEADER_TYPE) & 0x7f; msg_pspew("PCI header type 0x%02x\n", headertype); + bar_number = pci_bar_nuber_from_offset(bar); - /* Don't use dev->base_addr[x] (as value for 'bar'), won't work on older libpci. */ - addr = pci_read_long(dev, bar); + if (PCI_LIB_VERSION >= 0x030500 && bar_number > -1) { + addr = dev->base_addr[bar_number]; + } else { + /* Don't use dev->base_addr[x] (as value for 'bar'), won't work on older libpci. */ + addr = pci_read_long(dev, bar); + } /* Sanity checks. */ switch (headertype) { diff --git a/programmer.h b/programmer.h index 9a41be1..5d4c1d7 100644 --- a/programmer.h +++ b/programmer.h @@ -190,6 +190,7 @@ // FIXME: This needs to be local, not global(?) extern struct pci_access *pacc; int pci_init_common(void); +int pci_bar_nuber_from_offset(int offset); uintptr_t pcidev_readbar(struct pci_dev *dev, int bar); struct pci_dev *pcidev_init(const struct dev_entry *devs, int bar); /* rpci_write_* are reversible writes. The original PCI config space register -- To view, visit https://review.coreboot.org/c/flashrom/+/39965 To unsubscribe, or for help writing mail filters, visit https://review.coreboot.org/settings Gerrit-Project: flashrom Gerrit-Branch: master Gerrit-Change-Id: I8bd32c6344b0831a949c3853abeb84905420922a Gerrit-Change-Number: 39965 Gerrit-PatchSet: 1 Gerrit-Owner: Martijn Berger Gerrit-MessageType: newchange

5 6

Change in flashrom[master]: cli_classic.c: Add runtime measurement
by Simon Buhrow (Code Review) Aug. 19, 2025

Aug. 19, 2025

Simon Buhrow has uploaded this change for review. ( https://review.coreboot.org/c/flashrom/+/47805 ) Change subject: cli_classic.c: Add runtime measurement ...................................................................... cli_classic.c: Add runtime measurement To get an fast and easy feedback on how parameters effect runtime (e.g. clock setting, polling delays, ...). Signed-off-by: Simon Buhrow <simon.buhrow(a)posteo.de> Change-Id: I2238b3f3e6c2ab7745994662a88787fa2e86d480 --- M cli_classic.c 1 file changed, 7 insertions(+), 0 deletions(-) git pull ssh://review.coreboot.org:29418/flashrom refs/changes/05/47805/1 diff --git a/cli_classic.c b/cli_classic.c index ae7f6ef..0d5381f 100644 --- a/cli_classic.c +++ b/cli_classic.c @@ -24,6 +24,7 @@ #include <string.h> #include <stdlib.h> #include <getopt.h> +#include <time.h> #include "flash.h" #include "flashchips.h" #include "fmap.h" @@ -142,6 +143,7 @@ /* Probe for up to eight flash chips. */ struct flashctx flashes[8] = {{0}}; struct flashctx *fill_flash; + struct timespec time_start, time_end; const char *name; int namelen, opt, i, j; int startchip = -1, chipcount = 0, option_index = 0, force = 0, ifd = 0, fmap = 0; @@ -528,6 +530,8 @@ /* FIXME: Delay calibration should happen in programmer code. */ myusec_calibrate_delay(); + timespec_get(&time_start, TIME_UTC); + if (programmer_init(prog, pparam)) { msg_perr("Error: Programmer initialization failed.\n"); ret = 1; @@ -806,6 +810,9 @@ for (i = 0; i < chipcount; i++) free(flashes[i].chip); + timespec_get(&time_end, TIME_UTC); + msg_gdbg("Runtime: %d:%2d min:s\n", (int)((time_end.tv_sec-time_start.tv_sec) / 60), (int)(time_end.tv_sec-time_start.tv_sec) % 60); + layout_cleanup(&include_args); free(filename); free(fmapfile); -- To view, visit https://review.coreboot.org/c/flashrom/+/47805 To unsubscribe, or for help writing mail filters, visit https://review.coreboot.org/settings Gerrit-Project: flashrom Gerrit-Branch: master Gerrit-Change-Id: I2238b3f3e6c2ab7745994662a88787fa2e86d480 Gerrit-Change-Number: 47805 Gerrit-PatchSet: 1 Gerrit-Owner: Simon Buhrow Gerrit-MessageType: newchange

5 11

Change in flashrom[master]: libflashrom.map: Add missing symbols
by Edward O'Callaghan (Code Review) April 7, 2025

April 7, 2025

Edward O'Callaghan has uploaded this change for review. ( https://review.coreboot.org/c/flashrom/+/38993 ) Change subject: libflashrom.map: Add missing symbols ...................................................................... libflashrom.map: Add missing symbols The following symbols were missing at link-time from libflashrom: supported_flash_chips; supported_boards; supported_chipsets; Change-Id: I299928d62788c0abfe7f6cdd3e8ad8be0c49e45e Signed-off-by: Edward O'Callaghan <quasisec(a)google.com> --- M libflashrom.map 1 file changed, 3 insertions(+), 0 deletions(-) git pull ssh://review.coreboot.org:29418/flashrom refs/changes/93/38993/1 diff --git a/libflashrom.map b/libflashrom.map index d6dd24d..9430775 100644 --- a/libflashrom.map +++ b/libflashrom.map @@ -25,6 +25,9 @@ flashrom_set_log_callback; flashrom_shutdown; flashrom_supported_programmers; + flashrom_supported_flash_chips; + flashrom_supported_boards; + flashrom_supported_chipsets; flashrom_system_info; flashrom_version_info; local: *; -- To view, visit https://review.coreboot.org/c/flashrom/+/38993 To unsubscribe, or for help writing mail filters, visit https://review.coreboot.org/settings Gerrit-Project: flashrom Gerrit-Branch: master Gerrit-Change-Id: I299928d62788c0abfe7f6cdd3e8ad8be0c49e45e Gerrit-Change-Number: 38993 Gerrit-PatchSet: 1 Gerrit-Owner: Edward O'Callaghan <quasisec(a)chromium.org> Gerrit-MessageType: newchange

4 3

[M] Change in flashrom[main]: libflashrom: Update the API for progress callback
by Anastasia Klimchuk (Code Review) Feb. 28, 2025

Feb. 28, 2025

Attention is currently required from: Peter Marheine, Richard Hughes, Sergii Dmytruk. Anastasia Klimchuk has posted comments on this change by Anastasia Klimchuk. ( https://review.coreboot.org/c/flashrom/+/86031?usp=email ) Change subject: libflashrom: Update the API for progress callback ...................................................................... Patch Set 11: (1 comment) File include/flash.h: https://review.coreboot.org/c/flashrom/+/86031/comment/dbdcab60_08d88acb?us… : PS8, Line 624: flashrom_progress_callback_v2 *progress_callback; : struct flashrom_progress progress_state; : struct stage_progress stage_progress[FLASHROM_PROGRESS_NR]; : /* deprecated, do not use */ : flashrom_progress_callback *deprecated_progress_callback; : struct flashrom_progress *deprecated_progress_state; > I made an attempt (added lines 90-97 in libflashrom. […] I rebased to fix merge conflict in devel.rst (my favourite type of merge conflict :D) If you can have a look whether I addressed this comment or not? Thank you! -- To view, visit https://review.coreboot.org/c/flashrom/+/86031?usp=email To unsubscribe, or for help writing mail filters, visit https://review.coreboot.org/settings?usp=email Gerrit-MessageType: comment Gerrit-Project: flashrom Gerrit-Branch: main Gerrit-Change-Id: Ia8cc0461c449b7e65888a64cdc594c55b81eae7a Gerrit-Change-Number: 86031 Gerrit-PatchSet: 11 Gerrit-Owner: Anastasia Klimchuk <aklm(a)chromium.org> Gerrit-Reviewer: Peter Marheine <pmarheine(a)chromium.org> Gerrit-Reviewer: Richard Hughes <richard(a)hughsie.com> Gerrit-Reviewer: Sergii Dmytruk <sergii.dmytruk(a)3mdeb.com> Gerrit-Reviewer: build bot (Jenkins) <no-reply(a)coreboot.org> Gerrit-Attention: Richard Hughes <richard(a)hughsie.com> Gerrit-Attention: Peter Marheine <pmarheine(a)chromium.org> Gerrit-Attention: Sergii Dmytruk <sergii.dmytruk(a)3mdeb.com> Gerrit-Comment-Date: Fri, 28 Feb 2025 08:14:32 +0000 Gerrit-HasComments: Yes Gerrit-Has-Labels: No Comment-In-Reply-To: Anastasia Klimchuk <aklm(a)chromium.org> Comment-In-Reply-To: Peter Marheine <pmarheine(a)chromium.org>

1 0

[M] Change in flashrom[main]: libflashrom: Update the API for progress callback
by Anastasia Klimchuk (Code Review) Feb. 27, 2025

Feb. 27, 2025

Attention is currently required from: Peter Marheine, Richard Hughes, Sergii Dmytruk. Hello Peter Marheine, Richard Hughes, Sergii Dmytruk, build bot (Jenkins), I'd like you to reexamine a change. Please visit https://review.coreboot.org/c/flashrom/+/86031?usp=email to look at the new patch set (#11). The following approvals got outdated and were removed: Verified+1 by build bot (Jenkins) Change subject: libflashrom: Update the API for progress callback ...................................................................... libflashrom: Update the API for progress callback The initial version of API for progress callback would require the callback function to make a second call to get the needed data about progress state (current, total etc). This patch changes the callback API, so that callback function gets all needed data straight away as parameters, and with this, callback has all the data to do its job. Since the initial version was submitted and it was in the tree for a while, the change needs to add a _v2 suffix for new thing and deprecated attribute for old thing. Testing: both unit tests and cli are libflashrom clients. All unit tests run successfully, for the cli all scenarios from commit 75dc0655b95dde91f1426a7e5aecfc04d7b8d631 run successfully. Change-Id: Ia8cc0461c449b7e65888a64cdc594c55b81eae7a Signed-off-by: Anastasia Klimchuk <aklm(a)flashrom.org> --- M cli_classic.c M cli_output.c M doc/release_notes/devel.rst M flashrom.c M include/cli_output.h M include/flash.h M include/libflashrom.h M libflashrom.c M libflashrom.map M tests/chip.c M tests/spi25.c 11 files changed, 128 insertions(+), 72 deletions(-) git pull ssh://review.coreboot.org:29418/flashrom refs/changes/31/86031/11 -- To view, visit https://review.coreboot.org/c/flashrom/+/86031?usp=email To unsubscribe, or for help writing mail filters, visit https://review.coreboot.org/settings?usp=email Gerrit-MessageType: newpatchset Gerrit-Project: flashrom Gerrit-Branch: main Gerrit-Change-Id: Ia8cc0461c449b7e65888a64cdc594c55b81eae7a Gerrit-Change-Number: 86031 Gerrit-PatchSet: 11 Gerrit-Owner: Anastasia Klimchuk <aklm(a)chromium.org> Gerrit-Reviewer: Peter Marheine <pmarheine(a)chromium.org> Gerrit-Reviewer: Richard Hughes <richard(a)hughsie.com> Gerrit-Reviewer: Sergii Dmytruk <sergii.dmytruk(a)3mdeb.com> Gerrit-Reviewer: build bot (Jenkins) <no-reply(a)coreboot.org> Gerrit-Attention: Richard Hughes <richard(a)hughsie.com> Gerrit-Attention: Peter Marheine <pmarheine(a)chromium.org> Gerrit-Attention: Sergii Dmytruk <sergii.dmytruk(a)3mdeb.com>

1 0

[L] Change in flashrom[main]: doc: autogenerate a list of authors and hall of fame
by Anastasia Klimchuk (Code Review) Feb. 27, 2025

Feb. 27, 2025

Anastasia Klimchuk has submitted this change. ( https://review.coreboot.org/c/flashrom/+/86350?usp=email ) Change subject: doc: autogenerate a list of authors and hall of fame ...................................................................... doc: autogenerate a list of authors and hall of fame This adds a build-time option to automatically generate a list of authors from git history, and includes it in the documentation by reading the output from git in a Sphinx extension. When git isn't available or the project source doesn't appear to be a git checkout, the list is not generated and gracefully replaced with a message explaining its absence. Change-Id: I1e9634a90e84262aafd80590deba9875f4b71a3c Signed-off-by: Peter Marheine <pmarheine(a)chromium.org> Reviewed-on: https://review.coreboot.org/c/flashrom/+/86350 Tested-by: build bot (Jenkins) <no-reply(a)coreboot.org> Reviewed-by: Anastasia Klimchuk <aklm(a)chromium.org> --- A doc/_ext/.gitignore A doc/_ext/flashrom_authors.py A doc/about_flashrom/hall_of_fame.rst M doc/about_flashrom/index.rst M doc/classic_cli_manpage.rst A doc/collect-authors.sh M doc/conf.py M doc/dev_guide/building_from_source.rst M doc/how_to_support_flashrom.rst M doc/meson.build M doc/release_notes/devel.rst M meson_options.txt 12 files changed, 278 insertions(+), 12 deletions(-) Approvals: Anastasia Klimchuk: Looks good to me, approved build bot (Jenkins): Verified diff --git a/doc/_ext/.gitignore b/doc/_ext/.gitignore new file mode 100644 index 0000000..5ec9334 --- /dev/null +++ b/doc/_ext/.gitignore @@ -0,0 +1,2 @@ +# Python bytecode cache generated on module import +/__pycache__/ \ No newline at end of file diff --git a/doc/_ext/flashrom_authors.py b/doc/_ext/flashrom_authors.py new file mode 100644 index 0000000..f160d21 --- /dev/null +++ b/doc/_ext/flashrom_authors.py @@ -0,0 +1,82 @@ +from docutils import nodes +from pathlib import Path +from typing import TYPE_CHECKING + +from sphinx.application import Sphinx +from sphinx.util.docutils import SphinxDirective + +if TYPE_CHECKING: + from sphinx.util.typing import ExtensionMetadata + + +class FlashromAuthorsDirective(SphinxDirective): + required_arguments = 1 + has_content = True + + def make_table(self, list_file: Path): + body = nodes.tbody() + with list_file.open("r") as f: + for line in f: + count, _, name = line.strip().partition("\t") + + body += nodes.row( + "", + nodes.entry("", nodes.paragraph(text=name)), + nodes.entry("", nodes.paragraph(text=count)), + ) + + return nodes.table( + "", + nodes.tgroup( + "", + nodes.colspec(colname="name"), + nodes.colspec(colname="count"), + nodes.thead( + "", + nodes.row( + "", + nodes.entry("", nodes.paragraph(text="Name")), + nodes.entry("", nodes.paragraph(text="Number of changes")), + ), + ), + body, + cols=2, + ), + ) + + def make_placeholder(self, contents): + return nodes.admonition( + "", + nodes.title("", text="List not available"), + *contents, + ) + + def run(self) -> list[nodes.Node]: + config = self.config.flashrom_authors_list_files + + source_name = self.arguments[0] + list_file = (config or {}).get(source_name) + if list_file is None: + if config is not None: + available_names = ','.join(config.keys()) + raise self.error( + 'Undefined authors list file: "{}" (available names: {})'.format( + source_name, available_names + ) + ) + container = nodes.Element() + self.state.nested_parse(self.content, 0, container) + return [self.make_placeholder(container.children)] + else: + return [self.make_table(Path(list_file))] + + +def setup(app: Sphinx) -> 'ExtensionMetadata': + app.add_config_value( + "flashrom_authors_list_files", default=None, rebuild="html", types=[dict] + ) + app.add_directive("flashrom-authors", FlashromAuthorsDirective) + + return { + "version": "1", + } diff --git a/doc/about_flashrom/hall_of_fame.rst b/doc/about_flashrom/hall_of_fame.rst new file mode 100644 index 0000000..88f2728 --- /dev/null +++ b/doc/about_flashrom/hall_of_fame.rst @@ -0,0 +1,57 @@ +============ +Hall of Fame +============ + +This is the flashrom project's hall of fame, where we credit everybody who +has contributed to flashrom's code in the past. + +Based on the Git history (dating back to 2002!), this page separately lists all +:ref:`authors <authors>` and :ref:`reviewers <reviewers>` where each line +lists a person's name and how many commits they are credited for. [#svn]_ + +flashrom is alive and running because of you all, the people who during all +these years (and decades!) give their time, energy, knowledge, and a piece of +their heart to flashrom. The project is what we all are creating together. + +**Thank you everyone so much!** + +.. _authors: + +Authors +======= + +The people listed here are those credited as the author or a co-author (as +in ``Co-authored-by`` or ``Co-developed-by``) of at least one Git commit in +flashrom. + +.. flashrom-authors:: authors + + This copy of the flashrom documentation was built without + generating the list of authors. To generate it, ensure + the :code:`generate_authors_list` + :ref:`Meson option <meson_configuration>` is enabled when + building. + +.. _reviewers: + +Reviewers +========= + +The people listed here are those credited as a reviewer (``Reviewed-by``) +of at least one Git commit in flashrom. + +We very much appreciate flashrom code reviews; you can read more about it +in our :ref:`code review documentation <support-code-reviews>`. + +.. flashrom-authors:: reviewers + + This copy of the flashrom documentation was built without + generating the list of reviewers. To generate it, ensure + the :code:`generate_authors_list` + :ref:`Meson option <meson_configuration>` is enabled when + building. + +.. [#svn] Data for contributions prior to 2017 may be inaccurate or missing, + because flashrom used SVN rather than Git prior to then and old metadata might + not be in a format that is understood by the scripts that automatically generate + this page. diff --git a/doc/about_flashrom/index.rst b/doc/about_flashrom/index.rst index 143c7b6..753a19d 100644 --- a/doc/about_flashrom/index.rst +++ b/doc/about_flashrom/index.rst @@ -5,5 +5,6 @@ :maxdepth: 1 team + hall_of_fame code_of_conduct privacy_policy diff --git a/doc/classic_cli_manpage.rst b/doc/classic_cli_manpage.rst index af897a0..243cf4f 100644 --- a/doc/classic_cli_manpage.rst +++ b/doc/classic_cli_manpage.rst @@ -1565,14 +1565,12 @@ AUTHORS ------- -Andrew Morgan, Anastasia Klimchuk, Carl-Daniel Hailfinger, Claus Gindhart, David Borg, David Hendricks, Dominik Geyer, -Edward O'Callaghan, Eric Biederman, Giampiero Giancipoli, Helge Wagner, Idwer Vollering, Joe Bao, Joerg Fischer, -Joshua Roys, Kyösti Mälkki, Luc Verhaegen, Li-Ta Lo, Mark Marshall, Markus Boas, Mattias Mattsson, Michael Karcher, -Nikolay Petukhov, Patrick Georgi, Peter Lemenkov, Peter Stuge, Reinder E.N. de Haan, Ronald G. Minnich, Ronald Hoogenboom, -Sean Nelson, Stefan Reinauer, Stefan Tauner, Stefan Wildemann, Stephan Guilloux, Steven James, Urja Rannikko, Uwe Hermann, -Wang Qingpei, Yinghai Lu and others, please see the **flashrom** git history for details. +More than 350 authors have contributed to Flashrom over its life. Each individual +is credited in the `hall of fame <https://flashrom.org/about_flashrom/hall_of_fame.html>`_, +or author metadata can be found in the git history. All still active authors can be reached via `the mailing list <flashrom\(a)flashrom.org>`_. -This manual page was written by `Uwe Hermann <uwe\(a)hermann-uwe.de>`_, Carl-Daniel Hailfinger, Stefan Tauner and others. -It is licensed under the terms of the GNU GPL (version 2 or later). +This manual page was written by `Uwe Hermann <uwe\(a)hermann-uwe.de>`_, +Carl-Daniel Hailfinger, Stefan Tauner and others. It is licensed under the +terms of the GNU GPL (version 2 or later). diff --git a/doc/collect-authors.sh b/doc/collect-authors.sh new file mode 100644 index 0000000..96db87c --- /dev/null +++ b/doc/collect-authors.sh @@ -0,0 +1,39 @@ +#!/bin/sh + +if [ $# -ne 3 ] +then + echo "Wrong number of arguments. Usage: $0 [authors|reviewers] outfile git_dir" >&2 + exit 1 +fi + +case "$1" in + authors) + GROUP_ARGS="--group=author --group=trailer:Co-Authored-by --group=trailer:Co-Developed-by" + ;; + reviewers) + GROUP_ARGS="--group=trailer:Reviewed-by" + ;; + *) + echo "Unknown contributor kind: \"$1\"" >&2 + exit 1 + ;; +esac +OUTFILE="$2" +# GIT_DIR is passed explicitly so we never need to guess where +# the source directory is. It may be somewhere entirely different +# from where meson is running us. +GIT_DIR="$3" + +if ! command -v git >/dev/null +then + echo "git not available" >&2 + exit 1 +fi + +if [ ! -d "$GIT_DIR" ] +then + echo "GIT_DIR ($GIT_DIR) does not exist" >&2 + exit 1 +fi + +git --no-pager --git-dir="$GIT_DIR" shortlog --summary --numbered $GROUP_ARGS HEAD > "$OUTFILE" diff --git a/doc/conf.py b/doc/conf.py index be9cc01..b7fb2d4 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -3,7 +3,13 @@ # For the full list of built-in configuration values, see the documentation: # https://www.sphinx-doc.org/en/master/usage/configuration.html -import os +import sys + +from pathlib import Path + + +sys.path.append(str(Path('_ext').resolve())) + # -- Project information ----------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-infor… @@ -18,7 +24,8 @@ master_doc = 'index' # this is needed for old versions extensions = [ - 'sphinx.ext.todo' + 'sphinx.ext.todo', + 'flashrom_authors' ] #templates_path = ['_templates'] diff --git a/doc/dev_guide/building_from_source.rst b/doc/dev_guide/building_from_source.rst index a8521ce..2394767 100644 --- a/doc/dev_guide/building_from_source.rst +++ b/doc/dev_guide/building_from_source.rst @@ -216,8 +216,11 @@ .. todo:: Add building instructions for libpayload +.. _meson_configuration: + Configuration ------------- + In the flashrom repository run:: meson setup [builtin options] [flashrom options] <builddir> diff --git a/doc/how_to_support_flashrom.rst b/doc/how_to_support_flashrom.rst index 7fdfdf8..bb5cdaa 100644 --- a/doc/how_to_support_flashrom.rst +++ b/doc/how_to_support_flashrom.rst @@ -39,6 +39,8 @@ For some types of contributions we have more detailed guidelines, check the list :doc:`/contrib_howtos/index`. +.. _support-code-reviews: + Code reviews ============ diff --git a/doc/meson.build b/doc/meson.build index 5bc57b9..ff1e7bc 100644 --- a/doc/meson.build +++ b/doc/meson.build @@ -1,6 +1,6 @@ - sphinx = find_program('sphinx-build', native : true, required : get_option('man-pages').enabled() or get_option('documentation').enabled()) sphinx_wrapper = meson.current_source_dir() / 'sphinx-wrapper.sh' +collect_authors = meson.current_source_dir() / 'collect-authors.sh' man_pages = [ 'flashrom.8' @@ -24,9 +24,67 @@ endif if get_option('documentation').auto() or get_option('documentation').enabled() + + with_authors_list = get_option('generate_authors_list') + git = find_program('git', native : true, required : with_authors_list) + git_dir = meson.project_source_root() / '.git' + + # When with_authors_list is requested, unsatisfied requirements are an error. + if with_authors_list.enabled() + if not git.found() + error('generate_authors_list was force-enabled but git is not available') + endif + if not fs.is_dir(git_dir) + error('generate_authors_list was force-enabled but a .git directory was not found in the source tree') + endif + endif + + if ( + (with_authors_list.enabled() or with_authors_list.auto()) + and git.found() and fs.is_dir(git_dir) + ) + # If requirements are met and authors list is allowed, generate it. + authors_lst = custom_target( + 'authors_lst', + output : 'authors.lst', + command : [collect_authors, 'authors', '@OUTPUT0@', git_dir], + ) + reviewers_lst = custom_target( + 'reviewers_lst', + output : 'reviewers.lst', + command : [collect_authors, 'reviewers', '@OUTPUT0@', git_dir], + ) + authors_list_options = [ + '-Dflashrom_authors_list_files.authors=' + authors_lst.full_path(), + '-Dflashrom_authors_list_files.reviewers=' + reviewers_lst.full_path(), + ] + doc_depends = [authors_lst, reviewers_lst] + else + # Disabled or prerequisites not met. Continue without the authors list. + # Checks earlier in this file will raise an error if the feature is enabled + # but the prerequisites aren't met. + authors_list_options = [] + doc_depends = [] + + if with_authors_list.auto() + # Explain what wasn't satisfied to help the user understand why + # the authors list is missing. + if not git.found() + message('git not found; will not generate authors list') + elif not fs.is_dir(git_dir) + message('.git directory not found in project; will not generate authors list') + endif + endif + endif + custom_target( 'documentation', - command : [sphinx, '-b', 'html', '-q', '-d', '@PRIVATE_DIR@', '-Drelease=' + flashrom_version,'@CURRENT_SOURCE_DIR@', '@OUTDIR@/html'], + command : [ + sphinx, '-b', 'html', '-q', '-d', '@PRIVATE_DIR@', + '-Drelease=' + flashrom_version, + '@CURRENT_SOURCE_DIR@', '@OUTDIR@/html' + ] + authors_list_options, + depends : doc_depends, build_always_stale : true, # sphinx handles rebuilds output : 'html', install : true, diff --git a/doc/release_notes/devel.rst b/doc/release_notes/devel.rst index 05fe4a0..62dffb0 100644 --- a/doc/release_notes/devel.rst +++ b/doc/release_notes/devel.rst @@ -35,3 +35,19 @@ ------------------------------------------- See :doc:`/classic_cli_manpage` for details. + +Hall of Fame added to documentation +----------------------------------- + +The flashrom HTML documentation (and web site) now includes an +automatically-generated list of historical contributors, to acknowledge +everybody who has made flashrom into what it is: +:doc:`../about_flashrom/hall_of_fame`. + +When building the documentation, the ``generate_authors_list`` Meson option will +cause the lists to be generated, requiring a runnable copy of Git on the system +and that the source tree being built is a Git working copy. If those +requirements are not satisfied or the option is disabled, the authors lists will +be replaced with placeholders unless the ``generate_authors_list`` option is set +to ``enabled`` in which case the build will fail if the requirements are not +satisfied. diff --git a/meson_options.txt b/meson_options.txt index 87456a9..318a419 100644 --- a/meson_options.txt +++ b/meson_options.txt @@ -19,6 +19,7 @@ option('llvm_cov', type : 'feature', value : 'disabled', description : 'build for llvm code coverage') option('man-pages', type : 'feature', value : 'auto', description : 'build the man-page for classic_cli') option('documentation', type : 'feature', value : 'auto', description : 'build the html documentation') +option('generate_authors_list', type : 'feature', value : 'auto', description : 'include automatically-generated lists of authors in the HTML documentation') option('ni845x_search_path', type : 'string', value : 'C:\Program Files (x86)\National Instruments\Ni-845x\MS Visual C', description : 'Path to search for the proprietary ni845x library and header (32-bit Windows only)') option('delay_minimum_sleep_us', type : 'integer', min : 0, value : 100, -- To view, visit https://review.coreboot.org/c/flashrom/+/86350?usp=email To unsubscribe, or for help writing mail filters, visit https://review.coreboot.org/settings?usp=email Gerrit-MessageType: merged Gerrit-Project: flashrom Gerrit-Branch: main Gerrit-Change-Id: I1e9634a90e84262aafd80590deba9875f4b71a3c Gerrit-Change-Number: 86350 Gerrit-PatchSet: 14 Gerrit-Owner: Peter Marheine <pmarheine(a)chromium.org> Gerrit-Reviewer: Anastasia Klimchuk <aklm(a)chromium.org> Gerrit-Reviewer: Patrick Georgi <patrick(a)coreboot.org> Gerrit-Reviewer: build bot (Jenkins) <no-reply(a)coreboot.org>

1 0

[S] Change in flashrom[main]: flashchips: Add Macronix MX77U25650FZ4I42
by Dolan Liu (Code Review) Feb. 27, 2025

Feb. 27, 2025

Attention is currently required from: Anastasia Klimchuk, Nikolai Artemiev, Stefan Reinauer. Dolan Liu has posted comments on this change by Dolan Liu. ( https://review.coreboot.org/c/flashrom/+/86348?usp=email ) Change subject: flashchips: Add Macronix MX77U25650FZ4I42 ...................................................................... Patch Set 2: (1 comment) Patchset: PS2: > Also, I know sometimes datasheets are not public but can be available only for partners for example. […] ya, thanks for commetns, we are asking HW team to request the datasheet, i will attached the link here once i got it. -- To view, visit https://review.coreboot.org/c/flashrom/+/86348?usp=email To unsubscribe, or for help writing mail filters, visit https://review.coreboot.org/settings?usp=email Gerrit-MessageType: comment Gerrit-Project: flashrom Gerrit-Branch: main Gerrit-Change-Id: I7866b2db343f4eb2bc194400ceca099d3af3b87d Gerrit-Change-Number: 86348 Gerrit-PatchSet: 2 Gerrit-Owner: Dolan Liu <liuyong5(a)huaqin.corp-partner.google.com> Gerrit-Reviewer: Anastasia Klimchuk <aklm(a)chromium.org> Gerrit-Reviewer: Nikolai Artemiev <nartemiev(a)google.com> Gerrit-Reviewer: Stefan Reinauer <stefan.reinauer(a)coreboot.org> Gerrit-Reviewer: build bot (Jenkins) <no-reply(a)coreboot.org> Gerrit-Attention: Stefan Reinauer <stefan.reinauer(a)coreboot.org> Gerrit-Attention: Anastasia Klimchuk <aklm(a)chromium.org> Gerrit-Attention: Nikolai Artemiev <nartemiev(a)google.com> Gerrit-Comment-Date: Thu, 27 Feb 2025 08:50:31 +0000 Gerrit-HasComments: Yes Gerrit-Has-Labels: No Comment-In-Reply-To: Anastasia Klimchuk <aklm(a)chromium.org>

1 0

[L] Change in flashrom[main]: doc: autogenerate a list of authors and hall of fame
by Anastasia Klimchuk (Code Review) Feb. 24, 2025

Feb. 24, 2025

Attention is currently required from: Patrick Georgi, Peter Marheine. Anastasia Klimchuk has posted comments on this change by Peter Marheine. ( https://review.coreboot.org/c/flashrom/+/86350?usp=email ) Change subject: doc: autogenerate a list of authors and hall of fame ...................................................................... Patch Set 13: Code-Review+2 -- To view, visit https://review.coreboot.org/c/flashrom/+/86350?usp=email To unsubscribe, or for help writing mail filters, visit https://review.coreboot.org/settings?usp=email Gerrit-MessageType: comment Gerrit-Project: flashrom Gerrit-Branch: main Gerrit-Change-Id: I1e9634a90e84262aafd80590deba9875f4b71a3c Gerrit-Change-Number: 86350 Gerrit-PatchSet: 13 Gerrit-Owner: Peter Marheine <pmarheine(a)chromium.org> Gerrit-Reviewer: Anastasia Klimchuk <aklm(a)chromium.org> Gerrit-Reviewer: Patrick Georgi <patrick(a)coreboot.org> Gerrit-Reviewer: build bot (Jenkins) <no-reply(a)coreboot.org> Gerrit-Attention: Patrick Georgi <patrick(a)coreboot.org> Gerrit-Attention: Peter Marheine <pmarheine(a)chromium.org> Gerrit-Comment-Date: Tue, 25 Feb 2025 02:08:41 +0000 Gerrit-HasComments: No Gerrit-Has-Labels: Yes

1 0

[L] Change in flashrom[main]: doc: autogenerate a list of authors and hall of fame
by Peter Marheine (Code Review) Feb. 24, 2025

Feb. 24, 2025

Attention is currently required from: Anastasia Klimchuk, Patrick Georgi. Peter Marheine has posted comments on this change by Peter Marheine. ( https://review.coreboot.org/c/flashrom/+/86350?usp=email ) Change subject: doc: autogenerate a list of authors and hall of fame ...................................................................... Patch Set 13: (3 comments) Patchset: PS5: > I think this can be in this patch too? Done Patchset: PS12: > I noticed when I downloaded the patch and built it locally, I got this as untracked: […] Done File doc/about_flashrom/hall_of_fame.rst: https://review.coreboot.org/c/flashrom/+/86350/comment/5fc6bf8b_ec0a2986?us… : PS12, Line 23: as : in ``Co-authored-by`` > A finishing touch: you need to add inside the brackets "or Co-developed-by" […] Done -- To view, visit https://review.coreboot.org/c/flashrom/+/86350?usp=email To unsubscribe, or for help writing mail filters, visit https://review.coreboot.org/settings?usp=email Gerrit-MessageType: comment Gerrit-Project: flashrom Gerrit-Branch: main Gerrit-Change-Id: I1e9634a90e84262aafd80590deba9875f4b71a3c Gerrit-Change-Number: 86350 Gerrit-PatchSet: 13 Gerrit-Owner: Peter Marheine <pmarheine(a)chromium.org> Gerrit-Reviewer: Anastasia Klimchuk <aklm(a)chromium.org> Gerrit-Reviewer: Patrick Georgi <patrick(a)coreboot.org> Gerrit-Reviewer: build bot (Jenkins) <no-reply(a)coreboot.org> Gerrit-Attention: Patrick Georgi <patrick(a)coreboot.org> Gerrit-Attention: Anastasia Klimchuk <aklm(a)chromium.org> Gerrit-Comment-Date: Mon, 24 Feb 2025 23:05:03 +0000 Gerrit-HasComments: Yes Gerrit-Has-Labels: No Comment-In-Reply-To: Anastasia Klimchuk <aklm(a)chromium.org>

1 0