1 /* Copyright (C) 2007-2012 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_
23 #define BATADV_ETH_P_BATMAN 0x4305 /* unofficial/not registered Ethertype */
25 enum batadv_packettype
{
28 BATADV_UNICAST
= 0x03,
31 BATADV_UNICAST_FRAG
= 0x06,
32 BATADV_TT_QUERY
= 0x07,
33 BATADV_ROAM_ADV
= 0x08,
34 BATADV_UNICAST_4ADDR
= 0x09,
38 * enum batadv_subtype - packet subtype for unicast4addr
39 * @BATADV_P_DATA: user payload
40 * @BATADV_P_DAT_DHT_GET: DHT request message
41 * @BATADV_P_DAT_DHT_PUT: DHT store message
42 * @BATADV_P_DAT_CACHE_REPLY: ARP reply generated by DAT
46 BATADV_P_DAT_DHT_GET
= 0x02,
47 BATADV_P_DAT_DHT_PUT
= 0x03,
48 BATADV_P_DAT_CACHE_REPLY
= 0x04,
51 /* this file is included by batctl which needs these defines */
52 #define BATADV_COMPAT_VERSION 14
54 enum batadv_iv_flags
{
55 BATADV_NOT_BEST_NEXT_HOP
= BIT(3),
56 BATADV_PRIMARIES_FIRST_HOP
= BIT(4),
57 BATADV_VIS_SERVER
= BIT(5),
58 BATADV_DIRECTLINK
= BIT(6),
61 /* ICMP message types */
62 enum batadv_icmp_packettype
{
63 BATADV_ECHO_REPLY
= 0,
64 BATADV_DESTINATION_UNREACHABLE
= 3,
65 BATADV_ECHO_REQUEST
= 8,
66 BATADV_TTL_EXCEEDED
= 11,
67 BATADV_PARAMETER_PROBLEM
= 12,
71 enum batadv_vis_packettype
{
72 BATADV_VIS_TYPE_SERVER_SYNC
= 0,
73 BATADV_VIS_TYPE_CLIENT_UPDATE
= 1,
76 /* fragmentation defines */
77 enum batadv_unicast_frag_flags
{
78 BATADV_UNI_FRAG_HEAD
= BIT(0),
79 BATADV_UNI_FRAG_LARGETAIL
= BIT(1),
82 /* TT_QUERY subtypes */
83 #define BATADV_TT_QUERY_TYPE_MASK 0x3
85 enum batadv_tt_query_packettype
{
86 BATADV_TT_REQUEST
= 0,
87 BATADV_TT_RESPONSE
= 1,
91 enum batadv_tt_query_flags
{
92 BATADV_TT_FULL_TABLE
= BIT(2),
95 /* BATADV_TT_CLIENT flags.
96 * Flags from BIT(0) to BIT(7) are sent on the wire, while flags from BIT(8) to
97 * BIT(15) are used for local computation only
99 enum batadv_tt_client_flags
{
100 BATADV_TT_CLIENT_DEL
= BIT(0),
101 BATADV_TT_CLIENT_ROAM
= BIT(1),
102 BATADV_TT_CLIENT_WIFI
= BIT(2),
103 BATADV_TT_CLIENT_TEMP
= BIT(3),
104 BATADV_TT_CLIENT_NOPURGE
= BIT(8),
105 BATADV_TT_CLIENT_NEW
= BIT(9),
106 BATADV_TT_CLIENT_PENDING
= BIT(10),
109 /* claim frame types for the bridge loop avoidance */
110 enum batadv_bla_claimframe
{
111 BATADV_CLAIM_TYPE_CLAIM
= 0x00,
112 BATADV_CLAIM_TYPE_UNCLAIM
= 0x01,
113 BATADV_CLAIM_TYPE_ANNOUNCE
= 0x02,
114 BATADV_CLAIM_TYPE_REQUEST
= 0x03,
117 /* the destination hardware field in the ARP frame is used to
118 * transport the claim type and the group id
120 struct batadv_bla_claim_dst
{
121 uint8_t magic
[3]; /* FF:43:05 */
122 uint8_t type
; /* bla_claimframe */
123 __be16 group
; /* group id */
126 struct batadv_header
{
128 uint8_t version
; /* batman version field */
130 /* the parent struct has to add a byte after the header to make
131 * everything 4 bytes aligned again
135 struct batadv_ogm_packet
{
136 struct batadv_header header
;
137 uint8_t flags
; /* 0x40: DIRECTLINK flag, 0x20 VIS_SERVER flag... */
139 uint8_t orig
[ETH_ALEN
];
140 uint8_t prev_sender
[ETH_ALEN
];
141 uint8_t gw_flags
; /* flags related to gateway class */
143 uint8_t tt_num_changes
;
144 uint8_t ttvn
; /* translation table version number */
148 #define BATADV_OGM_HLEN sizeof(struct batadv_ogm_packet)
150 struct batadv_icmp_packet
{
151 struct batadv_header header
;
152 uint8_t msg_type
; /* see ICMP message types above */
153 uint8_t dst
[ETH_ALEN
];
154 uint8_t orig
[ETH_ALEN
];
160 #define BATADV_RR_LEN 16
162 /* icmp_packet_rr must start with all fields from imcp_packet
163 * as this is assumed by code that handles ICMP packets
165 struct batadv_icmp_packet_rr
{
166 struct batadv_header header
;
167 uint8_t msg_type
; /* see ICMP message types above */
168 uint8_t dst
[ETH_ALEN
];
169 uint8_t orig
[ETH_ALEN
];
173 uint8_t rr
[BATADV_RR_LEN
][ETH_ALEN
];
176 struct batadv_unicast_packet
{
177 struct batadv_header header
;
178 uint8_t ttvn
; /* destination translation table version number */
179 uint8_t dest
[ETH_ALEN
];
180 /* "4 bytes boundary + 2 bytes" long to make the payload after the
181 * following ethernet header again 4 bytes boundary aligned
186 * struct batadv_unicast_4addr_packet - extended unicast packet
187 * @u: common unicast packet header
188 * @src: address of the source
189 * @subtype: packet subtype
191 struct batadv_unicast_4addr_packet
{
192 struct batadv_unicast_packet u
;
193 uint8_t src
[ETH_ALEN
];
196 /* "4 bytes boundary + 2 bytes" long to make the payload after the
197 * following ethernet header again 4 bytes boundary aligned
201 struct batadv_unicast_frag_packet
{
202 struct batadv_header header
;
203 uint8_t ttvn
; /* destination translation table version number */
204 uint8_t dest
[ETH_ALEN
];
207 uint8_t orig
[ETH_ALEN
];
211 struct batadv_bcast_packet
{
212 struct batadv_header header
;
215 uint8_t orig
[ETH_ALEN
];
216 /* "4 bytes boundary + 2 bytes" long to make the payload after the
217 * following ethernet header again 4 bytes boundary aligned
221 struct batadv_vis_packet
{
222 struct batadv_header header
;
223 uint8_t vis_type
; /* which type of vis-participant sent this? */
224 __be32 seqno
; /* sequence number */
225 uint8_t entries
; /* number of entries behind this struct */
227 uint8_t vis_orig
[ETH_ALEN
]; /* originator reporting its neighbors */
228 uint8_t target_orig
[ETH_ALEN
]; /* who should receive this packet */
229 uint8_t sender_orig
[ETH_ALEN
]; /* who sent or forwarded this packet */
232 struct batadv_tt_query_packet
{
233 struct batadv_header header
;
234 /* the flag field is a combination of:
235 * - TT_REQUEST or TT_RESPONSE
239 uint8_t dst
[ETH_ALEN
];
240 uint8_t src
[ETH_ALEN
];
241 /* the ttvn field is:
242 * if TT_REQUEST: ttvn that triggered the
244 * if TT_RESPONSE: new ttvn for the src
249 * if TT_REQUEST: crc associated with the
251 * if TT_RESPONSE: table_size
256 struct batadv_roam_adv_packet
{
257 struct batadv_header header
;
259 uint8_t dst
[ETH_ALEN
];
260 uint8_t src
[ETH_ALEN
];
261 uint8_t client
[ETH_ALEN
];
264 struct batadv_tt_change
{
266 uint8_t addr
[ETH_ALEN
];
269 #endif /* _NET_BATMAN_ADV_PACKET_H_ */