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 <net/genetlink.h>
  14 #include <net/cfg80211.h>
  15 #include "reg.h"
  16
  17 struct cfg80211_registered_device {
  18         struct cfg80211_ops *ops;
  19         struct list_head list;
  20         /* we hold this mutex during any call so that
  21          * we cannot do multiple calls at once, and also
  22          * to avoid the deregister call to proceed while
  23          * any call is in progress */
  24         struct mutex mtx;
  25
  26         /* ISO / IEC 3166 alpha2 for which this device is receiving
  27          * country IEs on, this can help disregard country IEs from APs
  28          * on the same alpha2 quickly. The alpha2 may differ from
  29          * cfg80211_regdomain's alpha2 when an intersection has occurred.
  30          * If the AP is reconfigured this can also be used to tell us if
  31          * the country on the country IE changed. */
  32         char country_ie_alpha2[2];
  33
  34         /* If a Country IE has been received this tells us the environment
  35          * which its telling us its in. This defaults to ENVIRON_ANY */
  36         enum environment_cap env;
  37
  38         /* wiphy index, internal only */
  39         int wiphy_idx;
  40
  41         /* associate netdev list */
  42         struct mutex devlist_mtx;
  43         struct list_head netdev_list;
  44
  45         /* BSSes/scanning */
  46         spinlock_t bss_lock;
  47         struct list_head bss_list;
  48         struct rb_root bss_tree;
  49         u32 bss_generation;
  50         struct cfg80211_scan_request *scan_req; /* protected by RTNL */
  51         unsigned long suspend_at;
  52
  53         /* must be last because of the way we do wiphy_priv(),
  54          * and it should at least be aligned to NETDEV_ALIGN */
  55         struct wiphy wiphy __attribute__((__aligned__(NETDEV_ALIGN)));
  56 };
  57
  58 static inline
  59 struct cfg80211_registered_device *wiphy_to_dev(struct wiphy *wiphy)
  60 {
  61         BUG_ON(!wiphy);
  62         return container_of(wiphy, struct cfg80211_registered_device, wiphy);
  63 }
  64
  65 /* Note 0 is valid, hence phy0 */
  66 static inline
  67 bool wiphy_idx_valid(int wiphy_idx)
  68 {
  69         return (wiphy_idx >= 0);
  70 }
  71
  72 extern struct mutex cfg80211_mutex;
  73 extern struct list_head cfg80211_drv_list;
  74
  75 #define assert_cfg80211_lock() WARN_ON(!mutex_is_locked(&cfg80211_mutex))
  76
  77 /*
  78  * You can use this to mark a wiphy_idx as not having an associated wiphy.
  79  * It guarantees cfg80211_drv_by_wiphy_idx(wiphy_idx) will return NULL
  80  */
  81 #define WIPHY_IDX_STALE -1
  82
  83 struct cfg80211_internal_bss {
  84         struct list_head list;
  85         struct rb_node rbn;
  86         unsigned long ts;
  87         struct kref ref;
  88         bool hold, ies_allocated;
  89
  90         /* must be last because of priv member */
  91         struct cfg80211_bss pub;
  92 };
  93
  94 struct cfg80211_registered_device *cfg80211_drv_by_wiphy_idx(int wiphy_idx);
  95 int get_wiphy_idx(struct wiphy *wiphy);
  96
  97 struct cfg80211_registered_device *
  98 __cfg80211_drv_from_info(struct genl_info *info);
  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,
 140                              enum nl80211_reg_initiator setby);
 141
 142 void cfg80211_bss_expire(struct cfg80211_registered_device *dev);
 143 void cfg80211_bss_age(struct cfg80211_registered_device *dev,
 144                       unsigned long age_secs);
 145
 146 /* IBSS */
 147 int cfg80211_join_ibss(struct cfg80211_registered_device *rdev,
 148                        struct net_device *dev,
 149                        struct cfg80211_ibss_params *params);
 150 void cfg80211_clear_ibss(struct net_device *dev, bool nowext);
 151 int cfg80211_leave_ibss(struct cfg80211_registered_device *rdev,
 152                         struct net_device *dev, bool nowext);
 153
 154 /* internal helpers */
 155 int cfg80211_validate_key_settings(struct key_params *params, int key_idx,
 156                                    const u8 *mac_addr);
 157
 158 #endif /* __NET_WIRELESS_CORE_H */