2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2007-2008 Sam Leffler, Errno Consulting
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 #ifndef _NET80211_IEEE80211_PHY_H_
31 #define _NET80211_IEEE80211_PHY_H_
35 * IEEE 802.11 PHY-related definitions.
39 * Contention window (slots).
41 #define IEEE80211_CW_MAX 1023 /* aCWmax */
42 #define IEEE80211_CW_MIN_0 31 /* DS/CCK aCWmin, ERP aCWmin(0) */
43 #define IEEE80211_CW_MIN_1 15 /* OFDM aCWmin, ERP aCWmin(1) */
46 * SIFS (microseconds).
48 #define IEEE80211_DUR_SIFS 10 /* DS/CCK/ERP SIFS */
49 #define IEEE80211_DUR_OFDM_SIFS 16 /* OFDM SIFS */
52 * Slot time (microseconds).
54 #define IEEE80211_DUR_SLOT 20 /* DS/CCK slottime, ERP long slottime */
55 #define IEEE80211_DUR_SHSLOT 9 /* ERP short slottime */
56 #define IEEE80211_DUR_OFDM_SLOT 9 /* OFDM slottime */
58 #define IEEE80211_GET_SLOTTIME(ic) \
59 ((ic->ic_flags & IEEE80211_F_SHSLOT) ? \
60 IEEE80211_DUR_SHSLOT : IEEE80211_DUR_SLOT)
63 * DIFS (microseconds).
65 #define IEEE80211_DUR_DIFS(sifs, slot) ((sifs) + 2 * (slot))
67 struct ieee80211_channel;
69 #define IEEE80211_RATE_TABLE_SIZE 128
71 struct ieee80211_rate_table {
72 int rateCount; /* NB: for proper padding */
73 uint8_t rateCodeToIndex[256]; /* back mapping */
75 uint8_t phy; /* CCK/OFDM/TURBO */
76 uint32_t rateKbps; /* transfer rate in kbs */
77 uint8_t shortPreamble; /* mask for enabling short
78 * preamble in CCK rate code */
79 uint8_t dot11Rate; /* value for supported rates
80 * info element of MLME */
81 uint8_t ctlRateIndex; /* index of next lower basic
82 * rate; used for dur. calcs */
83 uint16_t lpAckDuration; /* long preamble ACK dur. */
84 uint16_t spAckDuration; /* short preamble ACK dur. */
85 } info[IEEE80211_RATE_TABLE_SIZE];
88 const struct ieee80211_rate_table *ieee80211_get_ratetable(
89 struct ieee80211_channel *);
91 static __inline__ uint8_t
92 ieee80211_ack_rate(const struct ieee80211_rate_table *rt, uint8_t rate)
95 * XXX Assert this is for a legacy rate; not for an MCS rate.
96 * If the caller wishes to use it for a basic rate, they should
97 * clear the high bit first.
99 KASSERT(! (rate & 0x80), ("rate %d is basic/mcs?", rate));
101 uint8_t cix = rt->info[rt->rateCodeToIndex[rate & IEEE80211_RATE_VAL]].ctlRateIndex;
102 KASSERT(cix != (uint8_t)-1, ("rate %d has no info", rate));
103 return rt->info[cix].dot11Rate;
106 static __inline__ uint8_t
107 ieee80211_ctl_rate(const struct ieee80211_rate_table *rt, uint8_t rate)
110 * XXX Assert this is for a legacy rate; not for an MCS rate.
111 * If the caller wishes to use it for a basic rate, they should
112 * clear the high bit first.
114 KASSERT(! (rate & 0x80), ("rate %d is basic/mcs?", rate));
116 uint8_t cix = rt->info[rt->rateCodeToIndex[rate & IEEE80211_RATE_VAL]].ctlRateIndex;
117 KASSERT(cix != (uint8_t)-1, ("rate %d has no info", rate));
118 return rt->info[cix].dot11Rate;
121 static __inline__ enum ieee80211_phytype
122 ieee80211_rate2phytype(const struct ieee80211_rate_table *rt, uint8_t rate)
125 * XXX Assert this is for a legacy rate; not for an MCS rate.
126 * If the caller wishes to use it for a basic rate, they should
127 * clear the high bit first.
129 KASSERT(! (rate & 0x80), ("rate %d is basic/mcs?", rate));
131 uint8_t rix = rt->rateCodeToIndex[rate & IEEE80211_RATE_VAL];
132 KASSERT(rix != (uint8_t)-1, ("rate %d has no info", rate));
133 return rt->info[rix].phy;
136 static __inline__ int
137 ieee80211_isratevalid(const struct ieee80211_rate_table *rt, uint8_t rate)
140 * XXX Assert this is for a legacy rate; not for an MCS rate.
141 * If the caller wishes to use it for a basic rate, they should
142 * clear the high bit first.
144 KASSERT(! (rate & 0x80), ("rate %d is basic/mcs?", rate));
146 return rt->rateCodeToIndex[rate] != (uint8_t)-1;
150 * Calculate ACK field for
151 * o non-fragment data frames
152 * o management frames
153 * sent using rate, phy and short preamble setting.
155 static __inline__ uint16_t
156 ieee80211_ack_duration(const struct ieee80211_rate_table *rt,
157 uint8_t rate, int isShortPreamble)
159 uint8_t rix = rt->rateCodeToIndex[rate];
161 KASSERT(rix != (uint8_t)-1, ("rate %d has no info", rate));
162 if (isShortPreamble) {
163 KASSERT(rt->info[rix].spAckDuration != 0,
164 ("shpreamble ack dur is not computed!\n"));
165 return rt->info[rix].spAckDuration;
167 KASSERT(rt->info[rix].lpAckDuration != 0,
168 ("lgpreamble ack dur is not computed!\n"));
169 return rt->info[rix].lpAckDuration;
173 static __inline__ uint8_t
174 ieee80211_legacy_rate_lookup(const struct ieee80211_rate_table *rt,
178 return (rt->rateCodeToIndex[rate & IEEE80211_RATE_VAL]);
182 * Compute the time to transmit a frame of length frameLen bytes
183 * using the specified 802.11 rate code, phy, and short preamble
186 * NB: SIFS is included.
188 uint16_t ieee80211_compute_duration(const struct ieee80211_rate_table *,
189 uint32_t frameLen, uint16_t rate, int isShortPreamble);
191 * Convert PLCP signal/rate field to 802.11 rate code (.5Mbits/s)
193 uint8_t ieee80211_plcp2rate(uint8_t, enum ieee80211_phytype);
195 * Convert 802.11 rate code to PLCP signal.
197 uint8_t ieee80211_rate2plcp(int, enum ieee80211_phytype);
200 * 802.11n rate manipulation.
203 #define IEEE80211_HT_RC_2_MCS(_rc) ((_rc) & 0x1f)
204 #define IEEE80211_HT_RC_2_STREAMS(_rc) ((((_rc) & 0x78) >> 3) + 1)
205 #define IEEE80211_IS_HT_RATE(_rc) ( (_rc) & IEEE80211_RATE_MCS)
207 uint32_t ieee80211_compute_duration_ht(uint32_t frameLen,
208 uint16_t rate, int streams, int isht40,
212 #endif /* !_NET80211_IEEE80211_PHY_H_ */