4.3. CDD_FSI

4.3.1. About This Document

Document Title

User Guide of CDD FSI Driver

Document Version

Version 1.1

Company

Texas Instruments

Document Name

CDD FSI User Guide

4.3.2. Document Revision History

Version

Date

Revision History

Status

Version 1.0

3 Nov 2023

Initial Version.

Approved

Version 1.1

29 Apr 2024

Document release version column removed.

Approved

4.3.3. Table of contents

  1. Acronyms and Definitions

  2. Functional Overview

  3. FST TX Deviations to requirements

  4. FSI TX Integration Details

  5. CDD FSI TX API Description_Cdd_Fsi_Am263p

  6. FSI TX Configuration Description

  7. FSI TX Memory Mapping

  8. FSI TX Memory footprint

  9. FSI RX Deviations to requirements

  10. FSI RX Integration Details

  11. FSI RX API Description

  12. FSI RX Configuration Description

  13. FSI RX Memory Mapping

  14. FSI RX Memory footprint

  15. Performance

  16. Example Usage

  17. FAQ’s

  18. Test Report (Link to test report)

  19. References

  20. TI Disclaimer

4.3.4. Acronyms and Definitions

Acronyms and Definitions used are presented in below table.

Acronyms

Descriptions

BSW

Basic Software

AUTOSAR

Automotive Open System Architecture

CDD

Complex Device Driver

FSI

Fast Serial Interface

DDR

Double Data Rate

SDR

Single Data Rate

CRC

Cyclic Redundancy Check

HW

Hardware

SW

Software

DEM

Diagnostic Event Manager

DMA

Direct Memory Access

MCAL

Microcontroller Abstraction Layer

DET

Default Error Tracer

PWM

Pulse Width Modulation

PLL

Phase Locked Loop

MCU

Micro Controller Unit

OS

Operating System

API

Application Programming Interface

4.3.5. Functional Overview

This document describes CDD FSI Driver functionality, its application interfaces and configuration details as per AUTOSAR version 4.3.1 .

4.3.5.1. Brief Overview

The Fast Serial Interface (FSI) module is a serial communication peripheral capable of reliable high-speed communication across isolation devices. The FSI is designed specifically to ensure reliable high-speed communication for system scenarios that involve communication across isolation barriers without adding components. The FSI consists of independent transmitter (CDD FSI TX) and receiver (CDD FSI RX) cores. The CDD FSITX and CDD FSIRX cores are configured and operated independently. Both CDD FSI TX and FsiRx are capable of configurable frame length and can be operated via DMA. The following figure shows where the CDD Module is located in the AUTOSAR architecture. Since CDD FSI Transmitter and Receiver are CDD Module it occupies the highlighted region in the AUTOSAR architecture.

../_images/fsi_image2.png

Figure 1: CDD FSI (CDD Module) in AUTOSAR architecture

4.3.5.2. Brief Overview of CDD FSI Transmitter

The CDD FSI transmitter module handles the framing of data and signal generation of TXCLK, TXD0, and TXD1, as well as interrupt generation. The operation of the transmitter core is controlled and configured through programmable control registers. The transmitter control registers allow the CPU to program, control, and monitor the operation of CDD the FSI receiver. The transmit data buffer is accessible by the CPU and the DMA.

4.3.5.2.1. CDD FSI TX Driver Architecture

Supported AUTOSAR Release

4.3.1

Supported Configuration Variants

Pre-Compile, Post-build

Vendor ID

CDD_FSI_TX_VENDOR_ID (44)

Module ID

CDD_FSI_TX_MODULE_ID (235)

Supported Platform

AM263px
../_images/fsitx_image3.png

Figure 2: CDD FSI TX Hardware Overview.

4.3.5.2.2. Initialization

Cdd_FsiTx_Init() has to be called to initialize the CDD FSI TX driver before initiating a transmission. This will also set the CDD FSI Transmitter Hardware Unit to CDD_FSI_TX_IDLE STATE.

4.3.5.2.3. States

There are 2 states in which each CDD FSI Transmitter HW Unit can be:

  1. CDD_FSI_TX_UNINIT: This is the state before the Fsi Transmitter is initialized.

  2. CDD_FSI_TX_IDLE: This is the state before starting before starting a transmission. The transmitter becomes idle only after it gets initialized.

4.3.5.3. Features Supported and Not Supported

CDD FSI Tx features:

IP Supported Features

CDD FSI TX Supported Features

CDD FSI TX Not Supported Features

Automated ping frame generation

Automated ping frame generation

Externally triggered ping frames

Externally triggered ping frames

Externally triggered data frames

Externally triggered data frames

Software-configurable frame lengths

Software-configurable frame lengths

Data buffer underrun and overrun detection

Data buffer underrun and overrun detection

DMA support

DMA support

Double Data Rate(DDR)

Double Data Rate(DDR)

4.3.5.3.1. Configurable Hardware Units

  1. User configurable parameter to define how many Tx Hardware Units (Instances) to use out of a maximum of 4

  2. User configurable parameter to specify which Hardware Unit to use

  3. User configurable parameter to specify Prescale value to select clock frequency at which the Hardware Unit will operate internally.

  4. User configurable frame size which defines number of words to be copied into Tx internal Buffer and Transmitted.

4.3.5.3.2. Configurable Development Error

  1. User configurable error check to report development errors.

4.3.5.3.3. Configurable Frame Length

The number of words to be sent in each frame is user configurable. The argument TxDataLength passed into the API Cdd_FsiTx_BufferLoad will copy the required number of words from source buffer to internal Tx Buffer. The TxDataLength can be any value from the enum Cdd_FsiTx_DataLengthType which has a range of 1-16.

  1. CDD_FSI_TX_DATA_1_WORD_LENGTH - 1 WORD will be copied from source buffer to Internal Tx buffer for Transmission.

  2. CDD_FSI_TX_DATA_2_WORD_LENGTH - 2 WORDS will be copied from source buffer to Internal Tx buffer for Transmission.

  3. CDD_FSI_TX_DATA_3_WORD_LENGTH - 3 WORDS will be copied from source buffer to Internal Tx buffer for Transmission.

  4. CDD_FSI_TX_DATA_4_WORD_LENGTH - 4 WORDS will be copied from source buffer to Internal Tx buffer for Transmission.

  5. CDD_FSI_TX_DATA_5_WORD_LENGTH - 5 WORDS will be copied from source buffer to Internal Tx buffer for Transmission.

  6. CDD_FSI_TX_DATA_6_WORD_LENGTH - 6 WORDS will be copied from source buffer to Internal Tx buffer for Transmission.

  7. CDD_FSI_TX_DATA_7_WORD_LENGTH - 7 WORDS will be copied from source buffer to Internal Tx buffer for Transmission.

  8. CDD_FSI_TX_DATA_8_WORD_LENGTH - 8 WORDS will be copied from source buffer to Internal Tx buffer for Transmission.

  9. CDD_FSI_TX_DATA_9_WORD_LENGTH - 9 WORDS will be copied from source buffer to Internal Tx buffer for Transmission.

  10. CDD_FSI_TX_DATA_10_WORD_LENGTH - 10 WORDS will be copied from source buffer to Internal Tx buffer for Transmission.

  11. CDD_FSI_TX_DATA_11_WORD_LENGTH -11 WORDS will be copied from source buffer to Internal Tx buffer for Transmission.

  12. CDD_FSI_TX_DATA_12_WORD_LENGTH - 12 WORDS will be copied from source buffer to Internal Tx buffer for Transmission.

  13. CDD_FSI_TX_DATA_13_WORD_LENGTH - 13 WORDS will be copied from source buffer to Internal Tx buffer for Transmission.

  14. CDD_FSI_TX_DATA_14_WORD_LENGTH - 14 WORDS will be copied from source buffer to Internal Tx buffer for Transmission.

  15. CDD_FSI_TX_DATA_15_WORD_LENGTH - 15 WORDS will be copied from source buffer to Internal Tx buffer for Transmission.

  16. CDD_FSI_TX_DATA_16_WORD_LENGTH - 16 WORDS will be copied from source buffer to Internal Tx buffer for Transmission.

