diff options
| author | David Girault <david.girault@qorvo.com> | 2022-02-01 19:09:56 +0100 |
|---|---|---|
| committer | Stefan Schmidt <stefan@datenfreihafen.org> | 2022-02-01 21:03:48 +0100 |
| commit | 02b2a91c6f0d57df687e666b475849a54f295a12 (patch) | |
| tree | cc986cba2542a3e4b52039dc150e2806c3dae682 /include/net/cfg802154.h | |
| parent | c265a3a6690b093e542aceb4a7bf8bf6c577e42b (diff) | |
| download | linux-02b2a91c6f0d57df687e666b475849a54f295a12.tar.gz linux-02b2a91c6f0d57df687e666b475849a54f295a12.tar.bz2 linux-02b2a91c6f0d57df687e666b475849a54f295a12.zip | |
net: ieee802154: Provide a kdoc to the address structure
Give this structure a header to better explain its content.
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>
Link: https://lore.kernel.org/r/20220201180956.93581-1-miquel.raynal@bootlin.com
Signed-off-by: Stefan Schmidt <stefan@datenfreihafen.org>
Diffstat (limited to 'include/net/cfg802154.h')
| -rw-r--r-- | include/net/cfg802154.h | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/include/net/cfg802154.h b/include/net/cfg802154.h index 6ed07844eb24..833672d6fbe4 100644 --- a/include/net/cfg802154.h +++ b/include/net/cfg802154.h @@ -227,6 +227,16 @@ static inline void wpan_phy_net_set(struct wpan_phy *wpan_phy, struct net *net) write_pnet(&wpan_phy->_net, net); } +/** + * 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; |