This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

FlexRay Interface

1: AN-ISC-8-1140_FrIf_JobListConfiguration
2: AN-ISC-8-1140_FrIf_JobListConfiguration_ind
3: AN-ISC-8-1140_FrIf_JobListConfigurations
4: FrIf Peer Review Checklists
5: TechnicalReference_FrIf
6: TechnicalReference_FrIf_ind
7: TechnicalReference_FrIfs

FlexRay Interface

Component Documentation

1 - AN-ISC-8-1140_FrIf_JobListConfiguration

JobList Configuration of FlexRay Interface

2 - AN-ISC-8-1140_FrIf_JobListConfiguration_ind

Outline
Page 1
Page 2
Page 3
Page 4
Page 5
Page 6
Page 7
Page 8
Page 9
Page 10

3 - AN-ISC-8-1140_FrIf_JobListConfigurations

JobList Configuration of FlexRay Interface

According the AUTOSAR SWS the FlexRay Interface supports the following communication operations that can be
performed for each receive or transmit buffer:
•  Decoupled Transmission
•  Receive and Indicate
•  Tx Confirmation

1.2  Job List Configuration
As the FRIF Job List configuration is difficult and error-prone, GENy offers the possibility to calculate the
scheduling of the communication operations. The FlexRay Interface supports the following configuration
mechanisms (SchedulingAlgorithms) in GENy:
•  Default
•  Concatenated Jobs
•  User Defined
1.2.1  Scheduling Algorithm – Default
The default scheduling algorithm divides the FlexRay cycle into x segments of the same size, where x is the
number of Tx or Rx jobs. Depending on the start slot and end slot of these segments the start time of the
corresponding task and the maximum ISR delay is automatically calculated.
Example:
For a cycle with a length of 5000 macro ticks which is divided into a static segment of 3000 macro ticks length and
a dynamic segment of 2000 macro ticks length, the following segments (Segment 0 and Segment 1 in Figure 1)
arise:

Figure 1 – Default Scheduling Algorithm

Note:
A TxConf job is needed if a Tx job performs the decoupled transmission for a FlexRay frame with
at least one PDU that shall be confirmed to the upper layer component. The Default Scheduling
Algorithm takes the first job after the last slot of the Tx job as TxConf job.

In the example above Rx1 is the TxConf job for Tx1 (because it is the first job after Segment 0) and
Rx0 is the TxConf job for Tx0 (because it is the first Job after Segment 1).

2
Application Note AN-ISC-8-1140

JobList Configuration of FlexRay Interface

1.2.2  Scheduling Algorithm – Concatenated Jobs
In contrast to the default algorithm the Concatenated Jobs algorithm configures the start time of an Rx and the
following Tx FRIF job to the same macrotick parameter and enables the Job Concatenation Enable option. As one
timer interrupt is used to activate an Rx and Tx FRIF job, this algorithm can be used to reduce the interrupt load of
the FlexRay Interface.

Figure 2 – Concatenated Jobs Scheduling Algorithm

Note:
Due to the job concatenation it is not possible to achieve both shortest possible indication times
after reception and latest data for transmission.

For example in the picture above the concatenated jobs Rx0 and Tx0 can either be placed at the
beginning of the cycle with the consequence that the data indications for frames in Segment 1 will
be given to the upper layer components as soon as possible. Or Rx0 and Tx0 can be placed just
before the start of Segment 1 to reduce the age of the transmitted data.

1.2.3  Scheduling Algorithm – User Defined
Beside the automated job placement GENy offers the possibility to configure the following job parameters
manually:
•  Start Slot and End Slot (or assignment of single frames to a Job)
•  Macrotick
•  Maximum permissible ISR delay
•  TxConf Job

1.3  Synchronisation of BSW main functions
For deterministic communication behaviour on FlexRay it is necessary to synchronize the main function of FlexRay
relevant BSW modules to the global time of the FlexRay CC. If the main functions are not synchronized it is
possible that obsolete data is received or updated PDUs are not transmitted during the FlexRay cycle.

For example if an application task shall receive PDU data at the beginning of the FlexRay cycle and the response
should be transmitted at the end of the same cycle, it is necessary that this ApplTask is scheduled between the Rx
receive slot and the Tx transmit slot. If the task is not synchronised and the task drift causes the application to
transmit PDU data after the FlexRay slot is expired, the PDU will be transmitted in the next cycle as shown in
Figure 3.

3
Application Note AN-ISC-8-1140

JobList Configuration of FlexRay Interface

Figure 3 – Unsynchronized application behaviour on FlexRay

There are several ways to synchronize BSW modules to the FlexRay global time:
1.  Using synchronized schedule tables of the AUTOSAR OS
2.  Cancel and set relative alarms in the FlexRay timer or cycle start ISR (like the MICROSAR SCHM does)
3.  Calling the BSW main function directly in the context of the FlexRay timer or cycle start ISR

Note:
Calling the BSW main function only in the context of the FlexRay timer or cycle start ISR has the
disadvantage that the main function won’t be called if the FlexRay bus loses synchronization.
2.0  Configuration aspects
For optimal BSW behaviour some configuration aspects shall be considered by the integrator as described in this
section. Using the example of FRTP this chapter explains the details of:
•  FRIF job placement and configuration
•  Main function placement
•  FRIF PDU settings
•  Task priorities and interruptibilities
•  Duration of critical sections or resource locks
•  SystemTimer tick time

Note:
These settings are also relevant for non-FRTP modules like COM, PDUR, FRNM and FRXCP

Note:
Some FRNM specific details are also provided where applicable.
In the following example the FRTP PDUs are all transmitted and received during the dynamic segment of the
FlexRay cycle as depicted below. The corresponding frames have a cycle repetition 1 (meaning that they could be
sent every cycle).

Note:
With AUTOSAR 3.2.2 FRTP only the last Tx PDU of a PDU pool is confirmed by the FlexRay
Interface to reduce the CPU and interrupt load.

4
Application Note AN-ISC-8-1140

JobList Configuration of FlexRay Interface

2.1  PDUs with decoupled transmission
If FRTP PDUs are configured to use decoupled transmission, the transmission rate of the FlexRay Transport Layer
strongly depends on the positioning of the FRTP main function and the Rx, Tx and TxConf FRIFJobs of the FRTP
frames.
Note:
If the FRTP PDUs are sent with immediate transmission (the message buffers are written in the
context of the FRTP main function) only the start times of the Rx and TxConf jobs are relevant for
the placement of the FRTP main function.
2.1.1  Optimal BSW main function placement
2.1.1.1  FRTP Main Function placement
To achieve optimal throughput for segmented TP transmission it is recommended to place the SCHM Task which
executes the FRTP main function between the Rx and the Tx FRIFJob of the TP frames. The Rx FRIFJob should
handle the TxConfirmation as depicted in Figure 4.
In this scenario the TP Tx PDUs in the dynamic segment are sent in cycle n and in the following cycle these PDUs
are confirmed and the FRTP Rx PDUs (i.e. flow control or tester response) are received. Hence the first
consecutive frame is sent in the next cycle after the flow control and each consecutive frame is sent every cycle
(according the cycle repetition in ECUC database).

Figure 4 – FRTP Scenario 1 – optimal FrTp main function placement for TP frames in the dynamic segment

Note:
The FRTP main function must be called at least once per FlexRay cycle (between two Rx job
activations that handle the FRTP PDUs). Otherwise data loss is imminent.
2.1.1.2  FRNM Main Function placement
For the moment when the FRNM main function shall be executed, the SCHM task that calls the FRNM main
function should be placed between the Rx FRIF job that receives the last NM vote and the first Tx FRIF job that
sends one of the FRNM Tx PDUs. This can be seen in Figure 5.

5
Application Note AN-ISC-8-1140

JobList Configuration of FlexRay Interface

A
B
A
Point in time where all NM PDUs
Frame without NM PDU
are available
FrNm Task
activation window
B
Point in time where the own NM
Frame with other NM PDU (Rx)
PDU must be provided
FrNM Task
Frame with own NM PDU (Tx)
FrIf Rx
FrIf Tx
Time
Time
FlexRay Cycle N
FlexRay Cycle N + 1

Figure 5 – FRNM Main Function – Window for task activation

The FRNM Task function should always be executed either at the beginning of a FlexRay Cycle or at the end of a
FlexRay cycle. If it shall be executed at the beginning of a FlexRay Cycle, the configuration parameter ‘Main
Across Fr Cycle’ needs to be TRUE, otherwise FALSE. Note that this parameter is usually defined by the OEM.
It is necessary that all NM Vote and Data PDUs have been received until the FRNM main function is called
(Moment A in the figure). It is also necessary that the FRNM main function has finished execution before the
Moment B in the figure where the FRIF TX Job is started. At this point of time, the data of the TX NM PDUs needs
to be provided to the FRIF.
Note:
If the NM PDUs are in the dynamic segment (e.g. ‘Pdu Schedule Variant’ is 2) but not at the
beginning of the dynamic segment the corresponding FRIF job is always scheduled in the next FR
cycle. This means in this case the ‘Main Across Fr Cycle’ must be set to TRUE.

If ‘Main Across Fr Cycle’ is set to FALSE, the FRNM PDUs must be at the beginning of the
dynamic segment. In this case an additional Rx job is necessary where the ‘End Slot’ attribute of is
set to the slot ID of the last FRNM frame. The start time of this Rx Job in ‘Macrotick’ should be
scheduled after the last FRNM frame and before the FRNM main function in the same cycle.
Note that it is difficult to determine Moment A in the figure, because it depends on the worst-case execution time
(WCET) of the Rx Job that processes the last NM PDU. This Rx Job can be identified in GENy using the ‘Is Last
FrIf Rx Task for Nm’ attribute. This WCET should be measured by the integrator because the jobs runtime is
affected by the application behaviour in the RX Indication functions.
The latest point in time for Moment A in the figure starting from the beginning of a FlexRay Cycle boundary can be
determined by the following settings of the FRIF RX Job j that processes the last NM PDU in one FlexRay Cycle:
Macrotick(j) + Max Isr Delay(j) + tWCET(j)
where tWCET(j) denotes the worst-Case execution time of the FrIf_JobListExec_0() routine.
Note:
The FRNM Main Function has to be called once in each FlexRay cycle.
In the dual channel use case for ‘Sync PDU Wake-up Master’ nodes, the send requests of the FRNM Sync PDUs1
are also issued by the FRNM Main Function. These send requests, if required, are issued in a certain cycle of each
FRNM Voting Cycle called the ‘Sync Pdu Tx Request Cycle Offset’.
The following constraints have to be considered for ‘Sync PDU Wake-up Master’ nodes about the configuration:

1 This feature is OEM-specific and may not be available and/or relevant in your delivery

6
Application Note AN-ISC-8-1140

JobList Configuration of FlexRay Interface

•  In each ‘Sync Pdu Tx Request Cycle Offset’ cycle, all FRNM PDUs of other nodes in the current Voting
Cycle have been received after the Rx Job List has been executed and before the FRNM Main Function
has been executed.
•  The ‘Sync Pdu Tx Request Cycle Offset’ needs to be configured to a cycle offset in the Voting Cycle, so
that the transmission request of the NM Sync PDUs can be issued in that cycle in order to send the NM
Sync PDUs in the same Voting Cycle.
These constraints are illustrated by an example in Figure 6.
sd Scheduling in Detail
Moment for the decision to send the NM
he N  Sync PDUs
X
tion_
Running
ainFunc
_M
m
Idle
m
N
Fr
ists
Tx Job List
ists
Tx Job Li
obl
Rx Job List
If J
Fr
None
lots
Nm Sync
lots
Nm S
M S
Nm
M S
N
None
ent
Static
Dynamic
Static
Dynamic
Static
egm
S
e
ycl
Cycle 6 (D
e 6 ( ecision Cycle)
Cycle 7
Cycle 0
C
New Voting Cy
ng C cle

Figure 6 – FRNM Scheduling for Sync PDU Wake-up Master node

As it can be seen, two FlexRay cycles are shown in the example. These FRNM configuration parameters apply
here: ‘Voting Cycle’ = ‘Data Cycle’ = 8, ‘Main Across Fr Cycle’ = FALSE, ‘Sync Pdu Tx Request Cycle Offset’ = 6.
After NM PDUs may have been sent/received in the beginning of the Dynamic Segment in Cycle 6 and the RX Job
for FRNM PDUs in the FrIf RX Joblist has been executed, the FrNm_MainFunction_X may be executed and within
this context, the transmit request for the NM Sync PDUs may be issued. It has to be assured that execution of the
FRNM Main Function has been finished before the cycle end (because of ‘Main Across Fr Cycle’ = FALSE).

7
Application Note AN-ISC-8-1140

JobList Configuration of FlexRay Interface

Afterwards the FrIf TX Joblist may be processed in the next FlexRay Cycle and the Transmission of the NM Sync
PDUs may take place at the beginning of the Dynamic Segment in Cycle 7.
In this example it must be ensured that all NM RX PDUs from Cycle 0 to 6 have been received and processed by
FRNM when the ‘Moment for the decision to send the NM Sync PDUs’ arrives. Because the send request for the
NM Sync PDUs is issued at the end of Cycle 6 FrIf can transmit them in the next cycle.
For details about the FRNM Main Function usage and details about the ‘Sync PDU Wake-up Master’ also refer to
the ‘AUTOSAR FlexRay Network Management Technical Reference’ document.
2.1.2 Wrong FRIFJob configurations
For optimal FRTP throughput the integrator should ensure that task preemption by a high prior interrupt and/or jitter
of the SCHM task does not cause the FRTP main function to be called after the Tx job or before the Rx job as
shown in Figure 7.
The jitter of the SCHM task is affected by non-preemptive tasks (even if they have lower priority), long duration of
critical sections with locked interrupts/resources or large OS SystemTimer tick times. If the jitter or the preemption
cannot be avoided it is recommended to draw the FRIFJobs manually apart.

Figure 7 – FRTP Scenario 2 suboptimal FRTP main function placement caused large task jitter or preemption

Note:
It is not possible to achieve optimal FRTP transmission rates with the scheduling algorithm
Concatenated Jobs because the FRTP main function cannot be placed between the Rx and Tx job
as depicted in Figure 8.

Figure 8 – FRTP Scenario 3 suboptimal TP (decoupled) transmission rates due to job concatenation

8
Application Note AN-ISC-8-1140

JobList Configuration of FlexRay Interface

For example if additionally Rx Job 1 in Figure 9 is configured to handle the Tx confirmations for Tx0 FRIFJob the
consecutive frames of a segmented TP transfer will only be send every second FRTP main function cycle because
the Tx confirmations for the TP frames in the dynamic segment are given in cycle n+1 and not in the same cycle of
the FRTP main function. The reason is that in this case the TxConf job polls the transmission state before the
FlexRay slot has been transmitted by the communication controller.

Figure 9 – FRTP Scenario 4 suboptimal TxConf job configuration
Please ensure that the TxConf job for FRTP PDUs is not scheduled after the Rx job of the FRTP PDUs as depicted
in Figure . Otherwise it is possible that during segmented transmission the FRTP state machine handles the
reception of a flow control frame before the first frames is confirmed and the transmission of the consecutive
frames is delayed. Hence the FRTP transmission rates and OBD response times are affected negatively.

Figure 10 – FRTP Scenario 4.1 TxConf Task before Rx Task

Note:
If a Rx job handles the Tx confirmation for a Tx job the FlexRay Interface component ensures that
the confirmations will be handled before the Rx indications are given to the upper layer
components.
2.2  PDUs with immediate transmission
If FRTP PDUs are configured to use immediate transmission, the transmission rate of the FlexRay Transport Layer
only depends on the positioning of the FRTP main function and the Rx and TxConf FRIFJobs of the FRTP frames.
The position of the Tx FRIFJob does not matter  because the message buffers are written in the context of the
FRTP main function. For example in Figure 11 the FRTP PDUs in the dynamic segment will be transmitted in the
same cycle as long as the FRTP main function is called before the FlexRay frames are sent on the bus.

9
Application Note AN-ISC-8-1140

JobList Configuration of FlexRay Interface

Figure 11 – FRTP Scenario 5 Tx FRIF jobs don’t matter for PDUs with immediate transmission

Note:
FRIF PDUs can only be configured for immediate transmission if the PDU is the only one within the
FlexRay frame. Frames with more than one FRIF PDU always use decoupled transmission.

3.0 Contacts
For a full list with all Vector locations and addresses worldwide, please visit http://vector.com/contact/.

10
Application Note AN-ISC-8-1140

Document Outline

4 - FrIf Peer Review Checklists

Overview

Summary Sheet
Synergy Project
3rd Party Files

Sheet 1: Summary Sheet

Rev 1.0

19-Apr-17

Peer Review Summary Sheet

Synergy Project Name:

Windows User: Intended Use: Identify which component is being reviewed. This should match the component short name and the middle part of the Synergy project name FrIf

Revision / Baseline:

Windows User: Intended Use: Identify the implementation baseline name intended to be used for the changed component when changes are approved. FrIf_Vector_Ar4.0.3_05.01.02_0

Change Owner:

Windows User: Intended Use: Identify the developer who made the change(s) being reviewed Akilan

Work CR ID:

Windows User: Intended Use: Identify the Implementation Work CR whose work is being reviewed (may be more than one) EA4#20936

3rd party delivery package identifier:

Intended Use: This is a reference to the identifier of the 3rd party delivery package(s) that the component was extracted/created from. Rationale: This will allow easier tracing back to 3rd party deliveries. Vector MICROSAR SIP CBD1700369 D04 Rh850

Windows User: Identifiy which type of 3rd party component this is so as to provide appropriate review checklist sheets Component Type:

Windows User: General section for summarizing review comments or review notes. Review Checklist Summary:

Comments:

Sheet 2: Synergy Project

Peer Review Meeting Log (Component Synergy Project Review)

Quality Check Items:

Rationale is required for all answers of No

New baseline version name from Summary Sheet follows

Yes

Comments:

naming convention for 3rd Party Software Components

Project contains necessary subprojects

N/A

Comments:

There are no subprojects

Project contains the correct version of subprojects

N/A

Comments:

There are no subprojects

General Notes / Comments:

LN: Intended Use: Identify who were the reviewers and if the reviewed changes have been approved. Rationale: Since this Form will be attached to the Change Request it will confirm the approval and provides feedback in case of audits. KMC: Group Review Level removed in Rev 4.0 since the design review is not checked in until approved, so it would always be DR4. Review Board:

Change Owner:

Akilan

Review Date :

02/27/18

Lead Peer Reviewer:

Rijvi

Approved by Reviewer(s):

Yes

Other Reviewer(s):

Sheet 3: 3rd Party Files

Peer Review Meeting Log (3rd Party File Review)

Quality Check Items:

Rationale is required for all answers of No

(e.g. component_bswmd.arxml) Component "autosar" folder contains autosar module description file from 3rd party delivery package

Yes

Comments:

(e.g. component_preo.arxml) Component "autosar" folder contains any relevant preconfiguration files from 3rd party delivery package(s)

Yes

Comments:

If needed as in the case with Renesas MCAL (e.g. MCALcomponent_bswmd_rec.arxml taken from Vector delivery) Component "autosar" folder contains any needed supplemental autosar module description file(s)

N/A

Comments:

Component "doc" folder contains all documentation related to this component from 3rd party delivery package

Yes

Comments:

Modifications from delivery to be reviewed (e.g. path changes) Component "generate" folder contains all external generation files from 3rd party delivery package

N/A

Comments:

Component "include" and "src" folder contains exact component files from 3rd party delivery package

Yes

Comments:

Component "make" folder contains any makefiles included from 3rd party delivery package

Yes

Comments:

1) All source and headers of component should be referenced in .gpj 2) Compiler settings may need to be tailored to source component (e.g. Renesas MCAL vs Vector BSWs) Component "tools" folder contains GHS project file with appropriate files referenced with appropriate compiler settings

