[PATCH 0/4] some wireless doc updates

linux-wireless.vger.kernel.org archive mirror
 help / color / mirror / Atom feed

* [PATCH 0/4] some wireless doc updates
@ 2011-01-06 21:36 Johannes Berg
  2011-01-06 21:36 ` [PATCH 1/4] mac80211: add missing docs for off-chan TX flag Johannes Berg
                   ` (3 more replies)
  0 siblings, 4 replies; 5+ messages in thread
From: Johannes Berg @ 2011-01-06 21:36 UTC (permalink / raw)
  To: John Linville; +Cc: linux-wireless

Mostly stuff missed earlier, and then LED docs.

johannes


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

* [PATCH 1/4] mac80211: add missing docs for off-chan TX flag
  2011-01-06 21:36 [PATCH 0/4] some wireless doc updates Johannes Berg
@ 2011-01-06 21:36 ` Johannes Berg
  2011-01-06 21:36 ` [PATCH 2/4] cfg80211: add mesh join/leave callback docs Johannes Berg
                   ` (2 subsequent siblings)
  3 siblings, 0 replies; 5+ messages in thread
From: Johannes Berg @ 2011-01-06 21:36 UTC (permalink / raw)
  To: John Linville; +Cc: linux-wireless, Johannes Berg

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

The flag is IEEE80211_TX_CTL_TX_OFFCHAN and I had
added that in a previous patch but forgotten docs.

Signed-off-by: Johannes Berg <johannes.berg@intel.com>
---
 include/net/mac80211.h |    4 ++++
 1 file changed, 4 insertions(+)

--- wireless-testing.orig/include/net/mac80211.h	2011-01-06 22:18:55.000000000 +0100
+++ wireless-testing/include/net/mac80211.h	2011-01-06 22:19:53.000000000 +0100
@@ -337,6 +337,10 @@ struct ieee80211_bss_conf {
  * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
  * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
  *	frame and selects the maximum number of streams that it can use.
+ * @IEEE80211_TX_CTL_TX_OFFCHAN: Marks this packet to be transmitted on
+ *	the off-channel channel when a remain-on-channel offload is done
+ *	in hardware -- normal packets still flow and are expected to be
+ *	handled properly by the device.
  *
  * Note: If you have to add new flags to the enumeration, then don't
  *	 forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.



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

* [PATCH 2/4] cfg80211: add mesh join/leave callback docs
  2011-01-06 21:36 [PATCH 0/4] some wireless doc updates Johannes Berg
  2011-01-06 21:36 ` [PATCH 1/4] mac80211: add missing docs for off-chan TX flag Johannes Berg
@ 2011-01-06 21:36 ` Johannes Berg
  2011-01-06 21:36 ` [PATCH 3/4] nl80211: add/fix mesh docs Johannes Berg
  2011-01-06 21:36 ` [PATCH 4/4] mac80211: add doc short section on LED triggers Johannes Berg
  3 siblings, 0 replies; 5+ messages in thread
From: Johannes Berg @ 2011-01-06 21:36 UTC (permalink / raw)
  To: John Linville; +Cc: linux-wireless, Johannes Berg

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

When I made the patch to add mesh join/leave I
didn't pay attention to docs because it was a
proof of concept, and then when we actually did
merge it I forgot -- add docs now.

Signed-off-by: Johannes Berg <johannes.berg@intel.com>
---
 include/net/cfg80211.h |    2 ++
 1 file changed, 2 insertions(+)

--- wireless-testing.orig/include/net/cfg80211.h	2011-01-06 22:20:06.000000000 +0100
+++ wireless-testing/include/net/cfg80211.h	2011-01-06 22:20:41.000000000 +0100
@@ -1103,6 +1103,8 @@ struct cfg80211_pmksa {
  * @change_mpath: change a given mesh path
  * @get_mpath: get a mesh path for the given parameters
  * @dump_mpath: dump mesh path callback -- resume dump at index @idx
+ * @join_mesh: join the mesh network with the specified parameters
+ * @leave_mesh: leave the current mesh network
  *
  * @get_mesh_config: Get the current mesh configuration
  *



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

* [PATCH 3/4] nl80211: add/fix mesh docs
  2011-01-06 21:36 [PATCH 0/4] some wireless doc updates Johannes Berg
  2011-01-06 21:36 ` [PATCH 1/4] mac80211: add missing docs for off-chan TX flag Johannes Berg
  2011-01-06 21:36 ` [PATCH 2/4] cfg80211: add mesh join/leave callback docs Johannes Berg
@ 2011-01-06 21:36 ` Johannes Berg
  2011-01-06 21:36 ` [PATCH 4/4] mac80211: add doc short section on LED triggers Johannes Berg
  3 siblings, 0 replies; 5+ messages in thread
From: Johannes Berg @ 2011-01-06 21:36 UTC (permalink / raw)
  To: John Linville; +Cc: linux-wireless, Johannes Berg

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

Some mesh attribute/command docs are missing or
have errors in the name so they don't match, fix
all of them.

Signed-off-by: Johannes Berg <johannes.berg@intel.com>
---
 include/linux/nl80211.h |   20 +++++++++++++++-----
 1 file changed, 15 insertions(+), 5 deletions(-)

--- wireless-testing.orig/include/linux/nl80211.h	2011-01-06 22:21:07.000000000 +0100
+++ wireless-testing/include/linux/nl80211.h	2011-01-06 22:28:07.000000000 +0100
@@ -148,6 +148,10 @@
  * @NL80211_CMD_SET_MPATH:  Set mesh path attributes for mesh path to
  * 	destination %NL80211_ATTR_MAC on the interface identified by
  * 	%NL80211_ATTR_IFINDEX.
+ * @NL80211_CMD_NEW_MPATH: Create a new mesh path for the destination given by
+ *	%NL80211_ATTR_MAC via %NL80211_ATTR_MPATH_NEXT_HOP.
+ * @NL80211_CMD_DEL_MPATH: Delete a mesh path to the destination given by
+ *	%NL80211_ATTR_MAC.
  * @NL80211_CMD_NEW_PATH: Add a mesh path with given attributes to the
  *	the interface identified by %NL80211_ATTR_IFINDEX.
  * @NL80211_CMD_DEL_PATH: Remove a mesh path identified by %NL80211_ATTR_MAC
@@ -612,7 +616,7 @@ enum nl80211_commands {
  *	consisting of a nested array.
  *
  * @NL80211_ATTR_MESH_ID: mesh id (1-32 bytes).
- * @NL80211_ATTR_PLINK_ACTION: action to perform on the mesh peer link.
+ * @NL80211_ATTR_STA_PLINK_ACTION: action to perform on the mesh peer link.
  * @NL80211_ATTR_MPATH_NEXT_HOP: MAC address of the next hop for a mesh path.
  * @NL80211_ATTR_MPATH_INFO: information about a mesh_path, part of mesh path
  * 	info given for %NL80211_CMD_GET_MPATH, nested attribute described at
@@ -879,7 +883,9 @@ enum nl80211_commands {
  *	See &enum nl80211_key_default_types.
  *
  * @NL80211_ATTR_MESH_SETUP: Optional mesh setup parameters.  These cannot be
- * changed once the mesh is active.
+ *	changed once the mesh is active.
+ * @NL80211_ATTR_MESH_CONFIG: Mesh configuration parameters, a nested attribute
+ *	containing attributes from &enum nl80211_meshconf_params.
  *
  * @NL80211_ATTR_MAX: highest attribute number currently defined
  * @__NL80211_ATTR_AFTER_LAST: internal use
@@ -1225,8 +1231,6 @@ enum nl80211_rate_info {
  * @NL80211_STA_INFO_INACTIVE_TIME: time since last activity (u32, msecs)
  * @NL80211_STA_INFO_RX_BYTES: total received bytes (u32, from this station)
  * @NL80211_STA_INFO_TX_BYTES: total transmitted bytes (u32, to this station)
- * @__NL80211_STA_INFO_AFTER_LAST: internal
- * @NL80211_STA_INFO_MAX: highest possible station info attribute
  * @NL80211_STA_INFO_SIGNAL: signal strength of last received PPDU (u8, dBm)
  * @NL80211_STA_INFO_TX_BITRATE: current unicast tx rate, nested attribute
  * 	containing info as possible, see &enum nl80211_sta_info_txrate.
@@ -1236,6 +1240,11 @@ enum nl80211_rate_info {
  * @NL80211_STA_INFO_TX_RETRIES: total retries (u32, to this station)
  * @NL80211_STA_INFO_TX_FAILED: total failed packets (u32, to this station)
  * @NL80211_STA_INFO_SIGNAL_AVG: signal strength average (u8, dBm)
+ * @NL80211_STA_INFO_LLID: the station's mesh LLID
+ * @NL80211_STA_INFO_PLID: the station's mesh PLID
+ * @NL80211_STA_INFO_PLINK_STATE: peer link state for the station
+ * @__NL80211_STA_INFO_AFTER_LAST: internal
+ * @NL80211_STA_INFO_MAX: highest possible station info attribute
  */
 enum nl80211_sta_info {
 	__NL80211_STA_INFO_INVALID,
@@ -1626,7 +1635,7 @@ enum nl80211_mntr_flags {
  * @NL80211_MESHCONF_HWMP_NET_DIAM_TRVS_TIME: The interval of time (in TUs)
  * that it takes for an HWMP information element to propagate across the mesh
  *
- * @NL80211_MESHCONF_ROOTMODE: whether root mode is enabled or not
+ * @NL80211_MESHCONF_HWMP_ROOTMODE: whether root mode is enabled or not
  *
  * @NL80211_MESHCONF_ELEMENT_TTL: specifies the value of TTL field set at a
  * source mesh point for path selection elements.
@@ -1678,6 +1687,7 @@ enum nl80211_meshconf_params {
  * element that vendors will use to identify the path selection methods and
  * metrics in use.
  *
+ * @NL80211_MESH_SETUP_ATTR_MAX: highest possible mesh setup attribute number
  * @__NL80211_MESH_SETUP_ATTR_AFTER_LAST: Internal use
  */
 enum nl80211_mesh_setup_params {



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

* [PATCH 4/4] mac80211: add doc short section on LED triggers
  2011-01-06 21:36 [PATCH 0/4] some wireless doc updates Johannes Berg
                   ` (2 preceding siblings ...)
  2011-01-06 21:36 ` [PATCH 3/4] nl80211: add/fix mesh docs Johannes Berg
@ 2011-01-06 21:36 ` Johannes Berg
  3 siblings, 0 replies; 5+ messages in thread
