]> rtime.felk.cvut.cz Git - can-utils.git/blobdiff - can-calc-bit-timing.c
can-calc-bit-timing: fix checkpatch warnings
[can-utils.git] / can-calc-bit-timing.c
index 52fb83870bd14c51dc4bd327d6430b1ffe61f13d..46e2c16cbd515bf3f51deee9351aa364d302d2e8 100644 (file)
 #include <linux/types.h>
 #include <linux/can/netlink.h>
 
-/* seems not to be defined in errno.h */
-#ifndef ENOTSUPP
-#define ENOTSUPP       524     /* Operation is not supported */
-#endif
+/* imported from kernel */
 
-/* useful defines */
-#define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]))
-
-#define do_div(a,b) a = (a) / (b)
+/**
+ * abs - return absolute value of an argument
+ * @x: the value.  If it is unsigned type, it is converted to signed type first.
+ *     char is treated as if it was signed (regardless of whether it really is)
+ *     but the macro's return type is preserved as char.
+ *
+ * Return: an absolute value of x.
+ */
+#define abs(x) __abs_choose_expr(x, long long,                         \
+               __abs_choose_expr(x, long,                              \
+               __abs_choose_expr(x, int,                               \
+               __abs_choose_expr(x, short,                             \
+               __abs_choose_expr(x, char,                              \
+               __builtin_choose_expr(                                  \
+                       __builtin_types_compatible_p(typeof(x), char),  \
+                       (char)({ signed char __x = (x); __x<0?-__x:__x; }), \
+                       ((void)0)))))))
+
+#define __abs_choose_expr(x, type, other) __builtin_choose_expr(       \
+       __builtin_types_compatible_p(typeof(x),   signed type) ||       \
+       __builtin_types_compatible_p(typeof(x), unsigned type),         \
+       ({ signed type __x = (x); __x < 0 ? -__x : __x; }), other)
 
-#define abs(x) ({                              \
-               long __x = (x);                 \
-               (__x < 0) ? -__x : __x;         \
-       })
+/*
+ * min()/max()/clamp() macros that also do
+ * strict type-checking.. See the
+ * "unnecessary" pointer comparison.
+ */
+#define min(x, y) ({                           \
+       typeof(x) _min1 = (x);                  \
+       typeof(y) _min2 = (y);                  \
+       (void) (&_min1 == &_min2);              \
+       _min1 < _min2 ? _min1 : _min2; })
+
+#define max(x, y) ({                           \
+       typeof(x) _max1 = (x);                  \
+       typeof(y) _max2 = (y);                  \
+       (void) (&_max1 == &_max2);              \
+       _max1 > _max2 ? _max1 : _max2; })
 
 /**
  * clamp - return a value clamped to a given range with strict typechecking
  * @val: current value
- * @min: minimum allowable value
- * @max: maximum allowable value
+ * @lo: lowest allowable value
+ * @hi: highest allowable value
  *
- * This macro does strict typechecking of min/max to make sure they are of the
+ * This macro does strict typechecking of lo/hi to make sure they are of the
  * same type as val.  See the unnecessary pointer comparisons.
  */
-#define clamp(val, min, max) ({                        \
-       typeof(val) __val = (val);              \
-       typeof(min) __min = (min);              \
-       typeof(max) __max = (max);              \
-       (void) (&__val == &__min);              \
-       (void) (&__val == &__max);              \
-       __val = __val < __min ? __min: __val;   \
-       __val > __max ? __max: __val; })
+#define clamp(val, lo, hi) min((typeof(val))max(val, lo), hi)
+
+# define do_div(n,base) ({                                     \
+       uint32_t __base = (base);                               \
+       uint32_t __rem;                                         \
+       __rem = ((uint64_t)(n)) % __base;                       \
+       (n) = ((uint64_t)(n)) / __base;                         \
+       __rem;                                                  \
+ })
+
+/* */
+
+#define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]))
 
 /* we don't want to see these prints */
-#define dev_err(dev, format, arg...)   do { } while (0)
-#define dev_warn(dev, format, arg...)  do { } while (0)
+#define netdev_err(dev, format, arg...) do { } while (0)
+#define netdev_warn(dev, format, arg...) do { } while (0)
 
 /* define in-kernel-types */
 typedef __u64 u64;
