Large Data COM (LdCom)

This service initializes internal and external interfaces and variables of the AUTOSAR LdCom module for the further processing.

With a call to LdCom_DeInit the AUTOSAR LdCom module is put into an not initialized state.

Returns the version information of this module.

Requests transmission of a signal.

This function is called to acquire the transmit data of an I-PDU segment (N-PDU). Each call to this function provides the next part of the I-PDU data unless retry->TpDataState is TP_ DATARETRY. In this case the function restarts to copy the data beginning at the offset from the current position indicated by retry->TxTpDataCnt. The size of the remaining data is written to the position indicated by availableDataPtr.

This function is called after the I-PDU has been transmitted on its network, the result indicates whether the transmission was successful or not.

This function is called at the start of receiving an N-SDU. The N-SDU might be fragmented into multiple N-PDUs (FF with one or more following CFs) or might consist of a single N-PDU (SF). The service shall provide the currently available maximum buffer size when invoked with TpSdu Length equal to 0.

This function is called to provide the received data of an I-PDU segment (N-PDU) to the upper layer. Each call to this function provides the next part of the I-PDU data. The size of the remaining buffer is written to the position indicated by bufferSizePtr.

Called after an I-PDU has been received via the TP API, the result indicates whether the transmission was successful or not.

Indication of a received PDU from a lower layer communication interface module.

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.

This function is called to acquire the transmit data of an I - PDU segment (N - PDU). Each call to this function provides the next part of the I - PDU data u nless retry - >Tp Data State is TP_ DATARETRY. In this case the function restarts to copy the data beginning at the offset from the current position indicated by retry - >Tx Tp Data Cnt. The size of the remaining data is written to the position indicated by av ailable Data Ptr Tags: atp.Status=obsolete

This function is called after a Signal has been transmitted via the TP - API on its network. Tags: atp.Status=obsolete

This function is called at the start of receiving an N - SDU. The N - SDU might be fragmented into multiple N - PDUs (FF with one or more following CFs) or might consist of a single N - PDU (SF). The service shall provide the currently available maximum buffer size when invoked with Tp Sdu Length equal to 0. Tags: atp.Status=obsolete A vailable via Rte_ Cbk.h

{OBSOLETE} Service Name Rte_ Ld Com Cbk Copy Rx Data_<sn> (obsolete) Syntax Buf Req_ Return Type Rte_ Ld Com Cbk Copy Rx Data_<sn> ( const Pdu Info Type* info, Pdu Length Type* buffer Size Ptr ) Sync/ Async Synchronous Reentrancy Non Reentrant for same sn, otherwise Reentrant Parameters (in) info Provides the source buffer (Sdu Data Ptr) and the number of bytes to be copied (Sdu Length). An Sdu Length of 0 can be used to query the current amount of available buffer in the upper layer module. In this case, the Sdu Data Ptr may be a NULL_ PTR. Param eters (inout) None Parameters (out) buffer Size Ptr Available receive buffer after data has been copied. Return value Buf Req _ - Return - Type BUFREQ_ OK: Data copied successfully BUFREQ_ E_ NOT_ OK: Data was not copied because an error occurred. Descript ion This function is called to provide the received data of an I - PDU segment (N - PDU) to the upper layer. Each call to this function provides the next part of the I - PDU data. The size of the remaining data is written to the position indicated by buffer Size Ptr. Tags: atp.Status=obsolete Available via Rte_ Cbk.h

Called after an I - PDU has been received via the TP API, the result indicates whether the transmission was successful or not. Tags: atp.Status=obsolete

Indication of a received PDU from a lower layer communication interface module. Tags: atp.Status=obsolete

Within this API, the upper layer module (called module) shall check whether the available data fits into the buffer size reported by Pdu Info Ptr - >Sdu Length. If it fits, it shall copy its data into the buffer provided by Pdu Info Ptr - >Sdu Data Ptr and update the length of the actual copied data in Pdu Info Ptr - >Sdu Length. If not, it returns E_ NOT_ OK without changing Pdu Info Ptr. Tags: atp.Status=obsolete

The lower layer communication interface module confirms the transmission of a PDU, or the failure to transmit a PDU. Tags: atp.Status=obsolete

The lower layer communication interface module confirms the transmission of a PDU, or the failure to transmit a PDU.

