Sergey Pastor / 1

Webserver+3d print

Dependents:   Nucleo

common/os_port_rtx.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_rtx.h
Sergunb 0:8918a71cdbe9 3 * @brief RTOS abstraction layer (Keil RTX)
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_RTX_H
Sergunb 0:8918a71cdbe9 28 #define _OS_PORT_RTX_H
Sergunb 0:8918a71cdbe9 29
Sergunb 0:8918a71cdbe9 30 //Dependencies
Sergunb 0:8918a71cdbe9 31 #ifdef RTX_CUSTOM_HEADER
Sergunb 0:8918a71cdbe9 32 #include RTX_CUSTOM_HEADER
Sergunb 0:8918a71cdbe9 33 #else
Sergunb 0:8918a71cdbe9 34 #include "rtl.h"
Sergunb 0:8918a71cdbe9 35 #endif
Sergunb 0:8918a71cdbe9 36
Sergunb 0:8918a71cdbe9 37 //Maximum number of tasks that can be dynamically created
Sergunb 0:8918a71cdbe9 38 #ifndef OS_PORT_MAX_TASKS
Sergunb 0:8918a71cdbe9 39 #define OS_PORT_MAX_TASKS 16
Sergunb 0:8918a71cdbe9 40 #elif (OS_PORT_MAX_TASKS < 1)
Sergunb 0:8918a71cdbe9 41 #error OS_PORT_MAX_TASKS parameter is not valid
Sergunb 0:8918a71cdbe9 42 #endif
Sergunb 0:8918a71cdbe9 43
Sergunb 0:8918a71cdbe9 44 //Task priority (normal)
Sergunb 0:8918a71cdbe9 45 #ifndef OS_TASK_PRIORITY_NORMAL
Sergunb 0:8918a71cdbe9 46 #define OS_TASK_PRIORITY_NORMAL 1
Sergunb 0:8918a71cdbe9 47 #endif
Sergunb 0:8918a71cdbe9 48
Sergunb 0:8918a71cdbe9 49 //Task priority (high)
Sergunb 0:8918a71cdbe9 50 #ifndef OS_TASK_PRIORITY_HIGH
Sergunb 0:8918a71cdbe9 51 #define OS_TASK_PRIORITY_HIGH 2
Sergunb 0:8918a71cdbe9 52 #endif
Sergunb 0:8918a71cdbe9 53
Sergunb 0:8918a71cdbe9 54 //Milliseconds to system ticks
Sergunb 0:8918a71cdbe9 55 #ifndef OS_MS_TO_SYSTICKS
Sergunb 0:8918a71cdbe9 56 #define OS_MS_TO_SYSTICKS(n) (n)
Sergunb 0:8918a71cdbe9 57 #endif
Sergunb 0:8918a71cdbe9 58
Sergunb 0:8918a71cdbe9 59 //System ticks to milliseconds
Sergunb 0:8918a71cdbe9 60 #ifndef OS_SYSTICKS_TO_MS
Sergunb 0:8918a71cdbe9 61 #define OS_SYSTICKS_TO_MS(n) (n)
Sergunb 0:8918a71cdbe9 62 #endif
Sergunb 0:8918a71cdbe9 63
Sergunb 0:8918a71cdbe9 64 //Enter interrupt service routine
Sergunb 0:8918a71cdbe9 65 #define osEnterIsr()
Sergunb 0:8918a71cdbe9 66
Sergunb 0:8918a71cdbe9 67 //Leave interrupt service routine
Sergunb 0:8918a71cdbe9 68 #define osExitIsr(flag)
Sergunb 0:8918a71cdbe9 69
Sergunb 0:8918a71cdbe9 70
Sergunb 0:8918a71cdbe9 71 /**
Sergunb 0:8918a71cdbe9 72 * @brief Task object
Sergunb 0:8918a71cdbe9 73 **/
Sergunb 0:8918a71cdbe9 74
Sergunb 0:8918a71cdbe9 75 typedef struct
Sergunb 0:8918a71cdbe9 76 {
Sergunb 0:8918a71cdbe9 77 OS_TID tid;
Sergunb 0:8918a71cdbe9 78 } OsTask;
Sergunb 0:8918a71cdbe9 79
Sergunb 0:8918a71cdbe9 80
Sergunb 0:8918a71cdbe9 81 /**
Sergunb 0:8918a71cdbe9 82 * @brief Event object
Sergunb 0:8918a71cdbe9 83 **/
Sergunb 0:8918a71cdbe9 84
Sergunb 0:8918a71cdbe9 85 typedef OS_SEM OsEvent;
Sergunb 0:8918a71cdbe9 86
Sergunb 0:8918a71cdbe9 87
Sergunb 0:8918a71cdbe9 88 /**
Sergunb 0:8918a71cdbe9 89 * @brief Semaphore object
Sergunb 0:8918a71cdbe9 90 **/
Sergunb 0:8918a71cdbe9 91
Sergunb 0:8918a71cdbe9 92 typedef OS_SEM OsSemaphore;
Sergunb 0:8918a71cdbe9 93
Sergunb 0:8918a71cdbe9 94
Sergunb 0:8918a71cdbe9 95 /**
Sergunb 0:8918a71cdbe9 96 * @brief Mutex object
Sergunb 0:8918a71cdbe9 97 **/
Sergunb 0:8918a71cdbe9 98
Sergunb 0:8918a71cdbe9 99 typedef OS_MUT OsMutex;
Sergunb 0:8918a71cdbe9 100
Sergunb 0:8918a71cdbe9 101
Sergunb 0:8918a71cdbe9 102 /**
Sergunb 0:8918a71cdbe9 103 * @brief Task routine
Sergunb 0:8918a71cdbe9 104 **/
Sergunb 0:8918a71cdbe9 105
Sergunb 0:8918a71cdbe9 106 typedef void (*OsTaskCode)(void *params);
Sergunb 0:8918a71cdbe9 107
Sergunb 0:8918a71cdbe9 108
Sergunb 0:8918a71cdbe9 109 /**
Sergunb 0:8918a71cdbe9 110 * @brief Initialization task
Sergunb 0:8918a71cdbe9 111 **/
Sergunb 0:8918a71cdbe9 112
Sergunb 0:8918a71cdbe9 113 typedef void (*OsInitTaskCode)(void);
Sergunb 0:8918a71cdbe9 114
Sergunb 0:8918a71cdbe9 115
Sergunb 0:8918a71cdbe9 116 //Kernel management
Sergunb 0:8918a71cdbe9 117 void osInitKernel(void);
Sergunb 0:8918a71cdbe9 118 void osStartKernel(OsInitTaskCode task);
Sergunb 0:8918a71cdbe9 119
Sergunb 0:8918a71cdbe9 120 //Task management
Sergunb 0:8918a71cdbe9 121 bool_t osCreateStaticTask(OsTask *task, const char_t *name, OsTaskCode taskCode,
Sergunb 0:8918a71cdbe9 122 void *params, void *stack, size_t stackSize, int_t priority);
Sergunb 0:8918a71cdbe9 123
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 //Undefine conflicting definitions
Sergunb 0:8918a71cdbe9 161 #undef htons
Sergunb 0:8918a71cdbe9 162 #undef htonl
Sergunb 0:8918a71cdbe9 163 #undef ntohs
Sergunb 0:8918a71cdbe9 164 #undef ntohl
Sergunb 0:8918a71cdbe9 165 #undef TCP_STATE_CLOSED
Sergunb 0:8918a71cdbe9 166 #undef TCP_STATE_LISTEN
Sergunb 0:8918a71cdbe9 167 #undef TCP_STATE_SYN_SENT
Sergunb 0:8918a71cdbe9 168 #undef TCP_STATE_CLOSING
Sergunb 0:8918a71cdbe9 169 #undef TCP_STATE_LAST_ACK
Sergunb 0:8918a71cdbe9 170
Sergunb 0:8918a71cdbe9 171 #endif
Sergunb 0:8918a71cdbe9 172