@driver_ops{CAN Controller} More...

#include <can.h>

Data Fields
can_get_capabilities_t	get_capabilities
	@driver_ops_mandatory Get the supported modes of the CAN controller.
can_start_t	start
	@driver_ops_mandatory Start the CAN controller.
can_stop_t	stop
	@driver_ops_mandatory Stop the CAN controller.
can_set_mode_t	set_mode
	@driver_ops_mandatory Set the CAN controller to the given operation mode.
can_set_timing_t	set_timing
	@driver_ops_mandatory Configure the bus timing of a CAN controller.
can_send_t	send
	@driver_ops_mandatory Queue a CAN frame for transmission on the CAN bus.
can_add_rx_filter_t	add_rx_filter
	@driver_ops_mandatory Add a callback function for a given CAN filter.
can_remove_rx_filter_t	remove_rx_filter
	@driver_ops_mandatory Remove a CAN RX filter.
can_recover_t	recover
	@driver_ops_optional Recover from bus-off state.
can_get_state_t	get_state
	@driver_ops_mandatory Get current CAN controller state.
can_set_state_change_callback_t	set_state_change_callback
	@driver_ops_mandatory Set a callback for CAN controller state change events.
can_get_core_clock_t	get_core_clock
	@driver_ops_mandatory Get the CAN core clock rate.
can_get_max_filters_t	get_max_filters
	@driver_ops_optional Get maximum number of RX filters.
struct can_timing	timing_min
	@driver_ops_mandatory Min values for the timing registers
struct can_timing	timing_max
	@driver_ops_mandatory Max values for the timing registers
can_set_timing_data_t	set_timing_data
	@driver_ops_optional Configure the bus timing for the data phase of a CAN FD controller.
struct can_timing	timing_data_min
	Min values for the timing registers during the data phase.
struct can_timing	timing_data_max
	Max values for the timing registers during the data phase.

Detailed Description

@driver_ops{CAN Controller}

Field Documentation

◆ add_rx_filter

can_add_rx_filter_t can_driver_api::add_rx_filter

@driver_ops_mandatory Add a callback function for a given CAN filter.

◆ get_capabilities

can_get_capabilities_t can_driver_api::get_capabilities

@driver_ops_mandatory Get the supported modes of the CAN controller.

◆ get_core_clock

can_get_core_clock_t can_driver_api::get_core_clock

@driver_ops_mandatory Get the CAN core clock rate.

◆ get_max_filters

can_get_max_filters_t can_driver_api::get_max_filters

@driver_ops_optional Get maximum number of RX filters.

◆ get_state

can_get_state_t can_driver_api::get_state

@driver_ops_mandatory Get current CAN controller state.

◆ recover

can_recover_t can_driver_api::recover

@driver_ops_optional Recover from bus-off state.

Attention

Available only when the following Kconfig option is enabled:

CONFIG_CAN_MANUAL_RECOVERY_MODE

.

◆ remove_rx_filter

can_remove_rx_filter_t can_driver_api::remove_rx_filter

@driver_ops_mandatory Remove a CAN RX filter.

◆ send

can_send_t can_driver_api::send

@driver_ops_mandatory Queue a CAN frame for transmission on the CAN bus.

◆ set_mode

can_set_mode_t can_driver_api::set_mode

@driver_ops_mandatory Set the CAN controller to the given operation mode.

◆ set_state_change_callback

can_set_state_change_callback_t can_driver_api::set_state_change_callback

@driver_ops_mandatory Set a callback for CAN controller state change events.

◆ set_timing

can_set_timing_t can_driver_api::set_timing

@driver_ops_mandatory Configure the bus timing of a CAN controller.

◆ set_timing_data

can_set_timing_data_t can_driver_api::set_timing_data

@driver_ops_optional Configure the bus timing for the data phase of a CAN FD controller.

Attention

Available only when the following Kconfig option is enabled:

CONFIG_CAN_FD_MODE

.

◆ start

can_start_t can_driver_api::start

@driver_ops_mandatory Start the CAN controller.

◆ stop

can_stop_t can_driver_api::stop

@driver_ops_mandatory Stop the CAN controller.

◆ timing_data_max

struct can_timing can_driver_api::timing_data_max

Max values for the timing registers during the data phase.

@driver_ops_mandatory if set_timing_data is implemented

◆ timing_data_min

struct can_timing can_driver_api::timing_data_min

Min values for the timing registers during the data phase.