Skip to content

Commit f4e4af0

Browse files
committed
Improve rom_pick_ab_update_partition docs
1 parent dfc26a0 commit f4e4af0

File tree

1 file changed

+3
-0
lines changed
  • src/rp2_common/pico_bootrom/include/pico

1 file changed

+3
-0
lines changed

src/rp2_common/pico_bootrom/include/pico/bootrom.h

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1101,6 +1101,9 @@ int rom_add_flash_runtime_partition(uint32_t start_offset, uint32_t size, uint32
11011101
* a main image TBYB boot. It requires the same minimum workarea size as `rom_pick_ab_partition`.
11021102
* \see rom_pick_ab_partition()
11031103
*
1104+
* This should be used instead of `rom_pick_ab_partition` when performing a Flash Update Boot before calling `explicit_buy`, and can still be used without
1105+
* issue when a Flash Update Boot is not in progress.
1106+
*
11041107
* For example, if an `explicit_buy` is pending then calling `pick_ab_partition` would normally clear the saved flash erase address for the version downgrade,
11051108
* so the required erase of the other partition would not occur when `explicit_buy` is called - this function saves and restores that address to prevent this
11061109
* issue, and returns `BOOTROM_ERROR_NOT_PERMITTED` if the partition chosen by `pick_ab_partition` also requires a flash erase version downgrade (as you can't

0 commit comments

Comments
 (0)