BSW Multicore Library (Bmc)

Atomically sets the value pointed to by Object to true.

Atomically sets the value pointed to by Object to false.

Atomically loads the value pointed to by Object and returns it.

Atomically replaces the value pointed to by Object with the value of Desired.

Atomically replaces the value pointed to by Object with the value of Desired and returns the value pointed to by Object immediately before the effects.

Atomically compares the value pointed to by Object for equality with that in Expected, and if true, replaces the value pointed to by Object with Desired, and if false, updates the value in Expected with the value pointed to by Object.

Atomically replaces the value pointed to by Object with the result of the addition applied to the value pointed to by Object and the given Operand.

Atomically replaces the value pointed to by Object with the result of the subtraction applied to the value pointed to by Object and the given Operand.

Atomically replaces the value pointed to by Object with the result of the or-operation applied to the value pointed to by Object and the given Operand.

Atomically replaces the value pointed to by Object with the result of the xor-operation applied to the value pointed to by Object and the given Operand.

Atomically replaces the value pointed to by Object with the result of the and-operation applied to the value pointed to by Object and the given Operand.

Creates a sequentially consistent acquire and release fence. An acquire and release fence instruction prevents the memory reordering of any read or write which precedes it in program order with any read or write which follows it in program order.

Returns the version information of this library.

Atomically loads the value pointed to by Object and returns it.

Atomically loads the value pointed to by Object and returns it.

Atomically replaces the value pointed to by Object with the value of Desired.

Atomically replaces the value pointed to by Object with the value of Desired.

Atomically compares the value pointed to by Object for equality with that in Expected, and if true, replaces the value pointed to by Object with Desired, and if false, updates the value in Expected with the value pointed to by Object.

Atomically compares the value pointed to by Object for equality with that in Expected, and if true, replaces the value pointed to by Object with Desired, and if false, updates the value in Expected with the value pointed to by Object.

Atomically replaces the value pointed to by Object with the value of Desired and returns the value pointed to by Object immediately before the effects.

Atomically replaces the value pointed to by Object with the value of Desired and returns the value pointed to by Object immediately before the effects.

Atomically replaces the value pointed to by Object with the result of the addition applied to the value pointed to by Object and the given Operand.

Atomically replaces the value pointed to by Object with the result of the addition applied to the value pointed to by Object and the given Operand.

Atomically replaces the value pointed to by Object with the result of the and-operation applied to the value pointed to by Object and the given Operand.

Atomically replaces the value pointed to by Object with the result of the and-operation applied to the value pointed to by Object and the given Operand.

Atomically replaces the value pointed to by Object with the result of the or-operation applied to the value pointed to by Object and the given Operand.

Atomically replaces the value pointed to by Object with the result of the or-operation applied to the value pointed to by Object and the given Operand.

Atomically replaces the value pointed to by Object with the result of the subtraction applied to the value pointed to by Object and the given Operand.

Atomically replaces the value pointed to by Object with the result of the subtraction applied to the value pointed to by Object and the given Operand.

Atomically replaces the value pointed to by Object with the result of the xor-operation applied to the value pointed to by Object and the given Operand.

Atomically replaces the value pointed to by Object with the result of the xor-operation applied to the value pointed to by Object and the given Operand.

The type shall be used for all unsigned data items, which are used for Bmc library functions.

The type shall be used for all signed data items, which are used for Bmc library functions.

The type shall be used for all Flag data items, which are used for Bmc library functions.

The Bmc module shall provide the following files: C files Bmc_<name>.c used to implement the library. All C files shall be pre-fixed with 'Bmc_'. The header file Bmc.h provides all public function prototypes and types defined by the Bmc library specification.

DRAFT No error classification definition – like DET error IDs – shall be supported by library.

DRAFT Error detection: Functions should check at runtime (both in production and in development code) the value of input parameters, especially cases where erroneous value can bring to fatal error or unpredictable result, if they have the values allowed by the function specification. All the error cases shall be listed in SWS and the function should return a specified value (in SWS) that is not configurable. This value is dependent of the function and the error case so it is determined case by case. If values passed to the library routines are not in valid range, out of boundary condition and out of the function specification, then such errors are not detected in the library routines.

DRAFT The functions shall not call the DET for error notifica- tion.

The Bmc library shall not require an initialization phase. A Li- brary function may be called at the very first step of ECU initialization, e.g. even by the OS or EcuM, thus the library shall be ready.

The Bmc library shall not require a shutdown operation phase.

The Bmc API can be directly called from BSW modules or SWCs. No port definition is required. It is a pure function call.

