SNIP_CLASSIC_LINIF_SECTION_8_5_3_Configurable_interfaces

8.5.3 Configurable interfaces In this section, all interfaces are listed, where the target function of any upper layer to be called has to be set up by configuration. These call-out services are specified and implemented in the upper communication modules, which use the LIN Interface according to the AUTOSAR BSW architecture. The specific call-out notification is specified in the corresponding SWS document (see Chapter 3 “Related documentation”). As far the interface name is not specified to be mandatory, no call-out is performed, if no API name is configured. This section describes only the content of notification of the call-out, the call context inside the LIN Interface and exact time by the call event. <User>_NotificationName – This condition is applied for such interface services that will be implemented in the upper layer (‘user’) and called by the LIN Interface. This condition displays the symbolic name of the functional group in a call-out service in the corresponding upper layer. Each upper layer can define no, one or several call-out services for the same functionality (i.e. transmit confirmation). 8.5.3.1 <User>_ScheduleRequestConfirmation [SWS_LinIf_00520] Definition of configurable interface < User >_ScheduleRequestConfirmation ⌈ Service Name < User >_ScheduleRequestConfirmation Syntax void < User >_ScheduleRequestConfirmation ( NetworkHandleType channel, LinIf_SchHandleType ScheduleTableIdx ) Sync/Async Synchronous Reentrancy Reentrant channel Identification of the LIN channel Parameters (in) ScheduleTableIdx Index of the scheduled table Parameters (inout) None Parameters (out) None Return value None Description The LinIf will call this function when the schedule table change request has been performed. Available via Configuration parameters LinIfScheduleRequestConfirmationUL and LinIfPublicCddHeaderFile of the corresponding LinIfChannel ⌋ Configuration of <User>_ScheduleRequestConfirmation: The name of the API <User>_ScheduleRequestConfirmation which will be called by the LIN Interface module shall be configured for the LIN Interface module by parameter LinIfScheduleRequestConfirmationUL. 8.5.3.2 <User>_GotoSleepConfirmation [SWS_LinIf_00521] Definition of configurable interface < User >_GotoSleepConfirmation ⌈ Service Name < User >_GotoSleepConfirmation Syntax void < User >_GotoSleepConfirmation ( NetworkHandleType channel, boolean success ) Sync/Async Synchronous Reentrancy Reentrant channel Identification of the LIN channel Parameters (in) success True if goto sleep was successfully sent, false otherwise Parameters (inout) None Parameters (out) None Return value None ▽ △ Description The LinIf will call this function when the go to sleep command is sent not successfully/ successfully on the bus. Available via Configuration parameters LinIfGotoSleepConfirmationUL and LinIfPublicCddHeaderFile of the corresponding LinIfChannel ⌋ Configuration of <User>_GotoSleepConfirmation: The name of the API <User> _GotoSleepConfirmation which will be called by the LIN Interface module shall be configured for the LIN Interface module by parameter LinIfGotoSleepConfirmationUL. 8.5.3.3 <User>_WakeupConfirmation [SWS_LinIf_00522] Definition of configurable interface < User >_WakeupConfirmation ⌈ Service Name < User >_WakeupConfirmation Syntax void < User >_WakeupConfirmation ( NetworkHandleType channel, boolean success ) Sync/Async Synchronous Reentrancy Reentrant channel Identification of the LIN channel Parameters (in) success True if wakeup was successfully sent, false otherwise Parameters (inout) None Parameters (out) None Return value None Description The LinIf will call this function when the wake up signal command is sent not successfully/ successfully on the bus. Available via Configuration parameters LinIfWakeupConfirmationUL and LinIfPublicCddHeaderFile of the corresponding LinIfChannel ⌋ Configuration of <User>_WakeupConfirmation: The name of the API <User>_ WakeupConfirmation which will be called by the LIN Interface module shall be configured for the LIN Interface module by parameter LinIfWakeupConfirmationUL. 8.5.3.4 <User>_GotoSleepIndication [SWS_LinIf_00880] Definition of configurable interface <User>_GotoSleepIndication ⌈ Service Name <User>_GotoSleepIndication Syntax void <User>_GotoSleepIndication ( NetworkHandleType Channel ) Sync/Async Synchronous Reentrancy Reentrant for different Channels Parameters (in) Channel Identification of the LIN channel Parameters (inout) None Parameters (out) None Return value None Description The LinIf will call this callback when the go to sleep command is received on the network or a bus idle timeout occurs. Only applicable for LIN slave nodes. Available via Configuration parameters LinIfGotoSleepIndicationUL and LinIfPublicCddHeaderFile of the corresponding LinIfChannel ⌋ Configuration of <User>_GotoSleepIndication: The name of the API <User>_ GotoSleepIndication which will be called by the LIN Interface module shall be configured for the LIN Interface module by parameter LinIfGotoSleepIndicationUL.