@@ -78,7 +110,6 @@ struct calc_bittiming_const {
  * minimal structs, just enough to be source level compatible
  */
 struct can_priv {
-       const struct can_bittiming_const *bittiming_const;
        struct can_clock clock;
 };
 
@@ -500,6 +531,19 @@ static long common_bitrates[] = {
 
 #define CAN_CALC_MAX_ERROR 50 /* in one-tenth of a percent */
 
+/*
+ * Bit-timing calculation derived from:
+ *
+ * Code based on LinCAN sources and H8S2638 project
+ * Copyright 2004-2006 Pavel Pisa - DCE FELK CVUT cz
+ * Copyright 2005      Stanislav Marek
+ * email: pisa@cmp.felk.cvut.cz
+ *
+ * Calculates proper bit-timing parameters for a specified bit-rate
+ * and sample-point, which can then be used to set the bit-timing
+ * registers of the CAN controller. You can find more information
+ * in the header file linux/can/netlink.h.
+ */
 static int can_update_spt(const struct can_bittiming_const *btc,
                          int sampl_pt, int tseg, int *tseg1, int *tseg2)
 {
@@ -516,21 +560,18 @@ static int can_update_spt(const struct can_bittiming_const *btc,
        return 1000 * (tseg + 1 - *tseg2) / (tseg + 1);
 }
 
-static int can_calc_bittiming(struct net_device *dev, struct can_bittiming *bt)
+static int can_calc_bittiming(struct net_device *dev, struct can_bittiming *bt,
+                             const struct can_bittiming_const *btc)
 {
        struct can_priv *priv = netdev_priv(dev);
-       const struct can_bittiming_const *btc = priv->bittiming_const;
-       long rate = 0;
        long best_error = 1000000000, error = 0;
        int best_tseg = 0, best_brp = 0, brp = 0;
        int tsegall, tseg = 0, tseg1 = 0, tseg2 = 0;
        int spt_error = 1000, spt = 0, sampl_pt;
+       long rate;
        u64 v64;
 
-       if (!priv->bittiming_const)
-               return -ENOTSUPP;
-
-       /* Use CIA recommended sample points */
+       /* Use CiA recommended sample points */
        if (bt->sample_point) {
                sampl_pt = bt->sample_point;
        } else {
@@ -580,14 +621,13 @@ static int can_calc_bittiming(struct net_device *dev, struct can_bittiming *bt)
                /* Error in one-tenth of a percent */
                error = (best_error * 1000) / bt->bitrate;
                if (error > CAN_CALC_MAX_ERROR) {
-                       dev_err(dev->dev.parent,
-                               "bitrate error %ld.%ld%% too high\n",
-                               error / 10, error % 10);
+                       netdev_err(dev,
+                                  "bitrate error %ld.%ld%% too high\n",
+                                  error / 10, error % 10);
                        return -EDOM;
-               } else {
-                       dev_warn(dev->dev.parent, "bitrate error %ld.%ld%%\n",
-                                error / 10, error % 10);
                }
+               netdev_warn(dev, "bitrate error %ld.%ld%%\n",
+                           error / 10, error % 10);
        }
 
        /* real sample point */
@@ -600,9 +640,20 @@ static int can_calc_bittiming(struct net_device *dev, struct can_bittiming *bt)
        bt->prop_seg = tseg1 / 2;
        bt->phase_seg1 = tseg1 - bt->prop_seg;
        bt->phase_seg2 = tseg2;
-       bt->sjw = 1;
-       bt->brp = best_brp;
 
+       /* check for sjw user settings */
+       if (!bt->sjw || !btc->sjw_max)
+               bt->sjw = 1;
+       else {
+               /* bt->sjw is at least 1 -> sanitize upper bound to sjw_max */
+               if (bt->sjw > btc->sjw_max)
+                       bt->sjw = btc->sjw_max;
+               /* bt->sjw must not be higher than tseg2 */
+               if (tseg2 < bt->sjw)
+                       bt->sjw = tseg2;
+       }
+
+       bt->brp = best_brp;
        /* real bit-rate */
        bt->bitrate = priv->clock.freq / (bt->brp * (tseg1 + tseg2 + 1));
 
@@ -628,7 +679,6 @@ static void print_bit_timing(const struct calc_bittiming_const *btc,
                             bool quiet)
 {
        struct net_device dev = {
-               .priv.bittiming_const = &btc->bittiming_const,
                .priv.clock.freq = ref_clk,
        };
        struct can_bittiming bt = {
@@ -648,7 +698,7 @@ static void print_bit_timing(const struct calc_bittiming_const *btc,
                printf("\n");
        }
 
-       if (can_calc_bittiming(&dev, &bt)) {
+       if (can_calc_bittiming(&dev, &bt, &btc->bittiming_const)) {
                printf("%7d ***bitrate not possible***\n", bitrate);
                return;
        }