]> rtime.felk.cvut.cz Git - can-utils.git/blobdiff - can-calc-bit-timing.c
can-calc-bit-timing: use "struct can_bittiming_const" from uapi headers
[can-utils.git] / can-calc-bit-timing.c
index edfd560cec3de6981f821aa80d4c29e437209603..52fb83870bd14c51dc4bd327d6430b1ffe61f13d 100644 (file)
 
 #include <errno.h>
 #include <getopt.h>
+#include <stdbool.h>
 #include <stdint.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
 
 #include <linux/types.h>
+#include <linux/can/netlink.h>
 
 /* seems not to be defined in errno.h */
 #ifndef ENOTSUPP
 typedef __u64 u64;
 typedef __u32 u32;
 
+struct calc_bittiming_const {
+       struct can_bittiming_const bittiming_const;
 
-/*
- * CAN bit-timing parameters
- *
- * For futher information, please read chapter "8 BIT TIMING
- * REQUIREMENTS" of the "Bosch CAN Specification version 2.0"
- * at http://www.semiconductors.bosch.de/pdf/can2spec.pdf.
- */
-struct can_bittiming {
-       __u32 bitrate;          /* Bit-rate in bits/second */
-       __u32 sample_point;     /* Sample point in one-tenth of a percent */
-       __u32 tq;               /* Time quanta (TQ) in nanoseconds */
-       __u32 prop_seg;         /* Propagation segment in TQs */
-       __u32 phase_seg1;       /* Phase buffer segment 1 in TQs */
-       __u32 phase_seg2;       /* Phase buffer segment 2 in TQs */
-       __u32 sjw;              /* Synchronisation jump width in TQs */
-       __u32 brp;              /* Bit-rate prescaler */
-};
-
-/*
- * CAN harware-dependent bit-timing constant
- *
- * Used for calculating and checking bit-timing parameters
- */
-struct can_bittiming_const {
-       char name[16];          /* Name of the CAN controller hardware */
-       __u32 tseg1_min;        /* Time segement 1 = prop_seg + phase_seg1 */
-       __u32 tseg1_max;
-       __u32 tseg2_min;        /* Time segement 2 = phase_seg2 */
-       __u32 tseg2_max;
-       __u32 sjw_max;          /* Synchronisation jump width */
-       __u32 brp_min;          /* Bit-rate prescaler */
-       __u32 brp_max;
-       __u32 brp_inc;
-
-       /* added for can-calc-bit-timing utility */
        __u32 ref_clk;          /* CAN system clock frequency in Hz */
-       void (*printf_btr)(struct can_bittiming *bt, int hdr);
-};
-
-/*
- * CAN clock parameters
- */
-struct can_clock {
-       __u32 freq;             /* CAN system clock frequency in Hz */
+       void (*printf_btr)(struct can_bittiming *bt, bool hdr);
 };
 
-
 /*
  * minimal structs, just enough to be source level compatible
  */
@@ -130,7 +91,7 @@ static inline void *netdev_priv(const struct net_device *dev)
        return (void *)&dev->priv;
 }
 
-static void print_usage(charcmd)
+static void print_usage(char *cmd)
 {
        printf("Usage: %s [options] [<CAN-contoller-name>]\n"
               "\tOptions:\n"
@@ -145,7 +106,7 @@ static void print_usage(char* cmd)
        exit(EXIT_FAILURE);
 }
 
-static void printf_btr_sja1000(struct can_bittiming *bt, int hdr)
+static void printf_btr_sja1000(struct can_bittiming *bt, bool hdr)
 {
        uint8_t btr0, btr1;
 
@@ -159,7 +120,7 @@ static void printf_btr_sja1000(struct can_bittiming *bt, int hdr)
        }
 }
 
-static void printf_btr_at91(struct can_bittiming *bt, int hdr)
+static void printf_btr_at91(struct can_bittiming *bt, bool hdr)
 {
        if (hdr) {
                printf("%10s", "CAN_BR");
@@ -173,7 +134,7 @@ static void printf_btr_at91(struct can_bittiming *bt, int hdr)
        }
 }
 
