ADTF Device Toolbox SDK
Loading...
Searching...
No Matches
adtf::devicetb::sdk::canfd::axle::tCANFDData Struct Reference

#include <canfd_types.h>

Collaboration diagram for adtf::devicetb::sdk::canfd::axle::tCANFDData:
[legend]

Classes

struct  tData
 
struct  tMessageHeader
 
struct  tStatus
 

Public Types

enum  eMessageTag { MT_Data = 0 , MT_Status = 1 }
 
enum  eDataFlags {
  DF_NONE = 0 , DF_ERROR_FRAME = 1 , DF_REMOTE_FRAME = 2 , DF_TX_COMPLETED = 4 ,
  DF_EXTENDED_DATA_LENGTH = 8 , DF_CAN_FD_FORMAT_IDENTIFIER = DF_EXTENDED_DATA_LENGTH , DF_BAUD_RATE_SWITCH = 16 , DF_SET_CAN_FD_AND_BRS = DF_CAN_FD_FORMAT_IDENTIFIER | DF_BAUD_RATE_SWITCH ,
  DF_ERROR_STATE_INDICATOR = 32
}
 
enum  eBusStatus { BS_OFFLINE = 1 , BS_ERROR_PASSIVE = 2 , BS_ERROR_WARNING = 4 , BS_ERROR_ACTIVE = 8 }
 
enum  eMsgId { MSG_IDMASK_BASE = 0x000007FF , MSG_IDMASK_EXTENDED = 0x1FFFFFFF , MSG_EXTENDED_FLAG = 0x80000000 }
 

Public Attributes

tMessageHeader sHeader
 CAN FD message header structure.
 
union { 
 
   tData   sData 
 used when ui8Tag == MT_Data
 
   tStatus   sStatus 
 used when ui8Tag == MT_Status
 
};  
 

Detailed Description

The CAN FD data structure is used by CAN FD MediaSamples

Member Enumeration Documentation

◆ eBusStatus

CAN FD bus state flags.

Enumerator
BS_OFFLINE 

Bus is offline.

BS_ERROR_PASSIVE 

One of the error counters has reached the error level.

BS_ERROR_WARNING 

One of the error counters has reached the warning level.

BS_ERROR_ACTIVE 

Bus is online.

◆ eDataFlags

CAN FD message flags

Enumerator
DF_NONE 

Standard flags.

DF_ERROR_FRAME 

Indicates an error frame.

DF_REMOTE_FRAME 

Indicates a remote frame.

DF_TX_COMPLETED 

Notification for successful message transmission.

DF_EXTENDED_DATA_LENGTH 

Indicates FlexibleData-Rate (FDF Flexible Datarate Format Indicator)

DF_CAN_FD_FORMAT_IDENTIFIER 

same as Extended Data Length

DF_BAUD_RATE_SWITCH 

Indicates that the Message uses Flexible Datarate.

DF_SET_CAN_FD_AND_BRS 

Helper to Set Extended Data Length and Baud Rate Switch at once.

DF_ERROR_STATE_INDICATOR 

EDI Bit Indicates an Error-active state at the CAN FD Node.

◆ eMessageTag

This enum specifies the different kinds of messages that may be contained in the union

Enumerator
MT_Data 

Data.

MT_Status 

Status.

◆ eMsgId

CAN FD message id masks. These masks should be used to check for extended or standard messages and to get the correct identifier from ui32Id in tData.

Enumerator
MSG_IDMASK_BASE 

Message IDs for base frame format use 11 bit identifiers.

MSG_IDMASK_EXTENDED 

Message IDs for extended frame format use 29 bit identifiers.

MSG_EXTENDED_FLAG 

Extended CAN FD messages are marked by bit 31.


The documentation for this struct was generated from the following file: