diff mbox series

[6/6] wifi: ieee80211: document two FTM related functions

Message ID 20240515093852.229aa69e972c.Ifae6762a698e79cd5a49a055fe4c32330e826200@changeid (mailing list archive)
State Accepted
Delegated to: Johannes Berg
Headers show
Series wifi: further documentation cleanups | expand

Commit Message

Johannes Berg May 15, 2024, 7:38 a.m. UTC 
From: Johannes Berg <johannes.berg@intel.com>

Add some documentation to ieee80211_is_timing_measurement()
and ieee80211_is_ftm().

Signed-off-by: Johannes Berg <johannes.berg@intel.com>
---
 include/linux/ieee80211.h | 10 ++++++++++
 1 file changed, 10 insertions(+)
diff mbox series

Patch

diff --git a/include/linux/ieee80211.h b/include/linux/ieee80211.h
index 595f83783f0e..fb50a99daa93 100644
--- a/include/linux/ieee80211.h
+++ b/include/linux/ieee80211.h
@@ -4731,6 +4731,11 @@  static inline bool ieee80211_action_contains_tpc(struct sk_buff *skb)
 	return true;
 }
 
+/**
+ * ieee80211_is_timing_measurement - check if frame is timing measurement response
+ * @skb: the SKB to check
+ * Return: whether or not the frame is a valid timing measurement response
+ */
 static inline bool ieee80211_is_timing_measurement(struct sk_buff *skb)
 {
 	struct ieee80211_mgmt *mgmt = (void *)skb->data;
@@ -4750,6 +4755,11 @@  static inline bool ieee80211_is_timing_measurement(struct sk_buff *skb)
 	return false;
 }
 
+/**
+ * ieee80211_is_ftm - check if frame is FTM response
+ * @skb: the SKB to check
+ * Return: whether or not the frame is a valid FTM response action frame
+ */
 static inline bool ieee80211_is_ftm(struct sk_buff *skb)
 {
 	struct ieee80211_mgmt *mgmt = (void *)skb->data;