[deliverable/linux.git] / net / batman-adv / packet.h

/* Copyright (C) 2007-2013 B.A.T.M.A.N. contributors:
 *
 * Marek Lindner, Simon Wunderlich
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of version 2 of the GNU General Public
 * License as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, see <http://www.gnu.org/licenses/>.
 */

#ifndef _NET_BATMAN_ADV_PACKET_H_
#define _NET_BATMAN_ADV_PACKET_H_

/**
 * enum batadv_packettype - types for batman-adv encapsulated packets
 * @BATADV_IV_OGM: originator messages for B.A.T.M.A.N. IV
 * @BATADV_BCAST: broadcast packets carrying broadcast payload
 * @BATADV_CODED: network coded packets
 *
 * @BATADV_UNICAST: unicast packets carrying unicast payload traffic
 * @BATADV_UNICAST_FRAG: unicast packets carrying a fragment of the original
 *     payload packet
 * @BATADV_UNICAST_4ADDR: unicast packet including the originator address of
 *     the sender
 * @BATADV_ICMP: unicast packet like IP ICMP used for ping or traceroute
 * @BATADV_UNICAST_TVLV: unicast packet carrying TVLV containers
 */
enum batadv_packettype {
	/* 0x00 - 0x3f: local packets or special rules for handling */
	BATADV_IV_OGM           = 0x00,
	BATADV_BCAST            = 0x01,
	BATADV_CODED            = 0x02,
	/* 0x40 - 0x7f: unicast */
#define BATADV_UNICAST_MIN     0x40
	BATADV_UNICAST          = 0x40,
	BATADV_UNICAST_FRAG     = 0x41,
	BATADV_UNICAST_4ADDR    = 0x42,
	BATADV_ICMP             = 0x43,
	BATADV_UNICAST_TVLV     = 0x44,
#define BATADV_UNICAST_MAX     0x7f
	/* 0x80 - 0xff: reserved */
};

/**
 * enum batadv_subtype - packet subtype for unicast4addr
 * @BATADV_P_DATA: user payload
 * @BATADV_P_DAT_DHT_GET: DHT request message
 * @BATADV_P_DAT_DHT_PUT: DHT store message
 * @BATADV_P_DAT_CACHE_REPLY: ARP reply generated by DAT
 */
enum batadv_subtype {
	BATADV_P_DATA			= 0x01,
	BATADV_P_DAT_DHT_GET		= 0x02,
	BATADV_P_DAT_DHT_PUT		= 0x03,
	BATADV_P_DAT_CACHE_REPLY	= 0x04,
};

/* this file is included by batctl which needs these defines */
#define BATADV_COMPAT_VERSION 15

/**
 * enum batadv_iv_flags - flags used in B.A.T.M.A.N. IV OGM packets
 * @BATADV_NOT_BEST_NEXT_HOP: flag is set when ogm packet is forwarded and was
 *     previously received from someone else than the best neighbor.
 * @BATADV_PRIMARIES_FIRST_HOP: flag is set when the primary interface address
 *     is used, and the packet travels its first hop.
 * @BATADV_DIRECTLINK: flag is for the first hop or if rebroadcasted from a
 *     one hop neighbor on the interface where it was originally received.
 */
enum batadv_iv_flags {
	BATADV_NOT_BEST_NEXT_HOP   = BIT(0),
	BATADV_PRIMARIES_FIRST_HOP = BIT(1),
	BATADV_DIRECTLINK          = BIT(2),
};

/* ICMP message types */
enum batadv_icmp_packettype {
	BATADV_ECHO_REPLY	       = 0,
	BATADV_DESTINATION_UNREACHABLE = 3,
	BATADV_ECHO_REQUEST	       = 8,
	BATADV_TTL_EXCEEDED	       = 11,
	BATADV_PARAMETER_PROBLEM       = 12,
};

/* tt data subtypes */
#define BATADV_TT_DATA_TYPE_MASK 0x0F

/**
 * enum batadv_tt_data_flags - flags for tt data tvlv
 * @BATADV_TT_OGM_DIFF: TT diff propagated through OGM
 * @BATADV_TT_REQUEST: TT request message
 * @BATADV_TT_RESPONSE: TT response message
 * @BATADV_TT_FULL_TABLE: contains full table to replace existing table
 */
enum batadv_tt_data_flags {
	BATADV_TT_OGM_DIFF   = BIT(0),
	BATADV_TT_REQUEST    = BIT(1),
	BATADV_TT_RESPONSE   = BIT(2),
	BATADV_TT_FULL_TABLE = BIT(4),
};

/* BATADV_TT_CLIENT flags.
 * Flags from BIT(0) to BIT(7) are sent on the wire, while flags from BIT(8) to
 * BIT(15) are used for local computation only.
 * Flags from BIT(4) to BIT(7) are kept in sync with the rest of the network.
 */
enum batadv_tt_client_flags {
	BATADV_TT_CLIENT_DEL     = BIT(0),
	BATADV_TT_CLIENT_ROAM    = BIT(1),
	BATADV_TT_CLIENT_WIFI    = BIT(4),
	BATADV_TT_CLIENT_NOPURGE = BIT(8),
	BATADV_TT_CLIENT_NEW     = BIT(9),
	BATADV_TT_CLIENT_PENDING = BIT(10),
	BATADV_TT_CLIENT_TEMP	 = BIT(11),
};

/**
 * batadv_vlan_flags - flags for the four MSB of any vlan ID field
 * @BATADV_VLAN_HAS_TAG: whether the field contains a valid vlan tag or not
 */
enum batadv_vlan_flags {
	BATADV_VLAN_HAS_TAG	= BIT(15),
};

