Skip to content

Commit

Permalink
Cleanup comments for trailer functions.
Browse files Browse the repository at this point in the history
  • Loading branch information
dgarske committed Jul 15, 2024
1 parent 7735a7a commit bc7a403
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions src/libwolfboot.c
Original file line number Diff line number Diff line change
Expand Up @@ -408,8 +408,8 @@ static int RAMFUNCTION partition_magic_write(uint8_t part, uintptr_t addr)
* Function implementation externally defined
*/
uint8_t* RAMFUNCTION get_trailer_at(uint8_t part, uint32_t at);
void RAMFUNCTION set_trailer_at(uint8_t part, uint32_t at, uint8_t val);
void RAMFUNCTION set_partition_magic(uint8_t part);
void RAMFUNCTION set_trailer_at(uint8_t part, uint32_t at, uint8_t val);
void RAMFUNCTION set_partition_magic(uint8_t part);

#elif !defined(WOLFBOOT_FIXED_PARTITIONS)
static uint8_t* RAMFUNCTION get_trailer_at(uint8_t part, uint32_t at)
Expand All @@ -434,9 +434,10 @@ static void RAMFUNCTION set_partition_magic(uint8_t part)
#else

/**
* @brief Get the trailer at a specific address in a fixed partition.
* @brief Get the trailer at a specific address
*
* This function retrieves the trailer at a specific address in a fixed partition.
* This function retrieves the trailer at a specific address in external or
* internal flash
*
* @param[in] part Partition number.
* @param[in] at Address offset.
Expand Down Expand Up @@ -487,9 +488,10 @@ static uint8_t* RAMFUNCTION get_trailer_at(uint8_t part, uint32_t at)
}

/**
* @brief Set the trailer at a specific address in an external flash.
* @brief Set the trailer at a specific address
*
* This function sets the trailer at a specific address in an external flash.
* This function sets the trailer at a specific address in external or
* internal flash.
*
* @param[in] part Partition number.
* @param[in] at Address offset.
Expand Down Expand Up @@ -524,9 +526,9 @@ static void RAMFUNCTION set_trailer_at(uint8_t part, uint32_t at, uint8_t val)
}

/**
* @brief Set the partition magic trailer in an external flash.
* @brief Set the partition magic trailer
*
* This function sets the partition magic trailer in an external flash.
* This function sets the partition magic trailer in external or internal flash.
*
* @param[in] part Partition number.
*/
Expand Down

0 comments on commit bc7a403

Please sign in to comment.