net/batman-adv/packet.h

   1 /* Copyright (C) 2007-2012 B.A.T.M.A.N. contributors:
   2  *
   3  * Marek Lindner, Simon Wunderlich
   4  *
   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.
   8  *
   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.
  13  *
  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
  17  * 02110-1301, USA
  18  */
  19
  20 #ifndef _NET_BATMAN_ADV_PACKET_H_
  21 #define _NET_BATMAN_ADV_PACKET_H_
  22
  23 #define BATADV_ETH_P_BATMAN  0x4305 /* unofficial/not registered Ethertype */
  24
  25 enum batadv_packettype {
  26         BATADV_IV_OGM       = 0x01,
  27         BATADV_ICMP         = 0x02,
  28         BATADV_UNICAST      = 0x03,
  29         BATADV_BCAST        = 0x04,
  30         BATADV_VIS          = 0x05,
  31         BATADV_UNICAST_FRAG = 0x06,
  32         BATADV_TT_QUERY     = 0x07,
  33         BATADV_ROAM_ADV     = 0x08,
  34 };
  35
  36 /* this file is included by batctl which needs these defines */
  37 #define BATADV_COMPAT_VERSION 14
  38
  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),
  44 };
  45
  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,
  53 };
  54
  55 /* vis defines */
  56 enum batadv_vis_packettype {
  57         BATADV_VIS_TYPE_SERVER_SYNC   = 0,
  58         BATADV_VIS_TYPE_CLIENT_UPDATE = 1,
  59 };
  60
  61 /* fragmentation defines */
  62 enum batadv_unicast_frag_flags {
  63         BATADV_UNI_FRAG_HEAD      = BIT(0),
  64         BATADV_UNI_FRAG_LARGETAIL = BIT(1),
  65 };
  66
  67 /* TT_QUERY subtypes */
  68 #define BATADV_TT_QUERY_TYPE_MASK 0x3
  69
  70 enum batadv_tt_query_packettype {
  71         BATADV_TT_REQUEST  = 0,
  72         BATADV_TT_RESPONSE = 1,
  73 };
  74
  75 /* TT_QUERY flags */
  76 enum batadv_tt_query_flags {
  77         BATADV_TT_FULL_TABLE = BIT(2),
  78 };
  79
  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
  83  */
  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),
  92 };
  93
  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,
 100 };
 101
 102 /* the destination hardware field in the ARP frame is used to
 103  * transport the claim type and the group id
 104  */
 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 */
 109 } __packed;
 110
 111 struct batadv_header {
 112         uint8_t  packet_type;
 113         uint8_t  version;  /* batman version field */
 114         uint8_t  ttl;
 115 } __packed;
 116
 117 struct batadv_ogm_packet {
 118         struct batadv_header header;
 119         uint8_t  flags;    /* 0x40: DIRECTLINK flag, 0x20 VIS_SERVER flag... */
 120         __be32   seqno;
 121         uint8_t  orig[ETH_ALEN];
 122         uint8_t  prev_sender[ETH_ALEN];
 123         uint8_t  gw_flags;  /* flags related to gateway class */
 124         uint8_t  tq;
 125         uint8_t  tt_num_changes;
 126         uint8_t  ttvn; /* translation table version number */
 127         __be16   tt_crc;
 128 } __packed;
 129
 130 #define BATADV_OGM_HLEN sizeof(struct batadv_ogm_packet)
 131
 132 struct batadv_icmp_packet {
 133         struct batadv_header header;
 134         uint8_t  msg_type; /* see ICMP message types above */
 135         uint8_t  dst[ETH_ALEN];
 136         uint8_t  orig[ETH_ALEN];
 137         __be16   seqno;
 138         uint8_t  uid;
 139         uint8_t  reserved;
 140 } __packed;
 141
 142 #define BATADV_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
 146  */
 147 struct batadv_icmp_packet_rr {
 148         struct batadv_header header;
 149         uint8_t  msg_type; /* see ICMP message types above */
 150         uint8_t  dst[ETH_ALEN];
 151         uint8_t  orig[ETH_ALEN];
 152         __be16   seqno;
 153         uint8_t  uid;
 154         uint8_t  rr_cur;
 155         uint8_t  rr[BATADV_RR_LEN][ETH_ALEN];
 156 } __packed;
 157
 158 struct batadv_unicast_packet {
 159         struct batadv_header header;
 160         uint8_t  ttvn; /* destination translation table version number */
 161         uint8_t  dest[ETH_ALEN];
 162 } __packed;
 163
 164 struct batadv_unicast_frag_packet {
 165         struct batadv_header header;
 166         uint8_t  ttvn; /* destination translation table version number */
 167         uint8_t  dest[ETH_ALEN];
 168         uint8_t  flags;
 169         uint8_t  align;
 170         uint8_t  orig[ETH_ALEN];
 171         __be16   seqno;
 172 } __packed;
 173
 174 struct batadv_bcast_packet {
 175         struct batadv_header header;
 176         uint8_t  reserved;
 177         __be32   seqno;
 178         uint8_t  orig[ETH_ALEN];
 179 } __packed;
 180
 181 struct batadv_vis_packet {
 182         struct batadv_header header;
 183         uint8_t  vis_type;       /* which type of vis-participant sent this? */
 184         __be32   seqno;          /* sequence number */
 185         uint8_t  entries;        /* number of entries behind this struct */
 186         uint8_t  reserved;
 187         uint8_t  vis_orig[ETH_ALEN];    /* originator reporting its neighbors */
 188         uint8_t  target_orig[ETH_ALEN]; /* who should receive this packet */
 189         uint8_t  sender_orig[ETH_ALEN]; /* who sent or forwarded this packet */
 190 } __packed;
 191
 192 struct batadv_tt_query_packet {
 193         struct batadv_header header;
 194         /* the flag field is a combination of:
 195          * - TT_REQUEST or TT_RESPONSE
 196          * - TT_FULL_TABLE
 197          */
 198         uint8_t  flags;
 199         uint8_t  dst[ETH_ALEN];
 200         uint8_t  src[ETH_ALEN];
 201         /* the ttvn field is:
 202          * if TT_REQUEST: ttvn that triggered the
 203          *                request
 204          * if TT_RESPONSE: new ttvn for the src
 205          *                 orig_node
 206          */
 207         uint8_t  ttvn;
 208         /* tt_data field is:
 209          * if TT_REQUEST: crc associated with the
 210          *                ttvn
 211          * if TT_RESPONSE: table_size
 212          */
 213         __be16 tt_data;
 214 } __packed;
 215
 216 struct batadv_roam_adv_packet {
 217         struct batadv_header header;
 218         uint8_t  reserved;
 219         uint8_t  dst[ETH_ALEN];
 220         uint8_t  src[ETH_ALEN];
 221         uint8_t  client[ETH_ALEN];
 222 } __packed;
 223
 224 struct batadv_tt_change {
 225         uint8_t flags;
 226         uint8_t addr[ETH_ALEN];
 227 } __packed;
 228
 229 #endif /* _NET_BATMAN_ADV_PACKET_H_ */