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 \r
  19 #ifndef OS_H_\r
  20 #define OS_H_\r
  21 \r
  22 #define OS_SW_MAJOR_VERSION    2\r
  23 #define OS_SW_MINOR_VERSION    0\r
  24 #define OS_SW_PATCH_VERSION    0\r
  25 \r
  26 #include <assert.h>\r
  27 #include "Std_Types.h"\r
  28 #include "Os_Cfg.h"\r
  29 #include "MemMap.h"\r
  30 #include "Cpu.h"\r
  31 #include "limits.h"\r
  32 #include <sys/queue.h>\r
  33 \r
  34 typedef uint8 StatusType;\r
  35 \r
  36 #if (OS_ISR_CNT > OS_ISR_MAX_CNT)\r
  37 #error OS configuration error. OS_ISR_MAX_CNT must be bigger or equal to OS_ISR_CNT\r
  38 #endif\r
  39 \r
  40 #define E_OS_ACCESS (StatusType)1               /**< STD OSEK */\r
  41 #define E_OS_CALLEVEL (StatusType)2             /**< STD OSEK */\r
  42 #define E_OS_ID (StatusType)3                   /**< STD OSEK */\r
  43 #define E_OS_LIMIT (StatusType)4                /**< STD OSEK */\r
  44 #define E_OS_NOFUNC (StatusType)5               /**< STD OSEK */\r
  45 #define E_OS_RESOURCE (StatusType)6             /**< STD OSEK */\r
  46 #define E_OS_STATE (StatusType)7                /**< STD OSEK */\r
  47 #define E_OS_VALUE (StatusType)8                /**< STD OSEK */\r
  48 \r
  49 #define E_OS_SERVICEID (StatusType)9                /**< AUTOSAR, see 7.10 */\r
  50 #define E_OS_RATE (StatusType)10                    /**< AUTOSAR, see 7.10 */\r
  51 #define E_OS_ILLEGAL_ADDRESS (StatusType)11         /**< AUTOSAR, see 7.10 */\r
  52 #define E_OS_MISSINGEND (StatusType)12              /**< AUTOSAR, see 7.10 */\r
  53 #define E_OS_DISABLEDINT (StatusType)13             /**< AUTOSAR, see 7.10 */\r
  54 #define E_OS_STACKFAULT (StatusType)14              /**< AUTOSAR, see 7.10 */\r
  55 #define E_OS_PROTECTION_MEMORY (StatusType)15       /**< AUTOSAR, see 7.10 */\r
  56 #define E_OS_PROTECTION_TIME (StatusType)16         /**< AUTOSAR, see 7.10 */\r
  57 #define E_OS_PROTECTION_LOCKED (StatusType)17       /**< AUTOSAR, see 7.10 */\r
  58 #define E_OS_PROTECTION_EXCEPTION (StatusType)18    /**< AUTOSAR, see 7.10 */\r
  59 #define E_OS_PROTECTION_RATE (StatusType)19          /**< AUTOSAR, see 7.10 */\r
  60 \r
  61 #define E_COM_ID 255 // TODO: var ska E_COM_ID vara?"\r
  62 \r
  63 \r
  64 typedef uint32_t                EventMaskType;\r
  65 typedef EventMaskType * EventMaskRefType;\r
  66 typedef uint16_t                TaskType;\r
  67 typedef TaskType *              TaskRefType;\r
  68 \r
  69 typedef enum {\r
  70         TASK_STATE_WAITING,\r
  71         TASK_STATE_READY,\r
  72         TASK_STATE_SUSPENDED,\r
  73         TASK_STATE_RUNNING\r
  74 } TaskStateType;\r
  75 \r
  76 #define INVALID_TASK    0xdeadU\r
  77 \r
  78 typedef TaskStateType *TaskStateRefType;\r
  79 \r
  80 /* FIXME: OSMEMORY_IS__ , see 8.2*/\r
  81 \r
  82 #define OSMEMORY_IS_READABLE(_access)\r
  83 #define OSMEMORY_IS_WRITEABLE(_access)\r
  84 #define OSMEMORY_IS_EXECUTABLE(_access)\r
  85 #define OSMEMORY_IS_STACKSPACE(_access)\r
  86 \r
  87 #define OSDEFAULTAPPMODE  1\r
  88 \r
  89 #define INVALID_OSAPPLICATION (-1)\r
  90 \r
  91 /* TODO, I have no idea what this should be*/\r
  92 #if (OS_USE_APPLICATIONS == STD_ON)\r
  93 typedef sint32 ApplicationType;\r
  94 \r
  95 typedef enum {\r
  96         APPLICATION_ACCESSIBLE,\r
  97         APPLICATION_RESTARTING,\r
  98         APPLICATION_TERMINATED\r
  99 } ApplicationStateType;\r
 100 \r
 101 typedef ApplicationStateType *ApplicationStateRefType;\r
 102 #endif\r
 103 \r
 104 /* See oil config for defines */\r
 105 typedef sint32 AppModeType;\r
 106 \r
 107 /* FIXME: more types here */\r
 108 typedef uint16 ScheduleTableType;\r
 109 typedef uint16 GlobalTimeTickType;\r
 110 \r
 111 typedef enum {\r
 112         SCHEDULETABLE_STOPPED,\r
 113         SCHEDULETABLE_NEXT,\r
 114         SCHEDULETABLE_WAITING,\r
 115         SCHEDULETABLE_RUNNING,\r
 116         SCHEDULETABLE_RUNNING_AND_SYNCHRONOUS\r
 117 } ScheduleTableStatusType;\r
 118 \r
 119 typedef ScheduleTableStatusType *ScheduleTableStatusRefType;\r
 120 \r
 121 /* Flags for AccessType */\r
 122 #define ACCESSTYPE_W    1\r
 123 #define ACCESSTYPE_R    (1<<1)\r
 124 \r
 125 typedef uint32 AccessType;\r
 126 \r
 127 typedef enum {\r
 128         ACCESS,\r
 129         NO_ACCESS\r
 130 } ObjectAccessType;\r
 131 \r
 132 typedef enum {\r
 133         OBJECT_TASK,\r
 134         OBJECT_ISR,\r
 135         OBJECT_ALARM,\r
 136         OBJECT_RESOURCE,\r
 137         OBJECT_COUNTER,\r
 138         OBJECT_SCHEDULETABLE,\r
 139         OBJECT_MESSAGE\r
 140 } ObjectTypeType;\r
 141 \r
 142 typedef enum {\r
 143         PRO_KILLTASKISR,\r
 144         PRO_KILLAPPL,\r
 145         PRO_KILLAPPL_RESTART,\r
 146         PRO_SHUTDOWN\r
 147 } ProtectionReturnType;\r
 148 \r
 149 typedef enum {\r
 150         RESTART,\r
 151         NO_RESTART\r
 152 } RestartType;\r
 153 \r
 154 \r
 155 typedef ProtectionReturnType (*ProtectionHookType)( StatusType);\r
 156 typedef void (*StartupHookType)( void );\r
 157 typedef void (*ShutdownHookType)( StatusType );\r
 158 typedef void (*ErrorHookType)( StatusType );\r
 159 typedef void (*PreTaskHookType)( void );\r
 160 typedef void (*PostTaskHookType)( void );\r
 161 \r
 162 ProtectionReturnType ProtectionHook( StatusType FatalError );\r
 163 void StartupHook( void );\r
 164 void ShutdownHook( StatusType Error );\r
 165 void ErrorHook( StatusType Error );\r
 166 void PreTaskHook( void );\r
 167 void PostTaskHook( void );\r
 168 \r
 169 typedef uint16 TrustedFunctionIndexType;\r
 170 typedef  void * TrustedFunctionParameterRefType;\r
 171 \r
 172 /* See 8.3.9 */\r
 173 #define INVALID_ISR             ((sint16)(-1))\r
 174 typedef sint16 ISRType;\r
 175 \r
 176 #define APP_NO_OWNER    (-1UL)\r
 177 \r
 178 typedef void * MemoryStartAddressType;\r
 179 typedef uint32 MemorySizeType;\r
 180 \r
 181 #if 0\r
 182 #define WaitEvent(...) SC_CALL(WaitEvent,1,1,__VA_ARGS__)\r
 183 #define SetEvent(...) SC_CALL(SetEvent,2,2,__VA_ARGS__)\r
 184 #define ClearEvent(...) SC_CALL(ClearEvent,3,1,__VA_ARGS__)\r
 185 #endif\r
 186 StatusType WaitEvent( EventMaskType Mask );\r
 187 StatusType SetEvent( TaskType TaskID, EventMaskType Mask );\r
 188 StatusType ClearEvent( EventMaskType Mask);\r
 189 StatusType GetEvent( TaskType TaskId, EventMaskRefType Mask);\r
 190 \r
 191 void InitOS( void );\r
 192 void StartOS( AppModeType Mode );\r
 193 \r
 194 ISRType GetISRID( void );\r
 195 StatusType GetActiveApplicationMode( AppModeType* mode);\r
 196 \r
 197 typedef int8_t Os_IntCounterType;\r
 198 \r
 199 /* requirements here: OS368(ISR2), OS092 */\r
 200 \r
 201 extern Os_IntCounterType Os_IntDisableAllCnt;\r
 202 extern Os_IntCounterType Os_IntSuspendAllCnt;\r
 203 extern Os_IntCounterType Os_IntSuspendOsCnt;\r
 204 \r
 205 \r
 206 \r
 207 /** @req OS299 */\r
 208 /* OSEK: States that " service  does  not  support  nesting", but says\r
 209  * nothing what to do about it.\r
 210  *\r
 211  * OS092: "  If EnableAllInterrupts()/ResumeAllInterrupts()/ResumeOSInterrupts()\r
 212  * are called and no corresponding DisableAllInterupts()/SuspendAllInterrupts()/\r
 213  * SuspendOSInterrupts()  was  done  before,  the Operating System shall not\r
 214  * perform this OS service.\r
 215  */\r
 216 static inline void DisableAllInterrupts( void ) {\r
 217         Irq_Disable();\r
 218         Os_IntDisableAllCnt++;\r
 219         /* No nesting allowed */\r
 220         assert(Os_IntDisableAllCnt==1);\r
 221 }\r
 222 \r
 223 static inline void EnableAllInterrupts( void ) {\r
 224 \r
 225         if(Os_IntDisableAllCnt==0) {\r
 226                 /** @req OS092 EnableAllInterrupts */\r
 227         } else {\r
 228                 Os_IntDisableAllCnt--;\r
 229                 Irq_Enable();\r
 230         }\r
 231 }\r
 232 \r
 233 static inline void SuspendAllInterrupts( void ) {\r
 234         Irq_SuspendAll();\r
 235         Os_IntSuspendAllCnt++;\r
 236 }\r
 237 \r
 238 static inline void ResumeAllInterrupts( void ) {\r
 239 \r
 240         if(Os_IntSuspendAllCnt==0) {\r
 241                 /** @req OS092 ResumeAllInterrupts */\r
 242         } else {\r
 243                 Os_IntSuspendAllCnt--;\r
 244                 Irq_ResumeAll();\r
 245         }\r
 246 }\r
 247 \r
 248 /* Only ISR2 interrupts should be suspended but this can NEVER be\r
 249  * done in a more efficient way than to disable all, so let's\r
 250  * do that for all targets.\r
 251  */\r
 252 \r
 253 static inline void SuspendOSInterrupts( void ) {\r
 254         Irq_SuspendOs();\r
 255         Os_IntSuspendOsCnt++;\r
 256 }\r
 257 \r
 258 static inline void ResumeOSInterrupts( void ) {\r
 259 \r
 260         if(Os_IntSuspendOsCnt==0) {\r
 261                 /** @req OS092 ResumeOSInterrupts */\r
 262         } else {\r
 263                 Os_IntSuspendOsCnt--;\r
 264                 Irq_ResumeOs();\r
 265         }\r
 266 }\r
 267 \r
 268 /*\r
 269  * Class 2,3 and 4 API\r
 270  */\r
 271 \r
 272 #if (OS_USE_APPLICATIONS == STD_ON)\r
 273 \r
 274 ApplicationType GetApplicationID( void );\r
 275 AccessType      CheckISRMemoryAccess(   ISRType ISRID,\r
 276                                                                         MemoryStartAddressType Address,\r
 277                                                                         MemorySizeType Size );\r
 278 \r
 279 AccessType      CheckTaskMemoryAccess(  TaskType TaskID,\r
 280                                                                         MemoryStartAddressType Address,\r
 281                                                                         MemorySizeType Size );\r
 282 \r
 283 ObjectAccessType CheckObjectAccess( ApplicationType ApplId,\r
 284                                                                         ObjectTypeType ObjectType,\r
 285                                                                         uint32_t objectId );\r
 286 ApplicationType CheckObjectOwnership( ObjectTypeType ObjectType,\r
 287                                                                         uint32_t objectId );\r
 288 StatusType TerminateApplication(  ApplicationType Application, RestartType RestartOption );\r
 289 StatusType AllowAccess( void );\r
 290 StatusType GetApplicationState(   ApplicationType Application,  ApplicationStateRefType Value );\r
 291 StatusType      CallTrustedFunction(    TrustedFunctionIndexType FunctionIndex,\r
 292                                                                         TrustedFunctionParameterRefType FunctionParams );\r
 293 #endif\r
 294 \r
 295 StatusType      GetTaskID(              TaskRefType TaskID );\r
 296 StatusType      GetTaskState(   TaskType task_id, TaskStateRefType state);\r
 297 \r
 298 void            ShutdownOS( StatusType );\r
 299 StatusType      ActivateTask( TaskType TaskID );\r
 300 StatusType      TerminateTask( void );\r
 301 StatusType      ChainTask( TaskType TaskID );\r
 302 StatusType      Schedule( void );\r
 303 \r
 304 typedef uint8 ResourceType;\r
 305 #define DeclareResource(x) extern ResourceType (x);\r
 306 StatusType GetResource( ResourceType ResID );\r
 307 StatusType ReleaseResource( ResourceType ResID);\r
 308 \r
 309 /*\r
 310  * Define scheduler as topmost\r
 311  */\r
 312 #define RES_SCHEDULER                   OS_RESOURCE_CNT\r
 313 \r
 314 /*\r
 315  * Priorities of tasks and resources\r
 316  */\r
 317 #define OS_TASK_PRIORITY_MIN    0\r
 318 #define OS_TASK_PRIORITY_MAX    31\r
 319 /* Logical priority is higher higher than normal tasks */\r
 320 #define OS_RES_SCHEDULER_PRIO   32\r
 321 \r
 322 typedef struct OsDriver_s {\r
 323         int     OsGptChannelRef;\r
 324 } OsDriver;\r
 325 \r
 326 \r
 327 \r
 328 /*-------------------------------------------------------------------\r
 329  * Counters\r
 330  *-----------------------------------------------------------------*/\r
 331 typedef sint16 CounterType;\r
 332 \r
 333 typedef uint32 TickType;\r
 334 typedef TickType *TickRefType;\r
 335 \r
 336 StatusType IncrementCounter( CounterType );\r
 337 StatusType GetCounterValue( CounterType, TickRefType );\r
 338 StatusType GetElapsedCounterValue( CounterType, TickRefType val, TickRefType elapsed_val);\r
 339 \r
 340 \r
 341 /*-------------------------------------------------------------------\r
 342  * System timer\r
 343  *-----------------------------------------------------------------*/\r
 344 typedef const uint32 OsTickType;\r
 345 void Os_SysTickInit( void );\r
 346 void Os_SysTickStart(TickType period_ticks);\r
 347 TickType Os_SysTickGetValue( void );\r
 348 TickType Os_SysTickGetElapsedValue( TickType preValue );\r
 349 \r
 350 /* Return a value that is always a free running timer */\r
 351 TickType GetOsTick( void );\r
 352 \r
 353 /* Since this is based on SW ticks, no use to have ns resolution */\r
 354 #define OSTICKDURATION_US               (OSTICKDURATION/1000UL)\r
 355 \r
 356 /* Have special macros to always get the OsTick */\r
 357 #define OS_TICKS2SEC_OsTick(_ticks)             ( (OSTICKDURATION_US * (_ticks))/1000000UL )\r
 358 #define OS_TICKS2MS_OsTick(_ticks)              ( (OSTICKDURATION_US * (_ticks))/1000UL )\r
 359 #define OS_TICKS2US_OsTick(_ticks)              (OSTICKDURATION_US * (_ticks))\r
 360 #define OS_TICKS2NS_OsTick(_ticks)              (OSTICKDURATION * (_ticks))\r
 361 \r
 362 \r
 363 /*-------------------------------------------------------------------\r
 364  * Kernel extra\r
 365  *-----------------------------------------------------------------*/\r
 366 \r
 367 #if defined(USE_KERNEL_EXTRA)\r
 368 \r
 369 #define TICK_MAX        UINT_MAX\r
 370 \r
 371 typedef struct OsSemaphore {\r
 372         int val;\r
 373         STAILQ_HEAD(,OsTaskVar) taskHead;\r
 374 } OsSemaphoreType;\r
 375 \r
 376 typedef OsSemaphoreType OsMutexType;\r
 377 \r
 378 StatusType Sleep( TickType ticks );\r
 379 StatusType InitSemaphore( OsSemaphoreType *semPtr, int initialCount  );\r
 380 StatusType WaitSemaphore( OsSemaphoreType *semPtr, TickType tmo );\r
 381 void SignalSemaphore( OsSemaphoreType *semPtr );\r
 382 StatusType WaitMutex( OsMutexType *mutexPtr );\r
 383 StatusType ReleaseMutex( OsMutexType *mutexPtr );\r
 384 #endif\r
 385 \r
 386 \r
 387 /*-------------------------------------------------------------------\r
 388  * Schedule Tables\r
 389  *-----------------------------------------------------------------*/\r
 390 \r
 391 StatusType StartScheduleTableRel(ScheduleTableType sid, TickType offset);\r
 392 StatusType StartScheduleTableAbs(ScheduleTableType sid, TickType val );\r
 393 StatusType StartScheduleTableSynchron(ScheduleTableType sid );\r
 394 StatusType StopScheduleTable(ScheduleTableType sid);\r
 395 StatusType NextScheduleTable( ScheduleTableType sid_curr, ScheduleTableType sid_next);\r
 396 StatusType SyncScheduleTable( ScheduleTableType sid, GlobalTimeTickType global_time  );\r
 397 StatusType GetScheduleTableStatus( ScheduleTableType sid, ScheduleTableStatusRefType status );\r
 398 StatusType SetScheduleTableAsync( ScheduleTableType sid );\r
 399 \r
 400 \r
 401 /*-------------------------------------------------------------------\r
 402  * Alarms\r
 403  *-----------------------------------------------------------------*/\r
 404 \r
 405 typedef uint16 AlarmType;\r
 406 \r
 407 typedef struct {\r
 408         TickType maxallowedvalue;\r
 409         TickType tickperbase;\r
 410         TickType mincycle;\r
 411 } AlarmBaseType;\r
 412 \r
 413 typedef AlarmBaseType *AlarmBaseRefType;\r
 414 \r
 415 StatusType GetAlarmBase( AlarmType AlarmId, AlarmBaseRefType Info );\r
 416 StatusType GetAlarm(AlarmType AlarmId, TickRefType Tick);\r
 417 StatusType SetRelAlarm(AlarmType AlarmId, TickType Increment, TickType Cycle);\r
 418 StatusType SetAbsAlarm(AlarmType AlarmId, TickType Start, TickType Cycle);\r
 419 StatusType CancelAlarm(AlarmType AlarmId);\r
 420 \r
 421 \r
 422 /*-------------------------------------------------------------------\r
 423  * Error's\r
 424  *-----------------------------------------------------------------*/\r
 425 typedef enum {\r
 426     OSServiceId_ActivateTask,\r
 427     OSServiceId_TerminateTask,\r
 428     OSServiceId_ChainTask,\r
 429     OSServiceId_Schedule,\r
 430     OSServiceId_GetTaskID,\r
 431     OSServiceId_GetResource,\r
 432     OSServiceId_ReleaseResource,\r
 433     OSServiceId_SetEvent,\r
 434     OSServiceId_ClearEvent,\r
 435     OSServiceId_GetEvent,\r
 436     OSServiceId_WaitEvent,\r
 437     OSServiceId_GetAlarmBase,\r
 438     OSServiceId_GetAlarm,\r
 439     OSServiceId_SetRelAlarm,\r
 440     OSServiceId_SetAbsAlarm,\r
 441     OSServiceId_CancelAlarm,\r
 442     OSServiceId_StartOS,\r
 443     OSServiceId_ShutdownOS,\r
 444     OSServiceId_ErrorHook,\r
 445     OSServiceId_PreTaskHook,\r
 446     OSServiceId_PostTaskHook,\r
 447     OSServiceId_StartupHook,\r
 448     OSServiceId_ShutdownHook,\r
 449     OSServiceId_GetTaskState,\r
 450     OSServiceId_GetApplicationID,\r
 451     OSServiceId_GetISRID,\r
 452     OSServiceId_CallTrustedFunction,\r
 453     OSServiceId_CheckISRMemoryAccess,\r
 454     OSServiceId_TaskMemoryAccess,\r
 455     OSServiceId_CheckObjectAccess,\r
 456     OSServiceId_CheckObjectOwnership,\r
 457     OSServiceId_StartScheduleTableRel,\r
 458     OSServiceId_StartScheduleTableAbs,\r
 459     OSServiceId_StopScheduleTable,\r
 460     OSServiceId_NextScheduleTable,\r
 461     OSServiceId_StartScheduleTableSynchron,\r
 462     OSServiceId_SyncScheduleTable,\r
 463     OSServiceId_GetScheduleTable,\r
 464     OSServiceId_SetScheduleTableAsync,\r
 465     OSServiceId_IncrementCounter,\r
 466     OSServiceId_GetCounterValue,\r
 467     OSServiceId_GetElapsedValue,\r
 468     OSServiceId_TerminateApplication,\r
 469     OSServiceId_AllowAccess,\r
 470     OSServiceId_GetApplicationState,\r
 471 \r
 472 #if defined(USE_KERNEL_EXTRA)\r
 473     OSServiceId_Sleep,\r
 474 #endif\r
 475 } OsServiceIdType;\r
 476 \r
 477 typedef struct OsError {\r
 478         OsServiceIdType serviceId;\r
 479         uint32_t param1;\r
 480         uint32_t param2;\r
 481         uint32_t param3;\r
 482 } OsErrorType;\r
 483 \r
 484 extern OsErrorType os_error;\r
 485 \r
 486 // TODO: Add the service id to all OS service methods.\r
 487 static inline OsServiceIdType OSErrorGetServiceId(void)  {\r
 488         return os_error.serviceId;\r
 489 }\r
 490 \r
 491 extern OsErrorType os_error;\r
 492 \r
 493 #define OSError_ActivateTask_TaskID ((TaskType) os_error.param1)\r
 494 #define OSError_ChainTask_TaskID ((TaskType) os_error.param1)\r
 495 #define OSError_GetTaskID_TaskID ((TaskRefType) os_error.param1)\r
 496 #define OSError_GetResource_ResID ((ResourceType) os_error.param1)\r
 497 #define OSError_ReleaseResource_ResID ((ResourceType) os_error.param1)\r
 498 #define OSError_SetEvent_TaskID ((TaskType) os_error.param1)\r
 499 #define OSError_SetEvent_Mask ((EventMaskType) os_error.param2)\r
 500 #define OSError_ClearEvent_Mask ((EventMaskType) os_error.param1)\r
 501 #define OSError_GetEvent_TaskId ((TaskType) os_error.param1)\r
 502 #define OSError_GetEvent_Mask ((EventMaskRefType) os_error.param2)\r
 503 #define OSError_WaitEvent_Mask ((EventMaskType) os_error.param1)\r
 504 #define OSError_GetAlarmBase_AlarmId ((AlarmType) os_error.param1)\r
 505 #define OSError_GetAlarmBase_Info ((AlarmBaseRefType) os_error.param2)\r
 506 #define OSError_GetAlarm_AlarmId ((AlarmType) os_error.param1)\r
 507 #define OSError_GetAlarm_Tick ((TickRefType) os_error.param2)\r
 508 #define OSError_SetRelAlarm_AlarmId ((AlarmType) os_error.param1)\r
 509 #define OSError_SetRelAlarm_Increment ((TickType) os_error.param2)\r
 510 #define OSError_SetRelAlarm_Cycle ((TickType) os_error.param3)\r
 511 #define OSError_SetAbsAlarm_AlarmId ((AlarmType) os_error.param1)\r
 512 #define OSError_SetAbsAlarm_Start ((TickType) os_error.param2)\r
 513 #define OSError_SetAbsAlarm_Cycle ((TickType) os_error.param3)\r
 514 #define OSError_CancelAlarm_AlarmId ((AlarmType) os_error.param1)\r
 515 #define OSError_StartOS_Mode ((AppModeType) os_error.param1)\r
 516 #define OSError_ErrorHook_Error ((StatusType) os_error.param1)\r
 517 #define OSError_ShutdownHook_Error ((StatusType) os_error.param1)\r
 518 #define OSError_GetTaskState_TaskId ((TaskType) os_error.param1)\r
 519 #define OSError_GetTaskState_State ((TaskStateRefType) os_error.param2)\r
 520 \r
 521 /** @req OS398 */\r
 522 #if defined(LOCALMESSAGESONLY)\r
 523 #error LOCALMESSAGESONLY shall not be defined\r
 524 #endif\r
 525 \r
 526 \r
 527 /*-------------------------------------------------------------------\r
 528  * COM ( TODO : move )\r
 529  *-----------------------------------------------------------------*/\r
 530 \r
 531 /*\r
 532  * The only information about the COM that is valid is\r
 533  * in the COM specification ..SWS_COM.pdf.\r
 534  *\r
 535  * The most important requirements are COM010 and COM013\r
 536  *\r
 537  * Com_Init()\r
 538  * Com_DeInit()\r
 539  *\r
 540  * No error hooks..\r
 541  * No. GetMessageStatus()\r
 542  * No. SendZeroMessage()\r
 543  * No. SendDynamicMessage(), RecieveDynamicMessage()\r
 544  *\r
 545  * Yes. SendMessage()\r
 546  *\r
 547  * */\r
 548 \r
 549 \r
 550 typedef uint32 MessageType;\r
 551 typedef void *ApplicationDataRef;\r
 552 \r
 553 \r
 554 StatusType SendMessage( MessageType message_id, ApplicationDataRef dataRef );\r
 555 StatusType ReceiveMessage( MessageType message_id, ApplicationDataRef dataRef );\r
 556 \r
 557 /*\r
 558  * ArcCore extensions\r
 559  */\r
 560 TickType GetOsTick();\r
 561 void OsTick(void);\r
 562 void OsIdle(void);\r
 563 \r
 564 #define OS_ISR_TYPE2    0\r
 565 #define OS_ISR_TYPE1    1\r
 566 \r
 567 union isr_attr {\r
 568         TaskType tid;\r
 569         void (*entry)(void);\r
 570 };\r
 571 \r
 572 #define TTY_NONE                1\r
 573 #define TTY_T32         2\r
 574 #define TTY_WINIDEA     4\r
 575 #define TTY_SERIAL              8\r
 576 #define RAMLOG          16\r
 577 \r
 578 #endif /*OS_H_*/\r