/* claim frame types for the bridge loop avoidance */
enum batadv_bla_claimframe {
	BATADV_CLAIM_TYPE_CLAIM		= 0x00,
	BATADV_CLAIM_TYPE_UNCLAIM	= 0x01,
	BATADV_CLAIM_TYPE_ANNOUNCE	= 0x02,
	BATADV_CLAIM_TYPE_REQUEST	= 0x03,
};

/**
 * enum batadv_tvlv_type - tvlv type definitions
 * @BATADV_TVLV_GW: gateway tvlv
 * @BATADV_TVLV_DAT: distributed arp table tvlv
 * @BATADV_TVLV_NC: network coding tvlv
 * @BATADV_TVLV_TT: translation table tvlv
 * @BATADV_TVLV_ROAM: roaming advertisement tvlv
 */
enum batadv_tvlv_type {
	BATADV_TVLV_GW		= 0x01,
	BATADV_TVLV_DAT		= 0x02,
	BATADV_TVLV_NC		= 0x03,
	BATADV_TVLV_TT		= 0x04,
	BATADV_TVLV_ROAM	= 0x05,
};

#pragma pack(2)
/* the destination hardware field in the ARP frame is used to
 * transport the claim type and the group id
 */
struct batadv_bla_claim_dst {
	uint8_t magic[3];	/* FF:43:05 */
	uint8_t type;		/* bla_claimframe */
	__be16 group;		/* group id */
};
#pragma pack()

/**
 * struct batadv_ogm_packet - ogm (routing protocol) packet
 * @packet_type: batman-adv packet type, part of the general header
 * @version: batman-adv protocol version, part of the genereal header
 * @ttl: time to live for this packet, part of the genereal header
 * @flags: contains routing relevant flags - see enum batadv_iv_flags
 * @tvlv_len: length of tvlv data following the ogm header
 */
struct batadv_ogm_packet {
	uint8_t  packet_type;
	uint8_t  version;
	uint8_t  ttl;
	uint8_t  flags;
	__be32   seqno;
	uint8_t  orig[ETH_ALEN];
	uint8_t  prev_sender[ETH_ALEN];
	uint8_t  reserved;
	uint8_t  tq;
	__be16   tvlv_len;
	/* __packed is not needed as the struct size is divisible by 4,
	 * and the largest data type in this struct has a size of 4.
	 */
};

#define BATADV_OGM_HLEN sizeof(struct batadv_ogm_packet)

/**
 * batadv_icmp_header - common members among all the ICMP packets
 * @packet_type: batman-adv packet type, part of the general header
 * @version: batman-adv protocol version, part of the genereal header
 * @ttl: time to live for this packet, part of the genereal header
 * @msg_type: ICMP packet type
 * @dst: address of the destination node
 * @orig: address of the source node
 * @uid: local ICMP socket identifier
 * @align: not used - useful for alignment purposes only
 *
 * This structure is used for ICMP packets parsing only and it is never sent
 * over the wire. The alignment field at the end is there to ensure that
 * members are padded the same way as they are in real packets.
 */
struct batadv_icmp_header {
	uint8_t  packet_type;
	uint8_t  version;
	uint8_t  ttl;
	uint8_t  msg_type; /* see ICMP message types above */
	uint8_t  dst[ETH_ALEN];
	uint8_t  orig[ETH_ALEN];
	uint8_t  uid;
	uint8_t  align[3];
};

/**
 * batadv_icmp_packet - ICMP packet
 * @packet_type: batman-adv packet type, part of the general header
 * @version: batman-adv protocol version, part of the genereal header
 * @ttl: time to live for this packet, part of the genereal header
 * @msg_type: ICMP packet type
 * @dst: address of the destination node
 * @orig: address of the source node
 * @uid: local ICMP socket identifier
 * @reserved: not used - useful for alignment
 * @seqno: ICMP sequence number
 */
struct batadv_icmp_packet {
	uint8_t  packet_type;
	uint8_t  version;
	uint8_t  ttl;
	uint8_t  msg_type; /* see ICMP message types above */
	uint8_t  dst[ETH_ALEN];
	uint8_t  orig[ETH_ALEN];
	uint8_t  uid;
	uint8_t  reserved;
	__be16   seqno;
};

#define BATADV_RR_LEN 16

/**
 * batadv_icmp_packet_rr - ICMP RouteRecord packet
 * @packet_type: batman-adv packet type, part of the general header
 * @version: batman-adv protocol version, part of the genereal header
 * @ttl: time to live for this packet, part of the genereal header
 * @msg_type: ICMP packet type
 * @dst: address of the destination node
 * @orig: address of the source node
 * @uid: local ICMP socket identifier
 * @rr_cur: number of entries the rr array
 * @seqno: ICMP sequence number
 * @rr: route record array
 */
struct batadv_icmp_packet_rr {
	uint8_t  packet_type;
	uint8_t  version;
	uint8_t  ttl;
	uint8_t  msg_type; /* see ICMP message types above */
	uint8_t  dst[ETH_ALEN];
	uint8_t  orig[ETH_ALEN];
	uint8_t  uid;
	uint8_t  rr_cur;
	__be16   seqno;
	uint8_t  rr[BATADV_RR_LEN][ETH_ALEN];
};

#define BATADV_ICMP_MAX_PACKET_SIZE	sizeof(struct batadv_icmp_packet_rr)

