SNIP_CLASSIC_COMSTACK_SECTION_8_6_3_Configurable_interfaces_SAEJ1939DIAGNOSTICCOMMUNICATIONMANAGER

8.6.3 Configurable interfaces This section lists all interfaces where the target function can be configured. The target function is usually a call-back function. The name of this kind of interfaces is not fixed because they are configurable. 8.6.3.1 <GenericDMxRequestIndication> [SWS_J1939Dcm_91001] Definition of configurable interface <GenericDMxRequestIndication> Upstream requirements: RS_Diag_04241 ⌈ Service Name <GenericDMxRequestIndication> Syntax void <GenericDMxRequestIndication> ( uint8 dmId, NetworkHandleType channel, uint8 sourceAddress, uint8 destAddress, uint8 priority ) Sync/Async Synchronous Reentrancy Non Reentrant dmId Number of the requested J1939 diagnostic message. channel Channel on which the request was received. sourceAddress Address of the node that sent the Request PG. destAddress Address of this node or 0xFF for broadcast. Parameters (in) priority Priority of the Request PG. Parameters (inout) None Parameters (out) None Return value None Description Indicates reception of a Request or Request2 PG for an unsupported diagnostic message. Available via J1939Dcm.h ⌋ Manager for SAE J1939 8.6.3.2 <GenericDMxCopyTxData> [SWS_J1939Dcm_91005] Definition of configurable interface <GenericDMxCopy TxData> Upstream requirements: RS_Diag_04241 ⌈ Service Name <GenericDMxCopyTxData> Syntax BufReq_ReturnType <GenericDMxCopyTxData> ( uint8 dmId, NetworkHandleType channel, const PduInfoType info, const RetryInfoType* retry, PduLengthType* availableDataPtr ) Sync/Async Synchronous Reentrancy Non Reentrant dmId Number of the J1939 diagnostic message channel Channel on which the message is transmitted info Provides the destination buffer (SduDataPtr) and the number of bytes to be copied (SduLength). If not enough transmit data is available, no data is copied by the upper layer module and BUFREQ_E_BUSY is returned. The lower layer module may retry the call. An SduLength of 0 can be used to indicate state changes in the retry parameter or to query the current amount of available data in the upper layer module. In this case, the Sdu DataPtr may be a NULL_PTR. Parameters (in) retry This parameter is used to acknowledge transmitted data or to retransmit data after transmission problems. If the retry parameter is a NULL_PTR, it indicates that the transmit data can be removed from the buffer immediately after it has been copied. Otherwise, the retry parameter must point to a valid RetryInfoType element. If TpDataState indicates TP_CONFPENDING, the previously copied data must remain in the TP buffer to be available for error recovery. TP_DATACONF indicates that all data that has been copied before this call is confirmed and can be removed from the TP buffer. Data copied by this API call is excluded and will be confirmed later. TP_DATARETRY indicates that this API call shall copy previously copied data in order to recover from an error. In this case TxTpDataCnt specifies the offset in bytes from the current data copy position. Parameters (inout) None Parameters (out) availableDataPtr Indicates the remaining number of bytes that are available in the upper layer module’s Tx buffer. availableDataPtr can be used by TP modules that support dynamic payload lengths (e.g. FrIsoTp) to determine the size of the following CFs. Return value BufReq_ReturnType BUFREQ_OK: Data has been copied to the transmit buffer completely as requested. BUFREQ_E_BUSY: Request could not be fulfilled, because the required amount of Tx data is not available. The lower layer module may retry this call later on. No data has been copied. BUFREQ_E_NOT_OK: Data has not been copied. Request failed. ▽ Manager for SAE J1939 △ Description This function is called to acquire the transmit data of a diagnostic message segment. Each call to this function provides the next part of the diagnostic message data unless retry->TpData 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->TxTpDataCnt. The size of the remaining data is written to the position indicated by availableDataPtr. Available via J1939Dcm.h ⌋ 8.6.3.3 <GenericDMxTxConfirmation> [SWS_J1939Dcm_91003] Definition of configurable interface <GenericDMxTx Confirmation> Upstream requirements: RS_Diag_04241 ⌈ Service Name <GenericDMxTxConfirmation> Syntax void <GenericDMxTxConfirmation> ( uint8 dmId, NetworkHandleType channel, Std_ReturnType result ) Sync/Async Synchronous Reentrancy Non Reentrant dmId Number of the J1939 diagnostic message. channel Channel on which the message is transmitted. Parameters (in) result E_OK: The PDU was transmitted. E_NOT_OK: Transmission of the PDU failed. Parameters (inout) None Parameters (out) None Return value None Description Called after a diagnostic message has been transmitted, the result indicates whether the transmission was successful or not. Available via J1939Dcm.h ⌋ Manager for SAE J1939 8.6.3.4 <GenericDMxStartOfReception> [SWS_J1939Dcm_91004] Definition of configurable interface <GenericDMxStart OfReception> Upstream requirements: RS_Diag_04241 ⌈ Service Name <GenericDMxStartOfReception> Syntax BufReq_ReturnType <GenericDMxStartOfReception> ( uint8 mId, NetworkHandleType channel, PduLengthType length, PduLengthType bufferSizePtr, uint8 sourceAddress, uint8 priority ) Sync/Async Synchronous Reentrancy Non Reentrant mId Number of the J1939 diagnostic message. channel Channel on which the message is received. length Total length of the diagnostic message to be received. sourceAddress Address of the node that sent the diagnostic message. Parameters (in) priority Priority of the diagnostic message. Parameters (inout) None Parameters (out) bufferSizePtr Available receive buffer. Return value BufReq_ReturnType BUFREQ_OK: Connection has been accepted. bufferSizePtr indicates the available receive buffer; reception is continued. If no buffer of the requested size is available, a receive buffer size of 0 shall be indicated by bufferSizePtr. BUFREQ_E_NOT_OK: Connection has been rejected; reception is aborted. bufferSizePtr remains unchanged. BUFREQ_E_OVFL: No buffer of the required length can be provided; reception is aborted. bufferSizePtr remains unchanged. Description This function is called at the start of receiving an diagnostic message. Available via J1939Dcm.h ⌋