Yes

Comments:

Should delete old existing files/directories from integration project and copy new ones into integration project May also contain logic for integrator user interaction if required. (e.g. selection of micro variant on MCAL) Component "tools" folder contains Integrate.bat with appropriate logic in it for integration into project

Yes

Comments:

For external generation and internal behavior definition for use with Vector Davinci tools. Typically only desired/needed for non-Vector developed components. This file should be copied as part of Integrate.bat. Components optionally contains settings xml file with appropriate contents

N/A

Comments:

General Notes / Comments:

Change Owner:

Akilan

Review Date :

02/27/18

Lead Peer Reviewer:

Rijvi

Approved by Reviewer(s):

Yes

Other Reviewer(s):

5 - TechnicalReference_FrIf

MICROSAR FlexRay Interface

6 - TechnicalReference_FrIf_ind

Outline
Page 1
Page 2
Page 3
Page 4
Page 5
Page 6
Page 7
Page 8
Page 9
Page 10
Page 11
Page 12
Page 13
Page 14
Page 15
Page 16
Page 17
Page 18
Page 19
Page 20
Page 21
Page 22
Page 23
Page 24
Page 25
Page 26
Page 27
Page 28
Page 29
Page 30
Page 31
Page 32
Page 33
Page 34
Page 35
Page 36
Page 37
Page 38
Page 39
Page 40
Page 41
Page 42
Page 43
Page 44
Page 45
Page 46
Page 47
Page 48
Page 49
Page 50
Page 51
Page 52
Page 53
Page 54
Page 55
Page 56
Page 57
Page 58
Page 59
Page 60
Page 61
Page 62
Page 63
Page 64
Page 65
Page 66
Page 67
Page 68
Page 69
Page 70
Page 71
Page 72
Page 73
Page 74
Page 75
Page 76
Page 77
Page 78
Page 79
Page 80
Page 81

7 - TechnicalReference_FrIfs

MICROSAR FlexRay Interface
Technical Reference

Version 4.01.00

Authors
Oliver Reineke, Anthony Thomas
Status
Released

Technical Reference MICROSAR FlexRay Interface
Document Information
History
Author
Date
Version
Remarks
Anthony Thomas
2016-04-24
4.00.00
First SafeBSW release.
Anthony Thomas
2016-07-13
4.00.01
Added deviation related to the job list
resynchronization.
Anthony thomas
2017-03-24
4.01.00
Support 2 FlexRay Clusters

Reference Documents
No.
Title
Version
[1]
AUTOSAR_FlexRayInterface.pdf
V3.2.0
[2]
AUTOSAR_SWS_DET.pdf
V2.2.0
[3]
AUTOSAR_SWS_DEM.pdf
V2.2.1
[4]
AUTOSAR_BasicSoftwareModules.pdf
V1.0.0
[5]
TechnicalReference_Asr_Fr.pdf
V1.14 or
later
[6]
TechnicalReference_Asr_FrTrcv_Tja1080.pdf
V.1.08 or
later
[7]
TechnicalReference_Asr_FrNm.pdf
V1.3.0 or
later
[8]
TechnicalReference_Asr_EcuM.pdf
V2.1.0 or
later
[9]
TechnicalReference_Asr_Com.pdf
V2.6.0 or
later
[10]
TechnicalReference_Asr_PduR.pdf
V3.4.0 or
later
[11]
TechnicalReference_Asr_SchM.pdf
V2.3.0 or
later
[12]
AN-ISC-8-1118_MICROSAR_BSW_Compatibility_Check.pdf
V1.0
[13]
TechnicalReference_IdentityManager.pdf
V1.1.7 or
later

© 2017 Vector Informatik GmbH
Version 4.01.00
2
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
Scope of the Document
This technical reference describes the general use of the FlexRay Interface basic software.

Please note
  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 4.01.00
3
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
1  Component History
Component
New Features
Version
3.00.00
Adaptation to AUTOSAR Release 3
3.01.00
Added CRC check of configuration data
3.02.00
Support of configuration variant 2 (Link-Time)
Added Direct Buffer Access
Added Job Concatenation
Rework of Buffer Reconfiguration
3.03.00
Added AUTOSAR 4.0 FIFO support
Added API optimizations
3.04.00
Added additional code-size optimizations
3.05.00
Added FreeOp Callback Support
3.06.00
Added AUTOSAR 4.0 Get Sync Frame List Support
Added AUTOSAR 4.0 Reconfig L-PDU Support
Added Bugzilla 30176 Read CC Config Support
Added support for multiple CDDs as upper layer software module
Added support for delayed Tx Confirmation handling
3.07.00
Added Dual Channel Redundancy Support (Bugzilla 42025)
Added Support for PduInfoType in TriggerTransmit and RxIndication according to
AUTOSAR 3.1.5
Configurable Communication Operation assignment for TxConfirmation
3.10.00
Added support for AUTOSAR4 API services
4.02.00
Added post-build selectable support
Added FrTSyn upper layer module support
Added extended module initialization support
6.00.02
SafeBSW
6.01.00
Support 2 FlexRay Clusters
Table 1-1
Component history
© 2017 Vector Informatik GmbH
Version 4.01.00
11
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
2  Introduction
This  document  describes  the  functionality,  API  and  configuration  of  the  AUTOSAR  BSW  module  FrIf  as
specified in  [1].
467H
Supported AUTOSAR Release*:
4
Supported Configuration Variants:
pre-compile, link-time, post-build
Vendor ID:
FrIf_VENDOR_ID
30 decimal
(= Vector-Informatik,
according to HIS)
Module ID:
FrIf_MODULE_ID
61 decimal
(according to ref.  [4])
468H
* For the precise AUTOSAR Release 4.x please see the release specific documentation.
The main purpose of the FlexRay Interface is to provide a PDU based API that can be used asynchronously
to the FlexRay global time by upper software layer modules. The FlexRay Interface assembles PDUs of the
upper  software layers  into frames and vice versa. E.g. multiple bus-independent  PDUs with a length of 8
bytes can be assembled into a frame with a length of up to 254 bytes. Thus bus-independent modules can
take advantage of the large payload that is possible with FlexRay.
Another  task  of  the  FlexRay  Interface  is  to  abstract  the  usage  of  multiple  FlexRay  Communication
Controllers and multiple Transceiver Drivers within an ECU. As the Vector FlexRay-Stack currently supports
only one FlexRay Communication Controller per ECU, this feature is not relevant for the current version.
The behaviour of the FlexRay Interface can be summarized as follows:
  The FlexRay Interface does not have any RAM buffers to store the content of PDUs, e.g. for periodic
transmission.
  The FlexRay Interface cannot be polled for received data. When a frame is received, the reception of the
PDUs that are contained in the frame is actively indicated by the FlexRay Interface.
  The FlexRay Interface provides the possibility to actively indicate the transmission of PDUs when the
frame that contains the PDUs is actually transmitted.

© 2017 Vector Informatik GmbH
Version 4.01.00
12
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
2.1
Architecture Overview
The following figure shows where the FrIf is located in the AUTOSAR architecture.

Figure 2-1 AUTOSAR architecture
The next figure shows the interfaces to adjacent modules of the FrIf. This interfaces are explained in section
5.2
© 2017 Vector Informatik GmbH
Version 4.01.00
13
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
class Module Structure
Module
Module
Module
Module
Module
Module
Module
Module
Module
Module
Legend
PDU Handling
FrTp
FrArTp
PduR
Dcm
Application
Cdd
BswM
FrXcp
FrNm
FrTSyn
Service Handling
Communication Control
ECU Startup
«use»
Module
Module
Module
Module
Module
Module
Module
Module
EcuM
Dem
Det
Rtm
FBL Callouts
PDU Upper Layer
Service User
FrSM
«use»
«use»
«use»
«use»
«use»
«use»
FRIF
FrIf
«use»
«use»
«use»
«use»
«use»
«use»
«use»
«use»
«use»
«use»
«use»
«use»
«use»
«use»
«use»
«use»
«EmbeddedInterface»
PDU Handling
«use»
«ServiceFunction»
+  FrIf_CancelTransmit()
Driver Abstraction
+  FrIf_JobListExec_0()
«EmbeddedInterface»
+  FrIf_JobListExec_1()
+  FrIf_Transmit()
«EmbeddedInterface»
Transceiv er Abstraction
«EmbeddedInterface»
Controller Status
State Handling
«EmbeddedInterface»
«use»
«LocalFunction»
«EmbeddedInterface»
«ServiceFunction»
«EmbeddedInterface»
«EmbeddedInterface»
Generic
+  FrIf_ExecCurrentJob()
«ServiceFunction»
Wakeup Handling
+  FrIf_CheckWakeupByTransceiver()
«LocalFunction»
Communication Control
+  FrIf_JobListExec()
Absolute Timer Handling
«EmbeddedInterfa...
+  FrIf_GetChannelStatus()
+  FrIf_ClearTransceiverWakeup()
+  FrIf_DisableJobListExecution()
«LocalFunction»
«ServiceFunction»
«ServiceFunction»
Frame Reconfiguration
+  FrIf_GetClockCorrection()
+  FrIf_DisableTransceiverBranch()
«ServiceFunction»
+  FrIf_EnableJobListExecution()
+  FrIf_CheckChannelStatus()
+  FrIf_GetWakeupRxStatus()
+  FrIf_AbortCommunication()
+  FrIf_GetGlobalTime()
+  FrIf_EnableTransceiverBranch()
+  FrIf_AckAbsoluteTimerIRQ()
«ServiceFunction»
«ServiceFunction»
+  FrIf_DiffTime()
«use»
+  FrIf_SendWUP()
«use»
+  FrIf_AllowColdstart()
+  FrIf_GetNmVector()
+  FrIf_GetTransceiverError()
+  FrIf_CancelAbsoluteTimer()
+  FrIf_InitializeTransmission()
+  FrIf_DisableLPdu()
+  FrIf_SetWakeupChannel()
+  FrIf_GetState()
+  FrIf_AllSlots()
+  FrIf_GetSyncFrameList()
+  FrIf_GetTransceiverMode()
+  FrIf_DisableAbsoluteTimerIRQ()
+  FrIf_JobListOutOfSync()
+  FrIf_ReconfigLPdu()
+  FrIf_SetState()
«EmbeddedInterface»
+  FrIf_ControllerInit()
+  FrIf_ReadCCConfig()
+  FrIf_GetTransceiverWUReason()
+  FrIf_EnableAbsoluteTimerIRQ()
+  FrIf_MainFunction()
TX
+  FrIf_SetTransceiverMode()
«EmbeddedInterface»
+  FrIf_GetAbsoluteTimerIRQStatus()
+  FrIf_GetNumOfStartupFrames()
«ServiceFunction»
RX
+  FrIf_SetAbsoluteTimer()
+  FrIf_GetPOCStatus()
«LocalFunction»
+  FrIf_GetCycleLength()
+  FrIf_HaltCommunication()
+  FrIf_IncrementTxReqCounter()
+  FrIf_GetMacrotickDuration()
«LocalFunction»
+  FrIf_StartCommunication()
+  FrIf_PrepareFrameBuffer()
+  FrIf_GetMacroticksPerCycle()
+  FrIf_FillRedundantRxPduInfo()
+  FrIf_PrepareTxPdus()
+  FrIf_GetVersionInfo()
+  FrIf_HandleRedundantFrame()
+  FrIf_TriggerTransmitFunctions()
+  FrIf_Init()
«use»
+  FrIf_Receive()
+  FrIf_TxConfirmation()
+  FrIf_InitMemory()
+  FrIf_RxIndicationFunctions()
+  FrIf_TxConfirmationFunctions()
+  FrIf_MainFunction_0()
+  FrIf_RxTask()
+  FrIf_TxConfTask()
+  FrIf_MainFunction_1()
+  FrIf_TxRollback()
+  FrIf_TxTask()
«use»
«use»
«use»
«use»
«use»
«use»
«use»
«use»
«use»
«use»
«use»
«use»
Module
Module
Fr
FrTrcv
«access»
«access»
Hardware
Hardware
CC
Tranceiver Device

Figure 2-2  Interfaces to adjacent modules of the FrIf

© 2017 Vector Informatik GmbH
Version 4.01.00
14
based on template version 4.11.3

3  Functional Description
3.1
Features
The features listed in the following tables cover the complete functionality specified for the FrIf.
The AUTOSAR standard functionality is specified in [1], the corresponding features are listed in the tables
>  Table 3-1   Supported AUTOSAR standard conform features
>  Table 3-2   Not supported AUTOSAR standard conform features
Vector  Informatik  provides  further  FrIf  functionality  beyond  the  AUTOSAR  standard.  The  corresponding
features are listed in the table
>  Table 3-3   Features provided beyond the AUTOSAR standard
The following features specified in [1] are supported:
Supported AUTOSAR Standard Conform Features
PDU Reception:
  Reception Indication
  FIFO Support
PDU Transmission:
  Transmission Request
  Transmission Confirmation
  Transmit Request Queuing
  PDU-based Continuous Transmission
  Frame-based Continuous Transmission
  Transmit Cancellation
Frame Assembly and Disassembly:
  Update-bit Handling
  Frame Layout and PDU owner handling (for FrTp, FrArTp, FrTSyn, FrNm, FrXcp, CDD, PduR)
  Cycle Multiplexing
Hardware Abstraction:
  FR Driver API Abstraction
  FRTRCV Driver API Abstraction
Configuration Variants:
  Precompile
  Linktime
  Post-build Selectable
  Post-build Loadable

Technical Reference MICROSAR FlexRay Interface
Supported AUTOSAR Standard Conform Features
Error Detection and Handling:
  Dev Error Reporting
  Channel Status Checks with DEM reporting
  Job list monitoring
Table 3-1
Supported AUTOSAR standard conform features
3.1.1
Deviations
The following features specified in [1] are not or only partly supported:
Category
Description
ASR
Version
Functional
7.2 Indexing Scheme: The following features are partly supported:
4.0.3
  Multiple FlexRay Drivers: a single FlexRay Driver is currently supported.
  Multiple FlexRay Clusters: a maximum of two FlexRay Clusters is
currently supported.
  Multiple FlexRay Communication Controllers: a single FlexRay
Communication Controller per cluster is currently supported.
Functional
7.6.3 Communication Operations: The following Communication Operations
4.0.3
are not supported:
  RECEIVE_AND_STORE
  RX_INDICATION
  PREPARE_LPDU
  FREE_OP_A
  FREE_OP_B