/* All packet headers in front of an ethernet header have to be completely
 * divisible by 2 but not by 4 to make the payload after the ethernet
 * header again 4 bytes boundary aligned.
 *
 * A packing of 2 is necessary to avoid extra padding at the end of the struct
 * caused by a structure member which is larger than two bytes. Otherwise
 * the structure would not fulfill the previously mentioned rule to avoid the
 * misalignment of the payload after the ethernet header. It may also lead to
 * leakage of information when the padding it not initialized before sending.
 */
#pragma pack(2)

/**
 * struct batadv_unicast_packet - unicast packet for network payload
 * @packet_type: batman-adv packet type, part of the general header
 * @version: batman-adv protocol version, part of the genereal header
 * @ttl: time to live for this packet, part of the genereal header
 * @ttvn: translation table version number
 * @dest: originator destination of the unicast packet
 */
struct batadv_unicast_packet {
	uint8_t  packet_type;
	uint8_t  version;
	uint8_t  ttl;
	uint8_t  ttvn; /* destination translation table version number */
	uint8_t  dest[ETH_ALEN];
	/* "4 bytes boundary + 2 bytes" long to make the payload after the
	 * following ethernet header again 4 bytes boundary aligned
	 */
};

/**
 * struct batadv_unicast_4addr_packet - extended unicast packet
 * @u: common unicast packet header
 * @src: address of the source
 * @subtype: packet subtype
 */
struct batadv_unicast_4addr_packet {
	struct batadv_unicast_packet u;
	uint8_t src[ETH_ALEN];
	uint8_t subtype;
	uint8_t reserved;
	/* "4 bytes boundary + 2 bytes" long to make the payload after the
	 * following ethernet header again 4 bytes boundary aligned
	 */
};

/**
 * struct batadv_frag_packet - fragmented packet
 * @packet_type: batman-adv packet type, part of the general header
 * @version: batman-adv protocol version, part of the genereal header
 * @ttl: time to live for this packet, part of the genereal header
 * @dest: final destination used when routing fragments
 * @orig: originator of the fragment used when merging the packet
 * @no: fragment number within this sequence
 * @reserved: reserved byte for alignment
 * @seqno: sequence identification
 * @total_size: size of the merged packet
 */
struct batadv_frag_packet {
	uint8_t packet_type;
	uint8_t version;  /* batman version field */
	uint8_t ttl;
#if defined(__BIG_ENDIAN_BITFIELD)
	uint8_t no:4;
	uint8_t reserved:4;
#elif defined(__LITTLE_ENDIAN_BITFIELD)
	uint8_t reserved:4;
	uint8_t no:4;
#else
#error "unknown bitfield endianess"
#endif
	uint8_t dest[ETH_ALEN];
	uint8_t orig[ETH_ALEN];
	__be16  seqno;
	__be16  total_size;
};

/**
 * struct batadv_bcast_packet - broadcast packet for network payload
 * @packet_type: batman-adv packet type, part of the general header
 * @version: batman-adv protocol version, part of the genereal header
 * @ttl: time to live for this packet, part of the genereal header
 * @reserved: reserved byte for alignment
 * @seqno: sequence identification
 * @orig: originator of the broadcast packet
 */
struct batadv_bcast_packet {
	uint8_t  packet_type;
	uint8_t  version;  /* batman version field */
	uint8_t  ttl;
	uint8_t  reserved;
	__be32   seqno;
	uint8_t  orig[ETH_ALEN];
	/* "4 bytes boundary + 2 bytes" long to make the payload after the
	 * following ethernet header again 4 bytes boundary aligned
	 */
};

/**
 * struct batadv_coded_packet - network coded packet
 * @packet_type: batman-adv packet type, part of the general header
 * @version: batman-adv protocol version, part of the genereal header
 * @ttl: time to live for this packet, part of the genereal header
 * @reserved: Align following fields to 2-byte boundaries
 * @first_source: original source of first included packet
 * @first_orig_dest: original destinal of first included packet
 * @first_crc: checksum of first included packet
 * @first_ttvn: tt-version number of first included packet
 * @second_ttl: ttl of second packet
 * @second_dest: second receiver of this coded packet
 * @second_source: original source of second included packet
 * @second_orig_dest: original destination of second included packet
 * @second_crc: checksum of second included packet
 * @second_ttvn: tt version number of second included packet
 * @coded_len: length of network coded part of the payload
 */
struct batadv_coded_packet {
	uint8_t  packet_type;
	uint8_t  version;  /* batman version field */
	uint8_t  ttl;
	uint8_t  first_ttvn;
	/* uint8_t  first_dest[ETH_ALEN]; - saved in mac header destination */
	uint8_t  first_source[ETH_ALEN];
	uint8_t  first_orig_dest[ETH_ALEN];
	__be32   first_crc;
	uint8_t  second_ttl;
	uint8_t  second_ttvn;
	uint8_t  second_dest[ETH_ALEN];
	uint8_t  second_source[ETH_ALEN];
	uint8_t  second_orig_dest[ETH_ALEN];
	__be32   second_crc;
	__be16   coded_len;
};

#pragma pack()

/**
 * struct batadv_unicast_tvlv - generic unicast packet with tvlv payload
 * @packet_type: batman-adv packet type, part of the general header
 * @version: batman-adv protocol version, part of the genereal header
 * @ttl: time to live for this packet, part of the genereal header
 * @reserved: reserved field (for packet alignment)
 * @src: address of the source
 * @dst: address of the destination
 * @tvlv_len: length of tvlv data following the unicast tvlv header
 * @align: 2 bytes to align the header to a 4 byte boundry
 */
struct batadv_unicast_tvlv_packet {
	uint8_t  packet_type;
	uint8_t  version;  /* batman version field */
	uint8_t  ttl;
	uint8_t  reserved;
	uint8_t  dst[ETH_ALEN];
	uint8_t  src[ETH_ALEN];
	__be16   tvlv_len;
	uint16_t align;
};

