[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, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301, USA
 */

#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
 */
enum batadv_tt_client_flags {
	BATADV_TT_CLIENT_DEL     = BIT(0),
	BATADV_TT_CLIENT_ROAM    = BIT(1),
	BATADV_TT_CLIENT_WIFI    = BIT(2),
	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,
};

/* 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 */
};

struct batadv_header {
	uint8_t  packet_type;
	uint8_t  version;  /* batman version field */
	uint8_t  ttl;
	/* the parent struct has to add a byte after the header to make
	 * everything 4 bytes aligned again
	 */
};

/**
 * struct batadv_ogm_packet - ogm (routing protocol) packet
 * @header: common batman packet 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 {
	struct batadv_header header;
	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 ICMP header
 * @header: common batman header
 * @msg_type: ICMP packet type
 * @dst: address of the destination node
 * @orig: address of the source node
 * @uid: local ICMP socket identifier
 */
struct batadv_icmp_header {
	struct batadv_header header;
	uint8_t  msg_type; /* see ICMP message types above */
	uint8_t  dst[ETH_ALEN];
	uint8_t  orig[ETH_ALEN];
	uint8_t  uid;
};

/**
 * batadv_icmp_packet - ICMP packet
 * @icmph: common ICMP header
 * @reserved: not used - useful for alignment
 * @seqno: ICMP sequence number
 */
struct batadv_icmp_packet {
	struct batadv_icmp_header icmph;
	uint8_t  reserved;
	__be16   seqno;
};

#define BATADV_RR_LEN 16

/**
 * batadv_icmp_packet_rr - ICMP RouteRecord packet
 * @icmph: common ICMP header
 * @rr_cur: number of entries the rr array
 * @seqno: ICMP sequence number
 * @rr: route record array
 */
struct batadv_icmp_packet_rr {
	struct batadv_icmp_header icmph;
	uint8_t  rr_cur;
	__be16   seqno;
	uint8_t  rr[BATADV_RR_LEN][ETH_ALEN];
};

/* 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 {
	struct batadv_header header;
	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
 * @header: common batman packet header with type, compatversion, and ttl
 * @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 {
	struct  batadv_header header;
#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 {
	struct batadv_header header;
	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
	 */
};

#pragma pack()

/**
 * struct batadv_coded_packet - network coded packet
 * @header: common batman packet header and ttl of first included packet
 * @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 {
	struct batadv_header header;
	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;
};

/**
 * struct batadv_unicast_tvlv - generic unicast packet with tvlv payload
 * @header: common batman packet 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 {
	struct batadv_header header;
	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
 * @reserved: field reserved for future use
 * @crc: crc32 checksum of the local translation table
 */
struct batadv_tvlv_tt_data {
	uint8_t flags;
	uint8_t ttvn;
	uint16_t reserved;
	__be32  crc;
};

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