Wireshark 4.7.3
The Wireshark network protocol analyzer
Loading...
Searching...
No Matches
blf.h File Reference
#include "wtap.h"

Go to the source code of this file.

Classes

struct  blf_date
 Represents a date and time value as used in BLF file headers. More...
struct  blf_fileheader
 Top-level file header for a BLF (Binary Logging Format) capture file. More...
struct  blf_blockheader
 Common block header preceding every object in a BLF file. More...
struct  blf_logcontainerheader
 Header for a BLF log container object, which wraps a block of compressed or uncompressed log data. More...
struct  blf_logobjectheader
 Standard log object header (type 1) carrying a single timestamp. More...
struct  blf_logobjectheader2
 Extended log object header (type 2) carrying both an object timestamp and an original hardware timestamp. More...
struct  blf_logobjectheader3
 Compact log object header (type 3) carrying a static size field and a single timestamp. More...
struct  blf_ethernetframeheader
 Header for a BLF Ethernet frame object (legacy format). More...
struct  blf_ethernetframeheader_ex
 Extended header for a BLF Ethernet frame object with additional hardware metadata. More...
struct  blf_ethernet_rxerror
 Header for a BLF Ethernet receive-error event carrying raw frame bytes and error metadata. More...
struct  blf_wlanframeheader
 Header for a BLF WLAN frame object. More...
struct  blf_canmessage
 Header for a BLF CAN message or CAN message2 object. More...
struct  blf_canmessage2_trailer
 Trailer appended to a BLF CAN message2 object with timing and bit-count metadata. More...
struct  blf_canfdmessage
 Header for a BLF CAN FD message object. More...
struct  blf_canfdmessage64
 Header for a BLF CAN FD message object with extended 64-bit channel and timing metadata. More...
struct  blf_canerror
 Header for a BLF CAN error frame object recording a bus error event. More...
struct  blf_canerrorext
 Extended header for a BLF CAN error frame object with full error diagnostic metadata. More...
struct  blf_canfderror64
 Extended header for a BLF CAN FD error frame object with full diagnostic and timing metadata. More...
struct  blf_canxlchannelframe
 Header for a BLF CAN XL channel frame object with full timing, arbitration, and CRC metadata. More...
struct  blf_flexraydata
 Header for a BLF FlexRay data object capturing a single FlexRay frame. More...
struct  blf_flexraymessage
 Header for a BLF FlexRay V6 message object with FPGA timing and frame state metadata. More...
struct  blf_flexrayrcvmessage
 Header for a BLF FlexRay received message object with dual-channel CRC and cluster metadata. More...
struct  blf_flexrayrcvmessageex
 Extended header for a BLF FlexRay received message object with frame CRC, duration, and PDU offset metadata. More...
struct  blf_linmessage
 Header for a BLF LIN message object (legacy format) carrying up to 8 data bytes. More...
struct  blf_linrcverror
 Header for a BLF LIN receive error event object (legacy format). More...
struct  blf_linsenderror
 Header for a BLF LIN send error event object (legacy format). More...
struct  blf_linwakeupevent
 Header for a BLF LIN wake-up event object (legacy format). More...
struct  blf_linbusevent
 Base event header for BLF LIN bus events, carrying start-of-frame timing and baud rate. More...
struct  blf_linsynchfieldevent
 BLF LIN sync field event, extending the base bus event with break and delimiter lengths. More...
struct  blf_linmessagedescriptor
 BLF LIN message descriptor, extending the sync field event with frame identification and protocol metadata. More...
struct  blf_lindatabytetimestampevent
 BLF LIN data byte timestamp event, extending the message descriptor with per-byte arrival timestamps. More...
struct  blf_linmessage2
 Header for a BLF LIN message object (version 2) with extended timing and event-triggered frame metadata. More...
struct  blf_lincrcerror2
 Header for a BLF LIN CRC error event object (version 2). More...
struct  blf_linrcverror2
 Header for a BLF LIN receive error event object (version 2). More...
struct  blf_linsenderror2
 Header for a BLF LIN send error event object (version 2). More...
struct  blf_linwakeupevent2
 Header for a BLF LIN wake-up event object (version 2) with length validation. More...
struct  blf_linsleepmodeevent
 Header for a BLF LIN sleep mode event object recording a bus sleep or wake transition. More...
struct  blf_apptext
 Header for a BLF application text object carrying an embedded variable-length string. More...
