blob: b81fbbf21a6393af841ababdb845ba6179d79ca1 [file] [log] [blame]
Simon Wunderliche19f9752014-01-04 18:04:25 +01001/* Copyright (C) 2007-2014 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
Marek Lindneref261572013-04-23 21:39:57 +080021/**
22 * enum batadv_packettype - types for batman-adv encapsulated packets
Simon Wunderlicha1f1ac52013-04-25 10:37:23 +020023 * @BATADV_IV_OGM: originator messages for B.A.T.M.A.N. IV
24 * @BATADV_BCAST: broadcast packets carrying broadcast payload
25 * @BATADV_CODED: network coded packets
26 *
27 * @BATADV_UNICAST: unicast packets carrying unicast payload traffic
28 * @BATADV_UNICAST_FRAG: unicast packets carrying a fragment of the original
29 * payload packet
30 * @BATADV_UNICAST_4ADDR: unicast packet including the originator address of
31 * the sender
32 * @BATADV_ICMP: unicast packet like IP ICMP used for ping or traceroute
Marek Lindneref261572013-04-23 21:39:57 +080033 * @BATADV_UNICAST_TVLV: unicast packet carrying TVLV containers
34 */
Sven Eckelmannacd34af2012-06-03 22:19:21 +020035enum batadv_packettype {
Simon Wunderlicha1f1ac52013-04-25 10:37:23 +020036 /* 0x00 - 0x3f: local packets or special rules for handling */
37 BATADV_IV_OGM = 0x00,
38 BATADV_BCAST = 0x01,
39 BATADV_CODED = 0x02,
40 /* 0x40 - 0x7f: unicast */
41#define BATADV_UNICAST_MIN 0x40
42 BATADV_UNICAST = 0x40,
43 BATADV_UNICAST_FRAG = 0x41,
44 BATADV_UNICAST_4ADDR = 0x42,
45 BATADV_ICMP = 0x43,
46 BATADV_UNICAST_TVLV = 0x44,
47#define BATADV_UNICAST_MAX 0x7f
48 /* 0x80 - 0xff: reserved */
Antonio Quartulli7cdcf6d2012-10-01 09:57:35 +020049};
50
51/**
52 * enum batadv_subtype - packet subtype for unicast4addr
53 * @BATADV_P_DATA: user payload
Antonio Quartulli5c3a0e52011-06-02 12:29:51 +020054 * @BATADV_P_DAT_DHT_GET: DHT request message
55 * @BATADV_P_DAT_DHT_PUT: DHT store message
56 * @BATADV_P_DAT_CACHE_REPLY: ARP reply generated by DAT
Antonio Quartulli7cdcf6d2012-10-01 09:57:35 +020057 */
58enum batadv_subtype {
Antonio Quartulli5c3a0e52011-06-02 12:29:51 +020059 BATADV_P_DATA = 0x01,
60 BATADV_P_DAT_DHT_GET = 0x02,
61 BATADV_P_DAT_DHT_PUT = 0x03,
62 BATADV_P_DAT_CACHE_REPLY = 0x04,
Sven Eckelmanne8958db2011-06-04 11:26:00 +020063};
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +000064
65/* this file is included by batctl which needs these defines */
Antonio Quartulli60cf7982013-04-20 15:59:13 +020066#define BATADV_COMPAT_VERSION 15
Sven Eckelmanne8958db2011-06-04 11:26:00 +020067
Simon Wunderlich18c68d52013-04-25 10:37:25 +020068/**
69 * enum batadv_iv_flags - flags used in B.A.T.M.A.N. IV OGM packets
70 * @BATADV_NOT_BEST_NEXT_HOP: flag is set when ogm packet is forwarded and was
71 * previously received from someone else than the best neighbor.
72 * @BATADV_PRIMARIES_FIRST_HOP: flag is set when the primary interface address
73 * is used, and the packet travels its first hop.
74 * @BATADV_DIRECTLINK: flag is for the first hop or if rebroadcasted from a
75 * one hop neighbor on the interface where it was originally received.
76 */
Sven Eckelmannacd34af2012-06-03 22:19:21 +020077enum batadv_iv_flags {
Simon Wunderlich18c68d52013-04-25 10:37:25 +020078 BATADV_NOT_BEST_NEXT_HOP = BIT(0),
79 BATADV_PRIMARIES_FIRST_HOP = BIT(1),
80 BATADV_DIRECTLINK = BIT(2),
Sven Eckelmanne8958db2011-06-04 11:26:00 +020081};
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +000082
83/* ICMP message types */
Sven Eckelmannacd34af2012-06-03 22:19:21 +020084enum batadv_icmp_packettype {
85 BATADV_ECHO_REPLY = 0,
86 BATADV_DESTINATION_UNREACHABLE = 3,
87 BATADV_ECHO_REQUEST = 8,
88 BATADV_TTL_EXCEEDED = 11,
89 BATADV_PARAMETER_PROBLEM = 12,
Sven Eckelmanne8958db2011-06-04 11:26:00 +020090};
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +000091
Linus Lüssingab498862014-02-15 17:47:53 +010092/**
93 * enum batadv_mcast_flags - flags for multicast capabilities and settings
94 * @BATADV_MCAST_WANT_ALL_UNSNOOPABLES: we want all packets destined for
95 * 224.0.0.0/24 or ff02::1
Linus Lüssing4c8755d2014-02-15 17:47:54 +010096 * @BATADV_MCAST_WANT_ALL_IPV4: we want all IPv4 multicast packets
97 * @BATADV_MCAST_WANT_ALL_IPV6: we want all IPv6 multicast packets
Linus Lüssingab498862014-02-15 17:47:53 +010098 */
99enum batadv_mcast_flags {
100 BATADV_MCAST_WANT_ALL_UNSNOOPABLES = BIT(0),
Linus Lüssing4c8755d2014-02-15 17:47:54 +0100101 BATADV_MCAST_WANT_ALL_IPV4 = BIT(1),
102 BATADV_MCAST_WANT_ALL_IPV6 = BIT(2),
Linus Lüssingab498862014-02-15 17:47:53 +0100103};
104
Marek Lindnere1bf0c12013-04-23 21:40:01 +0800105/* tt data subtypes */
106#define BATADV_TT_DATA_TYPE_MASK 0x0F
Antonio Quartullia73105b2011-04-27 14:27:44 +0200107
Marek Lindnere1bf0c12013-04-23 21:40:01 +0800108/**
109 * enum batadv_tt_data_flags - flags for tt data tvlv
110 * @BATADV_TT_OGM_DIFF: TT diff propagated through OGM
111 * @BATADV_TT_REQUEST: TT request message
112 * @BATADV_TT_RESPONSE: TT response message
113 * @BATADV_TT_FULL_TABLE: contains full table to replace existing table
114 */
115enum batadv_tt_data_flags {
116 BATADV_TT_OGM_DIFF = BIT(0),
117 BATADV_TT_REQUEST = BIT(1),
118 BATADV_TT_RESPONSE = BIT(2),
119 BATADV_TT_FULL_TABLE = BIT(4),
Antonio Quartullia73105b2011-04-27 14:27:44 +0200120};
121
Antonio Quartulli43e6f652014-02-22 16:48:14 +0100122/**
123 * enum batadv_tt_client_flags - TT client specific flags
124 * @BATADV_TT_CLIENT_DEL: the client has to be deleted from the table
125 * @BATADV_TT_CLIENT_ROAM: the client roamed to/from another node and the new
126 * update telling its new real location has not been received/sent yet
127 * @BATADV_TT_CLIENT_WIFI: this client is connected through a wifi interface.
128 * This information is used by the "AP Isolation" feature
129 * @BATADV_TT_CLIENT_ISOLA: this client is considered "isolated". This
130 * information is used by the Extended Isolation feature
131 * @BATADV_TT_CLIENT_NOPURGE: this client should never be removed from the table
132 * @BATADV_TT_CLIENT_NEW: this client has been added to the local table but has
133 * not been announced yet
134 * @BATADV_TT_CLIENT_PENDING: this client is marked for removal but it is kept
135 * in the table for one more originator interval for consistency purposes
136 * @BATADV_TT_CLIENT_TEMP: this global client has been detected to be part of
137 * the network but no nnode has already announced it
138 *
139 * Bits from 0 to 7 are called _remote flags_ because they are sent on the wire.
140 * Bits from 8 to 15 are called _local flags_ because they are used for local
141 * computations only.
142 *
143 * Bits from 4 to 7 - a subset of remote flags - are ensured to be in sync with
144 * the other nodes in the network. To achieve this goal these flags are included
145 * in the TT CRC computation.
Sven Eckelmann9cfc7bd2012-05-12 02:09:43 +0200146 */
Sven Eckelmannacd34af2012-06-03 22:19:21 +0200147enum batadv_tt_client_flags {
Sven Eckelmann8de47de2012-07-08 16:32:09 +0200148 BATADV_TT_CLIENT_DEL = BIT(0),
149 BATADV_TT_CLIENT_ROAM = BIT(1),
Antonio Quartulli0eb015682013-10-13 02:50:20 +0200150 BATADV_TT_CLIENT_WIFI = BIT(4),
Antonio Quartulli9464d072013-11-16 12:03:48 +0100151 BATADV_TT_CLIENT_ISOLA = BIT(5),
Sven Eckelmann8de47de2012-07-08 16:32:09 +0200152 BATADV_TT_CLIENT_NOPURGE = BIT(8),
153 BATADV_TT_CLIENT_NEW = BIT(9),
154 BATADV_TT_CLIENT_PENDING = BIT(10),
Antonio Quartulli0035f972013-04-24 16:37:52 +0200155 BATADV_TT_CLIENT_TEMP = BIT(11),
Antonio Quartullia73105b2011-04-27 14:27:44 +0200156};
157
Antonio Quartullic018ad32013-06-04 12:11:39 +0200158/**
159 * batadv_vlan_flags - flags for the four MSB of any vlan ID field
160 * @BATADV_VLAN_HAS_TAG: whether the field contains a valid vlan tag or not
161 */
162enum batadv_vlan_flags {
163 BATADV_VLAN_HAS_TAG = BIT(15),
164};
165
Simon Wunderlich23721382012-01-22 20:00:19 +0100166/* claim frame types for the bridge loop avoidance */
Sven Eckelmannacd34af2012-06-03 22:19:21 +0200167enum batadv_bla_claimframe {
Simon Wunderlich3eb87732012-06-23 12:34:18 +0200168 BATADV_CLAIM_TYPE_CLAIM = 0x00,
169 BATADV_CLAIM_TYPE_UNCLAIM = 0x01,
Sven Eckelmannacd34af2012-06-03 22:19:21 +0200170 BATADV_CLAIM_TYPE_ANNOUNCE = 0x02,
171 BATADV_CLAIM_TYPE_REQUEST = 0x03,
Simon Wunderlich23721382012-01-22 20:00:19 +0100172};
173
Marek Lindner414254e2013-04-23 21:39:58 +0800174/**
175 * enum batadv_tvlv_type - tvlv type definitions
176 * @BATADV_TVLV_GW: gateway tvlv
Marek Lindner17cf0ea2013-04-23 21:39:59 +0800177 * @BATADV_TVLV_DAT: distributed arp table tvlv
Marek Lindner3f4841f2013-04-23 21:40:00 +0800178 * @BATADV_TVLV_NC: network coding tvlv
Marek Lindnere1bf0c12013-04-23 21:40:01 +0800179 * @BATADV_TVLV_TT: translation table tvlv
Marek Lindner122edaa2013-04-23 21:40:03 +0800180 * @BATADV_TVLV_ROAM: roaming advertisement tvlv
Linus Lüssing60432d72014-02-15 17:47:51 +0100181 * @BATADV_TVLV_MCAST: multicast capability tvlv
Marek Lindner414254e2013-04-23 21:39:58 +0800182 */
183enum batadv_tvlv_type {
184 BATADV_TVLV_GW = 0x01,
Marek Lindner17cf0ea2013-04-23 21:39:59 +0800185 BATADV_TVLV_DAT = 0x02,
Marek Lindner3f4841f2013-04-23 21:40:00 +0800186 BATADV_TVLV_NC = 0x03,
Marek Lindnere1bf0c12013-04-23 21:40:01 +0800187 BATADV_TVLV_TT = 0x04,
Marek Lindner122edaa2013-04-23 21:40:03 +0800188 BATADV_TVLV_ROAM = 0x05,
Linus Lüssing60432d72014-02-15 17:47:51 +0100189 BATADV_TVLV_MCAST = 0x06,
Marek Lindner414254e2013-04-23 21:39:58 +0800190};
191
Simon Wunderlich2f7a3182013-12-02 20:38:33 +0100192#pragma pack(2)
Simon Wunderlich23721382012-01-22 20:00:19 +0100193/* the destination hardware field in the ARP frame is used to
194 * transport the claim type and the group id
195 */
Sven Eckelmann96412692012-06-05 22:31:30 +0200196struct batadv_bla_claim_dst {
Simon Wunderlich23721382012-01-22 20:00:19 +0100197 uint8_t magic[3]; /* FF:43:05 */
198 uint8_t type; /* bla_claimframe */
Al Viro3e2f1a12012-04-22 07:47:50 +0100199 __be16 group; /* group id */
Sven Eckelmannf6c57a42012-11-05 21:25:26 +0100200};
Antonio Quartulliaa143d22014-09-01 14:37:27 +0200201
Simon Wunderlich2f7a3182013-12-02 20:38:33 +0100202#pragma pack()
Simon Wunderlich23721382012-01-22 20:00:19 +0100203
Marek Lindneref261572013-04-23 21:39:57 +0800204/**
205 * struct batadv_ogm_packet - ogm (routing protocol) packet
Simon Wunderlicha40d9b02013-12-02 20:38:31 +0100206 * @packet_type: batman-adv packet type, part of the general header
207 * @version: batman-adv protocol version, part of the genereal header
208 * @ttl: time to live for this packet, part of the genereal header
Simon Wunderlich18c68d52013-04-25 10:37:25 +0200209 * @flags: contains routing relevant flags - see enum batadv_iv_flags
Marek Lindneref261572013-04-23 21:39:57 +0800210 * @tvlv_len: length of tvlv data following the ogm header
211 */
Sven Eckelmann96412692012-06-05 22:31:30 +0200212struct batadv_ogm_packet {
Simon Wunderlicha40d9b02013-12-02 20:38:31 +0100213 uint8_t packet_type;
214 uint8_t version;
215 uint8_t ttl;
Simon Wunderlich18c68d52013-04-25 10:37:25 +0200216 uint8_t flags;
Al Viroe0f52112012-04-22 07:46:29 +0100217 __be32 seqno;
Antonio Quartullic1faead2012-01-30 20:59:17 +0100218 uint8_t orig[ETH_ALEN];
219 uint8_t prev_sender[ETH_ALEN];
Marek Lindner414254e2013-04-23 21:39:58 +0800220 uint8_t reserved;
Antonio Quartulli3b27ffb2011-05-28 14:51:06 +0200221 uint8_t tq;
Marek Lindneref261572013-04-23 21:39:57 +0800222 __be16 tvlv_len;
Simon Wunderlich9284a472013-04-25 10:37:24 +0200223 /* __packed is not needed as the struct size is divisible by 4,
224 * and the largest data type in this struct has a size of 4.
225 */
226};
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000227
Sven Eckelmann96412692012-06-05 22:31:30 +0200228#define BATADV_OGM_HLEN sizeof(struct batadv_ogm_packet)
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000229
Antonio Quartulli0bf84c12013-05-18 14:56:57 +0200230/**
Antonio Quartulli27a417e2013-12-05 15:33:00 +0100231 * batadv_icmp_header - common members among all the ICMP packets
Simon Wunderlicha40d9b02013-12-02 20:38:31 +0100232 * @packet_type: batman-adv packet type, part of the general header
233 * @version: batman-adv protocol version, part of the genereal header
234 * @ttl: time to live for this packet, part of the genereal header
Antonio Quartulli0bf84c12013-05-18 14:56:57 +0200235 * @msg_type: ICMP packet type
236 * @dst: address of the destination node
237 * @orig: address of the source node
238 * @uid: local ICMP socket identifier
Antonio Quartulli27a417e2013-12-05 15:33:00 +0100239 * @align: not used - useful for alignment purposes only
240 *
241 * This structure is used for ICMP packets parsing only and it is never sent
242 * over the wire. The alignment field at the end is there to ensure that
243 * members are padded the same way as they are in real packets.
Antonio Quartulli0bf84c12013-05-18 14:56:57 +0200244 */
245struct batadv_icmp_header {
Simon Wunderlicha40d9b02013-12-02 20:38:31 +0100246 uint8_t packet_type;
247 uint8_t version;
248 uint8_t ttl;
Antonio Quartulli3b27ffb2011-05-28 14:51:06 +0200249 uint8_t msg_type; /* see ICMP message types above */
Antonio Quartullic1faead2012-01-30 20:59:17 +0100250 uint8_t dst[ETH_ALEN];
251 uint8_t orig[ETH_ALEN];
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000252 uint8_t uid;
Antonio Quartulli27a417e2013-12-05 15:33:00 +0100253 uint8_t align[3];
Antonio Quartulli0bf84c12013-05-18 14:56:57 +0200254};
255
256/**
257 * batadv_icmp_packet - ICMP packet
Antonio Quartulli27a417e2013-12-05 15:33:00 +0100258 * @packet_type: batman-adv packet type, part of the general header
259 * @version: batman-adv protocol version, part of the genereal header
260 * @ttl: time to live for this packet, part of the genereal header
261 * @msg_type: ICMP packet type
262 * @dst: address of the destination node
263 * @orig: address of the source node
264 * @uid: local ICMP socket identifier
Antonio Quartulli0bf84c12013-05-18 14:56:57 +0200265 * @reserved: not used - useful for alignment
266 * @seqno: ICMP sequence number
267 */
268struct batadv_icmp_packet {
Antonio Quartulli27a417e2013-12-05 15:33:00 +0100269 uint8_t packet_type;
270 uint8_t version;
271 uint8_t ttl;
272 uint8_t msg_type; /* see ICMP message types above */
273 uint8_t dst[ETH_ALEN];
274 uint8_t orig[ETH_ALEN];
275 uint8_t uid;
Antonio Quartulli3b27ffb2011-05-28 14:51:06 +0200276 uint8_t reserved;
Antonio Quartulli0bf84c12013-05-18 14:56:57 +0200277 __be16 seqno;
Sven Eckelmannf6c57a42012-11-05 21:25:26 +0100278};
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000279
Sven Eckelmann7e071c72012-06-03 22:19:13 +0200280#define BATADV_RR_LEN 16
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000281
Antonio Quartulli0bf84c12013-05-18 14:56:57 +0200282/**
283 * batadv_icmp_packet_rr - ICMP RouteRecord packet
Antonio Quartulli27a417e2013-12-05 15:33:00 +0100284 * @packet_type: batman-adv packet type, part of the general header
285 * @version: batman-adv protocol version, part of the genereal header
286 * @ttl: time to live for this packet, part of the genereal header
287 * @msg_type: ICMP packet type
288 * @dst: address of the destination node
289 * @orig: address of the source node
290 * @uid: local ICMP socket identifier
Antonio Quartulli0bf84c12013-05-18 14:56:57 +0200291 * @rr_cur: number of entries the rr array
292 * @seqno: ICMP sequence number
293 * @rr: route record array
Sven Eckelmann9cfc7bd2012-05-12 02:09:43 +0200294 */
Sven Eckelmann96412692012-06-05 22:31:30 +0200295struct batadv_icmp_packet_rr {
Antonio Quartulli27a417e2013-12-05 15:33:00 +0100296 uint8_t packet_type;
297 uint8_t version;
298 uint8_t ttl;
299 uint8_t msg_type; /* see ICMP message types above */
300 uint8_t dst[ETH_ALEN];
301 uint8_t orig[ETH_ALEN];
302 uint8_t uid;
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000303 uint8_t rr_cur;
Antonio Quartulli0bf84c12013-05-18 14:56:57 +0200304 __be16 seqno;
Sven Eckelmann7e071c72012-06-03 22:19:13 +0200305 uint8_t rr[BATADV_RR_LEN][ETH_ALEN];
Sven Eckelmannf6c57a42012-11-05 21:25:26 +0100306};
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000307
Simon Wunderlichda6b8c22013-10-22 22:50:09 +0200308#define BATADV_ICMP_MAX_PACKET_SIZE sizeof(struct batadv_icmp_packet_rr)
309
Sven Eckelmanne022b952012-11-05 21:25:27 +0100310/* All packet headers in front of an ethernet header have to be completely
311 * divisible by 2 but not by 4 to make the payload after the ethernet
312 * header again 4 bytes boundary aligned.
313 *
314 * A packing of 2 is necessary to avoid extra padding at the end of the struct
315 * caused by a structure member which is larger than two bytes. Otherwise
316 * the structure would not fulfill the previously mentioned rule to avoid the
317 * misalignment of the payload after the ethernet header. It may also lead to
318 * leakage of information when the padding it not initialized before sending.
319 */
320#pragma pack(2)
321
Simon Wunderlicha40d9b02013-12-02 20:38:31 +0100322/**
323 * struct batadv_unicast_packet - unicast packet for network payload
324 * @packet_type: batman-adv packet type, part of the general header
325 * @version: batman-adv protocol version, part of the genereal header
326 * @ttl: time to live for this packet, part of the genereal header
327 * @ttvn: translation table version number
328 * @dest: originator destination of the unicast packet
329 */
Sven Eckelmann96412692012-06-05 22:31:30 +0200330struct batadv_unicast_packet {
Simon Wunderlicha40d9b02013-12-02 20:38:31 +0100331 uint8_t packet_type;
332 uint8_t version;
333 uint8_t ttl;
Antonio Quartullia73105b2011-04-27 14:27:44 +0200334 uint8_t ttvn; /* destination translation table version number */
Antonio Quartullic1faead2012-01-30 20:59:17 +0100335 uint8_t dest[ETH_ALEN];
Sven Eckelmannf6c57a42012-11-05 21:25:26 +0100336 /* "4 bytes boundary + 2 bytes" long to make the payload after the
337 * following ethernet header again 4 bytes boundary aligned
338 */
339};
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000340
Antonio Quartulli7cdcf6d2012-10-01 09:57:35 +0200341/**
342 * struct batadv_unicast_4addr_packet - extended unicast packet
343 * @u: common unicast packet header
344 * @src: address of the source
345 * @subtype: packet subtype
346 */
347struct batadv_unicast_4addr_packet {
348 struct batadv_unicast_packet u;
349 uint8_t src[ETH_ALEN];
350 uint8_t subtype;
351 uint8_t reserved;
352 /* "4 bytes boundary + 2 bytes" long to make the payload after the
353 * following ethernet header again 4 bytes boundary aligned
354 */
355};
356
Martin Hundebøll610bfc6bc2013-05-23 16:53:02 +0200357/**
358 * struct batadv_frag_packet - fragmented packet
Simon Wunderlicha40d9b02013-12-02 20:38:31 +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
Martin Hundebøll610bfc6bc2013-05-23 16:53:02 +0200362 * @dest: final destination used when routing fragments
363 * @orig: originator of the fragment used when merging the packet
364 * @no: fragment number within this sequence
365 * @reserved: reserved byte for alignment
366 * @seqno: sequence identification
367 * @total_size: size of the merged packet
368 */
369struct batadv_frag_packet {
Simon Wunderlicha40d9b02013-12-02 20:38:31 +0100370 uint8_t packet_type;
371 uint8_t version; /* batman version field */
372 uint8_t ttl;
Martin Hundebøll610bfc6bc2013-05-23 16:53:02 +0200373#if defined(__BIG_ENDIAN_BITFIELD)
374 uint8_t no:4;
375 uint8_t reserved:4;
376#elif defined(__LITTLE_ENDIAN_BITFIELD)
377 uint8_t reserved:4;
378 uint8_t no:4;
379#else
Antonio Quartulli3f687852014-11-02 11:29:56 +0100380#error "unknown bitfield endianness"
Martin Hundebøll610bfc6bc2013-05-23 16:53:02 +0200381#endif
382 uint8_t dest[ETH_ALEN];
383 uint8_t orig[ETH_ALEN];
384 __be16 seqno;
385 __be16 total_size;
386};
387
Simon Wunderlicha40d9b02013-12-02 20:38:31 +0100388/**
389 * struct batadv_bcast_packet - broadcast packet for network payload
390 * @packet_type: batman-adv packet type, part of the general header
391 * @version: batman-adv protocol version, part of the genereal header
392 * @ttl: time to live for this packet, part of the genereal header
393 * @reserved: reserved byte for alignment
394 * @seqno: sequence identification
395 * @orig: originator of the broadcast packet
396 */
Sven Eckelmann96412692012-06-05 22:31:30 +0200397struct batadv_bcast_packet {
Simon Wunderlicha40d9b02013-12-02 20:38:31 +0100398 uint8_t packet_type;
399 uint8_t version; /* batman version field */
400 uint8_t ttl;
Antonio Quartulli3b27ffb2011-05-28 14:51:06 +0200401 uint8_t reserved;
Al Viro3e2f1a12012-04-22 07:47:50 +0100402 __be32 seqno;
Antonio Quartullic1faead2012-01-30 20:59:17 +0100403 uint8_t orig[ETH_ALEN];
Sven Eckelmannf6c57a42012-11-05 21:25:26 +0100404 /* "4 bytes boundary + 2 bytes" long to make the payload after the
405 * following ethernet header again 4 bytes boundary aligned
406 */
Sven Eckelmanne022b952012-11-05 21:25:27 +0100407};
408
Martin Hundebøll3c12de92013-01-25 11:12:41 +0100409/**
410 * struct batadv_coded_packet - network coded packet
Simon Wunderlicha40d9b02013-12-02 20:38:31 +0100411 * @packet_type: batman-adv packet type, part of the general header
412 * @version: batman-adv protocol version, part of the genereal header
413 * @ttl: time to live for this packet, part of the genereal header
Martin Hundebøll3c12de92013-01-25 11:12:41 +0100414 * @reserved: Align following fields to 2-byte boundaries
415 * @first_source: original source of first included packet
416 * @first_orig_dest: original destinal of first included packet
417 * @first_crc: checksum of first included packet
418 * @first_ttvn: tt-version number of first included packet
419 * @second_ttl: ttl of second packet
420 * @second_dest: second receiver of this coded packet
421 * @second_source: original source of second included packet
422 * @second_orig_dest: original destination of second included packet
423 * @second_crc: checksum of second included packet
424 * @second_ttvn: tt version number of second included packet
425 * @coded_len: length of network coded part of the payload
426 */
427struct batadv_coded_packet {
Simon Wunderlicha40d9b02013-12-02 20:38:31 +0100428 uint8_t packet_type;
429 uint8_t version; /* batman version field */
430 uint8_t ttl;
Martin Hundebøll3c12de92013-01-25 11:12:41 +0100431 uint8_t first_ttvn;
432 /* uint8_t first_dest[ETH_ALEN]; - saved in mac header destination */
433 uint8_t first_source[ETH_ALEN];
434 uint8_t first_orig_dest[ETH_ALEN];
435 __be32 first_crc;
436 uint8_t second_ttl;
437 uint8_t second_ttvn;
438 uint8_t second_dest[ETH_ALEN];
439 uint8_t second_source[ETH_ALEN];
440 uint8_t second_orig_dest[ETH_ALEN];
441 __be32 second_crc;
Martin Hundebølle6a0b492013-03-14 21:30:21 +0100442 __be16 coded_len;
Martin Hundebøll3c12de92013-01-25 11:12:41 +0100443};
444
Simon Wunderlich46b76e02013-12-02 20:38:30 +0100445#pragma pack()
446
Marek Lindneref261572013-04-23 21:39:57 +0800447/**
448 * struct batadv_unicast_tvlv - generic unicast packet with tvlv payload
Simon Wunderlicha40d9b02013-12-02 20:38:31 +0100449 * @packet_type: batman-adv packet type, part of the general header
450 * @version: batman-adv protocol version, part of the genereal header
451 * @ttl: time to live for this packet, part of the genereal header
Marek Lindneref261572013-04-23 21:39:57 +0800452 * @reserved: reserved field (for packet alignment)
453 * @src: address of the source
454 * @dst: address of the destination
455 * @tvlv_len: length of tvlv data following the unicast tvlv header
Antonio Quartulli3f687852014-11-02 11:29:56 +0100456 * @align: 2 bytes to align the header to a 4 byte boundary
Marek Lindneref261572013-04-23 21:39:57 +0800457 */
458struct batadv_unicast_tvlv_packet {
Simon Wunderlicha40d9b02013-12-02 20:38:31 +0100459 uint8_t packet_type;
460 uint8_t version; /* batman version field */
461 uint8_t ttl;
Marek Lindneref261572013-04-23 21:39:57 +0800462 uint8_t reserved;
463 uint8_t dst[ETH_ALEN];
464 uint8_t src[ETH_ALEN];
465 __be16 tvlv_len;
466 uint16_t align;
467};
468
469/**
470 * struct batadv_tvlv_hdr - base tvlv header struct
471 * @type: tvlv container type (see batadv_tvlv_type)
472 * @version: tvlv container version
473 * @len: tvlv container length
474 */
475struct batadv_tvlv_hdr {
476 uint8_t type;
477 uint8_t version;
478 __be16 len;
479};
480
Marek Lindner414254e2013-04-23 21:39:58 +0800481/**
482 * struct batadv_tvlv_gateway_data - gateway data propagated through gw tvlv
483 * container
484 * @bandwidth_down: advertised uplink download bandwidth
485 * @bandwidth_up: advertised uplink upload bandwidth
486 */
487struct batadv_tvlv_gateway_data {
488 __be32 bandwidth_down;
489 __be32 bandwidth_up;
490};
491
Marek Lindnere1bf0c12013-04-23 21:40:01 +0800492/**
493 * struct batadv_tvlv_tt_data - tt data propagated through the tt tvlv container
494 * @flags: translation table flags (see batadv_tt_data_flags)
495 * @ttvn: translation table version number
Antonio Quartulli7ea7b4a2013-07-30 22:16:25 +0200496 * @vlan_num: number of announced VLANs. In the TVLV this struct is followed by
497 * one batadv_tvlv_tt_vlan_data object per announced vlan
Marek Lindnere1bf0c12013-04-23 21:40:01 +0800498 */
499struct batadv_tvlv_tt_data {
500 uint8_t flags;
501 uint8_t ttvn;
Antonio Quartulli7ea7b4a2013-07-30 22:16:25 +0200502 __be16 num_vlan;
503};
504
505/**
506 * struct batadv_tvlv_tt_vlan_data - vlan specific tt data propagated through
507 * the tt tvlv container
508 * @crc: crc32 checksum of the entries belonging to this vlan
509 * @vid: vlan identifier
510 * @reserved: unused, useful for alignment purposes
511 */
512struct batadv_tvlv_tt_vlan_data {
513 __be32 crc;
514 __be16 vid;
Antonio Quartulliced72932013-04-24 16:37:51 +0200515 uint16_t reserved;
Marek Lindnere1bf0c12013-04-23 21:40:01 +0800516};
517
518/**
519 * struct batadv_tvlv_tt_change - translation table diff data
520 * @flags: status indicators concerning the non-mesh client (see
521 * batadv_tt_client_flags)
Antonio Quartullica663042013-12-15 13:26:55 +0100522 * @reserved: reserved field - useful for alignment purposes only
Marek Lindnere1bf0c12013-04-23 21:40:01 +0800523 * @addr: mac address of non-mesh client that triggered this tt change
Antonio Quartullic018ad32013-06-04 12:11:39 +0200524 * @vid: VLAN identifier
Marek Lindnere1bf0c12013-04-23 21:40:01 +0800525 */
526struct batadv_tvlv_tt_change {
527 uint8_t flags;
Antonio Quartullica663042013-12-15 13:26:55 +0100528 uint8_t reserved[3];
Marek Lindnere1bf0c12013-04-23 21:40:01 +0800529 uint8_t addr[ETH_ALEN];
Antonio Quartullic018ad32013-06-04 12:11:39 +0200530 __be16 vid;
Marek Lindnere1bf0c12013-04-23 21:40:01 +0800531};
532
Marek Lindner122edaa2013-04-23 21:40:03 +0800533/**
534 * struct batadv_tvlv_roam_adv - roaming advertisement
535 * @client: mac address of roaming client
Antonio Quartullic018ad32013-06-04 12:11:39 +0200536 * @vid: VLAN identifier
Marek Lindner122edaa2013-04-23 21:40:03 +0800537 */
538struct batadv_tvlv_roam_adv {
539 uint8_t client[ETH_ALEN];
Antonio Quartullic018ad32013-06-04 12:11:39 +0200540 __be16 vid;
Marek Lindner122edaa2013-04-23 21:40:03 +0800541};
542
Linus Lüssing60432d72014-02-15 17:47:51 +0100543/**
544 * struct batadv_tvlv_mcast_data - payload of a multicast tvlv
545 * @flags: multicast flags announced by the orig node
546 * @reserved: reserved field
547 */
548struct batadv_tvlv_mcast_data {
549 uint8_t flags;
550 uint8_t reserved[3];
551};
552
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000553#endif /* _NET_BATMAN_ADV_PACKET_H_ */