include/net/ieee80211_radiotap.h

   1 /*
   2  * Copyright (c) 2017           Intel Deutschland GmbH
   3  *
   4  * Permission to use, copy, modify, and/or distribute this software for any
   5  * purpose with or without fee is hereby granted, provided that the above
   6  * copyright notice and this permission notice appear in all copies.
   7  *
   8  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
   9  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  10  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  11  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  12  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  13  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  14  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  15  */
  16 #ifndef __RADIOTAP_H
  17 #define __RADIOTAP_H
  18
  19 #include <linux/kernel.h>
  20 #include <asm/unaligned.h>
  21
  22 /**
  23  * struct ieee82011_radiotap_header - base radiotap header
  24  */
  25 struct ieee80211_radiotap_header {
  26         /**
  27          * @it_version: radiotap version, always 0
  28          */
  29         uint8_t it_version;
  30
  31         /**
  32          * @it_pad: padding (or alignment)
  33          */
  34         uint8_t it_pad;
  35
  36         /**
  37          * @it_len: overall radiotap header length
  38          */
  39         __le16 it_len;
  40
  41         /**
  42          * @it_present: (first) present word
  43          */
  44         __le32 it_present;
  45 } __packed;
  46
  47 /* version is always 0 */
  48 #define PKTHDR_RADIOTAP_VERSION 0
  49
  50 /* see the radiotap website for the descriptions */
  51 enum ieee80211_radiotap_presence {
  52         IEEE80211_RADIOTAP_TSFT = 0,
  53         IEEE80211_RADIOTAP_FLAGS = 1,
  54         IEEE80211_RADIOTAP_RATE = 2,
  55         IEEE80211_RADIOTAP_CHANNEL = 3,
  56         IEEE80211_RADIOTAP_FHSS = 4,
  57         IEEE80211_RADIOTAP_DBM_ANTSIGNAL = 5,
  58         IEEE80211_RADIOTAP_DBM_ANTNOISE = 6,
  59         IEEE80211_RADIOTAP_LOCK_QUALITY = 7,
  60         IEEE80211_RADIOTAP_TX_ATTENUATION = 8,
  61         IEEE80211_RADIOTAP_DB_TX_ATTENUATION = 9,
  62         IEEE80211_RADIOTAP_DBM_TX_POWER = 10,
  63         IEEE80211_RADIOTAP_ANTENNA = 11,
  64         IEEE80211_RADIOTAP_DB_ANTSIGNAL = 12,
  65         IEEE80211_RADIOTAP_DB_ANTNOISE = 13,
  66         IEEE80211_RADIOTAP_RX_FLAGS = 14,
  67         IEEE80211_RADIOTAP_TX_FLAGS = 15,
  68         IEEE80211_RADIOTAP_RTS_RETRIES = 16,
  69         IEEE80211_RADIOTAP_DATA_RETRIES = 17,
  70         /* 18 is XChannel, but it's not defined yet */
  71         IEEE80211_RADIOTAP_MCS = 19,
  72         IEEE80211_RADIOTAP_AMPDU_STATUS = 20,
  73         IEEE80211_RADIOTAP_VHT = 21,
  74         IEEE80211_RADIOTAP_TIMESTAMP = 22,
  75
  76         /* valid in every it_present bitmap, even vendor namespaces */
  77         IEEE80211_RADIOTAP_RADIOTAP_NAMESPACE = 29,
  78         IEEE80211_RADIOTAP_VENDOR_NAMESPACE = 30,
  79         IEEE80211_RADIOTAP_EXT = 31
  80 };
  81
  82 /* for IEEE80211_RADIOTAP_FLAGS */
  83 enum ieee80211_radiotap_flags {
  84         IEEE80211_RADIOTAP_F_CFP = 0x01,
  85         IEEE80211_RADIOTAP_F_SHORTPRE = 0x02,
  86         IEEE80211_RADIOTAP_F_WEP = 0x04,
  87         IEEE80211_RADIOTAP_F_FRAG = 0x08,
  88         IEEE80211_RADIOTAP_F_FCS = 0x10,
  89         IEEE80211_RADIOTAP_F_DATAPAD = 0x20,
  90         IEEE80211_RADIOTAP_F_BADFCS = 0x40,
  91 };
  92
  93 /* for IEEE80211_RADIOTAP_CHANNEL */
  94 enum ieee80211_radiotap_channel_flags {
  95         IEEE80211_CHAN_CCK = 0x0020,
  96         IEEE80211_CHAN_OFDM = 0x0040,
  97         IEEE80211_CHAN_2GHZ = 0x0080,
  98         IEEE80211_CHAN_5GHZ = 0x0100,
  99         IEEE80211_CHAN_DYN = 0x0400,
 100         IEEE80211_CHAN_HALF = 0x4000,
 101         IEEE80211_CHAN_QUARTER = 0x8000,
 102 };
 103
 104 /* for IEEE80211_RADIOTAP_RX_FLAGS */
 105 enum ieee80211_radiotap_rx_flags {
 106         IEEE80211_RADIOTAP_F_RX_BADPLCP = 0x0002,
 107 };
 108
 109 /* for IEEE80211_RADIOTAP_TX_FLAGS */
 110 enum ieee80211_radiotap_tx_flags {
 111         IEEE80211_RADIOTAP_F_TX_FAIL = 0x0001,
 112         IEEE80211_RADIOTAP_F_TX_CTS = 0x0002,
 113         IEEE80211_RADIOTAP_F_TX_RTS = 0x0004,
 114         IEEE80211_RADIOTAP_F_TX_NOACK = 0x0008,
 115 };
 116
 117 /* for IEEE80211_RADIOTAP_MCS "have" flags */
 118 enum ieee80211_radiotap_mcs_have {
 119         IEEE80211_RADIOTAP_MCS_HAVE_BW = 0x01,
 120         IEEE80211_RADIOTAP_MCS_HAVE_MCS = 0x02,
 121         IEEE80211_RADIOTAP_MCS_HAVE_GI = 0x04,
 122         IEEE80211_RADIOTAP_MCS_HAVE_FMT = 0x08,
 123         IEEE80211_RADIOTAP_MCS_HAVE_FEC = 0x10,
 124         IEEE80211_RADIOTAP_MCS_HAVE_STBC = 0x20,
 125 };
 126
 127 enum ieee80211_radiotap_mcs_flags {
 128         IEEE80211_RADIOTAP_MCS_BW_MASK = 0x03,
 129         IEEE80211_RADIOTAP_MCS_BW_20 = 0,
 130         IEEE80211_RADIOTAP_MCS_BW_40 = 1,
 131         IEEE80211_RADIOTAP_MCS_BW_20L = 2,
 132         IEEE80211_RADIOTAP_MCS_BW_20U = 3,
 133
 134         IEEE80211_RADIOTAP_MCS_SGI = 0x04,
 135         IEEE80211_RADIOTAP_MCS_FMT_GF = 0x08,
 136         IEEE80211_RADIOTAP_MCS_FEC_LDPC = 0x10,
 137         IEEE80211_RADIOTAP_MCS_STBC_MASK = 0x60,
 138         IEEE80211_RADIOTAP_MCS_STBC_1 = 1,
 139         IEEE80211_RADIOTAP_MCS_STBC_2 = 2,
 140         IEEE80211_RADIOTAP_MCS_STBC_3 = 3,
 141         IEEE80211_RADIOTAP_MCS_STBC_SHIFT = 5,
 142 };
 143
 144 /* for IEEE80211_RADIOTAP_AMPDU_STATUS */
 145 enum ieee80211_radiotap_ampdu_flags {
 146         IEEE80211_RADIOTAP_AMPDU_REPORT_ZEROLEN = 0x0001,
 147         IEEE80211_RADIOTAP_AMPDU_IS_ZEROLEN = 0x0002,
 148         IEEE80211_RADIOTAP_AMPDU_LAST_KNOWN = 0x0004,
 149         IEEE80211_RADIOTAP_AMPDU_IS_LAST = 0x0008,
 150         IEEE80211_RADIOTAP_AMPDU_DELIM_CRC_ERR = 0x0010,
 151         IEEE80211_RADIOTAP_AMPDU_DELIM_CRC_KNOWN = 0x0020,
 152 };
 153
 154 /* for IEEE80211_RADIOTAP_VHT */
 155 enum ieee80211_radiotap_vht_known {
 156         IEEE80211_RADIOTAP_VHT_KNOWN_STBC = 0x0001,
 157         IEEE80211_RADIOTAP_VHT_KNOWN_TXOP_PS_NA = 0x0002,
 158         IEEE80211_RADIOTAP_VHT_KNOWN_GI = 0x0004,
 159         IEEE80211_RADIOTAP_VHT_KNOWN_SGI_NSYM_DIS = 0x0008,
 160         IEEE80211_RADIOTAP_VHT_KNOWN_LDPC_EXTRA_OFDM_SYM = 0x0010,
 161         IEEE80211_RADIOTAP_VHT_KNOWN_BEAMFORMED = 0x0020,
 162         IEEE80211_RADIOTAP_VHT_KNOWN_BANDWIDTH = 0x0040,
 163         IEEE80211_RADIOTAP_VHT_KNOWN_GROUP_ID = 0x0080,
 164         IEEE80211_RADIOTAP_VHT_KNOWN_PARTIAL_AID = 0x0100,
 165 };
 166
 167 enum ieee80211_radiotap_vht_flags {
 168         IEEE80211_RADIOTAP_VHT_FLAG_STBC = 0x01,
 169         IEEE80211_RADIOTAP_VHT_FLAG_TXOP_PS_NA = 0x02,
 170         IEEE80211_RADIOTAP_VHT_FLAG_SGI = 0x04,
 171         IEEE80211_RADIOTAP_VHT_FLAG_SGI_NSYM_M10_9 = 0x08,
 172         IEEE80211_RADIOTAP_VHT_FLAG_LDPC_EXTRA_OFDM_SYM = 0x10,
 173         IEEE80211_RADIOTAP_VHT_FLAG_BEAMFORMED = 0x20,
 174 };
 175
 176 enum ieee80211_radiotap_vht_coding {
 177         IEEE80211_RADIOTAP_CODING_LDPC_USER0 = 0x01,
 178         IEEE80211_RADIOTAP_CODING_LDPC_USER1 = 0x02,
 179         IEEE80211_RADIOTAP_CODING_LDPC_USER2 = 0x04,
 180         IEEE80211_RADIOTAP_CODING_LDPC_USER3 = 0x08,
 181 };
 182
 183 /* for IEEE80211_RADIOTAP_TIMESTAMP */
 184 enum ieee80211_radiotap_timestamp_unit_spos {
 185         IEEE80211_RADIOTAP_TIMESTAMP_UNIT_MASK = 0x000F,
 186         IEEE80211_RADIOTAP_TIMESTAMP_UNIT_MS = 0x0000,
 187         IEEE80211_RADIOTAP_TIMESTAMP_UNIT_US = 0x0001,
 188         IEEE80211_RADIOTAP_TIMESTAMP_UNIT_NS = 0x0003,
 189         IEEE80211_RADIOTAP_TIMESTAMP_SPOS_MASK = 0x00F0,
 190         IEEE80211_RADIOTAP_TIMESTAMP_SPOS_BEGIN_MDPU = 0x0000,
 191         IEEE80211_RADIOTAP_TIMESTAMP_SPOS_PLCP_SIG_ACQ = 0x0010,
 192         IEEE80211_RADIOTAP_TIMESTAMP_SPOS_EO_PPDU = 0x0020,
 193         IEEE80211_RADIOTAP_TIMESTAMP_SPOS_EO_MPDU = 0x0030,
 194         IEEE80211_RADIOTAP_TIMESTAMP_SPOS_UNKNOWN = 0x00F0,
 195 };
 196
 197 enum ieee80211_radiotap_timestamp_flags {
 198         IEEE80211_RADIOTAP_TIMESTAMP_FLAG_64BIT = 0x00,
 199         IEEE80211_RADIOTAP_TIMESTAMP_FLAG_32BIT = 0x01,
 200         IEEE80211_RADIOTAP_TIMESTAMP_FLAG_ACCURACY = 0x02,
 201 };
 202
 203 /**
 204  * ieee80211_get_radiotap_len - get radiotap header length
 205  */
 206 static inline u16 ieee80211_get_radiotap_len(const char *data)
 207 {
 208         struct ieee80211_radiotap_header *hdr = (void *)data;
 209
 210         return get_unaligned_le16(&hdr->it_len);
 211 }
 212
 213 #endif /* __RADIOTAP_H */