1 /* Copyright (C) 2007-2013 B.A.T.M.A.N. contributors:
3 * Marek Lindner, Simon Wunderlich
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.
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.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
20 #ifndef _NET_BATMAN_ADV_PACKET_H_
21 #define _NET_BATMAN_ADV_PACKET_H_
24 * enum batadv_packettype - types for batman-adv encapsulated packets
25 * @BATADV_IV_OGM: originator messages for B.A.T.M.A.N. IV
26 * @BATADV_BCAST: broadcast packets carrying broadcast payload
27 * @BATADV_CODED: network coded packets
29 * @BATADV_UNICAST: unicast packets carrying unicast payload traffic
30 * @BATADV_UNICAST_FRAG: unicast packets carrying a fragment of the original
32 * @BATADV_UNICAST_4ADDR: unicast packet including the originator address of
34 * @BATADV_ICMP: unicast packet like IP ICMP used for ping or traceroute
35 * @BATADV_UNICAST_TVLV: unicast packet carrying TVLV containers
37 enum batadv_packettype
{
38 /* 0x00 - 0x3f: local packets or special rules for handling */
42 /* 0x40 - 0x7f: unicast */
43 #define BATADV_UNICAST_MIN 0x40
44 BATADV_UNICAST
= 0x40,
45 BATADV_UNICAST_FRAG
= 0x41,
46 BATADV_UNICAST_4ADDR
= 0x42,
48 BATADV_UNICAST_TVLV
= 0x44,
49 #define BATADV_UNICAST_MAX 0x7f
50 /* 0x80 - 0xff: reserved */
54 * enum batadv_subtype - packet subtype for unicast4addr
55 * @BATADV_P_DATA: user payload
56 * @BATADV_P_DAT_DHT_GET: DHT request message
57 * @BATADV_P_DAT_DHT_PUT: DHT store message
58 * @BATADV_P_DAT_CACHE_REPLY: ARP reply generated by DAT
62 BATADV_P_DAT_DHT_GET
= 0x02,
63 BATADV_P_DAT_DHT_PUT
= 0x03,
64 BATADV_P_DAT_CACHE_REPLY
= 0x04,
67 /* this file is included by batctl which needs these defines */
68 #define BATADV_COMPAT_VERSION 15
70 enum batadv_iv_flags
{
71 BATADV_NOT_BEST_NEXT_HOP
= BIT(3),
72 BATADV_PRIMARIES_FIRST_HOP
= BIT(4),
73 BATADV_DIRECTLINK
= BIT(6),
76 /* ICMP message types */
77 enum batadv_icmp_packettype
{
78 BATADV_ECHO_REPLY
= 0,
79 BATADV_DESTINATION_UNREACHABLE
= 3,
80 BATADV_ECHO_REQUEST
= 8,
81 BATADV_TTL_EXCEEDED
= 11,
82 BATADV_PARAMETER_PROBLEM
= 12,
85 /* fragmentation defines */
86 enum batadv_unicast_frag_flags
{
87 BATADV_UNI_FRAG_HEAD
= BIT(0),
88 BATADV_UNI_FRAG_LARGETAIL
= BIT(1),
91 /* tt data subtypes */
92 #define BATADV_TT_DATA_TYPE_MASK 0x0F
95 * enum batadv_tt_data_flags - flags for tt data tvlv
96 * @BATADV_TT_OGM_DIFF: TT diff propagated through OGM
97 * @BATADV_TT_REQUEST: TT request message
98 * @BATADV_TT_RESPONSE: TT response message
99 * @BATADV_TT_FULL_TABLE: contains full table to replace existing table
101 enum batadv_tt_data_flags
{
102 BATADV_TT_OGM_DIFF
= BIT(0),
103 BATADV_TT_REQUEST
= BIT(1),
104 BATADV_TT_RESPONSE
= BIT(2),
105 BATADV_TT_FULL_TABLE
= BIT(4),
108 /* BATADV_TT_CLIENT flags.
109 * Flags from BIT(0) to BIT(7) are sent on the wire, while flags from BIT(8) to
110 * BIT(15) are used for local computation only
112 enum batadv_tt_client_flags
{
113 BATADV_TT_CLIENT_DEL
= BIT(0),
114 BATADV_TT_CLIENT_ROAM
= BIT(1),
115 BATADV_TT_CLIENT_WIFI
= BIT(2),
116 BATADV_TT_CLIENT_NOPURGE
= BIT(8),
117 BATADV_TT_CLIENT_NEW
= BIT(9),
118 BATADV_TT_CLIENT_PENDING
= BIT(10),
119 BATADV_TT_CLIENT_TEMP
= BIT(11),
122 /* claim frame types for the bridge loop avoidance */
123 enum batadv_bla_claimframe
{
124 BATADV_CLAIM_TYPE_CLAIM
= 0x00,
125 BATADV_CLAIM_TYPE_UNCLAIM
= 0x01,
126 BATADV_CLAIM_TYPE_ANNOUNCE
= 0x02,
127 BATADV_CLAIM_TYPE_REQUEST
= 0x03,
131 * enum batadv_tvlv_type - tvlv type definitions
132 * @BATADV_TVLV_GW: gateway tvlv
133 * @BATADV_TVLV_DAT: distributed arp table tvlv
134 * @BATADV_TVLV_NC: network coding tvlv
135 * @BATADV_TVLV_TT: translation table tvlv
136 * @BATADV_TVLV_ROAM: roaming advertisement tvlv
138 enum batadv_tvlv_type
{
139 BATADV_TVLV_GW
= 0x01,
140 BATADV_TVLV_DAT
= 0x02,
141 BATADV_TVLV_NC
= 0x03,
142 BATADV_TVLV_TT
= 0x04,
143 BATADV_TVLV_ROAM
= 0x05,
146 /* the destination hardware field in the ARP frame is used to
147 * transport the claim type and the group id
149 struct batadv_bla_claim_dst
{
150 uint8_t magic
[3]; /* FF:43:05 */
151 uint8_t type
; /* bla_claimframe */
152 __be16 group
; /* group id */
155 struct batadv_header
{
157 uint8_t version
; /* batman version field */
159 /* the parent struct has to add a byte after the header to make
160 * everything 4 bytes aligned again
165 * struct batadv_ogm_packet - ogm (routing protocol) packet
166 * @header: common batman packet header
167 * @tvlv_len: length of tvlv data following the ogm header
169 struct batadv_ogm_packet
{
170 struct batadv_header header
;
171 uint8_t flags
; /* 0x40: DIRECTLINK flag ... */
173 uint8_t orig
[ETH_ALEN
];
174 uint8_t prev_sender
[ETH_ALEN
];
180 #define BATADV_OGM_HLEN sizeof(struct batadv_ogm_packet)
182 struct batadv_icmp_packet
{
183 struct batadv_header header
;
184 uint8_t msg_type
; /* see ICMP message types above */
185 uint8_t dst
[ETH_ALEN
];
186 uint8_t orig
[ETH_ALEN
];
192 #define BATADV_RR_LEN 16
194 /* icmp_packet_rr must start with all fields from imcp_packet
195 * as this is assumed by code that handles ICMP packets
197 struct batadv_icmp_packet_rr
{
198 struct batadv_header header
;
199 uint8_t msg_type
; /* see ICMP message types above */
200 uint8_t dst
[ETH_ALEN
];
201 uint8_t orig
[ETH_ALEN
];
205 uint8_t rr
[BATADV_RR_LEN
][ETH_ALEN
];
208 /* All packet headers in front of an ethernet header have to be completely
209 * divisible by 2 but not by 4 to make the payload after the ethernet
210 * header again 4 bytes boundary aligned.
212 * A packing of 2 is necessary to avoid extra padding at the end of the struct
213 * caused by a structure member which is larger than two bytes. Otherwise
214 * the structure would not fulfill the previously mentioned rule to avoid the
215 * misalignment of the payload after the ethernet header. It may also lead to
216 * leakage of information when the padding it not initialized before sending.
220 struct batadv_unicast_packet
{
221 struct batadv_header header
;
222 uint8_t ttvn
; /* destination translation table version number */
223 uint8_t dest
[ETH_ALEN
];
224 /* "4 bytes boundary + 2 bytes" long to make the payload after the
225 * following ethernet header again 4 bytes boundary aligned
230 * struct batadv_unicast_4addr_packet - extended unicast packet
231 * @u: common unicast packet header
232 * @src: address of the source
233 * @subtype: packet subtype
235 struct batadv_unicast_4addr_packet
{
236 struct batadv_unicast_packet u
;
237 uint8_t src
[ETH_ALEN
];
240 /* "4 bytes boundary + 2 bytes" long to make the payload after the
241 * following ethernet header again 4 bytes boundary aligned
245 struct batadv_unicast_frag_packet
{
246 struct batadv_header header
;
247 uint8_t ttvn
; /* destination translation table version number */
248 uint8_t dest
[ETH_ALEN
];
251 uint8_t orig
[ETH_ALEN
];
255 struct batadv_bcast_packet
{
256 struct batadv_header header
;
259 uint8_t orig
[ETH_ALEN
];
260 /* "4 bytes boundary + 2 bytes" long to make the payload after the
261 * following ethernet header again 4 bytes boundary aligned
268 * struct batadv_coded_packet - network coded packet
269 * @header: common batman packet header and ttl of first included packet
270 * @reserved: Align following fields to 2-byte boundaries
271 * @first_source: original source of first included packet
272 * @first_orig_dest: original destinal of first included packet
273 * @first_crc: checksum of first included packet
274 * @first_ttvn: tt-version number of first included packet
275 * @second_ttl: ttl of second packet
276 * @second_dest: second receiver of this coded packet
277 * @second_source: original source of second included packet
278 * @second_orig_dest: original destination of second included packet
279 * @second_crc: checksum of second included packet
280 * @second_ttvn: tt version number of second included packet
281 * @coded_len: length of network coded part of the payload
283 struct batadv_coded_packet
{
284 struct batadv_header header
;
286 /* uint8_t first_dest[ETH_ALEN]; - saved in mac header destination */
287 uint8_t first_source
[ETH_ALEN
];
288 uint8_t first_orig_dest
[ETH_ALEN
];
292 uint8_t second_dest
[ETH_ALEN
];
293 uint8_t second_source
[ETH_ALEN
];
294 uint8_t second_orig_dest
[ETH_ALEN
];
300 * struct batadv_unicast_tvlv - generic unicast packet with tvlv payload
301 * @header: common batman packet header
302 * @reserved: reserved field (for packet alignment)
303 * @src: address of the source
304 * @dst: address of the destination
305 * @tvlv_len: length of tvlv data following the unicast tvlv header
306 * @align: 2 bytes to align the header to a 4 byte boundry
308 struct batadv_unicast_tvlv_packet
{
309 struct batadv_header header
;
311 uint8_t dst
[ETH_ALEN
];
312 uint8_t src
[ETH_ALEN
];
318 * struct batadv_tvlv_hdr - base tvlv header struct
319 * @type: tvlv container type (see batadv_tvlv_type)
320 * @version: tvlv container version
321 * @len: tvlv container length
323 struct batadv_tvlv_hdr
{
330 * struct batadv_tvlv_gateway_data - gateway data propagated through gw tvlv
332 * @bandwidth_down: advertised uplink download bandwidth
333 * @bandwidth_up: advertised uplink upload bandwidth
335 struct batadv_tvlv_gateway_data
{
336 __be32 bandwidth_down
;
341 * struct batadv_tvlv_tt_data - tt data propagated through the tt tvlv container
342 * @flags: translation table flags (see batadv_tt_data_flags)
343 * @ttvn: translation table version number
344 * @reserved: field reserved for future use
345 * @crc: crc32 checksum of the local translation table
347 struct batadv_tvlv_tt_data
{
355 * struct batadv_tvlv_tt_change - translation table diff data
356 * @flags: status indicators concerning the non-mesh client (see
357 * batadv_tt_client_flags)
358 * @reserved: reserved field
359 * @addr: mac address of non-mesh client that triggered this tt change
361 struct batadv_tvlv_tt_change
{
364 uint8_t addr
[ETH_ALEN
];
368 * struct batadv_tvlv_roam_adv - roaming advertisement
369 * @client: mac address of roaming client
370 * @reserved: field reserved for future use
372 struct batadv_tvlv_roam_adv
{
373 uint8_t client
[ETH_ALEN
];
377 #endif /* _NET_BATMAN_ADV_PACKET_H_ */