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