git: a3fcd76e8076 - main - net80211: document ieee80211_free_mbuf()

The branch main has been updated by adrian:

URL: https://cgit.FreeBSD.org/src/commit/?id=a3fcd76e807648e4069e73e0a607687c26fadc3d

commit a3fcd76e807648e4069e73e0a607687c26fadc3d
Author:     Adrian Chadd <adrian@FreeBSD.org>
AuthorDate: 2025-05-13 03:32:17 +0000
Commit:     Adrian Chadd <adrian@FreeBSD.org>
CommitDate: 2025-05-13 03:32:17 +0000

    net80211: document ieee80211_free_mbuf()
    
    Document what ieee80211_free_mbuf() does.  In particular, it handles
    freeing a list of mbufs, as an 802.11 "frame" passed to drivers may be
    a chain of 802.11 encapsulated fragmented frames.
    
    Reviewed by:    bz
---
 sys/net80211/ieee80211_output.c | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/sys/net80211/ieee80211_output.c b/sys/net80211/ieee80211_output.c
index da7719b16dba..506c90991800 100644
--- a/sys/net80211/ieee80211_output.c
+++ b/sys/net80211/ieee80211_output.c
@@ -1945,6 +1945,15 @@ bad:
 #undef MC01
 }
 
+/**
+ * @brief Free an 802.11 frame mbuf.
+ *
+ * Note that since a "frame" may consist of an mbuf packet
+ * list containing the 802.11 fragments that make up said
+ * frame, it will free everything in the mbuf packet list.
+ *
+ * @param m     mbuf packet list to free
+ */
 void
 ieee80211_free_mbuf(struct mbuf *m)
 {