TTCAN Interface (TtcanIf)

Within this API, the upper layer module (called module) shall check whether the available data fits into the buffer size reported by PduInfoPtr->SduLength. If it fits, it shall copy its data into the buffer provided by PduInfoPtr->SduDataPtr and update the length of the actual copied data in PduInfoPtr->SduLength. If not, it returns E_NOT_OK without changing PduInfoPtr.

Gets the current values for the global, local and cycle time and the cycle count of the controller

Gets the master state. The master state includes the sync mode (sync_off, synchronizing, in_ gap, in_schedule) the master-slave mode (master_off, slave, backup_master, current_master) and the current value for ref trigger offset.

Gets the actual value of NTU (network time unit). Together with the local oscillator period, the actual value of NTU can be derived from the actual value of TUR.

Gets the error level. This includes the severity of the error level (S0-S3) and the minimum and maximum value of the message status count.

Sets the "Next_is_Gap" bit.

Signals the end of a gap.

Adjusts the global time at the beginning of the next basic cycle by the amount of "global time preset"

Sets the value of "global time preset".

Adjusts the NTU (network time unit) according to the value given by "NTU adjust". Together with the local oscillator period, "TUR adjust" can be derived from "NTU adjust".

Sets the value of "NTU adjust". Together with the local oscillator period, "TUR adjust" can be derived from "NTU adjust".

Processes the job list of the TTCAN controller <Controller>.

Gets the synchronization quality.

Sets a new value for the time mark for the given time source.

Cancels the time mark.

Acknowledges the time mark interrupt by resetting the flag in the interrupt vector register.

Enables the time mark interrupt.

Disables the time mark interrupt.

Gets the IRQ status of the time mark.

Reports an application watchdog error.

Reports one of the following errors: • Change of error level • Tx overflow / underflow • Synchronization failed • Init watch trigger

Reports the occurrence of a gap.

Reports the start of a basic cycle.

Reports a time discontinuity.

Reports change of the master state between potential and current master.

Reports one of the following errors: • failed to serve appl. watchdog • config error • watch trigger reached

16 bit value representing time values of TTCAN, e.g. cycle, local or global time

Master state type including sync mode, master-slave mode and current ref trigger offset

TTCAN error level including min and max values of message status count

Time source of time values in TTCAN

Combines all events that are reported by CanIf_TTTimingError (event indication and error level)

Master-Slave Mode

Sync mode

Error level (S0-S3)

Event that causes a Timing/Error IRQ

Event that causes a severe error

The Copy Operation into/from the TTCAN Controller shall be scheduled within a Job List .

If a Job List is used, the TTCAN Job List Execution Function ( JLEF ) shall execute the Communication Jobs of the Job List syn- chronously to the Controller time (i.e. at well-defined points in time).

The API names of the JLEF shall obey the following pattern: • CanIf_TTJobListExec_0() for Controller # 0 • CanIf_TTJobListExec_1() for Controller # 1 • CanIf_TTJobListExec_2() for Controller # 2 • CanIf_TTJobListExec_3() for Controller # 3 • ... and so on, if more than 4 Controllers are supported.

If the JLEF lost synchronisation to the Local Time of the TTCAN Controller then the function Dem_SetEventStatus(CANIF_TT_E_- JLE_SYNC, DEM_EVENT_STATUS_FAILED) shall be called.

Extended Production Errors of TtcanIf are defined in 7.1.

If parameter Controller of CanIf_TTGetController- Time() has an invalid value and if development error detection is enabled (i.e. CANIF_DEV_ERROR_DETECT equals ON ), the function CanIf_TTGetController- Time() shall report development error code CANIF_E_PARAM_CONTROLLER to the Det_ReportError service of the DET module.

Caveats of CanIf_TTGetControllerTime() : TtcanIf has to be initialized before this API service may be called.

If parameter Controller of CanIf_TTGetMasterState () has an invalid value and if development error detection is enabled (i.e. CANIF_- DEV_ERROR_DETECT equals ON ), the function CanIf_TTGetMasterState() shall report development error code CANIF_E_PARAM_CONTROLLER to the Det_Re- portError service of the DET module.

Caveats of CanIf_TTGetMasterState() : TtcanIf has to be initialized before this API service may be called.

If parameter Controller of CanIf_TTGetNTUActual() has an invalid value and if development error detection is enabled (i.e. CANIF_DEV_- ERROR_DETECT equals ON ), the function CanIf_TTGetNTUActual() shall report development error code CANIF_E_PARAM_CONTROLLER to the Det_ReportError service of the DET module.

