From 9f95ff5b6ba01db09552b84a0ab79607060a2666 Mon Sep 17 00:00:00 2001 From: Ali Labbene Date: Wed, 11 Dec 2019 08:59:21 +0100 Subject: Official ARM version: v5.4.0 Add CMSIS V5.4.0, please refer to index.html available under \docs folder. Note: content of \CMSIS\Core\Include has been copied under \Include to keep the same structure used in existing projects, and thus avoid projects mass update Note: the following components have been removed from ARM original delivery (as not used in ST packages) - CMSIS_EW2018.pdf - .gitattributes - .gitignore - \Device - \CMSIS - \CoreValidation - \DAP - \Documentation - \DoxyGen - \Driver - \Pack - \RTOS\CMSIS_RTOS_Tutorial.pdf - \RTOS\RTX - \RTOS\Template - \RTOS2\RTX - \Utilities - All ARM/GCC projects files are deleted from \DSP, \RTOS and \RTOS2 Change-Id: Ia026c3f0f0d016627a4fb5a9032852c33d24b4d3 --- docs/RTOS2/html/group__rtx__evr__memory.html | 447 +++++++++++++++++++++++++++ 1 file changed, 447 insertions(+) create mode 100644 docs/RTOS2/html/group__rtx__evr__memory.html (limited to 'docs/RTOS2/html/group__rtx__evr__memory.html') diff --git a/docs/RTOS2/html/group__rtx__evr__memory.html b/docs/RTOS2/html/group__rtx__evr__memory.html new file mode 100644 index 0000000..d71d791 --- /dev/null +++ b/docs/RTOS2/html/group__rtx__evr__memory.html @@ -0,0 +1,447 @@ + + + + + +Memory Functions +CMSIS-RTOS2: Memory Functions + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
CMSIS-RTOS2 +  Version 2.1.3 +
+
Real-Time Operating System: API and RTX Reference Implementation
+
+
+ +
+
    + +
+
+ + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+Functions
+
+
Memory Functions
Event functions
+
+
+ +

Events generated memory functions. +More...

+ + + + + + + + + + + + + + + + + + + + +

+Functions

void EvrRtxMemoryInit (void *mem, uint32_t size, uint32_t result)
 Event on memory initialization (Op) More...
 
void EvrRtxMemoryAlloc (void *mem, uint32_t size, uint32_t type, void *block)
 Event on memory allocate (Op) More...
 
void EvrRtxMemoryFree (void *mem, void *block, uint32_t result)
 Event on memory free (Op) More...
 
void EvrRtxMemoryBlockInit (osRtxMpInfo_t *mp_info, uint32_t block_count, uint32_t block_size, void *block_mem)
 Event on memory block initialization (Op) More...
 
void EvrRtxMemoryBlockAlloc (osRtxMpInfo_t *mp_info, void *block)
 Event on memory block alloc (Op) More...
 
void EvrRtxMemoryBlockFree (osRtxMpInfo_t *mp_info, void *block, int32_t status)
 Event on memory block free (Op) More...
 
+

Description

+

Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void EvrRtxMemoryInit (void * mem,
uint32_t size,
uint32_t result 
)
+
+
Parameters
+ + + + +
[in]mempointer to memory pool.
[in]sizesize of a memory pool in bytes.
[in]resultexecution status: 1 - success, 0 - failure.
+
+
+

The event MemoryInit is generated when initialization of a variable size memory block completes.

+

Value in the Event Recorder shows:

+
    +
  • mem : memory address of memory pool.
    • +
  • size : size of a memory pool in bytes.
    • +
  • result : execution status: 1 - success, 0 - failure.
    • +
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void EvrRtxMemoryAlloc (void * mem,
uint32_t size,
uint32_t type,
void * block 
)
+
+
Parameters
+ + + + + +
[in]mempointer to memory pool.
[in]sizesize of a memory block in bytes.
[in]typememory block type: 0 - generic, 1 - control block.
[in]blockpointer to allocated memory block or NULL in case of no memory is available.
+
+
+

The event MemoryAlloc is generated when allocation of a variable size memory block completes.

+

Value in the Event Recorder shows:

+
    +
  • mem : memory address of memory pool.
    • +
  • size : size of a memory block in bytes.
    • +
  • type : memory block type: 0 - generic, 1 - control block
    • +
  • block : memory address of allocated memory block or 0 in case of no memory is available.
    • +
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void EvrRtxMemoryFree (void * mem,
void * block,
uint32_t result 
)
+
+
Parameters
+ + + + +
[in]mempointer to memory pool.
[in]blockmemory block to be returned to the memory pool.
[in]resultexecution status: 1 - success, 0 - failure.
+
+
+

The event MemoryFree is generated when deallocation of a variable size memory block completes.

+

Value in the Event Recorder shows:

+
    +
  • mem : memory address of memory pool.
    • +
  • block : memory address of block to be returned to the memory pool.
    • +
  • result : execution status: 1 - success, 0 - failure.
    • +
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void EvrRtxMemoryBlockInit (osRtxMpInfo_t * mp_info,
uint32_t block_count,
uint32_t block_size,
void * block_mem 
)
+
+
Parameters
+ + + + + +
[in]mp_infomemory pool info.
[in]block_countmaximum number of memory blocks in memory pool.
[in]block_sizesize of a memory block in bytes.
[in]block_mempointer to memory for block storage.
+
+
+

The event MemoryBlockInit is generated when initialization of a fixed size memory block completes.

+

Value in the Event Recorder shows:

+
    +
  • mp_info : memory address of memory pool info.
    • +
  • block_count : maximum number of memory blocks in memory pool.
    • +
  • block_size : size of a memory block in bytes.
    • +
  • block_mem : memory address of memory for block storage.
    • +
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
void EvrRtxMemoryBlockAlloc (osRtxMpInfo_t * mp_info,
void * block 
)
+
+
Parameters
+ + + +
[in]mp_infomemory pool info.
[in]blockaddress of the allocated memory block or NULL in case of no memory is available.
+
+
+

The event MemoryBlockAlloc is generated when allocation of a fixed size memory block completes.

+

Value in the Event Recorder shows:

+
    +
  • mp_info : memory address of memory pool info.
    • +
  • block : memory address of the allocated memory block or 0 in case of no memory is available.
    • +
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void EvrRtxMemoryBlockFree (osRtxMpInfo_t * mp_info,
void * block,
int32_t status 
)
+
+
Parameters
+ + + + +
[in]mp_infomemory pool info.
[in]blockaddress of the allocated memory block to be returned to the memory pool.
[in]statusextended execution status.
+
+
+

The event MemoryBlockFree is generated when deallocation of a fixed size memory block completes.

+

Value in the Event Recorder shows:

+
    +
  • mp_info : memory address of memory pool info.
    • +
  • block : memory address of the allocated memory block to be returned to the memory pool.
    • +
  • status : execution status osStatus_t
    • +
+ +
+
+
+
+ + + + -- cgit