RTOS Specific Types and Defines

group group_abstraction_rtos_port

The following defines and types 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.

Defines

CY_RTOS_MIN_STACK_SIZE

Minimum stack size.

CY_RTOS_ALIGNMENT_MASK

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.

Enums

enum cy_thread_priority_t

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

Values:

enumerator CY_RTOS_PRIORITY_MIN

Minumum allowable Thread priority.

enumerator CY_RTOS_PRIORITY_LOW

A low priority Thread.

enumerator CY_RTOS_PRIORITY_BELOWNORMAL

A slightly below normal Thread priority.

enumerator CY_RTOS_PRIORITY_NORMAL

The normal Thread priority.

enumerator CY_RTOS_PRIORITY_ABOVENORMAL

A slightly elevated Thread priority.

enumerator CY_RTOS_PRIORITY_HIGH

A high priority Thread.

enumerator CY_RTOS_PRIORITY_REALTIME

Realtime Thread priority.

enumerator CY_RTOS_PRIORITY_MAX

Maximum allowable Thread priority.