4.3.5.3.4. Configurable User Data

The User Data is an 8 bit value which is fully user-configurable data field. There are no restrictions on how this field is used. This phase is only available in data frames. #. The userData argument in Cdd_FsiTx_BufferLoad API will configure the field in frame in DMA transmission Mode. #. The userData argument in Cdd_FsiTx_Transmit API will configure the field in frame in Interrupt/Polling transmission Mode.

4.3.5.3.5. Configurable Timeouts

#. User Configurable Ping Timeout value(value at which the Ping Timer timeout and it will trigger a Ping Frame transmission to check the physical connection between Tx and Rx ).

4.3.5.3.6. Configurable Transmission Modes

The FSI Transmitter can transmit data in three different Modes.

  1. Interrupt Mode.

  2. Polling Mode.

  3. DMA Mode.

4.3.5.4. Interrupt Mode

Each FSI module contains multiple interrupt sources which can be assigned to two different interrupt vectors: INT1 and INT2. Each interrupt source has an associated status flag. In Interrupt Mode, the macro CddFsiTxMainApi in Cdd_FsiTx_Cfg.h will be OFF. The transmitter can generate the following interrupts:

  1. Frame Done (FRAME_DONE) : This event indicates that FSI has completed transmitting a frame To enable this Interrupt Event, the macro CddFsiTxFrameDoneInterrupt in Cdd_FsiTx_Cfg.h should be ON.

  2. Buffer Underrun (BUF_UNDERRUN) : This event indicates that the transmit buffer has experienced underrun. Buffer underrun occurs when the transmitter tries to read data from a location which has not yet be written to by the CPU, or DMA. The macro CddFsiTxBufferUnderRunInterrupt in Cdd_FsiTx_Cfg.h should be ON and CddFsiTxDMAEnable should be OFF.

  3. Buffer Overrun (BUF_OVERRUN) : The buffer overrun interrupt is generated when the buffer has experienced overrun. Buffer overrun may occur if a piece of data is overwritten before it has been transmitted. The macro CddFsiTxBufferOverRunInterrupt in Cdd_FsiTx_Cfg.h should be ON and CddFsiTxDMAEnable should be OFF.

  4. Ping Frame Triggered (PING_TRIGGERED) : The ping frame triggered interrupt is generated when the ping frame has been triggered. This bit will be set when the ping counter has timed out.The macro CddFsiTxFrameDoneInterrupt in Cdd_FsiTx_Cfg.h should be ON.

4.3.5.5. Polling Mode

In Polling Mode the once the FSI Transmitter transmits the frame, the transmission status is continuously polled using CddFsiTxMainApi API. In Polling Mode the states of different macros inside Cdd_FsiTx_Cfg.h are listed below:

  1. CDD_FSI_TX_MAIN_FUNCTION_API -STD ON.

  2. CDD_FSI_TX_DMA_ENABLE -STD OFF

  3. CDD_FSI_TX_BUFFER_OVERRUN_INTERRUPT -STD OFF.

  4. CDD_FSI_TX_BUFFER_UNDERRUN_INTERRUPT-STD OFF

  5. CDD_FSI_TX_PING_TIMEOUT_INTERRUPT -STD OFF.

  6. CDD_FSI_TX_FRAME_DONE_INTERRUPT -STD OFF

  7. The macro related with each Interrupt event should be OFF if Main Function API macro is ON.

4.3.5.6. DMA Mode

The FSI transmitter can send data which is continuously fed with the DMA. In order to transmit continuous data with the DMA, some configurations need to be made on the transmitter: #. Two DMA channels have to be triggered by the same FSI transmitter and DMA trigger. #. One Channel to fill the data in transmit buffer and the other will be used to copy the userdata and frametag. In DMA Mode the states of different macros inside Cdd_FsiTx_Cfg.h are listed below:

  1. CDD_FSI_TX_MAIN_FUNCTION_API -STD OFF.

  2. CDD_FSI_TX_DMA_ENABLE -STD ON

  3. CDD_FSI_TX_BUFFER_OVERRUN_INTERRUPT -STD OFF.

  4. CDD_FSI_TX_BUFFER_UNDERRUN_INTERRUPT -STD OFF

  5. CDD_FSI_TX_PING_TIMEOUT_INTERRUPT -STD OFF

  6. CDD_FSI_TX_FRAME_DONE_INTERRUPT -STD OFF

For the FSI Transmitter to be functional in DMA mode, some configurations to be done in DMA Plugin as well. The DMA Instance curresponding to each Tx unit should be configured in chaining Mode. For each handle, two dma channels have to be configured. In Fsi, DMA Mode transfer is possible in only the Manual Trigger Mode of DMA.

4.3.6. API Description

4.3.6.1. Supported API�s

All below mentioned API�s are user accessible and can be found in Cdd_FsiTx.c file

4.3.6.1.1. FUNC(void, CDD_FSITX_CODE) Cdd_FsiTx_Init(P2CONST(Cdd_FsiTx_ConfigType, AUTOMATIC, CDD_FsiTx_CFG) ConfigurationPtr)

  1. Argument passed to the function is ConfigurationPtr.

  2. Function returns void

  3. Function is used to initialize all configured hardware units at specified frequencies.

  4. Function initializes configuration Parameters to default values.

4.3.6.1.2. FUNC(void, CDD_FSITX_CODE) Cdd_FsiTx_DeInit(void)

  1. Function used to de-initialize all initialized Fsi Tx Hardware Units

  2. Function returns void

  3. Function can not be called in case driver is uninitialized

4.3.6.1.3. FUNC(void, CDD_FSITX_CODE) Cdd_FsiTx_GetVersionInfo(P2VAR(Std_VersionInfoType, AUTOMATIC, CDD_FSI_TX_APPL_DATA) VersionInfoPtr)

  1. Argument passed to the function is a valid pointer of type Std_VersionInfoType

  2. Function stores Version information in pointer

  3. Function returns void

4.3.6.1.4. FUNC(Std_ReturnType, CDD_FSITX_CODE) Cdd_FsiTx_BufferLoad(Cdd_FsiTx_HWUnitType hwUnitId, P2VAR(Cdd_FsiTx_DataBufferType, AUTOMATIC, CDD_FSI_TX_APPL_DATA) SrcBufferPtr,Cdd_FsiTx_DataType Cdd_FsiTx_userData, Cdd_FsiTx_DataLengthType TxDataLength)

  1. Argument passed to the function are:

    hwUnitId:Tx instance which Transmits. SrcBufferPtr: Pointer to the Data Buffer from which data has to be copied Cdd_FsiTx_userData:User Specific 8 bit value passed from application for each frame. TxDataLength:Number of words in each Frame.

  2. Function copies data from the source pointer to internal Transmit buffer of Fsi Tx instance.

  3. Function returns E_OK/E_NOT_OK.

4.3.6.1.5. FUNC(Std_ReturnType, CDD_FSITX_CODE) Cdd_FsiTx_Transmit(Cdd_FsiTx_HWUnitType hwUnitId, Cdd_FsiTx_UserDataType userData, Cdd_FsiTx_DataLengthType TxDataLength)

  1. Argument passed to the function are:

    hwUnitId:Tx instance which Transmits. Cdd_FsiTx_userData:User Specific 8 bit value passed from application for each frame. TxDataLength:Number of words in each Frame.

  2. Function initiate the transmission of data from Tx Transmission buffer to Rx Internal reception Buffer.

  3. Function returns E_OK/E_NOT_OK.

