can_netlink.h 3.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124
  1. /*
  2. * linux/can/netlink.h
  3. *
  4. * Definitions for the CAN netlink interface
  5. *
  6. * Copyright (c) 2009 Wolfgang Grandegger <wg@grandegger.com>
  7. *
  8. * Send feedback to <socketcan-users@lists.berlios.de>
  9. *
  10. */
  11. #ifndef CAN_NETLINK_H
  12. #define CAN_NETLINK_H
  13. #include <linux/types.h>
  14. /*
  15. * CAN bit-timing parameters
  16. *
  17. * For futher information, please read chapter "8 BIT TIMING
  18. * REQUIREMENTS" of the "Bosch CAN Specification version 2.0"
  19. * at http://www.semiconductors.bosch.de/pdf/can2spec.pdf.
  20. */
  21. struct can_bittiming {
  22. __u32 bitrate; /* Bit-rate in bits/second */
  23. __u32 sample_point; /* Sample point in one-tenth of a percent */
  24. __u32 tq; /* Time quanta (TQ) in nanoseconds */
  25. __u32 prop_seg; /* Propagation segment in TQs */
  26. __u32 phase_seg1; /* Phase buffer segment 1 in TQs */
  27. __u32 phase_seg2; /* Phase buffer segment 2 in TQs */
  28. __u32 sjw; /* Synchronisation jump width in TQs */
  29. __u32 brp; /* Bit-rate prescaler */
  30. };
  31. /*
  32. * CAN harware-dependent bit-timing constant
  33. *
  34. * Used for calculating and checking bit-timing parameters
  35. */
  36. struct can_bittiming_const {
  37. char name[16]; /* Name of the CAN controller hardware */
  38. __u32 tseg1_min; /* Time segement 1 = prop_seg + phase_seg1 */
  39. __u32 tseg1_max;
  40. __u32 tseg2_min; /* Time segement 2 = phase_seg2 */
  41. __u32 tseg2_max;
  42. __u32 sjw_max; /* Synchronisation jump width */
  43. __u32 brp_min; /* Bit-rate prescaler */
  44. __u32 brp_max;
  45. __u32 brp_inc;
  46. };
  47. /*
  48. * CAN clock parameters
  49. */
  50. struct can_clock {
  51. __u32 freq; /* CAN system clock frequency in Hz */
  52. };
  53. /*
  54. * CAN operational and error states
  55. */
  56. enum can_state {
  57. CAN_STATE_ERROR_ACTIVE = 0, /* RX/TX error count < 96 */
  58. CAN_STATE_ERROR_WARNING, /* RX/TX error count < 128 */
  59. CAN_STATE_ERROR_PASSIVE, /* RX/TX error count < 256 */
  60. CAN_STATE_BUS_OFF, /* RX/TX error count >= 256 */
  61. CAN_STATE_STOPPED, /* Device is stopped */
  62. CAN_STATE_SLEEPING, /* Device is sleeping */
  63. CAN_STATE_MAX
  64. };
  65. /*
  66. * CAN bus error counters
  67. */
  68. struct can_berr_counter {
  69. __u16 txerr;
  70. __u16 rxerr;
  71. };
  72. /*
  73. * CAN controller mode
  74. */
  75. struct can_ctrlmode {
  76. __u32 mask;
  77. __u32 flags;
  78. };
  79. #define CAN_CTRLMODE_LOOPBACK 0x01 /* Loopback mode */
  80. #define CAN_CTRLMODE_LISTENONLY 0x02 /* Listen-only mode */
  81. #define CAN_CTRLMODE_3_SAMPLES 0x04 /* Triple sampling mode */
  82. #define CAN_CTRLMODE_ONE_SHOT 0x08 /* One-Shot mode */
  83. #define CAN_CTRLMODE_BERR_REPORTING 0x10 /* Bus-error reporting */
  84. /*
  85. * CAN device statistics
  86. */
  87. struct can_device_stats {
  88. __u32 bus_error; /* Bus errors */
  89. __u32 error_warning; /* Changes to error warning state */
  90. __u32 error_passive; /* Changes to error passive state */
  91. __u32 bus_off; /* Changes to bus off state */
  92. __u32 arbitration_lost; /* Arbitration lost errors */
  93. __u32 restarts; /* CAN controller re-starts */
  94. };
  95. /*
  96. * CAN netlink interface
  97. */
  98. enum {
  99. IFLA_CAN_UNSPEC,
  100. IFLA_CAN_BITTIMING,
  101. IFLA_CAN_BITTIMING_CONST,
  102. IFLA_CAN_CLOCK,
  103. IFLA_CAN_STATE,
  104. IFLA_CAN_CTRLMODE,
  105. IFLA_CAN_RESTART_MS,
  106. IFLA_CAN_RESTART,
  107. IFLA_CAN_BERR_COUNTER,
  108. __IFLA_CAN_MAX
  109. };
  110. #define IFLA_CAN_MAX (__IFLA_CAN_MAX - 1)
  111. #endif /* CAN_NETLINK_H */