blob: 8a8d7ca1a5cf16542bcee9e21ac7a5673aaf11f2 [file] [log] [blame]
Sven Eckelmann0046b042016-01-01 00:01:03 +01001/* Copyright (C) 2007-2016 B.A.T.M.A.N. contributors:
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +00002 *
3 * Marek Lindner, Simon Wunderlich
4 *
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of version 2 of the GNU General Public
7 * License as published by the Free Software Foundation.
8 *
9 * This program is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
Antonio Quartulliebf38fb2013-11-03 20:40:48 +010015 * along with this program; if not, see <http://www.gnu.org/licenses/>.
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +000016 */
17
18#ifndef _NET_BATMAN_ADV_PACKET_H_
19#define _NET_BATMAN_ADV_PACKET_H_
20
Sven Eckelmann1e2c2a42015-04-17 19:40:28 +020021#include <asm/byteorder.h>
22#include <linux/types.h>
23
Marek Lindneref261572013-04-23 21:39:57 +080024/**
25 * enum batadv_packettype - types for batman-adv encapsulated packets
Simon Wunderlicha1f1ac52013-04-25 10:37:23 +020026 * @BATADV_IV_OGM: originator messages for B.A.T.M.A.N. IV
27 * @BATADV_BCAST: broadcast packets carrying broadcast payload
28 * @BATADV_CODED: network coded packets
Linus Luessingd6f94d92016-01-16 16:40:09 +080029 * @BATADV_ELP: echo location packets for B.A.T.M.A.N. V
Antonio Quartulli0da00352016-01-16 16:40:12 +080030 * @BATADV_OGM2: originator messages for B.A.T.M.A.N. V
Simon Wunderlicha1f1ac52013-04-25 10:37:23 +020031 *
32 * @BATADV_UNICAST: unicast packets carrying unicast payload traffic
33 * @BATADV_UNICAST_FRAG: unicast packets carrying a fragment of the original
34 * payload packet
35 * @BATADV_UNICAST_4ADDR: unicast packet including the originator address of
36 * the sender
37 * @BATADV_ICMP: unicast packet like IP ICMP used for ping or traceroute
Marek Lindneref261572013-04-23 21:39:57 +080038 * @BATADV_UNICAST_TVLV: unicast packet carrying TVLV containers
39 */
Sven Eckelmannacd34af2012-06-03 22:19:21 +020040enum batadv_packettype {
Simon Wunderlicha1f1ac52013-04-25 10:37:23 +020041 /* 0x00 - 0x3f: local packets or special rules for handling */
42 BATADV_IV_OGM = 0x00,
43 BATADV_BCAST = 0x01,
44 BATADV_CODED = 0x02,
Linus Luessingd6f94d92016-01-16 16:40:09 +080045 BATADV_ELP = 0x03,
Antonio Quartulli0da00352016-01-16 16:40:12 +080046 BATADV_OGM2 = 0x04,
Simon Wunderlicha1f1ac52013-04-25 10:37:23 +020047 /* 0x40 - 0x7f: unicast */
48#define BATADV_UNICAST_MIN 0x40
49 BATADV_UNICAST = 0x40,
50 BATADV_UNICAST_FRAG = 0x41,
51 BATADV_UNICAST_4ADDR = 0x42,
52 BATADV_ICMP = 0x43,
53 BATADV_UNICAST_TVLV = 0x44,
54#define BATADV_UNICAST_MAX 0x7f
55 /* 0x80 - 0xff: reserved */
Antonio Quartulli7cdcf6d2012-10-01 09:57:35 +020056};
57
58/**
59 * enum batadv_subtype - packet subtype for unicast4addr
60 * @BATADV_P_DATA: user payload
Antonio Quartulli5c3a0e52011-06-02 12:29:51 +020061 * @BATADV_P_DAT_DHT_GET: DHT request message
62 * @BATADV_P_DAT_DHT_PUT: DHT store message
63 * @BATADV_P_DAT_CACHE_REPLY: ARP reply generated by DAT
Antonio Quartulli7cdcf6d2012-10-01 09:57:35 +020064 */
65enum batadv_subtype {
Antonio Quartulli5c3a0e52011-06-02 12:29:51 +020066 BATADV_P_DATA = 0x01,
67 BATADV_P_DAT_DHT_GET = 0x02,
68 BATADV_P_DAT_DHT_PUT = 0x03,
69 BATADV_P_DAT_CACHE_REPLY = 0x04,
Sven Eckelmanne8958db2011-06-04 11:26:00 +020070};
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +000071
72/* this file is included by batctl which needs these defines */
Antonio Quartulli60cf7982013-04-20 15:59:13 +020073#define BATADV_COMPAT_VERSION 15
Sven Eckelmanne8958db2011-06-04 11:26:00 +020074
Simon Wunderlich18c68d52013-04-25 10:37:25 +020075/**
76 * enum batadv_iv_flags - flags used in B.A.T.M.A.N. IV OGM packets
77 * @BATADV_NOT_BEST_NEXT_HOP: flag is set when ogm packet is forwarded and was
78 * previously received from someone else than the best neighbor.
Marek Lindner143d1572015-08-09 23:56:50 +080079 * @BATADV_PRIMARIES_FIRST_HOP: flag unused.
Simon Wunderlich18c68d52013-04-25 10:37:25 +020080 * @BATADV_DIRECTLINK: flag is for the first hop or if rebroadcasted from a
81 * one hop neighbor on the interface where it was originally received.
82 */
Sven Eckelmannacd34af2012-06-03 22:19:21 +020083enum batadv_iv_flags {
Simon Wunderlich18c68d52013-04-25 10:37:25 +020084 BATADV_NOT_BEST_NEXT_HOP = BIT(0),
85 BATADV_PRIMARIES_FIRST_HOP = BIT(1),
86 BATADV_DIRECTLINK = BIT(2),
Sven Eckelmanne8958db2011-06-04 11:26:00 +020087};
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +000088
89/* ICMP message types */
Sven Eckelmannacd34af2012-06-03 22:19:21 +020090enum batadv_icmp_packettype {
91 BATADV_ECHO_REPLY = 0,
92 BATADV_DESTINATION_UNREACHABLE = 3,
93 BATADV_ECHO_REQUEST = 8,
94 BATADV_TTL_EXCEEDED = 11,
95 BATADV_PARAMETER_PROBLEM = 12,
Sven Eckelmanne8958db2011-06-04 11:26:00 +020096};
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +000097
Linus Lüssingab498862014-02-15 17:47:53 +010098/**
99 * enum batadv_mcast_flags - flags for multicast capabilities and settings
100 * @BATADV_MCAST_WANT_ALL_UNSNOOPABLES: we want all packets destined for
101 * 224.0.0.0/24 or ff02::1
Linus Lüssing4c8755d2014-02-15 17:47:54 +0100102 * @BATADV_MCAST_WANT_ALL_IPV4: we want all IPv4 multicast packets
103 * @BATADV_MCAST_WANT_ALL_IPV6: we want all IPv6 multicast packets
Linus Lüssingab498862014-02-15 17:47:53 +0100104 */
105enum batadv_mcast_flags {
106 BATADV_MCAST_WANT_ALL_UNSNOOPABLES = BIT(0),
Linus Lüssing4c8755d2014-02-15 17:47:54 +0100107 BATADV_MCAST_WANT_ALL_IPV4 = BIT(1),
108 BATADV_MCAST_WANT_ALL_IPV6 = BIT(2),
Linus Lüssingab498862014-02-15 17:47:53 +0100109};
110
Marek Lindnere1bf0c12013-04-23 21:40:01 +0800111/* tt data subtypes */
112#define BATADV_TT_DATA_TYPE_MASK 0x0F
Antonio Quartullia73105b2011-04-27 14:27:44 +0200113
Marek Lindnere1bf0c12013-04-23 21:40:01 +0800114/**
115 * enum batadv_tt_data_flags - flags for tt data tvlv
116 * @BATADV_TT_OGM_DIFF: TT diff propagated through OGM
117 * @BATADV_TT_REQUEST: TT request message
118 * @BATADV_TT_RESPONSE: TT response message
119 * @BATADV_TT_FULL_TABLE: contains full table to replace existing table
120 */
121enum batadv_tt_data_flags {
122 BATADV_TT_OGM_DIFF = BIT(0),
123 BATADV_TT_REQUEST = BIT(1),
124 BATADV_TT_RESPONSE = BIT(2),
125 BATADV_TT_FULL_TABLE = BIT(4),
Antonio Quartullia73105b2011-04-27 14:27:44 +0200126};
127
Antonio Quartulli43e6f652014-02-22 16:48:14 +0100128/**
129 * enum batadv_tt_client_flags - TT client specific flags
130 * @BATADV_TT_CLIENT_DEL: the client has to be deleted from the table
131 * @BATADV_TT_CLIENT_ROAM: the client roamed to/from another node and the new
132 * update telling its new real location has not been received/sent yet
133 * @BATADV_TT_CLIENT_WIFI: this client is connected through a wifi interface.
134 * This information is used by the "AP Isolation" feature
135 * @BATADV_TT_CLIENT_ISOLA: this client is considered "isolated". This
136 * information is used by the Extended Isolation feature
137 * @BATADV_TT_CLIENT_NOPURGE: this client should never be removed from the table
138 * @BATADV_TT_CLIENT_NEW: this client has been added to the local table but has
139 * not been announced yet
140 * @BATADV_TT_CLIENT_PENDING: this client is marked for removal but it is kept
141 * in the table for one more originator interval for consistency purposes
142 * @BATADV_TT_CLIENT_TEMP: this global client has been detected to be part of
143 * the network but no nnode has already announced it
144 *
145 * Bits from 0 to 7 are called _remote flags_ because they are sent on the wire.
146 * Bits from 8 to 15 are called _local flags_ because they are used for local
147 * computations only.
148 *
149 * Bits from 4 to 7 - a subset of remote flags - are ensured to be in sync with
150 * the other nodes in the network. To achieve this goal these flags are included
151 * in the TT CRC computation.
Sven Eckelmann9cfc7bd2012-05-12 02:09:43 +0200152 */
Sven Eckelmannacd34af2012-06-03 22:19:21 +0200153enum batadv_tt_client_flags {
Sven Eckelmann8de47de2012-07-08 16:32:09 +0200154 BATADV_TT_CLIENT_DEL = BIT(0),
155 BATADV_TT_CLIENT_ROAM = BIT(1),
Antonio Quartulli0eb015682013-10-13 02:50:20 +0200156 BATADV_TT_CLIENT_WIFI = BIT(4),
Antonio Quartulli9464d072013-11-16 12:03:48 +0100157 BATADV_TT_CLIENT_ISOLA = BIT(5),
Sven Eckelmann8de47de2012-07-08 16:32:09 +0200158 BATADV_TT_CLIENT_NOPURGE = BIT(8),
159 BATADV_TT_CLIENT_NEW = BIT(9),
160 BATADV_TT_CLIENT_PENDING = BIT(10),
Antonio Quartulli0035f972013-04-24 16:37:52 +0200161 BATADV_TT_CLIENT_TEMP = BIT(11),
Antonio Quartullia73105b2011-04-27 14:27:44 +0200162};
163
Antonio Quartullic018ad32013-06-04 12:11:39 +0200164/**
Sven Eckelmann6f68b002015-09-06 21:38:49 +0200165 * enum batadv_vlan_flags - flags for the four MSB of any vlan ID field
Antonio Quartullic018ad32013-06-04 12:11:39 +0200166 * @BATADV_VLAN_HAS_TAG: whether the field contains a valid vlan tag or not
167 */
168enum batadv_vlan_flags {
169 BATADV_VLAN_HAS_TAG = BIT(15),
170};
171
Simon Wunderlich23721382012-01-22 20:00:19 +0100172/* claim frame types for the bridge loop avoidance */
Sven Eckelmannacd34af2012-06-03 22:19:21 +0200173enum batadv_bla_claimframe {
Simon Wunderlich3eb87732012-06-23 12:34:18 +0200174 BATADV_CLAIM_TYPE_CLAIM = 0x00,
175 BATADV_CLAIM_TYPE_UNCLAIM = 0x01,
Sven Eckelmannacd34af2012-06-03 22:19:21 +0200176 BATADV_CLAIM_TYPE_ANNOUNCE = 0x02,
177 BATADV_CLAIM_TYPE_REQUEST = 0x03,
Simon Wunderlich23721382012-01-22 20:00:19 +0100178};
179
Marek Lindner414254e2013-04-23 21:39:58 +0800180/**
181 * enum batadv_tvlv_type - tvlv type definitions
182 * @BATADV_TVLV_GW: gateway tvlv
Marek Lindner17cf0ea2013-04-23 21:39:59 +0800183 * @BATADV_TVLV_DAT: distributed arp table tvlv
Marek Lindner3f4841f2013-04-23 21:40:00 +0800184 * @BATADV_TVLV_NC: network coding tvlv
Marek Lindnere1bf0c12013-04-23 21:40:01 +0800185 * @BATADV_TVLV_TT: translation table tvlv
Marek Lindner122edaa2013-04-23 21:40:03 +0800186 * @BATADV_TVLV_ROAM: roaming advertisement tvlv
Linus Lüssing60432d72014-02-15 17:47:51 +0100187 * @BATADV_TVLV_MCAST: multicast capability tvlv
Marek Lindner414254e2013-04-23 21:39:58 +0800188 */
189enum batadv_tvlv_type {
190 BATADV_TVLV_GW = 0x01,
Marek Lindner17cf0ea2013-04-23 21:39:59 +0800191 BATADV_TVLV_DAT = 0x02,
Marek Lindner3f4841f2013-04-23 21:40:00 +0800192 BATADV_TVLV_NC = 0x03,
Marek Lindnere1bf0c12013-04-23 21:40:01 +0800193 BATADV_TVLV_TT = 0x04,
Marek Lindner122edaa2013-04-23 21:40:03 +0800194 BATADV_TVLV_ROAM = 0x05,
Linus Lüssing60432d72014-02-15 17:47:51 +0100195 BATADV_TVLV_MCAST = 0x06,
Marek Lindner414254e2013-04-23 21:39:58 +0800196};
197
Simon Wunderlich2f7a3182013-12-02 20:38:33 +0100198#pragma pack(2)
Simon Wunderlich23721382012-01-22 20:00:19 +0100199/* the destination hardware field in the ARP frame is used to
200 * transport the claim type and the group id
201 */
Sven Eckelmann96412692012-06-05 22:31:30 +0200202struct batadv_bla_claim_dst {
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200203 u8 magic[3]; /* FF:43:05 */
204 u8 type; /* bla_claimframe */
Al Viro3e2f1a12012-04-22 07:47:50 +0100205 __be16 group; /* group id */
Sven Eckelmannf6c57a42012-11-05 21:25:26 +0100206};
Antonio Quartulliaa143d22014-09-01 14:37:27 +0200207
Simon Wunderlich2f7a3182013-12-02 20:38:33 +0100208#pragma pack()
Simon Wunderlich23721382012-01-22 20:00:19 +0100209
Marek Lindneref261572013-04-23 21:39:57 +0800210/**
211 * struct batadv_ogm_packet - ogm (routing protocol) packet
Simon Wunderlicha40d9b02013-12-02 20:38:31 +0100212 * @packet_type: batman-adv packet type, part of the general header
213 * @version: batman-adv protocol version, part of the genereal header
214 * @ttl: time to live for this packet, part of the genereal header
Simon Wunderlich18c68d52013-04-25 10:37:25 +0200215 * @flags: contains routing relevant flags - see enum batadv_iv_flags
Sven Eckelmann7afcbbe2015-10-31 12:29:29 +0100216 * @seqno: sequence identification
217 * @orig: address of the source node
218 * @prev_sender: address of the previous sender
219 * @reserved: reserved byte for alignment
220 * @tq: transmission quality
Marek Lindneref261572013-04-23 21:39:57 +0800221 * @tvlv_len: length of tvlv data following the ogm header
222 */
Sven Eckelmann96412692012-06-05 22:31:30 +0200223struct batadv_ogm_packet {
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200224 u8 packet_type;
225 u8 version;
226 u8 ttl;
227 u8 flags;
228 __be32 seqno;
229 u8 orig[ETH_ALEN];
230 u8 prev_sender[ETH_ALEN];
231 u8 reserved;
232 u8 tq;
233 __be16 tvlv_len;
Simon Wunderlich9284a472013-04-25 10:37:24 +0200234 /* __packed is not needed as the struct size is divisible by 4,
235 * and the largest data type in this struct has a size of 4.
236 */
237};
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000238
Sven Eckelmann96412692012-06-05 22:31:30 +0200239#define BATADV_OGM_HLEN sizeof(struct batadv_ogm_packet)
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000240
Antonio Quartulli0bf84c12013-05-18 14:56:57 +0200241/**
Antonio Quartulli0da00352016-01-16 16:40:12 +0800242 * struct batadv_ogm2_packet - ogm2 (routing protocol) packet
243 * @packet_type: batman-adv packet type, part of the general header
244 * @version: batman-adv protocol version, part of the general header
245 * @ttl: time to live for this packet, part of the general header
246 * @flags: reseved for routing relevant flags - currently always 0
247 * @seqno: sequence number
248 * @orig: originator mac address
249 * @tvlv_len: length of the appended tvlv buffer (in bytes)
250 * @throughput: the currently flooded path throughput
251 */
252struct batadv_ogm2_packet {
253 u8 packet_type;
254 u8 version;
255 u8 ttl;
256 u8 flags;
257 __be32 seqno;
258 u8 orig[ETH_ALEN];
259 __be16 tvlv_len;
260 __be32 throughput;
261 /* __packed is not needed as the struct size is divisible by 4,
262 * and the largest data type in this struct has a size of 4.
263 */
264};
265
266#define BATADV_OGM2_HLEN sizeof(struct batadv_ogm2_packet)
267
268/**
Linus Luessingd6f94d92016-01-16 16:40:09 +0800269 * struct batadv_elp_packet - elp (neighbor discovery) packet
270 * @packet_type: batman-adv packet type, part of the general header
271 * @version: batman-adv protocol version, part of the genereal header
272 * @orig: originator mac address
273 * @seqno: sequence number
274 * @elp_interval: currently used ELP sending interval in ms
275 */
276struct batadv_elp_packet {
277 u8 packet_type;
278 u8 version;
279 u8 orig[ETH_ALEN];
280 __be32 seqno;
281 __be32 elp_interval;
282};
283
284#define BATADV_ELP_HLEN sizeof(struct batadv_elp_packet)
285
286/**
Sven Eckelmann6f68b002015-09-06 21:38:49 +0200287 * struct batadv_icmp_header - common members among all the ICMP packets
Simon Wunderlicha40d9b02013-12-02 20:38:31 +0100288 * @packet_type: batman-adv packet type, part of the general header
289 * @version: batman-adv protocol version, part of the genereal header
290 * @ttl: time to live for this packet, part of the genereal header
Antonio Quartulli0bf84c12013-05-18 14:56:57 +0200291 * @msg_type: ICMP packet type
292 * @dst: address of the destination node
293 * @orig: address of the source node
294 * @uid: local ICMP socket identifier
Antonio Quartulli27a417e2013-12-05 15:33:00 +0100295 * @align: not used - useful for alignment purposes only
296 *
297 * This structure is used for ICMP packets parsing only and it is never sent
298 * over the wire. The alignment field at the end is there to ensure that
299 * members are padded the same way as they are in real packets.
Antonio Quartulli0bf84c12013-05-18 14:56:57 +0200300 */
301struct batadv_icmp_header {
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200302 u8 packet_type;
303 u8 version;
304 u8 ttl;
305 u8 msg_type; /* see ICMP message types above */
306 u8 dst[ETH_ALEN];
307 u8 orig[ETH_ALEN];
308 u8 uid;
309 u8 align[3];
Antonio Quartulli0bf84c12013-05-18 14:56:57 +0200310};
311
312/**
Sven Eckelmann6f68b002015-09-06 21:38:49 +0200313 * struct batadv_icmp_packet - ICMP packet
Antonio Quartulli27a417e2013-12-05 15:33:00 +0100314 * @packet_type: batman-adv packet type, part of the general header
315 * @version: batman-adv protocol version, part of the genereal header
316 * @ttl: time to live for this packet, part of the genereal header
317 * @msg_type: ICMP packet type
318 * @dst: address of the destination node
319 * @orig: address of the source node
320 * @uid: local ICMP socket identifier
Antonio Quartulli0bf84c12013-05-18 14:56:57 +0200321 * @reserved: not used - useful for alignment
322 * @seqno: ICMP sequence number
323 */
324struct batadv_icmp_packet {
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200325 u8 packet_type;
326 u8 version;
327 u8 ttl;
328 u8 msg_type; /* see ICMP message types above */
329 u8 dst[ETH_ALEN];
330 u8 orig[ETH_ALEN];
331 u8 uid;
332 u8 reserved;
333 __be16 seqno;
Sven Eckelmannf6c57a42012-11-05 21:25:26 +0100334};
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000335
Sven Eckelmann7e071c72012-06-03 22:19:13 +0200336#define BATADV_RR_LEN 16
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000337
Antonio Quartulli0bf84c12013-05-18 14:56:57 +0200338/**
Sven Eckelmann6f68b002015-09-06 21:38:49 +0200339 * struct batadv_icmp_packet_rr - ICMP RouteRecord packet
Antonio Quartulli27a417e2013-12-05 15:33:00 +0100340 * @packet_type: batman-adv packet type, part of the general header
341 * @version: batman-adv protocol version, part of the genereal header
342 * @ttl: time to live for this packet, part of the genereal header
343 * @msg_type: ICMP packet type
344 * @dst: address of the destination node
345 * @orig: address of the source node
346 * @uid: local ICMP socket identifier
Antonio Quartulli0bf84c12013-05-18 14:56:57 +0200347 * @rr_cur: number of entries the rr array
348 * @seqno: ICMP sequence number
349 * @rr: route record array
Sven Eckelmann9cfc7bd2012-05-12 02:09:43 +0200350 */
Sven Eckelmann96412692012-06-05 22:31:30 +0200351struct batadv_icmp_packet_rr {
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200352 u8 packet_type;
353 u8 version;
354 u8 ttl;
355 u8 msg_type; /* see ICMP message types above */
356 u8 dst[ETH_ALEN];
357 u8 orig[ETH_ALEN];
358 u8 uid;
359 u8 rr_cur;
360 __be16 seqno;
361 u8 rr[BATADV_RR_LEN][ETH_ALEN];
Sven Eckelmannf6c57a42012-11-05 21:25:26 +0100362};
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000363
Simon Wunderlichda6b8c22013-10-22 22:50:09 +0200364#define BATADV_ICMP_MAX_PACKET_SIZE sizeof(struct batadv_icmp_packet_rr)
365
Sven Eckelmanne022b952012-11-05 21:25:27 +0100366/* All packet headers in front of an ethernet header have to be completely
367 * divisible by 2 but not by 4 to make the payload after the ethernet
368 * header again 4 bytes boundary aligned.
369 *
370 * A packing of 2 is necessary to avoid extra padding at the end of the struct
371 * caused by a structure member which is larger than two bytes. Otherwise
372 * the structure would not fulfill the previously mentioned rule to avoid the
373 * misalignment of the payload after the ethernet header. It may also lead to
374 * leakage of information when the padding it not initialized before sending.
375 */
376#pragma pack(2)
377
Simon Wunderlicha40d9b02013-12-02 20:38:31 +0100378/**
379 * struct batadv_unicast_packet - unicast packet for network payload
380 * @packet_type: batman-adv packet type, part of the general header
381 * @version: batman-adv protocol version, part of the genereal header
382 * @ttl: time to live for this packet, part of the genereal header
383 * @ttvn: translation table version number
384 * @dest: originator destination of the unicast packet
385 */
Sven Eckelmann96412692012-06-05 22:31:30 +0200386struct batadv_unicast_packet {
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200387 u8 packet_type;
388 u8 version;
389 u8 ttl;
390 u8 ttvn; /* destination translation table version number */
391 u8 dest[ETH_ALEN];
Sven Eckelmannf6c57a42012-11-05 21:25:26 +0100392 /* "4 bytes boundary + 2 bytes" long to make the payload after the
393 * following ethernet header again 4 bytes boundary aligned
394 */
395};
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000396
Antonio Quartulli7cdcf6d2012-10-01 09:57:35 +0200397/**
398 * struct batadv_unicast_4addr_packet - extended unicast packet
399 * @u: common unicast packet header
400 * @src: address of the source
401 * @subtype: packet subtype
Sven Eckelmann7afcbbe2015-10-31 12:29:29 +0100402 * @reserved: reserved byte for alignment
Antonio Quartulli7cdcf6d2012-10-01 09:57:35 +0200403 */
404struct batadv_unicast_4addr_packet {
405 struct batadv_unicast_packet u;
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200406 u8 src[ETH_ALEN];
407 u8 subtype;
408 u8 reserved;
Antonio Quartulli7cdcf6d2012-10-01 09:57:35 +0200409 /* "4 bytes boundary + 2 bytes" long to make the payload after the
410 * following ethernet header again 4 bytes boundary aligned
411 */
412};
413
Martin Hundebøll610bfc6bc2013-05-23 16:53:02 +0200414/**
415 * struct batadv_frag_packet - fragmented packet
Simon Wunderlicha40d9b02013-12-02 20:38:31 +0100416 * @packet_type: batman-adv packet type, part of the general header
417 * @version: batman-adv protocol version, part of the genereal header
418 * @ttl: time to live for this packet, part of the genereal header
Martin Hundebøll610bfc6bc2013-05-23 16:53:02 +0200419 * @dest: final destination used when routing fragments
420 * @orig: originator of the fragment used when merging the packet
421 * @no: fragment number within this sequence
422 * @reserved: reserved byte for alignment
423 * @seqno: sequence identification
424 * @total_size: size of the merged packet
425 */
426struct batadv_frag_packet {
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200427 u8 packet_type;
428 u8 version; /* batman version field */
429 u8 ttl;
Martin Hundebøll610bfc6bc2013-05-23 16:53:02 +0200430#if defined(__BIG_ENDIAN_BITFIELD)
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200431 u8 no:4;
432 u8 reserved:4;
Martin Hundebøll610bfc6bc2013-05-23 16:53:02 +0200433#elif defined(__LITTLE_ENDIAN_BITFIELD)
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200434 u8 reserved:4;
435 u8 no:4;
Martin Hundebøll610bfc6bc2013-05-23 16:53:02 +0200436#else
Antonio Quartulli3f687852014-11-02 11:29:56 +0100437#error "unknown bitfield endianness"
Martin Hundebøll610bfc6bc2013-05-23 16:53:02 +0200438#endif
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200439 u8 dest[ETH_ALEN];
440 u8 orig[ETH_ALEN];
441 __be16 seqno;
442 __be16 total_size;
Martin Hundebøll610bfc6bc2013-05-23 16:53:02 +0200443};
444
Simon Wunderlicha40d9b02013-12-02 20:38:31 +0100445/**
446 * struct batadv_bcast_packet - broadcast packet for network payload
447 * @packet_type: batman-adv packet type, part of the general header
448 * @version: batman-adv protocol version, part of the genereal header
449 * @ttl: time to live for this packet, part of the genereal header
450 * @reserved: reserved byte for alignment
451 * @seqno: sequence identification
452 * @orig: originator of the broadcast packet
453 */
Sven Eckelmann96412692012-06-05 22:31:30 +0200454struct batadv_bcast_packet {
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200455 u8 packet_type;
456 u8 version; /* batman version field */
457 u8 ttl;
458 u8 reserved;
459 __be32 seqno;
460 u8 orig[ETH_ALEN];
Sven Eckelmannf6c57a42012-11-05 21:25:26 +0100461 /* "4 bytes boundary + 2 bytes" long to make the payload after the
462 * following ethernet header again 4 bytes boundary aligned
463 */
Sven Eckelmanne022b952012-11-05 21:25:27 +0100464};
465
Martin Hundebøll3c12de92013-01-25 11:12:41 +0100466/**
467 * struct batadv_coded_packet - network coded packet
Simon Wunderlicha40d9b02013-12-02 20:38:31 +0100468 * @packet_type: batman-adv packet type, part of the general header
469 * @version: batman-adv protocol version, part of the genereal header
470 * @ttl: time to live for this packet, part of the genereal header
Martin Hundebøll3c12de92013-01-25 11:12:41 +0100471 * @first_source: original source of first included packet
472 * @first_orig_dest: original destinal of first included packet
473 * @first_crc: checksum of first included packet
474 * @first_ttvn: tt-version number of first included packet
475 * @second_ttl: ttl of second packet
476 * @second_dest: second receiver of this coded packet
477 * @second_source: original source of second included packet
478 * @second_orig_dest: original destination of second included packet
479 * @second_crc: checksum of second included packet
480 * @second_ttvn: tt version number of second included packet
481 * @coded_len: length of network coded part of the payload
482 */
483struct batadv_coded_packet {
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200484 u8 packet_type;
485 u8 version; /* batman version field */
486 u8 ttl;
487 u8 first_ttvn;
488 /* u8 first_dest[ETH_ALEN]; - saved in mac header destination */
489 u8 first_source[ETH_ALEN];
490 u8 first_orig_dest[ETH_ALEN];
491 __be32 first_crc;
492 u8 second_ttl;
493 u8 second_ttvn;
494 u8 second_dest[ETH_ALEN];
495 u8 second_source[ETH_ALEN];
496 u8 second_orig_dest[ETH_ALEN];
497 __be32 second_crc;
498 __be16 coded_len;
Martin Hundebøll3c12de92013-01-25 11:12:41 +0100499};
500
Simon Wunderlich46b76e02013-12-02 20:38:30 +0100501#pragma pack()
502
Marek Lindneref261572013-04-23 21:39:57 +0800503/**
504 * struct batadv_unicast_tvlv - generic unicast packet with tvlv payload
Simon Wunderlicha40d9b02013-12-02 20:38:31 +0100505 * @packet_type: batman-adv packet type, part of the general header
506 * @version: batman-adv protocol version, part of the genereal header
507 * @ttl: time to live for this packet, part of the genereal header
Marek Lindneref261572013-04-23 21:39:57 +0800508 * @reserved: reserved field (for packet alignment)
509 * @src: address of the source
510 * @dst: address of the destination
511 * @tvlv_len: length of tvlv data following the unicast tvlv header
Antonio Quartulli3f687852014-11-02 11:29:56 +0100512 * @align: 2 bytes to align the header to a 4 byte boundary
Marek Lindneref261572013-04-23 21:39:57 +0800513 */
514struct batadv_unicast_tvlv_packet {
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200515 u8 packet_type;
516 u8 version; /* batman version field */
517 u8 ttl;
518 u8 reserved;
519 u8 dst[ETH_ALEN];
520 u8 src[ETH_ALEN];
521 __be16 tvlv_len;
522 u16 align;
Marek Lindneref261572013-04-23 21:39:57 +0800523};
524
525/**
526 * struct batadv_tvlv_hdr - base tvlv header struct
527 * @type: tvlv container type (see batadv_tvlv_type)
528 * @version: tvlv container version
529 * @len: tvlv container length
530 */
531struct batadv_tvlv_hdr {
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200532 u8 type;
533 u8 version;
534 __be16 len;
Marek Lindneref261572013-04-23 21:39:57 +0800535};
536
Marek Lindner414254e2013-04-23 21:39:58 +0800537/**
538 * struct batadv_tvlv_gateway_data - gateway data propagated through gw tvlv
539 * container
540 * @bandwidth_down: advertised uplink download bandwidth
541 * @bandwidth_up: advertised uplink upload bandwidth
542 */
543struct batadv_tvlv_gateway_data {
544 __be32 bandwidth_down;
545 __be32 bandwidth_up;
546};
547
Marek Lindnere1bf0c12013-04-23 21:40:01 +0800548/**
549 * struct batadv_tvlv_tt_data - tt data propagated through the tt tvlv container
550 * @flags: translation table flags (see batadv_tt_data_flags)
551 * @ttvn: translation table version number
Sven Eckelmanne51f0392015-09-06 21:38:51 +0200552 * @num_vlan: number of announced VLANs. In the TVLV this struct is followed by
Antonio Quartulli7ea7b4a2013-07-30 22:16:25 +0200553 * one batadv_tvlv_tt_vlan_data object per announced vlan
Marek Lindnere1bf0c12013-04-23 21:40:01 +0800554 */
555struct batadv_tvlv_tt_data {
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200556 u8 flags;
557 u8 ttvn;
558 __be16 num_vlan;
Antonio Quartulli7ea7b4a2013-07-30 22:16:25 +0200559};
560
561/**
562 * struct batadv_tvlv_tt_vlan_data - vlan specific tt data propagated through
563 * the tt tvlv container
564 * @crc: crc32 checksum of the entries belonging to this vlan
565 * @vid: vlan identifier
566 * @reserved: unused, useful for alignment purposes
567 */
568struct batadv_tvlv_tt_vlan_data {
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200569 __be32 crc;
570 __be16 vid;
571 u16 reserved;
Marek Lindnere1bf0c12013-04-23 21:40:01 +0800572};
573
574/**
575 * struct batadv_tvlv_tt_change - translation table diff data
576 * @flags: status indicators concerning the non-mesh client (see
577 * batadv_tt_client_flags)
Antonio Quartullica663042013-12-15 13:26:55 +0100578 * @reserved: reserved field - useful for alignment purposes only
Marek Lindnere1bf0c12013-04-23 21:40:01 +0800579 * @addr: mac address of non-mesh client that triggered this tt change
Antonio Quartullic018ad32013-06-04 12:11:39 +0200580 * @vid: VLAN identifier
Marek Lindnere1bf0c12013-04-23 21:40:01 +0800581 */
582struct batadv_tvlv_tt_change {
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200583 u8 flags;
584 u8 reserved[3];
585 u8 addr[ETH_ALEN];
Antonio Quartullic018ad32013-06-04 12:11:39 +0200586 __be16 vid;
Marek Lindnere1bf0c12013-04-23 21:40:01 +0800587};
588
Marek Lindner122edaa2013-04-23 21:40:03 +0800589/**
590 * struct batadv_tvlv_roam_adv - roaming advertisement
591 * @client: mac address of roaming client
Antonio Quartullic018ad32013-06-04 12:11:39 +0200592 * @vid: VLAN identifier
Marek Lindner122edaa2013-04-23 21:40:03 +0800593 */
594struct batadv_tvlv_roam_adv {
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200595 u8 client[ETH_ALEN];
Antonio Quartullic018ad32013-06-04 12:11:39 +0200596 __be16 vid;
Marek Lindner122edaa2013-04-23 21:40:03 +0800597};
598
Linus Lüssing60432d72014-02-15 17:47:51 +0100599/**
600 * struct batadv_tvlv_mcast_data - payload of a multicast tvlv
601 * @flags: multicast flags announced by the orig node
602 * @reserved: reserved field
603 */
604struct batadv_tvlv_mcast_data {
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200605 u8 flags;
606 u8 reserved[3];
Linus Lüssing60432d72014-02-15 17:47:51 +0100607};
608
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000609#endif /* _NET_BATMAN_ADV_PACKET_H_ */