diff options
author | Alexander Aring <alex.aring@gmail.com> | 2015-06-06 17:30:52 +0200 |
---|---|---|
committer | Marcel Holtmann <marcel@holtmann.org> | 2015-06-07 09:13:32 +0200 |
commit | a0825b03aed91dd25d31aaff1e6e85c322caf8b2 (patch) | |
tree | fec9a18ee87165ea90b5f29a9ad00e4a24954f7d | |
parent | af69a34548cb01aefef76aeb3565cebc7a9fb0d6 (diff) | |
download | op-kernel-dev-a0825b03aed91dd25d31aaff1e6e85c322caf8b2.zip op-kernel-dev-a0825b03aed91dd25d31aaff1e6e85c322caf8b2.tar.gz |
mac802154: add missing structure comments
This patch add missing comments to internal mac802154 structures.
Signed-off-by: Alexander Aring <alex.aring@gmail.com>
Reviewed-by: Varka Bhadram <varkabhadram@gmail.com>
Signed-off-by: Marcel Holtmann <marcel@holtmann.org>
-rw-r--r-- | include/net/mac802154.h | 34 |
1 files changed, 28 insertions, 6 deletions
diff --git a/include/net/mac802154.h b/include/net/mac802154.h index d8e9e6f..095c9d0 100644 --- a/include/net/mac802154.h +++ b/include/net/mac802154.h @@ -55,18 +55,40 @@ enum ieee802154_hw_addr_filt_flags { IEEE802154_AFILT_PANC_CHANGED = BIT(4), }; +/** + * struct ieee802154_hw_addr_filt - hardware address filtering settings + * + * @pan_id: pan_id which should be set to the hardware address filter. + * + * @short_addr: short_addr which should be set to the hardware address filter. + * + * @ieee_addr: extended address which should be set to the hardware address + * filter. + * + * @pan_coord: boolean if hardware filtering should be operate as coordinator. + */ struct ieee802154_hw_addr_filt { - __le16 pan_id; /* Each independent PAN selects a unique - * identifier. This PAN id allows communication - * between devices within a network using short - * addresses and enables transmissions between - * devices across independent networks. - */ + __le16 pan_id; __le16 short_addr; __le64 ieee_addr; u8 pan_coord; }; +/** + * struct ieee802154_hw - ieee802154 hardware + * + * @extra_tx_headroom: headroom to reserve in each transmit skb for use by the + * driver (e.g. for transmit headers.) + * + * @flags: hardware flags, see &enum ieee802154_hw_flags + * + * @parent: parent device of the hardware. + * + * @priv: pointer to private area that was allocated for driver use along with + * this structure. + * + * @phy: This points to the &struct wpan_phy allocated for this 802.15.4 PHY. + */ struct ieee802154_hw { /* filled by the driver */ int extra_tx_headroom; |