Diagnostic over IP (DoIP)

Requests transmission of a PDU.

Requests cancellation of an ongoing transmission of a PDU in a lower layer communication module. The call of this API to cancel an ongoing transmission will close the used TCP connection.

Requests cancellation of an ongoing reception of a PDU in a lower layer transport protocol module. The call of this API to cancel an ongoing reception will close the used TCP connection.

This service initializes all global variables of the DoIP module. After return of this service the Do IP module is operational.

Returns the version information of this module.

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 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.

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.

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

Notification about a SoAd socket connection state change, e.g. socket connection gets online

This function gets called by the SoAd if an IP address assignment related to a socket connection changes (i.e. new address assigned or assigned address becomes invalid).

Schedules the Diagnostic over IP module. (Entry point for scheduling)

Callback function to check if the PowerMode of the DoIP entity is ready or not.

Callback function to get the confirmation for the Routing Activation.

Callback function to get the confirmation for the Routing Activation.

Function is used in the case that DoIPVinGIDMaster is set to true and a container DoIPTrigger GidSyncCallback is configured to trigger the synchronization process of the GroupIdentifier.

Function is used in the case that DoIPVinGIDMaster is set to false and DoIPGetGidCallback is configured to get on a vehicle identification the GID. If the return value is not E_OK the DoIP shall use the default GID.

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

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

Requests transmission of a PDU.

Requests cancellation of an ongoing transmission of a PDU in a lower layer communication module.

Callback function to get the OEM specific Further Action Byte for the DoIP vehicle identification response/vehicle announcement.

This function is to be used by integrators to inform the DoIP implementation about the status of the activation line of a DoIP interface with given InterfaceId.

This function is used to notify the DoIP module to start vehicle announcement for DoIP interfaces with given InterfaceId. This function is just a trigger to start the DoIPInitialVehicle AnnouncementTime timeout.

Call with argument NonTlsAllowed==TRUE to allow unsecured DoIP connection establishments. If called with NonTlsAllowed==FALSE, DoIP will close the unsecured connection with NRC 0x07 and require the tester to use TLS.

Configuration data structure of the DoIP module

Used for handling of the PowerMode in DoIP entity status requests Variation –

Variation Name = {ecuc(DoIP/DoIPConfigSet/DoIPInterface/DoIPRoutingActivation.SHORT-NAME)}

Variation Name = {ecuc(DoIP/DoIPConfigSet/DoIPRoutingActivation.SHORT-NAME)}

Variation Name = {ecuc(DoIP/DoIPConfigSet/DoIPRoutingActivation.SHORT-NAME)}

Variation Name = {ecuc(DoIP/DoIPConfigSet/DoIPRoutingActivation.SHORT-NAME)}

Used to get the OEM specific Further Action Byte for the DoIP vehicle identification response/ vehicle announcement. Variation –

The DoIP module shall maintain the following information of the configured DoIPUdpConnection (for UDP communication): (a) State of the SocketConnection

The DoIP module shall be able to maintain DoIPMaxTesterCon- nections configured connections with the following information: (a) DoIPSoAdTcpRxPduId, describes the connection to the SocketConnection (b) Source Address (SA) as soon as the information is available for the DoIP module (c) All Routing activation status of this socket connection (d) Status of the SocketConnection (f) Time since last TCP communication (Rx or Tx) (g) Information if the connection is active or not

The first 8 Bytes of a DoIP message shall contain the DoIP Header followed by the actual payload data.

Byte 0 of the DoIP header has to contain the protocol version e.g. 0x02.

The Byte 1 of the DoIP header shall contain the inverse protocol version e.g. 0xFD value shall be added if the protocol version is 0x02.

Byte 2 and Byte 3 shall contain the PayloadType.

The following PayloadTypes shall be supported for reception of DoIP messages:

The following PayloadTypes shall be supported for sending of DoIP messages:

Bytes 4 to 7 shall contain the payload length in Bytes not includ- ing the length of the DoIP header information (i.e. if a DoIP message is received with Payload length set to 2 it means that 10 Bytes in total were received).

If an invalid DoIP header was received, a DoIP message with payload type 0x0000 shall be transmitted with the payload described in [SWS_DoIP_00013] on the TxPdu which is related to the RxPdu the message was received on, if the according SocketConnection status has not changed since the re- ception of the DoIP message

The payload of the generic DoIP header shall contain the corresponding NACK code (1 Byte) as specified from [SWS_DoIP_00014] to [SWS_DoIP_00019].

If the Protocol information is incorrect, (see [SWS_DoIP_00005], [SWS_DoIP_00006] and [SWS_DoIP_00015] for valid information) the NACK code 0x00 shall be sent and the according socket shall be closed (see [SWS_DoIP_00058]).

On a vehicle identification request the Protocol Type 0xFF and the inverse Protocol Type 0x00 shall be supported as default values, additionally to the ProtocolType described in [SWS_DoIP_00005] and [SWS_DoIP_00006].

If a payload type is not supported (see [SWS_DoIP_00008] for valid payload types) the DoIP module shall send the NACK code 0x01 to indicate that a unkown payload type was requested. The message shall be discarded for further processing.

If the payload length exceeds the value configured by DoIPMax RequestBytes, the DoIP module shall send the NACK code 0x02 to indicate that the message is too large. The message shall be discarded for further processing.

If the DoIP module is called with DoIP_SoAdTpStartOfRecep- tion() and the indicated payload length exceeds the currently available buffer size, the function must return with BUFREQ_E_OVFL value (No buffer of the required length can be provided) and trigger a Negative Response (NACK) with value 0x03. The currently available buffer size calculation shall be based on Payload Type. If the DoIP message is processed internally (see [SWS_DoIP_00008]) the locally avalailable buffer, other case the upper layer (PduR_DoIPTpStartOfReception) provided buffer size shall be the base for the response.

If the DoIP module is called with a payload length that is not valid for the specifc payload type, the NACK code 0x04 shall be sent and the according socket shall be closed (see [SWS_DoIP_00058]).

Module Header File Imported Type ComStack_Types.h BufReq_ReturnType ComStack_Types.h PduIdType ComStack_Types.h PduInfoType ComStack_Types.h PduLengthType ComStack_Types.h RetryInfoType ComStack_Types ComStack_Types.h TpDataStateType SoAd.h SoAd_SoConIdType SoAd SoAd.h SoAd_SoConModeType Std_Types.h Std_ReturnType Std Std_Types.h Std_VersionInfoType TcpIp.h TcpIp_DomainType TcpIp.h TcpIp_IpAddrAssignmentType TcpIp.h TcpIp_IpAddrStateType TcpIp TcpIp.h TcpIp_SockAddrType

If source code for caller and callee of DoIP_GetVersionInfo is available, the DoIP module should realize DoIP_GetVersionInfo as a macro, defined in the module's header file.

If development error detection is enabled: The function shall check if the id matches a configured DoIPSoAdTcpRxPduId. If the check fails the function shall raise the development error DOIP_E_INVALID_PDU_SDU_ID.

The main function for scheduling the DoIP module (Entry point for scheduling) shall be called by the Schedule Manager according to the configured call period.

The call period of the DoIP_MainFunction() is determined by the configuration parameter DoIPMainFunctionPeriod.

Dcm_GetVin Dcm.h Function to get the VIN (as defined in SAE J1979-DA) PduR_DoIPTpCopyRxData PduR_DoIPTp.h 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. PduR_DoIPTpCopyTxData PduR_DoIPTp.h 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. PduR_DoIPTpRxIndication PduR_DoIPTp.h Called after an I-PDU has been received via the TP API, the result indicates whether the transmission was successful or not. API Function Header File Description PduR_DoIPTpStartOfReception PduR_DoIPTp.h 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. PduR_DoIPTpTxConfirmation PduR_DoIPTp.h This function is called after the I-PDU has been transmitted on its network, the result indicates whether the transmission was successful or not. SoAd_CloseSoCon SoAd.h This service closes the socket connection specified by SoConId. SoAd_GetPhysAddr SoAd.h Retrieves the physical source address of the EthIf controller used by the SoAd socket connection specified by SoConId. SoAd_GetSoConId SoAd.h Returns socket connection index related to the specified TxPduId. SoAd_IfTransmit SoAd.h Requests transmission of a PDU. SoAd_OpenSoCon SoAd.h This service opens the socket connection specified by SoConId. SoAd_ReadDhcpHostNameOption SoAd.h By this API service an upper layer of the SoAd can read the currently configured hostname, i.e. FQDN option in the DHCP submodule of the TCP/IP stack. SoAd_ReleaseIpAddrAssignment SoAd.h By this API service the local IP address assignment used for the socket connection specified by SoConId is released. SoAd_RequestIpAddrAssignment SoAd.h By this API service the local IP address assignment which shall be used for the socket connection specified by SoConId is initiated. SoAd_TpTransmit SoAd.h Requests transmission of a PDU. SoAd_WriteDhcpHostNameOption SoAd.h By this API service an upper layer of the SoAd can set the hostname, i.e. FQDN option in the DHCP submodule of the TCP/IP stack.

