len0rd/FreeRTOS-Kernel
1
0
Fork 0
mirror of https://github.com/FreeRTOS/FreeRTOS-Kernel.git synced 2026-07-10 13:29:45 -04:00
Code Issues Projects Releases Packages Wiki Activity

docs: clarify MPU region parameter macros (#1445)

Browse source 
Document that MemoryRegion_t.ulParameters macros are port specific so users select the tskMPU_REGION_* or portMPU_REGION_* values that match their MPU port.

Signed-off-by: Old-Ding <ai.neo.ae86@gmail.com>
Co-authored-by: Old-Ding <ai.neo.ae86@gmail.com>
This commit is contained in:
Old-Ding 2026-07-10 08:31:36 +08:00 • committed by GitHub
parent d72263b404
commit 9db704cd3b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 24 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

24
include/task.h
View file

@ -548,6 +548,14 @@ typedef enum
* The function parameters define the memory regions and associated access * The function parameters define the memory regions and associated access
* permissions allocated to the task. * permissions allocated to the task.
* *
* The parameter macros used in MemoryRegion_t.ulParameters are port specific.
* Some ports, including the Cortex-M3/4 MPU ports, use the portMPU_REGION_*
* values shown below.
* ARMv8-M MPU ports, such as CM23, CM33, CM52, CM55, CM85 and STAR_MC3, use
* the tskMPU_REGION_* values defined in this header; the port translates them
* into MPU register settings. Check the selected port's headers before selecting
* the region parameter macros.
*
* See xTaskCreateRestrictedStatic() for a version that does not use any * See xTaskCreateRestrictedStatic() for a version that does not use any
* dynamic memory allocation. * dynamic memory allocation.
* *
@ -639,6 +647,14 @@ typedef enum
* xTaskCreateRestrictedStatic() therefore allows a memory protected task to be * xTaskCreateRestrictedStatic() therefore allows a memory protected task to be
* created without using any dynamic memory allocation. * created without using any dynamic memory allocation.
* *
* The parameter macros used in MemoryRegion_t.ulParameters are port specific.
* Some ports, including the Cortex-M3/4 MPU ports, use the portMPU_REGION_*
* values shown below.
* ARMv8-M MPU ports, such as CM23, CM33, CM52, CM55, CM85 and STAR_MC3, use
* the tskMPU_REGION_* values defined in this header; the port translates them
* into MPU register settings. Check the selected port's headers before selecting
* the region parameter macros.
*
* @param pxTaskDefinition Pointer to a structure that contains a member * @param pxTaskDefinition Pointer to a structure that contains a member
* for each of the normal xTaskCreate() parameters (see the xTaskCreate() API * for each of the normal xTaskCreate() parameters (see the xTaskCreate() API
* documentation) plus an optional stack buffer and the memory region * documentation) plus an optional stack buffer and the memory region
@ -728,6 +744,14 @@ typedef enum
* @param[in] pxRegions A pointer to a MemoryRegion_t structure that contains the * @param[in] pxRegions A pointer to a MemoryRegion_t structure that contains the
* new memory region definitions. * new memory region definitions.
* *
* The parameter macros used in MemoryRegion_t.ulParameters are port specific.
* Some ports, including the Cortex-M3/4 MPU ports, use the portMPU_REGION_*
* values shown below.
* ARMv8-M MPU ports, such as CM23, CM33, CM52, CM55, CM85 and STAR_MC3, use
* the tskMPU_REGION_* values defined in this header; the port translates them
* into MPU register settings. Check the selected port's headers before selecting
* the region parameter macros.
*
* Example usage: * Example usage:
* @code{c} * @code{c}
* // Define an array of MemoryRegion_t structures that configures an MPU region * // Define an array of MemoryRegion_t structures that configures an MPU region