include/linux/can/dev.h

   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 /*
  36  * CAN common private data
  37  */
  38 struct can_priv {
  39         struct net_device *dev;
  40         struct can_device_stats can_stats;
  41
  42         struct can_bittiming bittiming, data_bittiming;
  43         const struct can_bittiming_const *bittiming_const,
  44                 *data_bittiming_const;
  45         const u16 *termination_const;
  46         unsigned int termination_const_cnt;
  47         u16 termination;
  48         const u32 *bitrate_const;
  49         unsigned int bitrate_const_cnt;
  50         const u32 *data_bitrate_const;
  51         unsigned int data_bitrate_const_cnt;
  52         u32 bitrate_max;
  53         struct can_clock clock;
  54
  55         enum can_state state;
  56
  57         /* CAN controller features - see include/uapi/linux/can/netlink.h */
  58         u32 ctrlmode;           /* current options setting */
  59         u32 ctrlmode_supported; /* options that can be modified by netlink */
  60         u32 ctrlmode_static;    /* static enabled options for driver/hardware */
  61
  62         int restart_ms;
  63         struct delayed_work restart_work;
  64
  65         int (*do_set_bittiming)(struct net_device *dev);
  66         int (*do_set_data_bittiming)(struct net_device *dev);
  67         int (*do_set_mode)(struct net_device *dev, enum can_mode mode);
  68         int (*do_set_termination)(struct net_device *dev, u16 term);
  69         int (*do_get_state)(const struct net_device *dev,
  70                             enum can_state *state);
  71         int (*do_get_berr_counter)(const struct net_device *dev,
  72                                    struct can_berr_counter *bec);
  73
  74         unsigned int echo_skb_max;
  75         struct sk_buff **echo_skb;
  76
  77 #ifdef CONFIG_CAN_LEDS
  78         struct led_trigger *tx_led_trig;
  79         char tx_led_trig_name[CAN_LED_NAME_SZ];
  80         struct led_trigger *rx_led_trig;
  81         char rx_led_trig_name[CAN_LED_NAME_SZ];
  82         struct led_trigger *rxtx_led_trig;
  83         char rxtx_led_trig_name[CAN_LED_NAME_SZ];
  84 #endif
  85 };
  86
  87
  88 /* helper to define static CAN controller features at device creation time */
  89 static inline void can_set_static_ctrlmode(struct net_device *dev,
  90                                            u32 static_mode)
  91 {
  92         struct can_priv *priv = netdev_priv(dev);
  93
  94         /* alloc_candev() succeeded => netdev_priv() is valid at this point */
  95         priv->ctrlmode = static_mode;
  96         priv->ctrlmode_static = static_mode;
  97
  98         /* override MTU which was set by default in can_setup()? */
  99         if (static_mode & CAN_CTRLMODE_FD)
 100                 dev->mtu = CANFD_MTU;
 101 }
 102
 103 void can_setup(struct net_device *dev);
 104
 105 struct net_device *alloc_candev_mqs(int sizeof_priv, unsigned int echo_skb_max,
 106                                     unsigned int txqs, unsigned int rxqs);
 107 #define alloc_candev(sizeof_priv, echo_skb_max) \
 108         alloc_candev_mqs(sizeof_priv, echo_skb_max, 1, 1)
 109 #define alloc_candev_mq(sizeof_priv, echo_skb_max, count) \
 110         alloc_candev_mqs(sizeof_priv, echo_skb_max, count, count)
 111 void free_candev(struct net_device *dev);
 112
 113 /* a candev safe wrapper around netdev_priv */
 114 struct can_priv *safe_candev_priv(struct net_device *dev);
 115
 116 int open_candev(struct net_device *dev);
 117 void close_candev(struct net_device *dev);
 118 int can_change_mtu(struct net_device *dev, int new_mtu);
 119
 120 int register_candev(struct net_device *dev);
 121 void unregister_candev(struct net_device *dev);
 122
 123 int can_restart_now(struct net_device *dev);
 124 void can_bus_off(struct net_device *dev);
 125
 126 const char *can_get_state_str(const enum can_state state);
 127 void can_change_state(struct net_device *dev, struct can_frame *cf,
 128                       enum can_state tx_state, enum can_state rx_state);
 129
 130 #ifdef CONFIG_OF
 131 void of_can_transceiver(struct net_device *dev);
 132 #else
 133 static inline void of_can_transceiver(struct net_device *dev) { }
 134 #endif
 135
 136 extern struct rtnl_link_ops can_link_ops;
 137 int can_netlink_register(void);
 138 void can_netlink_unregister(void);
 139
 140 #endif /* !_CAN_DEV_H */