TechnicalReference_Oss

MICROSAR OS
Technical Reference


Version 2.12.0

Authors
Anton  Schmukel,  Ivan  Begert,  Stefano  Simoncelli,
Torsten  Schmidt,  Da  He,  David  Feuerstein,  Michael
Kock,  Martin  Schultheiß,  Andreas  Jehl,  Fabian  Wild,
Senol Cendere, Benjamin Seifert
Status
Released

Technical Reference MICROSAR OS
Document Information
History
Author
Date
Version  Remarks
Torsten Schmidt
2016-04-27  1.0.0
First release version
Torsten Schmidt
2016-05-18  1.0.1
References to hardware manuals added.
Revision work
Torsten Schmidt
2016-06-03  1.0.2
Fix of ESCAN00089598
Torsten Schmidt
2016-06-20  1.1.0
List of OS internal objects added.
Additional startup concept chapter added.
Chapter “Memory mapping concept” reworked.
Description of “generate callout stubs” feature
added.
Torsten Schmidt
2016-07-05  1.1.1
Chapter “Memory Mapping Concept” extended.
IOC notification callback concept changed.
HSI of RH850 family added.
HSI of Power PC family added.
Torsten Schmidt
2016-07-19  1.1.2
Chapter “Memory Mapping Concept” changed.
Hints for shorter compile times added.
Nesting behavior of OS hooks described.
Ivan Begert
2016-08-11  1.1.3
HSI of ARM family added.
Torsten Schmidt
2016-08-12  1.1.4
Chapter “Memory Mapping Concept” extended.
Chapter “Clear Pending Interrupt” extended.
Chapter “RH850 Special Characteristics” extended.
Ivan Begert
2016-08-18  1.1.5
HSI of ARM Zynq UltraScale added.
Torsten Schmidt
2016-08-30  1.1.6
HSI of RH850 extended.
Torsten Schmidt
2016-08-31  1.1.7
ORTI Debugging added.
Timing Hook Macros reworked.
Chapter “Memory Mapping Concept” changed.
Chapter “Category 1 Interrupts” extended.
Stefano Simoncelli  2016-09-15  1.1.8
Chapter “Interrupt Source API” extended.
Torsten Schmidt
HSI chapter for ARM extended
Torsten Schmidt
2016-09-22  1.2.0
VTT OS and Dual Target Concept added.
Chapter ORTI Debugging extended.
Anton Schmukel
2016-10-14  1.3.0
Ristrictions concerning API usage before StartOS()
Da He
documented.
Clarification concerning forcible termination and
schedule tables added.
Deviations in IOC added.
Notes on mixed criticality systems added.
Chapter “RH850 Special Characteristics” extended.
Torsten Schmidt
2016-10-19  1.3.1
Chapter “Configuration of X-Signals” added.
Chapter “Power PC Special Characteristics”
© 2017 Vector Informatik GmbH
Version 2.12.0
2
based on template version 6.0.1

Technical Reference MICROSAR OS
extended.
Correction of startup examples.
Chapter “User include files” added.
RH850 HSI extended.
PPC HSI extended.
Hardware Overview extended by RH850.
David Feuerstein
2016-11-03  1.4.0
PPC HSI extended.
Chapter ORTI Debugging extended.
Michael Kock
2016-11-25  1.5.0
Updated chapter Timing Hooks
Martin Schultheiß  2016-12-08  1.6.0
PPC HSI extended.
Updated characteristics of VTT OS.
David Feuerstein
2016-12-22  1.7.0
Updated precautions in PreStartTask.
Andreas Jehl
Support new Power PC Derivative: PC580003
Ivan Begert
Support IAR compiler for ARM
Stefano Simoncelli
ARM Cortex-A HSI added
David Feuerstein
2017-01-23  1.8.0
Chapter “Memory Mapping Concept” changed.
Torsten Schmidt
Chapter “Resulting sections” extended.
Chapter “X-Signals” extended.
Chapter “API Description” extended.
Torsten Schmidt
2017-02-06  2.0.0
Chapter “Memory Mapping Concept” corrected.
Stefano Simoncelli
Chapter “MICROSAR OS Deviations from
David Feuerstein
AUTOSAR OS Specification” extended.
Chapter “IOC” extended.
Feature “Fast Trusted Functions” added.
Chapter “Non-Trusted Functions (NTF)” changed.
ARM Cortex-M Hardware overview updated.
Feature “Barriers” added.
Martin Schultheiß  2017-03-22  2.1.0
Updated Hardware Overview for Power PC
Benjamin Seifert
derivative groups (RM revisions).
Da He
Chapter “MICROSAR OS Deviations from
Torsten Schmidt
AUTOSAR OS Specification” corrected.
Stefano Simoncelli
Added API
Anton Schmukel
OSError_GetScheduleTableStatus_ScheduleStatus

Chapter “ARM Special characteristic” extended.
Chapter “Cortex-R derivatives” extended.
Chapter “Idle Task” extended.
TI Compiler added as supported compiler for ARM.
Platform POSIX added
Added HSI for ARM Cortext-M
Fabian Wild
2017-03-31  2.2.0
Added AUTOSAR specification deviations.
Stefano Simoncelli
Changed address parameter type in periperal API
functions.
Da He
2017-04-11  2.3.0
Added HSI for TI AR16xx
Martin Schultheiß
Added information for Hardware Init Core
Senol Cendere
2017-05-10  2.4.0
Added HSI for R-Car H3.
Torsten Schmidt
© 2017 Vector Informatik GmbH
Version 2.12.0
3
based on template version 6.0.1

Technical Reference MICROSAR OS
Martin Schultheiß
Extended chapter “Memory Mapping Concept”.
Da He
Added chapter “Linking of Spinlocks”.
Updated HSI for S32K derivatives.
Added chapter for exception context manipulation
Fabian Wild
2017-06-19  2.5.0
Removed ORTI tracing from Os_Init and
Martin Schultheiß
Os_InitMemory
Support new Power PC Derivative: SPC574Sxx
Torsten Schmidt
2017-06-06  2.6.0
Added descriptions for category 0 ISRs.
Ivan Begert
2017-07-05  2.6.1
Chapter “ARM Special characteristic” extended.
Senol Cendere
RH850 HSI extended.
Updated Table 1-9 Supported RH850 Compilers.
Updated Chapter 4.5.2 RH850
Torsten Schmidt
2017-07-17  2.7.0
Chapter “Software Stack Check” extended.
Chapter “VTT OS Specifics” extended.
Chapter “Initialization of Interrupt Sources”
extended.
Chapter “Notes on Category 1 ISRs” extended.
Chapter “Notes on Category 0 ISRs” extended.
Chapter “Pre-Process Linker Command Files”
added.
API description of “Os_Init” extended.
Senol Cendere
2017-08-15  2.8.0
Documented support for more RH850 derivatives
Da He
and compiler versions.
Andreas Jehl
Updated documentations regarding location of OS
identifiers.
Support ARM CC (5.x) compiler for ARM Cortex-M
Documented support of TC39x derivative with
Tasking v6.0r1p2 compiler
Martin Schultheiß  2017-08-17  2.9.0
Updated Derivative Support for PPC and RH850
Senol Cendere
2017-10-25  2.10.0
New vector timing hooks
Torsten Schmidt
OS_VTHACTIVATION_LIMIT and
Rainer
OS_VTH_WAITEVENT_NOWAIT, usage of vector
Künnemeyer
timing hooks now also in safety systems. Chapter
“Task Stack Sharing” Extended
Added comments on RTE interrupt API
Da He
2017-11-13  2.11.0
Support GCC Linaro compiler for ARM Cortex-A/R
Benjamin Seifert
and Cortex-M
Added HighTec compiler support for PowerPC and
TriCore
Added MPC56xx derivatives to chapter “Hardware
Overview” and “Hardware Software Interfaces”
Fixed Timing Hooks API descriptions
Stefano Simoncelli  2017-12-14  2.12.00  Support for TDA2x family derivatives
Torsten Schmidt
Support for TriCore Aurix TC38x
Benjamin Seifert
Added caution to chapter “Aurix Special
Characteristics
Fixed descriptions in chapter "Os generated
© 2017 Vector Informatik GmbH
Version 2.12.0
4
based on template version 6.0.1

Technical Reference MICROSAR OS
objects"

© 2017 Vector Informatik GmbH
Version 2.12.0
5
based on template version 6.0.1

Technical Reference MICROSAR OS
Reference Documents
No.
Source
Title
Version
[1]
AUTOSAR
Specification of Operating System
4.2.1
Document ID 034:  AUTOSAR_SWS_OS
[2]
OSEK/VDX
OSEK/VDX Operating System Specification
2.2.3
This document is available in PDF-format on
the Internet at the OSEK/VDX homepage
(http://www.osek-vdx.org)
[3]
OSEK/VDX
OSEK RunTime Interface (ORTI) Part A:
2.2
Language Specification.
This document is available in PDF-format on
the Internet at the OSEK/VDX homepage
(http://www.osek-vdx.org)
[4]
OSEK/VDX
OSEK Run Time Interface (ORTI) Part B: OSEK  2.2
Objects and Attributes
This document is available in PDF-format on
the Internet at the OSEK/VDX homepage
(http://www.osek-vdx.org)
[5]
Lauterbach
ORTI Representation of SMP Systems (ORTI
4
2.3)
[6]
Vector
vVIRTUALtarget Technical Reference
See delivery
information
[7]
Vector
Startup with Vector and vVIRTUALtarget
See delivery
information
[8]
Vector
MICROSAR VStdLib Technical Reference
See delivery
TechnicalReference_VStdLib_GenericAsr.pdf
information

Caution
We have configured the programs in accordance with your specifications in the

questionnaire. Whereas the programs do support other configurations than the one
specified in your questionnaire, Vector´s release of the programs delivered to your
company is expressly restricted to the configuration you have specified in the
questionnaire.

© 2017 Vector Informatik GmbH
Version 2.12.0
6
based on template version 6.0.1

Technical Reference MICROSAR OS
1  Introduction
This  document  describes  the  usage  and  functions  of  “MICROSAR  OS”,  an  operating
system which implements the AUTOSAR BSW module “OS” as specified in [1].
This  documentation  assumes  that  the  reader  is  familiar  with  both  the  OSEK  OS1
specification and the AUTOSAR OS specification.
1.1
Architecture Overview
The  following  figure  shows  the  location  of  the  OS  module  within  the  AUTOSAR
architecture.

Figure 1-1  AUTOSAR Architecture Overview


1 OSEK is a registered trademark of Continental Automotive GmbH (until 2007: Siemens AG)
© 2017 Vector Informatik GmbH
Version 2.12.0
24
based on template version 6.0.1

Technical Reference MICROSAR OS
1.2
Abstract
The  MICROSAR  OS  operating  system  is  a  real  time  operating  system,  which  was
specified for the usage in electronic control.
As a requirement, there is no dynamic creation of new tasks at runtime; all tasks have to
be defined before compilation (pre-compile configuration variant).
The OS has no dynamic memory management and there is no shell for the control of tasks
by hand.
Typically  the  source  and  configuration  files  of  the  operating  system  and  the  application
source files are compiled and linked together to one executable file, which is loaded into
an emulator or is burned into an EPROM or Flash EEPROM.
1.3
Characteristics
MICROSAR OS has the following characteristics:
Supported Scalability Classes
SC1, SC2, SC3, SC4 (as described in [1])
Single Core ECUs
Supported
Multi Core ECUs
Supported
IOC
Supported
Table 1-1   MICROSAR OS Characteristics
MICROSAR  OS  supports  various  different  processor  families  of  different  vendors  in
conjunction with multiple compilers.
The  availability  for  a  particular  processor  in  conjunction  with  a  specific  compiler  can  be
queried from Vector Informatik.

© 2017 Vector Informatik GmbH
Version 2.12.0
25
based on template version 6.0.1

Technical Reference MICROSAR OS
1.4
Hardware Overview
The  following  table  summarizes  information  about  MICROSAR  OS.  It  gives  detailed
information  about  the  derivatives  and  compilers.  As  very  important  information  the
documentations of the hardware manufacturers are listed. MICROSAR OS is based upon
these documents in the given version.
Table Rows
>  Compiler: List of Compilers MICROSAR OS is working with.
>  Derivative: This can be a single information or a list of derivatives, MICROSAR OS
can be used on.
>  Hardware Manufacturer Document Name: List of hardware documentation
MICROSAR OS is based on.
>  Document Version: To be able to reference to this hardware documentation its
version is very important.

© 2017 Vector Informatik GmbH
Version 2.12.0
26
based on template version 6.0.1

Technical Reference MICROSAR OS
1.4.1
TriCore Aurix
Derivative  Hardware Manufacturer Document Name
Document
Version
TC21x
User Manual: tc23x_tc22x_tc21x_um_v1.1.pdf
V1.1
TC22x
Errata Sheet: TC22x_TC21x_AB_Errata_Sheet_v1_2_03804A.pdf
V1.2
TC23x
TC24x
Target Specification: tc24x_ts_v2.0_OPEN_MARKET.pdf
V2.0
TC26x
User Manual:
V1.3
tc26xB_um_v1.3._usermanual_rev1v3.pdf
Errata Sheet:
V1.2
TC26x_BB_Errata_Sheet_rev1v2_03989A_2016-04-18.pdf
TC27x
User Manual:
V2.2
tc27xD_um_v2.2_UserManual_rev2v2_2014-12.pdf
Errata Sheet:
V1.5
TC27x_BC_Errata_Sheet_rev1v5_2015_09_16.pdf
TC29x
User Manual:
V1.3
tc29xB_um_v1.3._TC29x_B-Step_User_Manual_rev_1v3_2014_12.pdf
Errata Sheet:
V1.0
TC29x_BA_Errata_Sheet_v1_0.pdf
TC38x
User Manual:
V1.3
TC3XX_ts__TargetSpec_rev1v3v0.pdf V1.3.0, 2016-02
Appendix:
V2.3
TC38X_ts_appx_V2.3.0.pdf V2.3.0 2017-09
TC39x
User Manual:
V1.3
TC3XX_ts__TargetSpec_rev1v3v0.pdf V1.3.0, 2016-02
Errata Sheet:
V1.0
TC39x AA_Errata_Sheet_rev1v0_2016-06-08.pdf Rel. 1.0, 2016-06-08
Table 1-2   Supported TriCore Aurix Hardware

Tasking
v4.2r2 (TC2xx only)
v6.0r1p2 (TC3xx only)
HighTec (GNU)
V4.6.3.0
Table 1-3   Supported TriCore Aurix Compilers

© 2017 Vector Informatik GmbH
Version 2.12.0
27
based on template version 6.0.1

Technical Reference MICROSAR OS
1.4.2
Power PC
Derivative
Hardware Manufacturer Document Name
Document
Version
MPC560xB
Freescale Semiconductor MPC5607B
Rev. 7.2, 05/2012
Microcontroller Reference Manual
Freescale Semiconductor e200z0
Rev. 0, 04/2008
Power Architecture Core Reference Manual
MPC560xC
Freescale Semiconductor MPC5604B/C
Rev. 8.2, 09/2013
Microcontroller Reference Manual
Freescale Semiconductor e200z0
Rev. 0, 04/2008
Power Architecture Core Reference Manual
MPC564xB
Freescale Semiconductor MPC5646C
Rev. 5, 11/2013
Microcontroller Reference Manual
Freescale Semiconductor e200z4
Rev. 0, 10/2009
Power Architecture Core Reference Manual
MPC564xC
Freescale Semiconductor MPC5646C
Rev. 5, 11/2013
Microcontroller Reference Manual
Freescale Semiconductor e200z0
Rev. 0, 04/2008
Power Architecture Core Reference Manual
Freescale Semiconductor e200z4
Rev. 0, 10/2009
Power Architecture Core Reference Manual
MPC564xL
Freescale Semiconductor MPC5643L
Rev. 10, 06/2013
Microcontroller Reference Manual
Freescale Semiconductor e200z4
Rev. 0, 10/2009
Power Architecture Core Reference Manual
Freescale Semiconductor Safety Manual for Qorivva
Rev. 2, 04/2013
MPC5643L
MPC567xF
Freescale Semiconductor MPC5674F
Rev. 7, 02/2015
Microcontroller Reference Manual
Freescale Semiconductor e200z760n3
Rev. 2, 06/2012
Power Architecture Core Reference Manual
MPC567xK
Freescale Semiconductor Qorivva MPC5675K
Rev. 10, 11/2013
Microcontroller Reference Manual
Freescale Semiconductor e200z760n3
Rev. 2, 06/2012
Power Architecture Core Reference Manual
Freescale Semiconductor Safety Manual for Qorivva
Rev. 1, 12/2012
MPC567xK
MPC567xR
Freescale Semiconductors MPC5676R
Rev. 5, 09/2012
Microcontroller Reference Manual
Freescale Semiconductor e200z759n3
Rev. 2, 01/2015
Power Architecture Core Reference Manual
MPC574xBD
Freescale Semiconductor MPC5746C
Rev. 2.1, 06/2015
© 2017 Vector Informatik GmbH
Version 2.12.0
28
based on template version 6.0.1

Technical Reference MICROSAR OS
Reference Manual
MPC574xC1
Freescale Semiconductor MPC5746C
Rev. 2.1, 06/2015
Reference Manual
MPC574xC2
NXP MPC5748G Reference Manual
Rev. 4, 07/2015
MPC574xG
NXP MPC5748G Reference Manual
Rev. 4, 07/2015
NXP Safety Manual for MPC5748G
Rev. 2, 01/2016
MPC574xK
ST SPC574Kxx
Rev. 5, 08/2015
Reference Manual
MPC574xM
Freescale Semiconductor MPC5746M
Rev. 5.1, 04/2014
Reference Manual
MPC574xP
Freescale Semiconductor MPC5744P
Rev. 5.1, 02/2015
Reference Manual
NXP Safety Manual for MPC5744P
Rev. 3, 06/2014
MPC574xR
NXP MPC5746R
Rev. 6, 03/2016
Reference Manual
MPC577xC
Freescale Semiconductors MPC5777C
Rev. 8, 11/2016
Microcontroller Reference Manual
Freescale Semiconductor e200z759n3
Rev. 2, 01/2015
Power Architecture Core Reference Manual
Freescale Semiconductor Safety Manual for MPC5777C
Rev. 2.1, 02/2017
MPC577xK
Freescale Semiconductor MPC5775K
Rev. 4, 12/2015
Reference Manual
MPC577xM
NXP MPC5777M
Rev. 4, 04/2015
Reference Manual
MPC577xN
Freescale Semiconductor MPC5774N
Rev. 2, 02/2014
Reference Manual
PC580000
Freescale Semiconductor QUASAR0
Rev. 3, 03/2015
Reference Manual

PC580002
Freescale Semiconductor QUASAR2 Cut2
Rev. 5, 07/2014
Reference Manual
PC580002e
NXP QUASAR2e Reference Manual
Rev. 2, 06/2017
PC580003
NXP QUASAR3 Reference Manual
Rev. 5.2, 01/2017
SPC58ECxx
ST SPC584Cx/SPC58ECx
Rev. 2, 10/2016
Reference Manual
SPC58EGxx
ST SPC58NE84x/SPC58xG84x
Rev. 2, 02/2016
Reference Manual
SPC58NGxx
ST SPC58NE84x/SPC58xG84x
Rev. 2, 02/2016
Reference Manual
SPC582Bxx
ST SPC582Bx
Rev. 2, 09/2016
Reference Manual
SPC584Bxx
ST SPC584Cx/SPC58ECx
Rev. 1, 10/2015
Reference Manual
© 2017 Vector Informatik GmbH
Version 2.12.0
29
based on template version 6.0.1

Technical Reference MICROSAR OS
SPC584Cxx
ST SPC584Cx/SPC58ECx
Rev. 2, 10/2016
Reference Manual
SPC584Gxx
ST SPC58NE84x/SPC58xG84x
Rev. 2, 02/2016
Reference Manual
SPC574Sxx
ST SPC574Sx Reference Manual
Rev. 3, 05/2016
Table 1-4   Supported Power PC Hardware
Windriver DiabData
5.9.4.x
Green Hills (GHS)
2014.1.6
HighTec (GNU)
4.6.6.1
Table 1-5   Supported Power PC compilers
1.4.3
ARM
Derivative
Hardware Manufacturer Document Name
Document
Version
S6J32xx
Cypress S6J3200 Series Hardware Manual
Rev. 4.0,
09/2015
ZUxxx
XILINX Zynq UltraScale+ MPSoc Technical Reference
v1.2, 06/2016
Manual
iMX6xx
i.MX 6Dual/6Quad  Applications Processor Reference
Rev. 3,
Manual
07/2015
ATSAMV7x
SAM v70 Datasheet
Rev.11297D,
06/2016
S32K14x
NXP/Freescale - S32K14x Series Reference Manual -
Rev. 3,
Supports S32K142, S32K144, S32K146, and S32K148
03/2017
Generic Cortex-M  ARMv7-M Architecture Reference Manual
v.E.b
12/2015
AR16xx
16xx Technical Reference Manual
SWRU431,
November
2016
TDA2x
TDA2x Technical Reference Manual
SPRUI29D,
November
2015
Table 1-6   Supported ARM Hardware
Green Hills (GHS)
2013.5.4
IAR
V7.50.1
TI
v15.12.3.LTS
ARM CC
5.06u1
GCC Linaro Distribution
gcc-linaro-7.1.1-2017.08-i686-mingw32_arm-eabi
Table 1-7   Supported ARM compilers
© 2017 Vector Informatik GmbH
Version 2.12.0
30
based on template version 6.0.1

Technical Reference MICROSAR OS

© 2017 Vector Informatik GmbH
Version 2.12.0
31
based on template version 6.0.1

Technical Reference MICROSAR OS
1.4.4
RH850
Derivative Family
Hardware Manufacturer Document Name
Document Version
RH850 C1M
RH850/C1x User’s Manual: Hardware
Rev.1.00 Mar 2015
RH850 C1H
RH850/C1x User’s Manual: Hardware
Rev.1.00 Mar 2015
RH850 D1x
RH850/D1L/D1M Group User’s Manual: Hardware  Rev.2.01 Aug 2016
RH850 E1x FCC2
RH850/E1x-FCC2 User’s Manual: Hardware
Rev.1.00 Jun 2016
RH850 E1x FCC1
RH850/E1x-FCC1 User’s Manual: Hardware
Rev.0.50 Jul 2014
RH850 E1L
RH850/E1L User’s Manual: Hardware
Rev.1.10 Apr 2016
RH850 E1M
RH850/E1M-S User’s Manual: Hardware
Rev.1.10 Apr 2016
RH850 F1H
RH850/F1H Group User’s Manual: Hardware
Rev.1.12 May 2016
RH850 F1L
RH850/F1L Group User’s Manual: Hardware
Rev.1.33 Apr 2016
RH850 F1K
RH850/F1K Group User’s Manual: Hardware
Rev.1.00 Jun 2016
RH850 F1KM
RH850/F1KM Group User’s Manual: Hardware
Rev.0.50 Jan 2017
RH850 F1M
RH850/F1M Group User’s Manual: Hardware
Rev.1.03 May 2016
RH850 P1HC
RH850/P1x-C Group User’s Manual: Hardware
Rev.1.10 Jul 2016
RH850 P1MC
RH850/P1x-C Group User’s Manual: Hardware
Rev.1.10 Jul 2016
RH850 P1M
RH850/P1x Group User’s Manual: Hardware
Rev.1.00 Jul, 2015
RH850 R1L
RH850/R1x Group User’s Manual: Hardware
Rev.1.31 Jun 2016
G3K Core
RH850G3K User’s Manual: Software
Rev.1.20 Apr 2016
G3KH Core
RH850G3KH User’s Manual: Software
Rev.1.10 Jul 2016
G3M Core
RH850G3M User’s Manual: Software
Rev.1.30 Jun 2016
G3MH Core
RH850G3MH User’s Manual: Software
Rev.1.00 Mar 2015
Table 1-8   Supported RH850 Hardware
Green Hills (GHS)
V6.1.4 2013.5.4
V6.1.4 2013.5.5
V6.1.6 2014.1.7
V6.1.6 2015.1.5
V6.1.6 2015.1.7
Table 1-9   Supported RH850 Compilers

© 2017 Vector Informatik GmbH
Version 2.12.0
32
based on template version 6.0.1

Technical Reference MICROSAR OS
1.4.5
VTT OS
VTT  OS  stands  for  “vVIRTUALtarget  Operating  System”.  It  runs  within  Vectors  CANoe
development tool.
Vectors CANoe is capable of simulating an entire ECU network. Within such a simulated
network the OS of each ECU can be simulated.
This is useful in early ECU development phases when no real hardware is available yet.
Application development can be started at once.
The VTT OS behaves as regular AUTOSAR  OS. All OS objects  (e.g.  tasks or ISRs) are
simulated.
The VTT system is described in [6].
1.4.5.1
Characteristics of VTT OS
Supported Scalability Classes
SC1, SC2
Single Core ECUs
Supported
Multi Core ECUs
Up to 32 cores are supported
IOC
Supported
Number of Simulated Interrupt Sources  Up to 10000
Simulated Interrupt Levels
VTT OS allows interrupt levels from 1 .. 200
Whereas 1 is the lowest priority and 200 is the
highest.
Memory Protection
Not supported2
Stack Protection
Not supported
Stack Usage Measurement
Not supported
Stack Sharing
Not supported
Table 1-10   VTT OS characteristics
1.4.6
POSIX OS
POSIX OS is an AUTOSAR Operating System running as a process in the user space of a
POSIX3 host.
There  are  no  dependencies  with  the  underlying  hardware  or  with  specific  POSIX
conforming host OS (QNX, Linux…).
In the Adaptive AUTOSAR scenario, it is necessary to exploit new resources (i.e. pthreads)
offered by such environment and to deal with the new abstraction layers.


2 The memory protection can be configured. However the actual protection mechanism is not executed.
3 Portable Operating System Interface
© 2017 Vector Informatik GmbH
Version 2.12.0
33
based on template version 6.0.1

Technical Reference MICROSAR OS
1.4.6.1
Characteristic of POSIX OS
Supported Scalability Classes
SC1
Single Core ECUs
Supported
Multi Core ECUs
Not supported
IOC
Supported
Number of Simulated Interrupt
Up to 10000
Sources
Simulated Interrupt Levels
POSIX OS allows interrupt levels from 1 .. 100
Whereas 1 is the lowest priority and 100 is the
highest.
Memory Protection
Not supported4
Stack Protection
Not supported
Stack Usage Measurement
Not supported
Stack Sharing
Not supported
Table 1-11 POSIX OS characteristic

4 The memory protection can be configured. However the actual protection mechanism is not executed.
© 2017 Vector Informatik GmbH
Version 2.12.0
34
based on template version 6.0.1

Technical Reference MICROSAR OS
2  Functional Description
2.1
General
The  MICROSAR  OS  basically  implements  the  OS  according  to  the  AUTOSAR  OS
standard referred in [1].
It  is  possible  that  MICROSAR  OS  deviates  from  specified  AUTOSAR  OS  behavior.  All
deviations from the standard are listed in the chapters hereafter.
On  the  other  hand  MICROSAR  OS  extends  the AUTOSAR  OS  standard  with  numerous
functions. These extensions in function are described in detail in chapter 2.21.1.
2.2
MICROSAR OS Deviations from AUTOSAR OS Specification
2.2.1
Generic Deviation for API Functions
Specified Behavior
There are some API functions which are only available within specific
scalability classes (e.g. TerminateApplication() in SC3 and SC4 only).
Deviation Description
Within the MICROSAR OS all API functions are always available.
Deviation Reason
The static OS code gets more simplified for better maintainability (less
pre-processor statements are necessary).
Modern toolchains will remove unused function automatically.

2.2.2
Trusted Function API Deviations
Specified Behavior
The Operating System shall not schedule any other Tasks which
belong to the same OS-Application as the non-trusted caller of the
service. Also interrupts of Category 2 which belong to the same OS-
Application shall be disabled during the execution of the service.
Deviation Description
In MICROSAR OS the re-scheduling of tasks in this particular case is
not suppressed.
The selective disabling of category 2 ISRs is also not done.
Deviation Reason
For a better runtime performance during trusted function calls the
specified behavior is not implemented in MICROSAR OS.
Data consistency problems can be solved in a more efficient way by
using the OS interrupt API and/or OS resource API.

© 2017 Vector Informatik GmbH
Version 2.12.0
35
based on template version 6.0.1

Technical Reference MICROSAR OS
Specified Behavior
All specified OS APIs should be called with interrupts enabled.
In case CallTrustedFunction() API is called with disabled interrupts it
returns the status code E_OS_DISABLEDINT.
Deviation Description
In MICROSAR OS this limitation does not exist.
It is allowed to call CallTrustedFunction() API with disabled interrupts.
There is no error check.
The return value E_OS_DISABLEDINT is not possible.
Deviation Reason
It offers the possibility to call CallTrustedFunction() API where
interrupts may be disabled. This is more convenient and reasonable.

2.2.3
Service Protection Deviation
Specified Behavior
If an invalid address (address is not writable by this OS-Application) is
passed as an out-parameter to an Operating System service, the
Operating System module shall return the status code
E_OS_ILLEGAL_ADDRESS.
Deviation Description
The validity of out-parameters is checked automatically by the MPU.
Write accesses to such parameters are always done with the
accessing rights of the caller of the OS service.
If the address is invalid a MPU exception is raised.
The return value E_OS_ILLEGAL_ADDRESS is not possible.
Deviation Reason
Hardware checks by the MPU are much more performant than
software memory checks.

2.2.4
Code Protection
Specified Behavior
The Operating System module may provide an OS-Application
the ability to protect its code sections against executing by non-
trusted OS-Applications.
Deviation Description The MICROSAR OS does not support code section protection.
Deviation Reason
Design decision.

2.2.5
SyncScheduleTable API Deviation
Specified Behavior
All specified OS APIs should be called with interrupts enabled.
In case SyncScheduleTable() is called with disabled interrupts it
returns the status code E_OS_DISABLEDINT.
Deviation Description
In MICROSAR OS this limitation does not exist.
It is allowed to call SyncScheduleTable() with disabled interrupts.
There is no error check.
The return value E_OS_DISABLEDINT is not possible.
Deviation Reason
It offers the possibility to call SyncScheduleTable() where interrupts
may be disabled. This is more convenient and reasonable.

© 2017 Vector Informatik GmbH
Version 2.12.0
36
based on template version 6.0.1

Technical Reference MICROSAR OS
2.2.6
CheckTask/ISRMemoryAccess API Deviation
Specified Behavior
All specified OS APIs should be called with interrupts enabled.
In case one of these APIs is called with disabled interrupts it issues
the error E_OS_DISABLEDINT.
Deviation Description
In MICROSAR OS this limitation does not exist.
It is allowed to call these API functions with disabled interrupts. There
is no error check.
The return value E_OS_DISABLEDINT is not possible.
Deviation Reason
It offers the possibility to call these functions e.g. from hardware
drivers where interrupts may be disabled. This is more convenient and
reasonable.

Specified Behavior
The API functions CheckTask/ISRMemoryAccess() are only allowed
within specific OS call contexts (Task/Cat2
ISR/ErrorHook/ProtectionHook)
In case one of these APIs is called within the wrong OS call context it
issues the error E_OS_CALLEVEL.
Deviation Description
In MICROSAR OS In MICROSAR OS this limitation does not exist.
It is allowed to call these API functions from all OS contexts.
The return value E_OS_CALLEVEL is not possible.
Deviation Reason
Practically it is more reasonable to allow these APIs in all OS runtime
contexts.

2.2.7
Interrupt API Deviation
Specified Behavior
The API functions SuspendOSInterrupts() and ResumeOSInterrupts()
are allowed within a category 1 ISR
Deviation Description
In MICROSAR OS it is not allowed to use SuspendOSInterrupts() and
ResumeOSInterrupts() within a category 1 ISR.
Deviation Reason
The function SuspendOSInterrupts() lowers the current interrupt level
when used in a category 1 ISR. This may lead to data inconsistencies
if another category 1 ISR occurs.
Therefore those functions are not allowed.

2.2.8
Cross Core Getter APIs
Specified Behavior
All getter APIs (e.g. GetTaskID()) may be called cross core within
hooks and non nestable category 2 ISRs.
Deviation Description
MICROSAR OS does not allow usage of those functions within OS
Hooks and non-nestable category 2 ISRs.
Deviation Reason
Deadlock avoidance due to disabled interrupts in case that there are
two simultaneous concurrent usages of those APIs from multiple
cores.

© 2017 Vector Informatik GmbH
Version 2.12.0
37
based on template version 6.0.1

Technical Reference MICROSAR OS
2.2.9
IOC
Specified Behavior
IocSend/IocWrite APIs have an IN parameter. The parameter will be
passed by value for primitive data elements and by reference for all
other types. The data type is configured in “OsIocDataTypeRef”.
Deviation Description
The configurator does not evaluate information in
“OsIocDataTypeRef”. Instead it evaluates the parameter
“OsIocDataType“. Primitive data types are passed by value. The
configurator identifies all primitive AUTOSAR and OS data types (e.g.
“uint8”, “sint32”, “TaskType”). All other data types are passed by
reference.
Deviation Reason
Usage of “OsIocDataType” reduces dependencies and complexity of
the OS configurator.

Specified Behavior
The configuration parameter “OsIocInitValue” is specified to be an
initialization value.
Deviation Description
If the used data is of a complex type the configuration parameter
“OsIocInitValue” holds the name of a constant, which contains the
initialization value. For integral types it can hold a value or the name of
a constant containing the value.
Deviation Reason
It enables the OS to initialize complex data types.

2.2.10 Return value upon stack violation
Specified Behavior
If a stack fault is detected by stack monitoring AND no ProtectionHook
is configured, the Operating System module shall call the
ShutdownOS() service with the status E_OS_STACKFAULT.
Deviation Description
Within a SC3 / SC4 system with MPU stack supervision:
If a stack fault is detected by stack monitoring AND no ProtectionHook
is configured, the Operating System module shall call the
ShutdownOS() service with the status
E_OS_PROTECTION_MEMORY.
Deviation Reason
With hardware stack supervision MICROSAR OS is not possible to
distinguish between stack violation and other memory violation

Specified Behavior
If a stack fault is detected by stack monitoring AND a ProtectionHook
is configured the Operating System module shall call the
ProtectionHook() with the status E_OS_STACKFAULT.
Deviation Description
Within a SC3 / SC4 system with MPU stack supervision:
If a stack fault is detected by stack monitoring AND a ProtectionHook
is configured the Operating System module shall call the
ProtectionHook() with the status E_OS_PROTECTION_MEMORY.
Deviation Reason
With hardware stack supervision MICROSAR OS is not possible to
distinguish between stack violation and other memory violation

© 2017 Vector Informatik GmbH
Version 2.12.0
38
based on template version 6.0.1

Technical Reference MICROSAR OS
2.2.11 Handling of OS internal errors
Specified Behavior
In cases where the OS detects a fatal internal error all cores shall be
shut down.
Deviation Description
In case that the OS detects an internal error the kernel panic mode is
entered.
Deviation Reason
In case of OS internal errors normal operations (e.g. calling the
protection hook) are possible no more, as the OS is in an inconsistent
state.

2.2.12 Forcible Termination of Applications
Specified Behavior
AUTOSAR does not specify the handling of “next” schedule tables in
case of forcible termination of applications.
Deviation Description
Use case:
An application has a running schedule table which itself has a nexted
schedule table of a foreign application.
The foreign application is forcibly terminated.

The OS removes the “next” request from the running schedule table.
Deviation Reason
Clarification of behavior.
Impact on other applications should be minimal, therefore the current
schedule table is not stopped. This is different to the behavior of
StopScheduleTable().

Specified Behavior
AUTOSAR does not specify the handling of “next” schedule tables in
case of forcible termination of applications.
Deviation Description
Use case:
An application has a running schedule table which itself has a nexted
schedule table of a foreign application.
The first application is forcibly terminated.

The OS stops the current schedule table of the terminated application.
and removes the “next” request.
As a result it does not switch to the “next” schedule table of the foreign
application.
Deviation Reason
Clarification of behavior.
Impact on other applications should be minimal. The described
behavior is identical to the behavior of StopScheduleTable().

© 2017 Vector Informatik GmbH
Version 2.12.0
39
based on template version 6.0.1

Technical Reference MICROSAR OS
2.2.13  OS Configuration
Specified Behavior
The generator shall print out information about timers used
internally by the OS during generation (e.g. on console, list file).
Deviation Description  In case of MICROSAR OS there is no such output. Instead the
timer is visible to the user as any other timer during configuration.
Deviation Reason
In order to increase the transparency, OS internal objects are
visible to the user during configuration time.

Specified Behavior
If ShutdownOS() is called and ShutdownHook() returns then the
Operating System module shall disable all interrupts and enter an
endless loop.
Deviation Description  If ShutdownOS() is called and ShutdownHook() returns then the
Operating System module enters the kernel panic mode.
Deviation Reason
In case of unusual situations the MICROSAR OS enters the
kernel panic mode. To keep the behaviour of the OS consistent,
the kernel panic mode is also applied in case that the
ShutdownHook() returns.

© 2017 Vector Informatik GmbH
Version 2.12.0
40
based on template version 6.0.1

Technical Reference MICROSAR OS
2.3
Stack Concept
MICROSAR OS implements a specific stack concept.
It  defines  different  stacks  which  may  be  used  by  stack  consumers  (runtime  contexts).
Whereas not all stacks may be used by all consumers.
The following table gives an overview.
Stack Type
Multiplicity  Possible Stack Consumers
Kernel stack
1 per core
>  OS memory exception handling
>  Os_PanicHook()
>  Category 0 ISRs
Protection stack
0..1 per core  >  ProtectionHook()
>  OS API calls
>  Os_PanicHook()
>  Category 0 ISRs
Error stack
0..1 per core  >  ErrorHooks (global and OS-application specific)
>  OS API calls
>  Category 0/1 ISRs
>  Os_PanicHook()
Shutdown stack
0..1 per core  >  ShutdownHooks (global and OS-application
specific)
>  OS API calls
>  Os_PanicHook()
>  Category 0 ISRs
Startup stack
0..1 per core  >  StartupHooks (global and OS-application specific)
>  OS API calls
>  Category 0/1 ISRs
>  Os_PanicHook()
NTF stacks
0..n
>  Non-trusted functions
>  OS API calls
>  OS ISR wrapper
>  Trusted functions
>  Alarm callback functions
>  Pre / PostTaskHook()
>  Category 0/1 ISRs
>  Os_PanicHook()
No nesting interrupt stack
0..1 per core  >  No nesting category 2 ISRs
>  OS API calls
>  Trusted functions
>  Alarm callback functions
>  Category 0/1 ISRs
© 2017 Vector Informatik GmbH
Version 2.12.0
41
based on template version 6.0.1

Technical Reference MICROSAR OS
>  Os_PanicHook()
Interrupt level stacks
0..n
>  Nesting category 2 ISRs
>  OS API calls
>  OS ISR wrapper
>  Trusted functions
>  Alarm callback functions
>  Category 0/1 ISRs
>  Os_PanicHook()
Task stacks
1..n
>  Tasks
>  OS API calls
>  OS ISR wrapper
>  Trusted functions
>  Alarm callback functions
>  Pre / PostTaskHook()
>  Category 0/1 ISRs
>  Os_PanicHook()
IOC receiver pull callback
0..1 per core  >  IOC receiver pull callback functions
stack
>  Category 0 ISRs
Table 2-1   MICROSAR OS Stack Types

Note
The stack sizes of all stacks must be configured within the ECU configuration

2.3.1
Task Stack Sharing
2.3.1.1
Description
In order to save RAM it is possible that  different basic tasks share the same task stack.
Tasks which fulfill the following requirements share a stack:
>  Basic tasks which have the same configured priority.
>  Basic tasks which are non-preemptive and are configured to share stacks. Within
such basic tasks the call of the OS service Schedule() is not allowed.
>  Basic tasks which share an internal resource and are configured to share stacks.
Within such basic tasks the call of the OS service Schedule() is not allowed.
2.3.1.2
Activation
The  attribute  “OsTaskStackSharing”  of  a  basic  task  has  to  be  set  to  TRUE.  The  OS
decides  then  in  dependancy  of  the  preemption  settings  and  assigned  internal  resources
whether the stack of basic tasks may be shared or not.
© 2017 Vector Informatik GmbH
Version 2.12.0
42
based on template version 6.0.1

Technical Reference MICROSAR OS
The size of the shared task stack is the maximum of all stack sizes of tasks which share
the stack.

Note
  The OS activates stack sharing automatically for basic tasks with the same configured
priority regardless of the value of OsTaskStackSharing.

Note
  By setting “OsTaskStackSharing” to TRUE the OS API service Schedule() may not be
called within the corresponding basic task.
The OS throws an error if Schedule() is called within a task with activated stack
sharing.

Note
Stack sharing of tasks can only be achieved between tasks which are assigned to the
  same core!

2.3.1.3
Usage
Tasks  which  are  cooperative  to  each  other  are  sharing  the  same  stack.  No  additional
actions are necessary.
2.3.2
ISR Stack Sharing
2.3.2.1
Description
In  order  to  save  RAM  it  is  possible  that  different  category  2  ISRs  share  the  same  ISR
stack.
>  All category 2 ISRs which are not nestable can share one stack.
>  All Category 2 ISRs which have the same priority can share one stack.
2.3.2.2
Activation
The attribute “OsIsrEnableNesting” must be set to FALSE for a category 2 ISR.
The size of the shared ISR stack is the maximum of all configured ISR stack sizes of non-
nestable category 2 ISRs.
© 2017 Vector Informatik GmbH
Version 2.12.0
43
based on template version 6.0.1

Technical Reference MICROSAR OS

Note
Stack sharing of ISRs can only be achieved between ISRs which are assigned to the
  same core!

2.3.2.3
Usage
The feature is used automatically by the OS. All category 2 ISRs on the same core which
are not nestable are sharing the same stack.
2.3.3
Stack Check Strategy
All OS stacks must be protected from overflowing.
MICROSAR  OS  offers  different  strategies  to  detect  stack  overflows  or  even  to  prevent
stacks from overflowing.
In dependency of the configured scalability class there are the following strategies:

Scalability Class
Stack check strategy
SC1 / SC2
Software stack check (see 2.3.4)
SC3 / SC4
Stack supervision by memory protection unit (MPU) (see 2.3.5)

2.3.4
Software Stack Check
2.3.4.1
Description
The  OS  initializes  the  very  last  element  of  each  stack  to  a  specific  stack  check  pattern.
Whenever a stack switch is performed (e.g. a task switch) the OS checks whether this last
element of the valid stack still holds the stack check pattern.
If the  OS  detects  that  the  stack  check  pattern  has  been  altered  it  assumes  that  the  last
valid stack did overflow.

Stack Check Pattern
32 Bit Microcontrollers  0xAAAAAAAA
Table 2-2   Stack Check Patterns

Note
The software stack check is able to detect stack overflows. It is not capable to avoid
  them!

© 2017 Vector Informatik GmbH
Version 2.12.0
44
based on template version 6.0.1

Technical Reference MICROSAR OS

Caution
  The software stack check is not able to detect all stack overflows. There may be
scenarios where the memory of the adjacent stack is already overwritten, but the last
element of the current stack still holds the stack check pattern.
In such cases the software stack check is not able to detect the overflow.

Caution
  The software stack check is not able to detect the amount memory which has been
destroyed.

2.3.4.2
Activation
Within  a  SC1  or  SC2  configuration  the  attribute  “OsStackMonitoring”  has  to  be  set  to
TRUE to activate the software stack check feature.

Expert Knowledge
On platforms which disable the MPU in supervisor mode, the software stack check may
  be activated also for SC3 and SC4 configurations.
On other platforms the software stack check should be switched off in a SC3 or SC4
configuration.

2.3.4.3
Usage
Once  the  feature  is  activated  the  OS  checks  the  stacks  automatically  upon  each  stack
switch.
If the OS detects a stack overflow it goes into shutdown. If a ShutdownHook is configured
it is invoked to inform the application about OS shutdown.

Note
Debugging hint: The stack check pattern is restored by the OS before the
  ShutdownHook() is called.

© 2017 Vector Informatik GmbH
Version 2.12.0
45
based on template version 6.0.1

Technical Reference MICROSAR OS

2.3.5
Stack Supervision by MPU
2.3.5.1
Description
During the whole runtime of the OS the current active stack is supervised by the MPU of
the microcontroller. Therefore the OS reserves one MPU region which is reprogrammed by
the OS with each stack switch.
Stack  overflows  cannot  happen  since  the  MPU  avoids  write  accesses  beyond  the  stack
boundaries.
Whenever a memory violation is recognized (e.g. due to a stack violation) an exception is
raised. Within the exception handling the OS calls the ProtectionHook().
The  application decides  in  the ProtectionHook()  how  to  deal  with  the memory  protection
violation. If the application invokes the shutdown of the OS, the ShutdownHook() is called
as well (if configured).

Note
The stack supervision recognizes write accesses beyond stack boundaries and
  suppresses them.

2.3.5.2
Activation
The system must be configured as a SC3 or SC4 system.

2.3.5.3
Usage
In  a  SC3  /  SC4  system  the  OS  automatically  initializes  one  MPU  region  for  stack
supervision.
To  safely  detect  stack  violations  special  care  must  be  taken  with  configuring  additional
MPU regions and also with linking of sections:
>  When configuring additional MPU regions included memory region must never overlap
with any OS stack sections.
>  By using an OS generated linker command file (see 4.3.2) it is assured that the OS
stacks are linked consecutively into the RAM.
>  A stack safety gap is needed which is linked adjacent to the stacks (in dependency of
the stack growth direction; see Figure 2-1). No software parts must have write access
to the stack safety gap.
>  The size of the stack safety gap must be at least the granularity of the MPU.
>  The linkage of the safety gap is mandatory. Otherwise a stack violation of the stack
with the lowest address cannot be detected.

© 2017 Vector Informatik GmbH
Version 2.12.0
46
based on template version 6.0.1

Technical Reference MICROSAR OS
stack safety gap
OS stacks
Stack growth direction

Figure 2-1  Stack Safety Gap

Caution
Don’t configure MPU regions which grant access to any OS stacks

Caution
Add a stack safety gap to the linkage scheme. The stack safety gap is a restricted
  memory region. No software parts must have write access to this region.

2.3.6
Stack Usage Measurement
2.3.6.1
Description
During runtime of  the OS the maximum stack usage can be obtained by the application.
The OS initializes all OS stacks with the stack check pattern (see Table 2-2).
There are API functions which are capable to return the maximum stack usage (since call
of StartOS()) for each stack (see 5.2.8).
2.3.6.2
Activation
Set “OsStackUsageMeasurement” to TRUE
2.3.6.3
Usage
The stack usage APIs can be used anywhere in application.

Note
To save OS startup time, the feature can be deactivated in a productive environment.

© 2017 Vector Informatik GmbH
Version 2.12.0
47
based on template version 6.0.1

Technical Reference MICROSAR OS
2.4
Interrupt Concept
2.4.1
Interrupt Handling API
The AUTOSAR OS standard specifies several APIs to disable / enable Interrupts.

DisableAllInterrupts()
EnableAllInterrupts()
The functions disable all category 1 and
category 2 interrupts.
SuspendAllInterrupts()
ResumeAllInterrupts()
SuspendOSInterrupts()
The functions disable category 2
ResumeOSInterrupts()
interrupts only.

2.4.2
Interrupt Levels
The OS defines several interrupt levels.
Interrupt Priority
High
Category 0
ISRs
TP Lock Level
Timing
Protection
ISR
Category 1 Lock Level
Category 1
ISRs
DisableAllInterrupts()
EnableAllInterrupts()
Category 2 Lock Level
SuspendAllInterrupts()
Category 2
SuspendOSInterrupts()
ResumeAllInterrupts()
ISRs
ResumeOSInterrupts()
Low
Tasks

Figure 2-2  Interrupt Lock Levels
>  Category 2 ISRs must have a lower priority than category 1 ISRs
>  Category 1 ISRs must have a lower priority than the timing protection ISR (within an
SC2 / SC4 system)
>  The timing protection ISR must have a lower priority than category 0 ISRs (category 0
ISRs are described in detail in chapter 3.14)
>  The TP Lock Level cannot be set by the user. Interrupts are disabled up to this level
OS internally whenever timing protection is handled.
>  Category 0 ISRs are disabled OS internally for very short times only e.g. when
performing a stack switch (the locations where category 0 ISRs are locked can be
found in chapter 3.14.2.4).
© 2017 Vector Informatik GmbH
Version 2.12.0
48
based on template version 6.0.1

Technical Reference MICROSAR OS

2.4.3
Interrupt Vector Table
The  interrupt  vector  table  is  generated  by  MICROSAR  OS  with  respect  to  the
configuration, microcontroller family and used compiler.
In a multi core system multiple vector tables may be generated.
MICROSAR OS generates an interrupt vector for each possible interrupt source.
2.4.4
Nesting of Category 2 Interrupts
2.4.4.1
Description
To keep interrupt latency as low as possible it is possible that
>  A higher priority category 2 ISR interrupts a lower priority category 2 ISR.
>  A category 1 ISRs interrupts a category 2 ISR (category 1 ISR has always a higher
priority)
2.4.4.2
Activation
When  setting  “OsIsrEnableNesting”  to TRUE  the  category  2  ISR  itself  is  interruptible  by
higher priority ISRs.
2.4.5
Category 1 Interrupts
2.4.5.1
Implementation of Category 1 ISRs
MICROSAR  OS  offers  a  macro  for  implementing  a  category  1  ISR.  This  is  a  similar
mechanism like the macro for a category 2 ISR defined by the AUTOSAR standard.
MICROSAR OS abstracts the needed compiler keywords.

Implement a category 1 ISR
  OS_ISR1(<MyCategory1ISR>)
{
}

2.4.5.2
Nesting of Category 1 ISRs
Since category 1 ISRs are directly called  from interrupt vector table  without any OS pro-
and epilogue, automatic nesting of category 1 ISRs cannot be supported.
The configuration attribute “OsIsrEnableNesting” is ignored for category 1 ISRs.
Nevertheless  the  interrupts  may  be  enabled  during  a  category  1  ISR  to  allow  interrupt
nesting but OS API functions cannot be used for this purpose. The application has to use
compiler intrinsic functions or inline assembler statements.

© 2017 Vector Informatik GmbH
Version 2.12.0
49
based on template version 6.0.1

Technical Reference MICROSAR OS

Example
OS_ISR1(<MyCategory1ISR>)
  {
__asm(EI); /* enable nesting of this ISR */

__asm(DI); /* disable nesting before leaving the function */
}

2.4.5.3
Category 1 ISRs before StartOS
There  may  be  the  need  to  activate  and  serve  category  1  ISRs  before  the  OS  has  been
started.
The following sequence should be implemented:
1.  Call Os_InitMemory
2.  Call Os_Init (within the function the basic interrupt controller settings are initialized
e.g. priorities of interrupt sources).
3.  Enable the Interrupt sources of category 1 ISRs by directly manipulating the control
registers in the interrupt controller.
4.  Enable  the  interrupts  by  directly  manipulating  the  global  interrupt  flag  and  /  or
current interrupt priority to allow the category 1 ISRs

2.4.5.4
Notes on Category 1 ISRs

Expert Knowledge
On platforms which have no automatic stack switch upon interrupt request there will be
  no stack switch at all if a category 1 ISR occurs. Thus the stack consumption of a
category 1 ISR should be added to all stacks which are can be consumed by category
1 ISRs (see 2.3 for an overview).

Note
Although the interrupt priorities are initialized by MICROSAR OS there is no API to
  enable or acknowledge category 1 ISRs. The interrupt control registers have to be
accessed directly.

© 2017 Vector Informatik GmbH
Version 2.12.0
50
based on template version 6.0.1

Technical Reference MICROSAR OS

Caution
The AUTOSAR OS standard does not allow OS API usage within category 1 ISRs (the
  only exception is the interrupt handling API).
If a not allowed OS API is called anyway, MICROSAR OS is not able to detect this and
the called API may not work as expected.

Caution
Category 1 ISRs are always executed with trusted rights on supervisor level.

Caution
  The macro “OS_ISR1” abstracts the appropriate compiler keyword for implementing
the interrupt service routine. Thus the compiler generates code which safes and restore
a subset of the general purpose registers.
In certain usecases e.g. usage of the FPU or nested interrupts it may require the
application to save and restore more registers.

2.4.6
Initialization of Interrupt Sources
Through the OS configuration MICROSAR OS knows the assignment of interrupt sources
and priorities to ISRs. In multi core system the core assignment of all ISRs is also known.
Based  on  these  configuration  information  MICROSAR  OS  generates  data  structures  for
initializing the interrupt controller. It initializes the interrupt priority and its core assignment.

Note
  Enabling of interrupt sources:
The OS enables the interrupt sources only for the OS generated timer ISRs.
Other user ISRs can be only be served if the corresponding interrupt sources are
enabled by the application.
This should be done by using the interrupt source API (see 5.2.6 for details; function
Os_EnableInterruptSource).

© 2017 Vector Informatik GmbH
Version 2.12.0
51
based on template version 6.0.1

Technical Reference MICROSAR OS

2.4.7
Unhandled Interrupts
Interrupt sources which are not assigned to a user defined ISR are assigned to a default
OS interrupt handler which collects those interrupt sources.
Thus interrupt requests from unassigned interrupt sources are handled by the OS. Within
OS Hooks (e.g. ProtectionHook()) the application can obtain the source number of the
unhandled interrupt request by an OS API (see 5.2.7.1 for details).
In case of an unhandled interrupt request MICROSAR OS calls the ProtectionHook() with
the parameter E_OS_SYS_PROTECTION_IRQ.

© 2017 Vector Informatik GmbH
Version 2.12.0
52
based on template version 6.0.1

Technical Reference MICROSAR OS

2.5
Exception Concept
2.5.1
Exception Vector Table
The  exception  vector  table  is  generated  by  MICROSAR  OS  with  respect  to  the
configuration, microcontroller family and used compiler.
In a multi core multiple vector tables may be generated.
MICROSAR OS generates an exception vector for each possible exception source.

Note
In a SC3 and SC4 system MICROSAR OS defines OS exception handlers for memory
  protection errors and for SYSCALL / TRAP instructions.
Exception sources which are used by the OS cannot be configured by the application.

2.5.2
Unhandled Exceptions
Exception  sources  which  are  not  assigned  to  user  defined  exception  handlers  are
assigned to a default OS exception handler which collects those exceptions.
Thus  exception  requests  from  unassigned  exception  sources  are  handled  by  the  OS.
Within  OS  Hooks  the  application  can  obtain  the  exception  number  of  the  unhandled
exception request by an OS API (see 5.2.7.3 for details).
In case of an unhandled exception request MICROSAR OS calls the ProtectionHook() with
the parameter E_OS_PROTECTION_EXCEPTION.

© 2017 Vector Informatik GmbH
Version 2.12.0
53
based on template version 6.0.1

Technical Reference MICROSAR OS
2.6
Timer Concept
2.6.1
Description
MICROSAR  OS  can provide  a  time  base  generated from  timer  hardware  located  on  the
microcontroller. This time base can be used to drive alarms and schedule-tables.
2.6.2
Activation
The  OS  configuration  may  define  an  OsCounter  Object  of  type  “HARDWARE”.  Then  a
driving hardware must be assigned to “OsDriver” attribute.
2.6.3
Usage
Once the hardware counter is defined it can be assigned to alarms (“OsAlarmCounterRef”)
and schedule-tables (“OsScheduleTableCounterRef”).
Such alarms and schedule-tables are driven time based.
Additionally  MICROSAR  OS  provides  conversion  macros  (which  are  based  on  the
hardware counter configuration) to convert from hardware ticks to time and vice versa (see
for 5.2.10 details).
2.6.4
Dependencies
A hardware counter can be driven in two modes:
>  Periodical interrupt timer mode (see 2.7)
>  High resolution timer mode (see 2.8)

© 2017 Vector Informatik GmbH
Version 2.12.0
54
based on template version 6.0.1

Technical Reference MICROSAR OS
2.7
Periodical Interrupt Timer (PIT)
2.7.1
Description
The  timer  hardware  is  set  up  to  generate  timer  interrupts  requests  in  a  strict  periodical
interval (e.g. 1ms). The interval does not change during OS runtime.
Within  each  timer  ISR  MICROSAR  OS  checks  for  alarm  and  schedule-table  expirations
and execute the configured OS action.
2.7.2
Activation
>  Define an OsCounter of type “HARDWARE” and select the timer Hardware in
“OsDriver”.
>  Set the counter sub-attribute “OsDriverHighResolution” to FALSE.
>  The attribute “OsSecondsPerTick” specifies the cycle time of interrupt generation.
>  The attribute “OsCounterTicksPerBase” specifies the number of timer counter cycles
which are necessary to reach “OsSecondsPerTick”.

Note
The OS will add an appropriate ISR automatically to the configuration.

© 2017 Vector Informatik GmbH
Version 2.12.0
55
based on template version 6.0.1

Technical Reference MICROSAR OS
2.8
High Resolution Timer (HRT)
2.8.1
Description
The  timer  hardware  is  set  up  to  generate  one  timer  interrupt  request  when  an  alarm  or
schedule-table action shall be executed.
Within each  timer ISR MICROSAR OS  performs  that action,  calculates the timer interval
for the next action and reprograms the timer hardware with the new expiration time.
2.8.2
Activation
>  Define an OsCounter of type “HARDWARE” and select the timer Hardware in
“OsDriver”.
>  Set the counter sub-attribute “OsDriverHighResolution” to TRUE.
>  The attribute “OsSecondsPerTick” specifies the cycle time of the timer counter.
>  The attribute “OsCounterTicksPerBase” must be set to “1”.
>  The attribute “OsCounterMaxAllowedValue” must be set to 0x3FFFFFFF

Note
The OS will add an appropriate ISR automatically to the configuration.

2.9
PIT versus HRT

PIT
HRT
Interrupt Requests are generated …    Strictly periodical
 On demand
Precision of Alarms / Schedule-
 Only multiples of the
 Any times are possible.
tables
attribute
With precision of the
OsSecondsPerTick are
cycle time of the used
possible for alarm /
timer hardware.
schedule-table times.
Interrupt Load
 Generates a constant
 Interrupt load is not
interrupt load which is
equally distributed over
equally distributed over
runtime.
runtime.
 Interrupt bursts may be
possible.
Table 2-3   PIT versus HRT

© 2017 Vector Informatik GmbH
Version 2.12.0
56
based on template version 6.0.1

Technical Reference MICROSAR OS
2.10  Startup Concept
The  following  figure  gives  an  overview  of  the  different  startup  phases  of  the  OS.  It  also
shows which OS API functions are available in the different phases.
stm API Usage before StartOS
Initial
Startup-Phase0
Os_InitMemory()
Init-Step1
Startup-Phase1
Os_Init()
Init-Step2
Startup-Phases2and3
Startup-Phase2
DisableAllInterrupts(),
EnableAllInterrupts(),
Initial
SuspendAllInterrupts(),
ResumeAllInterrupts(),
SuspendOSInterrupts(),
ResumeOSInterrupts(),
Os_EnterPreStartTask()
Os_CallNonTrustedFunction(),
StartCore(), GetCoreID(),
Init-Step3
CallTrustedFunction,
StartNonAutosarCore()
Os_ReadPeripheral*,
Os_WritePeripheral*,
Os_ModifyPeripheral*
Startup-Phase3
StartOS()
Init-Step4
After StartOS() all API functions can be
ExitPoint
called in exactly the contexts as
described in the AutosarOS standard.
Mind that StartNonAutosarCore() can still
be called.

Figure 2-3  API functions during startup

© 2017 Vector Informatik GmbH
Version 2.12.0
57
based on template version 6.0.1

Technical Reference MICROSAR OS
2.11  Single Core Startup
This chapter shows some examples how MICROSAR OS is started as single core OS.
2.11.1  Single Core Derivatives

OS single core startup on a single core derivative
void main (void)
  {
Os_InitMemory();
Os_Init();
StartOS(OSDEFAULTAPPMODE);
}

2.11.2  Multi Core Derivatives
2.11.2.1  Examples for SC1 / SC2 Systems

OS single core startup on a multi core derivative
void main (void)
  {
StatusType rv;

Os_InitMemory();
Os_Init();

switch(GetCoreID())
{
  case OS_CORE_ID_MASTER:
StartNonAutosarCore(OS_CORE_ID_1, &rv); /* call of StartNonAutosarCore is
  optional the other core may also be
  held in reset */
StartOS(OSDEFAULTAPPMODE);
break;
  case OS_CORE_ID_1:
/* don’t call StartOS; do something else */
break;
  default:
break;
}
}

The example starts a single core OS on the master core of a multi core derivative.

© 2017 Vector Informatik GmbH
Version 2.12.0
58
based on template version 6.0.1

Technical Reference MICROSAR OS

OS single core startup on a multi core derivative
void main (void)
  {
StatusType rv;

Os_InitMemory();
Os_Init();

switch(GetCoreID())
{
  case OS_CORE_ID_MASTER:
StartCore(OS_CORE_ID_1, &rv);
/* don’t call StartOS; do something else */
break;
  case OS_CORE_ID_1:
StartOS(OSDEFAULTAPPMODE);
break;
  default:
break;
}
}

The example starts a single core OS on the slave core of a multi core derivative

2.11.2.2  Examples for SC3 / SC4 Systems

Caution
The function GetCoreID requires a trap into the OS to be functional. Since the OS does
  not initialize any trap tables on non-AUTOSAR cores GetCoreID cannot be used on
such cores.
Therefore it is not possible to use the API function GetCoreID within the main function.
A user function (e.g. UsrGetCoreID) is necessary which distinguishes the correct core
ID.

© 2017 Vector Informatik GmbH
Version 2.12.0
59
based on template version 6.0.1

Technical Reference MICROSAR OS

OS single core startup on a multi core derivative
void main (void)
  {
StatusType rv;

Os_InitMemory();
Os_Init();

switch(UsrGetCoreID())
{
  case 0:
    StartNonAutosarCore(OS_CORE_ID_1, &rv); /* call of StartNonAutosarCore is
  optional the other core may also be
  held in reset */
StartOS(OSDEFAULTAPPMODE);
break;
  case 1:
/* don’t call StartOS; do something else */
break;
  default:
break;
}
}

The example starts a single core OS on the master core of a multi core derivative.

© 2017 Vector Informatik GmbH
Version 2.12.0
60
based on template version 6.0.1

Technical Reference MICROSAR OS
2.12  Multi Core Startup
Within a multi core system each core has the following possibilities when entering the main
function:
1.  Mandatory: call to Os_InitMemory and Os_Init().
2.  Optional: calls to StartCore() to start additional cores under control of MICROSAR
OS.
3.  Optional: calls to StartNonAutosarCore() to start additional cores which are
independent of MICROSAR OS.
4.  Optional: call StartOS() to start MICROSAR OS on the core

For a slave core this is only possible if the core once has been started with
StartCore() API from another core.

For the master core this is only possible if the core itself is configured to be
an AUTOSAR core.
2.12.1  Example for SC1 / SC2 Systems

OS multi core startup
void main (void)
  {
StatusType rv;

Os_InitMemory();
Os_Init();

switch(GetCoreID())
{
  case OS_CORE_ID_MASTER:
StartCore(OS_CORE_ID_1, &rv);
StartCore(OS_CORE_ID_2, &rv);
StartOS(OSDEFAULTAPPMODE);
break;
  case OS_CORE_ID_1:
StartOS(DONOTCARE);
break;
  case OS_CORE_ID_2:
StartCore(OS_CORE_ID_3, &rv);
StartOS(DONOTCARE);
break;
  case OS_CORE_ID_3:
StartOS(DONOTCARE);
break;
  default:
break;
}
}

The example shows a possible startup sequence for a quad core system.

© 2017 Vector Informatik GmbH
Version 2.12.0
61
based on template version 6.0.1

Technical Reference MICROSAR OS
2.12.2  Examples for SC3 / SC4 systems
2.12.2.1  Only with AUTOSAR Cores

OS multi core startup
void main (void)
  {
StatusType rv;

Os_InitMemory();
Os_Init();

switch(GetCoreID())
{
  case OS_CORE_ID_MASTER:
StartCore(OS_CORE_ID_1, &rv);
StartCore(OS_CORE_ID_2, &rv);
StartOS(OSDEFAULTAPPMODE);
break;
  case OS_CORE_ID_1:
StartOS(DONOTCARE);
break;
  case OS_CORE_ID_2:
StartCore(OS_CORE_ID_3, &rv);
     StartOS(DONOTCARE);
break;
  case OS_CORE_ID_3:
StartOS(DONOTCARE);
break;
  default:
break;
}
}

The  example  shows  a  possible  startup  sequence  for  a  quad  core  system. All  cores  are
configured to be AUTOSAR cores.

2.12.2.2  Mixed Core System

Caution
The function GetCoreID requires a trap into the OS to be functional. Since the OS does
  not initialize any trap tables on non-AUTOSAR cores GetCoreID cannot be used on
such cores.
Therefore it is not possible to use the API function GetCoreID within the main function.
A user function (e.g. UsrGetCoreID) is necessary which distinguishes the correct core
ID.

© 2017 Vector Informatik GmbH
Version 2.12.0
62
based on template version 6.0.1

Technical Reference MICROSAR OS

OS multi core startup
void main (void)
  {
StatusType rv;

Os_InitMemory();
Os_Init();

switch(UsrGetCoreID())
{
  case 0:
StartNonAutosarCore(OS_CORE_ID_1, &rv);
StartCore(OS_CORE_ID_2, &rv);
StartOS(OSDEFAULTAPPMODE);
break;
  case 1:
/* not an AUTOSAR core; do something else */
     break;
  case 2:
StartCore(OS_CORE_ID_3, &rv);
StartOS(DONOTCARE);
break;
  case 3:
StartOS(DONOTCARE);
break;
  default:
break;
}
}

The example shows a possible startup sequence for a quad core system. Three cores are
AUTOSAR cores and one core is a non-AUTOSAR core.

© 2017 Vector Informatik GmbH
Version 2.12.0
63
based on template version 6.0.1

Technical Reference MICROSAR OS
2.13  Error Handling
MICROSAR OS is able to detect and handle the following types of errors:
Application Errors …
 Are raised if the OS could not execute a requested OS API service
correctly. Typically the OS API is used wrong (e.g. invalid object
ID).
 Do not corrupt the internal OS data.
 Will result in call of the global ErrorHook() for centralized error
handling (if configured).
 Will result in call of an application specific ErrorHook (if configured).
 May not induce shutdown / terminate reactions. Instead the
application may continue execution by simply returning from the
ErrorHooks.
Protection Errors …
 Are raised if the application violates its configured boundaries (e.g.
memory access violations, timing violations).
 Do not corrupt OS internal data.
 Are raised upon occurrence of unhandled exceptions and
interrupts.
 Will result in call of the ProtectionHook() where a shutdown or
terminate handling (with or without restart) is induced.
 If Shutdown is induced the ShutdownHook() is called (if
configured).
 If no ProtectionHook() is configured shutdown is induced.
Kernel Errors …
 Are raised if the OS cannot longer assume the correctness if its
internal data (e.g. memory access violation during
ProtectionHook())
 Will result in call of the Os_PanicHook() to inform the application.
 Afterwards the OS disables all interrupts and enters an infinite loop.
Table 2-4   Types of OS Errors
2.14  Error Reporting
MICROSAR OS supports error reporting according to the AUTOSAR [1] and OSEK OS [2]
standard.
This includes
>  StatusType return values of OS APIs
>  Parameter passing of error codes error to ErrorHook()
>  Service ID information provided by the macro OSErrorGetServiceId()
>  Parameter access macros (e.g. OSError_ActivateTask_TaskID())

2.14.1  Extension of Service IDs
MICROSAR OS introduces new service IDs for own services.
© 2017 Vector Informatik GmbH
Version 2.12.0
64
based on template version 6.0.1

Technical Reference MICROSAR OS

Reference
  All service IDs are listed in the OS header file Os_Types.h and may be looked up in
the enum data type OSServiceIdType.

2.14.2  Extension of Error Codes
MICROSAR OS introduces new 8 bit error codes which extend the error codes which are
already defined by AUTOSAR OS and OSEK OS standard.
Type of Error
Related Error Code
Value
An internal OS buffer used for cross core
E_OS_SYS_OVERFLOW
0xF5
communication is full.
A forcible termination of a kernel object has  E_OS_SYS_KILL_KERNEL_OBJ
0xF6
been requested e.g. terminate system
applications.
An OS-Application has been terminated
E_OS_SYS_NO_RESTARTTASK
0xF7
with requested restart but no restart task
has been configured.
The application tries to use an API cross
E_OS_SYS_CALL_NOT_ALLOWED
0xF8
core, but the target core has not been
configured for cross core API
The triggered cross core function is not
E_OS_SYS_FUNCTION_UNAVAILABLE  0xF9
available on the target core.
A syscall instruction has been executed
E_OS_SYS_PROTECTION_SYSCALL  0xFA
with an invalid syscall number.
An unhandled interrupt occurred.
E_OS_SYS_PROTECTION_IRQ
0xFB
The interrupt handling API is used wrong.
E_OS_SYS_API_ERROR
0xFC
Internal OS assertion (not issued to
E_OS_SYS_ASSERTION
0xFD
customer).
A system timer ISR was delayed too long.
E_OS_SYS_OVERLOAD
0xFE
Table 2-5   Extension of Error Codes

Reference
  All error codes and their values can be looked up in the header file Os_Types.h

2.14.3  Detailed Error Codes
MICROSAR  OS  provides  detailed  error  code  to  extend  the  standard  error  handling  of
AUTOSAR to uniquely identify each possible OS error.
The detailed error code is assembled from AUTOSAR StatusType error code and unique
error code.
© 2017 Vector Informatik GmbH
Version 2.12.0
65
based on template version 6.0.1

Technical Reference MICROSAR OS
0x XXXXXX
YY
MICROSAR OS
Error code extension
Autosar StatusType
Figure 2-4  MICROSAR OS Detailed Error Code
Within OS Hook routines the error code can be obtained by calling Os_GetDetailedError()
(see 5.2.7.1 for details).

Note
Vector OS experts always asks about the detailed error codes when supporting
  customers in case of OS errors.

Reference
  The detailed error codes are listed in the file Os_Types.h and may be looked up in
the enum data type Os_StatusType.
Each detailed error code is preceded by a descriptive comment.

© 2017 Vector Informatik GmbH
Version 2.12.0
66
based on template version 6.0.1

Technical Reference MICROSAR OS
2.15  Multi Core Concepts
2.15.1  Scheduling and Dispatching
MICROSAR OS implements independent schedulers and dispatchers for each core.
2.15.2  Multi Core Data Concepts
The multi core data concept of MICROSAR OS tries to avoid concurrent writing accesses
between cores.
Although  cores  may  read  all  OS  data  of  all  cores,  write  accesses  to  OS  data  are  only
performed locally from the owning core.
This data concept allows optimized linking:
>  The data of a particular core may be linked into fast accessible memory
>  The data of a particular core may be linked into cached memory
Only the variables related to spinlocks have to be linked into global memory which must be
accessible by all participating cores.
2.15.3  X-Signals
To realize cross core service APIs MICROSAR OS offers the X-Signal concept (see 3.9 for
details).
2.15.4  Master / Slave Core
In a real master / slave multi core architecture only one core is started upon reset. This is
the master core. All other cores are held in a reset state and must be explicitly started by
the master core. These are slave cores.
There  are  also  multi  core  systems  which  starts  all  cores  simultaneously.  There  is  no
hardware master / slave classification.
MICROSAR OS is capable to deal with  both concepts.  In a system with equal cores the
OS emulates master / slave behavior according to the core configurations.
2.15.5  Hardware Init Core
To  initialize  the  system  peripherals  used  by  the  OS  (e.g.  System  MPU,  Interrupt
Controller), MICROSAR OS uses a dedicated so called Hardware Init Core.
MICROSAR  OS  offers  the  possibility  to  configure  one  core  as  Hardware  Init  Core
("/MICROSAR/Os/OsOS/OsHardwareInitCore").  If  the  user  does  not  configure  a  specific
core, the Master Core is used as Hardware Init Core.
In  safety-critical  environments  it  is  recommended  to  configure  the  core  with  the  highest
diagnostic coverage as Hardware Init Core.
2.15.6  Startup of a Multi Core System
The startup of a multi core system is described in detail in 2.12.
MICROSAR OS offers the possibility to configure a startup symbol for each core. Within a
real master / slave system the OS needs this information for starting the slave cores.
2.15.7  Spinlocks
Synchronization of cores is done by
>  OS Spinlocks (see [1]) or
© 2017 Vector Informatik GmbH
Version 2.12.0
67
based on template version 6.0.1

Technical Reference MICROSAR OS
>  Optimized spinlocks (see 3.1)
2.15.7.1  Linking of Spinlocks
To  achieve  freedom  from  interference  between  cores  with  different  diagnostic  coverage
capability, spinlocks are linked into different memory sections.
An MPU may be used to allow access from only specific cores or specific OS applications.
The used memory sections depend on the feature „OsForcibleTermination“

OS spinlocks
Optimized spinlocks
Spinlock variables are linked
OsForcibleTermination = TRUE
into a core shared section
Spinlocks variables are linked
into a core shared section
Spinlock variables are linked
OsForcibleTermination = FALSE
into an application shared
section
Table 2-6   Linking of spinlocks
2.15.8  Cache
Due to cache coherency problems spinlock variables and other application variables which
are shared among cores must not be cached.
2.15.9  Shutdown
2.15.9.1  Shutdown of one Core
If ShutdownOS() is called on one core, it induces shutdown actions.
>  The core terminates all its applications
>  Application specific ShutdownHooks are called
>  The global ShutdownHook() is called
>  Interrupts are disabled
>  An endless loop is entered
2.15.9.2  Shutdown of all Cores
Upon  call  to  ShutdownAllCores()  synchronized  shutdown  of  the  system  is  invoked.  An
asynchronous X-Signal is used for this purpose.
Synchronized shutdown is described in [1].

2.15.9.3  Shutdown during Protection Violation
If  the  ProtectionHook()  returns  with  “PRO_SHUTDOWN”  a  shutdown  of  all  cores  is
invoked.

© 2017 Vector Informatik GmbH
Version 2.12.0
68
based on template version 6.0.1

Technical Reference MICROSAR OS
2.16  Debugging Concepts
2.16.1  Description
MICROSAR OS offers two software utilities to support OS debugging.
ORTI
MICROSAR OS generates an ORTI debug file (OSEK RunTime
Interface). Many debuggers are capable of loading such ORTI files
and provide comfortable debug means based upon the OS
configuration.
See chapter 2.16.3 for details
TimingHooks
MICROSAR OS provides macros which may be used for debugging
purposes (also suitable for third party tools). See chapter 3.10 for
details.

2.16.2  Activation
ORTI and TimingHooks may be switched on within the OsDebug container.

Note
There is an additional switch within the “OsDebug” container. It enables OS assertions.
  They are intended for OS internal test purposes. If activated the OS performs additional
runtime checks on its own internal states.

2.16.3  ORTI Debugging
ORTI is the abbreviation of “OSEK Runtime Interface”.
When ORTI debugging is activated MICROSAR OS generates additional files with “.ort”
extension.  These  files  contain  information  about  the  whole  OS  configuration.  They  are
intended to be read by a debugger.
The  debugger  uses  the  information  from  the  ORTI  files  to  display  static  and  runtime
information about OS objects e.g. task states.
ORTI versions supported by MICROSAR OS:
ORTI 2.2
As described in the OSEK standard [3] and [4]
ORTI 2.3
Unofficial “Standard” based upon ORTI 2.2. It does contain extensions
for multi core OS and was proposed by “Lauterbach Development
Tools” (described in [5]).

Both ORTI versions are capable to be used within single core and multi core systems.
© 2017 Vector Informatik GmbH
Version 2.12.0
69
based on template version 6.0.1

Technical Reference MICROSAR OS

Note for ORTI 2.2 multi core debugging
  For each configured AUTOSAR core there is one separate ORTI file.
For multi core debugging, the debugger software must be capable to read several
ORTI files.

Note for ORTI 2.3 multi core debugging
  The debug information for all configured cores is aggregated in one file.

Note
  Basically debuggers are capable to display the stack consumption for each stack
(OsStackUsageMeasurement must be switched on).
Please note that uninitialized OS stacks may show 100% stack usage within ORTI
debugging. Reliable information can only be given after the OS has initialized all
stacks.

Caution
  MESSAGE objects and CONTEXT information specified by ORTI 2.2 Standard are not
supported in MICROSAR OS.

Caution
  The following OS services are not traced by ORTI service tracing:
>  GetSpinlock (for optimized spinlocks)
>  TryToGetSpinlock (for optimized spinlocks)
>  ReleaseSpinlock (for optimized spinlocks)
>  IOC
>  Os_GetVersionInfo
>  Os_Init
>  Os_InitMemory

© 2017 Vector Informatik GmbH
Version 2.12.0
70
based on template version 6.0.1

Technical Reference MICROSAR OS
2.17  Memory Protection
MICROSAR OS uses memory protection facilities of a processor to achieve freedom from
interference between OS applications and cores. For this purpose it may use the system
MPU and the core MPUs.
2.17.1  Usage of the System MPU
In  multi  core  systems  whereas  the  cores  have  different  levels  of  diagnostic  coverage  it
may  be  necessary  to  use  a  system  MPU  to  achieve  freedom  of  interference  between
cores.
A  system  MPU  allows  configuring  access  rights  for  cores  to  access  specific  memory
ranges.
The  system  MPU  is  only  initialized  once  during  startup  of  the  OS.  It  is  never
reprogrammed during runtime.
With  a  system  MPU  other  potential  bus  masters  (DMA,  FlexRay)  can  be  isolated  to
achieve freedom from interference.
This is done with the following steps:
Step
Toolchain phase
Set up a SC3 system
Configure memory regions
Configuration of OS
Assign the memory region to the system MPU

2.17.2  Usage of the Core MPUs
The  core  MPUs  are  used  to  achieve  freedom  from  interference  between  applications  /
tasks / ISRs on the same core. The basic concept is that access rights  of these runtime
entities (read/write/executable) have to be granted explicitly to software parts.
This is done with the following steps:
Step
Toolchain phase
Set up a SC3 system
Configure memory regions
Configuration of OS
Assign the memory region to a core MPU
Assign the memory regions to OS applications / Tasks / ISRs
(optional)
Use the AUTOSAR MemMap mechanism to place code, constants and
Compilation
variables into appropriate sections (see 4.3.1.1)
Use OS generated linker command files to locate the sections into
Linkage
memory (see 4.3.2)

2.17.3  Configuration Aspects
A memory region is typically configured by
© 2017 Vector Informatik GmbH
Version 2.12.0
71
based on template version 6.0.1

Technical Reference MICROSAR OS
>  Specify a start and end address by number, or by linker labels (see 4.3.3 for OS
generated section labels)
>  Specify access rights to this region (a pre-defined set of access rights is referable)
>  Specify the validity of the region by ID (e.g. PID / ASID / Protection Set)
>  Specify to which memory protection unit the region belongs (e.g. Core MPU / System
MPU)
>  Specify the owner of the region
The owner of the memory region distinguishes the runtime behavior of the hardware MPU
regions (whether the region is static or dynamic).

Note
The start and end addresses of configured memory region should always be a multiple
  of the granularity of the hardware MPU.

Note
The number of available hardware MPU regions is limited by hardware!
  MICROSAR OS checks during code generation that the overall number of configured
memory regions does not exceed the number of available hardware MPU regions.

2.17.3.1  Static MPU Regions
If no owner is specified, MICROSAR OS initializes a hardware MPU region to be static. It
is never reprogrammed during runtime of the OS. It is valid for all software parts.

2.17.3.2  Dynamic MPU Regions
If an owner is specified for a memory region MICROSAR OS initializes a hardware MPU
region  to  be  dynamically  reprogrammed  during  OS  runtime. Whenever  the  owner  of  the
memory is active during runtime a specific hardware MPU region is programmed with the
configured values of the memory region.
Memory regions which are assigned to an OS application are reprogrammed whenever the
OS application is switched.
Memory regions which are assigned to tasks or ISRs are reprogrammed with each thread
switch.

2.17.3.3  Freedom from Interference
MICROSAR  OS  is  able  to  encapsulate  OS  application  data,  task  private  data  and  ISR
private data. This does also depend on the owner of the memory region.
© 2017 Vector Informatik GmbH
Version 2.12.0
72
based on template version 6.0.1

Technical Reference MICROSAR OS
Memory Region Owner
Access Granted To
Access Denied For
OS application
Runtime objects of this OS
>  Other non-trusted OS
application
applications and its
>  Tasks
applications objects
>  ISRs
>  IOC callbacks
>  Non-trusted functions
>  Application specific hooks
Task
>  The owning task
>  Other non-trusted OS
applications and its
ISR
>  The owning ISR
applications objects
>  Other runtime objects of the
belonging OS application

2.17.4  Stack Monitoring
MICROSAR OS uses one memory region of the MPU to supervise the current stack. This
is the default handling in SC3 and SC4 systems. See 2.3.5 for details.

Caution
Memory regions must not be configured to allow write access into any stack regions.
  Otherwise the OS cannot ensure stack data integrity.

2.17.5  Protection Violation Handling
Upon any memory protection violation the OS
>  Switches to the kernel stack
>  Informs the application by execution of the ProtectionHook()
2.17.6  Optimized / Fast Core MPU Handling
If the number of application / task / ISR specific memory regions is small, MICROSAR OS
may have the possibility to initialize the MPU entirely with static MPU regions.
By  utilize  memory  protection  identifiers  different  access  rights  may  still  be  achieved
between different applications.
MICROSAR OS  switches  access rights  by simply switching the  protection  identifier. This
will result in a very fast MPU handling.
>  Configure only memory regions which are static (no owner is assigned).
>  Use “OsMemoryRegionIdentifier” to assign a protection identifier to that region.
>  Assign either OS applications or Tasks and ISRs to use a specific protection identifier
(OsAppMemoryProtectionIdentifier, OsTaskMemoryProtectionIdentifier,
OsIsrMemoryProtectionIdentifier)
© 2017 Vector Informatik GmbH
Version 2.12.0
73
based on template version 6.0.1

Technical Reference MICROSAR OS

Note
Depending on the used platform protection identifiers are also referred as PID (MPC),
  ASID (RH850) or protection sets (TriCore). But the basic technique is the same.

2.17.7  Recommended Configuration
MICROSAR OS offers a recommended MPU configuration which contains a basic setup.
It configures the MPU to achieve the access rights as follows
Access Rights
Trusted Software
Non-Trusted Software
Executable rights to whole memory
X
X
Read access to whole RAM / ROM
X
X
Write access to whole RAM (except
X
-
stack regions)
Read / Write access to peripheral
X
-
registers
Read / Write access to global shared
X
X
memory
Write access to current active stack
X
X
Table 2-7   Recommended Configuration MPU Access Rights

© 2017 Vector Informatik GmbH
Version 2.12.0
74
based on template version 6.0.1

Technical Reference MICROSAR OS
2.18  Memory Access Checks
2.18.1  Description
AUTOSAR OS specifies functions for checking memory access rights of an ISR or task to
a specific memory region.
>  CheckTaskMemoryAccess
>  CheckISRMemoryAccess
2.18.2  Activation
No  explicit  activation  of  these  API  service  functions  necessary.  They  are  provided
automatically by the OS.
2.18.3  Usage
The  API  service  functions  CheckTaskMemoryAccess()  and  CheckISRMemoryAccess()
work on additional configuration data which has to be provided by the user.
Therefore  additional  regions  (“OsAccessCheckRegion“)  may  be  configured.  Tasks  and
ISRs may be assigned to each access check region.

Note
All memory access checks are based upon the configured “OsAccessCheckRegion”
  objects. They are not based upon current MPU values during runtime!
OsAccessCheckRegions and OsMemoryRegions contain redundant information.

2.18.4  Dependencies
This feature is of significance in SC3 and SC4 system with active memory protection.

© 2017 Vector Informatik GmbH
Version 2.12.0
75
based on template version 6.0.1

Technical Reference MICROSAR OS
2.19  Timing Protection Concept
2.19.1  Description
To implement timing protection, MICROSAR OS needs a timer hardware which is able to
generate an interrupt with high priority. This interrupt is never disabled by the OS interrupt
handling API.
Two concepts may be implemented within MICROSAR OS:
  The timing protection interrupt request is non-maskable (NMI request)
  The timing protection interrupt request is maskable
The consequences of both concepts are shown in the comparison:

Timing Protection IRQ is
Timing Protection IRQ is NMI
Maskable
Level of timing
The level of the interrupt source  The exception source has no
protection IRQ
is chosen to be higher than the
interrupt level.
highest category 1 ISR.

Caution
Any category 1 ISR bypasses the OS. For this reason such an ISR may get terminated
  in case it is executed, while the budget of a monitored entity is exhausted.
Thus the AUTOSAR OS specification advises not to use category 1 ISRs within a
system which uses timing protection.

Caution
In case of an inter-arrival time violation MICROSAR OS does currently not provide the
  information which task or ISR did violate its inter-arrival time. GetTaskID() and
GetISRID() return the current task / ISR. The suppressed task / ISR ID is not returned
by these APIs.

2.19.2  Activation
Timing  protection  features  are  activated  by  setting  the  scalability  class  to  SC2  or  SC4
(OsScalabilityClass).
Afterwards  timing  protection  containers  may  be  configured  for  tasks  or  ISRs
(OsTaskTimingProtection  /  OsIsrTimingProtection).  Observed  times  are  configured  within
these containers.

Note
The OS will add an appropriate ISR automatically to the configuration.

© 2017 Vector Informatik GmbH
Version 2.12.0
76
based on template version 6.0.1

Technical Reference MICROSAR OS
2.19.3 Usage
Once the timing protection feature is active tasks and ISRs are observed automatically by
the OS.
Observation of a particular OS object (task / ISR) only takes place if any execution
budgets or locking times are configured for this object.

© 2017 Vector Informatik GmbH
Version 2.12.0
77
based on template version 6.0.1

Technical Reference MICROSAR OS
2.20  IOC
2.20.1  Description
The Inter OS-Application Communicator (IOC) is responsible for data exchange between
OS applications. It handles two important tasks
>  Data exchange across core boundaries
>  Data exchange across memory protection boundaries
Parts of the IOC API services are generated.
MICROSAR OS always tries to generate IOC API services and data structures to minimize
resource usage.
Especially the runtime of IOC API services is influenced by the configuration of IOC
objects. For the customer it is important how configuration aspects minimize the IOC
runtime.
For each IOC object MICROSAR OS decides during runtime whether
>  Interrupt locks
>  Spinlocks
Are used or not.
2.20.2  Unqeued (Last Is Best) Communication

Note
Whenever the data of a last is best IOC object can be written / read atomically (integral
  data type) no spinlocks are used at all.

2.20.2.1  1:1 Communication Variant

Sender and Receiver are located  Sender and Receiver are located
on the same core
on the different cores
Interrupt Locks
Used
Not used
Spinlocks
Not Used
Used
System Call Traps
Not Used
Not Used

2.20.2.2  N:1 Communication Variant

Sender and Receiver are located  Sender and Receiver are located
on the same core
on the different cores
Interrupt Locks
Used
Not used
Spinlocks
Not Used
Used
System Call Traps
Used
Used

© 2017 Vector Informatik GmbH
Version 2.12.0
78
based on template version 6.0.1

Technical Reference MICROSAR OS
2.20.2.3  N:M Communication Variant

Sender and Receiver are located  Sender and Receiver are located
on the same core
on the different cores
Interrupt Locks
Used
Not used
Spinlocks
Not Used
Used
System Call Traps
Not Used
Not Used

2.20.3  Queued Communication
For 1:1 and N:1 Communication the following table is applied:

Sender and Receiver are located  Sender and Receiver are located
on the same core
on the different cores
Interrupt Locks
Not Used
Not used
Spinlocks
Not Used
Not Used
System Call Traps
Not Used
Not Used

2.20.4  Notification
MICROSAR OS provides configurable receiver callback functions for notification purposes.

Note
In case an IOC object has a configured receiver callback function a system call trap is
  needed in any case.

2.20.5  Particularities
2.20.5.1  N:1 Queued Communication
N:1 queued commination is realized with multiple sender queues. The receiver application
does  an  even  multiplexing  on  all  sender  queues  when  calling  the  receive  function  (see
figure).
© 2017 Vector Informatik GmbH
Version 2.12.0
79
based on template version 6.0.1

Technical Reference MICROSAR OS

Figure 2-5  N:1 Multiple Sender Queues
2.20.5.2  IOC Spinlocks

Note
During generation of OS data structures, if MICROSAR OS detects that a spinlock is
  needed for a particular IOC object, it automatically creates a spinlock object within the
OS configuration.

2.20.5.3  Notification
Based  on  the  core  assignment  of  sender  and  receiver  of  an  IOC  object,  two  possible
scenarios for callback handling are possible.
Sender and Receiver are located on
>  The callback notification function is called within the
the same core
IOC send function
Sender and Receiver are located on
>  The sender triggers an X-Signal request on the
different cores
receiving core
>  The callback notification function is called within the
X-Signal ISR

© 2017 Vector Informatik GmbH
Version 2.12.0
80
based on template version 6.0.1

Technical Reference MICROSAR OS

Note
  >  All callback functions are using the cores IOC receiver pull callback stack.
>  During execution of the IOC receiver pull callback function category 2 ISRs are
disabled.
>  Within IOC receiver pull callback functions only other IOC API functions and
interrupt dis/enable API functions are allowed.

2.20.5.4  Complex Data Types

Note
  If “OsIocDataType” of an IOC object is a complex data type, MICROSAR OS uses a
memcpy function of the VStdLib Module for data transfer and initialization.
See VStdLib Technical Reference [8].

© 2017 Vector Informatik GmbH
Version 2.12.0
81
based on template version 6.0.1

Technical Reference MICROSAR OS
2.21  Trusted OS Applications
Trusted  OS  Applications  are  basically  executed  in  supervisor  mode.  They  can  have
read/write access to nearly the whole memory (except stack regions).
MICROSAR OS allows gradually restricting of access rights of trusted OS applications.
Trusted OS applications may be restricted by memory access or by processor mode.
2.21.1  Trusted OS Applications with Memory Protection
2.21.1.1  Description
Runtime objects (Tasks / ISRs / Trusted functions) of trusted OS applications with enabled
memory protection have the following behavior
>  They run in supervisor mode
>  Memory access has to be granted explicitly (in the same way as for a non-trusted OS
application)
>  The MPU is re-programmed whenever software of the OS application is executed.
2.21.1.2  Activation
Set “OsTrustedApplicationWithProtection” to TRUE.
2.21.1.3  Dependencies
This feature is of significance in SC3 and SC4 system with active memory protection.
2.21.2  Trusted OS Applications in User Mode
2.21.2.1  Description
Such  OS  applications  can  have  read/write  access  to  nearly  the  whole  memory  (except
stack  regions),  but  they  are  running  in  user  mode.  This  is  also  applied  to  all  runtime
objects (Tasks / ISRs / Trusted functions) assigned to this OS application.

Note
  >  API runtimes for OS applications which run in user mode are longer.

2.21.2.2  Activation
Set “OsApplicationIsPrivileged” to FALSE.
2.21.2.3  Dependencies
This feature is of significance in SC3 and SC4 system with active memory protection.
© 2017 Vector Informatik GmbH
Version 2.12.0
82
based on template version 6.0.1

Technical Reference MICROSAR OS
2.21.3  Trusted Functions

Note
  >  The interrupt state of the caller is preserved when entering the trusted function.
>  The trusted function may manipulate the interrupt state by using OS services. The changed
interrupt state is preserved upon return from the trusted function.

Caution
Nesting level of trusted functions is limited to 255.
  The application has to ensure that this limitation is held. There is no error detection
within the OS.

© 2017 Vector Informatik GmbH
Version 2.12.0
83
based on template version 6.0.1

Technical Reference MICROSAR OS
2.22  OS Hooks
2.22.1  Runtime Context
MICROSAR  OS  implements  the  runtime  context  and  accessing  rights  of  OS  Hooks
according to the following table
Hook Name
Processor Mode  Access Rights  Interrupt State
StartupHook
Category 2 lock
ErrorHook
level

Supervisor
Trusted
ShutdownHook
Category 1 lock
ProtectionHook
level

StartupHook_<OS application name>
Category 2 lock
Depending on the configuration of
ErrorHook_<OS application name>
level

the owning OS application
ShutdownHook_<OS application name>
TP lock level
Os_PanicHook
Supervisor
Trusted
TP lock level
PreTaskHook
Supervisor
Trusted
TP lock level
PostTaskHook
Supervisor
Trusted
TP lock level
AlarmCallbacks
Category 1 lock
Supervisor
Trusted
level
IOC receiver pull callbacks
Depending on the configuration of
Category 2 lock
the owning OS application
level

2.22.2  Nesting behavior
It is possible that OS hooks may be nested by other OS hooks according to the following
table
Nested by  ErrorHook(s)
ProtectionHook  StartupHook(s)  ShutdownHook(s))  IOC Callbacks
OS Hook
ErrorHook(s)
Not possible
possible
Not possible
possible
possible
ProtectionHook
Not possible
Not possible
Not possible
possible
possible
StartupHook(s)
possible
possible
Not possible
possible
possible
ShutdownHook(s)
Not possible
Not possible
Not possible
Not possible
possible
IOC Callbacks
possible
possible
Not possible
possible
Not possible

2.22.3  Hints

Caution
Within OS Hooks the interrupts must not be enabled again!

© 2017 Vector Informatik GmbH
Version 2.12.0
84
based on template version 6.0.1

Technical Reference MICROSAR OS

Caution
Hooks must never be called by application code directly.

Note for SC2 or SC4
Hooks don’t have any own runtime budgets. OS Hooks consume the budget of the
current task / ISR.

Note: Protection violations during OS Hooks
If any protection violation occurs during the hooks
 PreTaskHook
 PostTaskHook
the OS will always go into shutdown!
The return value of the ProtectionHook (e.g. PRO_TERMINATEAPPL) will be ignored
and overwritten by the OS to PRO_SHUTDOWN.

© 2017 Vector Informatik GmbH
Version 2.12.0
85
based on template version 6.0.1

Technical Reference MICROSAR OS
3  Vector Specific OS Features
This chapter describes functions which are available only in MICROSAR OS. They extend
the standardized OS functions from the AUTOSAR and OSEK OS standard [1] [2].
3.1
Optimized Spinlocks
3.1.1
Description
For  core  synchronization  in  multi  core  systems,  MICROSAR  OS  offers  (beneath  the
AUTOSAR specified OS spinlocks) additional optimized spinlocks.
They are able to reduce the runtime of the Spinlock API. Configuration is also easier.
AUTOSAR  specified  OS  spinlocks  cannot  cause  any  deadlocks  between  cores  (see
unique  order  of  nesting  OS  spinlocks  in AUTOSAR  OS  standard).  Therefore  some  error
checks on OS configuration data are necessary.
The error checks are not performed with optimized spinlocks.

OS Spinlocks
Optimized Spinlocks
Deadlocks
No deadlocks possible
Deadlocks are possible
Runtime
Longer runtime due to more error  Smaller runtime due to less error
checks
checks
Configuration
OsSpinlockSuccessor must be
OsSpinlockSuccessor need not to
configured if spinlocks must be
be configured
nested
Nesting
Can be nested by other OS
Nesting of optimized spinlock
spinlocks
should be avoided or at least be
used with caution
Linking
OS and optimized spinlock variables are placed into different
dedicated memory sections (see 4.3.1).
Table 3-1   Differences of OS and Optimized Spinlocks
3.1.2
Activation
The spinlock attribute “OsSpinlockLockType” may be set to “OPTIMIZED”.
The “OsSpinlockSuccessor” attribute should not be configured for an optimized spinlock.
3.1.3
Usage
Once a spinlock object is configured to be an optimized spinlock the application may use
the  Spinlock  API  as  usual.  The  Spinlock  service  functions  are  capable  to  deal  with
optimized and OS spinlocks.

© 2017 Vector Informatik GmbH
Version 2.12.0
86
based on template version 6.0.1

Technical Reference MICROSAR OS
3.2
Barriers
3.2.1
Description
MICROSAR  OS  offers  the  feature  to  synchronize  participating  tasks  at  a  referenced
barrier. The calling task is blocked until the required numbers of tasks have also called the
method referencing the same barrier.
3.2.2
Activation
Within  OS  configuration  “Barrier”  objects  may  be  specified. A  barrier  consists  of  a  list  of
tasks that participate the barrier.

Note
Only one task per core may be assigned to a barrier object. The assigned task must
  also be the task that calls the API.

3.2.3
Usage
If  one  or  more  barriers  are  configured  Os_BarrierSynchronize  may  be  called  inside  the
tasks  that  are  configured  to  participate  the  barrier.  Tasks  can  participate  in  multiple
barriers. Per core only one task can participate a single barrier.
The core on which a task calls Os_BarrierSynchronize gets blocked inside the API until all
other participating tasks have called the API for the same BarrierID.

Task1
Task2
Task3
Os_BarrierSynchronize(Barrier1)
(Wa
Os_BarrierSynchronize(Barrier2)
itin
g
for
Os_BarrierSynchronize(Barrier2)
ot
Barrier2
h
er
cor
es)
Os_BarrierSynchronize(Barrier1)
Os_BarrierSynchronize(Barrier1)
Barrier1

Figure 3-1  Barriers
© 2017 Vector Informatik GmbH
Version 2.12.0
87
based on template version 6.0.1

Technical Reference MICROSAR OS

Caution
Deadlock may occur if one task has called Os_BarrierSynchronize and one of the other
participants don’t calls the API for the same barrier.

© 2017 Vector Informatik GmbH
Version 2.12.0
88
based on template version 6.0.1

Technical Reference MICROSAR OS
3.3
Peripheral Access API
3.3.1
Description
MICROSAR OS offers peripheral access services for manipulating registers of peripheral
units.  The  application  may  delegate  such  accesses  to  the  OS  in  case  that  its  own
accessing rights are not sufficient to manipulate specific peripheral registers.
3.3.2
Activation
The API service functions themselves do not need any activation.
But within the OS configuration “OsPeripheralRegion” objects may be specified. They are
needed for error and access checking by the OS.
An OsPeripheralRegion object consists of the start address, end address and a list of OS
applications which have accessing rights to the peripheral region.

Note
Access to a peripheral region is granted if the following constraint is held
  Start address of peripheral region <= Accessed address <= End address of peripheral region

3.3.3
Usage
Once peripheral regions are configured they may be passed to the API functions.

Reference
The API service functions themselves are described in chapter 5.2.2.

3.3.4
Dependencies
This feature is of significance in SC3 and SC4 system with active memory protection.
3.3.5
Alternatives
The access rights to peripheral registers may also be granted by configure an additional
MPU region for the accessing OS application.
3.3.6
Common Use Cases
The peripheral access APIs may be used …
>  … if the accessing OS application runs in user mode but the register to be
manipulated can only be accessed in supervisor mode.
>  … if the application does not want to spend a whole MPU region to grant access
rights.

© 2017 Vector Informatik GmbH
Version 2.12.0
89
based on template version 6.0.1

Technical Reference MICROSAR OS
3.4
Trusted Function Call Stubs
3.4.1
Description
Since the OS service CallTrustedFunction() is very generic, there is the need to implement
a stub-interface which does the packing and unpacking of the arguments for trusted
functions.
MICROSAR OS is able to generate these stub functions.
3.4.2
Activation
The OS application attribute “OsAppUseTrustedFunctionStubs” must be set to TRUE. Data
types
must
be
defined
in
the
header
file
which
is
referred
by
“OsAppCalloutStubsIncludeHeader”.
3.4.3
Usage
A particular trusted function is called with the following syntax:
<configured return type> Os_Call_<trusted function name>
(<configured parameters>);
Parameter packing, unpacking and return value handling is done by the stub function.
3.4.4
Dependencies
This feature is of significance in SC3 and SC4 system with active memory protection.

© 2017 Vector Informatik GmbH
Version 2.12.0
90
based on template version 6.0.1

Technical Reference MICROSAR OS
3.5
Non-Trusted Functions (NTF)
3.5.1
Description
Service  functions  which  are  provided  by  non-trusted  OS  applications  are  called  non-
trusted functions. They have the following characteristics:
>  They run in user mode.
>  They run with the MPU access rights of the owning OS application.
>  They perform a stack switch to specific non-trusted function stacks.
>  They run on an own secured stack.
>  They can safely provide non-trusted code to other OS applications.
>  Parameters are passed to the NTF with a reference to a data structure provided by
the caller.
>  Returning of values is only possible if the caller passes the non-trusted functions
parameters as pointer to global accessible data.
3.5.2
Activation
They are defined within an OsApplication container (“OsApplicationNonTrustedFunction”).
The attribute “OsTrusted” for this OS application must be set to FALSE.
3.5.3
Usage
Similar  to  the  CallTrustedFunction() API  of  the AUTOSAR  OS  standard  MICROSAR  OS
implements  an  additional  service  which  is  called  Os_CallNonTrustedFunction()  (see
chapter 5.2.4 for Details).
Configured non-trusted functions are called with this API.

Note
  >  The interrupt state of the caller is preserved when entering the non-trusted function
>  The non-trusted function may manipulate the interrupt state by using OS services. The
changed interrupt state is preserved upon return from the non-trusted function.

Caution
Non-trusted functions currently cannot be terminated without termination of the caller.

3.5.4
Dependencies
This feature is of significance in SC3 and SC4 system with active memory protection.

© 2017 Vector Informatik GmbH
Version 2.12.0
91
based on template version 6.0.1

Technical Reference MICROSAR OS
3.6
Fast Trusted Functions
3.6.1
Description
MICROSAR  OS  offers  the  feature  of  runtime  optimized  trusted  functions  (fast  trusted
functions).
The  speedup  of  the  runtime  is  achieved  by  removing  most  of  the  OS  error  checks,  the
application switch and the MPU reprogramming.
Fast trusted functions have the following characteristics:
>  They may be called with disabled interrupts.
>  They run in supervisor mode.
>  They run with the application ID of the caller.
>  They run on the stack of the caller.
>  They run with the MPU settings of the caller.
>  Parameters are passed to the fast trusted function with a reference to a data
structure provided by the caller.

Caution
  Calls to other OS API services are not allowed within a fast trusted function!

3.6.2
Activation
They are defined within an OsApplication container (“OsApplicationFastTrustedFunction”).
The attribute “OsTrusted” for this OS application must be set to TRUE.
3.6.3
Usage
Similar  to  the  CallTrustedFunction() API  of  the AUTOSAR  OS  standard  MICROSAR  OS
implements  an  additional  service  which  is  called  Os_CallFastTrustedFunction()  (see
chapter 5.2.5 for Details).
Configured fast trusted functions are called with this API.
3.6.4
Dependencies
This feature is of significance in SC3 and SC4 system with active memory protection.

© 2017 Vector Informatik GmbH
Version 2.12.0
92
based on template version 6.0.1

Technical Reference MICROSAR OS
3.7
Interrupt Source API
3.7.1
Description
MICROSAR  OS  offers  additional  API  services  for  category  2  ISRs  and  their  respective
interrupt sources.
The services include
>  Enable of an interrupt source
>  Disable of an interrupt source
>  Clearing of the interrupt pending bit
>  Checking if the interrupt source is enabled
>  Checking of interrupt pending bit status
(See 5.2.6 for API details).

© 2017 Vector Informatik GmbH
Version 2.12.0
93
based on template version 6.0.1

Technical Reference MICROSAR OS
3.8
Pre-Start Task
3.8.1
Description
MICROSAR OS offers the possibility to provide a set of OS API functions for initialization
purposes before StartOS has been called.
Therefore a pre-start task may be configured which is capable to run before the OS has
been started. Within this task stack protection is enabled and particular OS APIs  can be
used.
The table in 5.2.15 lists the OS API functions which may be used within the Pre-Start task.
3.8.2
Activation
>  Define a basic task
>  Within a core object this basic task has to be referred to be the pre-start task of this
core (attribute “OsCorePreStartTask”). Only one pre-start task per core is possible.
>  Start the OS as described below
3.8.3
Usage
1.  Execute Startup Code
2.  Call Os_InitMemory()
3.  Call Os_Init()
4.  Call Os_EnterPreStartTask() (see 5.2.3 for Details)
5.  The OS schedules and dispatches to the task which has been referred as pre-start
task.
6.  The pre-start task has to be left by a call to StartOS()

Caution
The pre-start task may only be active once prior to StartOS() call.

Caution
Within the pre-start task the getter OS API services (e.g. GetActiveApplicationMode())
  neither return a valid result nor a valid error code.

© 2017 Vector Informatik GmbH
Version 2.12.0
94
based on template version 6.0.1

Technical Reference MICROSAR OS

Caution
If MICROSAR OS encounters an error within the pre-start task, only the global hooks
  (ErrorHook(), ProtectionHook() and ShutdownHook()) are executed. OS application
specific hooks won’t be executed.
Consider that the StartupHook() did not yet run when the Pre-Start Task is executed.

Caution
If the Pre-Start Task is used, global hooks have to consider that the OS might not be
  completely initialized. OS APIs which are allowed after normal initialization (e.g.
TerminateApplication()) are not allowed within global hooks, if the error occurred in the
Pre-Start Task.

Caution
If the ProtectionHook() is triggered within the Pre-Start Task, the OS ignores its return
  value. The only valid return value is PRO_SHUTDOWN.

3.8.4
Dependencies
This feature is of significance in SC3 and SC4 system with active memory protection.

© 2017 Vector Informatik GmbH
Version 2.12.0
95
based on template version 6.0.1

Technical Reference MICROSAR OS
3.9
X-Signals
3.9.1
Description
MICROSAR OS uses cross core signaling (X-Signals) to realize API service calls between
cores.
The next figure shows the basic principles of an X-Signal
X-Signal
Requesting
Serving
Core
Core
Send Port Queue
Receive Port Queue
R/W access
Read only access

Figure 3-2  X-Signal
Whenever a core executes a service API cross core it writes this request into its own send
port  queue. Then  it  signals  this  request  by an  interrupt  request  (X-Signal)  to  the  serving
core.
The serving core reads the request from the send port queue and executes the requested
service API. The result of the service API is provided in the receive port queue.

X-Signals have the following characteristics:
>  An X-Signal is a unidirectional request from one core to another (1:1).
>  For each core interconnection one X-Signal is needed.
>  All accesses to the (sender / receiver) port queues are lock free.
>  Queue Sizes must be configured.
>  The Queues may be protected by MPU to achieve freedom of interference between
cores.
>  X-Signals may be configured to offer only a subset of possible cross core API services.
Not configured API services are refused to be served.
© 2017 Vector Informatik GmbH
Version 2.12.0
96
based on template version 6.0.1

Technical Reference MICROSAR OS
>  The API error codes for cross core API services are extended.
  Additional error codes for queue handling.
  Additional error code if the requested service is refused to be served.
>  X-Signals can be configured to be synchronous or asynchronous.

Synchronous X-Signal
Asynchronous X-Signal
Call behavior
After the cross core service API has  After the cross core service API has
been requested the requester core
been requested the requester core
goes into active waiting loop and
continues its own program execution.
polls for the result from the server
core (remote procedure call).
Note: During active wait the
interrupts are enabled.
Error signaling
Error handling is induced on the
Error handling is induced with the
requester core immediately, if the
next X-Signal request on the
polled API result is not E_OK.
requester core, if the result of the
previously requested API is not
E_OK.
Note: Upon potential errors of the
previously requested API the current
application ID on sender and receiver
side meanwhile may have changed.
AUTOSAR standard  Compliant to the AUTOSAR
Deviation to the AUTOSAR Standard
compliance
Standard
Table 3-2   Comparison between Synchronous and Asynchronous X-Signal

Note
Any cross core “getter” APIs e.g. GetTaskState() are always executed with a
  synchronous X-Signal.

Note
The sender core as well as the receiver core may cause protection violations.
  Protection error handling is performed on the core where the violation is detected.

© 2017 Vector Informatik GmbH
Version 2.12.0
97
based on template version 6.0.1

Technical Reference MICROSAR OS

Note
  When a cross core API is induced by an X-Signal, all static error checks (e.g. validity of
parameters) are done on the caller side.
All dynamic error checks (which depend on runtime states) are executed on the
receiver side.

Caution
For correct X-Signal function it is essentially that a sender core of an X-Signal must
  have read access to the receiver core data structure. Especially if the data is mapped
into core local RAM.
There are some platforms e.g. RH850 which does not grant cross core read access to
core local RAM out of reset. Within such platforms it is the duty of the application to set
up these cross core read accesses before the OS is started.

3.9.1.1
Notes on Synchronous X-Signals
The priority of the receiver ISR determines which other category 2 ISRs of one core may
use cross core API services.
Additionally category 2 ISRs may only use cross core API services if they allow nesting.
The following table gives an overview.
Logical Priority
ISR Nesting
Synchronous Cross
Core API Calls
ISR with higher priority than X-Signal priority
ISR nesting is allowed  Not allowed
ISR with higher priority than X-Signal priority
ISR nesting is disabled  Not allowed
X-Signal ISR priority
-
-
ISR with lower priority than X-Signal priority
ISR nesting is allowed  Allowed
ISR with lower priority than X-Signal priority
ISR nesting is disabled  Not allowed
Table 3-3   Priority of X-Signal receiver ISR

Caution
If the priority and nesting requirements from the previous table are not fulfilled there
  may be deadlocks within a multicore system!

3.9.1.2
Notes on Mixed Criticality Systems
MICROSAR  OS  checks  application  access  rights  on  sender  and  on  receiver  side.  This
increases  isolation  of  safety-critical  parts  in  mixed  criticality  systems  (e.g.  protect  a
lockstep core from a non-lockstep core).
© 2017 Vector Informatik GmbH
Version 2.12.0
98
based on template version 6.0.1

Technical Reference MICROSAR OS
Consider that these application access checks are not performed for ShutdownAllCores().
Thus switching off the usage of ShutdownAllCores API for non-lockstep cores is
recommended. This can be done within the X-Signal configuration.
3.9.2
Activation
X-Signals must be configured explicitly in a multi core environment. See chapter 4.5 for
details.

© 2017 Vector Informatik GmbH
Version 2.12.0
99
based on template version 6.0.1

Technical Reference MICROSAR OS
3.10  Timing Hooks
3.10.1  Description
MICROSAR OS supports timing measurement and analysis by external tools. Therefor it
provides timing hooks. Timing hooks inform the external tools about several events within
the OS:
>  Activation (arrival) of a task or ISR
  These allow an external tool to trace all activations of task as well as further arrivals
(e.g. setting of an event or the release of a semaphore with transfer to another task.
  They allow external tools to visualize the arrivals and to measure the time between
them in order to allow a schedule-ability analysis.
>  Context switch
  These allow external tools to trace all context switches from task to ISR and back as
well as between tasks. So external tools may visualize the information or measure
the execution time of tasks and ISRs.
>  Locking of interrupts, resources or spinlocks
  These allow an external tool to trace locks. This is important as locking times of
tasks and ISRs influence the execution of other tasks and ISRs. The kind of
influence is different for different locks.
Within MICROSAR OS code the timing hooks are called. Additionally it provides empty
hooks by default.
The application may decide to implement any of the hooks by itself. The empty OS default
hook is then replaced by the application implemented hook.
3.10.2  Activation
An  include  header  has  to  be  specified  in  the  attribute  “OsTimingHooksIncludeHeader”
located in the “OsDebug” container.
3.10.3  Usage
The timing hooks may be implemented in the configuration specified header. All available
macros are introduced in chapter 5.2.12.

Caution
Within the timing hooks trusted access rights are active e.g. access rights to OS
  variables.

© 2017 Vector Informatik GmbH
Version 2.12.0
100
based on template version 6.0.1

Technical Reference MICROSAR OS

Note: Protection violations during Timing Hooks
If any protection violation occurs during any of the timing hooks the OS will always go
into shutdown!
The return value of the ProtectionHook (e.g. PRO_TERMINATEAPPL) will be ignored
and overwritten by the OS to PRO_SHUTDOWN.

© 2017 Vector Informatik GmbH
Version 2.12.0
101
based on template version 6.0.1

Technical Reference MICROSAR OS
3.11  Kernel Panic
If  MICROSAR  OS  recognizes  an  inconsistent  internal  state  it  enters  the  kernel  panic
mode. In such cases, the OS does not know how to correctly continue execution. Even a
regular shutdown cannot be reached. E.g.:
>  The protection hook itself causes errors
>  The shutdown hook itself causes errors
MICROSAR OS goes into freeze as fast as possible
1.  Disable all interrupts
2.  Inform the application about the kernel panic by calling the Os_PanicHook() (see
5.2.13)
3.  Enter an endless loop

Caution
  >  The OS cannot recover from kernel panic.
>  ProtectionHook() is not called
>  ErrorHook() is not called
>  There is no stack switch. The Os_PanicHook() runs on the current active stack

© 2017 Vector Informatik GmbH
Version 2.12.0
102
based on template version 6.0.1

Technical Reference MICROSAR OS
3.12  Generate callout stubs
3.12.1  Description
MICROSAR  OS  offers  the  feature  to  generate  the  function  bodies  of  all  configured  OS
hook functions (all global hooks and application specific hooks).
The function bodies are generated into the file “Os_Callout_Stubs.c”.
3.12.2  Activation
The Configuration attribute “OsGenerateCalloutStubs” has to be set to TRUE.
3.12.3  Usage
Once the C-File  has been generated it may be altered by the user.  Code parts between
certain  special  comments  are  permanent  and  won’t  get  lost  between  two  generation
processes.
If  a  hook  is  switched off,  the  corresponding function  body  is  also  removed.  But  the user
code (between the special comments) is preserved. Once the hook is switched on again,
the preserved user code is also restored.

Example
FUNC(void, OS_STARTUPHOOK_CODE) StartupHook(void)
  {
/***********************************************************************
* DO NOT CHANGE THIS COMMENT! <USERBLOCK OS_Callout_Stubs_StartupHook>
**********************************************************************/

/* user code starts here */
/* code between those comments is preserved even if the file is newly generated
  Or even if the hook is switched off in the meanwhile */

/***********************************************************************
* DO NOT CHANGE THIS COMMENT! </USERBLOCK>
**********************************************************************/

}

© 2017 Vector Informatik GmbH
Version 2.12.0
103
based on template version 6.0.1

Technical Reference MICROSAR OS
3.13  Exception Context Manipulation
3.13.1  Description
MICROSAR OS offers the feature to read and modify the interrupted context in case of a
hardware  exception.  This  feature  shall  be  applied  in  ProtectionHook  in  the  combination
with PRO_IGNORE_EXCEPTION as the return value. One typical use case for this feature
is to recover from an ECC error in memory.
3.13.2  Usage
The following figure shows the usage of this feature.

Figure 3-3  Usage of manipulating exception context
Inside  ProtectiohHook  the  user  first  needs  to  call  Os_GetExceptionContext  to  read  the
previous  context.  Then  the  context  may  be  investigated  and  modified  according  to  user
requirements. For instance, the program counter may be adapted to the instruction, which
is  to  be  executed  directly  after  the  exception.  Note  that  the  content  of  the  context  is
depending on the platform. In general, the context contains all the processor registers and
some other relevant information. More detailed information can be found in the static code,
where the type Os_ExceptionContextType is defined. Finally the modified context can be
written  back  via  Os_SetExceptionContext.  When  ProtectionHook  returns  with
PRO_IGNORE_EXCEPTION, the processor continues its execution with the manipulated
context.

Note
Currently this feature is supported on PowerPC platform.

© 2017 Vector Informatik GmbH
Version 2.12.0
104
based on template version 6.0.1

Technical Reference MICROSAR OS

Caution
This feature may only be used within ProtectionHook when the error status is either
  E_OS_PROTECTION_MEMORY or E_OS_PROTECTION_EXCEPTION

3.14  Category 0 Interrupts
3.14.1  Description
MICROSAR  OS  implements  category  0  ISRs  to  have  minimal  interrupt  latency  time
especially in SC2 or SC4 systems. This is an extension to the OS standard.
3.14.2  Usage
3.14.2.1  Implement Category 0 ISRs
MICROSAR  OS  offers  a  macro  for  implementing  a  category  0  ISR.  This  is  a  similar
mechanism like the macro for a category 2 ISR defined by the AUTOSAR standard.
MICROSAR OS abstracts the needed compiler keywords.

Implement a category 0 ISR
  OS_ISR0(<MyCategory0ISR>)
{
}

3.14.2.2  Nesting of Category 0 ISRs
Since category 0 ISRs are directly called from interrupt vector table without any OS pro-
and epilogue, automatic nesting of category 0 ISRs cannot be supported.
The configuration attribute “OsIsrEnableNesting” is ignored for category 0 ISRs.
Nevertheless  the  interrupts  may  be  enabled  during  a  category  0  ISR  to  allow  interrupt
nesting but OS API functions cannot be used for this purpose. The application has to use
compiler intrinsic functions or inline assembler statements.

Example
OS_ISR0(<MyCategory0ISR>)
  {
__asm(EI); /* enable nesting of this ISR */

__asm(DI); /* disable nesting before leaving the function */
}

© 2017 Vector Informatik GmbH
Version 2.12.0
105
based on template version 6.0.1

Technical Reference MICROSAR OS
3.14.2.3  Category 0 ISRs before StartOS
There  may  be  the  need  to  activate  and  serve  category  0  ISRs  before  the  OS  has  been
started.
The following sequence should be implemented:
>  Call Os_InitMemory
>  Call Os_Init (within the function the basic interrupt controller settings are initialized
e.g. priorities of interrupt sources).
>  Enable the interrupt sources of category 0 ISRs by directly manipulating the control
registers in the interrupt controller.
>  Enable the interrupts by directly manipulating the global interrupt flag and / or current
interrupt priority to allow the category 0 ISRs

3.14.2.4  Locations where category 0 ISRs are locked
Category 0 interrupts are disabled OS internally for very short times only.
The following list mentions the locations of these locks:
>  Inside APIs that cause a context switch e.g. TerminateTask
>  Partial termination due to exception handled by ProtectionHook
>  On Interrupt, Exception and Trap entry and return
>  OS initialization routines inside Os_Init and StartOS

3.14.3  Notes on Category 0 ISRs

Expert Knowledge
  On platforms which have no automatic stack switch upon interrupt request there will be
no stack switch at all if a category 0 ISR occurs. Thus the stack consumption of a
category 0 ISR should be added to all stacks which can be consumed by category 0
ISRs (see 2.3 for an overview).

Expert Knowledge
  Category 0 ISRs are consuming timing protection budgets (execution budgets and
locking times) of the interrupted Task or category 2 ISR

© 2017 Vector Informatik GmbH
Version 2.12.0
106
based on template version 6.0.1

Technical Reference MICROSAR OS

Note
Although the interrupt priorities are initialized by MICROSAR OS there is no API to
  enable or acknowledge category 0 ISRs. The interrupt control registers have to be
accessed directly.

Caution
  If the timing protection interrupt occurs during the runtime of a category 0 ISR, its
execution (the timing protection violation handling/protection hook) is delayed until the
category 0 ISR has finished.

Caution
  MICROSAR OS does not allow OS API usage within category 0 ISRs.
If any OS API is called anyway, MICROSAR OS is not able to detect this and the called
API may not work as expected.

Caution
  Category 0 ISRs are always executed with trusted rights on supervisor level.

Caution
A category 0 ISR may never lower the interrupt priority of the CPU or the interrupt
  controller.

Caution
  Category 0 ISRs may still occur in case of a shutdown of the OS or even in case the
OS has entered the panic hook.

© 2017 Vector Informatik GmbH
Version 2.12.0
107
based on template version 6.0.1

Technical Reference MICROSAR OS

Caution
  Be aware that a category 0 ISR will interrupt category 2 ISRs even if they are
configured to be non-nestable!

Caution
  If the owner application of a category 0 ISR is terminated for any reason, assigned
category 0 ISRs are not disabled.

Caution
  The macro “OS_ISR0” abstracts the appropriate compiler keyword for implementing
the interrupt service routine. Thus the compiler generates code which safes and restore
a subset of the general purpose registers.
In certain usecases e.g. usage of the FPU or nested interrupts it may require the user
application to save and restore more registers.

© 2017 Vector Informatik GmbH
Version 2.12.0
108
based on template version 6.0.1

Technical Reference MICROSAR OS
4  Integration
4.1
Compiler Optimization Assumptions
MICROSAR OS makes the following assumptions for compiler optimization:
>  Inlining of functions is active
>  Not used functions are removed
>  If statements with a constant condition (due to configuration) are optimized
4.1.1
Compile Time
To shorten the compile time of the OS the following measures can be taken within the OS
configuration:
Systems without active memory
Set “OsGenerateMemMap” to “EMPTY”
protection (SC1/SC2)
Systems with memory protection
Set “OsGenerateMemMap” to “COMPLETE” and
(SC3/SC4)
"OsGenerateMemMapForThreads” to “FALSE”

4.2
Hardware Software Interfaces (HSI)
The  following  chapter  describes  the  Hardware-Software  Interface  for  the  supported
processor families of the MICROSAR OS.
The HSI describes all hardware registers which are used by the OS. Such registers must
not be altered by user software.
Included  within  the  HSI  is  the  context  of  the  OS. The  context  is  the  sum  of  all  registers
which are preserved upon a task switch and ISR execution.
Additionally platform specific characteristics of the OS are described here.

© 2017 Vector Informatik GmbH
Version 2.12.0
109
based on template version 6.0.1

Technical Reference MICROSAR OS
4.2.1
TriCore Aurix Family
4.2.1.1
Context
  A0-A15
  D0-D15
  PSW
  PCXI
  DPR0L, DPR0H

Note
The register A8 is exclusively used by the OS to hold the pointer to the current thread.
  Thus any addressing modes which would use A8 register are not possible.

4.2.1.2
Core Registers
  ICR
  SYSCON
  PCXI
  FCX
  LCX
  PSW
  PC
  DBGSR
  DPRxL, DPRxH
  CPRxL, CPRxH
  DPREx
  DPWEx
  CPXEx
4.2.1.3
Interrupt Registers
  INT_SRC0 – INTSRC255 (Aurix TC2xx)
  INT_SRC0 – INTSRC1023 (Aurix TC3xx)
4.2.1.4
GPT Registers
  T2, T3, T6
  T2CON, T3CON, T6CON
© 2017 Vector Informatik GmbH
Version 2.12.0
110
based on template version 6.0.1

Technical Reference MICROSAR OS
  CAPREL
4.2.1.5
STM Registers
  TIM0, TIM5, TIM6
  CMCON
  CAP
  CMP0, CMP1
4.2.1.6
Aurix Special Characteristics
  The exception handler for trap class 1 is implemented by the OS
  The exception handler for trap class 6 is implemented by the OS

Caution
  The TriCore Hardware enforces that a configured MPU region must be followed by at
least 15 padding bytes before the next region may be started.
MICROSAR OS obey to this rule within the generated linker scripts. For other
additional configured MPU regions the user has to take care to fulfill this requirement

Start Address of MPU Region
End Address of MPU Region
At least 15 padding bytes
Start Address of adjacent MPU Region
End Address of adjacent MPU Region

Figure 4-1  Padding bytes between MPU regions
© 2017 Vector Informatik GmbH
Version 2.12.0
111
based on template version 6.0.1

Technical Reference MICROSAR OS

Caution
Due to MPU granularity all start addresses and end addresses of configured MPU
  regions must be a multiple of 8.
MICROSAR OS programs the MPU to grant access to the memory region between
start address and end address.
>  Access to configured start address itself is granted
>  Access to configured end address is prohibited

Caution
MICROSAR OS does not use the System MPU to achieve freedom of interference
  between cores.
This has to be done by the application.
The system MPU has to be initialized by a lockstep core. It must not be accessed by
non-lockstep cores.

Note
All stack sizes shall be configured to be a multiple of 8

Expert Knowledge
For proper context management exception handling the LCX should be initialized
  during startup code that it does not point to the last available CSA.
In this way some CSAs are reserved which can be used within the context exception
handling for further function calls.

© 2017 Vector Informatik GmbH
Version 2.12.0
112
based on template version 6.0.1

Technical Reference MICROSAR OS

Caution with HighTec (GNU) Compiler
The interrupt vector table (used in BIV) and exception vector table (used in BTV) must
be aligned manually in the user linker script.
The following example shows how the interrupt vector table (of Core0) can be included
and aligned to a 0x2000 byte boundary:
. = ALIGN(8192);
#define OS_LINK_INTVEC_CODE
#include "Os_Link_Core0.ld"
The following example shows how the exception vector table (of Core0) can be
included and aligned to a 0x100 byte boundary:
. = ALIGN(256);
#define OS_LINK_EXCVEC_CODE
#include "Os_Link_Core0.ld"

© 2017 Vector Informatik GmbH
Version 2.12.0
113
based on template version 6.0.1

Technical Reference MICROSAR OS
4.2.1.7
PSW handling
PSW.RM bit handling
MICROSAR OS sets the rounding mode bits to 0 upon start of a
thread.
PSW.S bit handling
MICROSAR OS sets the safety task identifier bit to 1 for trusted
software parts and to 0 for non-trusted software parts.
PSW.IS bit handling
MICROSAR OS sets the interrupt stack bit to 1.
Thus automatic hardware stack switch is not supported.
PSW.GW bit handling
MICROSAR OS sets the global address register write permission to 0.
Write permission to A0, A1, A8 and A9 are not allowed.
PSW.CDE bit handling
MICROSAR OS sets the call depth enable bit to 1 upon start of a
thread.
Call depth counting is enabled.
PSW.CDC bits handling MICROSAR OS sets the call depth counter to 1 upon start of a thread.

© 2017 Vector Informatik GmbH
Version 2.12.0
114
based on template version 6.0.1

Technical Reference MICROSAR OS
4.2.2
RH850 Family
4.2.2.1
Context
  R1 ... R31
  PC
  PSW
  PMR
  LP
  SP
  EIPC, EIPSW
  FPSR, FPEPC
  ASID
  MPLA0, MPUA0
4.2.2.2
Core Registers
  PC
  PSW
  PMR
  LP
  SP
  ASID
  SCCFG
  SCBP
  EIPC
  EIPSW
  EIWR
  FPSR
  FPEPC
  EBASE
  INTBP
  INTCFG
  CTPC
  EIIC
  FEIC
© 2017 Vector Informatik GmbH
Version 2.12.0
115
based on template version 6.0.1

Technical Reference MICROSAR OS
  FEPC
  FEPSW
  HTCFG0

Note
  The register EIWR is exclusively used by the OS to hold the pointer to the current
thread.

4.2.2.3
MPU Registers
  MPM
  MPRC
  MPLA0 ... MPLA15
  MPUA0 ... MPUA15
  MPAT0 ... MPAT15
4.2.2.4
INTC Registers
  EIC0 ... EIC511
  IBD0 … IBD511
  FEINTFMSK0
  FEINTFMSK1
4.2.2.5
Inter Processor Interrupt Control Registers
  IPIR_CH0
  IPIR_CH1
  IPIR_CH2
  IPIR_CH3
4.2.2.6
Timer TAUJ Registers
  TAUJnCDR
  TAUJnCNT
  TAUJnCMUR
  TAUJnCSR
  TAUJnCSC
  TAUJnTE
  TAUJnTE0
© 2017 Vector Informatik GmbH
Version 2.12.0
116
based on template version 6.0.1

Technical Reference MICROSAR OS
  TAUJnTE1
  TAUJnTS
  TAUJnTS0
  TAUJnTS1
  TAUJnTT
  TAUJnTT0
  TAUJnTT1
  TAUJnTO
  TAUJnTO0
  TAUJnTO1
  TAUJnTOE
  TAUJnTOE0
  TAUJnTOE1
  TAUJnTOL
  TAUJnTOL0
  TAUJnTOL1
  TAUJnRDT
  TAUJnRDT0
  TAUJnRDT1
  TAUJnRSF
  TAUJnRSF0
  TAUJnRSF1
  TAUJnRSF2
  TAUJnCMOR
  TAUJnTPS
  TAUJnTPS0
  TAUJnBRS
  TAUJnBRS0
  TAUJnBRS1
  TAUJnTOM
  TAUJnTOM0
© 2017 Vector Informatik GmbH
Version 2.12.0
117
based on template version 6.0.1

Technical Reference MICROSAR OS
  TAUJnTOM1
  TAUJnTOC
  TAUJnTOC0
  TAUJnTOC1
  TAUJnRDE
  TAUJnRDE0
  TAUJnRDE1
  TAUJnRDM
  TAUJnRDM0
  TAUJnRDM1
4.2.2.7
Timer STM Registers
  STMnCKSEL
  STMnTS
  STMnTT
  STMnCSTR
  STMnSTR
  STMnSTC
  STMnIS
  STMnRM
  STMnCNT0L
  STMnCNT0H
  STMnCMP0AL
  STMnCMP0AH
  STMnCMP0BL
  STMnCMP0BH
  STMnCMP0CL
  STMnCMP0CH
  STMnCMP0DL
  STMnCMP0DH
  STMnCNT1
  STMnCMP1A
© 2017 Vector Informatik GmbH
Version 2.12.0
118
based on template version 6.0.1

Technical Reference MICROSAR OS
  STMnCMP1B
  STMnCMP1C
  STMnCMP1D
  STMnCNT2
  STMnCMP2A
  STMnCMP2B
  STMnCMP2C
  STMnCMP2D
  STMnCNT3
  STMnCMP3A
  STMnCMP3B
  STMnCMP3C
  STMnCMP3D
4.2.2.8
Timer OSTM Registers
  OSTMnCMP
  OSTMnCNT
  OSTMnTO
  OSTMnTOE
  OSTMnTE
  OSTMnTS
  OSTMnTT
  OSTMnCTL
  OSTMnEMU
4.2.2.9
RH850 Special Characteristics

Note
  >  The exception handler for TRAP1 (offset = 0x50) is implemented by the OS.

© 2017 Vector Informatik GmbH
Version 2.12.0
119
based on template version 6.0.1

Technical Reference MICROSAR OS

Note
  In SC3 / SC4 systems
>  The exception handler for TRAP0 (offset = 0x40) is implemented by the OS.
>  The exception handler for MIP/MDP (offset = 0x90) is implemented by the OS.

Caution
  The MPU in RH850 has a granularity of 4Byte. Each data section must have 4Byte
address alignement.

Caution
  Due to MPU granularity the start address of any configured MPU region must be a
multiple of 4Byte.
The end address of any configured MPU region must be the address of the last valid
Byte of the section.
MICROSAR OS programs the MPU to grant access to the memory region from start
address and end address.

Note
All stack sizes shall be configured to be a multiple of 4

Note
  Tiny data area (TDA) and zero data area (ZDA) addressing are not supported.

Note
  For multicore-core derivatives, the stack used before StartOS should be linked into the
respective core local RAM areas.

© 2017 Vector Informatik GmbH
Version 2.12.0
120
based on template version 6.0.1

Technical Reference MICROSAR OS
4.2.2.10  PSW Register Handling
PSW.EBV
MICROSAR OS sets PSW.EBV to 1 upon Os_Init().
PSW.UM
MICROSAR OS sets PSW.UM to 0 for trusted software parts and to 1 for non-
trusted software parts.
PSW.NP
MICROSAR OS sets PSW.NP to 1 to disable FE level interrupts and to 0 to
enable FE level interrupts.
PSW.ID
MICROSAR OS sets PSW.ID to 1 to disable EI level interrupts and to 0 to
enable EI level interrupts.
PSW.CU0
MICROSAR OS sets PSW.CU0  to 1 in order to support FPU.

4.2.2.11  Instructions

Caution
> The instructions "trap 16" … “trap 31” used for TRAP1 are exclusively used by the
  OS.

Caution
  In SC3 / SC4 systems
>  The instructions "trap 0" … “trap 15” used for TRAP0 are exclusively used by the
OS.
>  The instruction "syscall" is not supported and therefore shall not be used.

4.2.2.12  Exception and Interrupt Cause Address

Note
  The exception and interrupt cause address from EIPC and FEPC is stored in register
CTPC when unhandled EIINT, unhandled SYSCALL, MIP/MDP exception (SC3/SC4)
or unhandled core exception is reported.

© 2017 Vector Informatik GmbH
Version 2.12.0
121
based on template version 6.0.1

Technical Reference MICROSAR OS
4.2.3
Power PC Family

4.2.3.1
Context
  R2
  R13-R31
  PID
  SP
  PC
  LR
  MSR
  INTC_CPR[0|1|2]
  SPEFSCR5

4.2.3.2
Core Registers
  SPRG0, SPRG1
  SRR0, SRR1
  IVPR
  PIR
  SIR5
  IVOR0 – 355

4.2.3.3
Interrupt Registers
  INTC_BCR5
  INTC_MCR5
  INTC_CPRn
  INTC_IACKRn
  INTC_EOIRn
  INTC_SSCIRn
  INTC_PSRn


5 Only used if the register is available on hardware.
© 2017 Vector Informatik GmbH
Version 2.12.0
122
based on template version 6.0.1

Technical Reference MICROSAR OS
4.2.3.4
PIT Registers
  PIT_MCR
  PIT_LDVALn
  PIT_CVALn
  PIT_TCTRLn
  PIT_TFLGn

4.2.3.5
STM Registers
  STM_CR
  STM_CNT
  STM_CCRn
  STM_CIRn
  STM_CMPn

4.2.3.6
MPU Registers
Core MPU
System MPU
>  CMPU_MAS0
>  SMPU_CESR0
>  CMPU_MAS1
>  SMPU_RGDn_WRDn
>  CMPU_MAS2
(number of used region words depends on
system MPU hardware)
>  CMPU_MAS3
>  CMPU_MPU0CSR0

4.2.3.7
SEMA4 Registers
  SEMA42_GATE0

4.2.3.8
MC_ME Registers
  MC_ME_MCTL
  MC_MC_CCTLn
  MC_ME_CADDRn

4.2.3.9
SSCM Registers
  SSCM_DPMBOOT
  SSCM_DPMKEY

© 2017 Vector Informatik GmbH
Version 2.12.0
123
based on template version 6.0.1

Technical Reference MICROSAR OS
4.2.3.10  Power PC Special Characteristics
  The exception handler for Machine check is implemented by the OS
  The exception handler for Data Storage is implemented by the OS
  The exception handler for Instruction Storage is implemented by the OS
  The exception handler for External Input is implemented by the OS
  The exception handler for Program is implemented by the OS
  The exception handler for System call is implemented by the OS

Note
The register SPRG0 is exclusively used by the OS to hold the identifier of the current
  thread.
The register SPRG1 is exclusively used by the OS to hold the address of the
INTC_CPR register.
The register SEMA42_GATE0 is exclusively used by the OS to provide mutual
exclusion in multicore systems for spinlock handling.
Thus these registers must not be used otherwise.

Caution
  Due to MPU granularity all start addresses of configured MPU regions for the
SystemMPU must be a multiple of 32. The configured end addresses must be a
multiple of 32 minus one byte.
MICROSAR OS programs the MPU to grant access to the memory region between
start address and end address.
>  Access to configured start address and end address itself is granted

Note
For the CoreMPU, no restrictions on start address and end address apply.
  MICROSAR OS programs the MPU to grant access to the memory region between
start address and end address.
>  Access to configured start address and end address itself is granted

© 2017 Vector Informatik GmbH
Version 2.12.0
124
based on template version 6.0.1

Technical Reference MICROSAR OS

Note
All stack sizes shall be configured to be a multiple of 8

Caution
  MICROSAR OS assumes that Power PC multi core derivatives are booted as a master
/ slave system (as described in 2.15.4).

Note
  For System MPU regions only the format FMT1 is supported to setting up the
SMPUx_RGDn_WORD2.

Note
  MICROSAR OS does not change the target chip mode of register MC_ME_MCTL.
Furthermore, user software may change this register.

Caution
  If the user software changes the target chip mode of register MC_ME_MCTL, it must
ensure that all running cores are allowed to run in the new target chip mode by setting
appropriate flags in MC_ME_CCTLn.

Note
Only 32-Bit GPR registers are saved during context switch.

© 2017 Vector Informatik GmbH
Version 2.12.0
125
based on template version 6.0.1

Technical Reference MICROSAR OS
4.2.3.11  Derivative Special Characteristics
The following table shows special characeristics of the MICROSAR OS for different Power
PC derivative groups.
MPC564xL
>  Only LS-Mode supported
MPC567xK
>  Only LS-Mode supported
MPC577xC
>  Stacks for physical core 0 need to be mapped to PRAMC_0
>  Stacks for physical core 0 need to be mapped to PRAMC_1

4.2.3.12  MSR Handling
MSR.SPV bit handling
MICROSAR OS sets the SPV bit to 1 upon start of a thread.
MSR.EE bit handling
MICROSAR OS sets the external interrupt enable bit to 0 for non-
interruptible threads without TimingProtection supervision, and to 1 for
interruptible or TimingProtection supervised threads.
MSR.PR bit handling
MICROSAR OS sets the problem state bit to 0 for trusted software
parts and to 1 for non-trusted software parts.
MSR.ME bit handling
MICROSAR OS sets the machine check enable bit to 1.
Asynchronous Machine Check interrupts are enabled.
MSR remaining bits
MICROSAR OS sets all other MSR bits to 0 upon start of a thread.
handling

© 2017 Vector Informatik GmbH
Version 2.12.0
126
based on template version 6.0.1

Technical Reference MICROSAR OS
4.2.4
ARM Family
4.2.4.1
Cortex-R derivatives

Cortex-R Limitations
MICROSAR OS does not support the configuration of ISRs with parameter
  OsIsrEnableNesting = TRUE in combination with timing protection (SC2 or SC4).

4.2.4.1.1
Generic Cortex-R
Context Registers
>  R4-R11
>  PC
>  LR
>  SP
>  PSR
Core Registers
>  SCTLR
>  TPIDRURO
MPU Registers
>  DRBAR
>  DRSR
>  DRACR
>  RGNR

© 2017 Vector Informatik GmbH
Version 2.12.0
127
based on template version 6.0.1

Technical Reference MICROSAR OS
4.2.4.1.2
Traveo Family
Context Registers
>  R4-R11
>  PC
>  LR
>  SP
>  PSR
>  IRQPLM
Core Registers
>  SCTLR
>  TPIDRURO
MPU Registers
>  DRBAR
>  DRSR
>  DRACR
>  RGNR
Bootrom Registers
>  UNLOCK
>  CNFG
>  UNDEFINACT
>  SVCINACT
>  PABORTINACT
>  DABORTINACT
INTC Registers
>  NMIST
>  IRQST
>  NMIVAn
>  IRQVAn
>  NMIPLn
>  IRQPLn
>  NMIS
>  NMIR
>  IRQSn
>  IRQRn
>  IRQCESn
>  IRQCERn
>  NMIHC
>  IRQHC
>  UNLOCK
FRT Registers
>  TCDT
>  TCCS
>  TCCSC
>  TCCSS
Output Compare Registers
>  OCCP0, OCCP1
>  OCS
© 2017 Vector Informatik GmbH
Version 2.12.0
128
based on template version 6.0.1

Technical Reference MICROSAR OS
> OCSC
> OCSS

© 2017 Vector Informatik GmbH
Version 2.12.0
129
based on template version 6.0.1

Technical Reference MICROSAR OS
4.2.4.1.3
Ultrascale Family
Context Registers
>  R4-R11
>  PC
>  LR
>  SP
>  PSR
>  ICCPMR
Core Registers
>  SCTLR
>  TPIDRURO
MPU Registers
>  DRBAR
>  DRSR
>  DRACR
>  RGNR
INTC Registers
>  ICCICR
>  ICCBPR
>  ICCIAR
>  ICCEOIR
>  ICDDCR
>  ICDISRn
>  ICDISERn
>  ICDICERn
>  ICDISPRn
>  ICDICPRn
>  ICDIPRn
>  ICDIPTRn
>  ICDSGIR
TTC Registers
>  Clock_Control
>  Counter_Control
>  Counter_Value
>  Interval_Counter
>  Match_1_Counter
>  Match_2_Counter
>  Match_3_Counter
>  Interrupt_Register
>  Interrupt_Enable
>  Event_Control_Timer
>  Event_Register

© 2017 Vector Informatik GmbH
Version 2.12.0
130
based on template version 6.0.1

Technical Reference MICROSAR OS
4.2.4.1.4
TI AR 16xx
Context Registers
>  R4-R11
>  PC
>  LR
>  SP
>  PSR
Core Registers
>  SCTLR
>  TPIDRURO
MPU Registers
>  DRBAR
>  DRSR
>  DRACR
>  RGNR
INTC Registers
>  FIRQPR
>  CHANNCTRL
>  REQENASET
>  REQENACLR
>  INTREQ
RTI Registers
>  Global Control
>  Timebase Control
>  Capture Control
>  Compare Control
>  Counter 0/1
>  Up Counter 0/1
>  Compare Up Counter 0/1
>  Capture Free Running Counter 0/1
>  Capture Up Counter 0/1
>  Compare 0/1/2/3
>  Update Compare 0/1/2/3
>  Timebase Low Compare
>  Timebase High Compare
>  Set Interrupt Enable
>  Clear Interrupt Enable
>  Interrupt Flag
Software Interrupt
>  MSS_RCM_SWIRQA
Registers
>  MSS_RCM_SWIRQB
>  MSS_RCM_SWIRQC

© 2017 Vector Informatik GmbH
Version 2.12.0
131
based on template version 6.0.1

Technical Reference MICROSAR OS
4.2.4.1.5
Renesas R-Car H3 (Cortex-R7)
Context Registers
>  R4-R11
>  PC
>  LR
>  SP
>  PSR
>  ICCPMR
Core Registers
>  SCTLR
>  TPIDRURO
MPU Registers
>  DRBAR
>  DRSR
>  DRACR
>  RGNR
Core GIC Registers
>  ICCICR
>  ICCPMR
>  ICCBPR
>  ICCIAR
>  ICCEOIR
>  ICCRPR
>  ICCHPIR
>  ICCIIDR
>  ICDDCR
>  ICDICTR
>  ICDIIDR
>  ICDISERn
>  ICDICERn
>  ICDISPRn
>  ICDICPRn
>  ICDABRn
>  ICDIPRn
>  ICDIPTRn
>  ICDICFRn
>  PPISR
>  SPISRn
>  ICDSGIR
>  PIDR0 ... PIDR4
>  CIDR0 ... CIDR3
INTC-RT Registers
>  GICC_CTLR

>  GICC_PMR
>  GICC_BPR
>  GICC_IAR
>  GICC_EOIR
>  GICC_RPR
>  GICC_HPPIR
>  GICC_ABPR
>  GICC_AIAR
© 2017 Vector Informatik GmbH
Version 2.12.0
132
based on template version 6.0.1

Technical Reference MICROSAR OS
>  GICC_AEOIR
>  GICC_AHPPIR
>  GICC_APR0
>  GICC_NSAPR0
>  GICC_IIDR
>  GICC_DIR
>  GICD_CTLR
>  GICD_TYPER
>  GICD_IIDR
>  GICD_IGROUPRn
>  GICD_ISENABLERn
>  GICD_ICENABLERn
>  GICD_ISPENDRn
>  GICD_ICPENDRn
>  GICD_ISACTIVERn
>  GICD_ICACTIVERn
>  GICD_IPRIORITYRn
>  GICD_ITARGETSRn
>  GICD_ICFGRn
>  GICD_PPISR
>  GICD_SPISRn
>  GICD_SGIR
>  GICD_CPENDSGIRn
>  GICD_SPENDSGIRn
>  GICD_PIDR0 ... GICD_PIDR7
>  GICD_CIDR0 ... GICD_CIDR3
Timer Unit (TMU)
>  TSTRm (m = 0 ... 4)
Registers
>  TCORn (n = 0 ... 14)
>  TCNTn (n = 0 ... 14)
>  TCRn (n = 0 ... 14)

© 2017 Vector Informatik GmbH
Version 2.12.0
133
based on template version 6.0.1

Technical Reference MICROSAR OS
4.2.4.2
Cortex-A derivatives

Generic Cortex-A
iMX6 Family
Context Registers
>  R4-R11
>  PC
>  LR
>  SP
>  PSR
Core Registers
>  SCTLR
>  VBAR
INTC Registers
>  ICCICR
>  ICCBPR
>  ICCIAR
>  ICCEOIR
>  ICDDCR
>  ICDISRn
>  ICDISERn
---
>  ICDICERn
>  ICDISPRn
>  ICDICPRn
>  ICDIPRn
>  ICCPMR
>  ICDIPTRn
>  ICDSGIR

© 2017 Vector Informatik GmbH
Version 2.12.0
134
based on template version 6.0.1

Technical Reference MICROSAR OS
4.2.4.3
Cortex-M derivatives

4.2.4.3.1
Generic Cortex-M
Context Registers
>  R4-R11
>  PC
>  LR
>  SP
>  PSR
>  CONTROL
>  BASEPRI
Core Registers
>  MPIDR
>  PRIMASK
>  FAULTMASK
>  CCR
>  SHPR1
>  SHPR2
>  SHPR3
>  SHCSR
>  SYST_CSR
>  SYST_RVR
>  SYST_CVR
>  SYST_CALIB
Core MPU
>  MPU_TYPE
Registers
>  MPU_CTRL
(Optional)
>  MPU_RNR
>  MPU_RBAR
>  MPU_RASR
INTC Registers
>  SHPR
>  NVIC_ISER
>  NVIC_ICER
>  NVIC_ISPR
>  NVIC_ICPR
>  NVIC_IABR
>  NVIC_IPR
>  ICSR
>  VTOR
>  STIR

© 2017 Vector Informatik GmbH
Version 2.12.0
135
based on template version 6.0.1

Technical Reference MICROSAR OS
4.2.4.3.2
ATSAMv7x Family
Context Registers
>  R4-R11
>  PC
>  LR
>  SP
>  PSR
>  CONTROL
>  BASEPRI
Core Registers
>  MPIDR
>  PRIMASK
>  FAULTMASK
>  CCR
>  SHPR1
>  SHPR2
>  SHPR3
>  SHCSR
>  SYST_CSR
>  SYST_RVR
>  SYST_CVR
>  SYST_CALIB
Core MPU
>  MPU_TYPE
Registers
>  MPU_CTRL
>  MPU_RNR
>  MPU_RBAR
>  MPU_RASR
INTC Registers
>  SHPR
>  NVIC_ISER
>  NVIC_ICER
>  NVIC_ISPR
>  NVIC_ICPR
>  NVIC_IABR
>  NVIC_IPR
>  ICSR
>  VTOR
>  STIR
RTT Registers
>  RTT_MR
>  RTT_SR
>  RTT_AR
>  RTT_VR
© 2017 Vector Informatik GmbH
Version 2.12.0
136
based on template version 6.0.1

Technical Reference MICROSAR OS
4.2.4.3.3
S32K14x Family
Context Registers
>  R4-R11
>  PC
>  LR
>  SP
>  PSR
>  CONTROL
>  BASEPRI
Core Registers
>  MPIDR
>  PRIMASK
>  FAULTMASK
>  CCR
>  SHPR1
>  SHPR2
>  SHPR3
>  SHCSR
>  SYST_CSR
>  SYST_RVR
>  SYST_CVR
>  SYST_CALIB
System MPU
>  SMPU_CESR
Registers
>  SMPU_RGDn_WORD0
>  SMPU_RGDn_WORD1
>  SMPU_RGDn_WORD2
>  SMPU_RGDn_WORD3
>  SMPU_RGDAAC0
INTC Registers
>  SHPR
>  NVIC_ISER
>  NVIC_ICER
>  NVIC_ISPR
>  NVIC_ICPR
>  NVIC_IABR
>  NVIC_IPR
>  ICSR
>  VTOR
>  STIR

© 2017 Vector Informatik GmbH
Version 2.12.0
137
based on template version 6.0.1

Technical Reference MICROSAR OS
4.2.4.3.4
TDA2x
Context Registers
>  R4-R11
>  PC
>  LR
>  SP
>  PSR
>  CONTROL
>  BASEPRI
Core Registers
>  MPIDR
>  PRIMASK
>  FAULTMASK
>  CCR
>  SHPR1
>  SHPR2
>  SHPR3
>  SHCSR
>  SYST_CSR
>  SYST_RVR
>  SYST_CVR
>  SYST_CALIB
INTC Registers
>  SHPR
>  NVIC_ISER
>  NVIC_ICER
>  NVIC_ISPR
>  NVIC_ICPR
>  NVIC_IABR
>  NVIC_IPR
>  ICSR
>  VTOR
>  STIR
IPU Registers
>  CORTEXM4_CTRL_REG
>  CORTEXM4_RW_PID1
Spinlock Registers
>  SPINLOCK_SYSCONFIG
>  SPINLOCK_SYSTATUS
>  SPINLOCK_LOCK_REG_0

© 2017 Vector Informatik GmbH
Version 2.12.0
138
based on template version 6.0.1

Technical Reference MICROSAR OS
4.2.4.4
ARM Special Characteristics

  The exception handler for Supervisor Call is implemented by the OS
  The exception handler for Undefined Instruction is implemented by the OS
  The exception handler for Prefetch Abort is implemented by the OS
  The exception handler for Data Abort is implemented by the OS

Caution
Due to MPU hardware restriction the sizes of MPU regions and stack sizes must be
  configured with power of 2 values.

Caution
The MPU configuration must not contain the regions with the number higher than the
  number of available MPU regions minus 2. One region with the highest number is
always reserved for the stack protection.
E.g. if 16 regions are available, only the region numbers from 0 to 14 (inclusive) are
allowed.

Caution with UltraScale derivatives
  The exception vector table of each core must be located in tightly coupled RAM
memory at address 0x0.
Either the debugger or the startup code has to copy the exception vector table from
ROM section “OS_EXCVEC_CORE<core ID>_CODE” to address 0x0.
During OS startup OS code assumes that the exception vector table has already been
copied.

Caution with S32K derivatives
Region 0 of the System MPU is reserved for debugging functionality and could not be
  written by the core. This region is not available for user configuration.

© 2017 Vector Informatik GmbH
Version 2.12.0
139
based on template version 6.0.1

Technical Reference MICROSAR OS

Caution with Cortex-M derivatives exception vector table address
  To avoid memory violations directly after boot phase, the exception vector table has to
be linked correctly (derivative specific) by the user linker script.
e.g. ATSAMv7 Derivative expects that section OS_INTVEC_CORE<core ID>_CODE is
linked to address 0x00400000 (first available internal flash address).

Limitations in TI derivatives with VIM interrupt controller
MICROSAR OS has limited interrupt priority support because VIM interrupt controllers
  do not provide interrupt priority levels:
  Category 1 ISRs can interrupt category 2 ISRs, but ISRs of the same
category cannot interrupt each other.
  Interrupt resources disable all category 2 ISRs.

Caution with GCC compiler
If the feature “Stack Usage Measurement” is activated and one of the OS stacks
  (managed by the OS) is applied before calling Os_Init, then the optimization option
tree-loop-distribute-patterns needs to be disabled.

Note for Cortex-M derivatives with GCC compiler
The interrupt vector tables are in the sections with the name
  “<Core_Name>_VectorTable_Section”. These sections need to be 128 bytes aligned.

Caution with TDA2x derivatives
MICROSAR OS expects that register CORTEXM4_RW_PID1 is initialized with the
  physical core id, before starting.

© 2017 Vector Informatik GmbH
Version 2.12.0
140
based on template version 6.0.1

Technical Reference MICROSAR OS
4.3
Memory Mapping Concept
MICROSAR OS uses the AUTOSAR MemMap mechanism to locate its own variables but
also application variables.

Note
To use the OS memory mapping concept within the AUTOSAR MemMap mechanism
  the generated OS file “Os_MemMap.h” has to be included into “MemMap.h”.
It should be included after the inclusion of the MemMap headers of all other basic
software components.

4.3.1
Provided MemMap Section Specifiers
MICROSAR  OS  uses  and  specifies  section  specifiers  as  described  in  the  AUTOSAR
specification of memory mapping. All section specifiers have one of the following forms:
OS_START_SEC_<SectionType>[_<InitPolicy>][_<Alignment>]
OS_STOP_SEC_<SectionType>[_<InitPolicy>][_<Alignment>]

Note
  Due to clarity and understanding this chapter does only refer to section specifiers that
shall be handled by the application.
The OS internally used section specifiers are not listed here.

SectionType
InitPolicy
Alignment
<Callout>_CODE
-
-
NONAUTOSAR_CORE<Core Id>_CONST
-
UNSPECIFIED
NONAUTOSAR_CORE<Core Id>_VAR
NOINIT
UNSPECIFIED
<ApplicationName>_VAR
-
BOOLEAN
NOINIT
8BIT
ZERO_INIT
16BIT
32BIT
UNSPECIFIED
<ApplicationName>_VAR_FAST
-
BOOLEAN
NOINIT
8BIT
16BIT
32BIT
UNSPECIFIED
<ApplicationName>_VAR_NOCACHE
-
BOOLEAN
NOINIT
8BIT
© 2017 Vector Informatik GmbH
Version 2.12.0
141
based on template version 6.0.1

Technical Reference MICROSAR OS
ZERO_INIT
16BIT
32BIT
UNSPECIFIED
<ApplicationName>_CONST
-
BOOLEAN
8BIT
16BIT
32BIT
UNSPECIFIED
<ApplicationName>CONST_FAST
-
BOOLEAN
8BIT
16BIT
32BIT
UNSPECIFIED

SectionType
InitPolicy
Alignment
<Task/IsrName>_VAR
-
BOOLEAN
NOINIT
8BIT
ZERO_INIT
16BIT
32BIT
UNSPECIFIED
<Task/IsrName>_VAR_FAST
-
BOOLEAN
NOINIT
8BIT
ZERO_INIT
16BIT
32BIT
UNSPECIFIED
<Task/IsrName>_CONST
-
BOOLEAN
8BIT
16BIT
32BIT
UNSPECIFIED
<Task/IsrName>_CONST_FAST
-
BOOLEAN
8BIT
16BIT
32BIT
UNSPECIFIED

SectionType
InitPolicy
Alignment
GLOBALSHARED_VAR
-
BOOLEAN
NOINIT
8BIT
ZERO_INIT
16BIT
32BIT
UNSPECIFIED
© 2017 Vector Informatik GmbH
Version 2.12.0
142
based on template version 6.0.1

Technical Reference MICROSAR OS
GLOBALSHARED_VAR_FAST
-
BOOLEAN
NOINIT
8BIT
ZERO_INIT
16BIT
32BIT
UNSPECIFIED
GLOBALSHARED_VAR_NOCACHE
-
BOOLEAN
NOINIT
8BIT
ZERO_INIT
16BIT
32BIT
UNSPECIFIED
GLOBALSHARED_CONST
-
BOOLEAN
8BIT
16BIT
32BIT
UNSPECIFIED
GLOBALSHARED_CONST_FAST
-
BOOLEAN
8BIT
16BIT
32BIT
UNSPECIFIED
APPSHARED_0X<application bitmask>_VAR_NOCACHE
NOINIT
UNSPECIFIED
CORESHARED_0X<core bitmask>_VAR_NOCACHE
NOINIT
UNSPECIFIED
Table 4-1   Provided MemMap Section Specifiers

Note
  The < application bitmask >: Is a bitmask that specifes all OS applications which are
sharing the section.

Note
  The < core bitmask >: Is a bitmask that specifes all cores which are sharing the
section.

© 2017 Vector Informatik GmbH
Version 2.12.0
143
based on template version 6.0.1

Technical Reference MICROSAR OS
4.3.1.1
Usage of MemMap Macros

Example
#define OS_START_SEC_MyAppl_VAR_FAST_NOINIT_UNSPECIFIED
  #include “MemMap.h”
uint16 MyApplicationVariable;
#define OS_STOP_SEC_MyAppl_VAR_FAST_NOINIT_UNSPECIFIED
#include “MemMap.h”

This code snippet puts the user variable into an OS application section.

4.3.1.2
Resulting sections
The usage of the above described macros will result in the following memory sections:
SectionType
Content / Description
OS_CODE
>  OS Code
OS_INTVEC_CODE
>  Interrupt vector table in case the system needs
one generic vector table for all cores
OS_INTVEC_CORE<Core Id>_CODE
>  Interrupt vector table of one specific core
OS_EXCVEC_CORE<Core Id>_CODE
>  Exception vector table of one core
Table 4-2   MemMap Code Sections Descriptions
The  resulting  sections  for  callouts  are  generated  in  dependency  of  the  configuration
attribute “/MICROSAR/Os/OsOS/OsGenerateMemMap”.
OsGenerateMemMap
Section
Content
USERCODE_AND_STAC OS_USER_CORE<Core Id>_CODE
>  Code of all Tasks,
KS_GROUPED_PER_C
ISRs and all other
ORE
user callouts which
are mapped on one
core.
COMPLETE
OS_<Callout>_CODE
>  Code of one Task or
one ISR or one OS
Hook or other callouts.
Table 4-3   MemMap Callout Code Sections Descriptions

Note
  The MPU may be set up to grant execution from the whole address space.

© 2017 Vector Informatik GmbH
Version 2.12.0
144
based on template version 6.0.1

Technical Reference MICROSAR OS
SectionType
Content / Description
OS_CONST
>  OS constant data
OS_CONST_FAST
>  OS constant data for fast memory
OS_INTVEC_CONST
>  Interrupt vector table in case the system needs
one generic vector table for all cores
OS_CORE<Core Id>_CONST
>  OS constant data related to one specific core
OS_CORE<Core Id>_CONST_FAST
>  OS constant data related to one specific for fast
memory
OS_INTVEC_CORE<Core Id>_CONST
>  Interrupt vector table of one specific core
OS_EXCVEC_CORE<Core Id>_CONST
>  Exception vector table of one core
OS_NONAUTOSAR_CORE<Core Id>_CONST  >  OS constant data of a non-AUTOSAR core
OS_NONAUTOSAR_CORE<Core
>  OS constant data of a non-AUTOSAR core with
Id>_CONST_FAST
shord addressing
OS_GLOBALSHARED_CONST
>  Constants which shall be shared among core
boundaries
OS_GLOBALSHARED_CONST_FAST
>  Constants which shall be shared among core
boundaries and which use short addressing
accesses (e.g. by base address pointer)
OS_<Task/IsrName>_CONST
>  Thread specific constants
OS_<Task/IsrName>_CONST_FAST
>  Thread specific constants which use short
addressing accesses (e.g. by base address
pointer)
OS_<ApplicationName>_CONST
>  Application specific constants
OS_<ApplicationName>_CONST_FAST
>  Application specific constants which use short
addressing accesses (e.g. by base address
pointer)
Table 4-4   MemMap Const Sections Descriptions

Note
The MPU may be set up to grant read access to const sections from all runtime
  contexts (trusted and non-trusted)

Section
t
ent
on
C
OS_VAR_NOCACHE
OS global variables. All cores may
© 2017 Vector Informatik GmbH
Version 2.12.0
145
based on template version 6.0.1

Technical Reference MICROSAR OS
OS_VAR_NOCACHE_NOINIT
have to access these variables.
OS_VAR_FAST_NOCACHE
OS_VAR_FAST_NOCACHE_NOINIT
OS_CORE<Core Id>_VAR
OS core local variables. These
variables are never accessed from
OS_CORE<Core Id>_VAR_FAST
foreign cores.
OS_CORE<Core Id>_VAR_NOINIT
OS_CORE<Core Id>_VAR_FAST_NOINIT
OS_CORE<Core Id>_VAR_NOCACHE
OS_CORE<Core Id>_VAR_FAST_NOCACHE
OS_CORE<Core Id>_VAR_NOCACHE_NOINIT
OS_CORE<Core Id>_VAR_FAST_NOCACHE_NOINIT
OS_PUBLIC_CORE<Core Id>_VAR_NOINIT
OS core local variables. These
variables may also be accessed
OS_PUBLIC_CORE<Core Id>_VAR_FAST_NOINIT
from foreign cores
OS_APPSHARED_0X<application
OS optimized spinlock variables.
bitmask>_VAR_NOCACHE_NOINIT
Only OS applications specified by
<application bitmask> have access
to them.
OS_CORESHARED_0X<core
OS Standard/Optimized spinlock
bitmask>_VAR_NOCACHE_NOINIT
variables.
IOC data structures.
All cores wich are specified by <core
bitmask> have access to them.
OS_NONAUTOSAR_CORE<Core Id>_VAR
User core local variables of non-
AUTOSAR cores. Access to these
OS_NONAUTOSAR_CORE<Core Id>_VAR_FAST
from foreign cores may be allowed.
OS_NONAUTOSAR_CORE<Core Id>_VAR_NOINIT
OS_NONAUTOSAR_CORE<Core Id>_VAR_FAST_NOINIT

Section
t
ent
on
C
OS_GLOBALSHARED_VAR
User global shared variables. All
cores have access to them.
OS_GLOBALSHARED_VAR_FAST
OS_GLOBALSHARED_VAR_NOINIT
OS_GLOBALSHARED_VAR_FAST_NOINIT
OS_GLOBALSHARED_VAR_ZERO_INIT
OS_GLOBALSHARED_VAR_NOCACHE
OS_GLOBALSHARED_VAR_FAST_NOCACHE
© 2017 Vector Informatik GmbH
Version 2.12.0
146
based on template version 6.0.1

Technical Reference MICROSAR OS
OS_GLOBALSHARED_VAR_NOCACHE_NOINIT
OS_GLOBALSHARED_VAR_FAST_NOCACHE_NOINIT
OS_GLOBALSHARED_VAR_NOCACHE_ZERO_INIT
OS_<ApplicationName>_VAR
User application private variables.
Only application members and
OS_<ApplicationName>_VAR_FAST
other trusted software may have
OS_<ApplicationName>_VAR_NOINIT
access to them.
OS_<ApplicationName>_VAR_FAST_NOINIT
OS_<ApplicationName>_VAR_FAST_ZERO_INIT
OS_<ApplicationName>_VAR_NOCACHE
OS_<ApplicationName>_VAR_FAST_NOCACHE
OS_<ApplicationName>_VAR_NOCACHE_NOINIT
OS_<ApplicationName>_VAR_FAST_NOCACHE_NOINIT
OS_<ApplicationName>_VAR_NOCACHE_ZERO_INIT

© 2017 Vector Informatik GmbH
Version 2.12.0
147
based on template version 6.0.1

Technical Reference MICROSAR OS
Section
t
ent
on
C
OS_<Task/IsrName>_VAR
User thread private
variables. Only the owning
OS_<Task/IsrName>_VAR_FAST
thread and other trusted
OS_<Task/IsrName>_VAR_NOINIT
software may have
OS_<Task/IsrName>_VAR_FAST_NOINIT
access to them
OS_<Task/IsrName>_VAR_ZERO_INIT
OS_BARRIER_CORE<Core Id>_VAR_NOCACHE_NOINIT
OS synchronization
barriers. Only the OS
OS_BARRIER_CORE<Core Id>_VAR_FAST_NOCACHE_NOINIT
must have access to
them. They will be
accessed from all cores
OS_CORESTATUS_CORE<Core Id>_VAR_ NOCACHE_NOINIT
Startup state of each
physical core. Only the
OS_CORESTATUS_CORE<Core
OS must have access to
Id>_VAR_FAST_NOCACHE_NOINIT
them. They will be written
by the master core and
the owning core itself, and
read from all cores.
Table 4-5 MemMap Variable Sections Descriptions

© 2017 Vector Informatik GmbH
Version 2.12.0
148
based on template version 6.0.1

Technical Reference MICROSAR OS
The  resulting  sections  for  stacks  are  generated  in  dependency  of  the  configuration
attribute “/MICROSAR/Os/OsOS/OsGenerateMemMap”.
OsGenerateMemMap
Section
Content
USERCODE_AND_STAC OS_STACK_CORE<Core Id>_VAR_NOINIT
Contains all stacks of
KS_GROUPED_PER_C
one core.
ORE
Only the current
running software has
access to the stack.
Software which runs on
a foreign core must not
have access to it.
COMPLETE
OS_STACK_<StackName>_VAR_NOINIT
Contains one OS
stack.
Only the current
running software has
access to the stack.
Software which runs on
a foreign core must not
have access to it.
Table 4-6   MemMap Variable Stack Sections Descriptions

Notes
Sections which contain the keyword “FAST” are intended to be linked into fast RAM.
  Sections which contain the keyword “NOCACHE” must never be linked into cacheable
memory.
Sections which contain the keyword “NOINIT” contain non-initialized variables.
Sections which contain the keyword “ZERO_INIT” contain zero initialized variables.

© 2017 Vector Informatik GmbH
Version 2.12.0
149
based on template version 6.0.1

Technical Reference MICROSAR OS
4.3.1.3
Access Rights to Variable Sections
The table shows the recommended access rights to the sections.
Section

n

no
re
re

ed
ore
re
t

co
co
C

co
l
l
gn
gn
rus
ca
ca
rei
rei
n t
Lo
rustedT
Lo
rustedt
Fo
rustedt
Fo
no
OS_VAR_NOCACHE
OS_VAR_NOCACHE_NOINIT
RW
RO
RW
RO
OS_VAR_FAST_NOCACHE
OS_VAR_FAST_NOCACHE_NOINIT
OS_CORE<Core Id>_VAR
OS_CORE<Core Id>_VAR_FAST
OS_CORE<Core Id>_VAR_NOINIT
OS_CORE<Core Id>_VAR_FAST_NOINIT
RW
RO
RO
RO
OS_CORE<Core Id>_VAR_NOCACHE
OS_CORE<Core Id>_VAR_FAST_NOCACHE
OS_CORE<Core Id>_VAR_NOCACHE_NOINIT
OS_CORE<Core Id>_VAR_FAST_NOCACHE_NOINIT
OS_PUBLIC_CORE<Core Id>_VAR_NOINIT
RW
RO
RW
RO
OS_PUBLIC_CORE<Core Id>_VAR_FAST_NOINIT
OS_NONAUTOSAR_CORE<Core Id>_VAR
OS_NONAUTOSAR_CORE<Core Id>_VAR_FAST
RW
RO
RW
RO
OS_NONAUTOSAR_CORE<Core Id>_VAR_NOINIT
OS_NONAUTOSAR_CORE<Core Id>_VAR_FAST_NOINIT
OS_GLOBALSHARED_VAR
OS_GLOBALSHARED_VAR_FAST
OS_GLOBALSHARED_VAR_NOINIT
OS_GLOBALSHARED_VAR_FAST_NOINIT
OS_GLOBALSHARED_VAR_ZERO_INIT
RW
RW
RW
RW
OS_GLOBALSHARED_VAR_NOCACHE
OS_GLOBALSHARED_VAR_FAST_NOCACHE
OS_GLOBALSHARED_VAR_NOCACHE_NOINIT
OS_GLOBALSHARED_VAR_FAST_NOCACHE_NOINIT
OS_GLOBALSHARED_VAR_NOCACHE_ZERO_INIT

© 2017 Vector Informatik GmbH
Version 2.12.0
150
based on template version 6.0.1

Technical Reference MICROSAR OS
Section

n

no
re
re

ed
ore
re
t

co
co
C

co
l
l
gn
gn
rus
ca
ca
rei
rei
n t
Lo
rustedT
Lo
rustedt
Fo
rustedt
Fo
no
OS_<ApplicationName>_VAR
OS_<ApplicationName>_VAR_FAST
OS_<ApplicationName>_VAR_NOINIT
OS_<ApplicationName>_VAR_FAST_NOINIT
OS_<ApplicationName>_VAR_FAST_ZERO_INIT
RW
RW
RW
RO
OS_<ApplicationName>_VAR_NOCACHE
OS_<ApplicationName>_VAR_FAST_NOCACHE
OS_<ApplicationName>_VAR_NOCACHE_NOINIT
OS_<ApplicationName>_VAR_FAST_NOCACHE_NOINIT
OS_<ApplicationName>_VAR_NOCACHE_ZERO_INIT
OS_<Task/IsrName>_VAR
OS_<Task/IsrName>_VAR_FAST
OS_<Task/IsrName>_VAR_NOINIT
RW
RW
RW
RO
OS_<Task/IsrName>_VAR_FAST_NOINIT
OS_<Task/IsrName>_VAR_ZERO_INIT
OS_BARRIER_CORE<Core Id>_VAR_NOCACHE_NOINIT
RW
RO
RW
RO
OS_BARRIER_CORE<Core Id>_VAR_FAST_NOCACHE_NOINIT
OS_CORESTATUS_CORE<Core Id>_VAR_ NOCACHE_NOINIT
OS_CORESTATUS_CORE<Core
RW
RO
RW
RO
Id>_VAR_FAST_NOCACHE_NOINIT
Table 4-7 Recommended Section Access Rights

Note
The access to the stack section is handled completely by MICROSAR OS

Note
The table is only valid for cores which have the same diagnostic level. Cores with a
lower diagnostic level must never interact with data from a core with a higher diagnostic
level.

© 2017 Vector Informatik GmbH
Version 2.12.0
151
based on template version 6.0.1

Technical Reference MICROSAR OS
4.3.1.4
Access Rights to Shared Data Sections
Section
Access Rights
OS_APPSHARED_0X<application
Only applications which are specified by the
bitmask>_VAR_NOCACHE_NOINIT
<application bitmask> shall have read / write
access.
The bitmasks of applications may be looked up
in “Os_Types_Lcfg.h” > "ApplicationType"
OS_CORESHARED_0X<core
Only cores which are specified by the <core
bitmask>_VAR_NOCACHE_NOINIT
bitmask> shall have read / write access.
The bitmasks of cores may be looked up in
“Os_Hal_Lcfg.h” > "CoreIdType"
Table 4-8   Recommended Spinlock Section Access Rights
4.3.2
Link Sections
Once  variables  have  been  put  into  OS  sections  (by  usage  of  the  section  specifiers
described in 4.3.1.1) the sections would have to be linked.
Therefore  MICROSAR  OS  generates  linker  command  files  which  utilize  the  linkage  of
those sections.
Linker Command Filename
Content
Os_Link_<Core>.<FileSuffix>
All data and code sections which are bound to a
core
Os_Link.<FileSuffix>
All data and code sections which are global
Os_Link_<Core>_Stacks.<FileSuffix>
all stacks of a core
Table 4-9   List of Generated Linker Command Files

Note
<Core> is the logical core ID
  <FileSuffix> is the suffix for linker command files. It depends on the used compiler.

4.3.2.1
Pre-Process Linker Command Files
The generated linker command files uses C pre-processor statements. Some Linkers don’t
understand pre-processor statements. These Linkers require a pre-processing step on the
linker command files.
Windriver DiabData
The pre-processor should be used on command line to pre-process
the linker command files e.g.:
dcc.exe –P Os_Link.dld –o Os_Link_new.dld

© 2017 Vector Informatik GmbH
Version 2.12.0
152
based on template version 6.0.1

Technical Reference MICROSAR OS

4.3.2.2
Simple Linker Defines
The following defines are used to select groups of OS sections from the linker command
files.
Select OS code
OS_LINK_CODE
Select an interrupt vector table
OS_LINK_INTVEC_CODE
Select an exception vector table
OS_LINK_EXCVEC_CODE
Select user callouts (Tasks, ISRs, Hooks)
OS_LINK_CALLOUT_CODE
Select constants related to an interrupt vector table
OS_LINK_INTVEC_CONST
Select constants related to an exception vector table
OS_LINK_EXCVEC_CONST
Select OS stacks
OS_LINK_KERNEL_STACKS

Example
#define OS_LINK_INTVEC_CODE
  #include Os_Link_Core0.lsl

Selects the interrupt vector table from the included linker command file for linking.

4.3.2.3
Hierachical Linker Defines
The linker command files are intended to be included into a main linker command file.
Single sections or group of sections can be selected for linkage by usage of C-like defines.
This mechanism is similar to the MemMap mechanism of AUTOSAR.
The linker defines of MICROSAR OS uses a hierarchical syntax.
The more one walks down in the hierarchy the less sections are selected.

Note
Once one have made the decision for a specific hierarchical level one will have to stick
  to this level throughout the linker defines group. Otherwise there may be multiple
section definitions.

4.3.2.4
Selecting OS constants
These are hierarchical linker defines
Prefix
Optional Hierarchy level 1
OS_LINK_CONST_KERNEL
_NEAR
_FAR
Table 4-10   OS constants linker define group
© 2017 Vector Informatik GmbH
Version 2.12.0
153
based on template version 6.0.1

Technical Reference MICROSAR OS

Example
#define OS_LINK_CONST_KERNEL
  #include Os_Link_Core0.lsl

Selects all OS constants.

Example
#define OS_LINK_CONST_KERNEL_NEAR
  #include Os_Link_Core0.lsl

Selects all near addressable OS constants only.

4.3.2.5
Selecting OS variables
These are hierarchical linker defines
Prefix
Optional Hierarchy
Optional
Optional
level 1
Hierarchy level  Hierarchy level 3
2
OS_LINK_VAR_KERNEL
_NEAR
_CACHE
_INIT
_FAR
_NOCACHE
_NOINIT
Table 4-11   OS variables linker define group

Example
#define OS_LINK_VAR_KERNEL
  #include Os_Link_Core0.lsl

Selects all OS variables.

Example
#define OS_LINK_VAR_KERNEL_NEAR_CACHE
  #include Os_Link_Core0.lsl

Selects all OS variables which are near addressable and cacheable.

© 2017 Vector Informatik GmbH
Version 2.12.0
154
based on template version 6.0.1

Technical Reference MICROSAR OS
4.3.2.6
Selecting special OS Variables
These are hierarchical linker defines
Prefix
Optional Hierarchy level 1
OS_LINK_KERNEL_BARRIERS
_NEAR
OS_LINK_KERNEL_CORESTATUS
_FAR
OS_LINK_KERNEL_TRACE
Table 4-12   OS Barriers and Core status linker define group

Example
#define OS_LINK_KERNEL_BARRIERS
  #include Os_Link_Core0.lsl

Selects all OS Barriers.

Example
#define OS_LINK_KERNEL_CORESTATUS
  #include Os_Link_Core0.lsl

Selects all OS core state variables.

Prefix
Optional Hierarchy level  Owner Bitmask
Optional
1
Hierarchy level
2
OS_LINK_VAR
_APPSHARED
_0X<application bitmask>  _NEAR
_CORESHARED
_0X<core bitmask>
_FAR

Example
#define OS_LINK_VAR_APPSHARED
  #include Os_Link.lsl

Selects all OS application shared variables

© 2017 Vector Informatik GmbH
Version 2.12.0
155
based on template version 6.0.1

Technical Reference MICROSAR OS
4.3.2.7
Selecting User Constant Sections
These are hierarchical linker defines
Prefix
Optional Hierarchy level 1
Owner Name
Optional Hierarchy level 2
OS_LINK_CONST
_APP
<Owner Name>
_TASK
_NEAR
_ISR
_FAR
_GLOBALSHARED
---
Table 4-13 User constants linker define group

Example
#define OS_LINK_CONST_APP_<ApplicationName>

#include Os_Link_Core0.lsl

Selects all constants which belong to the OS application <ApplicationName>

Example
#define OS_LINK_CONST_ISR_<ISRName>_FAR

#include Os_Link_Core0.lsl

Selects all constants which belong to the ISR <ISRName> which have far addressing

© 2017 Vector Informatik GmbH
Version 2.12.0
156
based on template version 6.0.1

Technical Reference MICROSAR OS
4.3.2.8
Selecting User Variable Sections
These are hierarchical linker defines
Prefix
Optional Hierarchy
Owner Name
Optional Hierarchy
Optional Hierarchy
Optional Hierarchy
level 1
level 2
level 3
level 4
OS_LINK_VAR
_APP
<Owner Name>
_INIT
_TASK
_NEAR
_CACHE
_NOINIT
_ISR
_FAR
_NOCACHE
_ZEROINIT
_GLOBALSHARED
---
Table 4-14 User variables linker define group

Example
#define OS_LINK_VAR_APP_<ApplicationName>

#include Os_Link_Core0.lsl

Selects all variables which belong to the OS application <ApplicationName>

© 2017 Vector Informatik GmbH
Version 2.12.0
157
based on template version 6.0.1

Technical Reference MICROSAR OS

Example
#define OS_LINK_VAR_APP_<ApplicationName>_FAR_CACHE_INIT

#include Os_Link_Core0.lsl

Selects all variables which belong to the OS application <ApplicationName> which have far addressing, are cacheable and are
initialized

© 2017 Vector Informatik GmbH
Version 2.12.0
158
based on template version 6.0.1

Technical Reference MICROSAR OS
4.3.3
Section Symbols
The linker command files described in 4.3.2 also generate section start and stop symbols
which may be used to configure start and end addresses of MPU region objects or access
check region objects.
These have the syntax
OS_<SectionType>_START
OS_<SectionType>_END

Example
  OS_MyAppl_VAR_FAST_START
OS_ MyAppl_VAR_FAST_END

Note
For ARM compiler, the OS generator will not generate section start and stop symbols.
  However, the ARM linker will provide region-related symbols with special patterns (e.g.:
Image$$region_name$$Base or Load$$region_name$$Base), which can be used to
configure start and end addresses of MPU region objects or access check region
objects. Detailed information about the region-related symbols can be found in the user
guide of the ARM compiler.

4.4
Static Code Analysis

Note
  When running tools for static code analysis (e.g. MISRA, MSSV), the pre-processor
definition OS_STATIC_CODE_ANALYSIS has to be set during analysis. It switches off
compiler specific keywords and inline assembler parts. Typically code analysis tools
cannot deal with such code parts.

© 2017 Vector Informatik GmbH
Version 2.12.0
159
based on template version 6.0.1

Technical Reference MICROSAR OS
4.5
Configuration of X-Signals
This chapter describes how X-Signals are configured for cross core API calls.
1.  Add an “OsCoreXSignalChannel” to an “OsCore” object. This core will be the sender of
the X-Signal.
2.  Specify the queue size of the channel with the “OsCoreXSignalChannelSize” attribute.
3.  Add an X-Signal receiver ISR. It must be of category 2.
4.  Assign this ISR to be the X-Signal receiver
“OsCore/OsCoreXSignalChannelReceiverIsr”.
5.  Configure an appropriate interrupt priority for the receiver ISR (see the following
chapters for details on your used platform). The configured priority must follow the
rules listed in Table 3-3.
6.  Choose an appropriate interrupt source for the receiver ISR (see the following
chapters for details on your used platform).
7.  Add the "OsIsrXSignalReceiver" to the receiver ISR and select the provided APIs
(callable from the sender core) with the "OsIsrXSignalReceiverProvidedApis" attribute.

Note
  The DaVinci Configurator provides solving actions which support the correct
configuration of X-signals.

4.5.1
TriCore Aurix Family
Logical Priority
A low number for OsIsrInterruptPriority attribute means a low
logical priority
X-Signal ISR Interrupt Priority
Beside the rules listed in Table 3-3 the OsIsrInterruptPriority
can be chosen freely.
X-Signal ISR Interrupt Source
Any interrupt source, which is not used by other modules, may
be used for the X-Signal ISR.
The offset of the SRC register of the used interrupt source has
to be specified for OsIsrInterruptSource.

4.5.2
RH850 Family
Logical Priority
A low number for OsIsrInterruptPriority attribute means a high
logical priority
X-Signal ISR Interrupt Priority
Beside the rules listed in Table 3-3 the OsIsrInterruptPriority
can be chosen freely.
X-Signal ISR Interrupt Source
Only interrupt sources of type INTIPIRn can be used. Available
sources INTIPIRn are listed in the hardware manual of used
derivative.

© 2017 Vector Informatik GmbH
Version 2.12.0
160
based on template version 6.0.1

Technical Reference MICROSAR OS
4.5.3
Power PC Family
Logical Priority
A low number for OsIsrInterruptPriority attribute means a low
logical priority
X-Signal ISR Interrupt Priority
Beside the rules listed in Table 3-3 the OsIsrInterruptPriority
can be chosen freely.
X-Signal ISR Interrupt Source
Any Interrupt source of the available software interrupts may
be used.

4.5.4
ARM Family

NVIC Interrupt Controller – TDA2x
GIC Interrupt Controller
Logical Priority
A low number for OsIsrInterruptPriority attribute means a high logical priority
X-Signal ISR
Beside the rules listed in Table 3-3 the OsIsrInterruptPriority can be chosen
Interrupt Priority
freely.
X-Signal ISR
Interrupt source 19 has to be used for  The interrupt sources 0..15 have to be
Interrupt Source
the X-Signal ISRs.
used for the X-Signal ISR.

4.5.5
VTT OS
Logical Priority
A low number for OsIsrInterruptPriority attribute means a low
logical priority
X-Signal ISR Interrupt Priority
Beside the rules listed in Table 3-3 the OsIsrInterruptPriority
can be chosen freely.
X-Signal ISR Interrupt Source
Any interrupt source, which is not used by other modules, may
be used for the X-Signal ISR.

4.6
OS generated objects
In  dependency  of  its  configuration  MICROSAR  OS  may  add  other  OS  configuration
objects to it.
4.6.1
System Application
Type
OsApplication
Name
SystemApplication_<CoreName>
Condition
Is added when the OsCore <CoreName> is configured to be an
AUTOSAR core.
Features
>  A system application contains the OS objects
>  IdleTask_<CoreName>
>  TpCounter_<CoreName>
>  XSignalIsr_<CoreName>
>  CounterIsr_TpCounter_<CoreName>

© 2017 Vector Informatik GmbH
Version 2.12.0
161
based on template version 6.0.1

Technical Reference MICROSAR OS
4.6.2
Idle Task
Type
OsTask
Name
IdleTask_<CoreName>
Condition
Is added when the OsCore <CoreName> is configured to be an
AUTOSAR core.
Features
>  Has the lowest priority of all tasks assigned to the same core.
>  Is fully preemptive.
>  Is implemented by the OS

Idle Task Priority
The generator has a special treatment for the idle task. The idle task has the virtual
  priority 0xFFFFFFFF to differentiate it from regular tasks. It will be generated to have
the lowest priority, even if there are tasks configured with priority 0.

User Code Execution
The idle task is implemented by the OS to simplify scheduling and idle treatment. The
  OS does not rely on execution of the idle task. Implement an additional task with
priority 0, if user code execution during idle time is needed.

4.6.3
Timer ISR
Type
OsIsr
Name
CounterIsr_<CoreName>
Condition
Is added if a hardware OsCounter is configured to have a driver
(attribute “OsCounterDriver”).
Features
>  Is Implemented by the OS.
>  Handles the system timer counter, alarms and scheduletables
which are assigned to the core.

4.6.4
System Timer Counter
Type
OsCounter
Name
SystemTimer
Condition
Is added optionally within the recommended configuration.
Features
>  Is used for OSEK backward compatibility

© 2017 Vector Informatik GmbH
Version 2.12.0
162
based on template version 6.0.1

Technical Reference MICROSAR OS
4.6.5
Timing Protection Counter
Type
OsCounter
Name
TpCounter_<CoreName>
Condition
Is added when OsTask/IsrTimingProtection parameters are configured
on the core.
Features
>  Handles all times related to timing protection

4.6.6
Timing protection ISR
Type
OsIsr
Name
CounterIsr_TpCounter_<CoreName>
Condition
Is added when OsTask/IsrTimingProtection parameters are configured
on the core.
Features
>  Interrupt service routine of the timing protection feature

4.6.7
Resource Scheduler
Type
OsResource
Name
RES_SCHEDULER_<CoreName>
Condition
For each core the resource scheduler is added when
OsUseResScheduler is set to TRUE.
Features
>  Is automatically assigned to all tasks of core <CoreName>

4.6.8
X-Signal ISR
Type
OsIsr
Name
XSignalIsr_<CoreName>
Condition
Is added when an X-Signal channel is configured on the core.
Features
>  Handles cross core requests.

4.6.9
IOC Spinlocks
Type
OsSpinlock
Name
IocSpinlock_<IOC Name>
Condition
Is added when an IOC is configured which requires cross core
communication.
Features
>  Each IOC has its own spinlock to reduce core wait times

© 2017 Vector Informatik GmbH
Version 2.12.0
163
based on template version 6.0.1

Technical Reference MICROSAR OS
4.7
VTT OS Specifics
4.7.1
Configuration
As described in [6] all VTT configuration parameters are derived from the hardware target.
The only exceptions are the ISR objects for the VTT OS.
  ISRs  from  other  Vector  MICROSAR  BSW  modules  (e.g.  CAN)  are  inserted
automatically by the respective BSW module.
  Other user ISRs have to be added separately.
  Interrupt levels for all ISRs have to be configured manually. VTT OS knows interrupt
levels from 1 to 200 (where 1 is the lowest priority and 200 the highest).
4.7.2
CANoe Interface
A  VTT  OS  is  simulated  within  the  CANoe  simulation  software.  There  are  a  set  of  API
functions which are capable to communicate with CANoe (e.g. sending a message on the
CAN bus).
These API functions are prefixed with “CANoeAPI_”.
The available set of API functions can be looked up in the delivered header “CANoeApi.h”.
4.7.2.1
Idle Task behavior with VTT OS
Any  idle  task  which  runs  within  the  VTT  OS  must  call  the  function
“CANoeAPI_ConsumeTicks” (see description in CANoeApi.h).

Caution
  If the call of “CANoeAPI_ConsumeTicks” is missing within the idle task, the CANoe
windows application won’t respond any longer!

There are two possible solutions which solves this problem:
1.  The OS generated idle task (see 4.6.2) calls this function by default. The application
has to ensure that this idle task is entered cyclically.
2.  It may be that the OS idle task is never executed, because there is a higher priority
application  idle  task.  This  application  idle  task  must  implement  a  cyclic  call  of
“CANoeAPI_ConsumeTicks” instead of the OS idle task.

© 2017 Vector Informatik GmbH
Version 2.12.0
164
based on template version 6.0.1

Technical Reference MICROSAR OS
4.8
POSIX OS Specifics
4.8.1
Configuration
POSIX OS configuration parameters are not derived from the hardware target.
A  virtual  interrupt  controller  is  implemented  in  order  to  simulate  the  hardware  behaviour.
The maximum configurable values are:
  1000 Interrupt sources.
  100 Interrupt levels (ascending priority).
4.8.2
Posix Interface
The set of used POSIX libraries are included in the file: Os_Hal_Compiler_Gcc_types.h.
The recommended POSIX standard version is at least IEEE Std 1003.1-2008.

© 2017 Vector Informatik GmbH
Version 2.12.0
165
based on template version 6.0.1

Technical Reference MICROSAR OS
4.9
User include files
Within some features of MICROSAR OS it may be necessary to provide foreign data types
to the OS.
This can be done by referencing user headers within the OS configuration.
The  features  “IOC”  and  “trusted  functions  stub  generation”  are  relying  on  such  include
mechanisms.

Configuration
Content
IOC
IOC include files are configured with
The headers have to provide
the IOC attribute
>  Definitions of foreign OS data
"OsIocIncludeHeader“.
types which are used within IOC
A list of include files may be specified
communication.
here.
Trusted
Include files which are needed for
The headers have to provide
Functions
trusted function feature are configured  >  The definitions of foreign OS data
within the application attribute
types which are used as trusted
“OsAppCalloutStubsIncludeHeader”.
functions parameters or return
A list of include files may be specified
values.
here.

Caution
  All user include files need to implement a double inclusion preventer!

© 2017 Vector Informatik GmbH
Version 2.12.0
166
based on template version 6.0.1

Technical Reference MICROSAR OS
5  API Description
This chapter lists all API service functions which are provided by MICROSAR OS.
5.1
Specified OS services
The  OS  provides  the  following  services  which  are  specified  within  the  AUTOSAR  OS
specification.
5.1.1
StartCore
Prototype
void StartCore (CoreIdType CoreID, StatusType *Status)
Parameter
CoreID [in]
The core to start.
Status [out]
Status code.
Return code
void
>  E_OK No Error. E_OS_ID (EXTENDED status:)
>  - Core ID is invalid.
>  - Core is no AUTOSAR core. E_OS_ACCESS (EXTENDED status:) The
function was called after starting the OS. E_OS_STATE (EXTENDED
status:) The Core is already activated.
Functional Description
OS service StartCore().
Particularities and Limitations
>  Pre-Condition: Supervisor mode. Pre-Condition: Given object pointer(s) are valid.
Starts the core given by CoreID that is controlled by the AUTOSAR OS. This API is allowed to be used from
AUTOSAR and non-AUTOSAR cores.
Call context
>  -
>  This function is Synchronous
>  This function is Non-Reentrant
Table 5-1   StartCore

© 2017 Vector Informatik GmbH
Version 2.12.0
167
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.2
StartNonAutosarCore
Prototype
void StartNonAutosarCore (CoreIdType CoreID, StatusType *Status)
Parameter
CoreID
The core to start.
Status [out]
Status code.
Return code
void
E_OK No Error. E_OS_ID (EXTENDED status:) Core ID is invalid.
E_OS_STATE (EXTENDED status:) The Core is already activated.
Functional Description
OS service StartNonAutosarCore().
Particularities and Limitations
Pre-Condition: Supervisor mode.
Starts the core given by CoreID that is not controlled by the AUTOSAR OS.
Call context
>  -
>  This function is Synchronous
>  This function is Non-Reentrant
Table 5-2   StartNonAutosarCore

© 2017 Vector Informatik GmbH
Version 2.12.0
168
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.3
GetCoreID
Prototype
CoreIdType GetCoreID (void)
Parameter
void
none
Return code
CoreIdType
Unique ID of the calling core.
Functional Description
OS service GetCoreID().
Particularities and Limitations
Pre-Condition: None
Returns the unique logical core identifier of the core on which the function is called. The mapping of
physical cores to logical CoreIDs is implementation specific. This API is allowed to be used from AUTOSAR
cores only. If the API is required on a non-AUTOSAR core, it is possible to configure the core as an
AUTOSAR core but start it as a non-AUTOSAR core using the StartNonAutosarCore() API.
Call context
>  ANY
>  This function is Synchronous
>  This function is Reentrant
Table 5-3   GetCoreID

© 2017 Vector Informatik GmbH
Version 2.12.0
169
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.4
GetNumberOfActivatedCores
Prototype
uint32 GetNumberOfActivatedCores (void)
Parameter
void
none
Return code
uint32
Number of cores activated by the StartCore() function.
Functional Description
OS service GetNumberOfActivatedCores().
Particularities and Limitations
Pre-Condition: None
The function returns the number of cores activated by the StartCore() function. AUTOSAR specifies this
function to be usable from task and ISR call level. But this function does not explicitly perform any call
context checks. There is no need to, because it is a primitive getter function.
Call context
>  TASK|ISR2
>  This function is Synchronous
>  This function is Reentrant
Table 5-4   GetNumberOfActivatedCores

© 2017 Vector Informatik GmbH
Version 2.12.0
170
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.5
GetActiveApplicationMode
Prototype
AppModeType GetActiveApplicationMode (void)
Parameter
void
none
Return code
AppModeType
Current Application Mode
Functional Description
OS service GetActiveApplicationMode().
Particularities and Limitations
Pre-Condition: None
This service returns the current application mode.
Call context
>  TASK|ISR2|ERRHOOK|PRETHOOK|POSTTHOOK|STARTHOOK|SHUTHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-5   GetActiveApplicationMode

© 2017 Vector Informatik GmbH
Version 2.12.0
171
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.6
StartOS
Prototype
void StartOS (AppModeType Mode)
Parameter
Mode [in]
The application mode in which the OS shall start.
Return code
void
none
Functional Description
OS service StartOS().
Particularities and Limitations
>  Pre-Condition: Supervisor mode. Pre-Condition: Os_Init() has been called before.
Starts the operating system in a given application mode.
Call context
>  -
>  This function is Synchronous
>  This function is Non-Reentrant
Table 5-6   StartOS

© 2017 Vector Informatik GmbH
Version 2.12.0
172
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.7
ShutdownOS
Prototype
void ShutdownOS (StatusType Error)
Parameter
Error
Error code which shall be passed to the ShutdownHook()
Return code
void
none
Functional Description
OS service ShutdownOS().
Particularities and Limitations
Pre-Condition: None
This function shall shutdown the core on which it was called. Only allowed in trusted applications. In case
that ShutdownOS() is called from an invalid context, OS_STATUS_CALLEVEL is reported via the
ProtectionHook.
Call context
>  TASK|ISR2|ERRHOOK|STARTHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-7   ShutdownOS

© 2017 Vector Informatik GmbH
Version 2.12.0
173
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.8
ShutdownAllCores
Prototype
void ShutdownAllCores (StatusType Error)
Parameter
Error [in]
This is the error code which shall be passed to the ShutdownHook().
Return code
void
none
Functional Description
OS service ShutdownAllCores().
Particularities and Limitations
Pre-Condition: None
Propagates a shutdown request to all started AUTOSAR cores and performs a shutdown itself afterwards.
Only allowed in trusted applications.
Call context
>  TASK|ISR2|ERRHOOK|STARTHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-8   ShutdownAllCores

© 2017 Vector Informatik GmbH
Version 2.12.0
174
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.9
ControlIdle
Prototype
StatusType ControlIdle (CoreIdType CoreID, IdleModeType IdleMode)
Parameter
CoreID [in]
Selects the core which idle mode is set
IdleMode [in]
The mode which shall be performed during idle time
Return code
StatusType
E_OK No error. E_OS_ID (EXTENDED status): Invalid core and/or invalid
IdleMode. E_OS_CALLEVEL (EXTENDED status:) Called from invalid context.
E_OS_DISABLEDINT (Service Protection:) Caller is in interrupt API sequence.
Functional Description
OS service ControlIdle().
Particularities and Limitations
Pre-Condition: None
This API allows the caller to select the idle mode action which is performed during idle time of the OS (e.g. if
no Task/ISR is active). The real idle modes are hardware dependent and not standardized. The default idle
mode on each core is IDLE_NO_HALT.
Call context
>  TASK|ISR2
>  This function is Synchronous
>  This function is Non-Reentrant
Table 5-9   ControlIdle

© 2017 Vector Informatik GmbH
Version 2.12.0
175
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.10  GetSpinlock
Prototype
StatusType GetSpinlock (SpinlockIdType SpinlockId)
Parameter
SpinlockId [in]
The spinlock which shall be locked.
Return code
StatusType
>  E_OK No error. E_OS_ID (EXTENDED status:) Invalid SpinlockID.
E_OS_INTERFERENCE_DEADLOCK (EXTENDED status:) Spinlock
already occupied by a task/ISR of the same core.
E_OS_NESTING_DEADLOCK (EXTENDED status:) Invalid Spinlock
allocation order. E_OS_CALLEVEL (EXTENDED status:) Called from
invalid context. E_OS_ACCESS (Service Protection:)
>  - Caller's access rights are not sufficient.
Functional Description
OS service GetSpinlock().
Particularities and Limitations
Pre-Condition: None
Allocates the requested spinlock for the caller. If it is already locked, the function performs active around
until the spinlock becomes available again.
Call context
>  TASK|ISR2
>  This function is Synchronous
>  This function is Reentrant
Table 5-10   GetSpinlock

© 2017 Vector Informatik GmbH
Version 2.12.0
176
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.11  ReleaseSpinlock
Prototype
StatusType ReleaseSpinlock (SpinlockIdType SpinlockId)
Parameter
SpinlockId [in]
The spinlock which shall be released.
Return code
StatusType
E_OK No error. E_OS_ID (EXTENDED status:) Invalid SpinlockID.
E_OS_STATE (EXTENDED status:) The caller is not the owner of the given
spinlock. E_OS_NOFUNC (EXTENDED status:) The caller tries to release a
spinlock while another spinlock has to be released before. E_OS_RESOURCE
(EXTENDED status:) Spinlock and Resource API not used in LIFO order.
E_OS_ACCESS (Service Protection:) Caller's access rights are not sufficient.
This error may occur in combination with trusted functions.
Functional Description
OS service ReleaseSpinlock().
Particularities and Limitations
Pre-Condition: None
ReleaseSpinlock releases a spinlock variable that was occupied before. Before terminating a task/ISR all
spinlock variables that have been occupied with GetSpinlock() shall be released. The error
E_OS_CALLEVEL is already checked by E_OS_STATE. See Os_SpinlockRelease() for details.
Call context
>  TASK|ISR2
>  This function is Synchronous
>  This function is Reentrant
Table 5-11   ReleaseSpinlock

© 2017 Vector Informatik GmbH
Version 2.12.0
177
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.12  TryToGetSpinlock
Prototype
StatusType TryToGetSpinlock (SpinlockIdType SpinlockId, TryToGetSpinlockType
*Success)
Parameter
SpinlockId [in]
The spinlock which shall be locked.
Success [out]
The result of the allocation attempt.
Return code
StatusType
>  E_OK No error. E_OS_ID (EXTENDED status:) Invalid SpinlockID.
E_OS_INTERFERENCE_DEADLOCK (EXTENDED status:) Spinlock
already occupied by a task/ISR of the same core.
E_OS_NESTING_DEADLOCK (EXTENDED status:) Invalid Spinlock
allocation order. E_OS_CALLEVEL (EXTENDED status:) Called from
invalid context. E_OS_ACCESS (Service Protection:)
>  - Caller's access rights are not sufficient.
Functional Description
OS service TryToGetSpinlock().
Particularities and Limitations
Pre-Condition: None
Allocates the requested spinlock for the caller. If it is already locked, the function returns.
Call context
>  TASK|ISR2
>  This function is Synchronous
>  This function is Reentrant
Table 5-12   TryToGetSpinlock

© 2017 Vector Informatik GmbH
Version 2.12.0
178
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.13  DisableAllInterrupts
Prototype
void DisableAllInterrupts (void)
Parameter
void
none
Return code
void
none
Functional Description
OS service DisableAllInterrupts()..
Particularities and Limitations
Pre-Condition: Not already in DisableAllInterrupts() sequence.
Disables category 1 and category 2 ISRs. If timing protection is configured, the timing protection interrupt is
not affected.
Call context
>  TASK|ISR2|ERRHOOK|PRETHOOK|POSTTHOOK|STARTHOOK|SHUTHOOK|ALARMHOOK|PROTH
OOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-13   DisableAllInterrupts

© 2017 Vector Informatik GmbH
Version 2.12.0
179
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.14  EnableAllInterrupts
Prototype
void EnableAllInterrupts (void)
Parameter
void
none
Return code
void
none
Functional Description
OS service EnableAllInterrupts().
Particularities and Limitations
Pre-Condition: In DisableAllInterrupts() sequence.
Restores the state saved by DisableAllInterrupts().
Call context
>  TASK|ISR2|ERRHOOK|PRETHOOK|POSTTHOOK|STARTHOOK|SHUTHOOK|ALARMHOOK|PROTH
OOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-14   EnableAllInterrupts

© 2017 Vector Informatik GmbH
Version 2.12.0
180
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.15  SuspendAllInterrupts
Prototype
void SuspendAllInterrupts (void)
Parameter
void
none
Return code
void
none
Functional Description
OS service SuspendAllInterrupts().
Particularities and Limitations
Pre-Condition: Not in DisableAllInterrupts() sequence.
Saves the recognition status of all interrupts and disables all interrupts for which the hardware supports
disabling. This API can be called nested.
Call context
>  TASK|ISR2|ERRHOOK|PRETHOOK|POSTTHOOK|STARTHOOK|SHUTHOOK|ALARMHOOK|PROTH
OOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-15   SuspendAllInterrupts

© 2017 Vector Informatik GmbH
Version 2.12.0
181
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.16  ResumeAllInterrupts
Prototype
void ResumeAllInterrupts (void)
Parameter
void
none
Return code
void
none
Functional Description
OS service ResumeAllInterrupts().
Particularities and Limitations
>  Pre-Condition: In SuspendAllInterrupts() sequence.Pre-Condition: Correct nesting sequence of suspend
interrupt API.
Restores the recognition status of all interrupts saved by the SuspendAllInterrupts() service.
Call context
>  TASK|ISR2|ERRHOOK|PRETHOOK|POSTTHOOK|STARTHOOK|SHUTHOOK|ALARMHOOK|PROTH
OOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-16   ResumeAllInterrupts

© 2017 Vector Informatik GmbH
Version 2.12.0
182
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.17  SuspendOSInterrupts
Prototype
void SuspendOSInterrupts (void)
Parameter
void
none
Return code
void
none
Functional Description
OS service SuspendOSInterrupts().
Particularities and Limitations
Pre-Condition: Not in DisableAllInterrupts() sequence.
Saves the recognition status of interrupts of category 2 and disables the recognition of these interrupts. This
API can be called nested.
Call context
>  TASK|ISR2|ERRHOOK|PRETHOOK|POSTTHOOK|STARTHOOK|SHUTHOOK|ALARMHOOK|PROTH
OOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-17   SuspendOSInterrupts

© 2017 Vector Informatik GmbH
Version 2.12.0
183
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.18  ResumeOSInterrupts
Prototype
void ResumeOSInterrupts (void)
Parameter
void
none
Return code
void
none
Functional Description
OS service ResumeOSInterrupts().
Particularities and Limitations
>  Pre-Condition: In SuspendOSInterrupts() sequence.Pre-Condition: Correct nesting sequence of suspend
interrupt API.
Restores the recognition status of interrupts saved by the SuspendOSInterrupts() service.
Call context
>  TASK|ISR2|ERRHOOK|PRETHOOK|POSTTHOOK|STARTHOOK|SHUTHOOK|ALARMHOOK|PROTH
OOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-18   ResumeOSInterrupts

© 2017 Vector Informatik GmbH
Version 2.12.0
184
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.19  ActivateTask
Prototype
StatusType ActivateTask (TaskType TaskID)
Parameter
TaskID [in]
The task which shall be activated.
Return code
StatusType
>  E_OK No error. E_OS_LIMIT Too many task activations. E_OS_ID
(EXTENDED status:) Invalid TaskID. E_OS_CALLEVEL (EXTENDED
status:) Called from invalid context. E_OS_DISABLEDINT (Service
Protection:) Caller is in interrupt API sequence. E_OS_ACCESS (Service
Protection:)
>  - Caller's access rights are not sufficient.
>  - Given task's owner application is not accessible.
Functional Description
OS service ActivateTask().
Particularities and Limitations
Pre-Condition: None
The task TaskID is transferred from the SUSPENDED state into the READY state. The operating system
ensures that the task code is being executed from the first statement.
Call context
>  TASK|ISR2
>  This function is Synchronous
>  This function is Reentrant
Table 5-19   ActivateTask

© 2017 Vector Informatik GmbH
Version 2.12.0
185
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.20  TerminateTask
Prototype
StatusType TerminateTask (void)
Parameter
void
none
Return code
StatusType
E_OS_CALLEVEL (EXTENDED status:) Called from invalid context.
E_OS_RESOURCE (EXTENDED status:) Task still occupies resources.
E_OS_SPINLOCK (EXTENDED status:) Task still holds spinlocks.
E_OS_DISABLEDINT (Service Protection:) Caller is in interrupt API sequence.
Functional Description
OS service TerminateTask().
Particularities and Limitations
Pre-Condition: None
This service causes the termination of the calling task. The calling task is transferred from the RUNNING
state into the SUSPENDED state. This service only returns in case it detects an error.
Call context
>  TASK
>  This function is Synchronous
>  This function is Reentrant
Table 5-20   TerminateTask

© 2017 Vector Informatik GmbH
Version 2.12.0
186
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.21  ChainTask
Prototype
StatusType ChainTask (TaskType TaskID)
Parameter
TaskID [in]
The task which shall be activated.
Return code
StatusType
>  E_OS_LIMIT Too many task activations. E_OS_CALLEVEL (EXTENDED
status:) Called from invalid context. E_OS_RESOURCE (EXTENDED
status:) Task still occupies resources. E_OS_SPINLOCK (EXTENDED
status:) Task still holds spinlocks. E_OS_ID (EXTENDED status:) Invalid
TaskID. E_OS_DISABLEDINT (Service Protection:) Caller is in interrupt API
sequence. E_OS_ACCESS (Service Protection:)
>  - Caller's access rights are not sufficient.
>  - Given task's owner application is not accessible.
Functional Description
OS service ChainTask().
Particularities and Limitations
Pre-Condition: None
After termination of the calling task the given task is activated. This service only returns in case it detects an
error.
Call context
>  TASK
>  This function is Synchronous
>  This function is Reentrant
Table 5-21   ChainTask

© 2017 Vector Informatik GmbH
Version 2.12.0
187
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.22  Schedule
Prototype
StatusType Schedule (void)
Parameter
void
none
Return code
StatusType
E_OK No Error. E_OS_CALLEVEL (EXTENDED status:) The service was
called from any context which is not allowed. E_OS_RESOURCE
(EXTENDED status:) The service was called from a task which holds an OS
resource. E_OS_SPINLOCK (EXTENDED status:) The service was called
from a task which holds a spinlock. E_OS_DISABLEDINT (Service Protection:)
The service was called with disabled interrupts.
Functional Description
OS service Schedule().
Particularities and Limitations
Pre-Condition: Interrupts are enabled.

Call context
>  TASK
>  This function is Synchronous
>  This function is Reentrant
Table 5-22   Schedule

© 2017 Vector Informatik GmbH
Version 2.12.0
188
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.23  GetTaskID
Prototype
StatusType GetTaskID (TaskRefType TaskID)
Parameter
TaskID [out]
The current task ID.
Return code
StatusType
E_OK No error. E_OS_CALLEVEL (EXTENDED status:) Called from invalid
context. E_OS_PARAM_POINTER (EXTENDED status:) Given pointer is
NULL. E_OS_DISABLEDINT (Service Protection:) Caller is in interrupt API
sequence.
Functional Description
OS service GetTaskID().
Particularities and Limitations
Pre-Condition: None
Returns the ID of the task which is currently RUNNING on the local core.
Call context
>  TASK|ISR2|ERRHOOK|PRETHOOK|POSTTHOOK|PROTHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-23   GetTaskID

© 2017 Vector Informatik GmbH
Version 2.12.0
189
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.24  GetTaskState
Prototype
StatusType GetTaskState (TaskType TaskID, TaskStateRefType State)
Parameter
TaskID [in]
The task to be queried.
State [out]
The task's state.
Return code
StatusType
>  E_OK No error. E_OS_CALLEVEL (EXTENDED status:) Called from
invalid context. E_OS_ID (EXTENDED status:) Invalid TaskID.
E_OS_PARAM_POINTER (EXTENDED status:) Given pointer is NULL.
E_OS_DISABLEDINT (Service Protection:) Caller is in interrupt API
sequence. E_OS_ACCESS (Service Protection:)
>  - Caller's access rights are not sufficient.
>  - Given task's owner application is not accessible.
Functional Description
OS service GetTaskState().
Particularities and Limitations
Pre-Condition: The given task has to be assigned to the current core.
Returns the current scheduling state of a task (RUNNING, READY, ...).
Call context
>  TASK|ISR2|ERRHOOK|PRETHOOK|POSTTHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-24   GetTaskState

© 2017 Vector Informatik GmbH
Version 2.12.0
190
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.25  GetISRID
Prototype
ISRType GetISRID (void)
Parameter
void
none
Return code
ISRType
>  Identifier of running ISR INVALID_ISR If called from
>  - invalid call-context,
>  - from a task or
>  - a hook which was called inside a task context.
Functional Description
OS service GetISRID().
Particularities and Limitations
Pre-Condition: None
Return the identifier of the currently executing ISR.
Call context
>  TASK|ISR2|ERRHOOK|PROTHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-25   GetISRID

© 2017 Vector Informatik GmbH
Version 2.12.0
191
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.26  SetEvent
Prototype
StatusType SetEvent (TaskType TaskID, EventMaskType Mask)
Parameter
TaskID [in]
The task which shall be modified.
Mask [in]
The events which shall be set.
Return code
StatusType
>  E_OK No error. E_OS_ID (EXTENDED status:) Invalid TaskID.
E_OS_ACCESS (EXTENDED status:)
>  - Task is no extended task. (Service Protection:)
>  - Task's owner application is not accessible.
>  - Caller's access rights are not sufficient. E_OS_STATE (EXTENDED
status:) Events cannot be set as the referenced task is in the SUSPENDED
state. E_OS_CALLEVEL (Service Protection:) Called from invalid context.
E_OS_DISABLEDINT (Service Protection:) Caller is in interrupt API
sequence.
Functional Description
OS service SetEvent().
Particularities and Limitations
Pre-Condition: None
The events of the given task are set according to the given event mask.
Call context
>  TASK|ISR2
>  This function is Synchronous
>  This function is Reentrant
Table 5-26   SetEvent

© 2017 Vector Informatik GmbH
Version 2.12.0
192
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.27  ClearEvent
Prototype
StatusType ClearEvent (EventMaskType Mask)
Parameter
Mask [in]
The events which shall be set.
Return code
StatusType
E_OK No error. E_OS_ACCESS (EXTENDED status:) Task is no extended
task. E_OS_CALLEVEL (EXTENDED status:) Called from invalid context.
E_OS_DISABLEDINT (Service Protection:) Caller is in interrupt API sequence.
Functional Description
OS service ClearEvent().
Particularities and Limitations
Pre-Condition: None
The events of the calling task are cleared according to the given event mask.
Call context
>  TASK
>  This function is Synchronous
>  This function is Reentrant
Table 5-27   ClearEvent

© 2017 Vector Informatik GmbH
Version 2.12.0
193
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.28  GetEvent
Prototype
StatusType GetEvent (TaskType TaskID, EventMaskRefType Mask)
Parameter
TaskID [in]
The task which shall be queried.
Mask [out]
Events which are set.
Return code
StatusType
>  E_OK No error. E_OS_PARAM_POINTER (EXTENDED status:) Given
pointer is NULL. E_OS_ID (EXTENDED status:) Invalid TaskID.
E_OS_ACCESS (EXTENDED status:)
>  - Task is no extended task. (Service Protection:)
>  - Task's owner application is not accessible.
>  - Caller's access rights are not sufficient. E_OS_STATE (EXTENDED
status:) Referenced task is in SUSPENDED state. E_OS_CALLEVEL
(EXTENDED status:) Called from invalid context. E_OS_DISABLEDINT
(Service Protection:) Caller is in interrupt API sequence.
Functional Description
OS service GetEvent().
Particularities and Limitations
Pre-Condition: Task is assigned to the current core.
This service returns the state of all event bits of the given task, not the events that the task is waiting for.
Call context
>  TASK|ISR2|ERRHOOK|PRETHOOK|POSTTHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-28   GetEvent

© 2017 Vector Informatik GmbH
Version 2.12.0
194
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.29  WaitEvent
Prototype
StatusType WaitEvent (EventMaskType Mask)
Parameter
Mask [in]
Mask of the events waited for.
Return code
StatusType
E_OK No error. E_OS_ACCESS (EXTENDED status:) Task is no extended
task. E_OS_RESOURCE (EXTENDED status:) Task still occupies resources.
E_OS_SPINLOCK (EXTENDED status:) Task still holds spinlocks.
E_OS_CALLEVEL (EXTENDED status:) Called from invalid context.
E_OS_DISABLEDINT (Service Protection:) Caller is in interrupt API sequence.
Functional Description
OS service WaitEvent().
Particularities and Limitations
Pre-Condition: None
The state of the current task is set to WAITING, unless at least one of the given events is set.
Call context
>  TASK
>  This function is Synchronous
>  This function is Reentrant
Table 5-29   WaitEvent

© 2017 Vector Informatik GmbH
Version 2.12.0
195
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.30  IncrementCounter
Prototype
StatusType IncrementCounter (CounterType CounterID)
Parameter
CounterID [in]
The counter to be incremented.
Return code
StatusType
>  E_OK No Error. E_OS_ID (EXTENDED status:) CounterID is not a valid
software counter ID. E_OS_CALLEVEL (EXTENDED status:) Called from
invalid context. E_OS_CORE (EXTENDED status:) The given object
belongs to a foreign core. E_OS_ACCESS (Service Protection:)
>  - Caller's access rights are not sufficient.
>  - Given counter's owner application is not accessible.
E_OS_DISABLEDINT (Service Protection:) Caller is in interrupt API
sequence.
Functional Description
OS service IncrementCounter().
Particularities and Limitations
Pre-Condition: None

Call context
>  TASK|ISR2
>  This function is Synchronous
>  This function is Reentrant
Table 5-30   IncrementCounter

© 2017 Vector Informatik GmbH
Version 2.12.0
196
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.31  GetCounterValue
Prototype
StatusType GetCounterValue (CounterType CounterID, TickRefType Value)
Parameter
CounterID [in]
The counter to be read.
Value [out]
Contains the current tick value of the counter.
Return code
StatusType
>  E_OK No Error. E_OS_ID (EXTENDED status:) Invalid CounterID.
E_OS_CALLEVEL (EXTENDED status:) Called from invalid context.
E_OS_PARAM_POINTER (EXTENDED status:) Given pointer is NULL.
E_OS_ACCESS (Service Protection:)
>  - Counter's owner application is not accessible.
>  - Caller's access rights are not sufficient. E_OS_DISABLEDINT (Service
Protection:) Caller is in interrupt API sequence.
Functional Description
OS service GetCounterValue().
Particularities and Limitations
Pre-Condition: None

Call context
>  TASK|ISR2
>  This function is Synchronous
>  This function is Reentrant
Table 5-31   GetCounterValue

© 2017 Vector Informatik GmbH
Version 2.12.0
197
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.32  GetElapsedValue
Prototype
StatusType GetElapsedValue (CounterType CounterID, TickRefType Value,
TickRefType ElapsedValue)
Parameter
CounterID [in]
The counter to be read.
Value [in,out]
**in:** The previously read tick value of the counter.
**out:** The current tick value of the counter.
ElapsedValue [out]
The difference to the previous read value.
Return code
StatusType
>  E_OK No Error. E_OS_ID (EXTENDED status:) Invalid CounterID.
E_OS_CALLEVEL (EXTENDED status:) Called from invalid context.
E_OS_VALUE (EXTENDED status:) The given Value was not valid.
E_OS_PARAM_POINTER (EXTENDED status:) Given pointer is NULL.
E_OS_ACCESS (Service Protection:)
>  - Counter's owner application is not accessible.
>  - Caller's access rights are not sufficient. E_OS_DISABLEDINT (Service
Protection:) Caller is in interrupt API sequence.
Functional Description
OS service GetElapsedValue().
Particularities and Limitations
Pre-Condition: None

Call context
>  TASK|ISR2
>  This function is Synchronous
>  This function is Reentrant
Table 5-32   GetElapsedValue

© 2017 Vector Informatik GmbH
Version 2.12.0
198
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.33  GetAlarmBase
Prototype
StatusType GetAlarmBase (AlarmType AlarmID, AlarmBaseRefType Info)
Parameter
AlarmID [in]
Reference to the alarm element.
Info [out]
Contains information about the counter on successful return.
Return code
StatusType
>  E_OK No error. E_OS_ID (EXTENDED status:) Invalid AlarmID.
E_OS_PARAM_POINTER (EXTENDED status:) Given pointer is NULL.
E_OS_CALLEVEL (EXTENDED status:) Called from invalid context.
E_OS_DISABLEDINT (Service Protection:) Caller is in interrupt API
sequence. E_OS_ACCESS (Service Protection:)
>  - Caller's access rights are not sufficient.
>  - Given task's owner application is not accessible.
Functional Description
OS service GetAlarmBase().
Particularities and Limitations
Pre-Condition: Given object pointer(s) are valid.
The system service GetAlarmBase reads the alarm base characteristics. The return value Info is a structure
in which the information of data type AlarmBaseType is stored.
Call context
>  TASK|ISR2|PRETHOOK|POSTTHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-33   GetAlarmBase

© 2017 Vector Informatik GmbH
Version 2.12.0
199
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.34  GetAlarm
Prototype
StatusType GetAlarm (AlarmType AlarmID, TickRefType Tick)
Parameter
AlarmID [in]
Reference to the alarm element.
Tick [out]
Relative value in ticks before the alarm expires.
Return code
StatusType
>  E_OK No error. E_OS_NOFUNC Alarm is not in use. E_OS_ID
(EXTENDED status:) Invalid AlarmID. E_OS_PARAM_POINTER
(EXTENDED status:) Given pointer is NULL. E_OS_CALLEVEL
(EXTENDED status:) Called from invalid context. E_OS_DISABLEDINT
(Service Protection:) Caller is in interrupt API sequence. E_OS_ACCESS
(Service Protection:)
>  - Caller's access rights are not sufficient.
>  - Given task's owner application is not accessible.
Functional Description
OS service GetAlarm().
Particularities and Limitations
The given alarm is assigned to the local core.
It is up to the application to decide whether for example a CancelAlarm may still be useful. If AlarmID is not
in use, Tick is not defined. Allowed on task level, ISR, and in several hook routines.
Call context
>  TASK|ISR2|PRETHOOK|POSTTHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-34   GetAlarm

© 2017 Vector Informatik GmbH
Version 2.12.0
200
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.35  SetRelAlarm
Prototype
StatusType SetRelAlarm (AlarmType AlarmID, TickType Increment, TickType Cycle)
Parameter
AlarmID [in]
Reference to the alarm element.
Increment [in]
Relative value in ticks.
Cycle [in]
Cycle value in case of cyclic alarm. In case of single alarms, cycle shall be
zero.
Return code
StatusType
>  E_OK No error. E_OS_STATE Alarm is already in use. E_OS_ID
(EXTENDED status:) Invalid AlarmID. E_OS_VALUE Returned if:
>  - Value of increment is zero
>  - (EXTENDED status:) Value of Increment outside of the admissible limits
(lower than zero or greater than maxallowedvalue).
>  - (EXTENDED status:) Value of Cycle unequal to 0 and outside of the
admissible counter limits (less than mincycle or greater than
maxallowedvalue). E_OS_CALLEVEL (EXTENDED status:) Called from
invalid context. E_OS_DISABLEDINT (Service Protection:) Caller is in
interrupt API sequence. E_OS_ACCESS (Service Protection:)
>  - Caller's access rights are not sufficient.
>  - Given alarm's owner application is not accessible. other See
Os_XSigSend_SetRelAlarm() and Os_XSigRecv_SetRelAlarm().
Functional Description
OS service SetRelAlarm().
Particularities and Limitations
Pre-Condition: None
The system service occupies the alarm AlarmID element. After increment ticks have elapsed, the task
assigned to the alarm AlarmID is activated or the assigned event (only for extended tasks) is set or the
alarm-callback routine is called.
Call context
>  TASK|ISR2
>  This function is Synchronous
>  This function is Reentrant
Table 5-35   SetRelAlarm

© 2017 Vector Informatik GmbH
Version 2.12.0
201
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.36  SetAbsAlarm
Prototype
StatusType SetAbsAlarm (AlarmType AlarmID, TickType Start, TickType Cycle)
Parameter
AlarmID [in]
Reference to the alarm element.
Start [in]
Absolute value in ticks.
Cycle [in]
Cycle value in case of cyclic alarm. In case of single alarms, cycle shall be
zero.
Return code
StatusType
>  E_OK No error. E_OS_STATE Alarm is already in use. E_OS_ID
(EXTENDED status:) Invalid AlarmID. E_OS_VALUE (EXTENDED status:)
Returned if:
>  - Value of Start outside of the admissible counter limit (less than zero or
greater than maxallowedvalue).
>  - Value of Cycle unequal to 0 and outside of the admissible counter limits
(less than mincycle or greater than maxallowedvalue). E_OS_CALLEVEL
(EXTENDED status:) Called from invalid context. E_OS_DISABLEDINT
(Service Protection:) Caller is in interrupt API sequence. E_OS_ACCESS
(Service Protection:)
>  - Caller's access rights are not sufficient.
>  - Given alarm's owner application is not accessible. other See
Os_XSigSend_SetAbsAlarm() and Os_XSigRecv_SetAbsAlarm().
Functional Description
OS service SetAbsAlarm().
Particularities and Limitations
Pre-Condition: None
The system service occupies the alarm AlarmID element. When start ticks are reached, the task assigned
to the alarm AlarmID is activated or the assigned event (only for extended tasks) is set or the alarm-callback
routine is called.
Call context
>  TASK|ISR2
>  This function is Synchronous
>  This function is Reentrant
Table 5-36   SetAbsAlarm

© 2017 Vector Informatik GmbH
Version 2.12.0
202
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.37  CancelAlarm
Prototype
StatusType CancelAlarm (AlarmType AlarmID)
Parameter
AlarmID [in]
Reference to the alarm element.
Return code
StatusType
>  E_OK No error. E_OS_NOFUNC Alarm is not in use. E_OS_ID
(EXTENDED status:) Invalid AlarmID. E_OS_CALLEVEL (EXTENDED
status:) Called from invalid context. E_OS_DISABLEDINT (Service
Protection:) Caller is in interrupt API sequence. E_OS_ACCESS (Service
Protection:)
>  - Caller's access rights are not sufficient.
>  - Given alarm's owner application is not accessible.
Functional Description
OS service CancelAlarm().
Particularities and Limitations
Pre-Condition: None
The system service cancels the alarm AlarmID.
Call context
>  TASK|ISR2
>  This function is Synchronous
>  This function is Reentrant
Table 5-37   CancelAlarm

© 2017 Vector Informatik GmbH
Version 2.12.0
203
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.38  GetResource
Prototype
StatusType GetResource (ResourceType ResID)
Parameter
ResID [in]
The resource which shall be occupied.
Return code
StatusType
>  E_OK No error. E_OS_ID (EXTENDED status:) Invalid ResID.
E_OS_CALLEVEL (EXTENDED status:) Called from invalid context.
E_OS_CORE (EXTENDED status:) The given object belongs to a foreign
core. E_OS_ACCESS (EXTENDED status:)
>  - Statically assigned priority of the caller is higher than the calculated ceiling
priority.
>  - Attempt to get a resource which is already occupied. (Service Protection:)
>  - Caller's access rights are not sufficient. E_OS_DISABLEDINT (Service
Protection:) Caller is in interrupt API sequence.
Functional Description
OS service GetResource().
Particularities and Limitations
Pre-Condition: None
This API serves to enter critical sections in the code. A critical section shall always be left using
ReleaseResource().
Call context
>  TASK|ISR2
>  This function is Synchronous
>  This function is Reentrant
Table 5-38   GetResource

© 2017 Vector Informatik GmbH
Version 2.12.0
204
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.39  ReleaseResource
Prototype
StatusType ReleaseResource (ResourceType ResID)
Parameter
ResID [in]
The resource which shall be released.
Return code
StatusType
>  E_OK No error. E_OS_ID (EXTENDED status:) Invalid ResID.
E_OS_CALLEVEL (EXTENDED status:) Called from invalid context.
E_OS_CORE (EXTENDED status:) The given object belongs to a foreign
core. E_OS_NOFUNC (EXTENDED status:)
>  - Attempt to release a resource which has not been occupied by the caller
before.
>  - Attempt to release a nested resource in wrong order. E_OS_SPINLOCK
(EXTENDED status:) Spinlock and Resource API not used in LIFO order.
E_OS_ACCESS (EXTENDED status:)
>  - Attempt to release a resource which has a lower ceiling priority than the
statically assigned priority of the caller. (Service Protection:)
>  - Caller's access rights are not sufficient. E_OS_DISABLEDINT (Service
Protection:) Caller is in interrupt API sequence.
Functional Description
OS service ReleaseResource().
Particularities and Limitations
This API is the counterpart of GetResource() and serves to leave critical sections in the code.
Call context
>  TASK|ISR2
>  This function is Synchronous
>  This function is Reentrant
Table 5-39   ReleaseResource

© 2017 Vector Informatik GmbH
Version 2.12.0
205
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.40  StartScheduleTableRel
Prototype
StatusType StartScheduleTableRel (ScheduleTableType ScheduleTableID, TickType
Offset)
Parameter
ScheduleTableID [in]
The ID of the schedule table to be started.
Offset [in]
The relative offset when the schedule table shall be started.
Return code
StatusType
>  E_OK No error. E_OS_STATE Schedule table has already been started.
E_OS_ID (EXTENDED status:) Invalid ScheduleTableID.
E_OS_CALLEVEL (EXTENDED status:) Called from invalid context.
E_OS_VALUE (EXTENDED status:) Offset is bigger than
(OsCounterMaxAllowedValue - InitialOffset) or is equal to zero
E_OS_DISABLEDINT (Service Protection:) Caller is in interrupt API
sequence. E_OS_ACCESS (Service Protection:)
>  - Caller's access rights are not sufficient.
>  - Given schedule table's owner application is not accessible.
Functional Description
OS service StartScheduleTableRel().
Particularities and Limitations
Pre-Condition: None
The schedule table is started at a relative offset to the current time.
Call context
>  TASK|ISR2
>  This function is Synchronous
>  This function is Reentrant
Table 5-40   StartScheduleTableRel

© 2017 Vector Informatik GmbH
Version 2.12.0
206
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.41  StartScheduleTableAbs
Prototype
StatusType StartScheduleTableAbs (ScheduleTableType ScheduleTableID, TickType
Start)
Parameter
ScheduleTableID [in]
The ID of the schedule table to be started
Start [in]
The absolute time when the schedule table shall be started
Return code
StatusType
>  E_OK No error. E_OS_STATE Schedule table has already been started.
E_OS_ID (EXTENDED status:) Invalid ScheduleTableID.
E_OS_CALLEVEL (EXTENDED status:) Called from invalid context.
E_OS_VALUE (EXTENDED status:) Offset is bigger than
OsCounterMaxAllowedValue E_OS_DISABLEDINT (Service Protection:)
Caller is in interrupt API sequence. E_OS_ACCESS (Service Protection:)
>  - Caller's access rights are not sufficient.
>  - Given schedule table's owner application is not accessible.
Functional Description
OS service StartScheduleTableAbs().
Particularities and Limitations
Pre-Condition: None
The schedule table is started at an absolute time.
Call context
>  TASK|ISR2
>  This function is Synchronous
>  This function is Reentrant
Table 5-41   StartScheduleTableAbs

© 2017 Vector Informatik GmbH
Version 2.12.0
207
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.42  StopScheduleTable
Prototype
StatusType StopScheduleTable (ScheduleTableType ScheduleTableID)
Parameter
ScheduleTableID [in]
The ID of the schedule table to be stopped.
Return code
StatusType
>  E_OK No error. E_OS_NOFUNC Schedule table has already been
stopped. E_OS_ID (EXTENDED status:) Invalid ScheduleTableID.
E_OS_CALLEVEL (EXTENDED status:) Called from invalid context.
E_OS_DISABLEDINT (Service Protection:) Caller is in interrupt API
sequence. E_OS_ACCESS (Service Protection:)
>  - Caller's access rights are not sufficient.
>  - Given schedule table's owner application is not accessible.
Functional Description
OS service StopScheduleTable().
Particularities and Limitations
Pre-Condition: None
The schedule table is stopped immediately.
Call context
>  TASK|ISR2
>  This function is Synchronous
>  This function is Reentrant
Table 5-42   StopScheduleTable

© 2017 Vector Informatik GmbH
Version 2.12.0
208
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.43  NextScheduleTable
Prototype
StatusType NextScheduleTable (ScheduleTableType ScheduleTableID_From,
ScheduleTableType ScheduleTableID_To)
Parameter
ScheduleTableID_From [in]  The ID of the schedule table which is requested to stop at its end
ScheduleTableID_To [in]
The ID of the schedule table which starts after the other one has stopped
Return code
StatusType
>  E_OK No error. E_OS_NOFUNC Schedule table ScheduleTableID_From
has not been started. E_OS_STATE Schedule table ScheduleTableID_To
has already been requested to start at the end of another schedule table.
E_OS_ID (EXTENDED status:) Invalid ScheduleTableID_From/To.
E_OS_CALLEVEL (EXTENDED status:) Called from invalid context.
E_OS_DISABLEDINT (Service Protection:) Caller is in interrupt API
sequence. E_OS_ACCESS (Service Protection:)
>  - Caller's access rights are not sufficient.
>  - Given schedule table's owner application is not accessible.
Functional Description
OS service NextScheduleTable().
Particularities and Limitations
Pre-Condition: None
Requests the switch of schedule table processing from one schedule table to another after the first one has
reached its end.
Call context
>  TASK|ISR2
>  This function is Synchronous
>  This function is Reentrant
Table 5-43   NextScheduleTable

© 2017 Vector Informatik GmbH
Version 2.12.0
209
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.44  GetScheduleTableStatus
Prototype
StatusType GetScheduleTableStatus (ScheduleTableType ScheduleTableID,
ScheduleTableStatusRefType ScheduleStatus)
Parameter
ScheduleTableID [in]
The ID of the schedule table for which the status shall be requested.
ScheduleStatus [out]
Reference to ScheduleTableStatusType.
Return code
StatusType
>  E_OK No error. E_OS_ID (EXTENDED status:) Invalid ScheduleTableID
E_OS_CALLEVEL (EXTENDED status:) Called from invalid context.
E_OS_PARAM_POINTER (EXTENDED status:) ScheduleStatus is a
pointer to null. E_OS_DISABLEDINT (Service Protection:) Caller is in
interrupt API sequence. E_OS_ACCESS (Service Protection:)
>  - Caller's access rights are not sufficient.
>  - Given schedule table's owner application is not accessible.
Functional Description
OS service GetScheduleTableStatus().
Particularities and Limitations
Pre-Condition: None
This service queries the state of a schedule table (also with respect to synchronization).
Call context
>  TASK|ISR2
>  This function is Synchronous
>  This function is Reentrant
Table 5-44   GetScheduleTableStatus

© 2017 Vector Informatik GmbH
Version 2.12.0
210
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.45  StartScheduleTableSynchron
Prototype
StatusType StartScheduleTableSynchron (ScheduleTableType ScheduleTableID)
Parameter
ScheduleTableID [in]
The ID of the schedule table which shall start synchronously
Return code
StatusType
>  E_OK No error. E_OS_STATE Schedule table ScheduleTableID has
already been started. E_OS_ID (EXTENDED status:) Invalid
ScheduleTableID. E_OS_CORE (EXTENDED status:) The given object
belongs to a foreign core. E_OS_CALLEVEL (EXTENDED status:) Called
from invalid context. E_OS_DISABLEDINT (Service Protection:) Caller is in
interrupt API sequence. E_OS_ACCESS (Service Protection:)
>  - Caller's access rights are not sufficient.
>  - Given schedule table's owner application is not accessible.
Functional Description
OS service StartScheduleTableSynchron().
Particularities and Limitations
Pre-Condition: None
This service starts an explicitly synchronized schedule table synchronously. As a result the schedule table
enters the state SCHEDULETABLE_WAITING and waits for a synchronization count to be provided.
Call context
>  TASK|ISR2
>  This function is Synchronous
>  This function is Reentrant
Table 5-45   StartScheduleTableSynchron

© 2017 Vector Informatik GmbH
Version 2.12.0
211
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.46  SyncScheduleTable
Prototype
StatusType SyncScheduleTable (ScheduleTableType ScheduleTableID, TickType
Value)
Parameter
ScheduleTableID [in]
The ID of the schedule table to the synchronized
Value [in]
The current value of the synchronization counter
Return code
StatusType
>  E_OK No error. E_OS_STATE The state of the schedule table
ScheduleTableId is equal to SCHEDULETABLE_STOPPED or
SCHEDULETABLE_NEXT. E_OS_ID (EXTENDED status:) Invalid
ScheduleTableID. E_OS_CORE (EXTENDED status:) The given object
belongs to a foreign core. E_OS_CALLEVEL (EXTENDED status:) Called
from invalid context. E_OS_VALUE (EXTENDED status:) The Value is out
of range E_OS_ACCESS (Service Protection:)
>  - Caller's access rights are not sufficient.
>  - Given schedule table's owner application is not accessible.
Functional Description
OS service SyncScheduleTable().
Particularities and Limitations
Pre-Condition: None
This service provides the schedule table with a synchronization count and starts the synchronization.
Call context
>  TASK|ISR2
>  This function is Synchronous
>  This function is Reentrant
Table 5-46   SyncScheduleTable

© 2017 Vector Informatik GmbH
Version 2.12.0
212
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.47  SetScheduleTableAsync
Prototype
StatusType SetScheduleTableAsync (ScheduleTableType ScheduleTableID)
Parameter
ScheduleTableID [in]
The ID of the schedule table which shall no longer be synchronized.
Return code
StatusType
>  E_OK No error. E_OS_STATE Current state of ScheduleTableID is
SCHEDULETABLE_STOPPED, SCHEDULETABLE_NEXT or
SCHEDULETABLE_WAITING. E_OS_ID (EXTENDED status:)
>  - Invalid ScheduleTableID.
>  - OsScheduleTblSyncStrategy of ScheduleTableID is not equal to
EXPLICIT E_OS_CORE (EXTENDED status:) The given object belongs to
a foreign core. E_OS_CALLEVEL (EXTENDED status:) Called from invalid
context. E_OS_DISABLEDINT (Service Protection:) Caller is in interrupt
API sequence. E_OS_ACCESS (Service Protection:)
>  - Caller's access rights are not sufficient.
>  - Given schedule table's owner application is not accessible.
Functional Description
OS service SetScheduleTableAsync().
Particularities and Limitations
Pre-Condition: None
This service stops the synchronization of a schedule table.
Call context
>  TASK|ISR2
>  This function is Synchronous
>  This function is Reentrant
Table 5-47   SetScheduleTableAsync

© 2017 Vector Informatik GmbH
Version 2.12.0
213
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.48  GetApplicationID
Prototype
ApplicationType GetApplicationID (void)
Parameter
void
none
Return code
ApplicationType
Identifier of the OS-Application.
Functional Description
OS service GetApplicationID().
Particularities and Limitations
Pre-Condition: None
This service determines the OS-Application where the caller (Task/ISR/Hook) originally belongs to (was
configured to). All system objects (e.g. system hooks, idle task, ...) belong to kernel applications. Kernel
applications are regular applications and have valid identifiers. Therefore INVALID_OSAPPLICATION is
never returned because there is always a valid application active.
Call context
>  TASK|ISR2|ERRHOOK|PRETHOOK|POSTTHOOK|STARTHOOK|SHUTHOOK|PROTHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-48   GetApplicationID

© 2017 Vector Informatik GmbH
Version 2.12.0
214
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.49  GetCurrentApplicationID
Prototype
ApplicationType GetCurrentApplicationID (void)
Parameter
void
none
Return code
ApplicationType
Identifier of the OS-Application.
Functional Description
OS service GetCurrentApplicationID().
Particularities and Limitations
Pre-Condition: None
This service determines the OS-Application where the caller (Task/ISR/Hook) of the service is currently
executing. Note that, if the caller is not within a CallTrustedFunction() call, the value is equal to the result of
GetApplicationID().
Call context
>  TASK|ISR2|ERRHOOK|PRETHOOK|POSTTHOOK|STARTHOOK|SHUTHOOK|PROTHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-49   GetCurrentApplicationID

© 2017 Vector Informatik GmbH
Version 2.12.0
215
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.50  GetApplicationState
Prototype
StatusType GetApplicationState (ApplicationType Application,
ApplicationStateRefType Value)
Parameter
Application [in]
The OS-Application from which the state is requested.
Value [out]
The current state of the application.
Return code
StatusType
E_OK No error. E_OS_ID (EXTENDED status:) Invalid Application.
E_OS_PARAM_POINTER (EXTENDED status:) Given pointer is NULL.
E_OS_CALLEVEL (EXTENDED status:) Called from invalid context.
E_OS_DISABLEDINT (Service Protection:) Caller is in interrupt API sequence.
Functional Description
OS service GetApplicationState().
Particularities and Limitations
Pre-Condition: None
This service returns the current state of an OS-Application.
Call context
>  TASK|ISR2|ERRHOOK|PRETHOOK|POSTTHOOK|STARTHOOK|SHUTHOOK|PROTHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-50   GetApplicationState

© 2017 Vector Informatik GmbH
Version 2.12.0
216
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.51  CheckObjectAccess
Prototype
ObjectAccessType CheckObjectAccess (ApplicationType ApplID, ObjectTypeType
ObjectType, Os_ObjectIdType ObjectID)
Parameter
ApplID [in]
OS-Application identifier.
ObjectType [in]
Type of the following parameter.
ObjectID [in]
The object to be examined.
Return code
ObjectAccessType
>  ACCESS if the ApplID has access to the object. NO_ACCESS If:
>  - ApplID doesn't have access to the object.
>  - ApplID is invalid.
>  - ObjectID is invalid.
Functional Description
OS service CheckObjectAccess().
Particularities and Limitations
Pre-Condition: None
This service determines if the OS-Application, given by ApplID, is allowed to use the IDs of a Task,
Resource, Counter, Alarm or Schedule Table in API calls.
Call context
>  TASK|ISR2|ERRHOOK|PROTHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-51   CheckObjectAccess

© 2017 Vector Informatik GmbH
Version 2.12.0
217
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.52  CheckObjectOwnership
Prototype
ApplicationType CheckObjectOwnership (ObjectTypeType ObjectType,
Os_ObjectIdType ObjectID)
Parameter
ObjectType [in]
Type of the following parameter.
ObjectID [in]
The object to be examined.
Return code
ApplicationType
Identifier of the owner OS-Application. INVALID_OSAPPLICATION if the object
does not exist.
Functional Description
OS service CheckObjectOwnership().
Particularities and Limitations
Pre-Condition: None
This service determines to which OS-Application a given Task, ISR, Counter, Alarm or Schedule Table
belongs.
Call context
>  TASK|ISR2|ERRHOOK|PROTHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-52   CheckObjectOwnership

© 2017 Vector Informatik GmbH
Version 2.12.0
218
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.53  AllowAccess
Prototype
StatusType AllowAccess (void)
Parameter
void
none
Return code
StatusType
E_OK No error. E_OS_STATE The application is not in the restarting state.
E_OS_CALLEVEL (EXTENDED status:) Called from invalid context.
E_OS_DISABLEDINT (Service Protection:) Caller is in interrupt API sequence.
Functional Description
OS service AllowAccess().
Particularities and Limitations
Pre-Condition: None
This service sets the state of the current OS-Application from APPLICATION_RESTARTING to
APPLICATION_ACCESSIBLE.
Call context
>  TASK|ISR2
>  This function is Synchronous
>  This function is Reentrant
Table 5-53   AllowAccess

© 2017 Vector Informatik GmbH
Version 2.12.0
219
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.54  TerminateApplication
Prototype
StatusType TerminateApplication (ApplicationType Application, RestartType
RestartOption)
Parameter
Application [in]
The identifier of the OS-Application to be terminated. If the caller belongs to
Application the call results in a self-termination.
RestartOption [in]
Either RESTART for doing a restart of the OS-Application or NO_RESTART if
OS-Application shall not be restarted.
Return code
StatusType
>  E_OK No errors E_OS_STATE The state of Application does not allow
terminating it:
>  - The application is already terminated.
>  - The application is restarting AND the caller does not belong to the
application.
>  - The application is restarting AND the caller does belong to the application
AND the RestartOption is RESTART. E_OS_ID (EXTENDED status:)
Application was not valid. E_OS_VALUE (EXTENDED status:)
RestartOption was neither RESTART nor NO_RESTART.
E_OS_CALLEVEL (EXTENDED status:) Called from invalid context.
E_OS_ACCESS (EXTENDED status:) The caller belongs to a non-trusted
OS-Application AND the caller does not belong to given Application
TerminateApplication() shall return E_OS_ACCESS. E_OS_DISABLEDINT
(Service Protection:) Caller is in interrupt API sequence.
Functional Description
OS service TerminateApplication().
Particularities and Limitations
Pre-Condition: None
This service terminates the OS-Application to which the calling Task/ISR/application specific error hook
belongs.
Call context
>  TASK|ISR2|ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-54   TerminateApplication

© 2017 Vector Informatik GmbH
Version 2.12.0
220
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.55  CallTrustedFunction
Prototype
StatusType CallTrustedFunction (TrustedFunctionIndexType FunctionIndex,
TrustedFunctionParameterRefType FunctionParams)
Parameter
FunctionIndex [in]
Index of the function to be called.
FunctionParams [in]
Pointer to the parameters for the function. If no parameters are provided, a
NULL pointer has to be passed.
Return code
StatusType
>  E_OK No error. E_OS_SERVICEID No function defined for this index.
E_OS_CALLEVEL (EXTENDED status:) Called from invalid context.
E_OS_ACCESS (EXTENDED status:) The given object belongs to a
foreign core. E_OS_ACCESS (Service Protection:)
>  - Owner application is not accessible.
Functional Description
OS service CallTrustedFunction().
Particularities and Limitations
Pre-Condition: None
Each trusted OS-Application may export services which are callable from other OS-Applications.
Call context
>  TASK|ISR2
>  This function is Synchronous
>  This function is Reentrant
Table 5-55   CallTrustedFunction

© 2017 Vector Informatik GmbH
Version 2.12.0
221
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.56  Check Task Memory Access
Prototype
FUNC(AccessType, OS_CODE) CheckTaskMemoryAccess(
  TaskType TaskID,
  MemoryStartAddressType Address,
  MemorySizeType Size
)
Parameter
TaskID
ID of task
Address
Start address of checked address range
Size
Size of checked address range
Return code
AccessType
Returns the access rights of the Task to the given address range
Functional Description
The service distinguishes the memory access rights of a given Task.
Particularities and Limitations
>  The access checks are based upon the “OsAccessCheckRegion” configuration objects.
>  The return value of this functions is typically used with the AUTOSAR OS specified macros
>  OSMEMORY_IS_READABLE
>  OSMEMORY_IS_WRITEABLE
>  OSMEMORY_IS_EXECUTABLE
>  OSMEMORY_IS_STACKSPACE
Table 5-56   API Service CheckTaskMemoryAccess

© 2017 Vector Informatik GmbH
Version 2.12.0
222
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.57  Check ISR Memory Access
Prototype
FUNC(AccessType, OS_CODE) CheckISRMemoryAccess(
  ISRType ISRID,
  MemoryStartAddressType Address,
  MemorySizeType Size
)
Parameter
ISRID
ID of category 2 ISR
Address
Start address of checked address range
Size
Size of checked address range
Return code
AccessType
Returns the access rights of the ISR to the given address range
Functional Description
The service distinguishes the memory access rights of a given category 2 ISR
Particularities and Limitations
>  The access checks are based upon the “OsAccessCheckRegion” configuration objects.
>  The return value of this functions is typically used with the AUTOSAR OS specified macros
>  OSMEMORY_IS_READABLE
>  OSMEMORY_IS_WRITEABLE
>  OSMEMORY_IS_EXECUTABLE
>  OSMEMORY_IS_STACKSPACE
Table 5-57   API Service CheckISRMemoryAccess

© 2017 Vector Informatik GmbH
Version 2.12.0
223
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.58  OSErrorGetServiceId
Prototype
OSServiceIdType OSErrorGetServiceId (void)
Parameter
void
none
Return code
OSServiceIdType
none
Functional Description
OS service OSErrorGetServiceId().
Particularities and Limitations
Pre-Condition: None
Provides the service identifier where the error has been risen.
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-58   OSErrorGetServiceId

© 2017 Vector Informatik GmbH
Version 2.12.0
224
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.59  OSError_Os_DisableInterruptSource_ISRID
Prototype
ISRType OSError_Os_DisableInterruptSource_ISRID (void)
Parameter
void
none
Return code
ISRType
Requested parameter value.
Functional Description
Returns parameter ISRID of a faulty Os_DisableInterruptSource call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-59   OSError_Os_DisableInterruptSource_ISRID
5.1.60  OSError_Os_EnableInterruptSource_ISRID
Prototype
ISRType OSError_Os_EnableInterruptSource_ISRID (void)
Parameter
void
none
Return code
ISRType
Requested parameter value.
Functional Description
Returns parameter ISRID of a faulty Os_EnableInterruptSource call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-60   OSError_Os_EnableInterruptSource_ISRID

© 2017 Vector Informatik GmbH
Version 2.12.0
225
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.61  OSError_Os_EnableInterruptSource_ClearPending
Prototype
boolean OSError_Os_EnableInterruptSource_ClearPending (void)
Parameter
void
none
Return code
boolean
Requested parameter value.
Functional Description
Returns parameter ClearPending of a faulty Os_EnableInterruptSource call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-61   OSError_Os_EnableInterruptSource_ClearPending
5.1.62  OSError_Os_ClearPendingInterrupt_ISRID
Prototype
ISRType OSError_Os_ClearPendingInterrupt_ISRID (void)
Parameter
void
none
Return code
ISRType
Requested parameter value.
Functional Description
Returns parameter ISRID of a faulty Os_ClearPendingInterrupt call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-62   OSError_Os_ClearPendingInterrupt_ISRID

© 2017 Vector Informatik GmbH
Version 2.12.0
226
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.63  OSError_Os_IsInterruptSourceEnabled_ISRID
Prototype
ISRType OSError_Os_IsInterruptSourceEnabled_ISRID (void)
Parameter
void
none
Return code
ISRType
Requested parameter value.
Functional Description
Returns parameter ISRID of a faulty Os_IsInterruptSourceEnabled call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-63   OSError_Os_IsInterruptSourceEnabled_ISRID
5.1.64  OSError_Os_IsInterruptSourceEnabled_IsEnabled
Prototype
boolean * OSError_Os_IsInterruptSourceEnabled_IsEnabled (void)
Parameter
void
none
Return code
boolean *
Requested parameter value.
Functional Description
Returns parameter IsEnabled of a faulty Os_IsInterruptSourceEnabled call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-64   OSError_Os_IsInterruptSourceEnabled_IsEnabled

© 2017 Vector Informatik GmbH
Version 2.12.0
227
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.65  OSError_Os_IsInterruptPending_ISRID
Prototype
ISRType OSError_Os_IsInterruptPending_ISRID (void)
Parameter
void
none
Return code
ISRType
Requested parameter value.
Functional Description
Returns parameter ISRID of a faulty Os_IsInterruptPending call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-65   OSError_Os_IsInterruptPending_ISRID
5.1.66  OSError_Os_IsInterruptPending_IsPending
Prototype
boolean * OSError_Os_IsInterruptPending_IsPending (void)
Parameter
void
none
Return code
boolean *
Requested parameter value.
Functional Description
Returns parameter IsPending of a faulty Os_IsInterruptPending_IsPending call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-66   OSError_Os_IsInterruptPending_IsPending

© 2017 Vector Informatik GmbH
Version 2.12.0
228
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.67  OSError_CallTrustedFunction_FunctionIndex
Prototype
TrustedFunctionIndexType OSError_CallTrustedFunction_FunctionIndex (void)
Parameter
void
none
Return code
TrustedFunctionIndexType  Requested parameter value.
Functional Description
Returns parameter FunctionIndex of a faulty CallTrustedFunction call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-67   OSError_CallTrustedFunction_FunctionIndex
5.1.68  OSError_CallTrustedFunction_FunctionParams
Prototype
TrustedFunctionParameterRefType OSError_CallTrustedFunction_FunctionParams
(void)
Parameter
void
none
Return code
TrustedFunctionParameterRefType  Requested parameter value.
Functional Description
Returns parameter FunctionParams of a faulty CallTrustedFunction call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-68   OSError_CallTrustedFunction_FunctionParams

© 2017 Vector Informatik GmbH
Version 2.12.0
229
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.69  OSError_CallNonTrustedFunction_FunctionIndex
Prototype
Os_NonTrustedFunctionIndexType OSError_CallNonTrustedFunction_FunctionIndex
(void)
Parameter
void
none
Return code
Os_NonTrustedFunctionIndexType  Requested parameter value.
Functional Description
Returns parameter FunctionIndex of a faulty CallTrustedFunction call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-69   OSError_CallNonTrustedFunction_FunctionIndex
5.1.70  OSError_CallNonTrustedFunction_FunctionParams
Prototype
Os_NonTrustedFunctionParameterRefType
OSError_CallNonTrustedFunction_FunctionParams (void)
Parameter
void
none
Return code
Os_NonTrustedFunctionParameterRefType  Requested parameter value.
Functional Description
Returns parameter FunctionParams of a faulty CallNonTrustedFunction call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-70   OSError_CallNonTrustedFunction_FunctionParams

© 2017 Vector Informatik GmbH
Version 2.12.0
230
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.71  OSError_StartScheduleTableRel_ScheduleTableID
Prototype
ScheduleTableType OSError_StartScheduleTableRel_ScheduleTableID (void)
Parameter
void
none
Return code
ScheduleTableType
Requested parameter value.
Functional Description
Returns parameter ScheduleTableID of a faulty StartScheduleTableRel call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-71   OSError_StartScheduleTableRel_ScheduleTableID
5.1.72  OSError_StartScheduleTableRel_Offset
Prototype
TickType OSError_StartScheduleTableRel_Offset (void)
Parameter
void
none
Return code
TickType
Requested parameter value.
Functional Description
Returns parameter Offset of a faulty StartScheduleTableRel call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-72   OSError_StartScheduleTableRel_Offset

© 2017 Vector Informatik GmbH
Version 2.12.0
231
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.73  OSError_StartScheduleTableAbs_ScheduleTableID
Prototype
ScheduleTableType OSError_StartScheduleTableAbs_ScheduleTableID (void)
Parameter
void
none
Return code
ScheduleTableType
Requested parameter value.
Functional Description
Returns parameter ScheduleTableID of a faulty StartScheduleTableAbs call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-73   OSError_StartScheduleTableAbs_ScheduleTableID
5.1.74  OSError_StartScheduleTableAbs_Start
Prototype
TickType OSError_StartScheduleTableAbs_Start (void)
Parameter
void
none
Return code
TickType
Requested parameter value.
Functional Description
Returns parameter Start of a faulty StartScheduleTableAbs call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-74   OSError_StartScheduleTableAbs_Start

© 2017 Vector Informatik GmbH
Version 2.12.0
232
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.75  OSError_StopScheduleTable_ScheduleTableID
Prototype
ScheduleTableType OSError_StopScheduleTable_ScheduleTableID (void)
Parameter
void
none
Return code
ScheduleTableType
Requested parameter value.
Functional Description
Returns parameter ScheduleTableID of a faulty StopScheduleTable call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-75   OSError_StopScheduleTable_ScheduleTableID
5.1.76  OSError_NextScheduleTable_ScheduleTableID_From
Prototype
ScheduleTableType OSError_NextScheduleTable_ScheduleTableID_From (void)
Parameter
void
none
Return code
ScheduleTableType
Requested parameter value.
Functional Description
Returns parameter ScheduleTableID_From of a faulty NextScheduleTable call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-76   OSError_NextScheduleTable_ScheduleTableID_From

© 2017 Vector Informatik GmbH
Version 2.12.0
233
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.77  OSError_NextScheduleTable_ScheduleTableID_To
Prototype
ScheduleTableType OSError_NextScheduleTable_ScheduleTableID_To (void)
Parameter
void
none
Return code
ScheduleTableType
Requested parameter value.
Functional Description
Returns parameter ScheduleTableID_To of a faulty NextScheduleTable call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-77   OSError_NextScheduleTable_ScheduleTableID_To
5.1.78  OSError_StartScheduleTableSynchron_ScheduleTableID
Prototype
ScheduleTableType OSError_StartScheduleTableSynchron_ScheduleTableID (void)
Parameter
void
none
Return code
ScheduleTableType
Requested parameter value.
Functional Description
Returns parameter ScheduleTableID of a faulty StartScheduleTableSynchron call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-78   OSError_StartScheduleTableSynchron_ScheduleTableID

© 2017 Vector Informatik GmbH
Version 2.12.0
234
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.79  OSError_SyncScheduleTable_ScheduleTableID
Prototype
ScheduleTableType OSError_SyncScheduleTable_ScheduleTableID (void)
Parameter
void
none
Return code
ScheduleTableType
Requested parameter value.
Functional Description
Returns parameter ScheduleTableID of a faulty SyncScheduleTable call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-79   OSError_SyncScheduleTable_ScheduleTableID
5.1.80  OSError_SyncScheduleTable_Value
Prototype
TickType OSError_SyncScheduleTable_Value (void)
Parameter
void
none
Return code
TickType
Requested parameter value.
Functional Description
Returns parameter Value of a faulty SyncScheduleTable call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-80   OSError_SyncScheduleTable_Value

© 2017 Vector Informatik GmbH
Version 2.12.0
235
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.81  OSError_SetScheduleTableAsync_ScheduleTableID
Prototype
ScheduleTableType OSError_SetScheduleTableAsync_ScheduleTableID (void)
Parameter
void
none
Return code
ScheduleTableType
Requested parameter value.
Functional Description
Returns parameter ScheduleTableID of a faulty SetScheduleTableAsync call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-81   OSError_SetScheduleTableAsync_ScheduleTableID
5.1.82  OSError_GetScheduleTableStatus_ScheduleTableID
Prototype
ScheduleTableType OSError_GetScheduleTableStatus_ScheduleTableID (void)
Parameter
void
none
Return code
ScheduleTableType
Requested parameter value.
Functional Description
Returns parameter ScheduleTableID of a faulty GetScheduleTableStatus call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-82   OSError_GetScheduleTableStatus_ScheduleTableID
© 2017 Vector Informatik GmbH
Version 2.12.0
236
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.83  OSError_GetScheduleTableStatus_ScheduleStatus
Prototype
ScheduleTableStatusRefType OSError_GetScheduleTableStatus_ScheduleStatus (void)
Parameter
void
none
Return code
ScheduleTableType
Requested parameter value.
Functional Description
Returns parameter ScheduleStatus of a faulty GetScheduleTableStatus call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-83   OSError_GetScheduleTableStatus_ScheduleStatus

5.1.84  OSError_IncrementCounter_CounterID
Prototype
CounterType OSError_IncrementCounter_CounterID (void)
Parameter
void
none
Return code
CounterType
Requested parameter value.
Functional Description
Returns parameter CounterID of a faulty IncrementCounter call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-84   OSError_IncrementCounter_CounterID
© 2017 Vector Informatik GmbH
Version 2.12.0
237
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.85  OSError_GetCounterValue_CounterID
Prototype
CounterType OSError_GetCounterValue_CounterID (void)
Parameter
void
none
Return code
CounterType
Requested parameter value.
Functional Description
Returns parameter CounterID of a faulty GetCounterValue call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-85   OSError_GetCounterValue_CounterID

© 2017 Vector Informatik GmbH
Version 2.12.0
238
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.86  OSError_GetCounterValue_Value
Prototype
TickRefType OSError_GetCounterValue_Value (void)
Parameter
void
none
Return code
TickRefType
Requested parameter value.
Functional Description
Returns parameter Value of a faulty GetCounterValue call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-86   OSError_GetCounterValue_Value
5.1.87  OSError_GetElapsedValue_CounterID
Prototype
CounterType OSError_GetElapsedValue_CounterID (void)
Parameter
void
none
Return code
CounterType
Requested parameter value.
Functional Description
Returns parameter CounterID of a faulty GetElapsedValue call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-87   OSError_GetElapsedValue_CounterID

© 2017 Vector Informatik GmbH
Version 2.12.0
239
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.88  OSError_GetElapsedValue_Value
Prototype
TickRefType OSError_GetElapsedValue_Value (void)
Parameter
void
none
Return code
TickRefType
Requested parameter value.
Functional Description
Returns parameter Value of a faulty GetElapsedValue call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-88   OSError_GetElapsedValue_Value
5.1.89  OSError_GetElapsedValue_ElapsedValue
Prototype
TickRefType OSError_GetElapsedValue_ElapsedValue (void)
Parameter
void
none
Return code
TickRefType
Requested parameter value.
Functional Description
Returns parameter ElapsedValue of a faulty GetElapsedValue call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-89   OSError_GetElapsedValue_ElapsedValue

© 2017 Vector Informatik GmbH
Version 2.12.0
240
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.90  OSError_TerminateApplication_Application
Prototype
ApplicationType OSError_TerminateApplication_Application (void)
Parameter
void
none
Return code
ApplicationType
Requested parameter value.
Functional Description
Returns parameter Application of a faulty TerminateApplication call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-90   OSError_TerminateApplication_Application
5.1.91  OSError_TerminateApplication_RestartOption
Prototype
RestartType OSError_TerminateApplication_RestartOption (void)
Parameter
void
none
Return code
RestartType
Requested parameter value.
Functional Description
Returns parameter RestartOption of a faulty TerminateApplication call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-91   OSError_TerminateApplication_RestartOption

© 2017 Vector Informatik GmbH
Version 2.12.0
241
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.92  OSError_GetApplicationState_Application
Prototype
ApplicationType OSError_GetApplicationState_Application (void)
Parameter
void
none
Return code
ApplicationType
Requested parameter value.
Functional Description
Returns parameter Application of a faulty GetApplicationState call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-92   OSError_GetApplicationState_Application
5.1.93  OSError_GetApplicationState_Value
Prototype
ApplicationStateRefType OSError_GetApplicationState_Value (void)
Parameter
void
none
Return code
ApplicationStateRefType
Requested parameter value.
Functional Description
Returns parameter Value of a faulty GetApplicationState call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-93   OSError_GetApplicationState_Value

© 2017 Vector Informatik GmbH
Version 2.12.0
242
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.94  OSError_GetSpinlock_SpinlockId
Prototype
SpinlockIdType OSError_GetSpinlock_SpinlockId (void)
Parameter
void
none
Return code
SpinlockIdType
Requested parameter value.
Functional Description
Returns parameter SpinlockId of a faulty GetSpinlock call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-94   OSError_GetSpinlock_SpinlockId
5.1.95  OSError_ReleaseSpinlock_SpinlockId
Prototype
SpinlockIdType OSError_ReleaseSpinlock_SpinlockId (void)
Parameter
void
none
Return code
SpinlockIdType
Requested parameter value.
Functional Description
Returns parameter SpinlockId of a faulty ReleaseSpinlock call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-95   OSError_ReleaseSpinlock_SpinlockId

© 2017 Vector Informatik GmbH
Version 2.12.0
243
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.96  OSError_TryToGetSpinlock_SpinlockId
Prototype
SpinlockIdType OSError_TryToGetSpinlock_SpinlockId (void)
Parameter
void
none
Return code
SpinlockIdType
Requested parameter value.
Functional Description
Returns parameter SpinlockId of a faulty TryToGetSpinlock call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-96   OSError_TryToGetSpinlock_SpinlockId
5.1.97  OSError_TryToGetSpinlock_Success
Prototype
TryToGetSpinlockType const * OSError_TryToGetSpinlock_Success (void)
Parameter
void
none
Return code
TryToGetSpinlockType
Requested parameter value.
const *
Functional Description
Returns parameter Success of a faulty TryToGetSpinlock call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-97   OSError_TryToGetSpinlock_Success

© 2017 Vector Informatik GmbH
Version 2.12.0
244
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.98  OSError_ControlIdle_CoreID
Prototype
CoreIdType OSError_ControlIdle_CoreID (void)
Parameter
void
none
Return code
CoreIdType
Requested parameter value.
Functional Description
Returns parameter CoreID of a faulty ControlIdle call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-98   OSError_ControlIdle_CoreID

5.1.99  OSError_Os_GetExceptionContext_Context
Prototype
Os_ExceptionContextRefType OSError_Os_GetExceptionContext_Context (void)
Parameter
void
none
Return code
Os_ExceptionContextRefType  Requested parameter value.
Functional Description
Returns parameter Context of a faulty Os_GetExceptionContext call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-99   OSError_Os_GetExceptionContext_Context
© 2017 Vector Informatik GmbH
Version 2.12.0
245
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.100 OSError_Os_SetExceptionContext_Context
Prototype
Os_ExceptionContextRefType OSError_Os_SetExceptionContext_Context (void)
Parameter
void
none
Return code
Os_ExceptionContextRefType  Requested parameter value.
Functional Description
Returns parameter Context of a faulty Os_SetExceptionContext call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-100  OSError_Os_SetExceptionContext_Context
5.1.101 OSError_ControlIdle_IdleMode
Prototype
IdleModeType OSError_ControlIdle_IdleMode (void)
Parameter
void
none
Return code
IdleModeType
Requested parameter value.
Functional Description
Returns parameter IdleMode of a faulty ControlIdle call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-101  OSError_ControlIdle_IdleMode

© 2017 Vector Informatik GmbH
Version 2.12.0
246
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.102 OSError_IocSend_IN
Prototype
void const * OSError_IocSend_IN (void)
Parameter
void
none
Return code
void const *
Requested parameter value.
Functional Description
Returns parameter IN of a faulty IocSend call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-102  OSError_IocSend_IN
5.1.103 OSError_IocWrite_IN
Prototype
void const * OSError_IocWrite_IN (void)
Parameter
void
none
Return code
void const *
Requested parameter value.
Functional Description
Returns parameter IN of a faulty IocWrite call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-103  OSError_IocWrite_IN

© 2017 Vector Informatik GmbH
Version 2.12.0
247
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.104 OSError_IocSendGroup_IN
Prototype
void const * OSError_IocSendGroup_IN (void)
Parameter
void
none
Return code
void const *
Requested parameter value.
Functional Description
Returns parameter IN of a faulty IocSendGroup call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-104  OSError_IocSendGroup_IN
5.1.105 OSError_IocWriteGroup_IN
Prototype
void const * OSError_IocWriteGroup_IN (void)
Parameter
void
none
Return code
void const *
Requested parameter value.
Functional Description
Returns parameter IN of a faulty IocWriteGroup call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-105  OSError_IocWriteGroup_IN

© 2017 Vector Informatik GmbH
Version 2.12.0
248
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.106 OSError_IocReceive_OUT
Prototype
void const * OSError_IocReceive_OUT (void)
Parameter
void
none
Return code
void const *
Requested parameter value.
Functional Description
Returns parameter OUT of a faulty IocReceive call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-106  OSError_IocReceive_OUT
5.1.107 OSError_IocRead_OUT
Prototype
void const * OSError_IocRead_OUT (void)
Parameter
void
none
Return code
void const *
Requested parameter value.
Functional Description
Returns parameter OUT of a faulty IocRead call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-107  OSError_IocRead_OUT

© 2017 Vector Informatik GmbH
Version 2.12.0
249
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.108 OSError_IocReceiveGroup_OUT
Prototype
void const * OSError_IocReceiveGroup_OUT (void)
Parameter
void
none
Return code
void const *
Requested parameter value.
Functional Description
Returns parameter OUT of a faulty IocReceiveGroup call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-108  OSError_IocReceiveGroup_OUT
5.1.109 OSError_IocReadGroup_OUT
Prototype
void const * OSError_IocReadGroup_OUT (void)
Parameter
void
none
Return code
void const *
Requested parameter value.
Functional Description
Returns parameter OUT of a faulty IocReadGroup call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-109  OSError_IocReadGroup_OUT

© 2017 Vector Informatik GmbH
Version 2.12.0
250
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.110 OSError_StartOS_Mode
Prototype
AppModeType OSError_StartOS_Mode (void)
Parameter
void
none
Return code
AppModeType
Requested parameter value.
Functional Description
Returns parameter Mode of a faulty StartOS call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-110  OSError_StartOS_Mode
5.1.111 OSError_ActivateTask_TaskID
Prototype
TaskType OSError_ActivateTask_TaskID (void)
Parameter
void
none
Return code
TaskType
Requested parameter value.
Functional Description
Returns parameter TaskID of a faulty ActivateTask call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-111   OSError_ActivateTask_TaskID

© 2017 Vector Informatik GmbH
Version 2.12.0
251
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.112 OSError_ChainTask_TaskID
Prototype
TaskType OSError_ChainTask_TaskID (void)
Parameter
void
none
Return code
TaskType
Requested parameter value.
Functional Description
Returns parameter TaskID of a faulty ChainTask call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-112  OSError_ChainTask_TaskID
5.1.113 OSError_GetTaskID_TaskID
Prototype
TaskRefType OSError_GetTaskID_TaskID (void)
Parameter
void
none
Return code
TaskRefType
Requested parameter value.
Functional Description
Returns parameter TaskID of a faulty GetTaskID call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-113  OSError_GetTaskID_TaskID

© 2017 Vector Informatik GmbH
Version 2.12.0
252
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.114 OSError_GetTaskState_TaskID
Prototype
TaskType OSError_GetTaskState_TaskID (void)
Parameter
void
none
Return code
TaskType
Requested parameter value.
Functional Description
Returns parameter TaskID of a faulty GetTaskState call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-114  OSError_GetTaskState_TaskID
5.1.115 OSError_GetTaskState_State
Prototype
TaskStateRefType OSError_GetTaskState_State (void)
Parameter
void
none
Return code
TaskStateRefType
Requested parameter value.
Functional Description
Returns parameter State of a faulty GetTaskState call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-115  OSError_GetTaskState_State

© 2017 Vector Informatik GmbH
Version 2.12.0
253
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.116 OSError_SetEvent_TaskID
Prototype
TaskType OSError_SetEvent_TaskID (void)
Parameter
void
none
Return code
TaskType
Requested parameter value.
Functional Description
Returns parameter TaskID of a faulty SetEvent call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-116  OSError_SetEvent_TaskID
5.1.117 OSError_SetEvent_Mask
Prototype
EventMaskType OSError_SetEvent_Mask (void)
Parameter
void
none
Return code
EventMaskType
Requested parameter value.
Functional Description
Returns parameter Mask of a faulty SetEvent call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-117  OSError_SetEvent_Mask

© 2017 Vector Informatik GmbH
Version 2.12.0
254
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.118 OSError_ClearEvent_Mask
Prototype
EventMaskType OSError_ClearEvent_Mask (void)
Parameter
void
none
Return code
EventMaskType
Requested parameter value.
Functional Description
Returns parameter Mask of a faulty ClearEvent call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-118  OSError_ClearEvent_Mask
5.1.119 OSError_GetEvent_TaskID
Prototype
TaskType OSError_GetEvent_TaskID (void)
Parameter
void
none
Return code
TaskType
Requested parameter value.
Functional Description
Returns parameter TaskID of a faulty GetEvent call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-119  OSError_GetEvent_TaskID

© 2017 Vector Informatik GmbH
Version 2.12.0
255
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.120 OSError_GetEvent_Mask
Prototype
EventMaskRefType OSError_GetEvent_Mask (void)
Parameter
void
none
Return code
EventMaskRefType
Requested parameter value.
Functional Description
Returns parameter Mask of a faulty GetEvent call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-120  OSError_GetEvent_Mask
5.1.121 OSError_WaitEvent_Mask
Prototype
EventMaskType OSError_WaitEvent_Mask (void)
Parameter
void
none
Return code
EventMaskType
Requested parameter value.
Functional Description
Returns parameter Mask of a faulty WaitEvent call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-121  OSError_WaitEvent_Mask

© 2017 Vector Informatik GmbH
Version 2.12.0
256
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.122 OSError_GetAlarmBase_AlarmID
Prototype
AlarmType OSError_GetAlarmBase_AlarmID (void)
Parameter
void
none
Return code
AlarmType
Requested parameter value.
Functional Description
Returns parameter AlarmID of a faulty GetAlarmBase call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-122  OSError_GetAlarmBase_AlarmID
5.1.123 OSError_GetAlarmBase_Info
Prototype
AlarmBaseRefType OSError_GetAlarmBase_Info (void)
Parameter
void
none
Return code
AlarmBaseRefType
Requested parameter value.
Functional Description
Returns parameter Info of a faulty GetAlarmBase call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-123  OSError_GetAlarmBase_Info

© 2017 Vector Informatik GmbH
Version 2.12.0
257
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.124 OSError_GetAlarm_AlarmID
Prototype
AlarmType OSError_GetAlarm_AlarmID (void)
Parameter
void
none
Return code
AlarmType
Requested parameter value.
Functional Description
Returns parameter AlarmID of a faulty GetAlarm call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-124  OSError_GetAlarm_AlarmID
5.1.125 OSError_GetAlarm_Tick
Prototype
TickRefType OSError_GetAlarm_Tick (void)
Parameter
void
none
Return code
TickRefType
Requested parameter value.
Functional Description
Returns parameter Tick of a faulty GetAlarm call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-125  OSError_GetAlarm_Tick

© 2017 Vector Informatik GmbH
Version 2.12.0
258
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.126 OSError_SetRelAlarm_AlarmID
Prototype
AlarmType OSError_SetRelAlarm_AlarmID (void)
Parameter
void
none
Return code
AlarmType
Requested parameter value.
Functional Description
Returns parameter AlarmID of a faulty SetRelAlarm call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-126  OSError_SetRelAlarm_AlarmID
5.1.127 OSError_SetRelAlarm_increment
Prototype
TickType OSError_SetRelAlarm_increment (void)
Parameter
void
none
Return code
TickType
Requested parameter value.
Functional Description
Returns parameter increment of a faulty SetRelAlarm call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-127  OSError_SetRelAlarm_increment

© 2017 Vector Informatik GmbH
Version 2.12.0
259
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.128 OSError_SetRelAlarm_cycle
Prototype
TickType OSError_SetRelAlarm_cycle (void)
Parameter
void
none
Return code
TickType
Requested parameter value.
Functional Description
Returns parameter cycle of a faulty SetRelAlarm call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-128  OSError_SetRelAlarm_cycle
5.1.129 OSError_SetAbsAlarm_AlarmID
Prototype
AlarmType OSError_SetAbsAlarm_AlarmID (void)
Parameter
void
none
Return code
AlarmType
Requested parameter value.
Functional Description
Returns parameter AlarmID of a faulty SetAbsAlarm call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-129  OSError_SetAbsAlarm_AlarmID

© 2017 Vector Informatik GmbH
Version 2.12.0
260
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.130 OSError_SetAbsAlarm_start
Prototype
TickType OSError_SetAbsAlarm_start (void)
Parameter
void
none
Return code
TickType
Requested parameter value.
Functional Description
Returns parameter start of a faulty SetAbsAlarm call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-130  OSError_SetAbsAlarm_start
5.1.131 OSError_SetAbsAlarm_cycle
Prototype
TickType OSError_SetAbsAlarm_cycle (void)
Parameter
void
none
Return code
TickType
Requested parameter value.
Functional Description
Returns parameter cycle of a faulty SetAbsAlarm call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-131  OSError_SetAbsAlarm_cycle

© 2017 Vector Informatik GmbH
Version 2.12.0
261
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.132 OSError_CancelAlarm_AlarmID
Prototype
AlarmType OSError_CancelAlarm_AlarmID (void)
Parameter
void
none
Return code
AlarmType
Requested parameter value.
Functional Description
Returns parameter AlarmID of a faulty CancelAlarm call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-132  OSError_CancelAlarm_AlarmID
5.1.133 OSError_GetResource_ResID
Prototype
ResourceType OSError_GetResource_ResID (void)
Parameter
void
none
Return code
ResourceType
Requested parameter value.
Functional Description
Returns parameter ResID of a faulty GetResource call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-133  OSError_GetResource_ResID

© 2017 Vector Informatik GmbH
Version 2.12.0
262
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.134 OSError_ReleaseResource_ResID
Prototype
ResourceType OSError_ReleaseResource_ResID (void)
Parameter
void
none
Return code
ResourceType
Requested parameter value.
Functional Description
Returns parameter ResID of a faulty ReleaseResource call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-134  OSError_ReleaseResource_ResID
5.1.135 OSError_Os_GetUnhandledIrq_InterruptSource
Prototype
Os_InterruptSourceIdRefType OSError_Os_GetUnhandledIrq_InterruptSource (void)
Parameter
void
none
Return code
Os_InterruptSourceIdRefType  Requested parameter value.
Functional Description
Returns parameter InterruptSource of a faulty Os_GetUnhandledIrq call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-135  OSError_Os_GetUnhandledIrq_InterruptSource

© 2017 Vector Informatik GmbH
Version 2.12.0
263
based on template version 6.0.1

Technical Reference MICROSAR OS
5.1.136 OSError_Os_GetUnhandledExc_ExceptionSource
Prototype
Os_ExceptionSourceIdRefType OSError_Os_GetUnhandledExc_ExceptionSource (void)
Parameter
void
none
Return code
Os_ExceptionSourceIdRefType  Requested parameter value.
Functional Description
Returns parameter ExceptionSource of a faulty Os_GetUnhandledExc call.
Particularities and Limitations
Pre-Condition: None
--no details--
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-136  OSError_Os_GetUnhandledExc_ExceptionSource
5.1.137 OSError_BarrierSynchronize_BarrierID
Prototype
Os_BarrierIdType OSError_BarrierSynchronize_BarrierID(void)
Parameter
void
none
Return code
Os_BarrierIdType
Requested parameter value
Functional Description
Returns parameter BarrierID of a faulty Os_BarrierSynchronize call.
Particularities and Limitations
>  Pre-Condition: None
Call context
>  ERRHOOK
>  This function is Synchronous
>  This function is Reentrant
Table 5-137  OSError_BarrierSynchronize_BarrierID

© 2017 Vector Informatik GmbH
Version 2.12.0
264
based on template version 6.0.1

Technical Reference MICROSAR OS
5.2
Additional OS services
The OS provides the following additional services which are not part of the AUTOSAR OS
specification.
5.2.1
Os_GetVersionInfo
Prototype
void Os_GetVersionInfo (Std_VersionInfoType *versioninfo)
Parameter
versioninfo [out]
Version information (decimal coded).
Return code
void
none
Functional Description
AUTOSAR Get Version Information API.
Particularities and Limitations
Given object pointer(s) are valid.
Returns the Published information of MICROSAR OS.
Call context
>  ANY
>  This function is Synchronous
>  This function is Reentrant
Table 5-138  Os_GetVersionInfo

© 2017 Vector Informatik GmbH
Version 2.12.0
265
based on template version 6.0.1

Technical Reference MICROSAR OS
5.2.2
Peripheral Access API
The  API  consists  of  read,  write  and  bit  manipulating  functions  for  8,  16  and  32  bit
accesses.
5.2.2.1
Read Functions
Prototype
FUNC(uint8, OS_CODE) Os_ReadPeripheral8(
  Os_PeripheralIdType PeripheralID,
  P2CONST(uint8, AUTOMATIC, OS_APPL_DATA) Address
)
FUNC(uint16, OS_CODE) Os_ReadPeripheral16(
  Os_PeripheralIdType PeripheralID,
  P2CONST(uint16, AUTOMATIC, OS_APPL_DATA) Address
)
FUNC(uint32, OS_CODE) Os_ReadPeripheral32(
  Os_PeripheralIdType PeripheralID,
  P2CONST(uint32, AUTOMATIC, OS_APPL_DATA) Address
)
Parameter
PeripheralID
The ID of a configured peripheral region.
The symbolic name may be passed here.
Address
The address of the peripheral register which shall be read.
Return code
uint8
uint16
The content of the peripheral register which has been passed in the Address
parameter.
uint32
Functional Description
The function distinguishes the address range of the passed peripheral region. It checks whether the
parameter “Address” is within this range. Then it checks whether the calling OS application has access
rights to the passed peripheral region.
If all checks did pass the API returns the content of the passed address
Particularities and Limitations
>  If one of the performed checks within the API is not passed the OS treats it as a memory protection
violation. The ProtectionHook() is called.
>  The data alignment of the “Address” parameter is not checked by the service function. Misaligned
accesses may lead to exceptions.
Table 5-139  Read Peripheral API
© 2017 Vector Informatik GmbH
Version 2.12.0
266
based on template version 6.0.1

Technical Reference MICROSAR OS

Note
The former names of the API functions osReadPeripheral8(), osReadPeripheral16()
and osReadPeripheral32() may also be used (the OS is backward compatible).

© 2017 Vector Informatik GmbH
Version 2.12.0
267
based on template version 6.0.1

Technical Reference MICROSAR OS
5.2.2.2
Write Functions
Prototype
FUNC(void, OS_CODE) Os_WritePeripheral8(
  Os_PeripheralIdType PeripheralID,
  P2VAR(uint8, AUTOMATIC, OS_APPL_DATA) Address,
  uint8 Value
)
FUNC(void, OS_CODE) Os_WritePeripheral16(
  Os_PeripheralIdType PeripheralID,
  P2VAR(uint16, AUTOMATIC, OS_APPL_DATA) Address,
  uint16 Value
)
FUNC(void, OS_CODE) Os_WritePeripheral32(
  Os_PeripheralIdType PeripheralID,
  P2VAR(uint32, AUTOMATIC, OS_APPL_DATA) Address,
  uint32 Value
)
Parameter
PeripheralID
The ID of a configured peripheral region.
The symbolic name may be passed here.
Address
The address of the peripheral register which shall be written.
Value uint8
Value uint16
Value which shall be written to the peripheral register.
Value uint32
Return code
void
none
Functional Description
The function distinguishes the address range of the passed peripheral region. It checks whether the
parameter “Address” is within this range. Then it checks whether the calling OS application has access
rights to the passed peripheral region.
If all checks did pass the OS writes the Value into the peripheral register.
Particularities and Limitations
>  If one of the performed checks within the API is not passed the OS treats it as a memory protection
violation. The ProtectionHook() is called.
>  The data alignment of the “Address” parameter is not checked by the service function. Misaligned
accesses may lead to exceptions.
Table 5-140  Write Peripheral APIs
© 2017 Vector Informatik GmbH
Version 2.12.0
268
based on template version 6.0.1

Technical Reference MICROSAR OS

Note
The former names of the API functions osWritePeripheral8(), osWritePeripheral16()
and osWritePeripheral32() may also be used (the OS is backward compatible).

© 2017 Vector Informatik GmbH
Version 2.12.0
269
based on template version 6.0.1

Technical Reference MICROSAR OS
5.2.2.3
Bitmask Functions
Prototype
FUNC(void, OS_CODE) Os_ModifyPeripheral8(
  Os_PeripheralIdType PeripheralID,
  P2VAR(uint8, AUTOMATIC, OS_APPL_DATA) Address,
  uint8 ClearMask,
  uint8 SetMask
)
FUNC(void, OS_CODE) Os_ModifyPeripheral16(
  Os_PeripheralIdType PeripheralID,
  P2VAR(uint16, AUTOMATIC, OS_APPL_DATA) Address,
  uint16 ClearMask,
  uint16 SetMask
)
FUNC(void, OS_CODE) Os_ModifyPeripheral32(
  Os_PeripheralIdType PeripheralID,
  P2VAR(uint32, AUTOMATIC, OS_APPL_DATA) Address,
  uint32 ClearMask,
  uint32 SetMask
)
Parameter
PeripheralID
The ID of a configured peripheral region.
The symbolic name may be passed here.
Address
The address of the peripheral register which shall be modified.
ClearMask uint8
ClearMask uint16  The mask for the AND operation.
ClearMask uint32
SetMask uint8
SetMask uint16
The mask for the OR operation.
SetMask uint32
Return code
void
none
Functional Description
The function distinguishes the address range of the passed peripheral region. It checks whether the
parameter “Address” is within this range. Then it checks whether the calling OS application has access
rights to the passed peripheral region.
If all checks did pass the OS performs the following operation:
Address = (Address & ClearMask) | SetMask;
Particularities and Limitations
>  If one of the performed checks within the API is not passed the OS treats it as a memory protection
violation. The ProtectionHook() is called.
© 2017 Vector Informatik GmbH
Version 2.12.0
270
based on template version 6.0.1

Technical Reference MICROSAR OS
>  The data alignment of the “Address” parameter is not checked by the service function. Misaligned
accesses may lead to exceptions.
Table 5-141  Bitmask Peripheral API

Note
The former names of the API functions osModifyPeripheral8(), osModifyPeripheral16()
  and osModifyPeripheral32() may also be used (the OS is backward compatible).

© 2017 Vector Informatik GmbH
Version 2.12.0
271
based on template version 6.0.1

Technical Reference MICROSAR OS
5.2.3
Pre-Start Task
Prototype
FUNC(void, OS_CODE) Os_EnterPreStartTask(void)
Parameter
none
Return code
none
Functional Description
The function schedules and dispatches to the pre-start task. The core is initialized that non-trusted function
calls can be used safely within this task.
Particularities and Limitations
>  Has to be called on a core which is started as an AUTOSAR core.
>  The core which calls this function must have a configured pre-start task.
>  Must only be called once.
>  Must be called prior to StartOS() but after Os_Init()
Table 5-142  API Service Os_EnterPreStartTask

© 2017 Vector Informatik GmbH
Version 2.12.0
272
based on template version 6.0.1

Technical Reference MICROSAR OS
5.2.4
Non-Trusted Functions (NTF)
Prototype
FUNC(StatusType, OS_CODE) Os_CallNonTrustedFunction(
  Os_NonTrustedFunctionIndexType FunctionIndex,
  Os_NonTrustedFunctionParameterRefType FunctionParams
)
Parameter
FunctionIndex
The Index of the non-trusted function.
FunctionParams
Pointer to parameters which are passed to the non-trusted function.
Return code
E_OK
No error.
E_OS_SERVICEID
No function defined for this index.
E_OS_CALLEVEL
Called from invalid context. (EXTENDED status)
E_OS_ACCESS
The given object belongs to a foreign core. (EXTENDED status)
E_OS_ACCESS
Owner OS application is not accessible. (Service Protection)
E_OS_SYS_NO_NTFSTACK
No further NTF-Stacks available. (EXTENDED status)
Functional Description
Performs a call to the non-trusted function passed in „FunctionIndex“.
Particularities and Limitations
>  The non-trusted function will not be able to return any values. It has no access rights to the data
structure of the caller referenced by the “FunctionParams” parameter.
>  This API service may be called with disabled interrupts.
Table 5-143  Call Non-Trusted Function API

© 2017 Vector Informatik GmbH
Version 2.12.0
273
based on template version 6.0.1

Technical Reference MICROSAR OS
5.2.5
Fast Trusted Functions
Prototype
FUNC(StatusType, OS_CODE) Os_CallFastTrustedFunction
(
  Os_FastTrustedFunctionIndexType FunctionIndex,
  Os_FastTrustedFunctionParameterRefType FunctionParams
)
Parameter
FunctionIndex
Index of the function to be called.
FunctionParams
Pointer to the parameters for the function.
If no parameters are provided a NULL pointer has to be passed.
Return code
E_OK
No error.
E_OS_SERVICEID
No function defined for this index.
Functional Description
Performs a call to the fast trusted function passed in „FunctionIndex“.
Particularities and Limitations
>  May be called with interrupts disabled

© 2017 Vector Informatik GmbH
Version 2.12.0
274
based on template version 6.0.1

Technical Reference MICROSAR OS
5.2.6
Interrupt Source API
5.2.6.1
Disable Interrupt Source
Prototype
FUNC(StatusType, OS_CODE) Os_DisableInterruptSource(
  ISRType ISRID
)
Parameter
ISRID
The ID of a category 2 ISR.
Return code
E_OK
No error.
E_OS_ID
ISRID is not a valid category 2 ISR identifier (EXTENDED status)
E_OS_CALLEVEL
Wrong call context of the API function (EXTENDED status)
E_OS_ACCESS
The calling application is not the owner of the ISR passed in ISRID (Service
Protection)
Functional Description
MICROSAR OS disables the interrupt source by modifying the interrupt controller registers.
Particularities and Limitations
>  May be called for category 2 ISRs only.
Table 5-144  API Service Os_DisableInterruptSource

Caution
  Depending on target platform (e.g. ARM platforms), the ISR may still become active
although Os_DisableInterruptSource has returned E_OK.
This may be caused by hardware racing conditions e.g. when the interrupt is requested
immediately before the effect of Os_DisableInterruptSource becomes active.

© 2017 Vector Informatik GmbH
Version 2.12.0
275
based on template version 6.0.1

Technical Reference MICROSAR OS
5.2.6.2
Enable Interrupt Source
Prototype
FUNC(StatusType, OS_CODE) Os_EnableInterruptSource(
  ISRType ISRID,
  boolean ClearPending
)
Parameter
ISRID
The ID of a category 2 ISR.
ClearPending
Defines whether the pending flag shall be cleared (TRUE) or not (FALSE).
Return code
E_OK
No error.
E_OS_ID
ISRID is not a valid category 2 ISR identifier ID (EXTENDED status)
E_OS_CALLEVEL
Wrong call context of the API function (EXTENDED status)
E_OS_VALUE
The parameter “ClearPending” is not a boolean value (EXTENDED status)
E_OS_ACCESS
The calling application is not the owner of the ISR passed in ISRID (Service
Protection)
Functional Description
MICROSAR OS enables the interrupt source by modifying the interrupt controller registers. Additionally it
may clear the interrupt pending flag
Particularities and Limitations
>  May be called for category 2 ISRs only
Table 5-145  API Service Os_EnableInterruptSource

© 2017 Vector Informatik GmbH
Version 2.12.0
276
based on template version 6.0.1

Technical Reference MICROSAR OS
5.2.6.3
Clear Pending Interrupt
Prototype
FUNC(StatusType, OS_CODE) Os_ClearPendingInterrupt(
  ISRType ISRID
)
Parameter
ISRID
The ID of a category 2 ISR.
Return code
E_OK
No errors
E_OS_ID
ISRID is not a valid category 2 ISR identifier (EXTENDED status)
E_OS_CALLEVEL
Wrong call context of the API function (EXTENDED status)
E_OS_ACCESS
The calling application is not the owner of the ISR passed in ISRID (Service
Protection)
Functional Description
MICROSAR OS clears the interrupt pending flag by modifying the interrupt controller registers.
Particularities and Limitations
>  May be called for category 2 ISRs only
Table 5-146  API Service Os_ClearPendingInterrupt

Note
  In order to minimize the risk of spurious interrupts, Os_ClearPendingInterrupt shall be
called only after the ISR (IsrId) has been disabled and before it is enabled again.

Note
  The API service tries to clear the pending flag only. The interrupt cause has to be reset
by the application software. Otherwise the flag may be set again immediately after it
has been cleared by the API. This may be the case e.g. with level triggered ISRs.

© 2017 Vector Informatik GmbH
Version 2.12.0
277
based on template version 6.0.1

Technical Reference MICROSAR OS
5.2.6.4
Check Interrupt Source Enabled
Prototype
FUNC(StatusType, OS_CODE) Os_IsInterruptSourceEnabled(
  ISRType ISRID,
  P2VAR(boolean, AUTOMATIC, OS_VAR_NOINIT) IsEnabled
)
Parameter
ISRID
The ID of a category 2 ISR.
IsEnabled
Defines wether the source of the ISR is enabled (TRUE) or not (FALSE)
Return code
E_OK
No errors
E_OS_ID
ISRID is not a valid category 2 ISR identifier (EXTENDED status)
E_OS_CALLEVEL
Wrong call context of the API function (EXTENDED status)
E_OS_ACCESS
The calling application is not the owner of the ISR passed in ISRID (Service
Protection)
E_OS_PARAM_POINTER  Given pointer parameter (isEnabled) is NULL (EXTENDED status)
Functional Description
MICROSAR OS checks if the interrupt source is enabled reading the interrupt controller registers and
update the boolean addressed by IsEnabled accordingly
Particularities and Limitations
>  May be called for category 2 ISRs only
Table 5-147  API Service Os_IsInterruptSourceEnabled

© 2017 Vector Informatik GmbH
Version 2.12.0
278
based on template version 6.0.1

Technical Reference MICROSAR OS
5.2.6.5
Check Interrupt Pending
Prototype
FUNC(StatusType, OS_CODE) Os_IsInterruptPending(
  ISRType ISRID,
  P2VAR(boolean, AUTOMATIC, OS_VAR_NOINIT) IsPending
)
Parameter
ISRID
The ID of a category 2 ISR.
IsPending
Defines wether the ISR has been already
requesterd (TRUE) or not (FALSE)
Return code
E_OK
No errors
E_OS_ID
ISRID is not a valid category 2 ISR identifier
(EXTENDED status)
E_OS_CALLEVEL
Wrong call context of the API function
(EXTENDED status)
E_OS_ACCESS
The calling application is not the owner of the
ISR passed in ISRID (Service Protection)
E_OS_PARAM_POINTER
Given pointer parameter (isPending) is NULL
(EXTENDED status)
E_OS_SYS_UNIMPLEMENTED_FUNCTIONALITY Hardware does not support to check if there are
pending interrupts
Functional Description
MICROSAR OS checks if the ISR has been already requested,  reading the interrupt controller registers
and update the boolean addressed by IsPending accordingly
Particularities and Limitations
>  May be called for category 2 ISRs only
Table 5-148  API Service Os_IsInterruptPending

© 2017 Vector Informatik GmbH
Version 2.12.0
279
based on template version 6.0.1

Technical Reference MICROSAR OS
5.2.7
Detailed Error API
5.2.7.1
Get detailed Error
Prototype
FUNC(StatusType, OS_CODE) Os_GetDetailedError(
  Os_ErrorInformationRefType ErrorRef
)
Parameter
ErrorRef
Output parameter of type Os_ErrorInformationRefType
Return code
E_OK
No error.
E_OS_CALLEVEL
Called from invalid context. (EXTENDED status)
E_OS_PARAM_POINTER Given parameter pointer is NULL. (EXTENDED status)
Functional Description
Returns error information of the last error occurred on the local core.
Particularities and Limitations
>  The ErrorRef output parameter is a struct which holds the 8 bit AUTOSAR error code, the detailed error
code and the service ID of the causing API service.
Table 5-149  API Service Os_GetDetailedError

© 2017 Vector Informatik GmbH
Version 2.12.0
280
based on template version 6.0.1

Technical Reference MICROSAR OS
5.2.7.2
Unhandled Interrupt Requests
Prototype
FUNC(StatusType, OS_CODE) Os_GetUnhandledIrq(
  Os_InterruptSourceIdRefType InterruptSource
)
Parameter
InterruptSource
Output parameter of type Os_InterruptSourceIdRefType
Return code
E_OK
No error.
E_OS_CORE
Called from a non-AUTOSAR core (EXTENDED status)
E_OS_PARAM_POINTER Null pointer passed as argument (EXTENDED status)
E_OS_STATE
No unhandled interrupt reported since start up (EXTENDED status)
Functional Description
In case of an unhandled interrupt request the triggering interrupt source can be distinguished with this
service.
Particularities and Limitations
>  The return value of this function may be interpreted differently for different controller families.
Table 5-150  API Service Os_GetUnhandledIrq

© 2017 Vector Informatik GmbH
Version 2.12.0
281
based on template version 6.0.1

Technical Reference MICROSAR OS
5.2.7.3
Unhandled Exception Requests
Prototype
FUNC(StatusType, OS_CODE) Os_GetUnhandledExc(
  Os_ExceptionSourceIdRefType ExceptionSource
)
Parameter
ExceptionSource
Output parameter of type Os_ExceptionSourceIdRefType
Return code
E_OK
No error.
E_OS_CORE
Called from a non-AUTOSAR core (EXTENDED status)
E_OS_PARAM_POINTER Null pointer passed as argument (EXTENDED status)
E_OS_STATE
No unhandled exception reported since start up. (EXTENDED status)
Functional Description
In case of an unhandled exception request the triggering exception source can be distinguished with this
service.
Particularities and Limitations
>  The return value of this function may be interpreted differently for different controller families.
Table 5-151  API Service Os_GetUnhandledExc

© 2017 Vector Informatik GmbH
Version 2.12.0
282
based on template version 6.0.1

Technical Reference MICROSAR OS
5.2.8
Stack Usage API
All Service API functions which calculate stack usage are working in the same way.
>  The service performs error checks:
>  validity of passed parameters
>  existence of OS Hook routine (if hook stacks are queried)
>  cross core checks (when stack sizes are queried of stacks which are located on a
foreign core)
>  if one of these checks fails, the OS initiates error handling (ErrorHook() is called)
>  Calculates the maximum stack usage of the queried stack since call of StartOS()
>  Returns the stack usage in bytes
>  Stack Usage API services may be called from any context
>  Stack Usage API services may be used cross core
Stack usage service API Prototypes
Parameter
FUNC(uint32, OS_CODE) Os_GetTaskStackUsage (TaskType TaskID)
Task ID
FUNC(uint32, OS_CODE) Os_GetISRStackUsage (ISRType IsrID)
ISR ID
FUNC(uint32, OS_CODE) Os_GetKernelStackUsage (CoreIdType CoreID)
Core ID
FUNC(uint32, OS_CODE) Os_GetStartupHookStackUsage(CoreIdType CoreID)
Core ID
FUNC(uint32, OS_CODE) Os_GetErrorHookStackUsage (CoreIdType CoreID)
Core ID
FUNC(uint32, OS_CODE) Os_GetShutdownHookStackUsage(CoreIdType CoreID)
Core ID
FUNC(uint32, OS_CODE) Os_GetProtectionHookStackUsage(CoreIdType CoreID)
Core ID
Table 5-152  Overview: Stack Usage Functions

Caution
Any stack usage function must not be used cross core with interrupts disabled.

© 2017 Vector Informatik GmbH
Version 2.12.0
283
based on template version 6.0.1

Technical Reference MICROSAR OS
5.2.9
RTE Interrupt API
MICROSAR OS provides optimized interrupt en-/disable functions for exclusive usage by
the RTE module of Vector.

API Name
Alias (for backward
Comment
compatibility)
Os_DisableLevelAM()
osDisableLevelAM()
non nestable service to disable all category
2 interrupts callable from any mode
Os_DisableLevelKM()
osDisableLevelKM()
non nestable service to disable all category
2 interrupts callable from kernel mode
Os_DisableLevelUM()
osDisableLevelUM()
non nestable service to disable all category
2 interrupts callable from user mode
Os_EnableLevelAM()
osEnableLevelAM()
non nestable service to enable all category
2 interrupts callable from any mode
Os_EnableLevelKM()
osEnableLevelKM()
non nestable service to enable all category
2 interrupts callable from kernel mode
Os_EnableLevelUM()
osEnableLevelUM()
non nestable service to enable all category
2 interrupts callable from user mode
Os_DisableGlobalAM()  osDisableGlobalAM()
non nestable service to disable all interrupts
callable from any mode
Os_DisableGlobalKM()  osDisableGlobalKM()
non nestable service to disable all interrupts
callable from kernel mode
Os_DisableGlobalUM()  osDisableGlobalUM()
non nestable service to disable all interrupts
callable from user mode
Os_EnableGlobalAM()
osEnableGlobalAM()
non nestable service to enable all interrupts
callable from any mode
Os_EnableGlobalKM()
osEnableGlobalKM()
non nestable service to enable all interrupts
callable from kernel mode
Os_EnableGlobalUM()
osEnableGlobalUM()
non nestable service to enable all interrupts
callable from user mode

Caution
RTE interrupt handling functions should not be used by the application and are listed
  here to avoid naming collisions.

© 2017 Vector Informatik GmbH
Version 2.12.0
284
based on template version 6.0.1

Technical Reference MICROSAR OS
5.2.10  Time Conversion Macros
Based  on  counter  configuration  attributes  conversion  macros  are  generated  which  are
capable to convert from time into counter ticks and vice versa.
There are a set of conversion macros for each configured OS counter

Caution
The conversion macros embody multiplication operations which may lead to a data
  type overflow. The macros are not capable to detect these overflows

Caution
Although the results of the macros are mathematically rounded the result will still be an
  integer (e.g. results smaller than 0.5 are used as 0).

5.2.10.1  Convert from Time into Counter Ticks
OS_NS2TICKS_<Counter Name>(x)
x is given in nanoseconds
OS_US2TICKS_<Counter Name>(x)
x is given in microseconds
OS_MS2TICKS_<Counter Name>(x)
x is given in milliseconds
OS_SEC2TICKS_<Counter Name>(x)
x is given in seconds
Table 5-153  Conversion Macros from Time to Counter Ticks
5.2.10.2  Convert from Counter Ticks into Time
OS_TICKS2NS_<Counter Name>(x)
The result is in nanoseconds
OS_TICKS2US_<Counter Name>(x)
The result is in microseconds
OS_TICKS2MS_<Counter Name>(x)
The result is in milliseconds
OS_TICKS2SEC_<Counter Name>(x)
The result is in seconds
Table 5-154  Conversion Macros from Counter Ticks to Time

© 2017 Vector Informatik GmbH
Version 2.12.0
285
based on template version 6.0.1

Technical Reference MICROSAR OS
5.2.11  OS Initialization
Prototype
FUNC(void, OS_CODE) Os_Init(void)
Parameter
none
Return code
none
Functional Description
The function performs all the basic OS initialization which includes
>  Variable initialization
>  Interrupt controller initialization
>  System MPU initialization in SC3 and SC4 systems (if supported by platform)
>  Synchronization barriers in multi core systems
Particularities and Limitations
>  A function call to this service must be available on all available cores (even for cores which are intended
to be a non-AUTOSAR core)
>  After call of Os_Init() the AUTOSAR interrupt API may be used.
>  After Call of Os_Init() the API GetCoreID may be used.
>  Pre-Condition:
>  Os_Init may only be called if the interrupts are globally disabled.
>  Either disable the interrupts by using the global flag or, in case of Cortex M platform, disable
the interrupts by setting the highest possible interrupt level (BASEPRI register).
Table 5-155  API Service Os_Init

Prototype
FUNC(void, OS_CODE) Os_InitMemory(void)
Parameter
none
Return code
none
Functional Description
>  This is an API function which is provided within all BSWs of Vector. It initializes variables of the BSW.
Within the OS module this function is currently empty
Particularities and Limitations
>  This service must be called on all available cores (even for cores which are intended to be a non-
AUTOSAR core)
Table 5-156  API Service Os_InitMemory

© 2017 Vector Informatik GmbH
Version 2.12.0
286
based on template version 6.0.1

Technical Reference MICROSAR OS
5.2.12  Timing Hooks
Implementation of all timing hooks must conform to the following guidelines:
>  They are expected to be implemented as a macro.
>  Reentrancy is possible on multicore systems with different caller core IDs.
>  Calls of any operating system API functions are prohibited within the hooks.

Note
All hooks are called from within an OS API service. Interrupts are disabled

5.2.12.1  Timing Hooks for Activation
5.2.12.1.1  Task Activation
Macro
#define OS_VTH_ACTIVATION(TaskId, DestCoreId, CallerCoreId)
Parameter
TaskId
Identifier of the task which is activated
DestCoreId
Identifier of the core on which the task is activated
CallerCoreId
Identifier of the core which performs the activation (has called ActivateTask(), has
called ChainTask() or has performed an alarm/schedule table action to activate a
task)
Return code
none
Functional Description
This hook is called on the caller core when that core has successfully performed the activation of TaskId on
the destination core. On single core systems both core IDs are identical.
Particularities and Limitations
>  Due to internal implementation DestCoreId and CallerCoreId are always the same.

© 2017 Vector Informatik GmbH
Version 2.12.0
287
based on template version 6.0.1

Technical Reference MICROSAR OS
5.2.12.1.2  Task Activation Exeeding Limit
Macro
#define OS_VTH_ACTIVATION_LIMIT(TaskId, DestCoreId, CallerCoreId)
Parameter
TaskId
Identifier of the task which is activated
DestCoreId
Identifier of the core on which the task is activated
CallerCoreId
Identifier of the core which performs the activation (has called ActivateTask(), has
called ChainTask() or has performed an alarm/schedule table action to activate a
task)
Return code
none
Functional Description
This hook is called on the caller core when that core has failed the activation of TaskId on the destination
core because number of activations exceeds the limit.
Particularities and Limitations
>  Due to internal implementation DestCoreId and CallerCoreId are always the same.

5.2.12.1.3  Set Event
Macro
#define OS_VTH_SETEVENT(TaskId, EventMask, StateChanged,
DestCoreId, CallerCoreId)
Parameter
TaskId
Identifier of the task which receives this event
EventMask
A bit mask with the events which shall be set
StateChanged
TRUE: The task state has changed from WAITING to READY
FALSE: The task state hasn’t changed
DestCoreId
Identifier of the core on which the task receives the event
CallerCoreId
Identifier of the core which performs the event setting (has called SetEvent() or
performed an alarm/schedule table action to set an event)
Return code
none
Functional Description
This hook is called on the caller core when that core has successfully performed the event setting on the
destination core.
Particularities and Limitations
>  Due to internal implementation DestCoreId and CallerCoreId are always the same.

© 2017 Vector Informatik GmbH
Version 2.12.0
288
based on template version 6.0.1

Technical Reference MICROSAR OS
5.2.12.1.4 Wait Event Not Waiting
Macro
#define OS_VTH_WAITEVENT_NOWAIT(TaskId, EventMask, DestCoreId,
CallerCoreId)
Parameter
TaskId
Identifier of the task which is waiting for the event
EventMask
A bit mask with the events for which the task is waiting
DestCoreId
Identifier of the core on which the task is waiting for the event
CallerCoreId
Identifier of the core which performs the wait event (has called WaitEvent())
Return code
none
Functional Description
This hook is called on the caller core when that core has successfully performed the wait event call on the
destination core and the events waiting are already set and calling task stays in state RUNNING.
Particularities and Limitations
> Due to internal implementation DestCoreId and CallerCoreId are always the same.

© 2017 Vector Informatik GmbH
Version 2.12.0
289
based on template version 6.0.1

Technical Reference MICROSAR OS
5.2.12.1.5  Timing Hook for Context Switch
Macro
#define OS_VTH_SCHEDULE(FromThreadId, FromThreadReason,
ToThreadId, ToThreadReason, CallerCoreId)
Parameter
FromThreadId
Identifier of the thread (task, ISR) which has run on the caller core before the
switch took place
FromThreadReason  OS_VTHP_TASK_TERMINATION
>  The thread is a task, which has just been terminated.
OS_VTHP_ISR_END
>  The thread is an ISR, which has reached its end.
OS_VTHP_TASK_WAITEVENT
>  The thread is a task, which waits for an event.
OS_VTHP_TASK_WAITSEMA
>  The thread is a task, which waits for the release of a semaphore.
OS_VTHP_THREAD_PREEMPT
>  The thread is interrupted by another one, which has higher priority.
ToThreadId
The identifier of the thread, which runs from now on
ToThreadReason
OS_VTHP_TASK_ACTIVATION
>  The thread is a task, which was activated.
OS_VTHP_ISR_START
>  The thread is an ISR, which now starts execution.
OS_VTHP_TASK_SETEVENT
>  The thread is a task, which has just received an event it was
waiting for. It resumes execution right behind the call of
WaitEvent().
OS_VTHP_TASK_GOTSEMA
>  The thread is a task, which has just got the semaphore it was
waiting for.
OS_VTHP_THREAD_RESUME:
>  The thread is a task or ISR, which was preempted before and
becomes running again as all higher priority tasks and ISRs do not
run anymore.
CallerCoreId
Identifier of the core which performs the thread switch
Return code
none
Functional Description
This hook is called on the caller core when that core in case it performs a thread switch (from one task or
ISR to another task or ISR). On single core systems both core IDs are always identical.
Particularities and Limitations
>  None

© 2017 Vector Informatik GmbH
Version 2.12.0
290
based on template version 6.0.1

Technical Reference MICROSAR OS
5.2.12.2  Timing Hooks for Locking Purposes
5.2.12.2.1  Get Resource
Macro
#define OS_VTH_GOT_RES(ResId, CallerCoreId)
Parameter
ResId
Identifier of the resource which has been taken
CallerCoreId
Identifier of the core where GetResorce() was called
Return code
none
Functional Description
The OS calls this hook on a successful call of the API function GetResource(). The priority of the calling
task or ISR has been increased so that other tasks and ISRs on the same core may need to wait until they
can be executed.
Particularities and Limitations
>  none

5.2.12.2.2  Release Resource
Macro
#define OS_VTH_REL_RES(ResId, CallerCoreId)
Parameter
ResId
Identifier of the resource which has been released
CallerCoreId
Identifier of the core where ReleaseResorce() was called
Return code
None
Functional Description
The OS calls this hook on a successful call of the API function ReleaseResource(). The priority of the
calling task or ISR has been decreased so that other tasks and ISRs on the same core may become
running as a result.
Particularities and Limitations
>  none

© 2017 Vector Informatik GmbH
Version 2.12.0
291
based on template version 6.0.1

Technical Reference MICROSAR OS
5.2.12.2.3  Request Spinlock
Macro
#define OS_VTH_REQ_SPINLOCK(SpinlockId, CallerCoreId)
Parameter
SpinlockId
Identifier of the spinlock which has been requested
CallerCoreId
Identifier of the core where GetSpinlock() was called
Return code
none
Functional Description
The OS calls this hook on any attempt to get a spinlock. The calling task or ISR may end up in entering a
busy waiting loop. In such case other tasks or ISRs of lower priority have to wait until this task or ISR has
taken and released the spinlock.
Particularities and Limitations
>  The hook is not called for optimized spinlocks
>  The hook is called only on multicore operating system implementations

5.2.12.2.4  Request Internal Spinlock
Macro
#define OS_VTH_REQ_ISPINLOCK(SpinlockId, CallerCoreId)
Parameter
SpinlockId
Identifier of the spinlock which has been requested
CallerCoreId
Identifier of the core where the internal spinlock was requested
Return code
none
Functional Description
The OS calls this hook on any attempt to get a spinlock for the OS itself. The OS may end up in entering a
busy waiting loop. In such case other program parts on this core have to wait until the OS has taken and
released the spinlock.
Particularities and Limitations
>  Only called for Spinlocks which used internally by the OS

© 2017 Vector Informatik GmbH
Version 2.12.0
292
based on template version 6.0.1

Technical Reference MICROSAR OS
5.2.12.2.5  Get Spinlock
Macro
#define OS_VTH_GOT_SPINLOCK(SpinlockId, CallerCoreId)
Parameter
SpinlockId
Identifier of the spinlock which has been taken
CallerCoreId
Identifier of the core where GetSpinlock() or TryToGetSpinlock() were called
Return code
none
Functional Description
The OS calls this hook whenever a spinlock has successfully been taken.
If a previosly attempt of getting the spinlock was not successful immediately (entered busy waiting loop),
this hook means that the core leaves the busy waiting loop.
From now on no other thread may get the spinlock until the current task or ISR has released it.
Particularities and Limitations
>  The hook is not called for optimized spinlocks
>  The hook is called only on multicore operating system implementations

5.2.12.2.6  Get Internal Spinlock
Macro
#define OS_VTH_GOT_ISPINLOCK(SpinlockId, CallerCoreId)
Parameter
SpinlockId
Identifier of the spinlock which has been taken
CallerCoreId
Identifier of the core where the internal spinlock has been taken
Return code
None
Functional Description
The OS calls this hook whenever a spinlock has successfully been taken by the OS itself.
If a previosly attempt of getting the spinlock was not successful immediately (entered busy waiting loop),
this hook means that the core leaves the busy waiting loop.
From now on no other thread may get the spinlock until the OS has released it.
Particularities and Limitations
>  Only called for Spinlocks which used internally by the OS

© 2017 Vector Informatik GmbH
Version 2.12.0
293
based on template version 6.0.1

Technical Reference MICROSAR OS
5.2.12.2.7  Release Spinlock
Macro
#define OS_VTH_REL_SPINLOCK(SpinlockId, CallerCoreId)
Parameter
SpinlockId
Identifier of the spinlock which has been released
CallerCoreId
Identifier of the core where ReleaseSpinlock() was called
Return code
none
Functional Description
The OS calls this hook on a release of a spinlock. Other tasks and ISR may take the spinlock now.
Particularities and Limitations
>  The hook is not called for optimized spinlocks
>  The hook is called only on multicore operating system implementations

5.2.12.2.8  Release Internal Spinlock
Macro
#define OS_VTH_REL_ISPINLOCK(SpinlockId, CallerCoreId)
Parameter
SpinlockId
Identifier of the spinlock which has been released
CallerCoreId
Identifier of the core where the internal spinlock has been released
Return code
none
Functional Description
The OS calls this hook on a release of a spinlock. Other tasks and ISR may take the spinlock now.
Particularities and Limitations
>  Only called for Spinlocks which used internally by the OS

© 2017 Vector Informatik GmbH
Version 2.12.0
294
based on template version 6.0.1

Technical Reference MICROSAR OS
5.2.12.2.9 Disable Interrupts
Macro
#define OS_VTH_DISABLEDINT(IntLockId, CallerCoreId)
Parameter
IntLockId
OS_VTHP_CAT2INTERRUPTS:
Interrupts have been disabled by means of the current interrupt level. That
interrupt level has been changed in order to disable all category 2 interrupts,
which also prevents task switch and alarm/schedule table management.
OS_VTHP_ALLINTERRUPTS:
Interrupts have been disabled by means of the global interrupt enable/disable
flag. Additionally to the effects described above, also category 1 interrupts are
disabled.
CallerCoreId
Identifier of the core where interrupts are disabled
Return code
none
Functional Description
The OS calls this hook if the application has called an API function to disable interrupts.
The parameter IntLockId describes whether category 1 interrupts may still occur. Mind that the two types of
interrupt locking (as described by the IntLockId) are independent from each other so that the hook may be
called twice before the hook OS_VTH_ENABLEDINT is called, dependent on the application.
Particularities and Limitations
> The hook is not called for operating system internal interrupt locks

© 2017 Vector Informatik GmbH
Version 2.12.0
295
based on template version 6.0.1

Technical Reference MICROSAR OS
5.2.12.2.10 Enable Interrupts
Macro
#define OS_VTH_ENABLEDINT(IntLockId, CallerCoreId)
Parameter
IntLockId
OS_VTHP_CAT2INTERRUPTS
>  Interrupts had been disabled by means of the current interrupt level
until this hook was called. The OS releases this lock right after the
hook has returned.
OS_VTHP_ALLINTERRUPTS
>  Interrupts had been disabled by means of the global interrupt
enable/disable flag before this hook was called. The OS releases this
lock right after the hook has returned.
CallerCoreId
Identifier of the core where interrupts are disabled
Return code
None
Functional Description
The OS calls this hook if the application has called an API function to enable interrupts. Mind that the two
types of interrupt locking (as described by the IntLockId) are independent from each other so that interrupts
may still be disabled by means of the other locking type after this hook has returned.
Particularities and Limitations
>  The hook is not called for operating system internal interrupt locks

© 2017 Vector Informatik GmbH
Version 2.12.0
296
based on template version 6.0.1

Technical Reference MICROSAR OS
5.2.13  PanicHook
Prototype
FUNC(void, OS_PANICHOOK_CODE) Os_PanicHook(void)
Parameter
none
Return code
none
Functional Description
Called upon kernel panic mode.
Particularities and Limitations
>  Trusted access rights
>  Interrupts are disabled
>  No OS API service calls are allowed

© 2017 Vector Informatik GmbH
Version 2.12.0
297
based on template version 6.0.1

Technical Reference MICROSAR OS
5.2.14  Barriers
Prototype
FUNC(StatusType, OS_CODE) Os_BarrierSynchronize(
  Os_BarrierIdType BarrierID
)
Parameter
BarrierID
The barrier to which rhe task shall be synchronized.
Return code
E_OK
No error
E_OS_ID
Invalid BarrierID (EXTENDED status)
E_OS_CALLEVEL
Called from invalid context (EXTENDED status)
E_OS_SYS_NO_BARRIER_PARTICIPANT  >  The given barrier is not configured for the local core
(EXTENDED status)
>  Task is not configured to participate the barrier
(EXTENDED status)
Functional Description
Synchronize the calling task at the barrier given in "BarrierID".
The calling task is blocked until all other participating tasks call this API with the same "BarrierID".
Particularities and Limitations
>  none
Call context
>  Task
Table 5-157  Barriers

© 2017 Vector Informatik GmbH
Version 2.12.0
298
based on template version 6.0.1

Technical Reference MICROSAR OS
5.2.15  Exception Context Manipulation
5.2.15.1  Os_GetExceptionContext
Prototype
FUNC(StatusType, OS_CODE) Os_GetExceptionContext(
  Os_ExceptionContextRefType Context
)
Parameter
Context
Current exception context.
Return code
E_OK
No error
E_OS_PARAM_POINTER
given pointer is a NULL_PTR (EXTENDED status)
E_OS_CALLEVEL
Called from invalid context (EXTENDED status)
E_OS_SYS_UNIMPLEMENTED_FUNCTIONALITY  Context manipulation is not supported on this
hardware (EXTENDED status)
Functional Description
Getter function for the exception context.
Returns the context structure of the thread interrupted by an exception.
Particularities and Limitations
>  none
Call context
>  ProtectionHook
Table 5-158  Os_GetExceptionContext

© 2017 Vector Informatik GmbH
Version 2.12.0
299
based on template version 6.0.1

Technical Reference MICROSAR OS
5.2.15.2  Os_SetExceptionContext
Prototype
FUNC(StatusType, OS_CODE) Os_SetExceptionContext(
  Os_ExceptionContextRefType Context
)
Parameter
Context
Context to set.
Return code
E_OK
No error
E_OS_PARAM_POINTER
given pointer is a NULL_PTR (EXTENDED status)
E_OS_CALLEVEL
Called from invalid context (EXTENDED status)
E_OS_SYS_UNIMPLEMENTED_FUNCTIONALITY  Context manipulation is not supported on this
hardware (EXTENDED status)
Functional Description
Setter function for the exception context.
Writes the given context into the exception context structure.
Particularities and Limitations
>  none
Call context
>  ProtectionHook
Table 5-159  Os_SetExceptionContext

© 2017 Vector Informatik GmbH
Version 2.12.0
300
based on template version 6.0.1

Technical Reference MICROSAR OS
5.3
Calling Context Overview
The following table gives an overview about the valid context for MICROSAR OS
additional API service calls.

Calling Context
S

R
R
k
ok
k
O

S

k
I
SI
k
c
s

ok
ba
k
l
Hook
asT
c

1
2
Hoo
Hoo
l
art of
k
n Ho
on
t
bal
ory
ory
k
p Ho
w
it
art t
al

as
c
e S
k
g
g
as
do
r
or Hook
tT
t
m Ca
S
API Service
r
eT
ar
ote
e-
C c

as
r
r
os
tartu
hu
l
r
efo
r
T
Cate
Cate
E
P
P
S
S
A
P
B
P
IO
Peripheral Access APIs
X

X
X
X
X
X
X
X
X

X

Os_EnterPreStartTask

X

Os_CallNonTrustedFunction
X

X

X

Os_DisableInterruptSource
X

X

Os_EnableInterruptSource
X

X

Os_ClearPendingInterrupt
X

X

Os_GetDetailedError

X

Os_GetUnhandledIrq
X

X
X
X
X
X
X
X
X

Os_GetUnhandledExc
X

X
X
X
X
X
X
X
X

Stack Usage APIs
X

X
X
X
X
X
X
X
X

Time Conversion Macros
X

X
X
X
X
X
X
X
X

Os_Init

X

CheckISRMemoryAccess
X

X
X

X

CheckTaskMemoryAccess
X

X
X

X

CallTrustedFunction
X

X

X

Os_CallFastTrustedFunction
X

X

X

Os_BarrierSynchronize
X

Os_GetExceptionContext

X

Os_SetExceptionContext

X

Table 5-160 Calling Context Overview

© 2017 Vector Informatik GmbH
Version 2.12.0
301
based on template version 6.0.1

Technical Reference MICROSAR OS
6 Configuration
MICROSAR OS is configured with Vectors “DaVinci Configurator”.
The descriptions of all OS configuration attributes are described with tool tips within the
configuration tool.
They can easily be look up during configuration of the OS component.

Note
The configuration with OIL (OSEK implementation language) is not supported.

© 2017 Vector Informatik GmbH
Version 2.12.0
302
based on template version 6.0.1

Technical Reference MICROSAR OS
7 Glossary
Term
Description
Non-trusted function (NTF) A non-trusted function is a functional service provided by a non-
trusted OS application.
It runs in the non-privileged mode of the processor with restricted
memory rights.
Application
Any software parts that uses the OS. This may include other
software modules or customer software (don’t confuse this with the
OS-application object).
Pre-start task
An OS task which may run before StartOS has been called. Within
the pre-start task the usage of non-trusted functions is allowed.
OS-application
An OS object of type application.
Category 2 Lock Level
The priority of the highest category 2 ISR
Category 1 Lock Level
The priority of the highest category 1 ISR
TP Lock Level
The priority the timing protection interrupt
X-Signal
MICROSAR OS mechanism which realizes cross core service APIs.
Kernel Panic
An inconsistent state of the OS results in kernel panic mode. The
OS does not know how to proceed correctly. It goes into freeze as
fast as possible (interrupts are disabled, the panic hook is called
and afterwards an endless loop is entered).
Thread
Umbrella Term for OS Task, OS hooks and OS ISR objects

© 2017 Vector Informatik GmbH
Version 2.12.0
303
based on template version 6.0.1

Technical Reference MICROSAR OS
8  Contact
Visit our website for more information on

>  News
>  Products
>  Demo software
>  Support
>  Training data
>  Addresses

www.vector.com
© 2017 Vector Informatik GmbH
Version 2.12.0
304
based on template version 6.0.1

Document Outline

Last modified October 12, 2025: Initial commit (af72ad2)