sys/net80211/ieee80211_phy.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2007-2008 Sam Leffler, Errno Consulting
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  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.
  15  *
  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.
  26  *
  27  * $FreeBSD$
  28  */
  29
  30 #ifndef _NET80211_IEEE80211_PHY_H_
  31 #define _NET80211_IEEE80211_PHY_H_
  32
  33 #ifdef _KERNEL
  34 /*
  35  * IEEE 802.11 PHY-related definitions.
  36  */
  37
  38 /*
  39  * Contention window (slots).
  40  */
  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) */
  44
  45 /*
  46  * SIFS (microseconds).
  47  */
  48 #define IEEE80211_DUR_SIFS      10      /* DS/CCK/ERP SIFS */
  49 #define IEEE80211_DUR_OFDM_SIFS 16      /* OFDM SIFS */
  50
  51 /*
  52  * Slot time (microseconds).
  53  */
  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 */
  57
  58 #define IEEE80211_GET_SLOTTIME(ic) \
  59         ((ic->ic_flags & IEEE80211_F_SHSLOT) ? \
  60             IEEE80211_DUR_SHSLOT : IEEE80211_DUR_SLOT)
  61
  62 /*
  63  * DIFS (microseconds).
  64  */
  65 #define IEEE80211_DUR_DIFS(sifs, slot)  ((sifs) + 2 * (slot))
  66
  67 struct ieee80211_channel;
  68
  69 #define IEEE80211_RATE_TABLE_SIZE       128
  70
  71 struct ieee80211_rate_table {
  72         int             rateCount;              /* NB: for proper padding */
  73         uint8_t         rateCodeToIndex[256];   /* back mapping */
  74         struct {
  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];
  86 };
  87
  88 const struct ieee80211_rate_table *ieee80211_get_ratetable(
  89                         struct ieee80211_channel *);
  90
  91 static __inline__ uint8_t
  92 ieee80211_ack_rate(const struct ieee80211_rate_table *rt, uint8_t rate)
  93 {
  94         /*
  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.
  98          */
  99         KASSERT(! (rate & 0x80), ("rate %d is basic/mcs?", rate));
 100
 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;
 104 }
 105
 106 static __inline__ uint8_t
 107 ieee80211_ctl_rate(const struct ieee80211_rate_table *rt, uint8_t rate)
 108 {
 109         /*
 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.
 113          */
 114         KASSERT(! (rate & 0x80), ("rate %d is basic/mcs?", rate));
 115
 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;
 119 }
 120
 121 static __inline__ enum ieee80211_phytype
 122 ieee80211_rate2phytype(const struct ieee80211_rate_table *rt, uint8_t rate)
 123 {
 124         /*
 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.
 128          */
 129         KASSERT(! (rate & 0x80), ("rate %d is basic/mcs?", rate));
 130
 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;
 134 }
 135
 136 static __inline__ int
 137 ieee80211_isratevalid(const struct ieee80211_rate_table *rt, uint8_t rate)
 138 {
 139         /*
 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.
 143          */
 144         KASSERT(! (rate & 0x80), ("rate %d is basic/mcs?", rate));
 145
 146         return rt->rateCodeToIndex[rate] != (uint8_t)-1;
 147 }
 148
 149 /*
 150  * Calculate ACK field for
 151  * o  non-fragment data frames
 152  * o  management frames
 153  * sent using rate, phy and short preamble setting.
 154  */
 155 static __inline__ uint16_t
 156 ieee80211_ack_duration(const struct ieee80211_rate_table *rt,
 157     uint8_t rate, int isShortPreamble)
 158 {
 159         uint8_t rix = rt->rateCodeToIndex[rate];
 160
 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;
 166         } else {
 167                 KASSERT(rt->info[rix].lpAckDuration != 0,
 168                         ("lgpreamble ack dur is not computed!\n"));
 169                 return rt->info[rix].lpAckDuration;
 170         }
 171 }
 172
 173 static __inline__ uint8_t
 174 ieee80211_legacy_rate_lookup(const struct ieee80211_rate_table *rt,
 175     uint8_t rate)
 176 {
 177
 178         return (rt->rateCodeToIndex[rate & IEEE80211_RATE_VAL]);
 179 }
 180
 181 /*
 182  * Compute the time to transmit a frame of length frameLen bytes
 183  * using the specified 802.11 rate code, phy, and short preamble
 184  * setting.
 185  *
 186  * NB: SIFS is included.
 187  */
 188 uint16_t        ieee80211_compute_duration(const struct ieee80211_rate_table *,
 189                         uint32_t frameLen, uint16_t rate, int isShortPreamble);
 190 /*
 191  * Convert PLCP signal/rate field to 802.11 rate code (.5Mbits/s)
 192  */
 193 uint8_t         ieee80211_plcp2rate(uint8_t, enum ieee80211_phytype);
 194 /*
 195  * Convert 802.11 rate code to PLCP signal.
 196  */
 197 uint8_t         ieee80211_rate2plcp(int, enum ieee80211_phytype);
 198
 199 /*
 200  * 802.11n rate manipulation.
 201  */
 202
 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)
 206
 207 uint32_t        ieee80211_compute_duration_ht(uint32_t frameLen,
 208                         uint16_t rate, int streams, int isht40,
 209                         int isShortGI);
 210
 211 #endif  /* _KERNEL */
 212 #endif  /* !_NET80211_IEEE80211_PHY_H_ */