From 2e54a7a20cf7c02ee17c56488fedb8cd3d2c2f35 Mon Sep 17 00:00:00 2001 From: Johannes Berg Date: Wed, 1 Dec 2010 09:43:27 +0100 Subject: cfg80211: include CQM packet loss docs Just include them in the list of functions, there aren't any more detailed docs (yet). Signed-off-by: Johannes Berg Signed-off-by: John W. Linville --- Documentation/DocBook/80211.tmpl | 1 + 1 file changed, 1 insertion(+) (limited to 'Documentation/DocBook/80211.tmpl') diff --git a/Documentation/DocBook/80211.tmpl b/Documentation/DocBook/80211.tmpl index 19a1210c2530..20db115cadcf 100644 --- a/Documentation/DocBook/80211.tmpl +++ b/Documentation/DocBook/80211.tmpl @@ -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 -- cgit v1.2.3 From d7ae30f073a179a9cebd663e7502843ddf4ba672 Mon Sep 17 00:00:00 2001 From: Johannes Berg Date: Wed, 1 Dec 2010 09:43:28 +0100 Subject: mac80211: document workqueue Create a new chapter for the mac80211 workqueue that contains the documentation written for it. Signed-off-by: Johannes Berg Signed-off-by: John W. Linville --- Documentation/DocBook/80211.tmpl | 7 +++++++ 1 file changed, 7 insertions(+) (limited to 'Documentation/DocBook/80211.tmpl') diff --git a/Documentation/DocBook/80211.tmpl b/Documentation/DocBook/80211.tmpl index 20db115cadcf..c3c211eebd2f 100644 --- a/Documentation/DocBook/80211.tmpl +++ b/Documentation/DocBook/80211.tmpl @@ -355,6 +355,13 @@ !Pinclude/net/mac80211.h Frame filtering !Finclude/net/mac80211.h ieee80211_filter_flags + + + The mac80211 workqueue +!Pinclude/net/mac80211.h mac80211 workqueue +!Finclude/net/mac80211.h ieee80211_queue_work +!Finclude/net/mac80211.h ieee80211_queue_delayed_work + -- cgit v1.2.3 From 7bcfda13fea4a8770deaf4b22093dc2708760128 Mon Sep 17 00:00:00 2001 From: Johannes Berg Date: Wed, 1 Dec 2010 09:43:29 +0100 Subject: mac80211: publish docs for _ni functions Put them along with their "regular" versions for now, we should write more docs in the future. Signed-off-by: Johannes Berg Signed-off-by: John W. Linville --- Documentation/DocBook/80211.tmpl | 2 ++ 1 file changed, 2 insertions(+) (limited to 'Documentation/DocBook/80211.tmpl') diff --git a/Documentation/DocBook/80211.tmpl b/Documentation/DocBook/80211.tmpl index c3c211eebd2f..a346c0fc45bc 100644 --- a/Documentation/DocBook/80211.tmpl +++ b/Documentation/DocBook/80211.tmpl @@ -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 -- cgit v1.2.3 From 625208138550562fd3bc731f53f43cb66a3be70a Mon Sep 17 00:00:00 2001 From: Johannes Berg Date: Wed, 1 Dec 2010 09:43:30 +0100 Subject: mac80211: publish some misc docs There isn't a clear TX documentation yet, so put these into the misc section for now. Signed-off-by: Johannes Berg Signed-off-by: John W. Linville --- Documentation/DocBook/80211.tmpl | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'Documentation/DocBook/80211.tmpl') diff --git a/Documentation/DocBook/80211.tmpl b/Documentation/DocBook/80211.tmpl index a346c0fc45bc..7b30331bc444 100644 --- a/Documentation/DocBook/80211.tmpl +++ b/Documentation/DocBook/80211.tmpl @@ -333,7 +333,11 @@ functions/definitions !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 @@ -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 -- cgit v1.2.3 From cf6cb7ab59e0b37afe6e76b2e444479bf86bf933 Mon Sep 17 00:00:00 2001 From: Johannes Berg Date: Wed, 1 Dec 2010 09:43:31 +0100 Subject: mac80211: publish some rate control docs 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 Signed-off-by: John W. Linville --- Documentation/DocBook/80211.tmpl | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) (limited to 'Documentation/DocBook/80211.tmpl') diff --git a/Documentation/DocBook/80211.tmpl b/Documentation/DocBook/80211.tmpl index 7b30331bc444..a9384e871882 100644 --- a/Documentation/DocBook/80211.tmpl +++ b/Documentation/DocBook/80211.tmpl @@ -453,9 +453,16 @@ interface and how it relates to mac80211 and drivers. - - dummy chapter + + Rate Control API TBD +!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 -- cgit v1.2.3 From e16c01030b8794992590ff9b1b1e4b1b89e0cad3 Mon Sep 17 00:00:00 2001 From: Johannes Berg Date: Wed, 1 Dec 2010 09:43:32 +0100 Subject: mac80211: document aggregation Include the aggregation documentation in the docbook, split up by public and internal docs. Signed-off-by: Johannes Berg Signed-off-by: John W. Linville --- Documentation/DocBook/80211.tmpl | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) (limited to 'Documentation/DocBook/80211.tmpl') diff --git a/Documentation/DocBook/80211.tmpl b/Documentation/DocBook/80211.tmpl index a9384e871882..3d230cf57cff 100644 --- a/Documentation/DocBook/80211.tmpl +++ b/Documentation/DocBook/80211.tmpl @@ -442,6 +442,21 @@ TBD !Finclude/net/mac80211.h ieee80211_scan_completed + + + Aggregation + + TX A-MPDU aggregation +!Pnet/mac80211/agg-tx.c TX A-MPDU aggregation +!Cnet/mac80211/agg-tx.c + + + RX A-MPDU aggregation +!Pnet/mac80211/agg-rx.c RX A-MPDU aggregation +!Cnet/mac80211/agg-rx.c + +!Finclude/net/mac80211.h ieee80211_ampdu_mlme_action + @@ -510,6 +525,13 @@ + + Aggregation +!Fnet/mac80211/sta_info.h sta_ampdu_mlme +!Fnet/mac80211/sta_info.h tid_ampdu_tx +!Fnet/mac80211/sta_info.h tid_ampdu_rx + + Synchronisation TBD -- cgit v1.2.3 From eebbb348df5a8c239a6300188907dec7e427bf70 Mon Sep 17 00:00:00 2001 From: Johannes Berg Date: Wed, 1 Dec 2010 09:43:33 +0100 Subject: mac80211: publish interface iteration docs Publish the documentation for the interface iteration functions in the right section of the book. Signed-off-by: Johannes Berg Signed-off-by: John W. Linville --- Documentation/DocBook/80211.tmpl | 2 ++ 1 file changed, 2 insertions(+) (limited to 'Documentation/DocBook/80211.tmpl') diff --git a/Documentation/DocBook/80211.tmpl b/Documentation/DocBook/80211.tmpl index 3d230cf57cff..50e75f370bd6 100644 --- a/Documentation/DocBook/80211.tmpl +++ b/Documentation/DocBook/80211.tmpl @@ -435,6 +435,8 @@ supported by mac80211, add notes about supporting hw crypto with it. +!Finclude/net/mac80211.h ieee80211_iterate_active_interfaces +!Finclude/net/mac80211.h ieee80211_iterate_active_interfaces_atomic -- cgit v1.2.3 From f6b8bef3634a5c9ea326b3ab0c9615fdac5f18ab Mon Sep 17 00:00:00 2001 From: Johannes Berg Date: Wed, 1 Dec 2010 09:43:34 +0100 Subject: mac80211: document station handling Add some existing documentation about station handling to a new chapter about advanced APIs. Signed-off-by: Johannes Berg Signed-off-by: John W. Linville --- Documentation/DocBook/80211.tmpl | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'Documentation/DocBook/80211.tmpl') diff --git a/Documentation/DocBook/80211.tmpl b/Documentation/DocBook/80211.tmpl index 50e75f370bd6..601ea785fc91 100644 --- a/Documentation/DocBook/80211.tmpl +++ b/Documentation/DocBook/80211.tmpl @@ -439,6 +439,16 @@ !Finclude/net/mac80211.h ieee80211_iterate_active_interfaces_atomic + + Station handling + TODO +!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 + + Hardware scan offload TBD -- cgit v1.2.3 From c1927d7a8fab07171d08f7a3a8b7e5fe87bb70d4 Mon Sep 17 00:00:00 2001 From: Johannes Berg Date: Wed, 1 Dec 2010 09:43:35 +0100 Subject: mac80211: publish SMPS docs 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 Signed-off-by: John W. Linville --- Documentation/DocBook/80211.tmpl | 7 +++++++ 1 file changed, 7 insertions(+) (limited to 'Documentation/DocBook/80211.tmpl') diff --git a/Documentation/DocBook/80211.tmpl b/Documentation/DocBook/80211.tmpl index 601ea785fc91..03641a08e275 100644 --- a/Documentation/DocBook/80211.tmpl +++ b/Documentation/DocBook/80211.tmpl @@ -469,6 +469,13 @@ !Finclude/net/mac80211.h ieee80211_ampdu_mlme_action + + + Spatial Multiplexing Powersave (SMPS) +!Pinclude/net/mac80211.h Spatial multiplexing power save +!Finclude/net/mac80211.h ieee80211_request_smps +!Finclude/net/mac80211.h ieee80211_smps_mode + -- cgit v1.2.3 From 016134eee334d51262f10ce3261976ea40a57878 Mon Sep 17 00:00:00 2001 From: Johannes Berg Date: Thu, 6 Jan 2011 22:36:47 +0100 Subject: mac80211: add doc short section on LED triggers Just create a section to collect the LED trigger functions and add a very short description as to what drivers should do. Signed-off-by: Johannes Berg Signed-off-by: John W. Linville --- Documentation/DocBook/80211.tmpl | 21 +++++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-) (limited to 'Documentation/DocBook/80211.tmpl') diff --git a/Documentation/DocBook/80211.tmpl b/Documentation/DocBook/80211.tmpl index 03641a08e275..8906648f962b 100644 --- a/Documentation/DocBook/80211.tmpl +++ b/Documentation/DocBook/80211.tmpl @@ -268,10 +268,6 @@ !Finclude/net/mac80211.h ieee80211_ops !Finclude/net/mac80211.h ieee80211_alloc_hw !Finclude/net/mac80211.h ieee80211_register_hw -!Finclude/net/mac80211.h ieee80211_get_tx_led_name -!Finclude/net/mac80211.h ieee80211_get_rx_led_name -!Finclude/net/mac80211.h ieee80211_get_assoc_led_name -!Finclude/net/mac80211.h ieee80211_get_radio_led_name !Finclude/net/mac80211.h ieee80211_unregister_hw !Finclude/net/mac80211.h ieee80211_free_hw @@ -382,6 +378,23 @@ + + LED support + + Mac80211 supports various ways of blinking LEDs. Wherever possible, + device LEDs should be exposed as LED class devices and hooked up to + the appropriate trigger, which will then be triggered appropriately + by mac80211. + +!Finclude/net/mac80211.h ieee80211_get_tx_led_name +!Finclude/net/mac80211.h ieee80211_get_rx_led_name +!Finclude/net/mac80211.h ieee80211_get_assoc_led_name +!Finclude/net/mac80211.h ieee80211_get_radio_led_name +!Finclude/net/mac80211.h ieee80211_tpt_blink +!Finclude/net/mac80211.h ieee80211_tpt_led_trigger_flags +!Finclude/net/mac80211.h ieee80211_create_tpt_led_trigger + + Hardware crypto acceleration !Pinclude/net/mac80211.h Hardware crypto acceleration -- cgit v1.2.3