blob: 6afc0b86950eca24633fc28138c643598e07c84f [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
Antonio Quartulli33a3bb42016-05-05 13:09:43 +020024#define batadv_tp_is_error(n) ((u8)n > 127 ? 1 : 0)
25
Marek Lindneref261572013-04-23 21:39:57 +080026/**
27 * enum batadv_packettype - types for batman-adv encapsulated packets
Simon Wunderlicha1f1ac52013-04-25 10:37:23 +020028 * @BATADV_IV_OGM: originator messages for B.A.T.M.A.N. IV
29 * @BATADV_BCAST: broadcast packets carrying broadcast payload
30 * @BATADV_CODED: network coded packets
Linus Luessingd6f94d92016-01-16 16:40:09 +080031 * @BATADV_ELP: echo location packets for B.A.T.M.A.N. V
Antonio Quartulli0da00352016-01-16 16:40:12 +080032 * @BATADV_OGM2: originator messages for B.A.T.M.A.N. V
Simon Wunderlicha1f1ac52013-04-25 10:37:23 +020033 *
34 * @BATADV_UNICAST: unicast packets carrying unicast payload traffic
35 * @BATADV_UNICAST_FRAG: unicast packets carrying a fragment of the original
36 * payload packet
37 * @BATADV_UNICAST_4ADDR: unicast packet including the originator address of
38 * the sender
39 * @BATADV_ICMP: unicast packet like IP ICMP used for ping or traceroute
Marek Lindneref261572013-04-23 21:39:57 +080040 * @BATADV_UNICAST_TVLV: unicast packet carrying TVLV containers
41 */
Sven Eckelmannacd34af2012-06-03 22:19:21 +020042enum batadv_packettype {
Simon Wunderlicha1f1ac52013-04-25 10:37:23 +020043 /* 0x00 - 0x3f: local packets or special rules for handling */
44 BATADV_IV_OGM = 0x00,
45 BATADV_BCAST = 0x01,
46 BATADV_CODED = 0x02,
Linus Luessingd6f94d92016-01-16 16:40:09 +080047 BATADV_ELP = 0x03,
Antonio Quartulli0da00352016-01-16 16:40:12 +080048 BATADV_OGM2 = 0x04,
Simon Wunderlicha1f1ac52013-04-25 10:37:23 +020049 /* 0x40 - 0x7f: unicast */
50#define BATADV_UNICAST_MIN 0x40
51 BATADV_UNICAST = 0x40,
52 BATADV_UNICAST_FRAG = 0x41,
53 BATADV_UNICAST_4ADDR = 0x42,
54 BATADV_ICMP = 0x43,
55 BATADV_UNICAST_TVLV = 0x44,
56#define BATADV_UNICAST_MAX 0x7f
57 /* 0x80 - 0xff: reserved */
Antonio Quartulli7cdcf6d2012-10-01 09:57:35 +020058};
59
60/**
61 * enum batadv_subtype - packet subtype for unicast4addr
62 * @BATADV_P_DATA: user payload
Antonio Quartulli5c3a0e52011-06-02 12:29:51 +020063 * @BATADV_P_DAT_DHT_GET: DHT request message
64 * @BATADV_P_DAT_DHT_PUT: DHT store message
65 * @BATADV_P_DAT_CACHE_REPLY: ARP reply generated by DAT
Antonio Quartulli7cdcf6d2012-10-01 09:57:35 +020066 */
67enum batadv_subtype {
Antonio Quartulli5c3a0e52011-06-02 12:29:51 +020068 BATADV_P_DATA = 0x01,
69 BATADV_P_DAT_DHT_GET = 0x02,
70 BATADV_P_DAT_DHT_PUT = 0x03,
71 BATADV_P_DAT_CACHE_REPLY = 0x04,
Sven Eckelmanne8958db2011-06-04 11:26:00 +020072};
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +000073
74/* this file is included by batctl which needs these defines */
Antonio Quartulli60cf7982013-04-20 15:59:13 +020075#define BATADV_COMPAT_VERSION 15
Sven Eckelmanne8958db2011-06-04 11:26:00 +020076
Simon Wunderlich18c68d52013-04-25 10:37:25 +020077/**
78 * enum batadv_iv_flags - flags used in B.A.T.M.A.N. IV OGM packets
79 * @BATADV_NOT_BEST_NEXT_HOP: flag is set when ogm packet is forwarded and was
80 * previously received from someone else than the best neighbor.
Marek Lindner143d1572015-08-09 23:56:50 +080081 * @BATADV_PRIMARIES_FIRST_HOP: flag unused.
Simon Wunderlich18c68d52013-04-25 10:37:25 +020082 * @BATADV_DIRECTLINK: flag is for the first hop or if rebroadcasted from a
83 * one hop neighbor on the interface where it was originally received.
84 */
Sven Eckelmannacd34af2012-06-03 22:19:21 +020085enum batadv_iv_flags {
Simon Wunderlich18c68d52013-04-25 10:37:25 +020086 BATADV_NOT_BEST_NEXT_HOP = BIT(0),
87 BATADV_PRIMARIES_FIRST_HOP = BIT(1),
88 BATADV_DIRECTLINK = BIT(2),
Sven Eckelmanne8958db2011-06-04 11:26:00 +020089};
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +000090
91/* ICMP message types */
Sven Eckelmannacd34af2012-06-03 22:19:21 +020092enum batadv_icmp_packettype {
93 BATADV_ECHO_REPLY = 0,
94 BATADV_DESTINATION_UNREACHABLE = 3,
95 BATADV_ECHO_REQUEST = 8,
96 BATADV_TTL_EXCEEDED = 11,
97 BATADV_PARAMETER_PROBLEM = 12,
Antonio Quartulli33a3bb42016-05-05 13:09:43 +020098 BATADV_TP = 15,
Sven Eckelmanne8958db2011-06-04 11:26:00 +020099};
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000100
Linus Lüssingab498862014-02-15 17:47:53 +0100101/**
102 * enum batadv_mcast_flags - flags for multicast capabilities and settings
103 * @BATADV_MCAST_WANT_ALL_UNSNOOPABLES: we want all packets destined for
104 * 224.0.0.0/24 or ff02::1
Linus Lüssing4c8755d2014-02-15 17:47:54 +0100105 * @BATADV_MCAST_WANT_ALL_IPV4: we want all IPv4 multicast packets
106 * @BATADV_MCAST_WANT_ALL_IPV6: we want all IPv6 multicast packets
Linus Lüssingab498862014-02-15 17:47:53 +0100107 */
108enum batadv_mcast_flags {
109 BATADV_MCAST_WANT_ALL_UNSNOOPABLES = BIT(0),
Linus Lüssing4c8755d2014-02-15 17:47:54 +0100110 BATADV_MCAST_WANT_ALL_IPV4 = BIT(1),
111 BATADV_MCAST_WANT_ALL_IPV6 = BIT(2),
Linus Lüssingab498862014-02-15 17:47:53 +0100112};
113
Marek Lindnere1bf0c12013-04-23 21:40:01 +0800114/* tt data subtypes */
115#define BATADV_TT_DATA_TYPE_MASK 0x0F
Antonio Quartullia73105b2011-04-27 14:27:44 +0200116
Marek Lindnere1bf0c12013-04-23 21:40:01 +0800117/**
118 * enum batadv_tt_data_flags - flags for tt data tvlv
119 * @BATADV_TT_OGM_DIFF: TT diff propagated through OGM
120 * @BATADV_TT_REQUEST: TT request message
121 * @BATADV_TT_RESPONSE: TT response message
122 * @BATADV_TT_FULL_TABLE: contains full table to replace existing table
123 */
124enum batadv_tt_data_flags {
125 BATADV_TT_OGM_DIFF = BIT(0),
126 BATADV_TT_REQUEST = BIT(1),
127 BATADV_TT_RESPONSE = BIT(2),
128 BATADV_TT_FULL_TABLE = BIT(4),
Antonio Quartullia73105b2011-04-27 14:27:44 +0200129};
130
Antonio Quartulli43e6f652014-02-22 16:48:14 +0100131/**
Sven Eckelmann6f68b002015-09-06 21:38:49 +0200132 * enum batadv_vlan_flags - flags for the four MSB of any vlan ID field
Antonio Quartullic018ad32013-06-04 12:11:39 +0200133 * @BATADV_VLAN_HAS_TAG: whether the field contains a valid vlan tag or not
134 */
135enum batadv_vlan_flags {
136 BATADV_VLAN_HAS_TAG = BIT(15),
137};
138
Simon Wunderlich23721382012-01-22 20:00:19 +0100139/* claim frame types for the bridge loop avoidance */
Sven Eckelmannacd34af2012-06-03 22:19:21 +0200140enum batadv_bla_claimframe {
Simon Wunderlich3eb87732012-06-23 12:34:18 +0200141 BATADV_CLAIM_TYPE_CLAIM = 0x00,
142 BATADV_CLAIM_TYPE_UNCLAIM = 0x01,
Sven Eckelmannacd34af2012-06-03 22:19:21 +0200143 BATADV_CLAIM_TYPE_ANNOUNCE = 0x02,
144 BATADV_CLAIM_TYPE_REQUEST = 0x03,
Simon Wunderlichcd9c7bf2016-03-12 10:49:33 +0100145 BATADV_CLAIM_TYPE_LOOPDETECT = 0x04,
Simon Wunderlich23721382012-01-22 20:00:19 +0100146};
147
Marek Lindner414254e2013-04-23 21:39:58 +0800148/**
149 * enum batadv_tvlv_type - tvlv type definitions
150 * @BATADV_TVLV_GW: gateway tvlv
Marek Lindner17cf0ea2013-04-23 21:39:59 +0800151 * @BATADV_TVLV_DAT: distributed arp table tvlv
Marek Lindner3f4841f2013-04-23 21:40:00 +0800152 * @BATADV_TVLV_NC: network coding tvlv
Marek Lindnere1bf0c12013-04-23 21:40:01 +0800153 * @BATADV_TVLV_TT: translation table tvlv
Marek Lindner122edaa2013-04-23 21:40:03 +0800154 * @BATADV_TVLV_ROAM: roaming advertisement tvlv
Linus Lüssing60432d72014-02-15 17:47:51 +0100155 * @BATADV_TVLV_MCAST: multicast capability tvlv
Marek Lindner414254e2013-04-23 21:39:58 +0800156 */
157enum batadv_tvlv_type {
158 BATADV_TVLV_GW = 0x01,
Marek Lindner17cf0ea2013-04-23 21:39:59 +0800159 BATADV_TVLV_DAT = 0x02,
Marek Lindner3f4841f2013-04-23 21:40:00 +0800160 BATADV_TVLV_NC = 0x03,
Marek Lindnere1bf0c12013-04-23 21:40:01 +0800161 BATADV_TVLV_TT = 0x04,
Marek Lindner122edaa2013-04-23 21:40:03 +0800162 BATADV_TVLV_ROAM = 0x05,
Linus Lüssing60432d72014-02-15 17:47:51 +0100163 BATADV_TVLV_MCAST = 0x06,
Marek Lindner414254e2013-04-23 21:39:58 +0800164};
165
Simon Wunderlich2f7a3182013-12-02 20:38:33 +0100166#pragma pack(2)
Simon Wunderlich23721382012-01-22 20:00:19 +0100167/* the destination hardware field in the ARP frame is used to
168 * transport the claim type and the group id
169 */
Sven Eckelmann96412692012-06-05 22:31:30 +0200170struct batadv_bla_claim_dst {
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200171 u8 magic[3]; /* FF:43:05 */
172 u8 type; /* bla_claimframe */
Al Viro3e2f1a12012-04-22 07:47:50 +0100173 __be16 group; /* group id */
Sven Eckelmannf6c57a42012-11-05 21:25:26 +0100174};
Antonio Quartulliaa143d22014-09-01 14:37:27 +0200175
Simon Wunderlich2f7a3182013-12-02 20:38:33 +0100176#pragma pack()
Simon Wunderlich23721382012-01-22 20:00:19 +0100177
Marek Lindneref261572013-04-23 21:39:57 +0800178/**
179 * struct batadv_ogm_packet - ogm (routing protocol) packet
Simon Wunderlicha40d9b02013-12-02 20:38:31 +0100180 * @packet_type: batman-adv packet type, part of the general header
181 * @version: batman-adv protocol version, part of the genereal header
182 * @ttl: time to live for this packet, part of the genereal header
Simon Wunderlich18c68d52013-04-25 10:37:25 +0200183 * @flags: contains routing relevant flags - see enum batadv_iv_flags
Sven Eckelmann7afcbbe2015-10-31 12:29:29 +0100184 * @seqno: sequence identification
185 * @orig: address of the source node
186 * @prev_sender: address of the previous sender
187 * @reserved: reserved byte for alignment
188 * @tq: transmission quality
Marek Lindneref261572013-04-23 21:39:57 +0800189 * @tvlv_len: length of tvlv data following the ogm header
190 */
Sven Eckelmann96412692012-06-05 22:31:30 +0200191struct batadv_ogm_packet {
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200192 u8 packet_type;
193 u8 version;
194 u8 ttl;
195 u8 flags;
196 __be32 seqno;
197 u8 orig[ETH_ALEN];
198 u8 prev_sender[ETH_ALEN];
199 u8 reserved;
200 u8 tq;
201 __be16 tvlv_len;
Simon Wunderlich9284a472013-04-25 10:37:24 +0200202 /* __packed is not needed as the struct size is divisible by 4,
203 * and the largest data type in this struct has a size of 4.
204 */
205};
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000206
Sven Eckelmann96412692012-06-05 22:31:30 +0200207#define BATADV_OGM_HLEN sizeof(struct batadv_ogm_packet)
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000208
Antonio Quartulli0bf84c12013-05-18 14:56:57 +0200209/**
Antonio Quartulli0da00352016-01-16 16:40:12 +0800210 * struct batadv_ogm2_packet - ogm2 (routing protocol) packet
211 * @packet_type: batman-adv packet type, part of the general header
212 * @version: batman-adv protocol version, part of the general header
213 * @ttl: time to live for this packet, part of the general header
214 * @flags: reseved for routing relevant flags - currently always 0
215 * @seqno: sequence number
216 * @orig: originator mac address
217 * @tvlv_len: length of the appended tvlv buffer (in bytes)
218 * @throughput: the currently flooded path throughput
219 */
220struct batadv_ogm2_packet {
221 u8 packet_type;
222 u8 version;
223 u8 ttl;
224 u8 flags;
225 __be32 seqno;
226 u8 orig[ETH_ALEN];
227 __be16 tvlv_len;
228 __be32 throughput;
229 /* __packed is not needed as the struct size is divisible by 4,
230 * and the largest data type in this struct has a size of 4.
231 */
232};
233
234#define BATADV_OGM2_HLEN sizeof(struct batadv_ogm2_packet)
235
236/**
Linus Luessingd6f94d92016-01-16 16:40:09 +0800237 * struct batadv_elp_packet - elp (neighbor discovery) packet
238 * @packet_type: batman-adv packet type, part of the general header
239 * @version: batman-adv protocol version, part of the genereal header
240 * @orig: originator mac address
241 * @seqno: sequence number
242 * @elp_interval: currently used ELP sending interval in ms
243 */
244struct batadv_elp_packet {
245 u8 packet_type;
246 u8 version;
247 u8 orig[ETH_ALEN];
248 __be32 seqno;
249 __be32 elp_interval;
250};
251
252#define BATADV_ELP_HLEN sizeof(struct batadv_elp_packet)
253
254/**
Antonio Quartulli33a3bb42016-05-05 13:09:43 +0200255 * enum batadv_icmp_user_cmd_type - types for batman-adv icmp cmd modes
256 * @BATADV_TP_START: start a throughput meter run
257 * @BATADV_TP_STOP: stop a throughput meter run
258 */
259enum batadv_icmp_user_cmd_type {
260 BATADV_TP_START = 0,
261 BATADV_TP_STOP = 2,
262};
263
264/**
Sven Eckelmann6f68b002015-09-06 21:38:49 +0200265 * struct batadv_icmp_header - common members among all the ICMP packets
Simon Wunderlicha40d9b02013-12-02 20:38:31 +0100266 * @packet_type: batman-adv packet type, part of the general header
267 * @version: batman-adv protocol version, part of the genereal header
268 * @ttl: time to live for this packet, part of the genereal header
Antonio Quartulli0bf84c12013-05-18 14:56:57 +0200269 * @msg_type: ICMP packet type
270 * @dst: address of the destination node
271 * @orig: address of the source node
272 * @uid: local ICMP socket identifier
Antonio Quartulli27a417e2013-12-05 15:33:00 +0100273 * @align: not used - useful for alignment purposes only
274 *
275 * This structure is used for ICMP packets parsing only and it is never sent
276 * over the wire. The alignment field at the end is there to ensure that
277 * members are padded the same way as they are in real packets.
Antonio Quartulli0bf84c12013-05-18 14:56:57 +0200278 */
279struct batadv_icmp_header {
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200280 u8 packet_type;
281 u8 version;
282 u8 ttl;
283 u8 msg_type; /* see ICMP message types above */
284 u8 dst[ETH_ALEN];
285 u8 orig[ETH_ALEN];
286 u8 uid;
287 u8 align[3];
Antonio Quartulli0bf84c12013-05-18 14:56:57 +0200288};
289
290/**
Sven Eckelmann6f68b002015-09-06 21:38:49 +0200291 * struct batadv_icmp_packet - ICMP packet
Antonio Quartulli27a417e2013-12-05 15:33:00 +0100292 * @packet_type: batman-adv packet type, part of the general header
293 * @version: batman-adv protocol version, part of the genereal header
294 * @ttl: time to live for this packet, part of the genereal header
295 * @msg_type: ICMP packet type
296 * @dst: address of the destination node
297 * @orig: address of the source node
298 * @uid: local ICMP socket identifier
Antonio Quartulli0bf84c12013-05-18 14:56:57 +0200299 * @reserved: not used - useful for alignment
300 * @seqno: ICMP sequence number
301 */
302struct batadv_icmp_packet {
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200303 u8 packet_type;
304 u8 version;
305 u8 ttl;
306 u8 msg_type; /* see ICMP message types above */
307 u8 dst[ETH_ALEN];
308 u8 orig[ETH_ALEN];
309 u8 uid;
310 u8 reserved;
311 __be16 seqno;
Sven Eckelmannf6c57a42012-11-05 21:25:26 +0100312};
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000313
Antonio Quartulli33a3bb42016-05-05 13:09:43 +0200314/**
315 * struct batadv_icmp_tp_packet - ICMP TP Meter packet
316 * @packet_type: batman-adv packet type, part of the general header
317 * @version: batman-adv protocol version, part of the genereal header
318 * @ttl: time to live for this packet, part of the genereal header
319 * @msg_type: ICMP packet type
320 * @dst: address of the destination node
321 * @orig: address of the source node
322 * @uid: local ICMP socket identifier
323 * @subtype: TP packet subtype (see batadv_icmp_tp_subtype)
324 * @session: TP session identifier
325 * @seqno: the TP sequence number
326 * @timestamp: time when the packet has been sent. This value is filled in a
327 * TP_MSG and echoed back in the next TP_ACK so that the sender can compute the
328 * RTT. Since it is read only by the host which wrote it, there is no need to
329 * store it using network order
330 */
331struct batadv_icmp_tp_packet {
332 u8 packet_type;
333 u8 version;
334 u8 ttl;
335 u8 msg_type; /* see ICMP message types above */
336 u8 dst[ETH_ALEN];
337 u8 orig[ETH_ALEN];
338 u8 uid;
339 u8 subtype;
340 u8 session[2];
341 __be32 seqno;
342 __be32 timestamp;
343};
344
345/**
346 * enum batadv_icmp_tp_subtype - ICMP TP Meter packet subtypes
347 * @BATADV_TP_MSG: Msg from sender to receiver
348 * @BATADV_TP_ACK: acknowledgment from receiver to sender
349 */
350enum batadv_icmp_tp_subtype {
351 BATADV_TP_MSG = 0,
352 BATADV_TP_ACK,
353};
354
Sven Eckelmann7e071c72012-06-03 22:19:13 +0200355#define BATADV_RR_LEN 16
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000356
Antonio Quartulli0bf84c12013-05-18 14:56:57 +0200357/**
Sven Eckelmann6f68b002015-09-06 21:38:49 +0200358 * struct batadv_icmp_packet_rr - ICMP RouteRecord packet
Antonio Quartulli27a417e2013-12-05 15:33:00 +0100359 * @packet_type: batman-adv packet type, part of the general header
360 * @version: batman-adv protocol version, part of the genereal header
361 * @ttl: time to live for this packet, part of the genereal header
362 * @msg_type: ICMP packet type
363 * @dst: address of the destination node
364 * @orig: address of the source node
365 * @uid: local ICMP socket identifier
Antonio Quartulli0bf84c12013-05-18 14:56:57 +0200366 * @rr_cur: number of entries the rr array
367 * @seqno: ICMP sequence number
368 * @rr: route record array
Sven Eckelmann9cfc7bd2012-05-12 02:09:43 +0200369 */
Sven Eckelmann96412692012-06-05 22:31:30 +0200370struct batadv_icmp_packet_rr {
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200371 u8 packet_type;
372 u8 version;
373 u8 ttl;
374 u8 msg_type; /* see ICMP message types above */
375 u8 dst[ETH_ALEN];
376 u8 orig[ETH_ALEN];
377 u8 uid;
378 u8 rr_cur;
379 __be16 seqno;
380 u8 rr[BATADV_RR_LEN][ETH_ALEN];
Sven Eckelmannf6c57a42012-11-05 21:25:26 +0100381};
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000382
Simon Wunderlichda6b8c22013-10-22 22:50:09 +0200383#define BATADV_ICMP_MAX_PACKET_SIZE sizeof(struct batadv_icmp_packet_rr)
384
Sven Eckelmanne022b952012-11-05 21:25:27 +0100385/* All packet headers in front of an ethernet header have to be completely
386 * divisible by 2 but not by 4 to make the payload after the ethernet
387 * header again 4 bytes boundary aligned.
388 *
389 * A packing of 2 is necessary to avoid extra padding at the end of the struct
390 * caused by a structure member which is larger than two bytes. Otherwise
391 * the structure would not fulfill the previously mentioned rule to avoid the
392 * misalignment of the payload after the ethernet header. It may also lead to
393 * leakage of information when the padding it not initialized before sending.
394 */
395#pragma pack(2)
396
Simon Wunderlicha40d9b02013-12-02 20:38:31 +0100397/**
398 * struct batadv_unicast_packet - unicast packet for network payload
399 * @packet_type: batman-adv packet type, part of the general header
400 * @version: batman-adv protocol version, part of the genereal header
401 * @ttl: time to live for this packet, part of the genereal header
402 * @ttvn: translation table version number
403 * @dest: originator destination of the unicast packet
404 */
Sven Eckelmann96412692012-06-05 22:31:30 +0200405struct batadv_unicast_packet {
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200406 u8 packet_type;
407 u8 version;
408 u8 ttl;
409 u8 ttvn; /* destination translation table version number */
410 u8 dest[ETH_ALEN];
Sven Eckelmannf6c57a42012-11-05 21:25:26 +0100411 /* "4 bytes boundary + 2 bytes" long to make the payload after the
412 * following ethernet header again 4 bytes boundary aligned
413 */
414};
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000415
Antonio Quartulli7cdcf6d2012-10-01 09:57:35 +0200416/**
417 * struct batadv_unicast_4addr_packet - extended unicast packet
418 * @u: common unicast packet header
419 * @src: address of the source
420 * @subtype: packet subtype
Sven Eckelmann7afcbbe2015-10-31 12:29:29 +0100421 * @reserved: reserved byte for alignment
Antonio Quartulli7cdcf6d2012-10-01 09:57:35 +0200422 */
423struct batadv_unicast_4addr_packet {
424 struct batadv_unicast_packet u;
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200425 u8 src[ETH_ALEN];
426 u8 subtype;
427 u8 reserved;
Antonio Quartulli7cdcf6d2012-10-01 09:57:35 +0200428 /* "4 bytes boundary + 2 bytes" long to make the payload after the
429 * following ethernet header again 4 bytes boundary aligned
430 */
431};
432
Martin Hundebøll610bfc6bc2013-05-23 16:53:02 +0200433/**
434 * struct batadv_frag_packet - fragmented packet
Simon Wunderlicha40d9b02013-12-02 20:38:31 +0100435 * @packet_type: batman-adv packet type, part of the general header
436 * @version: batman-adv protocol version, part of the genereal header
437 * @ttl: time to live for this packet, part of the genereal header
Martin Hundebøll610bfc6bc2013-05-23 16:53:02 +0200438 * @dest: final destination used when routing fragments
439 * @orig: originator of the fragment used when merging the packet
440 * @no: fragment number within this sequence
Andrew Lunnc0f25c82016-05-09 20:03:36 +0200441 * @priority: priority of frame, from ToS IP precedence or 802.1p
Martin Hundebøll610bfc6bc2013-05-23 16:53:02 +0200442 * @reserved: reserved byte for alignment
443 * @seqno: sequence identification
444 * @total_size: size of the merged packet
445 */
446struct batadv_frag_packet {
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200447 u8 packet_type;
448 u8 version; /* batman version field */
449 u8 ttl;
Martin Hundebøll610bfc6bc2013-05-23 16:53:02 +0200450#if defined(__BIG_ENDIAN_BITFIELD)
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200451 u8 no:4;
Andrew Lunnc0f25c82016-05-09 20:03:36 +0200452 u8 priority:3;
453 u8 reserved:1;
Martin Hundebøll610bfc6bc2013-05-23 16:53:02 +0200454#elif defined(__LITTLE_ENDIAN_BITFIELD)
Andrew Lunnc0f25c82016-05-09 20:03:36 +0200455 u8 reserved:1;
456 u8 priority:3;
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200457 u8 no:4;
Martin Hundebøll610bfc6bc2013-05-23 16:53:02 +0200458#else
Antonio Quartulli3f687852014-11-02 11:29:56 +0100459#error "unknown bitfield endianness"
Martin Hundebøll610bfc6bc2013-05-23 16:53:02 +0200460#endif
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200461 u8 dest[ETH_ALEN];
462 u8 orig[ETH_ALEN];
463 __be16 seqno;
464 __be16 total_size;
Martin Hundebøll610bfc6bc2013-05-23 16:53:02 +0200465};
466
Simon Wunderlicha40d9b02013-12-02 20:38:31 +0100467/**
468 * struct batadv_bcast_packet - broadcast packet for network payload
469 * @packet_type: batman-adv packet type, part of the general header
470 * @version: batman-adv protocol version, part of the genereal header
471 * @ttl: time to live for this packet, part of the genereal header
472 * @reserved: reserved byte for alignment
473 * @seqno: sequence identification
474 * @orig: originator of the broadcast packet
475 */
Sven Eckelmann96412692012-06-05 22:31:30 +0200476struct batadv_bcast_packet {
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200477 u8 packet_type;
478 u8 version; /* batman version field */
479 u8 ttl;
480 u8 reserved;
481 __be32 seqno;
482 u8 orig[ETH_ALEN];
Sven Eckelmannf6c57a42012-11-05 21:25:26 +0100483 /* "4 bytes boundary + 2 bytes" long to make the payload after the
484 * following ethernet header again 4 bytes boundary aligned
485 */
Sven Eckelmanne022b952012-11-05 21:25:27 +0100486};
487
Martin Hundebøll3c12de92013-01-25 11:12:41 +0100488/**
489 * struct batadv_coded_packet - network coded packet
Simon Wunderlicha40d9b02013-12-02 20:38:31 +0100490 * @packet_type: batman-adv packet type, part of the general header
491 * @version: batman-adv protocol version, part of the genereal header
492 * @ttl: time to live for this packet, part of the genereal header
Martin Hundebøll3c12de92013-01-25 11:12:41 +0100493 * @first_source: original source of first included packet
494 * @first_orig_dest: original destinal of first included packet
495 * @first_crc: checksum of first included packet
496 * @first_ttvn: tt-version number of first included packet
497 * @second_ttl: ttl of second packet
498 * @second_dest: second receiver of this coded packet
499 * @second_source: original source of second included packet
500 * @second_orig_dest: original destination of second included packet
501 * @second_crc: checksum of second included packet
502 * @second_ttvn: tt version number of second included packet
503 * @coded_len: length of network coded part of the payload
504 */
505struct batadv_coded_packet {
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200506 u8 packet_type;
507 u8 version; /* batman version field */
508 u8 ttl;
509 u8 first_ttvn;
510 /* u8 first_dest[ETH_ALEN]; - saved in mac header destination */
511 u8 first_source[ETH_ALEN];
512 u8 first_orig_dest[ETH_ALEN];
513 __be32 first_crc;
514 u8 second_ttl;
515 u8 second_ttvn;
516 u8 second_dest[ETH_ALEN];
517 u8 second_source[ETH_ALEN];
518 u8 second_orig_dest[ETH_ALEN];
519 __be32 second_crc;
520 __be16 coded_len;
Martin Hundebøll3c12de92013-01-25 11:12:41 +0100521};
522
Simon Wunderlich46b76e02013-12-02 20:38:30 +0100523#pragma pack()
524
Marek Lindneref261572013-04-23 21:39:57 +0800525/**
Antonio Quartulli6d030de2016-03-11 16:36:19 +0100526 * struct batadv_unicast_tvlv_packet - generic unicast packet with tvlv payload
Simon Wunderlicha40d9b02013-12-02 20:38:31 +0100527 * @packet_type: batman-adv packet type, part of the general header
528 * @version: batman-adv protocol version, part of the genereal header
529 * @ttl: time to live for this packet, part of the genereal header
Marek Lindneref261572013-04-23 21:39:57 +0800530 * @reserved: reserved field (for packet alignment)
531 * @src: address of the source
532 * @dst: address of the destination
533 * @tvlv_len: length of tvlv data following the unicast tvlv header
Antonio Quartulli3f687852014-11-02 11:29:56 +0100534 * @align: 2 bytes to align the header to a 4 byte boundary
Marek Lindneref261572013-04-23 21:39:57 +0800535 */
536struct batadv_unicast_tvlv_packet {
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200537 u8 packet_type;
538 u8 version; /* batman version field */
539 u8 ttl;
540 u8 reserved;
541 u8 dst[ETH_ALEN];
542 u8 src[ETH_ALEN];
543 __be16 tvlv_len;
544 u16 align;
Marek Lindneref261572013-04-23 21:39:57 +0800545};
546
547/**
548 * struct batadv_tvlv_hdr - base tvlv header struct
549 * @type: tvlv container type (see batadv_tvlv_type)
550 * @version: tvlv container version
551 * @len: tvlv container length
552 */
553struct batadv_tvlv_hdr {
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200554 u8 type;
555 u8 version;
556 __be16 len;
Marek Lindneref261572013-04-23 21:39:57 +0800557};
558
Marek Lindner414254e2013-04-23 21:39:58 +0800559/**
560 * struct batadv_tvlv_gateway_data - gateway data propagated through gw tvlv
561 * container
562 * @bandwidth_down: advertised uplink download bandwidth
563 * @bandwidth_up: advertised uplink upload bandwidth
564 */
565struct batadv_tvlv_gateway_data {
566 __be32 bandwidth_down;
567 __be32 bandwidth_up;
568};
569
Marek Lindnere1bf0c12013-04-23 21:40:01 +0800570/**
571 * struct batadv_tvlv_tt_data - tt data propagated through the tt tvlv container
572 * @flags: translation table flags (see batadv_tt_data_flags)
573 * @ttvn: translation table version number
Sven Eckelmanne51f0392015-09-06 21:38:51 +0200574 * @num_vlan: number of announced VLANs. In the TVLV this struct is followed by
Antonio Quartulli7ea7b4a2013-07-30 22:16:25 +0200575 * one batadv_tvlv_tt_vlan_data object per announced vlan
Marek Lindnere1bf0c12013-04-23 21:40:01 +0800576 */
577struct batadv_tvlv_tt_data {
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200578 u8 flags;
579 u8 ttvn;
580 __be16 num_vlan;
Antonio Quartulli7ea7b4a2013-07-30 22:16:25 +0200581};
582
583/**
584 * struct batadv_tvlv_tt_vlan_data - vlan specific tt data propagated through
585 * the tt tvlv container
586 * @crc: crc32 checksum of the entries belonging to this vlan
587 * @vid: vlan identifier
588 * @reserved: unused, useful for alignment purposes
589 */
590struct batadv_tvlv_tt_vlan_data {
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200591 __be32 crc;
592 __be16 vid;
593 u16 reserved;
Marek Lindnere1bf0c12013-04-23 21:40:01 +0800594};
595
596/**
597 * struct batadv_tvlv_tt_change - translation table diff data
598 * @flags: status indicators concerning the non-mesh client (see
599 * batadv_tt_client_flags)
Antonio Quartullica663042013-12-15 13:26:55 +0100600 * @reserved: reserved field - useful for alignment purposes only
Marek Lindnere1bf0c12013-04-23 21:40:01 +0800601 * @addr: mac address of non-mesh client that triggered this tt change
Antonio Quartullic018ad32013-06-04 12:11:39 +0200602 * @vid: VLAN identifier
Marek Lindnere1bf0c12013-04-23 21:40:01 +0800603 */
604struct batadv_tvlv_tt_change {
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200605 u8 flags;
606 u8 reserved[3];
607 u8 addr[ETH_ALEN];
Antonio Quartullic018ad32013-06-04 12:11:39 +0200608 __be16 vid;
Marek Lindnere1bf0c12013-04-23 21:40:01 +0800609};
610
Marek Lindner122edaa2013-04-23 21:40:03 +0800611/**
612 * struct batadv_tvlv_roam_adv - roaming advertisement
613 * @client: mac address of roaming client
Antonio Quartullic018ad32013-06-04 12:11:39 +0200614 * @vid: VLAN identifier
Marek Lindner122edaa2013-04-23 21:40:03 +0800615 */
616struct batadv_tvlv_roam_adv {
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200617 u8 client[ETH_ALEN];
Antonio Quartullic018ad32013-06-04 12:11:39 +0200618 __be16 vid;
Marek Lindner122edaa2013-04-23 21:40:03 +0800619};
620
Linus Lüssing60432d72014-02-15 17:47:51 +0100621/**
622 * struct batadv_tvlv_mcast_data - payload of a multicast tvlv
623 * @flags: multicast flags announced by the orig node
624 * @reserved: reserved field
625 */
626struct batadv_tvlv_mcast_data {
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200627 u8 flags;
628 u8 reserved[3];
Linus Lüssing60432d72014-02-15 17:47:51 +0100629};
630
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000631#endif /* _NET_BATMAN_ADV_PACKET_H_ */