All of lore.kernel.org
 help / color / mirror / Atom feed
* [PATCH 0/9] publish some docs
@ 2010-12-01  8:43 Johannes Berg
  2010-12-01  8:43 ` [PATCH 1/9] cfg80211: include CQM packet loss docs Johannes Berg
                   ` (8 more replies)
  0 siblings, 9 replies; 10+ messages in thread
From: Johannes Berg @ 2010-12-01  8:43 UTC (permalink / raw)
  To: John Linville; +Cc: linux-wireless

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

johannes


^ permalink raw reply	[flat|nested] 10+ messages in thread

* [PATCH 1/9] cfg80211: include CQM packet loss docs
  2010-12-01  8:43 [PATCH 0/9] publish some docs Johannes Berg
@ 2010-12-01  8:43 ` Johannes Berg
  2010-12-01  8:43 ` [PATCH 2/9] mac80211: document workqueue Johannes Berg
                   ` (7 subsequent siblings)
  8 siblings, 0 replies; 10+ messages in thread
From: Johannes Berg @ 2010-12-01  8:43 UTC (permalink / raw)
  To: John Linville; +Cc: linux-wireless

From: Johannes Berg <johannes.berg@intel.com>

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

Signed-off-by: Johannes Berg <johannes.berg@intel.com>
---
 Documentation/DocBook/80211.tmpl |    1 +
 1 file changed, 1 insertion(+)

--- wireless-testing.orig/Documentation/DocBook/80211.tmpl	2010-12-01 09:43:14.000000000 +0100
+++ wireless-testing/Documentation/DocBook/80211.tmpl	2010-12-01 09:43:16.000000000 +0100
@@ -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>



^ permalink raw reply	[flat|nested] 10+ messages in thread

* [PATCH 2/9] mac80211: document workqueue
  2010-12-01  8:43 [PATCH 0/9] publish some docs Johannes Berg
  2010-12-01  8:43 ` [PATCH 1/9] cfg80211: include CQM packet loss docs Johannes Berg
@ 2010-12-01  8:43 ` Johannes Berg
  2010-12-01  8:43 ` [PATCH 3/9] mac80211: publish docs for _ni functions Johannes Berg
                   ` (6 subsequent siblings)
  8 siblings, 0 replies; 10+ messages in thread
From: Johannes Berg @ 2010-12-01  8:43 UTC (permalink / raw)
  To: John Linville; +Cc: linux-wireless

From: Johannes Berg <johannes.berg@intel.com>

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

Signed-off-by: Johannes Berg <johannes.berg@intel.com>
---
 Documentation/DocBook/80211.tmpl |    7 +++++++
 1 file changed, 7 insertions(+)

--- wireless-testing.orig/Documentation/DocBook/80211.tmpl	2010-12-01 09:43:16.000000000 +0100
+++ wireless-testing/Documentation/DocBook/80211.tmpl	2010-12-01 09:43:17.000000000 +0100
@@ -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">



^ permalink raw reply	[flat|nested] 10+ messages in thread

* [PATCH 3/9] mac80211: publish docs for _ni functions
  2010-12-01  8:43 [PATCH 0/9] publish some docs Johannes Berg
  2010-12-01  8:43 ` [PATCH 1/9] cfg80211: include CQM packet loss docs Johannes Berg
  2010-12-01  8:43 ` [PATCH 2/9] mac80211: document workqueue Johannes Berg
@ 2010-12-01  8:43 ` Johannes Berg
  2010-12-01  8:43 ` [PATCH 4/9] mac80211: publish some misc docs Johannes Berg
                   ` (5 subsequent siblings)
  8 siblings, 0 replies; 10+ messages in thread
From: Johannes Berg @ 2010-12-01  8:43 UTC (permalink / raw)
  To: John Linville; +Cc: linux-wireless

From: Johannes Berg <johannes.berg@intel.com>

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

Signed-off-by: Johannes Berg <johannes.berg@intel.com>
---
 Documentation/DocBook/80211.tmpl |    2 ++
 1 file changed, 2 insertions(+)

--- wireless-testing.orig/Documentation/DocBook/80211.tmpl	2010-12-01 09:43:17.000000000 +0100
+++ wireless-testing/Documentation/DocBook/80211.tmpl	2010-12-01 09:43:17.000000000 +0100
@@ -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



^ permalink raw reply	[flat|nested] 10+ messages in thread