Caveats of CanIf_TTGetNTUActual() : TtcanIf has to be initialized before this API service may be called.

If parameter Controller of CanIf_TTGetErrorLevel() has an invalid value and if development error detection is enabled (i.e. CANIF_DEV_- ERROR_DETECT equals ON ), the function CanIf_TTGetErrorLevel() shall report development error code CANIF_E_PARAM_CONTROLLER to the Det_ReportError service of the DET module.

Caveats of CanIf_TTGetErrorLevel() : TtcanIf has to be initialized before this API service may be called.

If parameter Controller of CanIf_TTSetNextIsGap() has an invalid value and if development error detection is enabled (i.e. CANIF_DEV_- ERROR_DETECT equals ON ), the function CanIf_TTSetNextIsGap() shall report development error code CANIF_E_PARAM_CONTROLLER to the Det_ReportError service of the DET module.

Caveats of CanIf_TTSetNextIsGap() : TtcanIf has to be initialized before this API service may be called.

If parameter Controller of CanIf_TTSetEndOfGap() has an invalid value and if development error detection is enabled (i.e. CANIF_- DEV_ERROR_DETECT equals ON ), the function CanIf_TTSetEndOfGap() shall re- port development error code CANIF_E_PARAM_CONTROLLER to the Det_ReportEr- ror service of the DET module.

Caveats of CanIf_TTSetEndOfGap() : TtcanIf has to be initialized before this API service may be called.

If parameter Controller of CanIf_TTSetTimeCommand () has an invalid value and if development error detection is enabled (i.e. CANIF_- DEV_ERROR_DETECT equals ON ), the function CanIf_TTSetTimeCommand() shall report development error code CANIF_E_PARAM_CONTROLLER to the Det_Re- portError service of the DET module.

Caveats of CanIf_TTSetTimeCommand() : TtcanIf has to be initialized before this API service may be called.

If parameter Controller of CanIf_TTGlobalTimePre- set() has an invalid value and if development error detection is enabled (i.e. CANIF_DEV_ERROR_DETECT equals ON ), the function CanIf_TTGlobalTimePre- set() shall report development error code CANIF_E_PARAM_CONTROLLER to the Det_ReportError service of the DET module.

Caveats of CanIf_TTGlobalTimePreset() : TtcanIf has to be initialized before this API service may be called.

If parameter Controller of CanIf_TTSe- tExtClockSyncCommand() has an invalid value and if development error de- tection is enabled (i.e. CANIF_DEV_ERROR_DETECT equals ON ), the function CanIf_TTSetExtClockSyncCommand() shall report development error code CANIF_E_PARAM_CONTROLLER to the Det_ReportError service of the DET module.

Caveats of CanIf_TTSetExtClockSyncCommand() : TtcanIf has to be initialized before this API service may be called.

If parameter Controller of CanIf_TTSetNTUAdjust() has an invalid value and if development error detection is enabled (i.e. CANIF_DEV_- ERROR_DETECT equals ON ), the function CanIf_TTSetNTUAdjust() shall report development error code CANIF_E_PARAM_CONTROLLER to the Det_ReportError service of the DET module.

Caveats of CanIf_TTSetNTUAdjust() : TtcanIf has to be initialized before this API service may be called.

The function CanIf_TTJobListExec_<Controller>() shall exist once per TTCAN Controller , which use a Job List .

The function name of each instance of CanIf_TTJobLis- tExec_<Controller>() shall contain the index of the respective TTCAN Con- troller .

Caveats of CanIf_TTJobListExec_<Controller>() : TtcanIf has to be initialized before this API service may be called.

If parameter Controller of CanIf_TTGetSyncQuality () has an invalid value and if development error detection is enabled (i.e. CANIF_- DEV_ERROR_DETECT equals ON ), the function CanIf_TTGetSyncQuality() shall report development error code CANIF_E_PARAM_CONTROLLER to the Det_Re- portError service of the DET module.

Caveats of CanIf_TTGetSyncQuality() : TtcanIf has to be initialized before this API service may be called.

If parameter Controller of CanIf_TTSetTimeMark() has an invalid value and if development error detection is enabled (i.e. CANIF_- DEV_ERROR_DETECT equals ON ), the function CanIf_TTSetTimeMark() shall re- port development error code CANIF_E_PARAM_CONTROLLER to the Det_ReportEr- ror service of the DET module.

