From: Alexander Aring <alex.aring@gmail.com>
To: linux-wpan@vger.kernel.org
Cc: kernel@pengutronix.de, Alexander Aring <alex.aring@gmail.com>
Subject: [PATCH bluetooth-next 7/8] mac802154: add missing structure comments
Date: Sat, 6 Jun 2015 17:30:52 +0200 [thread overview]
Message-ID: <1433604653-9585-8-git-send-email-alex.aring@gmail.com> (raw)
In-Reply-To: <1433604653-9585-1-git-send-email-alex.aring@gmail.com>
This patch add missing comments to internal mac802154 structures.
Signed-off-by: Alexander Aring <alex.aring@gmail.com>
---
include/net/mac802154.h | 34 ++++++++++++++++++++++++++++------
1 file 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;
--
2.4.1
next prev parent reply other threads:[~2015-06-06 15:31 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-06-06 15:30 [PATCH bluetooth-next 0/8] mac802154: several cleanups Alexander Aring
2015-06-06 15:30 ` [PATCH bluetooth-next 1/8] mac802154: remove unneeded vif struct Alexander Aring
2015-06-07 2:36 ` Varka Bhadram
2015-06-06 15:30 ` [PATCH bluetooth-next 2/8] mac802154: cleanup address filtering flags Alexander Aring
2015-06-06 15:30 ` [PATCH bluetooth-next 3/8] mac802154: remove aack hw flag Alexander Aring
2015-06-06 19:49 ` Stefan Schmidt
2015-06-07 2:46 ` Varka Bhadram
2015-06-06 15:30 ` [PATCH bluetooth-next 4/8] mac802154: cleanup ieee802154 hardware flags Alexander Aring
2015-06-06 15:30 ` [PATCH bluetooth-next 5/8] mac802154: remove unused hw_filt attribute Alexander Aring
2015-06-06 15:30 ` [PATCH bluetooth-next 6/8] mac802154: rearrange attribute in ieee802154_hw Alexander Aring
2015-06-06 15:30 ` Alexander Aring [this message]
2015-06-06 15:30 ` [PATCH bluetooth-next 8/8] mac802154: change pan_coord type to bool Alexander Aring
2015-06-07 3:23 ` [PATCH bluetooth-next 0/8] mac802154: several cleanups Varka Bhadram
2015-06-07 7:15 ` Marcel Holtmann
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1433604653-9585-8-git-send-email-alex.aring@gmail.com \
--to=alex.aring@gmail.com \
--cc=kernel@pengutronix.de \
--cc=linux-wpan@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox