blob: 0ee1af770798d26d1a7ba38e301b4d00bcf211cf [file] [log] [blame]
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +00001/*
Sven Eckelmann567db7b2012-01-01 00:41:38 +01002 * Copyright (C) 2007-2012 B.A.T.M.A.N. contributors:
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +00003 *
4 * Marek Lindner, Simon Wunderlich
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of version 2 of the GNU General Public
8 * License as published by the Free Software Foundation.
9 *
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
18 * 02110-1301, USA
19 *
20 */
21
22#ifndef _NET_BATMAN_ADV_PACKET_H_
23#define _NET_BATMAN_ADV_PACKET_H_
24
25#define ETH_P_BATMAN 0x4305 /* unofficial/not registered Ethertype */
26
Sven Eckelmanne8958db2011-06-04 11:26:00 +020027enum bat_packettype {
Marek Lindner1eeb4792012-02-07 17:20:51 +080028 BAT_IV_OGM = 0x01,
Marek Lindnerb6da4bf2011-07-29 17:31:50 +020029 BAT_ICMP = 0x02,
30 BAT_UNICAST = 0x03,
31 BAT_BCAST = 0x04,
32 BAT_VIS = 0x05,
Antonio Quartullia73105b2011-04-27 14:27:44 +020033 BAT_UNICAST_FRAG = 0x06,
Marek Lindnerb6da4bf2011-07-29 17:31:50 +020034 BAT_TT_QUERY = 0x07,
35 BAT_ROAM_ADV = 0x08
Sven Eckelmanne8958db2011-06-04 11:26:00 +020036};
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +000037
38/* this file is included by batctl which needs these defines */
Antonio Quartulli3b27ffb2011-05-28 14:51:06 +020039#define COMPAT_VERSION 14
Sven Eckelmanne8958db2011-06-04 11:26:00 +020040
Marek Lindner1eeb4792012-02-07 17:20:51 +080041enum batman_iv_flags {
Marek Lindner13b25412012-03-11 06:17:53 +080042 NOT_BEST_NEXT_HOP = 1 << 3,
Sven Eckelmanne8958db2011-06-04 11:26:00 +020043 PRIMARIES_FIRST_HOP = 1 << 4,
44 VIS_SERVER = 1 << 5,
45 DIRECTLINK = 1 << 6
46};
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +000047
48/* ICMP message types */
Sven Eckelmanne8958db2011-06-04 11:26:00 +020049enum icmp_packettype {
50 ECHO_REPLY = 0,
51 DESTINATION_UNREACHABLE = 3,
52 ECHO_REQUEST = 8,
53 TTL_EXCEEDED = 11,
54 PARAMETER_PROBLEM = 12
55};
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +000056
57/* vis defines */
Sven Eckelmanne8958db2011-06-04 11:26:00 +020058enum vis_packettype {
59 VIS_TYPE_SERVER_SYNC = 0,
60 VIS_TYPE_CLIENT_UPDATE = 1
61};
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +000062
63/* fragmentation defines */
Sven Eckelmanne8958db2011-06-04 11:26:00 +020064enum unicast_frag_flags {
65 UNI_FRAG_HEAD = 1 << 0,
66 UNI_FRAG_LARGETAIL = 1 << 1
67};
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +000068
Antonio Quartullia73105b2011-04-27 14:27:44 +020069/* TT_QUERY subtypes */
70#define TT_QUERY_TYPE_MASK 0x3
71
72enum tt_query_packettype {
73 TT_REQUEST = 0,
74 TT_RESPONSE = 1
75};
76
77/* TT_QUERY flags */
78enum tt_query_flags {
79 TT_FULL_TABLE = 1 << 2
80};
81
Antonio Quartulli5fbc1592011-06-17 16:11:27 +020082/* TT_CLIENT flags.
83 * Flags from 1 to 1 << 7 are sent on the wire, while flags from 1 << 8 to
84 * 1 << 15 are used for local computation only */
85enum tt_client_flags {
86 TT_CLIENT_DEL = 1 << 0,
87 TT_CLIENT_ROAM = 1 << 1,
Antonio Quartullibc279082011-07-07 15:35:35 +020088 TT_CLIENT_WIFI = 1 << 2,
Antonio Quartulli058d0e22011-07-07 01:40:58 +020089 TT_CLIENT_NOPURGE = 1 << 8,
90 TT_CLIENT_NEW = 1 << 9,
91 TT_CLIENT_PENDING = 1 << 10
Antonio Quartullia73105b2011-04-27 14:27:44 +020092};
93
Simon Wunderlich23721382012-01-22 20:00:19 +010094/* claim frame types for the bridge loop avoidance */
95enum bla_claimframe {
96 CLAIM_TYPE_ADD = 0x00,
97 CLAIM_TYPE_DEL = 0x01,
98 CLAIM_TYPE_ANNOUNCE = 0x02,
99 CLAIM_TYPE_REQUEST = 0x03
100};
101
102/* the destination hardware field in the ARP frame is used to
103 * transport the claim type and the group id
104 */
105struct bla_claim_dst {
106 uint8_t magic[3]; /* FF:43:05 */
107 uint8_t type; /* bla_claimframe */
108 uint16_t group; /* group id */
109} __packed;
110
Sven Eckelmann76543d12011-11-20 15:47:38 +0100111struct batman_header {
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000112 uint8_t packet_type;
113 uint8_t version; /* batman version field */
Antonio Quartulli3b27ffb2011-05-28 14:51:06 +0200114 uint8_t ttl;
Sven Eckelmann76543d12011-11-20 15:47:38 +0100115} __packed;
116
117struct batman_ogm_packet {
118 struct batman_header header;
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000119 uint8_t flags; /* 0x40: DIRECTLINK flag, 0x20 VIS_SERVER flag... */
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000120 uint32_t seqno;
Antonio Quartullic1faead2012-01-30 20:59:17 +0100121 uint8_t orig[ETH_ALEN];
122 uint8_t prev_sender[ETH_ALEN];
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000123 uint8_t gw_flags; /* flags related to gateway class */
Antonio Quartulli3b27ffb2011-05-28 14:51:06 +0200124 uint8_t tq;
Antonio Quartullia73105b2011-04-27 14:27:44 +0200125 uint8_t tt_num_changes;
126 uint8_t ttvn; /* translation table version number */
127 uint16_t tt_crc;
Sven Eckelmannaa0adb12011-01-15 14:39:43 +0000128} __packed;
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000129
Marek Lindner76e3d7f2012-02-07 17:20:50 +0800130#define BATMAN_OGM_HLEN sizeof(struct batman_ogm_packet)
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000131
132struct icmp_packet {
Sven Eckelmann76543d12011-11-20 15:47:38 +0100133 struct batman_header header;
Antonio Quartulli3b27ffb2011-05-28 14:51:06 +0200134 uint8_t msg_type; /* see ICMP message types above */
Antonio Quartullic1faead2012-01-30 20:59:17 +0100135 uint8_t dst[ETH_ALEN];
136 uint8_t orig[ETH_ALEN];
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000137 uint16_t seqno;
138 uint8_t uid;
Antonio Quartulli3b27ffb2011-05-28 14:51:06 +0200139 uint8_t reserved;
Sven Eckelmannaa0adb12011-01-15 14:39:43 +0000140} __packed;
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000141
142#define BAT_RR_LEN 16
143
144/* icmp_packet_rr must start with all fields from imcp_packet
145 * as this is assumed by code that handles ICMP packets */
146struct icmp_packet_rr {
Sven Eckelmann76543d12011-11-20 15:47:38 +0100147 struct batman_header header;
Antonio Quartulli3b27ffb2011-05-28 14:51:06 +0200148 uint8_t msg_type; /* see ICMP message types above */
Antonio Quartullic1faead2012-01-30 20:59:17 +0100149 uint8_t dst[ETH_ALEN];
150 uint8_t orig[ETH_ALEN];
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000151 uint16_t seqno;
152 uint8_t uid;
153 uint8_t rr_cur;
154 uint8_t rr[BAT_RR_LEN][ETH_ALEN];
Sven Eckelmannaa0adb12011-01-15 14:39:43 +0000155} __packed;
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000156
157struct unicast_packet {
Sven Eckelmann76543d12011-11-20 15:47:38 +0100158 struct batman_header header;
Antonio Quartullia73105b2011-04-27 14:27:44 +0200159 uint8_t ttvn; /* destination translation table version number */
Antonio Quartullic1faead2012-01-30 20:59:17 +0100160 uint8_t dest[ETH_ALEN];
Sven Eckelmannaa0adb12011-01-15 14:39:43 +0000161} __packed;
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000162
163struct unicast_frag_packet {
Sven Eckelmann76543d12011-11-20 15:47:38 +0100164 struct batman_header header;
Antonio Quartullia73105b2011-04-27 14:27:44 +0200165 uint8_t ttvn; /* destination translation table version number */
Antonio Quartullic1faead2012-01-30 20:59:17 +0100166 uint8_t dest[ETH_ALEN];
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000167 uint8_t flags;
Antonio Quartulli3b27ffb2011-05-28 14:51:06 +0200168 uint8_t align;
Antonio Quartullic1faead2012-01-30 20:59:17 +0100169 uint8_t orig[ETH_ALEN];
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000170 uint16_t seqno;
Sven Eckelmannaa0adb12011-01-15 14:39:43 +0000171} __packed;
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000172
173struct bcast_packet {
Sven Eckelmann76543d12011-11-20 15:47:38 +0100174 struct batman_header header;
Antonio Quartulli3b27ffb2011-05-28 14:51:06 +0200175 uint8_t reserved;
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000176 uint32_t seqno;
Antonio Quartullic1faead2012-01-30 20:59:17 +0100177 uint8_t orig[ETH_ALEN];
Sven Eckelmannaa0adb12011-01-15 14:39:43 +0000178} __packed;
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000179
180struct vis_packet {
Sven Eckelmann76543d12011-11-20 15:47:38 +0100181 struct batman_header header;
Antonio Quartulli3b27ffb2011-05-28 14:51:06 +0200182 uint8_t vis_type; /* which type of vis-participant sent this? */
183 uint32_t seqno; /* sequence number */
184 uint8_t entries; /* number of entries behind this struct */
185 uint8_t reserved;
Antonio Quartullic1faead2012-01-30 20:59:17 +0100186 uint8_t vis_orig[ETH_ALEN]; /* originator reporting its neighbors */
187 uint8_t target_orig[ETH_ALEN]; /* who should receive this packet */
188 uint8_t sender_orig[ETH_ALEN]; /* who sent or forwarded this packet */
Sven Eckelmannaa0adb12011-01-15 14:39:43 +0000189} __packed;
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000190
Antonio Quartullia73105b2011-04-27 14:27:44 +0200191struct tt_query_packet {
Sven Eckelmann76543d12011-11-20 15:47:38 +0100192 struct batman_header header;
Antonio Quartullia73105b2011-04-27 14:27:44 +0200193 /* the flag field is a combination of:
194 * - TT_REQUEST or TT_RESPONSE
195 * - TT_FULL_TABLE */
196 uint8_t flags;
197 uint8_t dst[ETH_ALEN];
198 uint8_t src[ETH_ALEN];
199 /* the ttvn field is:
200 * if TT_REQUEST: ttvn that triggered the
201 * request
202 * if TT_RESPONSE: new ttvn for the src
203 * orig_node */
204 uint8_t ttvn;
205 /* tt_data field is:
206 * if TT_REQUEST: crc associated with the
207 * ttvn
208 * if TT_RESPONSE: table_size */
209 uint16_t tt_data;
210} __packed;
211
Antonio Quartullicc47f662011-04-27 14:27:57 +0200212struct roam_adv_packet {
Sven Eckelmann76543d12011-11-20 15:47:38 +0100213 struct batman_header header;
Antonio Quartullicc47f662011-04-27 14:27:57 +0200214 uint8_t reserved;
215 uint8_t dst[ETH_ALEN];
216 uint8_t src[ETH_ALEN];
217 uint8_t client[ETH_ALEN];
218} __packed;
219
Antonio Quartullia73105b2011-04-27 14:27:44 +0200220struct tt_change {
221 uint8_t flags;
222 uint8_t addr[ETH_ALEN];
223} __packed;
224
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000225#endif /* _NET_BATMAN_ADV_PACKET_H_ */