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