net/wireless/core.h

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