Functional
7.6.1 PDU Packing, PDU update bits, and Frame Construction Plans: Received
4.0.3
frames that are shorter than the configured length are not padded, even if the
FrIfUnusedBitValue exists.
Functional
7.3.1 FlexRay Interface Main Function and 7.6.2.2 FlexRay Job List Execution
4.0.3
Function: Pending transmissions and transmission confirmations are cleared
and forgotten during the resynchronization of the job list.
API
FrIf_CancelTransmit: The request counters of the PDUs sharing a frame with a
4.0.3
cancelled PDU are not increased after cancelling the transmission of the frame.
Config
FrIfByteOrder: Only little endian is currently supported.
4.0.3
Config
FrIfCounterLimit: Can only be configured to 1 or 255.
4.0.3
Config
FrIfDisableTransceiverBranchSupport and
4.0.3
FrIfEnableTransceiverBranchSupport:
The functions FrIf_DisableTransceiverBranch and FrIf_EnableTransceiverBranch
© 2017 Vector Informatik GmbH
Version 4.01.00
16
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
Category
Description
ASR
Version
will be available as long as a
FrIf/FrIfConfig/FrIfCluster/FrIfController/FrIfTransceiver container exists.
Config
FrIfRxComOpMaxLoop: A limit when emptying a FIFO can’t be configured.
4.0.3
Table 3-2
Not supported AUTOSAR standard conform features
3.1.2
Additions/ Extensions
The following features are provided beyond the AUTOSAR standard:
Features Provided Beyond The AUTOSAR Standard
Dual channel redundancy support
AMD runtime measurement
BSW debug parameters
Table 3-3
Features provided beyond the AUTOSAR standard
3.2
Initialization
The FlexRay Interface gets initialized by call of  FrIf_InitMemory and then  FrIf_Init out of EcuM.
474H
475H
If EcuM is not used the application has to call  FrIf_InitMemory and then  FrIf_Init.
476H
477H

Example
FrIf_Init(&FrIf_Config);
  482H

Figure 3-4
Initialization example for the FlexRay Interface

Caution
  Starting with AUTOSAR Release 3 the FlexRay Interface is no longer responsible for initializing
the FlexRay Driver and the FlexRay Transceiver Driver.

Depending  on  the  configuration  variant  the  FrIf_Config  parameter  of  FrIf_Init  has  different
478H
meaning:
3.2.1
Configuration Variants 1 and 2 (Pre-Compile and Link-Time Configuration)
At  Variant  1  (Pre-compile  Configuration)  and  Variant  2  (Link-Time  Configuration)  the  pointer  given  to
FrIf_Init is ignored. At these configuration variants the FlexRay interface is configured at compile or
479H
link  time  and  has  direct  access  to  all  configuration  data  which  is  stored  in  the  files  FrIf_Cfg.h  and
480H
FrIf_LCfg.c.
481H
© 2017 Vector Informatik GmbH
Version 4.01.00
17
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
3.2.2
Configuration Variant 3 (Post-build Configuration)
In this configuration variant, the FlexRay interface has to be initialized using the  FrIf_Init function with
483H
the  address  of  the  post-build  configuration  data  passed  as  parameter.  The  declaration  of  the  post-build
configuration data is contained in the files  FrIf_PBcfg.h and  FrIf_PBcfg.c.
484H
485H
3.3
States
The FlexRay Interface is shown in Figure 3-1 FrIf’s state machine. and comprises the following states:
State Name
Description
FRIF_STATE_OFFLINE
The job list of the FlexRay Interface is not executed.
487H
FRIF_STATE_ONLINE
The job list of the FlexRay Interface is executed.
488H

stm FrIf State Machine
Initial
FrIf_Init
FRIF_GOTO_ONLINE
FRIF_STATE_OFFLINE
FRIF_STATE_ONLINE
FRIF_GOTO_OFFLINE

Figure 3-1  FrIf’s state machine.

The state of the state machine can be changed using the  FrIf_SetState function, see section  5.2.45.
489H
490H
3.4
Main Functions
3.4.1
Cyclic function
The  FrIf_MainFunction_<ClstIdx>  monitors  the  job  execution.  This  function  should  be  called
491H
cyclically with a cycle time that is equal to or smaller than the FlexRay cycle length.
There is no need to synchronize t his  function  to  the  FlexRay  global  time. This  function  can  be  called  even
when the FlexRay communication has not been started.
3.4.2
Job List Execution
The communication via FlexRay is executed by a FlexRay communication controller that provides a number
of  transmit-  and  receive-buffers.  These  buffers  are  accessed  by  both  the  FlexRay-Stack  and  the
communication  controller.  As  some  controllers  prohibit  concurrent  access,  the  FlexRay-Stack  may  only
access the buffers when they are not busy. This is ensured by using a time-triggered access that is defined
by means of a job list. Each entry of the job list defines at which point in time (in terms of cycle and macro
tick  offset)  which  receive  buffer  has  to  be  read  or  which  transmit  buffer  has  to  be  filled  with  data  or
checked for transmission success.
© 2017 Vector Informatik GmbH
Version 4.01.00
18
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
The MICROSAR FlexRay Interface has a number of so called Rx- and Tx- jobs that execute the job list. An Rx
job executes the job list entries for reception; a Tx-job executes those for transmission. The numbers of Rx-
and Tx-job are independent, but usually at least 2 Rx- and 2 Tx-Job must be defined. The Rx- and Tx-jobs are
activated  by  using  one  absolute  timer  of  the  FlexRay  communication  controller  (see  section  3.8).  As
495H
described in the following two chapters the job list can be activated in the interrupt context of the FlexRay
timer  interrupt  or  in  the  context  of  an  OS  task.  As  the  <UL>_TriggerTransmit  and
<UL>_RxIndication  call-back  functions  are  called  during  the  FrIf_JobListExec_<ClstIdx>
routine, these functions can also be executed in interrupt context.

Info
  You can use the “Job Concatenation Enable” feature, to reduce the interrupt load of the
FlexRay Interface to a minimum of two timer interrupts per cycle, even if 2 Rx and 2 Tx jobs are
defined. If this feature is enabled, two FrIf jobs with the same configured “Macrotick”
parameter will be executed by one call of the  FrIf_JobListExec_<ClstIdx> function.
500H

3.4.2.1
Job List Execution in Interrupt Context
The job list execution is activated by a FlexRay timer interrupt. The  FrIf_JobListExec_<ClstIdx>
502H
function can be directly called in the call-back function of the FlexRay timer interrupt that is provided by
the FlexRay Driver. An example for the Vector FlexRay Driver is depicted in the following figure.

Example
void ApplFr_ISR_Timer0(void)
  {
  FrIf_JobListExec_0();
}

Figure 3-5
The FrIf_JobListExec_0() function is directly called in the call-back function for FlexRay timer 0.

© 2017 Vector Informatik GmbH
Version 4.01.00
19
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
3.4.2.2
Job List Execution in Task Context
Depending  on  the  platform  being  used,  the  execution  of  the  job  list  can  take  up  to  several  hundred
microseconds.  Thus  it  is  not  always  advisable  to  execute  the  job  list  in  the  context  of  the  FlexRay  timer
interrupt.
An example for the job list execution in the context of an OS task is depicted in the following figure.

Example
void ApplFr_ISR_Timer0(void)
  {
ActivateTask(FrIfJobExecTask);
}

TASK(FrIfJobExecTask)
{
  FrIf_JobListExec_0();
  (void)TerminateTask();
}

Figure 3-6
The FrIf_JobListExec_0() function is called inside a task that is activated in the call-back function for FlexRay timer 0.
3.5
Error Handling
3.5.1
Development Error Reporting
Development errors are reported to  DET using the service  Det_ReportError(), (specified in  [2]), if the pre-
505H
506H
507H
compile option “Dev Error Detect” is set.
The reported FrIf ID is 61.
The service IDs from the following table identify the services which are described in section 5.2.


© 2017 Vector Informatik GmbH
Version 4.01.00
20
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
Service ID
Service
FrIf_ReconfigLPdu
0x00
FrIf_GetVersionInfo
0x01
FrIf_Init
0x02
FrIf_ControllerInit
0x03
FrIf_StartCommunication
0x04
FrIf_HaltCommunication
0x05
FrIf_AbortCommunication
0x06
FrIf_GetState
0x07
FrIf_SetState
0x08
FrIf_SetWakeupChannel
0x09
FrIf_SendWUP
0x0A
FrIf_GetPOCStatus
0x0D
FrIf_GetGlobalTime
0x0E
FrIf_GetNmVector
0x0F
FrIf_AllowColdstart
0x10
FrIf_AllSlots
0x33
FrIf_GetNumOfStartupFrames
0x34
FrIf_GetMacroticksPerCycle
0x11
FrIf_GetWakeupRxStatus
0x2B
FrIf_Transmit
0x30
FrIf_SetTransceiverMode
0x13
FrIf_GetTransceiverMode
0x14
FrIf_GetTransceiverWUReason
0x15
FrIf_EnableTransceiverWakeup
0x36
FrIf_DisableTransceiverWakeup
0x37
FrIf_ClearTransceiverWakeup
0x18
FrIf_EnableTransceiverBranch
0x36
FrIf_DisableTransceiverBranch
0x37
FrIf_GetTransceiverError
0x35
FrIf_CheckWakeupByTransceiver
0x39
FrIf_SetAbsoluteTimer
0x19
© 2017 Vector Informatik GmbH
Version 4.01.00
21
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
Service ID
Service
FrIf_CancelAbsoluteTimer
0x1B
FrIf_EnableAbsoluteTimerIRQ
0x1D
FrIf_GetAbsoluteTimerIRQStatus
0x1F
FrIf_AckAbsoluteTimerIRQ
0x21
FrIf_DisableAbsoluteTimerIRQ
0x23
FrIf_Cbk_WakeupByTransceiver
0x39
FrIf_GetChannelStatus (optional)
0x26
FrIf_MainFunction_<ClstIdx>
0x27
FrIf_DisableLPdu (optional)
0x28
FrIf_GetClockCorrection (optional) 0x29
FrIf_GetCycleLength
0x3A
FrIf_GetSyncFrameList (optional)
0x2A
FrIf_GetMacrotickDuration
0x31
FrIf_JobListExec_<ClstIdx>
0x32
FrIf_CancelTransmit (optional)
0x30
FrIf_ReadCCConfig (optional)
0x3B
FrIf_ExecCurrentJob
0x40
FrIf_TriggerTransmitFunctions
0x41
Table 3-7
Mapping of service IDs to services
© 2017 Vector Informatik GmbH
Version 4.01.00
22
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
The errors reported to  DET are described in the following table:
510H
Error Code
Description
0x01
FRIF_E_INV_POINTER
Invalid pointer
0x02
FRIF_E_INV_CTRL_IDX
Invalid Controller index
0x03
FRIF_E_INV_CLST_IDX
Invalid Cluster index
0x04
FRIF_E_INV_CHNL_IDX
Invalid Channel index
0x05
FRIF_E_INV_TIMER_IDX
Invalid timer index
0x06
FRIF_E_INV_TXPDUID
Invalid FrIf_TxPdu Index
0x08
FRIF_E_NOT_INITIALIZED
FrIf not initialized
0x0A
FRIF_E_INV_LPDU_IDX
Invalid L-PDU Index
0x0B
FRIF_E_INV_FRAME_ID
Invalid Frame Index
0x26
FRIF_E_TXTASK_RET_E_NOT_OK
FrIf_TxTask_0 returned E_NOT_OK
0x27
FRIF_E_INVALID_PDU_OWNER
Invalid Pdu Owner
0x09
FRIF_E_JLE_SYNC
Job  List  Execution  lost  synchronization  to  the
FlexRay Global Time
Table 3-8
Errors reported to DET
3.5.1.1
Parameter Checking
The following table shows which parameter checks are performed on which services:

Info
  Note that the  FRIF_E_INV_CTRL_IDX error is only reported to  DET by the FlexRay Interface if
512H
513H
the “Single Channel API” feature is disabled.

© 2017 Vector Informatik GmbH
Version 4.01.00
23
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
Check

K

ER

N

W

X
ED
_NOT_O
X

X
X

IZ
E
X
D I
D
L
T_
U_O
D

ERT
_ID
_ID
D
L
R_ID
UID
P
E_
N
E
D
RE
P
ITIA
U_I
M

OIN
ST_I
IN
K_
ID_
D
L
P
AS

V_P
V_CTRL
V_CL
V_CH
V_TIM
V_TX
XT
VA
V_L
V_FRA
Service
F_E_IN
F_E_IN
F_E_IN
F_E_IN
F_E_IN
F_E_IN
F_E_NOT_
F_E_T
F_E_IN
F_E_IN
F_E_IN
FRI
FRI
FRI
FRI
FRI
FRI
FRI
FRI
FRI
FRI
FRI
515H
516H
517H
518H
519H
520H
521H
525H
526H
FrIf_ReconfigLPdu









FrIf_GetVersionInfo


FrIf_Init


FrIf_ControllerInit





FrIf_StartCommunication





FrIf_HaltCommunication





FrIf_AbortCommunication





FrIf_GetState






FrIf_SetState





FrIf_SetWakeupChannel





FrIf_SendWUP





FrIf_GetPOCStatus





FrIf_GetGlobalTime





FrIf_GetNmVector





FrIf_AllowColdstart





FrIf_GetMacrotickDuration



FrIf_Transmit





FrIf_SetTransceiverMode







FrIf_GetTransceiverMode







FrIf_GetTransceiverWUReason







© 2017 Vector Informatik GmbH
Version 4.01.00
24
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
Check

K

ER

N

W

X
ED
_NOT_O
X

X
X

IZ
E
X
D I
D
L
T_
U_O
D

ERT
_ID
_ID
D
L
R_ID
UID
P
E_
N
E
D
RE
P
ITIA
U_I
M

OIN
ST_I
IN
K_
ID_
D
L
P
AS

V_P
V_CTRL
V_CL
V_CH
V_TIM
V_TX
XT
VA
V_L
V_FRA
Service
F_E_IN
F_E_IN
F_E_IN
F_E_IN
F_E_IN
F_E_IN
F_E_NOT_
F_E_T
F_E_IN
F_E_IN
F_E_IN
FRI
FRI
FRI
FRI
FRI
FRI
FRI
FRI
FRI
FRI
FRI
515H
516H
517H
518H
519H
520H
521H
525H
526H
FrIf_ClearTransceiverWakeup







FrIf_SetAbsoluteTimer







FrIf_CancelAbsoluteTimer







FrIf_EnableAbsoluteTimerIRQ







FrIf_GetAbsoluteTimerIRQStatus 






FrIf_AckAbsoluteTimerIRQ







FrIf_DisableAbsoluteTimerIRQ







FrIf_GetChannelStatus





FrIf_MainFunction_<ClstIdx>

1

FrIf_DisableLPdu







FrIf_GetClockCorrection





FrIf_GetSyncFrameList





FrIf_GetMacrotickDuration



FrIf_JobListExec_<ClstIdx>



FrIf_CancelTransmit




FrIf_ReadCCConfig





FrIf_ExecCurrentJob_0



FrIf_GetCycleLength



1 Note: this DET error is not reported when using a multiple configuration ECUC.
© 2017 Vector Informatik GmbH
Version 4.01.00
25
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
Check

K

ER

N

W

X
ED
_NOT_O
X

X
X

IZ
E
X
D I
D
L
T_
U_O
D

ERT
_ID
_ID
D
L
R_ID
UID
P
E_
N
E
D
RE
P
ITIA
U_I
M

OIN
ST_I
IN
K_
ID_
D
L
P
AS

V_P
V_CTRL
V_CL
V_CH
V_TIM
V_TX
XT
VA
V_L
V_FRA
Service
F_E_IN
F_E_IN
F_E_IN
F_E_IN
F_E_IN
F_E_IN
F_E_NOT_
F_E_T
F_E_IN
F_E_IN
F_E_IN
FRI
FRI
FRI
FRI
FRI
FRI
FRI
FRI
FRI
FRI
FRI
515H
516H
517H
518H
519H
520H
521H
525H
526H
FrIf_TriggerTransmitFunctions



FrIf_TxConfirmationFunctions



FrIf_RxIndicationFunctions



FrIf_AllSlots





FrIf_GetMacroticksPerCycle





FrIf_GetNumOfStartupFrames





FrIf_GetWakeupRxStatus





FrIf_EnableTransceiverBranch







FrIf_DisableTransceiverBranch







FrIf_GetTransceiverError







FrIf_CheckWakeupByTransceiver







Table 3-9
Development Error Reporting: Assignment of checks to services
3.5.2
Production Code Error Reporting
Production code related errors are reported to  DEM using the service  Dem_ReportErrorStatus() (specified
527H
528H
in  [3]), if the pre-compile parameter “Prod Error Detect” option is enabled.
529H
The errors reported to  DEM are described in the following table:
531H
© 2017 Vector Informatik GmbH
Version 4.01.00
26
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
Error Code
Description
FRIF_E_NIT_CH_A
DEM_EVENT_STATUS_FAILED: is reported when
error bits for the NIT on channel A are set in the
return value of Fr_GetChannelStatus.

DEM_EVENT_STATUS_PASSED: is reported when
no error bits are set in the return value of
Fr_GetChannelStatus.
FRIF_E_NIT_CH_B
DEM_EVENT_STATUS_FAILED: is reported when
error bits for the NIT on channel B are set in the
return value of Fr_GetChannelStatus.

