can: bittiming: add calculation for CAN FD Transmitter Delay Compensation (TDC)

The logic for the tdco calculation is to just reuse the normal sample
point: tdco = sp. Because the sample point is expressed in tenth of
percent and the tdco is expressed in time quanta, a conversion is
needed.

At the end,
     ssp = tdcv + tdco
         = tdcv + sp.

Another popular method is to set tdco to the middle of the bit:
     tdc->tdco = can_bit_time(dbt) / 2
During benchmark tests, we could not find a clear advantages for one
of the two methods.

The tdco calculation is triggered each time the data_bittiming is
changed so that users relying on automated calculation can use the
netlink interface the exact same way without need of new parameters.
For example, a command such as:
	ip link set canX type can bitrate 500000 dbitrate 4000000 fd on
would trigger the calculation.

The user using CONFIG_CAN_CALC_BITTIMING who does not want automated
calculation needs to manually set tdco to zero.
For example with:
	ip link set canX type can tdco 0 bitrate 500000 dbitrate 4000000 fd on
(if the tdco parameter is provided in a previous command, it will be
overwritten).

If tdcv is set to zero (default), it is automatically calculated by
the transiver for each frame. As such, there is no code in the kernel
to calculate it.

tdcf has no automated calculation functions because we could not
figure out a formula for this parameter.

Link: https://lore.kernel.org/r/20210224002008.4158-6-mailhol.vincent@wanadoo.fr
Signed-off-by: Vincent Mailhol <mailhol.vincent@wanadoo.fr>
Signed-off-by: Marc Kleine-Budde <mkl@pengutronix.de>

diff --git a/drivers/net/can/dev/bittiming.c b/drivers/net/can/dev/bittiming.c
index f7fe226..2907e60 100644 (file)
--- a/drivers/net/can/dev/bittiming.c
+++ b/drivers/net/can/dev/bittiming.c
@@ -174,6 +174,30 @@ int can_calc_bittiming(struct net_device *dev, struct can_bittiming *bt,
 
        return 0;
 }
+
+void can_calc_tdco(struct net_device *dev)
+{
+       struct can_priv *priv = netdev_priv(dev);
+       const struct can_bittiming *dbt = &priv->data_bittiming;
+       struct can_tdc *tdc = &priv->tdc;
+       const struct can_tdc_const *tdc_const = priv->tdc_const;
+
+       if (!tdc_const)
+               return;
+
+       /* As specified in ISO 11898-1 section 11.3.3 "Transmitter
+        * delay compensation" (TDC) is only applicable if data BRP is
+        * one or two.
+        */
+       if (dbt->brp == 1 || dbt->brp == 2) {
+               /* Reuse "normal" sample point and convert it to time quanta */
+               u32 sample_point_in_tq = can_bit_time(dbt) * dbt->sample_point / 1000;
+
+               tdc->tdco = min(sample_point_in_tq, tdc_const->tdco_max);
+       } else {
+               tdc->tdco = 0;
+       }
+}
 #endif /* CONFIG_CAN_CALC_BITTIMING */
 
 /* Checks the validity of the specified bit-timing parameters prop_seg,

diff --git a/drivers/net/can/dev/netlink.c b/drivers/net/can/dev/netlink.c
index 8443480..e38c256 100644 (file)
--- a/drivers/net/can/dev/netlink.c
+++ b/drivers/net/can/dev/netlink.c
@@ -186,6 +186,8 @@ static int can_changelink(struct net_device *dev, struct nlattr *tb[],
 
                memcpy(&priv->data_bittiming, &dbt, sizeof(dbt));
 
+               can_calc_tdco(dev);
+
                if (priv->do_set_data_bittiming) {
                        /* Finally, set the bit-timing registers */
                        err = priv->do_set_data_bittiming(dev);

diff --git a/include/linux/can/bittiming.h b/include/linux/can/bittiming.h
index b31a49f..3c4cad7 100644 (file)
--- a/include/linux/can/bittiming.h
+++ b/include/linux/can/bittiming.h
@@ -78,6 +78,8 @@ struct can_tdc_const {
 #ifdef CONFIG_CAN_CALC_BITTIMING
 int can_calc_bittiming(struct net_device *dev, struct can_bittiming *bt,
                       const struct can_bittiming_const *btc);
+
+void can_calc_tdco(struct net_device *dev);
 #else /* !CONFIG_CAN_CALC_BITTIMING */
 static inline int
 can_calc_bittiming(struct net_device *dev, struct can_bittiming *bt,
@@ -86,6 +88,10 @@ can_calc_bittiming(struct net_device *dev, struct can_bittiming *bt,
        netdev_err(dev, "bit-timing calculation not available\n");
        return -EINVAL;
 }
+
+static inline void can_calc_tdco(struct net_device *dev)
+{
+}
 #endif /* CONFIG_CAN_CALC_BITTIMING */
 
 int can_get_bittiming(struct net_device *dev, struct can_bittiming *bt,