can: bittiming: add PWM validation

Add can_validate_pwm() to validate the values pwms, pwml and pwml.
Error messages are added to each of the checks to inform the user on
what went wrong. Refer to those error messages to understand the
validation logic.

The boundary values CAN_PWM_DECODE_NS (the transceiver minimum
decoding margin) and CAN_PWM_NS_MAX (the maximum PWM symbol duration)
are hardcoded for the moment. Note that a transceiver capable of
bitrates higher than 20 Mbps may be able to handle a CAN_PWM_DECODE_NS
below 5 ns. If such transceivers become commercially available, this
code could be revisited to make this parameter configurable. For now,
leave it static.

Signed-off-by: Vincent Mailhol <mailhol@kernel.org>
Signed-off-by: Oliver Hartkopp <socketcan@hartkopp.net>
Link: https://patch.msgid.link/20251126-canxl-v8-9-e7e3eb74f889@pengutronix.de
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 0b93900b1dfa38225694a6f8166e64affeaee106..8f82418230cea2d01cbf81f632d2ee6c0542ba6c 100644 (file)
--- a/drivers/net/can/dev/bittiming.c
+++ b/drivers/net/can/dev/bittiming.c
@@ -2,6 +2,7 @@
 /* Copyright (C) 2005 Marc Kleine-Budde, Pengutronix
  * Copyright (C) 2006 Andrey Volkov, Varma Electronics
  * Copyright (C) 2008-2009 Wolfgang Grandegger <wg@grandegger.com>
+ * Copyright (c) 2025 Vincent Mailhol <mailhol@kernel.org>
  */
 
 #include <linux/can/dev.h>
@@ -151,3 +152,65 @@ int can_get_bittiming(const struct net_device *dev, struct can_bittiming *bt,
 
        return -EINVAL;
 }
+
+int can_validate_pwm_bittiming(const struct net_device *dev,
+                              const struct can_pwm *pwm,
+                              struct netlink_ext_ack *extack)
+{
+       const struct can_priv *priv = netdev_priv(dev);
+       u32 xl_bit_time_tqmin = can_bit_time_tqmin(&priv->xl.data_bittiming);
+       u32 nom_bit_time_tqmin = can_bit_time_tqmin(&priv->bittiming);
+       u32 pwms_ns = can_tqmin_to_ns(pwm->pwms, priv->clock.freq);
+       u32 pwml_ns = can_tqmin_to_ns(pwm->pwml, priv->clock.freq);
+
+       if (pwms_ns + pwml_ns > CAN_PWM_NS_MAX) {
+               NL_SET_ERR_MSG_FMT(extack,
+                                  "The PWM symbol duration: %u ns may not exceed %u ns",
+                                  pwms_ns + pwml_ns, CAN_PWM_NS_MAX);
+               return -EINVAL;
+       }
+
+       if (pwms_ns < CAN_PWM_DECODE_NS) {
+               NL_SET_ERR_MSG_FMT(extack,
+                                  "PWMS: %u ns shall be at least %u ns",
+                                  pwms_ns, CAN_PWM_DECODE_NS);
+               return -EINVAL;
+       }
+
+       if (pwm->pwms >= pwm->pwml) {
+               NL_SET_ERR_MSG_FMT(extack,
+                                  "PWMS: %u tqmin shall be smaller than PWML: %u tqmin",
+                                  pwm->pwms, pwm->pwml);
+               return -EINVAL;
+       }
+
+       if (pwml_ns - pwms_ns < 2 * CAN_PWM_DECODE_NS) {
+               NL_SET_ERR_MSG_FMT(extack,
+                                  "At least %u ns shall separate PWMS: %u ns from PMWL: %u ns",
+                                  2 * CAN_PWM_DECODE_NS, pwms_ns, pwml_ns);
+               return -EINVAL;
+       }
+
+       if (xl_bit_time_tqmin % (pwm->pwms + pwm->pwml) != 0) {
+               NL_SET_ERR_MSG_FMT(extack,
+                                  "PWM duration: %u tqmin does not divide XL's bit time: %u tqmin",
+                                  pwm->pwms + pwm->pwml, xl_bit_time_tqmin);
+               return -EINVAL;
+       }
+
+       if (pwm->pwmo >= pwm->pwms + pwm->pwml) {
+               NL_SET_ERR_MSG_FMT(extack,
+                                  "PWMO: %u tqmin can not be greater than PWMS + PWML: %u tqmin",
+                                  pwm->pwmo, pwm->pwms + pwm->pwml);
+               return -EINVAL;
+       }
+
+       if (nom_bit_time_tqmin % (pwm->pwms + pwm->pwml) != pwm->pwmo) {
+               NL_SET_ERR_MSG_FMT(extack,
+                                  "Can not assemble nominal bit time: %u tqmin out of PWMS + PMWL and PWMO",
+                                  nom_bit_time_tqmin);
+               return -EINVAL;
+       }
+
+       return 0;
+}

diff --git a/include/linux/can/bittiming.h b/include/linux/can/bittiming.h
index 967d76689c4f23023baabfa3bb39141b881e0d57..2504fafc72e4705bcf69ae8dec6530cb57489db6 100644 (file)
--- a/include/linux/can/bittiming.h
+++ b/include/linux/can/bittiming.h
@@ -87,6 +87,11 @@ struct can_tdc {
        u32 tdcf;
 };
 
+/* The transceiver decoding margin corresponds to t_Decode in ISO 11898-2 */
+#define CAN_PWM_DECODE_NS 5
+/* Maximum PWM symbol duration. Corresponds to t_SymbolNom_MAX - t_Decode */
+#define CAN_PWM_NS_MAX (205 - CAN_PWM_DECODE_NS)
+
 /*
  * struct can_tdc_const - CAN hardware-dependent constant for
  *     Transmission Delay Compensation
@@ -203,6 +208,10 @@ int can_get_bittiming(const struct net_device *dev, struct can_bittiming *bt,
                      const unsigned int bitrate_const_cnt,
                      struct netlink_ext_ack *extack);
 
+int can_validate_pwm_bittiming(const struct net_device *dev,
+                              const struct can_pwm *pwm,
+                              struct netlink_ext_ack *extack);
+
 /*
  * can_get_relative_tdco() - TDCO relative to the sample point
  *
@@ -245,4 +254,17 @@ static inline unsigned int can_bit_time(const struct can_bittiming *bt)
        return CAN_SYNC_SEG + bt->prop_seg + bt->phase_seg1 + bt->phase_seg2;
 }
 
+/* Duration of one bit in minimum time quantum */
+static inline unsigned int can_bit_time_tqmin(const struct can_bittiming *bt)
+{
+       return can_bit_time(bt) * bt->brp;
+}
+
+/* Convert a duration from minimum a minimum time quantum to nano seconds */
+static inline u32 can_tqmin_to_ns(u32 tqmin, u32 clock_freq)
+{
+       return DIV_U64_ROUND_CLOSEST(mul_u32_u32(tqmin, NSEC_PER_SEC),
+                                    clock_freq);
+}
+
 #endif /* !_CAN_BITTIMING_H */