1 /* SPDX-License-Identifier: GPL-2.0 */ 1 /* SPDX-License-Identifier: GPL-2.0 */
2 /* 2 /*
3 * linux/can/dev.h 3 * linux/can/dev.h
4 * 4 *
5 * Definitions for the CAN network device driv 5 * Definitions for the CAN network device driver interface
6 * 6 *
7 * Copyright (C) 2006 Andrey Volkov <avolkov@v 7 * Copyright (C) 2006 Andrey Volkov <avolkov@varma-el.com>
8 * Varma Electronics Oy 8 * Varma Electronics Oy
9 * 9 *
10 * Copyright (C) 2008 Wolfgang Grandegger <wg@ 10 * Copyright (C) 2008 Wolfgang Grandegger <wg@grandegger.com>
11 * 11 *
12 */ 12 */
13 13
14 #ifndef _CAN_DEV_H 14 #ifndef _CAN_DEV_H
15 #define _CAN_DEV_H 15 #define _CAN_DEV_H
16 16
17 #include <linux/can.h> 17 #include <linux/can.h>
18 #include <linux/can/bittiming.h> 18 #include <linux/can/bittiming.h>
19 #include <linux/can/error.h> 19 #include <linux/can/error.h>
>> 20 #include <linux/can/led.h>
20 #include <linux/can/length.h> 21 #include <linux/can/length.h>
21 #include <linux/can/netlink.h> 22 #include <linux/can/netlink.h>
22 #include <linux/can/skb.h> 23 #include <linux/can/skb.h>
23 #include <linux/ethtool.h> <<
24 #include <linux/netdevice.h> 24 #include <linux/netdevice.h>
25 25
26 /* 26 /*
27 * CAN mode 27 * CAN mode
28 */ 28 */
29 enum can_mode { 29 enum can_mode {
30 CAN_MODE_STOP = 0, 30 CAN_MODE_STOP = 0,
31 CAN_MODE_START, 31 CAN_MODE_START,
32 CAN_MODE_SLEEP 32 CAN_MODE_SLEEP
33 }; 33 };
34 34
35 enum can_termination_gpio { <<
36 CAN_TERMINATION_GPIO_DISABLED = 0, <<
37 CAN_TERMINATION_GPIO_ENABLED, <<
38 CAN_TERMINATION_GPIO_MAX, <<
39 }; <<
40 <<
41 /* 35 /*
42 * CAN common private data 36 * CAN common private data
43 */ 37 */
44 struct can_priv { 38 struct can_priv {
45 struct net_device *dev; 39 struct net_device *dev;
46 struct can_device_stats can_stats; 40 struct can_device_stats can_stats;
47 41
48 const struct can_bittiming_const *bitt 42 const struct can_bittiming_const *bittiming_const,
49 *data_bittiming_const; 43 *data_bittiming_const;
50 struct can_bittiming bittiming, data_b 44 struct can_bittiming bittiming, data_bittiming;
51 const struct can_tdc_const *tdc_const; 45 const struct can_tdc_const *tdc_const;
52 struct can_tdc tdc; 46 struct can_tdc tdc;
53 47
54 unsigned int bitrate_const_cnt; 48 unsigned int bitrate_const_cnt;
55 const u32 *bitrate_const; 49 const u32 *bitrate_const;
56 const u32 *data_bitrate_const; 50 const u32 *data_bitrate_const;
57 unsigned int data_bitrate_const_cnt; 51 unsigned int data_bitrate_const_cnt;
58 u32 bitrate_max; 52 u32 bitrate_max;
59 struct can_clock clock; 53 struct can_clock clock;
60 54
61 unsigned int termination_const_cnt; 55 unsigned int termination_const_cnt;
62 const u16 *termination_const; 56 const u16 *termination_const;
63 u16 termination; 57 u16 termination;
64 struct gpio_desc *termination_gpio; <<
65 u16 termination_gpio_ohms[CAN_TERMINAT <<
66 <<
67 unsigned int echo_skb_max; <<
68 struct sk_buff **echo_skb; <<
69 58
70 enum can_state state; 59 enum can_state state;
71 60
72 /* CAN controller features - see inclu 61 /* CAN controller features - see include/uapi/linux/can/netlink.h */
73 u32 ctrlmode; /* current opt 62 u32 ctrlmode; /* current options setting */
74 u32 ctrlmode_supported; /* options tha 63 u32 ctrlmode_supported; /* options that can be modified by netlink */
>> 64 u32 ctrlmode_static; /* static enabled options for driver/hardware */
75 65
76 int restart_ms; 66 int restart_ms;
77 struct delayed_work restart_work; 67 struct delayed_work restart_work;
78 68
79 int (*do_set_bittiming)(struct net_dev 69 int (*do_set_bittiming)(struct net_device *dev);
80 int (*do_set_data_bittiming)(struct ne 70 int (*do_set_data_bittiming)(struct net_device *dev);
81 int (*do_set_mode)(struct net_device * 71 int (*do_set_mode)(struct net_device *dev, enum can_mode mode);
82 int (*do_set_termination)(struct net_d 72 int (*do_set_termination)(struct net_device *dev, u16 term);
83 int (*do_get_state)(const struct net_d 73 int (*do_get_state)(const struct net_device *dev,
84 enum can_state *st 74 enum can_state *state);
85 int (*do_get_berr_counter)(const struc 75 int (*do_get_berr_counter)(const struct net_device *dev,
86 struct can_ 76 struct can_berr_counter *bec);
87 int (*do_get_auto_tdcv)(const struct n <<
88 }; <<
89 77
90 static inline bool can_tdc_is_enabled(const st !! 78 unsigned int echo_skb_max;
91 { !! 79 struct sk_buff **echo_skb;
92 return !!(priv->ctrlmode & CAN_CTRLMOD <<
93 } <<
94 80
95 /* !! 81 #ifdef CONFIG_CAN_LEDS
96 * can_get_relative_tdco() - TDCO relative to !! 82 struct led_trigger *tx_led_trig;
97 * !! 83 char tx_led_trig_name[CAN_LED_NAME_SZ];
98 * struct can_tdc::tdco represents the absolut !! 84 struct led_trigger *rx_led_trig;
99 * controllers use instead an offset relative !! 85 char rx_led_trig_name[CAN_LED_NAME_SZ];
100 * such that: !! 86 struct led_trigger *rxtx_led_trig;
101 * !! 87 char rxtx_led_trig_name[CAN_LED_NAME_SZ];
102 * SSP = TDCV + absolute TDCO !! 88 #endif
103 * = TDCV + SP + relative TDCO !! 89 };
104 * <<
105 * -+----------- one bit ----------+-- TX pin <<
106 * |<--- Sample Point --->| <<
107 * <<
108 * --+----------- one <<
109 * |<-------- TDCV -------->| <<
110 * |<--------------- <<
111 * |<--- Sample Poin <<
112 * | <<
113 * |<------------- Secondary Sample Point --- <<
114 */ <<
115 static inline s32 can_get_relative_tdco(const <<
116 { <<
117 const struct can_bittiming *dbt = &pri <<
118 s32 sample_point_in_tc = (CAN_SYNC_SEG <<
119 dbt->phase_s <<
120 90
121 return (s32)priv->tdc.tdco - sample_po <<
122 } <<
123 91
124 /* helper to define static CAN controller feat 92 /* helper to define static CAN controller features at device creation time */
125 static inline int __must_check can_set_static_ !! 93 static inline void can_set_static_ctrlmode(struct net_device *dev,
126 !! 94 u32 static_mode)
127 { 95 {
128 struct can_priv *priv = netdev_priv(de 96 struct can_priv *priv = netdev_priv(dev);
129 97
130 /* alloc_candev() succeeded => netdev_ 98 /* alloc_candev() succeeded => netdev_priv() is valid at this point */
131 if (priv->ctrlmode_supported & static_ <<
132 netdev_warn(dev, <<
133 "Controller featur <<
134 return -EINVAL; <<
135 } <<
136 priv->ctrlmode = static_mode; 99 priv->ctrlmode = static_mode;
>> 100 priv->ctrlmode_static = static_mode;
137 101
138 /* override MTU which was set by defau 102 /* override MTU which was set by default in can_setup()? */
139 if (static_mode & CAN_CTRLMODE_FD) 103 if (static_mode & CAN_CTRLMODE_FD)
140 dev->mtu = CANFD_MTU; 104 dev->mtu = CANFD_MTU;
141 <<
142 return 0; <<
143 } <<
144 <<
145 static inline u32 can_get_static_ctrlmode(stru <<
146 { <<
147 return priv->ctrlmode & ~priv->ctrlmod <<
148 } <<
149 <<
150 static inline bool can_is_canxl_dev_mtu(unsign <<
151 { <<
152 return (mtu >= CANXL_MIN_MTU && mtu <= <<
153 } <<
154 <<
155 /* drop skb if it does not contain a valid CAN <<
156 static inline bool can_dev_dropped_skb(struct <<
157 { <<
158 struct can_priv *priv = netdev_priv(de <<
159 <<
160 if (priv->ctrlmode & CAN_CTRLMODE_LIST <<
161 netdev_info_once(dev, <<
162 "interface in <<
163 kfree_skb(skb); <<
164 dev->stats.tx_dropped++; <<
165 return true; <<
166 } <<
167 <<
168 return can_dropped_invalid_skb(dev, sk <<
169 } 105 }
170 106
171 void can_setup(struct net_device *dev); 107 void can_setup(struct net_device *dev);
172 108
173 struct net_device *alloc_candev_mqs(int sizeof 109 struct net_device *alloc_candev_mqs(int sizeof_priv, unsigned int echo_skb_max,
174 unsigned i 110 unsigned int txqs, unsigned int rxqs);
175 #define alloc_candev(sizeof_priv, echo_skb_max 111 #define alloc_candev(sizeof_priv, echo_skb_max) \
176 alloc_candev_mqs(sizeof_priv, echo_skb 112 alloc_candev_mqs(sizeof_priv, echo_skb_max, 1, 1)
177 #define alloc_candev_mq(sizeof_priv, echo_skb_ 113 #define alloc_candev_mq(sizeof_priv, echo_skb_max, count) \
178 alloc_candev_mqs(sizeof_priv, echo_skb 114 alloc_candev_mqs(sizeof_priv, echo_skb_max, count, count)
179 void free_candev(struct net_device *dev); 115 void free_candev(struct net_device *dev);
180 116
181 /* a candev safe wrapper around netdev_priv */ 117 /* a candev safe wrapper around netdev_priv */
182 struct can_priv *safe_candev_priv(struct net_d 118 struct can_priv *safe_candev_priv(struct net_device *dev);
183 119
184 int open_candev(struct net_device *dev); 120 int open_candev(struct net_device *dev);
185 void close_candev(struct net_device *dev); 121 void close_candev(struct net_device *dev);
186 int can_change_mtu(struct net_device *dev, int 122 int can_change_mtu(struct net_device *dev, int new_mtu);
187 int can_eth_ioctl_hwts(struct net_device *netd <<
188 int can_ethtool_op_get_ts_info_hwts(struct net <<
189 struct ker <<
190 123
191 int register_candev(struct net_device *dev); 124 int register_candev(struct net_device *dev);
192 void unregister_candev(struct net_device *dev) 125 void unregister_candev(struct net_device *dev);
193 126
194 int can_restart_now(struct net_device *dev); 127 int can_restart_now(struct net_device *dev);
195 void can_bus_off(struct net_device *dev); 128 void can_bus_off(struct net_device *dev);
196 129
197 const char *can_get_state_str(const enum can_s 130 const char *can_get_state_str(const enum can_state state);
198 void can_state_get_by_berr_counter(const struc <<
199 const struc <<
200 enum can_st <<
201 enum can_st <<
202 void can_change_state(struct net_device *dev, 131 void can_change_state(struct net_device *dev, struct can_frame *cf,
203 enum can_state tx_state, 132 enum can_state tx_state, enum can_state rx_state);
204 133
205 #ifdef CONFIG_OF 134 #ifdef CONFIG_OF
206 void of_can_transceiver(struct net_device *dev 135 void of_can_transceiver(struct net_device *dev);
207 #else 136 #else
208 static inline void of_can_transceiver(struct n 137 static inline void of_can_transceiver(struct net_device *dev) { }
209 #endif 138 #endif
210 139
211 extern struct rtnl_link_ops can_link_ops; 140 extern struct rtnl_link_ops can_link_ops;
212 int can_netlink_register(void); 141 int can_netlink_register(void);
213 void can_netlink_unregister(void); 142 void can_netlink_unregister(void);
214 143
215 #endif /* !_CAN_DEV_H */ 144 #endif /* !_CAN_DEV_H */
216 145
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.