/**
 * struct batadv_tvlv_hdr - base tvlv header struct
 * @type: tvlv container type (see batadv_tvlv_type)
 * @version: tvlv container version
 * @len: tvlv container length
 */
struct batadv_tvlv_hdr {
	uint8_t type;
	uint8_t version;
	__be16  len;
};

/**
 * struct batadv_tvlv_gateway_data - gateway data propagated through gw tvlv
 *  container
 * @bandwidth_down: advertised uplink download bandwidth
 * @bandwidth_up: advertised uplink upload bandwidth
 */
struct batadv_tvlv_gateway_data {
	__be32 bandwidth_down;
	__be32 bandwidth_up;
};

/**
 * struct batadv_tvlv_tt_data - tt data propagated through the tt tvlv container
 * @flags: translation table flags (see batadv_tt_data_flags)
 * @ttvn: translation table version number
 * @vlan_num: number of announced VLANs. In the TVLV this struct is followed by
 *  one batadv_tvlv_tt_vlan_data object per announced vlan
 */
struct batadv_tvlv_tt_data {
	uint8_t flags;
	uint8_t ttvn;
	__be16  num_vlan;
};

/**
 * struct batadv_tvlv_tt_vlan_data - vlan specific tt data propagated through
 *  the tt tvlv container
 * @crc: crc32 checksum of the entries belonging to this vlan
 * @vid: vlan identifier
 * @reserved: unused, useful for alignment purposes
 */
struct batadv_tvlv_tt_vlan_data {
	__be32	crc;
	__be16	vid;
	uint16_t reserved;
};

/**
 * struct batadv_tvlv_tt_change - translation table diff data
 * @flags: status indicators concerning the non-mesh client (see
 *  batadv_tt_client_flags)
 * @reserved: reserved field - useful for alignment purposes only
 * @addr: mac address of non-mesh client that triggered this tt change
 * @vid: VLAN identifier
 */
struct batadv_tvlv_tt_change {
	uint8_t flags;
	uint8_t reserved[3];
	uint8_t addr[ETH_ALEN];
	__be16 vid;
};

/**
 * struct batadv_tvlv_roam_adv - roaming advertisement
 * @client: mac address of roaming client
 * @vid: VLAN identifier
 */
struct batadv_tvlv_roam_adv {
	uint8_t  client[ETH_ALEN];
	__be16 vid;
};

#endif /* _NET_BATMAN_ADV_PACKET_H_ */
Commit	Line	Data
0b873931	1	/* Copyright (C) 2007-2013 B.A.T.M.A.N. contributors:
c6c8fea2 SE	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
ebf38fb7	15	* along with this program; if not, see <http://www.gnu.org/licenses/>.
c6c8fea2 SE	16	*/
	17
	18	#ifndef _NET_BATMAN_ADV_PACKET_H_
	19	#define _NET_BATMAN_ADV_PACKET_H_
	20
ef261577 ML	21	/**
ef261577 ML	22	* enum batadv_packettype - types for batman-adv encapsulated packets
a1f1ac5c SW	23	* @BATADV_IV_OGM: originator messages for B.A.T.M.A.N. IV
	24	* @BATADV_BCAST: broadcast packets carrying broadcast payload
	25	* @BATADV_CODED: network coded packets
	26	*
	27	* @BATADV_UNICAST: unicast packets carrying unicast payload traffic
	28	* @BATADV_UNICAST_FRAG: unicast packets carrying a fragment of the original
	29	* payload packet
	30	* @BATADV_UNICAST_4ADDR: unicast packet including the originator address of
	31	* the sender
	32	* @BATADV_ICMP: unicast packet like IP ICMP used for ping or traceroute
ef261577 ML	33	* @BATADV_UNICAST_TVLV: unicast packet carrying TVLV containers
ef261577 ML	34	*/
acd34afa	35	enum batadv_packettype {
a1f1ac5c SW	36	/* 0x00 - 0x3f: local packets or special rules for handling */
	37	BATADV_IV_OGM = 0x00,
	38	BATADV_BCAST = 0x01,
	39	BATADV_CODED = 0x02,
	40	/* 0x40 - 0x7f: unicast */
	41	#define BATADV_UNICAST_MIN 0x40
	42	BATADV_UNICAST = 0x40,
	43	BATADV_UNICAST_FRAG = 0x41,
	44	BATADV_UNICAST_4ADDR = 0x42,
	45	BATADV_ICMP = 0x43,
	46	BATADV_UNICAST_TVLV = 0x44,
	47	#define BATADV_UNICAST_MAX 0x7f
	48	/* 0x80 - 0xff: reserved */
7cdcf6dd AQ	49	};
	50
	51	/**
	52	* enum batadv_subtype - packet subtype for unicast4addr
	53	* @BATADV_P_DATA: user payload
5c3a0e55 AQ	54	* @BATADV_P_DAT_DHT_GET: DHT request message
	55	* @BATADV_P_DAT_DHT_PUT: DHT store message
	56	* @BATADV_P_DAT_CACHE_REPLY: ARP reply generated by DAT
7cdcf6dd AQ	57	*/
7cdcf6dd AQ	58	enum batadv_subtype {
5c3a0e55 AQ	59	BATADV_P_DATA = 0x01,
	60	BATADV_P_DAT_DHT_GET = 0x02,
	61	BATADV_P_DAT_DHT_PUT = 0x03,
	62	BATADV_P_DAT_CACHE_REPLY = 0x04,
e8958dbf	63	};
c6c8fea2 SE	64
c6c8fea2 SE	65	/* this file is included by batctl which needs these defines */
60cf7981	66	#define BATADV_COMPAT_VERSION 15
e8958dbf	67
18c68d59 SW	68	/**
	69	* enum batadv_iv_flags - flags used in B.A.T.M.A.N. IV OGM packets
	70	* @BATADV_NOT_BEST_NEXT_HOP: flag is set when ogm packet is forwarded and was
	71	* previously received from someone else than the best neighbor.
	72	* @BATADV_PRIMARIES_FIRST_HOP: flag is set when the primary interface address
	73	* is used, and the packet travels its first hop.
	74	* @BATADV_DIRECTLINK: flag is for the first hop or if rebroadcasted from a
	75	* one hop neighbor on the interface where it was originally received.
	76	*/