Using a library should be documented. If a BSW module or a SWC uses a library, the developer should add an ImplementationDependencyOnArti- fact in the BSW/SWC template. minVersion and maxVersion parameters correspond to the supplier version. In case of an AUTOSAR library, these parameters may be left empty because a SWC or BSW module may rely on a library behavior, not on a sup- plier implementation. However, the SWC or BSW modules shall be compatible with the AUTOSAR platform where they are integrated.

The Bmc library shall be implemented in a way that the code can be shared among callers in different memory partitions.

Usage of macros should be avoided. The functions should be declared as functions or inline functions.

A library function shall not call any BSW modules functions, e.g. the DET. A library function can call other library functions because a library function shall be re-entrant. But other BSW modules functions may not be re-entrant.

The library, written in the C programming language, should con- form to the MISRA C Standard. Please refer to SWS_BSW_00115 for more details.

Each AUTOSAR library Module implementation <library> * .c and <library> * .h shall map their code to memory sections using the AUTOSAR memory mapping mechanism.

Each AUTOSAR library Module implementation <library> * .c that uses AUTOSAR integer data types and/or the standard return type, shall include the header file Std_Types.h .

All AUTOSAR library Modules should use the AUTOSAR data types (integers, boolean) instead of native C data types unless this library is clearly identified to be compliant only with one platform.

All AUTOSAR library Modules should avoid direct use of com- piler and platform specific keywords unless this library is clearly identified to be com- pliant only with one platform.

The Bmc module shall provide the C macros ATOMIC_<TYPEMN>_LOCK_FREE which shall expand to constant expressions suit- able for use in #if preprocessing directives and which indicate the lock-free property of the corresponding atomic types. The implemented macros are listed in Table 8.3.

The function Bmc_FlagTestAndSet atomically sets the value pointed to by Object to TRUE . It returns this value before the operation, i.e., TRUE , if it was already set and FALSE otherwise.

The function Bmc_FlagClear atomically sets the value pointed to by Object to FALSE .

The Bmc_Load_<TypeMn> functions atomically load the value pointed to by Object and return it. The implemented functions are listed in Table 8.4.

The Bmc_Store_<TypeMn> functions atomically replace the value pointed to by Object with the value of Desired. The implemented functions are listed in Table 8.5.

The Bmc_Exchange_<TypeMn> functions atomically replace the value pointed to by Object with the value of Desired and return the value pointed to by Object immediately before the effects. The implemented functions are listed in Table 8.6.

The Bmc_CompareExchange_<TypeMn> functions atomically compare the value pointed to by Object for equality with that in Expected, and if true, replace the value pointed to by Object with Desired, and if false, update the value in Expected with the value pointed to by Object. The implemented functions are listed in Table 8.7.

The Bmc_FetchAdd_<TypeMn> functions atomically replace the value pointed to by Object with the result of the addition applied to the value pointed to by Object and the given Operand and return the value pointed to by Object immedi- ately before the effects. The implemented functions are listed in Table 8.8.

The Bmc_FetchSub_<TypeMn> functions atomically replace the value pointed to by Object with the result of the subtraction applied to the value pointed to by Object and the given Operand and return the value pointed to by Object immediately before the effects. The implemented functions are listed in Table 8.9.

The Bmc_FetchOr_<TypeMn> functions atomically replace the value pointed to by Object with the result of the or-operation applied to the value pointed to by Object and the given Operand and return the value pointed to by Object immedi- ately before the effects. The implemented functions are listed in Table 8.10.

The Bmc_FetchXor_<TypeMn> functions atomically replace the value pointed to by Object with the result of the xor-operation applied to the value pointed to by Object and the given Operand and return the value pointed to by Object immediately before the effects. The implemented functions are listed in Table 8.11.

The Bmc_FetchAnd_<TypeMn> functions atomically replace the value pointed to by Object with the result of the and-operation applied to the value pointed to by Object and the given Operand and return the value pointed to by Object immediately before the effects. The implemented functions are listed in Table 8.12.

The function Bmc_ThreadFence creates a sequentially consis- tent acquire and release fence.

If source code for caller and callee of Bmc_GetVersionInfo is available, the Bmc library should realize Bmc_GetVersionInfo as a macro defined in the module's header file.

The standardized common published parameters as required by SRS_BSW_00402 in the General Requirements on Basic Software Modules [3] shall be published within the header file of this module and need to be provided in the BSW Module Description. The according module abbreviation can be found in the List of Basic Software Modules

The Bmc library shall not have any configuration options that may affect the functional behavior of the routines. I.e. for a given set of input parame- ters, the outputs shall be always the same. For example, the returned value in case of error shall not be configurable.

All load and store routines shall implicitly make use of the feature explicitly introduced by Bmc_ThreadFence .

All fetch routines shall implicitly make use of the feature explicitly introduced by Bmc_ThreadFence .

These requirements are not applicable to this specification.