Browse Source

realtek: DSA: Document meaning of lag priv variables

The names of the LAG variables in struct rtl838x_switch_priv are not self
explaining. They are even suggesting that they are dealing with information
which are actually stored in a different variable. As first step, document
their meaning.

Signed-off-by: Sven Eckelmann <[email protected]>
Link: https://github.com/openwrt/openwrt/pull/20707
Signed-off-by: Hauke Mehrtens <[email protected]>
Sven Eckelmann 2 months ago
parent
commit
f82da653fd
1 changed files with 13 additions and 0 deletions
  1. 13 0
      target/linux/realtek/files-6.12/drivers/net/dsa/rtl83xx/rtl838x.h

+ 13 - 0
target/linux/realtek/files-6.12/drivers/net/dsa/rtl83xx/rtl838x.h

@@ -1164,9 +1164,22 @@ struct rtl838x_switch_priv {
 	u32 fib_entries;
 	int l2_bucket_size;
 	struct dentry *dbgfs_dir;
+
+	/** @lags_port_members: Port (bit) is part of a specific LAG */
 	u64 lags_port_members[MAX_LAGS];
+
+	/** @lag_primary: port of a LAG is primary (repesenting) and is added to
+	 * the port matrix
+	 */
 	u32 lag_primary[MAX_LAGS];
+
+	/**
+	 * @is_lagmember: Port is part of any LAG but not the first/primary
+	 * port which needs to be added in the port matrix
+	 */
 	u32 is_lagmember[57];
+
+	/** @lagmembers: Port (bit) is part of any LAG */
 	u64 lagmembers;
 	struct workqueue_struct *wq;
 	struct notifier_block ne_nb;