aboutsummaryrefslogtreecommitdiffstats
path: root/net/batman-adv
diff options
context:
space:
mode:
authorAntonio Quartulli <antonio@open-mesh.com>2014-02-22 10:48:14 -0500
committerAntonio Quartulli <antonio@meshcoding.com>2014-03-22 04:18:59 -0400
commit43e6f65a3d777d8edf9f8d5083022a98baac850a (patch)
treed3907658358334e1713df169cea6be0c832c8033 /net/batman-adv
parent4c8755d69cbde2ec464a39c932aed0a83f9ff89f (diff)
batman-adv: improve the TT flags documentation
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>
Diffstat (limited to 'net/batman-adv')
-rw-r--r--net/batman-adv/packet.h28
1 files changed, 24 insertions, 4 deletions
diff --git a/net/batman-adv/packet.h b/net/batman-adv/packet.h
index c7f6eefda681..34e096d2dce1 100644
--- a/net/batman-adv/packet.h
+++ b/net/batman-adv/packet.h
@@ -119,10 +119,30 @@ enum batadv_tt_data_flags {
119 BATADV_TT_FULL_TABLE = BIT(4), 119 BATADV_TT_FULL_TABLE = BIT(4),
120}; 120};
121 121
122/* BATADV_TT_CLIENT flags. 122/**
123 * Flags from BIT(0) to BIT(7) are sent on the wire, while flags from BIT(8) to 123 * enum batadv_tt_client_flags - TT client specific flags
124 * BIT(15) are used for local computation only. 124 * @BATADV_TT_CLIENT_DEL: the client has to be deleted from the table
125 * Flags from BIT(4) to BIT(7) are kept in sync with the rest of the network. 125 * @BATADV_TT_CLIENT_ROAM: the client roamed to/from another node and the new
126 * update telling its new real location has not been received/sent yet
127 * @BATADV_TT_CLIENT_WIFI: this client is connected through a wifi interface.
128 * This information is used by the "AP Isolation" feature
129 * @BATADV_TT_CLIENT_ISOLA: this client is considered "isolated". This
130 * information is used by the Extended Isolation feature
131 * @BATADV_TT_CLIENT_NOPURGE: this client should never be removed from the table
132 * @BATADV_TT_CLIENT_NEW: this client has been added to the local table but has
133 * not been announced yet
134 * @BATADV_TT_CLIENT_PENDING: this client is marked for removal but it is kept
135 * in the table for one more originator interval for consistency purposes
136 * @BATADV_TT_CLIENT_TEMP: this global client has been detected to be part of
137 * the network but no nnode has already announced it
138 *
139 * Bits from 0 to 7 are called _remote flags_ because they are sent on the wire.
140 * Bits from 8 to 15 are called _local flags_ because they are used for local
141 * computations only.
142 *
143 * Bits from 4 to 7 - a subset of remote flags - are ensured to be in sync with
144 * the other nodes in the network. To achieve this goal these flags are included
145 * in the TT CRC computation.
126 */ 146 */
127enum batadv_tt_client_flags { 147enum batadv_tt_client_flags {
128 BATADV_TT_CLIENT_DEL = BIT(0), 148 BATADV_TT_CLIENT_DEL = BIT(0),