Caveats of CanIf_TTSetTimeMark() : TtcanIf has to be initialized before this API service may be called.

If parameter Controller of CanIf_TTCancelTimeMark () has an invalid value and if development error detection is enabled (i.e. CANIF_- DEV_ERROR_DETECT equals ON ), the function CanIf_TTCancelTimeMark() shall report development error code CANIF_E_PARAM_CONTROLLER to the Det_Re- portError service of the DET module.

Caveats of CanIf_TTCancelTimeMark() : TtcanIf has to be initialized before this API service may be called.

If parameter Controller of CanIf_TTAckTimeMark() has an invalid value and if development error detection is enabled (i.e. CANIF_- DEV_ERROR_DETECT equals ON ), the function CanIf_TTAckTimeMark() shall re- port development error code CANIF_E_PARAM_CONTROLLER to the Det_ReportEr- ror service of the DET module.

Caveats of CanIf_TTAckTimeMark() : TtcanIf has to be initialized before this API service may be called.

If parameter Controller of CanIf_TTEnable- TimeMarkIRQ() has an invalid value and if development error detection is enabled (i.e. CANIF_DEV_ERROR_DETECT equals ON ), the function CanIf_TTEnable- TimeMarkIRQ() shall report development error code CANIF_E_PARAM_CON- TROLLER to the Det_ReportError service of the DET module.

Caveats of CanIf_TTEnableTimeMarkIRQ() : TtcanIf has to be initialized before this API service may be called.

If parameter Controller of CanIf_TTDisable- TimeMarkIRQ() has an invalid value and if development error detection is enabled (i.e. CANIF_DEV_ERROR_DETECT equals ON ), the function CanIf_TTDisable- TimeMarkIRQ() shall report development error code CANIF_E_PARAM_CON- TROLLER to the Det_ReportError service of the DET module.

Caveats of CanIf_TTDisableTimeMarkIRQ() : TtcanIf has to be initialized before this API service may be called.

If parameter Controller of CanIf_TTGet- TimeMarkIRQStatus() has an invalid value and if development error detection is enabled (i.e. CANIF_DEV_ERROR_DETECT equals ON ), the function CanIf_- TTGetTimeMarkIRQStatus() shall report development error code CANIF_- E_PARAM_CONTROLLER to the Det_ReportError service of the DET module.

Caveats of CanIf_TTGetTimeMarkIRQStatus() : TtcanIf has to be initialized before this API service may be called.

If parameter ControllerId of CanIf_TTApplWatch- dogError() has an invalid value and if development error detection is enabled (i.e. CANIF_DEV_ERROR_DETECT equals ON ), then the function CanIf_TTApplWatch- dogError() shall report development error code CANIF_E_PARAM_CONTROLLER to the Det_ReportError service of the DET module.

If parameter ControllerId of CanIf_TTTimingError() has an invalid value and if development error detection is enabled (i.e. CANIF_DEV_- ERROR_DETECT equals ON ), then the function CanIf_TTTimingError() shall report development error code CANIF_E_PARAM_CONTROLLER to the Det_ReportError service of the DET module.

If parameter ControllerId of CanIf_TTGap() has an in- valid value and if development error detection is enabled (i.e. CANIF_DEV_ERROR_- DETECT equals ON ), then the function CanIf_TTGap() shall report development error code CANIF_E_PARAM_CONTROLLER to the Det_ReportError service of the DET module.

If parameter ControllerId of CanIf_TTStartOfCycle () has an invalid value and if development error detection is enabled (i.e. CANIF_- DEV_ERROR_DETECT equals ON ), then the function CanIf_TTStartOfCycle() shall report development error code CANIF_E_PARAM_CONTROLLER to the Det_- ReportError service of the DET module.

If parameter ControllerId of CanIf_TTTimeDisc() has an invalid value and if development error detection is enabled (i.e. CANIF_DEV_ER- ROR_DETECT equals ON ), then the function CanIf_TTTimeDisc() shall report devel- opment error code CANIF_E_PARAM_CONTROLLER to the Det_ReportError service of the DET module.

If parameter ControllerId of CanIf_TTMasterState- Change() has an invalid value and if development error detection is enabled (i.e. CANIF_DEV_ERROR_DETECT equals ON ), then the function CanIf_TTMasterStat- eChange() shall report development error code CANIF_E_PARAM_CONTROLLER to the Det_ReportError service of the DET module.

