Skip to contentSkip to conversation

publish some docs

PATCH New Johannes Berg 1 participant 10 messages Dec 1, 2010 Documentation

lore
Share & tools
lore
#0 lore raw

cover publish some docs

We have more docs than our docbook contains,
so publish some of them :-)

johannes

#1 lore raw

PATCH 1/9 cfg80211: include CQM packet loss docs

From: Johannes Berg <[email protected]>

Just include them in the list of functions,
there aren't any more detailed docs (yet).

---
 Documentation/DocBook/80211.tmpl |    1 +
 1 file changed, 1 insertion(+)
Documentation/DocBook/80211.tmpl +1 -0
@@ -146,6 +146,7 @@
 !Finclude/net/cfg80211.h cfg80211_rx_mgmt
 !Finclude/net/cfg80211.h cfg80211_mgmt_tx_status
 !Finclude/net/cfg80211.h cfg80211_cqm_rssi_notify
+!Finclude/net/cfg80211.h cfg80211_cqm_pktloss_notify
 !Finclude/net/cfg80211.h cfg80211_michael_mic_failure
       </chapter>
       <chapter>
#2 lore raw

PATCH 2/9 mac80211: document workqueue

In reply to Johannes Berg

From: Johannes Berg <[email protected]>

Create a new chapter for the mac80211 workqueue
that contains the documentation written for it.

---
 Documentation/DocBook/80211.tmpl |    7 +++++++
 1 file changed, 7 insertions(+)
Documentation/DocBook/80211.tmpl +7 -0
@@ -355,6 +355,13 @@
 !Pinclude/net/mac80211.h Frame filtering
 !Finclude/net/mac80211.h ieee80211_filter_flags
       </chapter>
+
+      <chapter id="workqueue">
+        <title>The mac80211 workqueue</title>
+!Pinclude/net/mac80211.h mac80211 workqueue
+!Finclude/net/mac80211.h ieee80211_queue_work
+!Finclude/net/mac80211.h ieee80211_queue_delayed_work
+      </chapter>
     </part>
 
     <part id="advanced">
#3 lore raw

PATCH 3/9 mac80211: publish docs for _ni functions

In reply to Johannes Berg

From: Johannes Berg <[email protected]>

Put them along with their "regular" versions for
now, we should write more docs in the future.

---
 Documentation/DocBook/80211.tmpl |    2 ++
 1 file changed, 2 insertions(+)
Documentation/DocBook/80211.tmpl +2 -0
@@ -335,8 +335,10 @@
 !Finclude/net/mac80211.h mac80211_rx_flags
 !Finclude/net/mac80211.h ieee80211_tx_info
 !Finclude/net/mac80211.h ieee80211_rx
+!Finclude/net/mac80211.h ieee80211_rx_ni
 !Finclude/net/mac80211.h ieee80211_rx_irqsafe
 !Finclude/net/mac80211.h ieee80211_tx_status
+!Finclude/net/mac80211.h ieee80211_tx_status_ni
 !Finclude/net/mac80211.h ieee80211_tx_status_irqsafe
 !Finclude/net/mac80211.h ieee80211_rts_get
 !Finclude/net/mac80211.h ieee80211_rts_duration
#4 lore raw

PATCH 4/9 mac80211: publish some misc docs

In reply to Johannes Berg

From: Johannes Berg <[email protected]>

There isn't a clear TX documentation yet, so
put these into the misc section for now.

---
 Documentation/DocBook/80211.tmpl |    8 ++++++++
 1 file changed, 8 insertions(+)
Documentation/DocBook/80211.tmpl +8 -0
@@ -333,7 +333,11 @@
           <title>functions/definitions</title>
 !Finclude/net/mac80211.h ieee80211_rx_status
 !Finclude/net/mac80211.h mac80211_rx_flags
+!Finclude/net/mac80211.h mac80211_tx_control_flags
+!Finclude/net/mac80211.h mac80211_rate_control_flags
+!Finclude/net/mac80211.h ieee80211_tx_rate
 !Finclude/net/mac80211.h ieee80211_tx_info
+!Finclude/net/mac80211.h ieee80211_tx_info_clear_status
 !Finclude/net/mac80211.h ieee80211_rx
 !Finclude/net/mac80211.h ieee80211_rx_ni
 !Finclude/net/mac80211.h ieee80211_rx_irqsafe
@@ -349,6 +353,7 @@
 !Finclude/net/mac80211.h ieee80211_stop_queue
 !Finclude/net/mac80211.h ieee80211_wake_queues
 !Finclude/net/mac80211.h ieee80211_stop_queues
+!Finclude/net/mac80211.h ieee80211_queue_stopped
         </sect1>
       </chapter>
 
@@ -384,6 +389,9 @@
 !Finclude/net/mac80211.h set_key_cmd
 !Finclude/net/mac80211.h ieee80211_key_conf
 !Finclude/net/mac80211.h ieee80211_key_flags
+!Finclude/net/mac80211.h ieee80211_tkip_key_type
+!Finclude/net/mac80211.h ieee80211_get_tkip_key
+!Finclude/net/mac80211.h ieee80211_key_removed
       </chapter>
 
       <chapter id="powersave">
#5 lore raw

PATCH 5/9 mac80211: publish some rate control docs

In reply to Johannes Berg

From: Johannes Berg <[email protected]>

Add an API chapter to the rate control part of
the mac80211 book and populate it with some
existing documentation.

---
 Documentation/DocBook/80211.tmpl |   11 +++++++++--
 1 file changed, 9 insertions(+), 2 deletions(-)