4.3.6.1.6. FUNC(Std_ReturnType, CDD_FSITX_CODE) Cdd_FsiTx_MainFunction(void)

  1. The API is used in Polling Mode only.

  2. The main function API Polls whether the transmission status flags are set for each instance to ensure the data transmission.

  3. Function returns E_OK/E_NOT_OK.

4.3.6.1.7. FUNC(Std_ReturnType, CDD_FSITX_CODE) Cdd_FsiTx_Ping(Cdd_FsiTx_HWUnitType hwUnitId)

  1. Argument passed to the function are:

    hwUnitId:Tx instance which Transmits.

  2. Function initiates the transmission of a Ping Frame(Frame without Data) to the Rx to verify the physical

    connection between Tx and Rx instances.

  3. Function returns E_OK/E_NOT_OK.

4.3.6.1.8. FUNC(void, CDD_FSITX_CODE) Cdd_FsiTx_Reset(Cdd_FsiTx_HWUnitType hwUnitId, VAR(Cdd_FsiTx_ResetSubModuleType, AUTOMATIC) ResetModule)

  1. Argument passed to the function are:

    hwUnitId:Tx instance which Transmits. ResetModule: This argument specifies where the reset happens. Example:, Main Core Reset, Ping Timer Reset,Clock Reset

  2. Function resets either sub modules or main core in the Tx instance.

  3. Function returns E_OK/E_NOT_OK.

4.3.6.2. Assumptions

None

4.3.6.3. Limitations

  1. TXCLK which is derived from PLL Clock should never be configured to be faster than SYSCLK/2.

  2. Data Frame Configuration of Transmitter Module should be in sync with the receiver. (frame type, data width ).

#. In FSI, as soon as the DMA TX trigger is started, whatever data is available in the internal FSI buffer is transferred immediately before the DMA actually transfers from external buffer to FSI internal buffer. As a workaround, first iteration we are manually copying onto internal buffer before FSI DMA event is enabled #. In FSI, the DMA transfer happens only with the manual trigger mode of DMA. The event trigger mode is not supported

4.3.6.5. File Structure of CDD FSI TX Driver

Description of static files is provided below:

Static source and header files

Description

CddFsiTx.h

Contains the API’s of the CDD FSI TX driver to be used by upper layers.

CddFsiTx.c

Contains the implementation of the API’s for CDD FSI TX driver.

CddFsiTx_Irq.c and CddFsiTx_Irq.h

Contains ISR function definitions

CddFsiTx_Types.h

Contains the cdd data types and internal macro definitions.

CddFsiTx_Priv.c and CddFsiTx_Priv.h

Contains Internal functions definition of CDD FSI TX driver.

CddFsiTx_Platform.c and CddFsiTx_Platform.h

Contains device specific a function definition, data types and definitions.

Description of generated files is provided below:

Plugin Files

Descriptions

CddFsiTx_Cfg.h

Contains the Precompile switches, Symbolic names of hardware units and channels Configured maximum number hardware units

CddFsiTx_PBcfg.c

Contains all channels Post-Build Configured parameters

CddFsiTx_Cfg.c

Contains all channels Pre-Compile Configured parameters
../_images/fsitx_image4.png

Figure 3: CDD FSI TX header file include structure

4.3.7. FST TX Deviations to requirements

4.3.7.1. Module Requirements

Will be updated in future release

4.3.7.2. Deviation of requirements against CDD specification requirements

None

4.3.8. FSI TX Integration Details

4.3.8.1. Dependency on other Software Modules

4.3.8.1.1. The CDD FSI TX Driver dependent modules

4.3.8.1.1.1. MCU

The CDD FSI TX modules expects the MCU module to be powered on. The CDD_FSI_TX module depends on MCU module for PLL Clock initialization and crossbar interrupt mapping of CDD FSI TX interrupts depending on the Hardware unit being configured. Suppose the Hardware Unit 1 is configured for CDD FSI TX module:

../_images/fsitx_image5.png

Figure 4: CDD FSI TX Hardware container

Since CDD FSI TXCLK is driven by PLL, it is configured using CONTROLSS register and the the MCU module container McuClockSettingConfiguration should be configured as shown in below figure:

../_images/fsitx_image6.png

Figure 5: Mcu_Clock_Configuration container

Similarly, the crossbar interrupts also needs to be mapped in MCU module according to HW unit and interrupts being required.

The CDD FSI TX interrupts needs to be mapped to the corresponding cross bar interrupt required. For each CDD FSI TX instance there will be two interrupt vectors. INT1 and INT2. For each interrupt vector separate Crossbar pins should be selected in mcu configuration.

../_images/fsitx_image7.png

Figure 6: CDD FSI TX Interrupt configuration.

4.3.8.1.1.2. DMA

The CDD FSI TX Modules requires DMA module to be configured, when CDD FSI TX transmission is configured in DMA mode.

  1. CDD FSI TX Module Configuration:

    • The CDD FSI TX module parameter CddFsiTxDMAEnable should be configured for TRUE.

    • The CDD FSI TX HW Unit parameter CddFsiTxTransmissionMethod should be configured with CDD_FSI_TX_DMA_MODE.

      • The DMA supports CDD FSI TX in interrupt mode only.

      • The transmission mode in configurator should be CDD_FSI_TX_DMA_MODE and interrupt should be enabled inside the code.

  2. DMA module Configuration:

    • Set up two DMA channels to be triggered by the same CDD FSI transmitter and DMA trigger.

    • Configure one channel to fill the transmit buffer.

    • Configure the other channel to set the frame tag and user data fields.

    • Configure the DMA handleId and other parameters for each CDD FSI TX instance inside DMA configurator.

    • The DMA Configuration reference has given inside CDD FSI TX configurator to select the handleId for each TX Instance.

../_images/fsitx_image8.png

Figure 7: CDD FSI TX module DMA channel ID selection.

4.3.8.1.2. Error Handling module

4.3.8.1.2.1. DET

The module CDD FSI TX depends on the DET (by default) in order to report development errors. The DET error is reported with Module ID. The reported service IDs identify the services which are described earlier. The errors reported to DET module are described in the following table:

Error Code

Error Macro

Description

[0x01]

CDD_FSI_TX_E_UNINIT

Error code indicating the CDD FSI TX is uninitialized.

[0x02]

CDD_FSI_TX_E_INVALID_EVENT

Error code indicating an invalid event.

[0x03]

CDD_FSI_TX_E_PARAM_POINTER

Error code indicating invalid parameter pointer.

[0x04]

CDD_FSI_TX_E_PARAM_LENGTH

Error code indicating Service called with invalid length.

[0x05]

CDD_FSI_TX_E_INVALID_HWUNIT

Error code indicating invalid Number of CDD FSI TX HwUnit.
4.3.8.1.2.2. DEM

Note: Dem Event is enable only if $(Module_Name)DemEventParameterRefs is enabled. The extended run time errors reported to DEM module are described in the following table:

Error Code

Error Macro

Description

Assigned by DEM

CDD_FSI_TX_E_BUFFER_UNDERRUN

This error is raised when the Transmit Buffer Undergoes to an underrun.

Assigned by DEM

CDD_FSI_TX_E_BUFFER_OVERRUN

This error is raised when the Transmit Buffer Undergoes to an overrun.
4.3.8.1.2.3. Callback Functions

The CDD FSI TX driver does not provide any call back functions.

