Zephyr API Documentation  3.6.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
can.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2021 Vestas Wind Systems A/S
3 * Copyright (c) 2018 Karsten Koenig
4 * Copyright (c) 2018 Alexander Wachter
5 *
6 * SPDX-License-Identifier: Apache-2.0
7 */
8
14#ifndef ZEPHYR_INCLUDE_DRIVERS_CAN_H_
15#define ZEPHYR_INCLUDE_DRIVERS_CAN_H_
16
17#include <errno.h>
18
19#include <zephyr/types.h>
20#include <zephyr/device.h>
21#include <zephyr/kernel.h>
22#include <string.h>
23#include <zephyr/sys_clock.h>
24#include <zephyr/sys/util.h>
25
26#ifdef __cplusplus
27extern "C" {
28#endif
29
47#define CAN_STD_ID_MASK 0x7FFU
53#define CAN_MAX_STD_ID CAN_STD_ID_MASK __DEPRECATED_MACRO
57#define CAN_EXT_ID_MASK 0x1FFFFFFFU
63#define CAN_MAX_EXT_ID CAN_EXT_ID_MASK __DEPRECATED_MACRO
67#define CAN_MAX_DLC 8U
71#define CANFD_MAX_DLC 15U
72
77#ifndef CONFIG_CAN_FD_MODE
78#define CAN_MAX_DLEN 8U
79#else
80#define CAN_MAX_DLEN 64U
81#endif /* CONFIG_CAN_FD_MODE */
82
95#define CAN_MODE_NORMAL 0
96
98#define CAN_MODE_LOOPBACK BIT(0)
99
101#define CAN_MODE_LISTENONLY BIT(1)
102
104#define CAN_MODE_FD BIT(2)
105
107#define CAN_MODE_ONE_SHOT BIT(3)
108
110#define CAN_MODE_3_SAMPLES BIT(4)
111
113#define CAN_MODE_MANUAL_RECOVERY BIT(5)
114
126
141};
142
151#define CAN_FRAME_IDE BIT(0)
152
154#define CAN_FRAME_RTR BIT(1)
155
157#define CAN_FRAME_FDF BIT(2)
158
160#define CAN_FRAME_BRS BIT(3)
161
165#define CAN_FRAME_ESI BIT(4)
166
172struct can_frame {
179#if defined(CONFIG_CAN_RX_TIMESTAMP) || defined(__DOXYGEN__)
188#else
191 uint16_t reserved;
193#endif
195 union {
197 uint8_t data[CAN_MAX_DLEN];
199 uint32_t data_32[DIV_ROUND_UP(CAN_MAX_DLEN, sizeof(uint32_t))];
200 };
201};
202
211#define CAN_FILTER_IDE BIT(0)
212
227};
228
237};
238
282};
283
292typedef void (*can_tx_callback_t)(const struct device *dev, int error, void *user_data);
293
301typedef void (*can_rx_callback_t)(const struct device *dev, struct can_frame *frame,
302 void *user_data);
303
312typedef void (*can_state_change_callback_t)(const struct device *dev,
313 enum can_state state,
314 struct can_bus_err_cnt err_cnt,
315 void *user_data);
316
336#define CAN_CALC_TDCO(_timing_data, _tdco_min, _tdco_max) \
337 CLAMP((1U + _timing_data->prop_seg + _timing_data->phase_seg1) * _timing_data->prescaler, \
338 _tdco_min, _tdco_max)
339
346struct can_driver_config {
348 const struct device *phy;
350 uint32_t min_bitrate;
352 uint32_t max_bitrate;
354 uint32_t bus_speed;
356 uint16_t sample_point;
357#ifdef CONFIG_CAN_FD_MODE
359 uint16_t sample_point_data;
361 uint32_t bus_speed_data;
362#endif /* CONFIG_CAN_FD_MODE */
363};
364
372#define CAN_DT_DRIVER_CONFIG_GET(node_id, _min_bitrate, _max_bitrate) \
373 { \
374 .phy = DEVICE_DT_GET_OR_NULL(DT_PHANDLE(node_id, phys)), \
375 .min_bitrate = DT_CAN_TRANSCEIVER_MIN_BITRATE(node_id, _min_bitrate), \
376 .max_bitrate = DT_CAN_TRANSCEIVER_MAX_BITRATE(node_id, _max_bitrate), \
377 .bus_speed = DT_PROP_OR(node_id, bus_speed, CONFIG_CAN_DEFAULT_BITRATE), \
378 .sample_point = DT_PROP_OR(node_id, sample_point, 0), \
379 IF_ENABLED(CONFIG_CAN_FD_MODE, \
380 (.bus_speed_data = DT_PROP_OR(node_id, bus_speed_data, \
381 CONFIG_CAN_DEFAULT_BITRATE_DATA), \
382 .sample_point_data = DT_PROP_OR(node_id, sample_point_data, 0),)) \
383 }
384
393#define CAN_DT_DRIVER_CONFIG_INST_GET(inst, _min_bitrate, _max_bitrate) \
394 CAN_DT_DRIVER_CONFIG_GET(DT_DRV_INST(inst), _min_bitrate, _max_bitrate)
395
402struct can_driver_data {
404 can_mode_t mode;
406 bool started;
408 can_state_change_callback_t state_change_cb;
410 void *state_change_cb_user_data;
411};
412
417typedef int (*can_set_timing_t)(const struct device *dev,
418 const struct can_timing *timing);
419
424typedef int (*can_set_timing_data_t)(const struct device *dev,
425 const struct can_timing *timing_data);
426
431typedef int (*can_get_capabilities_t)(const struct device *dev, can_mode_t *cap);
432
437typedef int (*can_start_t)(const struct device *dev);
438
443typedef int (*can_stop_t)(const struct device *dev);
444
449typedef int (*can_set_mode_t)(const struct device *dev, can_mode_t mode);
450
458typedef int (*can_send_t)(const struct device *dev,
459 const struct can_frame *frame,
460 k_timeout_t timeout, can_tx_callback_t callback,
461 void *user_data);
462
467typedef int (*can_add_rx_filter_t)(const struct device *dev,
468 can_rx_callback_t callback,
469 void *user_data,
470 const struct can_filter *filter);
471
476typedef void (*can_remove_rx_filter_t)(const struct device *dev, int filter_id);
477
482typedef int (*can_recover_t)(const struct device *dev, k_timeout_t timeout);
483
488typedef int (*can_get_state_t)(const struct device *dev, enum can_state *state,
489 struct can_bus_err_cnt *err_cnt);
490
495typedef void(*can_set_state_change_callback_t)(const struct device *dev,
497 void *user_data);
498
503typedef int (*can_get_core_clock_t)(const struct device *dev, uint32_t *rate);
504
509typedef int (*can_get_max_filters_t)(const struct device *dev, bool ide);
510
511__subsystem struct can_driver_api {
512 can_get_capabilities_t get_capabilities;
513 can_start_t start;
514 can_stop_t stop;
515 can_set_mode_t set_mode;
516 can_set_timing_t set_timing;
517 can_send_t send;
518 can_add_rx_filter_t add_rx_filter;
519 can_remove_rx_filter_t remove_rx_filter;
520#if defined(CONFIG_CAN_MANUAL_RECOVERY_MODE) || defined(__DOXYGEN__)
521 can_recover_t recover;
522#endif /* CONFIG_CAN_MANUAL_RECOVERY_MODE */
523 can_get_state_t get_state;
524 can_set_state_change_callback_t set_state_change_callback;
525 can_get_core_clock_t get_core_clock;
526 can_get_max_filters_t get_max_filters;
527 /* Min values for the timing registers */
528 struct can_timing timing_min;
529 /* Max values for the timing registers */
530 struct can_timing timing_max;
531#if defined(CONFIG_CAN_FD_MODE) || defined(__DOXYGEN__)
532 can_set_timing_data_t set_timing_data;
533 /* Min values for the timing registers during the data phase */
534 struct can_timing timing_data_min;
535 /* Max values for the timing registers during the data phase */
536 struct can_timing timing_data_max;
537#endif /* CONFIG_CAN_FD_MODE */
538};
539
542#if defined(CONFIG_CAN_STATS) || defined(__DOXYGEN__)
543
544#include <zephyr/stats/stats.h>
545
549STATS_SECT_ENTRY32(bit_error)
550STATS_SECT_ENTRY32(bit0_error)
551STATS_SECT_ENTRY32(bit1_error)
552STATS_SECT_ENTRY32(stuff_error)
553STATS_SECT_ENTRY32(crc_error)
554STATS_SECT_ENTRY32(form_error)
555STATS_SECT_ENTRY32(ack_error)
556STATS_SECT_ENTRY32(rx_overrun)
558
560STATS_NAME(can, bit_error)
561STATS_NAME(can, bit0_error)
562STATS_NAME(can, bit1_error)
563STATS_NAME(can, stuff_error)
564STATS_NAME(can, crc_error)
565STATS_NAME(can, form_error)
566STATS_NAME(can, ack_error)
567STATS_NAME(can, rx_overrun)
568STATS_NAME_END(can);
569
580 struct stats_can stats;
581};
582
588#define Z_CAN_GET_STATS(dev_) \
589 CONTAINER_OF(dev_->state, struct can_device_state, devstate)->stats
590
609#define CAN_STATS_BIT_ERROR_INC(dev_) \
610 STATS_INC(Z_CAN_GET_STATS(dev_), bit_error)
611
623#define CAN_STATS_BIT0_ERROR_INC(dev_) \
624 do { \
625 STATS_INC(Z_CAN_GET_STATS(dev_), bit0_error); \
626 CAN_STATS_BIT_ERROR_INC(dev_); \
627 } while (0)
628
640#define CAN_STATS_BIT1_ERROR_INC(dev_) \
641 do { \
642 STATS_INC(Z_CAN_GET_STATS(dev_), bit1_error); \
643 CAN_STATS_BIT_ERROR_INC(dev_); \
644 } while (0)
645
654#define CAN_STATS_STUFF_ERROR_INC(dev_) \
655 STATS_INC(Z_CAN_GET_STATS(dev_), stuff_error)
656
665#define CAN_STATS_CRC_ERROR_INC(dev_) \
666 STATS_INC(Z_CAN_GET_STATS(dev_), crc_error)
667
676#define CAN_STATS_FORM_ERROR_INC(dev_) \
677 STATS_INC(Z_CAN_GET_STATS(dev_), form_error)
678
687#define CAN_STATS_ACK_ERROR_INC(dev_) \
688 STATS_INC(Z_CAN_GET_STATS(dev_), ack_error)
689
699#define CAN_STATS_RX_OVERRUN_INC(dev_) \
700 STATS_INC(Z_CAN_GET_STATS(dev_), rx_overrun)
701
710#define CAN_STATS_RESET(dev_) \
711 stats_reset(&(Z_CAN_GET_STATS(dev_).s_hdr))
712
718#define Z_CAN_DEVICE_STATE_DEFINE(dev_id) \
719 static struct can_device_state Z_DEVICE_STATE_NAME(dev_id) \
720 __attribute__((__section__(".z_devstate")))
721
728#define Z_CAN_INIT_FN(dev_id, init_fn) \
729 static inline int UTIL_CAT(dev_id, _init)(const struct device *dev) \
730 { \
731 struct can_device_state *state = \
732 CONTAINER_OF(dev->state, struct can_device_state, devstate); \
733 stats_init(&state->stats.s_hdr, STATS_SIZE_32, 8, \
734 STATS_NAME_INIT_PARMS(can)); \
735 stats_register(dev->name, &(state->stats.s_hdr)); \
736 if (!is_null_no_warn(init_fn)) { \
737 return init_fn(dev); \
738 } \
739 \
740 return 0; \
741 }
742
765#define CAN_DEVICE_DT_DEFINE(node_id, init_fn, pm, data, config, level, \
766 prio, api, ...) \
767 Z_CAN_DEVICE_STATE_DEFINE(Z_DEVICE_DT_DEV_ID(node_id)); \
768 Z_CAN_INIT_FN(Z_DEVICE_DT_DEV_ID(node_id), init_fn) \
769 Z_DEVICE_DEFINE(node_id, Z_DEVICE_DT_DEV_ID(node_id), \
770 DEVICE_DT_NAME(node_id), \
771 &UTIL_CAT(Z_DEVICE_DT_DEV_ID(node_id), _init), \
772 pm, data, config, level, prio, api, \
773 &(Z_DEVICE_STATE_NAME(Z_DEVICE_DT_DEV_ID(node_id)).devstate), \
774 __VA_ARGS__)
775
776#else /* CONFIG_CAN_STATS */
777
778#define CAN_STATS_BIT_ERROR_INC(dev_)
779#define CAN_STATS_BIT0_ERROR_INC(dev_)
780#define CAN_STATS_BIT1_ERROR_INC(dev_)
781#define CAN_STATS_STUFF_ERROR_INC(dev_)
782#define CAN_STATS_CRC_ERROR_INC(dev_)
783#define CAN_STATS_FORM_ERROR_INC(dev_)
784#define CAN_STATS_ACK_ERROR_INC(dev_)
785#define CAN_STATS_RX_OVERRUN_INC(dev_)
786#define CAN_STATS_RESET(dev_)
787
788#define CAN_DEVICE_DT_DEFINE(node_id, init_fn, pm, data, config, level, \
789 prio, api, ...) \
790 DEVICE_DT_DEFINE(node_id, init_fn, pm, data, config, level, \
791 prio, api, __VA_ARGS__)
792
793#endif /* CONFIG_CAN_STATS */
794
802#define CAN_DEVICE_DT_INST_DEFINE(inst, ...) \
803 CAN_DEVICE_DT_DEFINE(DT_DRV_INST(inst), __VA_ARGS__)
804
823__syscall int can_get_core_clock(const struct device *dev, uint32_t *rate);
824
825static inline int z_impl_can_get_core_clock(const struct device *dev, uint32_t *rate)
826{
827 const struct can_driver_api *api = (const struct can_driver_api *)dev->api;
828
829 return api->get_core_clock(dev, rate);
830}
831
840__syscall uint32_t can_get_bitrate_min(const struct device *dev);
841
842static inline uint32_t z_impl_can_get_bitrate_min(const struct device *dev)
843{
844 const struct can_driver_config *common = (const struct can_driver_config *)dev->config;
845
846 return common->min_bitrate;
847}
848
862__deprecated static inline int can_get_min_bitrate(const struct device *dev, uint32_t *min_bitrate)
863{
864 *min_bitrate = can_get_bitrate_min(dev);
865
866 return 0;
867}
868
877__syscall uint32_t can_get_bitrate_max(const struct device *dev);
878
879static inline uint32_t z_impl_can_get_bitrate_max(const struct device *dev)
880{
881 const struct can_driver_config *common = (const struct can_driver_config *)dev->config;
882
883 return common->max_bitrate;
884}
885
900__deprecated static inline int can_get_max_bitrate(const struct device *dev, uint32_t *max_bitrate)
901{
902 *max_bitrate = can_get_bitrate_max(dev);
903
904 return 0;
905}
906
914__syscall const struct can_timing *can_get_timing_min(const struct device *dev);
915
916static inline const struct can_timing *z_impl_can_get_timing_min(const struct device *dev)
917{
918 const struct can_driver_api *api = (const struct can_driver_api *)dev->api;
919
920 return &api->timing_min;
921}
922
930__syscall const struct can_timing *can_get_timing_max(const struct device *dev);
931
932static inline const struct can_timing *z_impl_can_get_timing_max(const struct device *dev)
933{
934 const struct can_driver_api *api = (const struct can_driver_api *)dev->api;
935
936 return &api->timing_max;
937}
938
965__syscall int can_calc_timing(const struct device *dev, struct can_timing *res,
966 uint32_t bitrate, uint16_t sample_pnt);
967
981__syscall const struct can_timing *can_get_timing_data_min(const struct device *dev);
982
983#ifdef CONFIG_CAN_FD_MODE
984static inline const struct can_timing *z_impl_can_get_timing_data_min(const struct device *dev)
985{
986 const struct can_driver_api *api = (const struct can_driver_api *)dev->api;
987
988 return &api->timing_data_min;
989}
990#endif /* CONFIG_CAN_FD_MODE */
991
1005__syscall const struct can_timing *can_get_timing_data_max(const struct device *dev);
1006
1007#ifdef CONFIG_CAN_FD_MODE
1008static inline const struct can_timing *z_impl_can_get_timing_data_max(const struct device *dev)
1009{
1010 const struct can_driver_api *api = (const struct can_driver_api *)dev->api;
1011
1012 return &api->timing_data_max;
1013}
1014#endif /* CONFIG_CAN_FD_MODE */
1015
1036__syscall int can_calc_timing_data(const struct device *dev, struct can_timing *res,
1037 uint32_t bitrate, uint16_t sample_pnt);
1038
1056__syscall int can_set_timing_data(const struct device *dev,
1057 const struct can_timing *timing_data);
1058
1087__syscall int can_set_bitrate_data(const struct device *dev, uint32_t bitrate_data);
1088
1109__deprecated int can_calc_prescaler(const struct device *dev, struct can_timing *timing,
1110 uint32_t bitrate);
1111
1125__syscall int can_set_timing(const struct device *dev,
1126 const struct can_timing *timing);
1127
1141__syscall int can_get_capabilities(const struct device *dev, can_mode_t *cap);
1142
1143static inline int z_impl_can_get_capabilities(const struct device *dev, can_mode_t *cap)
1144{
1145 const struct can_driver_api *api = (const struct can_driver_api *)dev->api;
1146
1147 return api->get_capabilities(dev, cap);
1148}
1149
1159__syscall const struct device *can_get_transceiver(const struct device *dev);
1160
1161static const struct device *z_impl_can_get_transceiver(const struct device *dev)
1162{
1163 const struct can_driver_config *common = (const struct can_driver_config *)dev->config;
1164
1165 return common->phy;
1166}
1167
1185__syscall int can_start(const struct device *dev);
1186
1187static inline int z_impl_can_start(const struct device *dev)
1188{
1189 const struct can_driver_api *api = (const struct can_driver_api *)dev->api;
1190
1191 return api->start(dev);
1192}
1193
1209__syscall int can_stop(const struct device *dev);
1210
1211static inline int z_impl_can_stop(const struct device *dev)
1212{
1213 const struct can_driver_api *api = (const struct can_driver_api *)dev->api;
1214
1215 return api->stop(dev);
1216}
1217
1228__syscall int can_set_mode(const struct device *dev, can_mode_t mode);
1229
1230static inline int z_impl_can_set_mode(const struct device *dev, can_mode_t mode)
1231{
1232 const struct can_driver_api *api = (const struct can_driver_api *)dev->api;
1233
1234 return api->set_mode(dev, mode);
1235}
1236
1244__syscall can_mode_t can_get_mode(const struct device *dev);
1245
1246static inline can_mode_t z_impl_can_get_mode(const struct device *dev)
1247{
1248 const struct can_driver_data *common = (const struct can_driver_data *)dev->data;
1249
1250 return common->mode;
1251}
1252
1278__syscall int can_set_bitrate(const struct device *dev, uint32_t bitrate);
1279
1332__syscall int can_send(const struct device *dev, const struct can_frame *frame,
1333 k_timeout_t timeout, can_tx_callback_t callback,
1334 void *user_data);
1335
1367int can_add_rx_filter(const struct device *dev, can_rx_callback_t callback,
1368 void *user_data, const struct can_filter *filter);
1369
1380#define CAN_MSGQ_DEFINE(name, max_frames) \
1381 K_MSGQ_DEFINE(name, sizeof(struct can_frame), max_frames, 4)
1382
1409__syscall int can_add_rx_filter_msgq(const struct device *dev, struct k_msgq *msgq,
1410 const struct can_filter *filter);
1411
1421__syscall void can_remove_rx_filter(const struct device *dev, int filter_id);
1422
1423static inline void z_impl_can_remove_rx_filter(const struct device *dev, int filter_id)
1424{
1425 const struct can_driver_api *api = (const struct can_driver_api *)dev->api;
1426
1427 return api->remove_rx_filter(dev, filter_id);
1428}
1429
1443__syscall int can_get_max_filters(const struct device *dev, bool ide);
1444
1445static inline int z_impl_can_get_max_filters(const struct device *dev, bool ide)
1446{
1447 const struct can_driver_api *api = (const struct can_driver_api *)dev->api;
1448
1449 if (api->get_max_filters == NULL) {
1450 return -ENOSYS;
1451 }
1452
1453 return api->get_max_filters(dev, ide);
1454}
1455
1477__syscall int can_get_state(const struct device *dev, enum can_state *state,
1478 struct can_bus_err_cnt *err_cnt);
1479
1480static inline int z_impl_can_get_state(const struct device *dev, enum can_state *state,
1481 struct can_bus_err_cnt *err_cnt)
1482{
1483 const struct can_driver_api *api = (const struct can_driver_api *)dev->api;
1484
1485 return api->get_state(dev, state, err_cnt);
1486}
1487
1505__syscall int can_recover(const struct device *dev, k_timeout_t timeout);
1506
1507#ifdef CONFIG_CAN_MANUAL_RECOVERY_MODE
1508static inline int z_impl_can_recover(const struct device *dev, k_timeout_t timeout)
1509{
1510 const struct can_driver_api *api = (const struct can_driver_api *)dev->api;
1511
1512 if (api->recover == NULL) {
1513 return -ENOSYS;
1514 }
1515
1516 return api->recover(dev, timeout);
1517}
1518#endif /* CONFIG_CAN_MANUAL_RECOVERY_MODE */
1519
1533static inline void can_set_state_change_callback(const struct device *dev,
1535 void *user_data)
1536{
1537 const struct can_driver_api *api = (const struct can_driver_api *)dev->api;
1538
1539 api->set_state_change_callback(dev, callback, user_data);
1540}
1541
1562__syscall uint32_t can_stats_get_bit_errors(const struct device *dev);
1563
1564#ifdef CONFIG_CAN_STATS
1565static inline uint32_t z_impl_can_stats_get_bit_errors(const struct device *dev)
1566{
1567 return Z_CAN_GET_STATS(dev).bit_error;
1568}
1569#endif /* CONFIG_CAN_STATS */
1570
1585__syscall uint32_t can_stats_get_bit0_errors(const struct device *dev);
1586
1587#ifdef CONFIG_CAN_STATS
1588static inline uint32_t z_impl_can_stats_get_bit0_errors(const struct device *dev)
1589{
1590 return Z_CAN_GET_STATS(dev).bit0_error;
1591}
1592#endif /* CONFIG_CAN_STATS */
1593
1608__syscall uint32_t can_stats_get_bit1_errors(const struct device *dev);
1609
1610#ifdef CONFIG_CAN_STATS
1611static inline uint32_t z_impl_can_stats_get_bit1_errors(const struct device *dev)
1612{
1613 return Z_CAN_GET_STATS(dev).bit1_error;
1614}
1615#endif /* CONFIG_CAN_STATS */
1616
1629__syscall uint32_t can_stats_get_stuff_errors(const struct device *dev);
1630
1631#ifdef CONFIG_CAN_STATS
1632static inline uint32_t z_impl_can_stats_get_stuff_errors(const struct device *dev)
1633{
1634 return Z_CAN_GET_STATS(dev).stuff_error;
1635}
1636#endif /* CONFIG_CAN_STATS */
1637
1650__syscall uint32_t can_stats_get_crc_errors(const struct device *dev);
1651
1652#ifdef CONFIG_CAN_STATS
1653static inline uint32_t z_impl_can_stats_get_crc_errors(const struct device *dev)
1654{
1655 return Z_CAN_GET_STATS(dev).crc_error;
1656}
1657#endif /* CONFIG_CAN_STATS */
1658
1671__syscall uint32_t can_stats_get_form_errors(const struct device *dev);
1672
1673#ifdef CONFIG_CAN_STATS
1674static inline uint32_t z_impl_can_stats_get_form_errors(const struct device *dev)
1675{
1676 return Z_CAN_GET_STATS(dev).form_error;
1677}
1678#endif /* CONFIG_CAN_STATS */
1679
1692__syscall uint32_t can_stats_get_ack_errors(const struct device *dev);
1693
1694#ifdef CONFIG_CAN_STATS
1695static inline uint32_t z_impl_can_stats_get_ack_errors(const struct device *dev)
1696{
1697 return Z_CAN_GET_STATS(dev).ack_error;
1698}
1699#endif /* CONFIG_CAN_STATS */
1700
1714__syscall uint32_t can_stats_get_rx_overruns(const struct device *dev);
1715
1716#ifdef CONFIG_CAN_STATS
1717static inline uint32_t z_impl_can_stats_get_rx_overruns(const struct device *dev)
1718{
1719 return Z_CAN_GET_STATS(dev).rx_overrun;
1720}
1721#endif /* CONFIG_CAN_STATS */
1722
1739{
1740 static const uint8_t dlc_table[] = {0, 1, 2, 3, 4, 5, 6, 7, 8, 12,
1741 16, 20, 24, 32, 48, 64};
1742
1743 return dlc_table[MIN(dlc, ARRAY_SIZE(dlc_table) - 1)];
1744}
1745
1753static inline uint8_t can_bytes_to_dlc(uint8_t num_bytes)
1754{
1755 return num_bytes <= 8 ? num_bytes :
1756 num_bytes <= 12 ? 9 :
1757 num_bytes <= 16 ? 10 :
1758 num_bytes <= 20 ? 11 :
1759 num_bytes <= 24 ? 12 :
1760 num_bytes <= 32 ? 13 :
1761 num_bytes <= 48 ? 14 :
1762 15;
1763}
1764
1772static inline bool can_frame_matches_filter(const struct can_frame *frame,
1773 const struct can_filter *filter)
1774{
1775 if ((frame->flags & CAN_FRAME_IDE) != 0 && (filter->flags & CAN_FILTER_IDE) == 0) {
1776 /* Extended (29-bit) ID frame, standard (11-bit) filter */
1777 return false;
1778 }
1779
1780 if ((frame->flags & CAN_FRAME_IDE) == 0 && (filter->flags & CAN_FILTER_IDE) != 0) {
1781 /* Standard (11-bit) ID frame, extended (29-bit) filter */
1782 return false;
1783 }
1784
1785 if ((frame->id ^ filter->id) & filter->mask) {
1786 /* Masked ID mismatch */
1787 return false;
1788 }
1789
1790 return true;
1791}
1792
1799#ifdef __cplusplus
1800}
1801#endif
1802
1803#include <syscalls/can.h>
1804
1805#endif /* ZEPHYR_INCLUDE_DRIVERS_CAN_H_ */
System error numbers.
static ssize_t send(int sock, const void *buf, size_t len, int flags)
POSIX wrapper for zsock_send.
Definition: socket.h:917
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:312
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:125
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_get_bitrate_max(const struct device *dev)
Get maximum supported bitrate.
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.
uint32_t can_get_bitrate_min(const struct device *dev)
Get minimum supported bitrate.
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:1753
uint32_t can_stats_get_rx_overruns(const struct device *dev)
Get the RX overrun counter for a CAN device.
#define CAN_FRAME_IDE
Frame uses extended (29-bit) CAN ID.
Definition: can.h:151
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:1738
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:301
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:1772
void(* can_tx_callback_t)(const struct device *dev, int error, void *user_data)
Defines the application callback handler function signature.
Definition: can.h:292
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:130
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:1533
static int can_get_max_bitrate(const struct device *dev, uint32_t *max_bitrate)
Get maximum supported bitrate.
Definition: can.h:900
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.
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.
static int can_get_min_bitrate(const struct device *dev, uint32_t *min_bitrate)
Get minimum supported bitrate.
Definition: can.h:862
#define CAN_FILTER_IDE
Filter matches frames with extended (29-bit) CAN IDs.
Definition: can.h:211
@ CAN_STATE_ERROR_ACTIVE
Error-active state (RX/TX error count < 96).
Definition: can.h:132
@ CAN_STATE_ERROR_WARNING
Error-warning state (RX/TX error count < 128).
Definition: can.h:134
@ CAN_STATE_STOPPED
CAN controller is stopped and does not participate in CAN communication.
Definition: can.h:140
@ CAN_STATE_BUS_OFF
Bus-off state (RX/TX error count >= 256).
Definition: can.h:138
@ CAN_STATE_ERROR_PASSIVE
Error-passive state (RX/TX error count < 256).
Definition: can.h:136
#define MIN(a, b)
Obtain the minimum of two values.
Definition: util.h:391
#define ARRAY_SIZE(array)
Number of elements in the given array.
Definition: util.h:127
#define DIV_ROUND_UP(n, d)
Divide and round up.
Definition: util.h:336
#define ENOSYS
Function not implemented.
Definition: errno.h:83
Public kernel APIs.
state
Definition: parser_state.h:29
Statistics.
#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:232
uint8_t tx_err_cnt
Value of the CAN controller transmit error counter.
Definition: can.h:234
uint8_t rx_err_cnt
Value of the CAN controller receive error counter.
Definition: can.h:236
CAN specific device state which allows for CAN device class specific additions.
Definition: can.h:576
struct device_state devstate
Common device state.
Definition: can.h:578
struct stats_can stats
CAN device statistics.
Definition: can.h:580
CAN filter structure.
Definition: can.h:218
uint32_t mask
CAN identifier matching mask.
Definition: can.h:224
uint8_t flags
Flags.
Definition: can.h:226
uint32_t id
CAN identifier to match.
Definition: can.h:220
CAN frame structure.
Definition: can.h:172
uint8_t dlc
Data Length Code (DLC) indicating data length in bytes.
Definition: can.h:176
uint8_t flags
Flags.
Definition: can.h:178
uint32_t id
Standard (11-bit) or extended (29-bit) CAN identifier.
Definition: can.h:174
uint8_t data[CAN_MAX_DLEN]
Payload data accessed as unsigned 8 bit values.
Definition: can.h:197
uint32_t data_32[DIV_ROUND_UP(CAN_MAX_DLEN, sizeof(uint32_t))]
Payload data accessed as unsigned 32 bit values.
Definition: can.h:199
uint16_t timestamp
Captured value of the free-running timer in the CAN controller when this frame was received.
Definition: can.h:187
CAN bus timing structure.
Definition: can.h:271
uint16_t sjw
Synchronisation jump width.
Definition: can.h:273
uint16_t phase_seg2
Phase segment 2.
Definition: can.h:279
uint16_t prescaler
Prescaler value.
Definition: can.h:281
uint16_t phase_seg1
Phase segment 1.
Definition: can.h:277
uint16_t prop_seg
Propagation segment.
Definition: can.h:275
Runtime device dynamic structure (in RAM) per driver instance.
Definition: device.h:370
Runtime device structure (in ROM) per driver instance.
Definition: device.h:399
void * data
Address of the device instance private data.
Definition: device.h:409
const void * api
Address of the API structure exposed by the device instance.
Definition: device.h:405
const void * config
Address of device instance config information.
Definition: device.h:403
Message Queue Structure.
Definition: kernel.h:4421
Kernel timeout type.
Definition: sys_clock.h:65
Variables needed for system clock.
Misc utilities.