RTOS Specific Types, Defines and Statuses

General Description

The following defines, types and return statuses have values that are specific to each RTOS port.

The define values are specific to each RTOS. The types are simple aliases that wrap RTOS specifc types. Code cannot assume anything about the values or internals of any types.

Due to the differences in RTOSes, the return statuses are not the same across all RTOSes. We recomend to control only "CY_RSLT_SUCCESS" status. And only if status not "CY_RSLT_SUCCESS" use "cy_rtos_last_error()" to get the last error from the RTOS.

Macros
#define	CY_RTOS_MIN_STACK_SIZE   300
	Minimum stack size.
#define	CY_RTOS_ALIGNMENT_MASK   0x00000007UL
	Checks for 8-bit alignment.

Typedefs
typedef void *	cy_thread_t
	Alias for the RTOS specific definition of a thread handle.
typedef void *	cy_thread_arg_t
	Alias for the RTOS specific argument passed to the entry function of a thread.
typedef void *	cy_mutex_t
	Alias for the RTOS specific definition of a mutex.
typedef void *	cy_semaphore_t
	Alias for the RTOS specific definition of a semaphore.
typedef void *	cy_event_t
	Alias for the RTOS specific definition of an event.
typedef void *	cy_queue_t
	Alias for the RTOS specific definition of a message queue.
typedef void *	cy_timer_t
	Alias for the RTOS specific definition of a timer.
typedef void *	cy_timer_callback_arg_t
	Alias for the RTOS specific argument passed to the timer callback function.
typedef void *	cy_time_t
	Alias for the RTOS specific time unit (in milliseconds)
typedef void *	cy_rtos_error_t
	Alias for the RTOS specific definition of a error status.

Enumerations
enum	cy_thread_priority_t {   CY_RTOS_PRIORITY_MIN = 0 ,   CY_RTOS_PRIORITY_LOW = 1 ,   CY_RTOS_PRIORITY_BELOWNORMAL = 2 ,   CY_RTOS_PRIORITY_NORMAL = 3 ,   CY_RTOS_PRIORITY_ABOVENORMAL = 4 ,   CY_RTOS_PRIORITY_HIGH = 5 ,   CY_RTOS_PRIORITY_REALTIME = 6 ,   CY_RTOS_PRIORITY_MAX = 7 }
	RTOS thread priority. More...

Enumeration Type Documentation

cy_thread_priority_t

enum cy_thread_priority_t

RTOS thread priority.

Note: Depending on the RTOS and interrupt options for the device, some of these priorities may end up being the same priority level in practice. Even if this happens, the relative ordering of priorities is still maintained. eg: MAX >= REALTIME >= HIGH >= ABOVENORMAL >= NORMAL >= BELOWNORMAL >= LOW >= MIN

Enumerator
CY_RTOS_PRIORITY_MIN	Minumum allowable Thread priority.
CY_RTOS_PRIORITY_LOW	A low priority Thread.
CY_RTOS_PRIORITY_BELOWNORMAL	A slightly below normal Thread priority.
CY_RTOS_PRIORITY_NORMAL	The normal Thread priority.
CY_RTOS_PRIORITY_ABOVENORMAL	A slightly elevated Thread priority.
CY_RTOS_PRIORITY_HIGH	A high priority Thread.
CY_RTOS_PRIORITY_REALTIME	Realtime Thread priority.
CY_RTOS_PRIORITY_MAX	Maximum allowable Thread priority.