struct  blf_ethernet_status
 Header for a BLF Ethernet status object reporting the physical link state and configuration of an Ethernet channel. More...
struct  blf_ethernet_phystate
 Header for a BLF Ethernet PHY state event object reporting a physical layer state transition. More...

Macros

#define BLF_HEADER_TYPE_DEFAULT   1
#define BLF_HEADER_TYPE_2   2
#define BLF_HEADER_TYPE_3   3
#define BLF_COMPRESSION_NONE   0
#define BLF_COMPRESSION_ZLIB   2
#define BLF_TIMESTAMP_RESOLUTION_10US   1
#define BLF_TIMESTAMP_RESOLUTION_1NS   2
#define BLF_TS_STATUS_ORIG_TS_VALID   0x01
#define BLF_TS_STATUS_SW_TS   0x02
#define BLF_TS_STATUS_PROTO_SPECIFIC   0x10
#define BLF_DIR_RX   0
#define BLF_DIR_TX   1
#define BLF_DIR_TX_RQ   2
#define BLF_ETHERNET_EX_RES   0x0001
#define BLF_ETHERNET_EX_HARDWARECHANNEL   0x0002
#define BLF_ETHERNET_EX_FRAMEDURATION   0x0004
#define BLF_ETHERNET_EX_FRAMEHANDLE   0x0008
#define BLF_CANMESSAGE_FLAG_TX   0x01
#define BLF_CANMESSAGE_FLAG_NERR   0x20
#define BLF_CANMESSAGE_FLAG_WU   0x40
#define BLF_CANMESSAGE_FLAG_RTR   0x80
#define BLF_CANFDMESSAGE_CANFDFLAG_EDL   0x01
#define BLF_CANFDMESSAGE_CANFDFLAG_BRS   0x02
#define BLF_CANFDMESSAGE_CANFDFLAG_ESI   0x04
#define BLF_CANFDMESSAGE64_FLAG_NERR   0x000004
#define BLF_CANFDMESSAGE64_FLAG_HIGH_VOLT_WAKE_UP   0x000008
#define BLF_CANFDMESSAGE64_FLAG_REMOTE_FRAME   0x000010
#define BLF_CANFDMESSAGE64_FLAG_TX_ACK   0x000040
#define BLF_CANFDMESSAGE64_FLAG_TX_REQ   0x000080
#define BLF_CANFDMESSAGE64_FLAG_SRR   0x000200
#define BLF_CANFDMESSAGE64_FLAG_R0   0x000400
#define BLF_CANFDMESSAGE64_FLAG_R1   0x000800
#define BLF_CANFDMESSAGE64_FLAG_EDL   0x001000
#define BLF_CANFDMESSAGE64_FLAG_BRS   0x002000
#define BLF_CANFDMESSAGE64_FLAG_ESI   0x004000
#define BLF_CANFDMESSAGE64_FLAG_BURST   0x020000
#define BLF_CANERROREXT_FLAG_SJA   0x01
#define BLF_CANERROREXT_FLAG_CANCORE   0x02
#define BLF_CANERROREXT_EXTECC_TX   0x1000
#define BLF_CANERROREXT_EXTECC_NOT_ACK   0x2000
#define BLF_CANERROREXT_ECC_MEANING_BIT_ERROR   0x0
#define BLF_CANERROREXT_ECC_MEANING_FORM_ERROR   0x1
#define BLF_CANERROREXT_ECC_MEANING_STUFF_ERROR   0x2
#define BLF_CANERROREXT_ECC_MEANING_OTHER_ERROR   0x3
#define BLF_CANERROREXT_ECC_MEANING_CRC_ERROR   0x4
#define BLF_CANERROREXT_ECC_MEANING_ACKDEL_ERROR   0x5
#define BLF_CANERROREXT_ECC_MEANING_OTHER_ERROR2   0x6
#define BLF_CANERROREXT_ECC_MEANING_NACK_ERROR   0x7
#define BLF_CANERROREXT_ECC_MEANING_OVERLOAD   0x8
#define BLF_CANERROREXT_ECC_FDF_BIT_ERROR   0x9
#define BLF_CANERROR64_FLAG_FDF   0x01
#define BLF_CANERROR65_FLAG_BRS   0x02
#define BLF_CANERROR65_FLAG_ESI   0x04
#define BLF_CANXLCHANNELFRAME_FLAG_REMOTE_FRAME   0x10
#define BLF_CANXLCHANNELFRAME_FLAG_SRR   0x200
#define BLF_CANXLCHANNELFRAME_FLAG_FDF   0x1000
#define BLF_CANXLCHANNELFRAME_FLAG_BRS   0x2000
#define BLF_CANXLCHANNELFRAME_FLAG_ESI   0x4000
#define BLF_CANXLCHANNELFRAME_FLAG_XLF   0x400000
#define BLF_CANXLCHANNELFRAME_FLAG_RRS   0x800000
#define BLF_CANXLCHANNELFRAME_FLAG_SEC   0x1000000
#define BLF_FLEXRAYDATA_FRAME   0x01
#define BLF_FLEXRAYDATA_CHANNEL_B   0x80
#define BLF_FLEXRAYMESSAGE_DIR_RX   0x01
#define BLF_FLEXRAYMESSAGE_DIR_TX   0x02
#define BLF_FLEXRAYMESSAGE_DIR_TX_REQ   0x04
#define BLF_FLEXRAYMESSAGE_STATE_PPI   0x01
#define BLF_FLEXRAYMESSAGE_STATE_SFI   0x02
#define BLF_FLEXRAYMESSAGE_STATE_RES_BIT2   0x04
#define BLF_FLEXRAYMESSAGE_STATE_NFI   0x08
#define BLF_FLEXRAYMESSAGE_STATE_STFI   0x10
#define BLF_FLEXRAYMESSAGE_STATE_FORMAT   0xe0
#define BLF_FLEXRAYMESSAGE_HEADER_BIT_NM   0x01
#define BLF_FLEXRAYMESSAGE_HEADER_BIT_SYNC   0x02
#define BLF_FLEXRAYMESSAGE_HEADER_BIT_RES   0x04
#define BLF_DLT_FLEXRAY_STFI   0x08
#define BLF_DLT_FLEXRAY_SFI   0x10
#define BLF_DLT_FLEXRAY_NFI   0x20
#define BLF_DLT_FLEXRAY_PPI   0x40
#define BLF_FLEXRAYRCVMSG_DIR_RX   0x01
#define BLF_FLEXRAYRCVMSG_DIR_TX   0x02
#define BLF_FLEXRAYRCVMSG_DIR_TX_REQ   0x04
#define BLF_FLEXRAYRCVMSG_CHANNELMASK_RES   0x00
#define BLF_FLEXRAYRCVMSG_CHANNELMASK_A   0x01
#define BLF_FLEXRAYRCVMSG_CHANNELMASK_B   0x02
#define BLF_FLEXRAYRCVMSG_CHANNELMASK_AB   0x03
#define BLF_FLEXRAYRCVMSG_FRAME_FLAG_NULL_FRAME   0x00000001
#define BLF_FLEXRAYRCVMSG_FRAME_FLAG_VALID_DATA   0x00000002
#define BLF_FLEXRAYRCVMSG_FRAME_FLAG_SYNC   0x00000004
#define BLF_FLEXRAYRCVMSG_FRAME_FLAG_STARTUP   0x00000008
#define BLF_FLEXRAYRCVMSG_FRAME_FLAG_PAYLOAD_PREAM   0x00000010
#define BLF_FLEXRAYRCVMSG_FRAME_FLAG_RES_20   0x00000020
#define BLF_FLEXRAYRCVMSG_FRAME_FLAG_ERROR   0x00000040
#define BLF_FLEXRAYRCVMSG_FRAME_FLAG_RES_80   0x00000080
#define BLF_LIN_WU_SLEEP_REASON_START_STATE   0 /* Initial state of the interface */
#define BLF_LIN_SLEEP_REASON_GO_TO_SLEEP_FRAME   1
#define BLF_LIN_SLEEP_REASON_BUS_IDLE_TIMEOUT   2
#define BLF_LIN_SLEEP_REASON_SILENT_SLEEPMODE_CMD   3 /* Command to shorten bus idle timeout */
#define BLF_LIN_WU_REASON_EXTERNAL_WAKEUP_SIG   9
#define BLF_LIN_WU_REASON_INTERNAL_WAKEUP_SIG   10
#define BLF_LIN_WU_REASON_BUS_TRAFFIC   11
#define BLF_LIN_NO_SLEEP_REASON_BUS_TRAFFIC   18 /* LIN hardware does not go into Sleep mode in spite of request to do so */
#define BLF_APPTEXT_COMMENT   0x00000000
#define BLF_APPTEXT_CHANNEL   0x00000001
#define BLF_APPTEXT_METADATA   0x00000002
#define BLF_APPTEXT_ATTACHMENT   0x00000003
#define BLF_APPTEXT_TRACELINE   0x00000004
#define BLF_APPTEXT_CONT   0x000000FE
#define BLF_APPTEXT_FAILED   0x000000FF
#define BLF_APPTEXT_XML_GENERAL   0x01
#define BLF_APPTEXT_XML_CHANNELS   0x02
#define BLF_APPTEXT_XML_IDENTITY   0x03
#define BLF_APPTEXT_TAG_DISS_ETHSTATUS   "blf-ethernetstatus-obj"
#define BLF_APPTEXT_TAG_DISS_ETHPHYSTATUS   "blf-ethernetphystate-obj"
#define BLF_APPTEXT_TAG_DISS_DEFAULT   "data-text-lines"
#define BLF_APPTEXT_COL_PROT_TEXT   "BLF App text"
#define BLF_APPTEXT_COL_INFO_TEXT   "Metadata"
#define BLF_APPTEXT_COL_INFO_TEXT_GENERAL   "Metadata: General"
#define BLF_APPTEXT_COL_INFO_TEXT_CHANNELS   "Metadata: Channels"
#define BLF_APPTEXT_COL_INFO_TEXT_IDENTITY   "Metadata: Identity"
#define BLF_BUSTYPE_CAN   1
#define BLF_BUSTYPE_LIN   5
#define BLF_BUSTYPE_MOST   6
#define BLF_BUSTYPE_FLEXRAY   7
#define BLF_BUSTYPE_J1708   9
#define BLF_BUSTYPE_ETHERNET   11
#define BLF_BUSTYPE_WLAN   13
#define BLF_BUSTYPE_AFDX   14
#define BLF_ETH_STATUS_LINKSTATUS   0x0001
#define BLF_ETH_STATUS_BITRATE   0x0002
#define BLF_ETH_STATUS_ETHERNETPHY   0x0004
#define BLF_ETH_STATUS_DUPLEX   0x0008
#define BLF_ETH_STATUS_MDITYPE   0x0010
#define BLF_ETH_STATUS_CONNECTOR   0x0020
#define BLF_ETH_STATUS_CLOCKMODE   0x0040
#define BLF_ETH_STATUS_BRPAIR   0x0080
#define BLF_ETH_STATUS_HARDWARECHANNEL   0x0100
#define BLF_ETH_STATUS_LINKUPDURATION   0x0200
#define BLF_PHY_STATE_PHYSTATE   0x0001
#define BLF_PHY_STATE_PHYEVENT   0x0002
#define BLF_PHY_STATE_HARDWARECHANNEL   0x0004
#define BLF_OBJTYPE_UNKNOWN   0
#define BLF_OBJTYPE_CAN_MESSAGE   1
#define BLF_OBJTYPE_CAN_ERROR   2
#define BLF_OBJTYPE_CAN_OVERLOAD   3
#define BLF_OBJTYPE_CAN_STATISTIC   4
#define BLF_OBJTYPE_APP_TRIGGER   5
#define BLF_OBJTYPE_ENV_INTEGER   6
#define BLF_OBJTYPE_ENV_DOUBLE   7
#define BLF_OBJTYPE_ENV_STRING   8
#define BLF_OBJTYPE_ENV_DATA   9
#define BLF_OBJTYPE_LOG_CONTAINER   10
#define BLF_OBJTYPE_LIN_MESSAGE   11
#define BLF_OBJTYPE_LIN_CRC_ERROR   12
#define BLF_OBJTYPE_LIN_DLC_INFO   13
#define BLF_OBJTYPE_LIN_RCV_ERROR   14
#define BLF_OBJTYPE_LIN_SND_ERROR   15
#define BLF_OBJTYPE_LIN_SLV_TIMEOUT   16
#define BLF_OBJTYPE_LIN_SCHED_MODCH   17
#define BLF_OBJTYPE_LIN_SYN_ERROR   18
#define BLF_OBJTYPE_LIN_BAUDRATE   19
#define BLF_OBJTYPE_LIN_SLEEP   20
#define BLF_OBJTYPE_LIN_WAKEUP   21
#define BLF_OBJTYPE_MOST_SPY   22
#define BLF_OBJTYPE_MOST_CTRL   23
#define BLF_OBJTYPE_MOST_LIGHTLOCK   24
#define BLF_OBJTYPE_MOST_STATISTIC   25
#define BLF_OBJTYPE_FLEXRAY_DATA   29
#define BLF_OBJTYPE_FLEXRAY_SYNC   30
#define BLF_OBJTYPE_CAN_DRIVER_ERROR   31
#define BLF_OBJTYPE_MOST_PKT   32
#define BLF_OBJTYPE_MOST_PKT2   33
#define BLF_OBJTYPE_MOST_HWMODE   34
#define BLF_OBJTYPE_MOST_REG   35
#define BLF_OBJTYPE_MOST_GENREG   36
#define BLF_OBJTYPE_MOST_NETSTATE   37
#define BLF_OBJTYPE_MOST_DATALOST   38
#define BLF_OBJTYPE_MOST_TRIGGER   39
#define BLF_OBJTYPE_FLEXRAY_CYCLE   40
#define BLF_OBJTYPE_FLEXRAY_MESSAGE   41
#define BLF_OBJTYPE_LIN_CHECKSUM_INFO   42
#define BLF_OBJTYPE_LIN_SPIKE_EVENT   43
#define BLF_OBJTYPE_CAN_DRIVER_SYNC   44
#define BLF_OBJTYPE_FLEXRAY_STATUS   45
#define BLF_OBJTYPE_GPS_EVENT   46
#define BLF_OBJTYPE_FLEXRAY_ERROR   47
#define BLF_OBJTYPE_FLEXRAY_STATUS2   48
#define BLF_OBJTYPE_FLEXRAY_STARTCYCLE   49
#define BLF_OBJTYPE_FLEXRAY_RCVMESSAGE   50
#define BLF_OBJTYPE_REALTIMECLOCK   51
#define BLF_OBJTYPE_LIN_STATISTIC   54
#define BLF_OBJTYPE_J1708_MESSAGE   55
#define BLF_OBJTYPE_J1708_VIRTUAL_MSG   56
#define BLF_OBJTYPE_LIN_MESSAGE2   57
#define BLF_OBJTYPE_LIN_SND_ERROR2   58
#define BLF_OBJTYPE_LIN_SYN_ERROR2   59
#define BLF_OBJTYPE_LIN_CRC_ERROR2   60
#define BLF_OBJTYPE_LIN_RCV_ERROR2   61
#define BLF_OBJTYPE_LIN_WAKEUP2   62
#define BLF_OBJTYPE_LIN_SPIKE_EVENT2   63
#define BLF_OBJTYPE_LIN_LONG_DOM_SIG   64
#define BLF_OBJTYPE_APP_TEXT   65
#define BLF_OBJTYPE_FLEXRAY_RCVMESSAGE_EX   66
#define BLF_OBJTYPE_MOST_STATISTICEX   67
#define BLF_OBJTYPE_MOST_TXLIGHT   68
#define BLF_OBJTYPE_MOST_ALLOCTAB   69
#define BLF_OBJTYPE_MOST_STRESS   70
#define BLF_OBJTYPE_ETHERNET_FRAME   71
#define BLF_OBJTYPE_SYS_VARIABLE   72
#define BLF_OBJTYPE_CAN_ERROR_EXT   73
#define BLF_OBJTYPE_CAN_DRIVER_ERROR_EXT   74
#define BLF_OBJTYPE_LIN_LONG_DOM_SIG2   75
#define BLF_OBJTYPE_MOST_150_MESSAGE   76
#define BLF_OBJTYPE_MOST_150_PKT   77
#define BLF_OBJTYPE_MOST_ETHERNET_PKT   78
#define BLF_OBJTYPE_MOST_150_MESSAGE_FRAGMENT   79
#define BLF_OBJTYPE_MOST_150_PKT_FRAGMENT   80
#define BLF_OBJTYPE_MOST_ETHERNET_PKT_FRAGMENT   81
#define BLF_OBJTYPE_MOST_SYSTEM_EVENT   82
#define BLF_OBJTYPE_MOST_150_ALLOCTAB   83
#define BLF_OBJTYPE_MOST_50_MESSAGE   84
#define BLF_OBJTYPE_MOST_50_PKT   85
#define BLF_OBJTYPE_CAN_MESSAGE2   86
#define BLF_OBJTYPE_LIN_UNEXPECTED_WAKEUP   87
#define BLF_OBJTYPE_LIN_SHORT_OR_SLOW_RESPONSE   88
#define BLF_OBJTYPE_LIN_DISTURBANCE_EVENT   89
#define BLF_OBJTYPE_SERIAL_EVENT   90
#define BLF_OBJTYPE_OVERRUN_ERROR   91
#define BLF_OBJTYPE_EVENT_COMMENT   92
#define BLF_OBJTYPE_WLAN_FRAME   93
#define BLF_OBJTYPE_WLAN_STATISTIC   94
#define BLF_OBJTYPE_MOST_ECL   95
#define BLF_OBJTYPE_GLOBAL_MARKER   96
#define BLF_OBJTYPE_AFDX_FRAME   97
#define BLF_OBJTYPE_AFDX_STATISTIC   98
#define BLF_OBJTYPE_KLINE_STATUSEVENT   99
#define BLF_OBJTYPE_CAN_FD_MESSAGE   100
#define BLF_OBJTYPE_CAN_FD_MESSAGE_64   101
#define BLF_OBJTYPE_ETHERNET_RX_ERROR   102
#define BLF_OBJTYPE_ETHERNET_STATUS   103
#define BLF_OBJTYPE_CAN_FD_ERROR_64   104
#define BLF_OBJTYPE_AFDX_STATUS   106
#define BLF_OBJTYPE_AFDX_BUS_STATISTIC   107
#define BLF_OBJTYPE_AFDX_ERROR_EVENT   109
#define BLF_OBJTYPE_A429_ERROR   110
#define BLF_OBJTYPE_A429_STATUS   111
#define BLF_OBJTYPE_A429_BUS_STATISTIC   112
#define BLF_OBJTYPE_A429_MESSAGE   113
#define BLF_OBJTYPE_ETHERNET_STATISTIC   114
#define BLF_OBJTYPE_RESERVED5   115
#define BLF_OBJTYPE_RESERVED6   116
#define BLF_OBJTYPE_RESERVED7   117
#define BLF_OBJTYPE_TEST_STRUCTURE   118
#define BLF_OBJTYPE_DIAG_REQUEST_INTERPRETATION   119
#define BLF_OBJTYPE_ETHERNET_FRAME_EX   120
#define BLF_OBJTYPE_ETHERNET_FRAME_FORWARDED   121
#define BLF_OBJTYPE_ETHERNET_ERROR_EX   122
#define BLF_OBJTYPE_ETHERNET_ERROR_FORWARDED   123
#define BLF_OBJTYPE_FUNCTION_BUS   124
#define BLF_OBJTYPE_DATA_LOST_BEGIN   125
#define BLF_OBJTYPE_DATA_LOST_END   126
#define BLF_OBJTYPE_WATER_MARK_EVENT   127
#define BLF_OBJTYPE_TRIGGER_CONDITION   128
#define BLF_OBJTYPE_CAN_SETTING_CHANGED   129
#define BLF_OBJTYPE_DISTRIBUTED_OBJECT_MEMBER   130
#define BLF_OBJTYPE_ATTRIBUTE_EVENT   131
#define BLF_OBJTYPE_DISTRIBUTED_OBJECT_CHANGE   132
#define BLF_OBJTYPE_ETHERNET_PHY_STATE   133
#define BLF_OBJTYPE_MACSEC_STATUS   134
#define BLF_OBJTYPE_10BASET1S_STATUS   136
#define BLF_OBJTYPE_10BASET1S_STATISTIC   137
#define BLF_OBJTYPE_TUNNEL_PROTO_DECODER_EVENT   138
#define BLF_OBJTYPE_CAN_XL_CHANNEL_FRAME   139
#define BLF_OBJTYPE_CAN_XL_CHANNEL_ERRORFRAME   140

