- flashrom-gerrit - mail.coreboot.org

[S] Change in flashrom[main]: doc: Add recent entries into Recent development doc
by Peter Marheine (Code Review) 20 Jan '25

20 Jan '25

Attention is currently required from: Anastasia Klimchuk. Peter Marheine has posted comments on this change by Anastasia Klimchuk. ( https://review.coreboot.org/c/flashrom/+/86060?usp=email ) Change subject: doc: Add recent entries into Recent development doc ...................................................................... Patch Set 1: Code-Review+2 -- To view, visit https://review.coreboot.org/c/flashrom/+/86060?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: Ic852df125c9740d95dc1b9ad8ad97bfd56d40211 Gerrit-Change-Number: 86060 Gerrit-PatchSet: 1 Gerrit-Owner: Anastasia Klimchuk <aklm(a)chromium.org> Gerrit-Reviewer: Matt DeVillier <matt.devillier(a)gmail.com> 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-Comment-Date: Mon, 20 Jan 2025 21:31:31 +0000 Gerrit-HasComments: No Gerrit-Has-Labels: Yes

1 0

[S] Change in flashrom[main]: doc: Add recent entries into Recent development doc
by Matt DeVillier (Code Review) 20 Jan '25

20 Jan '25

Attention is currently required from: Anastasia Klimchuk, Peter Marheine. Matt DeVillier has posted comments on this change by Anastasia Klimchuk. ( https://review.coreboot.org/c/flashrom/+/86060?usp=email ) Change subject: doc: Add recent entries into Recent development doc ...................................................................... Patch Set 1: Code-Review+1 -- To view, visit https://review.coreboot.org/c/flashrom/+/86060?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: Ic852df125c9740d95dc1b9ad8ad97bfd56d40211 Gerrit-Change-Number: 86060 Gerrit-PatchSet: 1 Gerrit-Owner: Anastasia Klimchuk <aklm(a)chromium.org> Gerrit-Reviewer: Matt DeVillier <matt.devillier(a)gmail.com> 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, 20 Jan 2025 14:47:24 +0000 Gerrit-HasComments: No Gerrit-Has-Labels: Yes

1 0

[S] Change in flashrom[main]: doc: Add recent entries into Recent development doc
by Anastasia Klimchuk (Code Review) 20 Jan '25

20 Jan '25

Anastasia Klimchuk has uploaded this change for review. ( https://review.coreboot.org/c/flashrom/+/86060?usp=email ) Change subject: doc: Add recent entries into Recent development doc ...................................................................... doc: Add recent entries into Recent development doc Normally the info would be added in the same patch, but these efforts were ongoing in parallel with release prep, which makes it hard to modify devel.rst at the same time. Change-Id: Ic852df125c9740d95dc1b9ad8ad97bfd56d40211 Signed-off-by: Anastasia Klimchuk <aklm(a)flashrom.org> --- M doc/release_notes/devel.rst 1 file changed, 19 insertions(+), 0 deletions(-) git pull ssh://review.coreboot.org:29418/flashrom refs/changes/60/86060/1 diff --git a/doc/release_notes/devel.rst b/doc/release_notes/devel.rst index bb2b73d..05fe4a0 100644 --- a/doc/release_notes/devel.rst +++ b/doc/release_notes/devel.rst @@ -16,3 +16,22 @@ not currently supported. https://ticket.coreboot.org/issues/370 + +flashchips.c split into separate files by vendor +================================================ + +``flashchips.c`` file was split into separate files per vendor. flashchips.c still exists in the source +code but it is much smaller and only contain "generic" chip entries. + +With this, instead of one file ``flashchips.c`` we now have a ``flashchips/`` directory which contains +all the files. + +There are no changes to the usage, and everything that's supported stays the same. + +New features +============ + +-r/-w/-v argument is optional when using -i +------------------------------------------- + +See :doc:`/classic_cli_manpage` for details. -- To view, visit https://review.coreboot.org/c/flashrom/+/86060?usp=email To unsubscribe, or for help writing mail filters, visit https://review.coreboot.org/settings?usp=email Gerrit-MessageType: newchange Gerrit-Project: flashrom Gerrit-Branch: main Gerrit-Change-Id: Ic852df125c9740d95dc1b9ad8ad97bfd56d40211 Gerrit-Change-Number: 86060 Gerrit-PatchSet: 1 Gerrit-Owner: Anastasia Klimchuk <aklm(a)chromium.org>

1 0

[M] Change in flashrom[main]: doc: Add document for using flashrom with CH341A/B
by Anastasia Klimchuk (Code Review) 20 Jan '25

20 Jan '25

Anastasia Klimchuk has submitted this change. ( https://review.coreboot.org/c/flashrom/+/86019?usp=email ) Change subject: doc: Add document for using flashrom with CH341A/B ...................................................................... doc: Add document for using flashrom with CH341A/B Document is contributed by Stephan Schneider. Change-Id: Id6848329d88146fc8a005437a76ec52bec986259 Signed-off-by: Anastasia Klimchuk <aklm(a)flashrom.org> Reviewed-on: https://review.coreboot.org/c/flashrom/+/86019 Reviewed-by: Peter Marheine <pmarheine(a)chromium.org> Tested-by: build bot (Jenkins) <no-reply(a)coreboot.org> --- A doc/supported_hw/supported_prog/black_board_with_IC_socket.jpg A doc/supported_hw/supported_prog/blue_board_additional_IC_socket_with_wiring.jpg A doc/supported_hw/supported_prog/blue_board_without_IC_socket.jpg A doc/supported_hw/supported_prog/ch341ab.rst A doc/supported_hw/supported_prog/green_3_3V_orange_5V.jpg M doc/supported_hw/supported_prog/index.rst A doc/supported_hw/supported_prog/pinout_of_EEPROM.jpg A doc/supported_hw/supported_prog/yellow_insulating_tape_pink_new_connections.jpg 8 files changed, 89 insertions(+), 0 deletions(-) Approvals: Peter Marheine: Looks good to me, approved build bot (Jenkins): Verified diff --git a/doc/supported_hw/supported_prog/black_board_with_IC_socket.jpg b/doc/supported_hw/supported_prog/black_board_with_IC_socket.jpg new file mode 100644 index 0000000..7c6df3a --- /dev/null +++ b/doc/supported_hw/supported_prog/black_board_with_IC_socket.jpg Binary files differ diff --git a/doc/supported_hw/supported_prog/blue_board_additional_IC_socket_with_wiring.jpg b/doc/supported_hw/supported_prog/blue_board_additional_IC_socket_with_wiring.jpg new file mode 100644 index 0000000..9a578b3 --- /dev/null +++ b/doc/supported_hw/supported_prog/blue_board_additional_IC_socket_with_wiring.jpg Binary files differ diff --git a/doc/supported_hw/supported_prog/blue_board_without_IC_socket.jpg b/doc/supported_hw/supported_prog/blue_board_without_IC_socket.jpg new file mode 100644 index 0000000..43b19db --- /dev/null +++ b/doc/supported_hw/supported_prog/blue_board_without_IC_socket.jpg Binary files differ diff --git a/doc/supported_hw/supported_prog/ch341ab.rst b/doc/supported_hw/supported_prog/ch341ab.rst new file mode 100644 index 0000000..9255989 --- /dev/null +++ b/doc/supported_hw/supported_prog/ch341ab.rst @@ -0,0 +1,88 @@ +========= +CH341A/B +========= + +.. meta:: + :author: Stephan Schneider + +The CH341\ **A** is a chip that provides a bridge between USB and serial communication. The +CH341\ **B** is almost identical, it also has a built-in oscillator. However, it is not +recommended to use the CH341\ **B** with the built-in oscillator and without a crystal +as the accuracy of the built-in oscillator is very poor and timing problems can occur +during data transmission. The serial communication of the CH341A/B can be UART or SPI/I2C, +here we are only interested in the SPI/I2C mode. The following description applies to both +chips, it does not matter which one you have. With a crystal, flashrom works with both the +CH341A and the CH341B without changing the software. + + +There are 2 ready-made boards that are suitable for use with flashrom, one with an IC socket +(Textool) with a mostly black board and one without an IC socket with a mostly blue board. + +Image 1: Black board with IC socket + +.. image:: black_board_with_IC_socket.jpg + +Image 2: Blue board without IC socket + +.. image:: blue_board_without_IC_socket.jpg + +Both boards have advantages and disadvantages. The black board with IC socket is more practical +because the IC socket is already installed. However, it has an error in the circuit diagram that +must be corrected so as not to jeopardize the EEPROMs. There is a voltage converter on the board to +convert the 5 volts of the USB to 3.3 volts, the 3.3 volts are then fed to the IC socket, but +unfortunately the CH341A is still supplied with 5 volts. The CH341A also works with 5 volts, but then +there is a voltage of just under 5 volts at the outputs of the CH341A that lead to the IC socket, +which is usually too much for the inputs of the EEPROMs and can cause them to break. The blue board +without an IC socket is correctly designed, but you also need an IC socket and some connecting wires, +which makes things complicated and error-prone. + +Image 3: Blue board and additional IC socket with wiring + +.. image:: blue_board_additional_IC_socket_with_wiring.jpg + +The conversion of the black circuit board with IC socket is simple: You need a soldering iron, +some insulated wire, some insulating tape and a steady hand. First you need to lift pin 28 of the +CH341A by approx. 1 mm, heat the pin with the soldering iron and insert a thin knife blade between +the pin and the board. Then stick a small piece of insulating tape between the pin and the circuit +board to prevent contact. Then you have to connect the bent up pin 28 with 3.3 volts and pin 9 also +with 3.3 volts, the connections are shown in the next picture. + +Image 4: Yellow: insulating tape, pink: new connections + +.. image:: yellow_insulating_tape_pink_new_connections.jpg + +For programming with flashrom you have to set the SPI/I2C mode of the CH341A, the corresponding jumper +must be set to the position shown in the pictures (it is the yellow jumper in each case). On the blue +board without IC socket you have to set the operating voltage with 2 jumpers (here blue), this is +usually 3.3 volts, there are only a few older EEPROMs that still require 5 volts, please check the data +sheet of the EEPROM to be on the safe side. + +Image 5: Green: 3.3 Volt, orange: 5 Volt + +.. image:: green_3_3V_orange_5V.jpg + +When using the blue board, you still have to make the correct connections between the EEPROM and the CH341A board: + ++---------------+--------------+ +| Pin 1 -> CS0 | Pin 8 -> Vcc | ++---------------+--------------+ +| Pin 2 -> MISO | Pin 7 -> Vcc | ++---------------+--------------+ +| Pin 3 -> Vcc | Pin 6 ➔ SCK | ++---------------+--------------+ +| Pin 4 -> GND | Pin 5 ➔ MOSI | ++---------------+--------------+ + +Pin 1 of the EEPROM is usually marked with a dot or similar, see also the EEPROM data sheet + +Image 6: Pinout of an EEPROM + +.. image:: pinout_of_EEPROM.jpg + +The following commands are some examples how to call flashrom with CH341A:: + + flashrom -p ch341a_spi + flashrom -p ch341a_spi -r filename.bin + flashrom -p ch341a_spi -w filename.bin + +That's all, good luck! diff --git a/doc/supported_hw/supported_prog/green_3_3V_orange_5V.jpg b/doc/supported_hw/supported_prog/green_3_3V_orange_5V.jpg new file mode 100644 index 0000000..6886f6f --- /dev/null +++ b/doc/supported_hw/supported_prog/green_3_3V_orange_5V.jpg Binary files differ diff --git a/doc/supported_hw/supported_prog/index.rst b/doc/supported_hw/supported_prog/index.rst index 7912f34..b87b995 100644 --- a/doc/supported_hw/supported_prog/index.rst +++ b/doc/supported_hw/supported_prog/index.rst @@ -16,6 +16,7 @@ :maxdepth: 1 buspirate + ch341ab dummyflasher ft2232_spi serprog/index diff --git a/doc/supported_hw/supported_prog/pinout_of_EEPROM.jpg b/doc/supported_hw/supported_prog/pinout_of_EEPROM.jpg new file mode 100644 index 0000000..bf17d6f --- /dev/null +++ b/doc/supported_hw/supported_prog/pinout_of_EEPROM.jpg Binary files differ diff --git a/doc/supported_hw/supported_prog/yellow_insulating_tape_pink_new_connections.jpg b/doc/supported_hw/supported_prog/yellow_insulating_tape_pink_new_connections.jpg new file mode 100644 index 0000000..af20705 --- /dev/null +++ b/doc/supported_hw/supported_prog/yellow_insulating_tape_pink_new_connections.jpg Binary files differ -- To view, visit https://review.coreboot.org/c/flashrom/+/86019?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: Id6848329d88146fc8a005437a76ec52bec986259 Gerrit-Change-Number: 86019 Gerrit-PatchSet: 2 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: 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) 18 Jan '25

18 Jan '25

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 1: (1 comment) Patchset: PS1: A comment for me to add item to "Recent development" doc after the review -- 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: 1 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, 17 Jan 2025 23:37:28 +0000 Gerrit-HasComments: Yes Gerrit-Has-Labels: No

1 0

[S] Change in flashrom[main]: libflashrom: Allow getting the progress_state from the flashctx
by Anastasia Klimchuk (Code Review) 17 Jan '25

17 Jan '25

Attention is currently required from: Richard Hughes. Anastasia Klimchuk has posted comments on this change by Richard Hughes. ( https://review.coreboot.org/c/flashrom/+/64663?usp=email ) Change subject: libflashrom: Allow getting the progress_state from the flashctx ...................................................................... Patch Set 6: (1 comment) File tests/chip.c: https://review.coreboot.org/c/flashrom/+/64663/comment/903a2ec1_d2275700?us… : PS6, Line 86: struct progress_user_data *progress_user_data = progress_state->user_data; > Thanks heaps for all details! Very useful. […] After implementing the new version of callback API I realised it is better to be as a separate patch (so, instead of updating this patch I created new one, see CB:86031 ) The reason is, the new implementation basically undoes changes in this patch, updates the API, and commit message needs to be fully changed too. So my plan is to abandon this patch, and continue the work in CB:86031 -- To view, visit https://review.coreboot.org/c/flashrom/+/64663?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: I322bf56ff92f7b4d0ffc92768e9f0cdf7cb82010 Gerrit-Change-Number: 64663 Gerrit-PatchSet: 6 Gerrit-Owner: Richard Hughes <richard(a)hughsie.com> Gerrit-Reviewer: Anastasia Klimchuk <aklm(a)chromium.org> Gerrit-Reviewer: Daniel Campello <campello(a)chromium.org> Gerrit-Reviewer: Edward O'Callaghan <quasisec(a)chromium.org> Gerrit-Reviewer: Nico Huber <nico.h(a)gmx.de> Gerrit-Reviewer: Thomas Heijligen <src(a)posteo.de> Gerrit-Reviewer: build bot (Jenkins) <no-reply(a)coreboot.org> Gerrit-CC: Paul Menzel <paulepanter(a)mailbox.org> Gerrit-CC: Peter Marheine <pmarheine(a)chromium.org> Gerrit-CC: Stefan Reinauer <stefan.reinauer(a)coreboot.org> Gerrit-Attention: Richard Hughes <richard(a)hughsie.com> Gerrit-Comment-Date: Fri, 17 Jan 2025 08:36:56 +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

[S] Change in flashrom[main]: libflashrom: Allow getting the progress_state from the flashctx
by Anastasia Klimchuk (Code Review) 17 Jan '25

17 Jan '25

Anastasia Klimchuk has abandoned this change. ( https://review.coreboot.org/c/flashrom/+/64663?usp=email ) Change subject: libflashrom: Allow getting the progress_state from the flashctx ...................................................................... Abandoned The work on libflashrom progress API continues in CB:86031 -- To view, visit https://review.coreboot.org/c/flashrom/+/64663?usp=email To unsubscribe, or for help writing mail filters, visit https://review.coreboot.org/settings?usp=email Gerrit-MessageType: abandon Gerrit-Project: flashrom Gerrit-Branch: main Gerrit-Change-Id: I322bf56ff92f7b4d0ffc92768e9f0cdf7cb82010 Gerrit-Change-Number: 64663 Gerrit-PatchSet: 6 Gerrit-Owner: Richard Hughes <richard(a)hughsie.com> Gerrit-Reviewer: Anastasia Klimchuk <aklm(a)chromium.org> Gerrit-Reviewer: Daniel Campello <campello(a)chromium.org> Gerrit-Reviewer: Edward O'Callaghan <quasisec(a)chromium.org> Gerrit-Reviewer: Nico Huber <nico.h(a)gmx.de> Gerrit-Reviewer: Thomas Heijligen <src(a)posteo.de> Gerrit-Reviewer: build bot (Jenkins) <no-reply(a)coreboot.org> Gerrit-CC: Paul Menzel <paulepanter(a)mailbox.org> Gerrit-CC: Peter Marheine <pmarheine(a)chromium.org> Gerrit-CC: Stefan Reinauer <stefan.reinauer(a)coreboot.org>

1 0

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

17 Jan '25

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 1: (1 comment) Patchset: PS1: This patch is a new version of the earlier effort in CB:64663 -- 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: 1 Gerrit-Owner: Anastasia Klimchuk <aklm(a)chromium.org> Gerrit-Reviewer: build bot (Jenkins) <no-reply(a)coreboot.org> Gerrit-Comment-Date: Fri, 17 Jan 2025 08:26:50 +0000 Gerrit-HasComments: Yes Gerrit-Has-Labels: No

1 0

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

17 Jan '25

Anastasia Klimchuk has uploaded this change for review. ( 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 _v1 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 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 9 files changed, 66 insertions(+), 68 deletions(-) git pull ssh://review.coreboot.org:29418/flashrom refs/changes/31/86031/1 diff --git a/cli_classic.c b/cli_classic.c index 1a0565b..d6a3637 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_v1(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/include/cli_output.h b/include/cli_output.h index 3a3db88..0b916f6 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 a845186..62d9f42 100644 --- a/include/flash.h +++ b/include/flash.h @@ -621,8 +621,8 @@ void *data; } chip_restore_fn[MAX_CHIP_RESTORE_FUNCTIONS]; /* Progress reporting */ - flashrom_progress_callback *progress_callback; - struct flashrom_progress *progress_state; + flashrom_progress_callback_v1 *progress_callback; + struct flashrom_progress progress_state; struct stage_progress stage_progress[FLASHROM_PROGRESS_NR]; /* Maximum allowed % of redundant erase */ diff --git a/include/libflashrom.h b/include/libflashrom.h index e87776b..f1febc9 100644 --- a/include/libflashrom.h +++ b/include/libflashrom.h @@ -75,14 +75,28 @@ 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); + +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_v1 instead"))); + +typedef void(flashrom_progress_callback_v1)(enum flashrom_progress_stage stage, + size_t current, + size_t total, + void* user_data); + /** * @brief Set the progress callback function. * @@ -90,12 +104,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_v1 Pointer to the new progress callback function. + * @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_v1(struct flashrom_flashctx *const flashctx, + flashrom_progress_callback_v1 *progress_callback, + void* user_data); /** @} */ /* end flashrom-general */ diff --git a/libflashrom.c b/libflashrom.c index 78e5c9b..3120636 100644 --- a/libflashrom.c +++ b/libflashrom.c @@ -64,10 +64,12 @@ 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_v1(struct flashrom_flashctx *flashctx, + flashrom_progress_callback_v1 *progress_callback, + void* user_data) { 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) @@ -96,11 +98,12 @@ 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); + flashctx->progress_callback(stage, stage_progress->current, stage_progress->total, + flashctx->progress_state.user_data); } const char *flashrom_version_info(void) diff --git a/libflashrom.map b/libflashrom.map index e1cdfa6..cebdd52 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_v1; flashrom_shutdown; flashrom_supported_boards; flashrom_supported_chipsets; diff --git a/tests/chip.c b/tests/chip.c index 25bb8db..1d3b853 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_v1(&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_v1(&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_v1(&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_v1(&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..ab8ce95 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_v1(&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_v1(&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: newchange Gerrit-Project: flashrom Gerrit-Branch: main Gerrit-Change-Id: Ia8cc0461c449b7e65888a64cdc594c55b81eae7a Gerrit-Change-Number: 86031 Gerrit-PatchSet: 1 Gerrit-Owner: Anastasia Klimchuk <aklm(a)chromium.org>

1 0

[M] Change in flashrom[main]: doc: Add document for using flashrom with CH341A/B
by Peter Marheine (Code Review) 17 Jan '25

17 Jan '25

Attention is currently required from: Anastasia Klimchuk. Peter Marheine has posted comments on this change by Anastasia Klimchuk. ( https://review.coreboot.org/c/flashrom/+/86019?usp=email ) Change subject: doc: Add document for using flashrom with CH341A/B ...................................................................... Patch Set 1: Code-Review+2 -- To view, visit https://review.coreboot.org/c/flashrom/+/86019?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: Id6848329d88146fc8a005437a76ec52bec986259 Gerrit-Change-Number: 86019 Gerrit-PatchSet: 1 Gerrit-Owner: 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-Comment-Date: Thu, 16 Jan 2025 23:09:54 +0000 Gerrit-HasComments: No Gerrit-Has-Labels: Yes

1 0

2025

2024

2023

2022

2021

2020

2019

2018

2017

flashrom-gerrit