Something went wrong. Try again.
Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
Something went wrong. Try again.
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220/* SPDX-License-Identifier: GPL-2.0 *//* * linux/can/dev.h * * Definitions for the CAN network device driver interface * * Copyright (C) 2006 Andrey Volkov <avolkov@varma-el.com> * Varma Electronics Oy * * Copyright (C) 2008 Wolfgang Grandegger <wg@grandegger.com> * */
#ifndef _CAN_DEV_H#define _CAN_DEV_H
#include <linux/can.h>#include <linux/can/bittiming.h>#include <linux/can/error.h>#include <linux/can/length.h>#include <linux/can/netlink.h>#include <linux/can/skb.h>#include <linux/ethtool.h>#include <linux/netdevice.h>
/* * CAN mode */enum can_mode { CAN_MODE_STOP = 0, CAN_MODE_START, CAN_MODE_SLEEP};
enum can_termination_gpio { CAN_TERMINATION_GPIO_DISABLED = 0, CAN_TERMINATION_GPIO_ENABLED, CAN_TERMINATION_GPIO_MAX,};
struct data_bittiming_params { const struct can_bittiming_const *data_bittiming_const; struct can_bittiming data_bittiming; const struct can_tdc_const *tdc_const; struct can_tdc tdc; const u32 *data_bitrate_const; unsigned int data_bitrate_const_cnt; int (*do_set_data_bittiming)(struct net_device *dev); int (*do_get_auto_tdcv)(const struct net_device *dev, u32 *tdcv);};
/* * CAN common private data */struct can_priv { struct net_device *dev; struct can_device_stats can_stats;
const struct can_bittiming_const *bittiming_const; struct can_bittiming bittiming; struct data_bittiming_params fd; unsigned int bitrate_const_cnt; const u32 *bitrate_const; u32 bitrate_max; struct can_clock clock;
unsigned int termination_const_cnt; const u16 *termination_const; u16 termination; struct gpio_desc *termination_gpio; u16 termination_gpio_ohms[CAN_TERMINATION_GPIO_MAX];
unsigned int echo_skb_max; struct sk_buff **echo_skb;
enum can_state state;
/* CAN controller features - see include/uapi/linux/can/netlink.h */ u32 ctrlmode; /* current options setting */ u32 ctrlmode_supported; /* options that can be modified by netlink */
int restart_ms; struct delayed_work restart_work;
int (*do_set_bittiming)(struct net_device *dev); int (*do_set_mode)(struct net_device *dev, enum can_mode mode); int (*do_set_termination)(struct net_device *dev, u16 term); int (*do_get_state)(const struct net_device *dev, enum can_state *state); int (*do_get_berr_counter)(const struct net_device *dev, struct can_berr_counter *bec);};
static inline bool can_tdc_is_enabled(const struct can_priv *priv){ return !!(priv->ctrlmode & CAN_CTRLMODE_TDC_MASK);}
/* * can_get_relative_tdco() - TDCO relative to the sample point * * struct can_tdc::tdco represents the absolute offset from TDCV. Some * controllers use instead an offset relative to the Sample Point (SP) * such that: * * SSP = TDCV + absolute TDCO * = TDCV + SP + relative TDCO * * -+----------- one bit ----------+-- TX pin * |<--- Sample Point --->| * * --+----------- one bit ----------+-- RX pin * |<-------- TDCV -------->| * |<------------------------>| absolute TDCO * |<--- Sample Point --->| * | |<->| relative TDCO * |<------------- Secondary Sample Point ------------>| */static inline s32 can_get_relative_tdco(const struct can_priv *priv){ const struct can_bittiming *dbt = &priv->fd.data_bittiming; s32 sample_point_in_tc = (CAN_SYNC_SEG + dbt->prop_seg + dbt->phase_seg1) * dbt->brp;
return (s32)priv->fd.tdc.tdco - sample_point_in_tc;}
/* helper to define static CAN controller features at device creation time */static inline int __must_check can_set_static_ctrlmode(struct net_device *dev, u32 static_mode){ struct can_priv *priv = netdev_priv(dev);
/* alloc_candev() succeeded => netdev_priv() is valid at this point */ if (priv->ctrlmode_supported & static_mode) { netdev_warn(dev, "Controller features can not be supported and static at the same time\n"); return -EINVAL; } priv->ctrlmode = static_mode;
/* override MTU which was set by default in can_setup()? */ if (static_mode & CAN_CTRLMODE_FD) dev->mtu = CANFD_MTU;
return 0;}
static inline u32 can_get_static_ctrlmode(struct can_priv *priv){ return priv->ctrlmode & ~priv->ctrlmode_supported;}
static inline bool can_is_canxl_dev_mtu(unsigned int mtu){ return (mtu >= CANXL_MIN_MTU && mtu <= CANXL_MAX_MTU);}
/* drop skb if it does not contain a valid CAN frame for sending */static inline bool can_dev_dropped_skb(struct net_device *dev, struct sk_buff *skb){ struct can_priv *priv = netdev_priv(dev);
if (priv->ctrlmode & CAN_CTRLMODE_LISTENONLY) { netdev_info_once(dev, "interface in listen only mode, dropping skb\n"); kfree_skb(skb); dev->stats.tx_dropped++; return true; }
return can_dropped_invalid_skb(dev, skb);}
void can_setup(struct net_device *dev);
struct net_device *alloc_candev_mqs(int sizeof_priv, unsigned int echo_skb_max, unsigned int txqs, unsigned int rxqs);#define alloc_candev(sizeof_priv, echo_skb_max) \ alloc_candev_mqs(sizeof_priv, echo_skb_max, 1, 1)#define alloc_candev_mq(sizeof_priv, echo_skb_max, count) \ alloc_candev_mqs(sizeof_priv, echo_skb_max, count, count)void free_candev(struct net_device *dev);
/* a candev safe wrapper around netdev_priv */struct can_priv *safe_candev_priv(struct net_device *dev);
int open_candev(struct net_device *dev);void close_candev(struct net_device *dev);int can_change_mtu(struct net_device *dev, int new_mtu);int can_eth_ioctl_hwts(struct net_device *netdev, struct ifreq *ifr, int cmd);int can_ethtool_op_get_ts_info_hwts(struct net_device *dev, struct kernel_ethtool_ts_info *info);
int register_candev(struct net_device *dev);void unregister_candev(struct net_device *dev);
int can_restart_now(struct net_device *dev);void can_bus_off(struct net_device *dev);
const char *can_get_state_str(const enum can_state state);void can_state_get_by_berr_counter(const struct net_device *dev, const struct can_berr_counter *bec, enum can_state *tx_state, enum can_state *rx_state);void can_change_state(struct net_device *dev, struct can_frame *cf, enum can_state tx_state, enum can_state rx_state);
#ifdef CONFIG_OFvoid of_can_transceiver(struct net_device *dev);#elsestatic inline void of_can_transceiver(struct net_device *dev) { }#endif
extern struct rtnl_link_ops can_link_ops;int can_netlink_register(void);void can_netlink_unregister(void);
#endif /* !_CAN_DEV_H */