Typedefs

typedef struct blf_date blf_date_t
 Represents a date and time value as used in BLF file headers.
typedef struct blf_fileheader blf_fileheader_t
 Top-level file header for a BLF (Binary Logging Format) capture file.
typedef struct blf_blockheader blf_blockheader_t
 Common block header preceding every object in a BLF file.
typedef struct blf_logcontainerheader blf_logcontainerheader_t
 Header for a BLF log container object, which wraps a block of compressed or uncompressed log data.
typedef struct blf_logobjectheader blf_logobjectheader_t
 Standard log object header (type 1) carrying a single timestamp.
typedef struct blf_logobjectheader2 blf_logobjectheader2_t
 Extended log object header (type 2) carrying both an object timestamp and an original hardware timestamp.
typedef struct blf_logobjectheader3 blf_logobjectheader3_t
 Compact log object header (type 3) carrying a static size field and a single timestamp.
typedef struct blf_ethernetframeheader blf_ethernetframeheader_t
 Header for a BLF Ethernet frame object (legacy format).
typedef struct blf_ethernetframeheader_ex blf_ethernetframeheader_ex_t
 Extended header for a BLF Ethernet frame object with additional hardware metadata.
typedef struct blf_ethernet_rxerror blf_ethernet_rxerror_t
 Header for a BLF Ethernet receive-error event carrying raw frame bytes and error metadata.
typedef struct blf_wlanframeheader blf_wlanframeheader_t
 Header for a BLF WLAN frame object.
typedef struct blf_canmessage blf_canmessage_t
 Header for a BLF CAN message or CAN message2 object.
typedef struct blf_canmessage2_trailer blf_canmessage2_trailer_t
 Trailer appended to a BLF CAN message2 object with timing and bit-count metadata.
typedef struct blf_canfdmessage blf_canfdmessage_t
 Header for a BLF CAN FD message object.
typedef struct blf_canfdmessage64 blf_canfdmessage64_t
 Header for a BLF CAN FD message object with extended 64-bit channel and timing metadata.
typedef struct blf_canerror blf_canerror_t
 Header for a BLF CAN error frame object recording a bus error event.
typedef struct blf_canerrorext blf_canerrorext_t
 Extended header for a BLF CAN error frame object with full error diagnostic metadata.
typedef struct blf_canfderror64 blf_canfderror64_t
 Extended header for a BLF CAN FD error frame object with full diagnostic and timing metadata.
typedef struct blf_canxlchannelframe blf_canxlchannelframe_t
 Header for a BLF CAN XL channel frame object with full timing, arbitration, and CRC metadata.
typedef struct blf_flexraydata blf_flexraydata_t
 Header for a BLF FlexRay data object capturing a single FlexRay frame.
