mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
synced 2025-01-16 02:14:58 +00:00
docs: networking: convert radiotap-headers.txt to ReST
- add SPDX header; - adjust title markup; - mark code blocks and literals as such; - adjust identation, whitespaces and blank lines where needed; - add to networking/index.rst. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by: David S. Miller <davem@davemloft.net>
This commit is contained in:
parent
832619012c
commit
66d495d0a5
@ -95,6 +95,7 @@ Contents:
|
|||||||
plip
|
plip
|
||||||
ppp_generic
|
ppp_generic
|
||||||
proc_net_tcp
|
proc_net_tcp
|
||||||
|
radiotap-headers
|
||||||
|
|
||||||
.. only:: subproject and html
|
.. only:: subproject and html
|
||||||
|
|
||||||
|
@ -13,7 +13,7 @@ following format::
|
|||||||
[ payload ]
|
[ payload ]
|
||||||
|
|
||||||
The radiotap format is discussed in
|
The radiotap format is discussed in
|
||||||
./Documentation/networking/radiotap-headers.txt.
|
./Documentation/networking/radiotap-headers.rst.
|
||||||
|
|
||||||
Despite many radiotap parameters being currently defined, most only make sense
|
Despite many radiotap parameters being currently defined, most only make sense
|
||||||
to appear on received packets. The following information is parsed from the
|
to appear on received packets. The following information is parsed from the
|
||||||
|
@ -1,3 +1,6 @@
|
|||||||
|
.. SPDX-License-Identifier: GPL-2.0
|
||||||
|
|
||||||
|
===========================
|
||||||
How to use radiotap headers
|
How to use radiotap headers
|
||||||
===========================
|
===========================
|
||||||
|
|
||||||
@ -5,9 +8,9 @@ Pointer to the radiotap include file
|
|||||||
------------------------------------
|
------------------------------------
|
||||||
|
|
||||||
Radiotap headers are variable-length and extensible, you can get most of the
|
Radiotap headers are variable-length and extensible, you can get most of the
|
||||||
information you need to know on them from:
|
information you need to know on them from::
|
||||||
|
|
||||||
./include/net/ieee80211_radiotap.h
|
./include/net/ieee80211_radiotap.h
|
||||||
|
|
||||||
This document gives an overview and warns on some corner cases.
|
This document gives an overview and warns on some corner cases.
|
||||||
|
|
||||||
@ -21,6 +24,8 @@ of the it_present member of ieee80211_radiotap_header is set, it means that
|
|||||||
the header for argument index 0 (IEEE80211_RADIOTAP_TSFT) is present in the
|
the header for argument index 0 (IEEE80211_RADIOTAP_TSFT) is present in the
|
||||||
argument area.
|
argument area.
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
< 8-byte ieee80211_radiotap_header >
|
< 8-byte ieee80211_radiotap_header >
|
||||||
[ <possible argument bitmap extensions ... > ]
|
[ <possible argument bitmap extensions ... > ]
|
||||||
[ <argument> ... ]
|
[ <argument> ... ]
|
||||||
@ -76,6 +81,8 @@ ieee80211_radiotap_header.
|
|||||||
Example valid radiotap header
|
Example valid radiotap header
|
||||||
-----------------------------
|
-----------------------------
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
0x00, 0x00, // <-- radiotap version + pad byte
|
0x00, 0x00, // <-- radiotap version + pad byte
|
||||||
0x0b, 0x00, // <- radiotap header length
|
0x0b, 0x00, // <- radiotap header length
|
||||||
0x04, 0x0c, 0x00, 0x00, // <-- bitmap
|
0x04, 0x0c, 0x00, 0x00, // <-- bitmap
|
||||||
@ -89,14 +96,14 @@ Using the Radiotap Parser
|
|||||||
|
|
||||||
If you are having to parse a radiotap struct, you can radically simplify the
|
If you are having to parse a radiotap struct, you can radically simplify the
|
||||||
job by using the radiotap parser that lives in net/wireless/radiotap.c and has
|
job by using the radiotap parser that lives in net/wireless/radiotap.c and has
|
||||||
its prototypes available in include/net/cfg80211.h. You use it like this:
|
its prototypes available in include/net/cfg80211.h. You use it like this::
|
||||||
|
|
||||||
#include <net/cfg80211.h>
|
#include <net/cfg80211.h>
|
||||||
|
|
||||||
/* buf points to the start of the radiotap header part */
|
/* buf points to the start of the radiotap header part */
|
||||||
|
|
||||||
int MyFunction(u8 * buf, int buflen)
|
int MyFunction(u8 * buf, int buflen)
|
||||||
{
|
{
|
||||||
int pkt_rate_100kHz = 0, antenna = 0, pwr = 0;
|
int pkt_rate_100kHz = 0, antenna = 0, pwr = 0;
|
||||||
struct ieee80211_radiotap_iterator iterator;
|
struct ieee80211_radiotap_iterator iterator;
|
||||||
int ret = ieee80211_radiotap_iterator_init(&iterator, buf, buflen);
|
int ret = ieee80211_radiotap_iterator_init(&iterator, buf, buflen);
|
||||||
@ -147,6 +154,6 @@ int MyFunction(u8 * buf, int buflen)
|
|||||||
|
|
||||||
...
|
...
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
Andy Green <andy@warmcat.com>
|
Andy Green <andy@warmcat.com>
|
@ -5211,7 +5211,7 @@ u32 ieee80211_mandatory_rates(struct ieee80211_supported_band *sband,
|
|||||||
* Radiotap parsing functions -- for controlled injection support
|
* Radiotap parsing functions -- for controlled injection support
|
||||||
*
|
*
|
||||||
* Implemented in net/wireless/radiotap.c
|
* Implemented in net/wireless/radiotap.c
|
||||||
* Documentation in Documentation/networking/radiotap-headers.txt
|
* Documentation in Documentation/networking/radiotap-headers.rst
|
||||||
*/
|
*/
|
||||||
|
|
||||||
struct radiotap_align_size {
|
struct radiotap_align_size {
|
||||||
|
@ -90,7 +90,7 @@ static const struct ieee80211_radiotap_namespace radiotap_ns = {
|
|||||||
* iterator.this_arg for type "type" safely on all arches.
|
* iterator.this_arg for type "type" safely on all arches.
|
||||||
*
|
*
|
||||||
* Example code:
|
* Example code:
|
||||||
* See Documentation/networking/radiotap-headers.txt
|
* See Documentation/networking/radiotap-headers.rst
|
||||||
*/
|
*/
|
||||||
|
|
||||||
int ieee80211_radiotap_iterator_init(
|
int ieee80211_radiotap_iterator_init(
|
||||||
|
Loading…
x
Reference in New Issue
Block a user