net/batman-adv/hard-interface.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /* Copyright (C) B.A.T.M.A.N. contributors:
   3  *
   4  * Marek Lindner, Simon Wunderlich
   5  */
   6
   7 #ifndef _NET_BATMAN_ADV_HARD_INTERFACE_H_
   8 #define _NET_BATMAN_ADV_HARD_INTERFACE_H_
   9
  10 #include "main.h"
  11
  12 #include <linux/compiler.h>
  13 #include <linux/kref.h>
  14 #include <linux/netdevice.h>
  15 #include <linux/notifier.h>
  16 #include <linux/rcupdate.h>
  17 #include <linux/stddef.h>
  18 #include <linux/types.h>
  19
  20 /**
  21  * enum batadv_hard_if_state - State of a hard interface
  22  */
  23 enum batadv_hard_if_state {
  24         /**
  25          * @BATADV_IF_NOT_IN_USE: interface is not used as slave interface of a
  26          * batman-adv soft interface
  27          */
  28         BATADV_IF_NOT_IN_USE,
  29
  30         /**
  31          * @BATADV_IF_TO_BE_REMOVED: interface will be removed from soft
  32          * interface
  33          */
  34         BATADV_IF_TO_BE_REMOVED,
  35
  36         /** @BATADV_IF_INACTIVE: interface is deactivated */
  37         BATADV_IF_INACTIVE,
  38
  39         /** @BATADV_IF_ACTIVE: interface is used */
  40         BATADV_IF_ACTIVE,
  41
  42         /** @BATADV_IF_TO_BE_ACTIVATED: interface is getting activated */
  43         BATADV_IF_TO_BE_ACTIVATED,
  44 };
  45
  46 /**
  47  * enum batadv_hard_if_bcast - broadcast avoidance options
  48  */
  49 enum batadv_hard_if_bcast {
  50         /** @BATADV_HARDIF_BCAST_OK: Do broadcast on according hard interface */
  51         BATADV_HARDIF_BCAST_OK = 0,
  52
  53         /**
  54          * @BATADV_HARDIF_BCAST_NORECIPIENT: Broadcast not needed, there is no
  55          *  recipient
  56          */
  57         BATADV_HARDIF_BCAST_NORECIPIENT,
  58
  59         /**
  60          * @BATADV_HARDIF_BCAST_DUPFWD: There is just the neighbor we got it
  61          *  from
  62          */
  63         BATADV_HARDIF_BCAST_DUPFWD,
  64
  65         /** @BATADV_HARDIF_BCAST_DUPORIG: There is just the originator */
  66         BATADV_HARDIF_BCAST_DUPORIG,
  67 };
  68
  69 extern struct notifier_block batadv_hard_if_notifier;
  70
  71 struct net_device *batadv_get_real_netdev(struct net_device *net_device);
  72 bool batadv_is_cfg80211_hardif(struct batadv_hard_iface *hard_iface);
  73 bool batadv_is_wifi_hardif(struct batadv_hard_iface *hard_iface);
  74 struct batadv_hard_iface*
  75 batadv_hardif_get_by_netdev(const struct net_device *net_dev);
  76 int batadv_hardif_enable_interface(struct batadv_hard_iface *hard_iface,
  77                                    struct net_device *soft_iface);
  78 void batadv_hardif_disable_interface(struct batadv_hard_iface *hard_iface);
  79 int batadv_hardif_min_mtu(struct net_device *soft_iface);
  80 void batadv_update_min_mtu(struct net_device *soft_iface);
  81 void batadv_hardif_release(struct kref *ref);
  82 int batadv_hardif_no_broadcast(struct batadv_hard_iface *if_outgoing,
  83                                u8 *orig_addr, u8 *orig_neigh);
  84
  85 /**
  86  * batadv_hardif_put() - decrement the hard interface refcounter and possibly
  87  *  release it
  88  * @hard_iface: the hard interface to free
  89  */
  90 static inline void batadv_hardif_put(struct batadv_hard_iface *hard_iface)
  91 {
  92         if (!hard_iface)
  93                 return;
  94
  95         kref_put(&hard_iface->refcount, batadv_hardif_release);
  96 }
  97
  98 /**
  99  * batadv_primary_if_get_selected() - Get reference to primary interface
 100  * @bat_priv: the bat priv with all the soft interface information
 101  *
 102  * Return: primary interface (with increased refcnt), otherwise NULL
 103  */
 104 static inline struct batadv_hard_iface *
 105 batadv_primary_if_get_selected(struct batadv_priv *bat_priv)
 106 {
 107         struct batadv_hard_iface *hard_iface;
 108
 109         rcu_read_lock();
 110         hard_iface = rcu_dereference(bat_priv->primary_if);
 111         if (!hard_iface)
 112                 goto out;
 113
 114         if (!kref_get_unless_zero(&hard_iface->refcount))
 115                 hard_iface = NULL;
 116
 117 out:
 118         rcu_read_unlock();
 119         return hard_iface;
 120 }
 121
 122 #endif /* _NET_BATMAN_ADV_HARD_INTERFACE_H_ */