typedef struct blf_flexraymessage blf_flexraymessage_t
 Header for a BLF FlexRay V6 message object with FPGA timing and frame state metadata.
typedef struct blf_flexrayrcvmessage blf_flexrayrcvmessage_t
 Header for a BLF FlexRay received message object with dual-channel CRC and cluster metadata.
typedef struct blf_flexrayrcvmessageex blf_flexrayrcvmessageex_t
 Extended header for a BLF FlexRay received message object with frame CRC, duration, and PDU offset metadata.
typedef struct blf_linmessage blf_linmessage_t
 Header for a BLF LIN message object (legacy format) carrying up to 8 data bytes.
typedef struct blf_linrcverror blf_linrcverror_t
 Header for a BLF LIN receive error event object (legacy format).
typedef struct blf_linsenderror blf_linsenderror_t
 Header for a BLF LIN send error event object (legacy format).
typedef struct blf_linwakeupevent blf_linwakeupevent_t
 Header for a BLF LIN wake-up event object (legacy format).
typedef struct blf_linbusevent blf_linbusevent_t
 Base event header for BLF LIN bus events, carrying start-of-frame timing and baud rate.
typedef struct blf_linsynchfieldevent blf_linsynchfieldevent_t
 BLF LIN sync field event, extending the base bus event with break and delimiter lengths.