4.3.8.1.2.4. Callback Notification

Notifications: Cdd_FsiTx_BufferNotifyType: This Cdd_FsiTx_BufferNotifyType which is defined in CddFsiTx_Types.h file. This is called to notify the HwUnit about the completion of the transmission and availability of Tx Buffer to transmit another frame.

4.3.8.2. Hardware - Software - ISR API name mapping

For interrupt notification, ISR’s are provided in CDD FSI TX driver.There are two ISRs for each CDD FSI TX hardware unit. Depending on hardware unit configured, it will call the notify function. The interrupt service routines shall be mapped to the interrupt sources of the respective cross bar interrupt. The supported ISRs are part of the CddFsiTx_Irq.h file. Following are the ISRs for each CDD FSI TX hardware units:

Hardware Unit

ISR

CDD_FSI_TX_HW_UNIT_0

CddFsiTx_FSIINT1_IrqUnit0()

CddFsiTx_FSIINT2_IrqUnit0()

CDD_FSI_TX_HW_UNIT_1

CddFsiTx_FSIINT1_IrqUnit1()

CddFsiTx_FSIINT2_IrqUnit1()

CDD_FSI_TX_HW_UNIT_2

CddFsiTx_FSIINT1_IrqUnit2()

CddFsiTx_FSIINT2_IrqUnit2()

CDD_FSI_TX_HW_UNIT_3

CddFsiTx_FSIINT1_IrqUnit3()

CddFsiTx_FSIINT2_IrqUnit3()

DMA Mode ISR

CDD_EDMA_lld_transferCompletionMasterIsrFxn()

  1. CddFsiTxBufferOverRunInterrupt parameter enables/disables the bufferOverrun interrupt event.

    • This event indicates that the transmit buffer has experienced overrun.

    • Buffer underrun occurs when the transmitter tries to read data from a location which has not yet be written to by the CPU, or DMA.

  2. CddFsiTxBufferUnderRunInterrupt parameter enables/disables the bufferUnderRun interrupt event .

    • This event indicates that the transmit buffer has experienced underrun.

    • Buffer overrun may occur if a piece of data is overwritten before it has been transmitted.

  3. CddFsiTxFrameDoneInterrupt parameter enables/disables the Frame Done interrupt event .

    • This event indicates that FSI has completed transmitting a frame.

  4. CddFsiTxPingTimeOutInterrupt parameter enables/disables the Ping Timeout interrupt event .

    • The ping frame triggered interrupt is generated when the ping frame has been triggered.

    • This bit will be set when the ping counter has timed out.

4.3.8.3. Scheduling Strategy

4.3.8.3.1. SchM

Beside the OS, the BSW Scheduler provides functions that module CDD FSI TX calls at beginning and end of critical sections.

4.3.8.3.2. Critical Sections

There is only one kind of critical sections in this driver. Within these sections the transmission of data from Tx Buffer to the Rx Buffer will takeplace.This is handled internally in the CDD FSI TX driver by invoking SchM_Enter_Cdd_FsiTx_FSI_TX_EXCLUSIVE_AREA_0() / SchM_Exit_Cdd_FsiTx_FSI_TX_EXCLUSIVE_AREA_0().

4.3.8.4. CDD FSI TX API’s with Service ID

The following table presents the service IDs and the related services:

CDD FSI TX API’s Supported:

Service ID

Service

0x01

Cdd_FsiTx_Init

0x02

Cdd_FsiTx_GetVersionInfo

0x03

Cdd_FsiTx_Ping

0x04

Cdd_FsiTx_BufferLoad

0x05

Cdd_FsiTx_Transmit

0x06

Cdd_FsiTx_MainFunction

0x07

Cdd_FsiTx_DeInit

0x08

Cdd_FsiTx_Reset

4.3.9. FSI TX Configuration Description

4.3.9.1. Configuration Variants

The CDD FSI TX can be configured as Post-Build or Pre-Compile variant, using EB tresos tool.

Variants

Generated Files

PostBuild

CddFsiTx_PBcfg.c , CddFsiTx_Cfg.h

Pre-Compile

CddFsiTx_Cfg.c , CddFsiTx_Cfg.h

Note

  1. The DDR (Double Data Rate) is not supported.So CddFsiRxMultiLaneEnable Parameter will be OFF.

4.3.9.2. Parameter Description

Will be updated in future release

4.3.9.3. Symbolic Names deviations

The Symbolic names are generated for following parameters:

  1. CddFsiTxHwUnitId : Symbolic name is generated as CddFsiTxConf_CddFsiTxHwUnit_<CddFsiTxHwUnitId>

4.3.9.4. Configuration rules and constraints to enable plausibility checks

Will be updated in future release

4.3.10. FSI TX Memory Mapping

Memory Mapping Sections

CDD_FSITX_CODE

CDD_FSITX_CODE_ISR

CDD_FSITX_VAR_NO_INIT

CDD_FSI TX_VAR

CDD_FSITX_CONST

CDD_FSITX_PBCFG

CDD_FSITX_START_SEC_VAR_INIT_UNSPECIFIED(.bss)

x

CDD_FSITX_STOP_SEC_VAR_INIT_UNSPECIFIED

x

CDD_FSITX_START_SEC_CONFIG_DATA (.const)

x

CDD_FSITX_STOP_SEC_CONFIG_DATA

x

CDD_FSITX_START_SEC_CODE(.text)

x

CDD_FSITX_STOP_SEC_CODE

x

CDD_FSITX_START_SEC_VAR_INIT_32(.bss)

x

CDD_FSITX_STOP_SEC_VAR_INIT_32

x

CDD_FSITX_START_SEC_VAR_NO_INIT_UNSPECIFIED(.data)

x

CDD_FSITX_STOP_SEC_VAR_NO_INIT_UNSPECIFIED

x

CDD_FSITX_START_SEC_ISR_CODE

x

CDD_FSITX_STOP_SEC_ISR_CODE

x

4.3.11. FSI TX Memory footprint

Please refer Memory Footprint for more details.

4.3.11.1. Brief Overview of CDD FSI Receiver

The receiver module interfaces to the CDD FSI Receiver clock (RXCLK), and data lines (RXD0 and RXD1). The receiver core handles the data framing, CRC computation,and frame-related error checking. The receiver bit clock and state machine are run by the RXCLK input, which is asynchronous to the device system clock. The receiver control registers allow the CPU to program, control, and monitor the operation of the FSI receiver.The receive data buffer is accessible by the CPU and the DMA.

4.3.11.1.1. CDD FSI RX Driver Architecture

Supported AUTOSAR Release

4.3.1

Supported Configuration Variants

Pre-Compile, Post-build

Vendor ID

CDD_FSI_RX_VENDOR_ID (44)

Module ID

CDD_FSI_RX_MODULE_ID (234)

Supported Platform

AM263px
../_images/fsirx_image2.png

Figure 8: CDD FSI RX Hardware Overview.

4.3.11.1.2. Initialization

Cdd_FsiRx_Init() has to be called to initialize the Fsi Receiver driver before initiating a reception.This will also set the CDD FSI Receiver Hardware Unit to CDD_FSI_RX_IDLE STATE.

4.3.11.1.3. States

There are 2 states in which each CDD FSI Receiver HW Unit can be:

  1. CDD_FSI_RX_UNINIT: This is the state before the CDD FSI Receiver is initialized.

  2. CDD_FSI_RX_IDLE: This is the state before starting before starting a reception. The receiver becomes idle only after it gets initialized.

4.3.11.2. Features Supported and Not Supported

CDD FSI RX features:

IP Supported Features

CDD FSI RX Supported Features

CDD FSI RX Not Supported Features

Software-configurable frame lengths

