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> <<
19 #include <linux/can/error.h> 18 #include <linux/can/error.h>
20 #include <linux/can/length.h> !! 19 #include <linux/can/led.h>
21 #include <linux/can/netlink.h> 20 #include <linux/can/netlink.h>
22 #include <linux/can/skb.h> 21 #include <linux/can/skb.h>
23 #include <linux/ethtool.h> <<
24 #include <linux/netdevice.h> 22 #include <linux/netdevice.h>
25 23
26 /* 24 /*
27 * CAN mode 25 * CAN mode
28 */ 26 */
29 enum can_mode { 27 enum can_mode {
30 CAN_MODE_STOP = 0, 28 CAN_MODE_STOP = 0,
31 CAN_MODE_START, 29 CAN_MODE_START,
32 CAN_MODE_SLEEP 30 CAN_MODE_SLEEP
33 }; 31 };
34 32
35 enum can_termination_gpio { <<
36 CAN_TERMINATION_GPIO_DISABLED = 0, <<
37 CAN_TERMINATION_GPIO_ENABLED, <<
38 CAN_TERMINATION_GPIO_MAX, <<
39 }; <<
40 <<
41 /* 33 /*
42 * CAN common private data 34 * CAN common private data
43 */ 35 */
44 struct can_priv { 36 struct can_priv {
45 struct net_device *dev; 37 struct net_device *dev;
46 struct can_device_stats can_stats; 38 struct can_device_stats can_stats;
47 39
>> 40 struct can_bittiming bittiming, data_bittiming;
48 const struct can_bittiming_const *bitt 41 const struct can_bittiming_const *bittiming_const,
49 *data_bittiming_const; 42 *data_bittiming_const;
50 struct can_bittiming bittiming, data_b !! 43 const u16 *termination_const;
51 const struct can_tdc_const *tdc_const; !! 44 unsigned int termination_const_cnt;
52 struct can_tdc tdc; !! 45 u16 termination;
53 <<
54 unsigned int bitrate_const_cnt; <<
55 const u32 *bitrate_const; 46 const u32 *bitrate_const;
>> 47 unsigned int bitrate_const_cnt;
56 const u32 *data_bitrate_const; 48 const u32 *data_bitrate_const;
57 unsigned int data_bitrate_const_cnt; 49 unsigned int data_bitrate_const_cnt;
58 u32 bitrate_max; 50 u32 bitrate_max;
59 struct can_clock clock; 51 struct can_clock clock;
60 52
61 unsigned int termination_const_cnt; <<
62 const u16 *termination_const; <<
63 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 <<
70 enum can_state state; 53 enum can_state state;
71 54
72 /* CAN controller features - see inclu 55 /* CAN controller features - see include/uapi/linux/can/netlink.h */
73 u32 ctrlmode; /* current opt 56 u32 ctrlmode; /* current options setting */
74 u32 ctrlmode_supported; /* options tha 57 u32 ctrlmode_supported; /* options that can be modified by netlink */
>> 58 u32 ctrlmode_static; /* static enabled options for driver/hardware */
75 59
76 int restart_ms; 60 int restart_ms;
77 struct delayed_work restart_work; 61 struct delayed_work restart_work;
78 62
79 int (*do_set_bittiming)(struct net_dev 63 int (*do_set_bittiming)(struct net_device *dev);
80 int (*do_set_data_bittiming)(struct ne 64 int (*do_set_data_bittiming)(struct net_device *dev);
81 int (*do_set_mode)(struct net_device * 65 int (*do_set_mode)(struct net_device *dev, enum can_mode mode);
82 int (*do_set_termination)(struct net_d 66 int (*do_set_termination)(struct net_device *dev, u16 term);
83 int (*do_get_state)(const struct net_d 67 int (*do_get_state)(const struct net_device *dev,
84 enum can_state *st 68 enum can_state *state);
85 int (*do_get_berr_counter)(const struc 69 int (*do_get_berr_counter)(const struct net_device *dev,
86 struct can_ 70 struct can_berr_counter *bec);
87 int (*do_get_auto_tdcv)(const struct n <<
88 }; <<
89 71
90 static inline bool can_tdc_is_enabled(const st !! 72 unsigned int echo_skb_max;
91 { !! 73 struct sk_buff **echo_skb;
92 return !!(priv->ctrlmode & CAN_CTRLMOD !! 74
93 } !! 75 #ifdef CONFIG_CAN_LEDS
>> 76 struct led_trigger *tx_led_trig;
>> 77 char tx_led_trig_name[CAN_LED_NAME_SZ];
>> 78 struct led_trigger *rx_led_trig;
>> 79 char rx_led_trig_name[CAN_LED_NAME_SZ];
>> 80 struct led_trigger *rxtx_led_trig;
>> 81 char rxtx_led_trig_name[CAN_LED_NAME_SZ];
>> 82 #endif
>> 83 };
94 84
95 /* 85 /*
96 * can_get_relative_tdco() - TDCO relative to !! 86 * get_can_dlc(value) - helper macro to cast a given data length code (dlc)
>> 87 * to __u8 and ensure the dlc value to be max. 8 bytes.
97 * 88 *
98 * struct can_tdc::tdco represents the absolut !! 89 * To be used in the CAN netdriver receive path to ensure conformance with
99 * controllers use instead an offset relative !! 90 * ISO 11898-1 Chapter 8.4.2.3 (DLC field)
100 * such that: <<
101 * <<
102 * SSP = TDCV + absolute TDCO <<
103 * = TDCV + SP + relative TDCO <<
104 * <<
105 * -+----------- one bit ----------+-- TX pin <<
106 * |<--- Sample Point --->| <<
107 * <<
108 * --+----------- one <<
109 * |<-------- TDCV -------->| <<
110 * |<--------------- <<
111 * |<--- Sample Poin <<
112 * | <<
113 * |<------------- Secondary Sample Point --- <<
114 */ 91 */
115 static inline s32 can_get_relative_tdco(const !! 92 #define get_can_dlc(i) (min_t(__u8, (i), CAN_MAX_DLC))
116 { !! 93 #define get_canfd_dlc(i) (min_t(__u8, (i), CANFD_MAX_DLC))
117 const struct can_bittiming *dbt = &pri <<
118 s32 sample_point_in_tc = (CAN_SYNC_SEG <<
119 dbt->phase_s <<
120 94
121 return (s32)priv->tdc.tdco - sample_po !! 95 /* Check for outgoing skbs that have not been created by the CAN subsystem */
>> 96 static inline bool can_skb_headroom_valid(struct net_device *dev,
>> 97 struct sk_buff *skb)
>> 98 {
>> 99 /* af_packet creates a headroom of HH_DATA_MOD bytes which is fine */
>> 100 if (WARN_ON_ONCE(skb_headroom(skb) < sizeof(struct can_skb_priv)))
>> 101 return false;
>> 102
>> 103 /* af_packet does not apply CAN skb specific settings */
>> 104 if (skb->ip_summed == CHECKSUM_NONE) {
>> 105 /* init headroom */
>> 106 can_skb_prv(skb)->ifindex = dev->ifindex;
>> 107 can_skb_prv(skb)->skbcnt = 0;
>> 108
>> 109 skb->ip_summed = CHECKSUM_UNNECESSARY;
>> 110
>> 111 /* preform proper loopback on capable devices */
>> 112 if (dev->flags & IFF_ECHO)
>> 113 skb->pkt_type = PACKET_LOOPBACK;
>> 114 else
>> 115 skb->pkt_type = PACKET_HOST;
>> 116
>> 117 skb_reset_mac_header(skb);
>> 118 skb_reset_network_header(skb);
>> 119 skb_reset_transport_header(skb);
>> 120 }
>> 121
>> 122 return true;
122 } 123 }
123 124
124 /* helper to define static CAN controller feat !! 125 /* Drop a given socketbuffer if it does not contain a valid CAN frame. */
125 static inline int __must_check can_set_static_ !! 126 static inline bool can_dropped_invalid_skb(struct net_device *dev,
126 !! 127 struct sk_buff *skb)
127 { 128 {
128 struct can_priv *priv = netdev_priv(de !! 129 const struct canfd_frame *cfd = (struct canfd_frame *)skb->data;
129 130
130 /* alloc_candev() succeeded => netdev_ !! 131 if (skb->protocol == htons(ETH_P_CAN)) {
131 if (priv->ctrlmode_supported & static_ !! 132 if (unlikely(skb->len != CAN_MTU ||
132 netdev_warn(dev, !! 133 cfd->len > CAN_MAX_DLEN))
133 "Controller featur !! 134 goto inval_skb;
134 return -EINVAL; !! 135 } else if (skb->protocol == htons(ETH_P_CANFD)) {
135 } !! 136 if (unlikely(skb->len != CANFD_MTU ||
136 priv->ctrlmode = static_mode; !! 137 cfd->len > CANFD_MAX_DLEN))
>> 138 goto inval_skb;
>> 139 } else
>> 140 goto inval_skb;
137 141
138 /* override MTU which was set by defau !! 142 if (!can_skb_headroom_valid(dev, skb))
139 if (static_mode & CAN_CTRLMODE_FD) !! 143 goto inval_skb;
140 dev->mtu = CANFD_MTU; <<
141 144
142 return 0; !! 145 return false;
143 } <<
144 146
145 static inline u32 can_get_static_ctrlmode(stru !! 147 inval_skb:
146 { !! 148 kfree_skb(skb);
147 return priv->ctrlmode & ~priv->ctrlmod !! 149 dev->stats.tx_dropped++;
>> 150 return true;
148 } 151 }
149 152
150 static inline bool can_is_canxl_dev_mtu(unsign !! 153 static inline bool can_is_canfd_skb(const struct sk_buff *skb)
151 { 154 {
152 return (mtu >= CANXL_MIN_MTU && mtu <= !! 155 /* the CAN specific type of skb is identified by its data length */
>> 156 return skb->len == CANFD_MTU;
153 } 157 }
154 158
155 /* drop skb if it does not contain a valid CAN !! 159 /* helper to define static CAN controller features at device creation time */
156 static inline bool can_dev_dropped_skb(struct !! 160 static inline void can_set_static_ctrlmode(struct net_device *dev,
>> 161 u32 static_mode)
157 { 162 {
158 struct can_priv *priv = netdev_priv(de 163 struct can_priv *priv = netdev_priv(dev);
159 164
160 if (priv->ctrlmode & CAN_CTRLMODE_LIST !! 165 /* alloc_candev() succeeded => netdev_priv() is valid at this point */
161 netdev_info_once(dev, !! 166 priv->ctrlmode = static_mode;
162 "interface in !! 167 priv->ctrlmode_static = static_mode;
163 kfree_skb(skb); <<
164 dev->stats.tx_dropped++; <<
165 return true; <<
166 } <<
167 168
168 return can_dropped_invalid_skb(dev, sk !! 169 /* override MTU which was set by default in can_setup()? */
>> 170 if (static_mode & CAN_CTRLMODE_FD)
>> 171 dev->mtu = CANFD_MTU;
169 } 172 }
170 173
171 void can_setup(struct net_device *dev); !! 174 /* get data length from can_dlc with sanitized can_dlc */
>> 175 u8 can_dlc2len(u8 can_dlc);
>> 176
>> 177 /* map the sanitized data length to an appropriate data length code */
>> 178 u8 can_len2dlc(u8 len);
172 179
173 struct net_device *alloc_candev_mqs(int sizeof 180 struct net_device *alloc_candev_mqs(int sizeof_priv, unsigned int echo_skb_max,
174 unsigned i 181 unsigned int txqs, unsigned int rxqs);
175 #define alloc_candev(sizeof_priv, echo_skb_max 182 #define alloc_candev(sizeof_priv, echo_skb_max) \
176 alloc_candev_mqs(sizeof_priv, echo_skb 183 alloc_candev_mqs(sizeof_priv, echo_skb_max, 1, 1)
177 #define alloc_candev_mq(sizeof_priv, echo_skb_ 184 #define alloc_candev_mq(sizeof_priv, echo_skb_max, count) \
178 alloc_candev_mqs(sizeof_priv, echo_skb 185 alloc_candev_mqs(sizeof_priv, echo_skb_max, count, count)
179 void free_candev(struct net_device *dev); 186 void free_candev(struct net_device *dev);
180 187
181 /* a candev safe wrapper around netdev_priv */ 188 /* a candev safe wrapper around netdev_priv */
182 struct can_priv *safe_candev_priv(struct net_d 189 struct can_priv *safe_candev_priv(struct net_device *dev);
183 190
184 int open_candev(struct net_device *dev); 191 int open_candev(struct net_device *dev);
185 void close_candev(struct net_device *dev); 192 void close_candev(struct net_device *dev);
186 int can_change_mtu(struct net_device *dev, int 193 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 194
191 int register_candev(struct net_device *dev); 195 int register_candev(struct net_device *dev);
192 void unregister_candev(struct net_device *dev) 196 void unregister_candev(struct net_device *dev);
193 197
194 int can_restart_now(struct net_device *dev); 198 int can_restart_now(struct net_device *dev);
195 void can_bus_off(struct net_device *dev); 199 void can_bus_off(struct net_device *dev);
196 200
197 const char *can_get_state_str(const enum can_s <<
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, 201 void can_change_state(struct net_device *dev, struct can_frame *cf,
203 enum can_state tx_state, 202 enum can_state tx_state, enum can_state rx_state);
204 203
>> 204 void can_put_echo_skb(struct sk_buff *skb, struct net_device *dev,
>> 205 unsigned int idx);
>> 206 struct sk_buff *__can_get_echo_skb(struct net_device *dev, unsigned int idx, u8 *len_ptr);
>> 207 unsigned int can_get_echo_skb(struct net_device *dev, unsigned int idx);
>> 208 void can_free_echo_skb(struct net_device *dev, unsigned int idx);
>> 209
205 #ifdef CONFIG_OF 210 #ifdef CONFIG_OF
206 void of_can_transceiver(struct net_device *dev 211 void of_can_transceiver(struct net_device *dev);
207 #else 212 #else
208 static inline void of_can_transceiver(struct n 213 static inline void of_can_transceiver(struct net_device *dev) { }
209 #endif 214 #endif
210 215
211 extern struct rtnl_link_ops can_link_ops; !! 216 struct sk_buff *alloc_can_skb(struct net_device *dev, struct can_frame **cf);
212 int can_netlink_register(void); !! 217 struct sk_buff *alloc_canfd_skb(struct net_device *dev,
213 void can_netlink_unregister(void); !! 218 struct canfd_frame **cfd);
>> 219 struct sk_buff *alloc_can_err_skb(struct net_device *dev,
>> 220 struct can_frame **cf);
214 221
215 #endif /* !_CAN_DEV_H */ 222 #endif /* !_CAN_DEV_H */
216 223
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.