net/ieee80211/softmac/ieee80211softmac_priv.h

   1 /*
   2  * Internal softmac API definitions.
   3  *
   4  * Copyright (c) 2005, 2006 Johannes Berg <johannes@sipsolutions.net>
   5  *                          Joseph Jezak <josejx@gentoo.org>
   6  *                          Larry Finger <Larry.Finger@lwfinger.net>
   7  *                          Danny van Dyk <kugelfang@gentoo.org>
   8  *                          Michael Buesch <mbuesch@freenet.de>
   9  *
  10  * This program is free software; you can redistribute it and/or modify it
  11  * under the terms of version 2 of the GNU General Public License as
  12  * published by the Free Software Foundation.
  13  *
  14  * This program is distributed in the hope that it will be useful, but WITHOUT
  15  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  16  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  17  * more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  22  *
  23  * The full GNU General Public License is included in this distribution in the
  24  * file called COPYING.
  25  */
  26
  27 #ifndef IEEE80211SOFTMAC_PRIV_H_
  28 #define IEEE80211SOFTMAC_PRIV_H_
  29
  30 #include <net/ieee80211softmac.h>
  31 #include <net/ieee80211softmac_wx.h>
  32 #include <linux/kernel.h>
  33 #include <linux/stringify.h>
  34
  35
  36 #define PFX                             "SoftMAC: "
  37
  38 #ifdef assert
  39 # undef assert
  40 #endif
  41 #ifdef CONFIG_IEEE80211_SOFTMAC_DEBUG
  42 #define assert(expr) \
  43         do {                                                                            \
  44                 if (unlikely(!(expr))) {                                                \
  45                 printkl(KERN_ERR PFX "ASSERTION FAILED (%s) at: %s:%d:%s()\n", #expr,   \
  46                         __FILE__, __LINE__, __FUNCTION__);                              \
  47                 }                                                                       \
  48         } while (0)
  49 #else
  50 #define assert(expr) do {} while (0)
  51 #endif
  52
  53 /* rate limited printk(). */
  54 #ifdef printkl
  55 # undef printkl
  56 #endif
  57 #define printkl(f, x...)  do { if (printk_ratelimit()) printk(f ,##x); } while (0)
  58 /* rate limited printk() for debugging */
  59 #ifdef dprintkl
  60 # undef dprintkl
  61 #endif
  62 #ifdef CONFIG_IEEE80211_SOFTMAC_DEBUG
  63 # define dprintkl               printkl
  64 #else
  65 # define dprintkl(f, x...)      do { /* nothing */ } while (0)
  66 #endif
  67
  68 /* debugging printk() */
  69 #ifdef dprintk
  70 # undef dprintk
  71 #endif
  72 #ifdef CONFIG_IEEE80211_SOFTMAC_DEBUG
  73 # define dprintk(f, x...)  do { printk(f ,##x); } while (0)
  74 #else
  75 # define dprintk(f, x...)  do { /* nothing */ } while (0)
  76 #endif
  77
  78 #ifdef function_enter
  79 # undef function_enter
  80 #endif
  81 #ifdef CONFIG_IEEE80211_SOFTMAC_DEBUG
  82 # define function_enter() do { printk(KERN_DEBUG PFX "%s:%d:%s()\n", __FILE__, __LINE__, __FUNCTION__); } while (0)
  83 #else
  84 # define function_enter() do { /* nothing */ } while (0)
  85 #endif
  86
  87 /* private definitions and prototypes */
  88
  89 /*** prototypes from _scan.c */
  90 void ieee80211softmac_scan(void *sm);
  91 /* for internal use if scanning is needed */
  92 int ieee80211softmac_start_scan(struct ieee80211softmac_device *mac);
  93 void ieee80211softmac_stop_scan(struct ieee80211softmac_device *mac);
  94 void ieee80211softmac_wait_for_scan(struct ieee80211softmac_device *mac);
  95
  96 /* for use by _module.c to assign to the callbacks */
  97 int ieee80211softmac_start_scan_implementation(struct net_device *dev);
  98 void ieee80211softmac_stop_scan_implementation(struct net_device *dev);
  99 void ieee80211softmac_wait_for_scan_implementation(struct net_device *dev);
 100
 101 /*** Network prototypes from _module.c */
 102 struct ieee80211softmac_network * ieee80211softmac_create_network(
 103         struct ieee80211softmac_device *mac, struct ieee80211_network *net);
 104 void ieee80211softmac_add_network_locked(struct ieee80211softmac_device *mac,
 105         struct ieee80211softmac_network *net);
 106 void ieee80211softmac_add_network(struct ieee80211softmac_device *mac,
 107         struct ieee80211softmac_network *net);
 108 void ieee80211softmac_del_network_locked(struct ieee80211softmac_device *mac,
 109         struct ieee80211softmac_network *net);
 110 void ieee80211softmac_del_network(struct ieee80211softmac_device *mac,
 111         struct ieee80211softmac_network *net);
 112 struct ieee80211softmac_network * ieee80211softmac_get_network_by_bssid_locked(
 113         struct ieee80211softmac_device *mac, u8 *ea);
 114 struct ieee80211softmac_network * ieee80211softmac_get_network_by_bssid(
 115         struct ieee80211softmac_device *mac, u8 *ea);
 116 struct ieee80211softmac_network * ieee80211softmac_get_network_by_ssid_locked(
 117         struct ieee80211softmac_device *mac, u8 *ssid, u8 ssid_len);
 118 struct ieee80211softmac_network * ieee80211softmac_get_network_by_ssid(
 119         struct ieee80211softmac_device *mac, u8 *ssid, u8 ssid_len);
 120 struct ieee80211softmac_network *
 121 ieee80211softmac_get_network_by_essid_locked(struct ieee80211softmac_device *mac,
 122         struct ieee80211softmac_essid *essid);
 123 struct ieee80211softmac_network *
 124 ieee80211softmac_get_network_by_essid(struct ieee80211softmac_device *mac,
 125         struct ieee80211softmac_essid *essid);
 126
 127 /* Rates related */
 128 u8 ieee80211softmac_lower_rate_delta(struct ieee80211softmac_device *mac, u8 rate, int delta);
 129 static inline u8 lower_rate(struct ieee80211softmac_device *mac, u8 rate) {
 130         return ieee80211softmac_lower_rate_delta(mac, rate, 1);
 131 }
 132
 133 static inline u8 get_fallback_rate(struct ieee80211softmac_device *mac, u8 rate)
 134 {
 135         return ieee80211softmac_lower_rate_delta(mac, rate, 2);
 136 }
 137
 138
 139 /*** prototypes from _io.c */
 140 int ieee80211softmac_send_mgt_frame(struct ieee80211softmac_device *mac,
 141         void* ptrarg, u32 type, u32 arg);
 142
 143 /*** prototypes from _auth.c */
 144 /* do these have to go into the public header? */
 145 int ieee80211softmac_auth_req(struct ieee80211softmac_device *mac, struct ieee80211softmac_network *net);
 146 int ieee80211softmac_deauth_req(struct ieee80211softmac_device *mac, struct ieee80211softmac_network *net, int reason);
 147
 148 /* for use by _module.c to assign to the callbacks */
 149 int ieee80211softmac_auth_resp(struct net_device *dev, struct ieee80211_auth *auth);
 150 int ieee80211softmac_deauth_resp(struct net_device *dev, struct ieee80211_deauth *deauth);
 151
 152 /*** prototypes from _assoc.c */
 153 void ieee80211softmac_assoc_work(void *d);
 154 int ieee80211softmac_handle_assoc_response(struct net_device * dev,
 155                                            struct ieee80211_assoc_response * resp,
 156                                            struct ieee80211_network * network);
 157 int ieee80211softmac_handle_disassoc(struct net_device * dev,
 158                                      struct ieee80211_disassoc * disassoc);
 159 void ieee80211softmac_assoc_timeout(void *d);
 160
 161 /* some helper functions */
 162 static inline int ieee80211softmac_scan_handlers_check_self(struct ieee80211softmac_device *sm)
 163 {
 164         return (sm->start_scan == ieee80211softmac_start_scan_implementation) &&
 165                 (sm->stop_scan == ieee80211softmac_stop_scan_implementation) &&
 166                 (sm->wait_for_scan == ieee80211softmac_wait_for_scan_implementation);
 167 }
 168
 169 static inline int ieee80211softmac_scan_sanity_check(struct ieee80211softmac_device *sm)
 170 {
 171         return ((sm->start_scan != ieee80211softmac_start_scan_implementation) &&
 172                 (sm->stop_scan != ieee80211softmac_stop_scan_implementation) &&
 173                 (sm->wait_for_scan != ieee80211softmac_wait_for_scan_implementation)
 174                 ) || ieee80211softmac_scan_handlers_check_self(sm);
 175 }
 176
 177 #define IEEE80211SOFTMAC_PROBE_DELAY            HZ/2
 178 #define IEEE80211SOFTMAC_WORKQUEUE_NAME_LEN     (17 + IFNAMSIZ)
 179
 180 struct ieee80211softmac_network {
 181         struct list_head                list;   /* List */
 182         /* Network information copied from ieee80211_network */
 183         u8 bssid[ETH_ALEN];
 184         u8 channel;
 185         struct ieee80211softmac_essid essid;
 186
 187         struct ieee80211softmac_ratesinfo supported_rates;
 188
 189         /* SoftMAC specific */
 190         u16 authenticating:1,                   /* Status Flags */
 191             authenticated:1,
 192             auth_desynced_once:1;
 193
 194         u16 capabilities;                       /* Capabilities bitfield */
 195         u8 challenge_len;                       /* Auth Challenge length */
 196         char *challenge;                        /* Challenge Text */
 197 };
 198
 199 /* structure used to keep track of networks we're auth'ing to */
 200 struct ieee80211softmac_auth_queue_item {
 201         struct list_head                list;   /* List head */
 202         struct ieee80211softmac_network *net;   /* Network to auth */
 203         struct ieee80211softmac_device  *mac;   /* SoftMAC device */
 204         u8 retry;                               /* Retry limit */
 205         u8 state;                               /* Auth State */
 206         struct work_struct              work;   /* Work queue */
 207 };
 208
 209 /* scanning information */
 210 struct ieee80211softmac_scaninfo {
 211         u8 current_channel_idx,
 212            number_channels;
 213         struct ieee80211_channel *channels;
 214         u8 started:1,
 215            stop:1;
 216         u8 skip_flags;
 217         struct completion finished;
 218         struct work_struct softmac_scan;
 219 };
 220
 221 /* private event struct */
 222 struct ieee80211softmac_event {
 223         struct list_head list;
 224         int event_type;
 225         void *event_context;
 226         struct work_struct work;
 227         notify_function_ptr fun;
 228         void *context;
 229         struct ieee80211softmac_device *mac;
 230 };
 231
 232 void ieee80211softmac_call_events(struct ieee80211softmac_device *mac, int event, void *event_context);
 233 void ieee80211softmac_call_events_locked(struct ieee80211softmac_device *mac, int event, void *event_context);
 234 int ieee80211softmac_notify_internal(struct ieee80211softmac_device *mac,
 235         int event, void *event_context, notify_function_ptr fun, void *context, gfp_t gfp_mask);
 236
 237 #endif /* IEEE80211SOFTMAC_PRIV_H_ */