From: Johannes Berg @ 2011-01-06 21:36 UTC (permalink / raw)
  To: John Linville; +Cc: linux-wireless, Johannes Berg

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

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 <johannes.berg@intel.com>
---
 Documentation/DocBook/80211.tmpl |   21 +++++++++++++++++----
 1 file changed, 17 insertions(+), 4 deletions(-)

--- wireless-testing.orig/Documentation/DocBook/80211.tmpl	2011-01-06 22:30:55.000000000 +0100
+++ wireless-testing/Documentation/DocBook/80211.tmpl	2011-01-06 22:33:25.000000000 +0100
@@ -285,10 +285,6 @@ MISSING
 !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
       </chapter>
@@ -399,6 +395,23 @@ MISSING
         </para>
       </partintro>
 
+      <chapter id="led-support">
+        <title>LED support</title>
+        <para>
+         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.
+        </para>
+!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
+      </chapter>
+
       <chapter id="hardware-crypto-offload">
         <title>Hardware crypto acceleration</title>
 !Pinclude/net/mac80211.h Hardware crypto acceleration



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

end of thread, other threads:[~2011-01-06 21:38 UTC | newest]

Thread overview: 5+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2011-01-06 21:36 [PATCH 0/4] some wireless doc updates Johannes Berg
2011-01-06 21:36 ` [PATCH 1/4] mac80211: add missing docs for off-chan TX flag Johannes Berg
2011-01-06 21:36 ` [PATCH 2/4] cfg80211: add mesh join/leave callback docs Johannes Berg
2011-01-06 21:36 ` [PATCH 3/4] nl80211: add/fix mesh docs Johannes Berg
2011-01-06 21:36 ` [PATCH 4/4] mac80211: add doc short section on LED triggers Johannes Berg

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).