Det_ReportError Det.h Service to report development errors. PduR_DoIPIfTxConfirmation PduR_DoIPIf.h The lower layer communication interface module confirms the transmission of a PDU, or the failure to transmit a PDU.

A DoIP Service Component with the ShortName DoIP shall be provided based on the configuration of the DoIP module.

Name CallbackGetPowerMode Comment – IsService true Variation {ecuc(DoIP/DoIPGeneral/DoIPPowerModeCallback/DoIPPowerModeDirect)} == NULL 0 E_OK Operation successful Possible Errors 1 E_NOT_OK Operation failed Operation GetPowerMode Comment – Mapped to API <User>_DoIPGetPowerModeCallback Variation – Parameters PowerStateReady Type DoIP_PowerStateType Direction OUT Comment – Variation – Possible Errors E_OK E_NOT_OK

Name {Name}_RoutingActivation Comment – IsService true Variation (({ecuc(DoIP/DoIPConfigSet/DoIPInterface/DoIPRoutingActivation/DoIPRoutingActivation AuthenticationCallback)} != null) && ({ecuc(DoIP/DoIPConfigSet/DoIPInterface/DoIPRouting Activation/DoIPRoutingActivationAuthenticationCallback/DoIPRoutingActivationAuthentication Func)} == "")) || (({ecuc(DoIP/DoIPConfigSet/DoIPInterface/DoIPRoutingActivation/Do IPRoutingActivationConfirmationCallback)} != null) && ({ecuc(DoIP/DoIPConfigSet/Do IPInterface/DoIPRoutingActivation/DoIPRoutingActivationConfirmationCallback/DoIPRouting ActivationConfirmationFunc)} == "")) Name = {ecuc(DoIP/DoIPConfigSet/DoIPInterface/DoIPRoutingActivation.SHORT-NAME)} 0 E_OK Operation successful 1 E_NOT_OK Operation failed Possible Errors 16 DOIP_E_PENDING RoutingActivation still pending. Operation RoutingActivationAuthentication Comment – Mapped to API <User>_DoIPRoutingActivationAuthentication Variation (({ecuc(DoIP/DoIPConfigSet/DoIPInterface/DoIPRoutingActivation/DoIPRoutingActivation AuthenticationCallback)} != NULL) && ({ecuc(DoIP/DoIPConfigSet/DoIPInterface/DoIPRouting Activation/DoIPRoutingActivationAuthenticationCallback/DoIPRoutingActivationAuthentication Func)} ==NULL)) Authentified Parameters Type boolean Direction OUT Comment – Variation – AuthenticationReqData Type AuthenticationReqDataType_{Name} Direction IN Comment – Variation {ecuc(DoIP/DoIPConfigSet/DoIPInterface/DoIPRoutingActivation/DoIPRouting ActivationAuthenticationCallback.DoIPRoutingActivationAuthenticationReq Length)} > 0 Name = {ecuc(DoIP/DoIPConfigSet/DoIPInterface/DoIPRouting Activation.SHORT-NAME)} AuthenticationResData Type AuthenticationResDataType_{Name} Direction OUT Comment – Variation {ecuc(DoIP/DoIPConfigSet/DoIPInterface/DoIPRoutingActivation/DoIPRouting ActivationAuthenticationCallback.DoIPRoutingActivationAuthenticationRes Length)} > 0 Name = {ecuc(DoIP/DoIPConfigSet/DoIPInterface/DoIPRouting Activation.SHORT-NAME)} Possible Errors E_OK E_NOT_OK DOIP_E_PENDING Operation RoutingActivationConfirmation Comment – Mapped to API <User>_DoIPRoutingActivationConfirmation Variation (({ecuc(DoIP/DoIPConfigSet/DoIPInterface/DoIPRoutingActivation/DoIPRoutingActivation ConfirmationCallback)} != NULL) && ({ecuc(DoIP/DoIPConfigSet/DoIPInterface/DoIPRouting Activation/DoIPRoutingActivationConfirmationCallback/DoIPRoutingActivationConfirmation Func)} ==NULL)) Confirmed Type boolean Direction OUT Comment – Variation – ConfirmedReqData Type ConfirmationReqDataType_{Name} Direction IN Comment – Variation {ecuc(DoIP/DoIPConfigSet/DoIPInterface/DoIPRoutingActivation/DoIPRouting ActivationConfirmationCallback.DoIPRoutingActivationConfirmationReq Length)} > 0 Name = {ecuc(DoIP/DoIPConfigSet/DoIPInterface/DoIPRouting Activation.SHORT-NAME)} ConfirmedResData Type ConfirmationResDataType_{Name} Direction OUT Parameters Comment – Variation {ecuc(DoIP/DoIPConfigSet/DoIPInterface/DoIPRoutingActivation/DoIPRouting ActivationConfirmationCallback.DoIPRoutingActivationConfirmationRes Length)} > 0 Name = {ecuc(DoIP/DoIPConfigSet/DoIPInterface/DoIPRouting Activation.SHORT-NAME)} Possible Errors E_OK E_NOT_OK DOIP_E_PENDING

Name CallbackTriggerGIDSynchronization Comment – IsService true Variation ({ecuc(DoIP/DoIPGeneral/DoIPTriggerGidSyncCallback)} != NULL) && ({ecuc(DoIP/Do IPGeneral/DoIPTriggerGidSyncCallback/DoIPTriggerGidSyncDirect)} == NULL) && ({ecuc(Do IP/DoIPGeneral/DoIPVinGidMaster)} == TRUE) 0 E_OK Operation successful Possible Errors 1 E_NOT_OK Operation failed Operation TriggerGIDSynchronization Comment – Mapped to API <User>_DoIPTriggerGidSyncCallback Variation – Possible Errors E_OK E_NOT_OK

Name CallbackGetGID Comment – IsService true Variation ({ecuc(DoIP/DoIPGeneral/DoIPGetGidCallback)} != NULL) && ({ecuc(DoIP/DoIPGeneral/Do IPGetGidCallback/DoIPGetGidDirect)} == NULL) 0 E_OK Operation successful Possible Errors 1 E_NOT_OK Operation failed Operation GetGID Comment – Mapped to API <User>_DoIPGetGidCallback Variation – Data Type uint8 Direction OUT Comment – Parameters Variation – Possible Errors E_OK E_NOT_OK

If a connection needs to be closed based on DoIP specific be- havior, the DoIP module shall call the function SoAd_CloseSoCon with the parameter abort set to FALSE and the SoConId determined by a call to the function SoAd_Get SoConId for the corresponding DoIPSoAdTcpTxPdu. Additionally, the inactivity timer shall be stopped.

The expected payload length (see [SWS_DoIP_00019]) for vehi- cle identification request message with payload type 0x0001 shall be exactly 0.

If a DoIP message with payload Type 0x0001 is received on the configured DoIPUdpConnection, the DoIP module shall respond with a vehicle identifi- cation response/vehicle announcement message after the configured DoIPInitialVehi- cleAnnouncementTime with payload type 0x0004.

When the module receives a DoIP message with payload type 0x0001 on a connection different than a configured DoIPUdpConnection, the module shall discard the DoIP message.

When the module receives a DoIP message with payload Type 0x0002 on a connection different than a configured DoIPUdpConnection, the module shall discard the DoIP message.

The expected payload length (see [SWS_DoIP_00019]) for vehi- cle identification request message with payload type 0x0002 shall be exactly 6.

If a DoIP message with payload Type 0x0002 is received on the configured DoIPUdpConnection, the DoIP module shall further process the message.

If the Parameter DoIPUseMacAdressForIdentification is set to true the received "EID" 6 payload data bytes shall be compared to the MacAddress received via SoAd_GetPhysAddr . If they match the DoIP module shall respond with a vehicle identification response/vehicle announcement message with payload type 0x0004.

