ieee80211_radiotap.h 8.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231
  1. /* $FreeBSD: src/sys/net80211/ieee80211_radiotap.h,v 1.5 2005/01/22 20:12:05 sam Exp $ */
  2. /* $NetBSD: ieee80211_radiotap.h,v 1.11 2005/06/22 06:16:02 dyoung Exp $ */
  3. /*-
  4. * Copyright (c) 2003, 2004 David Young. All rights reserved.
  5. *
  6. * Redistribution and use in source and binary forms, with or without
  7. * modification, are permitted provided that the following conditions
  8. * are met:
  9. * 1. Redistributions of source code must retain the above copyright
  10. * notice, this list of conditions and the following disclaimer.
  11. * 2. Redistributions in binary form must reproduce the above copyright
  12. * notice, this list of conditions and the following disclaimer in the
  13. * documentation and/or other materials provided with the distribution.
  14. * 3. The name of David Young may not be used to endorse or promote
  15. * products derived from this software without specific prior
  16. * written permission.
  17. *
  18. * THIS SOFTWARE IS PROVIDED BY DAVID YOUNG ``AS IS'' AND ANY
  19. * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  20. * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  21. * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL DAVID
  22. * YOUNG BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  23. * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
  24. * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25. * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  26. * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  27. * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28. * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
  29. * OF SUCH DAMAGE.
  30. */
  31. /*
  32. * Modifications to fit into the linux IEEE 802.11 stack,
  33. * Mike Kershaw (dragorn@kismetwireless.net)
  34. */
  35. #ifndef IEEE80211RADIOTAP_H
  36. #define IEEE80211RADIOTAP_H
  37. #include <linux/if_ether.h>
  38. #include <linux/kernel.h>
  39. /* Radiotap header version (from official NetBSD feed) */
  40. #define IEEE80211RADIOTAP_VERSION "1.5"
  41. /* Base version of the radiotap packet header data */
  42. #define PKTHDR_RADIOTAP_VERSION 0
  43. /* A generic radio capture format is desirable. There is one for
  44. * Linux, but it is neither rigidly defined (there were not even
  45. * units given for some fields) nor easily extensible.
  46. *
  47. * I suggest the following extensible radio capture format. It is
  48. * based on a bitmap indicating which fields are present.
  49. *
  50. * I am trying to describe precisely what the application programmer
  51. * should expect in the following, and for that reason I tell the
  52. * units and origin of each measurement (where it applies), or else I
  53. * use sufficiently weaselly language ("is a monotonically nondecreasing
  54. * function of...") that I cannot set false expectations for lawyerly
  55. * readers.
  56. */
  57. /* XXX tcpdump/libpcap do not tolerate variable-length headers,
  58. * yet, so we pad every radiotap header to 64 bytes. Ugh.
  59. */
  60. #define IEEE80211_RADIOTAP_HDRLEN 64
  61. /* The radio capture header precedes the 802.11 header. */
  62. struct ieee80211_radiotap_header {
  63. u8 it_version; /* Version 0. Only increases
  64. * for drastic changes,
  65. * introduction of compatible
  66. * new fields does not count.
  67. */
  68. u8 it_pad;
  69. u16 it_len; /* length of the whole
  70. * header in bytes, including
  71. * it_version, it_pad,
  72. * it_len, and data fields.
  73. */
  74. u32 it_present; /* A bitmap telling which
  75. * fields are present. Set bit 31
  76. * (0x80000000) to extend the
  77. * bitmap by another 32 bits.
  78. * Additional extensions are made
  79. * by setting bit 31.
  80. */
  81. };
  82. /* Name Data type Units
  83. * ---- --------- -----
  84. *
  85. * IEEE80211_RADIOTAP_TSFT u64 microseconds
  86. *
  87. * Value in microseconds of the MAC's 64-bit 802.11 Time
  88. * Synchronization Function timer when the first bit of the
  89. * MPDU arrived at the MAC. For received frames, only.
  90. *
  91. * IEEE80211_RADIOTAP_CHANNEL 2 x u16 MHz, bitmap
  92. *
  93. * Tx/Rx frequency in MHz, followed by flags (see below).
  94. *
  95. * IEEE80211_RADIOTAP_FHSS u16 see below
  96. *
  97. * For frequency-hopping radios, the hop set (first byte)
  98. * and pattern (second byte).
  99. *
  100. * IEEE80211_RADIOTAP_RATE u8 500kb/s
  101. *
  102. * Tx/Rx data rate
  103. *
  104. * IEEE80211_RADIOTAP_DBM_ANTSIGNAL int8_t decibels from
  105. * one milliwatt (dBm)
  106. *
  107. * RF signal power at the antenna, decibel difference from
  108. * one milliwatt.
  109. *
  110. * IEEE80211_RADIOTAP_DBM_ANTNOISE int8_t decibels from
  111. * one milliwatt (dBm)
  112. *
  113. * RF noise power at the antenna, decibel difference from one
  114. * milliwatt.
  115. *
  116. * IEEE80211_RADIOTAP_DB_ANTSIGNAL u8 decibel (dB)
  117. *
  118. * RF signal power at the antenna, decibel difference from an
  119. * arbitrary, fixed reference.
  120. *
  121. * IEEE80211_RADIOTAP_DB_ANTNOISE u8 decibel (dB)
  122. *
  123. * RF noise power at the antenna, decibel difference from an
  124. * arbitrary, fixed reference point.
  125. *
  126. * IEEE80211_RADIOTAP_LOCK_QUALITY u16 unitless
  127. *
  128. * Quality of Barker code lock. Unitless. Monotonically
  129. * nondecreasing with "better" lock strength. Called "Signal
  130. * Quality" in datasheets. (Is there a standard way to measure
  131. * this?)
  132. *
  133. * IEEE80211_RADIOTAP_TX_ATTENUATION u16 unitless
  134. *
  135. * Transmit power expressed as unitless distance from max
  136. * power set at factory calibration. 0 is max power.
  137. * Monotonically nondecreasing with lower power levels.
  138. *
  139. * IEEE80211_RADIOTAP_DB_TX_ATTENUATION u16 decibels (dB)
  140. *
  141. * Transmit power expressed as decibel distance from max power
  142. * set at factory calibration. 0 is max power. Monotonically
  143. * nondecreasing with lower power levels.
  144. *
  145. * IEEE80211_RADIOTAP_DBM_TX_POWER int8_t decibels from
  146. * one milliwatt (dBm)
  147. *
  148. * Transmit power expressed as dBm (decibels from a 1 milliwatt
  149. * reference). This is the absolute power level measured at
  150. * the antenna port.
  151. *
  152. * IEEE80211_RADIOTAP_FLAGS u8 bitmap
  153. *
  154. * Properties of transmitted and received frames. See flags
  155. * defined below.
  156. *
  157. * IEEE80211_RADIOTAP_ANTENNA u8 antenna index
  158. *
  159. * Unitless indication of the Rx/Tx antenna for this packet.
  160. * The first antenna is antenna 0.
  161. *
  162. * IEEE80211_RADIOTAP_FCS u32 data
  163. *
  164. * FCS from frame in network byte order.
  165. */
  166. enum ieee80211_radiotap_type {
  167. IEEE80211_RADIOTAP_TSFT = 0,
  168. IEEE80211_RADIOTAP_FLAGS = 1,
  169. IEEE80211_RADIOTAP_RATE = 2,
  170. IEEE80211_RADIOTAP_CHANNEL = 3,
  171. IEEE80211_RADIOTAP_FHSS = 4,
  172. IEEE80211_RADIOTAP_DBM_ANTSIGNAL = 5,
  173. IEEE80211_RADIOTAP_DBM_ANTNOISE = 6,
  174. IEEE80211_RADIOTAP_LOCK_QUALITY = 7,
  175. IEEE80211_RADIOTAP_TX_ATTENUATION = 8,
  176. IEEE80211_RADIOTAP_DB_TX_ATTENUATION = 9,
  177. IEEE80211_RADIOTAP_DBM_TX_POWER = 10,
  178. IEEE80211_RADIOTAP_ANTENNA = 11,
  179. IEEE80211_RADIOTAP_DB_ANTSIGNAL = 12,
  180. IEEE80211_RADIOTAP_DB_ANTNOISE = 13,
  181. IEEE80211_RADIOTAP_EXT = 31,
  182. };
  183. /* Channel flags. */
  184. #define IEEE80211_CHAN_TURBO 0x0010 /* Turbo channel */
  185. #define IEEE80211_CHAN_CCK 0x0020 /* CCK channel */
  186. #define IEEE80211_CHAN_OFDM 0x0040 /* OFDM channel */
  187. #define IEEE80211_CHAN_2GHZ 0x0080 /* 2 GHz spectrum channel. */
  188. #define IEEE80211_CHAN_5GHZ 0x0100 /* 5 GHz spectrum channel */
  189. #define IEEE80211_CHAN_PASSIVE 0x0200 /* Only passive scan allowed */
  190. #define IEEE80211_CHAN_DYN 0x0400 /* Dynamic CCK-OFDM channel */
  191. #define IEEE80211_CHAN_GFSK 0x0800 /* GFSK channel (FHSS PHY) */
  192. /* For IEEE80211_RADIOTAP_FLAGS */
  193. #define IEEE80211_RADIOTAP_F_CFP 0x01 /* sent/received
  194. * during CFP
  195. */
  196. #define IEEE80211_RADIOTAP_F_SHORTPRE 0x02 /* sent/received
  197. * with short
  198. * preamble
  199. */
  200. #define IEEE80211_RADIOTAP_F_WEP 0x04 /* sent/received
  201. * with WEP encryption
  202. */
  203. #define IEEE80211_RADIOTAP_F_FRAG 0x08 /* sent/received
  204. * with fragmentation
  205. */
  206. #define IEEE80211_RADIOTAP_F_FCS 0x10 /* frame includes FCS */
  207. #define IEEE80211_RADIOTAP_F_DATAPAD 0x20 /* frame has padding between
  208. * 802.11 header and payload
  209. * (to 32-bit boundary)
  210. */
  211. /* Ugly macro to convert literal channel numbers into their mhz equivalents
  212. * There are certianly some conditions that will break this (like feeding it '30')
  213. * but they shouldn't arise since nothing talks on channel 30. */
  214. #define ieee80211chan2mhz(x) \
  215. (((x) <= 14) ? \
  216. (((x) == 14) ? 2484 : ((x) * 5) + 2407) : \
  217. ((x) + 1000) * 5)
  218. #endif /* IEEE80211_RADIOTAP_H */