Sergey Pastor / 1

Webserver+3d print

Dependents:   Nucleo

common/os_port_freertos.h@0:8918a71cdbe9, 2017-02-04 (annotated)

Committer:
Sergunb
Date:
Sat Feb 04 18:15:49 2017 +0000
Revision:
0:8918a71cdbe9
nothing else

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Sergunb 0:8918a71cdbe9 1 /**
Sergunb 0:8918a71cdbe9 2 * @file os_port_freertos.h
Sergunb 0:8918a71cdbe9 3 * @brief RTOS abstraction layer (FreeRTOS)
Sergunb 0:8918a71cdbe9 4 *
Sergunb 0:8918a71cdbe9 5 * @section License
Sergunb 0:8918a71cdbe9 6 *
Sergunb 0:8918a71cdbe9 7 * Copyright (C) 2010-2017 Oryx Embedded SARL. All rights reserved.
Sergunb 0:8918a71cdbe9 8 *
Sergunb 0:8918a71cdbe9 9 * This program is free software; you can redistribute it and/or
Sergunb 0:8918a71cdbe9 10 * modify it under the terms of the GNU General Public License
Sergunb 0:8918a71cdbe9 11 * as published by the Free Software Foundation; either version 2
Sergunb 0:8918a71cdbe9 12 * of the License, or (at your option) any later version.
Sergunb 0:8918a71cdbe9 13 *
Sergunb 0:8918a71cdbe9 14 * This program is distributed in the hope that it will be useful,
Sergunb 0:8918a71cdbe9 15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Sergunb 0:8918a71cdbe9 16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
Sergunb 0:8918a71cdbe9 17 * GNU General Public License for more details.
Sergunb 0:8918a71cdbe9 18 *
Sergunb 0:8918a71cdbe9 19 * You should have received a copy of the GNU General Public License
Sergunb 0:8918a71cdbe9 20 * along with this program; if not, write to the Free Software Foundation,
Sergunb 0:8918a71cdbe9 21 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
Sergunb 0:8918a71cdbe9 22 *
Sergunb 0:8918a71cdbe9 23 * @author Oryx Embedded SARL (www.oryx-embedded.com)
Sergunb 0:8918a71cdbe9 24 * @version 1.7.6
Sergunb 0:8918a71cdbe9 25 **/
Sergunb 0:8918a71cdbe9 26
Sergunb 0:8918a71cdbe9 27 #ifndef _OS_PORT_FREERTOS_H
Sergunb 0:8918a71cdbe9 28 #define _OS_PORT_FREERTOS_H
Sergunb 0:8918a71cdbe9 29
Sergunb 0:8918a71cdbe9 30 //Dependencies
Sergunb 0:8918a71cdbe9 31 #include "FreeRTOS.h"
Sergunb 0:8918a71cdbe9 32 #include "task.h"
Sergunb 0:8918a71cdbe9 33 #include "semphr.h"
Sergunb 0:8918a71cdbe9 34
Sergunb 0:8918a71cdbe9 35 //Task priority (normal)
Sergunb 0:8918a71cdbe9 36 #ifndef OS_TASK_PRIORITY_NORMAL
Sergunb 0:8918a71cdbe9 37 #define OS_TASK_PRIORITY_NORMAL (tskIDLE_PRIORITY + 1)
Sergunb 0:8918a71cdbe9 38 #endif
Sergunb 0:8918a71cdbe9 39
Sergunb 0:8918a71cdbe9 40 //Task priority (high)
Sergunb 0:8918a71cdbe9 41 #ifndef OS_TASK_PRIORITY_HIGH
Sergunb 0:8918a71cdbe9 42 #define OS_TASK_PRIORITY_HIGH (tskIDLE_PRIORITY + 2)
Sergunb 0:8918a71cdbe9 43 #endif
Sergunb 0:8918a71cdbe9 44
Sergunb 0:8918a71cdbe9 45 //Milliseconds to system ticks
Sergunb 0:8918a71cdbe9 46 #ifndef OS_MS_TO_SYSTICKS
Sergunb 0:8918a71cdbe9 47 #define OS_MS_TO_SYSTICKS(n) (n)
Sergunb 0:8918a71cdbe9 48 #endif
Sergunb 0:8918a71cdbe9 49
Sergunb 0:8918a71cdbe9 50 //System ticks to milliseconds
Sergunb 0:8918a71cdbe9 51 #ifndef OS_SYSTICKS_TO_MS
Sergunb 0:8918a71cdbe9 52 #define OS_SYSTICKS_TO_MS(n) (n)
Sergunb 0:8918a71cdbe9 53 #endif
Sergunb 0:8918a71cdbe9 54
Sergunb 0:8918a71cdbe9 55 //Enter interrupt service routine
Sergunb 0:8918a71cdbe9 56 #if defined(portENTER_SWITCHING_ISR)
Sergunb 0:8918a71cdbe9 57 #define osEnterIsr() portENTER_SWITCHING_ISR()
Sergunb 0:8918a71cdbe9 58 #else
Sergunb 0:8918a71cdbe9 59 #define osEnterIsr()
Sergunb 0:8918a71cdbe9 60 #endif
Sergunb 0:8918a71cdbe9 61
Sergunb 0:8918a71cdbe9 62 //Leave interrupt service routine
Sergunb 0:8918a71cdbe9 63 #if defined(portEXIT_SWITCHING_ISR)
Sergunb 0:8918a71cdbe9 64 #define osExitIsr(flag) portEXIT_SWITCHING_ISR()
Sergunb 0:8918a71cdbe9 65 #elif defined(portEND_SWITCHING_ISR)
Sergunb 0:8918a71cdbe9 66 #define osExitIsr(flag) portEND_SWITCHING_ISR(flag)
Sergunb 0:8918a71cdbe9 67 #elif defined(portYIELD_FROM_ISR)
Sergunb 0:8918a71cdbe9 68 #define osExitIsr(flag) portYIELD_FROM_ISR(flag)
Sergunb 0:8918a71cdbe9 69 #else
Sergunb 0:8918a71cdbe9 70 #define osExitIsr(flag)
Sergunb 0:8918a71cdbe9 71 #endif
Sergunb 0:8918a71cdbe9 72
Sergunb 0:8918a71cdbe9 73
Sergunb 0:8918a71cdbe9 74 /**
Sergunb 0:8918a71cdbe9 75 * @brief Task object
Sergunb 0:8918a71cdbe9 76 **/
Sergunb 0:8918a71cdbe9 77
Sergunb 0:8918a71cdbe9 78 //typedef void OsTask;
Sergunb 0:8918a71cdbe9 79 #define OsTask void
Sergunb 0:8918a71cdbe9 80
Sergunb 0:8918a71cdbe9 81
Sergunb 0:8918a71cdbe9 82 /**
Sergunb 0:8918a71cdbe9 83 * @brief Event object
Sergunb 0:8918a71cdbe9 84 **/
Sergunb 0:8918a71cdbe9 85
Sergunb 0:8918a71cdbe9 86 typedef struct
Sergunb 0:8918a71cdbe9 87 {
Sergunb 0:8918a71cdbe9 88 xSemaphoreHandle handle;
Sergunb 0:8918a71cdbe9 89 } OsEvent;
Sergunb 0:8918a71cdbe9 90
Sergunb 0:8918a71cdbe9 91
Sergunb 0:8918a71cdbe9 92 /**
Sergunb 0:8918a71cdbe9 93 * @brief Semaphore object
Sergunb 0:8918a71cdbe9 94 **/
Sergunb 0:8918a71cdbe9 95
Sergunb 0:8918a71cdbe9 96 typedef struct
Sergunb 0:8918a71cdbe9 97 {
Sergunb 0:8918a71cdbe9 98 xSemaphoreHandle handle;
Sergunb 0:8918a71cdbe9 99 } OsSemaphore;
Sergunb 0:8918a71cdbe9 100
Sergunb 0:8918a71cdbe9 101
Sergunb 0:8918a71cdbe9 102 /**
Sergunb 0:8918a71cdbe9 103 * @brief Mutex object
Sergunb 0:8918a71cdbe9 104 **/
Sergunb 0:8918a71cdbe9 105
Sergunb 0:8918a71cdbe9 106 typedef struct
Sergunb 0:8918a71cdbe9 107 {
Sergunb 0:8918a71cdbe9 108 xSemaphoreHandle handle;
Sergunb 0:8918a71cdbe9 109 } OsMutex;
Sergunb 0:8918a71cdbe9 110
Sergunb 0:8918a71cdbe9 111
Sergunb 0:8918a71cdbe9 112 /**
Sergunb 0:8918a71cdbe9 113 * @brief Task routine
Sergunb 0:8918a71cdbe9 114 **/
Sergunb 0:8918a71cdbe9 115
Sergunb 0:8918a71cdbe9 116 typedef void (*OsTaskCode)(void *params);
Sergunb 0:8918a71cdbe9 117
Sergunb 0:8918a71cdbe9 118
Sergunb 0:8918a71cdbe9 119 //Kernel management
Sergunb 0:8918a71cdbe9 120 void osInitKernel(void);
Sergunb 0:8918a71cdbe9 121 void osStartKernel(void);
Sergunb 0:8918a71cdbe9 122
Sergunb 0:8918a71cdbe9 123 //Task management
Sergunb 0:8918a71cdbe9 124 OsTask *osCreateTask(const char_t *name, OsTaskCode taskCode,
Sergunb 0:8918a71cdbe9 125 void *params, size_t stackSize, int_t priority);
Sergunb 0:8918a71cdbe9 126
Sergunb 0:8918a71cdbe9 127 void osDeleteTask(OsTask *task);
Sergunb 0:8918a71cdbe9 128 void osDelayTask(systime_t delay);
Sergunb 0:8918a71cdbe9 129 void osSwitchTask(void);
Sergunb 0:8918a71cdbe9 130 void osSuspendAllTasks(void);
Sergunb 0:8918a71cdbe9 131 void osResumeAllTasks(void);
Sergunb 0:8918a71cdbe9 132
Sergunb 0:8918a71cdbe9 133 //Event management
Sergunb 0:8918a71cdbe9 134 bool_t osCreateEvent(OsEvent *event);
Sergunb 0:8918a71cdbe9 135 void osDeleteEvent(OsEvent *event);
Sergunb 0:8918a71cdbe9 136 void osSetEvent(OsEvent *event);
Sergunb 0:8918a71cdbe9 137 void osResetEvent(OsEvent *event);
Sergunb 0:8918a71cdbe9 138 bool_t osWaitForEvent(OsEvent *event, systime_t timeout);
Sergunb 0:8918a71cdbe9 139 bool_t osSetEventFromIsr(OsEvent *event);
Sergunb 0:8918a71cdbe9 140
Sergunb 0:8918a71cdbe9 141 //Semaphore management
Sergunb 0:8918a71cdbe9 142 bool_t osCreateSemaphore(OsSemaphore *semaphore, uint_t count);
Sergunb 0:8918a71cdbe9 143 void osDeleteSemaphore(OsSemaphore *semaphore);
Sergunb 0:8918a71cdbe9 144 bool_t osWaitForSemaphore(OsSemaphore *semaphore, systime_t timeout);
Sergunb 0:8918a71cdbe9 145 void osReleaseSemaphore(OsSemaphore *semaphore);
Sergunb 0:8918a71cdbe9 146
Sergunb 0:8918a71cdbe9 147 //Mutex management
Sergunb 0:8918a71cdbe9 148 bool_t osCreateMutex(OsMutex *mutex);
Sergunb 0:8918a71cdbe9 149 void osDeleteMutex(OsMutex *mutex);
Sergunb 0:8918a71cdbe9 150 void osAcquireMutex(OsMutex *mutex);
Sergunb 0:8918a71cdbe9 151 void osReleaseMutex(OsMutex *mutex);
Sergunb 0:8918a71cdbe9 152
Sergunb 0:8918a71cdbe9 153 //System time
Sergunb 0:8918a71cdbe9 154 systime_t osGetSystemTime(void);
Sergunb 0:8918a71cdbe9 155
Sergunb 0:8918a71cdbe9 156 //Memory management
Sergunb 0:8918a71cdbe9 157 void *osAllocMem(size_t size);
Sergunb 0:8918a71cdbe9 158 void osFreeMem(void *p);
Sergunb 0:8918a71cdbe9 159
Sergunb 0:8918a71cdbe9 160 #endif
Sergunb 0:8918a71cdbe9 161