os_port_freertos.h

00001 /**
00002  * @file os_port_freertos.h
00003  * @brief RTOS abstraction layer (FreeRTOS)
00004  *
00005  * @section License
00006  *
00007  * Copyright (C) 2010-2017 Oryx Embedded SARL. All rights reserved.
00008  *
00009  * This program is free software; you can redistribute it and/or
00010  * modify it under the terms of the GNU General Public License
00011  * as published by the Free Software Foundation; either version 2
00012  * of the License, or (at your option) any later version.
00013  *
00014  * This program is distributed in the hope that it will be useful,
00015  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00016  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00017  * GNU General Public License for more details.
00018  *
00019  * You should have received a copy of the GNU General Public License
00020  * along with this program; if not, write to the Free Software Foundation,
00021  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
00022  *
00023  * @author Oryx Embedded SARL (www.oryx-embedded.com)
00024  * @version 1.7.6
00025  **/
00026 
00027 #ifndef _OS_PORT_FREERTOS_H
00028 #define _OS_PORT_FREERTOS_H
00029 
00030 //Dependencies
00031 #include "FreeRTOS.h"
00032 #include "task.h"
00033 #include "semphr.h"
00034 
00035 //Task priority (normal)
00036 #ifndef OS_TASK_PRIORITY_NORMAL
00037    #define OS_TASK_PRIORITY_NORMAL (tskIDLE_PRIORITY + 1)
00038 #endif
00039 
00040 //Task priority (high)
00041 #ifndef OS_TASK_PRIORITY_HIGH
00042    #define OS_TASK_PRIORITY_HIGH (tskIDLE_PRIORITY + 2)
00043 #endif
00044 
00045 //Milliseconds to system ticks
00046 #ifndef OS_MS_TO_SYSTICKS
00047    #define OS_MS_TO_SYSTICKS(n) (n)
00048 #endif
00049 
00050 //System ticks to milliseconds
00051 #ifndef OS_SYSTICKS_TO_MS
00052    #define OS_SYSTICKS_TO_MS(n) (n)
00053 #endif
00054 
00055 //Enter interrupt service routine
00056 #if defined(portENTER_SWITCHING_ISR)
00057    #define osEnterIsr() portENTER_SWITCHING_ISR()
00058 #else
00059    #define osEnterIsr()
00060 #endif
00061 
00062 //Leave interrupt service routine
00063 #if defined(portEXIT_SWITCHING_ISR)
00064    #define osExitIsr(flag) portEXIT_SWITCHING_ISR()
00065 #elif defined(portEND_SWITCHING_ISR)
00066    #define osExitIsr(flag) portEND_SWITCHING_ISR(flag)
00067 #elif defined(portYIELD_FROM_ISR)
00068    #define osExitIsr(flag) portYIELD_FROM_ISR(flag)
00069 #else
00070    #define osExitIsr(flag)
00071 #endif
00072 
00073 
00074 /**
00075  * @brief Task object
00076  **/
00077 
00078 //typedef void OsTask;
00079 #define OsTask void
00080 
00081 
00082 /**
00083  * @brief Event object
00084  **/
00085 
00086 typedef struct
00087 {
00088    xSemaphoreHandle handle;
00089 } OsEvent;
00090 
00091 
00092 /**
00093  * @brief Semaphore object
00094  **/
00095 
00096 typedef struct
00097 {
00098    xSemaphoreHandle handle;
00099 } OsSemaphore;
00100 
00101 
00102 /**
00103  * @brief Mutex object
00104  **/
00105 
00106 typedef struct
00107 {
00108    xSemaphoreHandle handle;
00109 } OsMutex;
00110 
00111 
00112 /**
00113  * @brief Task routine
00114  **/
00115 
00116 typedef void (*OsTaskCode)(void *params);
00117 
00118 
00119 //Kernel management
00120 void osInitKernel(void);
00121 void osStartKernel(void);
00122 
00123 //Task management
00124 OsTask *osCreateTask(const char_t *name, OsTaskCode taskCode,
00125    void *params, size_t stackSize, int_t priority);
00126 
00127 void osDeleteTask(OsTask *task);
00128 void osDelayTask(systime_t delay);
00129 void osSwitchTask(void);
00130 void osSuspendAllTasks(void);
00131 void osResumeAllTasks(void);
00132 
00133 //Event management
00134 bool_t osCreateEvent(OsEvent *event);
00135 void osDeleteEvent(OsEvent *event);
00136 void osSetEvent(OsEvent *event);
00137 void osResetEvent(OsEvent *event);
00138 bool_t osWaitForEvent(OsEvent *event, systime_t timeout);
00139 bool_t osSetEventFromIsr(OsEvent *event);
00140 
00141 //Semaphore management
00142 bool_t osCreateSemaphore(OsSemaphore *semaphore, uint_t count);
00143 void osDeleteSemaphore(OsSemaphore *semaphore);
00144 bool_t osWaitForSemaphore(OsSemaphore *semaphore, systime_t timeout);
00145 void osReleaseSemaphore(OsSemaphore *semaphore);
00146 
00147 //Mutex management
00148 bool_t osCreateMutex(OsMutex *mutex);
00149 void osDeleteMutex(OsMutex *mutex);
00150 void osAcquireMutex(OsMutex *mutex);
00151 void osReleaseMutex(OsMutex *mutex);
00152 
00153 //System time
00154 systime_t osGetSystemTime(void);
00155 
00156 //Memory management
00157 void *osAllocMem(size_t size);
00158 void osFreeMem(void *p);
00159 
00160 #endif
00161