If the Parameter DoIPUseMacAdressForIdentification is set to false the received "EID" 6 payload data bytes shall be compared to the configured Do IPEID. If they match the DoIP module shall respond with a vehicle identification respon- se/vehicle announcement message with payload type 0x0004.

When the module receives a DoIP message with payload Type 0x0003 on a connection different than a configured DoIPUdpConnection, the module shall discard the DoIP message.

The expected payload length (see [SWS_DoIP_00019]) for ve- hicle identification request message with payload type 0x0003, shall be exactly 17.

If a DoIP message with payload Type 0x0003 is received on the configured DoIPUdpConnection the DoIP module shall further process the message.

The DoIP 17 payload data bytes shall be compared to the data retrieved by the function Dcm_GetVin. If the function returns E_OK, the VIN pointer is considered to contain valid information. If the function returns E_NOT_OK or the returned VIN do not match the requested VIN, the DoIP message with payload Type 0x0003 shall be ignored. If the requested VIN matches the derived VIN, the DoIP mod- ule shall respond with a vehicle identification response/vehicle announcement mes- sage with payload type 0x0004.

If the DoIP module needs to send a vehicle announcement mes- sage (see [SWS_DoIP_00205] and [SWS_DoIP_00298]), it shall send the vehicle an- nouncement message via the configured DoIPUdpVehicleAnnouncementConnection after DoIPInitialVehicleAnnouncementTime. This message shall be sent DoIPVehi- cleAnnouncementCount times with a delay of DoIPVehicleAnnouncementInterval be- tween each message. The last "VIN/GID Status" byte of the Vehicle identification re- sponse message is optional as defined in the ISO 13400-2 standard. It shall exist only if the "DoIPUseVehicleIdentificationSyncStatus" configuration parameter is set to True. (See [SWS_DoIP_00086]).

The "VIN" of a vehicle identification response/vehicle announce- ment message shall be derived by calling Dcm_GetVin. If Dcm_GetVin returns E_OK, the 17 Bytes in the pointer shall be used, if the callback returns E_NOT_OK the 17 Bytes shall be filled with the configured DoIPVinInvalidityPattern with "Further Action Required" field set to 0x00 and VIN/GID sync. Status field set to 0x10 if (DoIPUse VehicleIdentificationSyncStatus) is set to true.

The "LA" of a vehicle identification response/vehicle announce- ment message shall contain the configured DoIPLogicalAddress.

The "EID" of a vehicle identification response/vehicle announce- ment message shall contain the MAC address derived by Soad_GetPhysAddr if the configuration parameter DoIPUseMacAdressForIdentification is set to true.

The "EID" of a vehicle identification response/vehicle announce- ment message shall contain the configured DoIPEID if the configuration parameter Do IPUseMacAdressForIdentification is set to false.

If the parameter DoIPVinGIDMaster is set to true and the Con- tainer DoIPTriggerGIDSynchronization is configured, the DoIP module shall call the <User>_DoIPTriggerGIDSynchronization function (after successful IP Address assign- ment, see [SWS_DoIP_00306]) and repeat this call within the DoIP_MainFunction until its return value equals to E_OK or until the complete connection is closed for any other reason.

The "GID" of a vehicle identification response/vehicle announce- ment message shall contain the same value as for the EID, if both configuration parameter and DoIPUseEIDasGID are set to true (see [SWS_DoIP_00074] and [SWS_DoIP_00075]).

The "GID" of a vehicle identification response/vehicle announce- ment message shall contain the configured DoIPGID value, if the configuration param- eter DoIPVinGIDMaster is set to true, the configuration parameter DoIPUseEIDasGID is set to false and the parameter DoIPGID is configured.

The "GID" of a vehicle identification response/vehicle announce- ment message shall contain the value retrieved by the configured DoIPGetGidCallback function(for the signature see <User>_DoIPGetGidcallback, [SWS_DoIP_00051]), if the configuration parameter DoIPVinGIDMaster is set to true, the configuration param- eter DoIPUseEIDasGID is set to false and the parameter DoIPGID is not configured. If the function does not return E_OK the GID shall consist of 6 Bytes according to the configured DoIPGIDInvalidityPattern.

The "GID" of a vehicle identification response/vehicle announce- ment message shall contain the configured DoIPGID value, if the configuration pa- rameter DoIPVinGIDMaster is set to false and the parameter DoIPGID is configured.

The "GID" of a vehicle identification response/vehicle announce- ment message shall contain the value retrieved by the configured DoIPGetGID func- tion, if the configuration parameter DoIPVinGIDMaster is set to false and the parameter DoIPGID is not configured. If the function does not return E_OK, the GID shall consist of 6 Bytes according to the configured DoIPGIDInvalidityPattern.

The "Further action" byte of a vehicle identification response/ve- hicle announcement message shall contain the value 0x10 if any DoIPRoutingActiva- tion with DoIPRoutingActivationNumber equal to 0xE0 is configured and the according RoutingActivation was not yet successfully performed.

The "Further action" byte of a vehicle identification response/ve- hicle announcement message shall contain the value 0x00, if no DoIPRoutingActivation with DoIPRoutingActivationNumber equal to 0xE0 is configured.

The "Further action" byte of a vehicle identification response/ve- hicle announcement message shall contain the value 0x00, if any DoIPRoutingActiva- tion with DoIPRoutingActivationNumber equal to 0xE0 is configured and the according RoutingActivation was successfully performed.

If a change in the IP address assignment indicated by Do IP_LocalIpAddrAssignmentChg with another TCP_IpAddrStateType then TCPIP_ IPADDR_STATE_ASSIGNED, the function to start GID synchronisation as described in [SWS_DoIP_00076] shall not be called any longer independent from the before re- turn value.

If the configuration parameter DoIPUseVehicleIdentificationSync Status is set to true, the "VIN/GID status" byte shall be additionally added to the vehicle identification response/vehicle announcement message.

If a valid VIN could be requested in [SWS_DoIP_00072], the value of the "VIN/GID status" byte shall be 0x00.

If no valid VIN could be requested in [SWS_DoIP_00072] and the vehicle GID synchronization was not yet successful as described in [SWS_DoIP_00076], the value of the "VIN/GID status" byte shall be 0x10.

If no valid VIN could be requested in [SWS_DoIP_00072] and the vehicle GID synchronization was already successful as described in [SWS_DoIP_00076], the value of the "VIN/GID status" byte shall be 0x00.

When the module receives a DoIP message with payload Type 0x4003 on a connection different than a configured DoIPUdpConnection, the module shall discard the DoIP message.

The expected payload length (see [SWS_DoIP_00019]) for di- agnostic power mode information request message with payload type 0x4003 shall be exactly 0.

After a valid Diagnostic power mode request message, the DoIP module shall send a Diagnostic Power mode information response message ([SWS_DoIP_00093]) on the configured DoIPUdpConnection.

The "Diagnostic Power Mode" byte of diagnostic power mode in- formation response message contains the 1 Byte value retrieved by a call to the config- ured DoIPPowerModeCallback (for the signature see <User>DoIPGetPowerModeSta- tus, [SWS_DoIP_00047]). If the function returns E_OK, the "Diagnostic Power Mode" shall be set to the retrieved value of PowerStateReady, otherwise it shall be set to 0x00 to indicate that the power mode is not ready.

When the module receives a DoIP message with payload Type 0x4001 on a connection different than a configured DoIPUdpConnection, the module shall discard the DoIP message.

The expected payload length (see [SWS_DoIP_00019]) for di- agnostic entity status request message with payload type 0x4001 shall be exactly 0.

After a valid Diagnostic entity status request message, the DoIP module shall send a Diagnostic entity status response message (see Table 7.11) on the configured DoIPUdpConnection.

The "Node Type" byte of a diagnostic entity status response message shall contain the configured DoIPNodeType, whereas DOIP_GATEWAY shall be represented by 0x00 and DOIP_NODE shall be represented by 0x01.

The "Max open sockets" byte of a diagnostic entity status re- sponse message shall contain the configured DoIPMaxTesterConnections. This pa- rameter represents the maximum number of concurrent TCP_DATA sockets allowed with this DoIP entity, excluding the reserve socket required for socket handling as de- fined in the ISO 13400-2 standard.