Software-configurable frame lengths

Ping frame watchdog

Ping frame watchdog

Data Frame watchdog

Data Frame watchdog

Data buffer underrun and overrun detection

Data buffer underrun and overrun detection

DMA support

DMA support

Double Data Rate(DDR)

Double Data Rate(DDR)

4.3.11.2.1. Configurable Hardware Units

  1. User configurable parameter to define how many Rx Hardware Units (Instances) to use out of a maximum of 4

  2. User configurable parameter to specify which Hardware Unit to use

  3. User configurable frame size which defines number of words to be Received into Rx internal Buffer.

4.3.11.2.2. Configurable Development Error

  1. User configurable error check to report development errors.

4.3.11.2.3. Configurable Frame Length

The number of words to be sent in each frame is user configurable. The argument RxDataLength passed into the API Cdd_FsiRx_setUpBuffer will setup the internal Rx Buffer for data reception. The RxDataLength can be any value from the enum Cdd_FsiRx_DataLengthType which has a range of 1-16.

  1. CDD_FSI_RX_DATA_1_WORD_LENGTH - Rx Reception buffer will be configured to receive 1 WORD.

  2. CDD_FSI_RX_DATA_2_WORD_LENGTH - Rx Reception buffer will be configured to receive 2 WORDS .

  3. CDD_FSI_RX_DATA_3_WORD_LENGTH - Rx Reception buffer will be configured to receive 3 WORDS.

  4. CDD_FSI_RX_DATA_4_WORD_LENGTH - Rx Reception buffer will be configured to receive 4 WORDS.

  5. CDD_FSI_RX_DATA_5_WORD_LENGTH - Rx Reception buffer will be configured to receive 5 WORDS.

  6. CDD_FSI_RX_DATA_6_WORD_LENGTH - Rx Reception buffer will be configured to receive 6 WORDS.

  7. CDD_FSI_RX_DATA_7_WORD_LENGTH - Rx Reception buffer will be configured to receive 7 WORDS.

  8. CDD_FSI_RX_DATA_8_WORD_LENGTH - Rx Reception buffer will be configured to receive 8 WORDS.

  9. CDD_FSI_RX_DATA_9_WORD_LENGTH - Rx Reception buffer will be configured to receive 9 WORDS.

  10. CDD_FSI_RX_DATA_10_WORD_LENGTH - Rx Reception buffer will be configured to receive 10 WORDS.

  11. CDD_FSI_RX_DATA_11_WORD_LENGTH -Rx Reception buffer will be configured to receive 11 WORDS.

  12. CDD_FSI_RX_DATA_12_WORD_LENGTH - Rx Reception buffer will be configured to receive 12 WORDS.

  13. CDD_FSI_RX_DATA_13_WORD_LENGTH - Rx Reception buffer will be configured to receive 13 WORDS.

  14. CDD_FSI_RX_DATA_14_WORD_LENGTH - Rx Reception buffer will be configured to receive 14 WORDS.

  15. CDD_FSI_RX_DATA_15_WORD_LENGTH - Rx Reception buffer will be configured to receive 15 WORDS.

  16. CDD_FSI_RX_DATA_16_WORD_LENGTH - Rx Reception buffer will be configured to receive 16 WORDS.

4.3.11.2.4. Configurable Timeouts

#. User Configurable Ping Watch Dog Timeout value( If the Rx instance doesnot receive a ping frame within the configured timeout period of Ping WatchDog, then the Watchdog will Timeout and sent notification to application. This feature can be used to check the physical connection between Tx and Rx ). #. User Configurable Frame Watch Dog Timeout value( If the Rx instance doesnot receive a data frame within the configured timeout period of Frame WatchDog, then the Watchdog will Timeout and sent notification to application. This feature can be used to check the physical connection between Tx and Rx ).

4.3.11.2.5. Configurable Reception Modes

The FSI Receiver can Receive data in three different Modes.

  1. Interrupt Mode.

  2. Polling Mode.

  3. DMA Mode.

4.3.11.3. Interrupt Mode

Each FSI module contains multiple interrupt sources which can be assigned to two different interrupt vectors: INT1 and INT2. Each interrupt source has an associated status flag. In Interrupt Mode, the parameter CddFsiRxMainApi and should be OFF and CddFsiRxDMAEnable in Cdd_FsiRx_Cfg.h will be OFF. The receiver can generate the following interrupts:

  1. Ping Watchdog Timeout (PING_WD_TO) : This event indicates that the ping watchdog timer has timed out. The receiver has not received a valid frame within the time period specified in the RX_PING_WD_REF register. To enable this Interrupt Event, the parameter CddFsiRxPingWdgTimeoutInterruptEvent in Cdd_FsiRx_Cfg.h should be ON.

  2. Frame Watchdog Timeout (FRAME_WD_TO) : This event indicates that the frame watchdog timer has timed out. The conditions of this timeout are set using the RX_FRAME_WD_CTRL register. As soon as the start of frame phase is detected, the frame watchdog counter will start counting from 0. The end of frame phase must complete by the time the watchdog counter reaches the reference value. If this does not happen, the watchdog will time out and this event will be generated. If this event occurs, the receiver must undergo a soft reset and subsequent resynchronization in order to guarantee proper operation. The Parameter CddFsiRxFrameWdgTimeoutInterruptEvent in Cdd_FsiRx_Cfg.h

  3. Ping Frame Received (PING_FRAME) : This event indicates that a ping frame has been received. The Parameter CddFsiRxPingFrameReceivedInterruptEvent in Cdd_FsiRx_Cfg.h should be ON.

  4. Data Frame Received (DATA_FRAME) : This event indicates that a data frame has been received. The macro CddFsiRxDataFrameReceivedInterruptEvent in Cdd_FsiRx_Cfg.h should be ON.

4.3.11.4. Polling Mode

In Polling Mode the FSI Receiver is continuously polled using Cdd_FsiRx_MainFunction API to check whether data has received or not. In Polling Mode the states of different macros inside Cdd_FsiTx_Cfg.h are listed below:

  1. CDD_FSI_RX_MAIN_FUNCTION_API -STD ON.

  2. CDD_FSI_RX_DMA_ENABLE -STD OFF

  3. CDD_FSI_RX_PING_WDG_TIMEOUT_INTERRUPT -STD OFF.

  4. CDD_FSI_RX_FRAME_WDG_TIMEOUT_INTERRUPT -STD OFF

  5. CDD_FSI_RX_CRC_ERROR_INTERRUPT -STD OFF.

  6. CDD_FSI_RX_BUFFER_OVERRUN_INTERRUPT -STD OFF

  7. CDD_FSI_RX_BUFFER_UNDERRUN_INTERRUPT -STD OFF

  8. CDD_FSI_RX_PING_RECEIVED_INTERRUPT -STD OFF.

  9. CDD_FSI_RX_DATA_RECEIVED_INTERRUPT -STD OFF

  10. The Parameter related with each Interrupt event should be OFF if Main Function API Parameter is ON.

4.3.11.5. DMA Mode

The FSI Receiver can receive data which is continuously copied to the destination buffer with the DMA. In order to transmit continuous data with the DMA, some configurations need to be made on the transmitter:

  1. Configure the DMA channel and handle for the Rx Instance in CDD_DMA_TRANSFER_MODE_CHAINING

  2. Whenever data receives at the Rx internal buffer , the Rx interrupt will get hit and it will trigger internal function to copy data from Internal buffer to destination buffer.

