March 2025 - flashrom-gerrit - mail.coreboot.org

[XS] Change in flashrom[main]: tests/chip: fix print format errors in gcc 14.2.0
by Antonio Vázquez Blanco (Code Review) 12 Mar '25

12 Mar '25

Attention is currently required from: Anastasia Klimchuk. Antonio Vázquez Blanco has posted comments on this change by Antonio Vázquez Blanco. ( https://review.coreboot.org/c/flashrom/+/86679?usp=email ) Change subject: tests/chip: fix print format errors in gcc 14.2.0 ...................................................................... Patch Set 3: (1 comment) Commit Message: https://review.coreboot.org/c/flashrom/+/86679/comment/ad6c1a83_75123e74?us… : PS2, Line 8: > Done! Thanks! Acknowledged -- To view, visit https://review.coreboot.org/c/flashrom/+/86679?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: I8c461accefddce3d5ee33b0fb6b91c434d721945 Gerrit-Change-Number: 86679 Gerrit-PatchSet: 3 Gerrit-Owner: Antonio Vázquez Blanco <antoniovazquezblanco(a)gmail.com> Gerrit-Reviewer: Anastasia Klimchuk <aklm(a)chromium.org> Gerrit-Reviewer: build bot (Jenkins) <no-reply(a)coreboot.org> Gerrit-Attention: Anastasia Klimchuk <aklm(a)chromium.org> Gerrit-Comment-Date: Wed, 12 Mar 2025 14:33:02 +0000 Gerrit-HasComments: Yes Gerrit-Has-Labels: No Comment-In-Reply-To: Antonio Vázquez Blanco <antoniovazquezblanco(a)gmail.com> Comment-In-Reply-To: Anastasia Klimchuk <aklm(a)chromium.org>

1 0

[XS] Change in flashrom[main]: tests/chip: fix print format errors in gcc 14.2.0
by Antonio Vázquez Blanco (Code Review) 12 Mar '25

12 Mar '25

Attention is currently required from: Anastasia Klimchuk. Antonio Vázquez Blanco has posted comments on this change by Antonio Vázquez Blanco. ( https://review.coreboot.org/c/flashrom/+/86679?usp=email ) Change subject: tests/chip: fix print format errors in gcc 14.2.0 ...................................................................... Patch Set 3: (1 comment) Commit Message: https://review.coreboot.org/c/flashrom/+/86679/comment/3cdf8eb0_05886902?us… : PS2, Line 8: > Could you please add environment info? where the format errors were reproduced Done! Thanks! -- To view, visit https://review.coreboot.org/c/flashrom/+/86679?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: I8c461accefddce3d5ee33b0fb6b91c434d721945 Gerrit-Change-Number: 86679 Gerrit-PatchSet: 3 Gerrit-Owner: Antonio Vázquez Blanco <antoniovazquezblanco(a)gmail.com> Gerrit-Reviewer: Anastasia Klimchuk <aklm(a)chromium.org> Gerrit-Reviewer: build bot (Jenkins) <no-reply(a)coreboot.org> Gerrit-Attention: Anastasia Klimchuk <aklm(a)chromium.org> Gerrit-Comment-Date: Wed, 12 Mar 2025 14:30:01 +0000 Gerrit-HasComments: Yes Gerrit-Has-Labels: No Comment-In-Reply-To: Anastasia Klimchuk <aklm(a)chromium.org>

1 0

[XS] Change in flashrom[main]: tests/chip: fix print format errors in gcc 14.2.0
by Antonio Vázquez Blanco (Code Review) 12 Mar '25

12 Mar '25

Attention is currently required from: Antonio Vázquez Blanco. Hello Anastasia Klimchuk, build bot (Jenkins), I'd like you to reexamine a change. Please visit https://review.coreboot.org/c/flashrom/+/86679?usp=email to look at the new patch set (#3). The following approvals got outdated and were removed: Verified+1 by build bot (Jenkins) Change subject: tests/chip: fix print format errors in gcc 14.2.0 ...................................................................... tests/chip: fix print format errors in gcc 14.2.0 Change-Id: I8c461accefddce3d5ee33b0fb6b91c434d721945 Signed-off-by: Antonio Vázquez Blanco <antoniovazquezblanco(a)gmail.com> --- M tests/chip.c 1 file changed, 1 insertion(+), 1 deletion(-) git pull ssh://review.coreboot.org:29418/flashrom refs/changes/79/86679/3 -- To view, visit https://review.coreboot.org/c/flashrom/+/86679?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: I8c461accefddce3d5ee33b0fb6b91c434d721945 Gerrit-Change-Number: 86679 Gerrit-PatchSet: 3 Gerrit-Owner: Antonio Vázquez Blanco <antoniovazquezblanco(a)gmail.com> Gerrit-Reviewer: Anastasia Klimchuk <aklm(a)chromium.org> Gerrit-Reviewer: build bot (Jenkins) <no-reply(a)coreboot.org> Gerrit-Attention: Antonio Vázquez Blanco <antoniovazquezblanco(a)gmail.com>

1 0

[L] Change in flashrom[main]: spidriver: Add support for the Excamera Labs SPIDriver programmer
by Simon Arlott (Code Review) 10 Mar '25

10 Mar '25

Attention is currently required from: Anastasia Klimchuk, Peter Marheine. Simon Arlott has posted comments on this change by Simon Arlott. ( https://review.coreboot.org/c/flashrom/+/86411?usp=email ) Change subject: spidriver: Add support for the Excamera Labs SPIDriver programmer ...................................................................... Patch Set 4: (1 comment) File spidriver.c: https://review.coreboot.org/c/flashrom/+/86411/comment/2f0fe27c_21612fb2?us… : PS4, Line 307: fw_version >= 2 > Just to double-check, it's 2 as it's also described on line 267 above? […] Only version 2 supports setting the SPI mode, I don't have a version 1 device so the condition does nothing for me when testing -- To view, visit https://review.coreboot.org/c/flashrom/+/86411?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: I07b23c1146d4ad3606b54a1e8dc8030cf4ebf57b Gerrit-Change-Number: 86411 Gerrit-PatchSet: 4 Gerrit-Owner: Simon Arlott <flashrom.simon(a)arlott.org> Gerrit-Reviewer: Anastasia Klimchuk <aklm(a)chromium.org> Gerrit-Reviewer: Peter Marheine <pmarheine(a)chromium.org> Gerrit-Reviewer: build bot (Jenkins) <no-reply(a)coreboot.org> Gerrit-Attention: Anastasia Klimchuk <aklm(a)chromium.org> Gerrit-Attention: Peter Marheine <pmarheine(a)chromium.org> Gerrit-Comment-Date: Mon, 10 Mar 2025 12:25:46 +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]: spidriver: Add support for the Excamera Labs SPIDriver programmer
by Anastasia Klimchuk (Code Review) 10 Mar '25

10 Mar '25

Attention is currently required from: Peter Marheine, Simon Arlott. Anastasia Klimchuk has posted comments on this change by Simon Arlott. ( https://review.coreboot.org/c/flashrom/+/86411?usp=email ) Change subject: spidriver: Add support for the Excamera Labs SPIDriver programmer ...................................................................... Patch Set 4: (4 comments) Patchset: PS2: > I've added an entry to the release notes. […] Alright, but you can change your mind later! You can keep it working as is, not necessarily adding new stuff. File spidriver.c: https://review.coreboot.org/c/flashrom/+/86411/comment/8eedddca_d2e4cd24?us… : PS2, Line 81: { > It reduces the scope of "buf" so that it's not being shadowed later and can't accidentally be used. I see, thank you https://review.coreboot.org/c/flashrom/+/86411/comment/4fbc12b6_b64e5732?us… : PS2, Line 136: /* Read and write */ > There's no read API, because something must always be written on the SPI bus in order to read from i […] Thank you! File spidriver.c: https://review.coreboot.org/c/flashrom/+/86411/comment/ad213f4a_28b91389?us… : PS4, Line 307: fw_version >= 2 Just to double-check, it's 2 as it's also described on line 267 above? I noticed that fw_version condition changed from 1->2->1->2 between patchsets, but you mean 2 right? -- To view, visit https://review.coreboot.org/c/flashrom/+/86411?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: I07b23c1146d4ad3606b54a1e8dc8030cf4ebf57b Gerrit-Change-Number: 86411 Gerrit-PatchSet: 4 Gerrit-Owner: Simon Arlott <flashrom.simon(a)arlott.org> Gerrit-Reviewer: Anastasia Klimchuk <aklm(a)chromium.org> Gerrit-Reviewer: Peter Marheine <pmarheine(a)chromium.org> Gerrit-Reviewer: build bot (Jenkins) <no-reply(a)coreboot.org> Gerrit-Attention: Simon Arlott <flashrom.simon(a)arlott.org> Gerrit-Attention: Peter Marheine <pmarheine(a)chromium.org> Gerrit-Comment-Date: Mon, 10 Mar 2025 09:43:02 +0000 Gerrit-HasComments: Yes Gerrit-Has-Labels: No Comment-In-Reply-To: Simon Arlott <flashrom.simon(a)arlott.org> 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]: doc: Final cleanup of remaining references to the old wiki website
by Anastasia Klimchuk (Code Review) 09 Mar '25

09 Mar '25

Anastasia Klimchuk has submitted this change. ( https://review.coreboot.org/c/flashrom/+/86676?usp=email ) Change subject: doc: Final cleanup of remaining references to the old wiki website ...................................................................... doc: Final cleanup of remaining references to the old wiki website Change-Id: Ie002c1242075c8becb59d26bd9c562c7616233c1 Signed-off-by: Anastasia Klimchuk <aklm(a)flashrom.org> Reviewed-on: https://review.coreboot.org/c/flashrom/+/86676 Tested-by: build bot (Jenkins) <no-reply(a)coreboot.org> Reviewed-by: Stefan Reinauer <stefan.reinauer(a)coreboot.org> --- M doc/classic_cli_manpage.rst M doc/how_to_support_flashrom.rst M doc/index.rst M doc/supported_hw/supported_prog/index.rst M flashrom.c M ichspi.c M util/git-hooks/commit-msg 7 files changed, 41 insertions(+), 15 deletions(-) Approvals: Stefan Reinauer: Looks good to me, approved build bot (Jenkins): Verified diff --git a/doc/classic_cli_manpage.rst b/doc/classic_cli_manpage.rst index 243cf4f..cf80556 100644 --- a/doc/classic_cli_manpage.rst +++ b/doc/classic_cli_manpage.rst @@ -789,13 +789,43 @@ atavia programmer ^^^^^^^^^^^^^^^^^ +The VT6421A is a PATA/SATA PCI controller that can be found on various cheap PCI cards. +Currently there is a `datasheet <http://spacehopper.org/mirrors/ftp.vtbridge.org/Docs/Storage/DS_VT6421A_100…>`_. + +There exists a patch for flashrom that makes it possible to access the attached flash chip, +but it has problems with some cards. They seem to need an offset added to the chip address for unknown reasons. + Due to the mysterious address handling of the VIA VT6421A controller the user can specify an offset with the:: flashrom -p atavia:offset=addr syntax where ``addr`` will be interpreted as usual (leading 0x (0) for hexadecimal (octal) values, or else decimal). -For more information please see `its wiki page <https://flashrom.org/VT6421A "its wiki page>`_. +Cards found in the wild: + ++----------------+----------------------+--------+---------+------------+-------------+----------+----------------------+-------+ +| Vendor | Model | rev. | country | lot code | Chip | Size [B] | Offset | lspci | ++================+======================+========+=========+============+=============+==========+======================+=======+ +| | | | | | W39V040BPZ | 512k | | | ++----------------+----------------------+--------+---------+------------+-------------+----------+----------------------+-------+ +| Eminent | EM2001 | 0910CD | Taiwan | 2IA0022481 | SST49LF020A | 256k | 0xfff00000 | [2] | ++----------------+----------------------+--------+---------+------------+-------------+----------+----------------------+-------+ +| "SATA CONNECT" | "High speed 2/4-port | 0901CD | Taiwan | 2IA0022471 | Pm49FL004 | 512k | 0xfff80000 = | [3] | +| | Serial ATA card" | | | | | | 0xffffffff - size | | +| | | | | | | | + 1 (aka phys_addr) | | ++----------------+----------------------+--------+---------+------------+-------------+----------+----------------------+-------+ +| Gembird | SATA-3 | | | | W39V040C | 512k | | | ++----------------+----------------------+--------+---------+------------+-------------+----------+----------------------+-------+ +| | HZ-006 | | | | Pm39LV512 | 64k | | [4] | ++----------------+----------------------+--------+---------+------------+-------------+----------+----------------------+-------+ + +* `[2] <http://paste.flashrom.org/view.php?id=1369>`_ +* `[3] <http://www.flashrom.org/pipermail/flashrom/2012-September/009992.html>`_ +* `[4] <http://www.flashrom.org/pipermail/flashrom/2012-December/010318.html>`_ + +The revision consists of two characters that are printed below the "VT6421A" string on the chip +prefixed by 4 numbers that encode the production year and week. +The country is noted right of the revision. atapromise programmer ^^^^^^^^^^^^^^^^^^^^^ diff --git a/doc/how_to_support_flashrom.rst b/doc/how_to_support_flashrom.rst index bb5cdaa..483d3e6 100644 --- a/doc/how_to_support_flashrom.rst +++ b/doc/how_to_support_flashrom.rst @@ -94,11 +94,8 @@ #. If there is an announcement on the mailing list about new doc under review, have a look and you can join the review -#. Help migrate information from `old website <https://wiki.flashrom.org/>`_ to `new website <https://www.flashrom.org/>`_. - The rule is, all useful docs need to be migrated but they should be reviewed. Concrete example, - there are docs for programmers, written a while ago. If you are using the programmer regularly - you can review the existing doc and help update it (if needed) and then the updated doc will - go to the new website. +#. If you have been following the document and discovered something incorrect there, or outdated, + send a patch to update the document. #. New documentation welcome. diff --git a/doc/index.rst b/doc/index.rst index f32f182..b175787 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -20,7 +20,6 @@ how_to_support_flashrom how_to_add_docs documentation_license - Old wiki website <https://wiki.flashrom.org/> .. include:: intro.rst diff --git a/doc/supported_hw/supported_prog/index.rst b/doc/supported_hw/supported_prog/index.rst index b87b995..d1a42c9 100644 --- a/doc/supported_hw/supported_prog/index.rst +++ b/doc/supported_hw/supported_prog/index.rst @@ -10,7 +10,7 @@ (see :doc:`/classic_cli_manpage` for more details on command line options). The output of this command is long, so you might want to save it to file or grep. -Patches to add/update documentation, or migrate docs from `old wiki website <https://wiki.flashrom.org/Supported_programmers>`_ are very much appreciated. +Patches to add/update documentation are very much appreciated. .. toctree:: :maxdepth: 1 diff --git a/flashrom.c b/flashrom.c index dbac127..af15552 100644 --- a/flashrom.c +++ b/flashrom.c @@ -1528,27 +1528,27 @@ if (is_internal_programmer()) msg_gerr("This means we have to add special support for your board, programmer or flash\n" "chip. Please report this to the mailing list at flashrom(a)flashrom.org or on\n" - "IRC (see https://www.flashrom.org/Contact for details), thanks!\n" + "chat channels (see https://flashrom.org/contact.html for details), thanks!\n" "-------------------------------------------------------------------------------\n" "You may now reboot or simply leave the machine running.\n"); else msg_gerr("Please check the connections (especially those to write protection pins) between\n" "the programmer and the flash chip. If you think the error is caused by flashrom\n" - "please report this to the mailing list at flashrom(a)flashrom.org or on IRC (see\n" - "https://www.flashrom.org/Contact for details), thanks!\n"); + "please report this to the mailing list at flashrom(a)flashrom.org or on chat (see\n" + "https://flashrom.org/contact.html for details), thanks!\n"); } void emergency_help_message(void) { msg_gerr("Your flash chip is in an unknown state.\n"); if (is_internal_programmer()) - msg_gerr("Get help on IRC (see https://www.flashrom.org/Contact) or mail\n" + msg_gerr("Get help on chat (see https://flashrom.org/contact.html) or mail\n" "flashrom(a)flashrom.org with the subject \"FAILED: <your board name>\"!" "-------------------------------------------------------------------------------\n" "DO NOT REBOOT OR POWEROFF!\n"); else msg_gerr("Please report this to the mailing list at flashrom(a)flashrom.org or\n" - "on IRC (see https://www.flashrom.org/Contact for details), thanks!\n"); + "on chat (see https://flashrom.org/contact.html for details), thanks!\n"); } void list_programmers_linebreak(int startcol, int cols, int paren) diff --git a/ichspi.c b/ichspi.c index ac70eed..7471d1a 100644 --- a/ichspi.c +++ b/ichspi.c @@ -2236,7 +2236,7 @@ if (ich_spi_rw_restricted) msg_pinfo("Not all flash regions are freely accessible by flashrom. This is " "most likely\ndue to an active ME. Please see " - "https://flashrom.org/ME for details.\n"); + "https://flashrom.org/user_docs/management_engine.html for details.\n"); } /* Handle PR registers */ diff --git a/util/git-hooks/commit-msg b/util/git-hooks/commit-msg index e2f5de5..505c0cd 100755 --- a/util/git-hooks/commit-msg +++ b/util/git-hooks/commit-msg @@ -28,7 +28,7 @@ CHANGE_ID_AFTER="Bug|Depends-On|Issue|Test|Feature|Fixes|Fixed|Staging-ID" MSG="$1" -DEV_GUIDELINES_URL="https://www.flashrom.org/Development_Guidelines" +DEV_GUIDELINES_URL="https://flashrom.org/dev_guide/development_guide.html" # Check for, and add if missing, a unique Change-Id # -- To view, visit https://review.coreboot.org/c/flashrom/+/86676?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: Ie002c1242075c8becb59d26bd9c562c7616233c1 Gerrit-Change-Number: 86676 Gerrit-PatchSet: 2 Gerrit-Owner: Anastasia Klimchuk <aklm(a)chromium.org> Gerrit-Reviewer: Anastasia Klimchuk <aklm(a)chromium.org> Gerrit-Reviewer: Stefan Reinauer <stefan.reinauer(a)coreboot.org> Gerrit-Reviewer: build bot (Jenkins) <no-reply(a)coreboot.org>

1 0

[M] Change in flashrom[main]: libflashrom: Update the API for progress callback
by Anastasia Klimchuk (Code Review) 09 Mar '25

09 Mar '25

Anastasia Klimchuk has submitted this change. ( https://review.coreboot.org/c/flashrom/+/86031?usp=email ) 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> Reviewed-on: https://review.coreboot.org/c/flashrom/+/86031 Tested-by: build bot (Jenkins) <no-reply(a)coreboot.org> Reviewed-by: Sergii Dmytruk <sergii.dmytruk(a)3mdeb.com> Reviewed-by: Peter Marheine <pmarheine(a)chromium.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, 122 insertions(+), 72 deletions(-) Approvals: build bot (Jenkins): Verified Sergii Dmytruk: Looks good to me, approved Peter Marheine: Looks good to me, approved diff --git a/cli_classic.c b/cli_classic.c index 1a0565b..d0c7114 100644 --- a/cli_classic.c +++ b/cli_classic.c @@ -1282,11 +1282,8 @@ fill_flash = &flashes[0]; struct cli_progress cli_progress = {0}; - struct flashrom_progress progress_state = { - .user_data = &cli_progress - }; if (options.show_progress) - flashrom_set_progress_callback(fill_flash, &flashrom_progress_cb, &progress_state); + flashrom_set_progress_callback_v2(fill_flash, &flashrom_progress_cb, &cli_progress); print_chip_support_status(fill_flash->chip); diff --git a/cli_output.c b/cli_output.c index a8b8d7c..42608b3 100644 --- a/cli_output.c +++ b/cli_output.c @@ -92,14 +92,13 @@ msg_ginfo("[%s: %2u%%]", flashrom_progress_stage_to_string(stage), cli_progress->stage_pc[stage]); } -void flashrom_progress_cb(struct flashrom_flashctx *flashctx) +void flashrom_progress_cb(enum flashrom_progress_stage stage, size_t current, size_t total, void* user_data) { - struct flashrom_progress *progress_state = flashctx->progress_state; unsigned int pc = 0; - struct cli_progress *cli_progress = progress_state->user_data; + struct cli_progress *cli_progress = user_data; /* The expectation is that initial progress of zero is reported before doing anything. */ - if (progress_state->current == 0) { + if (current == 0) { if (!cli_progress->stage_setup) { cli_progress->stage_setup = true; @@ -113,17 +112,17 @@ } } - cli_progress->stage_pc[progress_state->stage] = 0; + cli_progress->stage_pc[stage] = 0; } else { cli_progress->stage_setup = false; - cli_progress->visible_stages |= 1 << progress_state->stage; + cli_progress->visible_stages |= 1 << stage; } - if (progress_state->current > 0 && progress_state->total > 0) - pc = ((unsigned long long) progress_state->current * 100llu) / - ((unsigned long long) progress_state->total); - if (cli_progress->stage_pc[progress_state->stage] != pc) { - cli_progress->stage_pc[progress_state->stage] = pc; + if (current > 0 && total > 0) + pc = ((unsigned long long) current * 100llu) / + ((unsigned long long) total); + if (cli_progress->stage_pc[stage] != pc) { + cli_progress->stage_pc[stage] = pc; if (line_state == PROGRESS) { /* Erase previous output, because it was previous progress step. */ diff --git a/doc/release_notes/devel.rst b/doc/release_notes/devel.rst index 62dffb0..4defe52 100644 --- a/doc/release_notes/devel.rst +++ b/doc/release_notes/devel.rst @@ -51,3 +51,16 @@ 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. + +New libflashrom API for progress reporting +------------------------------------------ + +The old ``flashrom_set_progress_callback`` function for requesting progress updates +during library operations is now deprecated. Users should call +``flashrom_set_progress_callback_v2`` instead, which also changes the signature +of the callback function. Specifically, new function type ``flashrom_progress_callback_v2`` +should be used from now on. + +This new API fixes limitations with the old one where most users would need to +define their own global state to track progress, and it was impossible to fix that +issue while maintaining binary compatibility without adding a new API. diff --git a/flashrom.c b/flashrom.c index 8daad74..dbac127 100644 --- a/flashrom.c +++ b/flashrom.c @@ -1221,7 +1221,7 @@ static void setup_progress_from_layout(struct flashctx *flashctx, enum flashrom_progress_stage stage) { - if (!flashctx->progress_callback) + if (!flashctx->progress_callback && !flashctx->deprecated_progress_callback) return; const struct flashrom_layout *const flash_layout = get_layout(flashctx); @@ -1242,7 +1242,7 @@ const void *want, enum flashrom_progress_stage stage) { - if (!flashctx->progress_callback) + if (!flashctx->progress_callback && !flashctx->deprecated_progress_callback) return; const struct flashrom_layout *flash_layout = get_layout(flashctx); diff --git a/include/cli_output.h b/include/cli_output.h index 311c85e..1a62382 100644 --- a/include/cli_output.h +++ b/include/cli_output.h @@ -26,6 +26,6 @@ int close_logfile(void); void start_logging(void); int flashrom_print_cb(enum flashrom_log_level level, const char *fmt, va_list ap); -void flashrom_progress_cb(struct flashrom_flashctx *flashctx); +void flashrom_progress_cb(enum flashrom_progress_stage stage, size_t current, size_t total, void* user_data); #endif /* __CLI_OUTPUT_H__ */ diff --git a/include/flash.h b/include/flash.h index 80ee5f6..3293980 100644 --- a/include/flash.h +++ b/include/flash.h @@ -621,9 +621,12 @@ void *data; } chip_restore_fn[MAX_CHIP_RESTORE_FUNCTIONS]; /* Progress reporting */ - flashrom_progress_callback *progress_callback; - struct flashrom_progress *progress_state; + 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; /* Maximum allowed % of redundant erase */ int sacrifice_ratio; diff --git a/include/libflashrom.h b/include/libflashrom.h index e87776b..41c7424 100644 --- a/include/libflashrom.h +++ b/include/libflashrom.h @@ -75,14 +75,31 @@ FLASHROM_PROGRESS_ERASE, FLASHROM_PROGRESS_NR, }; + struct flashrom_progress { enum flashrom_progress_stage stage; size_t current; size_t total; void *user_data; }; + struct flashrom_flashctx; typedef void(flashrom_progress_callback)(struct flashrom_flashctx *flashctx); + +/** + * @deprecated Use flashrom_set_progress_callback_v2 instead + */ +void flashrom_set_progress_callback( + struct flashrom_flashctx *const flashctx, + flashrom_progress_callback *progress_callback, + struct flashrom_progress *progress_state) +__attribute__((deprecated("Use flashrom_set_progress_callback_v2 instead"))); + +typedef void(flashrom_progress_callback_v2)(enum flashrom_progress_stage stage, + size_t current, + size_t total, + void *user_data); + /** * @brief Set the progress callback function. * @@ -90,12 +107,12 @@ * to indicate the progress has changed. This allows frontends to do whatever * they see fit with such values, e.g. update a progress bar in a GUI tool. * - * @param progress_callback Pointer to the new progress callback function. - * @param progress_state Pointer to progress state to include with the progress - * callback. + * @param flashrom_progress_callback_v2 Pointer to the new progress callback function. + * @param user_data A pointer to a piece of data which is managed by progress caller */ -void flashrom_set_progress_callback(struct flashrom_flashctx *const flashctx, - flashrom_progress_callback *progress_callback, struct flashrom_progress *progress_state); +void flashrom_set_progress_callback_v2(struct flashrom_flashctx *const flashctx, + flashrom_progress_callback_v2 *progress_callback, + void* user_data); /** @} */ /* end flashrom-general */ diff --git a/libflashrom.c b/libflashrom.c index 78e5c9b..8cc38c4 100644 --- a/libflashrom.c +++ b/libflashrom.c @@ -64,15 +64,42 @@ return 0; } -void flashrom_set_progress_callback(struct flashrom_flashctx *flashctx, flashrom_progress_callback *progress_callback, struct flashrom_progress *progress_state) +void flashrom_set_progress_callback(struct flashrom_flashctx *flashctx, + flashrom_progress_callback *progress_callback, + struct flashrom_progress *progress_state) { + msg_gwarn("%s: this function is deprecated (for developers: call %s_v2 instead)\n", + __func__, __func__); + + if (flashctx->progress_callback) { + msg_gwarn("Progress callback already set by %s_v2, " + "ignoring this call since only one progress callback can be registered.\n", + __func__); + return; + } + + flashctx->deprecated_progress_callback = progress_callback; + flashctx->deprecated_progress_state = progress_state; + flashctx->progress_state = *progress_state; +} + +void flashrom_set_progress_callback_v2(struct flashrom_flashctx *flashctx, + flashrom_progress_callback_v2 *progress_callback, + void *user_data) +{ + if (flashctx->deprecated_progress_callback) { + msg_gwarn("Deprecated progress callback already set by flashrom_set_progress_callback, " + "ignoring this call since only one progress callback can be registered.\n"); + return; + } + flashctx->progress_callback = progress_callback; - flashctx->progress_state = progress_state; + flashctx->progress_state.user_data = user_data; } /** @private */ void init_progress(struct flashrom_flashctx *flashctx, enum flashrom_progress_stage stage, size_t total) { - if (flashctx->progress_callback == NULL) + if (!flashctx->progress_callback && !flashctx->deprecated_progress_callback) return; struct stage_progress *stage_progress = &flashctx->stage_progress[stage]; @@ -85,7 +112,7 @@ /** @private */ void update_progress(struct flashrom_flashctx *flashctx, enum flashrom_progress_stage stage, size_t increment) { - if (flashctx->progress_callback == NULL) + if (!flashctx->progress_callback && !flashctx->deprecated_progress_callback) return; struct stage_progress *stage_progress = &flashctx->stage_progress[stage]; @@ -96,11 +123,20 @@ stage_progress->total = stage_progress->current; } - flashctx->progress_state->stage = stage; - flashctx->progress_state->current = stage_progress->current; - flashctx->progress_state->total = stage_progress->total; + flashctx->progress_state.stage = stage; + flashctx->progress_state.current = stage_progress->current; + flashctx->progress_state.total = stage_progress->total; - flashctx->progress_callback(flashctx); + if (flashctx->progress_callback) { + flashctx->progress_callback(stage, stage_progress->current, stage_progress->total, + flashctx->progress_state.user_data); + } else if (flashctx->deprecated_progress_callback) { + *(flashctx->deprecated_progress_state) = flashctx->progress_state; + flashctx->deprecated_progress_callback(flashctx); + memcpy(&flashctx->progress_state.user_data, + flashctx->deprecated_progress_state->user_data, + sizeof(flashctx->progress_state.user_data)); + } } const char *flashrom_version_info(void) diff --git a/libflashrom.map b/libflashrom.map index e1cdfa6..8e4635d 100644 --- a/libflashrom.map +++ b/libflashrom.map @@ -25,6 +25,7 @@ flashrom_programmer_shutdown; flashrom_set_log_callback; flashrom_set_progress_callback; + flashrom_set_progress_callback_v2; flashrom_shutdown; flashrom_supported_boards; flashrom_supported_chipsets; diff --git a/tests/chip.c b/tests/chip.c index 25bb8db..95c8616 100644 --- a/tests/chip.c +++ b/tests/chip.c @@ -81,20 +81,20 @@ return 0; } -static void progress_callback(struct flashctx *flash) { - struct progress_user_data *progress_user_data = flash->progress_state->user_data; - if (flash->progress_state->current == 0) { - printf("Progress started for stage %d, initial callback call\n", flash->progress_state->stage); +static void progress_callback(enum flashrom_progress_stage stage, size_t current, size_t total, void* user_data) { + struct progress_user_data *progress_user_data = user_data; + + if (current == 0) { + printf("Progress started for stage %d, initial callback call\n", stage); } else { /* Progress cannot go backwards. */ - assert_true(flash->progress_state->current >= progress_user_data->last_seen[flash->progress_state->stage]); + assert_true(current >= progress_user_data->last_seen[stage]); } - if (flash->progress_state->current >= flash->progress_state->total - 1) - printf("Progress almost complete for stage %d, current %ld, total %ld\n", - flash->progress_state->stage, flash->progress_state->current, flash->progress_state->total); + if (current >= total - 1) + printf("Progress almost complete for stage %d, current %ld, total %ld\n", stage, current, total); - progress_user_data->last_seen[flash->progress_state->stage] = flash->progress_state->current; + progress_user_data->last_seen[stage] = current; } static void setup_chip(struct flashrom_flashctx *flashctx, struct flashrom_layout **layout, @@ -255,10 +255,7 @@ setup_chip(&flashctx, &layout, &mock_chip, param, &chip_io); struct progress_user_data progress_user_data = {0}; - struct flashrom_progress progress_state = { - .user_data = &progress_user_data - }; - flashrom_set_progress_callback(&flashctx, progress_callback, &progress_state); + flashrom_set_progress_callback_v2(&flashctx, progress_callback, &progress_user_data); printf("Erase chip operation started.\n"); assert_int_equal(0, flashrom_flash_erase(&flashctx)); @@ -357,10 +354,7 @@ setup_chip(&flashctx, &layout, &mock_chip, param, &chip_io); struct progress_user_data progress_user_data = {0}; - struct flashrom_progress progress_state = { - .user_data = &progress_user_data - }; - flashrom_set_progress_callback(&flashctx, progress_callback, &progress_state); + flashrom_set_progress_callback_v2(&flashctx, progress_callback, &progress_user_data); const char *const filename = "read_chip.test"; unsigned long size = mock_chip.total_size * 1024; @@ -488,10 +482,7 @@ setup_chip(&flashctx, &layout, &mock_chip, param, &chip_io); struct progress_user_data progress_user_data = {0}; - struct flashrom_progress progress_state = { - .user_data = &progress_user_data - }; - flashrom_set_progress_callback(&flashctx, progress_callback, &progress_state); + flashrom_set_progress_callback_v2(&flashctx, progress_callback, &progress_user_data); const char *const filename = "-"; unsigned long size = mock_chip.total_size * 1024; @@ -621,10 +612,7 @@ assert_non_null(newcontents); struct progress_user_data progress_user_data = {0}; - struct flashrom_progress progress_state = { - .user_data = &progress_user_data - }; - flashrom_set_progress_callback(&flashctx, progress_callback, &progress_state); + flashrom_set_progress_callback_v2(&flashctx, progress_callback, &progress_user_data); printf("Write chip operation started.\n"); assert_int_equal(0, read_buf_from_file(newcontents, size, filename)); diff --git a/tests/spi25.c b/tests/spi25.c index a442c7b..0370312 100644 --- a/tests/spi25.c +++ b/tests/spi25.c @@ -69,26 +69,25 @@ return 0; } -static void spi_read_progress_cb(struct flashrom_flashctx *flashctx) +static void spi_read_progress_cb(enum flashrom_progress_stage stage, size_t current, size_t total, void* user_data) { - struct flashrom_progress *progress_state = flashctx->progress_state; - uint32_t *cnt = (uint32_t *) progress_state->user_data; - assert_int_equal(0x400, progress_state->total); + uint32_t *cnt = (uint32_t *) user_data; + assert_int_equal(0x400, total); switch (*cnt) { case 0: - assert_int_equal(0x0, progress_state->current); + assert_int_equal(0x0, current); break; case 1: - assert_int_equal(0x100, progress_state->current); + assert_int_equal(0x100, current); break; case 2: - assert_int_equal(0x200, progress_state->current); + assert_int_equal(0x200, current); break; case 3: - assert_int_equal(0x300, progress_state->current); + assert_int_equal(0x300, current); break; case 4: - assert_int_equal(0x400, progress_state->current); + assert_int_equal(0x400, current); break; default: fail(); @@ -113,10 +112,7 @@ .chip = &mock_chip, .mst = &mst }; - struct flashrom_progress progress_state = { - .user_data = (void *) &cnt, - }; - flashrom_set_progress_callback(&flashctx, spi_read_progress_cb, &progress_state); + flashrom_set_progress_callback_v2(&flashctx, spi_read_progress_cb, (void *) &cnt); init_progress(&flashctx, FLASHROM_PROGRESS_READ, 0x400); for (int i = 0; i < 4; i++) { will_return(__wrap_spi_send_command, JEDEC_WRDI); @@ -126,7 +122,7 @@ assert_int_equal(0, default_spi_read(&flashctx, buf, offset, sizeof(buf))); assert_int_equal(5, cnt); - flashrom_set_progress_callback(&flashctx, NULL, NULL); + flashrom_set_progress_callback_v2(&flashctx, NULL, NULL); } void spi_write_enable_test_success(void **state) -- 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: merged Gerrit-Project: flashrom Gerrit-Branch: main Gerrit-Change-Id: Ia8cc0461c449b7e65888a64cdc594c55b81eae7a Gerrit-Change-Number: 86031 Gerrit-PatchSet: 14 Gerrit-Owner: Anastasia Klimchuk <aklm(a)chromium.org> Gerrit-Reviewer: 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>

1 0

[M] Change in flashrom[main]: libflashrom: Update the API for progress callback
by Peter Marheine (Code Review) 06 Mar '25

06 Mar '25

Attention is currently required from: Anastasia Klimchuk, Richard Hughes. Peter Marheine 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 13: Code-Review+2 -- 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: 13 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: Anastasia Klimchuk <aklm(a)chromium.org> Gerrit-Comment-Date: Thu, 06 Mar 2025 23:12:53 +0000 Gerrit-HasComments: No Gerrit-Has-Labels: Yes

1 0

[S] Change in flashrom[main]: util/docker: Update the script that updates the website
by Patrick Georgi (Code Review) 06 Mar '25

06 Mar '25

Patrick Georgi has submitted this change. ( https://review.coreboot.org/c/flashrom/+/86681?usp=email ) Change subject: util/docker: Update the script that updates the website ...................................................................... util/docker: Update the script that updates the website - Update the base system (alpine 3.8 -> 3.21) - Update sphinx and its modules (and from pip-install to alpine-install) - Remove unused features that increase maintenance overhead (autobuild/livehtml and ditaa) - Use the build system to generate docs (instead of calling sphinx in its own, custom ways) Change-Id: I844e4ea84b94444c96f29325fee205b0deb972da Signed-off-by: Patrick Georgi <patrick(a)georgi-clan.de> Reviewed-on: https://review.coreboot.org/c/flashrom/+/86681 Reviewed-by: Anastasia Klimchuk <aklm(a)chromium.org> Tested-by: build bot (Jenkins) <no-reply(a)coreboot.org> --- M util/docker/flashrom.org/Dockerfile D util/docker/flashrom.org/ditaa.sh M util/docker/flashrom.org/makeSphinx.sh 3 files changed, 12 insertions(+), 35 deletions(-) Approvals: build bot (Jenkins): Verified Anastasia Klimchuk: Looks good to me, approved diff --git a/util/docker/flashrom.org/Dockerfile b/util/docker/flashrom.org/Dockerfile index 23f5f50..2fc9e9f 100644 --- a/util/docker/flashrom.org/Dockerfile +++ b/util/docker/flashrom.org/Dockerfile @@ -1,29 +1,12 @@ -FROM alpine:3.8 +FROM alpine:3.21 -COPY makeSphinx.sh /makeSphinx.sh - -ADD https://sourceforge.net/projects/ditaa/files/ditaa/0.9/ditaa0_9.zip/download /tmp/ditaa.zip - -RUN apk add --no-cache python3 make bash git openjdk8-jre ttf-dejavu fontconfig \ - && pip3 install --upgrade --no-cache-dir pip \ - && pip3 install --no-cache-dir \ - sphinx===1.8.3 \ - sphinx_rtd_theme===0.4.2 \ - recommonmark===0.5.0 \ - sphinx_autobuild===0.7.1 \ - sphinxcontrib-ditaa===0.6 \ - && chmod 755 /makeSphinx.sh -RUN cd /tmp \ - && unzip ditaa.zip \ - && mv ditaa0_9.jar /usr/lib -ADD ditaa.sh /usr/bin/ditaa +RUN apk add --no-cache sphinx py3-sphinx_rtd_theme bash git meson ninja gcc musl-dev pkgconf VOLUME /data-in /data-out -# For Sphinx-autobuild -# Port 8000 - HTTP server -# Port 35729 - websockets connection to allow automatic browser reloads after each build -EXPOSE 8000 35729 +COPY makeSphinx.sh /makeSphinx.sh + +ENV MESON_PACKAGE_CACHE_DIR /tmp/meson-pkgcache/ ENTRYPOINT ["/bin/bash", "/makeSphinx.sh"] CMD [] diff --git a/util/docker/flashrom.org/ditaa.sh b/util/docker/flashrom.org/ditaa.sh deleted file mode 100755 index 637379f..0000000 --- a/util/docker/flashrom.org/ditaa.sh +++ /dev/null @@ -1,2 +0,0 @@ -#!/usr/bin/env sh -exec java -jar /usr/lib/ditaa0_9.jar $* diff --git a/util/docker/flashrom.org/makeSphinx.sh b/util/docker/flashrom.org/makeSphinx.sh index 5b6ea03..51ff771 100755 --- a/util/docker/flashrom.org/makeSphinx.sh +++ b/util/docker/flashrom.org/makeSphinx.sh @@ -1,12 +1,8 @@ #!/usr/bin/env bash - -if [ "$1" == "livehtml" ]; then - echo "Starting live documentation build" - cd /data-in/ && sphinx-autobuild -b html doc /tmp/build/html -else - echo "Starting production documentation build" - cd /data-in/ \ - && sphinx-build -b html doc /tmp/build/html \ - && rm -rf /data-out/* \ - && mv /tmp/build/html/* /data-out/ -fi +set -e +cd /data-in/ +meson setup /tmp/build -Ddocumentation=enabled -Dgenerate_authors_list=enabled +ninja -C /tmp/build doc/html +rm -rf /data-out/* +mv /tmp/build/doc/html/* /data-out/ +rm -rf /tmp/build -- To view, visit https://review.coreboot.org/c/flashrom/+/86681?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: I844e4ea84b94444c96f29325fee205b0deb972da Gerrit-Change-Number: 86681 Gerrit-PatchSet: 3 Gerrit-Owner: Patrick Georgi <patrick(a)coreboot.org> Gerrit-Reviewer: Anastasia Klimchuk <aklm(a)chromium.org> Gerrit-Reviewer: Elyes Haouas <ehaouas(a)noos.fr> Gerrit-Reviewer: Patrick Georgi <patrick(a)coreboot.org> Gerrit-Reviewer: Stefan Reinauer <stefan.reinauer(a)coreboot.org> Gerrit-Reviewer: build bot (Jenkins) <no-reply(a)coreboot.org>

1 0

[S] Change in flashrom[main]: util/docker: Update the script that updates the website
by Anastasia Klimchuk (Code Review) 06 Mar '25

06 Mar '25

Attention is currently required from: Elyes Haouas, Patrick Georgi, Stefan Reinauer. Anastasia Klimchuk has posted comments on this change by Patrick Georgi. ( https://review.coreboot.org/c/flashrom/+/86681?usp=email ) Change subject: util/docker: Update the script that updates the website ...................................................................... Patch Set 2: Code-Review+2 -- To view, visit https://review.coreboot.org/c/flashrom/+/86681?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: I844e4ea84b94444c96f29325fee205b0deb972da Gerrit-Change-Number: 86681 Gerrit-PatchSet: 2 Gerrit-Owner: Patrick Georgi <patrick(a)coreboot.org> Gerrit-Reviewer: Anastasia Klimchuk <aklm(a)chromium.org> Gerrit-Reviewer: Elyes Haouas <ehaouas(a)noos.fr> Gerrit-Reviewer: Stefan Reinauer <stefan.reinauer(a)coreboot.org> Gerrit-Reviewer: build bot (Jenkins) <no-reply(a)coreboot.org> Gerrit-Attention: Patrick Georgi <patrick(a)coreboot.org> Gerrit-Attention: Stefan Reinauer <stefan.reinauer(a)coreboot.org> Gerrit-Attention: Elyes Haouas <ehaouas(a)noos.fr> Gerrit-Comment-Date: Thu, 06 Mar 2025 09:03:56 +0000 Gerrit-HasComments: No Gerrit-Has-Labels: Yes

1 0

2025

2024

2023

2022

2021

2020

2019

2018

2017

flashrom-gerrit March 2025