The "Currently open sockets" byte of a diagnostic entity status response message shall contain the currently active connections, based on the infor- mation described in [SWS_DoIP_00002].

The "Max data size" bytes are only supported if the configuration parameter DoIPEntityStatusMaxByteFieldUse is set to TRUE. In this case, the diag- nostic entity status response message shall contain the configured DoIPMaxRequest Bytes in the "Max data size" field.

When the module receives a DoIP message with payload Type 0x0005 on a connection different than a configured DoIPTcpConnection, the module shall discard the DoIP message.

If a routing activation request message is received with a valid DoIP header, the DoIP module shall process further to [SWS_DoIP_00103], if the field "Source address" matches a configured DoIPTesterSA.

The DoIP module shall always continue with processing as de- fined in [SWS_DoIP_00105], either if the received "Source Address" is already regis- tered to a connection as described in [SWS_DoIP_00002] and it is the same socket connection this routing activation request was received on, or if the received "Source Address" is not registered to a connection yet.

If a routing activation request message is received with a "Source address" that does not match a configured DoIPTesterSA, the routing activa- tion response message shall be sent on the same connection as the received request with the routing activation response code 0x00. Additionally the socket connection shall be closed as defined in [SWS_DoIP_00058].

If the received "Source Address" is already registered to an- other connection, belonging to the same DoIPInterface, an alive check request to this connection shall be triggered as described in [SWS_DoIP_00139] and [SWS_DoIP_00140] and it shall be waiting for the alive check response message or until the time configured in parameter DoIPAliveCheckResponseTimeout expired. If the alive check response was received within the configured time, the DoIP mod- ule shall send a routing activation response message with the activation response code set to 0x03. Additionally the socket connection shall be closed as defined in [SWS_DoIP_00058]. If the "Source Address" is not already registered or the DoIPAlive CheckResponseTimeout expired without receiving an alive check response message the DoIP module shall continue with [SWS_DoIP_00107].

If a routing activation request message is received with a valid "Source address" but the connection this Routing activation was received on is already registered to another source address, the DoIP module shall send a routing activation response message on the same connection the request was received on, with the routing activation response code set to 0x02. Additionally the socket connection shall be closed as defined in [SWS_DoIP_00058].

If the amount of registered connections is smaller than the configured DoIPMaxTesterConnections, the DoIP module shall proceed with the message as described in [SWS_DoIP_00108] otherwise an alive check request shall be sent to all registered connections as described in [SWS_DoIP_00139] and [SWS_DoIP_00140]. If none of the alive checks times out (i.e. all tester respond with a valid alive check response within the configured DoIPAliveCheckResponseTimeout) the DoIP module shall send a routing activation response message with the activa- tion response code set to 0x01. Additionally the socket connection shall be closed as defined in [SWS_DoIP_00058]. If at least one of them times out the DoIp module shall close the socket connection and continue as described in [SWS_DoIP_00108].

If the "Activation type" bytes matches the DoIPRoutingActiva- tionNumber of one of the DoIPRoutingActivationRef of the "Source Address" (i.e. DoIPTester has a DoIPRoutingActivationRef configured which has the DoIPRouting ActivationNumber equal to "Activation type") the DoIP module shall proceed with [SWS_DoIP_00109].

If an DoIPRoutingActivationAuthenticationCallback is configured for the referenced DoIPRoutingActivation, the DoIP module shall call this callback (for the signature see <User>_DoIPRoutingActivationAuthentication, [SWS_DoIP_00049]). If the DoIPRoutingActivationAuthenticationReqLength is not configured to 0, the Do IP module shall handle additionally the first DoIPRoutingActivationAuthenticationReq Length bytes of the optional field "OEM specific".

If the DoIPRoutingActivationAuthenticationCallback returns DOIP_E_PENDING the DoIP module shall trigger the callback at next DoIP_MainFunc- tion call again until something else than DOIP_E_PENDING is returned. Additionally the socket connection shall be considered as registered to this DoIPTesterSA without activating the routing.

If the DoIPRoutingActivationAuthenticationCallback returns something else (e.g. E_NOT_OK) the DoIP module shall send a routing activation response message with the activation response code set to 0x04 and the socket con- nection shall be considered as registered to this DoIPTesterSA without activating the routing.

If a DoIPRoutingActivationConfirmationCallback is configured for the referenced DoIPRoutingActivation, the DoIp module shall call this callback (for the signature see <User>_DoIPRoutingActivationConfirmation, [SWS_DoIP_00048]). If the DoIPRoutingActivationConfirmationReqLength is not configured to 0, the Do IP module shall handle additionally the last DoIPRoutingActivationConfirmationReq Length bytes of the optional field "OEM specific". If the Callback returns with E_OK the routing activation confirmation shall be considered as successful and if the Do IPRoutingActivationConfirmationResLengthis not set to 0, the last DoIPRoutingActi- vationConfirmationResLength bytes shall be attached in routing activation response message in the field "OEM specific" as described in [SWS_DoIP_00120].

If no response was sent because of the before mentioned checks this DoIPRoutingActivation is confirmed, authorized and valid so the DoIP module shall send a routing activation response message with the activation response code set to 0x10 and the socket connection shall be considered as registered to this DoIPTester SA and enable the routing for this routing activation. From now on the routing to the configured DoIPTargetAdressRef are active and valid so the diagnostic request mes- sages related to the specified DoIPTargetAdress received via this socket connection are active.

If the DoIPRoutingActivationConfirmationCallback returns DOIP_E_PENDING, the DoIP module shall send a routing activation response mes- sage once with the activation response code set to 0x11.

If a TCP socket connection gets closed (after the DoIP_SoCon ModeChg was called with different mode value than SOAD_SOCON_ONLINE or any other reason described by [SWS_DoIP_00058] or [SWS_DoIP_00358]) the DoIP mod- ule shall - unregister and release the socket connection to the related Tester, - discard the ongoing diagnostic message processing and - reset the inactivity timer of the given socket connection.

The "Logical Address Tester" field shall be set to the Tester SA the according routing activation request message was received from.

The expected payload length (see [SWS_DoIP_00019]) for Routing Activation Request Message with payload type 0x0005 shall be either exactly 7 or 11.

The "Logical Address DoIP entity" shall be set to the configured parameter DoIPLogicalAddress.

The "Routing activation response code shall be set accord- ing to the response conditions specified in [SWS_DoIP_00106], [SWS_DoIP_00104], [SWS_DoIP_00105], [SWS_DoIP_00107], [SWS_DoIP_00160], [SWS_DoIP_00111], [SWS_DoIP_00114], [SWS_DoIP_00274] and [SWS_DoIP_00113].

The "OEM specific" field shall be filled with the optional values as defined in chapter 7.3.2.2.1. if the according DoIPRoutingActivationAuthentica- tionResLength and/or DoIPRoutingActivationConfirmationResLength is used.

When the module receives a DoIP message with payload Type 0x8001 on a connection different than a configured DoIPTcpConnection, the module shall discard the DoIP message.

The expected payload length (see [SWS_DoIP_00019]) for diag- nostic messages with payload type 0x8001 shall be at least 5 byte.

If the DoIP module receives a diagnostic message with a "Source Address" (equals DoIPTesterSA) which is not registered on an established socket connection, the DoIP modules shall send a diagnostic message negative acknowledge message with the diagnostic message negative acknowledge code set to 0x02. Additionally the socket connection shall be closed as described in [SWS_DoIP_00058].

If the DoIP module receives a diagnostic message with a "Target Addess" (equals DoIPTargetAdressValue) which is not connected via DoIPRoutingAc- tivationRef and DoIPTargetAdressRef to the received valid DoIPTesterSA, than the Do IP module shall send a diagnostic message negative acknowledge message with the diagnostic message negative acknowledge code set to 0x03. Additionally the message shall be discarded.

If the DoIP module receives a diagnostic message with the pay- load data length in the DoIP header is set to a value bigger than DoIPMaxRequest Bytes-4, than the DoIP module shall send a diagnostic message negative acknowl- edge message with the diagnostic message negative acknowledge code set to 0x04. Additionally the message shall be discarded.

If the DoIP module receives a diagnostic message and [SWS_DoIP_00125] does not apply but the current buffer size is not sufficient to re- ceive the message, than the DoIP module shall send a diagnostic message negative acknowledge message with the diagnostic message negative acknowledge code set to 0x05. Additionally the message shall be discarded.

If the DoIP module receives a diagnostic message and the according "TargetAddress" was not activated by routing activation as described in [SWS_DoIP_00113], the DoIP module shall send a diagnostic message negative ac- knowledge message with the diagnostic message negative acknowledge code set to 0x06. Additionally the message shall be discarded.

If no negative acknowledge was sent the DoIP module shall eval- uate the message and forward the content (i.e. all UDS Data, not the TargetAddress and SourceAddress) to the DoIPPduRRxPdu connected to the received TargetAd- dress/SourceAddress combination as configured in DoIPChannel

If the PduR accepted all Data, the DoIP module shall send a diagnostic acknowledge message as described in Table 7.13.

The DoIP module will get a diagnostic response message (i.e Do IP_TpTransmit or DoIP_IfTransmit is called with DoIPPduRTxPdu which matches to the DoIPPduRRxPdu that handled the data to the PduR) via the upper layer connection to the PduR, so it has to monitor whether the socket connection the request was received on is still established. If the socket connection has been closed, the response shall be discarded and the DoIP shall return with E_NOT_OK in the return value.

If the DoIP module is called with DoIPPduRTxPdu in the DoIP_ TpTransmit or DoIP_IfTransmit as described in [SWS_DoIP_00130] and the according socket connection has not been closed since the reception of the according diagnos- tic message, the DoIP module shall prepare a diagnostic message via the according socket connection with the "SourceAddress" set to the DoIPTargetAdressValue of the request and the "TargetAddress" set to the DoIPTesterSA.

If the DoIP module needs to send a diagnostic acknowledge message the "Source Address" shall be set to the according "TargetAddress" of the received message.

If the DoIP module needs to send a diagnostic acknowledge message the "Target Address" shall be set to the according "SourceAddress" of the received message.

If the DoIP module needs to send a diagnostic acknowledge message the field "previous diag message" shall be filled with the number of bytes of the original request message as configured in the parameter DoIPNumByteDiagAck Nack for the DoIPTester the request was received on.

If the DoIP module needs to send a diagnostic negative acknowl- edge message the "Source Address" shall be set to the according "TargetAddress" of the received message.

If the DoIP module needs to send a diagnostic negative acknowl- edge message the "Target Address" shall be set to the according "SourceAddress" of the received message.

If the DoIP module needs to send a diagnostic negative acknowl- edge message, the "Diagnostic message negative acknowledge code" shall be set to the value specified by the specification item that is triggering the diagnostic negative acknowledge message.

If the DoIP module needs to send a diagnostic negative acknowl- edge message the field "previous diag message" shall be filled with the configured number of the original request message as configured in the parameter DoIPNumByte DiagAckNack for the DoIPTester the request was received on.

If the DoIP module needs to send a alive check request, it shall have no payload data but only the generic DoIP header and the payload type set 0x0007.

After sending an alive check request the DoIP module shall wait the configured time DoIPAliveCheckResponseTimeout to receive a valid alive check response and [SWS_DoIP_00141]. If it does not receive an alive check response, the socket connection on which the alive check request was sent shall be reset as described in [SWS_DoIP_00358].

If the received Alive check response field "SourceAddress" matches the registered Source Address of the socket connection the response was received on, the DoIP module shall do nothing. Otherwise it shall reset the socket connection as described in [SWS_DoIP_00358].

The DoIP module shall maintain an inactivity timer for each reg- istered TCP connection.

After a successful TCP socket connection (i.e. DoIP_SoCon ModeChg) the DoIP module shall start the inactivity timer.

If no Routing Activation request was received on a new opened socket within the configured DoIPInitialInactivityTime, the DoIP module shall reset the socket connection as described in [SWS_DoIP_00358].

After a routing activation has been performed (see [SWS_DoIP_00159]), the DoIP module shall reset the inactivtity timer to 0 al- ways when data communication is performed on the socket (send or receive).

If the inactivity timer reaches the time configured in DoIPGen- eralInactivityTime, the corresponding socket connection shall be reset as described in [SWS_DoIP_00358].

Type of error Related error code Error value API service call without module initialization DOIP_E_UNINIT 0x01 NULL-Pointer on any API call DOIP_E_PARAM_POINTER 0x02 Wrong Lower Layer (SoAd) or Upper Layer (Pdu Router) Id received DOIP_E_INVALID_PDU_SDU_ID 0x03 API call with invalid Parameter DOIP_E_INVALID_PARAMETER 0x04 DoIP Init service call failure DOIP_E_INIT_FAILED 0x05

If the API DoIP_LocalIpAddrAssignmentChg is called with the State set to TCPIP_IPADDR_STATE_ASSIGNED, the DoIP module shall call the func- tion SoAd_ReadDhcpHostNameOption with the received SoConId to get the currently set host name option. The returned Byte buffer shall be considered as ASCII buffer and shall start with "DoIP-".

If the ASCII buffer returned in [SWS_DoIP_00154] does not start with "DoIP-" and the configuration parameter DoIPDhcpOptionVinUse is set to FALSE the DoIP module shall call the SoAd_WriteDhcpHostNameOption with a pointer to the string "DoIP-" in order to set the hostname.

If the ASCII buffer returned in [SWS_DoIP_00154] does not start with "DoIP-" and the configuration parameter DoIPDhcpOptionVinUse is set to TRUE the DoIP module shall call the SoAd_WriteDhcpHostNameOption with a pointer to to the ASCII buffer "DoIP-VIN<vinnumberinascii>" with <vinnumberinascii> representing the ASCII representation of the VIN that is retrieved via Dcm_GetVin. If no valid VIN could be retrieved the DoIP shall use the configured DoIPVinInvalidityPattern in ASCII representation.

If a Routing Activation request was received on a new opened socket before the inactivity timer elapsed (i.e. the configured DoIPInitialInactivityTime did not pass) the DoIP module shall reset the inactivity timer to 0.

If the "Activation type" bytes do not fulfill the [SWS_DoIP_00108] requirement, the DoIP module shall send a routing activation response message with the activation response code set to 0x06. In this case the socket connection shall be closed as defined in [SWS_DoIP_00058].

If the DoIPRoutingActivationAuthenticationCallback returns with E_OK the routing activation authentication shall be considered as successful. If the Do IPRoutingActivationAuthenticationResLength is not set to 0 the first DoIPRoutingAc- tivationAuthenticationResLength byte shall be attached in routing activation response message in the field "OEM specific" as described in [SWS_DoIP_00120].

If development error detection is enabled: The function shall check that the service DoIP_Init was previously called. If the check fails, the function shall raise the development error DOIP_E_UNINIT.

If development error detection is enabled: The function shall check if the TxPduId matches a configured DoIPPduRTxPduId. If the check fails the function shall raise the development error DOIP_E_INVALID_PDU_SDU_ID.

If development error detection is enabled: The function shall check if the PduInfoPtr is not a NULL_PTR. If the check fails the function shall raise the development error DOIP_E_PARAM_POINTER.

If development error detection is enabled: The function shall check that the service DoIP_Init was previously called. If the check fails, the function shall raise the development error DOIP_E_UNINIT.

If development error detection is enabled: The function shall check if the TxPduId matches a configured DoIPPduRTxPduId. If the check fails the function shall raise the development error DOIP_E_INVALID_PDU_SDU_ID.

If development error detection is enabled: The function shall check that the service DoIP_Init was previously called. If the check fails, the function shall raise the development error DOIP_E_UNINIT.

If development error detection is enabled: The function shall check if the RxPduId matches a configured DoIPPduRRxPduId. If the check fails the function shall raise the development error DOIP_E_INVALID_PDU_SDU_ID.

If development error detection is enabled: The function shall check if the versioninfo is not a NULL_PTR. If the check fails the function shall raise the development error DOIP_E_PARAM_POINTER.

The field "User data" of the [SWS_DoIP_00131] message con- tains the actual diagnostic payload data which shall not be modified by DoIP.

If the PduR is not accepting the data totally (for details refer to chapter 7.5.1), the DoIP module shall send a diagnostic message negative acknowl- edge message with the diagnostic message negative acknowledge code set to 0x08 as described in chapter 7.3.2.6.3. Additionally the message shall be discarded.

If development error detection is enabled: The function shall check that the service DoIP_Init was previously called. If the check fails, the function shall raise the development error DOIP_E_UNINIT.

