1 /* SPDX-License-Identifier: GPL-2.0 */
5 * Definitions for the CAN network device driver interface
7 * Copyright (C) 2006 Andrey Volkov <avolkov@varma-el.com>
10 * Copyright (C) 2008 Wolfgang Grandegger <wg@grandegger.com>
17 #include <linux/can.h>
18 #include <linux/can/bittiming.h>
19 #include <linux/can/error.h>
20 #include <linux/can/led.h>
21 #include <linux/can/length.h>
22 #include <linux/can/netlink.h>
23 #include <linux/can/skb.h>
24 #include <linux/netdevice.h>
36 * CAN common private data
39 struct net_device *dev;
40 struct can_device_stats can_stats;
42 struct can_bittiming bittiming, data_bittiming;
43 const struct can_bittiming_const *bittiming_const,
44 *data_bittiming_const;
46 const struct can_tdc_const *tdc_const;
48 const u16 *termination_const;
49 unsigned int termination_const_cnt;
51 const u32 *bitrate_const;
52 unsigned int bitrate_const_cnt;
53 const u32 *data_bitrate_const;
54 unsigned int data_bitrate_const_cnt;
56 struct can_clock clock;
60 /* CAN controller features - see include/uapi/linux/can/netlink.h */
61 u32 ctrlmode; /* current options setting */
62 u32 ctrlmode_supported; /* options that can be modified by netlink */
63 u32 ctrlmode_static; /* static enabled options for driver/hardware */
66 struct delayed_work restart_work;
68 int (*do_set_bittiming)(struct net_device *dev);
69 int (*do_set_data_bittiming)(struct net_device *dev);
70 int (*do_set_mode)(struct net_device *dev, enum can_mode mode);
71 int (*do_set_termination)(struct net_device *dev, u16 term);
72 int (*do_get_state)(const struct net_device *dev,
73 enum can_state *state);
74 int (*do_get_berr_counter)(const struct net_device *dev,
75 struct can_berr_counter *bec);
77 unsigned int echo_skb_max;
78 struct sk_buff **echo_skb;
80 #ifdef CONFIG_CAN_LEDS
81 struct led_trigger *tx_led_trig;
82 char tx_led_trig_name[CAN_LED_NAME_SZ];
83 struct led_trigger *rx_led_trig;
84 char rx_led_trig_name[CAN_LED_NAME_SZ];
85 struct led_trigger *rxtx_led_trig;
86 char rxtx_led_trig_name[CAN_LED_NAME_SZ];
91 /* helper to define static CAN controller features at device creation time */
92 static inline void can_set_static_ctrlmode(struct net_device *dev,
95 struct can_priv *priv = netdev_priv(dev);
97 /* alloc_candev() succeeded => netdev_priv() is valid at this point */
98 priv->ctrlmode = static_mode;
99 priv->ctrlmode_static = static_mode;
101 /* override MTU which was set by default in can_setup()? */
102 if (static_mode & CAN_CTRLMODE_FD)
103 dev->mtu = CANFD_MTU;
106 void can_setup(struct net_device *dev);
108 struct net_device *alloc_candev_mqs(int sizeof_priv, unsigned int echo_skb_max,
109 unsigned int txqs, unsigned int rxqs);
110 #define alloc_candev(sizeof_priv, echo_skb_max) \
111 alloc_candev_mqs(sizeof_priv, echo_skb_max, 1, 1)
112 #define alloc_candev_mq(sizeof_priv, echo_skb_max, count) \
113 alloc_candev_mqs(sizeof_priv, echo_skb_max, count, count)
114 void free_candev(struct net_device *dev);
116 /* a candev safe wrapper around netdev_priv */
117 struct can_priv *safe_candev_priv(struct net_device *dev);
119 int open_candev(struct net_device *dev);
120 void close_candev(struct net_device *dev);
121 int can_change_mtu(struct net_device *dev, int new_mtu);
123 int register_candev(struct net_device *dev);
124 void unregister_candev(struct net_device *dev);
126 int can_restart_now(struct net_device *dev);
127 void can_bus_off(struct net_device *dev);
129 const char *can_get_state_str(const enum can_state state);
130 void can_change_state(struct net_device *dev, struct can_frame *cf,
131 enum can_state tx_state, enum can_state rx_state);
134 void of_can_transceiver(struct net_device *dev);
136 static inline void of_can_transceiver(struct net_device *dev) { }
139 extern struct rtnl_link_ops can_link_ops;
140 int can_netlink_register(void);
141 void can_netlink_unregister(void);
143 #endif /* !_CAN_DEV_H */