Can_TTGetControllerTime Ttcan.h Gets the current values for the global, local and cycle time and the cycle count of the controller Can_TTGetErrorLevel Ttcan.h Gets the error level. This includes the severity of the error level (S0-S3) and the minimum and maximum value of the message status count. Can_TTGetMasterState Ttcan.h Gets the master state. The master state includes the sync mode (sync_off, synchronizing, in_gap, in_ schedule) the master-slave mode (master_off, slave, backup_master, current_master) and the current value for ref trigger offset. Can_TTGetNTUActual Ttcan.h Gets the actual value of NTU (network time unit). Together with the local oscillator period, the actual value of NTU can be derived from the actual value of TUR. Can_TTGlobalTimePreset Ttcan.h Sets the value of "global time preset". Can_TTSetEndOfGap Ttcan.h Signals the end of a gap. Can_TTSetExtClockSyncCommand Ttcan.h Adjusts the NTU (network time unit) according to the value given by "NTU adjust". Together with the local oscillator period, "TUR adjust" can be derived from "NTU adjust". Can_TTSetNextIsGap Ttcan.h Sets the "Next_is_Gap" bit. Can_TTSetNTUAdjust Ttcan.h Sets the value of "NTU adjust". Together with the local oscillator period, "TUR adjust" can be derived from "NTU adjust". Can_TTSetTimeCommand Ttcan.h Adjusts the global time at the beginning of the next basic cycle by the amount of "global time preset" Dem_SetEventStatus Dem.h Called by SW-Cs or BSW modules to report monitor status information to the Dem. BSW modules calling Dem_SetEventStatus can safely ignore the return value. This API will be available only if ({Dem/Dem ConfigSet/DemEventParameter/DemEvent ReportingType} == STANDARD_REPORTING)

Can_TTAckTimeMark Ttcan.h Acknowledges the time mark interrupt by resetting the flag in the interrupt vector register. Can_TTCancelTimeMark Ttcan.h Cancels the time mark. Can_TTDisableTimeMarkIRQ Ttcan.h Disables the time mark interrupt. Can_TTEnableTimeMarkIRQ Ttcan.h Enables the time mark interrupt. API Function Header File Description Can_TTGetSyncQuality Ttcan.h Gets the synchronization quality. Can_TTGetTimeMarkIRQStatus Ttcan.h Gets the IRQ status of the time mark. Can_TTReceive Ttcan.h Reads received data from the controller by returning the pointer of the CanID, the DLC and the Data of the message in the requested HRH. Can_TTSetTimeMark Ttcan.h Sets a new value for the time mark for the given time source.

If development error detection for TtcanIf is enabled: The function CanIf_TTGetControllerTime() shall raise the error CANIF_E_PARAM_- POINTER and shall return E_NOT_OK if one of the parameter CanIf_TTCycle- Count , CanIf_TTGlobalTime , CanIf_TTLocalTime and CanIf_TTCycleTime is a NULL pointer.

If development error detection for TtcanIf is enabled: The function CanIf_TTGetMasterState() shall raise the error CAN_E_PARAM_- POINTER and shall return E_NOT_OK if the parameter CanIf_TTMasterState is a NULL pointer.

If development error detection for TtcanIf is enabled: The function CanIf_TTGetErrorLevel() shall raise the error CAN_E_PARAM_POINTER and shall return E_NOT_OK if the parameter CanIf_TTErrorLevel is a NULL pointer.

If development error detection for TtcanIf is enabled: The function CanIf_TTGetSyncQuality() shall raise the error CAN_E_PARAM_- POINTER and shall return E_NOT_OK if one of the parameter CanIf_ClockSpeed and CanIf_GlobalTimePhase is a NULL pointer.

If development error detection for TtcanIf is enabled: The function CanIf_TTGetTimeMarkIRQStatus() shall raise the error CAN_E_- PARAM_POINTER and shall return E_NOT_OK if the parameter CanIf_IRQStatus is a NULL pointer.

The function CanIf_TTGetControllerTime() shall call Can_TTGetControllerTime(Controller, Can_TTGlobalTime, CanTT- LocalTime, Can_TTCycleTime, Can_TTCycleCount) .

The function CanIf_TTGetMasterState() shall call Can_TTGetMasterState(Controller, Can_TTMasterState) .

The function CanIf_TTGetNTUActual() shall call Can_- TTGetNTUActual(Controller, Can_TTTURAct) .

