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
This commit is contained in:
Adrian Chadd 2025-05-12 20:32:17 -07:00
parent c4921a0faa
commit a3fcd76e80

View file

@ -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)
{