zephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity

devicetree: can: add support for getting CAN transceiver minimum bitrate 

Add support for getting the minimum supported bitrate of a CAN transceiver.

Signed-off-by: Henrik Brix Andersen <hebad@vestas.com>
This commit is contained in:
Henrik Brix Andersen 2024-02-20 12:17:02 +01:00 committed by Henrik Brix Andersen
parent 6c21ae41a9
commit 653387446e
1 changed files with 65 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

66
include/zephyr/devicetree/can.h
View File

@ -22,6 +22,60 @@ extern "C" {
* @{
*/
/**
* @brief Get the minimum transceiver bitrate for a CAN controller
*
* The bitrate will be limited to the minimum bitrate supported by the CAN
* controller. If no CAN transceiver is present in the devicetree, the minimum
* bitrate will be that of the CAN controller.
*
* Example devicetree fragment:
*
* transceiver0: can-phy0 {
* compatible = "vnd,can-transceiver";
* min-bitrate = <15000>;
* max-bitrate = <1000000>;
* #phy-cells = <0>;
* };
*
* can0: can@... {
* compatible = "vnd,can-controller";
* phys = <&transceiver0>;
* };
*
* can1: can@... {
* compatible = "vnd,can-controller";
*
* can-transceiver {
* min-bitrate = <25000>;
* max-bitrate = <2000000>;
* };
* };
*
* can2: can@... {
* compatible = "vnd,can-controller";
*
* can-transceiver {
* max-bitrate = <2000000>;
* };
* };
*
* Example usage:
*
* DT_CAN_TRANSCEIVER_MIN_BITRATE(DT_NODELABEL(can0), 10000) // 15000
* DT_CAN_TRANSCEIVER_MIN_BITRATE(DT_NODELABEL(can1), 0) // 250000
* DT_CAN_TRANSCEIVER_MIN_BITRATE(DT_NODELABEL(can1), 50000) // 500000
* DT_CAN_TRANSCEIVER_MIN_BITRATE(DT_NODELABEL(can2), 0) // 0
*
* @param node_id node identifier
* @param min minimum bitrate supported by the CAN controller
* @return the minimum bitrate supported by the CAN controller/transceiver combination
*/
#define DT_CAN_TRANSCEIVER_MIN_BITRATE(node_id, min) \
COND_CODE_1(DT_NODE_HAS_PROP(node_id, phys), \
MAX(DT_PROP_OR(DT_PHANDLE(node_id, phys), min_bitrate, 0), min), \
MAX(DT_PROP_OR(DT_CHILD(node_id, can_transceiver), min_bitrate, min), min))
/**
* @brief Get the maximum transceiver bitrate for a CAN controller
*
@ -60,11 +114,21 @@ extern "C" {
* @param max maximum bitrate supported by the CAN controller
* @return the maximum bitrate supported by the CAN controller/transceiver combination
*/
#define DT_CAN_TRANSCEIVER_MAX_BITRATE(node_id, max) \
#define DT_CAN_TRANSCEIVER_MAX_BITRATE(node_id, max) \
COND_CODE_1(DT_NODE_HAS_PROP(node_id, phys), \
MIN(DT_PROP(DT_PHANDLE(node_id, phys), max_bitrate), max), \
MIN(DT_PROP_OR(DT_CHILD(node_id, can_transceiver), max_bitrate, max), max))
/**
* @brief Get the minimum transceiver bitrate for a DT_DRV_COMPAT CAN controller
* @param inst DT_DRV_COMPAT instance number
* @param min minimum bitrate supported by the CAN controller
* @return the minimum bitrate supported by the CAN controller/transceiver combination
* @see DT_CAN_TRANSCEIVER_MIN_BITRATE()
*/
#define DT_INST_CAN_TRANSCEIVER_MIN_BITRATE(inst, min) \
DT_CAN_TRANSCEIVER_MIN_BITRATE(DT_DRV_INST(inst), min)
/**
* @brief Get the maximum transceiver bitrate for a DT_DRV_COMPAT CAN controller
* @param inst DT_DRV_COMPAT instance number