# Common¶

group group_abstraction_rtos_common

General types and defines for working with the RTOS abstraction layer.

Unnamed Group

CY_RSLT_SUCCESS

Return value indicating success.

CY_RTOS_NEVER_TIMEOUT

Used with RTOS calls that require a timeout.

This implies the call will never timeout.

CY_RTOS_TIMEOUT

Requested operation did not complete in the specified time.

CY_RTOS_NO_MEMORY

The RTOS could not allocate memory for the specified operation.

CY_RTOS_GENERAL_ERROR

An error occured in the RTOS.

CY_RTOS_BAD_PARAM

A bad argument was passed into the APIs.

CY_RTOS_ALIGNMENT_ERROR

A memory alignment issue was detected.

Ensure memory provided is aligned per CY_RTOS_ALIGNMENT_MASK

Functions

cy_rtos_error_t cy_rtos_last_error()

Return the last error from the RTOS.

The functions in the RTOS abstraction layer adhere to the Cypress return results calling convention. The underlying RTOS implementations will not but rather will have their own error code conventions. This function is provided as a service to the developer, mostly for debugging, and returns the underlying RTOS error code from the last RTOS abstraction layer that returned CY_RTOS_GENERAL_ERROR.

Return

RTOS specific error code.