wifi: mac80211: clarify the dormant/suspended links docs

Since I keep getting confused about this and asking about it,
update the documentation.

In the future, especially when we add more reasons for a link
to be disabled, we should add a per-link 'disable state' bitmap
instead of maintaining all these bitmaps with subset logic, to
indicate each of the different states separately.

Signed-off-by: Johannes Berg <johannes.berg@intel.com>
Signed-off-by: Miri Korenblit <miriam.rachel.korenblit@intel.com>
Link: https://msgid.link/20240318184907.a5b24595b1a2.I92dd7d177b25df189b842d3bcddb1f2b13b1de13@changeid
Signed-off-by: Johannes Berg <johannes.berg@intel.com>

diff --git a/include/net/mac80211.h b/include/net/mac80211.h
index 353488ab94a294fd1fb2a985d015f9c8b59d421d..47fa73a62f8a1b43eef18cb2ef31d62168a962a6 100644 (file)
--- a/include/net/mac80211.h
+++ b/include/net/mac80211.h
@@ -1921,10 +1921,12 @@ enum ieee80211_neg_ttlm_res {
  * @active_links: The bitmap of active links, or 0 for non-MLO.
  *     The driver shouldn't change this directly, but use the
  *     API calls meant for that purpose.
- * @dormant_links: bitmap of valid but disabled links, or 0 for non-MLO.
- *     Must be a subset of valid_links.
+ * @dormant_links: subset of the valid links that are disabled/suspended
+ *     due to advertised or negotiated TTLM respectively.
+ *     0 for non-MLO.
  * @suspended_links: subset of dormant_links representing links that are
- *     suspended.
+ *     suspended due to negotiated TTLM, and could be activated in the
+ *     future by tearing down the TTLM negotiation.
  *     0 for non-MLO.
  * @neg_ttlm: negotiated TID to link mapping info.
  *     see &struct ieee80211_neg_ttlm.