From nobody Mon May 25 01:33:09 2026 X-Original-To: dev-commits-src-main@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 4gNz0k0Cj7z6ff88 for ; Mon, 25 May 2026 01:33:10 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R13" (not verified)) by mx1.freebsd.org (Postfix) with ESMTPS id 4gNz0j5Yrqz3S7M for ; Mon, 25 May 2026 01:33:09 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1779672789; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=+Oa0J8gLfAcTvK0i0Mo4WJJSQjAxBjls6qp95GodFY0=; b=L5KhP/fv/R/EFYnlU35UqAkj31e+wgE3dzQWL1A7jxg7VJM/HoJihAHTnXYysfFwPdCHqZ AEVkhNTektgkD2xGRub72qjP3pGhu0xkFFRihXO1mhBvM6nQJ+n87gVybe1XACNYZgK5wW pdxkzNwHSESr1suUZfBGNbz9sIJ305QkZN/oBCU+R5xgO3Pt8oDDs3bWTgHk2cqxWlpQWd 0SqzGZKND3MdQfkrUS1WT8MQbiLXFCLZqZWAwe1GoSfKM1yEhm4P9QC0C5cO37LN8PfHe9 0AUyyxjQmW3EYjVtUrBOUX5VZv/7x0WIW+UjC7Pxg3Vfn9WBkFUwKO45sr084w== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1779672789; a=rsa-sha256; cv=none; b=iCIL8+Rps8PiVe0/IHZeRfOPKpMwvW2NdB36Wlub5gL/HpvtzZ1KwlqHWr3PIaWKMbmhtX gzg0l66XReUUvT/eVPvSlA2XQFgjcRrL3Gbd8lI+QUl+m8+vX1RA2saSdpKwMNql0g6xDd YVAN3ORmXStss+WyRiKmIYsZ4W67dJ1UGlsraeG6GVwOkVkGgxnN+diLZ0idin9SL9JphP +6SnIS0xwk8rR9OV3mnn97BFlkTn75Bo+/PR+hWAmAoN5g4XffRkmYfcwHQWZzecKGMrUP R3q3DRqnWXYp/P97Lmft2wcfdQ7lZs7CiSnxaiDg6m2bV8Iun77t4vL6XKzB9A== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1779672789; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=+Oa0J8gLfAcTvK0i0Mo4WJJSQjAxBjls6qp95GodFY0=; b=MuGYe8YYusQ4NgOYawwkFlPexvJsEoYUucPG847DNW6t05YyXywA5eK9V4itiYNJn/MVoz xW0f3DO6xcH2TYAMThtLzlfFgWu4/Fax5cAs0ecto3E2ZooF4imc0wE01NxPoH38p/D3ic 2DnOfgt7VtbstyF96PXZvxJcbyzafGnfiq1kMsQcn3xln7C+bnsO3ry0xCX7zr7QuWm2ig s54VK0AlundQetHZXKGi5sPUMTrsJLdRccmIuAvaZvOopPL62ygEr+pdV/neexhBRdEDea J+VOtiZr34AvcgBDEid2nVYgm3QgqtWzHLD9TDLYXi0gwwjSMoRktTpx9zHiJA== Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) by mxrelay.nyi.freebsd.org (Postfix) with ESMTP id 4gNz0j560gz4JG for ; Mon, 25 May 2026 01:33:09 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from git (uid 1279) (envelope-from git@FreeBSD.org) id 429bd by gitrepo.freebsd.org (DragonFly Mail Agent v0.13+ on gitrepo.freebsd.org); Mon, 25 May 2026 01:33:09 +0000 To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-main@FreeBSD.org From: Adrian Chadd Subject: git: 0c37c9928c68 - main - net80211: add some example doxygen inline documents List-Id: Commit messages for the main branch of the src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-main List-Help: List-Post: List-Subscribe: List-Unsubscribe: X-BeenThere: dev-commits-src-main@freebsd.org Sender: owner-dev-commits-src-main@FreeBSD.org List-Id: List-Post: List-Help: List-Subscribe: List-Unsubscribe: List-Owner: Precedence: list MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: adrian X-Git-Repository: src X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 0c37c9928c68ca50b3d5a1282d0c756e71c2ef35 Auto-Submitted: auto-generated Date: Mon, 25 May 2026 01:33:09 +0000 Message-Id: <6a13a6d5.429bd.4e7acf3f@gitrepo.freebsd.org> The branch main has been updated by adrian: URL: https://cgit.FreeBSD.org/src/commit/?id=0c37c9928c68ca50b3d5a1282d0c756e71c2ef35 commit 0c37c9928c68ca50b3d5a1282d0c756e71c2ef35 Author: Adrian Chadd AuthorDate: 2026-05-17 18:41:11 +0000 Commit: Adrian Chadd CommitDate: 2026-05-25 01:32:10 +0000 net80211: add some example doxygen inline documents This isn't supposed to be comprehensive, I want to have examples for the common doxygen comments: * describing a struct * inside a struct - single line before the item * inside a struct - same line after an item * inside a struct - multi-line before an item These build fine with the doxygen build in tools/kerneldoc/subsys/ . Differential Revision: https://reviews.freebsd.org/D57056 --- sys/net80211/ieee80211_var.h | 29 ++++++++++++++++++++++++++--- 1 file changed, 26 insertions(+), 3 deletions(-) diff --git a/sys/net80211/ieee80211_var.h b/sys/net80211/ieee80211_var.h index 2f11fa7c887f..f38489174986 100644 --- a/sys/net80211/ieee80211_var.h +++ b/sys/net80211/ieee80211_var.h @@ -134,8 +134,11 @@ struct ieee80211_frame; struct net80211dump_methods; +/** + * @brief ieee80211com - the top level driver / hardware instance. + */ struct ieee80211com { - void *ic_softc; /* driver softc */ + void *ic_softc; /**< pointer to driver softc */ const char *ic_name; /* usually device name */ ieee80211_com_lock_t ic_comlock; /* state update lock */ ieee80211_tx_lock_t ic_txlock; /* ic/vap TX lock */ @@ -176,7 +179,15 @@ struct ieee80211com { uint8_t ic_allmulti; /* vap's needing all multicast*/ uint8_t ic_nrunning; /* vap's marked running */ uint8_t ic_curmode; /* current mode */ + /** + * @brief Driver assigned MAC address. + * + * Drivers are required to populate ic_macaddr at attach time with + * the MAC address of the device. It is then used as the base for + * MAC addresses created for VAP interfaces. + */ uint8_t ic_macaddr[IEEE80211_ADDR_LEN]; + uint16_t ic_bintval; /* beacon interval */ uint16_t ic_lintval; /* listen interval */ uint16_t ic_holdover; /* PM hold over duration */ @@ -283,7 +294,19 @@ struct ieee80211com { struct ieee80211_regdomain *, int, struct ieee80211_channel []); - int (*ic_set_quiet)(struct ieee80211_node *, + /** + * @brief Handle the quiet time information element configuration. + * + * This allows drivers/modules to tie into the quiet time IE + * for controlling the transmit duty cycle. This may be required + * for more accurate radar detection. + * + * @param ni The ieee80211_node which transmitted the IE (eg in a scan) + * or if unknown, the BSSID node + * @param quiet_elm the quiet time element contents to parse/handle + * @returns 0 for OK, non-zero with errno (eg ENOSYS) + */ + int (*ic_set_quiet)(struct ieee80211_node *ni, u_int8_t *quiet_elm); /* regular transmit */ @@ -296,7 +319,7 @@ struct ieee80211com { int (*ic_raw_xmit)(struct ieee80211_node *, struct mbuf *, const struct ieee80211_bpf_params *); - /* update device state for 802.11 slot time change */ + /** update device state for 802.11 slot time change */ void (*ic_updateslot)(struct ieee80211com *); /* handle multicast state changes */ void (*ic_update_mcast)(struct ieee80211com *);