1 /* SPDX-License-Identifier: GPL-2.0 */ 2 /* 3 * linux/can/dev.h 4 * 5 * Definitions for the CAN network device driver interface 6 * 7 * Copyright (C) 2006 Andrey Volkov <avolkov@varma-el.com> 8 * Varma Electronics Oy 9 * 10 * Copyright (C) 2008 Wolfgang Grandegger <wg@grandegger.com> 11 * 12 */ 13 14 #ifndef _CAN_DEV_H 15 #define _CAN_DEV_H 16 17 #include <linux/can.h> 18 #include <linux/can/bittiming.h> 19 #include <linux/can/error.h> 20 #include <linux/can/led.h> 21 #include <linux/can/length.h> 22 #include <linux/can/netlink.h> 23 #include <linux/can/skb.h> 24 #include <linux/netdevice.h> 25 26 /* 27 * CAN mode 28 */ 29 enum can_mode { 30 CAN_MODE_STOP = 0, 31 CAN_MODE_START, 32 CAN_MODE_SLEEP 33 }; 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 /* 42 * CAN common private data 43 */ 44 struct can_priv { 45 struct net_device *dev; 46 struct can_device_stats can_stats; 47 48 const struct can_bittiming_const *bittiming_const, 49 *data_bittiming_const; 50 struct can_bittiming bittiming, data_bittiming; 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; 60 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_TERMINATION_GPIO_MAX]; 66 67 unsigned int echo_skb_max; 68 struct sk_buff **echo_skb; 69 70 enum can_state state; 71 72 /* CAN controller features - see include/uapi/linux/can/netlink.h */ 73 u32 ctrlmode; /* current options setting */ 74 u32 ctrlmode_supported; /* options that can be modified by netlink */ 75 76 int restart_ms; 77 struct delayed_work restart_work; 78 79 int (*do_set_bittiming)(struct net_device *dev); 80 int (*do_set_data_bittiming)(struct net_device *dev); 81 int (*do_set_mode)(struct net_device *dev, enum can_mode mode); 82 int (*do_set_termination)(struct net_device *dev, u16 term); 83 int (*do_get_state)(const struct net_device *dev, 84 enum can_state *state); 85 int (*do_get_berr_counter)(const struct net_device *dev, 86 struct can_berr_counter *bec); 87 int (*do_get_auto_tdcv)(const struct net_device *dev, u32 *tdcv); 88 89 #ifdef CONFIG_CAN_LEDS 90 struct led_trigger *tx_led_trig; 91 char tx_led_trig_name[CAN_LED_NAME_SZ]; 92 struct led_trigger *rx_led_trig; 93 char rx_led_trig_name[CAN_LED_NAME_SZ]; 94 struct led_trigger *rxtx_led_trig; 95 char rxtx_led_trig_name[CAN_LED_NAME_SZ]; 96 #endif 97 }; 98 99 static inline bool can_tdc_is_enabled(const struct can_priv *priv) 100 { 101 return !!(priv->ctrlmode & CAN_CTRLMODE_TDC_MASK); 102 } 103 104 /* 105 * can_get_relative_tdco() - TDCO relative to the sample point 106 * 107 * struct can_tdc::tdco represents the absolute offset from TDCV. Some 108 * controllers use instead an offset relative to the Sample Point (SP) 109 * such that: 110 * 111 * SSP = TDCV + absolute TDCO 112 * = TDCV + SP + relative TDCO 113 * 114 * -+----------- one bit ----------+-- TX pin 115 * |<--- Sample Point --->| 116 * 117 * --+----------- one bit ----------+-- RX pin 118 * |<-------- TDCV -------->| 119 * |<------------------------>| absolute TDCO 120 * |<--- Sample Point --->| 121 * | |<->| relative TDCO 122 * |<------------- Secondary Sample Point ------------>| 123 */ 124 static inline s32 can_get_relative_tdco(const struct can_priv *priv) 125 { 126 const struct can_bittiming *dbt = &priv->data_bittiming; 127 s32 sample_point_in_tc = (CAN_SYNC_SEG + dbt->prop_seg + 128 dbt->phase_seg1) * dbt->brp; 129 130 return (s32)priv->tdc.tdco - sample_point_in_tc; 131 } 132 133 /* helper to define static CAN controller features at device creation time */ 134 static inline int __must_check can_set_static_ctrlmode(struct net_device *dev, 135 u32 static_mode) 136 { 137 struct can_priv *priv = netdev_priv(dev); 138 139 /* alloc_candev() succeeded => netdev_priv() is valid at this point */ 140 if (priv->ctrlmode_supported & static_mode) { 141 netdev_warn(dev, 142 "Controller features can not be supported and static at the same time\n"); 143 return -EINVAL; 144 } 145 priv->ctrlmode = static_mode; 146 147 /* override MTU which was set by default in can_setup()? */ 148 if (static_mode & CAN_CTRLMODE_FD) 149 dev->mtu = CANFD_MTU; 150 151 return 0; 152 } 153 154 static inline u32 can_get_static_ctrlmode(struct can_priv *priv) 155 { 156 return priv->ctrlmode & ~priv->ctrlmode_supported; 157 } 158 159 void can_setup(struct net_device *dev); 160 161 struct net_device *alloc_candev_mqs(int sizeof_priv, unsigned int echo_skb_max, 162 unsigned int txqs, unsigned int rxqs); 163 #define alloc_candev(sizeof_priv, echo_skb_max) \ 164 alloc_candev_mqs(sizeof_priv, echo_skb_max, 1, 1) 165 #define alloc_candev_mq(sizeof_priv, echo_skb_max, count) \ 166 alloc_candev_mqs(sizeof_priv, echo_skb_max, count, count) 167 void free_candev(struct net_device *dev); 168 169 /* a candev safe wrapper around netdev_priv */ 170 struct can_priv *safe_candev_priv(struct net_device *dev); 171 172 int open_candev(struct net_device *dev); 173 void close_candev(struct net_device *dev); 174 int can_change_mtu(struct net_device *dev, int new_mtu); 175 176 int register_candev(struct net_device *dev); 177 void unregister_candev(struct net_device *dev); 178 179 int can_restart_now(struct net_device *dev); 180 void can_bus_off(struct net_device *dev); 181 182 const char *can_get_state_str(const enum can_state state); 183 void can_change_state(struct net_device *dev, struct can_frame *cf, 184 enum can_state tx_state, enum can_state rx_state); 185 186 #ifdef CONFIG_OF 187 void of_can_transceiver(struct net_device *dev); 188 #else 189 static inline void of_can_transceiver(struct net_device *dev) { } 190 #endif 191 192 extern struct rtnl_link_ops can_link_ops; 193 int can_netlink_register(void); 194 void can_netlink_unregister(void); 195 196 #endif /* !_CAN_DEV_H */ 197