1 /*
2  * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
3  * Use is subject to license terms.
4  */
5 
6 /*
7  * Copyright (c) 2007 Sam Leffler, Errno Consulting
8  * All rights reserved.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
20  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
21  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
22  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
23  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
24  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30 
31 #ifndef _SYS_NET80211_HT_H
32 #define	_SYS_NET80211_HT_H
33 
34 /*
35  * 802.11n protocol implementation definitions.
36  */
37 
38 #ifdef	__cplusplus
39 extern "C" {
40 #endif
41 
42 struct ieee80211com;
43 struct ieee80211_node;
44 struct ieee80211_channel;
45 
46 #define	IEEE80211_AGGR_BAWMAX	64	/* max block ack window size */
47 /* threshold for aging overlapping non-HT bss */
48 #define	IEEE80211_NONHT_PRESENT_AGE	(60*1000)	/* msec */
49 
50 #define	M_AMPDU			0x8000	/* A-MPDU processing done */
51 #define	M_WEP			0x4000	/* WEP done by hardware */
52 #define	M_80211_RX		(M_AMPDU | M_WEP)
53 
54 typedef uint16_t ieee80211_seq;
55 
56 struct ieee80211_tx_ampdu {
57 	ushort_t	txa_flags;
58 #define	IEEE80211_AGGR_IMMEDIATE	0x0001	/* BA policy */
59 #define	IEEE80211_AGGR_XCHGPEND		0x0002	/* ADDBA response pending */
60 #define	IEEE80211_AGGR_RUNNING		0x0004	/* ADDBA response received */
61 #define	IEEE80211_AGGR_SETUP		0x0008	/* deferred state setup */
62 #define	IEEE80211_AGGR_NAK		0x0010	/* peer NAK'd ADDBA request */
63 	uint8_t		txa_ac;
64 	uint8_t		txa_token;		/* dialog token */
65 	int		txa_qbytes;		/* data queued (bytes) */
66 	short		txa_qframes;		/* data queued (frames) */
67 	ieee80211_seq	txa_seqstart;
68 	ieee80211_seq	txa_start;
69 	uint16_t	txa_wnd;		/* BA window size */
70 	uint8_t		txa_attempts;		/* # setup attempts */
71 	clock_t		txa_lastrequest;	/* time of last ADDBA request */
72 	timeout_id_t	txa_timer;
73 };
74 
75 /* return non-zero if AMPDU tx for the TID is running */
76 #define	IEEE80211_AMPDU_RUNNING(tap) \
77 	(((tap)->txa_flags & IEEE80211_AGGR_RUNNING) != 0)
78 
79 /* return non-zero if AMPDU tx for the TID is running or started */
80 #define	IEEE80211_AMPDU_REQUESTED(tap) \
81 	(((tap)->txa_flags & (IEEE80211_AGGR_RUNNING |	\
82 	IEEE80211_AGGR_XCHGPEND | IEEE80211_AGGR_NAK)) != 0)
83 
84 struct ieee80211_rx_ampdu {
85 	int		rxa_flags;
86 	int		rxa_qbytes;	/* data queued (bytes) */
87 	short		rxa_qframes;	/* data queued (frames) */
88 	ieee80211_seq	rxa_seqstart;
89 	ieee80211_seq	rxa_start;	/* start of current BA window */
90 	uint16_t	rxa_wnd;	/* BA window size */
91 	clock_t		rxa_age;	/* age of oldest frame in window */
92 	int		rxa_nframes;	/* frames since ADDBA */
93 	mblk_t		*rxa_m[IEEE80211_AGGR_BAWMAX];
94 };
95 
96 void ieee80211_ht_attach(struct ieee80211com *);
97 void ieee80211_ht_detach(struct ieee80211com *);
98 
99 void ieee80211_ht_announce(struct ieee80211com *);
100 
101 extern const int ieee80211_htrates[16];
102 const struct ieee80211_htrateset *ieee80211_get_suphtrates(
103     struct ieee80211com *, const struct ieee80211_channel *);
104 
105 int ieee80211_setup_htrates(struct ieee80211_node *,
106     const uint8_t *htcap, int flags);
107 void ieee80211_setup_basic_htrates(struct ieee80211_node *,
108     const uint8_t *htinfo);
109 
110 mblk_t *ieee80211_decap_amsdu(struct ieee80211_node *, mblk_t *);
111 
112 int ieee80211_ampdu_reorder(struct ieee80211_node *, mblk_t *);
113 void ieee80211_recv_bar(struct ieee80211_node *, mblk_t *);
114 void ieee80211_ht_node_init(struct ieee80211_node *, const uint8_t *);
115 void ieee80211_ht_node_cleanup(struct ieee80211_node *);
116 struct ieee80211_channel *ieee80211_ht_adjust_channel(struct ieee80211com *,
117     struct ieee80211_channel *, int);
118 
119 void ieee80211_ht_wds_init(struct ieee80211_node *);
120 void ieee80211_ht_node_join(struct ieee80211_node *);
121 void ieee80211_ht_node_leave(struct ieee80211_node *);
122 void ieee80211_htinfo_update(struct ieee80211com *, int protmode);
123 void ieee80211_ht_timeout(struct ieee80211com *);
124 void ieee80211_parse_htcap(struct ieee80211_node *, const uint8_t *);
125 void ieee80211_parse_htinfo(struct ieee80211_node *, const uint8_t *);
126 void ieee80211_recv_action(struct ieee80211_node *,
127     const uint8_t *, const uint8_t *);
128 int ieee80211_ampdu_request(struct ieee80211_node *,
129     struct ieee80211_tx_ampdu *);
130 void ieee80211_ampdu_stop(struct ieee80211_node *,
131     struct ieee80211_tx_ampdu *);
132 int ieee80211_send_bar(struct ieee80211_node *,
133     const struct ieee80211_tx_ampdu *);
134 int ieee80211_send_action(struct ieee80211_node *, int, int, uint16_t [4]);
135 
136 uint8_t	*ieee80211_add_htcap(uint8_t *, struct ieee80211_node *);
137 uint8_t	*ieee80211_add_htcap_vendor(uint8_t *, struct ieee80211_node *);
138 uint8_t	*ieee80211_add_htinfo(uint8_t *, struct ieee80211_node *);
139 uint8_t	*ieee80211_add_htinfo_vendor(uint8_t *, struct ieee80211_node *);
140 
141 struct ieee80211_beacon_offsets;
142 void ieee80211_ht_update_beacon(struct ieee80211com *,
143     struct ieee80211_beacon_offsets *);
144 
145 #ifdef	__cplusplus
146 }
147 #endif
148 
149 #endif /* _SYS_NET80211_HT_H */
150