typedef struct blf_linmessagedescriptor blf_linmessagedescriptor_t
 BLF LIN message descriptor, extending the sync field event with frame identification and protocol metadata.
typedef struct blf_lindatabytetimestampevent blf_lindatabytetimestampevent_t
 BLF LIN data byte timestamp event, extending the message descriptor with per-byte arrival timestamps.
typedef struct blf_linmessage2 blf_linmessage2_t
 Header for a BLF LIN message object (version 2) with extended timing and event-triggered frame metadata.
typedef struct blf_lincrcerror2 blf_lincrcerror2_t
 Header for a BLF LIN CRC error event object (version 2).
typedef struct blf_linrcverror2 blf_linrcverror2_t
 Header for a BLF LIN receive error event object (version 2).
typedef struct blf_linsenderror2 blf_linsenderror2_t
 Header for a BLF LIN send error event object (version 2).
typedef struct blf_linwakeupevent2 blf_linwakeupevent2_t
 Header for a BLF LIN wake-up event object (version 2) with length validation.
typedef struct blf_linsleepmodeevent blf_linsleepmodeevent_t
 Header for a BLF LIN sleep mode event object recording a bus sleep or wake transition.
typedef struct blf_apptext blf_apptext_t
 Header for a BLF application text object carrying an embedded variable-length string.