In DMA Mode the states of different macros inside Cdd_FsiRx_Cfg.h are listed below:

  1. CDD_FSI_RX_MAIN_FUNCTION_API -STD OFF.

  2. CDD_FSI_RX_DMA_ENABLE -STD ON

  3. CDD_FSI_RX_PING_WDG_TIMEOUT_INTERRUPT -STD OFF.

  4. CDD_FSI_RX_FRAME_WDG_TIMEOUT_INTERRUPT -STD OFF

  5. CDD_FSI_RX_CRC_ERROR_INTERRUPT -STD OFF.

  6. CDD_FSI_RX_BUFFER_OVERRUN_INTERRUPT -STD OFF

  7. CDD_FSI_RX_BUFFER_UNDERRUN_INTERRUPT -STD OFF

  8. CDD_FSI_RX_PING_RECEIVED_INTERRUPT -STD OFF.

  9. CDD_FSI_RX_DATA_RECEIVED_INTERRUPT -STD OFF

4.3.12. API Description

4.3.12.1. Supported API�s

All below mentioned API�s are user accessible and can be found in Cdd_FsiRx.c file

4.3.12.1.1. FUNC(void, CDD_FSIRX_CODE) Cdd_FsiRx_Init(P2CONST(Cdd_FsiRx_ConfigType, AUTOMATIC, CDD_FsiRx_CFG) ConfigurationPtr)

  1. Argument passed to the function is ConfigurationPtr.

  2. Function returns void

  3. Function initializes configuration Parameters to default values.

4.3.12.1.2. FUNC(void, CDD_FSIRX_CODE) Cdd_FsiRx_DeInit(void)

  1. Function used to de-initialize all initialized Fsi Rx Hardware Units

  2. Function returns void

  3. Function can not be called in case driver is uninitialized

4.3.12.1.3. Cdd_FsiRx_GetVersionInfo(P2VAR(Std_VersionInfoType, AUTOMATIC, CDD_FsiRx_APPL_DATA) VersionInfoPtr)

  1. Argument passed to the function is a valid pointer of type Std_VersionInfoType

  2. Function stores Version information in pointer

  3. Function returns void

4.3.12.1.4. FUNC(void, CDD_FSIRX_CODE) Cdd_FsiRx_setUpBuffer(Cdd_FsiRx_HWUnitType hwUnitId, P2VAR( CddFsiRxDataBufferType, AUTOMATIC, CDD_FSI_RX_APPL_DATA) DataBufferPtr,CddFsiRx_DataLengthType RxDataLength)

  1. Argument passed to the function are:

    hwUnitId:Tx instance which Transmits. DataBufferPtr: Pointer to the Data Buffer to which data has to be copied RxDataLength:Number of words in each Frame.

  2. Function copies data from the source pointer to internal Transmit buffer of Fsi Tx instance.

  3. Function returns E_OK/E_NOT_OK.

4.3.12.1.5. FUNC(void, CDD_FSIRX_CODE) Cdd_FsiRx_MainFunction(void)

  1. The API is used in Polling Mode only.

  2. The main function API Polls whether the reception status flags are set for each instance to ensure the data reception.

  3. Function returns void.

4.3.12.1.6. FUNC(void, CDD_FSIRX_CODE) Cdd_FsiRx_Reset(Cdd_FsiRx_HWUnitType hwUnitId, VAR(Cdd_FsiRx_ResetSubModuleType, AUTOMATIC) ResetModule)

  1. Argument passed to the function are:

    hwUnitId:Tx instance which Transmits. ResetModule: This argument specifies where the reset happens. Example:, Main Core Reset, Ping Watchdog Reset,Frame Watchdog Reset

  2. Function initiates the reset of the particular module of Rx instance or the main core.

  3. Function returns void.

4.3.12.1.7. FUNC(void, CDD_FSIRX_CODE) Cdd_FsiRx_DmaDataReceive(Cdd_FsiRx_HWUnitType hwUnitId)

  1. Argument passed to the function are:

    hwUnitId:Tx instance which Transmits.

  2. Function transfers received data from Rx internal buffer to curresponding application buffer by using DMA.

  3. Function returns void.

4.3.12.2. Assumptions

None

4.3.12.3. Limitations

  1. RXCLK should be connected to TXCLK and it should never be configured to be faster than SYSCLK/2.

  2. Data Frame Configuration of Receiver Module should be in sync with the transmitter. (frame type, data width ).

#. In FSI, as soon as the DMA trigger is started, whatever data is available in the internal FSI buffer is transferred immediately before the DMA actually transfers from external buffer to FSI internal buffer. As a workaround, we are manually copying onto internal buffer before FSI DMA event is enabled

4.3.12.5. File Structure of CDD FSI RX Driver

Description of static files is provided below:

Static source and header files

Description

CddFsiRx.h

Contains the APIs of the CDD FSI RX driver to be used by upper layers.

CddFsiRx.c

Contains the implementation of the APIs for CDD FSI RX driver.

CddFsiRx_Irq.c and CddFsiRx_Irq.h

Contains ISR function definitions.

CddFsiRx_Types.h

Contains the CDD data types and internal macro definitions.

CddFsiRx_Priv.c and CddFsiRx_Priv.h

Contains Internal functions definition of Fsi Rx driver.

CddFsiRx_Platform.c and CddFsiRx_Platform.h

Contains device specific a function definition, data types and definitions.

Description of generated files is provided below:

Plugin Files

Descriptions

CddFsiRx_Cfg.h

Contains the Precompile switches, Symbolic names of hardware units and channels Configured maximum number hardware units

CddFsiRx_PBcfg.c

Contains all channels Post-Build Configured parameters

CddFsiRx_Cfg.c

Contains all channels Pre-Compile Configured parameters
../_images/fsirx_image4.png

Figure 9: CDD FSI RX header file include structure_Cdd_Fsi_am263p

4.3.13. FSI RX Deviations to requirements

4.3.13.1. Module Requirements

Will be updated in future release

4.3.13.2. Deviation of requirements against CDD specification requirements

None

4.3.14. FSI RX Integration Details

4.3.14.1. Dependency on Other Software Modules

4.3.14.1.1. The CDD FSI RX Driver dependent modules

4.3.14.1.1.1. MCU

The CDD FSI RX modules expects the MCU module to be powered on. The CDD FSI RX module depends on MCU module for crossbar interrupt mapping of CDD FSI RX interrupts depending on the Hardware unit being configured. Suppose the Hardware Unit 1 is configured for CDD FSI RX module:

../_images/fsirx_image6.png

Figure 10: CDD FSI RX Hardware container

Similarly, the crossbar interrupts also needs to be mapped in MCU module according to HW unit and interrupts being required. The FSI Rx interrupts needs to be mapped to the corresponding cross bar interrupt required. For each CDD FSI RX instance there will be two interrupt vectors. INT1 and INT2. For each interrupt vector separate Crossbar pins should be selected in mcu configuration.

../_images/fsirx_image3.png

Figure 11: FSI Rx Interrupt configuration.

../_images/fsirx_image5.png

Figure 12: CDD FSI RX Interrupt selection.

4.3.14.1.1.2. DMA

The CDD FSI RX Modules requires DMA module to be configured, when CDD FSI RX reception is configured in DMA mode.

  1. CDD FSI RX Module Configuration:

    • The CDD FSI RX module parameter CddFsiRxDMAEnable should be configured for TRUE.

    • The CDD FSI RX HW Unit parameter CddFsiRxReceptionMethod should be configured with CDD_FSI_RX_DMA_MODE.

    • The DMA supports CDD FSI TX in interrupt mode only.

    • The reception mode in configurator should be CDD_FSI_RX_DMA_MODE and interrupt should be enabled inside the code..

  2. DMA module Configuration:

    • Set up two DMA channels to be triggered by the same CDD FSI receiver and DMA trigger.

    • Configure one channel to take data from the Rx buffer.

    • Configure the other channel to copy the frame tag and user data fields.

    • Configure the DMA handleId and other parameters for each CDD FSI RX instance inside DMA configurator.

    • The DMA Configuration reference has given inside CDD FSI RX configurator to select the handleId for each RX Instance.

