From c99c3ceec280573750259704f015efeab14dcfd8 Mon Sep 17 00:00:00 2001 From: Tiago Medicci Date: Mon, 29 Jul 2024 09:27:29 -0300 Subject: [PATCH] up_copy_section: Improve function description Add "Input Parameters" section to already existing definitions and declarations of `up_copy_section` function. --- arch/xtensa/src/esp32s3/esp32s3_textheap.c | 9 ++++++++- include/nuttx/arch.h | 10 ++++++++-- 2 files changed, 16 insertions(+), 3 deletions(-) diff --git a/arch/xtensa/src/esp32s3/esp32s3_textheap.c b/arch/xtensa/src/esp32s3/esp32s3_textheap.c index 8eaa1ed42d..d93717325b 100644 --- a/arch/xtensa/src/esp32s3/esp32s3_textheap.c +++ b/arch/xtensa/src/esp32s3/esp32s3_textheap.c @@ -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. diff --git a/include/nuttx/arch.h b/include/nuttx/arch.h index f100a8a148..4c619b399f 100644 --- a/include/nuttx/arch.h +++ b/include/nuttx/arch.h @@ -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