net/batman-adv/packet.h

   1 /*
   2  * Copyright (C) 2007-2012 B.A.T.M.A.N. contributors:
   3  *
   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
  27 enum bat_packettype {
  28         BAT_IV_OGM       = 0x01,
  29         BAT_ICMP         = 0x02,
  30         BAT_UNICAST      = 0x03,
  31         BAT_BCAST        = 0x04,
  32         BAT_VIS          = 0x05,
  33         BAT_UNICAST_FRAG = 0x06,
  34         BAT_TT_QUERY     = 0x07,
  35         BAT_ROAM_ADV     = 0x08
  36 };
  37
  38 /* this file is included by batctl which needs these defines */
  39 #define COMPAT_VERSION 14
  40
  41 enum batman_iv_flags {
  42         PRIMARIES_FIRST_HOP = 1 << 4,
  43         VIS_SERVER          = 1 << 5,
  44         DIRECTLINK          = 1 << 6
  45 };
  46
  47 /* ICMP message types */
  48 enum icmp_packettype {
  49         ECHO_REPLY              = 0,
  50         DESTINATION_UNREACHABLE = 3,
  51         ECHO_REQUEST            = 8,
  52         TTL_EXCEEDED            = 11,
  53         PARAMETER_PROBLEM       = 12
  54 };
  55
  56 /* vis defines */
  57 enum vis_packettype {
  58         VIS_TYPE_SERVER_SYNC   = 0,
  59         VIS_TYPE_CLIENT_UPDATE = 1
  60 };
  61
  62 /* fragmentation defines */
  63 enum unicast_frag_flags {
  64         UNI_FRAG_HEAD      = 1 << 0,
  65         UNI_FRAG_LARGETAIL = 1 << 1
  66 };
  67
  68 /* TT_QUERY subtypes */
  69 #define TT_QUERY_TYPE_MASK 0x3
  70
  71 enum tt_query_packettype {
  72         TT_REQUEST    = 0,
  73         TT_RESPONSE   = 1
  74 };
  75
  76 /* TT_QUERY flags */
  77 enum tt_query_flags {
  78         TT_FULL_TABLE = 1 << 2
  79 };
  80
  81 /* TT_CLIENT flags.
  82  * Flags from 1 to 1 << 7 are sent on the wire, while flags from 1 << 8 to
  83  * 1 << 15 are used for local computation only */
  84 enum tt_client_flags {
  85         TT_CLIENT_DEL     = 1 << 0,
  86         TT_CLIENT_ROAM    = 1 << 1,
  87         TT_CLIENT_WIFI    = 1 << 2,
  88         TT_CLIENT_NOPURGE = 1 << 8,
  89         TT_CLIENT_NEW     = 1 << 9,
  90         TT_CLIENT_PENDING = 1 << 10
  91 };
  92
  93 /* claim frame types for the bridge loop avoidance */
  94 enum bla_claimframe {
  95         CLAIM_TYPE_ADD          = 0x00,
  96         CLAIM_TYPE_DEL          = 0x01,
  97         CLAIM_TYPE_ANNOUNCE     = 0x02,
  98         CLAIM_TYPE_REQUEST      = 0x03
  99 };
 100
 101 /* the destination hardware field in the ARP frame is used to
 102  * transport the claim type and the group id
 103  */
 104 struct bla_claim_dst {
 105         uint8_t magic[3];       /* FF:43:05 */
 106         uint8_t type;           /* bla_claimframe */
 107         uint16_t group;         /* group id */
 108 } __packed;
 109
 110 struct batman_header {
 111         uint8_t  packet_type;
 112         uint8_t  version;  /* batman version field */
 113         uint8_t  ttl;
 114 } __packed;
 115
 116 struct batman_ogm_packet {
 117         struct batman_header header;
 118         uint8_t  flags;    /* 0x40: DIRECTLINK flag, 0x20 VIS_SERVER flag... */
 119         uint32_t seqno;
 120         uint8_t  orig[ETH_ALEN];
 121         uint8_t  prev_sender[ETH_ALEN];
 122         uint8_t  gw_flags;  /* flags related to gateway class */
 123         uint8_t  tq;
 124         uint8_t  tt_num_changes;
 125         uint8_t  ttvn; /* translation table version number */
 126         uint16_t tt_crc;
 127 } __packed;
 128
 129 #define BATMAN_OGM_HLEN sizeof(struct batman_ogm_packet)
 130
 131 struct icmp_packet {
 132         struct batman_header header;
 133         uint8_t  msg_type; /* see ICMP message types above */
 134         uint8_t  dst[ETH_ALEN];
 135         uint8_t  orig[ETH_ALEN];
 136         uint16_t seqno;
 137         uint8_t  uid;
 138         uint8_t  reserved;
 139 } __packed;
 140
 141 #define BAT_RR_LEN 16
 142
 143 /* icmp_packet_rr must start with all fields from imcp_packet
 144  * as this is assumed by code that handles ICMP packets */
 145 struct icmp_packet_rr {
 146         struct batman_header header;
 147         uint8_t  msg_type; /* see ICMP message types above */
 148         uint8_t  dst[ETH_ALEN];
 149         uint8_t  orig[ETH_ALEN];
 150         uint16_t seqno;
 151         uint8_t  uid;
 152         uint8_t  rr_cur;
 153         uint8_t  rr[BAT_RR_LEN][ETH_ALEN];
 154 } __packed;
 155
 156 struct unicast_packet {
 157         struct batman_header header;
 158         uint8_t  ttvn; /* destination translation table version number */
 159         uint8_t  dest[ETH_ALEN];
 160 } __packed;
 161
 162 struct unicast_frag_packet {
 163         struct batman_header header;
 164         uint8_t  ttvn; /* destination translation table version number */
 165         uint8_t  dest[ETH_ALEN];
 166         uint8_t  flags;
 167         uint8_t  align;
 168         uint8_t  orig[ETH_ALEN];
 169         uint16_t seqno;
 170 } __packed;
 171
 172 struct bcast_packet {
 173         struct batman_header header;
 174         uint8_t  reserved;
 175         uint32_t seqno;
 176         uint8_t  orig[ETH_ALEN];
 177 } __packed;
 178
 179 struct vis_packet {
 180         struct batman_header header;
 181         uint8_t  vis_type;       /* which type of vis-participant sent this? */
 182         uint32_t seqno;          /* sequence number */
 183         uint8_t  entries;        /* number of entries behind this struct */
 184         uint8_t  reserved;
 185         uint8_t  vis_orig[ETH_ALEN];    /* originator reporting its neighbors */
 186         uint8_t  target_orig[ETH_ALEN]; /* who should receive this packet */
 187         uint8_t  sender_orig[ETH_ALEN]; /* who sent or forwarded this packet */
 188 } __packed;
 189
 190 struct tt_query_packet {
 191         struct batman_header header;
 192         /* the flag field is a combination of:
 193          * - TT_REQUEST or TT_RESPONSE
 194          * - TT_FULL_TABLE */
 195         uint8_t  flags;
 196         uint8_t  dst[ETH_ALEN];
 197         uint8_t  src[ETH_ALEN];
 198         /* the ttvn field is:
 199          * if TT_REQUEST: ttvn that triggered the
 200          *                request
 201          * if TT_RESPONSE: new ttvn for the src
 202          *                 orig_node */
 203         uint8_t  ttvn;
 204         /* tt_data field is:
 205          * if TT_REQUEST: crc associated with the
 206          *                ttvn
 207          * if TT_RESPONSE: table_size */
 208         uint16_t tt_data;
 209 } __packed;
 210
 211 struct roam_adv_packet {
 212         struct batman_header header;
 213         uint8_t  reserved;
 214         uint8_t  dst[ETH_ALEN];
 215         uint8_t  src[ETH_ALEN];
 216         uint8_t  client[ETH_ALEN];
 217 } __packed;
 218
 219 struct tt_change {
 220         uint8_t flags;
 221         uint8_t addr[ETH_ALEN];
 222 } __packed;
 223
 224 #endif /* _NET_BATMAN_ADV_PACKET_H_ */