blob: 6b011ff64dd8ea829be740011fdfe2dcaa378eb3 [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/**
132 * enum batadv_tt_client_flags - TT client specific flags
133 * @BATADV_TT_CLIENT_DEL: the client has to be deleted from the table
134 * @BATADV_TT_CLIENT_ROAM: the client roamed to/from another node and the new
135 * update telling its new real location has not been received/sent yet
136 * @BATADV_TT_CLIENT_WIFI: this client is connected through a wifi interface.
137 * This information is used by the "AP Isolation" feature
138 * @BATADV_TT_CLIENT_ISOLA: this client is considered "isolated". This
139 * information is used by the Extended Isolation feature
140 * @BATADV_TT_CLIENT_NOPURGE: this client should never be removed from the table
141 * @BATADV_TT_CLIENT_NEW: this client has been added to the local table but has
142 * not been announced yet
143 * @BATADV_TT_CLIENT_PENDING: this client is marked for removal but it is kept
144 * in the table for one more originator interval for consistency purposes
145 * @BATADV_TT_CLIENT_TEMP: this global client has been detected to be part of
146 * the network but no nnode has already announced it
147 *
148 * Bits from 0 to 7 are called _remote flags_ because they are sent on the wire.
149 * Bits from 8 to 15 are called _local flags_ because they are used for local
150 * computations only.
151 *
152 * Bits from 4 to 7 - a subset of remote flags - are ensured to be in sync with
153 * the other nodes in the network. To achieve this goal these flags are included
154 * in the TT CRC computation.
Sven Eckelmann9cfc7bd2012-05-12 02:09:43 +0200155 */
Sven Eckelmannacd34af2012-06-03 22:19:21 +0200156enum batadv_tt_client_flags {
Sven Eckelmann8de47de2012-07-08 16:32:09 +0200157 BATADV_TT_CLIENT_DEL = BIT(0),
158 BATADV_TT_CLIENT_ROAM = BIT(1),
Antonio Quartulli0eb015682013-10-13 02:50:20 +0200159 BATADV_TT_CLIENT_WIFI = BIT(4),
Antonio Quartulli9464d072013-11-16 12:03:48 +0100160 BATADV_TT_CLIENT_ISOLA = BIT(5),
Sven Eckelmann8de47de2012-07-08 16:32:09 +0200161 BATADV_TT_CLIENT_NOPURGE = BIT(8),
162 BATADV_TT_CLIENT_NEW = BIT(9),
163 BATADV_TT_CLIENT_PENDING = BIT(10),
Antonio Quartulli0035f972013-04-24 16:37:52 +0200164 BATADV_TT_CLIENT_TEMP = BIT(11),
Antonio Quartullia73105b2011-04-27 14:27:44 +0200165};
166
Antonio Quartullic018ad32013-06-04 12:11:39 +0200167/**
Sven Eckelmann6f68b002015-09-06 21:38:49 +0200168 * enum batadv_vlan_flags - flags for the four MSB of any vlan ID field
Antonio Quartullic018ad32013-06-04 12:11:39 +0200169 * @BATADV_VLAN_HAS_TAG: whether the field contains a valid vlan tag or not
170 */
171enum batadv_vlan_flags {
172 BATADV_VLAN_HAS_TAG = BIT(15),
173};
174
Simon Wunderlich23721382012-01-22 20:00:19 +0100175/* claim frame types for the bridge loop avoidance */
Sven Eckelmannacd34af2012-06-03 22:19:21 +0200176enum batadv_bla_claimframe {
Simon Wunderlich3eb87732012-06-23 12:34:18 +0200177 BATADV_CLAIM_TYPE_CLAIM = 0x00,
178 BATADV_CLAIM_TYPE_UNCLAIM = 0x01,
Sven Eckelmannacd34af2012-06-03 22:19:21 +0200179 BATADV_CLAIM_TYPE_ANNOUNCE = 0x02,
180 BATADV_CLAIM_TYPE_REQUEST = 0x03,
Simon Wunderlichcd9c7bf2016-03-12 10:49:33 +0100181 BATADV_CLAIM_TYPE_LOOPDETECT = 0x04,
Simon Wunderlich23721382012-01-22 20:00:19 +0100182};
183
Marek Lindner414254e2013-04-23 21:39:58 +0800184/**
185 * enum batadv_tvlv_type - tvlv type definitions
186 * @BATADV_TVLV_GW: gateway tvlv
Marek Lindner17cf0ea2013-04-23 21:39:59 +0800187 * @BATADV_TVLV_DAT: distributed arp table tvlv
Marek Lindner3f4841f2013-04-23 21:40:00 +0800188 * @BATADV_TVLV_NC: network coding tvlv
Marek Lindnere1bf0c12013-04-23 21:40:01 +0800189 * @BATADV_TVLV_TT: translation table tvlv
Marek Lindner122edaa2013-04-23 21:40:03 +0800190 * @BATADV_TVLV_ROAM: roaming advertisement tvlv
Linus Lüssing60432d72014-02-15 17:47:51 +0100191 * @BATADV_TVLV_MCAST: multicast capability tvlv
Marek Lindner414254e2013-04-23 21:39:58 +0800192 */
193enum batadv_tvlv_type {
194 BATADV_TVLV_GW = 0x01,
Marek Lindner17cf0ea2013-04-23 21:39:59 +0800195 BATADV_TVLV_DAT = 0x02,
Marek Lindner3f4841f2013-04-23 21:40:00 +0800196 BATADV_TVLV_NC = 0x03,
Marek Lindnere1bf0c12013-04-23 21:40:01 +0800197 BATADV_TVLV_TT = 0x04,
Marek Lindner122edaa2013-04-23 21:40:03 +0800198 BATADV_TVLV_ROAM = 0x05,
Linus Lüssing60432d72014-02-15 17:47:51 +0100199 BATADV_TVLV_MCAST = 0x06,
Marek Lindner414254e2013-04-23 21:39:58 +0800200};
201
Simon Wunderlich2f7a3182013-12-02 20:38:33 +0100202#pragma pack(2)
Simon Wunderlich23721382012-01-22 20:00:19 +0100203/* the destination hardware field in the ARP frame is used to
204 * transport the claim type and the group id
205 */
Sven Eckelmann96412692012-06-05 22:31:30 +0200206struct batadv_bla_claim_dst {
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200207 u8 magic[3]; /* FF:43:05 */
208 u8 type; /* bla_claimframe */
Al Viro3e2f1a12012-04-22 07:47:50 +0100209 __be16 group; /* group id */
Sven Eckelmannf6c57a42012-11-05 21:25:26 +0100210};
Antonio Quartulliaa143d22014-09-01 14:37:27 +0200211
Simon Wunderlich2f7a3182013-12-02 20:38:33 +0100212#pragma pack()
Simon Wunderlich23721382012-01-22 20:00:19 +0100213
Marek Lindneref261572013-04-23 21:39:57 +0800214/**
215 * struct batadv_ogm_packet - ogm (routing protocol) packet
Simon Wunderlicha40d9b02013-12-02 20:38:31 +0100216 * @packet_type: batman-adv packet type, part of the general header
217 * @version: batman-adv protocol version, part of the genereal header
218 * @ttl: time to live for this packet, part of the genereal header
Simon Wunderlich18c68d52013-04-25 10:37:25 +0200219 * @flags: contains routing relevant flags - see enum batadv_iv_flags
Sven Eckelmann7afcbbe2015-10-31 12:29:29 +0100220 * @seqno: sequence identification
221 * @orig: address of the source node
222 * @prev_sender: address of the previous sender
223 * @reserved: reserved byte for alignment
224 * @tq: transmission quality
Marek Lindneref261572013-04-23 21:39:57 +0800225 * @tvlv_len: length of tvlv data following the ogm header
226 */
Sven Eckelmann96412692012-06-05 22:31:30 +0200227struct batadv_ogm_packet {
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200228 u8 packet_type;
229 u8 version;
230 u8 ttl;
231 u8 flags;
232 __be32 seqno;
233 u8 orig[ETH_ALEN];
234 u8 prev_sender[ETH_ALEN];
235 u8 reserved;
236 u8 tq;
237 __be16 tvlv_len;
Simon Wunderlich9284a472013-04-25 10:37:24 +0200238 /* __packed is not needed as the struct size is divisible by 4,
239 * and the largest data type in this struct has a size of 4.
240 */
241};
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000242
Sven Eckelmann96412692012-06-05 22:31:30 +0200243#define BATADV_OGM_HLEN sizeof(struct batadv_ogm_packet)
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000244
Antonio Quartulli0bf84c12013-05-18 14:56:57 +0200245/**
Antonio Quartulli0da00352016-01-16 16:40:12 +0800246 * struct batadv_ogm2_packet - ogm2 (routing protocol) packet
247 * @packet_type: batman-adv packet type, part of the general header
248 * @version: batman-adv protocol version, part of the general header
249 * @ttl: time to live for this packet, part of the general header
250 * @flags: reseved for routing relevant flags - currently always 0
251 * @seqno: sequence number
252 * @orig: originator mac address
253 * @tvlv_len: length of the appended tvlv buffer (in bytes)
254 * @throughput: the currently flooded path throughput
255 */
256struct batadv_ogm2_packet {
257 u8 packet_type;
258 u8 version;
259 u8 ttl;
260 u8 flags;
261 __be32 seqno;
262 u8 orig[ETH_ALEN];
263 __be16 tvlv_len;
264 __be32 throughput;
265 /* __packed is not needed as the struct size is divisible by 4,
266 * and the largest data type in this struct has a size of 4.
267 */
268};
269
270#define BATADV_OGM2_HLEN sizeof(struct batadv_ogm2_packet)
271
272/**
Linus Luessingd6f94d92016-01-16 16:40:09 +0800273 * struct batadv_elp_packet - elp (neighbor discovery) packet
274 * @packet_type: batman-adv packet type, part of the general header
275 * @version: batman-adv protocol version, part of the genereal header
276 * @orig: originator mac address
277 * @seqno: sequence number
278 * @elp_interval: currently used ELP sending interval in ms
279 */
280struct batadv_elp_packet {
281 u8 packet_type;
282 u8 version;
283 u8 orig[ETH_ALEN];
284 __be32 seqno;
285 __be32 elp_interval;
286};
287
288#define BATADV_ELP_HLEN sizeof(struct batadv_elp_packet)
289
290/**
Antonio Quartulli33a3bb42016-05-05 13:09:43 +0200291 * enum batadv_icmp_user_cmd_type - types for batman-adv icmp cmd modes
292 * @BATADV_TP_START: start a throughput meter run
293 * @BATADV_TP_STOP: stop a throughput meter run
294 */
295enum batadv_icmp_user_cmd_type {
296 BATADV_TP_START = 0,
297 BATADV_TP_STOP = 2,
298};
299
300/**
Sven Eckelmann6f68b002015-09-06 21:38:49 +0200301 * struct batadv_icmp_header - common members among all the ICMP packets
Simon Wunderlicha40d9b02013-12-02 20:38:31 +0100302 * @packet_type: batman-adv packet type, part of the general header
303 * @version: batman-adv protocol version, part of the genereal header
304 * @ttl: time to live for this packet, part of the genereal header
Antonio Quartulli0bf84c12013-05-18 14:56:57 +0200305 * @msg_type: ICMP packet type
306 * @dst: address of the destination node
307 * @orig: address of the source node
308 * @uid: local ICMP socket identifier
Antonio Quartulli27a417e2013-12-05 15:33:00 +0100309 * @align: not used - useful for alignment purposes only
310 *
311 * This structure is used for ICMP packets parsing only and it is never sent
312 * over the wire. The alignment field at the end is there to ensure that
313 * members are padded the same way as they are in real packets.
Antonio Quartulli0bf84c12013-05-18 14:56:57 +0200314 */
315struct batadv_icmp_header {
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200316 u8 packet_type;
317 u8 version;
318 u8 ttl;
319 u8 msg_type; /* see ICMP message types above */
320 u8 dst[ETH_ALEN];
321 u8 orig[ETH_ALEN];
322 u8 uid;
323 u8 align[3];
Antonio Quartulli0bf84c12013-05-18 14:56:57 +0200324};
325
326/**
Sven Eckelmann6f68b002015-09-06 21:38:49 +0200327 * struct batadv_icmp_packet - ICMP packet
Antonio Quartulli27a417e2013-12-05 15:33:00 +0100328 * @packet_type: batman-adv packet type, part of the general header
329 * @version: batman-adv protocol version, part of the genereal header
330 * @ttl: time to live for this packet, part of the genereal header
331 * @msg_type: ICMP packet type
332 * @dst: address of the destination node
333 * @orig: address of the source node
334 * @uid: local ICMP socket identifier
Antonio Quartulli0bf84c12013-05-18 14:56:57 +0200335 * @reserved: not used - useful for alignment
336 * @seqno: ICMP sequence number
337 */
338struct batadv_icmp_packet {
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200339 u8 packet_type;
340 u8 version;
341 u8 ttl;
342 u8 msg_type; /* see ICMP message types above */
343 u8 dst[ETH_ALEN];
344 u8 orig[ETH_ALEN];
345 u8 uid;
346 u8 reserved;
347 __be16 seqno;
Sven Eckelmannf6c57a42012-11-05 21:25:26 +0100348};
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000349
Antonio Quartulli33a3bb42016-05-05 13:09:43 +0200350/**
351 * struct batadv_icmp_tp_packet - ICMP TP Meter packet
352 * @packet_type: batman-adv packet type, part of the general header
353 * @version: batman-adv protocol version, part of the genereal header
354 * @ttl: time to live for this packet, part of the genereal header
355 * @msg_type: ICMP packet type
356 * @dst: address of the destination node
357 * @orig: address of the source node
358 * @uid: local ICMP socket identifier
359 * @subtype: TP packet subtype (see batadv_icmp_tp_subtype)
360 * @session: TP session identifier
361 * @seqno: the TP sequence number
362 * @timestamp: time when the packet has been sent. This value is filled in a
363 * TP_MSG and echoed back in the next TP_ACK so that the sender can compute the
364 * RTT. Since it is read only by the host which wrote it, there is no need to
365 * store it using network order
366 */
367struct batadv_icmp_tp_packet {
368 u8 packet_type;
369 u8 version;
370 u8 ttl;
371 u8 msg_type; /* see ICMP message types above */
372 u8 dst[ETH_ALEN];
373 u8 orig[ETH_ALEN];
374 u8 uid;
375 u8 subtype;
376 u8 session[2];
377 __be32 seqno;
378 __be32 timestamp;
379};
380
381/**
382 * enum batadv_icmp_tp_subtype - ICMP TP Meter packet subtypes
383 * @BATADV_TP_MSG: Msg from sender to receiver
384 * @BATADV_TP_ACK: acknowledgment from receiver to sender
385 */
386enum batadv_icmp_tp_subtype {
387 BATADV_TP_MSG = 0,
388 BATADV_TP_ACK,
389};
390
Sven Eckelmann7e071c72012-06-03 22:19:13 +0200391#define BATADV_RR_LEN 16
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000392
Antonio Quartulli0bf84c12013-05-18 14:56:57 +0200393/**
Sven Eckelmann6f68b002015-09-06 21:38:49 +0200394 * struct batadv_icmp_packet_rr - ICMP RouteRecord packet
Antonio Quartulli27a417e2013-12-05 15:33:00 +0100395 * @packet_type: batman-adv packet type, part of the general header
396 * @version: batman-adv protocol version, part of the genereal header
397 * @ttl: time to live for this packet, part of the genereal header
398 * @msg_type: ICMP packet type
399 * @dst: address of the destination node
400 * @orig: address of the source node
401 * @uid: local ICMP socket identifier
Antonio Quartulli0bf84c12013-05-18 14:56:57 +0200402 * @rr_cur: number of entries the rr array
403 * @seqno: ICMP sequence number
404 * @rr: route record array
Sven Eckelmann9cfc7bd2012-05-12 02:09:43 +0200405 */
Sven Eckelmann96412692012-06-05 22:31:30 +0200406struct batadv_icmp_packet_rr {
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200407 u8 packet_type;
408 u8 version;
409 u8 ttl;
410 u8 msg_type; /* see ICMP message types above */
411 u8 dst[ETH_ALEN];
412 u8 orig[ETH_ALEN];
413 u8 uid;
414 u8 rr_cur;
415 __be16 seqno;
416 u8 rr[BATADV_RR_LEN][ETH_ALEN];
Sven Eckelmannf6c57a42012-11-05 21:25:26 +0100417};
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000418
Simon Wunderlichda6b8c22013-10-22 22:50:09 +0200419#define BATADV_ICMP_MAX_PACKET_SIZE sizeof(struct batadv_icmp_packet_rr)
420
Sven Eckelmanne022b952012-11-05 21:25:27 +0100421/* All packet headers in front of an ethernet header have to be completely
422 * divisible by 2 but not by 4 to make the payload after the ethernet
423 * header again 4 bytes boundary aligned.
424 *
425 * A packing of 2 is necessary to avoid extra padding at the end of the struct
426 * caused by a structure member which is larger than two bytes. Otherwise
427 * the structure would not fulfill the previously mentioned rule to avoid the
428 * misalignment of the payload after the ethernet header. It may also lead to
429 * leakage of information when the padding it not initialized before sending.
430 */
431#pragma pack(2)
432
Simon Wunderlicha40d9b02013-12-02 20:38:31 +0100433/**
434 * struct batadv_unicast_packet - unicast packet for network payload
435 * @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
438 * @ttvn: translation table version number
439 * @dest: originator destination of the unicast packet
440 */
Sven Eckelmann96412692012-06-05 22:31:30 +0200441struct batadv_unicast_packet {
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200442 u8 packet_type;
443 u8 version;
444 u8 ttl;
445 u8 ttvn; /* destination translation table version number */
446 u8 dest[ETH_ALEN];
Sven Eckelmannf6c57a42012-11-05 21:25:26 +0100447 /* "4 bytes boundary + 2 bytes" long to make the payload after the
448 * following ethernet header again 4 bytes boundary aligned
449 */
450};
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000451
Antonio Quartulli7cdcf6d2012-10-01 09:57:35 +0200452/**
453 * struct batadv_unicast_4addr_packet - extended unicast packet
454 * @u: common unicast packet header
455 * @src: address of the source
456 * @subtype: packet subtype
Sven Eckelmann7afcbbe2015-10-31 12:29:29 +0100457 * @reserved: reserved byte for alignment
Antonio Quartulli7cdcf6d2012-10-01 09:57:35 +0200458 */
459struct batadv_unicast_4addr_packet {
460 struct batadv_unicast_packet u;
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200461 u8 src[ETH_ALEN];
462 u8 subtype;
463 u8 reserved;
Antonio Quartulli7cdcf6d2012-10-01 09:57:35 +0200464 /* "4 bytes boundary + 2 bytes" long to make the payload after the
465 * following ethernet header again 4 bytes boundary aligned
466 */
467};
468
Martin Hundebøll610bfc6bc2013-05-23 16:53:02 +0200469/**
470 * struct batadv_frag_packet - fragmented packet
Simon Wunderlicha40d9b02013-12-02 20:38:31 +0100471 * @packet_type: batman-adv packet type, part of the general header
472 * @version: batman-adv protocol version, part of the genereal header
473 * @ttl: time to live for this packet, part of the genereal header
Martin Hundebøll610bfc6bc2013-05-23 16:53:02 +0200474 * @dest: final destination used when routing fragments
475 * @orig: originator of the fragment used when merging the packet
476 * @no: fragment number within this sequence
Andrew Lunnc0f25c82016-05-09 20:03:36 +0200477 * @priority: priority of frame, from ToS IP precedence or 802.1p
Martin Hundebøll610bfc6bc2013-05-23 16:53:02 +0200478 * @reserved: reserved byte for alignment
479 * @seqno: sequence identification
480 * @total_size: size of the merged packet
481 */
482struct batadv_frag_packet {
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200483 u8 packet_type;
484 u8 version; /* batman version field */
485 u8 ttl;
Martin Hundebøll610bfc6bc2013-05-23 16:53:02 +0200486#if defined(__BIG_ENDIAN_BITFIELD)
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200487 u8 no:4;
Andrew Lunnc0f25c82016-05-09 20:03:36 +0200488 u8 priority:3;
489 u8 reserved:1;
Martin Hundebøll610bfc6bc2013-05-23 16:53:02 +0200490#elif defined(__LITTLE_ENDIAN_BITFIELD)
Andrew Lunnc0f25c82016-05-09 20:03:36 +0200491 u8 reserved:1;
492 u8 priority:3;
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200493 u8 no:4;
Martin Hundebøll610bfc6bc2013-05-23 16:53:02 +0200494#else
Antonio Quartulli3f687852014-11-02 11:29:56 +0100495#error "unknown bitfield endianness"
Martin Hundebøll610bfc6bc2013-05-23 16:53:02 +0200496#endif
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200497 u8 dest[ETH_ALEN];
498 u8 orig[ETH_ALEN];
499 __be16 seqno;
500 __be16 total_size;
Martin Hundebøll610bfc6bc2013-05-23 16:53:02 +0200501};
502
Simon Wunderlicha40d9b02013-12-02 20:38:31 +0100503/**
504 * struct batadv_bcast_packet - broadcast packet for network payload
505 * @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
508 * @reserved: reserved byte for alignment
509 * @seqno: sequence identification
510 * @orig: originator of the broadcast packet
511 */
Sven Eckelmann96412692012-06-05 22:31:30 +0200512struct batadv_bcast_packet {
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200513 u8 packet_type;
514 u8 version; /* batman version field */
515 u8 ttl;
516 u8 reserved;
517 __be32 seqno;
518 u8 orig[ETH_ALEN];
Sven Eckelmannf6c57a42012-11-05 21:25:26 +0100519 /* "4 bytes boundary + 2 bytes" long to make the payload after the
520 * following ethernet header again 4 bytes boundary aligned
521 */
Sven Eckelmanne022b952012-11-05 21:25:27 +0100522};
523
Martin Hundebøll3c12de92013-01-25 11:12:41 +0100524/**
525 * struct batadv_coded_packet - network coded packet
Simon Wunderlicha40d9b02013-12-02 20:38:31 +0100526 * @packet_type: batman-adv packet type, part of the general header
527 * @version: batman-adv protocol version, part of the genereal header
528 * @ttl: time to live for this packet, part of the genereal header
Martin Hundebøll3c12de92013-01-25 11:12:41 +0100529 * @first_source: original source of first included packet
530 * @first_orig_dest: original destinal of first included packet
531 * @first_crc: checksum of first included packet
532 * @first_ttvn: tt-version number of first included packet
533 * @second_ttl: ttl of second packet
534 * @second_dest: second receiver of this coded packet
535 * @second_source: original source of second included packet
536 * @second_orig_dest: original destination of second included packet
537 * @second_crc: checksum of second included packet
538 * @second_ttvn: tt version number of second included packet
539 * @coded_len: length of network coded part of the payload
540 */
541struct batadv_coded_packet {
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200542 u8 packet_type;
543 u8 version; /* batman version field */
544 u8 ttl;
545 u8 first_ttvn;
546 /* u8 first_dest[ETH_ALEN]; - saved in mac header destination */
547 u8 first_source[ETH_ALEN];
548 u8 first_orig_dest[ETH_ALEN];
549 __be32 first_crc;
550 u8 second_ttl;
551 u8 second_ttvn;
552 u8 second_dest[ETH_ALEN];
553 u8 second_source[ETH_ALEN];
554 u8 second_orig_dest[ETH_ALEN];
555 __be32 second_crc;
556 __be16 coded_len;
Martin Hundebøll3c12de92013-01-25 11:12:41 +0100557};
558
Simon Wunderlich46b76e02013-12-02 20:38:30 +0100559#pragma pack()
560
Marek Lindneref261572013-04-23 21:39:57 +0800561/**
Antonio Quartulli6d030de2016-03-11 16:36:19 +0100562 * struct batadv_unicast_tvlv_packet - generic unicast packet with tvlv payload
Simon Wunderlicha40d9b02013-12-02 20:38:31 +0100563 * @packet_type: batman-adv packet type, part of the general header
564 * @version: batman-adv protocol version, part of the genereal header
565 * @ttl: time to live for this packet, part of the genereal header
Marek Lindneref261572013-04-23 21:39:57 +0800566 * @reserved: reserved field (for packet alignment)
567 * @src: address of the source
568 * @dst: address of the destination
569 * @tvlv_len: length of tvlv data following the unicast tvlv header
Antonio Quartulli3f687852014-11-02 11:29:56 +0100570 * @align: 2 bytes to align the header to a 4 byte boundary
Marek Lindneref261572013-04-23 21:39:57 +0800571 */
572struct batadv_unicast_tvlv_packet {
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200573 u8 packet_type;
574 u8 version; /* batman version field */
575 u8 ttl;
576 u8 reserved;
577 u8 dst[ETH_ALEN];
578 u8 src[ETH_ALEN];
579 __be16 tvlv_len;
580 u16 align;
Marek Lindneref261572013-04-23 21:39:57 +0800581};
582
583/**
584 * struct batadv_tvlv_hdr - base tvlv header struct
585 * @type: tvlv container type (see batadv_tvlv_type)
586 * @version: tvlv container version
587 * @len: tvlv container length
588 */
589struct batadv_tvlv_hdr {
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200590 u8 type;
591 u8 version;
592 __be16 len;
Marek Lindneref261572013-04-23 21:39:57 +0800593};
594
Marek Lindner414254e2013-04-23 21:39:58 +0800595/**
596 * struct batadv_tvlv_gateway_data - gateway data propagated through gw tvlv
597 * container
598 * @bandwidth_down: advertised uplink download bandwidth
599 * @bandwidth_up: advertised uplink upload bandwidth
600 */
601struct batadv_tvlv_gateway_data {
602 __be32 bandwidth_down;
603 __be32 bandwidth_up;
604};
605
Marek Lindnere1bf0c12013-04-23 21:40:01 +0800606/**
607 * struct batadv_tvlv_tt_data - tt data propagated through the tt tvlv container
608 * @flags: translation table flags (see batadv_tt_data_flags)
609 * @ttvn: translation table version number
Sven Eckelmanne51f0392015-09-06 21:38:51 +0200610 * @num_vlan: number of announced VLANs. In the TVLV this struct is followed by
Antonio Quartulli7ea7b4a2013-07-30 22:16:25 +0200611 * one batadv_tvlv_tt_vlan_data object per announced vlan
Marek Lindnere1bf0c12013-04-23 21:40:01 +0800612 */
613struct batadv_tvlv_tt_data {
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200614 u8 flags;
615 u8 ttvn;
616 __be16 num_vlan;
Antonio Quartulli7ea7b4a2013-07-30 22:16:25 +0200617};
618
619/**
620 * struct batadv_tvlv_tt_vlan_data - vlan specific tt data propagated through
621 * the tt tvlv container
622 * @crc: crc32 checksum of the entries belonging to this vlan
623 * @vid: vlan identifier
624 * @reserved: unused, useful for alignment purposes
625 */
626struct batadv_tvlv_tt_vlan_data {
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200627 __be32 crc;
628 __be16 vid;
629 u16 reserved;
Marek Lindnere1bf0c12013-04-23 21:40:01 +0800630};
631
632/**
633 * struct batadv_tvlv_tt_change - translation table diff data
634 * @flags: status indicators concerning the non-mesh client (see
635 * batadv_tt_client_flags)
Antonio Quartullica663042013-12-15 13:26:55 +0100636 * @reserved: reserved field - useful for alignment purposes only
Marek Lindnere1bf0c12013-04-23 21:40:01 +0800637 * @addr: mac address of non-mesh client that triggered this tt change
Antonio Quartullic018ad32013-06-04 12:11:39 +0200638 * @vid: VLAN identifier
Marek Lindnere1bf0c12013-04-23 21:40:01 +0800639 */
640struct batadv_tvlv_tt_change {
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200641 u8 flags;
642 u8 reserved[3];
643 u8 addr[ETH_ALEN];
Antonio Quartullic018ad32013-06-04 12:11:39 +0200644 __be16 vid;
Marek Lindnere1bf0c12013-04-23 21:40:01 +0800645};
646
Marek Lindner122edaa2013-04-23 21:40:03 +0800647/**
648 * struct batadv_tvlv_roam_adv - roaming advertisement
649 * @client: mac address of roaming client
Antonio Quartullic018ad32013-06-04 12:11:39 +0200650 * @vid: VLAN identifier
Marek Lindner122edaa2013-04-23 21:40:03 +0800651 */
652struct batadv_tvlv_roam_adv {
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200653 u8 client[ETH_ALEN];
Antonio Quartullic018ad32013-06-04 12:11:39 +0200654 __be16 vid;
Marek Lindner122edaa2013-04-23 21:40:03 +0800655};
656
Linus Lüssing60432d72014-02-15 17:47:51 +0100657/**
658 * struct batadv_tvlv_mcast_data - payload of a multicast tvlv
659 * @flags: multicast flags announced by the orig node
660 * @reserved: reserved field
661 */
662struct batadv_tvlv_mcast_data {
Sven Eckelmann6b5e9712015-05-26 18:34:26 +0200663 u8 flags;
664 u8 reserved[3];
Linus Lüssing60432d72014-02-15 17:47:51 +0100665};
666
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000667#endif /* _NET_BATMAN_ADV_PACKET_H_ */