Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions include/task.h
Original file line number Diff line number Diff line change
Expand Up @@ -548,6 +548,14 @@ typedef enum
* The function parameters define the memory regions and associated access
* 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
* dynamic memory allocation.
*
Expand Down Expand Up @@ -639,6 +647,14 @@ typedef enum
* xTaskCreateRestrictedStatic() therefore allows a memory protected task to be
* 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
* for each of the normal xTaskCreate() parameters (see the xTaskCreate() API
* documentation) plus an optional stack buffer and the memory region
Expand Down Expand Up @@ -728,6 +744,14 @@ typedef enum
* @param[in] pxRegions A pointer to a MemoryRegion_t structure that contains the
* 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:
* @code{c}
* // Define an array of MemoryRegion_t structures that configures an MPU region
Expand Down