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,
36 /* this file is included by batctl which needs these defines */
37 #define BATADV_COMPAT_VERSION 14
39 enum batadv_iv_flags {
40 BATADV_NOT_BEST_NEXT_HOP = BIT(3),
41 BATADV_PRIMARIES_FIRST_HOP = BIT(4),
42 BATADV_VIS_SERVER = BIT(5),
43 BATADV_DIRECTLINK = BIT(6),
46 /* ICMP message types */
47 enum batadv_icmp_packettype {
48 BATADV_ECHO_REPLY = 0,
49 BATADV_DESTINATION_UNREACHABLE = 3,
50 BATADV_ECHO_REQUEST = 8,
51 BATADV_TTL_EXCEEDED = 11,
52 BATADV_PARAMETER_PROBLEM = 12,
56 enum batadv_vis_packettype {
57 BATADV_VIS_TYPE_SERVER_SYNC = 0,
58 BATADV_VIS_TYPE_CLIENT_UPDATE = 1,
61 /* fragmentation defines */
62 enum batadv_unicast_frag_flags {
63 BATADV_UNI_FRAG_HEAD = BIT(0),
64 BATADV_UNI_FRAG_LARGETAIL = BIT(1),
67 /* TT_QUERY subtypes */
68 #define BATADV_TT_QUERY_TYPE_MASK 0x3
70 enum batadv_tt_query_packettype {
71 BATADV_TT_REQUEST = 0,
72 BATADV_TT_RESPONSE = 1,
76 enum batadv_tt_query_flags {
77 BATADV_TT_FULL_TABLE = BIT(2),
80 /* BATADV_TT_CLIENT flags.
81 * Flags from BIT(0) to BIT(7) are sent on the wire, while flags from BIT(8) to
82 * BIT(15) are used for local computation only
84 enum batadv_tt_client_flags {
85 BATADV_TT_CLIENT_DEL = BIT(0),
86 BATADV_TT_CLIENT_ROAM = BIT(1),
87 BATADV_TT_CLIENT_WIFI = BIT(2),
88 BATADV_TT_CLIENT_TEMP = BIT(3),
89 BATADV_TT_CLIENT_NOPURGE = BIT(8),
90 BATADV_TT_CLIENT_NEW = BIT(9),
91 BATADV_TT_CLIENT_PENDING = BIT(10),
94 /* claim frame types for the bridge loop avoidance */
95 enum batadv_bla_claimframe {
96 BATADV_CLAIM_TYPE_CLAIM = 0x00,
97 BATADV_CLAIM_TYPE_UNCLAIM = 0x01,
98 BATADV_CLAIM_TYPE_ANNOUNCE = 0x02,
99 BATADV_CLAIM_TYPE_REQUEST = 0x03,
102 /* the destination hardware field in the ARP frame is used to
103 * transport the claim type and the group id
105 struct batadv_bla_claim_dst {
106 uint8_t magic[3]; /* FF:43:05 */
107 uint8_t type; /* bla_claimframe */
108 __be16 group; /* group id */
111 struct batadv_header {
113 uint8_t version; /* batman version field */
115 /* the parent struct has to add a byte after the header to make
116 * everything 4 bytes aligned again
120 struct batadv_ogm_packet {
121 struct batadv_header header;
122 uint8_t flags; /* 0x40: DIRECTLINK flag, 0x20 VIS_SERVER flag... */
124 uint8_t orig[ETH_ALEN];
125 uint8_t prev_sender[ETH_ALEN];
126 uint8_t gw_flags; /* flags related to gateway class */
128 uint8_t tt_num_changes;
129 uint8_t ttvn; /* translation table version number */
133 #define BATADV_OGM_HLEN sizeof(struct batadv_ogm_packet)
135 struct batadv_icmp_packet {
136 struct batadv_header header;
137 uint8_t msg_type; /* see ICMP message types above */
138 uint8_t dst[ETH_ALEN];
139 uint8_t orig[ETH_ALEN];
145 #define BATADV_RR_LEN 16
147 /* icmp_packet_rr must start with all fields from imcp_packet
148 * as this is assumed by code that handles ICMP packets
150 struct batadv_icmp_packet_rr {
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];
158 uint8_t rr[BATADV_RR_LEN][ETH_ALEN];
161 struct batadv_unicast_packet {
162 struct batadv_header header;
163 uint8_t ttvn; /* destination translation table version number */
164 uint8_t dest[ETH_ALEN];
165 /* "4 bytes boundary + 2 bytes" long to make the payload after the
166 * following ethernet header again 4 bytes boundary aligned
170 struct batadv_unicast_frag_packet {
171 struct batadv_header header;
172 uint8_t ttvn; /* destination translation table version number */
173 uint8_t dest[ETH_ALEN];
176 uint8_t orig[ETH_ALEN];
180 struct batadv_bcast_packet {
181 struct batadv_header header;
184 uint8_t orig[ETH_ALEN];
185 /* "4 bytes boundary + 2 bytes" long to make the payload after the
186 * following ethernet header again 4 bytes boundary aligned
190 struct batadv_vis_packet {
191 struct batadv_header header;
192 uint8_t vis_type; /* which type of vis-participant sent this? */
193 __be32 seqno; /* sequence number */
194 uint8_t entries; /* number of entries behind this struct */
196 uint8_t vis_orig[ETH_ALEN]; /* originator reporting its neighbors */
197 uint8_t target_orig[ETH_ALEN]; /* who should receive this packet */
198 uint8_t sender_orig[ETH_ALEN]; /* who sent or forwarded this packet */
201 struct batadv_tt_query_packet {
202 struct batadv_header header;
203 /* the flag field is a combination of:
204 * - TT_REQUEST or TT_RESPONSE
208 uint8_t dst[ETH_ALEN];
209 uint8_t src[ETH_ALEN];
210 /* the ttvn field is:
211 * if TT_REQUEST: ttvn that triggered the
213 * if TT_RESPONSE: new ttvn for the src
218 * if TT_REQUEST: crc associated with the
220 * if TT_RESPONSE: table_size
225 struct batadv_roam_adv_packet {
226 struct batadv_header header;
228 uint8_t dst[ETH_ALEN];
229 uint8_t src[ETH_ALEN];
230 uint8_t client[ETH_ALEN];
233 struct batadv_tt_change {
235 uint8_t addr[ETH_ALEN];
238 #endif /* _NET_BATMAN_ADV_PACKET_H_ */