ieee80211softmac.h 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371
  1. /*
  2. * ieee80211softmac.h - public interface to the softmac
  3. *
  4. * Copyright (c) 2005 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. #ifndef IEEE80211SOFTMAC_H_
  27. #define IEEE80211SOFTMAC_H_
  28. #include <linux/kernel.h>
  29. #include <linux/spinlock.h>
  30. #include <linux/workqueue.h>
  31. #include <linux/list.h>
  32. #include <net/ieee80211.h>
  33. /* Once the API is considered more or less stable,
  34. * this should be incremented on API incompatible changes.
  35. */
  36. #define IEEE80211SOFTMAC_API 0
  37. #define IEEE80211SOFTMAC_MAX_RATES_LEN 8
  38. #define IEEE80211SOFTMAC_MAX_EX_RATES_LEN 255
  39. struct ieee80211softmac_ratesinfo {
  40. u8 count;
  41. u8 rates[IEEE80211SOFTMAC_MAX_RATES_LEN + IEEE80211SOFTMAC_MAX_EX_RATES_LEN];
  42. };
  43. /* internal structures */
  44. struct ieee80211softmac_network;
  45. struct ieee80211softmac_scaninfo;
  46. struct ieee80211softmac_essid {
  47. u8 len;
  48. char data[IW_ESSID_MAX_SIZE+1];
  49. };
  50. struct ieee80211softmac_wpa {
  51. char *IE;
  52. int IElen;
  53. int IEbuflen;
  54. };
  55. /*
  56. * Information about association
  57. */
  58. struct ieee80211softmac_assoc_info {
  59. struct mutex mutex;
  60. /*
  61. * This is the requested ESSID. It is written
  62. * only by the WX handlers.
  63. *
  64. */
  65. struct ieee80211softmac_essid req_essid;
  66. /*
  67. * the ESSID of the network we're currently
  68. * associated (or trying) to. This is
  69. * updated to the network's actual ESSID
  70. * even if the requested ESSID was 'ANY'
  71. */
  72. struct ieee80211softmac_essid associate_essid;
  73. /* BSSID we're trying to associate to */
  74. char bssid[ETH_ALEN];
  75. /* some flags.
  76. * static_essid is valid if the essid is constant,
  77. * this is for use by the wx handlers only.
  78. *
  79. * associating is true, if the network has been
  80. * auth'ed on and we are in the process of associating.
  81. *
  82. * bssvalid is true if we found a matching network
  83. * and saved it's BSSID into the bssid above.
  84. *
  85. * bssfixed is used for SIOCSIWAP.
  86. */
  87. u8 static_essid;
  88. u8 short_preamble_available;
  89. u8 associating;
  90. u8 associated;
  91. u8 assoc_wait;
  92. u8 bssvalid;
  93. u8 bssfixed;
  94. /* Scan retries remaining */
  95. int scan_retry;
  96. struct delayed_work work;
  97. struct delayed_work timeout;
  98. };
  99. struct ieee80211softmac_bss_info {
  100. /* Rates supported by the network */
  101. struct ieee80211softmac_ratesinfo supported_rates;
  102. /* This indicates whether frames can currently be transmitted with
  103. * short preamble (only use this variable during TX at CCK rates) */
  104. u8 short_preamble:1;
  105. /* This indicates whether protection (e.g. self-CTS) should be used
  106. * when transmitting with OFDM modulation */
  107. u8 use_protection:1;
  108. };
  109. enum {
  110. IEEE80211SOFTMAC_AUTH_OPEN_REQUEST = 1,
  111. IEEE80211SOFTMAC_AUTH_OPEN_RESPONSE = 2,
  112. };
  113. enum {
  114. IEEE80211SOFTMAC_AUTH_SHARED_REQUEST = 1,
  115. IEEE80211SOFTMAC_AUTH_SHARED_CHALLENGE = 2,
  116. IEEE80211SOFTMAC_AUTH_SHARED_RESPONSE = 3,
  117. IEEE80211SOFTMAC_AUTH_SHARED_PASS = 4,
  118. };
  119. /* We should make these tunable
  120. * AUTH_TIMEOUT seems really long, but that's what it is in BSD */
  121. #define IEEE80211SOFTMAC_AUTH_TIMEOUT (12 * HZ)
  122. #define IEEE80211SOFTMAC_AUTH_RETRY_LIMIT 5
  123. #define IEEE80211SOFTMAC_ASSOC_SCAN_RETRY_LIMIT 3
  124. struct ieee80211softmac_txrates {
  125. /* The Bit-Rate to be used for multicast frames. */
  126. u8 mcast_rate;
  127. /* The Bit-Rate to be used for multicast management frames. */
  128. u8 mgt_mcast_rate;
  129. /* The Bit-Rate to be used for any other (normal) data packet. */
  130. u8 default_rate;
  131. /* The Bit-Rate to be used for default fallback
  132. * (If the device supports fallback and hardware-retry)
  133. */
  134. u8 default_fallback;
  135. /* This is the rate that the user asked for */
  136. u8 user_rate;
  137. };
  138. /* Bits for txrates_change callback. */
  139. #define IEEE80211SOFTMAC_TXRATECHG_DEFAULT (1 << 0) /* default_rate */
  140. #define IEEE80211SOFTMAC_TXRATECHG_DEFAULT_FBACK (1 << 1) /* default_fallback */
  141. #define IEEE80211SOFTMAC_TXRATECHG_MCAST (1 << 2) /* mcast_rate */
  142. #define IEEE80211SOFTMAC_TXRATECHG_MGT_MCAST (1 << 3) /* mgt_mcast_rate */
  143. #define IEEE80211SOFTMAC_BSSINFOCHG_RATES (1 << 0) /* supported_rates */
  144. #define IEEE80211SOFTMAC_BSSINFOCHG_SHORT_PREAMBLE (1 << 1) /* short_preamble */
  145. #define IEEE80211SOFTMAC_BSSINFOCHG_PROTECTION (1 << 2) /* use_protection */
  146. struct ieee80211softmac_device {
  147. /* 802.11 structure for data stuff */
  148. struct ieee80211_device *ieee;
  149. struct net_device *dev;
  150. /* only valid if associated, then holds the Association ID */
  151. u16 association_id;
  152. /* the following methods are callbacks that the driver
  153. * using this framework has to assign
  154. */
  155. /* always assign these */
  156. void (*set_bssid_filter)(struct net_device *dev, const u8 *bssid);
  157. void (*set_channel)(struct net_device *dev, u8 channel);
  158. /* assign if you need it, informational only */
  159. void (*link_change)(struct net_device *dev);
  160. /* If the hardware can do scanning, assign _all_ three of these callbacks.
  161. * When the scan finishes, call ieee80211softmac_scan_finished().
  162. */
  163. /* when called, start_scan is guaranteed to not be called again
  164. * until you call ieee80211softmac_scan_finished.
  165. * Return 0 if scanning could start, error otherwise.
  166. * SOFTMAC AUTHORS: don't call this, use ieee80211softmac_start_scan */
  167. int (*start_scan)(struct net_device *dev);
  168. /* this should block until after ieee80211softmac_scan_finished was called
  169. * SOFTMAC AUTHORS: don't call this, use ieee80211softmac_wait_for_scan */
  170. void (*wait_for_scan)(struct net_device *dev);
  171. /* stop_scan aborts a scan, but is asynchronous.
  172. * if you want to wait for it too, use wait_for_scan
  173. * SOFTMAC AUTHORS: don't call this, use ieee80211softmac_stop_scan */
  174. void (*stop_scan)(struct net_device *dev);
  175. /* we'll need something about beacons here too, for AP or ad-hoc modes */
  176. /* Transmission rates to be used by the driver.
  177. * The SoftMAC figures out the best possible rates.
  178. * The driver just needs to read them.
  179. */
  180. struct ieee80211softmac_txrates txrates;
  181. /* If the driver needs to do stuff on TX rate changes, assign this
  182. * callback. See IEEE80211SOFTMAC_TXRATECHG for change flags. */
  183. void (*txrates_change)(struct net_device *dev,
  184. u32 changes);
  185. /* If the driver needs to do stuff when BSS properties change, assign
  186. * this callback. see IEEE80211SOFTMAC_BSSINFOCHG for change flags. */
  187. void (*bssinfo_change)(struct net_device *dev,
  188. u32 changes);
  189. /* private stuff follows */
  190. /* this lock protects this structure */
  191. spinlock_t lock;
  192. u8 running; /* SoftMAC started? */
  193. u8 scanning;
  194. struct ieee80211softmac_scaninfo *scaninfo;
  195. struct ieee80211softmac_assoc_info associnfo;
  196. struct ieee80211softmac_bss_info bssinfo;
  197. struct list_head auth_queue;
  198. struct list_head events;
  199. struct ieee80211softmac_ratesinfo ratesinfo;
  200. int txrate_badness;
  201. /* WPA stuff */
  202. struct ieee80211softmac_wpa wpa;
  203. /* we need to keep a list of network structs we copied */
  204. struct list_head network_list;
  205. /* This must be the last item so that it points to the data
  206. * allocated beyond this structure by alloc_ieee80211 */
  207. u8 priv[0];
  208. };
  209. extern void ieee80211softmac_scan_finished(struct ieee80211softmac_device *sm);
  210. static inline void * ieee80211softmac_priv(struct net_device *dev)
  211. {
  212. return ((struct ieee80211softmac_device *)ieee80211_priv(dev))->priv;
  213. }
  214. extern struct net_device * alloc_ieee80211softmac(int sizeof_priv);
  215. extern void free_ieee80211softmac(struct net_device *dev);
  216. /* Call this function if you detect a lost TX fragment.
  217. * (If the device indicates failure of ACK RX, for example.)
  218. * It is wise to call this function if you are able to detect lost packets,
  219. * because it contributes to the TX Rates auto adjustment.
  220. */
  221. extern void ieee80211softmac_fragment_lost(struct net_device *dev,
  222. u16 wireless_sequence_number);
  223. /* Call this function before _start to tell the softmac what rates
  224. * the hw supports. The rates parameter is copied, so you can
  225. * free it right after calling this function.
  226. * Note that the rates need to be sorted. */
  227. extern void ieee80211softmac_set_rates(struct net_device *dev, u8 count, u8 *rates);
  228. /* Finds the highest rate which is:
  229. * 1. Present in ri (optionally a basic rate)
  230. * 2. Supported by the device
  231. * 3. Less than or equal to the user-defined rate
  232. */
  233. extern u8 ieee80211softmac_highest_supported_rate(struct ieee80211softmac_device *mac,
  234. struct ieee80211softmac_ratesinfo *ri, int basic_only);
  235. /* Helper function which advises you the rate at which a frame should be
  236. * transmitted at. */
  237. static inline u8 ieee80211softmac_suggest_txrate(struct ieee80211softmac_device *mac,
  238. int is_multicast,
  239. int is_mgt)
  240. {
  241. struct ieee80211softmac_txrates *txrates = &mac->txrates;
  242. if (!mac->associnfo.associated)
  243. return txrates->mgt_mcast_rate;
  244. /* We are associated, sending unicast frame */
  245. if (!is_multicast)
  246. return txrates->default_rate;
  247. /* We are associated, sending multicast frame */
  248. if (is_mgt)
  249. return txrates->mgt_mcast_rate;
  250. else
  251. return txrates->mcast_rate;
  252. }
  253. /* Helper function which advises you when it is safe to transmit with short
  254. * preamble.
  255. * You should only call this function when transmitting at CCK rates. */
  256. static inline int ieee80211softmac_short_preamble_ok(struct ieee80211softmac_device *mac,
  257. int is_multicast,
  258. int is_mgt)
  259. {
  260. return (is_multicast && is_mgt) ? 0 : mac->bssinfo.short_preamble;
  261. }
  262. /* Helper function which advises you whether protection (e.g. self-CTS) is
  263. * needed. 1 = protection needed, 0 = no protection needed
  264. * Only use this function when transmitting with OFDM modulation. */
  265. static inline int ieee80211softmac_protection_needed(struct ieee80211softmac_device *mac)
  266. {
  267. return mac->bssinfo.use_protection;
  268. }
  269. /* Start the SoftMAC. Call this after you initialized the device
  270. * and it is ready to run.
  271. */
  272. extern void ieee80211softmac_start(struct net_device *dev);
  273. /* Stop the SoftMAC. Call this before you shutdown the device. */
  274. extern void ieee80211softmac_stop(struct net_device *dev);
  275. /*
  276. * Event system
  277. */
  278. /* valid event types */
  279. #define IEEE80211SOFTMAC_EVENT_ANY -1 /*private use only*/
  280. #define IEEE80211SOFTMAC_EVENT_SCAN_FINISHED 0
  281. #define IEEE80211SOFTMAC_EVENT_ASSOCIATED 1
  282. #define IEEE80211SOFTMAC_EVENT_ASSOCIATE_FAILED 2
  283. #define IEEE80211SOFTMAC_EVENT_ASSOCIATE_TIMEOUT 3
  284. #define IEEE80211SOFTMAC_EVENT_AUTHENTICATED 4
  285. #define IEEE80211SOFTMAC_EVENT_AUTH_FAILED 5
  286. #define IEEE80211SOFTMAC_EVENT_AUTH_TIMEOUT 6
  287. #define IEEE80211SOFTMAC_EVENT_ASSOCIATE_NET_NOT_FOUND 7
  288. #define IEEE80211SOFTMAC_EVENT_DISASSOCIATED 8
  289. /* keep this updated! */
  290. #define IEEE80211SOFTMAC_EVENT_LAST 8
  291. /*
  292. * If you want to be notified of certain events, you can call
  293. * ieee80211softmac_notify[_atomic] with
  294. * - event set to one of the constants below
  295. * - fun set to a function pointer of the appropriate type
  296. * - context set to the context data you want passed
  297. * The return value is 0, or an error.
  298. */
  299. typedef void (*notify_function_ptr)(struct net_device *dev, int event_type, void *context);
  300. #define ieee80211softmac_notify(dev, event, fun, context) ieee80211softmac_notify_gfp(dev, event, fun, context, GFP_KERNEL);
  301. #define ieee80211softmac_notify_atomic(dev, event, fun, context) ieee80211softmac_notify_gfp(dev, event, fun, context, GFP_ATOMIC);
  302. extern int ieee80211softmac_notify_gfp(struct net_device *dev,
  303. int event, notify_function_ptr fun, void *context, gfp_t gfp_mask);
  304. /* To clear pending work (for ifconfig down, etc.) */
  305. extern void
  306. ieee80211softmac_clear_pending_work(struct ieee80211softmac_device *sm);
  307. #endif /* IEEE80211SOFTMAC_H_ */