acd34afa	77	enum batadv_iv_flags {
18c68d59 SW	78	BATADV_NOT_BEST_NEXT_HOP = BIT(0),
	79	BATADV_PRIMARIES_FIRST_HOP = BIT(1),
	80	BATADV_DIRECTLINK = BIT(2),
e8958dbf	81	};
c6c8fea2 SE	82
c6c8fea2 SE	83	/* ICMP message types */
acd34afa SE	84	enum batadv_icmp_packettype {
	85	BATADV_ECHO_REPLY = 0,
	86	BATADV_DESTINATION_UNREACHABLE = 3,
	87	BATADV_ECHO_REQUEST = 8,
	88	BATADV_TTL_EXCEEDED = 11,
	89	BATADV_PARAMETER_PROBLEM = 12,
e8958dbf	90	};
c6c8fea2	91
e1bf0c14 ML	92	/* tt data subtypes */
e1bf0c14 ML	93	#define BATADV_TT_DATA_TYPE_MASK 0x0F
a73105b8	94
e1bf0c14 ML	95	/**
	96	* enum batadv_tt_data_flags - flags for tt data tvlv
	97	* @BATADV_TT_OGM_DIFF: TT diff propagated through OGM
	98	* @BATADV_TT_REQUEST: TT request message
	99	* @BATADV_TT_RESPONSE: TT response message
	100	* @BATADV_TT_FULL_TABLE: contains full table to replace existing table
	101	*/
	102	enum batadv_tt_data_flags {
	103	BATADV_TT_OGM_DIFF = BIT(0),
	104	BATADV_TT_REQUEST = BIT(1),
	105	BATADV_TT_RESPONSE = BIT(2),
	106	BATADV_TT_FULL_TABLE = BIT(4),
a73105b8 AQ	107	};
a73105b8 AQ	108
acd34afa	109	/* BATADV_TT_CLIENT flags.
8de47de5	110	* Flags from BIT(0) to BIT(7) are sent on the wire, while flags from BIT(8) to
0eb01568 AQ	111	* BIT(15) are used for local computation only.
0eb01568 AQ	112	* Flags from BIT(4) to BIT(7) are kept in sync with the rest of the network.
9cfc7bd6	113	*/
acd34afa	114	enum batadv_tt_client_flags {
8de47de5 SE	115	BATADV_TT_CLIENT_DEL = BIT(0),
8de47de5 SE	116	BATADV_TT_CLIENT_ROAM = BIT(1),
0eb01568	117	BATADV_TT_CLIENT_WIFI = BIT(4),
8de47de5 SE	118	BATADV_TT_CLIENT_NOPURGE = BIT(8),
	119	BATADV_TT_CLIENT_NEW = BIT(9),
	120	BATADV_TT_CLIENT_PENDING = BIT(10),
0035f97e	121	BATADV_TT_CLIENT_TEMP = BIT(11),
a73105b8 AQ	122	};
a73105b8 AQ	123
c018ad3d AQ	124	/**
	125	* batadv_vlan_flags - flags for the four MSB of any vlan ID field
	126	* @BATADV_VLAN_HAS_TAG: whether the field contains a valid vlan tag or not
	127	*/
	128	enum batadv_vlan_flags {
	129	BATADV_VLAN_HAS_TAG = BIT(15),
	130	};
	131
23721387	132	/* claim frame types for the bridge loop avoidance */
acd34afa	133	enum batadv_bla_claimframe {
3eb8773e SW	134	BATADV_CLAIM_TYPE_CLAIM = 0x00,
3eb8773e SW	135	BATADV_CLAIM_TYPE_UNCLAIM = 0x01,
acd34afa SE	136	BATADV_CLAIM_TYPE_ANNOUNCE = 0x02,
acd34afa SE	137	BATADV_CLAIM_TYPE_REQUEST = 0x03,
23721387 SW	138	};
23721387 SW	139
414254e3 ML	140	/**
	141	* enum batadv_tvlv_type - tvlv type definitions
	142	* @BATADV_TVLV_GW: gateway tvlv
17cf0ea4	143	* @BATADV_TVLV_DAT: distributed arp table tvlv
3f4841ff	144	* @BATADV_TVLV_NC: network coding tvlv
e1bf0c14	145	* @BATADV_TVLV_TT: translation table tvlv
122edaa0	146	* @BATADV_TVLV_ROAM: roaming advertisement tvlv
414254e3 ML	147	*/
	148	enum batadv_tvlv_type {
	149	BATADV_TVLV_GW = 0x01,
17cf0ea4	150	BATADV_TVLV_DAT = 0x02,
3f4841ff	151	BATADV_TVLV_NC = 0x03,
e1bf0c14	152	BATADV_TVLV_TT = 0x04,
122edaa0	153	BATADV_TVLV_ROAM = 0x05,
414254e3 ML	154	};
414254e3 ML	155
2f7a3182	156	#pragma pack(2)
23721387 SW	157	/* the destination hardware field in the ARP frame is used to
	158	* transport the claim type and the group id
	159	*/
