nl80211: add/fix mesh docs

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> Signed-off-by: John W. Linville <linville@tuxdriver.com>

nl80211: add/fix mesh docs
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> Signed-off-by: John W. Linville <linville@tuxdriver.com>
Johannes Berg · John W. Linville
1 parent f52555a4b2
Showing 1 changed file with 15 additions and 5 deletions Side-by-side Diff
include/linux/nl80211.h
@@ -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 @@
  *	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 @@
  *	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 @@
  * @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 @@
  * @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 @@
  * @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 @@
  * 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 {
...	...	@@ -148,6 +148,10 @@
148	148	* @NL80211_CMD_SET_MPATH: Set mesh path attributes for mesh path to
149	149	* destination %NL80211_ATTR_MAC on the interface identified by
150	150	* %NL80211_ATTR_IFINDEX.
	151	+ * @NL80211_CMD_NEW_MPATH: Create a new mesh path for the destination given by
	152	+ * %NL80211_ATTR_MAC via %NL80211_ATTR_MPATH_NEXT_HOP.
	153	+ * @NL80211_CMD_DEL_MPATH: Delete a mesh path to the destination given by
	154	+ * %NL80211_ATTR_MAC.
151	155	* @NL80211_CMD_NEW_PATH: Add a mesh path with given attributes to the
152	156	* the interface identified by %NL80211_ATTR_IFINDEX.
153	157	* @NL80211_CMD_DEL_PATH: Remove a mesh path identified by %NL80211_ATTR_MAC
...	...	@@ -612,7 +616,7 @@
612	616	* consisting of a nested array.
613	617	*
614	618	* @NL80211_ATTR_MESH_ID: mesh id (1-32 bytes).
615		- * @NL80211_ATTR_PLINK_ACTION: action to perform on the mesh peer link.
	619	+ * @NL80211_ATTR_STA_PLINK_ACTION: action to perform on the mesh peer link.
616	620	* @NL80211_ATTR_MPATH_NEXT_HOP: MAC address of the next hop for a mesh path.
617	621	* @NL80211_ATTR_MPATH_INFO: information about a mesh_path, part of mesh path
618	622	* info given for %NL80211_CMD_GET_MPATH, nested attribute described at
...	...	@@ -879,7 +883,9 @@
879	883	* See &enum nl80211_key_default_types.
880	884	*
881	885	* @NL80211_ATTR_MESH_SETUP: Optional mesh setup parameters. These cannot be
882		- * changed once the mesh is active.
	886	+ * changed once the mesh is active.
	887	+ * @NL80211_ATTR_MESH_CONFIG: Mesh configuration parameters, a nested attribute
	888	+ * containing attributes from &enum nl80211_meshconf_params.
883	889	*
884	890	* @NL80211_ATTR_MAX: highest attribute number currently defined
885	891	* @__NL80211_ATTR_AFTER_LAST: internal use
...	...	@@ -1225,8 +1231,6 @@
1225	1231	* @NL80211_STA_INFO_INACTIVE_TIME: time since last activity (u32, msecs)
1226	1232	* @NL80211_STA_INFO_RX_BYTES: total received bytes (u32, from this station)
1227	1233	* @NL80211_STA_INFO_TX_BYTES: total transmitted bytes (u32, to this station)
1228		- * @__NL80211_STA_INFO_AFTER_LAST: internal
1229		- * @NL80211_STA_INFO_MAX: highest possible station info attribute
1230	1234	* @NL80211_STA_INFO_SIGNAL: signal strength of last received PPDU (u8, dBm)
1231	1235	* @NL80211_STA_INFO_TX_BITRATE: current unicast tx rate, nested attribute
1232	1236	* containing info as possible, see &enum nl80211_sta_info_txrate.
...	...	@@ -1236,6 +1240,11 @@
1236	1240	* @NL80211_STA_INFO_TX_RETRIES: total retries (u32, to this station)
1237	1241	* @NL80211_STA_INFO_TX_FAILED: total failed packets (u32, to this station)
1238	1242	* @NL80211_STA_INFO_SIGNAL_AVG: signal strength average (u8, dBm)
	1243	+ * @NL80211_STA_INFO_LLID: the station's mesh LLID
	1244	+ * @NL80211_STA_INFO_PLID: the station's mesh PLID
	1245	+ * @NL80211_STA_INFO_PLINK_STATE: peer link state for the station
	1246	+ * @__NL80211_STA_INFO_AFTER_LAST: internal
	1247	+ * @NL80211_STA_INFO_MAX: highest possible station info attribute
1239	1248	*/
1240	1249	enum nl80211_sta_info {
1241	1250	__NL80211_STA_INFO_INVALID,
...	...	@@ -1626,7 +1635,7 @@
1626	1635	* @NL80211_MESHCONF_HWMP_NET_DIAM_TRVS_TIME: The interval of time (in TUs)
1627	1636	* that it takes for an HWMP information element to propagate across the mesh
1628	1637	*
1629		- * @NL80211_MESHCONF_ROOTMODE: whether root mode is enabled or not
	1638	+ * @NL80211_MESHCONF_HWMP_ROOTMODE: whether root mode is enabled or not
1630	1639	*
1631	1640	* @NL80211_MESHCONF_ELEMENT_TTL: specifies the value of TTL field set at a
1632	1641	* source mesh point for path selection elements.
...	...	@@ -1678,6 +1687,7 @@
1678	1687	* element that vendors will use to identify the path selection methods and
1679	1688	* metrics in use.
1680	1689	*
	1690	+ * @NL80211_MESH_SETUP_ATTR_MAX: highest possible mesh setup attribute number
1681	1691	* @__NL80211_MESH_SETUP_ATTR_AFTER_LAST: Internal use
1682	1692	*/
1683	1693	enum nl80211_mesh_setup_params {