../_images/fsirx_image7.png

Figure 13: CDD FSI RX module DMA channel ID selection.

4.3.14.1.2. Error Handling module

4.3.14.1.2.1. DET

The module CDD FSI RX depends on the DET (by default) in order to report development errors. Detection and reporting of development errors can be enabled or disabled by the parameter CddFsiRxDevErrorDetect The macro CDD_FSI_RX_DEV_ERROR_DETECT = STD_ON generated in file CddFsiRx_Cfg.h). The DET error is reported with Module ID. The reported service IDs identify the services which are described earlier. The errors reported to DET module are described in the following table:

Error Code

Error Macro

Description

[0x01]

CDD_FSI_RX_E_UNINIT

Error code indicating the CDD FSI RX is uninitialized.

[0x02]

CDD_FSI_RX_E_INVALID_EVENT

Error code indicating an invalid event.

[0x03]

CDD_FSI_RX_E_PARAM_POINTER

Error code indicating invalid parameter pointer.

[0x04]

CDD_FSI_RX_E_ALREADY_INITIALIZED

API service called with invalid ramsection parameter.

[0x05]

CDD_FSI_RX_E_PARAM_LENGTH

Error code indicating Service called with invalid length.

[0x06]

CDD_FSI_RX_E_INVALID_HW_UNIT

Error code indicating invalid Number of FsiRx HwUnit.
4.3.14.1.2.2. DEM

Note: Dem Event is enable only if $(Module_Name)DemEventParameterRefs is enabled. The extended run time errors reported to DEM module are described in the following table:

Error Code

Error Macro

Description

Assigned by DEM

CDD_FSI_RX_E_BUFFER_UNDERRUN

This error is raised when the Receive Buffer Undergoes to an underrun.

Assigned by DEM

CDD_FSI_RX_E_BUFFER_OVERRUN

This error is raised when the Receive Buffer Undergoes to an overrun.

Assigned by DEM

CDD_FSI_RX_E_CRC_ERROR

This error is raised when the Receive Buffer receives a wrong CRC.

Assigned by DEM

CDD_FSI_RX_E_TYPE_ERR

This error is raised when the Receive Buffer receives an invalid frame type.

Assigned by DEM

CDD_FSI_RX_E_FRAME_OVERRUN

This error is raised when the Receive Buffer receives a new frame has been received while the FRAME_DONE flag was still set .

Assigned by DEM

CDD_FSI_RX_E_BUFFER_OVERRUN

This error is raised when the Receive Buffer Undergoes to an overrun.
4.3.14.1.2.3. Callback Functions

The CDD FSI RX driver does not provide any call back functions.

4.3.14.1.2.4. Callback Notification

Notifications: Cdd_FsiRx_BufferNotifyType: This Cdd_FsiRx_BufferNotifyType which is defined in CddFsiRx_Types.h file. This is called to notify the HwUnit about the completion of the data reception and availability of Rx Buffer to receive another frame.

4.3.14.2. Hardware - Software - ISR API name mapping

For interrupt notification, ISR’s are provided in CDD FSI RX driver. There are two ISRs for each CDD FSI RX hardware units. Depending on hardware unit configured, it will call the notify function. The interrupt service routines shall be mapped to the interrupt sources of the respective cross bar interrupt. The supported ISRs are part of the CddFsiRx_Irq.h file. Following are the ISRs for each CDD FSI RX hardware units:

Hardware Unit

ISR

CDD_FSI_RX_HW_UNIT_0

CddFsiRx_FSIINT1_IrqUnit0()

CddFsiRx_FSIINT2_IrqUnit0()

CDD_FSI_RX_HW_UNIT_1

CddFsiRx_FSIINT1_IrqUnit1()

CddFsiRx_FSIINT2_IrqUnit1()

CDD_FSI_RX_HW_UNIT_2

CddFsiRx_FSIINT1_IrqUnit2()

CddFsiRx_FSIINT2_IrqUnit2()

CDD_FSI_RX_HW_UNIT_3

CddFsiRx_FSIINT1_IrqUnit3()

CddFsiRx_FSIINT2_IrqUnit3()

DMA Mode ISR

CddFsiRx_DMA_IrqChannel()

  1. CddFsiRxPingWdgTimeoutInterruptEvent Parameter enables/disables the Ping Watch Dog Timeout interrupt event.

    • This event indicates that the ping watchdog timer has timed out.

    • The receiver has not received a valid frame within the time period specified in the RX_PING_WD_REF register.

  2. CddFsiRxFrameWdgTimeoutInterruptEvent Parameter enables/disables the Frame Watch Dog Timeout interrupt event .

    • This event indicates that the frame watchdog timer has timed out.

    • . If this event occurs, the receiver must undergo a soft reset and subsequent resynchronization in order to guarantee proper operation.

  3. CddFsiRxCRCErrorInterruptEvent Parameter enables/disables the CRC Error event .

    • This error indicates that a CRC error has occurred.

  4. CddFsiRxUnderRunInterruptEvent Parameter enables/disables the BufferUnderRun interrupt event .

    • This event indicates that an underrun condition has occurred in the receive buffer.

    • This condition occurs when software reads the buffer while it is empty.

  5. CddFsiRxBufferOverRunInterruptEvent Parameter enables/disables the BufferOverRun interrupt event .

    • This event indicates that an overrun condition has occurred in the receive buffer.

  6. CddFsiRxPingFrameReceivedInterruptEvent Parameter enables/disables the Ping frame received interrupt event .

    • This event indicates that a ping frame has been received.

  7. CddFsiRxDataFrameReceivedInterruptEvent Parameter enables/disables the data frame received interrupt event .

    • This event indicates that a data frame has been received.

4.3.14.3. Scheduling Strategy

4.3.14.3.1. SchM

Beside the OS the BSW Scheduler provides functions that module CDD FSI RX calls at begin and end of critical sections.

4.3.14.3.2. Critical Sections

There is only one kind of critical sections in this driver. Within these sections the reception of data from Rx Buffer to the Destination Buffer will takeplace. This is handled internally in the CDD FSI RX driver by invoking SchM_Enter_Cdd_FsiRx_FSI_RX_EXCLUSIVE_AREA_0() /SchM_Exit_Cdd_FsiRx_FSI_RX_EXCLUSIVE_AREA_0()

4.3.15. FSI RX API Description

4.3.15.1. Description of the CDD FSI RX API’s

Will be updated in future release.

4.3.15.2. CDD FSI RX API’s with Service ID

The following table presents the service IDs and the related services: CDD FSI RX API’s Supported:

Service ID

Service

0x01

Cdd_FsiRx_Init

0x02

Cdd_FsiRx_GetVersionInfo

0x03

Cdd_FsiRx_MainFunction

0x04

Cdd_FsiRx_DeInit

0x05

Cdd_FsiRx_GetStatus

0x06

Cdd_FsiRx_Reset

0x07

Cdd_FsiRx_SetUpBuffer

0x08

Cdd_FsiRx_dmaDataReceive

4.3.16. FSI RX Configuration Description

4.3.16.1. Configuration Variants

The FSI Rx can be configured as Post-Build or Pre-Compile variant, using EB tresos tool.

Variants

Generated Files

PostBuild

CddFsiRx_PBcfg.c , CddFsiRx_Cfg.h

Pre-Compile

CddFsiRx_Cfg.c ,CddFsiRx_Cfg.h

