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         NOT_BEST_NEXT_HOP   = 1 << 3,
  43         PRIMARIES_FIRST_HOP = 1 << 4,
  44         VIS_SERVER          = 1 << 5,
  45         DIRECTLINK          = 1 << 6
  46 };
  47
  48 /* ICMP message types */
  49 enum icmp_packettype {
  50         ECHO_REPLY              = 0,
  51         DESTINATION_UNREACHABLE = 3,
  52         ECHO_REQUEST            = 8,
  53         TTL_EXCEEDED            = 11,
  54         PARAMETER_PROBLEM       = 12
  55 };
  56
  57 /* vis defines */
  58 enum vis_packettype {
  59         VIS_TYPE_SERVER_SYNC   = 0,
  60         VIS_TYPE_CLIENT_UPDATE = 1
  61 };
  62
  63 /* fragmentation defines */
  64 enum unicast_frag_flags {
  65         UNI_FRAG_HEAD      = 1 << 0,
  66         UNI_FRAG_LARGETAIL = 1 << 1
  67 };
  68
  69 /* TT_QUERY subtypes */
  70 #define TT_QUERY_TYPE_MASK 0x3
  71
  72 enum tt_query_packettype {
  73         TT_REQUEST    = 0,
  74         TT_RESPONSE   = 1
  75 };
  76
  77 /* TT_QUERY flags */
  78 enum tt_query_flags {
  79         TT_FULL_TABLE = 1 << 2
  80 };
  81
  82 /* 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 */
  85 enum tt_client_flags {
  86         TT_CLIENT_DEL     = 1 << 0,
  87         TT_CLIENT_ROAM    = 1 << 1,
  88         TT_CLIENT_WIFI    = 1 << 2,
  89         TT_CLIENT_NOPURGE = 1 << 8,
  90         TT_CLIENT_NEW     = 1 << 9,
  91         TT_CLIENT_PENDING = 1 << 10
  92 };
  93
  94 /* claim frame types for the bridge loop avoidance */
  95 enum 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  */
 105 struct 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
 111 struct batman_header {
 112         uint8_t  packet_type;
 113         uint8_t  version;  /* batman version field */
 114         uint8_t  ttl;
 115 } __packed;
 116
 117 struct batman_ogm_packet {
 118         struct batman_header header;
 119         uint8_t  flags;    /* 0x40: DIRECTLINK flag, 0x20 VIS_SERVER flag... */
 120         uint32_t 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         uint16_t tt_crc;
 128 } __packed;
 129
 130 #define BATMAN_OGM_HLEN sizeof(struct batman_ogm_packet)
 131
 132 struct icmp_packet {
 133         struct batman_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         uint16_t seqno;
 138         uint8_t  uid;
 139         uint8_t  reserved;
 140 } __packed;
 141
 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 */
 146 struct icmp_packet_rr {
 147         struct batman_header header;
 148         uint8_t  msg_type; /* see ICMP message types above */
 149         uint8_t  dst[ETH_ALEN];
 150         uint8_t  orig[ETH_ALEN];
 151         uint16_t seqno;
 152         uint8_t  uid;
 153         uint8_t  rr_cur;
 154         uint8_t  rr[BAT_RR_LEN][ETH_ALEN];
 155 } __packed;
 156
 157 struct unicast_packet {
 158         struct batman_header header;
 159         uint8_t  ttvn; /* destination translation table version number */
 160         uint8_t  dest[ETH_ALEN];
 161 } __packed;
 162
 163 struct unicast_frag_packet {
 164         struct batman_header header;
 165         uint8_t  ttvn; /* destination translation table version number */
 166         uint8_t  dest[ETH_ALEN];
 167         uint8_t  flags;
 168         uint8_t  align;
 169         uint8_t  orig[ETH_ALEN];
 170         uint16_t seqno;
 171 } __packed;
 172
 173 struct bcast_packet {
 174         struct batman_header header;
 175         uint8_t  reserved;
 176         uint32_t seqno;
 177         uint8_t  orig[ETH_ALEN];
 178 } __packed;
 179
 180 struct vis_packet {
 181         struct batman_header header;
 182         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;
 186         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 */
 189 } __packed;
 190
 191 struct tt_query_packet {
 192         struct batman_header header;
 193         /* 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
 212 struct roam_adv_packet {
 213         struct batman_header header;
 214         uint8_t  reserved;
 215         uint8_t  dst[ETH_ALEN];
 216         uint8_t  src[ETH_ALEN];
 217         uint8_t  client[ETH_ALEN];
 218 } __packed;
 219
 220 struct tt_change {
 221         uint8_t flags;
 222         uint8_t addr[ETH_ALEN];
 223 } __packed;
 224
 225 #endif /* _NET_BATMAN_ADV_PACKET_H_ */