blob: 9e747c08d0bccb994307a5e40500050a6d281b88 [file] [log] [blame]
Sven Eckelmann9f6446c2015-04-23 13:16:35 +02001/* Copyright (C) 2007-2015 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
29 *
30 * @BATADV_UNICAST: unicast packets carrying unicast payload traffic
31 * @BATADV_UNICAST_FRAG: unicast packets carrying a fragment of the original
32 * payload packet
33 * @BATADV_UNICAST_4ADDR: unicast packet including the originator address of
34 * the sender
35 * @BATADV_ICMP: unicast packet like IP ICMP used for ping or traceroute
Marek Lindneref261572013-04-23 21:39:57 +080036 * @BATADV_UNICAST_TVLV: unicast packet carrying TVLV containers
37 */
Sven Eckelmannacd34af2012-06-03 22:19:21 +020038enum batadv_packettype {
Simon Wunderlicha1f1ac52013-04-25 10:37:23 +020039 /* 0x00 - 0x3f: local packets or special rules for handling */
40 BATADV_IV_OGM = 0x00,
41 BATADV_BCAST = 0x01,
42 BATADV_CODED = 0x02,
43 /* 0x40 - 0x7f: unicast */
44#define BATADV_UNICAST_MIN 0x40
45 BATADV_UNICAST = 0x40,
46 BATADV_UNICAST_FRAG = 0x41,
47 BATADV_UNICAST_4ADDR = 0x42,
48 BATADV_ICMP = 0x43,
49 BATADV_UNICAST_TVLV = 0x44,
50#define BATADV_UNICAST_MAX 0x7f
51 /* 0x80 - 0xff: reserved */
Antonio Quartulli7cdcf6d2012-10-01 09:57:35 +020052};
53
54/**
55 * enum batadv_subtype - packet subtype for unicast4addr
56 * @BATADV_P_DATA: user payload
Antonio Quartulli5c3a0e52011-06-02 12:29:51 +020057 * @BATADV_P_DAT_DHT_GET: DHT request message
58 * @BATADV_P_DAT_DHT_PUT: DHT store message
59 * @BATADV_P_DAT_CACHE_REPLY: ARP reply generated by DAT
Antonio Quartulli7cdcf6d2012-10-01 09:57:35 +020060 */
61enum batadv_subtype {
Antonio Quartulli5c3a0e52011-06-02 12:29:51 +020062 BATADV_P_DATA = 0x01,
63 BATADV_P_DAT_DHT_GET = 0x02,
64 BATADV_P_DAT_DHT_PUT = 0x03,
65 BATADV_P_DAT_CACHE_REPLY = 0x04,
Sven Eckelmanne8958db2011-06-04 11:26:00 +020066};
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +000067
68/* this file is included by batctl which needs these defines */
Antonio Quartulli60cf7982013-04-20 15:59:13 +020069#define BATADV_COMPAT_VERSION 15
Sven Eckelmanne8958db2011-06-04 11:26:00 +020070
Simon Wunderlich18c68d52013-04-25 10:37:25 +020071/**
72 * enum batadv_iv_flags - flags used in B.A.T.M.A.N. IV OGM packets
73 * @BATADV_NOT_BEST_NEXT_HOP: flag is set when ogm packet is forwarded and was
74 * previously received from someone else than the best neighbor.
75 * @BATADV_PRIMARIES_FIRST_HOP: flag is set when the primary interface address
76 * is used, and the packet travels its first hop.
77 * @BATADV_DIRECTLINK: flag is for the first hop or if rebroadcasted from a
78 * one hop neighbor on the interface where it was originally received.
79 */
Sven Eckelmannacd34af2012-06-03 22:19:21 +020080enum batadv_iv_flags {
Simon Wunderlich18c68d52013-04-25 10:37:25 +020081 BATADV_NOT_BEST_NEXT_HOP = BIT(0),
82 BATADV_PRIMARIES_FIRST_HOP = BIT(1),
83 BATADV_DIRECTLINK = BIT(2),
Sven Eckelmanne8958db2011-06-04 11:26:00 +020084};
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +000085
86/* ICMP message types */
Sven Eckelmannacd34af2012-06-03 22:19:21 +020087enum batadv_icmp_packettype {
88 BATADV_ECHO_REPLY = 0,
89 BATADV_DESTINATION_UNREACHABLE = 3,
90 BATADV_ECHO_REQUEST = 8,
91 BATADV_TTL_EXCEEDED = 11,
92 BATADV_PARAMETER_PROBLEM = 12,
Sven Eckelmanne8958db2011-06-04 11:26:00 +020093};
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +000094
Linus Lüssingab498862014-02-15 17:47:53 +010095/**
96 * enum batadv_mcast_flags - flags for multicast capabilities and settings
97 * @BATADV_MCAST_WANT_ALL_UNSNOOPABLES: we want all packets destined for
98 * 224.0.0.0/24 or ff02::1
Linus Lüssing4c8755d2014-02-15 17:47:54 +010099 * @BATADV_MCAST_WANT_ALL_IPV4: we want all IPv4 multicast packets
100 * @BATADV_MCAST_WANT_ALL_IPV6: we want all IPv6 multicast packets
Linus Lüssingab498862014-02-15 17:47:53 +0100101 */
102enum batadv_mcast_flags {
103 BATADV_MCAST_WANT_ALL_UNSNOOPABLES = BIT(0),
Linus Lüssing4c8755d2014-02-15 17:47:54 +0100104 BATADV_MCAST_WANT_ALL_IPV4 = BIT(1),
105 BATADV_MCAST_WANT_ALL_IPV6 = BIT(2),
Linus Lüssingab498862014-02-15 17:47:53 +0100106};
107
Marek Lindnere1bf0c12013-04-23 21:40:01 +0800108/* tt data subtypes */
109#define BATADV_TT_DATA_TYPE_MASK 0x0F
Antonio Quartullia73105b2011-04-27 14:27:44 +0200110
Marek Lindnere1bf0c12013-04-23 21:40:01 +0800111/**
112 * enum batadv_tt_data_flags - flags for tt data tvlv
113 * @BATADV_TT_OGM_DIFF: TT diff propagated through OGM
114 * @BATADV_TT_REQUEST: TT request message
115 * @BATADV_TT_RESPONSE: TT response message
116 * @BATADV_TT_FULL_TABLE: contains full table to replace existing table
117 */
118enum batadv_tt_data_flags {
119 BATADV_TT_OGM_DIFF = BIT(0),
120 BATADV_TT_REQUEST = BIT(1),
121 BATADV_TT_RESPONSE = BIT(2),
122 BATADV_TT_FULL_TABLE = BIT(4),
Antonio Quartullia73105b2011-04-27 14:27:44 +0200123};
124
Antonio Quartulli43e6f652014-02-22 16:48:14 +0100125/**
126 * enum batadv_tt_client_flags - TT client specific flags
127 * @BATADV_TT_CLIENT_DEL: the client has to be deleted from the table
128 * @BATADV_TT_CLIENT_ROAM: the client roamed to/from another node and the new
129 * update telling its new real location has not been received/sent yet
130 * @BATADV_TT_CLIENT_WIFI: this client is connected through a wifi interface.
131 * This information is used by the "AP Isolation" feature
132 * @BATADV_TT_CLIENT_ISOLA: this client is considered "isolated". This
133 * information is used by the Extended Isolation feature
134 * @BATADV_TT_CLIENT_NOPURGE: this client should never be removed from the table
135 * @BATADV_TT_CLIENT_NEW: this client has been added to the local table but has
136 * not been announced yet
137 * @BATADV_TT_CLIENT_PENDING: this client is marked for removal but it is kept
138 * in the table for one more originator interval for consistency purposes
139 * @BATADV_TT_CLIENT_TEMP: this global client has been detected to be part of
140 * the network but no nnode has already announced it
141 *
142 * Bits from 0 to 7 are called _remote flags_ because they are sent on the wire.
143 * Bits from 8 to 15 are called _local flags_ because they are used for local
144 * computations only.
145 *
146 * Bits from 4 to 7 - a subset of remote flags - are ensured to be in sync with
147 * the other nodes in the network. To achieve this goal these flags are included
148 * in the TT CRC computation.
Sven Eckelmann9cfc7bd2012-05-12 02:09:43 +0200149 */
Sven Eckelmannacd34af2012-06-03 22:19:21 +0200150enum batadv_tt_client_flags {
Sven Eckelmann8de47de2012-07-08 16:32:09 +0200151 BATADV_TT_CLIENT_DEL = BIT(0),
152 BATADV_TT_CLIENT_ROAM = BIT(1),
Antonio Quartulli0eb015682013-10-13 02:50:20 +0200153 BATADV_TT_CLIENT_WIFI = BIT(4),
Antonio Quartulli9464d072013-11-16 12:03:48 +0100154 BATADV_TT_CLIENT_ISOLA = BIT(5),
Sven Eckelmann8de47de2012-07-08 16:32:09 +0200155 BATADV_TT_CLIENT_NOPURGE = BIT(8),
156 BATADV_TT_CLIENT_NEW = BIT(9),
157 BATADV_TT_CLIENT_PENDING = BIT(10),
Antonio Quartulli0035f972013-04-24 16:37:52 +0200158 BATADV_TT_CLIENT_TEMP = BIT(11),
Antonio Quartullia73105b2011-04-27 14:27:44 +0200159};
160
Antonio Quartullic018ad32013-06-04 12:11:39 +0200161/**
162 * batadv_vlan_flags - flags for the four MSB of any vlan ID field
163 * @BATADV_VLAN_HAS_TAG: whether the field contains a valid vlan tag or not
164 */
165enum batadv_vlan_flags {
166 BATADV_VLAN_HAS_TAG = BIT(15),
167};
168
Simon Wunderlich23721382012-01-22 20:00:19 +0100169/* claim frame types for the bridge loop avoidance */
Sven Eckelmannacd34af2012-06-03 22:19:21 +0200170enum batadv_bla_claimframe {
Simon Wunderlich3eb87732012-06-23 12:34:18 +0200171 BATADV_CLAIM_TYPE_CLAIM = 0x00,
172 BATADV_CLAIM_TYPE_UNCLAIM = 0x01,
Sven Eckelmannacd34af2012-06-03 22:19:21 +0200173 BATADV_CLAIM_TYPE_ANNOUNCE = 0x02,
174 BATADV_CLAIM_TYPE_REQUEST = 0x03,
Simon Wunderlich23721382012-01-22 20:00:19 +0100175};
176
Marek Lindner414254e2013-04-23 21:39:58 +0800177/**
178 * enum batadv_tvlv_type - tvlv type definitions
179 * @BATADV_TVLV_GW: gateway tvlv
Marek Lindner17cf0ea2013-04-23 21:39:59 +0800180 * @BATADV_TVLV_DAT: distributed arp table tvlv
Marek Lindner3f4841f2013-04-23 21:40:00 +0800181 * @BATADV_TVLV_NC: network coding tvlv
Marek Lindnere1bf0c12013-04-23 21:40:01 +0800182 * @BATADV_TVLV_TT: translation table tvlv
Marek Lindner122edaa2013-04-23 21:40:03 +0800183 * @BATADV_TVLV_ROAM: roaming advertisement tvlv
Linus Lüssing60432d72014-02-15 17:47:51 +0100184 * @BATADV_TVLV_MCAST: multicast capability tvlv
Marek Lindner414254e2013-04-23 21:39:58 +0800185 */
186enum batadv_tvlv_type {
187 BATADV_TVLV_GW = 0x01,
Marek Lindner17cf0ea2013-04-23 21:39:59 +0800188 BATADV_TVLV_DAT = 0x02,
Marek Lindner3f4841f2013-04-23 21:40:00 +0800189 BATADV_TVLV_NC = 0x03,
Marek Lindnere1bf0c12013-04-23 21:40:01 +0800190 BATADV_TVLV_TT = 0x04,
Marek Lindner122edaa2013-04-23 21:40:03 +0800191 BATADV_TVLV_ROAM = 0x05,
Linus Lüssing60432d72014-02-15 17:47:51 +0100192 BATADV_TVLV_MCAST = 0x06,
Marek Lindner414254e2013-04-23 21:39:58 +0800193};
194
Simon Wunderlich2f7a3182013-12-02 20:38:33 +0100195#pragma pack(2)
Simon Wunderlich23721382012-01-22 20:00:19 +0100196/* the destination hardware field in the ARP frame is used to
197 * transport the claim type and the group id
198 */
Sven Eckelmann96412692012-06-05 22:31:30 +0200199struct batadv_bla_claim_dst {
Simon Wunderlich23721382012-01-22 20:00:19 +0100200 uint8_t magic[3]; /* FF:43:05 */
201 uint8_t type; /* bla_claimframe */
Al Viro3e2f1a12012-04-22 07:47:50 +0100202 __be16 group; /* group id */
Sven Eckelmannf6c57a42012-11-05 21:25:26 +0100203};
Antonio Quartulliaa143d22014-09-01 14:37:27 +0200204
Simon Wunderlich2f7a3182013-12-02 20:38:33 +0100205#pragma pack()
Simon Wunderlich23721382012-01-22 20:00:19 +0100206
Marek Lindneref261572013-04-23 21:39:57 +0800207/**
208 * struct batadv_ogm_packet - ogm (routing protocol) packet
Simon Wunderlicha40d9b02013-12-02 20:38:31 +0100209 * @packet_type: batman-adv packet type, part of the general header
210 * @version: batman-adv protocol version, part of the genereal header
211 * @ttl: time to live for this packet, part of the genereal header
Simon Wunderlich18c68d52013-04-25 10:37:25 +0200212 * @flags: contains routing relevant flags - see enum batadv_iv_flags
Marek Lindneref261572013-04-23 21:39:57 +0800213 * @tvlv_len: length of tvlv data following the ogm header
214 */
Sven Eckelmann96412692012-06-05 22:31:30 +0200215struct batadv_ogm_packet {
Simon Wunderlicha40d9b02013-12-02 20:38:31 +0100216 uint8_t packet_type;
217 uint8_t version;
218 uint8_t ttl;
Simon Wunderlich18c68d52013-04-25 10:37:25 +0200219 uint8_t flags;
Al Viroe0f52112012-04-22 07:46:29 +0100220 __be32 seqno;
Antonio Quartullic1faead2012-01-30 20:59:17 +0100221 uint8_t orig[ETH_ALEN];
222 uint8_t prev_sender[ETH_ALEN];
Marek Lindner414254e2013-04-23 21:39:58 +0800223 uint8_t reserved;
Antonio Quartulli3b27ffb2011-05-28 14:51:06 +0200224 uint8_t tq;
Marek Lindneref261572013-04-23 21:39:57 +0800225 __be16 tvlv_len;
Simon Wunderlich9284a472013-04-25 10:37:24 +0200226 /* __packed is not needed as the struct size is divisible by 4,
227 * and the largest data type in this struct has a size of 4.
228 */
229};
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000230
Sven Eckelmann96412692012-06-05 22:31:30 +0200231#define BATADV_OGM_HLEN sizeof(struct batadv_ogm_packet)
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000232
Antonio Quartulli0bf84c12013-05-18 14:56:57 +0200233/**
Antonio Quartulli27a417e2013-12-05 15:33:00 +0100234 * batadv_icmp_header - common members among all the ICMP packets
Simon Wunderlicha40d9b02013-12-02 20:38:31 +0100235 * @packet_type: batman-adv packet type, part of the general header
236 * @version: batman-adv protocol version, part of the genereal header
237 * @ttl: time to live for this packet, part of the genereal header
Antonio Quartulli0bf84c12013-05-18 14:56:57 +0200238 * @msg_type: ICMP packet type
239 * @dst: address of the destination node
240 * @orig: address of the source node
241 * @uid: local ICMP socket identifier
Antonio Quartulli27a417e2013-12-05 15:33:00 +0100242 * @align: not used - useful for alignment purposes only
243 *
244 * This structure is used for ICMP packets parsing only and it is never sent
245 * over the wire. The alignment field at the end is there to ensure that
246 * members are padded the same way as they are in real packets.
Antonio Quartulli0bf84c12013-05-18 14:56:57 +0200247 */
248struct batadv_icmp_header {
Simon Wunderlicha40d9b02013-12-02 20:38:31 +0100249 uint8_t packet_type;
250 uint8_t version;
251 uint8_t ttl;
Antonio Quartulli3b27ffb2011-05-28 14:51:06 +0200252 uint8_t msg_type; /* see ICMP message types above */
Antonio Quartullic1faead2012-01-30 20:59:17 +0100253 uint8_t dst[ETH_ALEN];
254 uint8_t orig[ETH_ALEN];
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000255 uint8_t uid;
Antonio Quartulli27a417e2013-12-05 15:33:00 +0100256 uint8_t align[3];
Antonio Quartulli0bf84c12013-05-18 14:56:57 +0200257};
258
259/**
260 * batadv_icmp_packet - ICMP packet
Antonio Quartulli27a417e2013-12-05 15:33:00 +0100261 * @packet_type: batman-adv packet type, part of the general header
262 * @version: batman-adv protocol version, part of the genereal header
263 * @ttl: time to live for this packet, part of the genereal header
264 * @msg_type: ICMP packet type
265 * @dst: address of the destination node
266 * @orig: address of the source node
267 * @uid: local ICMP socket identifier
Antonio Quartulli0bf84c12013-05-18 14:56:57 +0200268 * @reserved: not used - useful for alignment
269 * @seqno: ICMP sequence number
270 */
271struct batadv_icmp_packet {
Antonio Quartulli27a417e2013-12-05 15:33:00 +0100272 uint8_t packet_type;
273 uint8_t version;
274 uint8_t ttl;
275 uint8_t msg_type; /* see ICMP message types above */
276 uint8_t dst[ETH_ALEN];
277 uint8_t orig[ETH_ALEN];
278 uint8_t uid;
Antonio Quartulli3b27ffb2011-05-28 14:51:06 +0200279 uint8_t reserved;
Antonio Quartulli0bf84c12013-05-18 14:56:57 +0200280 __be16 seqno;
Sven Eckelmannf6c57a42012-11-05 21:25:26 +0100281};
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000282
Sven Eckelmann7e071c72012-06-03 22:19:13 +0200283#define BATADV_RR_LEN 16
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000284
Antonio Quartulli0bf84c12013-05-18 14:56:57 +0200285/**
286 * batadv_icmp_packet_rr - ICMP RouteRecord packet
Antonio Quartulli27a417e2013-12-05 15:33:00 +0100287 * @packet_type: batman-adv packet type, part of the general header
288 * @version: batman-adv protocol version, part of the genereal header
289 * @ttl: time to live for this packet, part of the genereal header
290 * @msg_type: ICMP packet type
291 * @dst: address of the destination node
292 * @orig: address of the source node
293 * @uid: local ICMP socket identifier
Antonio Quartulli0bf84c12013-05-18 14:56:57 +0200294 * @rr_cur: number of entries the rr array
295 * @seqno: ICMP sequence number
296 * @rr: route record array
Sven Eckelmann9cfc7bd2012-05-12 02:09:43 +0200297 */
Sven Eckelmann96412692012-06-05 22:31:30 +0200298struct batadv_icmp_packet_rr {
Antonio Quartulli27a417e2013-12-05 15:33:00 +0100299 uint8_t packet_type;
300 uint8_t version;
301 uint8_t ttl;
302 uint8_t msg_type; /* see ICMP message types above */
303 uint8_t dst[ETH_ALEN];
304 uint8_t orig[ETH_ALEN];
305 uint8_t uid;
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000306 uint8_t rr_cur;
Antonio Quartulli0bf84c12013-05-18 14:56:57 +0200307 __be16 seqno;
Sven Eckelmann7e071c72012-06-03 22:19:13 +0200308 uint8_t rr[BATADV_RR_LEN][ETH_ALEN];
Sven Eckelmannf6c57a42012-11-05 21:25:26 +0100309};
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000310
Simon Wunderlichda6b8c22013-10-22 22:50:09 +0200311#define BATADV_ICMP_MAX_PACKET_SIZE sizeof(struct batadv_icmp_packet_rr)
312
Sven Eckelmanne022b952012-11-05 21:25:27 +0100313/* All packet headers in front of an ethernet header have to be completely
314 * divisible by 2 but not by 4 to make the payload after the ethernet
315 * header again 4 bytes boundary aligned.
316 *
317 * A packing of 2 is necessary to avoid extra padding at the end of the struct
318 * caused by a structure member which is larger than two bytes. Otherwise
319 * the structure would not fulfill the previously mentioned rule to avoid the
320 * misalignment of the payload after the ethernet header. It may also lead to
321 * leakage of information when the padding it not initialized before sending.
322 */
323#pragma pack(2)
324
Simon Wunderlicha40d9b02013-12-02 20:38:31 +0100325/**
326 * struct batadv_unicast_packet - unicast packet for network payload
327 * @packet_type: batman-adv packet type, part of the general header
328 * @version: batman-adv protocol version, part of the genereal header
329 * @ttl: time to live for this packet, part of the genereal header
330 * @ttvn: translation table version number
331 * @dest: originator destination of the unicast packet
332 */
Sven Eckelmann96412692012-06-05 22:31:30 +0200333struct batadv_unicast_packet {
Simon Wunderlicha40d9b02013-12-02 20:38:31 +0100334 uint8_t packet_type;
335 uint8_t version;
336 uint8_t ttl;
Antonio Quartullia73105b2011-04-27 14:27:44 +0200337 uint8_t ttvn; /* destination translation table version number */
Antonio Quartullic1faead2012-01-30 20:59:17 +0100338 uint8_t dest[ETH_ALEN];
Sven Eckelmannf6c57a42012-11-05 21:25:26 +0100339 /* "4 bytes boundary + 2 bytes" long to make the payload after the
340 * following ethernet header again 4 bytes boundary aligned
341 */
342};
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000343
Antonio Quartulli7cdcf6d2012-10-01 09:57:35 +0200344/**
345 * struct batadv_unicast_4addr_packet - extended unicast packet
346 * @u: common unicast packet header
347 * @src: address of the source
348 * @subtype: packet subtype
349 */
350struct batadv_unicast_4addr_packet {
351 struct batadv_unicast_packet u;
352 uint8_t src[ETH_ALEN];
353 uint8_t subtype;
354 uint8_t reserved;
355 /* "4 bytes boundary + 2 bytes" long to make the payload after the
356 * following ethernet header again 4 bytes boundary aligned
357 */
358};
359
Martin Hundebøll610bfc6bc2013-05-23 16:53:02 +0200360/**
361 * struct batadv_frag_packet - fragmented packet
Simon Wunderlicha40d9b02013-12-02 20:38:31 +0100362 * @packet_type: batman-adv packet type, part of the general header
363 * @version: batman-adv protocol version, part of the genereal header
364 * @ttl: time to live for this packet, part of the genereal header
Martin Hundebøll610bfc6bc2013-05-23 16:53:02 +0200365 * @dest: final destination used when routing fragments
366 * @orig: originator of the fragment used when merging the packet
367 * @no: fragment number within this sequence
368 * @reserved: reserved byte for alignment
369 * @seqno: sequence identification
370 * @total_size: size of the merged packet
371 */
372struct batadv_frag_packet {
Simon Wunderlicha40d9b02013-12-02 20:38:31 +0100373 uint8_t packet_type;
374 uint8_t version; /* batman version field */
375 uint8_t ttl;
Martin Hundebøll610bfc6bc2013-05-23 16:53:02 +0200376#if defined(__BIG_ENDIAN_BITFIELD)
377 uint8_t no:4;
378 uint8_t reserved:4;
379#elif defined(__LITTLE_ENDIAN_BITFIELD)
380 uint8_t reserved:4;
381 uint8_t no:4;
382#else
Antonio Quartulli3f687852014-11-02 11:29:56 +0100383#error "unknown bitfield endianness"
Martin Hundebøll610bfc6bc2013-05-23 16:53:02 +0200384#endif
385 uint8_t dest[ETH_ALEN];
386 uint8_t orig[ETH_ALEN];
387 __be16 seqno;
388 __be16 total_size;
389};
390
Simon Wunderlicha40d9b02013-12-02 20:38:31 +0100391/**
392 * struct batadv_bcast_packet - broadcast packet for network payload
393 * @packet_type: batman-adv packet type, part of the general header
394 * @version: batman-adv protocol version, part of the genereal header
395 * @ttl: time to live for this packet, part of the genereal header
396 * @reserved: reserved byte for alignment
397 * @seqno: sequence identification
398 * @orig: originator of the broadcast packet
399 */
Sven Eckelmann96412692012-06-05 22:31:30 +0200400struct batadv_bcast_packet {
Simon Wunderlicha40d9b02013-12-02 20:38:31 +0100401 uint8_t packet_type;
402 uint8_t version; /* batman version field */
403 uint8_t ttl;
Antonio Quartulli3b27ffb2011-05-28 14:51:06 +0200404 uint8_t reserved;
Al Viro3e2f1a12012-04-22 07:47:50 +0100405 __be32 seqno;
Antonio Quartullic1faead2012-01-30 20:59:17 +0100406 uint8_t orig[ETH_ALEN];
Sven Eckelmannf6c57a42012-11-05 21:25:26 +0100407 /* "4 bytes boundary + 2 bytes" long to make the payload after the
408 * following ethernet header again 4 bytes boundary aligned
409 */
Sven Eckelmanne022b952012-11-05 21:25:27 +0100410};
411
Martin Hundebøll3c12de92013-01-25 11:12:41 +0100412/**
413 * struct batadv_coded_packet - network coded packet
Simon Wunderlicha40d9b02013-12-02 20:38:31 +0100414 * @packet_type: batman-adv packet type, part of the general header
415 * @version: batman-adv protocol version, part of the genereal header
416 * @ttl: time to live for this packet, part of the genereal header
Martin Hundebøll3c12de92013-01-25 11:12:41 +0100417 * @reserved: Align following fields to 2-byte boundaries
418 * @first_source: original source of first included packet
419 * @first_orig_dest: original destinal of first included packet
420 * @first_crc: checksum of first included packet
421 * @first_ttvn: tt-version number of first included packet
422 * @second_ttl: ttl of second packet
423 * @second_dest: second receiver of this coded packet
424 * @second_source: original source of second included packet
425 * @second_orig_dest: original destination of second included packet
426 * @second_crc: checksum of second included packet
427 * @second_ttvn: tt version number of second included packet
428 * @coded_len: length of network coded part of the payload
429 */
430struct batadv_coded_packet {
Simon Wunderlicha40d9b02013-12-02 20:38:31 +0100431 uint8_t packet_type;
432 uint8_t version; /* batman version field */
433 uint8_t ttl;
Martin Hundebøll3c12de92013-01-25 11:12:41 +0100434 uint8_t first_ttvn;
435 /* uint8_t first_dest[ETH_ALEN]; - saved in mac header destination */
436 uint8_t first_source[ETH_ALEN];
437 uint8_t first_orig_dest[ETH_ALEN];
438 __be32 first_crc;
439 uint8_t second_ttl;
440 uint8_t second_ttvn;
441 uint8_t second_dest[ETH_ALEN];
442 uint8_t second_source[ETH_ALEN];
443 uint8_t second_orig_dest[ETH_ALEN];
444 __be32 second_crc;
Martin Hundebølle6a0b492013-03-14 21:30:21 +0100445 __be16 coded_len;
Martin Hundebøll3c12de92013-01-25 11:12:41 +0100446};
447
Simon Wunderlich46b76e02013-12-02 20:38:30 +0100448#pragma pack()
449
Marek Lindneref261572013-04-23 21:39:57 +0800450/**
451 * struct batadv_unicast_tvlv - generic unicast packet with tvlv payload
Simon Wunderlicha40d9b02013-12-02 20:38:31 +0100452 * @packet_type: batman-adv packet type, part of the general header
453 * @version: batman-adv protocol version, part of the genereal header
454 * @ttl: time to live for this packet, part of the genereal header
Marek Lindneref261572013-04-23 21:39:57 +0800455 * @reserved: reserved field (for packet alignment)
456 * @src: address of the source
457 * @dst: address of the destination
458 * @tvlv_len: length of tvlv data following the unicast tvlv header
Antonio Quartulli3f687852014-11-02 11:29:56 +0100459 * @align: 2 bytes to align the header to a 4 byte boundary
Marek Lindneref261572013-04-23 21:39:57 +0800460 */
461struct batadv_unicast_tvlv_packet {
Simon Wunderlicha40d9b02013-12-02 20:38:31 +0100462 uint8_t packet_type;
463 uint8_t version; /* batman version field */
464 uint8_t ttl;
Marek Lindneref261572013-04-23 21:39:57 +0800465 uint8_t reserved;
466 uint8_t dst[ETH_ALEN];
467 uint8_t src[ETH_ALEN];
468 __be16 tvlv_len;
469 uint16_t align;
470};
471
472/**
473 * struct batadv_tvlv_hdr - base tvlv header struct
474 * @type: tvlv container type (see batadv_tvlv_type)
475 * @version: tvlv container version
476 * @len: tvlv container length
477 */
478struct batadv_tvlv_hdr {
479 uint8_t type;
480 uint8_t version;
481 __be16 len;
482};
483
Marek Lindner414254e2013-04-23 21:39:58 +0800484/**
485 * struct batadv_tvlv_gateway_data - gateway data propagated through gw tvlv
486 * container
487 * @bandwidth_down: advertised uplink download bandwidth
488 * @bandwidth_up: advertised uplink upload bandwidth
489 */
490struct batadv_tvlv_gateway_data {
491 __be32 bandwidth_down;
492 __be32 bandwidth_up;
493};
494
Marek Lindnere1bf0c12013-04-23 21:40:01 +0800495/**
496 * struct batadv_tvlv_tt_data - tt data propagated through the tt tvlv container
497 * @flags: translation table flags (see batadv_tt_data_flags)
498 * @ttvn: translation table version number
Antonio Quartulli7ea7b4a2013-07-30 22:16:25 +0200499 * @vlan_num: number of announced VLANs. In the TVLV this struct is followed by
500 * one batadv_tvlv_tt_vlan_data object per announced vlan
Marek Lindnere1bf0c12013-04-23 21:40:01 +0800501 */
502struct batadv_tvlv_tt_data {
503 uint8_t flags;
504 uint8_t ttvn;
Antonio Quartulli7ea7b4a2013-07-30 22:16:25 +0200505 __be16 num_vlan;
506};
507
508/**
509 * struct batadv_tvlv_tt_vlan_data - vlan specific tt data propagated through
510 * the tt tvlv container
511 * @crc: crc32 checksum of the entries belonging to this vlan
512 * @vid: vlan identifier
513 * @reserved: unused, useful for alignment purposes
514 */
515struct batadv_tvlv_tt_vlan_data {
516 __be32 crc;
517 __be16 vid;
Antonio Quartulliced72932013-04-24 16:37:51 +0200518 uint16_t reserved;
Marek Lindnere1bf0c12013-04-23 21:40:01 +0800519};
520
521/**
522 * struct batadv_tvlv_tt_change - translation table diff data
523 * @flags: status indicators concerning the non-mesh client (see
524 * batadv_tt_client_flags)
Antonio Quartullica663042013-12-15 13:26:55 +0100525 * @reserved: reserved field - useful for alignment purposes only
Marek Lindnere1bf0c12013-04-23 21:40:01 +0800526 * @addr: mac address of non-mesh client that triggered this tt change
Antonio Quartullic018ad32013-06-04 12:11:39 +0200527 * @vid: VLAN identifier
Marek Lindnere1bf0c12013-04-23 21:40:01 +0800528 */
529struct batadv_tvlv_tt_change {
530 uint8_t flags;
Antonio Quartullica663042013-12-15 13:26:55 +0100531 uint8_t reserved[3];
Marek Lindnere1bf0c12013-04-23 21:40:01 +0800532 uint8_t addr[ETH_ALEN];
Antonio Quartullic018ad32013-06-04 12:11:39 +0200533 __be16 vid;
Marek Lindnere1bf0c12013-04-23 21:40:01 +0800534};
535
Marek Lindner122edaa2013-04-23 21:40:03 +0800536/**
537 * struct batadv_tvlv_roam_adv - roaming advertisement
538 * @client: mac address of roaming client
Antonio Quartullic018ad32013-06-04 12:11:39 +0200539 * @vid: VLAN identifier
Marek Lindner122edaa2013-04-23 21:40:03 +0800540 */
541struct batadv_tvlv_roam_adv {
542 uint8_t client[ETH_ALEN];
Antonio Quartullic018ad32013-06-04 12:11:39 +0200543 __be16 vid;
Marek Lindner122edaa2013-04-23 21:40:03 +0800544};
545
Linus Lüssing60432d72014-02-15 17:47:51 +0100546/**
547 * struct batadv_tvlv_mcast_data - payload of a multicast tvlv
548 * @flags: multicast flags announced by the orig node
549 * @reserved: reserved field
550 */
551struct batadv_tvlv_mcast_data {
552 uint8_t flags;
553 uint8_t reserved[3];
554};
555
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000556#endif /* _NET_BATMAN_ADV_PACKET_H_ */