96412690	160	struct batadv_bla_claim_dst {
23721387 SW	161	uint8_t magic[3]; /* FF:43:05 */
23721387 SW	162	uint8_t type; /* bla_claimframe */
3e2f1a1b	163	__be16 group; /* group id */
f6c57a46	164	};
2f7a3182	165	#pragma pack()
23721387	166
ef261577 ML	167	/**
ef261577 ML	168	* struct batadv_ogm_packet - ogm (routing protocol) packet
a40d9b07 SW	169	* @packet_type: batman-adv packet type, part of the general header
	170	* @version: batman-adv protocol version, part of the genereal header
	171	* @ttl: time to live for this packet, part of the genereal header
18c68d59	172	* @flags: contains routing relevant flags - see enum batadv_iv_flags
ef261577 ML	173	* @tvlv_len: length of tvlv data following the ogm header
ef261577 ML	174	*/
96412690	175	struct batadv_ogm_packet {
a40d9b07 SW	176	uint8_t packet_type;
	177	uint8_t version;
	178	uint8_t ttl;
18c68d59	179	uint8_t flags;
e0f5211f	180	__be32 seqno;
c1faead3 AQ	181	uint8_t orig[ETH_ALEN];
c1faead3 AQ	182	uint8_t prev_sender[ETH_ALEN];
414254e3	183	uint8_t reserved;
3b27ffb0	184	uint8_t tq;
ef261577	185	__be16 tvlv_len;
9284a47e SW	186	/* __packed is not needed as the struct size is divisible by 4,
	187	* and the largest data type in this struct has a size of 4.
	188	*/
	189	};
c6c8fea2	190
96412690	191	#define BATADV_OGM_HLEN sizeof(struct batadv_ogm_packet)
c6c8fea2	192
0bf84c16	193	/**
27a417e6	194	* batadv_icmp_header - common members among all the ICMP packets
a40d9b07 SW	195	* @packet_type: batman-adv packet type, part of the general header
	196	* @version: batman-adv protocol version, part of the genereal header
	197	* @ttl: time to live for this packet, part of the genereal header
0bf84c16 AQ	198	* @msg_type: ICMP packet type
	199	* @dst: address of the destination node
	200	* @orig: address of the source node
	201	* @uid: local ICMP socket identifier
27a417e6 AQ	202	* @align: not used - useful for alignment purposes only
	203	*
	204	* This structure is used for ICMP packets parsing only and it is never sent
	205	* over the wire. The alignment field at the end is there to ensure that
	206	* members are padded the same way as they are in real packets.
0bf84c16 AQ	207	*/
0bf84c16 AQ	208	struct batadv_icmp_header {
a40d9b07 SW	209	uint8_t packet_type;
	210	uint8_t version;
	211	uint8_t ttl;
3b27ffb0	212	uint8_t msg_type; /* see ICMP message types above */
c1faead3 AQ	213	uint8_t dst[ETH_ALEN];
c1faead3 AQ	214	uint8_t orig[ETH_ALEN];
c6c8fea2	215	uint8_t uid;
27a417e6	216	uint8_t align[3];
0bf84c16 AQ	217	};
	218
	219	/**
	220	* batadv_icmp_packet - ICMP packet
27a417e6 AQ	221	* @packet_type: batman-adv packet type, part of the general header
	222	* @version: batman-adv protocol version, part of the genereal header
	223	* @ttl: time to live for this packet, part of the genereal header
	224	* @msg_type: ICMP packet type
	225	* @dst: address of the destination node
	226	* @orig: address of the source node
	227	* @uid: local ICMP socket identifier
0bf84c16 AQ	228	* @reserved: not used - useful for alignment
	229	* @seqno: ICMP sequence number
	230	*/
	231	struct batadv_icmp_packet {
27a417e6 AQ	232	uint8_t packet_type;
	233	uint8_t version;
	234	uint8_t ttl;
	235	uint8_t msg_type; /* see ICMP message types above */
	236	uint8_t dst[ETH_ALEN];
	237	uint8_t orig[ETH_ALEN];
	238	uint8_t uid;
3b27ffb0	239	uint8_t reserved;
0bf84c16	240	__be16 seqno;
f6c57a46	241	};
c6c8fea2	242
7e071c79	243	#define BATADV_RR_LEN 16
c6c8fea2	244
0bf84c16 AQ	245	/**
0bf84c16 AQ	246	* batadv_icmp_packet_rr - ICMP RouteRecord packet
27a417e6 AQ	247	* @packet_type: batman-adv packet type, part of the general header
	248	* @version: batman-adv protocol version, part of the genereal header
	249	* @ttl: time to live for this packet, part of the genereal header
	250	* @msg_type: ICMP packet type
	251	* @dst: address of the destination node
	252	* @orig: address of the source node
	253	* @uid: local ICMP socket identifier
0bf84c16 AQ	254	* @rr_cur: number of entries the rr array
	255	* @seqno: ICMP sequence number
	256	* @rr: route record array
9cfc7bd6	257	*/
96412690	258	struct batadv_icmp_packet_rr {
27a417e6 AQ	259	uint8_t packet_type;
	260	uint8_t version;
	261	uint8_t ttl;
	262	uint8_t msg_type; /* see ICMP message types above */
	263	uint8_t dst[ETH_ALEN];
	264	uint8_t orig[ETH_ALEN];
	265	uint8_t uid;
c6c8fea2	266	uint8_t rr_cur;
0bf84c16	267	__be16 seqno;
7e071c79	268	uint8_t rr[BATADV_RR_LEN][ETH_ALEN];
f6c57a46	269	};
c6c8fea2	270
da6b8c20 SW	271	#define BATADV_ICMP_MAX_PACKET_SIZE sizeof(struct batadv_icmp_packet_rr)
da6b8c20 SW	272
e022b956 SE	273	/* All packet headers in front of an ethernet header have to be completely
	274	* divisible by 2 but not by 4 to make the payload after the ethernet
	275	* header again 4 bytes boundary aligned.
	276	*
	277	* A packing of 2 is necessary to avoid extra padding at the end of the struct
	278	* caused by a structure member which is larger than two bytes. Otherwise
	279	* the structure would not fulfill the previously mentioned rule to avoid the
	280	* misalignment of the payload after the ethernet header. It may also lead to
	281	* leakage of information when the padding it not initialized before sending.
	282	*/
	283	#pragma pack(2)
	284