This function is called to acquire the transmit data of an I-PDU segment (N-PDU). Each call to this function provides the next part of the I-PDU data unless retry->TpDataState is TP_ DATARETRY. In this case the function restarts to copy the data beginning at the offset from the current position indicated by retry->TxTpDataCnt. The size of the remaining data is written to the position indicated by availableDataPtr Tags: atp.Status=draft

This function is called after a Signal has been transmitted via the TP-API on its network. Tags: atp.Status=draft

This function is called at the start of receiving an N-SDU. The N-SDU might be fragmented into multiple N-PDUs (FF with one or more following CFs) or might consist of a single N-PDU (SF). The service shall provide the currently available maximum buffer size when invoked with TpSdu Length equal to 0. Tags: atp.Status=draft

This function is called to provide the received data of an I-PDU segment (N-PDU) to the upper layer. Each call to this function provides the next part of the I-PDU data. The size of the remaining data is written to the position indicated by bufferSizePtr. Tags: atp.Status=draft

Called after an I-PDU has been received via the TP API, the result indicates whether the transmission was successful or not. Tags: atp.Status=draft

Indication of a received PDU from a lower layer communication interface module. Tags: atp.Status=draft

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. Tags: atp.Status=draft

The lower layer communication interface module confirms the transmission of a PDU, or the failure to transmit a PDU. Tags: atp.Status=draft

This type contains the implementation-specific post build configuration structure.

Type of error Related error code Value [hex] Error code if any other API service, except LdCom_GetVersionInfo is called before the AUTOSAR LdCom module was initialized with LdCom_Init or after a call to LdCom_Deinit LDCOM_E_UNINIT 0x02 API service called with a NULL pointer. In case of this error, the API service shall return immediately without any further action, except for reporting this development error. LDCOM_E_PARAM_POINTER 0x03 API service called with wrong PDU-ID LDCOM_E_INVALID_PDU_SDU_ID 0x04 API service called with wrong Signal-ID LDCOM_E_INVALID_SIGNAL_ID 0x05 Invalid configuration set selection LDCOM_E_INIT_FAILED 0x06 Table 7.2: Development Error Types

Module Header File Imported Type ComStack_Types.h BufReq_ReturnType ComStack_Types.h CbkHandleIdType (draft) ComStack_Types.h PduIdType ComStack_Types.h PduInfoType ComStack_Types.h PduLengthType ComStack_Types.h RetryInfoType ComStack_Types ComStack_Types.h TpDataStateType Std_Types.h Std_ReturnType Std Std_Types.h Std_VersionInfoType

Det_ReportError Det.h Service to report development errors. PduR_LdComTransmit PduR_LdCom.h Requests transmission of a PDU.

LdCom_TxConfirmation shall only be available if at least one LdComIPdu has LdComIPduDirection configured to LDCOM_SEND and LdComApi- Type configured to LDCOM_IF.

LdCom_RxIndication shall only be available if at least one Ld- ComIPdu has LdComIPduDirection configured to LDCOM_RECEIVE and LdComApi- Type configured to LDCOM_IF.

When called by its users (e.g. RTE, SwCluC LdCom Proxy), LdCom shall use the Signal Id ("id" parameter in the call) as LdComHandleId (ECUC_LdCom_00005), to look-up the correct LdComIPdu in the LdCom configura- tion. Using the LdComPduRef configuration parameter (ECUC_LdCom_00010) the corresponding PDU Id in the PduR'S configuration shall be derived. This PDU Id shall then be used when forwarding the call towards the PduR.

{DRAFT} When called by its users (e.g. RTE, SwCluC LdCom Proxy), LdCom shall use the Signal Id ("id" parameter in the call) as LdComHandleId (ECUC_LdCom_00005) to look-up the correct LdComIPdu in the LdCom configura- tion. Using the LdComPduRef configuration parameter (ECUC_LdCom_00010) the corresponding PDU Id in the PduR'S configuration shall be derived. This PDU Id shall then be used when forwarding the call towards the PduR.

{DRAFT} When LdCom_TriggerTransmit is invoked, LdCom shall use the passed PDU Id as Handle Id (LdComHandleId ECUC_LdCom_00005) to derive the corresponding <LdComUser_LdComCbkTriggerTransmit> user notification callback and call it with the according LdCom user callback handle Id.

{DRAFT} When LdCom_TxConfirmation is invoked, LdCom shall use the passed PDU Id as Handle Id (LdComHandleId ECUC_LdCom_00005) to derive the corresponding <LdComUser_LdComCbkTxConfirmation> user notification callback and call it with the according LdCom user callback handle Id.

