1/* SPDX-License-Identifier: GPL-2.0-only */
2/*
3 * Merged with mainline ieee80211.h in Aug 2004.  Original ieee802_11
4 * remains copyright by the original authors
5 *
6 * Portions of the merged code are based on Host AP (software wireless
7 * LAN access point) driver for Intersil Prism2/2.5/3.
8 *
9 * Copyright (c) 2001-2002, SSH Communications Security Corp and Jouni Malinen
10 * <j@w1.fi>
11 * Copyright (c) 2002-2003, Jouni Malinen <j@w1.fi>
12 *
13 * Adaption to a generic IEEE 802.11 stack by James Ketrenos
14 * <jketreno@linux.intel.com>
15 * Copyright (c) 2004-2005, Intel Corporation
16 *
17 * API Version History
18 * 1.0.x -- Initial version
19 * 1.1.x -- Added radiotap, QoS, TIM, libipw_geo APIs,
20 *          various structure changes, and crypto API init method
21 */
22#ifndef LIBIPW_H
23#define LIBIPW_H
24#include <linux/if_ether.h>	/* ETH_ALEN */
25#include <linux/kernel.h>	/* ARRAY_SIZE */
26#include <linux/wireless.h>
27#include <linux/ieee80211.h>
28
29#include <net/lib80211.h>
30#include <net/cfg80211.h>
31
32#define LIBIPW_VERSION "git-1.1.13"
33
34#define LIBIPW_DATA_LEN		2304
35/* Maximum size for the MA-UNITDATA primitive, 802.11 standard section
36   6.2.1.1.2.
37
38   The figure in section 7.1.2 suggests a body size of up to 2312
39   bytes is allowed, which is a bit confusing, I suspect this
40   represents the 2304 bytes of real data, plus a possible 8 bytes of
41   WEP IV and ICV. (this interpretation suggested by Ramiro Barreiro) */
42
43#define LIBIPW_1ADDR_LEN 10
44#define LIBIPW_2ADDR_LEN 16
45#define LIBIPW_3ADDR_LEN 24
46#define LIBIPW_4ADDR_LEN 30
47#define LIBIPW_FCS_LEN    4
48#define LIBIPW_HLEN			(LIBIPW_4ADDR_LEN)
49#define LIBIPW_FRAME_LEN		(LIBIPW_DATA_LEN + LIBIPW_HLEN)
50
51#define MIN_FRAG_THRESHOLD     256U
52#define	MAX_FRAG_THRESHOLD     2346U
53
54/* QOS control */
55#define LIBIPW_QCTL_TID		0x000F
56
57/* debug macros */
58
59#ifdef CONFIG_LIBIPW_DEBUG
60extern u32 libipw_debug_level;
61#define LIBIPW_DEBUG(level, fmt, args...) \
62do { if (libipw_debug_level & (level)) \
63  printk(KERN_DEBUG "libipw: %s " fmt, __func__ , ## args); } while (0)
64#else
65#define LIBIPW_DEBUG(level, fmt, args...) do {} while (0)
66#endif				/* CONFIG_LIBIPW_DEBUG */
67
68/*
69 * To use the debug system:
70 *
71 * If you are defining a new debug classification, simply add it to the #define
72 * list here in the form of:
73 *
74 * #define LIBIPW_DL_xxxx VALUE
75 *
76 * shifting value to the left one bit from the previous entry.  xxxx should be
77 * the name of the classification (for example, WEP)
78 *
79 * You then need to either add a LIBIPW_xxxx_DEBUG() macro definition for your
80 * classification, or use LIBIPW_DEBUG(LIBIPW_DL_xxxx, ...) whenever you want
81 * to send output to that classification.
82 *
83 * To add your debug level to the list of levels seen when you perform
84 *
85 * % cat /proc/net/ieee80211/debug_level
86 *
87 * you simply need to add your entry to the libipw_debug_level array.
88 *
89 * If you do not see debug_level in /proc/net/ieee80211 then you do not have
90 * CONFIG_LIBIPW_DEBUG defined in your kernel configuration
91 *
92 */
93
94#define LIBIPW_DL_INFO          (1<<0)
95#define LIBIPW_DL_WX            (1<<1)
96#define LIBIPW_DL_SCAN          (1<<2)
97#define LIBIPW_DL_STATE         (1<<3)
98#define LIBIPW_DL_MGMT          (1<<4)
99#define LIBIPW_DL_FRAG          (1<<5)
100#define LIBIPW_DL_DROP          (1<<7)
101
102#define LIBIPW_DL_TX            (1<<8)
103#define LIBIPW_DL_RX            (1<<9)
104#define LIBIPW_DL_QOS           (1<<31)
105
106#define LIBIPW_ERROR(f, a...) printk(KERN_ERR "libipw: " f, ## a)
107#define LIBIPW_WARNING(f, a...) printk(KERN_WARNING "libipw: " f, ## a)
108#define LIBIPW_DEBUG_INFO(f, a...)   LIBIPW_DEBUG(LIBIPW_DL_INFO, f, ## a)
109
110#define LIBIPW_DEBUG_WX(f, a...)     LIBIPW_DEBUG(LIBIPW_DL_WX, f, ## a)
111#define LIBIPW_DEBUG_SCAN(f, a...)   LIBIPW_DEBUG(LIBIPW_DL_SCAN, f, ## a)
112#define LIBIPW_DEBUG_STATE(f, a...)  LIBIPW_DEBUG(LIBIPW_DL_STATE, f, ## a)
113#define LIBIPW_DEBUG_MGMT(f, a...)  LIBIPW_DEBUG(LIBIPW_DL_MGMT, f, ## a)
114#define LIBIPW_DEBUG_FRAG(f, a...)  LIBIPW_DEBUG(LIBIPW_DL_FRAG, f, ## a)
115#define LIBIPW_DEBUG_DROP(f, a...)  LIBIPW_DEBUG(LIBIPW_DL_DROP, f, ## a)
116#define LIBIPW_DEBUG_TX(f, a...)  LIBIPW_DEBUG(LIBIPW_DL_TX, f, ## a)
117#define LIBIPW_DEBUG_RX(f, a...)  LIBIPW_DEBUG(LIBIPW_DL_RX, f, ## a)
118#define LIBIPW_DEBUG_QOS(f, a...)  LIBIPW_DEBUG(LIBIPW_DL_QOS, f, ## a)
119#include <linux/netdevice.h>
120#include <linux/if_arp.h>	/* ARPHRD_ETHER */
121
122#ifndef WIRELESS_SPY
123#define WIRELESS_SPY		/* enable iwspy support */
124#endif
125#include <net/iw_handler.h>	/* new driver API */
126
127#define ETH_P_PREAUTH 0x88C7	/* IEEE 802.11i pre-authentication */
128
129#ifndef ETH_P_80211_RAW
130#define ETH_P_80211_RAW (ETH_P_ECONET + 1)
131#endif
132
133/* IEEE 802.11 defines */
134
135#define P80211_OUI_LEN 3
136
137struct libipw_snap_hdr {
138
139	u8 dsap;		/* always 0xAA */
140	u8 ssap;		/* always 0xAA */
141	u8 ctrl;		/* always 0x03 */
142	u8 oui[P80211_OUI_LEN];	/* organizational universal id */
143
144} __packed;
145
146#define SNAP_SIZE sizeof(struct libipw_snap_hdr)
147
148#define WLAN_FC_GET_VERS(fc) ((fc) & IEEE80211_FCTL_VERS)
149#define WLAN_FC_GET_TYPE(fc) ((fc) & IEEE80211_FCTL_FTYPE)
150#define WLAN_FC_GET_STYPE(fc) ((fc) & IEEE80211_FCTL_STYPE)
151
152#define WLAN_GET_SEQ_FRAG(seq) ((seq) & IEEE80211_SCTL_FRAG)
153#define WLAN_GET_SEQ_SEQ(seq)  (((seq) & IEEE80211_SCTL_SEQ) >> 4)
154
155#define LIBIPW_STATMASK_SIGNAL (1<<0)
156#define LIBIPW_STATMASK_RSSI (1<<1)
157#define LIBIPW_STATMASK_NOISE (1<<2)
158#define LIBIPW_STATMASK_RATE (1<<3)
159#define LIBIPW_STATMASK_WEMASK 0x7
160
161#define LIBIPW_CCK_MODULATION    (1<<0)
162#define LIBIPW_OFDM_MODULATION   (1<<1)
163
164#define LIBIPW_24GHZ_BAND     (1<<0)
165#define LIBIPW_52GHZ_BAND     (1<<1)
166
167#define LIBIPW_CCK_RATE_1MB		        0x02
168#define LIBIPW_CCK_RATE_2MB		        0x04
169#define LIBIPW_CCK_RATE_5MB		        0x0B
170#define LIBIPW_CCK_RATE_11MB		        0x16
171#define LIBIPW_OFDM_RATE_6MB		        0x0C
172#define LIBIPW_OFDM_RATE_9MB		        0x12
173#define LIBIPW_OFDM_RATE_12MB		0x18
174#define LIBIPW_OFDM_RATE_18MB		0x24
175#define LIBIPW_OFDM_RATE_24MB		0x30
176#define LIBIPW_OFDM_RATE_36MB		0x48
177#define LIBIPW_OFDM_RATE_48MB		0x60
178#define LIBIPW_OFDM_RATE_54MB		0x6C
179#define LIBIPW_BASIC_RATE_MASK		0x80
180
181#define LIBIPW_CCK_RATE_1MB_MASK		(1<<0)
182#define LIBIPW_CCK_RATE_2MB_MASK		(1<<1)
183#define LIBIPW_CCK_RATE_5MB_MASK		(1<<2)
184#define LIBIPW_CCK_RATE_11MB_MASK		(1<<3)
185#define LIBIPW_OFDM_RATE_6MB_MASK		(1<<4)
186#define LIBIPW_OFDM_RATE_9MB_MASK		(1<<5)
187#define LIBIPW_OFDM_RATE_12MB_MASK		(1<<6)
188#define LIBIPW_OFDM_RATE_18MB_MASK		(1<<7)
189#define LIBIPW_OFDM_RATE_24MB_MASK		(1<<8)
190#define LIBIPW_OFDM_RATE_36MB_MASK		(1<<9)
191#define LIBIPW_OFDM_RATE_48MB_MASK		(1<<10)
192#define LIBIPW_OFDM_RATE_54MB_MASK		(1<<11)
193
194#define LIBIPW_CCK_RATES_MASK	        0x0000000F
195#define LIBIPW_CCK_BASIC_RATES_MASK	(LIBIPW_CCK_RATE_1MB_MASK | \
196	LIBIPW_CCK_RATE_2MB_MASK)
197#define LIBIPW_CCK_DEFAULT_RATES_MASK	(LIBIPW_CCK_BASIC_RATES_MASK | \
198        LIBIPW_CCK_RATE_5MB_MASK | \
199        LIBIPW_CCK_RATE_11MB_MASK)
200
201#define LIBIPW_OFDM_RATES_MASK		0x00000FF0
202#define LIBIPW_OFDM_BASIC_RATES_MASK	(LIBIPW_OFDM_RATE_6MB_MASK | \
203	LIBIPW_OFDM_RATE_12MB_MASK | \
204	LIBIPW_OFDM_RATE_24MB_MASK)
205#define LIBIPW_OFDM_DEFAULT_RATES_MASK	(LIBIPW_OFDM_BASIC_RATES_MASK | \
206	LIBIPW_OFDM_RATE_9MB_MASK  | \
207	LIBIPW_OFDM_RATE_18MB_MASK | \
208	LIBIPW_OFDM_RATE_36MB_MASK | \
209	LIBIPW_OFDM_RATE_48MB_MASK | \
210	LIBIPW_OFDM_RATE_54MB_MASK)
211#define LIBIPW_DEFAULT_RATES_MASK (LIBIPW_OFDM_DEFAULT_RATES_MASK | \
212                                LIBIPW_CCK_DEFAULT_RATES_MASK)
213
214#define LIBIPW_NUM_OFDM_RATES	    8
215#define LIBIPW_NUM_CCK_RATES	            4
216#define LIBIPW_OFDM_SHIFT_MASK_A         4
217
218/* NOTE: This data is for statistical purposes; not all hardware provides this
219 *       information for frames received.
220 *       For libipw_rx_mgt, you need to set at least the 'len' parameter.
221 */
222struct libipw_rx_stats {
223	u32 mac_time;
224	s8 rssi;
225	u8 signal;
226	u8 noise;
227	u16 rate;		/* in 100 kbps */
228	u8 received_channel;
229	u8 control;
230	u8 mask;
231	u8 freq;
232	u16 len;
233	u64 tsf;
234	u32 beacon_time;
235};
236
237/* IEEE 802.11 requires that STA supports concurrent reception of at least
238 * three fragmented frames. This define can be increased to support more
239 * concurrent frames, but it should be noted that each entry can consume about
240 * 2 kB of RAM and increasing cache size will slow down frame reassembly. */
241#define LIBIPW_FRAG_CACHE_LEN 4
242
243struct libipw_frag_entry {
244	unsigned long first_frag_time;
245	unsigned int seq;
246	unsigned int last_frag;
247	struct sk_buff *skb;
248	u8 src_addr[ETH_ALEN];
249	u8 dst_addr[ETH_ALEN];
250};
251
252struct libipw_stats {
253	unsigned int tx_unicast_frames;
254	unsigned int tx_multicast_frames;
255	unsigned int tx_fragments;
256	unsigned int tx_unicast_octets;
257	unsigned int tx_multicast_octets;
258	unsigned int tx_deferred_transmissions;
259	unsigned int tx_single_retry_frames;
260	unsigned int tx_multiple_retry_frames;
261	unsigned int tx_retry_limit_exceeded;
262	unsigned int tx_discards;
263	unsigned int rx_unicast_frames;
264	unsigned int rx_multicast_frames;
265	unsigned int rx_fragments;
266	unsigned int rx_unicast_octets;
267	unsigned int rx_multicast_octets;
268	unsigned int rx_fcs_errors;
269	unsigned int rx_discards_no_buffer;
270	unsigned int tx_discards_wrong_sa;
271	unsigned int rx_discards_undecryptable;
272	unsigned int rx_message_in_msg_fragments;
273	unsigned int rx_message_in_bad_msg_fragments;
274};
275
276struct libipw_device;
277
278#define SEC_KEY_1		(1<<0)
279#define SEC_KEY_2		(1<<1)
280#define SEC_KEY_3		(1<<2)
281#define SEC_KEY_4		(1<<3)
282#define SEC_ACTIVE_KEY		(1<<4)
283#define SEC_AUTH_MODE		(1<<5)
284#define SEC_UNICAST_GROUP	(1<<6)
285#define SEC_LEVEL		(1<<7)
286#define SEC_ENABLED		(1<<8)
287#define SEC_ENCRYPT		(1<<9)
288
289#define SEC_LEVEL_0		0	/* None */
290#define SEC_LEVEL_1		1	/* WEP 40 and 104 bit */
291#define SEC_LEVEL_2		2	/* Level 1 + TKIP */
292#define SEC_LEVEL_2_CKIP	3	/* Level 1 + CKIP */
293#define SEC_LEVEL_3		4	/* Level 2 + CCMP */
294
295#define SEC_ALG_NONE		0
296#define SEC_ALG_WEP		1
297#define SEC_ALG_TKIP		2
298#define SEC_ALG_CCMP		3
299
300#define WEP_KEYS		4
301#define WEP_KEY_LEN		13
302#define SCM_KEY_LEN		32
303#define SCM_TEMPORAL_KEY_LENGTH	16
304
305struct libipw_security {
306	u16 active_key:2, enabled:1, unicast_uses_group:1, encrypt:1;
307	u8 auth_mode;
308	u8 encode_alg[WEP_KEYS];
309	u8 key_sizes[WEP_KEYS];
310	u8 keys[WEP_KEYS][SCM_KEY_LEN];
311	u8 level;
312	u16 flags;
313} __packed;
314
315/*
316
317 802.11 data frame from AP
318
319      ,-------------------------------------------------------------------.
320Bytes |  2   |  2   |    6    |    6    |    6    |  2   | 0..2312 |   4  |
321      |------|------|---------|---------|---------|------|---------|------|
322Desc. | ctrl | dura |  DA/RA  |   TA    |    SA   | Sequ |  frame  |  fcs |
323      |      | tion | (BSSID) |         |         | ence |  data   |      |
324      `-------------------------------------------------------------------'
325
326Total: 28-2340 bytes
327
328*/
329
330#define BEACON_PROBE_SSID_ID_POSITION 12
331
332struct libipw_hdr_1addr {
333	__le16 frame_ctl;
334	__le16 duration_id;
335	u8 addr1[ETH_ALEN];
336	u8 payload[];
337} __packed;
338
339struct libipw_hdr_2addr {
340	__le16 frame_ctl;
341	__le16 duration_id;
342	u8 addr1[ETH_ALEN];
343	u8 addr2[ETH_ALEN];
344	u8 payload[];
345} __packed;
346
347struct libipw_hdr_3addr {
348	__le16 frame_ctl;
349	__le16 duration_id;
350	u8 addr1[ETH_ALEN];
351	u8 addr2[ETH_ALEN];
352	u8 addr3[ETH_ALEN];
353	__le16 seq_ctl;
354	u8 payload[];
355} __packed;
356
357struct libipw_hdr_4addr {
358	__le16 frame_ctl;
359	__le16 duration_id;
360	u8 addr1[ETH_ALEN];
361	u8 addr2[ETH_ALEN];
362	u8 addr3[ETH_ALEN];
363	__le16 seq_ctl;
364	u8 addr4[ETH_ALEN];
365	u8 payload[];
366} __packed;
367
368struct libipw_hdr_3addrqos {
369	__le16 frame_ctl;
370	__le16 duration_id;
371	u8 addr1[ETH_ALEN];
372	u8 addr2[ETH_ALEN];
373	u8 addr3[ETH_ALEN];
374	__le16 seq_ctl;
375	u8 payload[0];
376	__le16 qos_ctl;
377} __packed;
378
379struct libipw_info_element {
380	u8 id;
381	u8 len;
382	u8 data[];
383} __packed;
384
385/*
386 * These are the data types that can make up management packets
387 *
388	u16 auth_algorithm;
389	u16 auth_sequence;
390	u16 beacon_interval;
391	u16 capability;
392	u8 current_ap[ETH_ALEN];
393	u16 listen_interval;
394	struct {
395		u16 association_id:14, reserved:2;
396	} __packed;
397	u32 time_stamp[2];
398	u16 reason;
399	u16 status;
400*/
401
402struct libipw_auth {
403	struct libipw_hdr_3addr header;
404	__le16 algorithm;
405	__le16 transaction;
406	__le16 status;
407	/* challenge */
408	struct libipw_info_element info_element[];
409} __packed;
410
411struct libipw_channel_switch {
412	u8 id;
413	u8 len;
414	u8 mode;
415	u8 channel;
416	u8 count;
417} __packed;
418
419struct libipw_action {
420	struct libipw_hdr_3addr header;
421	u8 category;
422	u8 action;
423	union {
424		struct libipw_action_exchange {
425			u8 token;
426			struct libipw_info_element info_element[0];
427		} exchange;
428		struct libipw_channel_switch channel_switch;
429
430	} format;
431} __packed;
432
433struct libipw_disassoc {
434	struct libipw_hdr_3addr header;
435	__le16 reason;
436} __packed;
437
438/* Alias deauth for disassoc */
439#define libipw_deauth libipw_disassoc
440
441struct libipw_probe_request {
442	struct libipw_hdr_3addr header;
443	/* SSID, supported rates */
444	struct libipw_info_element info_element[];
445} __packed;
446
447struct libipw_probe_response {
448	struct libipw_hdr_3addr header;
449	__le32 time_stamp[2];
450	__le16 beacon_interval;
451	__le16 capability;
452	/* SSID, supported rates, FH params, DS params,
453	 * CF params, IBSS params, TIM (if beacon), RSN */
454	struct libipw_info_element info_element[];
455} __packed;
456
457/* Alias beacon for probe_response */
458#define libipw_beacon libipw_probe_response
459
460struct libipw_assoc_request {
461	struct libipw_hdr_3addr header;
462	__le16 capability;
463	__le16 listen_interval;
464	/* SSID, supported rates, RSN */
465	struct libipw_info_element info_element[];
466} __packed;
467
468struct libipw_reassoc_request {
469	struct libipw_hdr_3addr header;
470	__le16 capability;
471	__le16 listen_interval;
472	u8 current_ap[ETH_ALEN];
473	struct libipw_info_element info_element[];
474} __packed;
475
476struct libipw_assoc_response {
477	struct libipw_hdr_3addr header;
478	__le16 capability;
479	__le16 status;
480	__le16 aid;
481	/* supported rates */
482	struct libipw_info_element info_element[];
483} __packed;
484
485struct libipw_txb {
486	u8 nr_frags;
487	u8 encrypted;
488	u8 rts_included;
489	u8 reserved;
490	u16 frag_size;
491	u16 payload_size;
492	struct sk_buff *fragments[];
493};
494
495/* SWEEP TABLE ENTRIES NUMBER */
496#define MAX_SWEEP_TAB_ENTRIES		  42
497#define MAX_SWEEP_TAB_ENTRIES_PER_PACKET  7
498/* MAX_RATES_LENGTH needs to be 12.  The spec says 8, and many APs
499 * only use 8, and then use extended rates for the remaining supported
500 * rates.  Other APs, however, stick all of their supported rates on the
501 * main rates information element... */
502#define MAX_RATES_LENGTH                  ((u8)12)
503#define MAX_RATES_EX_LENGTH               ((u8)16)
504#define MAX_NETWORK_COUNT                  128
505
506#define CRC_LENGTH                 4U
507
508#define MAX_WPA_IE_LEN 64
509
510#define NETWORK_HAS_OFDM       (1<<1)
511#define NETWORK_HAS_CCK        (1<<2)
512
513/* QoS structure */
514#define NETWORK_HAS_QOS_PARAMETERS      (1<<3)
515#define NETWORK_HAS_QOS_INFORMATION     (1<<4)
516#define NETWORK_HAS_QOS_MASK            (NETWORK_HAS_QOS_PARAMETERS | \
517					 NETWORK_HAS_QOS_INFORMATION)
518
519/* 802.11h */
520#define NETWORK_HAS_POWER_CONSTRAINT    (1<<5)
521#define NETWORK_HAS_CSA                 (1<<6)
522#define NETWORK_HAS_QUIET               (1<<7)
523#define NETWORK_HAS_IBSS_DFS            (1<<8)
524#define NETWORK_HAS_TPC_REPORT          (1<<9)
525
526#define NETWORK_HAS_ERP_VALUE           (1<<10)
527
528#define QOS_QUEUE_NUM                   4
529#define QOS_OUI_LEN                     3
530#define QOS_OUI_TYPE                    2
531#define QOS_ELEMENT_ID                  221
532#define QOS_OUI_INFO_SUB_TYPE           0
533#define QOS_OUI_PARAM_SUB_TYPE          1
534#define QOS_VERSION_1                   1
535#define QOS_AIFSN_MIN_VALUE             2
536
537struct libipw_qos_information_element {
538	u8 elementID;
539	u8 length;
540	u8 qui[QOS_OUI_LEN];
541	u8 qui_type;
542	u8 qui_subtype;
543	u8 version;
544	u8 ac_info;
545} __packed;
546
547struct libipw_qos_ac_parameter {
548	u8 aci_aifsn;
549	u8 ecw_min_max;
550	__le16 tx_op_limit;
551} __packed;
552
553struct libipw_qos_parameter_info {
554	struct libipw_qos_information_element info_element;
555	u8 reserved;
556	struct libipw_qos_ac_parameter ac_params_record[QOS_QUEUE_NUM];
557} __packed;
558
559struct libipw_qos_parameters {
560	__le16 cw_min[QOS_QUEUE_NUM];
561	__le16 cw_max[QOS_QUEUE_NUM];
562	u8 aifs[QOS_QUEUE_NUM];
563	u8 flag[QOS_QUEUE_NUM];
564	__le16 tx_op_limit[QOS_QUEUE_NUM];
565} __packed;
566
567struct libipw_qos_data {
568	struct libipw_qos_parameters parameters;
569	int active;
570	int supported;
571	u8 param_count;
572	u8 old_param_count;
573};
574
575struct libipw_tim_parameters {
576	u8 tim_count;
577	u8 tim_period;
578} __packed;
579
580/*******************************************************/
581
582struct libipw_tpc_report {
583	u8 transmit_power;
584	u8 link_margin;
585} __packed;
586
587struct libipw_channel_map {
588	u8 channel;
589	u8 map;
590} __packed;
591
592struct libipw_ibss_dfs {
593	struct libipw_info_element ie;
594	u8 owner[ETH_ALEN];
595	u8 recovery_interval;
596	struct libipw_channel_map channel_map[];
597};
598
599struct libipw_csa {
600	u8 mode;
601	u8 channel;
602	u8 count;
603} __packed;
604
605struct libipw_quiet {
606	u8 count;
607	u8 period;
608	u8 duration;
609	u8 offset;
610} __packed;
611
612struct libipw_network {
613	/* These entries are used to identify a unique network */
614	u8 bssid[ETH_ALEN];
615	u8 channel;
616	/* Ensure null-terminated for any debug msgs */
617	u8 ssid[IW_ESSID_MAX_SIZE + 1];
618	u8 ssid_len;
619
620	struct libipw_qos_data qos_data;
621
622	/* These are network statistics */
623	struct libipw_rx_stats stats;
624	u16 capability;
625	u8 rates[MAX_RATES_LENGTH];
626	u8 rates_len;
627	u8 rates_ex[MAX_RATES_EX_LENGTH];
628	u8 rates_ex_len;
629	unsigned long last_scanned;
630	u8 mode;
631	u32 flags;
632	u32 last_associate;
633	u32 time_stamp[2];
634	u16 beacon_interval;
635	u16 listen_interval;
636	u16 atim_window;
637	u8 erp_value;
638	u8 wpa_ie[MAX_WPA_IE_LEN];
639	size_t wpa_ie_len;
640	u8 rsn_ie[MAX_WPA_IE_LEN];
641	size_t rsn_ie_len;
642	struct libipw_tim_parameters tim;
643
644	/* 802.11h info */
645
646	/* Power Constraint - mandatory if spctrm mgmt required */
647	u8 power_constraint;
648
649	/* TPC Report - mandatory if spctrm mgmt required */
650	struct libipw_tpc_report tpc_report;
651
652	/* Channel Switch Announcement - optional if spctrm mgmt required */
653	struct libipw_csa csa;
654
655	/* Quiet - optional if spctrm mgmt required */
656	struct libipw_quiet quiet;
657
658	struct list_head list;
659};
660
661enum libipw_state {
662	LIBIPW_UNINITIALIZED = 0,
663	LIBIPW_INITIALIZED,
664	LIBIPW_ASSOCIATING,
665	LIBIPW_ASSOCIATED,
666	LIBIPW_AUTHENTICATING,
667	LIBIPW_AUTHENTICATED,
668	LIBIPW_SHUTDOWN
669};
670
671#define DEFAULT_MAX_SCAN_AGE (15 * HZ)
672#define DEFAULT_FTS 2346
673
674#define CFG_LIBIPW_RESERVE_FCS (1<<0)
675#define CFG_LIBIPW_COMPUTE_FCS (1<<1)
676#define CFG_LIBIPW_RTS (1<<2)
677
678#define LIBIPW_24GHZ_MIN_CHANNEL 1
679#define LIBIPW_24GHZ_MAX_CHANNEL 14
680#define LIBIPW_24GHZ_CHANNELS (LIBIPW_24GHZ_MAX_CHANNEL - \
681				  LIBIPW_24GHZ_MIN_CHANNEL + 1)
682
683#define LIBIPW_52GHZ_MIN_CHANNEL 34
684#define LIBIPW_52GHZ_MAX_CHANNEL 165
685#define LIBIPW_52GHZ_CHANNELS (LIBIPW_52GHZ_MAX_CHANNEL - \
686				  LIBIPW_52GHZ_MIN_CHANNEL + 1)
687
688enum {
689	LIBIPW_CH_PASSIVE_ONLY = (1 << 0),
690	LIBIPW_CH_80211H_RULES = (1 << 1),
691	LIBIPW_CH_B_ONLY = (1 << 2),
692	LIBIPW_CH_NO_IBSS = (1 << 3),
693	LIBIPW_CH_UNIFORM_SPREADING = (1 << 4),
694	LIBIPW_CH_RADAR_DETECT = (1 << 5),
695	LIBIPW_CH_INVALID = (1 << 6),
696};
697
698struct libipw_channel {
699	u32 freq;	/* in MHz */
700	u8 channel;
701	u8 flags;
702	u8 max_power;	/* in dBm */
703};
704
705struct libipw_geo {
706	u8 name[4];
707	u8 bg_channels;
708	u8 a_channels;
709	struct libipw_channel bg[LIBIPW_24GHZ_CHANNELS];
710	struct libipw_channel a[LIBIPW_52GHZ_CHANNELS];
711};
712
713struct libipw_device {
714	struct net_device *dev;
715	struct wireless_dev wdev;
716	struct libipw_security sec;
717
718	/* Bookkeeping structures */
719	struct libipw_stats ieee_stats;
720
721	struct libipw_geo geo;
722	struct ieee80211_supported_band bg_band;
723	struct ieee80211_supported_band a_band;
724
725	/* Probe / Beacon management */
726	struct list_head network_free_list;
727	struct list_head network_list;
728	struct libipw_network *networks[MAX_NETWORK_COUNT];
729	int scans;
730	int scan_age;
731
732	int iw_mode;		/* operating mode (IW_MODE_*) */
733	struct iw_spy_data spy_data;	/* iwspy support */
734
735	spinlock_t lock;
736
737	int tx_headroom;	/* Set to size of any additional room needed at front
738				 * of allocated Tx SKBs */
739	u32 config;
740
741	/* WEP and other encryption related settings at the device level */
742	int open_wep;		/* Set to 1 to allow unencrypted frames */
743
744	/* If the host performs {en,de}cryption, then set to 1 */
745	int host_encrypt;
746	int host_encrypt_msdu;
747	int host_decrypt;
748	/* host performs multicast decryption */
749	int host_mc_decrypt;
750
751	/* host should strip IV and ICV from protected frames */
752	/* meaningful only when hardware decryption is being used */
753	int host_strip_iv_icv;
754
755	int host_open_frag;
756	int ieee802_1x;		/* is IEEE 802.1X used */
757
758	/* WPA data */
759	int wpa_enabled;
760	int drop_unencrypted;
761	int privacy_invoked;
762	size_t wpa_ie_len;
763	u8 *wpa_ie;
764
765	struct lib80211_crypt_info crypt_info;
766
767	int bcrx_sta_key;	/* use individual keys to override default keys even
768				 * with RX of broad/multicast frames */
769
770	/* Fragmentation structures */
771	struct libipw_frag_entry frag_cache[LIBIPW_FRAG_CACHE_LEN];
772	unsigned int frag_next_idx;
773	u16 fts;		/* Fragmentation Threshold */
774	u16 rts;		/* RTS threshold */
775
776	/* Association info */
777	u8 bssid[ETH_ALEN];
778
779	enum libipw_state state;
780
781	int mode;		/* A, B, G */
782	int modulation;		/* CCK, OFDM */
783	int freq_band;		/* 2.4Ghz, 5.2Ghz, Mixed */
784	int abg_true;		/* ABG flag              */
785
786	int perfect_rssi;
787	int worst_rssi;
788
789	u16 prev_seq_ctl;	/* used to drop duplicate frames */
790
791	/* Callback functions */
792	void (*set_security) (struct net_device * dev,
793			      struct libipw_security * sec);
794	netdev_tx_t (*hard_start_xmit) (struct libipw_txb * txb,
795					struct net_device * dev, int pri);
796	int (*is_queue_full) (struct net_device * dev, int pri);
797
798	int (*handle_management) (struct net_device * dev,
799				  struct libipw_network * network, u16 type);
800	int (*is_qos_active) (struct net_device *dev, struct sk_buff *skb);
801
802	/* Typical STA methods */
803	int (*handle_auth) (struct net_device * dev,
804			    struct libipw_auth * auth);
805	int (*handle_deauth) (struct net_device * dev,
806			      struct libipw_deauth * auth);
807	int (*handle_action) (struct net_device * dev,
808			      struct libipw_action * action,
809			      struct libipw_rx_stats * stats);
810	int (*handle_disassoc) (struct net_device * dev,
811				struct libipw_disassoc * assoc);
812	int (*handle_beacon) (struct net_device * dev,
813			      struct libipw_beacon * beacon,
814			      struct libipw_network * network);
815	int (*handle_probe_response) (struct net_device * dev,
816				      struct libipw_probe_response * resp,
817				      struct libipw_network * network);
818	int (*handle_probe_request) (struct net_device * dev,
819				     struct libipw_probe_request * req,
820				     struct libipw_rx_stats * stats);
821	int (*handle_assoc_response) (struct net_device * dev,
822				      struct libipw_assoc_response * resp,
823				      struct libipw_network * network);
824
825	/* Typical AP methods */
826	int (*handle_assoc_request) (struct net_device * dev);
827	int (*handle_reassoc_request) (struct net_device * dev,
828				       struct libipw_reassoc_request * req);
829
830	/* This must be the last item so that it points to the data
831	 * allocated beyond this structure by alloc_libipw */
832	u8 priv[];
833};
834
835#define IEEE_A            (1<<0)
836#define IEEE_B            (1<<1)
837#define IEEE_G            (1<<2)
838#define IEEE_MODE_MASK    (IEEE_A|IEEE_B|IEEE_G)
839
840static inline void *libipw_priv(struct net_device *dev)
841{
842	return ((struct libipw_device *)netdev_priv(dev))->priv;
843}
844
845static inline int libipw_is_valid_mode(struct libipw_device *ieee,
846					  int mode)
847{
848	/*
849	 * It is possible for both access points and our device to support
850	 * combinations of modes, so as long as there is one valid combination
851	 * of ap/device supported modes, then return success
852	 *
853	 */
854	if ((mode & IEEE_A) &&
855	    (ieee->modulation & LIBIPW_OFDM_MODULATION) &&
856	    (ieee->freq_band & LIBIPW_52GHZ_BAND))
857		return 1;
858
859	if ((mode & IEEE_G) &&
860	    (ieee->modulation & LIBIPW_OFDM_MODULATION) &&
861	    (ieee->freq_band & LIBIPW_24GHZ_BAND))
862		return 1;
863
864	if ((mode & IEEE_B) &&
865	    (ieee->modulation & LIBIPW_CCK_MODULATION) &&
866	    (ieee->freq_band & LIBIPW_24GHZ_BAND))
867		return 1;
868
869	return 0;
870}
871
872static inline int libipw_get_hdrlen(u16 fc)
873{
874	int hdrlen = LIBIPW_3ADDR_LEN;
875	u16 stype = WLAN_FC_GET_STYPE(fc);
876
877	switch (WLAN_FC_GET_TYPE(fc)) {
878	case IEEE80211_FTYPE_DATA:
879		if ((fc & IEEE80211_FCTL_FROMDS) && (fc & IEEE80211_FCTL_TODS))
880			hdrlen = LIBIPW_4ADDR_LEN;
881		if (stype & IEEE80211_STYPE_QOS_DATA)
882			hdrlen += 2;
883		break;
884	case IEEE80211_FTYPE_CTL:
885		switch (WLAN_FC_GET_STYPE(fc)) {
886		case IEEE80211_STYPE_CTS:
887		case IEEE80211_STYPE_ACK:
888			hdrlen = LIBIPW_1ADDR_LEN;
889			break;
890		default:
891			hdrlen = LIBIPW_2ADDR_LEN;
892			break;
893		}
894		break;
895	}
896
897	return hdrlen;
898}
899
900static inline u8 *libipw_get_payload(struct ieee80211_hdr *hdr)
901{
902	switch (libipw_get_hdrlen(le16_to_cpu(hdr->frame_control))) {
903	case LIBIPW_1ADDR_LEN:
904		return ((struct libipw_hdr_1addr *)hdr)->payload;
905	case LIBIPW_2ADDR_LEN:
906		return ((struct libipw_hdr_2addr *)hdr)->payload;
907	case LIBIPW_3ADDR_LEN:
908		return ((struct libipw_hdr_3addr *)hdr)->payload;
909	case LIBIPW_4ADDR_LEN:
910		return ((struct libipw_hdr_4addr *)hdr)->payload;
911	}
912	return NULL;
913}
914
915static inline int libipw_is_ofdm_rate(u8 rate)
916{
917	switch (rate & ~LIBIPW_BASIC_RATE_MASK) {
918	case LIBIPW_OFDM_RATE_6MB:
919	case LIBIPW_OFDM_RATE_9MB:
920	case LIBIPW_OFDM_RATE_12MB:
921	case LIBIPW_OFDM_RATE_18MB:
922	case LIBIPW_OFDM_RATE_24MB:
923	case LIBIPW_OFDM_RATE_36MB:
924	case LIBIPW_OFDM_RATE_48MB:
925	case LIBIPW_OFDM_RATE_54MB:
926		return 1;
927	}
928	return 0;
929}
930
931static inline int libipw_is_cck_rate(u8 rate)
932{
933	switch (rate & ~LIBIPW_BASIC_RATE_MASK) {
934	case LIBIPW_CCK_RATE_1MB:
935	case LIBIPW_CCK_RATE_2MB:
936	case LIBIPW_CCK_RATE_5MB:
937	case LIBIPW_CCK_RATE_11MB:
938		return 1;
939	}
940	return 0;
941}
942
943/* libipw.c */
944void free_libipw(struct net_device *dev, int monitor);
945struct net_device *alloc_libipw(int sizeof_priv, int monitor);
946
947void libipw_networks_age(struct libipw_device *ieee, unsigned long age_secs);
948
949int libipw_set_encryption(struct libipw_device *ieee);
950
951/* libipw_tx.c */
952netdev_tx_t libipw_xmit(struct sk_buff *skb, struct net_device *dev);
953void libipw_txb_free(struct libipw_txb *);
954
955/* libipw_rx.c */
956void libipw_rx_any(struct libipw_device *ieee, struct sk_buff *skb,
957		   struct libipw_rx_stats *stats);
958int libipw_rx(struct libipw_device *ieee, struct sk_buff *skb,
959	      struct libipw_rx_stats *rx_stats);
960/* make sure to set stats->len */
961void libipw_rx_mgt(struct libipw_device *ieee, struct libipw_hdr_4addr *header,
962		   struct libipw_rx_stats *stats);
963
964/* libipw_geo.c */
965const struct libipw_geo *libipw_get_geo(struct libipw_device *ieee);
966void libipw_set_geo(struct libipw_device *ieee, const struct libipw_geo *geo);
967
968int libipw_is_valid_channel(struct libipw_device *ieee, u8 channel);
969int libipw_channel_to_index(struct libipw_device *ieee, u8 channel);
970u8 libipw_freq_to_channel(struct libipw_device *ieee, u32 freq);
971u8 libipw_get_channel_flags(struct libipw_device *ieee, u8 channel);
972const struct libipw_channel *libipw_get_channel(struct libipw_device *ieee,
973						u8 channel);
974u32 libipw_channel_to_freq(struct libipw_device *ieee, u8 channel);
975
976/* libipw_wx.c */
977int libipw_wx_get_scan(struct libipw_device *ieee, struct iw_request_info *info,
978		       union iwreq_data *wrqu, char *key);
979int libipw_wx_set_encode(struct libipw_device *ieee,
980			 struct iw_request_info *info, union iwreq_data *wrqu,
981			 char *key);
982int libipw_wx_get_encode(struct libipw_device *ieee,
983			 struct iw_request_info *info, union iwreq_data *wrqu,
984			 char *key);
985int libipw_wx_set_encodeext(struct libipw_device *ieee,
986			    struct iw_request_info *info,
987			    union iwreq_data *wrqu, char *extra);
988int libipw_wx_get_encodeext(struct libipw_device *ieee,
989			    struct iw_request_info *info,
990			    union iwreq_data *wrqu, char *extra);
991
992static inline void libipw_increment_scans(struct libipw_device *ieee)
993{
994	ieee->scans++;
995}
996
997static inline int libipw_get_scans(struct libipw_device *ieee)
998{
999	return ieee->scans;
1000}
1001
1002#endif				/* LIBIPW_H */
1003