From: Antonio Quartulli <antonio@meshcoding.com> To: davem@davemloft.net Cc: netdev@vger.kernel.org, b.a.t.m.a.n@lists.open-mesh.org, Antonio Quartulli <antonio@open-mesh.com>, Marek Lindner <mareklindner@neomailbox.ch> Subject: [PATCH 14/16] batman-adv: improve the TT flags documentation Date: Sat, 22 Mar 2014 09:56:14 +0100 [thread overview] Message-ID: <1395478576-10999-15-git-send-email-antonio@meshcoding.com> (raw) In-Reply-To: <1395478576-10999-1-git-send-email-antonio@meshcoding.com> From: Antonio Quartulli <antonio@open-mesh.com> Convert the current documentation for the TT flags in proper kerneldoc and improve it by adding an explanation for each of the flags. Signed-off-by: Antonio Quartulli <antonio@open-mesh.com> Signed-off-by: Marek Lindner <mareklindner@neomailbox.ch> --- net/batman-adv/packet.h | 28 ++++++++++++++++++++++++---- 1 file changed, 24 insertions(+), 4 deletions(-) diff --git a/net/batman-adv/packet.h b/net/batman-adv/packet.h index c7f6eef..34e096d 100644 --- a/net/batman-adv/packet.h +++ b/net/batman-adv/packet.h @@ -119,10 +119,30 @@ enum batadv_tt_data_flags { BATADV_TT_FULL_TABLE = BIT(4), }; -/* BATADV_TT_CLIENT flags. - * Flags from BIT(0) to BIT(7) are sent on the wire, while flags from BIT(8) to - * BIT(15) are used for local computation only. - * Flags from BIT(4) to BIT(7) are kept in sync with the rest of the network. +/** + * enum batadv_tt_client_flags - TT client specific flags + * @BATADV_TT_CLIENT_DEL: the client has to be deleted from the table + * @BATADV_TT_CLIENT_ROAM: the client roamed to/from another node and the new + * update telling its new real location has not been received/sent yet + * @BATADV_TT_CLIENT_WIFI: this client is connected through a wifi interface. + * This information is used by the "AP Isolation" feature + * @BATADV_TT_CLIENT_ISOLA: this client is considered "isolated". This + * information is used by the Extended Isolation feature + * @BATADV_TT_CLIENT_NOPURGE: this client should never be removed from the table + * @BATADV_TT_CLIENT_NEW: this client has been added to the local table but has + * not been announced yet + * @BATADV_TT_CLIENT_PENDING: this client is marked for removal but it is kept + * in the table for one more originator interval for consistency purposes + * @BATADV_TT_CLIENT_TEMP: this global client has been detected to be part of + * the network but no nnode has already announced it + * + * Bits from 0 to 7 are called _remote flags_ because they are sent on the wire. + * Bits from 8 to 15 are called _local flags_ because they are used for local + * computations only. + * + * Bits from 4 to 7 - a subset of remote flags - are ensured to be in sync with + * the other nodes in the network. To achieve this goal these flags are included + * in the TT CRC computation. */ enum batadv_tt_client_flags { BATADV_TT_CLIENT_DEL = BIT(0), -- 1.8.3.2
WARNING: multiple messages have this Message-ID (diff)
From: Antonio Quartulli <antonio@meshcoding.com> To: davem@davemloft.net Cc: netdev@vger.kernel.org, b.a.t.m.a.n@lists.open-mesh.org, Marek Lindner <mareklindner@neomailbox.ch>, Antonio Quartulli <antonio@open-mesh.com> Subject: [B.A.T.M.A.N.] [PATCH 14/16] batman-adv: improve the TT flags documentation Date: Sat, 22 Mar 2014 09:56:14 +0100 [thread overview] Message-ID: <1395478576-10999-15-git-send-email-antonio@meshcoding.com> (raw) In-Reply-To: <1395478576-10999-1-git-send-email-antonio@meshcoding.com> From: Antonio Quartulli <antonio@open-mesh.com> Convert the current documentation for the TT flags in proper kerneldoc and improve it by adding an explanation for each of the flags. Signed-off-by: Antonio Quartulli <antonio@open-mesh.com> Signed-off-by: Marek Lindner <mareklindner@neomailbox.ch> --- net/batman-adv/packet.h | 28 ++++++++++++++++++++++++---- 1 file changed, 24 insertions(+), 4 deletions(-) diff --git a/net/batman-adv/packet.h b/net/batman-adv/packet.h index c7f6eef..34e096d 100644 --- a/net/batman-adv/packet.h +++ b/net/batman-adv/packet.h @@ -119,10 +119,30 @@ enum batadv_tt_data_flags { BATADV_TT_FULL_TABLE = BIT(4), }; -/* BATADV_TT_CLIENT flags. - * Flags from BIT(0) to BIT(7) are sent on the wire, while flags from BIT(8) to - * BIT(15) are used for local computation only. - * Flags from BIT(4) to BIT(7) are kept in sync with the rest of the network. +/** + * enum batadv_tt_client_flags - TT client specific flags + * @BATADV_TT_CLIENT_DEL: the client has to be deleted from the table + * @BATADV_TT_CLIENT_ROAM: the client roamed to/from another node and the new + * update telling its new real location has not been received/sent yet + * @BATADV_TT_CLIENT_WIFI: this client is connected through a wifi interface. + * This information is used by the "AP Isolation" feature + * @BATADV_TT_CLIENT_ISOLA: this client is considered "isolated". This + * information is used by the Extended Isolation feature + * @BATADV_TT_CLIENT_NOPURGE: this client should never be removed from the table + * @BATADV_TT_CLIENT_NEW: this client has been added to the local table but has + * not been announced yet + * @BATADV_TT_CLIENT_PENDING: this client is marked for removal but it is kept + * in the table for one more originator interval for consistency purposes + * @BATADV_TT_CLIENT_TEMP: this global client has been detected to be part of + * the network but no nnode has already announced it + * + * Bits from 0 to 7 are called _remote flags_ because they are sent on the wire. + * Bits from 8 to 15 are called _local flags_ because they are used for local + * computations only. + * + * Bits from 4 to 7 - a subset of remote flags - are ensured to be in sync with + * the other nodes in the network. To achieve this goal these flags are included + * in the TT CRC computation. */ enum batadv_tt_client_flags { BATADV_TT_CLIENT_DEL = BIT(0), -- 1.8.3.2
next prev parent reply other threads:[~2014-03-22 9:14 UTC|newest] Thread overview: 36+ messages / expand[flat|nested] mbox.gz Atom feed top 2014-03-22 8:56 pull request: batman-adv 20140322 Antonio Quartulli 2014-03-22 8:56 ` [B.A.T.M.A.N.] " Antonio Quartulli 2014-03-22 8:56 ` [PATCH 01/16] batman-adv: fix coccinelle warnings Antonio Quartulli 2014-03-22 8:56 ` [B.A.T.M.A.N.] " Antonio Quartulli 2014-03-22 8:56 ` [PATCH 02/16] batman-adv: use vlan_/eth_hdr() instead of skb->data in interface_tx path Antonio Quartulli 2014-03-22 8:56 ` [B.A.T.M.A.N.] " Antonio Quartulli 2014-03-22 8:56 ` [PATCH 03/16] batman-adv: remove obsolete skb_reset_mac_header() in batadv_bla_tx() Antonio Quartulli 2014-03-22 8:56 ` [B.A.T.M.A.N.] " Antonio Quartulli 2014-03-22 8:56 ` [PATCH 04/16] batman-adv: prefer ether_addr_copy to memcpy Antonio Quartulli 2014-03-22 8:56 ` [B.A.T.M.A.N.] " Antonio Quartulli 2014-03-22 8:56 ` [PATCH 05/16] batman-adv: fix a few kerneldoc inconsistencies Antonio Quartulli 2014-03-22 8:56 ` [B.A.T.M.A.N.] " Antonio Quartulli 2014-03-22 8:56 ` [PATCH 06/16] batman-adv: call unregister_netdev() to have it handle the locking for us Antonio Quartulli 2014-03-22 8:56 ` [B.A.T.M.A.N.] " Antonio Quartulli 2014-03-22 8:56 ` [PATCH 07/16] batman-adv: add kerneldoc for dst_hint argument Antonio Quartulli 2014-03-22 8:56 ` [B.A.T.M.A.N.] " Antonio Quartulli 2014-03-22 8:56 ` [PATCH 08/16] batman-adv: Multicast Listener Announcements via Translation Table Antonio Quartulli 2014-03-22 8:56 ` [B.A.T.M.A.N.] " Antonio Quartulli 2014-03-22 8:56 ` [PATCH 09/16] batman-adv: introduce capability initialization bitfield Antonio Quartulli 2014-03-22 8:56 ` [B.A.T.M.A.N.] " Antonio Quartulli 2014-03-22 8:56 ` [PATCH 10/16] batman-adv: Announce new capability via multicast TVLV Antonio Quartulli 2014-03-22 8:56 ` [B.A.T.M.A.N.] " Antonio Quartulli 2014-03-22 8:56 ` [PATCH 11/16] batman-adv: Modified forwarding behaviour for multicast packets Antonio Quartulli 2014-03-22 8:56 ` [B.A.T.M.A.N.] " Antonio Quartulli 2014-03-22 8:56 ` [PATCH 12/16] batman-adv: Add IPv4 link-local/IPv6-ll-all-nodes multicast support Antonio Quartulli 2014-03-22 8:56 ` [B.A.T.M.A.N.] " Antonio Quartulli 2014-03-22 8:56 ` [PATCH 13/16] batman-adv: Send multicast packets to nodes with a WANT_ALL flag Antonio Quartulli 2014-03-22 8:56 ` [B.A.T.M.A.N.] " Antonio Quartulli 2014-03-22 8:56 ` Antonio Quartulli [this message] 2014-03-22 8:56 ` [B.A.T.M.A.N.] [PATCH 14/16] batman-adv: improve the TT flags documentation Antonio Quartulli 2014-03-22 8:56 ` [PATCH 15/16] batman-adv: improve DAT documentation Antonio Quartulli 2014-03-22 8:56 ` [B.A.T.M.A.N.] " Antonio Quartulli 2014-03-22 8:56 ` [PATCH 16/16] batman-adv: Start new development cycle Antonio Quartulli 2014-03-22 8:56 ` [B.A.T.M.A.N.] " Antonio Quartulli 2014-03-22 19:00 ` pull request: batman-adv 20140322 David Miller 2014-03-22 19:00 ` [B.A.T.M.A.N.] " David Miller
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=1395478576-10999-15-git-send-email-antonio@meshcoding.com \ --to=antonio@meshcoding.com \ --cc=antonio@open-mesh.com \ --cc=b.a.t.m.a.n@lists.open-mesh.org \ --cc=davem@davemloft.net \ --cc=mareklindner@neomailbox.ch \ --cc=netdev@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: linkBe sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes, see mirroring instructions on how to clone and mirror all data and code used by this external index.