If development error detection is enabled: The function shall check if the id matches a configured DoIPSoAdTcpTxPduId. If the check fails the function shall raise the development error DOIP_E_INVALID_PDU_SDU_ID.

If development error detection is enabled: The function shall check that neither the info nor the availableDataPtr are a NULL_PTR. If the check fails the function shall raise the development error DOIP_E_PARAM_POINTER.

If development error detection is enabled: The function shall check if the retry is a NULL_PTR. If the check fails the function shall raise the develop- ment error DOIP_E_INVALID_PARAMETER.

If development error detection is enabled: The function shall check that the service DoIP_Init was previously called. If the check fails, the function shall raise the development error DOIP_E_UNINIT.

If development error detection is enabled: The function shall check if the id matches a configured DoIPSoAdTcpTxPduId. If the check fails the function shall raise the development error DOIP_E_INVALID_PDU_SDU_ID.

If development error detection is enabled: The function shall check if the result is valid. If the check fails the function shall raise the development error DOIP_E_INVALID_PARAMETER.

If development error detection is enabled: The function shall check that the service DoIP_Init was previously called. If the check fails, the function shall raise the development error DOIP_E_UNINIT.

If development error detection is enabled: The function shall check that neither the info nor the bufferSizePtr are a NULL_PTR. If the check fails, the function shall raise the development error DOIP_E_PARAM_POINTER.

If development error detection is enabled: The function shall check that the service DoIP_Init was previously called. If the check fails, the function shall raise the development error DOIP_E_UNINIT.

If development error detection is enabled: The function shall check if the id matches a configured DoIPSoAdTcpRxPduId. If the check fails the function shall raise the development error DOIP_E_INVALID_PDU_SDU_ID.

If development error detection is enabled: The function shall check if the bufferSizePtr is not a NULL_PTR. If the check fails the function shall raise the development error DOIP_E_PARAM_POINTER.

If development error detection is enabled: The function shall check if the TpSduLength is not 0. If TpSduLength is not 0 the function shall raise the development error DOIP_E_INVALID_PARAMETER.

If development error detection is enabled: The function shall check that the service DoIP_Init was previously called. If the check fails, the function shall raise the development error DOIP_E_UNINIT.

If development error detection is enabled: The function shall check if the id matches a configured DoIPSoAdTcpRxPduId. If the check fails the function shall raise the development error DOIP_E_INVALID_PDU_SDU_ID.

If development error detection is enabled: The function shall check if the result is valid. If the check fails the function shall raise the development error DOIP_E_INVALID_PARAMETER.

If development error detection is enabled: The function shall check that the service DoIP_Init was previously called. If the check fails, the function shall raise the development error DOIP_E_UNINIT.

If development error detection is enabled: The function shall check if the SoConId and Mode are valid. If the check fails the function shall raise the development error DOIP_E_INVALID_PARAMETER.

If development error detection is enabled: The function shall check that the service DoIP_Init was previously called. If the check fails, the function shall raise the development error DOIP_E_UNINIT.

If development error detection is enabled: The function shall check if the SoConId and State are valid. If the check fails the function shall raise the development error DOIP_E_INVALID_PARAMETER.

If the SoAd calls the DoIP module via the Interface DoIP_SoAdIf RxIndication, the DoIP module shall copy the message into the internal UDP buffer for further processing.

If the DoIP module shall send a DoIP message via UDP it shall call the SoAd_IfTransmit with the TxPduId set to the SoAd internal TxPduId that is retrieved via the according configured DoIPSoAdUdpTxPduRef, the PduInfoPtr shall contain the length of the message and the pointer to the to be transmitted message buffer and additionally the buffer shall be locked.

If the SoAd calls the DoIP module via the Interface DoIP_So AdIfTxConfirmation, the DoIP module shall release the buffer which is related to the received TxPduId.

If the function DoIP_SoAdTpRxIndication is called the DoIp mod- ule shall release all data connected to the reception and forward the result to PduR_ DoIPTpRxIndication if a reception for diagnostic message is currently ongoing.

The DoIP module shall determine the DoIP Activation Line status by the calls to DoIP_ActivationLineSwitch (uint8 InterfaceId, boolean *Active) based on the value of the boolean parameter Active per DoIPInterface with a given InterfaceId. The Activation Line status is considered "active", if the boolean value in the call is set to TRUE. The Activation Line status is considered "inactive", if the boolean value in the call is set to FALSE.

If data is received from SoAd or PduR (i.e. communication re- lated interfaces are called) via PduIds related to a certain DoIPInterface configured with DoIPInterfaceActLineCtrl = TRUE, where the status of the Activation Line of this DoIPInterface is currently inactive, the DoIP module shall ignore all these requests and return a negative return value as return value.

For activation line controlled DoIP Interfaces with DoIPInterface ActLineCtrl = TRUE, DoIP shall establish the corresponding connections for these interfaces according to [SWS_DoIP_00306] if corresponding Activation Line Status switches to "active". (SRS_Eth_00081, SRS_Eth_00028, SRS_Eth_00026).

If the function DoIP_SoConModeChg is called with Mode set to SOAD_SOCON_ONLINE for a UDP vehicle announcement connection, the DoIP module shall send the vehicle announcement message via the corresponding Tx PDU configured in the DoIPUdpVehicleAnnouncementConnection and belonging to the re- ported socket connection.

If the function DoIP_SoAdTpStartOfReception is called with Tp SduLength set to 0, the DoIP module shall fill in the bufferSizePtr the available buffer size in the DoIP for the reception of the TCP message, lock the according buffer for other TCP connections and return BUFREQ_OK.

If the function DoIP_SoAdTpCopyRxData is called at the start of a new DoIP message (e.g. directly after DoIPSoAdTpStartOfReception succeeded or previous DoIP message processed completely) with info.SduLength set to 0 the DoIP module shall return in the parameter bufferSizePtr the length to the maximum necessary bytes to evaluate the DoIP relevant data for routing of diagnostic data.

If the function DoIP_SoAdTpCopyRxData is called at the start of a new DoIP message (e.g. directly after DoIPSoAdTpStartOfReception succeeded or previous DoIP message processed completely) with info.SduLength is not set to 0 and the DoIP TCP buffer is big enough to copy all the data, the DoIP module shall copy the received data to the internal TCP buffer, return the parameter bufferSizePtr set to the available buffer after copying and return BUFREQ_OK.

If the function DoIP_SoAdTpCopyRxData is called at the start of a new DoIP message (e.g. directly after DoIPSoAdTpStartOfReception succeeded or previous DoIP message processed completely) with info.SduLength is not set to 0 and the DoIP TCP buffer is not big enough to copy all the data, the DoIP module shall return BUFREQ_E_NOT_OK.

If the DoIP module has received sufficient data to evaluate the DoIP header, the payload type is diagnostic message and the Routing was already activated for the SourceAddress/TargetAddress combination on this DoIPInterface, the DoIP module shall call the PduR_DoIPTpStartOfReception with the according id set to the DoIPPduRRxPduId matching the SourceAddress/TargetAddress combination of the diagnostic message on this DoIPInterface, set the info.SduLength to the already received diagnostic data, set the info->SduDataPtr to the buffer containing the received diagnostic data and set the TpSduLength to the total size of the diagnostic message extracted from DoIP Header.

If the DoIP module has received sufficient data to evaluate the DoIP header and the payload type is not diagnostic message the DoIP shall copy all data of this DoIP message to the internal DoIP TCP buffer, lock the according buffer for other TCP connections and process the DoIP message as described in [SWS_DoIP_00219].

If PduR_DoIPTpStartOfReception returns BUFREQ_E_NOT_ OK, the DoIP module shall send a diagnostic negative acknowledge message with the diagnostic message negative acknowledge code set to 0x08 and discard all the TCP data until the next DoIP message.

If PduR_DoIPTpCopyRxData returns BUFREQ_E_NOT_OK, the DoIP module shall discard all the TCP data until the next DoIP message and call the PduR_DoIPTpRxIndication with the according PduId and the result set to E_NOT_ OK.

If PduR_DoIPTpStartOfReception returns BUFREQ_OK the re- ception was accepted and the DoIP shall forward all subsequent calls to DoIP_So AdTpCopyRxData directly to PduR_DoIPTpCopyRxData until all diagnostic data was handed to the PduR.