The function CanIf_TTGetErrorLevel() shall call Can_- TTGetErrorLevel(Controller, Can_TTErrorLevel) .

The function CanIf_TTSetNextIsGap() shall call Can_- TTSetNextIsGap(Controller) .

The function CanIf_TTSetEndOfGap() shall call Can_- TTSetNextIsGap(Controller) .

The function CanIf_TTSetTimeCommand() shall call Can_TTSetTimeCommand(Controller) .

The function CanIf_TTGlobalTimePreset() shall call Can_TTGlobalTimePreset(Controller, Can_TTGlobalTimePreset) .

The function CanIf_TTSetExtClockSyncCommand() shall call Can_TTSetExtClockSyncCommand(Controller) .

The function CanIf_TTSetNTUAdjust() shall call Can_- TTSetNTUAdjust(Controller, Can_TTNTUAdjust) .

The function CanIf_TTGetSyncQuality() shall call Can_TTGetSyncQuality(Controller, Can_TTClockSpeed, Can_TTGlob- alTimePhase) .

The function CanIf_TTSetTimeMark() shall call Can_- TTSetTimeMark(Controller, Can_TTTimeMark, Can_TTTimeSource) .

The function CanIf_TTCancelTimeMark() shall call Can_TTCancelTimeMark(Controller) .

The function CanIf_TTAckTimeMark() shall call Can_- TTAckTimeMark(Controller) .

The function CanIf_TTEnableTimeMarkIRQ() shall call Can_TTEnableTimeMarkIRQ(Controller) .

The function CanIf_TTDisableTimeMarkIRQ() shall call Can_TTDisableTimeMarkIRQ(Controller) .

The function CanIf_TTGetTimeMarkIRQStatus() shall call Can_TTGetTimeMarkIRQStatus(Controller, Can_TTIRQStatus) .

If a CanIf Controller mode state machine is either in state CAN_CS_STARTED , CAN_CS_STOPPED or CAN_CS_SLEEP when function CanIf_TT- SevereError() is called, then CanIf shall call the function CanSM_Controller- BusOff() for the CAN Network assigned to parameter Controller of CanIf_TT- SevereError() .

If a CanIf Controller mode state machine is in state CAN_CS_- STARTED when the function CanIf_TTSevereError(ControllerId, CanIf_- TTSevereError) is called with parameter ControllerId referencing that CanIf Controller mode state machine, then CanIf shall call Can_SetControllerMode (Controller, CAN_CS_STOPPED) and CanIf shall call CanSM_ControllerBu- sOff(ControllerId) of CanSM .

If parameter ControllerId of CanIf_TTSevereError() has an invalid value and if development error detection is enabled (i.e. CANIF_DEV_- ERROR_DETECT equals ON ), then the function CanIf_TTSevereError() shall report development error code CANIF_E_PARAM_CONTROLLER to the Det_ReportError service of the DET module.

Module Header File Imported Type Can_GeneralTypes.h Can_IdType Ttcan.h Can_TTErrorLevelEnumType Ttcan.h Can_TTErrorLevelType Ttcan.h Can_TTMasterSlaveModeType Ttcan.h Can_TTMasterStateType Ttcan.h Can_TTSyncModeEnumType Ttcan.h Can_TTTURType Ttcan.h Can_TTTimeSourceType Can Ttcan.h Can_TTTimeType ComStack_Types.h PduIdType ComStack_Types.h PduInfoType ComStack_Types ComStack_Types.h PduLengthType Rte_Dem_Type.h Dem_EventIdType Dem Rte_Dem_Type.h Dem_EventStatusType Std Std_Types.h Std_ReturnType

If a Job List is configured for a Tx L-PDU (see CanIfT- TJoblist ), a function call of CanIf_Transmit() (see SWS_CanIf_00318 ) shall not directly call Can_Write() . The information that a call of CanIf_Transmit() occurred has to be buffered within TtcanIf until the data is transmitted by the Job List .

For each Controller that is controlled by TtcanIf one dedicated Job List and one dedicated JLEF (refer to section 7.3) shall be used. It's possible to mixture both variants, with and without the usage of a Job List .

If during JLEF <User_TriggerTransmit>() returns E_- NOT_OK , TtcanIf shall not call Can_Write() afterwards.

If the JLEF was executed successfully, then the func- tion Dem_SetEventStatus(CANIF_TT_E_JLE_SYNC, DEM_EVENT_STATUS_- PASSED) shall be called.

These requirements are not applicable to this specification.