/** * SSAS - Simple Smart Automotive Software * Copyright (C) 2021 Parai Wang * * ref: Specification of Diagnostic over IP AUTOSAR CP Release 4.4.0 */ #ifndef DOIP_PRIV_H #define DOIP_PRIV_H /* ================================ [ INCLUDES ] ============================================== */ #include "DoIP.h" #include "SoAd.h" /* ================================ [ MACROS ] ============================================== */ #define DET_THIS_MODULE_ID MODULE_ID_DOIP /* @SWS_DoIP_00008, @SWS_DoIP_00009 */ #define DOIP_GENERAL_HEADER_NEGATIVE_ACK 0x0000u /* UDP/TCP*/ #define DOIP_VID_REQUEST 0x0001u /* UDP */ #define DOIP_VID_REQUEST_WITH_EID 0x0002u /* UDP */ #define DOIP_VID_REQUEST_WITH_VIN 0x0003u /* UDP */ #define DOIP_VAN_MSG_OR_VIN_RESPONCE 0x0004u /* UDP */ #define DOIP_ROUTING_ACTIVATION_REQUEST 0x0005u /* TCP */ #define DOIP_ROUTING_ACTIVATION_RESPONSE 0x0006u /* TCP */ #define DOIP_ALIVE_CHECK_REQUEST 0x0007u /* TCP */ #define DOIP_ALIVE_CHECK_RESPONSE 0x0008u /* TCP */ #define DOIP_ENTITY_STATUS_REQUEST 0x4001u /* UDP */ #define DOIP_ENTITY_STATUS_RESPONSE 0x4002u /* UDP */ #define DOIP_DIAGNOSTIC_POWER_MODE_INFORMATION_REQUEST 0x4003u /* UDP */ #define DOIP_DIAGNOSTIC_POWER_MODE_INFORMATION_RESPONSE 0x4004u /* UDP */ #define DOIP_DIAGNOSTIC_MESSAGE 0x8001 /* TCP */ #define DOIP_DIAGNOSTIC_MESSAGE_POSITIVE_ACK 0x8002 /* TCP */ #define DOIP_DIAGNOSTIC_MESSAGE_NEGATIVE_ACK 0x8003 /* TCP */ #define DOIP_INVALID_PROTOCOL_NACK 0x00u /* SWS_DoIP_00014 */ #define DOIP_UNKNOW_PAYLOAD_TYPE_NACK 0x01u /* SWS_DoIP_00016 */ #define DOIP_TOO_MUCH_PAYLOAD_NACK 0x02u /* @SWS_DoIP_00017 */ #define DOIP_NO_BUF_AVAIL_NACK 0x03u /* @SWS_DoIP_00018 */ #define DOIP_INVALID_PAYLOAD_LENGTH_NACK 0x04u /* @SWS_DoIP_00019 */ /* @ISO13400-2-2019 Table 49 - Routing activation response code values */ #define DOIP_RA_UNKNOWN_SA 0x00u #define DOIP_RA_TCP_DATA_SOCKETS_FULL 0x01u #define DOIP_RA_CONNECTION_IN_USE 0x02u #define DOIP_RA_SA_ALREADY_ACTIVE 0x03u #define DOIP_RA_AUTHENTICATION_FAILED 0x04u #define DOIP_RA_REJECTED_CONFIRMATION 0x05u #define DOIP_RA_UNSUPPORTED_TYPE 0x06u #define DOIP_RA_OK 0x10u #define DOIP_RA_PENDING_CONFIRMATION 0x11u /* Diagnostic message negative acknowledge codes */ #define DOIP_DIAG_INVALID_SA 0x02u #define DOIP_DIAG_UNKNOWN_TA 0x03u #define DOIP_DIAG_MSG_TOO_LARGE 0x04u #define DOIP_DIAG_OUT_OF_MEMORY 0x05u #define DOIP_DIAG_TARGET_UNREACHABLE 0x06u #define DOIP_DIAG_UNKNOWN_NETWORK 0x07u #define DOIP_DIAG_TP_ERROR 0x08u #define DOIP_INVALID_PAYLOAD_TYPE 0xFFFFu #define DOIP_INVALID_INDEX ((uint8_t)-1) #ifndef DOIP_MAX_ROUTINE_ACTIVATIONS #define DOIP_MAX_ROUTINE_ACTIVATIONS 32 #endif #define DOIP_GATEWAY 0x00 #define DOIP_NODE 0x01 /* further action code values */ #define DOIP_NO_FURTHER_ACTION_REQUIRED 0x00u #define DOIP_ROUTING_ACTIVATION_REQUIRED_TO_INITATE_CENTRAL_SECURITY 0x10u /* VIN/GID synchronization status code values */ #define DOIP_VIN_GID_ARE_SYNCHRONIZED 0x00u #define DOIP_VIN_GID_INCOMPLETE_NOT_SYNCHRONIZED 0x10u #define DOIP_CON_CLOSED ((DoIP_ConnectionStateType)0) #define DOIP_CON_OPEN ((DoIP_ConnectionStateType)1) #define DOIP_MSG_IDLE ((DoIP_MessageStateType)0) #define DOIP_MSG_RX ((DoIP_MessageStateType)1) #define DOIP_MSG_TX ((DoIP_MessageStateType)2) /* @SWS_DoIP_00148 */ #define DOIP_E_UNINIT 0x01u #define DOIP_E_PARAM_POINTER 0x02u #define DOIP_E_INVALID_PDU_SDU_ID 0x03u #define DOIP_E_INVALID_PARAMETER 0x04u #define DOIP_E_INIT_FAILED 0x05u /* ================================ [ TYPES ] ============================================== */ /* Architecture of DoIP * SoAd provides one DOIP_UDP socket, which will be used both for broadcast vehicle * announcement and unicast UDP service process. * SoAd provides one DOIP_TCP_SERVER socket as server, this will be used to accept * new connection from the tester and socket DOIP_TCP_APTx(x < MAX_APT) will be used * for the new connection. * According to DOIP Channel definition, a channel is unique connection between * the configured tester and target address. */ /* @ECUC_DoIP_00035, @SWS_DoIP_00048 */ typedef Std_ReturnType (*DoIP_RoutingActivationAuthenticationCallbackType)( boolean *Authentified, const uint8_t *AuthenticationReqData, uint8_t *AuthenticationResData); /* @ECUC_DoIP_00061, @SWS_DoIP_00048 */ typedef Std_ReturnType (*DoIP_RoutingActivationConfirmationCallbackType)( boolean *Confirmed, const uint8_t *ConfirmationReqData, uint8_t *ConfirmationResData); typedef Std_ReturnType (*DoIP_GetVinFncType)(uint8_t *Data); typedef Std_ReturnType (*DoIP_GetEIDFncType)(uint8_t *Data); typedef Std_ReturnType (*DoIP_GetGIDFncType)(uint8_t *Data); typedef Std_ReturnType (*DoIP_GetPowerModeStatusFncType)(uint8_t *PowerState); typedef Std_ReturnType (*DoIP_GetRoutingActivationResponseOemFncType)(uint8_t *Data); typedef uint8_t DoIP_ConnectionStateType; typedef uint8_t DoIP_MessageStateType; typedef struct { PduLengthType TpSduLength; PduLengthType index; DoIP_MessageStateType state; } DoIP_TargetNodeContextType; typedef struct { DoIP_TargetNodeContextType *context; PduIdType TxPduId; /* PduR ID */ PduIdType doipTxPduId; /* DoIP ID called by PduR */ uint16_t TargetAddress; } DoIP_TargetNodeType; /* @ECUC_DoIP_00053 */ typedef struct { const DoIP_TargetNodeType *targetNodes; uint16_t numTargetNodes; uint16_t TargetAddress; PduIdType RxPduId; /* PduR ID */ } DoIP_TargetAddressType; typedef struct { uint8_t *req; /* len = NumByteDiagAckNack */ const DoIP_TargetAddressType *TargetAddressRef; PduLengthType TpSduLength; PduLengthType index; DoIP_MessageStateType state; } DoIP_MessageContextType; typedef struct DoIP_Tester_s DoIP_TesterType; /* @ECUC_DoIP_00030 */ typedef struct { uint8_t Number; /* @ECUC_DoIP_00033 */ uint8_t OEMReqLen; uint8_t OEMResLen; const DoIP_TargetAddressType *const *TargetAddressRefs; /* @ECUC_DoIP_00034 */ uint16_t numOfTargetAddressRefs; DoIP_RoutingActivationAuthenticationCallbackType AuthenticationCallback; DoIP_RoutingActivationConfirmationCallbackType ConfirmationCallback; } DoIP_RoutingActivationType; typedef enum { DOIP_RA_IDLE, DOIP_RA_SOCKET_HANDLER, DOIP_RA_SOCKET_HANDLER_2, DOIP_RA_CHECK_AUTHENTICATION, DOIP_RA_CHECK_CONFIRMATION, } DoIP_RoutineActivationStateType; typedef struct { DoIP_RoutineActivationStateType state; const DoIP_TesterType *tester; uint8_t raid; uint8_t OEM[4]; } DoIP_RoutineActivationManagerType; typedef struct { DoIP_ConnectionStateType state; DoIP_MessageContextType msg; DoIP_RoutineActivationManagerType ramgr; uint32_t RAMask; /* maximum 32 Routine can be activated per tester */ const DoIP_TesterType *TesterRef; uint16_t InactivityTimer; uint16_t AliveCheckResponseTimer; boolean isAlive; } DoIP_TesterConnectionContextType; typedef struct { DoIP_TesterConnectionContextType *context; SoAd_SoConIdType SoConId; PduIdType SoAdTxPdu; #ifdef USE_TLS boolean bEnableTLS; #endif } DoIP_TesterConnectionType; /* @ECUC_DoIP_00031 */ struct DoIP_Tester_s { uint16_t NumByteDiagAckNack; /* @ECUC_DoIP_00042 */ uint16_t TesterSA; /* @ECUC_DoIP_00043 */ const DoIP_RoutingActivationType *const *RoutingActivationRefs; /* @ECUC_DoIP_00062 */ uint8_t numOfRoutingActivations; }; /* @ECUC_DoIP_00045 */ typedef struct { SoAd_SoConIdType SoConId; /* TCP_SERVER */ boolean RequestAddressAssignment; } DoIP_TcpConnectionType; /* @ECUC_DoIP_00052 */ typedef struct { SoAd_SoConIdType SoConId; PduIdType SoAdTxPdu; boolean RequestAddressAssignment; /* @ECUC_DoIP_00095 */ } DoIP_UdpConnectionType; typedef struct { DoIP_ConnectionStateType state; uint16_t AnnouncementTimer; uint8_t AnnouncementCounter; } DoIP_UdpVehicleAnnouncementConnectionContextType; /* @ECUC_DoIP_00076 */ typedef struct { DoIP_UdpVehicleAnnouncementConnectionContextType *context; SoAd_SoConIdType SoConId; PduIdType SoAdTxPdu; boolean RequestAddressAssignment; /* @ECUC_DoIP_00095 */ } DoIP_UdpVehicleAnnouncementConnectionType; /* @SWS_DoIP_00271 */ typedef enum { DOIP_ACTIVATION_LINE_INACTIVE, DOIP_ACTIVATION_LINE_ACTIVE, } DoIP_ActivationLineType; /* @ECUC_DoIP_00069 */ typedef struct { const DoIP_TesterType *SARef; /* @ECUC_DoIP_00070 */ const DoIP_TargetAddressType *TARef; /* @ECUC_DoIP_00071 */ } DoIP_ChannelConfigType; struct DoIP_Config_s { uint16_t InitialInactivityTime; /* @ECUC_DoIP_00010*/ uint16_t GeneralInactivityTime; /* @ECUC_DoIP_00068 */ uint16_t AliveCheckResponseTimeout; /* @ECUC_DoIP_00009 */ uint8_t VinInvalidityPattern; /* @ECUC_DoIP_00066 */ uint16_t InitialVehicleAnnouncementTime; /* @ECUC_DoIP_00008 */ uint16_t VehicleAnnouncementInterval; /* @ECUC_DoIP_00007 */ uint8_t VehicleAnnouncementCount; /* @ECUC_DoIP_00094 */ uint8_t NodeType; /* @ECUC_DoIP_00021 */ boolean EntityStatusMaxByteFieldUse; /* @ECUC_DoIP_00064 */ DoIP_GetVinFncType GetVin; DoIP_GetEIDFncType GetEID; /* @ECUC_DoIP_00014 */ DoIP_GetGIDFncType GetGID; /* @ECUC_DoIP_00015 */ DoIP_GetPowerModeStatusFncType GetPowerModeStatus; DoIP_GetRoutingActivationResponseOemFncType GetRoutingActivationResponseOem; uint16_t LogicalAddress; /* @ECUC_DoIP_00020 */ /* @ECUC_DoIP_00032 */ const DoIP_TargetAddressType *TargetAddresss; uint16_t numOfTargetAddresss; const DoIP_TcpConnectionType *TcpConnections; uint16_t numOfTcpConnections; const DoIP_UdpConnectionType *UdpConnections; uint16_t numOfUdpConnections; const DoIP_UdpVehicleAnnouncementConnectionType *UdpVehicleAnnouncementConnections; uint16_t numOfUdpVehicleAnnouncementConnections; const DoIP_TesterConnectionType *testerConnections; uint16_t MaxTesterConnections; /* @ECUC_DoIP_00012 */ const DoIP_RoutingActivationType *routingActivations; uint16_t numOfRoutingActivations; const DoIP_TesterType *testers; uint16_t numOfTesters; const uint16_t *RxPduIdToConnectionMap; uint16_t numOfRxPduIds; }; /* ================================ [ DECLARES ] ============================================== */ /* ================================ [ DATAS ] ============================================== */ /* ================================ [ LOCALS ] ============================================== */ /* ================================ [ FUNCTIONS ] ============================================== */ #endif /* DOIP_PRIV_H */