a40d9b07 SW	285	/**
	286	* struct batadv_unicast_packet - unicast packet for network payload
	287	* @packet_type: batman-adv packet type, part of the general header
	288	* @version: batman-adv protocol version, part of the genereal header
	289	* @ttl: time to live for this packet, part of the genereal header
	290	* @ttvn: translation table version number
	291	* @dest: originator destination of the unicast packet
	292	*/
96412690	293	struct batadv_unicast_packet {
a40d9b07 SW	294	uint8_t packet_type;
	295	uint8_t version;
	296	uint8_t ttl;
a73105b8	297	uint8_t ttvn; /* destination translation table version number */
c1faead3	298	uint8_t dest[ETH_ALEN];
f6c57a46 SE	299	/* "4 bytes boundary + 2 bytes" long to make the payload after the
	300	* following ethernet header again 4 bytes boundary aligned
	301	*/
	302	};
c6c8fea2	303
7cdcf6dd AQ	304	/**
	305	* struct batadv_unicast_4addr_packet - extended unicast packet
	306	* @u: common unicast packet header
	307	* @src: address of the source
	308	* @subtype: packet subtype
	309	*/
	310	struct batadv_unicast_4addr_packet {
	311	struct batadv_unicast_packet u;
	312	uint8_t src[ETH_ALEN];
	313	uint8_t subtype;
	314	uint8_t reserved;
	315	/* "4 bytes boundary + 2 bytes" long to make the payload after the
	316	* following ethernet header again 4 bytes boundary aligned
	317	*/
	318	};
	319
610bfc6b MH	320	/**
610bfc6b MH	321	* struct batadv_frag_packet - fragmented packet
a40d9b07 SW	322	* @packet_type: batman-adv packet type, part of the general header
	323	* @version: batman-adv protocol version, part of the genereal header
	324	* @ttl: time to live for this packet, part of the genereal header
610bfc6b MH	325	* @dest: final destination used when routing fragments
	326	* @orig: originator of the fragment used when merging the packet
	327	* @no: fragment number within this sequence
	328	* @reserved: reserved byte for alignment
	329	* @seqno: sequence identification
	330	* @total_size: size of the merged packet
	331	*/
	332	struct batadv_frag_packet {
a40d9b07 SW	333	uint8_t packet_type;
	334	uint8_t version; /* batman version field */
	335	uint8_t ttl;
610bfc6b MH	336	#if defined(__BIG_ENDIAN_BITFIELD)
	337	uint8_t no:4;
	338	uint8_t reserved:4;
	339	#elif defined(__LITTLE_ENDIAN_BITFIELD)
	340	uint8_t reserved:4;
	341	uint8_t no:4;
	342	#else
	343	#error "unknown bitfield endianess"
	344	#endif
	345	uint8_t dest[ETH_ALEN];
	346	uint8_t orig[ETH_ALEN];
	347	__be16 seqno;
	348	__be16 total_size;
	349	};
	350
a40d9b07 SW	351	/**
	352	* struct batadv_bcast_packet - broadcast packet for network payload
	353	* @packet_type: batman-adv packet type, part of the general header
	354	* @version: batman-adv protocol version, part of the genereal header
	355	* @ttl: time to live for this packet, part of the genereal header
	356	* @reserved: reserved byte for alignment
	357	* @seqno: sequence identification
	358	* @orig: originator of the broadcast packet
	359	*/
