NetBurner 3.5.6
PDF Version
mcanMODM7AE70::mcan_config Class Reference

MCAN configuration structure. More...

#include <mcan.h>

Public Member Functions

void set_config_defaults ()
 Initializes an MCAN configuration structure to defaults.
 

Public Attributes

bool run_in_standby
 
uint8_t watchdog_configuration
 
bool transmit_pause
 
bool edge_filtering
 
bool protocol_exception_handling
 
bool automatic_retransmission
 
bool clock_stop_request
 
bool clock_stop_acknowledge
 
uint8_t timestamp_prescaler
 
uint16_t timeout_period
 
enum mcan_timeout_mode timeout_mode
 
bool timeout_enable
 
bool tdc_enable
 
uint8_t delay_compensation_offset
 
uint8_t delay_compensation_filter_window_length
 
enum mcan_nonmatching_frames_action nonmatching_frames_action_standard
 
enum mcan_nonmatching_frames_action nonmatching_frames_action_extended
 
bool remote_frames_standard_reject
 
bool remote_frames_extended_reject
 
uint32_t extended_id_mask
 
bool rx_fifo_0_overwrite
 
uint8_t rx_fifo_0_watermark
 
bool rx_fifo_1_overwrite
 
uint8_t rx_fifo_1_watermark
 
bool tx_queue_mode
 
uint8_t tx_event_fifo_watermark
 

Detailed Description

MCAN configuration structure.

Configuration structure for an MCAN instance. This structure should be initialized by the mcan_get_config_defaults() function before being modified by the user application.

Member Function Documentation

◆ set_config_defaults()

void mcanMODM7AE70::mcan_config::set_config_defaults ( )
inline

Initializes an MCAN configuration structure to defaults.

Initializes a given MCAN configuration struct to a set of known default values. This function should be called on any new instance of the configuration struct before being modified by the user application.

The default configuration is as follows:

  • Not run in standby mode
  • Disable Watchdog
  • Transmit pause enabled
  • Edge filtering during bus integration enabled
  • Protocol exception handling enabled
  • Automatic retransmission enabled
  • Clock stop request disabled
  • Clock stop acknowledge disabled
  • Timestamp Counter Prescaler 1
  • Timeout Period with 0xFFFF
  • Timeout Mode: Continuous operation
  • Disable Timeout
  • Transmitter Delay Compensation Offset is 0
  • Transmitter Delay Compensation Filter Window Length is 0
  • Reject nonmatching standard frames
  • Reject nonmatching extended frames
  • Reject remote standard frames
  • Reject remote extended frames
  • Extended ID Mask is 0x1FFFFFFF
  • Rx FIFO 0 Operation Mode: overwrite
  • Disable Rx FIFO 0 Watermark
  • Rx FIFO 1 Operation Mode: overwrite
  • Disable Rx FIFO 1 Watermark
  • Tx FIFO/Queue Mode: FIFO
  • Disable Tx Event FIFO Watermark

Member Data Documentation

◆ automatic_retransmission

bool mcanMODM7AE70::mcan_config::automatic_retransmission

Automatic Retransmission.

◆ clock_stop_acknowledge

bool mcanMODM7AE70::mcan_config::clock_stop_acknowledge

Clock Stop Acknowledge.

◆ clock_stop_request

bool mcanMODM7AE70::mcan_config::clock_stop_request

Clock Stop Request.

◆ delay_compensation_filter_window_length

uint8_t mcanMODM7AE70::mcan_config::delay_compensation_filter_window_length

Transmitter Delay Compensation Filter Window Length : 0x0-0x7F

◆ delay_compensation_offset

uint8_t mcanMODM7AE70::mcan_config::delay_compensation_offset

Transmitter Delay Compensation Offset : 0x0-0x7F

◆ edge_filtering

bool mcanMODM7AE70::mcan_config::edge_filtering

Edge Filtering during Bus Integration.

◆ extended_id_mask

uint32_t mcanMODM7AE70::mcan_config::extended_id_mask

Extended ID Mask: 0x0-0x1FFFFFFF.

◆ nonmatching_frames_action_extended

enum mcan_nonmatching_frames_action mcanMODM7AE70::mcan_config::nonmatching_frames_action_extended

Nonmatching frames action for extended frames.

◆ nonmatching_frames_action_standard

enum mcan_nonmatching_frames_action mcanMODM7AE70::mcan_config::nonmatching_frames_action_standard

Nonmatching frames action for standard frames.

◆ protocol_exception_handling

bool mcanMODM7AE70::mcan_config::protocol_exception_handling

Protocol Exception Handling.

◆ remote_frames_extended_reject

bool mcanMODM7AE70::mcan_config::remote_frames_extended_reject

Reject Remote Extended Frames.

◆ remote_frames_standard_reject

bool mcanMODM7AE70::mcan_config::remote_frames_standard_reject

Reject Remote Standard Frames.

◆ run_in_standby

bool mcanMODM7AE70::mcan_config::run_in_standby

MCAN run in standby control.

◆ rx_fifo_0_overwrite

bool mcanMODM7AE70::mcan_config::rx_fifo_0_overwrite

Rx FIFO 0 Operation Mode.

◆ rx_fifo_0_watermark

uint8_t mcanMODM7AE70::mcan_config::rx_fifo_0_watermark

Rx FIFO 0 Watermark: 1-64, other value disable it.

◆ rx_fifo_1_overwrite

bool mcanMODM7AE70::mcan_config::rx_fifo_1_overwrite

Rx FIFO 1 Operation Mode.

◆ rx_fifo_1_watermark

uint8_t mcanMODM7AE70::mcan_config::rx_fifo_1_watermark

Rx FIFO 1 Watermark: 1-64, other value disable it.

◆ tdc_enable

bool mcanMODM7AE70::mcan_config::tdc_enable

Transceiver Delay Compensation enable.

◆ timeout_enable

bool mcanMODM7AE70::mcan_config::timeout_enable

Timeout enable.

◆ timeout_mode

enum mcan_timeout_mode mcanMODM7AE70::mcan_config::timeout_mode

Timeout Mode.

◆ timeout_period

uint16_t mcanMODM7AE70::mcan_config::timeout_period

Timeout Period.

◆ timestamp_prescaler

uint8_t mcanMODM7AE70::mcan_config::timestamp_prescaler

Timestamp Counter Prescaler: 0x0-0xF

◆ transmit_pause

bool mcanMODM7AE70::mcan_config::transmit_pause

Transmit Pause.

◆ tx_event_fifo_watermark

uint8_t mcanMODM7AE70::mcan_config::tx_event_fifo_watermark

Tx Event FIFO Watermark: 1-32, other value disable it.

◆ tx_queue_mode

bool mcanMODM7AE70::mcan_config::tx_queue_mode

Tx FIFO/Queue Mode, 0 for FIFO and 1 for Queue.

◆ watchdog_configuration

uint8_t mcanMODM7AE70::mcan_config::watchdog_configuration

Start value of the Message RAM Watchdog Counter


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