If the DoIP module has received with the DoIP_SoAdTpCopy RxData operations enough data to evaluate the DoIP header and the payload type is not diagnostic message (see [SWS_DoIP_00214]), the DoIP module shall receive via subsequent calls to DoIP_SoAdTpCopyRxData all data for the DoIP message and process it.

If the DoIP module needs to send a DoIP message that is not a diagnostic message on the TCP connection, the DoIP shall call the SoAd_TpTransmit with the TxPduId containing the Id of the according socket, the PduInfoPtr.SduLength set to the size of the data to be transmitted and lock the buffer to send.

If all diagnostic data was successfully forwarded to the PduR (see [SWS_DoIP_00216]) the DoIP module shall call the PduR_DoIPTpRxIndication with the according PduId and the result set to E_OK.

If the call to SoAd_TpTransmit returns E_NOT_OK the DoIP module shall discard the DoIP message.

If the function DoIP_SoAdCopyTxData is called after a sucess- full call to SoAd_TpTransmit, with a valid id and the info.SduLength is set to 0 the DoIP shall return BUFREQ_OK and set the parameter availableDataPtr to the total available data size of the current DoIP message to be transmitted.

If the function DoIP_SoAdCopyTxData is called after a sucess- full call to SoAd_TpTransmit, with a valid id and the info.SduLength is not set to 0, the DoIP module shall copy the bytes specified in the info.SduLength to the info->SduData Ptr, return BUFREQ_OK and set the parameter availableDataPtr to the total available data size of the current DoIP message after the copy process.

If the function DoIP_TpTransmit or DoIP_IfTransmit is called and the data package is not allowed according to the current DoIP protocol related infor- mation, the DoIP module shall return E_NOT_OK.

If the call to SoAd_TpTransmit returns for the use case "diag- nostic message" E_NOT_OK the DoIP module shall discard the DoIP message and, in case the DoIPPduType of the corresponding DoIPPduRTxPdu is DOIP_TPPDU, call the PduR_DoIPTpTxConfirmation with result set to E_NOT_OK.

If the function DoIP_SoAdTpTxConfirmation is called the DoIP module shall release the buffer related to the id.

If the function DoIP_TpTransmit or DoIP_IfTransmit is called and the data package is allowed to be sent according to the current DoIP protocol related information, the DoIP module shall return E_OK. 1.) If the connection to the SoAd is idle, the DoIP shall call the SoAd_TpTransmit function according to [SWS_DoIP_00284]. 2.) If the connection to the SoAd is not idle, the DoIP shall store the transmission request and call SoAd_TpTransmit according to [SWS_DoIP_00284] as soon as the connection is idle again.

If the function DoIP_SoAdCopyTxData is called after a sucess- full call to SoAd_TpTransmit for the use case "diagnostic message", with a valid id and the info.SduLength is set to 0 the DoIP shall return BUFREQ_OK and set the pa- rameter availableDataPtr to the total available data size of the current buffered DoIP message to be transmitted.

If the function DoIP_SoAdCopyTxData is called after a sucess- full call to SoAd_TpTransmit for the use case "diagnostic message" with a valid id and the info.SduLength is not set to 0, the DoIP module shall copy the bytes specified in the info.SduLength to the info->SduDataPtr. If the requested bytes are more than in the Do IP internal buffer, the DoIP shall call the PduR_DoIPTpCopyTxData with the info.Sdu Length set to the remaining requested data bytes and the info-> SduDataPtr set to the position where the PduR shall continue to copy the data.

If the DoIP module has copied via subsequent calls to DoIP_So AdTpCopyTxData for the use case "diagnostic message" all information stored in the DoIP internal buffer, the DoIP module shall forward all subsequent calls to DoIP_SoAd TpCopyTxData/DoIP_SoAdTpTxConfirmation for this transmission directly to the PduR using PduR_DoIPTpCopyTxData/PduR_DoIPTpTxConfirmation in case the DoIPPdu RTxPdu is DOIP_TPPDU and PduR_DoIPIfTxConfirmation otherwise, and release the internal buffer for this transmission.

If the Activation Line status of a DoIPInterface switches to "inac- tive", the DoIP module shall shall loop over all DoIPTcpConnection, DoIPUdpConnec- tion, and DoIPUdpVehicleAnnouncementConnections. For each of these DoIPCon- nections the DoIP module shall retrieve the corresponding SoConId via call to the So Ad_GetSoConId and close all the connection by a call to SoAd_CloseSoCon with the retrieved SoConId.

In addition to [SWS_DoIP_00234], the DoIP module shall re- lease the corresponding IP Address assignment via the call to SoAd_ReleaseIpAddr Assignment for those connections, which belong to the DoIPInterface for which the Ac- tivation Line status switched to "inactive", that have DoIPRequestAddressAssignment set to true.

If the DoIP module is called with DoIP_SoConModeChg and the Mode set to SOAD_SOCON_ONLINE the state of the socket connection shall be considered as online and the DoIP module shall behave as described in [SWS_DoIP_00143].

⌊ OBSOLETE g Name DoIPActivationLineStatus (obsolete) Comment – Tags: atp.Status=obsolete IsService true Variation – ModeGroup currentDoIPActivationLineStatus DoIP_ActivationLineType

If the DoIP module is called with DoIP_SoConModeChg and the Mode set to something else than SOAD_SOCON_ONLINE the state of the socket con- nection shall be considered as offline and the DoIP module shall behave as described in [SWS_DoIP_00115].

If development error detection is enabled: The function shall check that the service DoIP_Init was previously called. If the check fails, the function shall raise the development error DOIP_E_UNINIT.

If development error detection is enabled: The function shall check if the RxPduId matches a configured DoIPSoAdUdpRxPduId. If the check fails the function shall raise the development error DOIP_E_INVALID_PDU_SDU_ID.

If development error detection is enabled: The function shall check the validity of the PduInfoPtr and call the DET with DOIP_E_PARAM_POINTER error id if it is a NULL_PTR.

If development error detection is enabled: The function shall check that the service DoIP_Init was previously called. If the check fails, the function shall raise the development error DOIP_E_UNINIT.

If development error detection is enabled: The function shall check if the TxPduId matches a configured DoIPSoAdUdpTxPduId. If the check fails the function shall raise the development error DOIP_E_INVALID_PDU_SDU_ID.

If the buffer size reported by PduR_DoIPTpStartOfReception does not suffice for already received data, DoIP shall abort the reception and call Pdu R_DoIPTpRxIndication with E_NOT_OK.

If the call to PduR_DoIPTpCopyTxData returns BUFREQ_OK or all the requested data was part of the DoIP internal buffer, the DoIP module shall return BUFREQ_OK and set the parameter availableDataPtr to the remaining data size of the DoIP header and diagnostic SourceAddress/TargetAddress if they have not been copied completely or to the remaining data size returned from PduR_DoIPTpCopyTx Data.

If the DoIP module is called with DoIP_TpCancelTransmit or Do IP_IfCancelTransmit, the DoIP module shall call the SoAd_TpCancelTransmit function of the according SoAdTxPduId.

If the DoIP module is called with DoIP_TpCancelReceive, the DoIP module shall call the SoAd_TpCancelReceive function with the RxPduId that is retrieved via the according configured DoIPSoAdTcpRxPduRef.

At the end of the copy procedure via PduR_DoIPTpCopyRxData to PduR, the DoIP module has to modify the available buffer size pointer returned to SoAd in order to stop before the next DoIP header.

If PduR_DoIPTpStartOfReception returns BUFREQ_OK the re- ception was accepted and the DoIP module shall forward already received data of the diagnostic message to the upper layer by subsequent calls to PduR_DoIPTpCopyRx Data.

Variation {ecuc(DoIP/DoIPGeneral/DoIPPowerModeCallback/DoIPPowerModeDirect)} == NULL

Variation Name = {ecuc(DoIP/DoIPConfigSet/DoIPInterface/DoIPRoutingActivation.SHORT-NAME)}

Variation ({ecuc(DoIP/DoIPGeneral/DoIPTriggerGidSyncCallback)} != NULL) && ({ecuc(DoIP/DoIPGeneral/ DoIPTriggerGidSyncCallback/DoIPTriggerGidSyncDirect)} == NULL) && ({ecuc(DoIP/Do IPGeneral/DoIPVinGidMaster)} == TRUE)

Variation ({ecuc(DoIP/DoIPGeneral/DoIPGetGidCallback)} != NULL) && ({ecuc(DoIP/DoIPGeneral/DoIPGet GidCallback/DoIPGetGidDirect)} == NULL)

