tinyusb/tinyusb/osal/osal.h

/**************************************************************************/
/*!
    @file     osal.h
    @author   hathach (tinyusb.org)

    @section LICENSE

    Software License Agreement (BSD License)

    Copyright (c) 2013, hathach (tinyusb.org)
    All rights reserved.

    Redistribution and use in source and binary forms, with or without
    modification, are permitted provided that the following conditions are met:
    1. Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.
    2. Redistributions in binary form must reproduce the above copyright
    notice, this list of conditions and the following disclaimer in the
    documentation and/or other materials provided with the distribution.
    3. Neither the name of the copyright holders nor the
    names of its contributors may be used to endorse or promote products
    derived from this software without specific prior written permission.

    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY
    EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
    WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
    DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY
    DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
    INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
    LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION HOWEVER CAUSED AND
    ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
    INCLUDING NEGLIGENCE OR OTHERWISE ARISING IN ANY WAY OUT OF THE USE OF THIS
    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

    This file is part of the tinyusb stack.
*/
/**************************************************************************/

#ifndef _TUSB_OSAL_H_
#define _TUSB_OSAL_H_

/** \ingroup group_configuration
 *  \defgroup TUSB_OS RTOS Integration Selection
 * \brief TUSB_CFG_OS must be defined to one of these
 *  @{ */
#define TUSB_OS_NONE       1 ///< No RTOS is used
#define TUSB_OS_FREERTOS   2 ///< FreeRTOS is used
#define TUSB_OS_CMSIS_RTX  3 ///< CMSIS RTX is used
#define TUSB_OS_UCOS3      4 ///< MicroC OS III is used (not supported yet)
/** @} */


/** \defgroup group_osal OS Abstraction Layer (OSAL)
 *  @{ */

