Messages in this thread Patch in this message | | | From | Miquel Raynal <> | Subject | [net-next 06/18] net: ieee802154: Add a kernel doc header to the ieee802154_addr structure | Date | Wed, 22 Dec 2021 16:57:31 +0100 |
| |
From: David Girault <david.girault@qorvo.com>
While not being absolutely needed, it at least explain the mode vs. enum fields.
Signed-off-by: David Girault <david.girault@qorvo.com> [miquel.raynal@bootlin.com: Isolate this change from a bigger commit and reword the comment] Signed-off-by: Miquel Raynal <miquel.raynal@bootlin.com> --- include/net/cfg802154.h | 10 ++++++++++ 1 file changed, 10 insertions(+)
diff --git a/include/net/cfg802154.h b/include/net/cfg802154.h index 9f57bafeb3bb..4f36003bca98 100644 --- a/include/net/cfg802154.h +++ b/include/net/cfg802154.h @@ -29,6 +29,16 @@ struct ieee802154_llsec_key_id; struct ieee802154_llsec_key; #endif /* CONFIG_IEEE802154_NL802154_EXPERIMENTAL */ +/** + * struct ieee802154_addr - IEEE802.15.4 device address + * @mode: Address mode from frame header. Can be one of: + * - @IEEE802154_ADDR_NONE + * - @IEEE802154_ADDR_SHORT + * - @IEEE802154_ADDR_LONG + * @pan_id: The PAN ID this address belongs to + * @short_addr: address if @mode is @IEEE802154_ADDR_SHORT + * @extended_addr: address if @mode is @IEEE802154_ADDR_LONG + */ struct ieee802154_addr { u8 mode; __le16 pan_id; -- 2.27.0
| |