-static void printf_btr_flexcan(struct can_bittiming *bt, int hdr)
+static void printf_btr_flexcan(struct can_bittiming *bt, bool hdr)
 {
        if (hdr) {
                printf("%10s", "CAN_CTRL");
@@ -188,7 +149,7 @@ static void printf_btr_flexcan(struct can_bittiming *bt, int hdr)
        }
 }
 
-static void printf_btr_mcp251x(struct can_bittiming *bt, int hdr)
+static void printf_btr_mcp251x(struct can_bittiming *bt, bool hdr)
 {
        uint8_t cnf1, cnf2, cnf3;
 
@@ -202,7 +163,7 @@ static void printf_btr_mcp251x(struct can_bittiming *bt, int hdr)
        }
 }
 
-static void printf_btr_ti_hecc(struct can_bittiming *bt, int hdr)
+static void printf_btr_ti_hecc(struct can_bittiming *bt, bool hdr)
 {
        if (hdr) {
                printf("%10s", "CANBTC");
@@ -224,7 +185,7 @@ static void printf_btr_ti_hecc(struct can_bittiming *bt, int hdr)
 #define RCAR_CAN_BCR_SJW(x)    (((x) & 0x3) << 4)
 #define RCAR_CAN_BCR_TSEG2(x)  ((x) & 0x07)
 
-static void printf_btr_rcar_can(struct can_bittiming *bt, int hdr)
+static void printf_btr_rcar_can(struct can_bittiming *bt, bool hdr)
 {
        if (hdr) {
                printf("%10s", "CiBCR");
@@ -240,285 +201,286 @@ static void printf_btr_rcar_can(struct can_bittiming *bt, int hdr)
        }
 }
 
-static struct can_bittiming_const can_calc_consts[] = {
+static struct calc_bittiming_const can_calc_consts[] = {
        {
-               .name = "sja1000",
-               .tseg1_min = 1,
-               .tseg1_max = 16,
-               .tseg2_min = 1,
-               .tseg2_max = 8,
-               .sjw_max = 4,
-               .brp_min = 1,
-               .brp_max = 64,
-               .brp_inc = 1,
-
+               .bittiming_const = {
+                       .name = "sja1000",
+                       .tseg1_min = 1,
+                       .tseg1_max = 16,
+                       .tseg2_min = 1,
+                       .tseg2_max = 8,
+                       .sjw_max = 4,
+                       .brp_min = 1,
+                       .brp_max = 64,
+                       .brp_inc = 1,
+               },
                .ref_clk = 8000000,
                .printf_btr = printf_btr_sja1000,
-       },
-       {
-               .name = "mscan",
-               .tseg1_min = 4,
-               .tseg1_max = 16,
-               .tseg2_min = 2,
-               .tseg2_max = 8,
-               .sjw_max = 4,
-               .brp_min = 1,
-               .brp_max = 64,
-               .brp_inc = 1,
-
+       }, {
+               .bittiming_const = {
+                       .name = "mscan",
+                       .tseg1_min = 4,
+                       .tseg1_max = 16,
+                       .tseg2_min = 2,
+                       .tseg2_max = 8,
+                       .sjw_max = 4,
+                       .brp_min = 1,
+                       .brp_max = 64,
+                       .brp_inc = 1,
+               },
                .ref_clk = 32000000,
                .printf_btr = printf_btr_sja1000,
-       },
-       {
-               .name = "mscan",
-               .tseg1_min = 4,
-               .tseg1_max = 16,
-               .tseg2_min = 2,
-               .tseg2_max = 8,
-               .sjw_max = 4,
-               .brp_min = 1,
-               .brp_max = 64,
-               .brp_inc = 1,
-
+       }, {
+               .bittiming_const = {
+                       .name = "mscan",
+                       .tseg1_min = 4,
+                       .tseg1_max = 16,
+                       .tseg2_min = 2,
+                       .tseg2_max = 8,
+                       .sjw_max = 4,
+                       .brp_min = 1,
+                       .brp_max = 64,
+                       .brp_inc = 1,
+               },
                .ref_clk = 33000000,
                .printf_btr = printf_btr_sja1000,
-       },
-       {
-               .name = "mscan",
-               .tseg1_min = 4,
-               .tseg1_max = 16,
-               .tseg2_min = 2,
-               .tseg2_max = 8,
-               .sjw_max = 4,
-               .brp_min = 1,
-               .brp_max = 64,
-               .brp_inc = 1,
-
+       }, {
+               .bittiming_const = {
+                       .name = "mscan",
+                       .tseg1_min = 4,
+                       .tseg1_max = 16,
+                       .tseg2_min = 2,
+                       .tseg2_max = 8,
+                       .sjw_max = 4,
+                       .brp_min = 1,
+                       .brp_max = 64,
+                       .brp_inc = 1,
+               },
                .ref_clk = 33300000,
                .printf_btr = printf_btr_sja1000,
-       },
-       {
-               .name = "mscan",
-               .tseg1_min = 4,
-               .tseg1_max = 16,
-               .tseg2_min = 2,
-               .tseg2_max = 8,
-               .sjw_max = 4,
-               .brp_min = 1,
-               .brp_max = 64,
-               .brp_inc = 1,
-
+       }, {
+               .bittiming_const = {
+                       .name = "mscan",
+                       .tseg1_min = 4,
+                       .tseg1_max = 16,
+                       .tseg2_min = 2,
+                       .tseg2_max = 8,
+                       .sjw_max = 4,
+                       .brp_min = 1,
+                       .brp_max = 64,
+                       .brp_inc = 1,
+               },
                .ref_clk = 33333333,
                .printf_btr = printf_btr_sja1000,
-       },
-       {
-               .name = "mscan",
-               .tseg1_min = 4,
-               .tseg1_max = 16,
-               .tseg2_min = 2,
-               .tseg2_max = 8,
-               .sjw_max = 4,
-               .brp_min = 1,
-               .brp_max = 64,
-               .brp_inc = 1,
-
+       }, {
+               .bittiming_const = {
+                       .name = "mscan",
+                       .tseg1_min = 4,
+                       .tseg1_max = 16,
+                       .tseg2_min = 2,
+                       .tseg2_max = 8,
+                       .sjw_max = 4,
+                       .brp_min = 1,
+                       .brp_max = 64,
+                       .brp_inc = 1,
+               },
                .ref_clk = 66660000,    /* mpc5121 */
                .printf_btr = printf_btr_sja1000,
-       },
-       {
-               .name = "mscan",
-               .tseg1_min = 4,
-               .tseg1_max = 16,
-               .tseg2_min = 2,
-               .tseg2_max = 8,
-               .sjw_max = 4,
-               .brp_min = 1,
-               .brp_max = 64,
-               .brp_inc = 1,
-
+       }, {
+               .bittiming_const = {
+                       .name = "mscan",
+                       .tseg1_min = 4,
+                       .tseg1_max = 16,
+                       .tseg2_min = 2,
+                       .tseg2_max = 8,
+                       .sjw_max = 4,
+                       .brp_min = 1,
+                       .brp_max = 64,
+                       .brp_inc = 1,
+               },
                .ref_clk = 66666666,    /* mpc5121 */
                .printf_btr = printf_btr_sja1000,
-       },
-       {
-               .name = "at91",
-               .tseg1_min = 4,
-               .tseg1_max = 16,
-               .tseg2_min = 2,
-               .tseg2_max = 8,
-               .sjw_max = 4,
-               .brp_min = 2,
-               .brp_max = 128,
-               .brp_inc = 1,
-
+       }, {
+               .bittiming_const = {
+                       .name = "at91",
+                       .tseg1_min = 4,
+                       .tseg1_max = 16,
+                       .tseg2_min = 2,
+                       .tseg2_max = 8,
+                       .sjw_max = 4,
+                       .brp_min = 2,
+                       .brp_max = 128,
+                       .brp_inc = 1,
+               },
                .ref_clk = 100000000,
                .printf_btr = printf_btr_at91,
-       },
-       {
-               .name = "at91",
-               .tseg1_min = 4,
-               .tseg1_max = 16,
-               .tseg2_min = 2,
-               .tseg2_max = 8,
-               .sjw_max = 4,
-               .brp_min = 2,
-               .brp_max = 128,
-               .brp_inc = 1,
-
+       }, {
+               .bittiming_const = {
+                       .name = "at91",
+                       .tseg1_min = 4,
+                       .tseg1_max = 16,
+                       .tseg2_min = 2,
+                       .tseg2_max = 8,
+                       .sjw_max = 4,
+                       .brp_min = 2,
+                       .brp_max = 128,
+                       .brp_inc = 1,
+               },
                /* real world clock as found on the ronetix PM9263 */
                .ref_clk = 99532800,
                .printf_btr = printf_btr_at91,
-       },
-       {
-               .name = "flexcan",
-               .tseg1_min = 4,
-               .tseg1_max = 16,
-               .tseg2_min = 2,
-               .tseg2_max = 8,
-               .sjw_max = 4,
-               .brp_min = 1,
-               .brp_max = 256,
-               .brp_inc = 1,
-
+       }, {
+               .bittiming_const = {
+                       .name = "flexcan",
+                       .tseg1_min = 4,
+                       .tseg1_max = 16,
+                       .tseg2_min = 2,
+                       .tseg2_max = 8,
+                       .sjw_max = 4,
+                       .brp_min = 1,
+                       .brp_max = 256,
+                       .brp_inc = 1,
+               },
                .ref_clk = 24000000,    /* mx28 */
                .printf_btr = printf_btr_flexcan,
-       },
-       {
-               .name = "flexcan",
-               .tseg1_min = 4,
-               .tseg1_max = 16,
-               .tseg2_min = 2,
-               .tseg2_max = 8,
-               .sjw_max = 4,
-               .brp_min = 1,
-               .brp_max = 256,
-               .brp_inc = 1,
-
+       }, {
+               .bittiming_const = {
+                       .name = "flexcan",
+                       .tseg1_min = 4,
+                       .tseg1_max = 16,
+                       .tseg2_min = 2,
+                       .tseg2_max = 8,
+                       .sjw_max = 4,
+                       .brp_min = 1,
+                       .brp_max = 256,
+                       .brp_inc = 1,
+               },
                .ref_clk = 30000000,    /* mx6 */
                .printf_btr = printf_btr_flexcan,
-       },
-       {
-               .name = "flexcan",
-               .tseg1_min = 4,
-               .tseg1_max = 16,
-               .tseg2_min = 2,
-               .tseg2_max = 8,
-               .sjw_max = 4,
-               .brp_min = 1,
-               .brp_max = 256,
-               .brp_inc = 1,
-
+       }, {
+               .bittiming_const = {
+                       .name = "flexcan",
+                       .tseg1_min = 4,
+                       .tseg1_max = 16,
+                       .tseg2_min = 2,
+                       .tseg2_max = 8,
+                       .sjw_max = 4,
+                       .brp_min = 1,
+                       .brp_max = 256,
+                       .brp_inc = 1,
+               },
                .ref_clk = 49875000,
                .printf_btr = printf_btr_flexcan,
-       },
-       {
-               .name = "flexcan",
-               .tseg1_min = 4,
-               .tseg1_max = 16,
-               .tseg2_min = 2,
-               .tseg2_max = 8,
-               .sjw_max = 4,
-               .brp_min = 1,
-               .brp_max = 256,
-               .brp_inc = 1,
-
+       }, {
+               .bittiming_const = {
+                       .name = "flexcan",
+                       .tseg1_min = 4,
+                       .tseg1_max = 16,
+                       .tseg2_min = 2,
+                       .tseg2_max = 8,
+                       .sjw_max = 4,
+                       .brp_min = 1,
+                       .brp_max = 256,
+                       .brp_inc = 1,
+               },
                .ref_clk = 66000000,
                .printf_btr = printf_btr_flexcan,
-       },
-       {
-               .name = "flexcan",
-               .tseg1_min = 4,
-               .tseg1_max = 16,
-               .tseg2_min = 2,
-               .tseg2_max = 8,
-               .sjw_max = 4,
-               .brp_min = 1,
-               .brp_max = 256,
-               .brp_inc = 1,
-
+       }, {
+               .bittiming_const = {
+                       .name = "flexcan",
+                       .tseg1_min = 4,
+                       .tseg1_max = 16,
+                       .tseg2_min = 2,
+                       .tseg2_max = 8,
+                       .sjw_max = 4,
+                       .brp_min = 1,
+                       .brp_max = 256,
+                       .brp_inc = 1,
+               },
                .ref_clk = 66500000,
                .printf_btr = printf_btr_flexcan,
-       },
-       {
-               .name = "flexcan",
-               .tseg1_min = 4,
-               .tseg1_max = 16,
-               .tseg2_min = 2,
-               .tseg2_max = 8,
-               .sjw_max = 4,
-               .brp_min = 1,
-               .brp_max = 256,
-               .brp_inc = 1,
-
+       }, {
+               .bittiming_const = {
+                       .name = "flexcan",
+                       .tseg1_min = 4,
+                       .tseg1_max = 16,
+                       .tseg2_min = 2,
+                       .tseg2_max = 8,
+                       .sjw_max = 4,
+                       .brp_min = 1,
+                       .brp_max = 256,
+                       .brp_inc = 1,
+               },
                .ref_clk = 66666666,
                .printf_btr = printf_btr_flexcan,
-       },
-       {
-               .name = "flexcan",
-               .tseg1_min = 4,
-               .tseg1_max = 16,
-               .tseg2_min = 2,
-               .tseg2_max = 8,
-               .sjw_max = 4,
-               .brp_min = 1,
-               .brp_max = 256,
-               .brp_inc = 1,
-
+       }, {
+               .bittiming_const = {
+                       .name = "flexcan",
+                       .tseg1_min = 4,
+                       .tseg1_max = 16,
+                       .tseg2_min = 2,
+                       .tseg2_max = 8,
+                       .sjw_max = 4,
+                       .brp_min = 1,
+                       .brp_max = 256,
+                       .brp_inc = 1,
+               },
                .ref_clk = 83368421,
                .printf_btr = printf_btr_flexcan, /* vybrid */
-       },
-       {
-               .name = "mcp251x",
-               .tseg1_min = 3,
-               .tseg1_max = 16,
-               .tseg2_min = 2,
-               .tseg2_max = 8,
-               .sjw_max = 4,
-               .brp_min = 1,
-               .brp_max = 64,
-               .brp_inc = 1,
-
+       }, {
+               .bittiming_const = {
+                       .name = "mcp251x",
+                       .tseg1_min = 3,
+                       .tseg1_max = 16,
+                       .tseg2_min = 2,
+                       .tseg2_max = 8,
+                       .sjw_max = 4,
+                       .brp_min = 1,
+                       .brp_max = 64,
+                       .brp_inc = 1,
+               },
                .ref_clk = 8000000,
                .printf_btr = printf_btr_mcp251x,
-       },
-       {
-               .name = "mcp251x",
-               .tseg1_min = 3,
-               .tseg1_max = 16,
-               .tseg2_min = 2,
-               .tseg2_max = 8,
-               .sjw_max = 4,
-               .brp_min = 1,
-               .brp_max = 64,
-               .brp_inc = 1,
-
+       }, {
+               .bittiming_const = {
+                       .name = "mcp251x",
+                       .tseg1_min = 3,
+                       .tseg1_max = 16,
+                       .tseg2_min = 2,
+                       .tseg2_max = 8,
+                       .sjw_max = 4,
+                       .brp_min = 1,
+                       .brp_max = 64,
+                       .brp_inc = 1,
+               },
                .ref_clk = 16000000,
                .printf_btr = printf_btr_mcp251x,
-       },
-       {
-               .name = "ti_hecc",
-               .tseg1_min = 1,
-               .tseg1_max = 16,
-               .tseg2_min = 1,
-               .tseg2_max = 8,
-               .sjw_max = 4,
-               .brp_min = 1,
-               .brp_max = 256,
-               .brp_inc = 1,
-
+       }, {
+               .bittiming_const = {
+                       .name = "ti_hecc",
+                       .tseg1_min = 1,
+                       .tseg1_max = 16,
+                       .tseg2_min = 1,
+                       .tseg2_max = 8,
+                       .sjw_max = 4,
+                       .brp_min = 1,
+                       .brp_max = 256,
+                       .brp_inc = 1,
+               },
                .ref_clk = 13000000,
                .printf_btr = printf_btr_ti_hecc,
-       },
-       {
-               .name = "rcar_can",
-               .tseg1_min = 4,
-               .tseg1_max = 16,
-               .tseg2_min = 2,
-               .tseg2_max = 8,
-               .sjw_max = 4,
-               .brp_min = 1,
-               .brp_max = 1024,
-               .brp_inc = 1,
-
+       }, {
+               .bittiming_const = {
+                       .name = "rcar_can",
+                       .tseg1_min = 4,
+                       .tseg1_max = 16,
+                       .tseg2_min = 2,
+                       .tseg2_max = 8,
+                       .sjw_max = 4,
+                       .brp_min = 1,
+                       .brp_max = 1024,
+                       .brp_inc = 1,
+               },
                .ref_clk = 65000000,
                .printf_btr = printf_btr_rcar_can,
        },
@@ -661,12 +623,12 @@ static __u32 get_cia_sample_point(__u32 bitrate)
        return sampl_pt;
 }
 
-static void print_bit_timing(const struct can_bittiming_const *btc,
+static void print_bit_timing(const struct calc_bittiming_const *btc,
                             __u32 bitrate, __u32 sample_point, __u32 ref_clk,
-                            int quiet)
+                            bool quiet)
 {
        struct net_device dev = {
-               .priv.bittiming_const = btc,
+               .priv.bittiming_const = &btc->bittiming_const,
                .priv.clock.freq = ref_clk,
        };
        struct can_bittiming bt = {
@@ -679,10 +641,10 @@ static void print_bit_timing(const struct can_bittiming_const *btc,
                printf("Bit timing parameters for %s with %.6f MHz ref clock\n"
                       "nominal                                 real Bitrt   nom  real SampP\n"
                       "Bitrate TQ[ns] PrS PhS1 PhS2 SJW BRP Bitrate Error SampP SampP Error ",
-                      btc->name,
+                      btc->bittiming_const.name,
                       ref_clk / 1000000.0);
 
-               btc->printf_btr(&bt, 1);
+               btc->printf_btr(&bt, true);
                printf("\n");
        }
 
@@ -714,7 +676,7 @@ static void print_bit_timing(const struct can_bittiming_const *btc,
               bt.sample_point / 10.0,
               100.0 * spt_error / sample_point);
 
-       btc->printf_btr(&bt, 0);
+       btc->printf_btr(&bt, false);
        printf("\n");
 }
 
@@ -723,7 +685,7 @@ static void do_list(void)
        unsigned int i;
 
        for (i = 0; i < ARRAY_SIZE(can_calc_consts); i++)
-               printf("%s\n", can_calc_consts[i].name);
+               printf("%s\n", can_calc_consts[i].bittiming_const.name);
 }
 
 int main(int argc, char *argv[])
@@ -731,13 +693,12 @@ int main(int argc, char *argv[])
        __u32 bitrate = 0;
        __u32 opt_ref_clk = 0, ref_clk;
        int sampl_pt = 0;
-       int quiet = 0;
-       int list = 0;
+       bool quiet = false, list = false, found = false;
        char *name = NULL;
        unsigned int i, j;
-       int opt, found = 0;
+       int opt;
 
-       const struct can_bittiming_const *btc = NULL;
+       const struct calc_bittiming_const *btc = NULL;
 
        while ((opt = getopt(argc, argv, "b:c:lps:")) != -1) {
                switch (opt) {
@@ -750,11 +711,11 @@ int main(int argc, char *argv[])
                        break;
 
                case 'l':
-                       list = 1;
+                       list = true;
                        break;
 
                case 'q':
-                       quiet = 1;
+                       quiet = true;
                        break;
 
                case 's':
@@ -782,10 +743,10 @@ int main(int argc, char *argv[])
                print_usage(argv[0]);
 
        for (i = 0; i < ARRAY_SIZE(can_calc_consts); i++) {
-               if (name && strcmp(can_calc_consts[i].name, name))
+               if (name && strcmp(can_calc_consts[i].bittiming_const.name, name))
                        continue;
 
-               found = 1;
+               found = true;
                btc = &can_calc_consts[i];
 
                if (opt_ref_clk)