net/wireless/core.h

   1 /*
   2  * Wireless configuration interface internals.
   3  *
   4  * Copyright 2006, 2007 Johannes Berg <johannes@sipsolutions.net>
   5  */
   6 #ifndef __NET_WIRELESS_CORE_H
   7 #define __NET_WIRELESS_CORE_H
   8 #include <linux/mutex.h>
   9 #include <linux/list.h>
  10 #include <linux/netdevice.h>
  11 #include <linux/kref.h>
  12 #include <linux/rbtree.h>
  13 #include <linux/mutex.h>
  14 #include <net/genetlink.h>
  15 #include <net/wireless.h>
  16 #include <net/cfg80211.h>
  17 #include "reg.h"
  18
  19 struct cfg80211_registered_device {
  20         struct cfg80211_ops *ops;
  21         struct list_head list;
  22         /* we hold this mutex during any call so that
  23          * we cannot do multiple calls at once, and also
  24          * to avoid the deregister call to proceed while
  25          * any call is in progress */
  26         struct mutex mtx;
  27
  28         /* ISO / IEC 3166 alpha2 for which this device is receiving
  29          * country IEs on, this can help disregard country IEs from APs
  30          * on the same alpha2 quickly. The alpha2 may differ from
  31          * cfg80211_regdomain's alpha2 when an intersection has occurred.
  32          * If the AP is reconfigured this can also be used to tell us if
  33          * the country on the country IE changed. */
  34         char country_ie_alpha2[2];
  35
  36         /* If a Country IE has been received this tells us the environment
  37          * which its telling us its in. This defaults to ENVIRON_ANY */
  38         enum environment_cap env;
  39
  40         /* wiphy index, internal only */
  41         int wiphy_idx;
  42
  43         /* associate netdev list */
  44         struct mutex devlist_mtx;
  45         struct list_head netdev_list;
  46
  47         /* BSSes/scanning */
  48         spinlock_t bss_lock;
  49         struct list_head bss_list;
  50         struct rb_root bss_tree;
  51         u32 bss_generation;
  52         struct cfg80211_scan_request *scan_req; /* protected by RTNL */
  53         unsigned long suspend_at;
  54
  55         /* must be last because of the way we do wiphy_priv(),
  56          * and it should at least be aligned to NETDEV_ALIGN */
  57         struct wiphy wiphy __attribute__((__aligned__(NETDEV_ALIGN)));
  58 };
  59
  60 static inline
  61 struct cfg80211_registered_device *wiphy_to_dev(struct wiphy *wiphy)
  62 {
  63         BUG_ON(!wiphy);
  64         return container_of(wiphy, struct cfg80211_registered_device, wiphy);
  65 }
  66
  67 /* Note 0 is valid, hence phy0 */
  68 static inline
  69 bool wiphy_idx_valid(int wiphy_idx)
  70 {
  71         return (wiphy_idx >= 0);
  72 }
  73
  74 extern struct mutex cfg80211_mutex;
  75 extern struct list_head cfg80211_drv_list;
  76
  77 static inline void assert_cfg80211_lock(void)
  78 {
  79         BUG_ON(!mutex_is_locked(&cfg80211_mutex));
  80 }
  81
  82 /*
  83  * You can use this to mark a wiphy_idx as not having an associated wiphy.
  84  * It guarantees cfg80211_drv_by_wiphy_idx(wiphy_idx) will return NULL
  85  */
  86 #define WIPHY_IDX_STALE -1
  87
  88 struct cfg80211_internal_bss {
  89         struct list_head list;
  90         struct rb_node rbn;
  91         unsigned long ts;
  92         struct kref ref;
  93         /* must be last because of priv member */
  94         struct cfg80211_bss pub;
  95 };
  96
  97 struct cfg80211_registered_device *cfg80211_drv_by_wiphy_idx(int wiphy_idx);
  98 int get_wiphy_idx(struct wiphy *wiphy);
  99
 100 /*
 101  * This function returns a pointer to the driver
 102  * that the genl_info item that is passed refers to.
 103  * If successful, it returns non-NULL and also locks
 104  * the driver's mutex!
 105  *
 106  * This means that you need to call cfg80211_put_dev()
 107  * before being allowed to acquire &cfg80211_mutex!
 108  *
 109  * This is necessary because we need to lock the global
 110  * mutex to get an item off the list safely, and then
 111  * we lock the drv mutex so it doesn't go away under us.
 112  *
 113  * We don't want to keep cfg80211_mutex locked
 114  * for all the time in order to allow requests on
 115  * other interfaces to go through at the same time.
 116  *
 117  * The result of this can be a PTR_ERR and hence must
 118  * be checked with IS_ERR() for errors.
 119  */
 120 extern struct cfg80211_registered_device *
 121 cfg80211_get_dev_from_info(struct genl_info *info);
 122
 123 /* requires cfg80211_drv_mutex to be held! */
 124 struct wiphy *wiphy_idx_to_wiphy(int wiphy_idx);
 125
 126 /* identical to cfg80211_get_dev_from_info but only operate on ifindex */
 127 extern struct cfg80211_registered_device *
 128 cfg80211_get_dev_from_ifindex(int ifindex);
 129
 130 extern void cfg80211_put_dev(struct cfg80211_registered_device *drv);
 131
 132 /* free object */
 133 extern void cfg80211_dev_free(struct cfg80211_registered_device *drv);
 134
 135 extern int cfg80211_dev_rename(struct cfg80211_registered_device *drv,
 136                                char *newname);
 137
 138 void ieee80211_set_bitrate_flags(struct wiphy *wiphy);
 139 void wiphy_update_regulatory(struct wiphy *wiphy, enum reg_set_by setby);
 140
 141 void cfg80211_bss_expire(struct cfg80211_registered_device *dev);
 142 void cfg80211_bss_age(struct cfg80211_registered_device *dev,
 143                       unsigned long age_secs);
 144
 145 #endif /* __NET_WIRELESS_CORE_H */