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 --- .../html/group__CMSIS__RTOS__Definitions.html | 297 +++++++++++++++++++++ 1 file changed, 297 insertions(+) create mode 100644 docs/RTOS2/html/group__CMSIS__RTOS__Definitions.html (limited to 'docs/RTOS2/html/group__CMSIS__RTOS__Definitions.html') diff --git a/docs/RTOS2/html/group__CMSIS__RTOS__Definitions.html b/docs/RTOS2/html/group__CMSIS__RTOS__Definitions.html new file mode 100644 index 0000000..6ad3530 --- /dev/null +++ b/docs/RTOS2/html/group__CMSIS__RTOS__Definitions.html @@ -0,0 +1,297 @@ + + + + + +Definitions +CMSIS-RTOS2: Definitions + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
CMSIS-RTOS2 +  Version 2.1.3 +
+
Real-Time Operating System: API and RTX Reference Implementation
+
+
+ +
+
    + +
+
+ + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+Content | +Macros | +Enumerations
+
+
Definitions
CMSIS-RTOS API v2
+
+
+ +

Constants and enumerations used by many CMSIS-RTOS functions. +More...

+ + + + + +

+Content

 Flags Functions Error Codes
 Constants used by Thread Flags and Event Flags to return error codes.
 
+ + + + + + + + + + + + + +

+Macros

#define osWaitForever   0xFFFFFFFFU
 Wait forever timeout value. More...
 
#define osFlagsWaitAny   0x00000000U
 Wait for any flag (default). More...
 
#define osFlagsWaitAll   0x00000001U
 Wait for all flags. More...
 
#define osFlagsNoClear   0x00000002U
 Do not clear flags which have been specified to wait for. More...
 
+ + + + +

+Enumerations

enum  osStatus_t {
+  osOK = 0, +
+  osError = -1, +
+  osErrorTimeout = -2, +
+  osErrorResource = -3, +
+  osErrorParameter = -4, +
+  osErrorNoMemory = -5, +
+  osErrorISR = -6, +
+  osStatusReserved = 0x7FFFFFFF +
+ }
 Status code values returned by CMSIS-RTOS functions. More...
 
+

Description

+

The following constants and enumerations are used by many CMSIS-RTOS function calls.

+

Macro Definition Documentation

+ +
+
+ + + + +
#define osWaitForever   0xFFFFFFFFU
+
+

A special Timeout Value that informs the RTOS to wait infinite until a resource becomes available. It applies to the following functions:

+ + +
+
+ +
+
+ + + + +
#define osFlagsWaitAny   0x00000000U
+
+

Reference:

+ + +
+
+ +
+
+ + + + +
#define osFlagsWaitAll   0x00000001U
+
+

Reference:

+ + +
+
+ +
+
+ + + + +
#define osFlagsNoClear   0x00000002U
+
+

Reference:

+ + +
+
+

Enumeration Type Documentation

+ +
+
+ + + + +
enum osStatus_t
+
+

The osStatus_t enumeration defines the event status and error codes that are returned by many CMSIS-RTOS functions.

+ + + + + + + + + +
Enumerator
osOK  +

Operation completed successfully.

+
osError  +

Unspecified RTOS error: run-time error but no other error message fits.

+
osErrorTimeout  +

Operation not completed within the timeout period.

+
osErrorResource  +

Resource not available.

+
osErrorParameter  +

Parameter error.

+
osErrorNoMemory  +

System is out of memory: it was impossible to allocate or reserve memory for the operation.

+
osErrorISR  +

Not allowed in ISR context: the function cannot be called from interrupt service routines.

+
osStatusReserved  +

Prevents enum down-size compiler optimization.

+
+ +
+
+
+
+ + + + -- cgit