2013-05-06 07:50:19 +02:00
|
|
|
/**************************************************************************/
|
|
|
|
/*!
|
|
|
|
@file osal_freeRTOS.h
|
|
|
|
@author hathach (tinyusb.org)
|
2013-02-03 18:03:08 +01:00
|
|
|
|
2013-05-06 07:50:19 +02:00
|
|
|
@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.
|
|
|
|
*/
|
|
|
|
/**************************************************************************/
|
2013-02-03 18:03:08 +01:00
|
|
|
|
2014-03-24 06:35:44 +01:00
|
|
|
/** \ingroup group_osal
|
2014-03-16 16:20:33 +01:00
|
|
|
* @{
|
|
|
|
* \defgroup Group_FreeRTOS FreeRTOS
|
|
|
|
* @{ */
|
2013-02-03 18:03:08 +01:00
|
|
|
|
|
|
|
#ifndef _TUSB_OSAL_FREERTOS_H_
|
|
|
|
#define _TUSB_OSAL_FREERTOS_H_
|
|
|
|
|
2013-02-04 11:13:26 +01:00
|
|
|
//------------- FreeRTOS Headers -------------//
|
2013-02-03 18:03:08 +01:00
|
|
|
#include "FreeRTOS.h"
|
2013-02-04 11:13:26 +01:00
|
|
|
#include "semphr.h"
|
|
|
|
#include "queue.h"
|
2013-04-24 12:53:43 +02:00
|
|
|
#include "task.h"
|
2013-02-03 18:03:08 +01:00
|
|
|
|
2013-02-08 06:12:10 +01:00
|
|
|
#ifdef __cplusplus
|
|
|
|
extern "C" {
|
|
|
|
#endif
|
|
|
|
|
2018-03-30 10:33:36 +02:00
|
|
|
#if 0
|
|
|
|
// Helper to determine if we are in ISR to use ISR API (only cover ARM Cortex)
|
|
|
|
// Note: Actually we don't need this since any event signal (queue send, semaphore post)
|
|
|
|
// is done in ISR, other event receive (queue receive, semaphore wait ) in in thread
|
|
|
|
static inline bool in_isr(void)
|
|
|
|
{
|
|
|
|
return (SCB->ICSR & SCB_ICSR_VECTACTIVE_Msk);
|
|
|
|
}
|
|
|
|
#endif
|
2013-02-03 18:03:08 +01:00
|
|
|
|
|
|
|
//--------------------------------------------------------------------+
|
|
|
|
// TASK API
|
|
|
|
//--------------------------------------------------------------------+
|
2018-03-01 05:28:26 +01:00
|
|
|
typedef void (*osal_func_t)(void *param);
|
|
|
|
typedef void* osal_task_t;
|
|
|
|
|
|
|
|
static inline osal_task_t osal_task_create(osal_func_t code, const char* name, uint32_t stack_size, void* param, uint32_t prio)
|
2013-04-24 12:53:43 +02:00
|
|
|
{
|
2018-03-01 05:28:26 +01:00
|
|
|
osal_task_t task_hdl;
|
2018-03-01 15:15:06 +01:00
|
|
|
xTaskCreate(code, (const char*) name, stack_size, param, prio, &task_hdl);
|
2018-03-01 05:28:26 +01:00
|
|
|
return task_hdl;
|
2013-04-24 12:53:43 +02:00
|
|
|
}
|
2013-04-23 10:35:27 +02:00
|
|
|
|
2013-04-25 11:41:00 +02:00
|
|
|
static inline void osal_task_delay(uint32_t msec)
|
|
|
|
{
|
2018-03-29 13:03:04 +02:00
|
|
|
vTaskDelay( pdMS_TO_TICKS(msec) );
|
2013-04-25 11:41:00 +02:00
|
|
|
}
|
|
|
|
|
2018-03-01 05:42:13 +01:00
|
|
|
//--------------------------------------------------------------------+
|
|
|
|
// QUEUE API
|
|
|
|
//--------------------------------------------------------------------+
|
2018-03-30 11:57:18 +02:00
|
|
|
typedef QueueHandle_t osal_queue_t;
|
2018-03-01 05:42:13 +01:00
|
|
|
|
|
|
|
static inline osal_queue_t osal_queue_create(uint32_t depth, uint32_t item_size)
|
|
|
|
{
|
|
|
|
return xQueueCreate(depth, item_size);
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline void osal_queue_receive (osal_queue_t const queue_hdl, void *p_data, uint32_t msec, tusb_error_t *p_error)
|
|
|
|
{
|
2018-03-29 13:03:04 +02:00
|
|
|
uint32_t const ticks = (msec == OSAL_TIMEOUT_WAIT_FOREVER) ? portMAX_DELAY : pdMS_TO_TICKS(msec);
|
2018-03-30 10:33:36 +02:00
|
|
|
(*p_error) = ( xQueueReceive(queue_hdl, p_data, ticks) ? TUSB_ERROR_NONE : TUSB_ERROR_OSAL_TIMEOUT);
|
2018-03-01 05:42:13 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
static inline bool osal_queue_send(osal_queue_t const queue_hdl, void const * data)
|
|
|
|
{
|
2018-03-30 10:33:36 +02:00
|
|
|
return xQueueSendToFrontFromISR(queue_hdl, data, NULL);
|
2018-03-01 05:42:13 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
static inline void osal_queue_flush(osal_queue_t const queue_hdl)
|
|
|
|
{
|
2018-03-30 11:57:18 +02:00
|
|
|
// TODO move to thread context
|
2018-03-01 16:25:24 +01:00
|
|
|
// xQueueReset(queue_hdl);
|
2018-03-01 05:42:13 +01:00
|
|
|
}
|
|
|
|
|
2013-02-03 18:03:08 +01:00
|
|
|
//--------------------------------------------------------------------+
|
|
|
|
// Semaphore API
|
|
|
|
//--------------------------------------------------------------------+
|
2018-03-30 11:57:18 +02:00
|
|
|
typedef SemaphoreHandle_t osal_semaphore_t;
|
2013-02-04 11:13:26 +01:00
|
|
|
|
2018-03-01 05:17:11 +01:00
|
|
|
static inline osal_semaphore_t osal_semaphore_create(uint32_t max, uint32_t init)
|
|
|
|
{
|
|
|
|
return xSemaphoreCreateCounting(max, init);
|
|
|
|
}
|
2013-02-04 11:13:26 +01:00
|
|
|
|
2013-04-24 12:53:43 +02:00
|
|
|
// TODO add timeout (with instant return from ISR option) for semaphore post & queue send
|
2018-03-01 05:42:13 +01:00
|
|
|
static inline bool osal_semaphore_post(osal_semaphore_t sem_hdl)
|
2013-02-04 12:05:22 +01:00
|
|
|
{
|
2018-03-30 10:33:36 +02:00
|
|
|
return xSemaphoreGiveFromISR(sem_hdl, NULL);
|
2013-02-04 12:05:22 +01:00
|
|
|
}
|
|
|
|
|
2018-03-01 05:17:11 +01:00
|
|
|
static inline void osal_semaphore_wait(osal_semaphore_t sem_hdl, uint32_t msec, tusb_error_t *p_error)
|
2013-02-04 12:05:22 +01:00
|
|
|
{
|
2018-03-29 13:03:04 +02:00
|
|
|
uint32_t const ticks = (msec == OSAL_TIMEOUT_WAIT_FOREVER) ? portMAX_DELAY : pdMS_TO_TICKS(msec);
|
2018-03-30 10:33:36 +02:00
|
|
|
(*p_error) = (xSemaphoreTake(sem_hdl, ticks) ? TUSB_ERROR_NONE : TUSB_ERROR_OSAL_TIMEOUT);
|
2013-02-04 12:05:22 +01:00
|
|
|
}
|
|
|
|
|
2018-03-30 11:23:50 +02:00
|
|
|
// TODO remove
|
2018-03-01 05:17:11 +01:00
|
|
|
static inline void osal_semaphore_reset(osal_semaphore_t const sem_hdl)
|
2013-04-24 12:53:43 +02:00
|
|
|
{
|
2018-03-30 11:23:50 +02:00
|
|
|
xSemaphoreTakeFromISR(sem_hdl, NULL);
|
2013-04-24 12:53:43 +02:00
|
|
|
}
|
|
|
|
|
2013-07-04 08:24:54 +02:00
|
|
|
//--------------------------------------------------------------------+
|
|
|
|
// MUTEX API (priority inheritance)
|
|
|
|
//--------------------------------------------------------------------+
|
2018-03-30 11:57:18 +02:00
|
|
|
typedef SemaphoreHandle_t osal_mutex_t;
|
2013-07-04 08:24:54 +02:00
|
|
|
|
2014-04-17 17:57:11 +02:00
|
|
|
#define osal_mutex_create(x) xSemaphoreCreateMutex()
|
2013-07-04 08:24:54 +02:00
|
|
|
|
2018-03-01 05:42:13 +01:00
|
|
|
static inline bool osal_mutex_release(osal_mutex_t mutex_hdl)
|
2013-07-04 08:24:54 +02:00
|
|
|
{
|
2018-03-30 10:33:36 +02:00
|
|
|
return xSemaphoreGive(mutex_hdl);
|
2013-07-04 08:24:54 +02:00
|
|
|
}
|
|
|
|
|
2018-03-01 05:17:11 +01:00
|
|
|
static inline void osal_mutex_wait(osal_mutex_t mutex_hdl, uint32_t msec, tusb_error_t *p_error)
|
2013-07-04 08:24:54 +02:00
|
|
|
{
|
2018-03-30 10:33:36 +02:00
|
|
|
uint32_t const ticks = (msec == OSAL_TIMEOUT_WAIT_FOREVER) ? portMAX_DELAY : pdMS_TO_TICKS(msec);
|
|
|
|
(*p_error) = (xSemaphoreTake(mutex_hdl, ticks) ? TUSB_ERROR_NONE : TUSB_ERROR_OSAL_TIMEOUT);
|
2013-07-04 08:24:54 +02:00
|
|
|
}
|
|
|
|
|
2013-04-24 12:53:43 +02:00
|
|
|
|
2013-02-03 18:03:08 +01:00
|
|
|
#ifdef __cplusplus
|
|
|
|
}
|
|
|
|
#endif
|
|
|
|
|
|
|
|
#endif /* _TUSB_OSAL_FREERTOS_H_ */
|
|
|
|
|
|
|
|
/** @} */
|
2014-03-16 16:20:33 +01:00
|
|
|
/** @} */
|
|
|
|
|