DEM_EVENT_STATUS_PASSED: is reported when
no error bits are set in the return value of
Fr_GetChannelStatus.
FRIF_E_SW_CH_A
DEM_EVENT_STATUS_FAILED: is reported when
error bits for the SW on channel A are set in the
return value of Fr_GetChannelStatus.

DEM_EVENT_STATUS_PASSED: is reported when
no error bits are set in the return value of
Fr_GetChannelStatus.
FRIF_E_SW_CH_B
DEM_EVENT_STATUS_FAILED: is reported when
error bits for the SW on channel B are set in the
return value of Fr_GetChannelStatus.

DEM_EVENT_STATUS_PASSED: is reported when
no error bits are set in the return value of
Fr_GetChannelStatus.
FRIF_E_ACS_CH_A
DEM_EVENT_STATUS_FAILED: is reported when
error bits for the ACS on channel A are set in the
return value of Fr_GetChannelStatus.

DEM_EVENT_STATUS_PASSED: is reported when
no error bits are set in the return value of
Fr_GetChannelStatus.
© 2017 Vector Informatik GmbH
Version 4.01.00
27
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
FRIF_E_ACS_CH_B
DEM_EVENT_STATUS_FAILED: is reported when
error bits for the ACS on channel B are set in the
return value of Fr_GetChannelStatus.

DEM_EVENT_STATUS_PASSED: is reported when
no error bits are set in the return value of
Fr_GetChannelStatus.
Table 3-10
Errors reported to DEM
3.6
Transmission
3.6.1
Decoupled Transmission
Usually  the  Decoupled  Transmission  is  used  for  the  transmission  of  PDUs.  Decoupled  Transmission  is
mandatory in case a frame contains multiple PDUs.
When an upper layer software module calls the  FrIf_Transmit method of the FlexRay Interface, the
538H
parameter that holds the pointer to the PDU content is not evaluated. It is just stored that the given PDU
shall be transmitted. When the frame that contains the PDU is assembled, the FlexRay Interface calls the
call-back function <UL>_TriggerTransmit where <UL> is the name of the upper layer module. The
upper layer module then copies the PDU content to the memory location that is given as a parameter of
the call-back function.
A frame that contains multiple PDUs will be transmitted, if the  FrIf_Transmit function was called for
540H
at  least  one  of  its  PDUs.  The  FlexRay  Interface  does  not  buffer  any  PDU  content.  The
<UL>_TriggerTransmit  function  is  only  called  for  those  PDUs  for  which  FrIf_Transmit  was
542H
called.
When a frame  is transmitted and  FrIf_Transmit  has not  been called for each PDU contained in the
543H
frame, the FlexRay Interface cannot transmit the previous value of those PDUs that have not been updated.
Instead, the FlexRay Interface uses update-bits to indicate which PDUs of a frame are valid.
3.6.2
Immediate Transmission
If a PDU is configured for immediate transmission, the  FrIf_Transmit will immediately copy the PDU
544H
content to the FlexRay Driver, i.e. the <UL>_TriggerTransmit call-back will not be used.
However, the following constraints have to hold true:
  Immediate Transmission cannot be used, if there are multiple PDUs in a frame. I.e. a PDU that is
configured for immediate transmission must be the only PDU of the frame.
  The upper layer software module must not call the  FrIf_Transmit function when the transmit
546H
buffer of the FlexRay communication controller is transmitting data. I.e. the upper layer software
module must be synchronized to the FlexRay global time.

© 2017 Vector Informatik GmbH
Version 4.01.00
28
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
3.7
Reception
The FlexRay Interface cannot be polled for received data. When a frame is received, the reception of the
PDUs  that  are  contained  in  the  frame  is  actively  indicated  by  the  FlexRay  Interface  using  the
<UL>_RxIndication call-back function.
3.8
Timer Handling
The FlexRay Interface uses one absolute timer of the FlexRay communication controller for the execution of
the  job  list.  Therefore  the  application  can  only  use  one  FlexRay  timer  if  the  communication  controller
provides at least two timers.

Caution
  The values of the new payload shall be smaller or equal as the payload value that was defined
within FIBEX or EcuC.

Info
  The FlexRay protocol standard only requires one absolute timer. Many FlexRay communication
controllers provide two timers, but there are controllers that only have one timer.

The  FlexRay  Interface  uses  timer  0  of  the  FlexRay  communication  controller.  Thus  the  application  can
only use timer 1, provided that it is available.
3.9
Buffer Reconfiguration
The  FlexRay  Communication  Controllers  (CC)  that  are  currently  available,  only  offer  a  limited  amount  of
message buffers. A FlexRay Schedule with a large number of frames might exceed the number of available
message buffers.
The  buffer  reconfiguration  feature  reduces  the  amount  of  message  buffers  that  are  used  by  the  FlexRay
Driver.  The  MICROSAR  FlexRay Driver  triggers  the  buffer  reconfiguration  automatically  (the  FrIf  does  not
need  to  call  the  Fr_PrepareLPdu  function).  For  a  detailed  description  of  the  buffer  reconfiguration
feature of the MICROSAR FlexRay Driver refer to  [5].
548H
3.10
L-PDU Reconfiguration
The  MICROSAR  FlexRay  Interface  supports  the  AUTOSAR  4.0  L-PDU  reconfiguration  feature.  This  feature
allows  the  FlexRay  Interface  to  reconfigure  the  frame  ID,  channel,  cycle  repetition,  cycle  offset,  payload
length and the header CRC at runtime for a given L-PDU.
The  L-PDU  reconfiguration  can  be  enabled  with  the  attribute  “Reconfig  LPdu  Support”  within  the  FrIf
module
© 2017 Vector Informatik GmbH
Version 4.01.00
29
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
Only FrIf PDUs with the  “Reconfigurable”  option enabled can be  reconfigured/disabled by using the  API
services FrIf_ReconfigLPdu and FrIf_DisableLPdu.
Info
  Note that if L-PDU reconfiguration is enabled for a specific L-PDU, this L-PDU is not sent after
FrIf_ControllerInit but has to be enabled with FrIf_ReconfigLPdu. Therewith it
is not allowed to set the “Reconfigurable” flag for a sync frame.

3.11
Dual Channel Redundancy Support
The  MICROSAR  FlexRay Interface  supports  optional feature for the replicated reception and transmission
on a FlexRay dual channel (or single channel) cluster according to Bugzillla 42025. This feature allows the
FlexRay Interface to transmit a L-PDU in different slots either on one channel or on both channels with the
same payload.
If two Tx frames (i.e. frame1 and frame2 of Figure 3-2) are configured to be redundant to each other the
FlexRay Interface assembles the frame only once for both frames in order to ensure that the identical frame
content is transmitted.

Figure 3-2  Behaviour of FrIf for replicated transmission
© 2017 Vector Informatik GmbH
Version 4.01.00
30
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
Additionally this feature allows the application above the FlexRay Interface to use a payload comparison
between the received PDUs of two redundant Rx frames as depicted in Figure 3-3. This payload comparison
can be used to check whether a I-PDU was received on both channels or not.
For a detailed API description of the voting function refer to section 5.5.2.4.

Figure 3-3 Behaviour of FrIf for replicated reception

© 2017 Vector Informatik GmbH
Version 4.01.00
31
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface

Info
  Only frames that have frame triggerings with the same base cycle, cycle repetition, LSdu length
and the same frame layout can be configured to be redundant to each other.
The frame layout of two frames is identical if both frames use the same number of PDUs and
the redundant PDUs within the frames have the same:
  PDU length, PDU offset and PDU owner
  PDU update bit configuration
The Tx PDUs for replicated transmission may not have the “Immediate” flag enabled.
Redundant reception and FIFOs are mutually exclusive, so no redundant frames are allowed
within the slot range of FIFOs.
3.12
Dynamic Payload
The  dynamic  payload  feature  allows  the  FrIf  to  pass  only  the  actual  used  L-PDU  length  via
FrIf_Transmit() to the driver ( Fr_TransmitTxLPdu()). If the feature is enabled, the  FR module updates
551H
552H
553H
the buffer configuration with the new payload and new calculated header CRC at runtime.

Caution
  The values of the new payload shall be smaller or equal as the payload value that was defined
within FIBEX or EcuC.

Info
  The calculation of the header CRC is done at the runtime. Note that this feature uses more
processor resources

© 2017 Vector Informatik GmbH
Version 4.01.00
32
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
4  Integration
This  chapter  gives  necessary  information  for  the  integration  of  the  MICROSAR  FrIf  into  an  application
environment of an ECU.
4.1
Scope of Delivery
The delivery of the FrIf contains the files which are described in the chapters  4.1.1 and  4.1.2:
556H
557H
4.1.1
Static Files
File Name
Description
FrIf.c
Static source for FlexRay Interface core.
FrIf.h
Static header file for FlexRay Interface API.
FrIf_Cbk.h
Static header file for callbacks.
FrIf_LCfg.h
Static header file for link time configuration data.
FrIf_AbsTimer.c
Static source for absolute time handling.
FrIf_Priv.h
Static header file for private prototypes and macros.
FrIf_Ext.c
Static source for external synchronization API.
FrIf_Rx.c
Static source for reception handling.
FrIf_Time.c
Static source for time services.
FrIf_Trcv.c
Static source for transceiver handling.
FrIf_Tx.c
Static source for transmission handling.
Table 4-1
Static files
4.1.2
Dynamic Files
The dynamic files are generated by the configuration tool
.
File Name
Description
FrIf_Cfg.h
Generated header file for pre-compile time configuration data.
FrIf_LCfg.c
Generated source for link time configuration data.
FrIf_PBcfg.c
Generated source for post-build time configuration data.
FrIf_PBcfg.h
Generated header file for post-build time configuration data.
FrIf_Types.h
Generated header file for FlexRay Interface type definitions.
Table 4-2
Generated files
© 2017 Vector Informatik GmbH
Version 4.01.00
33
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface

4.2
Include Structure
obj ect Header File Structure
dem.h
det.h
SchM_FrIf.h
FrIf_Lcfg.h
«include»
«include»
«include»
«include»
Fr.h
«include»
FrIf.c
«include»
FrIf_PBcfg.h
«include»
«include»
«include»
FrIf.h
Memmap.h
FrTrcv .h
«include»
«include»
«include»
«include»
FrIf_cfg.h
ComStack_Types.h
Fr_GeneralTypes.h
FrIf_Types.h

Figure 4-1
Include structure

© 2017 Vector Informatik GmbH
Version 4.01.00
34
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
4.3
Compiler Abstraction and Memory Mapping
The  objects  (e.g.  variables,  functions,  constants)  are  declared  by  compiler  independent  definitions  –  the
compiler abstraction definitions. Each compiler abstraction definition is assigned to a memory section.
The following table contains the memory section names and the compiler abstraction definitions defined
for the FrIf and illustrates their assignment among each other.

Compiler Abstraction

Definitions

Memory Mapping
Sections
FRIF_VAR_NOINIT
FRIF_CONST
FRIF_PBCFG
FRIF_CODE
FRIF_APPL_DATA
FRIF_START_SEC_CODE



FRIF_STOP_SEC_CODE
FRIF_START_SEC_PBCFG



FRIF_STOP_SEC_PBCFG
FRIF_START_SEC_CONST_32BIT



FRIF_STOP_SEC_CONST_32BIT
FRIF_START_SEC_CONST_UNSPECIFIED



FRIF_STOP_SEC_CONST_UNSPECIFIED
FRIF_START_SEC_VAR_NOINIT_UNSPECIFIED


FRIF_STOP_SEC_VAR_NOINIT_UNSPECIFIED
Table 4-3
Compiler abstraction and memory mapping
The Compiler Abstraction Definition FRIF_APPL_DATA is used to address code, variables and constants
which are declared by other modules and used by the FlexRay Interface.
4.4
Critical Sections and Exclusive Areas
4.4.1
FRIF_EXCLUSIVE_AREA_0
This  exclusive  area  is  used  to  avoid  modifications  to  the  FrIf_TxPduDirtyBits  and/or
FrIf_TxPduTxRequestCounters  arrays  from  different  contexts,  by  preventing  that  the  functions
FrIf_Transmit,  FrIf_CancelTransmit  and  FrIf_JobListExec_<ClstIdx>  interrupt
themselves. It can be ommited if the 2 following conditions are fulfilled:
>  The parameter FrIfPduDirtyByteUsage is set to true.
>  The parameter FrIfCounterLimitDisable is set to true.
© 2017 Vector Informatik GmbH
Version 4.01.00
35
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
A  global  interrupt  lock  is  recommended,  since  the  3  functions  could  be  called  from  different  interrupt
contexts if they have different priorities (e.g., in a routing scenario FrIf_Transmit could be called from
an  CAN  RxIndication  interrupt  while  the    FrIf_JobListExec_<ClstIdx>  is  being  executed  or  vice
versa).
This  exclusive  area  has  a  medium  duration  if  the  flags  and  counters  of  all  the  PDUs  in  a  frame  must  be
rolled back. However, under normal conditions the whole processing shouldn’t take long.
4.4.2
FRIF_EXCLUSIVE_AREA_1
This exclusive area is used to protect the time-critical estimation and setting of the timer for the next job
list
execution
that
takes
place
within
the
FrIf_JobListExec_<ClstIdx>,
FrIf_MainFunction_<ClstIdx> and FrIf_SetState functions.
Any  tasks  or  interrupts  of  higher  priority  must  be  blocked,  since  the  estimation  and  setting  of  the  next
timer interrupt shall not be interrupted.
It’s not possible to tell the exact duration of this exclusive area, since the functions Fr_GetGlobalTime and
Fr_SetAbsoluteTimer  from  the  Fr  are  called.  However,  if  no  errors  take  place  within  these  functions  the
whole processing shouldn't take long.