typedef struct blf_ethernet_status blf_ethernet_status_t
 Header for a BLF Ethernet status object reporting the physical link state and configuration of an Ethernet channel.
typedef struct blf_ethernet_phystate blf_ethernet_phystate_t
 Header for a BLF Ethernet PHY state event object reporting a physical layer state transition.

Functions

wtap_open_return_val blf_open (wtap *wth, int *err, char **err_info)
 Opens a BLF file.

Detailed Description

Binary Log File (BLF) file format from Vector Informatik decoder for the Wiretap library.

Copyright (c) 2021-2025 by Dr. Lars Völker lars..nosp@m.voel.nosp@m.ker@t.nosp@m.echn.nosp@m.ica-e.nosp@m.ngin.nosp@m.eerin.nosp@m.g.de

SPDX-License-Identifier: GPL-2.0-or-later

Macro Definition Documentation

◆ BLF_CANFDMESSAGE_CANFDFLAG_BRS

#define BLF_CANFDMESSAGE_CANFDFLAG_BRS   0x02

Bit Rate Switch: data phase transmitted at a higher bit rate.

◆ BLF_CANFDMESSAGE_CANFDFLAG_EDL

#define BLF_CANFDMESSAGE_CANFDFLAG_EDL   0x01

Extended Data Length: 0 = Classical CAN, 1 = CAN FD.