96412690	360	struct batadv_bcast_packet {
a40d9b07 SW	361	uint8_t packet_type;
	362	uint8_t version; /* batman version field */
	363	uint8_t ttl;
3b27ffb0	364	uint8_t reserved;
3e2f1a1b	365	__be32 seqno;
c1faead3	366	uint8_t orig[ETH_ALEN];
f6c57a46 SE	367	/* "4 bytes boundary + 2 bytes" long to make the payload after the
	368	* following ethernet header again 4 bytes boundary aligned
	369	*/
e022b956 SE	370	};
e022b956 SE	371
3c12de9a MH	372	/**
3c12de9a MH	373	* struct batadv_coded_packet - network coded packet
a40d9b07 SW	374	* @packet_type: batman-adv packet type, part of the general header
	375	* @version: batman-adv protocol version, part of the genereal header
	376	* @ttl: time to live for this packet, part of the genereal header
3c12de9a MH	377	* @reserved: Align following fields to 2-byte boundaries
	378	* @first_source: original source of first included packet
	379	* @first_orig_dest: original destinal of first included packet
	380	* @first_crc: checksum of first included packet
	381	* @first_ttvn: tt-version number of first included packet
	382	* @second_ttl: ttl of second packet
	383	* @second_dest: second receiver of this coded packet
	384	* @second_source: original source of second included packet
	385	* @second_orig_dest: original destination of second included packet
	386	* @second_crc: checksum of second included packet
	387	* @second_ttvn: tt version number of second included packet
	388	* @coded_len: length of network coded part of the payload
	389	*/
	390	struct batadv_coded_packet {
a40d9b07 SW	391	uint8_t packet_type;
	392	uint8_t version; /* batman version field */
	393	uint8_t ttl;
3c12de9a MH	394	uint8_t first_ttvn;
	395	/* uint8_t first_dest[ETH_ALEN]; - saved in mac header destination */
	396	uint8_t first_source[ETH_ALEN];
	397	uint8_t first_orig_dest[ETH_ALEN];
	398	__be32 first_crc;
	399	uint8_t second_ttl;
	400	uint8_t second_ttvn;
	401	uint8_t second_dest[ETH_ALEN];
	402	uint8_t second_source[ETH_ALEN];
	403	uint8_t second_orig_dest[ETH_ALEN];
	404	__be32 second_crc;
e6a0b495	405	__be16 coded_len;
3c12de9a MH	406	};
3c12de9a MH	407
46b76e0b SW	408	#pragma pack()
46b76e0b SW	409
ef261577 ML	410	/**
ef261577 ML	411	* struct batadv_unicast_tvlv - generic unicast packet with tvlv payload
a40d9b07 SW	412	* @packet_type: batman-adv packet type, part of the general header
	413	* @version: batman-adv protocol version, part of the genereal header
	414	* @ttl: time to live for this packet, part of the genereal header
ef261577 ML	415	* @reserved: reserved field (for packet alignment)
	416	* @src: address of the source
	417	* @dst: address of the destination
	418	* @tvlv_len: length of tvlv data following the unicast tvlv header
	419	* @align: 2 bytes to align the header to a 4 byte boundry
	420	*/
	421	struct batadv_unicast_tvlv_packet {
a40d9b07 SW	422	uint8_t packet_type;
	423	uint8_t version; /* batman version field */
	424	uint8_t ttl;
ef261577 ML	425	uint8_t reserved;
	426	uint8_t dst[ETH_ALEN];
	427	uint8_t src[ETH_ALEN];
	428	__be16 tvlv_len;
	429	uint16_t align;
	430	};
	431
	432	/**
	433	* struct batadv_tvlv_hdr - base tvlv header struct
	434	* @type: tvlv container type (see batadv_tvlv_type)
	435	* @version: tvlv container version
	436	* @len: tvlv container length
	437	*/
	438	struct batadv_tvlv_hdr {
	439	uint8_t type;
	440	uint8_t version;
	441	__be16 len;
	442	};
	443
414254e3 ML	444	/**
	445	* struct batadv_tvlv_gateway_data - gateway data propagated through gw tvlv
	446	* container
	447	* @bandwidth_down: advertised uplink download bandwidth
	448	* @bandwidth_up: advertised uplink upload bandwidth
	449	*/
	450	struct batadv_tvlv_gateway_data {
	451	__be32 bandwidth_down;
	452	__be32 bandwidth_up;
	453	};
	454
e1bf0c14 ML	455	/**
	456	* struct batadv_tvlv_tt_data - tt data propagated through the tt tvlv container
	457	* @flags: translation table flags (see batadv_tt_data_flags)
	458	* @ttvn: translation table version number
7ea7b4a1 AQ	459	* @vlan_num: number of announced VLANs. In the TVLV this struct is followed by
7ea7b4a1 AQ	460	* one batadv_tvlv_tt_vlan_data object per announced vlan
e1bf0c14 ML	461	*/
	462	struct batadv_tvlv_tt_data {
	463	uint8_t flags;
	464	uint8_t ttvn;
7ea7b4a1 AQ	465	__be16 num_vlan;
	466	};
	467
	468	/**
	469	* struct batadv_tvlv_tt_vlan_data - vlan specific tt data propagated through
	470	* the tt tvlv container
	471	* @crc: crc32 checksum of the entries belonging to this vlan
	472	* @vid: vlan identifier
	473	* @reserved: unused, useful for alignment purposes
	474	*/
	475	struct batadv_tvlv_tt_vlan_data {
	476	__be32 crc;
	477	__be16 vid;
ced72933	478	uint16_t reserved;
e1bf0c14 ML	479	};
	480
	481	/**
	482	* struct batadv_tvlv_tt_change - translation table diff data
	483	* @flags: status indicators concerning the non-mesh client (see
	484	* batadv_tt_client_flags)
ca663046	485	* @reserved: reserved field - useful for alignment purposes only
e1bf0c14	486	* @addr: mac address of non-mesh client that triggered this tt change
c018ad3d	487	* @vid: VLAN identifier
e1bf0c14 ML	488	*/
	489	struct batadv_tvlv_tt_change {
	490	uint8_t flags;
ca663046	491	uint8_t reserved[3];
e1bf0c14	492	uint8_t addr[ETH_ALEN];
c018ad3d	493	__be16 vid;
e1bf0c14 ML	494	};
e1bf0c14 ML	495
122edaa0 ML	496	/**
	497	* struct batadv_tvlv_roam_adv - roaming advertisement
	498	* @client: mac address of roaming client
c018ad3d	499	* @vid: VLAN identifier
122edaa0 ML	500	*/
	501	struct batadv_tvlv_roam_adv {
	502	uint8_t client[ETH_ALEN];
c018ad3d	503	__be16 vid;
122edaa0 ML	504	};
122edaa0 ML	505
c6c8fea2	506	#endif /* _NET_BATMAN_ADV_PACKET_H_ */