4.4.3
FRIF_EXCLUSIVE_AREA_2
This  exclusive  area  is  used  to  ensure  the  required  atomicity  during  initialization,  by  preventing  that  the
function FrIf_SetState gets interrupted by the FrIf_JobListExec_<ClstIdx>.
At  least  the  FlexRay  timer  interrupt  must  be  blocked  within  this  exclusive  area,  since  the
FrIf_JobListExec_<ClstIdx> is usually executed within that interrupt context.
It’s not possible to tell the exact duration of this exclusive area, since the functions Fr_GetGlobalTime and
Fr_SetAbsoluteTimer  from  the  Fr  are  called.  However,  if  no  errors  take  place  within  these  functions  the
whole processing shouldn't take long.
© 2017 Vector Informatik GmbH
Version 4.01.00
36
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
5  API Description
For an interfaces overview please see Figure 2-2.
5.1
Type Definitions
Type Name
C-Type
Description
Value Range
FrIf_StateType
Enum
Representation of the FrIf job  FRIF_STATE_OFFLINE
list execution status
Job list is not executed
FRIF_STATE_ONLINE
Job list is executed
FrIf_StateTransitio Enum
Start or stop the the FrIf job
FRIF_GOTO_OFFLINE
nType
list execution
Stop the job list execution.
FRIF_GOTO_ONLINE
Start the job list is execution.
Table 5-1
Type definitions
5.2
Services provided by FrIf
The FrIf API consists of services, which are realized by function calls.
5.2.1
FrIf_AbortCommunication
Prototype
Std_ReturnType FrIf_AbortCommunication(uint8 FrIf_CtrlIdx)
Parameter
FrIf_CtrlIdx
Index of the FlexRay communication controller for which
Fr_AbortCommunication shall be called.
Return code
E_OK
The call of the FlexRay Driver API service Fr_AbortCommunication() has
returned E_OK.
E_NOT_OK
The call of the FlexRay Driver API service Fr_AbortCommunication() has
returned E_NOT_OK, or an error has been detected if development error
detection is enabled.
Functional Description
Call the function Fr_AbortCommunication of the FlexRay Driver.
© 2017 Vector Informatik GmbH
Version 4.01.00
37
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
Particularities and Limitations
>  Precondition: The FlexRay Interface has to be initialized with a call of  FrIf_Init.
558H
>  This API function is only available if “AbortCommunication Disable” has not been set for FlexRay
Interface.
>  For the parameter FrIf_CtrlIdx only the value 0 is allowed.
>  This function is implemented as macro to reduce code size if the “Wrapper APIs As Macro” option is
enabled for the FlexRay Interface.
Expected Caller Context
>  This function can be called in any context.
Table 5-2
FrIf_AbortCommunication
5.2.2
FrIf_AckAbsoluteTimerIRQ
Prototype
Std_ReturnType FrIf_AckAbsoluteTimerIRQ(uint8 FrIf_CtrlIdx, uint8
FrIf_AbsTimerIdx)
Parameter
FrIf_CtrlIdx
The index of the FlexRay Communication Controller.
FrIf_AbsTimerIdx
Index of the absolute timer.
Return code
E_OK
The call of the FlexRay Driver API service Fr_AckAbsoluteTimerIRQ() has
returned E_OK.
E_NOT_OK
The call of the FlexRay Driver API service Fr_AckAbsoluteTimerIRQ() has
returned E_NOT_OK, or an error has been detected if development error
detection is enabled.
Functional Description
This function wraps the Fr_AckAbsoluteTimerIRQ function of the FlexRay Driver.
Particularities and Limitations
>  Precondition: The FlexRay Interface has to be initialized with a call of  FrIf_Init.
559H
>  This function is not available if the parameter FrIf/FrIfGeneral/FrIfAbsTimerIdx is set to 0.
>  For the parameter FrIf_CtrlIdx only the value 0 is allowed.
>  This function is implemented as macro to reduce code size if the “Wrapper APIs As Macro” option is
enabled for the FlexRay Interface.
Expected Caller Context
© 2017 Vector Informatik GmbH
Version 4.01.00
38
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
>  This function must be called by the application or integration code in the context of the timer interrupt
service routine.
Table 5-3
FrIf_AckAbsoluteTimerIRQ
5.2.3
FrIf_AckRelativeTimerIRQ
Table 5-4
FrIf_AckRelativeTimerIRQ
5.2.4
FrIf_AllowColdstart
Prototype
Std_ReturnType FrIf_AllowColdstart(uint8 FrIf_CtrlIdx)
Parameter
FrIf_CtrlIdx
Index of the FlexRay communication controller for which Fr_AllowColdstart
shall be called.
Return code
E_OK
The call of the FlexRay Driver API service Fr_AllowColdstart() has returned
E_OK.
E_NOT_OK
The call of the FlexRay Driver API service Fr_AllowColdstart() has returned
E_NOT_OK, or an error has been detected if development error detection is
enabled.
Functional Description
Call the function Fr_AllowColdstart of the FlexRay Driver.
Particularities and Limitations
>  Precondition: The FlexRay Interface has to be initialized with a call of  FrIf_Init.
561H
>  For the parameter FrIf_CtrlIdx only the value 0 is allowed.
>  This function is implemented as macro to reduce code size if the “Wrapper APIs As Macro” option is
enabled for the FlexRay Interface.
Expected Caller Context
>  This function can be called in any context.
Table 5-5
FrIf_AllowColdstart
5.2.5
FrIf_AllSlots
Prototype
Std_ReturnType FrIf_AllSlots(uint8 FrIf_CtrlIdx)
© 2017 Vector Informatik GmbH
Version 4.01.00
39
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
Parameter
FrIf_CtrlIdx
Index of the FlexRay communication controller for which Fr_AllSlots shall
be called.
Return code
E_OK
The call of the FlexRay Driver API service Fr_AllSlots() has returned E_OK.
E_NOT_OK
The call of the FlexRay Driver API service Fr_AllSlots() has returned
E_NOT_OK, or an error has been detected if development error
detection is enabled.
Functional Description
Call the function Fr_AllSlots of the FlexRay Driver.
Particularities and Limitations
>  Precondition: The FlexRay Interface has to be initialized with a call of  FrIf_Init.
587H
>  This API function is only available if the “All Slots Support” has been enabled for FlexRay Interface.
>  For the parameter FrIf_CtrlIdx only the value 0 is allowed.
>  This function is implemented as macro to reduce code size if the “Wrapper APIs As Macro” option is
enabled for the FlexRay Interface.
Expected Caller Context
>  This function can be called in any context.
Table 5-6
FrIf_AllSlots
5.2.6
FrIf_CancelAbsoluteTimer
Prototype
Std_ReturnType FrIf_CancelAbsoluteTimer(uint8 FrIf_CtrlIdx, uint8
FrIf_AbsTimerIdx)
Parameter
FrIf_CtrlIdx
The index of the FlexRay Communication Controller.
FrIf_AbsTimerIdx
Index of the absolute timer.
Return code
E_OK
The call of the FlexRay Driver API service Fr_CancelAbsoluteTimer() has
returned E_OK.
E_NOT_OK
The call of the FlexRay Driver API service Fr_CancelAbsoluteTimer() has
returned E_NOT_OK, or an error has been detected if development error
detection is enabled.
© 2017 Vector Informatik GmbH
Version 4.01.00
40
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
Functional Description
This function wraps the Fr_CancelAbsoluteTimer function of the FlexRay Driver.
Particularities and Limitations
>  Precondition: The FlexRay Interface has to be initialized with a call of  FrIf_Init.
562H
>  This function is not available if the parameter FrIf/FrIfGeneral/FrIfAbsTimerIdx is set to 0.
>  For the parameter FrIf_CtrlIdx only the value 0 is allowed.
>  As one FlexRay timer is used by the FlexRay Interface this function must not be used for timer 0.
>  This function is implemented as macro to reduce code size if the “Wrapper APIs As Macro” option is
enabled for the FlexRay Interface.
Expected Caller Context
>  This function can be called in any context.
Table 5-7
FrIf_CancelAbsoluteTimer
5.2.7
FrIf_CancelRelativeTimer (optional)
Table 5-8
FrIf_CancelRelativeTimer
5.2.8
FrIf_CancelTransmit (optional)
Prototype
Std_ReturnType FrIf_CancelTransmit(PduIdType FrIf_TxPduId)
Parameter
FrIf_TxPduId
FrIf-ID of the PDU to be cancelled.
Return code
E_OK
The cancelation request has been accepted.
E_NOT_OK
The cancelation request has been rejected, or an error has been detected if
development error detection is enabled.
Functional Description
This function cancels the transmission of a PDU by clearing the number of indications of ready PDU data.
Particularities and Limitations
>  Precondition: The FlexRay Interface has to be initialized with a call of  FrIf_Init.
609H
>  This API function is only available if the “Cancel Transmit Support” has been enabled for FlexRay
Interface.
>  During its runtime this function temporarily disables all interrupts.
Expected Caller Context
© 2017 Vector Informatik GmbH
Version 4.01.00
41
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
>  This function can be called in any context.
Table 5-9
FrIf_CancelTransmit (optional)
5.2.9
FrIf_CheckWakeupByTransceiver
Prototype
void FrIf_CheckWakeupByTransceiver(uint8 FrIf_CtrlIdx, Fr_ChannelType
FrIf_ChnlIdx)
Parameter
FrIf_CtrlIdx
The index of the FlexRay communication controller to which the transceiver
is connected.
FrIf_ChnlIdx
The index of the FlexRay channel to which the transceiver is connected.
Return code
E_OK
The call of the FlexRay Transceiver Driver API service
FrTrcv_CheckWakeupByTransceiver() has returned E_OK.
E_NOT_OK
The call of the FlexRay Transceiver Driver API service
FrTrcv_CheckWakeupByTransceiver() has returned E_NOT_OK, or an error
has been detected if development error detection is enabled.
Functional Description
This function wraps the FrTrcv_CheckWakeupByTransceiver function of the FlexRay Transceiver Driver.
Particularities and Limitations
>  Precondition: The FlexRay Interface has to be initialized with a call of  FrIf_Init.
564H
>  This API function is only available if the MICROSAR FlexRay Transceiver component is enabled in
configuration tool.
>  For the parameter FrIf_CtrlIdx only the value 0 is allowed.
>  This function is implemented as macro to reduce code size if the “Wrapper APIs As Macro” option is
enabled for the FlexRay Interface.
Expected Caller Context
>  This function can be called in any context.
Table 5-10
FrIf_CheckWakupByTransceiver
5.2.10
FrIf_ClearTransceiverWakeup
Prototype
Std_ReturnType FrIf_ClearTransceiverWakeup(uint8 FrIf_CtrlIdx,
Fr_ChannelType FrIf_ChnlIdx)
© 2017 Vector Informatik GmbH
Version 4.01.00
42
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
Parameter
FrIf_CtrlIdx
The index of the FlexRay communication controller to which the transceiver
is connected.
FrIf_ChnlIdx
The index of the FlexRay channel to which the transceiver is connected.
Return code
E_OK
The call of the FlexRay Transceiver Driver API service
FrTrcv_ClearTransceiverWakeup() has returned BUSTRCV_E_OK.
E_NOT_OK
The call of the FlexRay Transceiver Driver API service
FrTrcv_ClearTransceiverWakeup() has returned BUSTRCV_E_ERROR, or an
error has been detected if development error detection is enabled.
Functional Description
This function wraps the FrTrcv_ClearTransceiverWakeup function of the FlexRay Transceiver Driver.
Particularities and Limitations
>  Precondition: The FlexRay Interface has to be initialized with a call of  FrIf_Init.
565H
>  This API function is only available if the MICROSAR FlexRay Transceiver component is enabled in the
configuration tool.
>  For the parameter FrIf_CtrlIdx only the value 0 is allowed.
>  This function is implemented as macro to reduce code size if the “Wrapper APIs As Macro” option is
enabled for the FlexRay Interface.
Expected Caller Context
>  This function can be called in any context.
Table 5-11
FrIf_ClearTransceiverWakeup

5.2.11
FrIf_ControllerInit
Prototype
void FrIf_ControllerInit(uint8 FrIf_CtrlIdx)
Parameter
FrIf_CtrlIdx
Index of the FlexRay communication controller to be initialized. Only 0 is
allowed.
Return code
E_OK
The call of the FlexRay Driver API service Fr_ControllerInit() has returned
E_OK.
© 2017 Vector Informatik GmbH
Version 4.01.00
43
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
E_NOT_OK
The call of the FlexRay Driver API service Fr_ControllerInit() has returned
E_NOT_OK, or an error has been detected if development error detection is
enabled.
Functional Description
This function initializes one FlexRay communication controller by calling Fr_ControllerInit of the FlexRay
Driver.
Particularities and Limitations
>  Precondition: The FlexRay Interface has to be initialized with a call of  FrIf_Init.
566H
>  If this function is called during active communication, the communication of all FlexRay
communication controllers will be terminated.
>  This function is implemented as macro to reduce code size if the “Wrapper APIs As Macro” option is
enabled for the FlexRay Interface.
Expected Caller Context
>  This function can be called in any context.
Table 5-12
FrIf_ControllerInit
5.2.12
FrIf_DisableLPdu (optional)
Prototype
Std_ReturnType FrIf_DisableLPdu(uint8 FrIf_CtrlIdx, int16 FrIf_LPduIdx)
Parameter
FrIf_CtrlIdx
Index of the FlexRay communication controller for which Fr_DisableLPdu
shall be called.
FrIf_LPduIdx
This index is used to uniquely identify a FlexRay frame.
Return code
E_OK
The call of the FlexRay Driver API service Fr_DisableLPdu() has returned
E_OK.
E_NOT_OK
The call of the FlexRay Driver API service Fr_DisableLPdu() has returned
E_NOT_OK, or an error has been detected if development error detection is
enabled.
Functional Description
According to AUTOSAR 4.0 this function wraps the Fr_DisableLPdu of the FlexRay Driver to disable the
message buffer of the given L-PDU.
© 2017 Vector Informatik GmbH
Version 4.01.00
44
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
Particularities and Limitations
>  Precondition: The FlexRay Interface has to be initialized with a call of  FrIf_Init.
595H
>  This function is not available if the parameter FrIf/FrIfGeneral/FrIfDisableLPduSupport is set to true.
>  Only the L-PDUs with the “Reconfigurable” flag enabled can be disabled by this API.
>  For the parameter FrIf_CtrlIdx only the value 0 is allowed.
>  This function is implemented as macro to reduce code size if the “Wrapper APIs As Macro” option is
enabled for the FlexRay Interface.
Expected Caller Context
>  This function can be called in any context.
Table 5-13
FrIf_DisableLPdu
5.2.13
FrIf_DisableAbsoluteTimerIRQ
Prototype
Std_ReturnType FrIf_DisableAbsoluteTimerIRQ(uint8 FrIf_CtrlIdx, uint8
FrIf_AbsTimerIdx)
Parameter
FrIf_CtrlIdx
The index of the FlexRay Communication Controller.
FrIf_AbsTimerIdx
Index of the absolute timer.
Return code
E_OK
The call of the FlexRay Driver API service Fr_DisableAbsoluteTimerIRQ() has
returned E_OK.
E_NOT_OK
The call of the FlexRay Driver API service Fr_DisableAbsoluteTimerIRQ() has
returned E_NOT_OK, or an error has been detected if development error
detection is enabled.
Functional Description
This function wraps the Fr_DisableAbsoluteTimerIRQ function of the FlexRay Driver.
Particularities and Limitations
>  Precondition: The FlexRay Interface has to be initialized with a call of  FrIf_Init.
569H
>  This function is not available if the parameter FrIf/FrIfGeneral/FrIfAbsTimerIdx is set to 0.
>  For the parameter FrIf_CtrlIdx only the value 0 is allowed.
>  This function is implemented as macro to reduce code size if the “Wrapper APIs As Macro” option is
enabled for the FlexRay Interface.
Expected Caller Context
>  This function can be called in any context.
© 2017 Vector Informatik GmbH
Version 4.01.00
45
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
Table 5-14
FrIf_DisableAbsoluteTimerIRQ
5.2.14
FrIf_DisableRelativeTimerIRQ

5.2.15
FrIf_DisableTransceiverBranch
Prototype
Std_ReturnType FrIf_DisableTransceiverWakeup(uint8 FrIf_CtrlIdx,
Fr_ChannelType FrIf_ChnlIdx, uint8 FrIf_BranchIdx)
Parameter
FrIf_CtrlIdx
The index of the FlexRay communication controller to which the transceiver
is connected.
FrIf_ChnlIdx
The index of the FlexRay channel to which the transceiver is connected.
FrIf_BranchIdx
This zero based index identifies the branch of the (active star)  transceiver to
which the API call has to be applied.
Return code
E_OK
The call of the FlexRay Transceiver Driver API service
FrTrcv_DisableTransceiverBranch() has returned E_OK.
E_NOT_OK
The call of the FlexRay Transceiver Driver API service
FrTrcv_DisableTransceiverBranch() has returned E_NOT_OK, or an error has
been detected if development error detection is enabled.
Functional Description
This function wraps the FrTrcv_DisableTransceiverBranch function of the FlexRay Transceiver Driver.
Particularities and Limitations
>  Precondition: The FlexRay Interface has to be initialized with a call of  FrIf_Init.
571H
>  This API function is only available if the MICROSAR FlexRay Transceiver component is enabled in the
configuration tool.
>  For the parameter FrIf_CtrlIdx only the value 0 is allowed.
>  This function is implemented as macro to reduce code size if the “Wrapper APIs As Macro” option is
enabled for the FlexRay Interface.
Expected Caller Context
>  This function can be called in any context.
Table 5-15
FrIf_DisableTransceiverBranch
© 2017 Vector Informatik GmbH
Version 4.01.00
46
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
5.2.16
FrIf_EnableAbsoluteTimerIRQ
Prototype
Std_ReturnType FrIf_EnableAbsoluteTimerIRQ(uint8 FrIf_CtrlIdx, uint8
FrIf_AbsTimerIdx)
Parameter
FrIf_CtrlIdx
The index of the FlexRay Communication Controller.
FrIf_AbsTimerIdx
Index of the absolute timer.
Return code
E_OK
The call of the FlexRay Driver API service Fr_EnableAbsoluteTimerIRQ() has
returned E_OK.
E_NOT_OK
The call of the FlexRay Driver API service Fr_EnableAbsoluteTimerIRQ() has
returned E_NOT_OK, or an error has been detected if development error
detection is enabled.
Functional Description
This function wraps the Fr_EnableAbsoluteTimerIRQ function of the FlexRay Driver.
Particularities and Limitations
>  Precondition: The FlexRay Interface has to be initialized with a call of  FrIf_Init.
572H
>  This function is not available if the parameter FrIf/FrIfGeneral/FrIfAbsTimerIdx is set to 0.
>  For the parameter FrIf_CtrlIdx only the value 0 is allowed.
>  This function is implemented as macro to reduce code size if the “Wrapper APIs As Macro” option is
enabled for the FlexRay Interface.
Expected Caller Context
>  This function can be called in any context.
Table 5-16
FrIf_EnableAbsoluteTimerIRQ
5.2.17
FrIf_EnableRelativeTimerIRQ

