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> <<
20 #include <linux/can/length.h> <<
21 #include <linux/can/netlink.h> 17 #include <linux/can/netlink.h>
22 #include <linux/can/skb.h> !! 18 #include <linux/can/error.h>
23 #include <linux/ethtool.h> !! 19 #include <linux/can/led.h>
24 #include <linux/netdevice.h> <<
25 20
26 /* 21 /*
27 * CAN mode 22 * CAN mode
28 */ 23 */
29 enum can_mode { 24 enum can_mode {
30 CAN_MODE_STOP = 0, 25 CAN_MODE_STOP = 0,
31 CAN_MODE_START, 26 CAN_MODE_START,
32 CAN_MODE_SLEEP 27 CAN_MODE_SLEEP
33 }; 28 };
34 29
35 enum can_termination_gpio { <<
36 CAN_TERMINATION_GPIO_DISABLED = 0, <<
37 CAN_TERMINATION_GPIO_ENABLED, <<
38 CAN_TERMINATION_GPIO_MAX, <<
39 }; <<
40 <<
41 /* 30 /*
42 * CAN common private data 31 * CAN common private data
43 */ 32 */
44 struct can_priv { 33 struct can_priv {
45 struct net_device *dev; 34 struct net_device *dev;
46 struct can_device_stats can_stats; 35 struct can_device_stats can_stats;
47 36
48 const struct can_bittiming_const *bitt !! 37 struct can_bittiming bittiming;
49 *data_bittiming_const; !! 38 const struct can_bittiming_const *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; 39 struct can_clock clock;
60 40
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; 41 enum can_state state;
71 !! 42 u32 ctrlmode;
72 /* CAN controller features - see inclu !! 43 u32 ctrlmode_supported;
73 u32 ctrlmode; /* current opt <<
74 u32 ctrlmode_supported; /* options tha <<
75 44
76 int restart_ms; 45 int restart_ms;
77 struct delayed_work restart_work; 46 struct delayed_work restart_work;
78 47
79 int (*do_set_bittiming)(struct net_dev 48 int (*do_set_bittiming)(struct net_device *dev);
80 int (*do_set_data_bittiming)(struct ne <<
81 int (*do_set_mode)(struct net_device * 49 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 50 int (*do_get_state)(const struct net_device *dev,
84 enum can_state *st 51 enum can_state *state);
85 int (*do_get_berr_counter)(const struc 52 int (*do_get_berr_counter)(const struct net_device *dev,
86 struct can_ 53 struct can_berr_counter *bec);
87 int (*do_get_auto_tdcv)(const struct n <<
88 }; <<
89 54
90 static inline bool can_tdc_is_enabled(const st !! 55 unsigned int echo_skb_max;
91 { !! 56 struct sk_buff **echo_skb;
92 return !!(priv->ctrlmode & CAN_CTRLMOD !! 57
93 } !! 58 #ifdef CONFIG_CAN_LEDS
>> 59 struct led_trigger *tx_led_trig;
>> 60 char tx_led_trig_name[CAN_LED_NAME_SZ];
>> 61 struct led_trigger *rx_led_trig;
>> 62 char rx_led_trig_name[CAN_LED_NAME_SZ];
>> 63 #endif
>> 64 };
94 65
95 /* 66 /*
96 * can_get_relative_tdco() - TDCO relative to !! 67 * get_can_dlc(value) - helper macro to cast a given data length code (dlc)
97 * !! 68 * 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 * 69 *
102 * SSP = TDCV + absolute TDCO !! 70 * To be used in the CAN netdriver receive path to ensure conformance with
103 * = TDCV + SP + relative TDCO !! 71 * 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 */ 72 */
115 static inline s32 can_get_relative_tdco(const !! 73 #define get_can_dlc(i) (min_t(__u8, (i), CAN_MAX_DLC))
116 { !! 74 #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 75
121 return (s32)priv->tdc.tdco - sample_po !! 76 /* Drop a given socketbuffer if it does not contain a valid CAN frame. */
122 } !! 77 static inline int can_dropped_invalid_skb(struct net_device *dev,
123 !! 78 struct sk_buff *skb)
124 /* helper to define static CAN controller feat !! 79 {
125 static inline int __must_check can_set_static_ !! 80 const struct canfd_frame *cfd = (struct canfd_frame *)skb->data;
126 !! 81
127 { !! 82 if (skb->protocol == htons(ETH_P_CAN)) {
128 struct can_priv *priv = netdev_priv(de !! 83 if (unlikely(skb->len != CAN_MTU ||
129 !! 84 cfd->len > CAN_MAX_DLEN))
130 /* alloc_candev() succeeded => netdev_ !! 85 goto inval_skb;
131 if (priv->ctrlmode_supported & static_ !! 86 } else if (skb->protocol == htons(ETH_P_CANFD)) {
132 netdev_warn(dev, !! 87 if (unlikely(skb->len != CANFD_MTU ||
133 "Controller featur !! 88 cfd->len > CANFD_MAX_DLEN))
134 return -EINVAL; !! 89 goto inval_skb;
135 } !! 90 } else
136 priv->ctrlmode = static_mode; !! 91 goto inval_skb;
137 <<
138 /* override MTU which was set by defau <<
139 if (static_mode & CAN_CTRLMODE_FD) <<
140 dev->mtu = CANFD_MTU; <<
141 92
142 return 0; 93 return 0;
143 } <<
144 <<
145 static inline u32 can_get_static_ctrlmode(stru <<
146 { <<
147 return priv->ctrlmode & ~priv->ctrlmod <<
148 } <<
149 94
150 static inline bool can_is_canxl_dev_mtu(unsign !! 95 inval_skb:
151 { !! 96 kfree_skb(skb);
152 return (mtu >= CANXL_MIN_MTU && mtu <= !! 97 dev->stats.tx_dropped++;
>> 98 return 1;
153 } 99 }
154 100
155 /* drop skb if it does not contain a valid CAN !! 101 /* get data length from can_dlc with sanitized can_dlc */
156 static inline bool can_dev_dropped_skb(struct !! 102 u8 can_dlc2len(u8 can_dlc);
157 { <<
158 struct can_priv *priv = netdev_priv(de <<
159 103
160 if (priv->ctrlmode & CAN_CTRLMODE_LIST !! 104 /* map the sanitized data length to an appropriate data length code */
161 netdev_info_once(dev, !! 105 u8 can_len2dlc(u8 len);
162 "interface in <<
163 kfree_skb(skb); <<
164 dev->stats.tx_dropped++; <<
165 return true; <<
166 } <<
167 106
168 return can_dropped_invalid_skb(dev, sk !! 107 struct net_device *alloc_candev(int sizeof_priv, unsigned int echo_skb_max);
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); 108 void free_candev(struct net_device *dev);
180 109
181 /* a candev safe wrapper around netdev_priv */ 110 /* a candev safe wrapper around netdev_priv */
182 struct can_priv *safe_candev_priv(struct net_d 111 struct can_priv *safe_candev_priv(struct net_device *dev);
183 112
184 int open_candev(struct net_device *dev); 113 int open_candev(struct net_device *dev);
185 void close_candev(struct net_device *dev); 114 void close_candev(struct net_device *dev);
186 int can_change_mtu(struct net_device *dev, int <<
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 115
191 int register_candev(struct net_device *dev); 116 int register_candev(struct net_device *dev);
192 void unregister_candev(struct net_device *dev) 117 void unregister_candev(struct net_device *dev);
193 118
194 int can_restart_now(struct net_device *dev); 119 int can_restart_now(struct net_device *dev);
195 void can_bus_off(struct net_device *dev); 120 void can_bus_off(struct net_device *dev);
196 121
197 const char *can_get_state_str(const enum can_s !! 122 void can_put_echo_skb(struct sk_buff *skb, struct net_device *dev,
198 void can_state_get_by_berr_counter(const struc !! 123 unsigned int idx);
199 const struc !! 124 unsigned int can_get_echo_skb(struct net_device *dev, unsigned int idx);
200 enum can_st !! 125 void can_free_echo_skb(struct net_device *dev, unsigned int idx);
201 enum can_st !! 126
202 void can_change_state(struct net_device *dev, !! 127 struct sk_buff *alloc_can_skb(struct net_device *dev, struct can_frame **cf);
203 enum can_state tx_state, !! 128 struct sk_buff *alloc_can_err_skb(struct net_device *dev,
204 !! 129 struct can_frame **cf);
205 #ifdef CONFIG_OF <<
206 void of_can_transceiver(struct net_device *dev <<
207 #else <<
208 static inline void of_can_transceiver(struct n <<
209 #endif <<
210 <<
211 extern struct rtnl_link_ops can_link_ops; <<
212 int can_netlink_register(void); <<
213 void can_netlink_unregister(void); <<
214 130
215 #endif /* !_CAN_DEV_H */ !! 131 #endif /* CAN_DEV_H */
216 132
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.