SuperTinyKernel™ RTOS 1.08.x
Lightweight, high-performance, deterministic, bare-metal C++ RTOS for resource-constrained embedded systems. MIT Open Source License.
Loading...
Searching...
No Matches
cyabs_rtos.h File Reference

Defines the Infineon RTOS Interface. Provides prototypes for functions that allow Infineon libraries to use RTOS resources such as threads, mutexes & timing functions in an abstract way. The APIs are implemented in the Port Layer RTOS interface which is specific to the RTOS in use. More...

#include "cyabs_rtos_impl.h"
#include "cy_result.h"
#include <stdint.h>
#include <stdbool.h>
#include <stddef.h>
Include dependency graph for cyabs_rtos.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define cy_timer_type_periodic   (CY_TIMER_TYPE_PERIODIC)
#define cy_timer_type_once   (CY_TIMER_TYPE_ONCE)
#define CY_RTOS_NEVER_TIMEOUT   ( (uint32_t)0xffffffffUL )
#define CY_RTOS_TIMEOUT   CY_RSLT_CREATE(CY_RSLT_TYPE_ERROR, CY_RSLT_MODULE_ABSTRACTION_OS, 0)
#define CY_RTOS_NO_MEMORY   CY_RSLT_CREATE(CY_RSLT_TYPE_ERROR, CY_RSLT_MODULE_ABSTRACTION_OS, 1)
#define CY_RTOS_GENERAL_ERROR   CY_RSLT_CREATE(CY_RSLT_TYPE_ERROR, CY_RSLT_MODULE_ABSTRACTION_OS, 2)
#define CY_RTOS_BAD_PARAM   CY_RSLT_CREATE(CY_RSLT_TYPE_ERROR, CY_RSLT_MODULE_ABSTRACTION_OS, 5)
#define CY_RTOS_ALIGNMENT_ERROR   CY_RSLT_CREATE(CY_RSLT_TYPE_ERROR, CY_RSLT_MODULE_ABSTRACTION_OS, 6)
#define CY_RTOS_UNSUPPORTED   CY_RSLT_CREATE(CY_RSLT_TYPE_ERROR, CY_RSLT_MODULE_ABSTRACTION_OS, 7)
#define CY_RTOS_QUEUE_FULL   CY_RSLT_CREATE(CY_RSLT_TYPE_ERROR, CY_RSLT_MODULE_ABSTRACTION_OS, 3)
#define CY_RTOS_QUEUE_EMPTY   CY_RSLT_CREATE(CY_RSLT_TYPE_ERROR, CY_RSLT_MODULE_ABSTRACTION_OS, 4)
#define cy_rtos_create_thread(thread, entry_function, name, stack, stack_size, priority, arg)
#define cy_rtos_is_thread_running(thread, running)
#define cy_rtos_set_thread_notification(thread, in_isr)
#define cy_rtos_wait_thread_notification(timeout_ms)
#define cy_rtos_get_thread_state(thread, state)
#define cy_rtos_join_thread(thread)
#define cy_rtos_get_thread_handle(thread)
#define cy_rtos_terminate_thread(thread)
#define cy_rtos_exit_thread   cy_rtos_thread_exit
#define cy_rtos_init_mutex2(mutex, recursive)
#define cy_rtos_init_mutex(mutex)
#define cy_rtos_get_mutex(mutex, timeout_ms)
#define cy_rtos_set_mutex(mutex)
#define cy_rtos_deinit_mutex(mutex)
#define cy_rtos_init_semaphore(semaphore, maxcount, initcount)
#define cy_rtos_get_semaphore(semaphore, timeout_ms, in_isr)
#define cy_rtos_set_semaphore(semaphore, in_isr)
#define cy_rtos_get_count_semaphore(semaphore, count)
#define cy_rtos_deinit_semaphore(semaphore)
#define cy_rtos_init_event(event)
#define cy_rtos_setbits_event(event, bits, in_isr)
#define cy_rtos_clearbits_event(event, bits, in_isr)
#define cy_rtos_getbits_event(event, bits)
#define cy_rtos_waitbits_event(event, bits, clear, all, timeout_ms)
#define cy_rtos_deinit_event(event)
#define cy_rtos_init_queue(queue, length, itemsize)
#define cy_rtos_put_queue(queue, item_ptr, timeout_ms, in_isr)
#define cy_rtos_get_queue(queue, item_ptr, timeout_ms, in_isr)
#define cy_rtos_count_queue(queue, num_waiting)
#define cy_rtos_space_queue(queue, num_spaces)
#define cy_rtos_reset_queue(queue)
#define cy_rtos_deinit_queue(queue)
#define cy_rtos_init_timer(timer, type, fun, arg)
#define cy_rtos_start_timer(timer, num_ms)
#define cy_rtos_stop_timer(timer)
#define cy_rtos_is_running_timer(timer, state)
#define cy_rtos_deinit_timer(timer)
#define cy_rtos_get_time(tval)

