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/length.h>
21 #include <linux/can/netlink.h>
22 #include <linux/can/skb.h>
23 #include <linux/ethtool.h>
24 #include <linux/netdevice.h>
35 enum can_termination_gpio {
36 CAN_TERMINATION_GPIO_DISABLED = 0,
37 CAN_TERMINATION_GPIO_ENABLED,
38 CAN_TERMINATION_GPIO_MAX,
42 * CAN common private data
45 struct net_device *dev;
46 struct can_device_stats can_stats;
48 const struct can_bittiming_const *bittiming_const,
49 *data_bittiming_const;
50 struct can_bittiming bittiming, data_bittiming;
51 const struct can_tdc_const *tdc_const;
54 unsigned int bitrate_const_cnt;
55 const u32 *bitrate_const;
56 const u32 *data_bitrate_const;
57 unsigned int data_bitrate_const_cnt;
59 struct can_clock clock;
61 unsigned int termination_const_cnt;
62 const u16 *termination_const;
64 struct gpio_desc *termination_gpio;
65 u16 termination_gpio_ohms[CAN_TERMINATION_GPIO_MAX];
67 unsigned int echo_skb_max;
68 struct sk_buff **echo_skb;
72 /* CAN controller features - see include/uapi/linux/can/netlink.h */
73 u32 ctrlmode; /* current options setting */
74 u32 ctrlmode_supported; /* options that can be modified by netlink */
77 struct delayed_work restart_work;
79 int (*do_set_bittiming)(struct net_device *dev);
80 int (*do_set_data_bittiming)(struct net_device *dev);
81 int (*do_set_mode)(struct net_device *dev, enum can_mode mode);
82 int (*do_set_termination)(struct net_device *dev, u16 term);
83 int (*do_get_state)(const struct net_device *dev,
84 enum can_state *state);
85 int (*do_get_berr_counter)(const struct net_device *dev,
86 struct can_berr_counter *bec);
87 int (*do_get_auto_tdcv)(const struct net_device *dev, u32 *tdcv);
90 static inline bool can_tdc_is_enabled(const struct can_priv *priv)
92 return !!(priv->ctrlmode & CAN_CTRLMODE_TDC_MASK);
96 * can_get_relative_tdco() - TDCO relative to the sample point
98 * struct can_tdc::tdco represents the absolute offset from TDCV. Some
99 * controllers use instead an offset relative to the Sample Point (SP)
102 * SSP = TDCV + absolute TDCO
103 * = TDCV + SP + relative TDCO
105 * -+----------- one bit ----------+-- TX pin
106 * |<--- Sample Point --->|
108 * --+----------- one bit ----------+-- RX pin
109 * |<-------- TDCV -------->|
110 * |<------------------------>| absolute TDCO
111 * |<--- Sample Point --->|
112 * | |<->| relative TDCO
113 * |<------------- Secondary Sample Point ------------>|
115 static inline s32 can_get_relative_tdco(const struct can_priv *priv)
117 const struct can_bittiming *dbt = &priv->data_bittiming;
118 s32 sample_point_in_tc = (CAN_SYNC_SEG + dbt->prop_seg +
119 dbt->phase_seg1) * dbt->brp;
121 return (s32)priv->tdc.tdco - sample_point_in_tc;
124 /* helper to define static CAN controller features at device creation time */
125 static inline int __must_check can_set_static_ctrlmode(struct net_device *dev,
128 struct can_priv *priv = netdev_priv(dev);
130 /* alloc_candev() succeeded => netdev_priv() is valid at this point */
131 if (priv->ctrlmode_supported & static_mode) {
133 "Controller features can not be supported and static at the same time\n");
136 priv->ctrlmode = static_mode;
138 /* override MTU which was set by default in can_setup()? */
139 if (static_mode & CAN_CTRLMODE_FD)
140 dev->mtu = CANFD_MTU;
145 static inline u32 can_get_static_ctrlmode(struct can_priv *priv)
147 return priv->ctrlmode & ~priv->ctrlmode_supported;
150 /* drop skb if it does not contain a valid CAN frame for sending */
151 static inline bool can_dev_dropped_skb(struct net_device *dev, struct sk_buff *skb)
153 struct can_priv *priv = netdev_priv(dev);
155 if (priv->ctrlmode & CAN_CTRLMODE_LISTENONLY) {
156 netdev_info_once(dev,
157 "interface in listen only mode, dropping skb\n");
159 dev->stats.tx_dropped++;
163 return can_dropped_invalid_skb(dev, skb);
166 void can_setup(struct net_device *dev);
168 struct net_device *alloc_candev_mqs(int sizeof_priv, unsigned int echo_skb_max,
169 unsigned int txqs, unsigned int rxqs);
170 #define alloc_candev(sizeof_priv, echo_skb_max) \
171 alloc_candev_mqs(sizeof_priv, echo_skb_max, 1, 1)
172 #define alloc_candev_mq(sizeof_priv, echo_skb_max, count) \
173 alloc_candev_mqs(sizeof_priv, echo_skb_max, count, count)
174 void free_candev(struct net_device *dev);
176 /* a candev safe wrapper around netdev_priv */
177 struct can_priv *safe_candev_priv(struct net_device *dev);
179 int open_candev(struct net_device *dev);
180 void close_candev(struct net_device *dev);
181 int can_change_mtu(struct net_device *dev, int new_mtu);
182 int can_eth_ioctl_hwts(struct net_device *netdev, struct ifreq *ifr, int cmd);
183 int can_ethtool_op_get_ts_info_hwts(struct net_device *dev,
184 struct ethtool_ts_info *info);
186 int register_candev(struct net_device *dev);
187 void unregister_candev(struct net_device *dev);
189 int can_restart_now(struct net_device *dev);
190 void can_bus_off(struct net_device *dev);
192 const char *can_get_state_str(const enum can_state state);
193 void can_change_state(struct net_device *dev, struct can_frame *cf,
194 enum can_state tx_state, enum can_state rx_state);
197 void of_can_transceiver(struct net_device *dev);
199 static inline void of_can_transceiver(struct net_device *dev) { }
202 extern struct rtnl_link_ops can_link_ops;
203 int can_netlink_register(void);
204 void can_netlink_unregister(void);
206 #endif /* !_CAN_DEV_H */