include/Os.h

   1 /* -------------------------------- Arctic Core ------------------------------\r
   2  * Arctic Core - the open source AUTOSAR platform http://arccore.com\r
   3  *\r
   4  * Copyright (C) 2009  ArcCore AB <contact@arccore.com>\r
   5  *\r
   6  * This source code is free software; you can redistribute it and/or modify it\r
   7  * under the terms of the GNU General Public License version 2 as published by the\r
   8  * Free Software Foundation; See <http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt>.\r
   9  *\r
  10  * This program is distributed in the hope that it will be useful, but\r
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY\r
  12  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License\r
  13  * for more details.\r
  14  * -------------------------------- Arctic Core ------------------------------*/\r
  15 \r
  16 \r
  17 \r
  18 #ifndef OS_H_\r
  19 #define OS_H_\r
  20 \r
  21 #define OS_SW_MAJOR_VERSION    2\r
  22 #define OS_SW_MINOR_VERSION    0\r
  23 #define OS_SW_PATCH_VERSION    0\r
  24 \r
  25 #include <assert.h>\r
  26 #include "Std_Types.h"\r
  27 #include "Os_Cfg.h"\r
  28 #include "MemMap.h"\r
  29 #include "Cpu.h"\r
  30 \r
  31 typedef uint8 StatusType;\r
  32 \r
  33 #define E_OS_ACCESS (StatusType)1               /**< STD OSEK */\r
  34 #define E_OS_CALLEVEL (StatusType)2             /**< STD OSEK */\r
  35 #define E_OS_ID (StatusType)3                   /**< STD OSEK */\r
  36 #define E_OS_LIMIT (StatusType)4                /**< STD OSEK */\r
  37 #define E_OS_NOFUNC (StatusType)5               /**< STD OSEK */\r
  38 #define E_OS_RESOURCE (StatusType)6             /**< STD OSEK */\r
  39 #define E_OS_STATE (StatusType)7                /**< STD OSEK */\r
  40 #define E_OS_VALUE (StatusType)8                /**< STD OSEK */\r
  41 \r
  42 #define E_OS_SERVICEID (StatusType)9                /**< AUTOSAR, see 7.10 */\r
  43 #define E_OS_RATE (StatusType)10                    /**< AUTOSAR, see 7.10 */\r
  44 #define E_OS_ILLEGAL_ADDRESS (StatusType)11         /**< AUTOSAR, see 7.10 */\r
  45 #define E_OS_MISSINGEND (StatusType)12              /**< AUTOSAR, see 7.10 */\r
  46 #define E_OS_DISABLEDINT (StatusType)13             /**< AUTOSAR, see 7.10 */\r
  47 #define E_OS_STACKFAULT (StatusType)14              /**< AUTOSAR, see 7.10 */\r
  48 #define E_OS_PROTECTION_MEMORY (StatusType)15       /**< AUTOSAR, see 7.10 */\r
  49 #define E_OS_PROTECTION_TIME (StatusType)16         /**< AUTOSAR, see 7.10 */\r
  50 #define E_OS_PROTECTION_LOCKED (StatusType)17       /**< AUTOSAR, see 7.10 */\r
  51 #define E_OS_PROTECTION_EXCEPTION (StatusType)18    /**< AUTOSAR, see 7.10 */\r
  52 #define E_OS_PROTECTION_RATE (StatusType)19          /**< AUTOSAR, see 7.10 */\r
  53 \r
  54 #define E_COM_ID 255 // TODO: var ska E_COM_ID vara?"\r
  55 \r
  56 \r
  57 typedef uint32_t                EventMaskType;\r
  58 typedef EventMaskType * EventMaskRefType;\r
  59 typedef uint16_t                TaskType;\r
  60 typedef TaskType *              TaskRefType;\r
  61 \r
  62 typedef enum {\r
  63         TASK_STATE_WAITING,\r
  64         TASK_STATE_READY,\r
  65         TASK_STATE_SUSPENDED,\r
  66         TASK_STATE_RUNNING\r
  67 } TaskStateType;\r
  68 \r
  69 #define INVALID_TASK    0xdeadU\r
  70 \r
  71 typedef TaskStateType *TaskStateRefType;\r
  72 \r
  73 /* FIXME: OSMEMORY_IS__ , see 8.2*/\r
  74 \r
  75 #define OSDEFAULTAPPMODE  1\r
  76 \r
  77 #define INVALID_OSAPPLICATION (-1)\r
  78 \r
  79 /* TODO, I have no idea what this should be*/\r
  80 typedef sint32 ApplicationType;\r
  81 \r
  82 /* See oil config for defines */\r
  83 typedef sint32 AppModeType;\r
  84 \r
  85 /* FIXME: more types here */\r
  86 typedef uint16 ScheduleTableType;\r
  87 typedef uint16 GlobalTimeTickType;\r
  88 \r
  89 typedef enum {\r
  90         SCHEDULETABLE_STOPPED,\r
  91         SCHEDULETABLE_NEXT,\r
  92         SCHEDULETABLE_WAITING,\r
  93         SCHEDULETABLE_RUNNING,\r
  94         SCHEDULETABLE_RUNNING_AND_SYNCHRONOUS\r
  95 } ScheduleTableStatusType;\r
  96 \r
  97 typedef ScheduleTableStatusType *ScheduleTableStatusRefType;\r
  98 \r
  99 /* Flags for AccessType */\r
 100 #define ACCESSTYPE_W    1\r
 101 #define ACCESSTYPE_R    (1<<1)\r
 102 \r
 103 typedef uint32 AccessType;\r
 104 \r
 105 typedef enum {\r
 106         ACCESS,\r
 107         NO_ACCESS\r
 108 } ObjectAccessType;\r
 109 \r
 110 typedef enum {\r
 111         OBJECT_TASK,\r
 112         OBJECT_ISR,\r
 113         OBJECT_ALARM,\r
 114         OBJECT_RESOURCE,\r
 115         OBJECT_COUNTER,\r
 116         OBJECT_SCHEDULETABLE,\r
 117         OBJECT_MESSAGE\r
 118 } ObjectTypeType;\r
 119 \r
 120 typedef enum {\r
 121         PRO_KILLTASKISR,\r
 122         PRO_KILLAPPL,\r
 123         PRO_KILLAPPL_RESTART,\r
 124         PRO_SHUTDOWN\r
 125 } ProtectionReturnType;\r
 126 \r
 127 typedef enum {\r
 128         RESTART,\r
 129         NO_RESTART\r
 130 } RestartType;\r
 131 \r
 132 \r
 133 typedef ProtectionReturnType (*ProtectionHookType)( StatusType);\r
 134 typedef void (*StartupHookType)( void );\r
 135 typedef void (*ShutdownHookType)( StatusType );\r
 136 typedef void (*ErrorHookType)( StatusType );\r
 137 typedef void (*PreTaskHookType)( void );\r
 138 typedef void (*PostTaskHookType)( void );\r
 139 \r
 140 ProtectionReturnType ProtectionHook( StatusType FatalError );\r
 141 void StartupHook( void );\r
 142 void ShutdownHook( StatusType Error );\r
 143 void ErrorHook( StatusType Error );\r
 144 void PreTaskHook( void );\r
 145 void PostTaskHook( void );\r
 146 \r
 147 typedef uint16 TrustedFunctionIndexType;\r
 148 typedef  void * TrustedFunctionParameterRefType;\r
 149 \r
 150 /* See 8.3.9 */\r
 151 #define INVALID_ISR             ((sint16)(-1))\r
 152 typedef sint16 ISRType;\r
 153 \r
 154 typedef void * MemoryStartAddressType;\r
 155 typedef uint32 MemorySizeType;\r
 156 \r
 157 #if 0\r
 158 #define WaitEvent(...) SC_CALL(WaitEvent,1,1,__VA_ARGS__)\r
 159 #define SetEvent(...) SC_CALL(SetEvent,2,2,__VA_ARGS__)\r
 160 #define ClearEvent(...) SC_CALL(ClearEvent,3,1,__VA_ARGS__)\r
 161 #endif\r
 162 StatusType WaitEvent( EventMaskType Mask );\r
 163 StatusType SetEvent( TaskType TaskID, EventMaskType Mask );\r
 164 StatusType ClearEvent( EventMaskType Mask);\r
 165 StatusType GetEvent( TaskType TaskId, EventMaskRefType Mask);\r
 166 \r
 167 void InitOS( void );\r
 168 void StartOS( AppModeType Mode );\r
 169 \r
 170 \r
 171 \r
 172 ApplicationType GetApplicationID( void );\r
 173 ISRType GetISRID( void );\r
 174 StatusType GetActiveApplicationMode( AppModeType* mode);\r
 175 \r
 176 typedef int8_t Os_IntCounterType;\r
 177 \r
 178 /* requirements here: OS368(ISR2), OS092 */\r
 179 \r
 180 extern Os_IntCounterType Os_IntDisableAllCnt;\r
 181 extern Os_IntCounterType Os_IntSuspendAllCnt;\r
 182 extern Os_IntCounterType Os_IntSuspendOsCnt;\r
 183 \r
 184 \r
 185 \r
 186 /** @req OS299 */\r
 187 /* OSEK: States that " service  does  not  support  nesting", but says\r
 188  * nothing what to do about it.\r
 189  *\r
 190  * OS092: "  If EnableAllInterrupts()/ResumeAllInterrupts()/ResumeOSInterrupts()\r
 191  * are called and no corresponding DisableAllInterupts()/SuspendAllInterrupts()/\r
 192  * SuspendOSInterrupts()  was  done  before,  the Operating System shall not\r
 193  * perform this OS service.\r
 194  */\r
 195 static inline void DisableAllInterrupts( void ) {\r
 196         Irq_Disable();\r
 197         Os_IntDisableAllCnt++;\r
 198         /* No nesting allowed */\r
 199         assert(Os_IntDisableAllCnt==1);\r
 200 }\r
 201 \r
 202 static inline void EnableAllInterrupts( void ) {\r
 203 \r
 204         if(Os_IntDisableAllCnt==0) {\r
 205                 /** @req OS092 EnableAllInterrupts */\r
 206         } else {\r
 207                 Os_IntDisableAllCnt--;\r
 208                 Irq_Enable();\r
 209         }\r
 210 }\r
 211 \r
 212 static inline void SuspendAllInterrupts( void ) {\r
 213         Irq_SuspendAll();\r
 214         Os_IntSuspendAllCnt++;\r
 215 }\r
 216 \r
 217 static inline void ResumeAllInterrupts( void ) {\r
 218 \r
 219         if(Os_IntSuspendAllCnt==0) {\r
 220                 /** @req OS092 ResumeAllInterrupts */\r
 221         } else {\r
 222                 Os_IntSuspendAllCnt--;\r
 223                 Irq_ResumeAll();\r
 224         }\r
 225 }\r
 226 \r
 227 /* Only ISR2 interrupts should be suspended but this can NEVER be\r
 228  * done in a more efficient way than to disable all, so let's\r
 229  * do that for all targets.\r
 230  */\r
 231 \r
 232 static inline void SuspendOSInterrupts( void ) {\r
 233         Irq_SuspendOs();\r
 234         Os_IntSuspendOsCnt++;\r
 235 }\r
 236 \r
 237 static inline void ResumeOSInterrupts( void ) {\r
 238 \r
 239         if(Os_IntSuspendOsCnt==0) {\r
 240                 /** @req OS092 ResumeOSInterrupts */\r
 241         } else {\r
 242                 Os_IntSuspendOsCnt--;\r
 243                 Irq_ResumeOs();\r
 244         }\r
 245 }\r
 246 \r
 247 /*\r
 248  * Class 2,3 and 4 API\r
 249  */\r
 250 ApplicationType GetApplicationID( void );\r
 251 AccessType      CheckISRMemoryAccess(   ISRType ISRID,\r
 252                                                                         MemoryStartAddressType Address,\r
 253                                                                         MemorySizeType Size );\r
 254 \r
 255 AccessType      CheckTaskMemoryAccess(  TaskType TaskID,\r
 256                                                                         MemoryStartAddressType Address,\r
 257                                                                         MemorySizeType Size );\r
 258 \r
 259 StatusType      CallTrustedFunction(    TrustedFunctionIndexType FunctionIndex,\r
 260                                                                         TrustedFunctionParameterRefType FunctionParams );\r
 261 \r
 262 StatusType      GetTaskID(              TaskRefType TaskID );\r
 263 StatusType      GetTaskState(   TaskType task_id, TaskStateRefType state);\r
 264 \r
 265 void            ShutdownOS( StatusType );\r
 266 StatusType      ActivateTask( TaskType TaskID );\r
 267 StatusType      TerminateTask( void );\r
 268 StatusType      ChainTask( TaskType TaskID );\r
 269 StatusType      Schedule( void );\r
 270 \r
 271 typedef uint8 ResourceType;\r
 272 #define DeclareResource(x) extern ResourceType (x);\r
 273 StatusType GetResource( ResourceType ResID );\r
 274 StatusType ReleaseResource( ResourceType ResID);\r
 275 \r
 276 /*\r
 277  * Define scheduler as topmost\r
 278  */\r
 279 #define RES_SCHEDULER                   OS_RESOURCE_CNT\r
 280 \r
 281 /*\r
 282  * Priorities of tasks and resources\r
 283  */\r
 284 #define OS_TASK_PRIORITY_MIN    0\r
 285 #define OS_TASK_PRIORITY_MAX    31\r
 286 /* Logical priority is higher higher than normal tasks */\r
 287 #define OS_RES_SCHEDULER_PRIO   32\r
 288 \r
 289 typedef struct OsDriver_s {\r
 290         int     OsGptChannelRef;\r
 291 } OsDriver;\r
 292 \r
 293 \r
 294 \r
 295 /*-------------------------------------------------------------------\r
 296  * Counters\r
 297  *-----------------------------------------------------------------*/\r
 298 typedef sint16 CounterType;\r
 299 \r
 300 typedef uint32 TickType;\r
 301 typedef TickType *TickRefType;\r
 302 \r
 303 StatusType IncrementCounter( CounterType );\r
 304 StatusType GetCounterValue( CounterType, TickRefType );\r
 305 StatusType GetElapsedCounterValue( CounterType, TickRefType val, TickRefType elapsed_val);\r
 306 \r
 307 \r
 308 /*-------------------------------------------------------------------\r
 309  * System timer\r
 310  *-----------------------------------------------------------------*/\r
 311 typedef const uint32 OsTickType;\r
 312 void Os_SysTickInit( void );\r
 313 void Os_SysTickStart(TickType period_ticks);\r
 314 TickType Os_SysTickGetValue( void );\r
 315 TickType Os_SysTickGetElapsedValue( TickType preValue );\r
 316 \r
 317 /*-------------------------------------------------------------------\r
 318  * Schedule Tables\r
 319  *-----------------------------------------------------------------*/\r
 320 \r
 321 StatusType StartScheduleTableRel(ScheduleTableType sid, TickType offset);\r
 322 StatusType StartScheduleTableAbs(ScheduleTableType sid, TickType val );\r
 323 StatusType StartScheduleTableSynchron(ScheduleTableType sid );\r
 324 StatusType StopScheduleTable(ScheduleTableType sid);\r
 325 StatusType NextScheduleTable( ScheduleTableType sid_curr, ScheduleTableType sid_next);\r
 326 StatusType SyncScheduleTable( ScheduleTableType sid, GlobalTimeTickType global_time  );\r
 327 StatusType GetScheduleTableStatus( ScheduleTableType sid, ScheduleTableStatusRefType status );\r
 328 StatusType SetScheduleTableAsync( ScheduleTableType sid );\r
 329 \r
 330 \r
 331 /*-------------------------------------------------------------------\r
 332  * Alarms\r
 333  *-----------------------------------------------------------------*/\r
 334 \r
 335 typedef uint16 AlarmType;\r
 336 \r
 337 typedef struct {\r
 338         TickType maxallowedvalue;\r
 339         TickType tickperbase;\r
 340         TickType mincycle;\r
 341 } AlarmBaseType;\r
 342 \r
 343 typedef AlarmBaseType *AlarmBaseRefType;\r
 344 \r
 345 StatusType GetAlarmBase( AlarmType AlarmId, AlarmBaseRefType Info );\r
 346 StatusType GetAlarm(AlarmType AlarmId, TickRefType Tick);\r
 347 StatusType SetRelAlarm(AlarmType AlarmId, TickType Increment, TickType Cycle);\r
 348 StatusType SetAbsAlarm(AlarmType AlarmId, TickType Start, TickType Cycle);\r
 349 StatusType CancelAlarm(AlarmType AlarmId);\r
 350 \r
 351 \r
 352 /*-------------------------------------------------------------------\r
 353  * Error's\r
 354  *-----------------------------------------------------------------*/\r
 355 typedef enum {\r
 356     OSServiceId_ActivateTask,\r
 357     OSServiceId_TerminateTask,\r
 358     OSServiceId_ChainTask,\r
 359     OSServiceId_Schedule,\r
 360     OSServiceId_GetTaskID,\r
 361     OSServiceId_GetResource,\r
 362     OSServiceId_ReleaseResource,\r
 363     OSServiceId_SetEvent,\r
 364     OSServiceId_ClearEvent,\r
 365     OSServiceId_GetEvent,\r
 366     OSServiceId_WaitEvent,\r
 367     OSServiceId_GetAlarmBase,\r
 368     OSServiceId_GetAlarm,\r
 369     OSServiceId_SetRelAlarm,\r
 370     OSServiceId_SetAbsAlarm,\r
 371     OSServiceId_CancelAlarm,\r
 372     OSServiceId_StartOS,\r
 373     OSServiceId_ShutdownOS,\r
 374     OSServiceId_ErrorHook,\r
 375     OSServiceId_PreTaskHook,\r
 376     OSServiceId_PostTaskHook,\r
 377     OSServiceId_StartupHook,\r
 378     OSServiceId_ShutdownHook,\r
 379     OSServiceId_GetTaskState\r
 380 } OsServiceIdType;\r
 381 \r
 382 typedef struct OsError {\r
 383         OsServiceIdType serviceId;\r
 384         uint32_t param1;\r
 385         uint32_t param2;\r
 386         uint32_t param3;\r
 387 } OsErrorType;\r
 388 \r
 389 extern OsErrorType os_error;\r
 390 \r
 391 // TODO: Add the service id to all OS service methods.\r
 392 static inline OsServiceIdType OSErrorGetServiceId(void)  {\r
 393         return os_error.serviceId;\r
 394 }\r
 395 \r
 396 extern OsErrorType os_error;\r
 397 \r
 398 #define OSError_ActivateTask_TaskID ((TaskType) os_error.param1)\r
 399 #define OSError_ChainTask_TaskID ((TaskType) os_error.param1)\r
 400 #define OSError_GetTaskID_TaskID ((TaskRefType) os_error.param1)\r
 401 #define OSError_GetResource_ResID ((ResourceType) os_error.param1)\r
 402 #define OSError_ReleaseResource_ResID ((ResourceType) os_error.param1)\r
 403 #define OSError_SetEvent_TaskID ((TaskType) os_error.param1)\r
 404 #define OSError_SetEvent_Mask ((EventMaskType) os_error.param2)\r
 405 #define OSError_ClearEvent_Mask ((EventMaskType) os_error.param1)\r
 406 #define OSError_GetEvent_TaskId ((TaskType) os_error.param1)\r
 407 #define OSError_GetEvent_Mask ((EventMaskRefType) os_error.param2)\r
 408 #define OSError_WaitEvent_Mask ((EventMaskType) os_error.param1)\r
 409 #define OSError_GetAlarmBase_AlarmId ((AlarmType) os_error.param1)\r
 410 #define OSError_GetAlarmBase_Info ((AlarmBaseRefType) os_error.param2)\r
 411 #define OSError_GetAlarm_AlarmId ((AlarmType) os_error.param1)\r
 412 #define OSError_GetAlarm_Tick ((TickRefType) os_error.param2)\r
 413 #define OSError_SetRelAlarm_AlarmId ((AlarmType) os_error.param1)\r
 414 #define OSError_SetRelAlarm_Increment ((TickType) os_error.param2)\r
 415 #define OSError_SetRelAlarm_Cycle ((TickType) os_error.param3)\r
 416 #define OSError_SetAbsAlarm_AlarmId ((AlarmType) os_error.param1)\r
 417 #define OSError_SetAbsAlarm_Start ((TickType) os_error.param2)\r
 418 #define OSError_SetAbsAlarm_Cycle ((TickType) os_error.param3)\r
 419 #define OSError_CancelAlarm_AlarmId ((AlarmType) os_error.param1)\r
 420 #define OSError_StartOS_Mode ((AppModeType) os_error.param1)\r
 421 #define OSError_ErrorHook_Error ((StatusType) os_error.param1)\r
 422 #define OSError_ShutdownHook_Error ((StatusType) os_error.param1)\r
 423 #define OSError_GetTaskState_TaskId ((TaskType) os_error.param1)\r
 424 #define OSError_GetTaskState_State ((TaskStateRefType) os_error.param2)\r
 425 \r
 426 /** @req OS398 */\r
 427 #if defined(LOCALMESSAGESONLY)\r
 428 #error LOCALMESSAGESONLY shall not be defined\r
 429 #endif\r
 430 \r
 431 \r
 432 /*-------------------------------------------------------------------\r
 433  * COM ( TODO : move )\r
 434  *-----------------------------------------------------------------*/\r
 435 \r
 436 /*\r
 437  * The only information about the COM that is valid is\r
 438  * in the COM specification ..SWS_COM.pdf.\r
 439  *\r
 440  * The most important requirements are COM010 and COM013\r
 441  *\r
 442  * Com_Init()\r
 443  * Com_DeInit()\r
 444  *\r
 445  * No error hooks..\r
 446  * No. GetMessageStatus()\r
 447  * No. SendZeroMessage()\r
 448  * No. SendDynamicMessage(), RecieveDynamicMessage()\r
 449  *\r
 450  * Yes. SendMessage()\r
 451  *\r
 452  * */\r
 453 \r
 454 \r
 455 typedef uint32 MessageType;\r
 456 typedef void *ApplicationDataRef;\r
 457 \r
 458 \r
 459 StatusType SendMessage( MessageType message_id, ApplicationDataRef dataRef );\r
 460 StatusType ReceiveMessage( MessageType message_id, ApplicationDataRef dataRef );\r
 461 \r
 462 /*\r
 463  * ArcCore extensions\r
 464  */\r
 465 TickType GetOsTick();\r
 466 void OsTick(void);\r
 467 void OsIdle(void);\r
 468 \r
 469 #define OS_ISR_TYPE2    0\r
 470 #define OS_ISR_TYPE1    1\r
 471 \r
 472 union isr_attr {\r
 473         TaskType tid;\r
 474         void (*entry)(void);\r
 475 };\r
 476 \r
 477 #define TTY_NONE                1\r
 478 #define TTY_T32         2\r
 479 #define TTY_WINIDEA     4\r
 480 #define TTY_SERIAL              8\r
 481 #define RAMLOG          16\r
 482 \r
 483 #endif /*OS_H_*/\r