◆ BLF_CANFDMESSAGE_CANFDFLAG_ESI

#define BLF_CANFDMESSAGE_CANFDFLAG_ESI   0x04

Error State Indicator: transmitting node is in passive error state.

◆ BLF_CANMESSAGE_FLAG_NERR

#define BLF_CANMESSAGE_FLAG_NERR   0x20

No error (NERR) line was active during transmission.

◆ BLF_CANMESSAGE_FLAG_RTR

#define BLF_CANMESSAGE_FLAG_RTR   0x80

Frame is a Remote Transmission Request (RTR).

◆ BLF_CANMESSAGE_FLAG_TX

#define BLF_CANMESSAGE_FLAG_TX   0x01

Frame was transmitted (TX direction).

◆ BLF_CANMESSAGE_FLAG_WU

#define BLF_CANMESSAGE_FLAG_WU   0x40

Frame triggered a bus wake-up.

◆ BLF_DIR_RX

#define BLF_DIR_RX   0

Frame was received.

◆ BLF_DIR_TX

#define BLF_DIR_TX   1

Frame was transmitted.

◆ BLF_DIR_TX_RQ

#define BLF_DIR_TX_RQ   2

Frame transmission was requested but not yet confirmed.

◆ BLF_ETHERNET_EX_FRAMEDURATION

#define BLF_ETHERNET_EX_FRAMEDURATION   0x0004

The frame_duration field contains a valid value.

◆ BLF_ETHERNET_EX_FRAMEHANDLE

#define BLF_ETHERNET_EX_FRAMEHANDLE   0x0008

The frame_handle field contains a valid value.

◆ BLF_ETHERNET_EX_HARDWARECHANNEL

#define BLF_ETHERNET_EX_HARDWARECHANNEL   0x0002

The hw_channel field contains a valid hardware channel number.

◆ BLF_ETHERNET_EX_RES

#define BLF_ETHERNET_EX_RES   0x0001

Reserved flag.

◆ BLF_TS_STATUS_ORIG_TS_VALID

#define BLF_TS_STATUS_ORIG_TS_VALID   0x01

The original timestamp field contains a valid value.

◆ BLF_TS_STATUS_PROTO_SPECIFIC

#define BLF_TS_STATUS_PROTO_SPECIFIC   0x10

Timestamp interpretation is protocol-specific.

◆ BLF_TS_STATUS_SW_TS

#define BLF_TS_STATUS_SW_TS   0x02

Timestamp was generated in software rather than hardware.

Function Documentation

◆ blf_open()

wtap_open_return_val blf_open ( wtap * wth,
int * err,
char ** err_info )

Opens a BLF file.

This function attempts to open and read the header of a BLF file, determining if it is a valid BLF file.

Parameters
wthPointer to the wtap structure that will hold the file information.
errPointer to an integer where any error codes will be stored.
err_infoPointer to a char pointer where any error messages will be stored.
Returns
A value indicating whether the file is a valid BLF file, not a mine, or if there was an error opening the file.

< Timestamp precision is unknown.

< A UTF-8 string containing the * name of the application used to create this section.