5.2.18
FrIf_EnableTransceiverBranch
Prototype
Std_ReturnType FrIf_EnableTransceiverBranch(uint8 FrIf_CtrlIdx,
Fr_ChannelType FrIf_ChnlIdx, uint8 FrIf_BranchIdx)
Parameter
FrIf_CtrlIdx
The index of the FlexRay communication controller to which the transceiver
is connected.
© 2017 Vector Informatik GmbH
Version 4.01.00
47
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
FrIf_ChnlIdx
The index of the FlexRay channel to which the transceiver is connected.
FrIf_BranchIdx
This zero based index identifies the branch of the (active star) transceiver to
which the API call has to be applied.
Return code
E_OK
The call of the FlexRay Transceiver Driver API service
FrTrcv_EnableTransceiverBranch() has returned E_OK.
E_NOT_OK
The call of the FlexRay Transceiver Driver API service
FrTrcv_EnableTransceiverBranch() has returned E_NOT_OK, or an error has
been detected if development error detection is enabled.
Functional Description
This function wraps the FrTrcv_EnableTransceiverBranch function of the FlexRay Transceiver Driver.
Particularities and Limitations
>  Precondition: The FlexRay Interface has to be initialized with a call of  FrIf_Init.
574H
>  This API function is only available if the MICROSAR FlexRay Transceiver component is enabled in the
configuration tool.
>  For the parameter FrIf_CtrlIdx only the value 0 is allowed.
>  This function is implemented as macro to reduce code size if the “Wrapper APIs As Macro” option is
enabled for the FlexRay Interface.
Expected Caller Context
>  This function can be called in any context.
Table 5-17
FrIf_EnableTransceiverBranch
5.2.19
FrIf_GetAbsoluteTimerIRQStatus
Prototype
Std_ReturnType FrIf_GetAbsoluteTimerIRQStatus(uint8 FrIf_CtrlIdx, uint8
FrIf_AbsTimerIdx)
Parameter
FrIf_CtrlIdx
The index of the FlexRay Communication Controller.
FrIf_AbsTimerIdx
Index of the absolute timer.
Return code
E_OK
The call of the FlexRay Driver API service Fr_GetAbsoluteTimerIRQStatus()
has returned E_OK.
E_NOT_OK
The call of the FlexRay Driver API service Fr_GetAbsoluteTimerIRQStatus()
has returned E_NOT_OK, or an error has been detected if development error
detection is enabled.
© 2017 Vector Informatik GmbH
Version 4.01.00
48
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
Functional Description
This function wraps the Fr_GetAbsoluteTimerIRQStatus function of the FlexRay Driver.
Particularities and Limitations
>  Precondition: The FlexRay Interface has to be initialized with a call of  FrIf_Init.
575H
>  This function is not available if the parameter FrIf/FrIfGeneral/FrIfAbsTimerIdx is set to 0.
>  For the parameter FrIf_CtrlIdx only the value 0 is allowed.
>  This function is implemented as macro to reduce code size if the “Wrapper APIs As Macro” option is
enabled for the FlexRay Interface.
Expected Caller Context
>  This function can be called in any context.
Table 5-18
FrIf_GetAbsoluteTimerIRQStatus
5.2.20
FrIf_GetChannelStatus (optional)
Prototype
Std_ReturnType FrIf_GetChannelStatus(uint8 FrIf_CtrlIdx, uint16*
FrIf_ChannelAStatusPtr, uint16* FrIf_ChannelBStatusPtr)
Parameter
FrIf_CtrlIdx
Index of the FlexRay communication controller for which Fr_GetGlobalTime
shall be called.
FrIf_ChannelAStatusPtr
Address where the bitcoded channel A status information shall be stored
FrIf_ChannelBStatusPtr
Address where the bitcoded channel B status information shall be stored
Return code
E_OK
The call of the FlexRay Driver API service Fr_GetChannelStatus() has returned
E_OK.
E_NOT_OK
The call of the FlexRay Driver API service Fr_GetChannelStatus() has returned
E_NOT_OK, or an error has been detected if development error detection is
enabled.
Functional Description
This function wraps the Fr_GetChannelStatus of the FlexRay Driver according to AUTOSAR 4.0.
© 2017 Vector Informatik GmbH
Version 4.01.00
49
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
Particularities and Limitations
>  Precondition: The FlexRay Interface has to be initialized with a call of  FrIf_Init.
576H
>  This API function is only available if the “Get Channel Status Support” has been enabled for FlexRay
Interface and FlexRay Driver.
>  For the parameter FrIf_CtrlIdx only the value 0 is allowed.
>  This function is implemented as macro to reduce code size if the “Wrapper APIs As Macro” option is
enabled for the FlexRay Interface.
Expected Caller Context
>  This function can be called in any context.
Table 5-19
FrIf_GetChannelStatus (optional)
5.2.21
FrIf_GetClockCorrection (optional)
Prototype
Std_ReturnType FrIf_GetClockCorrection(uint8 FrIf_CtrlIdx, sint16*
FrIf_RateCorrectionPtr, sint32* FrIf_OffsetCorrectionPtr)
Parameter
FrIf_CtrlIdx
Index of the FlexRay communication controller for which Fr_GetGlobalTime
shall be called.
FrIf_RateCorrectionPtr
Address where the current rate correction value shall be stored.
FrIf_OffsetCorrectionPtr
Address where the current offset correction value shall be stored.
Return code
E_OK
The call of the FlexRay Driver API service Fr_GetClockCorrection() has
returned E_OK.
E_NOT_OK
The call of the FlexRay Driver API service Fr_GetClockCorrection() has
returned E_NOT_OK, or an error has been detected if development error
detection is enabled.
Functional Description
This function wraps the Fr_GetClockCorrection of the FlexRay Driver according to AUTOSAR 4.0..
Particularities and Limitations
>  Precondition: The FlexRay Interface has to be initialized with a call of  FrIf_Init.
577H
>  This API function is only available if the “Get Clock Correction Support” has been enabled for
FlexRay Interface and FlexRay Driver.
>  For the parameter FrIf_CtrlIdx only the value 0 is allowed.
>  This function is implemented as macro to reduce code size if the “Wrapper APIs As Macro” option is
enabled for the FlexRay Interface.
© 2017 Vector Informatik GmbH
Version 4.01.00
50
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
Expected Caller Context
>  This function can be called in any context.
Table 5-20
FrIf_GetClockCorrection (optional)
5.2.22
FrIf_GetCycleLength
Prototype
uint32 FrIf_GetCycleLength(uint8 FrIf_CtrlIdx)
Parameter
FrIf_CtrlIdx
Index of the FlexRay CC to address.
Return code
uint32

Time in unit of nanoseconds.
Functional Description
This API returns the configured time of the configuration parameter "GdCycle" in nanoseconds for the
FlexRay controller with index FrIf_CtrlIdx.
Particularities and Limitations
>  Precondition: The FlexRay Interface has to be initialized with a call of  FrIf_Init.
578H
>  For the parameter FrIf_CtrlIdx only the value 0 is allowed.
Expected Caller Context
>  This function can be called in any context.
Table 5-21 FrIf_GetCycleLength
5.2.23
FrIf_GetGlobalTime
Prototype
Std_ReturnType FrIf_GetGlobalTime(uint8 FrIf_CtrlIdx, uint8*
FrIf_CyclePtr, uint16* FrIf_MacroTickPtr)
Parameter
FrIf_CtrlIdx
Index of the FlexRay communication controller for which Fr_GetGlobalTime
shall be called.
FrIf_CyclePtr
Reference to the memory location the current FlexRay communication cycle
will be stored at.
FrIf_MacroTickPtr
Reference to the memory location the current macrotick value will be stored
at.
© 2017 Vector Informatik GmbH
Version 4.01.00
51
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
Return code
E_OK
The call of the FlexRay Driver API service Fr_GetGlobalTime() has returned
E_OK.
E_NOT_OK
The call of the FlexRay Driver API service Fr_GetGlobalTime() has returned
E_NOT_OK, or an error has been detected if development error detection is
enabled.
Functional Description
Call the function Fr_GetGlobalTime of the FlexRay Driver.
Particularities and Limitations
>  Precondition: The FlexRay Interface has to be initialized with a call of  FrIf_Init.
578H
>  For the parameter FrIf_CtrlIdx only the value 0 is allowed.
>  The FlexRay global time is only defined if the FlexRay bus is synchronized. If this function is called while
the communication controller is not in POC state normal active, it will return E_NOT_OK.
>  This function is implemented as macro to reduce code size if the “Wrapper APIs As Macro” option is
enabled for the FlexRay Interface.
Expected Caller Context
>  This function can be called in any context.
Table 5-22
FrIf_GetGlobalTime
5.2.24
FrIf_GetMacrotickDuration
Prototype
uint16 FrIf_GetMacrotickDuration(uint8 FrIf_CtrlIdx)
Parameter
FrIf_CtrlIdx
Index of the FlexRay controller for which the macro tick duration shall be
determined.
Return code
uint16
The duration of a macro tick in nanoseconds.
Functional Description
This function returns the duration of a macro tick.
Particularities and Limitations
>  Precondition: The FlexRay Interface has to be initialized with a call of  FrIf_Init.
579H
>  For the parameter FrIf_CtrlIdx only the value 0 is allowed.
Expected Caller Context
>  This function can be called in any context.
© 2017 Vector Informatik GmbH
Version 4.01.00
52
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
Table 5-23
FrIf_GetMacrotickDuration
5.2.25
FrIf_GetMacroticksPerCycle
Prototype
uint16 FrIf_GetMacroticksPerCycle (uint8 FrIf_CtrlIdx)
Parameter
FrIf_CtrlIdx
Index of the FlexRay controller for which the number of macro ticks per cycle
shall be determined.
Return code
uint16
The number of macro ticks per cycle.
Functional Description
This function returns the number of macro ticks per cycle.
Particularities and Limitations
>  Precondition: The FlexRay Interface has to be initialized with a call of  FrIf_Init.
579H
>  For the parameter FrIf_CtrlIdx only the value 0 is allowed.
Expected Caller Context
>  This function can be called in any context.
Table 5-24
FrIf_GetMacrotickDuration
5.2.26
FrIf_GetNmVector
Prototype
Std_ReturnType FrIf_GetNmVector(uint8 FrIf_CtrlIdx, uint8*
FrIf_NmVectorPtr)
Parameter
FrIf_CtrlIdx
Index of the FlexRay communication controller for which Fr_GetNmVector
shall be called.
FrIf_NmVectorPtr
Pointer to a memory location where the NM vector will be stored.
Return code
E_OK
The call of the FlexRay Driver API service Fr_GetNmVector() has returned
E_OK.
E_NOT_OK
The call of the FlexRay Driver API service Fr_GetNmVector() has returned
E_NOT_OK, or an error has been detected if development error detection is
enabled.
© 2017 Vector Informatik GmbH
Version 4.01.00
53
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
Functional Description
Call the function Fr_GetNmVector of the FlexRay Driver.
Particularities and Limitations
>  Precondition: The FlexRay Interface has to be initialized with a call of  FrIf_Init.
581H
>  This API function is only available if the “Get NM Vector Support” has been enabled for FlexRay
Interface and FlexRay Driver.
>  For the parameter FrIf_CtrlIdx only the value 0 is allowed.
>  This function is implemented as macro to reduce code size if the “Wrapper APIs As Macro” option is
enabled for the FlexRay Interface.
Expected Caller Context
>  This function can be called in any context.
Table 5-25
FrIf_GetNmVector
5.2.27
FrIf_GetNumOfStartupFrames
Prototype
Std_ReturnType FrIf_GetNumOfStartupFrames(uint8 FrIf_CtrlIdx, uint8*
FrIf_NumOfStartupFramesPtr)
Parameter
FrIf_CtrlIdx
Index of the FlexRay communication controller for which
Fr_GetNumOfStartupFrames() shall be called.
FrIf_NumOfStartupFramesPtr  Address where the number of startup frames seen within the last even/odd
cycle pair shall be stored.
Return code
E_OK
The call of the FlexRay Driver API service Fr_GetNumOfStartupFrames() has
returned E_OK.
E_NOT_OK
The call of the FlexRay Driver API service Fr_GetNumOfStartupFrames() has
returned E_NOT_OK, or an error has been detected if development error
detection is enabled.
Functional Description
Call the function Fr_GetNumOfStartupFrames of the FlexRay Driver.
© 2017 Vector Informatik GmbH
Version 4.01.00
54
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
Particularities and Limitations
>  Precondition: The FlexRay Interface has to be initialized with a call of  FrIf_Init.
587H
>  This API function is only available if the “Get Num Of Startup Frames Support” has been enabled for
FlexRay Interface.
>  For the parameter FrIf_CtrlIdx only the value 0 is allowed.
>  This function is implemented as macro to reduce code size if the “Wrapper APIs As Macro” option is
enabled for the FlexRay Interface.
Expected Caller Context
>  This function can be called in any context.
Table 5-26
FrIf_GetNumOfStartupFrames
5.2.28
FrIf_GetPOCStatus
Prototype
Std_ReturnType FrIf_GetPOCStatus(uint8 FrIf_CtrlIdx, Fr_POCStatusType*
FrIf_POCStatusPtr)
Parameter
FrIf_CtrlIdx
Index of the FlexRay communication controller for which Fr_GetPOCStatus
shall be called.
FrIf_POCStatusPtr
Pointer to a memory location where the output value will be stored.
Return code
E_OK
The call of the FlexRay Driver API service Fr_GetPOCStatus() has returned
E_OK.
E_NOT_OK
The call of the FlexRay Driver API service Fr_GetPOCStatus() has returned
E_NOT_OK, or an error has been detected if development error detection is
enabled.
Functional Description
Call the function Fr_GetPOCStatus of the FlexRay Driver.
Particularities and Limitations
>  Precondition: The FlexRay Interface has to be initialized with a call of  FrIf_Init.
582H
>  For the parameter FrIf_CtrlIdx only the value 0 is allowed.
>  This function is implemented as macro to reduce code size if the “Wrapper APIs As Macro” option is
enabled for the FlexRay Interface.
Expected Caller Context
>  This function can be called in any context.
Table 5-27
FrIf_GetPOCStatus
© 2017 Vector Informatik GmbH
Version 4.01.00
55
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
5.2.29
FrIf_GetRelativeTimerIRQStatus
Table 5-28
FrIf_GetRelativeTimerIRQStatus
5.2.30
FrIf_GetState
Prototype
Std_ReturnType FrIf_GetState(uint8 FrIf_ClstIdx, FrIf_StateType
*FrIf_StatePtr)
Parameter
FrIf_ClstIdx
Index of the FlexRay cluster for which the state of the FlexRay Interface shall
be determined.
FrIf_StatePtr
Pointer to a memory location where the retrieved FrIf_State will be stored.
Return code
E_OK
Function was successfully executed.
E_NOT_OK
Function execution failed due to detected errors.
Functional Description
Determine the state of the FlexRay Interface for the given cluster which can be either
FRIF_STATE_OFFLINE or  FRIF_STATE_ONLINE.
584H
585H
Particularities and Limitations
>  Precondition: The FlexRay Interface has to be initialized with a call of  FrIf_Init.
586H
>  For the parameter FrIf_ClstIdx only the value 0 is allowed.
Expected Caller Context
>  This function can be called in any context.
Table 5-29
FrIf_GetState

