net/batman-adv/packet.h

   1 /*
   2  * Copyright (C) 2007-2011 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_PACKET       = 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 };
  36
  37 /* this file is included by batctl which needs these defines */
  38 #define COMPAT_VERSION 14
  39
  40 enum batman_flags {
  41         PRIMARIES_FIRST_HOP = 1 << 4,
  42         VIS_SERVER          = 1 << 5,
  43         DIRECTLINK          = 1 << 6
  44 };
  45
  46 /* ICMP message types */
  47 enum icmp_packettype {
  48         ECHO_REPLY              = 0,
  49         DESTINATION_UNREACHABLE = 3,
  50         ECHO_REQUEST            = 8,
  51         TTL_EXCEEDED            = 11,
  52         PARAMETER_PROBLEM       = 12
  53 };
  54
  55 /* vis defines */
  56 enum vis_packettype {
  57         VIS_TYPE_SERVER_SYNC   = 0,
  58         VIS_TYPE_CLIENT_UPDATE = 1
  59 };
  60
  61 /* fragmentation defines */
  62 enum unicast_frag_flags {
  63         UNI_FRAG_HEAD      = 1 << 0,
  64         UNI_FRAG_LARGETAIL = 1 << 1
  65 };
  66
  67 /* TT_QUERY subtypes */
  68 #define TT_QUERY_TYPE_MASK 0x3
  69
  70 enum tt_query_packettype {
  71         TT_REQUEST    = 0,
  72         TT_RESPONSE   = 1
  73 };
  74
  75 /* TT_QUERY flags */
  76 enum tt_query_flags {
  77         TT_FULL_TABLE = 1 << 2
  78 };
  79
  80 /* TT_CHANGE flags */
  81 enum tt_change_flags {
  82         TT_CHANGE_DEL  = 0x01,
  83         TT_CLIENT_ROAM = 0x02
  84 };
  85
  86 struct batman_packet {
  87         uint8_t  packet_type;
  88         uint8_t  version;  /* batman version field */
  89         uint8_t  ttl;
  90         uint8_t  flags;    /* 0x40: DIRECTLINK flag, 0x20 VIS_SERVER flag... */
  91         uint32_t seqno;
  92         uint8_t  orig[6];
  93         uint8_t  prev_sender[6];
  94         uint8_t  gw_flags;  /* flags related to gateway class */
  95         uint8_t  tq;
  96         uint8_t  tt_num_changes;
  97         uint8_t  ttvn; /* translation table version number */
  98         uint16_t tt_crc;
  99 } __packed;
 100
 101 #define BAT_PACKET_LEN sizeof(struct batman_packet)
 102
 103 struct icmp_packet {
 104         uint8_t  packet_type;
 105         uint8_t  version;  /* batman version field */
 106         uint8_t  ttl;
 107         uint8_t  msg_type; /* see ICMP message types above */
 108         uint8_t  dst[6];
 109         uint8_t  orig[6];
 110         uint16_t seqno;
 111         uint8_t  uid;
 112         uint8_t  reserved;
 113 } __packed;
 114
 115 #define BAT_RR_LEN 16
 116
 117 /* icmp_packet_rr must start with all fields from imcp_packet
 118  * as this is assumed by code that handles ICMP packets */
 119 struct icmp_packet_rr {
 120         uint8_t  packet_type;
 121         uint8_t  version;  /* batman version field */
 122         uint8_t  ttl;
 123         uint8_t  msg_type; /* see ICMP message types above */
 124         uint8_t  dst[6];
 125         uint8_t  orig[6];
 126         uint16_t seqno;
 127         uint8_t  uid;
 128         uint8_t  rr_cur;
 129         uint8_t  rr[BAT_RR_LEN][ETH_ALEN];
 130 } __packed;
 131
 132 struct unicast_packet {
 133         uint8_t  packet_type;
 134         uint8_t  version;  /* batman version field */
 135         uint8_t  ttl;
 136         uint8_t  ttvn; /* destination translation table version number */
 137         uint8_t  dest[6];
 138 } __packed;
 139
 140 struct unicast_frag_packet {
 141         uint8_t  packet_type;
 142         uint8_t  version;  /* batman version field */
 143         uint8_t  ttl;
 144         uint8_t  ttvn; /* destination translation table version number */
 145         uint8_t  dest[6];
 146         uint8_t  flags;
 147         uint8_t  align;
 148         uint8_t  orig[6];
 149         uint16_t seqno;
 150 } __packed;
 151
 152 struct bcast_packet {
 153         uint8_t  packet_type;
 154         uint8_t  version;  /* batman version field */
 155         uint8_t  ttl;
 156         uint8_t  reserved;
 157         uint32_t seqno;
 158         uint8_t  orig[6];
 159 } __packed;
 160
 161 struct vis_packet {
 162         uint8_t  packet_type;
 163         uint8_t  version;        /* batman version field */
 164         uint8_t  ttl;            /* TTL */
 165         uint8_t  vis_type;       /* which type of vis-participant sent this? */
 166         uint32_t seqno;          /* sequence number */
 167         uint8_t  entries;        /* number of entries behind this struct */
 168         uint8_t  reserved;
 169         uint8_t  vis_orig[6];    /* originator that announces its neighbors */
 170         uint8_t  target_orig[6]; /* who should receive this packet */
 171         uint8_t  sender_orig[6]; /* who sent or rebroadcasted this packet */
 172 } __packed;
 173
 174 struct tt_query_packet {
 175         uint8_t  packet_type;
 176         uint8_t  version;  /* batman version field */
 177         uint8_t  ttl;
 178         /* the flag field is a combination of:
 179          * - TT_REQUEST or TT_RESPONSE
 180          * - TT_FULL_TABLE */
 181         uint8_t  flags;
 182         uint8_t  dst[ETH_ALEN];
 183         uint8_t  src[ETH_ALEN];
 184         /* the ttvn field is:
 185          * if TT_REQUEST: ttvn that triggered the
 186          *                request
 187          * if TT_RESPONSE: new ttvn for the src
 188          *                 orig_node */
 189         uint8_t  ttvn;
 190         /* tt_data field is:
 191          * if TT_REQUEST: crc associated with the
 192          *                ttvn
 193          * if TT_RESPONSE: table_size */
 194         uint16_t tt_data;
 195 } __packed;
 196
 197 struct tt_change {
 198         uint8_t flags;
 199         uint8_t addr[ETH_ALEN];
 200 } __packed;
 201
 202 #endif /* _NET_BATMAN_ADV_PACKET_H_ */