{DRAFT} When LdCom_CopyTxData and Ld- Com_TpTxConfirmation are invoked, LdCom shall use the passed PDU Id as Handle Id (LdComHandleId ECUC_LdCom_00005) to derive the corresponding <Ld- ComUser_LdComCbkCopyTxData> or <LdComUser_LdComCbkTpTxConfir-mation> user notification callback and call it with the according LdCom user callback handle Id.

{DRAFT} When LdCom_RxIndication is invoked, LdCom shall use the passed PDU Id as Handle Id (LdComHandleId ECUC_LdCom_00005) to de- rive the corresponding <LdComUser_LdComCbkRxIndication> user notification call- backs and call them with the according LdCom user callback handle Id.

{DRAFT} When LdCom_StartOfReception is invoked, LdCom shall use the passed PDU Id as Handle Id (LdComHandleId ECUC_LdCom_00005) to derive the corresponding <LdComUser_LdComCbkStartOfReception> user notifi- cation callback and call it with the according LdCom user callback handle Id.

{DRAFT} When LdCom_CopyRxData is invoked, LdCom shall use the passed PDU Id as Handle Id (LdComHandleId ECUC_LdCom_00005) to de- rive the corresponding <LdComUser_LdComCbkCopyRxData> user notification call- back and call it with the according LdCom user callback handle Id.

{DRAFT} When LdCom_TpRxIndication is invoked, LdCom shall use the passed PDU Id as Handle Id (LdComHandleId ECUC_LdCom_00005) to derive the corresponding <LdComUser_LdComTpRxIndication> user notification call- back and call it with the according LdCom user callback handle Id.

The AUTOSAR LdCom module's initialization function Ld- Com_Init shall initialize all internal data.

The AUTOSAR LdCom module shall provide the API function LdCom_DeInit for de-initialization of the AUTOSAR LdCom module. Inside this function call all de-initialization shall take place.

When LdCom_Transmit is invoked, LdCom shall invoke PduR_LdComTransmit by replacing the Signal Id by the according PDU Id.

LdCom shall pass invocations of LdCom_Transmit to PduR_LdComTransmit by replacing the Signal Id by the according PDU Id.

The API LdCom_GetVersionInfo shall be configured byLd- ComVersionInfoAPI.

LdCom_TriggerTransmit shall only be available if at least one LdComIPdu has LdComTxTriggerTransmit configured.

The LdCom implementation shall include Det.h if LdComDe- vErrorDetect is enabled.

{DRAFT} Sent IPdus shall be owned by at most one LdCom user.

{DRAFT} All LdCom users registering notifications for IPdus shall reside on the EcucPartition on which the LdCom module handles the related IPdu.

{DRAFT} Only a single LdCom user can be notified with <LdComUser_LdComCbkTriggerTransmit>.

{DRAFT} Only a single LdCom user can be notified with <LdComUser_LdComCbkTriggerTransmit>.

{DRAFT} Only a single LdCom user can be notified with <LdComUser_LdComCbkCopyTxData> or <LdCo- mUser_LdComCbkTpTxConfirmation>.

{DRAFT} Only a single LdCom user can be notified with <LdComUser_LdComCbkStartOfReception>.

{DRAFT} Only a single LdCom user can be notified with <LdComUser_LdComCbkCopyRxData>.

{DRAFT} Only a single LdCom user can be notified with <LdComUser_LdComTpRxIndication>.

If there exists a LdComUserIPdu with the Ld- ComIPduDirection set to LDCOM_SEND and LdComApiType set to LDCOM_TP which references an ISignal, the respective • <LdComUser_LdComCbkCopyTxData> • <LdComUser_LdComCbkTpTxConfirmation> Notification callbacks shall be configured too.

If there exists a LdComUserIPdu with the Ld- ComIPduDirection set to LDCOM_RECEIVE and LdComApiType set to LDCOM_TP, the respective • <LdComUser_LdComCbkStartOfReception> • <LdComUser_LdComCbkCopyRxData> • <LdComUser_LdComTpRxIndication> Notification callbacks shall be configured too.

If there exists a LdComUserIPdu with the Ld- ComIPduDirection set to LDCOM_RECEIVE and LdComApiType set to LDCOM_IF, the respective • <LdComUser_LdComCbkRxIndication> Notification callback shall be configured too.