5.2.31
FrIf_GetSyncFrameList (optional)
Prototype
Std_ReturnType FrIf_GetSyncFrameList(uint8 FrIf_CtrlIdx, uint8
FrIf_ListSize, uint16* FrIf_ChannelAEvenListPtr, int16*
FrIf_ChannelBEvenListPtr, int16* FrIf_ChannelAOddListPtr, uint16*
FrIf_ChannelBOddListPtr)
Parameter
FrIf_CtrlIdx
Index of the FlexRay communication controller for which
Fr_GetSyncFrameList shall be called.
© 2017 Vector Informatik GmbH
Version 4.01.00
56
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
FrIf_ListSize
Size of the arrays passed via parameters:
- FrIf_ChannelAEvenListPtr FrIf_ChannelBEvenListPtr
- FrIf_ChannelAOddListPtr FrIf_ChannelBOddListPtr.
The service must ensure to not write more entries into those arrays than
granted by this parameter.
FrIf_ChannelAEvenListPtr
Address the list of sync frames on channel A within the even communication
cycle is written to. The exact number of elements written to the list is limited
by parameter FrIf_ListSize. Unused list elements are filled with the value '0'
to indicate that no more sync frame has been seen.
FrIf_ChannelBEvenListPtr
Address the list of sync frames on channel B within the even communication
cycle is written to. The exact number of elements written to the list is limited
by parameter FrIf_ListSize. Unused list elements are filled with the value '0'
to indicate that no more sync frame has been seen.
FrIf_ChannelAOddListPtr
Address the list of sync frames on channel A within the odd communication
cycle is written to. The exact number of elements written to the list is limited
by parameter FrIf_ListSize. Unused list elements are filled with the value '0'
to indicate that no more sync frame has been seen.
FrIf_ChannelBOddListPtr
Address the list of sync frames on channel B within the odd communication
cycle is written to. The exact number of elements written to the list is limited
by parameter FrIf_ListSize. Unused list elements are filled with the value '0'
to indicate that no more sync frame has been seen.
Return code
E_OK
The call of the FlexRay Driver API service Fr_GetSyncFrameList() has returned
E_OK.
E_NOT_OK
The call of the FlexRay Driver API service Fr_GetSyncFrameList() has returned
E_NOT_OK, or an error has been detected if development error detection is
enabled.
Functional Description
According to AUTOSAR 4.0 this function wraps the Fr_GetSyncFrameList() of the FlexRay Driver to read
the list of sync frames received in the last two communication cycles and write it to the given arrays.
Particularities and Limitations
>  Precondition: The FlexRay Interface has to be initialized with a call of  FrIf_Init.
587H
>  This API function is only available if the “Get Sync Frame List Support” has been enabled for FlexRay
Interface and FlexRay Driver.
>  The FrIf_ListSize parameter is limited to a maximum of 15 by the FlexRay Driver.
>  For the parameter FrIf_CtrlIdx only the value 0 is allowed.
>  This function is implemented as macro to reduce code size if the “Wrapper APIs As Macro” option is
enabled for the FlexRay Interface.
© 2017 Vector Informatik GmbH
Version 4.01.00
57
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
Expected Caller Context
>  This function can be called in any context.
Table 5-30
FrIf_GetSyncFrameList (optional)
5.2.32
FrIf_GetTransceiverError
Prototype
Std_ReturnType FrIf_GetTransceiverMode(uint8 FrIf_CtrlIdx,
Fr_ChannelType FrIf_ChnlIdx, uint8 FrIf_BranchIdx, uint32*
FrIf_BusErrorState)
Parameter
FrIf_CtrlIdx
The index of the FlexRay communication controller to which the transceiver
is connected.
FrIf_ChnlIdx
The index of the FlexRay channel to which the transceiver is connected.
FrIf_BranchIdx
This zero based index identifies the branch of the (active star) transceiver to
which the API call has to be applied.
FrIf_BusErrorState
Address where the transceiver error state is stored.
Return code
E_OK
The call of the FlexRay Transceiver Driver API service
FrTrcv_GetTransceiverError() has returned E_OK.
E_NOT_OK
The call of the FlexRay Transceiver Driver API service
FrTrcv_GetTransceiverError() has returned E_NOT_OK, or an error has been
detected if development error detection is enabled.
Functional Description
This function wraps the FrTrcv_GetTransceiverError() function of the FlexRay Transceiver Driver.
The enum value "FR_CHANNEL_AB" shall not be used.
Particularities and Limitations
>  Precondition: The FlexRay Interface has to be initialized with a call of  FrIf_Init.
588H
>  This API function is only available if the MICROSAR FlexRay Transceiver component is enabled in the
configuration tool.
>  For the parameter FrIf_CtrlIdx only the value 0 is allowed.
>  This function is implemented as macro to reduce code size if the “Wrapper APIs As Macro” option is
enabled for the FlexRay Interface.
Expected Caller Context
>  This function can be called in any context.
Table 5-31
FrIf_GetTransceiverError
© 2017 Vector Informatik GmbH
Version 4.01.00
58
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
5.2.33
FrIf_GetTransceiverMode
Prototype
Std_ReturnType FrIf_GetTransceiverMode(uint8 FrIf_CtrlIdx,
Fr_ChannelType FrIf_ChnlIdx, FrTrcv_TrcvModeType* FrIf_TrcvModePtr)
Parameter
FrIf_CtrlIdx
The index of the FlexRay communication controller to which the transceiver
is connected.
FrIf_ChnlIdx
The index of the FlexRay channel to which the transceiver is connected.
FrIf_TrcvModePtr
The memory location to which the mode shall be written.
Return code
E_OK
The call of the FlexRay Transceiver Driver API service
FrTrcv_GetTransceiverMode() has returned BUSTRCV_E_OK.
E_NOT_OK
The call of the FlexRay Transceiver Driver API service
FrTrcv_GetTransceiverMode() has returned BUSTRCV_E_ERROR, or an error
has been detected if development error detection is enabled.
Functional Description
This function wraps the FrTrcv_GetTransceiverMode function of the FlexRay Transceiver Driver.
Particularities and Limitations
>  Precondition: The FlexRay Interface has to be initialized with a call of  FrIf_Init.
588H
>  This API function is only available if the MICROSAR FlexRay Transceiver component is enabled in the
configuration tool.
>  For the parameter FrIf_CtrlIdx only the value 0 is allowed.
>  This function is implemented as macro to reduce code size if the “Wrapper APIs As Macro” option is
enabled for the FlexRay Interface.
Expected Caller Context
>  This function can be called in any context.
Table 5-32
FrIf_GetTransceiverMode
5.2.34
FrIf_GetTransceiverWUReason
Prototype
Std_ReturnType FrIf_GetTransceiverWUReason(uint8 FrIf_CtrlIdx,
Fr_ChannelType FrIf_ChnlIdx, FrTrcv_TrcvWUReasonType*
FrIf_TrcvWUReasonPtr)
© 2017 Vector Informatik GmbH
Version 4.01.00
59
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
Parameter
FrIf_CtrlIdx
The index of the FlexRay communication controller to which the transceiver
is connected.
FrIf_ChnlIdx
The index of the FlexRay channel to which the transceiver is connected.
FrIf_TrcvWUReasonPtr
The memory location to which the wake-up reason shall be written.
Return code
E_OK
The call of the FlexRay Transceiver Driver API service
FrTrcv_GetTransceiverWUReason() has returned BUSTRCV_E_OK.
E_NOT_OK
The call of the FlexRay Transceiver Driver API service
FrTrcv_GetTransceiverWUReason() has returned BUSTRCV_E_ERROR, or an
error has been detected if development error detection is enabled.
Functional Description
This function wraps the FrTrcv_GetTransceiverWUReason function of the FlexRay Transceiver Driver.
Particularities and Limitations
>  Precondition: The FlexRay Interface has to be initialized with a call of  FrIf_Init.
589H
>  This API function is only available if the MICROSAR FlexRay Transceiver component is enabled in the
configuration tool.
>  For the parameter FrIf_CtrlIdx only the value 0 is allowed.
>  This function is implemented as macro to reduce code size if the “Wrapper APIs As Macro” option is
enabled for the FlexRay Interface.
Expected Caller Context
>  This function can be called in any context.
Table 5-33
FrIf_GetTransceiverWUReason
5.2.35
FrIf_GetWakeupRxStatus
Prototype
Std_ReturnType FrIf_GetWakeupRxStatus(uint8 FrIf_CtrlIdx, uint8*
FrIf_WakeupRxStatusPtr)
Parameter
FrIf_CtrlIdx
Index of the FlexRay communication controller for which
Fr_GetWakeupRxStatus shall be called.
FrIf_WakeupRxStatusPtr
Address where bitcoded wakeup reception status shall be stored.
  Bit 0: Wakeup received on channel A indicator
  Bit 1: Wakeup received on channel B indicator
  Bit 2-7: Unused
© 2017 Vector Informatik GmbH
Version 4.01.00
60
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
Return code
E_OK
The call of the FlexRay Driver API service Fr_GetWakeupRxStatus () has
returned E_OK.
E_NOT_OK
The call of the FlexRay Driver API service Fr_GetWakeupRxStatus () has
returned E_NOT_OK, or an error has been detected if development error
detection is enabled.
Functional Description
Call the function Fr_GetWakeupRxStatus of the FlexRay Driver.
Particularities and Limitations
>  Precondition: The FlexRay Interface has to be initialized with a call of  FrIf_Init.
587H
>  This API function is only available if the “Get Wakeup Rx Status Support” has been enabled for
FlexRay Interface.
>  For the parameter FrIf_CtrlIdx only the value 0 is allowed.
>  This function is implemented as macro to reduce code size if the “Wrapper APIs As Macro” option is
enabled for the FlexRay Interface.
Expected Caller Context
>  This function can be called in any context.
Table 5-34
FrIf_GetWakeupRxStatus
5.2.36
FrIf_HaltCommunication
Prototype
Std_ReturnType FrIf_HaltCommunication(uint8 FrIf_CtrlIdx)
Parameter
FrIf_CtrlIdx
Index of the FlexRay communication controller for which
Fr_HaltCommunication shall be called.
Return code
E_OK
The call of the FlexRay Driver API service Fr_HaltCommunication() has
returned E_OK.
E_NOT_OK
The call of the FlexRay Driver API service Fr_HaltCommunication() has
returned E_NOT_OK, or an error has been detected if development error
detection is enabled.
Functional Description
Call the function Fr_HaltCommunication of the FlexRay Driver.
© 2017 Vector Informatik GmbH
Version 4.01.00
61
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
Particularities and Limitations
>  Precondition: The FlexRay Interface has to be initialized with a call of  FrIf_Init.
590H
>  For the parameter FrIf_CtrlIdx only the value 0 is allowed.
>  This function is implemented as macro to reduce code size if the “Wrapper APIs As Macro” option is
enabled for the FlexRay Interface.
Expected Caller Context
>  This function can be called in any context.
Table 5-35
FrIf_HaltCommunication
5.2.37
FrIf_Init
Prototype
void FrIf_Init(const FrIf_ConfigType *FrIf_ConfigPtr)
Parameter
FrIf_ConfigPtr
Pointer to the post-build configuration data structure of the FlexRay
Interface. If the configuration variant pre-compile is used, the pointer given
to  FrIf_Init is ignored.
591H
Return code
Void
-
Functional Description
This function is used to initialize the FlexRay Interface. The configuration data that shall be used by the
FlexRay Interface is passed as parameter.
Particularities and Limitations
>  If this function is called during active communication, the communication of all FlexRay
communication controllers will be terminated.
Expected Caller Context
>  This function can be called in any context.
Table 5-36
FrIf_Init
5.2.38
FrIf_InitMemory
Prototype
void FrIf_InitMemory(void)
Parameter
Void
-
© 2017 Vector Informatik GmbH
Version 4.01.00
62
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
Return code
Void
-
Functional Description
This function is used to initialize the global variables of the FlexRay Interface at startup.
Particularities and Limitations
>  This function shall be called at startup before  FrIf_Init.
592H
Expected Caller Context
>  This function can be called in any context.
Table 5-37
FrIf_InitMemory
5.2.39
FrIf_JobListExec_<ClstIdx>
Prototype
void FrIf_JobListExec_<ClstIdx> (void)
Parameter
Void
-
Return code
Void
-
Functional Description
This is the common call-back function for the activation of the Rx- or Tx-tasks (job execution) of the
FlexRay Interface. Depending on the current FlexRay global time and the configured start times of the Rx-
and Tx-tasks, the FlexRay Interface will either execute the Rx- or Tx-task of the corresponding FlexRay
Cluster.
Particularities and Limitations
>  Precondition: The FlexRay Interface has to be initialized with a call of  FrIf_Init.
593H
>  During its runtime this function temporarily disables all interrupts.
Expected Caller Context
>  This function must be called by the application or integration code either directly in the context of the
timer interrupt or in the context of an OS task that is activated in the context of the timer interrupt.
Table 5-38
FrIf_JobListExec_<ClstIdx>
5.2.40
FrIf_MainFunction_<ClstIdx>
Prototype
void FrIf_MainFunction_<ClstIdx>(void)
© 2017 Vector Informatik GmbH
Version 4.01.00
63
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
Parameter
Void
-
Return code
Void
-
Functional Description
This function checks whether the job execution of its related FlexRay Cluster is synchronized.
Particularities and Limitations
>  Precondition: The FlexRay Interface has to be initialized with a call of  FrIf_Init.
594H
Expected Caller Context
>  This function is called cyclically by the BSW Scheduler.
Table 5-39
FrIf_MainFunction_<ClstIdx>
5.2.41
FrIf_ReadCCConfig (optional)
Prototype
Std_ReturnType FrIf_ReadCCConfig(uint8 FrIf_CtrlIdx, uint8
FrIf_CCLLParamIndex, uint32* FrIf_CCLLParamValue)
Parameter
FrIf_CtrlIdx
Index of the FlexRay communication controller for which Fr_SendWUP shall
be called.
FrIf_CCLLParamIndex
This index selects the low level parameter value that shall be copied. Refer to
Fr_GeneralTypes.h for the list of supported low level parameters.
FrIf_CCLLParamValue
Value of the read parameter.
Return code
E_OK
The call of the FlexRay Driver API service Fr_ReadCCConfig() has returned
E_OK.
E_NOT_OK
The call of the FlexRay Driver API service Fr_ReadCCConfig() has returned
E_NOT_OK, or an error has been detected if development error detection is
enabled.
Functional Description
This function wraps the Fr_ReadCCConfig of the FlexRay Driver to read the CC configuration registers.
© 2017 Vector Informatik GmbH
Version 4.01.00
64
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
Particularities and Limitations
>  Precondition: The FlexRay Interface has to be initialized with a call of  FrIf_Init.
595H
>  This API function is only available if the “Read CC Config Support” has been enabled for FlexRay
Interface and FlexRay Driver.
>  For the parameter FrIf_CtrlIdx only the value 0 is allowed.
>  This function is implemented as macro to reduce code size if the “Wrapper APIs As Macro” option is
enabled for the FlexRay Interface.
Expected Caller Context
>  This function can be called in any context.
Table 5-40
FrIf_ReadCCConfig (optional)
5.2.42
FrIf_ReconfigLPdu (optional)
Prototype
Std_ReturnType FrIf_ReconfigLPdu(uint8 FrIf_CtrlIdx, int16
FrIf_LPduIdx, int16 FrIf_FrameId, Fr_ChannelType FrIf_ChnlIdx, int8
FrIf_CycleRepetition, int8 FrIf_CycleOffset, uint8 FrIf_PayloadLength,
int16 FrIf_HeaderCRC )
Parameter
FrIf_CtrlIdx
Index of the FlexRay communication controller for which Fr_ReconfigLPdu
shall be called.
FrIf_LPduIdx
This index is used to uniquely identify a FlexRay frame.
FrIf_FrameId
FlexRay Frame ID the FrIf_LPdu shall be configured to.
FrIf_ChnlIdx
FlexRay Channel the FrIf_LPdu shall be configured to.
FrIf_CycleRepetition
Cycle Repetition part of the cycle filter mechanism FrIf_LPdu shall be
configured to.
FrIf_CycleOffset
Cycle Offset part of the cycle filter mechanism FrIf_LPdu shall be configured
to.
FrIf_PayloadLength
Payloadlength in units of bytes the FrIf_LPduIdx shall be configured to.
FrIf_HeaderCRC
Header CRC the FrIf_LPdu shall be configured to.
Return code
E_OK
The call of the FlexRay Driver API service Fr_ReconfigLPdu() has returned
E_OK.
E_NOT_OK
The call of the FlexRay Driver API service Fr_ReconfigLPdu() has returned
E_NOT_OK, or an error has been detected if development error detection is
enabled.
© 2017 Vector Informatik GmbH
Version 4.01.00
65
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
Functional Description
According to AUTOSAR 4.0 this function wraps the Fr_ReconfigLPdu of the FlexRay Driver to reconfigure
the corresponding HW buffer according the given parameters during runtime.
Particularities and Limitations
>  Precondition: The FlexRay Interface has to be initialized with a call of  FrIf_Init.
595H
>  This API function is only available if the “Reconfig LPdu Support” has been enabled for FlexRay
Interface and FlexRay Driver.
>  Only the L-PDUs with the “Reconfigurable” flag enabled can be reconfigured by this API.
>  If L-PDU reconfiguration is enabled for a specific L-PDU, this L-PDU is not sent after FrIf_ControllerInit
but has to be enabled with this function. Therewith it is not allowed to set the “Reconfigurable” flag
for a sync frame.
>  For the parameter FrIf_CtrlIdx only the value 0 is allowed.
>  This function is implemented as macro to reduce code size if the “Wrapper APIs As Macro” option is
enabled for the FlexRay Interface.
Expected Caller Context
>  This function can be called in any context.
Table 5-41
FrIf_ReconfigLPdu (optional)
5.2.43
FrIf_SendWUP
Prototype
Std_ReturnType FrIf_SendWUP(uint8 FrIf_CtrlIdx)
Parameter
FrIf_CtrlIdx
Index of the FlexRay communication controller for which Fr_SendWUP shall
be called.
Return code
E_OK
The call of the FlexRay Driver API service Fr_SendWUP() has returned E_OK.
E_NOT_OK
The call of the FlexRay Driver API service Fr_SendWUP() has returned
E_NOT_OK, or an error has been detected if development error detection is
enabled.
Functional Description
Call the function Fr_SendWUP of the FlexRay Driver.
© 2017 Vector Informatik GmbH
Version 4.01.00
66
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
Particularities and Limitations
>  Precondition: The FlexRay Interface has to be initialized with a call of  FrIf_Init.
595H
>  For the parameter FrIf_CtrlIdx only the value 0 is allowed.
>  This function is implemented as macro to reduce code size if the “Wrapper APIs As Macro” option is
enabled for the FlexRay Interface.
Expected Caller Context
>  This function can be called in any context.
Table 5-42
FrIf_SendWUP
5.2.44
FrIf_SetAbsoluteTimer
Prototype
Std_ReturnType FrIf_SetAbsoluteTimer(uint8 FrIf_CtrlIdx, uint8
FrIf_AbsTimerIdx, uint8 FrIf_Cycle, uint16 FrIf_Offset)
Parameter
FrIf_CtrlIdx
The index of the FlexRay Communication Controller.
FrIf_AbsTimerIdx
Index of the absolute timer to be used for setting the alarm time.
FrIf_Cycle
Cycle in which the timer shall expire.
FrIf_Offset
Offset to the cycle start in macro ticks.
Return code
E_OK
The call of the FlexRay Driver API service Fr_SetAbsoluteTimer() has returned
E_OK.
E_NOT_OK
The call of the FlexRay Driver API service Fr_SetAbsoluteTimer() has returned
E_NOT_OK, or an error has been detected if development error detection is
enabled.
Functional Description
This function wraps the Fr_SetAbsoluteTimer function of the FlexRay Driver.
Particularities and Limitations
>  Precondition: The FlexRay Interface has to be initialized with a call of  FrIf_Init.
596H
>  For the parameter FrIf_CtrlIdx only the value 0 is allowed.
>  As one FlexRay timer is used by the FlexRay Interface this function must not be used for timer 0.
>  The FlexRay global time is only defined if the FlexRay bus is synchronized.
>  This function is implemented as macro to reduce code size if the “Wrapper APIs As Macro” option is
enabled for the FlexRay Interface.
Expected Caller Context
© 2017 Vector Informatik GmbH
Version 4.01.00
67
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
>  This function can be called in any context.
Table 5-43
FrIf_SetAbsoluteTimer

5.2.45
FrIf_SetState
Prototype
Std_ReturnType FrIf_SetState(uint8 FrIf_ClstIdx,
FrIf_StateTransitionType FrIf_StateTransition )
Parameter
FrIf_ClstIdx
Index of the FlexRay cluster for which the state of the FlexRay Interface shall
be determined.
FrIf_StateTransition
Requested state transition, i.e. either  FRIF_GOTO_OFFLINE or
599H
FRIF_GOTO_ONLINE
600H
Return code
E_OK
Function was successfully executed.
E_NOT_OK
Function execution failed due to detected errors.
Functional Description
Change the state of the FlexRay Interface for the given cluster.
>  FRIF_GOTO_ONLINE will start the FrIf job list execution.
601H
  FRIF_GOTO_OFFLINE will stop the FrIf job list execution.
