dev.h 2.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103
  1. /*
  2. * linux/can/dev.h
  3. *
  4. * Definitions for the CAN network device driver interface
  5. *
  6. * Copyright (C) 2006 Andrey Volkov <avolkov@varma-el.com>
  7. * Varma Electronics Oy
  8. *
  9. * Copyright (C) 2008 Wolfgang Grandegger <wg@grandegger.com>
  10. *
  11. */
  12. #ifndef CAN_DEV_H
  13. #define CAN_DEV_H
  14. #include <linux/can.h>
  15. #include <linux/can/netlink.h>
  16. #include <linux/can/error.h>
  17. /*
  18. * CAN mode
  19. */
  20. enum can_mode {
  21. CAN_MODE_STOP = 0,
  22. CAN_MODE_START,
  23. CAN_MODE_SLEEP
  24. };
  25. /*
  26. * CAN common private data
  27. */
  28. struct can_priv {
  29. struct can_device_stats can_stats;
  30. struct can_bittiming bittiming;
  31. struct can_bittiming_const *bittiming_const;
  32. struct can_clock clock;
  33. enum can_state state;
  34. u32 ctrlmode;
  35. u32 ctrlmode_supported;
  36. int restart_ms;
  37. struct timer_list restart_timer;
  38. int (*do_set_bittiming)(struct net_device *dev);
  39. int (*do_set_mode)(struct net_device *dev, enum can_mode mode);
  40. int (*do_get_state)(const struct net_device *dev,
  41. enum can_state *state);
  42. int (*do_get_berr_counter)(const struct net_device *dev,
  43. struct can_berr_counter *bec);
  44. unsigned int echo_skb_max;
  45. struct sk_buff **echo_skb;
  46. };
  47. /*
  48. * get_can_dlc(value) - helper macro to cast a given data length code (dlc)
  49. * to __u8 and ensure the dlc value to be max. 8 bytes.
  50. *
  51. * To be used in the CAN netdriver receive path to ensure conformance with
  52. * ISO 11898-1 Chapter 8.4.2.3 (DLC field)
  53. */
  54. #define get_can_dlc(i) (min_t(__u8, (i), 8))
  55. /* Drop a given socketbuffer if it does not contain a valid CAN frame. */
  56. static inline int can_dropped_invalid_skb(struct net_device *dev,
  57. struct sk_buff *skb)
  58. {
  59. const struct can_frame *cf = (struct can_frame *)skb->data;
  60. if (unlikely(skb->len != sizeof(*cf) || cf->can_dlc > 8)) {
  61. kfree_skb(skb);
  62. dev->stats.tx_dropped++;
  63. return 1;
  64. }
  65. return 0;
  66. }
  67. struct net_device *alloc_candev(int sizeof_priv, unsigned int echo_skb_max);
  68. void free_candev(struct net_device *dev);
  69. int open_candev(struct net_device *dev);
  70. void close_candev(struct net_device *dev);
  71. int register_candev(struct net_device *dev);
  72. void unregister_candev(struct net_device *dev);
  73. int can_restart_now(struct net_device *dev);
  74. void can_bus_off(struct net_device *dev);
  75. void can_put_echo_skb(struct sk_buff *skb, struct net_device *dev,
  76. unsigned int idx);
  77. unsigned int can_get_echo_skb(struct net_device *dev, unsigned int idx);
  78. void can_free_echo_skb(struct net_device *dev, unsigned int idx);
  79. struct sk_buff *alloc_can_skb(struct net_device *dev, struct can_frame **cf);
  80. struct sk_buff *alloc_can_err_skb(struct net_device *dev,
  81. struct can_frame **cf);
  82. #endif /* CAN_DEV_H */