Skip to content

Commit 80fc3ce

Browse files
committed
Fix docs typos, add \see, and rename brief
1 parent 639e0c4 commit 80fc3ce

File tree

1 file changed

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

1 file changed

+4
-3
lines changed

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

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1046,11 +1046,12 @@ static inline int rom_get_last_boot_type(void) {
10461046
*/
10471047
int rom_add_flash_runtime_partition(uint32_t start_offset, uint32_t size, uint32_t permissions);
10481048

1049-
/*! \brief Pick A/B partition for a separate partition
1049+
/*! \brief Pick A/B partition with TBYB guards
10501050
* \ingroup pico_bootrom
10511051
*
10521052
* This will call `rom_pick_ab_partition` with the current `flash_update_boot_window_base`, while performing extra checks to prevent disrupting a main image TBYB.
10531053
* It requires the same minimum workarea size as `rom_pick_ab_partition`.
1054+
* \see rom_pick_ab_partition()
10541055
*
10551056
* For example, if an `explicit_buy` is pending then calling `pick_ab_partition` would normally clear the saved `flash_erase_addr` so the required erase would not
10561057
* occur when `explicit_buy` is called - this function saves and restores that address to prevent this issue, and returns `BOOTROM_ERROR_NOT_PERMITTED` if the
@@ -1061,8 +1062,8 @@ int rom_add_flash_runtime_partition(uint32_t start_offset, uint32_t size, uint32
10611062
*
10621063
* \param workarea_base base address of work area
10631064
* \param workarea_size size of work area
1064-
* @param partition_a_num the A partition of the pair
1065-
* @return >= 0 the partition number picked
1065+
* \param partition_a_num the A partition of the pair
1066+
* \return >= 0 the partition number picked
10661067
* BOOTROM_ERROR_NOT_PERMITTED if not possible to do an update correctly, eg if both main image and data image are TBYB
10671068
* BOOTROM_ERROR_NOT_FOUND if the chosen partition failed verification
10681069
*/

0 commit comments

Comments
 (0)