* [PATCH 4/9] mac80211: publish some misc docs
  2010-12-01  8:43 [PATCH 0/9] publish some docs Johannes Berg
                   ` (2 preceding siblings ...)
  2010-12-01  8:43 ` [PATCH 3/9] mac80211: publish docs for _ni functions Johannes Berg
@ 2010-12-01  8:43 ` Johannes Berg
  2010-12-01  8:43 ` [PATCH 5/9] mac80211: publish some rate control docs Johannes Berg
                   ` (4 subsequent siblings)
  8 siblings, 0 replies; 10+ messages in thread
From: Johannes Berg @ 2010-12-01  8:43 UTC (permalink / raw)
  To: John Linville; +Cc: linux-wireless

From: Johannes Berg <johannes.berg@intel.com>

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

Signed-off-by: Johannes Berg <johannes.berg@intel.com>
---
 Documentation/DocBook/80211.tmpl |    8 ++++++++
 1 file changed, 8 insertions(+)

--- wireless-testing.orig/Documentation/DocBook/80211.tmpl	2010-12-01 09:43:17.000000000 +0100
+++ wireless-testing/Documentation/DocBook/80211.tmpl	2010-12-01 09:43:18.000000000 +0100
@@ -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">



^ permalink raw reply	[flat|nested] 10+ messages in thread

* [PATCH 5/9] mac80211: publish some rate control docs
  2010-12-01  8:43 [PATCH 0/9] publish some docs Johannes Berg
                   ` (3 preceding siblings ...)
  2010-12-01  8:43 ` [PATCH 4/9] mac80211: publish some misc docs Johannes Berg
@ 2010-12-01  8:43 ` Johannes Berg
  2010-12-01  8:43 ` [PATCH 6/9] mac80211: document aggregation Johannes Berg
                   ` (3 subsequent siblings)
  8 siblings, 0 replies; 10+ messages in thread
From: Johannes Berg @ 2010-12-01  8:43 UTC (permalink / raw)
  To: John Linville; +Cc: linux-wireless

From: Johannes Berg <johannes.berg@intel.com>

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

Signed-off-by: Johannes Berg <johannes.berg@intel.com>
---
 Documentation/DocBook/80211.tmpl |   11 +++++++++--
 1 file changed, 9 insertions(+), 2 deletions(-)

--- wireless-testing.orig/Documentation/DocBook/80211.tmpl	2010-12-01 09:43:18.000000000 +0100
+++ wireless-testing/Documentation/DocBook/80211.tmpl	2010-12-01 09:43:18.000000000 +0100
@@ -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>
 



^ permalink raw reply	[flat|nested] 10+ messages in thread

* [PATCH 6/9] mac80211: document aggregation
  2010-12-01  8:43 [PATCH 0/9] publish some docs Johannes Berg
                   ` (4 preceding siblings ...)
  2010-12-01  8:43 ` [PATCH 5/9] mac80211: publish some rate control docs Johannes Berg
@ 2010-12-01  8:43 ` Johannes Berg
  2010-12-01  8:43 ` [PATCH 7/9] mac80211: publish interface iteration docs Johannes Berg
                   ` (2 subsequent siblings)
  8 siblings, 0 replies; 10+ messages in thread
From: Johannes Berg @ 2010-12-01  8:43 UTC (permalink / raw)
  To: John Linville; +Cc: linux-wireless

From: Johannes Berg <johannes.berg@intel.com>

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

Signed-off-by: Johannes Berg <johannes.berg@intel.com>
---
 Documentation/DocBook/80211.tmpl |   22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

--- wireless-testing.orig/Documentation/DocBook/80211.tmpl	2010-12-01 09:43:18.000000000 +0100
+++ wireless-testing/Documentation/DocBook/80211.tmpl	2010-12-01 09:43:19.000000000 +0100
@@ -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>



^ permalink raw reply	[flat|nested] 10+ messages in thread

* [PATCH 7/9] mac80211: publish interface iteration docs
  2010-12-01  8:43 [PATCH 0/9] publish some docs Johannes Berg
                   ` (5 preceding siblings ...)
  2010-12-01  8:43 ` [PATCH 6/9] mac80211: document aggregation Johannes Berg
@ 2010-12-01  8:43 ` Johannes Berg
  2010-12-01  8:43 ` [PATCH 8/9] mac80211: document station handling Johannes Berg
  2010-12-01  8:43 ` [PATCH 9/9] mac80211: publish SMPS docs Johannes Berg
  8 siblings, 0 replies; 10+ messages in thread