Tags: atp.Status=obsolete Variation –

Tags: atp.Status=obsolete

The value of DOIP_E_PENDING shall be 0x10.

If the DoIPRoutingActivationConfirmationCallback returns E_ NOT_OK, the DoIP module shall send a routing activation response message with the activation response code set to 0x05 and the socket connection shall be closed as defined in [SWS_DoIP_00058].

If DoIP receives more UDP requests on a connection than the configured amount of DoIPMaxUDPRequestPerConnection, only DoIPMaxUDPRe- questPerConnection requests (including the request that has just been accepted) shall be processed and responded. DoIP shall silently discard the request messages that cannot be processed.

If the DoIPPduType of a DoIPPduRTxPdu is DOIP_IFPDU, the content of the PDU provided by DoIP_IfTransmit shall be stored completely in the Do IP internal buffer. If the buffer is too small, E_NOT_OK shall be returned immediately.

Runtime Error Types Type of Error Relevance Related Error Code Value [hex] Runtime Runtime Runtime Runtime Runtime

Transient Fault Types Type of Error Releva nce Related Error Code Value [hex] Transient Transient Transient Transient Transient

To transmit a DoIP diagnostic message the DoIP shall assemble the DoIP header considering the information of the handed PduInfoPtr.SduLength and call SoAd_TpTransmit with the TxPduId set to the according PduId of the socket con- nection and the PduInfoPtr.SduLength set to the sum of the following lengths: DoIP header (8 Byte), the DoIP diagnostic message specific data (4 Byte) and received length of the call to DoIP_TpTransmit or DoIP_IfTransmit (PduInfoPtr.SduLength).

If development error detection is enabled: The function shall check that the service DoIP_Init was previously called. If the check fails, the function shall raise the development error DOIP_E_UNINIT.

DoIP module shall consider the announcement successful and process DoIPVehicleAnnouncementCount if the SoAd calls the DoIP module via the interface DoIP_SoAdIfTxConfirmation with Result set to E_OK for the announcement related SoAd_IfTransmit() call i.e. if E_NOT_OK is returned for the last announcement message, it will not be considered an announcement.

Variation {ecuc(DoIP/DoIPConfigSet/DoIPInterface/DoIPFurtherActionByteCallback/DoIPFurtherActionByte Direct)} == NULL

Name CallbackGetFurtherActionByte Comment – IsService true Variation {ecuc(DoIP/DoIPConfigSet/DoIPInterface/DoIPFurtherActionByteCallback/DoIPFurtherAction ByteDirect)} == NULL 0 E_OK Operation successful Possible Errors 1 E_NOT_OK Operation failed Operation GetFurtherActionByte Comment – Mapped to API <User>_DoIPGetFurtherActionByteCallback Variation – FurtherActionByte Type DoIP_FurtherActionByteType Direction OUT Comment – Parameters Variation – Possible Errors E_OK E_NOT_OK

The "Further action" byte of a vehicle identification response/ vehicle announcement message shall contain the 1 Byte value retrieved by a call to the configured DoIPFurtherActionByteCallback (if configured, for the signature see <User>_DoIPGetFurtherActionByteCallback, [SWS_DoIP_00288]). If the function re- turns E_OK, the "Further action" byte shall be set to the retrieved value of FurtherAction Byte. If the function returns E_NOT_OK, the "Further action" byte shall be set accord- ing to [SWS_DoIP_00082], [SWS_DoIP_00083] or [SWS_DoIP_00084].

If a DoIP message with payload Type 0x0000 is received on a configured DoIPUdpConnection or DoIPTcpConnection, the message shall be dis- carded.

If a DoIP message with payload Type 0x0004 is received on a configured DoIPUdpConnection, the message shall be discarded.

When receiving a routing activation request on a TCP connec- tion where DoIPTcpConnection/DoIPTcpConnectionSecurityRequired is not set or set to FALSE, the DoIP module shall search for a DoIPTester with an assigned container that matches DoIPTesterSA. If such a DoIPTester container was found and the match- ing DoIPRoutingActivation container (refer to [SWS_DoIP_00108]) has the attribute DoIPRoutingActivationSecurityRequired not set or set to FALSE, the connection will be established. If such a DoIPTester container was found and the matching DoIPRoutingActivation container (refer to [SWS_DoIP_00108]) has the attribute DoIPRoutingActivationSecu- rityRequired is set to TRUE, the connection shall be rejected with the response code "0x07".

When receiving a routing activation request on a TCP connec- tion where DoIPTcpConnection/DoIPTcpConnectionSecurityRequired set to TRUE, the DoIP module shall search for a DoIPTester with an assigned container that matches DoIPTesterSA. If such a DoIPTester container was found, the connection will be established.

For non activation line controlled DoIP Interfaces with DoIPIn- terfaceActLineCtrl = FALSE, DoIP shall establish the corresponding connections for these interfaces according to [SWS_DoIP_00306] in context of first call to DoIP_Main Function(). (SRS_Eth_00081, SRS_Eth_00028, SRS_Eth_00026).

For a DoIP Interface with DoIPInterfaceAnnouncementStart = DOIP_AUTOMATIC_ANNOUNCE, the DoIP module shall start Vehicle announcement according to [SWS_DoIP_00205].

For a DoIP Interface with DoIPInterfaceAnnouncementStart = DOIP_ONTRIGGER_ANNOUNCE, the sending of vehicle announcement only starts if DoIP_TriggerVehicleAnnouncement () has been called for that Interface.

If DoIP_TriggerVehicleAnnouncement() is called, but the corre- sponding socket is not yet ONLINE then the request shall be remembered and vehicle announcement shall be sent as soon as the socket goes ONLINE.

If development error detection is enabled DoIP_ ActivationLine Switch (InterfaceId,*Active) shall check if interface identified by InterfaceId actually ex- ists and DoIPInterfaceActLineCtrl is set to TRUE. If the check fails, the function shall raise the development error DOIP_E_INVALID_PARAMETER.

If development error detection is enabled call to DoIP_ Activa- tionLineSwitch shall check if the interface identified by InterfaceId actually exists. If the check fails, the function shall raise the development error DOIP_E_INVALID_PARAM- ETER.

If development error detection is enabled DoIP_ TriggerVehicle Announcement shall check if the interface identified by InterfaceId is configured with DoIPInterfaceActLineCtrl set to FALSE. If the check fails the function shall raise the development error DOIP_E_INVALID_PARAMETER.

If development error detection is enabled call to DoIP_ Trigger VehicleAnnouncement shall check if the interface identified by InterfaceId actually ex- ists. If the check fails, the function shall raise the development error DOIP_E_INVALID_ PARAMETER.

To open the socket connections (triggered by SWS_DoIP_00204 or SWS_DoIP_00296) of an DoIP interface the DoIP module shall loop over all its associated DoIPTcpConnection, DoIPUdpConnection and DoIPUdpVehicleAnnounce- mentConnections. For each DoIP connections belonging to respective DoIP Interfaces which has a DoIPRequestAddressAssignment set to true the DoIP module shall re- trieve the corresponding SoConId via call to the SoAd_GetSoConId() and trigger the IP Address assignment via subsequent calls to SoAd_RequestIpAddrAssignment() with the retrieved SoConId, LocalIpAddrPtr and DefaultRouterPtr set to NULL_PTR, Net- mask set to 0, and Type set to TCPIP_IPADDR_ASSIGNMENT_ALL. For each of these DoIP connections (irrespective of the value of DoIPRequestAddressAssignment) the DoIP module shall open the respective connection by an according call to SoAd_Open SoCon(). (SRS_Eth_00081, SRS_Eth_00028, SRS_Eth_00026).

If a UDP message contains more than one DoIP requests, Do IP shall process and respond to the first DoIP request and discard the remaining re- quests.

If PduR_DoIPTpStartOfReception returns BUFREQ_E_OVFL, the DoIP module shall send a diagnostic negative acknowledge message with the di- agnostic message negative acknowledge code set to 0x05 and discard all the TCP data until the next DoIP message.

If a connection needs to be reset based on DoIP specific be- havior, the DoIP module shall call the function SoAd_CloseSoCon with the parameter abort set to TRUE and the SoConId determined by a call to the function SoAd_Get SoConId for the corresponding DoIPSoAdTcpTxPdu. Additionally, the inactivity timer shall be stopped.