cyabs_rtos_impl.h

/***********************************************************************************************//**
 * \file cyabs_rtos_impl.h
 *
 * \brief
 * Template file for internal definitions for RTOS abstraction layer.
 * Replace all TODO items with the proper values for the RTOS that is
 * being wrapped.
 *
 ***************************************************************************************************
 * \copyright
 * Copyright 2019-2021 Cypress Semiconductor Corporation (an Infineon company) or
 * an affiliate of Cypress Semiconductor Corporation
 *
 * SPDX-License-Identifier: Apache-2.0
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * 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.
 **************************************************************************************************/

#pragma once

/*
 * Exclude template files except for documentation purposes.
 * This should be removed when using the template to support a new RTOS.
 */
#if defined(DOXYGEN)

// #include "TODO: RTOS HEADER"
#include "publisher_task.h"
#include "mqtt_task.h"
#include "subscriber_task.h"

#include "FreeRTOS.h"
#include "stdbool.h"
#include "cyhal.h"


#ifdef __cplusplus
extern "C"
{
#endif

/**
 * \addtogroup group_abstraction_rtos_port RTOS Specific Types and Defines
 * \ingroup group_abstraction_rtos_common
 * \{
 * 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.
 */

/******************************************************
*                 Constants
******************************************************/
// TODO: Replace these with proper values for the target RTOS
#define CY_RTOS_MIN_STACK_SIZE      300                     /**< Minimum stack size */
#define CY_RTOS_ALIGNMENT           0x00000008UL   /**< Minimum alignment for RTOS objects */
#define CY_RTOS_ALIGNMENT_MASK      0x00000007UL            /**< Checks for 8-bit alignment */


/******************************************************
*                 Type Definitions
******************************************************/

// TODO: Replace all priority values with values specific to the RTOS
/** 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
 */
typedef enum
{
    CY_RTOS_PRIORITY_MIN         = 0,   /**< Minumum allowable Thread priority */
    CY_RTOS_PRIORITY_LOW         = 1,   /**< A low priority Thread */
    CY_RTOS_PRIORITY_BELOWNORMAL = 2,   /**< A slightly below normal Thread priority */
    CY_RTOS_PRIORITY_NORMAL      = 3,   /**< The normal Thread priority */
    CY_RTOS_PRIORITY_ABOVENORMAL = 4,   /**< A slightly elevated Thread priority */
    CY_RTOS_PRIORITY_HIGH        = 5,   /**< A high priority Thread */
    CY_RTOS_PRIORITY_REALTIME    = 6,   /**< Realtime Thread priority */
    CY_RTOS_PRIORITY_MAX         = 7    /**< Maximum allowable Thread priority */
} cy_thread_priority_t;


typedef struct
{
    SemaphoreHandle_t mutex_handle;
    bool              is_recursive;
} cy_mutex_t;

typedef QueueHandle_t      cy_queue_t;
typedef SemaphoreHandle_t  cy_semaphore_t;
typedef TaskHandle_t       cy_thread_t;
typedef EventGroupHandle_t cy_event_t;
typedef TimerHandle_t      cy_timer_t;
typedef uint32_t           cy_timer_callback_arg_t;
typedef void*              cy_thread_arg_t;
typedef uint32_t           cy_time_t;
typedef BaseType_t         cy_rtos_error_t;


/** \} group_abstraction_rtos_port */

#ifdef __cplusplus
} // extern "C"
#endif

#endif // defined(DOXYGEN)