Skip to content

Commit

Permalink
up_copy_section: Improve function description
Browse files Browse the repository at this point in the history
Add "Input Parameters" section to already existing definitions
and declarations of `up_copy_section` function.
  • Loading branch information
tmedicci authored and xiaoxiang781216 committed Jul 30, 2024
1 parent 016bc47 commit c99c3ce
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 3 deletions.
9 changes: 8 additions & 1 deletion arch/xtensa/src/esp32s3/esp32s3_textheap.c
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,14 @@ IRAM_ATTR void up_textheap_data_sync(void)
* Name: up_copy_section
*
* Description:
* Copy section from general temporary buffer(src) to special addr(dest).
* This function copies a section from a general temporary buffer (src) to
* a specific address (dest). This is typically used in architectures that
* require specific handling of memory sections.
*
* Input Parameters:
* dest - A pointer to the destination where the data needs to be copied.
* src - A pointer to the source from where the data needs to be copied.
* n - The number of bytes to be copied from src to dest.
*
* Returned Value:
* Zero (OK) on success; a negated errno value on failure.
Expand Down
10 changes: 8 additions & 2 deletions include/nuttx/arch.h
Original file line number Diff line number Diff line change
Expand Up @@ -885,13 +885,19 @@ bool up_dataheap_heapmember(FAR void *p);
* Name: up_copy_section
*
* Description:
* Copy section from general temporary buffer(src) to special addr(dest).
* This function copies a section from a general temporary buffer (src) to
* a specific address (dest). This is typically used in architectures that
* require specific handling of memory sections.
*
* Input Parameters:
* dest - A pointer to the destination where the data needs to be copied.
* src - A pointer to the source from where the data needs to be copied.
* n - The number of bytes to be copied from src to dest.
*
* Returned Value:
* Zero (OK) on success; a negated errno value on failure.
*
****************************************************************************/

#if defined(CONFIG_ARCH_USE_COPY_SECTION)
int up_copy_section(FAR void *dest, FAR const void *src, size_t n);
#endif
Expand Down

0 comments on commit c99c3ce

Please sign in to comment.