14#ifndef ZEPHYR_INCLUDE_DRIVERS_CAN_H_
15#define ZEPHYR_INCLUDE_DRIVERS_CAN_H_
45#define CAN_STD_ID_MASK 0x7FFU
49#define CAN_MAX_STD_ID CAN_STD_ID_MASK
53#define CAN_EXT_ID_MASK 0x1FFFFFFFU
57#define CAN_MAX_EXT_ID CAN_EXT_ID_MASK
65#define CANFD_MAX_DLC 15U
71#ifndef CONFIG_CAN_FD_MODE
72#define CAN_MAX_DLEN 8U
74#define CAN_MAX_DLEN 64U
89#define CAN_MODE_NORMAL 0
92#define CAN_MODE_LOOPBACK BIT(0)
95#define CAN_MODE_LISTENONLY BIT(1)
98#define CAN_MODE_FD BIT(2)
101#define CAN_MODE_ONE_SHOT BIT(3)
104#define CAN_MODE_3_SAMPLES BIT(4)
142#define CAN_FRAME_IDE BIT(0)
145#define CAN_FRAME_RTR BIT(1)
148#define CAN_FRAME_FDF BIT(2)
151#define CAN_FRAME_BRS BIT(3)
156#define CAN_FRAME_ESI BIT(4)
173#if defined(CONFIG_CAN_RX_TIMESTAMP) || defined(__DOXYGEN__)
204#define CAN_FILTER_IDE BIT(0)
326struct can_driver_config {
335#ifdef CONFIG_CAN_FD_MODE
349#define CAN_DT_DRIVER_CONFIG_GET(node_id, _max_bitrate) \
351 .phy = DEVICE_DT_GET_OR_NULL(DT_PHANDLE(node_id, phys)), \
352 .max_bitrate = DT_CAN_TRANSCEIVER_MAX_BITRATE(node_id, _max_bitrate), \
353 .bus_speed = DT_PROP(node_id, bus_speed), \
354 .sample_point = DT_PROP_OR(node_id, sample_point, 0), \
355 IF_ENABLED(CONFIG_CAN_FD_MODE, \
356 (.bus_speed_data = DT_PROP_OR(node_id, bus_speed_data, 0), \
357 .sample_point_data = DT_PROP_OR(node_id, sample_point_data, 0),)) \
367#define CAN_DT_DRIVER_CONFIG_INST_GET(inst, _max_bitrate) \
368 CAN_DT_DRIVER_CONFIG_GET(DT_DRV_INST(inst), _max_bitrate)
376struct can_driver_data {
384 void *state_change_cb_user_data;
391typedef int (*can_set_timing_t)(
const struct device *dev,
398typedef int (*can_set_timing_data_t)(
const struct device *dev,
405typedef int (*can_get_capabilities_t)(
const struct device *dev,
can_mode_t *cap);
411typedef int (*can_start_t)(
const struct device *dev);
417typedef int (*can_stop_t)(
const struct device *dev);
432typedef int (*can_send_t)(
const struct device *dev,
441typedef int (*can_add_rx_filter_t)(
const struct device *dev,
450typedef void (*can_remove_rx_filter_t)(
const struct device *dev,
int filter_id);
469typedef void(*can_set_state_change_callback_t)(
const struct device *dev,
477typedef int (*can_get_core_clock_t)(
const struct device *dev,
uint32_t *rate);
483typedef int (*can_get_max_filters_t)(
const struct device *dev,
bool ide);
485__subsystem
struct can_driver_api {
486 can_get_capabilities_t get_capabilities;
489 can_set_mode_t set_mode;
490 can_set_timing_t set_timing;
492 can_add_rx_filter_t add_rx_filter;
493 can_remove_rx_filter_t remove_rx_filter;
494#if !defined(CONFIG_CAN_AUTO_BUS_OFF_RECOVERY) || defined(__DOXYGEN__)
495 can_recover_t recover;
497 can_get_state_t get_state;
498 can_set_state_change_callback_t set_state_change_callback;
499 can_get_core_clock_t get_core_clock;
500 can_get_max_filters_t get_max_filters;
505#if defined(CONFIG_CAN_FD_MODE) || defined(__DOXYGEN__)
506 can_set_timing_data_t set_timing_data;
516#if defined(CONFIG_CAN_STATS) || defined(__DOXYGEN__)
562#define Z_CAN_GET_STATS(dev_) \
563 CONTAINER_OF(dev_->state, struct can_device_state, devstate)->stats
583#define CAN_STATS_BIT_ERROR_INC(dev_) \
584 STATS_INC(Z_CAN_GET_STATS(dev_), bit_error)
597#define CAN_STATS_BIT0_ERROR_INC(dev_) \
599 STATS_INC(Z_CAN_GET_STATS(dev_), bit0_error); \
600 CAN_STATS_BIT_ERROR_INC(dev_); \
614#define CAN_STATS_BIT1_ERROR_INC(dev_) \
616 STATS_INC(Z_CAN_GET_STATS(dev_), bit1_error); \
617 CAN_STATS_BIT_ERROR_INC(dev_); \
628#define CAN_STATS_STUFF_ERROR_INC(dev_) \
629 STATS_INC(Z_CAN_GET_STATS(dev_), stuff_error)
639#define CAN_STATS_CRC_ERROR_INC(dev_) \
640 STATS_INC(Z_CAN_GET_STATS(dev_), crc_error)
650#define CAN_STATS_FORM_ERROR_INC(dev_) \
651 STATS_INC(Z_CAN_GET_STATS(dev_), form_error)
661#define CAN_STATS_ACK_ERROR_INC(dev_) \
662 STATS_INC(Z_CAN_GET_STATS(dev_), ack_error)
673#define CAN_STATS_RX_OVERRUN_INC(dev_) \
674 STATS_INC(Z_CAN_GET_STATS(dev_), rx_overrun)
684#define CAN_STATS_RESET(dev_) \
685 stats_reset(&(Z_CAN_GET_STATS(dev_).s_hdr))
692#define Z_CAN_DEVICE_STATE_DEFINE(dev_id) \
693 static struct can_device_state Z_DEVICE_STATE_NAME(dev_id) \
694 __attribute__((__section__(".z_devstate")))
702#define Z_CAN_INIT_FN(dev_id, init_fn) \
703 static inline int UTIL_CAT(dev_id, _init)(const struct device *dev) \
705 struct can_device_state *state = \
706 CONTAINER_OF(dev->state, struct can_device_state, devstate); \
707 stats_init(&state->stats.s_hdr, STATS_SIZE_32, 8, \
708 STATS_NAME_INIT_PARMS(can)); \
709 stats_register(dev->name, &(state->stats.s_hdr)); \
710 if (init_fn != NULL) { \
711 return init_fn(dev); \
739#define CAN_DEVICE_DT_DEFINE(node_id, init_fn, pm, data, config, level, \
741 Z_CAN_DEVICE_STATE_DEFINE(Z_DEVICE_DT_DEV_ID(node_id)); \
742 Z_CAN_INIT_FN(Z_DEVICE_DT_DEV_ID(node_id), init_fn) \
743 Z_DEVICE_DEFINE(node_id, Z_DEVICE_DT_DEV_ID(node_id), \
744 DEVICE_DT_NAME(node_id), \
745 &UTIL_CAT(Z_DEVICE_DT_DEV_ID(node_id), _init), \
746 pm, data, config, level, prio, api, \
747 &(Z_DEVICE_STATE_NAME(Z_DEVICE_DT_DEV_ID(node_id)).devstate), \
752#define CAN_STATS_BIT_ERROR_INC(dev_)
753#define CAN_STATS_BIT0_ERROR_INC(dev_)
754#define CAN_STATS_BIT1_ERROR_INC(dev_)
755#define CAN_STATS_STUFF_ERROR_INC(dev_)
756#define CAN_STATS_CRC_ERROR_INC(dev_)
757#define CAN_STATS_FORM_ERROR_INC(dev_)
758#define CAN_STATS_ACK_ERROR_INC(dev_)
759#define CAN_STATS_RX_OVERRUN_INC(dev_)
760#define CAN_STATS_RESET(dev_)
762#define CAN_DEVICE_DT_DEFINE(node_id, init_fn, pm, data, config, level, \
764 DEVICE_DT_DEFINE(node_id, init_fn, pm, data, config, level, \
765 prio, api, __VA_ARGS__)
776#define CAN_DEVICE_DT_INST_DEFINE(inst, ...) \
777 CAN_DEVICE_DT_DEFINE(DT_DRV_INST(inst), __VA_ARGS__)
797static inline int z_impl_can_get_core_clock(
const struct device *dev,
uint32_t *rate)
799 const struct can_driver_api *api = (
const struct can_driver_api *)dev->
api;
801 return api->get_core_clock(dev, rate);
818static inline int z_impl_can_get_max_bitrate(
const struct device *dev,
uint32_t *max_bitrate)
820 const struct can_driver_config *common = (
const struct can_driver_config *)dev->
config;
822 if (common->max_bitrate == 0U) {
826 *max_bitrate = common->max_bitrate;
840static inline const struct can_timing *z_impl_can_get_timing_min(
const struct device *dev)
842 const struct can_driver_api *api = (
const struct can_driver_api *)dev->
api;
844 return &api->timing_min;
856static inline const struct can_timing *z_impl_can_get_timing_max(
const struct device *dev)
858 const struct can_driver_api *api = (
const struct can_driver_api *)dev->
api;
860 return &api->timing_max;
902#ifdef CONFIG_CAN_FD_MODE
903static inline const struct can_timing *z_impl_can_get_timing_data_min(
const struct device *dev)
905 const struct can_driver_api *api = (
const struct can_driver_api *)dev->
api;
907 return &api->timing_data_min;
926#ifdef CONFIG_CAN_FD_MODE
927static inline const struct can_timing *z_impl_can_get_timing_data_max(
const struct device *dev)
929 const struct can_driver_api *api = (
const struct can_driver_api *)dev->
api;
931 return &api->timing_data_max;
1057static inline int z_impl_can_get_capabilities(
const struct device *dev,
can_mode_t *cap)
1059 const struct can_driver_api *api = (
const struct can_driver_api *)dev->
api;
1061 return api->get_capabilities(dev, cap);
1075static const struct device *z_impl_can_get_transceiver(
const struct device *dev)
1077 const struct can_driver_config *common = (
const struct can_driver_config *)dev->
config;
1101static inline int z_impl_can_start(
const struct device *dev)
1103 const struct can_driver_api *api = (
const struct can_driver_api *)dev->
api;
1105 return api->start(dev);
1125static inline int z_impl_can_stop(
const struct device *dev)
1127 const struct can_driver_api *api = (
const struct can_driver_api *)dev->
api;
1129 return api->stop(dev);
1144static inline int z_impl_can_set_mode(
const struct device *dev,
can_mode_t mode)
1146 const struct can_driver_api *api = (
const struct can_driver_api *)dev->
api;
1148 return api->set_mode(dev, mode);
1162 const struct can_driver_data *common = (
const struct can_driver_data *)dev->
data;
1164 return common->mode;
1282 void *user_data,
const struct can_filter *filter)
1284 const struct can_driver_api *api = (
const struct can_driver_api *)dev->
api;
1286 if (filter == NULL) {
1290 return api->add_rx_filter(dev, callback, user_data, filter);
1303#define CAN_MSGQ_DEFINE(name, max_frames) \
1304 K_MSGQ_DEFINE(name, sizeof(struct can_frame), max_frames, 4)
1346static inline void z_impl_can_remove_rx_filter(
const struct device *dev,
int filter_id)
1348 const struct can_driver_api *api = (
const struct can_driver_api *)dev->
api;
1350 return api->remove_rx_filter(dev, filter_id);
1368static inline int z_impl_can_get_max_filters(
const struct device *dev,
bool ide)
1370 const struct can_driver_api *api = (
const struct can_driver_api *)dev->
api;
1372 if (api->get_max_filters == NULL) {
1376 return api->get_max_filters(dev, ide);
1406 const struct can_driver_api *api = (
const struct can_driver_api *)dev->
api;
1408 return api->get_state(dev,
state, err_cnt);
1426#if !defined(CONFIG_CAN_AUTO_BUS_OFF_RECOVERY) || defined(__DOXYGEN__)
1429static inline int z_impl_can_recover(
const struct device *dev,
k_timeout_t timeout)
1431 const struct can_driver_api *api = (
const struct can_driver_api *)dev->
api;
1433 return api->recover(dev, timeout);
1437static inline int z_impl_can_recover(
const struct device *dev,
k_timeout_t timeout)
1440 ARG_UNUSED(timeout);
1462 const struct can_driver_api *api = (
const struct can_driver_api *)dev->
api;
1464 api->set_state_change_callback(dev, callback, user_data);
1489#ifdef CONFIG_CAN_STATS
1490static inline uint32_t z_impl_can_stats_get_bit_errors(
const struct device *dev)
1492 return Z_CAN_GET_STATS(dev).bit_error;
1512#ifdef CONFIG_CAN_STATS
1513static inline uint32_t z_impl_can_stats_get_bit0_errors(
const struct device *dev)
1515 return Z_CAN_GET_STATS(dev).bit0_error;
1535#ifdef CONFIG_CAN_STATS
1536static inline uint32_t z_impl_can_stats_get_bit1_errors(
const struct device *dev)
1538 return Z_CAN_GET_STATS(dev).bit1_error;
1556#ifdef CONFIG_CAN_STATS
1557static inline uint32_t z_impl_can_stats_get_stuff_errors(
const struct device *dev)
1559 return Z_CAN_GET_STATS(dev).stuff_error;
1577#ifdef CONFIG_CAN_STATS
1578static inline uint32_t z_impl_can_stats_get_crc_errors(
const struct device *dev)
1580 return Z_CAN_GET_STATS(dev).crc_error;
1598#ifdef CONFIG_CAN_STATS
1599static inline uint32_t z_impl_can_stats_get_form_errors(
const struct device *dev)
1601 return Z_CAN_GET_STATS(dev).form_error;
1619#ifdef CONFIG_CAN_STATS
1620static inline uint32_t z_impl_can_stats_get_ack_errors(
const struct device *dev)
1622 return Z_CAN_GET_STATS(dev).ack_error;
1641#ifdef CONFIG_CAN_STATS
1642static inline uint32_t z_impl_can_stats_get_rx_overruns(
const struct device *dev)
1644 return Z_CAN_GET_STATS(dev).rx_overrun;
1665 static const uint8_t dlc_table[] = {0, 1, 2, 3, 4, 5, 6, 7, 8, 12,
1666 16, 20, 24, 32, 48, 64};
1680 return num_bytes <= 8 ? num_bytes :
1681 num_bytes <= 12 ? 9 :
1682 num_bytes <= 16 ? 10 :
1683 num_bytes <= 20 ? 11 :
1684 num_bytes <= 24 ? 12 :
1685 num_bytes <= 32 ? 13 :
1686 num_bytes <= 48 ? 14 :
1710 if ((frame->
id ^ filter->
id) & filter->
mask) {
1728#include <syscalls/can.h>
static ssize_t send(int sock, const void *buf, size_t len, int flags)
POSIX wrapper for zsock_send.
Definition: socket.h:882
void(* can_state_change_callback_t)(const struct device *dev, enum can_state state, struct can_bus_err_cnt err_cnt, void *user_data)
Defines the state change callback handler function signature.
Definition: can.h:309
int can_set_bitrate(const struct device *dev, uint32_t bitrate)
Set the bitrate of the CAN controller.
int can_set_bitrate_data(const struct device *dev, uint32_t bitrate_data)
Set the bitrate for the data phase of the CAN FD controller.
uint32_t can_mode_t
Provides a type to hold CAN controller configuration flags.
Definition: can.h:116
static int can_add_rx_filter(const struct device *dev, can_rx_callback_t callback, void *user_data, const struct can_filter *filter)
Add a callback function for a given CAN filter.
Definition: can.h:1281
uint32_t can_stats_get_stuff_errors(const struct device *dev)
Get the stuffing error counter for a CAN device.
int can_stop(const struct device *dev)
Stop the CAN controller.
int can_set_timing(const struct device *dev, const struct can_timing *timing)
Configure the bus timing of a CAN controller.
uint32_t can_stats_get_bit_errors(const struct device *dev)
Get the bit error counter for a CAN device.
uint32_t can_stats_get_crc_errors(const struct device *dev)
Get the CRC error counter for a CAN device.
int can_calc_timing_data(const struct device *dev, struct can_timing *res, uint32_t bitrate, uint16_t sample_pnt)
Calculate timing parameters for the data phase.
int can_send(const struct device *dev, const struct can_frame *frame, k_timeout_t timeout, can_tx_callback_t callback, void *user_data)
Queue a CAN frame for transmission on the CAN bus.
const struct can_timing * can_get_timing_data_max(const struct device *dev)
Get the maximum supported timing parameter values for the data phase.
int can_get_core_clock(const struct device *dev, uint32_t *rate)
Get the CAN core clock rate.
int can_get_capabilities(const struct device *dev, can_mode_t *cap)
Get the supported modes of the CAN controller.
uint32_t can_stats_get_bit1_errors(const struct device *dev)
Get the bit1 error counter for a CAN device.
uint32_t can_stats_get_ack_errors(const struct device *dev)
Get the acknowledge error counter for a CAN device.
int can_get_max_filters(const struct device *dev, bool ide)
Get maximum number of RX filters.
const struct can_timing * can_get_timing_min(const struct device *dev)
Get the minimum supported timing parameter values.
int can_set_timing_data(const struct device *dev, const struct can_timing *timing_data)
Configure the bus timing for the data phase of a CAN FD controller.
const struct can_timing * can_get_timing_data_min(const struct device *dev)
Get the minimum supported timing parameter values for the data phase.
uint32_t can_stats_get_bit0_errors(const struct device *dev)
Get the bit0 error counter for a CAN device.
int can_calc_prescaler(const struct device *dev, struct can_timing *timing, uint32_t bitrate)
Fill in the prescaler value for a given bitrate and timing.
void can_remove_rx_filter(const struct device *dev, int filter_id)
Remove a CAN RX filter.
static uint8_t can_bytes_to_dlc(uint8_t num_bytes)
Convert from number of bytes to Data Length Code (DLC)
Definition: can.h:1678
uint32_t can_stats_get_rx_overruns(const struct device *dev)
Get the RX overrun counter for a CAN device.
int can_get_max_bitrate(const struct device *dev, uint32_t *max_bitrate)
Get maximum supported bitrate.
#define CAN_FRAME_IDE
Frame uses extended (29-bit) CAN ID.
Definition: can.h:142
static uint8_t can_dlc_to_bytes(uint8_t dlc)
Convert from Data Length Code (DLC) to the number of data bytes.
Definition: can.h:1663
int can_add_rx_filter_msgq(const struct device *dev, struct k_msgq *msgq, const struct can_filter *filter)
Simple wrapper function for adding a message queue for a given filter.
void(* can_rx_callback_t)(const struct device *dev, struct can_frame *frame, void *user_data)
Defines the application callback handler function signature for receiving.
Definition: can.h:298
static bool can_frame_matches_filter(const struct can_frame *frame, const struct can_filter *filter)
Check if a CAN frame matches a CAN filter.
Definition: can.h:1697
void(* can_tx_callback_t)(const struct device *dev, int error, void *user_data)
Defines the application callback handler function signature.
Definition: can.h:289
int can_get_state(const struct device *dev, enum can_state *state, struct can_bus_err_cnt *err_cnt)
Get current CAN controller state.
can_mode_t can_get_mode(const struct device *dev)
Get the operation mode of the CAN controller.
const struct can_timing * can_get_timing_max(const struct device *dev)
Get the maximum supported timing parameter values.
uint32_t can_stats_get_form_errors(const struct device *dev)
Get the form error counter for a CAN device.
int can_calc_timing(const struct device *dev, struct can_timing *res, uint32_t bitrate, uint16_t sample_pnt)
Calculate timing parameters from bitrate and sample point.
int can_recover(const struct device *dev, k_timeout_t timeout)
Recover from bus-off state.
can_state
Defines the state of the CAN controller.
Definition: can.h:121
static void can_set_state_change_callback(const struct device *dev, can_state_change_callback_t callback, void *user_data)
Set a callback for CAN controller state change events.
Definition: can.h:1458
const struct device * can_get_transceiver(const struct device *dev)
Get the CAN transceiver associated with the CAN controller.
int can_set_mode(const struct device *dev, can_mode_t mode)
Set the CAN controller to the given operation mode.
int can_start(const struct device *dev)
Start the CAN controller.
#define CAN_FILTER_IDE
Filter matches frames with extended (29-bit) CAN IDs.
Definition: can.h:204
@ CAN_STATE_ERROR_ACTIVE
Error-active state (RX/TX error count < 96).
Definition: can.h:123
@ CAN_STATE_ERROR_WARNING
Error-warning state (RX/TX error count < 128).
Definition: can.h:125
@ CAN_STATE_STOPPED
CAN controller is stopped and does not participate in CAN communication.
Definition: can.h:131
@ CAN_STATE_BUS_OFF
Bus-off state (RX/TX error count >= 256).
Definition: can.h:129
@ CAN_STATE_ERROR_PASSIVE
Error-passive state (RX/TX error count < 256).
Definition: can.h:127
#define MIN(a, b)
Obtain the minimum of two values.
Definition: util.h:373
#define ARRAY_SIZE(array)
Number of elements in the given array.
Definition: util.h:124
#define DIV_ROUND_UP(n, d)
Divide and round up.
Definition: util.h:318
#define EINVAL
Invalid argument.
Definition: errno.h:61
#define ENOSYS
Function not implemented.
Definition: errno.h:83
Variables needed for system clock.
state
Definition: parser_state.h:29
#define STATS_NAME_END(name__)
Definition: stats.h:391
#define STATS_NAME(name__, entry__)
Definition: stats.h:390
#define STATS_SECT_END
Ends a stats group struct definition.
Definition: stats.h:89
#define STATS_SECT_ENTRY32(var__)
Definition: stats.h:359
#define STATS_NAME_START(name__)
Definition: stats.h:389
#define STATS_SECT_START(group__)
Definition: stats.h:354
__UINT32_TYPE__ uint32_t
Definition: stdint.h:90
__UINT8_TYPE__ uint8_t
Definition: stdint.h:88
__UINT16_TYPE__ uint16_t
Definition: stdint.h:89
CAN controller error counters.
Definition: can.h:229
uint8_t tx_err_cnt
Value of the CAN controller transmit error counter.
Definition: can.h:231
uint8_t rx_err_cnt
Value of the CAN controller receive error counter.
Definition: can.h:233
CAN specific device state which allows for CAN device class specific additions.
Definition: can.h:550
struct device_state devstate
Common device state.
Definition: can.h:552
struct stats_can stats
CAN device statistics.
Definition: can.h:554
CAN filter structure.
Definition: can.h:212
uint32_t mask
CAN identifier matching mask.
Definition: can.h:221
uint8_t flags
Flags.
Definition: can.h:223
uint32_t id
CAN identifier to match.
Definition: can.h:214
CAN frame structure.
Definition: can.h:163
uint8_t dlc
Data Length Code (DLC) indicating data length in bytes.
Definition: can.h:170
uint8_t flags
Flags.
Definition: can.h:172
uint32_t id
Standard (11-bit) or extended (29-bit) CAN identifier.
Definition: can.h:165
uint8_t data[CAN_MAX_DLEN]
Payload data accessed as unsigned 8 bit values.
Definition: can.h:190
uint32_t data_32[DIV_ROUND_UP(CAN_MAX_DLEN, sizeof(uint32_t))]
Payload data accessed as unsigned 32 bit values.
Definition: can.h:192
uint16_t timestamp
Captured value of the free-running timer in the CAN controller when this frame was received.
Definition: can.h:181
CAN bus timing structure.
Definition: can.h:268
uint16_t sjw
Synchronisation jump width.
Definition: can.h:270
uint16_t phase_seg2
Phase segment 2.
Definition: can.h:276
uint16_t prescaler
Prescaler value.
Definition: can.h:278
uint16_t phase_seg1
Phase segment 1.
Definition: can.h:274
uint16_t prop_seg
Propagation segment.
Definition: can.h:272
Runtime device dynamic structure (in RAM) per driver instance.
Definition: device.h:358
Runtime device structure (in ROM) per driver instance.
Definition: device.h:387
void * data
Address of the device instance private data.
Definition: device.h:397
const void * api
Address of the API structure exposed by the device instance.
Definition: device.h:393
const void * config
Address of device instance config information.
Definition: device.h:391
Message Queue Structure.
Definition: kernel.h:4402
Kernel timeout type.
Definition: sys_clock.h:65