From: Johannes Berg @ 2010-12-01  8:43 UTC (permalink / raw)
  To: John Linville; +Cc: linux-wireless

From: Johannes Berg <johannes.berg@intel.com>

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

Signed-off-by: Johannes Berg <johannes.berg@intel.com>
---
 Documentation/DocBook/80211.tmpl |    2 ++
 1 file changed, 2 insertions(+)

--- wireless-testing.orig/Documentation/DocBook/80211.tmpl	2010-12-01 09:43:19.000000000 +0100
+++ wireless-testing/Documentation/DocBook/80211.tmpl	2010-12-01 09:43:19.000000000 +0100
@@ -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">



^ permalink raw reply	[flat|nested] 10+ messages in thread

* [PATCH 8/9] mac80211: document station handling
  2010-12-01  8:43 [PATCH 0/9] publish some docs Johannes Berg
                   ` (6 preceding siblings ...)
  2010-12-01  8:43 ` [PATCH 7/9] mac80211: publish interface iteration docs Johannes Berg
@ 2010-12-01  8:43 ` Johannes Berg
  2010-12-01  8:43 ` [PATCH 9/9] mac80211: publish SMPS docs Johannes Berg
  8 siblings, 0 replies; 10+ messages in thread
From: Johannes Berg @ 2010-12-01  8:43 UTC (permalink / raw)
  To: John Linville; +Cc: linux-wireless

From: Johannes Berg <johannes.berg@intel.com>

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

Signed-off-by: Johannes Berg <johannes.berg@intel.com>
---
 Documentation/DocBook/80211.tmpl |   10 ++++++++++
 1 file changed, 10 insertions(+)

--- wireless-testing.orig/Documentation/DocBook/80211.tmpl	2010-12-01 09:43:19.000000000 +0100
+++ wireless-testing/Documentation/DocBook/80211.tmpl	2010-12-01 09:43:20.000000000 +0100
@@ -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>



^ permalink raw reply	[flat|nested] 10+ messages in thread

* [PATCH 9/9] mac80211: publish SMPS docs
  2010-12-01  8:43 [PATCH 0/9] publish some docs Johannes Berg
                   ` (7 preceding siblings ...)
  2010-12-01  8:43 ` [PATCH 8/9] mac80211: document station handling Johannes Berg
@ 2010-12-01  8:43 ` Johannes Berg
  8 siblings, 0 replies; 10+ messages in thread
From: Johannes Berg @ 2010-12-01  8:43 UTC (permalink / raw)
  To: John Linville; +Cc: linux-wireless

From: Johannes Berg <johannes.berg@intel.com>

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

Signed-off-by: Johannes Berg <johannes.berg@intel.com>
---
 Documentation/DocBook/80211.tmpl |    7 +++++++
 1 file changed, 7 insertions(+)

--- wireless-testing.orig/Documentation/DocBook/80211.tmpl	2010-12-01 09:43:20.000000000 +0100
+++ wireless-testing/Documentation/DocBook/80211.tmpl	2010-12-01 09:43:21.000000000 +0100
@@ -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">



^ permalink raw reply	[flat|nested] 10+ messages in thread

end of thread, other threads:[~2010-12-01  8:44 UTC | newest]

Thread overview: 10+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2010-12-01  8:43 [PATCH 0/9] publish some docs Johannes Berg
2010-12-01  8:43 ` [PATCH 1/9] cfg80211: include CQM packet loss docs Johannes Berg
2010-12-01  8:43 ` [PATCH 2/9] mac80211: document workqueue Johannes Berg
2010-12-01  8:43 ` [PATCH 3/9] mac80211: publish docs for _ni functions Johannes Berg
2010-12-01  8:43 ` [PATCH 4/9] mac80211: publish some misc docs Johannes Berg
2010-12-01  8:43 ` [PATCH 5/9] mac80211: publish some rate control docs Johannes Berg
2010-12-01  8:43 ` [PATCH 6/9] mac80211: document aggregation Johannes Berg
2010-12-01  8:43 ` [PATCH 7/9] mac80211: publish interface iteration docs Johannes Berg
2010-12-01  8:43 ` [PATCH 8/9] mac80211: document station handling Johannes Berg
2010-12-01  8:43 ` [PATCH 9/9] mac80211: publish SMPS docs Johannes Berg

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.