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