Skip to content

L
linux
Commit 352de557 authored by Johannes Berg's avatar Johannes Berg Committed by John W. Linville
Browse files
Options

wireless: move documentation books 

This moves mac80211 documentation into a new
802.11 bookset and also adds a cfg80211 book
to the set. All of this is rather incomplete,
but it's easier to work with big code moving
as a separate patch.
Signed-off-by: default avatarJohannes Berg <johannes.berg@intel.com>
Signed-off-by: default avatarJohn W. Linville <linville@tuxdriver.com>
parent d7eb50c0
Hide whitespace changes
Inline Side-by-side
Showing with 372 additions and 1 deletion
Documentation/DocBook/mac80211.tmpl → Documentation/DocBook/80211.tmpl
View file @ 352de557
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" <!DOCTYPE set PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" []> "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" []>
<set>
<setinfo>
<title>The 802.11 subsystems &ndash; for kernel developers</title>
<subtitle>
Explaining wireless 802.11 networking in the Linux kernel
</subtitle>
<book id="mac80211-developers-guide"> <copyright>
<bookinfo> <year>2007-2009</year>
<title>The mac80211 subsystem for kernel developers</title> <holder>Johannes Berg</holder>
</copyright>
<authorgroup> <authorgroup>
<author> <author>
...@@ -16,32 +23,24 @@ ...@@ -16,32 +23,24 @@
</author> </author>
</authorgroup> </authorgroup>
<copyright>
<year>2007-2009</year>
<holder>Johannes Berg</holder>
</copyright>
<legalnotice> <legalnotice>
<para> <para>
This documentation is free software; you can redistribute This documentation is free software; you can redistribute
it and/or modify it under the terms of the GNU General Public it and/or modify it under the terms of the GNU General Public
License version 2 as published by the Free Software Foundation. License version 2 as published by the Free Software Foundation.
</para> </para>
<para> <para>
This documentation is distributed in the hope that it will be This documentation is distributed in the hope that it will be
useful, but WITHOUT ANY WARRANTY; without even the implied useful, but WITHOUT ANY WARRANTY; without even the implied
warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU General Public License for more details. See the GNU General Public License for more details.
</para> </para>
<para> <para>
You should have received a copy of the GNU General Public You should have received a copy of the GNU General Public
License along with this documentation; if not, write to the Free License along with this documentation; if not, write to the Free
Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, Software Foundation, Inc., 59 Temple Place, Suite 330, Boston,
MA 02111-1307 USA MA 02111-1307 USA
</para> </para>
<para> <para>
For more details see the file COPYING in the source For more details see the file COPYING in the source
distribution of Linux. distribution of Linux.
...@@ -49,59 +48,93 @@ ...@@ -49,59 +48,93 @@
</legalnotice> </legalnotice>
<abstract> <abstract>
<para>
These books attempt to give a description of the
various subsystems that play a role in 802.11 wireless
networking in Linux. Since these books are for kernel
developers they attempts to document the structures
and functions used in the kernel as well as giving a
higher-level overview.
</para>
<para>
The reader is expected to be familiar with the 802.11
standard as published by the IEEE in 802.11-2007 (or
possibly later versions). References to this standard
will be given as "802.11-2007 8.1.5".
</para>
</abstract>
</setinfo>
<book id="cfg80211-developers-guide">
<bookinfo>
<title>The cfg80211 subsystem</title>
<abstract>
<para>
MISSING
</para>
</abstract>
</bookinfo>
<part><chapter>
!Finclude/net/cfg80211.h ieee80211_band
</chapter></part>
</book>
<book id="mac80211-developers-guide">
<bookinfo>
<title>The mac80211 subsystem</title>
<abstract>
!Pinclude/net/mac80211.h Introduction !Pinclude/net/mac80211.h Introduction
!Pinclude/net/mac80211.h Warning !Pinclude/net/mac80211.h Warning
</abstract> </abstract>
</bookinfo> </bookinfo>
<toc></toc> <toc></toc>
<!-- <!--
Generally, this document shall be ordered by increasing complexity. Generally, this document shall be ordered by increasing complexity.
It is important to note that readers should be able to read only It is important to note that readers should be able to read only
the first few sections to get a working driver and only advanced the first few sections to get a working driver and only advanced
usage should require reading the full document. usage should require reading the full document.
--> -->
<part> <part>
<title>The basic mac80211 driver interface</title> <title>The basic mac80211 driver interface</title>
<partintro> <partintro>
<para> <para>
You should read and understand the information contained You should read and understand the information contained
within this part of the book while implementing a driver. within this part of the book while implementing a driver.
In some chapters, advanced usage is noted, that may be In some chapters, advanced usage is noted, that may be
skipped at first. skipped at first.
</para> </para>
<para> <para>
This part of the book only covers station and monitor mode This part of the book only covers station and monitor mode
functionality, additional information required to implement functionality, additional information required to implement
the other modes is covered in the second part of the book. the other modes is covered in the second part of the book.
</para> </para>
</partintro> </partintro>
<chapter id="basics"> <chapter id="basics">
<title>Basic hardware handling</title> <title>Basic hardware handling</title>
<para>TBD</para> <para>TBD</para>
<para> <para>
This chapter shall contain information on getting a hw This chapter shall contain information on getting a hw
struct allocated and registered with mac80211. struct allocated and registered with mac80211.
</para> </para>
<para> <para>
Since it is required to allocate rates/modes before registering Since it is required to allocate rates/modes before registering
a hw struct, this chapter shall also contain information on setting a hw struct, this chapter shall also contain information on setting
up the rate/mode structs. up the rate/mode structs.
</para> </para>
<para> <para>
Additionally, some discussion about the callbacks and Additionally, some discussion about the callbacks and
the general programming model should be in here, including the general programming model should be in here, including
the definition of ieee80211_ops which will be referred to the definition of ieee80211_ops which will be referred to
a lot. a lot.
</para> </para>
<para> <para>
Finally, a discussion of hardware capabilities should be done Finally, a discussion of hardware capabilities should be done
with references to other parts of the book. with references to other parts of the book.
</para> </para>
<!-- intentionally multiple !F lines to get proper order --> <!-- intentionally multiple !F lines to get proper order -->
!Finclude/net/mac80211.h ieee80211_hw !Finclude/net/mac80211.h ieee80211_hw
!Finclude/net/mac80211.h ieee80211_hw_flags !Finclude/net/mac80211.h ieee80211_hw_flags
!Finclude/net/mac80211.h SET_IEEE80211_DEV !Finclude/net/mac80211.h SET_IEEE80211_DEV
...@@ -115,63 +148,63 @@ usage should require reading the full document. ...@@ -115,63 +148,63 @@ usage should require reading the full document.
!Finclude/net/mac80211.h ieee80211_get_radio_led_name !Finclude/net/mac80211.h ieee80211_get_radio_led_name
!Finclude/net/mac80211.h ieee80211_unregister_hw !Finclude/net/mac80211.h ieee80211_unregister_hw
!Finclude/net/mac80211.h ieee80211_free_hw !Finclude/net/mac80211.h ieee80211_free_hw
</chapter> </chapter>
<chapter id="phy-handling"> <chapter id="phy-handling">
<title>PHY configuration</title> <title>PHY configuration</title>
<para>TBD</para> <para>TBD</para>
<para> <para>
This chapter should describe PHY handling including This chapter should describe PHY handling including
start/stop callbacks and the various structures used. start/stop callbacks and the various structures used.
</para> </para>
!Finclude/net/mac80211.h ieee80211_conf !Finclude/net/mac80211.h ieee80211_conf
!Finclude/net/mac80211.h ieee80211_conf_flags !Finclude/net/mac80211.h ieee80211_conf_flags
</chapter> </chapter>
<chapter id="iface-handling">
<title>Virtual interfaces</title>
<para>TBD</para>
<para>
This chapter should describe virtual interface basics
that are relevant to the driver (VLANs, MGMT etc are not.)
It should explain the use of the add_iface/remove_iface
callbacks as well as the interface configuration callbacks.
</para>
<para>Things related to AP mode should be discussed there.</para>
<para>
Things related to supporting multiple interfaces should be
in the appropriate chapter, a BIG FAT note should be here about
this though and the recommendation to allow only a single
interface in STA mode at first!
</para>
!Finclude/net/mac80211.h ieee80211_vif
</chapter>
<chapter id="rx-tx"> <chapter id="iface-handling">
<title>Receive and transmit processing</title> <title>Virtual interfaces</title>
<sect1>
<title>what should be here</title>
<para>TBD</para> <para>TBD</para>
<para> <para>
This should describe the receive and transmit This chapter should describe virtual interface basics
paths in mac80211/the drivers as well as that are relevant to the driver (VLANs, MGMT etc are not.)
transmit status handling. It should explain the use of the add_iface/remove_iface
callbacks as well as the interface configuration callbacks.
</para> </para>
</sect1> <para>Things related to AP mode should be discussed there.</para>
<sect1> <para>
<title>Frame format</title> Things related to supporting multiple interfaces should be
in the appropriate chapter, a BIG FAT note should be here about
this though and the recommendation to allow only a single
interface in STA mode at first!
</para>
!Finclude/net/mac80211.h ieee80211_vif
</chapter>
<chapter id="rx-tx">
<title>Receive and transmit processing</title>
<sect1>
<title>what should be here</title>
<para>TBD</para>
<para>
This should describe the receive and transmit
paths in mac80211/the drivers as well as
transmit status handling.
</para>
</sect1>
<sect1>
<title>Frame format</title>
!Pinclude/net/mac80211.h Frame format !Pinclude/net/mac80211.h Frame format
</sect1> </sect1>
<sect1> <sect1>
<title>Packet alignment</title> <title>Packet alignment</title>
!Pnet/mac80211/rx.c Packet alignment !Pnet/mac80211/rx.c Packet alignment
</sect1> </sect1>
<sect1> <sect1>
<title>Calling into mac80211 from interrupts</title> <title>Calling into mac80211 from interrupts</title>
!Pinclude/net/mac80211.h Calling mac80211 from interrupts !Pinclude/net/mac80211.h Calling mac80211 from interrupts
</sect1> </sect1>
<sect1> <sect1>
<title>functions/definitions</title> <title>functions/definitions</title>
!Finclude/net/mac80211.h ieee80211_rx_status !Finclude/net/mac80211.h ieee80211_rx_status
!Finclude/net/mac80211.h mac80211_rx_flags !Finclude/net/mac80211.h mac80211_rx_flags
!Finclude/net/mac80211.h ieee80211_tx_info !Finclude/net/mac80211.h ieee80211_tx_info
...@@ -188,150 +221,151 @@ usage should require reading the full document. ...@@ -188,150 +221,151 @@ usage should require reading the full document.
!Finclude/net/mac80211.h ieee80211_stop_queue !Finclude/net/mac80211.h ieee80211_stop_queue
!Finclude/net/mac80211.h ieee80211_wake_queues !Finclude/net/mac80211.h ieee80211_wake_queues
!Finclude/net/mac80211.h ieee80211_stop_queues !Finclude/net/mac80211.h ieee80211_stop_queues
</sect1> </sect1>
</chapter> </chapter>
<chapter id="filters"> <chapter id="filters">
<title>Frame filtering</title> <title>Frame filtering</title>
!Pinclude/net/mac80211.h Frame filtering !Pinclude/net/mac80211.h Frame filtering
!Finclude/net/mac80211.h ieee80211_filter_flags !Finclude/net/mac80211.h ieee80211_filter_flags
</chapter> </chapter>
</part> </part>
<part id="advanced"> <part id="advanced">
<title>Advanced driver interface</title> <title>Advanced driver interface</title>
<partintro> <partintro>
<para> <para>
Information contained within this part of the book is Information contained within this part of the book is
of interest only for advanced interaction of mac80211 of interest only for advanced interaction of mac80211
with drivers to exploit more hardware capabilities and with drivers to exploit more hardware capabilities and
improve performance. improve performance.
</para> </para>
</partintro> </partintro>
<chapter id="hardware-crypto-offload"> <chapter id="hardware-crypto-offload">
<title>Hardware crypto acceleration</title> <title>Hardware crypto acceleration</title>
!Pinclude/net/mac80211.h Hardware crypto acceleration !Pinclude/net/mac80211.h Hardware crypto acceleration
<!-- intentionally multiple !F lines to get proper order --> <!-- intentionally multiple !F lines to get proper order -->
!Finclude/net/mac80211.h set_key_cmd !Finclude/net/mac80211.h set_key_cmd
!Finclude/net/mac80211.h ieee80211_key_conf !Finclude/net/mac80211.h ieee80211_key_conf
!Finclude/net/mac80211.h ieee80211_key_alg !Finclude/net/mac80211.h ieee80211_key_alg
!Finclude/net/mac80211.h ieee80211_key_flags !Finclude/net/mac80211.h ieee80211_key_flags
</chapter> </chapter>
<chapter id="powersave"> <chapter id="powersave">
<title>Powersave support</title> <title>Powersave support</title>
!Pinclude/net/mac80211.h Powersave support !Pinclude/net/mac80211.h Powersave support
</chapter> </chapter>
<chapter id="beacon-filter"> <chapter id="beacon-filter">
<title>Beacon filter support</title> <title>Beacon filter support</title>
!Pinclude/net/mac80211.h Beacon filter support !Pinclude/net/mac80211.h Beacon filter support
!Finclude/net/mac80211.h ieee80211_beacon_loss !Finclude/net/mac80211.h ieee80211_beacon_loss
</chapter> </chapter>
<chapter id="qos"> <chapter id="qos">
<title>Multiple queues and QoS support</title> <title>Multiple queues and QoS support</title>
<para>TBD</para> <para>TBD</para>
!Finclude/net/mac80211.h ieee80211_tx_queue_params !Finclude/net/mac80211.h ieee80211_tx_queue_params
</chapter> </chapter>
<chapter id="AP"> <chapter id="AP">
<title>Access point mode support</title> <title>Access point mode support</title>
<para>TBD</para> <para>TBD</para>
<para>Some parts of the if_conf should be discussed here instead</para> <para>Some parts of the if_conf should be discussed here instead</para>
<para> <para>
Insert notes about VLAN interfaces with hw crypto here or Insert notes about VLAN interfaces with hw crypto here or
in the hw crypto chapter. in the hw crypto chapter.
</para> </para>
!Finclude/net/mac80211.h ieee80211_get_buffered_bc !Finclude/net/mac80211.h ieee80211_get_buffered_bc
!Finclude/net/mac80211.h ieee80211_beacon_get !Finclude/net/mac80211.h ieee80211_beacon_get
</chapter> </chapter>
<chapter id="multi-iface"> <chapter id="multi-iface">
<title>Supporting multiple virtual interfaces</title> <title>Supporting multiple virtual interfaces</title>
<para>TBD</para> <para>TBD</para>
<para> <para>
Note: WDS with identical MAC address should almost always be OK Note: WDS with identical MAC address should almost always be OK
</para> </para>
<para> <para>
Insert notes about having multiple virtual interfaces with Insert notes about having multiple virtual interfaces with
different MAC addresses here, note which configurations are different MAC addresses here, note which configurations are
supported by mac80211, add notes about supporting hw crypto supported by mac80211, add notes about supporting hw crypto
with it. with it.
</para> </para>
</chapter> </chapter>
<chapter id="hardware-scan-offload"> <chapter id="hardware-scan-offload">
<title>Hardware scan offload</title> <title>Hardware scan offload</title>
<para>TBD</para> <para>TBD</para>
!Finclude/net/mac80211.h ieee80211_scan_completed !Finclude/net/mac80211.h ieee80211_scan_completed
</chapter> </chapter>
</part> </part>
<part id="rate-control"> <part id="rate-control">
<title>Rate control interface</title> <title>Rate control interface</title>
<partintro> <partintro>
<para>TBD</para> <para>TBD</para>
<para> <para>
This part of the book describes the rate control algorithm This part of the book describes the rate control algorithm
interface and how it relates to mac80211 and drivers. interface and how it relates to mac80211 and drivers.
</para> </para>
</partintro> </partintro>
<chapter id="dummy"> <chapter id="dummy">
<title>dummy chapter</title> <title>dummy chapter</title>
<para>TBD</para> <para>TBD</para>
</chapter> </chapter>
</part> </part>
<part id="internal"> <part id="internal">
<title>Internals</title> <title>Internals</title>
<partintro> <partintro>
<para>TBD</para> <para>TBD</para>
<para> <para>
This part of the book describes mac80211 internals. This part of the book describes mac80211 internals.
</para> </para>
</partintro> </partintro>
<chapter id="key-handling"> <chapter id="key-handling">
<title>Key handling</title> <title>Key handling</title>
<sect1> <sect1>
<title>Key handling basics</title> <title>Key handling basics</title>
!Pnet/mac80211/key.c Key handling basics !Pnet/mac80211/key.c Key handling basics
</sect1> </sect1>
<sect1> <sect1>
<title>MORE TBD</title> <title>MORE TBD</title>
<para>TBD</para> <para>TBD</para>
</sect1> </sect1>
</chapter> </chapter>
<chapter id="rx-processing"> <chapter id="rx-processing">
<title>Receive processing</title> <title>Receive processing</title>
<para>TBD</para> <para>TBD</para>
</chapter> </chapter>
<chapter id="tx-processing"> <chapter id="tx-processing">
<title>Transmit processing</title> <title>Transmit processing</title>
<para>TBD</para> <para>TBD</para>
</chapter> </chapter>
<chapter id="sta-info"> <chapter id="sta-info">
<title>Station info handling</title> <title>Station info handling</title>
<sect1> <sect1>
<title>Programming information</title> <title>Programming information</title>
!Fnet/mac80211/sta_info.h sta_info !Fnet/mac80211/sta_info.h sta_info
!Fnet/mac80211/sta_info.h ieee80211_sta_info_flags !Fnet/mac80211/sta_info.h ieee80211_sta_info_flags
</sect1> </sect1>
<sect1> <sect1>
<title>STA information lifetime rules</title> <title>STA information lifetime rules</title>
!Pnet/mac80211/sta_info.c STA information lifetime rules !Pnet/mac80211/sta_info.c STA information lifetime rules
</sect1> </sect1>
</chapter> </chapter>
<chapter id="synchronisation"> <chapter id="synchronisation">
<title>Synchronisation</title> <title>Synchronisation</title>
<para>TBD</para> <para>TBD</para>
<para>Locking, lots of RCU</para> <para>Locking, lots of RCU</para>
</chapter> </chapter>
</part> </part>
</book> </book>
</set>
Documentation/DocBook/Makefile
View file @ 352de557
...@@ -12,7 +12,7 @@ DOCBOOKS := z8530book.xml mcabook.xml device-drivers.xml \ ...@@ -12,7 +12,7 @@ DOCBOOKS := z8530book.xml mcabook.xml device-drivers.xml \
kernel-api.xml filesystems.xml lsm.xml usb.xml kgdb.xml \ kernel-api.xml filesystems.xml lsm.xml usb.xml kgdb.xml \
gadget.xml libata.xml mtdnand.xml librs.xml rapidio.xml \ gadget.xml libata.xml mtdnand.xml librs.xml rapidio.xml \
genericirq.xml s390-drivers.xml uio-howto.xml scsi.xml \ genericirq.xml s390-drivers.xml uio-howto.xml scsi.xml \
mac80211.xml debugobjects.xml sh.xml regulator.xml \ 80211.xml debugobjects.xml sh.xml regulator.xml \
alsa-driver-api.xml writing-an-alsa-driver.xml \ alsa-driver-api.xml writing-an-alsa-driver.xml \
tracepoint.xml media.xml drm.xml tracepoint.xml media.xml drm.xml
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7