diff options
Diffstat (limited to 'include/dlt/dlt_common.h')
| -rw-r--r-- | include/dlt/dlt_common.h | 1959 |
1 files changed, 988 insertions, 971 deletions
diff --git a/include/dlt/dlt_common.h b/include/dlt/dlt_common.h index 3db3a27..fc02743 100644 --- a/include/dlt/dlt_common.h +++ b/include/dlt/dlt_common.h @@ -22,7 +22,7 @@ * License MPL-2.0: Mozilla Public License version 2.0 http://mozilla.org/MPL/2.0/. * * \file dlt_common.h -*/ + */ /******************************************************************************* ** ** @@ -63,163 +63,164 @@ * $LastChangedRevision: 1670 $ * $LastChangedDate: 2011-04-08 15:12:06 +0200 (Fr, 08. Apr 2011) $ * $LastChangedBy$ - Initials Date Comment - aw 13.01.2010 initial + * Initials Date Comment + * aw 13.01.2010 initial */ #ifndef DLT_COMMON_H -#define DLT_COMMON_H +# define DLT_COMMON_H /** - \defgroup commonapi DLT Common API - \addtogroup commonapi - \{ -*/ + * \defgroup commonapi DLT Common API + * \addtogroup commonapi + \{ + */ -#include <stdio.h> -#ifdef __linux__ -#include <linux/limits.h> -#else -#include <limits.h> -#endif +# include <stdio.h> +# ifdef __linux__ +# include <linux/limits.h> +# else +# include <limits.h> +# endif -#if !defined(_MSC_VER) -#include <unistd.h> -#include <time.h> -#endif +# if !defined(_MSC_VER) +# include <unistd.h> +# include <time.h> +# endif -#if !defined (__WIN32__) && !defined(_MSC_VER) -#include <termios.h> -#endif +# if !defined (__WIN32__) && !defined(_MSC_VER) +# include <termios.h> +# endif -#include "dlt_types.h" -#include "dlt_protocol.h" +# include "dlt_types.h" +# include "dlt_protocol.h" -#if !defined (PACKED) -#define PACKED __attribute__((aligned(1),packed)) -#endif +# if !defined (PACKED) +# define PACKED __attribute__((aligned(1), packed)) +# endif -#if defined (__MSDOS__) || defined (_MSC_VER) +# if defined (__MSDOS__) || defined (_MSC_VER) /* set instead /Zp8 flag in Visual C++ configuration */ -#undef PACKED -#define PACKED -#endif +# undef PACKED +# define PACKED +# endif /* * Macros to swap the byte order. */ -#define DLT_SWAP_64(value) ((((uint64_t)DLT_SWAP_32((value)&0xffffffffull))<<32) | (DLT_SWAP_32((value)>>32))) +# define DLT_SWAP_64(value) ((((uint64_t)DLT_SWAP_32((value) & 0xffffffffull)) << 32) | (DLT_SWAP_32((value) >> 32))) -#define DLT_SWAP_16(value) ((((value) >> 8)&0xff) | (((value) << 8)&0xff00)) -#define DLT_SWAP_32(value) ((((value) >> 24)&0xff) | (((value) << 8)&0xff0000) | (((value) >> 8)&0xff00) | (((value) << 24)&0xff000000)) +# define DLT_SWAP_16(value) ((((value) >> 8) & 0xff) | (((value) << 8) & 0xff00)) +# define DLT_SWAP_32(value) ((((value) >> 24) & 0xff) | (((value) << 8) & 0xff0000) | (((value) >> 8) & 0xff00) | \ + (((value) << 24) & 0xff000000)) /* Set Big Endian and Little Endian to a initial value, if not defined */ -#if !defined __USE_BSD -#ifndef LITTLE_ENDIAN -#define LITTLE_ENDIAN 1234 -#endif +# if !defined __USE_BSD +# ifndef LITTLE_ENDIAN +# define LITTLE_ENDIAN 1234 +# endif -#ifndef BIG_ENDIAN -#define BIG_ENDIAN 4321 -#endif -#endif /* __USE_BSD */ +# ifndef BIG_ENDIAN +# define BIG_ENDIAN 4321 +# endif +# endif /* __USE_BSD */ /* If byte order is not defined, default to little endian */ -#if !defined __USE_BSD -#ifndef BYTE_ORDER -#define BYTE_ORDER LITTLE_ENDIAN -#endif -#endif /* __USE_BSD */ +# if !defined __USE_BSD +# ifndef BYTE_ORDER +# define BYTE_ORDER LITTLE_ENDIAN +# endif +# endif /* __USE_BSD */ /* Check for byte-order */ -#if (BYTE_ORDER==BIG_ENDIAN) +# if (BYTE_ORDER == BIG_ENDIAN) /* #warning "Big Endian Architecture!" */ -#define DLT_HTOBE_16(x) ((x)) -#define DLT_HTOLE_16(x) DLT_SWAP_16((x)) -#define DLT_BETOH_16(x) ((x)) -#define DLT_LETOH_16(x) DLT_SWAP_16((x)) - -#define DLT_HTOBE_32(x) ((x)) -#define DLT_HTOLE_32(x) DLT_SWAP_32((x)) -#define DLT_BETOH_32(x) ((x)) -#define DLT_LETOH_32(x) DLT_SWAP_32((x)) - -#define DLT_HTOBE_64(x) ((x)) -#define DLT_HTOLE_64(x) DLT_SWAP_64((x)) -#define DLT_BETOH_64(x) ((x)) -#define DLT_LETOH_64(x) DLT_SWAP_64((x)) -#else +# define DLT_HTOBE_16(x) ((x)) +# define DLT_HTOLE_16(x) DLT_SWAP_16((x)) +# define DLT_BETOH_16(x) ((x)) +# define DLT_LETOH_16(x) DLT_SWAP_16((x)) + +# define DLT_HTOBE_32(x) ((x)) +# define DLT_HTOLE_32(x) DLT_SWAP_32((x)) +# define DLT_BETOH_32(x) ((x)) +# define DLT_LETOH_32(x) DLT_SWAP_32((x)) + +# define DLT_HTOBE_64(x) ((x)) +# define DLT_HTOLE_64(x) DLT_SWAP_64((x)) +# define DLT_BETOH_64(x) ((x)) +# define DLT_LETOH_64(x) DLT_SWAP_64((x)) +# else /* #warning "Litte Endian Architecture!" */ -#define DLT_HTOBE_16(x) DLT_SWAP_16((x)) -#define DLT_HTOLE_16(x) ((x)) -#define DLT_BETOH_16(x) DLT_SWAP_16((x)) -#define DLT_LETOH_16(x) ((x)) - -#define DLT_HTOBE_32(x) DLT_SWAP_32((x)) -#define DLT_HTOLE_32(x) ((x)) -#define DLT_BETOH_32(x) DLT_SWAP_32((x)) -#define DLT_LETOH_32(x) ((x)) - -#define DLT_HTOBE_64(x) DLT_SWAP_64((x)) -#define DLT_HTOLE_64(x) ((x)) -#define DLT_BETOH_64(x) DLT_SWAP_64((x)) -#define DLT_LETOH_64(x) ((x)) -#endif - -#define DLT_ENDIAN_GET_16(htyp,x) ((((htyp) & DLT_HTYP_MSBF)>0)?DLT_BETOH_16(x):DLT_LETOH_16(x)) -#define DLT_ENDIAN_GET_32(htyp,x) ((((htyp) & DLT_HTYP_MSBF)>0)?DLT_BETOH_32(x):DLT_LETOH_32(x)) -#define DLT_ENDIAN_GET_64(htyp,x) ((((htyp) & DLT_HTYP_MSBF)>0)?DLT_BETOH_64(x):DLT_LETOH_64(x)) - -#if defined (__WIN32__) || defined (_MSC_VER) -#define LOG_EMERG 0 -#define LOG_ALERT 1 -#define LOG_CRIT 2 -#define LOG_ERR 3 -#define LOG_WARNING 4 -#define LOG_NOTICE 5 -#define LOG_INFO 6 -#define LOG_DEBUG 7 - -#define LOG_PID 0x01 -#define LOG_DAEMON (3<<3) -#endif +# define DLT_HTOBE_16(x) DLT_SWAP_16((x)) +# define DLT_HTOLE_16(x) ((x)) +# define DLT_BETOH_16(x) DLT_SWAP_16((x)) +# define DLT_LETOH_16(x) ((x)) + +# define DLT_HTOBE_32(x) DLT_SWAP_32((x)) +# define DLT_HTOLE_32(x) ((x)) +# define DLT_BETOH_32(x) DLT_SWAP_32((x)) +# define DLT_LETOH_32(x) ((x)) + +# define DLT_HTOBE_64(x) DLT_SWAP_64((x)) +# define DLT_HTOLE_64(x) ((x)) +# define DLT_BETOH_64(x) DLT_SWAP_64((x)) +# define DLT_LETOH_64(x) ((x)) +# endif + +# define DLT_ENDIAN_GET_16(htyp, x) ((((htyp) & DLT_HTYP_MSBF) > 0) ? DLT_BETOH_16(x) : DLT_LETOH_16(x)) +# define DLT_ENDIAN_GET_32(htyp, x) ((((htyp) & DLT_HTYP_MSBF) > 0) ? DLT_BETOH_32(x) : DLT_LETOH_32(x)) +# define DLT_ENDIAN_GET_64(htyp, x) ((((htyp) & DLT_HTYP_MSBF) > 0) ? DLT_BETOH_64(x) : DLT_LETOH_64(x)) + +# if defined (__WIN32__) || defined (_MSC_VER) +# define LOG_EMERG 0 +# define LOG_ALERT 1 +# define LOG_CRIT 2 +# define LOG_ERR 3 +# define LOG_WARNING 4 +# define LOG_NOTICE 5 +# define LOG_INFO 6 +# define LOG_DEBUG 7 + +# define LOG_PID 0x01 +# define LOG_DAEMON (3 << 3) +# endif enum { - DLT_LOG_TO_CONSOLE=0, - DLT_LOG_TO_SYSLOG=1, - DLT_LOG_TO_FILE=2, - DLT_LOG_DROPPED=3 + DLT_LOG_TO_CONSOLE = 0, + DLT_LOG_TO_SYSLOG = 1, + DLT_LOG_TO_FILE = 2, + DLT_LOG_DROPPED = 3 }; /** * The standard TCP Port used for DLT daemon, can be overwritten via -p <port> when starting dlt-daemon */ -#define DLT_DAEMON_TCP_PORT 3490 +# define DLT_DAEMON_TCP_PORT 3490 /* Initial value for file descriptor */ -#define DLT_FD_INIT -1 +# define DLT_FD_INIT -1 /* Minimum value for a file descriptor except the POSIX Standards: stdin=0, stdout=1, stderr=2 */ -#define DLT_FD_MINIMUM 3 +# define DLT_FD_MINIMUM 3 /** * The size of a DLT ID */ -#define DLT_ID_SIZE 4 +# define DLT_ID_SIZE 4 -#define DLT_SIZE_WEID DLT_ID_SIZE -#define DLT_SIZE_WSID (sizeof(uint32_t)) -#define DLT_SIZE_WTMS (sizeof(uint32_t)) +# define DLT_SIZE_WEID DLT_ID_SIZE +# define DLT_SIZE_WSID (sizeof(uint32_t)) +# define DLT_SIZE_WTMS (sizeof(uint32_t)) /** * Definitions for GET_LOG_INFO */ -#define DLT_GET_LOG_INFO_HEADER 18 /*Get log info header size in response text */ -#define GET_LOG_INFO_LENGTH 13 -#define SERVICE_OPT_LENGTH 3 +# define DLT_GET_LOG_INFO_HEADER 18 /*Get log info header size in response text */ +# define GET_LOG_INFO_LENGTH 13 +# define SERVICE_OPT_LENGTH 3 /* checks if received size is big enough for expected data */ -#define DLT_CHECK_RCV_DATA_SIZE(received, required) \ +# define DLT_CHECK_RCV_DATA_SIZE(received, required) \ ({ \ int _ret = DLT_RETURN_OK; \ if (((int)received - (int)required) < 0) { \ @@ -232,155 +233,158 @@ enum { /** * Get the size of extra header parameters, depends on htyp. */ -#define DLT_STANDARD_HEADER_EXTRA_SIZE(htyp) ( (DLT_IS_HTYP_WEID(htyp) ? DLT_SIZE_WEID : 0) + (DLT_IS_HTYP_WSID(htyp) ? DLT_SIZE_WSID : 0) + (DLT_IS_HTYP_WTMS(htyp) ? DLT_SIZE_WTMS : 0) ) +# define DLT_STANDARD_HEADER_EXTRA_SIZE(htyp) ((DLT_IS_HTYP_WEID(htyp) ? DLT_SIZE_WEID : 0) + \ + (DLT_IS_HTYP_WSID(htyp) ? DLT_SIZE_WSID : 0) + \ + (DLT_IS_HTYP_WTMS(htyp) ? DLT_SIZE_WTMS : 0)) -#if defined (__MSDOS__) || defined (_MSC_VER) -#define __func__ __FUNCTION__ -#endif +# if defined (__MSDOS__) || defined (_MSC_VER) +# define __func__ __FUNCTION__ +# endif -#define PRINT_FUNCTION_VERBOSE(_verbose) \ -{ \ - static char _strbuf[255]; \ - \ - if(_verbose) \ +# define PRINT_FUNCTION_VERBOSE(_verbose) \ { \ - snprintf(_strbuf, 255, "%s()\n",__func__); \ - dlt_log(LOG_INFO, _strbuf); \ - } \ -} + static char _strbuf[255]; \ + \ + if (_verbose) \ + { \ + snprintf(_strbuf, 255, "%s()\n", __func__); \ + dlt_log(LOG_INFO, _strbuf); \ + } \ + } -#ifndef NULL -#define NULL (char*)0 -#endif +# ifndef NULL +# define NULL (char *)0 +# endif -#define DLT_MSG_IS_CONTROL(MSG) ((DLT_IS_HTYP_UEH((MSG)->standardheader->htyp)) && \ - (DLT_GET_MSIN_MSTP((MSG)->extendedheader->msin)==DLT_TYPE_CONTROL)) +# define DLT_MSG_IS_CONTROL(MSG) ((DLT_IS_HTYP_UEH((MSG)->standardheader->htyp)) && \ + (DLT_GET_MSIN_MSTP((MSG)->extendedheader->msin) == DLT_TYPE_CONTROL)) -#define DLT_MSG_IS_CONTROL_REQUEST(MSG) ((DLT_IS_HTYP_UEH((MSG)->standardheader->htyp)) && \ - (DLT_GET_MSIN_MSTP((MSG)->extendedheader->msin)==DLT_TYPE_CONTROL) && \ - (DLT_GET_MSIN_MTIN((MSG)->extendedheader->msin)==DLT_CONTROL_REQUEST)) +# define DLT_MSG_IS_CONTROL_REQUEST(MSG) ((DLT_IS_HTYP_UEH((MSG)->standardheader->htyp)) && \ + (DLT_GET_MSIN_MSTP((MSG)->extendedheader->msin) == DLT_TYPE_CONTROL) && \ + (DLT_GET_MSIN_MTIN((MSG)->extendedheader->msin) == DLT_CONTROL_REQUEST)) -#define DLT_MSG_IS_CONTROL_RESPONSE(MSG) ((DLT_IS_HTYP_UEH((MSG)->standardheader->htyp)) && \ - (DLT_GET_MSIN_MSTP((MSG)->extendedheader->msin)==DLT_TYPE_CONTROL) && \ - (DLT_GET_MSIN_MTIN((MSG)->extendedheader->msin)==DLT_CONTROL_RESPONSE)) +# define DLT_MSG_IS_CONTROL_RESPONSE(MSG) ((DLT_IS_HTYP_UEH((MSG)->standardheader->htyp)) && \ + (DLT_GET_MSIN_MSTP((MSG)->extendedheader->msin) == DLT_TYPE_CONTROL) && \ + (DLT_GET_MSIN_MTIN((MSG)->extendedheader->msin) == DLT_CONTROL_RESPONSE)) -#define DLT_MSG_IS_CONTROL_TIME(MSG) ((DLT_IS_HTYP_UEH((MSG)->standardheader->htyp)) && \ - (DLT_GET_MSIN_MSTP((MSG)->extendedheader->msin)==DLT_TYPE_CONTROL) && \ - (DLT_GET_MSIN_MTIN((MSG)->extendedheader->msin)==DLT_CONTROL_TIME)) +# define DLT_MSG_IS_CONTROL_TIME(MSG) ((DLT_IS_HTYP_UEH((MSG)->standardheader->htyp)) && \ + (DLT_GET_MSIN_MSTP((MSG)->extendedheader->msin) == DLT_TYPE_CONTROL) && \ + (DLT_GET_MSIN_MTIN((MSG)->extendedheader->msin) == DLT_CONTROL_TIME)) -#define DLT_MSG_IS_NW_TRACE(MSG) ((DLT_IS_HTYP_UEH((MSG)->standardheader->htyp)) && \ - (DLT_GET_MSIN_MSTP((MSG)->extendedheader->msin)==DLT_TYPE_NW_TRACE)) +# define DLT_MSG_IS_NW_TRACE(MSG) ((DLT_IS_HTYP_UEH((MSG)->standardheader->htyp)) && \ + (DLT_GET_MSIN_MSTP((MSG)->extendedheader->msin) == DLT_TYPE_NW_TRACE)) -#define DLT_MSG_IS_TRACE_MOST(MSG) ((DLT_IS_HTYP_UEH((MSG)->standardheader->htyp)) && \ - (DLT_GET_MSIN_MSTP((MSG)->extendedheader->msin)==DLT_TYPE_NW_TRACE) && \ - (DLT_GET_MSIN_MTIN((MSG)->extendedheader->msin)==DLT_NW_TRACE_MOST)) +# define DLT_MSG_IS_TRACE_MOST(MSG) ((DLT_IS_HTYP_UEH((MSG)->standardheader->htyp)) && \ + (DLT_GET_MSIN_MSTP((MSG)->extendedheader->msin) == DLT_TYPE_NW_TRACE) && \ + (DLT_GET_MSIN_MTIN((MSG)->extendedheader->msin) == DLT_NW_TRACE_MOST)) -#define DLT_MSG_IS_NONVERBOSE(MSG) (!(DLT_IS_HTYP_UEH((MSG)->standardheader->htyp)) || \ - ((DLT_IS_HTYP_UEH((MSG)->standardheader->htyp)) && (!(DLT_IS_MSIN_VERB((MSG)->extendedheader->msin))))) +# define DLT_MSG_IS_NONVERBOSE(MSG) (!(DLT_IS_HTYP_UEH((MSG)->standardheader->htyp)) || \ + ((DLT_IS_HTYP_UEH((MSG)->standardheader->htyp)) && \ + (!(DLT_IS_MSIN_VERB((MSG)->extendedheader->msin))))) /* - + * * Definitions of DLT message buffer overflow */ -#define DLT_MESSAGE_BUFFER_NO_OVERFLOW 0x00 /**< Buffer overflow has not occured */ -#define DLT_MESSAGE_BUFFER_OVERFLOW 0x01 /**< Buffer overflow has occured */ +# define DLT_MESSAGE_BUFFER_NO_OVERFLOW 0x00/**< Buffer overflow has not occured */ +# define DLT_MESSAGE_BUFFER_OVERFLOW 0x01/**< Buffer overflow has occured */ /* * Definition of DLT output variants */ -#define DLT_OUTPUT_HEX 1 -#define DLT_OUTPUT_ASCII 2 -#define DLT_OUTPUT_MIXED_FOR_PLAIN 3 -#define DLT_OUTPUT_MIXED_FOR_HTML 4 -#define DLT_OUTPUT_ASCII_LIMITED 5 +# define DLT_OUTPUT_HEX 1 +# define DLT_OUTPUT_ASCII 2 +# define DLT_OUTPUT_MIXED_FOR_PLAIN 3 +# define DLT_OUTPUT_MIXED_FOR_HTML 4 +# define DLT_OUTPUT_ASCII_LIMITED 5 -#define DLT_FILTER_MAX 30 /**< Maximum number of filters */ +# define DLT_FILTER_MAX 30 /**< Maximum number of filters */ -#define DLT_MSG_READ_VALUE(dst,src,length,type) \ -{ \ - if((length<0) || ((length)<((int32_t)sizeof(type)))) \ - { length = -1; } \ - else \ - { dst = *((type*)src);src+=sizeof(type);length-=sizeof(type); } \ -} - -#define DLT_MSG_READ_ID(dst,src,length) \ -{ \ - if((length<0) || ((length)<DLT_ID_SIZE)) \ - { length = -1; } \ - else \ - { memcpy(dst,src,DLT_ID_SIZE);src+=DLT_ID_SIZE;length-=DLT_ID_SIZE; } \ -} - -#define DLT_MSG_READ_STRING(dst,src,maxlength,length) \ -{ \ - if(((maxlength)<0) || ((length)<0) || ((maxlength)<(length))) \ - { maxlength = -1; } \ - else \ - { memcpy(dst,src,length);dlt_clean_string(dst,length);dst[length]=0; \ - src+=length;maxlength-=length; } \ -} +# define DLT_MSG_READ_VALUE(dst, src, length, type) \ + { \ + if ((length < 0) || ((length) < ((int32_t)sizeof(type)))) \ + { length = -1; } \ + else \ + { dst = *((type *)src); src += sizeof(type); length -= sizeof(type); } \ + } -#define DLT_MSG_READ_NULL(src,maxlength,length) \ -{ \ - if(((maxlength)<0) || ((length)<0) || ((maxlength)<(length))) \ - { length = -1; } \ - else \ - { src+=length;maxlength-=length; } \ -} +# define DLT_MSG_READ_ID(dst, src, length) \ + { \ + if ((length < 0) || ((length) < DLT_ID_SIZE)) \ + { length = -1; } \ + else \ + { memcpy(dst, src, DLT_ID_SIZE); src += DLT_ID_SIZE; length -= DLT_ID_SIZE; } \ + } -#define DLT_HEADER_SHOW_NONE 0x0000 -#define DLT_HEADER_SHOW_TIME 0x0001 -#define DLT_HEADER_SHOW_TMSTP 0x0002 -#define DLT_HEADER_SHOW_MSGCNT 0x0004 -#define DLT_HEADER_SHOW_ECUID 0x0008 -#define DLT_HEADER_SHOW_APID 0x0010 -#define DLT_HEADER_SHOW_CTID 0x0020 -#define DLT_HEADER_SHOW_MSGTYPE 0x0040 -#define DLT_HEADER_SHOW_MSGSUBTYPE 0x0080 -#define DLT_HEADER_SHOW_VNVSTATUS 0x0100 -#define DLT_HEADER_SHOW_NOARG 0x0200 -#define DLT_HEADER_SHOW_ALL 0xFFFF +# define DLT_MSG_READ_STRING(dst, src, maxlength, length) \ + { \ + if (((maxlength) < 0) || ((length) < 0) || ((maxlength) < (length))) \ + { maxlength = -1; } \ + else \ + { memcpy(dst, src, length); dlt_clean_string(dst, length); dst[length] = 0; \ + src += length; maxlength -= length; } \ + } + +# define DLT_MSG_READ_NULL(src, maxlength, length) \ + { \ + if (((maxlength) < 0) || ((length) < 0) || ((maxlength) < (length))) \ + { length = -1; } \ + else \ + { src += length; maxlength -= length; } \ + } + +# define DLT_HEADER_SHOW_NONE 0x0000 +# define DLT_HEADER_SHOW_TIME 0x0001 +# define DLT_HEADER_SHOW_TMSTP 0x0002 +# define DLT_HEADER_SHOW_MSGCNT 0x0004 +# define DLT_HEADER_SHOW_ECUID 0x0008 +# define DLT_HEADER_SHOW_APID 0x0010 +# define DLT_HEADER_SHOW_CTID 0x0020 +# define DLT_HEADER_SHOW_MSGTYPE 0x0040 +# define DLT_HEADER_SHOW_MSGSUBTYPE 0x0080 +# define DLT_HEADER_SHOW_VNVSTATUS 0x0100 +# define DLT_HEADER_SHOW_NOARG 0x0200 +# define DLT_HEADER_SHOW_ALL 0xFFFF /* dlt_receiver_check_and_get flags */ -#define DLT_RCV_NONE 0 -#define DLT_RCV_SKIP_HEADER (1 << 0) -#define DLT_RCV_REMOVE (1 << 1) +# define DLT_RCV_NONE 0 +# define DLT_RCV_SKIP_HEADER (1 << 0) +# define DLT_RCV_REMOVE (1 << 1) /** * Maximal length of mounted path */ -#define DLT_MOUNT_PATH_MAX 1024 +# define DLT_MOUNT_PATH_MAX 1024 /** * Maximal length of an entry */ -#define DLT_ENTRY_MAX 100 +# define DLT_ENTRY_MAX 100 /** * Maximal IPC path len */ -#define DLT_IPC_PATH_MAX 100 +# define DLT_IPC_PATH_MAX 100 /** * Maximal receiver buffer size for application messages */ -#define DLT_RECEIVE_BUFSIZE 65535 +# define DLT_RECEIVE_BUFSIZE 65535 /** * Maximal line length */ -#define DLT_LINE_LEN 1024 +# define DLT_LINE_LEN 1024 /** * Provision to test static function */ -#ifndef DLT_UNIT_TESTS -#define DLT_STATIC static -#else -#define DLT_STATIC -#endif +# ifndef DLT_UNIT_TESTS +# define DLT_STATIC static +# else +# define DLT_STATIC +# endif /** * Type to specify whether received data is from socket or file/fifo @@ -470,16 +474,16 @@ typedef struct sDltMessage int32_t datasize; /**< size of complete payload */ /* buffer for current loaded message */ - uint8_t headerbuffer[sizeof(DltStorageHeader)+ - sizeof(DltStandardHeader)+sizeof(DltStandardHeaderExtra)+sizeof(DltExtendedHeader)]; /**< buffer for loading complete header */ + uint8_t headerbuffer[sizeof(DltStorageHeader) + + sizeof(DltStandardHeader) + sizeof(DltStandardHeaderExtra) + sizeof(DltExtendedHeader)]; /**< buffer for loading complete header */ uint8_t *databuffer; /**< buffer for loading payload */ int32_t databuffersize; /* header values of current loaded message */ - DltStorageHeader *storageheader; /**< pointer to storage header of current loaded header */ - DltStandardHeader *standardheader; /**< pointer to standard header of current loaded header */ + DltStorageHeader *storageheader; /**< pointer to storage header of current loaded header */ + DltStandardHeader *standardheader; /**< pointer to standard header of current loaded header */ DltStandardHeaderExtra headerextra; /**< extra parameters of current loaded header */ - DltExtendedHeader *extendedheader; /**< pointer to extended of current loaded header */ + DltExtendedHeader *extendedheader; /**< pointer to extended of current loaded header */ } DltMessage; /** @@ -615,7 +619,7 @@ typedef struct typedef struct { uint32_t service_id; /**< service ID */ - uint8_t status; /**< reponse status */ + uint8_t status; /**< reponse status */ uint32_t length; /**< length of following payload */ /*char [] payload;*/ } PACKED DltServiceGetSoftwareVersionResponse; @@ -719,7 +723,7 @@ typedef struct { char apid[DLT_FILTER_MAX][DLT_ID_SIZE]; /**< application id */ char ctid[DLT_FILTER_MAX][DLT_ID_SIZE]; /**< context id */ - int counter; /**< number of filters */ + int counter; /**< number of filters */ } DltFilter; /** @@ -771,13 +775,13 @@ typedef struct typedef struct { - unsigned char* shm; /* pointer to beginning of shared memory */ - int size; /* size of data area in shared memory */ - unsigned char* mem; /* pointer to data area in shared memory */ + unsigned char *shm; /* pointer to beginning of shared memory */ + int size; /* size of data area in shared memory */ + unsigned char *mem; /* pointer to data area in shared memory */ - uint32_t min_size; /**< Minimum size of buffer */ - uint32_t max_size; /**< Maximum size of buffer */ - uint32_t step_size; /**< Step size of buffer */ + uint32_t min_size; /**< Minimum size of buffer */ + uint32_t max_size; /**< Maximum size of buffer */ + uint32_t step_size; /**< Step size of buffer */ } DltBuffer; typedef struct @@ -787,7 +791,7 @@ typedef struct int count; } DltBufferHead; -#define DLT_BUFFER_HEAD "SHM" +# define DLT_BUFFER_HEAD "SHM" typedef struct { @@ -796,759 +800,772 @@ typedef struct int size; } DltBufferBlockHead; -#define DLT_MESSAGE_ERROR_OK 0 -#define DLT_MESSAGE_ERROR_UNKNOWN -1 -#define DLT_MESSAGE_ERROR_SIZE -2 -#define DLT_MESSAGE_ERROR_CONTENT -3 +# define DLT_MESSAGE_ERROR_OK 0 +# define DLT_MESSAGE_ERROR_UNKNOWN -1 +# define DLT_MESSAGE_ERROR_SIZE -2 +# define DLT_MESSAGE_ERROR_CONTENT -3 -#ifdef __cplusplus +# ifdef __cplusplus extern "C" { -#endif - - /** - * Helper function to print a byte array in hex. - * @param ptr pointer to the byte array. - * @param size number of bytes to be printed. - */ - void dlt_print_hex(uint8_t *ptr,int size); - /** - * Helper function to print a byte array in hex into a string. - * @param text pointer to a ASCII string, in which the text is written - * @param textlength maximal size of text buffer - * @param ptr pointer to the byte array. - * @param size number of bytes to be printed. - * @return negative value if there was an error - */ - DltReturnValue dlt_print_hex_string(char *text,int textlength,uint8_t *ptr,int size); - /** - * Helper function to print a byte array in hex and ascii into a string. - * @param text pointer to a ASCII string, in which the text is written - * @param textlength maximal size of text buffer - * @param ptr pointer to the byte array. - * @param size number of bytes to be printed. - * @param html output is html? 0 - false, 1 - true - * @return negative value if there was an error - */ - DltReturnValue dlt_print_mixed_string(char *text,int textlength,uint8_t *ptr,int size,int html); - /** - * Helper function to print a byte array in ascii into a string. - * @param text pointer to a ASCII string, in which the text is written - * @param textlength maximal size of text buffer - * @param ptr pointer to the byte array. - * @param size number of bytes to be printed. - * @return negative value if there was an error - */ - DltReturnValue dlt_print_char_string(char **text,int textlength,uint8_t *ptr,int size); - - /** - * Helper function to print an id. - * @param text pointer to ASCII string where to write the id - * @param id four byte char array as used in DLT mesages as IDs. - */ - void dlt_print_id(char *text,const char *id); - - /** - * Helper function to set an ID parameter. - * @param id four byte char array as used in DLT mesages as IDs. - * @param text string to be copied into char array. - */ - void dlt_set_id(char *id,const char *text); - - /** - * Helper function to remove not nice to print characters, e.g. NULL or carage return. - * @param text pointer to string to be cleaned. - * @param length length of string excluding terminating zero. - */ - void dlt_clean_string(char *text,int length); - - /** - * Initialise the filter list. - * This function must be called before using further dlt filter. - * @param filter pointer to structure of organising DLT filter - * @param verbose if set to true verbose information is printed out. - * @return negative value if there was an error - */ - DltReturnValue dlt_filter_init(DltFilter *filter,int verbose); - /** - * Free the used memory by the organising structure of filter. - * @param filter pointer to structure of organising DLT filter - * @param verbose if set to true verbose information is printed out. - * @return negative value if there was an error - */ - DltReturnValue dlt_filter_free(DltFilter *filter,int verbose); - /** - * Load filter list from file. - * @param filter pointer to structure of organising DLT filter - * @param filename filename to load filters from - * @param verbose if set to true verbose information is printed out. - * @return negative value if there was an error - */ - DltReturnValue dlt_filter_load(DltFilter *filter,const char *filename,int verbose); - /** - * Save filter list to file. - * @param filter pointer to structure of organising DLT filter - * @param filename filename to load filters from - * @param verbose if set to true verbose information is printed out. - * @return negative value if there was an error - */ - DltReturnValue dlt_filter_save(DltFilter *filter,const char *filename,int verbose); - /** - * Find index of filter in filter list - * @param filter pointer to structure of organising DLT filter - * @param apid application id to be found in filter list - * @param ctid context id to be found in filter list - * @param verbose if set to true verbose information is printed out. - * @return negative value if there was an error (or not found), else return index of filter - */ - int dlt_filter_find(DltFilter *filter,const char *apid,const char *ctid, int verbose); - /** - * Add new filter to filter list. - * @param filter pointer to structure of organising DLT filter - * @param apid application id to be added to filter list (must always be set). - * @param ctid context id to be added to filter list. empty equals don't care. - * @param verbose if set to true verbose information is printed out. - * @return negative value if there was an error - */ - DltReturnValue dlt_filter_add(DltFilter *filter,const char *apid,const char *ctid,int verbose); - /** - * Delete filter from filter list - * @param filter pointer to structure of organising DLT filter - * @param apid application id to be deleted from filter list - * @param ctid context id to be deleted from filter list - * @param verbose if set to true verbose information is printed out. - * @return negative value if there was an error - */ - DltReturnValue dlt_filter_delete(DltFilter *filter,const char *apid,const char *ctid,int verbose); - - /** - * Initialise the structure used to access a DLT message. - * This function must be called before using further dlt_message functions. - * @param msg pointer to structure of organising access to DLT messages - * @param verbose if set to true verbose information is printed out. - * @return negative value if there was an error - */ - DltReturnValue dlt_message_init(DltMessage *msg,int verbose); - /** - * Free the used memory by the organising structure of file. - * @param msg pointer to structure of organising access to DLT messages - * @param verbose if set to true verbose information is printed out. - * @return negative value if there was an error - */ - DltReturnValue dlt_message_free(DltMessage *msg,int verbose); - /** - * Print Header into an ASCII string. - * This function calls dlt_message_header_flags() with flags=DLT_HEADER_SHOW_ALL - * @param msg pointer to structure of organising access to DLT messages - * @param text pointer to a ASCII string, in which the header is written - * @param textlength maximal size of text buffer - * @param verbose if set to true verbose information is printed out. - * @return negative value if there was an error - */ - DltReturnValue dlt_message_header(DltMessage *msg,char *text,int textlength,int verbose); - /** - * Print Header into an ASCII string, selective. - * @param msg pointer to structure of organising access to DLT messages - * @param text pointer to a ASCII string, in which the header is written - * @param textlength maximal size of text buffer - * @param flags select, bit-field to select, what should be printed (DLT_HEADER_SHOW_...) - * @param verbose if set to true verbose information is printed out. - * @return negative value if there was an error - */ - DltReturnValue dlt_message_header_flags(DltMessage *msg,char *text,int textlength,int flags, int verbose); - /** - * Print Payload into an ASCII string. - * @param msg pointer to structure of organising access to DLT messages - * @param text pointer to a ASCII string, in which the header is written - * @param textlength maximal size of text buffer - * @param type 1 = payload as hex, 2 = payload as ASCII. - * @param verbose if set to true verbose information is printed out. - * @return negative value if there was an error - */ - DltReturnValue dlt_message_payload(DltMessage *msg,char *text,int textlength,int type,int verbose); - /** - * Check if message is filtered or not. All filters are applied (logical OR). - * @param msg pointer to structure of organising access to DLT messages - * @param filter pointer to filter - * @param verbose if set to true verbose information is printed out. - * @return 1 = filter matches, 0 = filter does not match, negative value if there was an error - */ - DltReturnValue dlt_message_filter_check(DltMessage *msg,DltFilter *filter,int verbose); - - /** - * Read message from memory buffer. - * Message in buffer has no storage header. - * @param msg pointer to structure of organising access to DLT messages - * @param buffer pointer to memory buffer - * @param length length of message in buffer - * @param resync if set to true resync to serial header is enforced - * @param verbose if set to true verbose information is printed out. - * @return negative value if there was an error - */ - int dlt_message_read(DltMessage *msg,uint8_t *buffer,unsigned int length,int resync,int verbose); - - /** - * Get standard header extra parameters - * @param msg pointer to structure of organising access to DLT messages - * @param verbose if set to true verbose information is printed out. - * @return negative value if there was an error - */ - DltReturnValue dlt_message_get_extraparameters(DltMessage *msg,int verbose); - - /** - * Set standard header extra parameters - * @param msg pointer to structure of organising access to DLT messages - * @param verbose if set to true verbose information is printed out. - * @return negative value if there was an error - */ - DltReturnValue dlt_message_set_extraparameters(DltMessage *msg,int verbose); - - /** - * Initialise the structure used to access a DLT file. - * This function must be called before using further dlt_file functions. - * @param file pointer to structure of organising access to DLT file - * @param verbose if set to true verbose information is printed out. - * @return negative value if there was an error - */ - DltReturnValue dlt_file_init(DltFile *file,int verbose); - /** - * Set a list to filters. - * This function should be called before loading a DLT file, if filters should be used. - * A filter list is an array of filters. Several filters are combined logically by or operation. - * The filter list is not copied, so take care to keep list in memory. - * @param file pointer to structure of organising access to DLT file - * @param filter pointer to filter list array - * @param verbose if set to true verbose information is printed out. - * @return negative value if there was an error - */ - DltReturnValue dlt_file_set_filter(DltFile *file,DltFilter *filter,int verbose); - /** - * Initialising loading a DLT file. - * @param file pointer to structure of organising access to DLT file - * @param filename filename of DLT file - * @param verbose if set to true verbose information is printed out. - * @return negative value if there was an error - */ - DltReturnValue dlt_file_open(DltFile *file,const char *filename,int verbose); - /** - * Find next message in the DLT file and parse them. - * This function finds the next message in the DLT file. - * If a filter is set, the filter list is used. - * @param file pointer to structure of organising access to DLT file - * @param verbose if set to true verbose information is printed out. - * @return 0 = message does not match filter, 1 = message was read, negative value if there was an error - */ - DltReturnValue dlt_file_read(DltFile *file,int verbose); - /** - * Find next message in the DLT file in RAW format (without storage header) and parse them. - * This function finds the next message in the DLT file. - * If a filter is set, the filter list is used. - * @param file pointer to structure of organising access to DLT file - * @param resync Resync to serial header when set to true - * @param verbose if set to true verbose information is printed out. - * @return 0 = message does not match filter, 1 = message was read, negative value if there was an error - */ - DltReturnValue dlt_file_read_raw(DltFile *file,int resync,int verbose); - /** - * Closing loading a DLT file. - * @param file pointer to structure of organising access to DLT file - * @param verbose if set to true verbose information is printed out. - * @return negative value if there was an error - */ - DltReturnValue dlt_file_close(DltFile *file,int verbose); - /** - * Load standard header of a message from file - * @param file pointer to structure of organising access to DLT file - * @param verbose if set to true verbose information is printed out. - * @return negative value if there was an error - */ - DltReturnValue dlt_file_read_header(DltFile *file,int verbose); - /** - * Load standard header of a message from file in RAW format (without storage header) - * @param file pointer to structure of organising access to DLT file - * @param resync Resync to serial header when set to true - * @param verbose if set to true verbose information is printed out. - * @return negative value if there was an error - */ - DltReturnValue dlt_file_read_header_raw(DltFile *file,int resync,int verbose); - /** - * Load, if available in message, extra standard header fields and - * extended header of a message from file - * (dlt_file_read_header() must have been called before this call!) - * @param file pointer to structure of organising access to DLT file - * @param verbose if set to true verbose information is printed out. - * @return negative value if there was an error - */ - DltReturnValue dlt_file_read_header_extended(DltFile *file, int verbose); - /** - * Load payload of a message from file - * (dlt_file_read_header() must have been called before this call!) - * @param file pointer to structure of organising access to DLT file - * @param verbose if set to true verbose information is printed out. - * @return negative value if there was an error - */ - DltReturnValue dlt_file_read_data(DltFile *file, int verbose); - /** - * Load headers and payload of a message selected by the index. - * If filters are set, index is based on the filtered list. - * @param file pointer to structure of organising access to DLT file - * @param index position of message in the files beginning from zero - * @param verbose if set to true verbose information is printed out. - * @return number of messages loaded, negative value if there was an error - */ - DltReturnValue dlt_file_message(DltFile *file,int index,int verbose); - /** - * Free the used memory by the organising structure of file. - * @param file pointer to structure of organising access to DLT file - * @param verbose if set to true verbose information is printed out. - * @return negative value if there was an error - */ - DltReturnValue dlt_file_free(DltFile *file,int verbose); - - /** - * Set internal logging filename if mode 2 - * @param filename the filename - */ - void dlt_log_set_filename(const char *filename); - /** - * Set internal logging level - * @param level the level - */ - void dlt_log_set_level(int level); - /** - * Initialize (external) logging facility - * @param mode positive, 0 = log to stdout, 1 = log to syslog, 2 = log to file - */ - void dlt_log_init(int mode); - /** - * Log ASCII string with null-termination to (external) logging facility - * @param prio priority (see syslog() call) - * @param s Pointer to ASCII string with null-termination - * @return negative value if there was an error - */ - DltReturnValue dlt_log(int prio, char *s); - /** - * Log with variable arguments to (external) logging facility (like printf) - * @param prio priority (see syslog() call) - * @param format format string for log message - * @return negative value if there was an error - */ - DltReturnValue dlt_vlog(int prio, const char *format, ...); - /** - * Log size bytes with variable arguments to (external) logging facility (similar to snprintf) - * @param prio priority (see syslog() call) - * @param size number of bytes to log - * @param format format string for log message - * @return negative value if there was an error - */ - DltReturnValue dlt_vnlog(int prio, size_t size, const char *format, ...); - /** - * De-Initialize (external) logging facility - */ - void dlt_log_free(void); - - /** - * Initialising a dlt receiver structure - * @param receiver pointer to dlt receiver structure - * @param _fd handle to file/socket/fifo, fram which the data should be received - * @param _buffersize size of data buffer for storing the received data - * @return negative value if there was an error - */ - DltReturnValue dlt_receiver_init(DltReceiver *receiver,int _fd, int _buffersize); - /** - * De-Initialize a dlt receiver structure - * @param receiver pointer to dlt receiver structure - * @return negative value if there was an error - */ - DltReturnValue dlt_receiver_free(DltReceiver *receiver); - /** - * Initialising a dlt receiver structure - * @param receiver pointer to dlt receiver structure - * @param fd handle to file/socket/fifo, fram which the data should be received - * @param buffer data buffer for storing the received data - * @return negative value if there was an error and zero if success - */ - DltReturnValue dlt_receiver_init_unix_socket(DltReceiver *receiver, int fd, char **buffer); - /** - * De-Initialize a dlt receiver structure - * @param receiver pointer to dlt receiver structure - * @return negative value if there was an error and zero if success - */ - DltReturnValue dlt_receiver_free_unix_socket(DltReceiver *receiver); - /** - * Receive data from socket or file/fifo using the dlt receiver structure - * @param receiver pointer to dlt receiver structure - * @param from_src specify whether received data is from socket or file/fifo - * @return number of received bytes or negative value if there was an error - */ - int dlt_receiver_receive(DltReceiver *receiver, DltReceiverType from_src); - /** - * Remove a specific size of bytes from the received data - * @param receiver pointer to dlt receiver structure - * @param size amount of bytes to be removed - * @return negative value if there was an error - */ - DltReturnValue dlt_receiver_remove(DltReceiver *receiver,int size); - /** - * Move data from last receive call to front of receive buffer - * @param receiver pointer to dlt receiver structure - * @return negative value if there was an error - */ - DltReturnValue dlt_receiver_move_to_begin(DltReceiver *receiver); - - /** - * Check whether to_get amount of data is available in receiver and - * copy it to dest. Skip the DltUserHeader if skip_header is set to 1. - * @param receiver pointer to dlt receiver structure - * @param dest pointer to the destination buffer - * @param to_get size of the data to copy in dest - * @skip_header whether if the DltUserHeader must be skipped. - */ - int dlt_receiver_check_and_get(DltReceiver *receiver, - void *dest, - unsigned int to_get, - unsigned int skip_header); - - /** - * Fill out storage header of a dlt message - * @param storageheader pointer to storage header of a dlt message - * @param ecu name of ecu to be set in storage header - * @return negative value if there was an error - */ - DltReturnValue dlt_set_storageheader(DltStorageHeader *storageheader, const char *ecu); - /** - * Check if a storage header contains its marker - * @param storageheader pointer to storage header of a dlt message - * @return 0 no, 1 yes, negative value if there was an error - */ - DltReturnValue dlt_check_storageheader(DltStorageHeader *storageheader); - - - /** - * Initialise static ringbuffer with a size of size. - * Initialise as server. Init counters. - * Memory is already allocated. - * @param buf Pointer to ringbuffer structure - * @param ptr Ptr to ringbuffer memory - * @param size Maximum size of buffer in bytes - * @return negative value if there was an error - */ - DltReturnValue dlt_buffer_init_static_server(DltBuffer *buf, const unsigned char *ptr, uint32_t size); - - /** - * Initialize static ringbuffer with a size of size. - * Initialise as a client. Do not change counters. - * Memory is already allocated. - * @param buf Pointer to ringbuffer structure - * @param ptr Ptr to ringbuffer memory - * @param size Maximum size of buffer in bytes - * @return negative value if there was an error - */ - DltReturnValue dlt_buffer_init_static_client(DltBuffer *buf, const unsigned char *ptr, uint32_t size); - - /** - * Initialize dynamic ringbuffer with a size of size. - * Initialise as a client. Do not change counters. - * Memory will be allocated starting with min_size. - * If more memory is needed size is increased wit step_size. - * The maximum size is max_size. - * @param buf Pointer to ringbuffer structure - * @param min_size Minimum size of buffer in bytes - * @param max_size Maximum size of buffer in bytes - * @param step_size size of which ringbuffer is increased - * @return negative value if there was an error - */ - DltReturnValue dlt_buffer_init_dynamic(DltBuffer *buf, uint32_t min_size, uint32_t max_size,uint32_t step_size); - - /** - * Deinitilaise usage of static ringbuffer - * @param buf Pointer to ringbuffer structure - * @return negative value if there was an error - */ - DltReturnValue dlt_buffer_free_static(DltBuffer *buf); - - /** - * Release and free memory used by dynamic ringbuffer - * @param buf Pointer to ringbuffer structure - * @return negative value if there was an error - */ - DltReturnValue dlt_buffer_free_dynamic(DltBuffer *buf); - - /** - * Check if message fits into buffer. - * @param buf Pointer to buffer structure - * @return DLT_RETURN_OK if enough space, DLT_RETURN_ERROR otherwise - */ - DltReturnValue dlt_buffer_check_size(DltBuffer *buf, int needed); - - /** - * Write one entry to ringbuffer - * @param buf Pointer to ringbuffer structure - * @param data Pointer to data to be written to ringbuffer - * @param size Size of data in bytes to be written to ringbuffer - * @return negative value if there was an error - */ - DltReturnValue dlt_buffer_push(DltBuffer *buf,const unsigned char *data,unsigned int size); - - /** - * Write up to three entries to ringbuffer. - * Entries are joined to one block. - * @param dlt Pointer to ringbuffer structure - * @param data1 Pointer to data to be written to ringbuffer - * @param size1 Size of data in bytes to be written to ringbuffer - * @param data2 Pointer to data to be written to ringbuffer - * @param size2 Size of data in bytes to be written to ringbuffer - * @param data3 Pointer to data to be written to ringbuffer - * @param size3 Size of data in bytes to be written to ringbuffer - * @return negative value if there was an error - */ - DltReturnValue dlt_buffer_push3(DltBuffer *buf,const unsigned char *data1,unsigned int size1,const unsigned char *data2,unsigned int size2,const unsigned char *data3,unsigned int size3); - - /** - * Read one entry from ringbuffer. - * Remove it from ringbuffer. - * @param buf Pointer to ringbuffer structure - * @param data Pointer to data read from ringbuffer - * @param max_size Max size of read data in bytes from ringbuffer - * @return size of read data, zero if no data available, negative value if there was an error - */ - int dlt_buffer_pull(DltBuffer *buf,unsigned char *data, int max_size); - - /** - * Read one entry from ringbuffer. - * Do not remove it from ringbuffer. - * @param buf Pointer to ringbuffer structure - * @param data Pointer to data read from ringbuffer - * @param max_size Max size of read data in bytes from ringbuffer - * @return size of read data, zero if no data available, negative value if there was an error - */ - int dlt_buffer_copy(DltBuffer *buf,unsigned char *data, int max_size); - - /** - * Remove entry from ringbuffer. - * @param buf Pointer to ringbuffer structure - * @return size of read data, zero if no data available, negative value if there was an error - */ - int dlt_buffer_remove(DltBuffer *buf); - - /** - * Print information about buffer and log to internal DLT log. - * @param buf Pointer to ringbuffer structure - */ - void dlt_buffer_info(DltBuffer *buf); - - /** - * Print status of buffer and log to internal DLT log. - * @param buf Pointer to ringbuffer structure - */ - void dlt_buffer_status(DltBuffer *buf); - - /** - * Get total size in bytes of ringbuffer. - * If buffer is dynamic, max size is returned. - * @param buf Pointer to ringbuffer structure - * @return total size of buffer - */ - uint32_t dlt_buffer_get_total_size(DltBuffer *buf); - - /** - * Get used size in bytes of ringbuffer. - * @param buf Pointer to ringbuffer structure - * @return used size of buffer - */ - int dlt_buffer_get_used_size(DltBuffer *buf); - - /** - * Get number of entries in ringbuffer. - * @param buf Pointer to ringbuffer structure - * @return number of entries - */ - int dlt_buffer_get_message_count(DltBuffer *buf); - -#if !defined (__WIN32__) - - /** - * Helper function: Setup serial connection - * @param fd File descriptor of serial tty device - * @param speed Serial line speed, as defined in termios.h - * @return negative value if there was an error - */ - DltReturnValue dlt_setup_serial(int fd, speed_t speed); - - /** - * Helper function: Convert serial line baudrate (as number) to line speed (as defined in termios.h) - * @param baudrate Serial line baudrate (as number) - * @return Serial line speed, as defined in termios.h - */ - speed_t dlt_convert_serial_speed(int baudrate); - - /** - * Print dlt version and dlt svn version to buffer - * @param buf Pointer to buffer - * @param size size of buffer - */ - void dlt_get_version(char *buf, size_t size); - - /** - * Print dlt major version to buffer - * @param buf Pointer to buffer - * @param size size of buffer - */ - void dlt_get_major_version(char *buf, size_t size); - - /** - * Print dlt minor version to buffer - * @param buf Pointer to buffer - * @param size size of buffer - */ - void dlt_get_minor_version(char *buf, size_t size); - -#endif - - /* Function prototypes which should be used only internally */ - /* */ - - /** - * Common part of initialisation - * @return negative value if there was an error - */ - DltReturnValue dlt_init_common(void); - - /** - * Return the uptime of the system in 0.1 ms resolution - * @return 0 if there was an error - */ - uint32_t dlt_uptime(void); - - /** - * Print header of a DLT message - * @param message pointer to structure of organising access to DLT messages - * @param text pointer to a ASCII string, in which the header is written - * @param size maximal size of text buffer - * @param verbose if set to true verbose information is printed out. - * @return negative value if there was an error - */ - DltReturnValue dlt_message_print_header(DltMessage *message, char *text, uint32_t size, int verbose); - - /** - * Print payload of a DLT message as Hex-Output - * @param message pointer to structure of organising access to DLT messages - * @param text pointer to a ASCII string, in which the output is written - * @param size maximal size of text buffer - * @param verbose if set to true verbose information is printed out. - * @return negative value if there was an error - */ - DltReturnValue dlt_message_print_hex(DltMessage *message, char *text, uint32_t size, int verbose); - - /** - * Print payload of a DLT message as ASCII-Output - * @param message pointer to structure of organising access to DLT messages - * @param text pointer to a ASCII string, in which the output is written - * @param size maximal size of text buffer - * @param verbose if set to true verbose information is printed out. - * @return negative value if there was an error - */ - DltReturnValue dlt_message_print_ascii(DltMessage *message, char *text, uint32_t size, int verbose); - - /** - * Print payload of a DLT message as Mixed-Ouput (Hex and ASCII), for plain text output - * @param message pointer to structure of organising access to DLT messages - * @param text pointer to a ASCII string, in which the output is written - * @param size maximal size of text buffer - * @param verbose if set to true verbose information is printed out. - * @return negative value if there was an error - */ - DltReturnValue dlt_message_print_mixed_plain(DltMessage *message, char *text, uint32_t size, int verbose); - - /** - * Print payload of a DLT message as Mixed-Ouput (Hex and ASCII), for HTML text output - * @param message pointer to structure of organising access to DLT messages - * @param text pointer to a ASCII string, in which the output is written - * @param size maximal size of text buffer - * @param verbose if set to true verbose information is printed out. - * @return negative value if there was an error - */ - DltReturnValue dlt_message_print_mixed_html(DltMessage *message, char *text, uint32_t size, int verbose); - - /** - * Decode and print a argument of a DLT message - * @param msg pointer to structure of organising access to DLT messages - * @param type_info Type of argument - * @param ptr pointer to pointer to data (pointer to data is changed within this function) - * @param datalength pointer to datalength (datalength is changed within this function) - * @param text pointer to a ASCII string, in which the output is written - * @param textlength maximal size of text buffer - * @param byteLength If argument is a string, and this value is 0 or greater, this value will be taken as string length - * @param verbose if set to true verbose information is printed out. - * @return negative value if there was an error - */ - DltReturnValue dlt_message_argument_print(DltMessage *msg,uint32_t type_info,uint8_t **ptr,int32_t *datalength,char *text,int textlength,int byteLength,int verbose); - - /** - * Check environment variables. - */ - void dlt_check_envvar(); - - /** - * Parse the response text and identifying service id and its options. - * - * @param resp_text char * - * @param service_id int * - * @param service_opt int * - * @return pointer to resp_text - */ - int dlt_set_loginfo_parse_service_id(char *resp_text, uint32_t *service_id, uint8_t *service_opt); - - /** - * Convert get log info from ASCII to uint16 - * - * @param rp char - * @param rp_count int - * @return length - */ - int16_t dlt_getloginfo_conv_ascii_to_uint16_t(char *rp, int *rp_count); - - /** - * Convert get log info from ASCII to int16 - * - * @param rp char - * @param rp_count int - * @return length - */ - int16_t dlt_getloginfo_conv_ascii_to_int16_t(char *rp, int *rp_count); - - /** - * Convert get log info from ASCII to ID - * - * @param rp char - * @param rp_count int - * @param wp char - * @param length int - */ - void dlt_getloginfo_conv_ascii_to_id(char *rp, int *rp_count, char *wp, int len); - - /** - * Convert from hex ASCII to binary - * @param ptr const char - * @param binary uint8_t - * @param size int - */ - void dlt_hex_ascii_to_binary(const char *ptr, uint8_t *binary, int *size); - -#ifndef DLT_USE_UNIX_SOCKET_IPC - /** - * Create the specified path, recursive if necessary - * behaves like calling mkdir -p <dir> on the console - */ - int dlt_mkdir_recursive(const char *dir); -#endif - -#ifdef __cplusplus +# endif + +/** + * Helper function to print a byte array in hex. + * @param ptr pointer to the byte array. + * @param size number of bytes to be printed. + */ +void dlt_print_hex(uint8_t *ptr, int size); +/** + * Helper function to print a byte array in hex into a string. + * @param text pointer to a ASCII string, in which the text is written + * @param textlength maximal size of text buffer + * @param ptr pointer to the byte array. + * @param size number of bytes to be printed. + * @return negative value if there was an error + */ +DltReturnValue dlt_print_hex_string(char *text, int textlength, uint8_t *ptr, int size); +/** + * Helper function to print a byte array in hex and ascii into a string. + * @param text pointer to a ASCII string, in which the text is written + * @param textlength maximal size of text buffer + * @param ptr pointer to the byte array. + * @param size number of bytes to be printed. + * @param html output is html? 0 - false, 1 - true + * @return negative value if there was an error + */ +DltReturnValue dlt_print_mixed_string(char *text, int textlength, uint8_t *ptr, int size, int html); +/** + * Helper function to print a byte array in ascii into a string. + * @param text pointer to a ASCII string, in which the text is written + * @param textlength maximal size of text buffer + * @param ptr pointer to the byte array. + * @param size number of bytes to be printed. + * @return negative value if there was an error + */ +DltReturnValue dlt_print_char_string(char **text, int textlength, uint8_t *ptr, int size); + +/** + * Helper function to print an id. + * @param text pointer to ASCII string where to write the id + * @param id four byte char array as used in DLT mesages as IDs. + */ +void dlt_print_id(char *text, const char *id); + +/** + * Helper function to set an ID parameter. + * @param id four byte char array as used in DLT mesages as IDs. + * @param text string to be copied into char array. + */ +void dlt_set_id(char *id, const char *text); + +/** + * Helper function to remove not nice to print characters, e.g. NULL or carage return. + * @param text pointer to string to be cleaned. + * @param length length of string excluding terminating zero. + */ +void dlt_clean_string(char *text, int length); + +/** + * Initialise the filter list. + * This function must be called before using further dlt filter. + * @param filter pointer to structure of organising DLT filter + * @param verbose if set to true verbose information is printed out. + * @return negative value if there was an error + */ +DltReturnValue dlt_filter_init(DltFilter *filter, int verbose); +/** + * Free the used memory by the organising structure of filter. + * @param filter pointer to structure of organising DLT filter + * @param verbose if set to true verbose information is printed out. + * @return negative value if there was an error + */ +DltReturnValue dlt_filter_free(DltFilter *filter, int verbose); +/** + * Load filter list from file. + * @param filter pointer to structure of organising DLT filter + * @param filename filename to load filters from + * @param verbose if set to true verbose information is printed out. + * @return negative value if there was an error + */ +DltReturnValue dlt_filter_load(DltFilter *filter, const char *filename, int verbose); +/** + * Save filter list to file. + * @param filter pointer to structure of organising DLT filter + * @param filename filename to load filters from + * @param verbose if set to true verbose information is printed out. + * @return negative value if there was an error + */ +DltReturnValue dlt_filter_save(DltFilter *filter, const char *filename, int verbose); +/** + * Find index of filter in filter list + * @param filter pointer to structure of organising DLT filter + * @param apid application id to be found in filter list + * @param ctid context id to be found in filter list + * @param verbose if set to true verbose information is printed out. + * @return negative value if there was an error (or not found), else return index of filter + */ +int dlt_filter_find(DltFilter *filter, const char *apid, const char *ctid, int verbose); +/** + * Add new filter to filter list. + * @param filter pointer to structure of organising DLT filter + * @param apid application id to be added to filter list (must always be set). + * @param ctid context id to be added to filter list. empty equals don't care. + * @param verbose if set to true verbose information is printed out. + * @return negative value if there was an error + */ +DltReturnValue dlt_filter_add(DltFilter *filter, const char *apid, const char *ctid, int verbose); +/** + * Delete filter from filter list + * @param filter pointer to structure of organising DLT filter + * @param apid application id to be deleted from filter list + * @param ctid context id to be deleted from filter list + * @param verbose if set to true verbose information is printed out. + * @return negative value if there was an error + */ +DltReturnValue dlt_filter_delete(DltFilter *filter, const char *apid, const char *ctid, int verbose); + +/** + * Initialise the structure used to access a DLT message. + * This function must be called before using further dlt_message functions. + * @param msg pointer to structure of organising access to DLT messages + * @param verbose if set to true verbose information is printed out. + * @return negative value if there was an error + */ +DltReturnValue dlt_message_init(DltMessage *msg, int verbose); +/** + * Free the used memory by the organising structure of file. + * @param msg pointer to structure of organising access to DLT messages + * @param verbose if set to true verbose information is printed out. + * @return negative value if there was an error + */ +DltReturnValue dlt_message_free(DltMessage *msg, int verbose); +/** + * Print Header into an ASCII string. + * This function calls dlt_message_header_flags() with flags=DLT_HEADER_SHOW_ALL + * @param msg pointer to structure of organising access to DLT messages + * @param text pointer to a ASCII string, in which the header is written + * @param textlength maximal size of text buffer + * @param verbose if set to true verbose information is printed out. + * @return negative value if there was an error + */ +DltReturnValue dlt_message_header(DltMessage *msg, char *text, int textlength, int verbose); +/** + * Print Header into an ASCII string, selective. + * @param msg pointer to structure of organising access to DLT messages + * @param text pointer to a ASCII string, in which the header is written + * @param textlength maximal size of text buffer + * @param flags select, bit-field to select, what should be printed (DLT_HEADER_SHOW_...) + * @param verbose if set to true verbose information is printed out. + * @return negative value if there was an error + */ +DltReturnValue dlt_message_header_flags(DltMessage *msg, char *text, int textlength, int flags, int verbose); +/** + * Print Payload into an ASCII string. + * @param msg pointer to structure of organising access to DLT messages + * @param text pointer to a ASCII string, in which the header is written + * @param textlength maximal size of text buffer + * @param type 1 = payload as hex, 2 = payload as ASCII. + * @param verbose if set to true verbose information is printed out. + * @return negative value if there was an error + */ +DltReturnValue dlt_message_payload(DltMessage *msg, char *text, int textlength, int type, int verbose); +/** + * Check if message is filtered or not. All filters are applied (logical OR). + * @param msg pointer to structure of organising access to DLT messages + * @param filter pointer to filter + * @param verbose if set to true verbose information is printed out. + * @return 1 = filter matches, 0 = filter does not match, negative value if there was an error + */ +DltReturnValue dlt_message_filter_check(DltMessage *msg, DltFilter *filter, int verbose); + +/** + * Read message from memory buffer. + * Message in buffer has no storage header. + * @param msg pointer to structure of organising access to DLT messages + * @param buffer pointer to memory buffer + * @param length length of message in buffer + * @param resync if set to true resync to serial header is enforced + * @param verbose if set to true verbose information is printed out. + * @return negative value if there was an error + */ +int dlt_message_read(DltMessage *msg, uint8_t *buffer, unsigned int length, int resync, int verbose); + +/** + * Get standard header extra parameters + * @param msg pointer to structure of organising access to DLT messages + * @param verbose if set to true verbose information is printed out. + * @return negative value if there was an error + */ +DltReturnValue dlt_message_get_extraparameters(DltMessage *msg, int verbose); + +/** + * Set standard header extra parameters + * @param msg pointer to structure of organising access to DLT messages + * @param verbose if set to true verbose information is printed out. + * @return negative value if there was an error + */ +DltReturnValue dlt_message_set_extraparameters(DltMessage *msg, int verbose); + +/** + * Initialise the structure used to access a DLT file. + * This function must be called before using further dlt_file functions. + * @param file pointer to structure of organising access to DLT file + * @param verbose if set to true verbose information is printed out. + * @return negative value if there was an error + */ +DltReturnValue dlt_file_init(DltFile *file, int verbose); +/** + * Set a list to filters. + * This function should be called before loading a DLT file, if filters should be used. + * A filter list is an array of filters. Several filters are combined logically by or operation. + * The filter list is not copied, so take care to keep list in memory. + * @param file pointer to structure of organising access to DLT file + * @param filter pointer to filter list array + * @param verbose if set to true verbose information is printed out. + * @return negative value if there was an error + */ +DltReturnValue dlt_file_set_filter(DltFile *file, DltFilter *filter, int verbose); +/** + * Initialising loading a DLT file. + * @param file pointer to structure of organising access to DLT file + * @param filename filename of DLT file + * @param verbose if set to true verbose information is printed out. + * @return negative value if there was an error + */ +DltReturnValue dlt_file_open(DltFile *file, const char *filename, int verbose); +/** + * Find next message in the DLT file and parse them. + * This function finds the next message in the DLT file. + * If a filter is set, the filter list is used. + * @param file pointer to structure of organising access to DLT file + * @param verbose if set to true verbose information is printed out. + * @return 0 = message does not match filter, 1 = message was read, negative value if there was an error + */ +DltReturnValue dlt_file_read(DltFile *file, int verbose); +/** + * Find next message in the DLT file in RAW format (without storage header) and parse them. + * This function finds the next message in the DLT file. + * If a filter is set, the filter list is used. + * @param file pointer to structure of organising access to DLT file + * @param resync Resync to serial header when set to true + * @param verbose if set to true verbose information is printed out. + * @return 0 = message does not match filter, 1 = message was read, negative value if there was an error + */ +DltReturnValue dlt_file_read_raw(DltFile *file, int resync, int verbose); +/** + * Closing loading a DLT file. + * @param file pointer to structure of organising access to DLT file + * @param verbose if set to true verbose information is printed out. + * @return negative value if there was an error + */ +DltReturnValue dlt_file_close(DltFile *file, int verbose); +/** + * Load standard header of a message from file + * @param file pointer to structure of organising access to DLT file + * @param verbose if set to true verbose information is printed out. + * @return negative value if there was an error + */ +DltReturnValue dlt_file_read_header(DltFile *file, int verbose); +/** + * Load standard header of a message from file in RAW format (without storage header) + * @param file pointer to structure of organising access to DLT file + * @param resync Resync to serial header when set to true + * @param verbose if set to true verbose information is printed out. + * @return negative value if there was an error + */ +DltReturnValue dlt_file_read_header_raw(DltFile *file, int resync, int verbose); +/** + * Load, if available in message, extra standard header fields and + * extended header of a message from file + * (dlt_file_read_header() must have been called before this call!) + * @param file pointer to structure of organising access to DLT file + * @param verbose if set to true verbose information is printed out. + * @return negative value if there was an error + */ +DltReturnValue dlt_file_read_header_extended(DltFile *file, int verbose); +/** + * Load payload of a message from file + * (dlt_file_read_header() must have been called before this call!) + * @param file pointer to structure of organising access to DLT file + * @param verbose if set to true verbose information is printed out. + * @return negative value if there was an error + */ +DltReturnValue dlt_file_read_data(DltFile *file, int verbose); +/** + * Load headers and payload of a message selected by the index. + * If filters are set, index is based on the filtered list. + * @param file pointer to structure of organising access to DLT file + * @param index position of message in the files beginning from zero + * @param verbose if set to true verbose information is printed out. + * @return number of messages loaded, negative value if there was an error + */ +DltReturnValue dlt_file_message(DltFile *file, int index, int verbose); +/** + * Free the used memory by the organising structure of file. + * @param file pointer to structure of organising access to DLT file + * @param verbose if set to true verbose information is printed out. + * @return negative value if there was an error + */ +DltReturnValue dlt_file_free(DltFile *file, int verbose); + +/** + * Set internal logging filename if mode 2 + * @param filename the filename + */ +void dlt_log_set_filename(const char *filename); +/** + * Set internal logging level + * @param level the level + */ +void dlt_log_set_level(int level); +/** + * Initialize (external) logging facility + * @param mode positive, 0 = log to stdout, 1 = log to syslog, 2 = log to file + */ +void dlt_log_init(int mode); +/** + * Log ASCII string with null-termination to (external) logging facility + * @param prio priority (see syslog() call) + * @param s Pointer to ASCII string with null-termination + * @return negative value if there was an error + */ +DltReturnValue dlt_log(int prio, char *s); +/** + * Log with variable arguments to (external) logging facility (like printf) + * @param prio priority (see syslog() call) + * @param format format string for log message + * @return negative value if there was an error + */ +DltReturnValue dlt_vlog(int prio, const char *format, ...); +/** + * Log size bytes with variable arguments to (external) logging facility (similar to snprintf) + * @param prio priority (see syslog() call) + * @param size number of bytes to log + * @param format format string for log message + * @return negative value if there was an error + */ +DltReturnValue dlt_vnlog(int prio, size_t size, const char *format, ...); +/** + * De-Initialize (external) logging facility + */ +void dlt_log_free(void); + +/** + * Initialising a dlt receiver structure + * @param receiver pointer to dlt receiver structure + * @param _fd handle to file/socket/fifo, fram which the data should be received + * @param _buffersize size of data buffer for storing the received data + * @return negative value if there was an error + */ +DltReturnValue dlt_receiver_init(DltReceiver *receiver, int _fd, int _buffersize); +/** + * De-Initialize a dlt receiver structure + * @param receiver pointer to dlt receiver structure + * @return negative value if there was an error + */ +DltReturnValue dlt_receiver_free(DltReceiver *receiver); +/** + * Initialising a dlt receiver structure + * @param receiver pointer to dlt receiver structure + * @param fd handle to file/socket/fifo, fram which the data should be received + * @param buffer data buffer for storing the received data + * @return negative value if there was an error and zero if success + */ +DltReturnValue dlt_receiver_init_unix_socket(DltReceiver *receiver, int fd, char **buffer); +/** + * De-Initialize a dlt receiver structure + * @param receiver pointer to dlt receiver structure + * @return negative value if there was an error and zero if success + */ +DltReturnValue dlt_receiver_free_unix_socket(DltReceiver *receiver); +/** + * Receive data from socket or file/fifo using the dlt receiver structure + * @param receiver pointer to dlt receiver structure + * @param from_src specify whether received data is from socket or file/fifo + * @return number of received bytes or negative value if there was an error + */ +int dlt_receiver_receive(DltReceiver *receiver, DltReceiverType from_src); +/** + * Remove a specific size of bytes from the received data + * @param receiver pointer to dlt receiver structure + * @param size amount of bytes to be removed + * @return negative value if there was an error + */ +DltReturnValue dlt_receiver_remove(DltReceiver *receiver, int size); +/** + * Move data from last receive call to front of receive buffer + * @param receiver pointer to dlt receiver structure + * @return negative value if there was an error + */ +DltReturnValue dlt_receiver_move_to_begin(DltReceiver *receiver); + +/** + * Check whether to_get amount of data is available in receiver and + * copy it to dest. Skip the DltUserHeader if skip_header is set to 1. + * @param receiver pointer to dlt receiver structure + * @param dest pointer to the destination buffer + * @param to_get size of the data to copy in dest + * @skip_header whether if the DltUserHeader must be skipped. + */ +int dlt_receiver_check_and_get(DltReceiver *receiver, + void *dest, + unsigned int to_get, + unsigned int skip_header); + +/** + * Fill out storage header of a dlt message + * @param storageheader pointer to storage header of a dlt message + * @param ecu name of ecu to be set in storage header + * @return negative value if there was an error + */ +DltReturnValue dlt_set_storageheader(DltStorageHeader *storageheader, const char *ecu); +/** + * Check if a storage header contains its marker + * @param storageheader pointer to storage header of a dlt message + * @return 0 no, 1 yes, negative value if there was an error + */ +DltReturnValue dlt_check_storageheader(DltStorageHeader *storageheader); + + +/** + * Initialise static ringbuffer with a size of size. + * Initialise as server. Init counters. + * Memory is already allocated. + * @param buf Pointer to ringbuffer structure + * @param ptr Ptr to ringbuffer memory + * @param size Maximum size of buffer in bytes + * @return negative value if there was an error + */ +DltReturnValue dlt_buffer_init_static_server(DltBuffer *buf, const unsigned char *ptr, uint32_t size); + +/** + * Initialize static ringbuffer with a size of size. + * Initialise as a client. Do not change counters. + * Memory is already allocated. + * @param buf Pointer to ringbuffer structure + * @param ptr Ptr to ringbuffer memory + * @param size Maximum size of buffer in bytes + * @return negative value if there was an error + */ +DltReturnValue dlt_buffer_init_static_client(DltBuffer *buf, const unsigned char *ptr, uint32_t size); + +/** + * Initialize dynamic ringbuffer with a size of size. + * Initialise as a client. Do not change counters. + * Memory will be allocated starting with min_size. + * If more memory is needed size is increased wit step_size. + * The maximum size is max_size. + * @param buf Pointer to ringbuffer structure + * @param min_size Minimum size of buffer in bytes + * @param max_size Maximum size of buffer in bytes + * @param step_size size of which ringbuffer is increased + * @return negative value if there was an error + */ +DltReturnValue dlt_buffer_init_dynamic(DltBuffer *buf, uint32_t min_size, uint32_t max_size, uint32_t step_size); + +/** + * Deinitilaise usage of static ringbuffer + * @param buf Pointer to ringbuffer structure + * @return negative value if there was an error + */ +DltReturnValue dlt_buffer_free_static(DltBuffer *buf); + +/** + * Release and free memory used by dynamic ringbuffer + * @param buf Pointer to ringbuffer structure + * @return negative value if there was an error + */ +DltReturnValue dlt_buffer_free_dynamic(DltBuffer *buf); + +/** + * Check if message fits into buffer. + * @param buf Pointer to buffer structure + * @return DLT_RETURN_OK if enough space, DLT_RETURN_ERROR otherwise + */ +DltReturnValue dlt_buffer_check_size(DltBuffer *buf, int needed); + +/** + * Write one entry to ringbuffer + * @param buf Pointer to ringbuffer structure + * @param data Pointer to data to be written to ringbuffer + * @param size Size of data in bytes to be written to ringbuffer + * @return negative value if there was an error + */ +DltReturnValue dlt_buffer_push(DltBuffer *buf, const unsigned char *data, unsigned int size); + +/** + * Write up to three entries to ringbuffer. + * Entries are joined to one block. + * @param dlt Pointer to ringbuffer structure + * @param data1 Pointer to data to be written to ringbuffer + * @param size1 Size of data in bytes to be written to ringbuffer + * @param data2 Pointer to data to be written to ringbuffer + * @param size2 Size of data in bytes to be written to ringbuffer + * @param data3 Pointer to data to be written to ringbuffer + * @param size3 Size of data in bytes to be written to ringbuffer + * @return negative value if there was an error + */ +DltReturnValue dlt_buffer_push3(DltBuffer *buf, + const unsigned char *data1, + unsigned int size1, + const unsigned char *data2, + unsigned int size2, + const unsigned char *data3, + unsigned int size3); + +/** + * Read one entry from ringbuffer. + * Remove it from ringbuffer. + * @param buf Pointer to ringbuffer structure + * @param data Pointer to data read from ringbuffer + * @param max_size Max size of read data in bytes from ringbuffer + * @return size of read data, zero if no data available, negative value if there was an error + */ +int dlt_buffer_pull(DltBuffer *buf, unsigned char *data, int max_size); + +/** + * Read one entry from ringbuffer. + * Do not remove it from ringbuffer. + * @param buf Pointer to ringbuffer structure + * @param data Pointer to data read from ringbuffer + * @param max_size Max size of read data in bytes from ringbuffer + * @return size of read data, zero if no data available, negative value if there was an error + */ +int dlt_buffer_copy(DltBuffer *buf, unsigned char *data, int max_size); + +/** + * Remove entry from ringbuffer. + * @param buf Pointer to ringbuffer structure + * @return size of read data, zero if no data available, negative value if there was an error + */ +int dlt_buffer_remove(DltBuffer *buf); + +/** + * Print information about buffer and log to internal DLT log. + * @param buf Pointer to ringbuffer structure + */ +void dlt_buffer_info(DltBuffer *buf); + +/** + * Print status of buffer and log to internal DLT log. + * @param buf Pointer to ringbuffer structure + */ +void dlt_buffer_status(DltBuffer *buf); + +/** + * Get total size in bytes of ringbuffer. + * If buffer is dynamic, max size is returned. + * @param buf Pointer to ringbuffer structure + * @return total size of buffer + */ +uint32_t dlt_buffer_get_total_size(DltBuffer *buf); + +/** + * Get used size in bytes of ringbuffer. + * @param buf Pointer to ringbuffer structure + * @return used size of buffer + */ +int dlt_buffer_get_used_size(DltBuffer *buf); + +/** + * Get number of entries in ringbuffer. + * @param buf Pointer to ringbuffer structure + * @return number of entries + */ +int dlt_buffer_get_message_count(DltBuffer *buf); + +# if !defined (__WIN32__) + +/** + * Helper function: Setup serial connection + * @param fd File descriptor of serial tty device + * @param speed Serial line speed, as defined in termios.h + * @return negative value if there was an error + */ +DltReturnValue dlt_setup_serial(int fd, speed_t speed); + +/** + * Helper function: Convert serial line baudrate (as number) to line speed (as defined in termios.h) + * @param baudrate Serial line baudrate (as number) + * @return Serial line speed, as defined in termios.h + */ +speed_t dlt_convert_serial_speed(int baudrate); + +/** + * Print dlt version and dlt svn version to buffer + * @param buf Pointer to buffer + * @param size size of buffer + */ +void dlt_get_version(char *buf, size_t size); + +/** + * Print dlt major version to buffer + * @param buf Pointer to buffer + * @param size size of buffer + */ +void dlt_get_major_version(char *buf, size_t size); + +/** + * Print dlt minor version to buffer + * @param buf Pointer to buffer + * @param size size of buffer + */ +void dlt_get_minor_version(char *buf, size_t size); + +# endif + +/* Function prototypes which should be used only internally */ +/* */ + +/** + * Common part of initialisation + * @return negative value if there was an error + */ +DltReturnValue dlt_init_common(void); + +/** + * Return the uptime of the system in 0.1 ms resolution + * @return 0 if there was an error + */ +uint32_t dlt_uptime(void); + +/** + * Print header of a DLT message + * @param message pointer to structure of organising access to DLT messages + * @param text pointer to a ASCII string, in which the header is written + * @param size maximal size of text buffer + * @param verbose if set to true verbose information is printed out. + * @return negative value if there was an error + */ +DltReturnValue dlt_message_print_header(DltMessage *message, char *text, uint32_t size, int verbose); + +/** + * Print payload of a DLT message as Hex-Output + * @param message pointer to structure of organising access to DLT messages + * @param text pointer to a ASCII string, in which the output is written + * @param size maximal size of text buffer + * @param verbose if set to true verbose information is printed out. + * @return negative value if there was an error + */ +DltReturnValue dlt_message_print_hex(DltMessage *message, char *text, uint32_t size, int verbose); + +/** + * Print payload of a DLT message as ASCII-Output + * @param message pointer to structure of organising access to DLT messages + * @param text pointer to a ASCII string, in which the output is written + * @param size maximal size of text buffer + * @param verbose if set to true verbose information is printed out. + * @return negative value if there was an error + */ +DltReturnValue dlt_message_print_ascii(DltMessage *message, char *text, uint32_t size, int verbose); + +/** + * Print payload of a DLT message as Mixed-Ouput (Hex and ASCII), for plain text output + * @param message pointer to structure of organising access to DLT messages + * @param text pointer to a ASCII string, in which the output is written + * @param size maximal size of text buffer + * @param verbose if set to true verbose information is printed out. + * @return negative value if there was an error + */ +DltReturnValue dlt_message_print_mixed_plain(DltMessage *message, char *text, uint32_t size, int verbose); + +/** + * Print payload of a DLT message as Mixed-Ouput (Hex and ASCII), for HTML text output + * @param message pointer to structure of organising access to DLT messages + * @param text pointer to a ASCII string, in which the output is written + * @param size maximal size of text buffer + * @param verbose if set to true verbose information is printed out. + * @return negative value if there was an error + */ +DltReturnValue dlt_message_print_mixed_html(DltMessage *message, char *text, uint32_t size, int verbose); + +/** + * Decode and print a argument of a DLT message + * @param msg pointer to structure of organising access to DLT messages + * @param type_info Type of argument + * @param ptr pointer to pointer to data (pointer to data is changed within this function) + * @param datalength pointer to datalength (datalength is changed within this function) + * @param text pointer to a ASCII string, in which the output is written + * @param textlength maximal size of text buffer + * @param byteLength If argument is a string, and this value is 0 or greater, this value will be taken as string length + * @param verbose if set to true verbose information is printed out. + * @return negative value if there was an error + */ +DltReturnValue dlt_message_argument_print(DltMessage *msg, + uint32_t type_info, + uint8_t **ptr, + int32_t *datalength, + char *text, + int textlength, + int byteLength, + int verbose); + +/** + * Check environment variables. + */ +void dlt_check_envvar(); + +/** + * Parse the response text and identifying service id and its options. + * + * @param resp_text char * + * @param service_id int * + * @param service_opt int * + * @return pointer to resp_text + */ +int dlt_set_loginfo_parse_service_id(char *resp_text, uint32_t *service_id, uint8_t *service_opt); + +/** + * Convert get log info from ASCII to uint16 + * + * @param rp char + * @param rp_count int + * @return length + */ +int16_t dlt_getloginfo_conv_ascii_to_uint16_t(char *rp, int *rp_count); + +/** + * Convert get log info from ASCII to int16 + * + * @param rp char + * @param rp_count int + * @return length + */ +int16_t dlt_getloginfo_conv_ascii_to_int16_t(char *rp, int *rp_count); + +/** + * Convert get log info from ASCII to ID + * + * @param rp char + * @param rp_count int + * @param wp char + * @param length int + */ +void dlt_getloginfo_conv_ascii_to_id(char *rp, int *rp_count, char *wp, int len); + +/** + * Convert from hex ASCII to binary + * @param ptr const char + * @param binary uint8_t + * @param size int + */ +void dlt_hex_ascii_to_binary(const char *ptr, uint8_t *binary, int *size); + +# ifndef DLT_USE_UNIX_SOCKET_IPC +/** + * Create the specified path, recursive if necessary + * behaves like calling mkdir -p <dir> on the console + */ +int dlt_mkdir_recursive(const char *dir); +# endif + +# ifdef __cplusplus } -#endif +# endif /** - \} -*/ + \} + */ #endif /* DLT_COMMON_H */ |