158 lines
4.5 KiB
C
158 lines
4.5 KiB
C
/*
|
|
* iso_tp.h - contains public api for iso-tp
|
|
*
|
|
* Copyright (c) 2018-2023 emotas embedded communication GmbH
|
|
*
|
|
*-------------------------------------------------------------------
|
|
* $Id: iso_tp.h 51963 2024-01-24 16:02:35Z boe $
|
|
*-------------------------------------------------------------------
|
|
*
|
|
*
|
|
*
|
|
*/
|
|
|
|
/**
|
|
* \brief api for iso-tp
|
|
*
|
|
* \file iso_tp.h - contains api for iso-tp stack
|
|
*
|
|
*/
|
|
|
|
#ifndef ISO_TP_H
|
|
#define ISO_TP_H 1
|
|
|
|
#include <co_datatype.h>
|
|
|
|
|
|
/* constants */
|
|
|
|
/* datatypes */
|
|
|
|
typedef enum {
|
|
ISOTP_ADDRESS_UNKNOWN = 0u,
|
|
ISOTP_ADDRESS_PHYS,
|
|
ISOTP_ADDRESS_FUNC
|
|
} ISO_TP_ADDRESS_T;
|
|
|
|
typedef enum {
|
|
ISOTP_FORMAT_NORMAL = 0u, /**< normal adressing */
|
|
ISOTP_FORMAT_NORMAL_FIXED, /**< normal fixed addressing */
|
|
ISOTP_FORMAT_EXTENDED, /**< extended addressing */
|
|
ISOTP_FORMAT_MIXED /**< mixed addressing */
|
|
} ISO_TP_FORMAT_T;
|
|
|
|
typedef enum {
|
|
ISOTP_DATAPTR_SERVER = 0u,
|
|
ISOTP_DATAPTR_CLIENT
|
|
} ISO_TP_DATAPTR_T;
|
|
|
|
typedef enum {
|
|
ISOTP_FRAME_TYPE_SF = 0u, /**< isotp single frame */
|
|
ISOTP_FRAME_TYPE_TP /**< isotp transport protocol */
|
|
} ISO_TP_FRAME_TYPE_T;
|
|
|
|
|
|
/** \brief parameter for isotp receive function */
|
|
typedef struct {
|
|
UNSIGNED8 addr; /* source address */
|
|
UNSIGNED8 *pData; /* pointer to data */
|
|
UNSIGNED16 dataSize; /* valid data size */
|
|
} ISOTP_EVENT_RECEIVE_PARA_T;
|
|
|
|
/** \brief function pointer for isotp receive function
|
|
*
|
|
* \param addr - source address
|
|
* \param pData - pointer to data
|
|
* \param dataSize - valid data size
|
|
*
|
|
* \return RET_T
|
|
*
|
|
*/
|
|
typedef RET_T (* ISOTP_EVENT_SERVER_T)(CO_LINE_DECL, UNSIGNED8 addr, UNSIGNED8 *pData, UNSIGNED16 dataSize);
|
|
|
|
|
|
/** \brief function pointer for isotp receive split function
|
|
*
|
|
* \param addr - source address
|
|
* \param pData - pointer to data
|
|
* \param dataSize - valid data size
|
|
* \param tranferSize - size of the currently tranfered
|
|
*
|
|
* \return RET_T
|
|
*
|
|
*/
|
|
typedef RET_T (* ISOTP_EVENT_SERVER_SPLIT_T)(CO_LINE_DECL, UNSIGNED8 addr, UNSIGNED8 *pData, UNSIGNED16 dataSize, UNSIGNED16 tranferSize);
|
|
|
|
|
|
/** \brief function pointer for isotp transmit function
|
|
*
|
|
* \param addr - souce address
|
|
* \param pData - pointer to data
|
|
* \param result - result of the transfer
|
|
*
|
|
* \return RET_T
|
|
*
|
|
*/
|
|
typedef RET_T (* ISOTP_EVENT_CLIENT_T)(CO_LINE_DECL, UNSIGNED8 addr, UNSIGNED8 *pData, RET_T result);
|
|
|
|
|
|
/** \brief function pointer for isotp transmit acknowledge function
|
|
*
|
|
* \param addr - souce address
|
|
* \param pData - pointer to data
|
|
* \param size - valid data bytes
|
|
*
|
|
* \return RET_T
|
|
*
|
|
*/
|
|
typedef RET_T(*ISOTP_EVENT_CLIENT_TXACK_T)(CO_LINE_DECL, UNSIGNED8 addr, UNSIGNED8* pData, UNSIGNED16 size);
|
|
|
|
|
|
/** \brief function pointer for isotp mapping function
|
|
*
|
|
* \param pDst - destination address
|
|
* \param srcOffset - source data offset
|
|
* \param size - number of mapping bytes
|
|
* \param pPara - additional parameter
|
|
*
|
|
* \return RET_T
|
|
*
|
|
*/
|
|
typedef void (* ISOTP_MAP_FCT)(void *pDst, UNSIGNED16 srcOffset, UNSIGNED16 size, void *pPara);
|
|
|
|
|
|
/* function prototypes */
|
|
EXTERN_DECL RET_T isoTpInit(const UNSIGNED16 *pClientCnt, const UNSIGNED16 *pServerCnt);
|
|
EXTERN_DECL RET_T isoTpInitChannel(CO_LINE_DECL,
|
|
UNSIGNED32 reqId, UNSIGNED32 respId,
|
|
UNSIGNED8 srcAddr, UNSIGNED8 destAdr,
|
|
ISO_TP_ADDRESS_T addrType, ISO_TP_FORMAT_T formatType,
|
|
UNSIGNED8 *pRecDataBuffer, UNSIGNED16 recBufSize);
|
|
EXTERN_DECL RET_T isoTpSetRecDataPtr(CO_LINE_DECL, ISO_TP_DATAPTR_T direction,
|
|
UNSIGNED8 destAddr, UNSIGNED8 *pRecData, UNSIGNED16 size);
|
|
|
|
EXTERN_DECL RET_T isoTpSendReq(CO_LINE_DECL, UNSIGNED8 destAddr,
|
|
UNSIGNED8 *pData, UNSIGNED16 dataLen, ISOTP_MAP_FCT pFct, void *pFctPara,
|
|
UNSIGNED8 flags);
|
|
EXTERN_DECL void isoTpAbortTransfer(CO_LINE_DECL, UNSIGNED8 destAddr);
|
|
|
|
EXTERN_DECL RET_T isoTpSetIds(CO_LINE_DECL, UNSIGNED8 destAddr,
|
|
UNSIGNED32 reqId, UNSIGNED32 respId);
|
|
EXTERN_DECL RET_T isoTpSetRemoteAddr(CO_LINE_DECL, UNSIGNED8 remoteAddr,
|
|
UNSIGNED8 newLocalAddr, UNSIGNED8 newRemoteAddr);
|
|
EXTERN_DECL RET_T isoTpSetLocalAddr(CO_LINE_DECL, UNSIGNED8 localAddr,
|
|
UNSIGNED8 newLocalAddr, UNSIGNED8 newRemoteAddr);
|
|
|
|
EXTERN_DECL RET_T isoTpEventRegister_SERVER(ISOTP_EVENT_SERVER_T pFunction);
|
|
EXTERN_DECL RET_T isoTpEventRegister_CLIENT(ISOTP_EVENT_CLIENT_T pFunction);
|
|
|
|
EXTERN_DECL RET_T isoTpEventRegister_SERVER_SPLIT(ISOTP_EVENT_SERVER_SPLIT_T pFunction);
|
|
EXTERN_DECL RET_T isoTpEventRegister_CLIENT_TXACK(ISOTP_EVENT_CLIENT_TXACK_T pFunction);
|
|
|
|
EXTERN_DECL ISO_TP_ADDRESS_T isoTpGetCurrectConType(CO_LINE_DECL);
|
|
|
|
EXTERN_DECL RET_T isoTpGetTxMaxPayloadSize(CO_LINE_DECL, UNSIGNED8 destAddr,
|
|
ISO_TP_FRAME_TYPE_T frameType, UNSIGNED32 *pSize);
|
|
|
|
#endif /* ISO_TP_H */
|