4.3.16.2. Parameter Description

Will be updated in future release

4.3.16.3. Symbolic Names deviations

The Symbolic names are generated for following parameters: #. CddFsiRxHwUnitId : Symbolic name is generated as CddFsiRxConf_CddFsiRxHwUnit_<CddFsiRxHwUnitId>

4.3.16.4. Configuration rules and constraints to enable plausibility checks

Will be updated in future release

4.3.17. FSI RX Memory Mapping

Memory Mapping Sections

CDD_FSIRX_CODE

CDD_FSIRX_CODE_ISR

CDD_FSIRX_VAR_NO_INIT

CDD_FSIRX_VAR

CDD_FSIRX_CONST

CDD_FSIRX_PBCFG

CDD_FSIRX_START_SEC_VAR_INIT_UNSPECIFIED(.bss)

x

CDD_FSIRX_STOP_SEC_VAR_INIT_UNSPECIFIED

x

CDD_FSIRX_START_SEC_CONFIG_DATA (.const)

x

CDD_FSIRX_STOP_SEC_CONFIG_DATA

x

CDD_FSIRX_START_SEC_CODE(.text)

x

CDD_FSIRX_STOP_SEC_CODE

x

CDD_FSIRX_START_SEC_VAR_INIT_32(.bss)

x

CDD_FSIRX_STOP_SEC_VAR_INIT_32

x

CDD_FSIRX_START_SEC_VAR_NO_INIT_UNSPECIFIED(.data)

x

CDD_FSIRX_STOP_SEC_VAR_NO_INIT_UNSPECIFIED

x

CDD_FSIRX_START_SEC_ISR_CODE

x

CDD_FSIRX_STOP_SEC_ISR_CODE

x

4.3.18. FSI RX Memory footprint

Please refer Memory Footprint for more details.

4.3.19. Performance

Not Applicable

4.3.20. Example Usage

4.3.20.1. Steps to build and run example

CDD FSI RX example application demonstrating the CDD FSI RX driver features is in folder <MCAL_ROOT>/examples/FsiRx. This application can be built from the root folder by giving gmake -S fsirx_app PLATFORM=am263px. Once the build is completed we get a binary file,which is loaded in our controller and executed.

4.3.20.2. External set up Information

None

4.3.20.3. Configuration used to test

#The CDD FSI module example application UT testing is done together with CDD FSI TX and CDD FSI RX modules (loop back test) and the configurations are as follows:

FSI TX HW UNIT 1 and FSI RX HW UNIT 1 are configured

SDR-INTERRUPT MODE-16 WORDS-SW TRIGGER: (HW UNIT 1)

  1. Initialize the Transmitter and Receiver.

  2. Transmit the Ping Frame with Tag 0 using API Cdd_FsiTx_Ping().

  3. Load the Transmition Buffer with Data using API Cdd_FsiTx_BufferLoad().

  4. Transmission and Reception are initiated using API Cdd_FsiTx_Transmit() and Cdd_FsiTx_Receive() respectively with SW Trigger, 16 words data length, Single Data Rate(Onlt TXD0 and RXD0) and in Interrupt Mode.

  5. Wait till reception completes and notification prints.

  6. Once test is completed successfully, verify the data in destination Buffer.

SDR-DMA MODE-16 WORDS-SW TRIGGER: (HW UNIT 1)

  1. Initialize the Transmitter and Receiver.

  2. Transmit the Ping Frame with Tag 0 using API Cdd_FsiTx_Ping().

  3. Load the Transmition Buffer with Data using API Cdd_FsiTx_BufferLoad().

  4. Transmission and Reception are initiated using API Cdd_FsiTx_Transmit() and Cdd_FsiTx_Receive() respectively with SW Trigger, 16 words data length, Single Data Rate(Onlt TXD0 and RXD0) and in Interrupt Mode.

  5. Wait till reception completes and notification prints.

  6. Once test is completed successfully, verify the data in destination Buffer.

SDR-POLLING MODE-16 WORDS-SW TRIGGER: (HW UNIT 0)

  1. Initialize the Transmitter and Receiver.

  2. Transmit the Ping Frame with Tag 0 using API Cdd_FsiTx_Ping().

  3. Load the Transmition Buffer with Data using API Cdd_FsiTx_BufferLoad().

  4. Transmission and Reception are initiated using API Cdd_FsiTx_Transmit() and Cdd_FsiTx_Receive() respectively with SW Trigger, 16 words data length, Single Data Rate(Onlt TXD0 and RXD0) and in Polling Mode.

  5. Wait till reception completes and notification prints.

  6. Once test is completed successfully, verify the data in destination Buffer.

4.3.20.4. Example Logs

FSIRX_APP
: Sample Application - STARTS !!!

Cdd Fsi Tx driver Version Info

Vendor ID           : 44
Module ID           : 255
SW Major Version    : 9
SW Minor Version    : 2
SW Patch Version    : 0

FSIRX_APP: Ping Frame Transmission completed!!
FSIRX_APP: BufferLoad completed!!
FSIRX_APP: Frame 1 reception completed!!
FSIRX_APP: BufferLoad completed!!
FSIRX_APP: Frame 2 reception completed!!
FSIRX_APP: BufferLoad completed!!
FSIRX_APP: Frame 3 reception completed!!
FSIRX_APP: BufferLoad completed!!
FSIRX_APP: Frame 4 reception completed!!
FSIRX_APP: BufferLoad completed!!
FSIRX_APP: Frame 5 reception completed!!
FSIRX_APP: All frames received!!
FSIRX_APP: Cdd Fsi driver de initialized!!
FSI Stack Usage: 840 bytes
All tests have passed
FSIRX_APP: Sample Application - Completed. !!!

4.3.21. FAQ’s

None

4.3.23. References

Technical Reference Manual

4.3.24. TI Disclaimer

Texas Instruments and its subsidiaries (TI) reserve the right to make changes to their products or to discontinue any product or service without notice, and advise customers to obtain the latest version of relevant information to verify, before placing orders, that information being relied on is current and complete. All products are sold subject to the terms and conditions of sale supplied at the time of order acknowledgment, including those pertaining to warranty, patent infringement, and limitation of liability.

TI warrants performance of its products to the specifications applicable at the time of sale in accordance with TI’s standard warranty. Testing and other quality control techniques are utilized to the extent TI deems necessary to support this warranty. Specific testing of all parameters of each device is not necessarily performed, except those mandated by government requirements.

Customers are responsible for their applications using TI components. In order to minimize risks associated with the customer’s applications, adequate design and operating safeguards must be provided by the customer to minimize inherent or procedural hazards.

TI assumes no liability for applications assistance or customer product design. TI does not warrant or represent that any license, either express or implied, is granted under any patent right, copyright, mask work right, or other intellectual property right of TI covering or relating to any combination, machine, or process in which such products or services might be or are used. TI’s publication of information regarding any third party’s products or services does not constitute TI’s approval, license, warranty or endorsement thereof.

Reproduction of information in TI data books or data sheets is permissible only if reproduction is without alteration and is accompanied by all associated warranties, conditions, limitations and notices. Representation or reproduction o f this information with alteration voids all warranties provided for an associated TI product or service, is an unfair and deceptive business practice, and TI is not responsible nor liable for any such use.

Resale of TI’s products or services with statements different from or beyond the parameters stated by TI for that product or service voids all express and any implied warranties for the associated TI product or service, is an unfair and deceptive business practice, and TI is not responsible nor liable for any such use.

Also see: Standard Terms and Conditions of Sale for Semiconductor Products https://www.ti.com/sc/docs/stdterms.htm

Mailing Address: Texas Instruments Post Office Box 655303 Dallas, Texas 75265