#ifdef __cplusplus
 extern "C" {
#endif

#include "tusb_option.h"

#ifndef _TEST_

#if TUSB_CFG_OS == TUSB_OS_NONE
  #include "osal_none.h"

#else
   #if TUSB_CFG_OS == TUSB_OS_FREERTOS
    #include "osal_freeRTOS.h"
  #elif TUSB_CFG_OS == TUSB_OS_CMSIS_RTX
    #include "osal_cmsis_rtx.h"
  #else
    #error TUSB_CFG_OS is not defined or OS is not supported yet
  #endif

  #define OSAL_VAR
  #define OSAL_TASK_LOOP_BEGIN \
    while(1) {

  #define OSAL_TASK_LOOP_END \
    }

  //------------- Sub Task -------------//
  #define OSAL_SUBTASK_BEGIN // TODO refractor move
  #define OSAL_SUBTASK_END \
    return TUSB_ERROR_NONE;

  #define SUBTASK_EXIT(error)   return error;

  #define OSAL_SUBTASK_INVOKED_AND_WAIT(subtask, status) \
    status = subtask

  //------------- Sub Task Assert -------------//
  #define SUBTASK_ASSERT_STATUS(sts) ASSERT_STATUS(sts)
  #define SUBTASK_ASSERT(condition)  ASSERT(condition, TUSB_ERROR_OSAL_TASK_FAILED)

  #define _SUBTASK_ASSERT_ERROR_HANDLER(error, func_call)\
      func_call; return error

  #define SUBTASK_ASSERT_STATUS_WITH_HANDLER(sts, func_call) \
      ASSERT_DEFINE_WITH_HANDLER(_SUBTASK_ASSERT_ERROR_HANDLER, func_call, tusb_error_t status = (tusb_error_t)(sts),\
                                 TUSB_ERROR_NONE == status, status, "%s", TUSB_ErrorStr[status])

  #define SUBTASK_ASSERT_WITH_HANDLER(condition, func_call) \
      ASSERT_DEFINE_WITH_HANDLER(_SUBTASK_ASSERT_ERROR_HANDLER, func_call, ,\
                                 condition, TUSB_ERROR_OSAL_TASK_FAILED, "%s", "evaluated to false")
#endif

//------------- OSAL API for cmock -------------//
#else

#define OSAL_VAR
#include "osal_common.h"

//------------- Tick -------------//
uint32_t osal_tick_get(void);

//--------------------------------------------------------------------+
// TASK API
//--------------------------------------------------------------------+
typedef uint32_t osal_task_t;
tusb_error_t osal_task_create(osal_task_t *task);

#define OSAL_TASK_DEF(code, stack_depth, prio) \
    osal_task_t variable

#define OSAL_TASK_REF(name) (&name)

#define OSAL_TASK_FUNCTION(task_name) \
    void task_name

void osal_task_delay(uint32_t msec);

#define OSAL_TASK_LOOP_BEGIN
#define OSAL_TASK_LOOP_END

#define SUBTASK_EXIT(error)   return error;

//------------- Sub Task -------------//
#define OSAL_SUBTASK_INVOKED_AND_WAIT(subtask, status) \
  status = subtask

#define OSAL_SUBTASK_BEGIN
#define OSAL_SUBTASK_END \
  return TUSB_ERROR_NONE;

//------------- Sub Task Assert -------------//
#define _SUBTASK_ASSERT_ERROR_HANDLER(error, func_call)\
    func_call; return error

#define SUBTASK_ASSERT_STATUS(sts) ASSERT_STATUS(sts)

#define SUBTASK_ASSERT_STATUS_WITH_HANDLER(sts, func_call) \
    ASSERT_DEFINE_WITH_HANDLER(_SUBTASK_ASSERT_ERROR_HANDLER, func_call, tusb_error_t status = (tusb_error_t)(sts),\
                               TUSB_ERROR_NONE == status, status, "%s", TUSB_ErrorStr[status])

#define SUBTASK_ASSERT(condition)  ASSERT(condition, TUSB_ERROR_OSAL_TASK_FAILED)

#define SUBTASK_ASSERT_WITH_HANDLER(condition, func_call) \
    ASSERT_DEFINE_WITH_HANDLER(_SUBTASK_ASSERT_ERROR_HANDLER, func_call, ,\
                               condition, TUSB_ERROR_OSAL_TASK_FAILED, "%s", "evaluated to false")


//--------------------------------------------------------------------+
// Semaphore API
//--------------------------------------------------------------------+
typedef volatile uint8_t osal_semaphore_t;
typedef osal_semaphore_t * osal_semaphore_handle_t;

#define OSAL_SEM_DEF(name)\
  osal_semaphore_t name

#define OSAL_SEM_REF(name)\
  &name

osal_semaphore_handle_t osal_semaphore_create(osal_semaphore_t * p_sem);
void osal_semaphore_wait(osal_semaphore_handle_t sem_hdl, uint32_t msec, tusb_error_t *p_error);
tusb_error_t osal_semaphore_post(osal_semaphore_handle_t sem_hdl);
void osal_semaphore_reset(osal_semaphore_handle_t sem_hdl);

//--------------------------------------------------------------------+
// MUTEX API (priority inheritance)
//--------------------------------------------------------------------+
#define OSAL_MUTEX_DEF(name)\
  osal_mutex_t name

#define OSAL_MUTEX_REF(name)\
  &name

typedef osal_semaphore_t        osal_mutex_t;
typedef osal_semaphore_handle_t osal_mutex_handle_t;

osal_mutex_handle_t osal_mutex_create(osal_mutex_t * p_mutex);
void osal_mutex_wait(osal_mutex_handle_t mutex_hdl, uint32_t msec, tusb_error_t *p_error);
tusb_error_t osal_mutex_release(osal_mutex_handle_t mutex_hdl);
void osal_mutex_reset(osal_mutex_handle_t mutex_hdl);
//--------------------------------------------------------------------+
// QUEUE API
//--------------------------------------------------------------------+
typedef struct{
           uint32_t * const buffer ; ///< buffer pointer
           uint8_t const depth     ; ///< buffer size
  volatile uint8_t count           ; ///< bytes in fifo
  volatile uint8_t wr_idx          ; ///< write pointer
  volatile uint8_t rd_idx          ; ///< read pointer
} osal_queue_t;

typedef osal_queue_t * osal_queue_handle_t;

#define OSAL_QUEUE_DEF(name, queue_depth, type) \
  osal_queue_t name

#define OSAL_QUEUE_REF(name)  (&name)

osal_queue_handle_t  osal_queue_create  (osal_queue_t *p_queue);
void                 osal_queue_receive (osal_queue_handle_t const queue_hdl, void *p_data, uint32_t msec, tusb_error_t *p_error);
tusb_error_t         osal_queue_send    (osal_queue_handle_t const queue_hdl, const void * data);
void osal_queue_flush(osal_queue_handle_t const queue_hdl);

//--------------------------------------------------------------------+
// TICK API
//--------------------------------------------------------------------+
uint32_t osal_tick_get(void);
#endif

#ifdef __cplusplus
 }
#endif

/** @} */

#endif /* _TUSB_OSAL_H_ */