Typedefs

typedef enum cy_thread_state cy_thread_state_t
typedef enum cy_scheduler_state cy_scheduler_state_t
typedef enum cy_timer_trigger_type cy_timer_trigger_type_t
typedef void(* cy_thread_entry_fn_t) (cy_thread_arg_t arg)
typedef void(* cy_timer_callback_t) (cy_timer_callback_arg_t arg)

Enumerations

enum  cy_thread_state {
  CY_THREAD_STATE_INACTIVE ,
  CY_THREAD_STATE_READY ,
  CY_THREAD_STATE_RUNNING ,
  CY_THREAD_STATE_BLOCKED ,
  CY_THREAD_STATE_TERMINATED ,
  CY_THREAD_STATE_UNKNOWN
}
enum  cy_scheduler_state {
  CY_SCHEDULER_STATE_NOT_STARTED ,
  CY_SCHEDULER_STATE_INACTIVE ,
  CY_SCHEDULER_STATE_LOCKED ,
  CY_SCHEDULER_STATE_READY ,
  CY_SCHEDULER_STATE_SUSPENDED ,
  CY_SCHEDULER_STATE_RUNNING ,
  CY_SCHEDULER_STATE_UNKNOWN
}
enum  cy_timer_trigger_type {
  CY_TIMER_TYPE_PERIODIC ,
  CY_TIMER_TYPE_ONCE
}

Functions