Documentation/DocBook/80211.tmpl +9 -2
@@ -453,9 +453,16 @@
          interface and how it relates to mac80211 and drivers.
         </para>
       </partintro>
-      <chapter id="dummy">
-        <title>dummy chapter</title>
+      <chapter id="ratecontrol-api">
+        <title>Rate Control API</title>
         <para>TBD</para>
+!Finclude/net/mac80211.h ieee80211_start_tx_ba_session
+!Finclude/net/mac80211.h ieee80211_start_tx_ba_cb_irqsafe
+!Finclude/net/mac80211.h ieee80211_stop_tx_ba_session
+!Finclude/net/mac80211.h ieee80211_stop_tx_ba_cb_irqsafe
+!Finclude/net/mac80211.h rate_control_changed
+!Finclude/net/mac80211.h ieee80211_tx_rate_control
+!Finclude/net/mac80211.h rate_control_send_low
       </chapter>
     </part>
 
#6 lore raw

PATCH 6/9 mac80211: document aggregation

In reply to Johannes Berg

From: Johannes Berg <[email protected]>

Include the aggregation documentation in the
docbook, split up by public and internal docs.

---
 Documentation/DocBook/80211.tmpl |   22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)
Documentation/DocBook/80211.tmpl +22 -0
@@ -442,6 +442,21 @@
         <para>TBD</para>
 !Finclude/net/mac80211.h ieee80211_scan_completed
       </chapter>
+
+      <chapter id="aggregation">
+        <title>Aggregation</title>
+        <sect1>
+          <title>TX A-MPDU aggregation</title>
+!Pnet/mac80211/agg-tx.c TX A-MPDU aggregation
+!Cnet/mac80211/agg-tx.c
+        </sect1>
+        <sect1>
+          <title>RX A-MPDU aggregation</title>
+!Pnet/mac80211/agg-rx.c RX A-MPDU aggregation
+!Cnet/mac80211/agg-rx.c
+        </sect1>
+!Finclude/net/mac80211.h ieee80211_ampdu_mlme_action
+      </chapter>
     </part>
 
     <part id="rate-control">
@@ -510,6 +525,13 @@
         </sect1>
       </chapter>
 
+      <chapter id="aggregation-internals">
+        <title>Aggregation</title>
+!Fnet/mac80211/sta_info.h sta_ampdu_mlme
+!Fnet/mac80211/sta_info.h tid_ampdu_tx
+!Fnet/mac80211/sta_info.h tid_ampdu_rx
+      </chapter>
+
       <chapter id="synchronisation">
         <title>Synchronisation</title>
         <para>TBD</para>
#7 lore raw

PATCH 7/9 mac80211: publish interface iteration docs

In reply to Johannes Berg

From: Johannes Berg <[email protected]>

Publish the documentation for the interface
iteration functions in the right section of
the book.

---
 Documentation/DocBook/80211.tmpl |    2 ++
 1 file changed, 2 insertions(+)
Documentation/DocBook/80211.tmpl +2 -0
@@ -435,6 +435,8 @@
           supported by mac80211, add notes about supporting hw crypto
           with it.
         </para>
+!Finclude/net/mac80211.h ieee80211_iterate_active_interfaces
+!Finclude/net/mac80211.h ieee80211_iterate_active_interfaces_atomic
       </chapter>
 
       <chapter id="hardware-scan-offload">
#8 lore raw

PATCH 8/9 mac80211: document station handling

In reply to Johannes Berg

From: Johannes Berg <[email protected]>

Add some existing documentation about station
handling to a new chapter about advanced APIs.

---
 Documentation/DocBook/80211.tmpl |   10 ++++++++++
 1 file changed, 10 insertions(+)
Documentation/DocBook/80211.tmpl +10 -0
@@ -439,6 +439,16 @@
 !Finclude/net/mac80211.h ieee80211_iterate_active_interfaces_atomic
       </chapter>
 
+      <chapter id="station-handling">
+        <title>Station handling</title>
+        <para>TODO</para>
+!Finclude/net/mac80211.h ieee80211_sta
+!Finclude/net/mac80211.h sta_notify_cmd
+!Finclude/net/mac80211.h ieee80211_find_sta
+!Finclude/net/mac80211.h ieee80211_find_sta_by_ifaddr
+!Finclude/net/mac80211.h ieee80211_sta_block_awake
+      </chapter>
+
       <chapter id="hardware-scan-offload">
         <title>Hardware scan offload</title>
         <para>TBD</para>
#9 lore raw

PATCH 9/9 mac80211: publish SMPS docs

In reply to Johannes Berg

From: Johannes Berg <[email protected]>

Create a new chapter about SMPS in the
driver API part of the mac80211 book and
populate it with the existing docs.

---
 Documentation/DocBook/80211.tmpl |    7 +++++++
 1 file changed, 7 insertions(+)
Documentation/DocBook/80211.tmpl +7 -0
@@ -469,6 +469,13 @@
         </sect1>
 !Finclude/net/mac80211.h ieee80211_ampdu_mlme_action
       </chapter>
+
+      <chapter id="smps">
+        <title>Spatial Multiplexing Powersave (SMPS)</title>
+!Pinclude/net/mac80211.h Spatial multiplexing power save
+!Finclude/net/mac80211.h ieee80211_request_smps
+!Finclude/net/mac80211.h ieee80211_smps_mode
+      </chapter>
     </part>
 
     <part id="rate-control">