602H
Note that the state of the FlexRay communication controller is not influenced by this function. I.e. the
function  FrIf_HaltCommunication has to be used to actually stop the FlexRay communication.
603H
Particularities and Limitations
>  Precondition: The FlexRay Interface has to be initialized with a call of  FrIf_Init.
604H
>  For the parameter FrIf_ClstIdx only the value 0 is allowed.
>  The FlexRay Interface can only be set to  FRIF_STATE_ONLINE after synchronization of the FlexRay
605H
bus has been achieved.
Expected Caller Context
>  This function can be called in any context.
Table 5-44
FrIf_SetState
© 2017 Vector Informatik GmbH
Version 4.01.00
68
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
5.2.46
FrIf_SetTransceiverMode
Prototype
Std_ReturnType FrIf_SetTransceiverMode(uint8 FrIf_CtrlIdx,
Fr_ChannelType FrIf_ChnlIdx, FrTrcv_TrcvModeType FrIf_TrcvMode)
Parameter
FrIf_CtrlIdx
The index of the FlexRay communication controller to which the transceiver
is connected.
FrIf_ChnlIdx
The index of the FlexRay channel to which the transceiver is connected.
FrIf_TrcvMode
The mode that shall be set.
Return code
E_OK
The call of the FlexRay Transceiver Driver API service
FrTrcv_SetTransceiverMode() has returned BUSTRCV_E_OK.
E_NOT_OK
The call of the FlexRay Transceiver Driver API service
FrTrcv_SetTransceiverMode() has returned BUSTRCV_E_ERROR, or an error
has been detected if development error detection is enabled.
Functional Description
This function wraps the FrTrcv_SetTransceiverMode function of the FlexRay Transceiver Driver.
Particularities and Limitations
>  Precondition: The FlexRay Interface has to be initialized with a call of  FrIf_Init.
606H
>  This API function is only available if the MICROSAR FlexRay Transceiver component is enabled in the
configuration tool.
>  For the parameter FrIf_CtrlIdx only the value 0 is allowed.
>  This function is implemented as macro to reduce code size if the “Wrapper APIs As Macro” option is
enabled for the FlexRay Interface.
Expected Caller Context
>  This function can be called in any context.
Table 5-45
FrIf_SetTransceiverMode
5.2.47
FrIf_SetWakeupChannel
Prototype
Std_ReturnType FrIf_SetWakeupChannel(uint8 FrIf_CtrlIdx, Fr_ChannelType
FrIf_ChnlIdx)
Parameter
FrIf_CtrlIdx
Index of the FlexRay communication controller for which
Fr_SetWakeupChannel shall be called.
© 2017 Vector Informatik GmbH
Version 4.01.00
69
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
FrIf_ChnlIdx
Index of the FlexRay channel.
Return code
E_OK
The call of the FlexRay Driver API service Fr_SetWakeupChannel() has
returned E_OK.
E_NOT_OK
The call of the FlexRay Driver API service Fr_SetWakeupChannel() has
returned E_NOT_OK, or an error has been detected if development error
detection is enabled.
Functional Description
Call the function Fr_SetWakeupChannel of the FlexRay Driver.
Particularities and Limitations
>  Precondition: The FlexRay Interface has to be initialized with a call of  FrIf_Init.
607H
>  This API function is only available if “SetWakeupChannel Disable” has not been disabled for FlexRay
Interface.
>  For the parameter FrIf_CtrlIdx only the value 0 is allowed.
>  This function is implemented as macro to reduce code size if the “Wrapper APIs As Macro” option is
enabled for the FlexRay Interface.
Expected Caller Context
>  This function can be called in any context.
Table 5-46
FrIf_SetWakeupChannel

5.2.48
FrIf_StartCommunication
Prototype
Std_ReturnType FrIf_StartCommunication(uint8 FrIf_CtrlIdx)
Parameter
FrIf_CtrlIdx
Index of the FlexRay communication controller for which
Fr_StartCommunication shall be called.
Return code
E_OK
The call of the FlexRay Driver API service Fr_StartCommunication() has
returned E_OK.
E_NOT_OK
The call of the FlexRay Driver API service Fr_StartCommunication() has
returned E_NOT_OK, or an error has been detected if development error
detection is enabled.
Functional Description
Call the function Fr_StartCommunication of the FlexRay Driver.
© 2017 Vector Informatik GmbH
Version 4.01.00
70
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
Particularities and Limitations
>  Precondition: The FlexRay Interface has to be initialized with a call of  FrIf_Init.
608H
>  For the parameter FrIf_CtrlIdx only the value 0 is allowed.
>  This function is implemented as macro to reduce code size if the “Wrapper APIs As Macro” option is
enabled for the FlexRay Interface.
Expected Caller Context
>  This function can be called in any context.
Table 5-47
FrIf_StartCommunication
5.2.49
FrIf_Transmit
Prototype
Std_ReturnType FrIf_Transmit(PduIdType FrIf_TxPduId, const PduInfoType
* FrIf_PduInfoPtr)
Parameter
FrIf_TxPduId
FrIf-ID of the PDU to be transmitted.
PduInfoPtr
Pointer to a structure with FlexRay PDU related data.
Return code
E_OK
The immediate transmission request has been accepted.
E_NOT_OK
The transmission request has been rejected, or an error has been detected if
development error detection is enabled.
Functional Description
This function initiates the transmission of a PDU.
If the PDU is configured for Decoupled Transmission, the PDU is marked as dirty. When a frame that
contains the PDU shall be transmitted, the <UL>_TriggerTransmit call-back function of the upper-layer
component will be called in order to get the PDU content.
If the PDU is configured for Immediate Transmission the PDU content is directly given to the FlexRay
Driver.
Particularities and Limitations
>  Precondition: The FlexRay Interface has to be initialized with a call of  FrIf_Init.
609H
>  During its runtime this function temporarily disables all interrupts.
Expected Caller Context
>  This function can be called in any context.
Table 5-48
FrIf_Transmit

© 2017 Vector Informatik GmbH
Version 4.01.00
71
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface

© 2017 Vector Informatik GmbH
Version 4.01.00
72
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
5.3
Services used by FrIf
In the following table services provided by other components, which are used by the FrIf are listed. For
details about prototype and functionality refer to the documentation of the providing component.
Component
API
Fr
Fr_AbortCommunication
212H
Fr
Fr_AckAbsoluteTimerIRQ
213H
Fr
Fr_AllowColdstart
215H
Fr
Fr_CancelAbsoluteTimer
216H
Fr
Fr_CheckTxLPduStatus
218H
Fr
Fr_ControllerInit
219H
Fr
Fr_DisableLPdu
231H

Fr
Fr_DisableAbsoluteTimerIRQ
220H
Fr
Fr_EnableAbsoluteTimerIRQ
222H
Fr
Fr_GetAbsoluteTimerIRQStatus
224H
Fr
Fr_GetChannelStatus
225H
Fr
Fr_GetClockCorrection
226H
Fr
Fr_GetGlobalTime
227H
Fr
Fr_GetNmVector
228H
Fr
Fr_GetPOCStatus
229H
Fr
Fr_GetSyncFrameList
231H

Fr
Fr_HaltCommunication
232H
Fr
Fr_PrepareLPdu
233H
Fr
Fr_ReadCCConfig
231H

Fr
Fr_ReceiveRxLPdu
234H
Fr
Fr_ReconfigLPdu
231H

Fr
Fr_SendWUP
235H
Fr
Fr_AllSlots
235H
Fr
Fr_GetNumOfStartupFrames
235H
Fr
Fr_GetWakeupRxStatus
235H
Fr
Fr_SetAbsoluteTimer
236H
Fr
Fr_SetWakeupChannel
239H
Fr
Fr_StartCommunication
240H
© 2017 Vector Informatik GmbH
Version 4.01.00
73
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
Component
API
Fr
Fr_TransmitTxLPdu
241H
FrTrcv
FrTrcv_ClearTransceiverWakeup
242H
FrTrcv
FrTrcv_GetTransceiverMode
245H
FrTrcv
FrTrcv_DisableTransceiverBranch
245H

FrTrcv
FrTrcv_EnableTransceiverBranch
245H

FrTrcv
FrTrcv_CheckWakeupByTransceiver
245H

FrTrcv
FrTrcv_GetTransceiverError
245H

FrTrcv
FrTrcv_GetTransceiverWUReason
246H
FrTrcv
FrTrcv_SetTransceiverMode
247H
Det
Det_ReportError
248H
Dem
Dem_ReportErrorStatus
249H
Table 5-49
Services used by the FrIf
5.4
Callback Functions
The FlexRay Interface does not provide any callback function.

© 2017 Vector Informatik GmbH
Version 4.01.00
74
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
5.5
Configurable Interfaces
At  its  configurable  interfaces  the  FrIf  defines  notifications  that  can  be  mapped  to  callback  functions
provided by other modules. The mapping is not statically defined by the BSW module but can be performed
at  configuration time. The function prototypes  that can be  used for the configuration have  to match the
appropriate function prototype signatures, which are described in the following tables.
5.5.1
Notifications
The MICROSAR FrIf does not use any notifications
5.5.2
Callout Functions
5.5.2.1
<UL>_TriggerTransmit

Prototype
Std_ReturnType <UL>_TriggerTransmit(PduIdType TxPduId, PduInfoType*
PduInfoPtr)
Parameter
TxPduId (in)
PDU-ID of FlexRay PDU that shall be copied to the FrIf
PduInfoPtr (inout)
Contains a pointer to a buffer (SduDataPtr) to where the SDU shall be
copied to. On return, the service will indicate the length of the copied
SDU data in SduLength.
Return code
E_OK
SDU has been copied and SduLength indicates the number of copied bytes.
E_NOT_OK
No SDU has been copied. PduInfoPtr must not be used since it may contain a
NULL pointer or point to invalid data.
Functional Description
The FlexRay Interface calls this function to request the PDU content from the upper layer software
module. For the different upper layer software module, the following function names are used:
  FrNm_TriggerTransmit
  FrTp_TriggerTransmit
  PduR_FrIfTriggerTransmit
  Xcp_FrIfTriggerTransmit
  FrTSyn_TriggerTransmit
  FrArTp_TriggerTransmit
Particularities and Limitations

Call Context
© 2017 Vector Informatik GmbH
Version 4.01.00
75
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
  Depending on how the FrIf job list function is activated (see section  3.4.2) this function can be called
610H
in interrupt context.
Table 5-50
<UL>_TriggerTransmit (“Use Pdu Info Type” enabled)
5.5.2.2
<UL>_TxConfirmation
Prototype
void <UL>_TxConfirmation( PduIdType TxPduId)
Parameter
TxPduId
The ID of the PDU in the upper layer software module.
Return code
Void
-
Functional Description
The FlexRay Interface calls this function to confirm the transmission of a PDU. For the different upper
layer software module, the following function names are used:
  FrNm_TxConfirmation
  FrTp_TxConfirmation
  PduR_FrIfTxConfirmation
  Xcp_FrIfTxConfirmation
  FrArTp_TxConfirmation
Particularities and Limitations
-
Call Context
  Depending on how the FrIf job list function is activated (see section  3.4.2) this function can be called
611H
in interrupt context.
Table 5-51
<UL>_TxConfirmation

© 2017 Vector Informatik GmbH
Version 4.01.00
76
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
5.5.2.3
<UL>_RxIndication

Prototype
void <UL>_RxIndication(PduIdType RxPduId, const PduInfoType*
PduInfoPtr)
Parameter
RxPduId (in)
PDU-ID of FlexRay PDU that has been received
PduInfoPtr (in)
Contains the length (SduLength) of the received I-PDU and a pointer to a
buffer (SduDataPtr) containing the I-PDU.
Return code
void
-
Functional Description
The FlexRay Interface calls this function to indicate the reception of a PDU. For the different upper layer
software module, the following function names are used:
  FrNm_RxIndication
  FrTp_RxIndication
  PduR_FrIfRxIndication
  Xcp_FrIfRxIndication
  FrTSyn_RxIndication
  FrArTp_RxIndication
Particularities and Limitations

Call Context
  Depending on how the FrIf job list function is activated (see section  3.4.2) this function can be called
612H
in interrupt context.
Table 5-52
<UL>_RxIndication (“Use Pdu Info Type” enabled)
5.5.2.4
Rx Voting Function (optional for Dual Channel Redundancy Support)
Prototype
Std_ReturnType <FrIfRxVotingFunction>(P2CONST(P2VAR(PduInfoType, AUTOMATIC,
FRIF_VAR_NOINIT), AUTOMATIC, FRIF_DATA) PduInfo, CONST(uint8, FRIF_CONST)
NumberOfPdus, P2VAR(uint8, AUTOMATIC, FRIF_DATA) SelectedPduIndex)
© 2017 Vector Informatik GmbH
Version 4.01.00
77
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
Parameter
PduInfo
PduInfo array holds a list of received PDU instances for one PDU of a
redundant frame
NumberOfPdus
NumberOfPdus indicates the size of the PduInfo array
SelectedPduIndex
SelectedPduIndex is set by application in order to select the PDU instance
that shall be indicated to the upper layer.
Return code
E_OK
The call of the service <FrIfRxVotingFunction> returns E_OK if the application
was able to select a valid PDU that shall be indicated.
E_NOT_OK
The call of the service <FrIfRxVotingFunction> returns E_NOT_OK if the
application was not able to select a valid PDU that shall be indicated (e.g.
NumberOfPdus is zero)
Functional Description
Voting function for dual channel redundancy. The FlexRay Interface calls this function to indicate the
reception of redundant PDUs.
Particularities and Limitations
>  This API function is only used by the FlexRay Interface if the “Dual Channel Redundancy Support“ is
enabled and at least one pair of redundant reception frames is configured (refer to “Redundant
Frame Triggering Ref” attribute).
>  If the “Dual Channel Redundancy Support“ is enabled the name of this API service can be
configured by setting the “Rx Voting Function” attribute. For the declaration of this voting function
the FlexRay interface includes the configured “Rx Voting Function Header File”.
Call Context
  Depending on how the FrIf job list function is activated (see section  3.4.2) this function can be called
612H
in interrupt context.
Table 5-53
<FrIfRxVotingFunction>
5.5.3
Complex Device Driver Callout Functions
Instead of calling the <UL>_TriggerTransmit, <UL>_TxConfirmation and <UL>_RxIndication functions of the
upperlayer modules FrNm, FrTp, FrXcp or PduR, the MICROSAR FlexRay Interface can call any user defined
application callout function for all PDUs which “Pdu Owner” is CDD.
© 2017 Vector Informatik GmbH
Version 4.01.00
78
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
6  Glossary and Abbreviations
6.1
Glossary
Term
Description
GENy
Generation tool for CANbedded and MICROSAR components
CFG5
Generation tool for MICROSAR4 components
If_AsrIfFr
Vector Informatik component name of the MICROSAR FlexRay Interface module
Table 6-1
Glossary
6.2
Abbreviations
Abbreviation
Description
API
Application Programming Interface
AUTOSAR
Automotive Open System Architecture
BSW
Basis Software
CDD
Complex Device Driver
CRC
Cyclic Redundancy Check
DEM
Diagnostic Event Manager
DET
Development Error Tracer
EAD
Embedded Architecture Designer
ECU
Electronic Control Unit
ECUC
ECU Configuration
ECUM
ECU Manager
ESCANXXXXXXXX  Vector PES Clearquest Database ID. Replace XXXXXXXX by the
numeric identifier.
FIBEX
Field Bus Exchange
FR
FlexRay Driver
FRIF
FlexRay Interface
FRNM
FlexRay Network Management
FRSM
FlexRay State Manager
FRTRCV
FlexRay Transceiver Driver
FRTP
FlexRay Transport Protocol
HIS
Hersteller Initiative Software
ISR
Interrupt Service Routine
© 2017 Vector Informatik GmbH
Version 4.01.00
79
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
FlexRay L-PDU
Synonym - „FlexRay Frame“: A structure used by the communication system to exchange
information within the system. A FlexRay Frame consists of a header segment, a payload
segment and a trailer segment. The payload segment is used to convey application data.
MICROSAR
Microcontroller Open System Architecture (the Vector AUTOSAR solution)
OEM
Original Equipment Manufacturer
OS
Operating System
PDU
Protocol Data Unit
PDUR
PDU Router
SCHM
Basic Software Scheduler
SRS
Software Requirement Specification
SWS
Software Specification
TP
Transport Protocol
UL
Upper layer component of the FlexRay Interface (FrNm, FrTp, FrXcp, PduR or CDD)
Table 6-2
Abbreviations
© 2017 Vector Informatik GmbH
Version 4.01.00
80
based on template version 4.11.3

Technical Reference MICROSAR FlexRay Interface
7 Contact
Visit our website for more information on
> News
> Products
> Demo software
> Support
> Training data
> Addresses

www.vector-informatik.com
254H
© 2017 Vector Informatik GmbH
Version 4.01.00
81
based on template version 4.11.3