cy_rtos_error_t cy_rtos_last_error (void)
cy_rslt_t cy_rtos_thread_create (cy_thread_t *thread, cy_thread_entry_fn_t entry_function, const char *name, void *stack, uint32_t stack_size, cy_thread_priority_t priority, cy_thread_arg_t arg)
cy_rslt_t cy_rtos_thread_exit (void)
cy_rslt_t cy_rtos_thread_terminate (const cy_thread_t *thread)
cy_rslt_t cy_rtos_thread_join (cy_thread_t *thread)
cy_rslt_t cy_rtos_thread_is_running (const cy_thread_t *thread, bool *running)
cy_rslt_t cy_rtos_thread_get_state (const cy_thread_t *thread, cy_thread_state_t *state)
cy_rslt_t cy_rtos_thread_get_handle (cy_thread_t *thread)
cy_rslt_t cy_rtos_thread_wait_notification (cy_time_t timeout_ms)
cy_rslt_t cy_rtos_thread_set_notification (const cy_thread_t *thread)
cy_rslt_t cy_rtos_thread_get_name (const cy_thread_t *thread, const char **thread_name)
cy_rslt_t cy_rtos_scheduler_suspend (void)
cy_rslt_t cy_rtos_scheduler_resume (void)
cy_rslt_t cy_rtos_scheduler_get_state (cy_scheduler_state_t *state)
cy_rslt_t cy_rtos_mutex_init (cy_mutex_t *mutex, bool recursive)
cy_rslt_t cy_rtos_mutex_get (const cy_mutex_t *mutex, cy_time_t timeout_ms)
cy_rslt_t cy_rtos_mutex_set (const cy_mutex_t *mutex)
cy_rslt_t cy_rtos_mutex_deinit (cy_mutex_t *mutex)
cy_rslt_t cy_rtos_semaphore_init (cy_semaphore_t *semaphore, uint32_t maxcount, uint32_t initcount)
cy_rslt_t cy_rtos_semaphore_get (const cy_semaphore_t *semaphore, cy_time_t timeout_ms)
cy_rslt_t cy_rtos_semaphore_set (const cy_semaphore_t *semaphore)
cy_rslt_t cy_rtos_semaphore_get_count (const cy_semaphore_t *semaphore, size_t *count)
cy_rslt_t cy_rtos_semaphore_deinit (cy_semaphore_t *semaphore)
cy_rslt_t cy_rtos_event_init (cy_event_t *event)
cy_rslt_t cy_rtos_event_setbits (const cy_event_t *event, uint32_t bits)
cy_rslt_t cy_rtos_event_clearbits (const cy_event_t *event, uint32_t bits)
cy_rslt_t cy_rtos_event_getbits (const cy_event_t *event, uint32_t *bits)
cy_rslt_t cy_rtos_event_waitbits (const cy_event_t *event, uint32_t *bits, bool clear, bool all, cy_time_t timeout_ms)
cy_rslt_t cy_rtos_event_deinit (cy_event_t *event)
cy_rslt_t cy_rtos_queue_init (cy_queue_t *queue, size_t length, size_t itemsize)
cy_rslt_t cy_rtos_queue_put (const cy_queue_t *queue, const void *item_ptr, cy_time_t timeout_ms)
cy_rslt_t cy_rtos_queue_get (const cy_queue_t *queue, void *item_ptr, cy_time_t timeout_ms)
cy_rslt_t cy_rtos_queue_count (const cy_queue_t *queue, size_t *num_waiting)
cy_rslt_t cy_rtos_queue_space (const cy_queue_t *queue, size_t *num_spaces)
cy_rslt_t cy_rtos_queue_reset (const cy_queue_t *queue)
cy_rslt_t cy_rtos_queue_deinit (cy_queue_t *queue)
cy_rslt_t cy_rtos_timer_init (cy_timer_t *timer, cy_timer_trigger_type_t type, cy_timer_callback_t fun, cy_timer_callback_arg_t arg)
cy_rslt_t cy_rtos_timer_start (const cy_timer_t *timer, cy_time_t num_ms)
cy_rslt_t cy_rtos_timer_stop (const cy_timer_t *timer)
cy_rslt_t cy_rtos_timer_is_running (const cy_timer_t *timer, bool *state)
cy_rslt_t cy_rtos_timer_deinit (cy_timer_t *timer)
cy_rslt_t cy_rtos_time_get (cy_time_t *tval)
cy_rslt_t cy_rtos_delay_milliseconds (cy_time_t num_ms)

Detailed Description

Defines the Infineon RTOS Interface. Provides prototypes for functions that allow Infineon libraries to use RTOS resources such as threads, mutexes & timing functions in an abstract way. The APIs are implemented in the Port Layer RTOS interface which is specific to the RTOS in use.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Definition in file cyabs_rtos.h.

Macro Definition Documentation

◆ cy_timer_type_once

#define cy_timer_type_once   (CY_TIMER_TYPE_ONCE)
Deprecated
replaced by CY_TIMER_TYPE_ONCE

Definition at line 169 of file cyabs_rtos.h.

◆ cy_timer_type_periodic

#define cy_timer_type_periodic   (CY_TIMER_TYPE_PERIODIC)
Deprecated
replaced by CY_TIMER_TYPE_PERIODIC

Definition at line 167 of file cyabs_rtos.h.