[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 {
	BATADV_NOT_BEST_NEXT_HOP   = BIT(3),
	BATADV_PRIMARIES_FIRST_HOP = BIT(4),
	BATADV_DIRECTLINK	   = BIT(6),
};

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

/* fragmentation defines */
enum batadv_unicast_frag_flags {
	BATADV_UNI_FRAG_HEAD	  = BIT(0),
	BATADV_UNI_FRAG_LARGETAIL = BIT(1),
};

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

/* 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
 * @tvlv_len: length of tvlv data following the ogm header
 */
struct batadv_ogm_packet {
	struct batadv_header header;
	uint8_t  flags;    /* 0x40: DIRECTLINK flag ... */
	__be32   seqno;
	uint8_t  orig[ETH_ALEN];
	uint8_t  prev_sender[ETH_ALEN];
	uint8_t  reserved;
	uint8_t  tq;
	__be16   tvlv_len;
} __packed;

#define BATADV_OGM_HLEN sizeof(struct batadv_ogm_packet)

struct batadv_icmp_packet {
	struct batadv_header header;
	uint8_t  msg_type; /* see ICMP message types above */
	uint8_t  dst[ETH_ALEN];
	uint8_t  orig[ETH_ALEN];
	__be16   seqno;
	uint8_t  uid;
	uint8_t  reserved;
};

#define BATADV_RR_LEN 16

/* icmp_packet_rr must start with all fields from imcp_packet
 * as this is assumed by code that handles ICMP packets
 */
struct batadv_icmp_packet_rr {
	struct batadv_header header;
	uint8_t  msg_type; /* see ICMP message types above */
	uint8_t  dst[ETH_ALEN];
	uint8_t  orig[ETH_ALEN];
	__be16   seqno;
	uint8_t  uid;
	uint8_t  rr_cur;
	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_unicast_frag_packet {
	struct batadv_header header;
	uint8_t  ttvn; /* destination translation table version number */
	uint8_t  dest[ETH_ALEN];
	uint8_t  flags;
	uint8_t  align;
	uint8_t  orig[ETH_ALEN];
	__be16   seqno;
} __packed;

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
 */
struct batadv_tvlv_tt_change {
	uint8_t flags;
	uint8_t reserved;
	uint8_t addr[ETH_ALEN];
};

/**
 * struct batadv_tvlv_roam_adv - roaming advertisement
 * @client: mac address of roaming client
 * @reserved: field reserved for future use
 */
struct batadv_tvlv_roam_adv {
	uint8_t  client[ETH_ALEN];
	uint16_t reserved;
};

#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
acd34afa	70	enum batadv_iv_flags {
8de47de5 SE	71	BATADV_NOT_BEST_NEXT_HOP = BIT(3),
8de47de5 SE	72	BATADV_PRIMARIES_FIRST_HOP = BIT(4),
8de47de5	73	BATADV_DIRECTLINK = BIT(6),
e8958dbf	74	};
c6c8fea2 SE	75
c6c8fea2 SE	76	/* ICMP message types */
acd34afa SE	77	enum batadv_icmp_packettype {
	78	BATADV_ECHO_REPLY = 0,
	79	BATADV_DESTINATION_UNREACHABLE = 3,
	80	BATADV_ECHO_REQUEST = 8,
	81	BATADV_TTL_EXCEEDED = 11,
	82	BATADV_PARAMETER_PROBLEM = 12,
e8958dbf	83	};
c6c8fea2	84
c6c8fea2	85	/* fragmentation defines */
acd34afa	86	enum batadv_unicast_frag_flags {
8de47de5 SE	87	BATADV_UNI_FRAG_HEAD = BIT(0),
8de47de5 SE	88	BATADV_UNI_FRAG_LARGETAIL = BIT(1),
e8958dbf	89	};
c6c8fea2	90
e1bf0c14 ML	91	/* tt data subtypes */
e1bf0c14 ML	92	#define BATADV_TT_DATA_TYPE_MASK 0x0F
a73105b8	93
e1bf0c14 ML	94	/**
	95	* enum batadv_tt_data_flags - flags for tt data tvlv
	96	* @BATADV_TT_OGM_DIFF: TT diff propagated through OGM
	97	* @BATADV_TT_REQUEST: TT request message
	98	* @BATADV_TT_RESPONSE: TT response message
	99	* @BATADV_TT_FULL_TABLE: contains full table to replace existing table
	100	*/
	101	enum batadv_tt_data_flags {
	102	BATADV_TT_OGM_DIFF = BIT(0),
	103	BATADV_TT_REQUEST = BIT(1),
	104	BATADV_TT_RESPONSE = BIT(2),
	105	BATADV_TT_FULL_TABLE = BIT(4),
a73105b8 AQ	106	};
a73105b8 AQ	107
acd34afa	108	/* BATADV_TT_CLIENT flags.
8de47de5 SE	109	* Flags from BIT(0) to BIT(7) are sent on the wire, while flags from BIT(8) to
8de47de5 SE	110	* BIT(15) are used for local computation only
9cfc7bd6	111	*/
acd34afa	112	enum batadv_tt_client_flags {
8de47de5 SE	113	BATADV_TT_CLIENT_DEL = BIT(0),
	114	BATADV_TT_CLIENT_ROAM = BIT(1),
	115	BATADV_TT_CLIENT_WIFI = BIT(2),
	116	BATADV_TT_CLIENT_NOPURGE = BIT(8),
	117	BATADV_TT_CLIENT_NEW = BIT(9),
	118	BATADV_TT_CLIENT_PENDING = BIT(10),
0035f97e	119	BATADV_TT_CLIENT_TEMP = BIT(11),
a73105b8 AQ	120	};
a73105b8 AQ	121
23721387	122	/* claim frame types for the bridge loop avoidance */
acd34afa	123	enum batadv_bla_claimframe {
3eb8773e SW	124	BATADV_CLAIM_TYPE_CLAIM = 0x00,
3eb8773e SW	125	BATADV_CLAIM_TYPE_UNCLAIM = 0x01,
acd34afa SE	126	BATADV_CLAIM_TYPE_ANNOUNCE = 0x02,
acd34afa SE	127	BATADV_CLAIM_TYPE_REQUEST = 0x03,
23721387 SW	128	};
23721387 SW	129
414254e3 ML	130	/**
	131	* enum batadv_tvlv_type - tvlv type definitions
	132	* @BATADV_TVLV_GW: gateway tvlv
17cf0ea4	133	* @BATADV_TVLV_DAT: distributed arp table tvlv
3f4841ff	134	* @BATADV_TVLV_NC: network coding tvlv
e1bf0c14	135	* @BATADV_TVLV_TT: translation table tvlv
122edaa0	136	* @BATADV_TVLV_ROAM: roaming advertisement tvlv
414254e3 ML	137	*/
	138	enum batadv_tvlv_type {
	139	BATADV_TVLV_GW = 0x01,
17cf0ea4	140	BATADV_TVLV_DAT = 0x02,
3f4841ff	141	BATADV_TVLV_NC = 0x03,
e1bf0c14	142	BATADV_TVLV_TT = 0x04,
122edaa0	143	BATADV_TVLV_ROAM = 0x05,
414254e3 ML	144	};
414254e3 ML	145
23721387 SW	146	/* the destination hardware field in the ARP frame is used to
	147	* transport the claim type and the group id
	148	*/
96412690	149	struct batadv_bla_claim_dst {
23721387 SW	150	uint8_t magic[3]; /* FF:43:05 */
23721387 SW	151	uint8_t type; /* bla_claimframe */
3e2f1a1b	152	__be16 group; /* group id */
f6c57a46	153	};
23721387	154
96412690	155	struct batadv_header {
c6c8fea2 SE	156	uint8_t packet_type;
c6c8fea2 SE	157	uint8_t version; /* batman version field */
3b27ffb0	158	uint8_t ttl;
f6c57a46 SE	159	/* the parent struct has to add a byte after the header to make
	160	* everything 4 bytes aligned again
	161	*/
	162	};
76543d14	163
ef261577 ML	164	/**
	165	* struct batadv_ogm_packet - ogm (routing protocol) packet
	166	* @header: common batman packet header
	167	* @tvlv_len: length of tvlv data following the ogm header
	168	*/
96412690 SE	169	struct batadv_ogm_packet {
96412690 SE	170	struct batadv_header header;
9f4980e6	171	uint8_t flags; /* 0x40: DIRECTLINK flag ... */
e0f5211f	172	__be32 seqno;
c1faead3 AQ	173	uint8_t orig[ETH_ALEN];
c1faead3 AQ	174	uint8_t prev_sender[ETH_ALEN];
414254e3	175	uint8_t reserved;
3b27ffb0	176	uint8_t tq;
ef261577	177	__be16 tvlv_len;
aa0adb1a	178	} __packed;
c6c8fea2	179
96412690	180	#define BATADV_OGM_HLEN sizeof(struct batadv_ogm_packet)
c6c8fea2	181
96412690 SE	182	struct batadv_icmp_packet {
96412690 SE	183	struct batadv_header header;
3b27ffb0	184	uint8_t msg_type; /* see ICMP message types above */
c1faead3 AQ	185	uint8_t dst[ETH_ALEN];
c1faead3 AQ	186	uint8_t orig[ETH_ALEN];
3e2f1a1b	187	__be16 seqno;
c6c8fea2	188	uint8_t uid;
3b27ffb0	189	uint8_t reserved;
f6c57a46	190	};
c6c8fea2	191
7e071c79	192	#define BATADV_RR_LEN 16
c6c8fea2 SE	193
c6c8fea2 SE	194	/* icmp_packet_rr must start with all fields from imcp_packet
9cfc7bd6 SE	195	* as this is assumed by code that handles ICMP packets
9cfc7bd6 SE	196	*/
96412690 SE	197	struct batadv_icmp_packet_rr {
96412690 SE	198	struct batadv_header header;
3b27ffb0	199	uint8_t msg_type; /* see ICMP message types above */
c1faead3 AQ	200	uint8_t dst[ETH_ALEN];
c1faead3 AQ	201	uint8_t orig[ETH_ALEN];
3e2f1a1b	202	__be16 seqno;
c6c8fea2 SE	203	uint8_t uid;
c6c8fea2 SE	204	uint8_t rr_cur;
7e071c79	205	uint8_t rr[BATADV_RR_LEN][ETH_ALEN];
f6c57a46	206	};
c6c8fea2	207
e022b956 SE	208	/* All packet headers in front of an ethernet header have to be completely
	209	* divisible by 2 but not by 4 to make the payload after the ethernet
	210	* header again 4 bytes boundary aligned.
	211	*
	212	* A packing of 2 is necessary to avoid extra padding at the end of the struct
	213	* caused by a structure member which is larger than two bytes. Otherwise
	214	* the structure would not fulfill the previously mentioned rule to avoid the
	215	* misalignment of the payload after the ethernet header. It may also lead to
	216	* leakage of information when the padding it not initialized before sending.
	217	*/
	218	#pragma pack(2)
	219
96412690 SE	220	struct batadv_unicast_packet {
96412690 SE	221	struct batadv_header header;
a73105b8	222	uint8_t ttvn; /* destination translation table version number */
c1faead3	223	uint8_t dest[ETH_ALEN];
f6c57a46 SE	224	/* "4 bytes boundary + 2 bytes" long to make the payload after the
	225	* following ethernet header again 4 bytes boundary aligned
	226	*/
	227	};
c6c8fea2	228
7cdcf6dd AQ	229	/**
	230	* struct batadv_unicast_4addr_packet - extended unicast packet
	231	* @u: common unicast packet header
	232	* @src: address of the source
	233	* @subtype: packet subtype
	234	*/
	235	struct batadv_unicast_4addr_packet {
	236	struct batadv_unicast_packet u;
	237	uint8_t src[ETH_ALEN];
	238	uint8_t subtype;
	239	uint8_t reserved;
	240	/* "4 bytes boundary + 2 bytes" long to make the payload after the
	241	* following ethernet header again 4 bytes boundary aligned
	242	*/
	243	};
	244
96412690 SE	245	struct batadv_unicast_frag_packet {
96412690 SE	246	struct batadv_header header;
a73105b8	247	uint8_t ttvn; /* destination translation table version number */
c1faead3	248	uint8_t dest[ETH_ALEN];
c6c8fea2	249	uint8_t flags;
3b27ffb0	250	uint8_t align;
c1faead3	251	uint8_t orig[ETH_ALEN];
3e2f1a1b	252	__be16 seqno;
aa0adb1a	253	} __packed;
c6c8fea2	254
96412690 SE	255	struct batadv_bcast_packet {
96412690 SE	256	struct batadv_header header;
3b27ffb0	257	uint8_t reserved;
3e2f1a1b	258	__be32 seqno;
c1faead3	259	uint8_t orig[ETH_ALEN];
f6c57a46 SE	260	/* "4 bytes boundary + 2 bytes" long to make the payload after the
	261	* following ethernet header again 4 bytes boundary aligned
	262	*/
e022b956 SE	263	};
	264
	265	#pragma pack()
c6c8fea2	266
3c12de9a MH	267	/**
	268	* struct batadv_coded_packet - network coded packet
	269	* @header: common batman packet header and ttl of first included packet
	270	* @reserved: Align following fields to 2-byte boundaries
	271	* @first_source: original source of first included packet
	272	* @first_orig_dest: original destinal of first included packet
	273	* @first_crc: checksum of first included packet
	274	* @first_ttvn: tt-version number of first included packet
	275	* @second_ttl: ttl of second packet
	276	* @second_dest: second receiver of this coded packet
	277	* @second_source: original source of second included packet
	278	* @second_orig_dest: original destination of second included packet
	279	* @second_crc: checksum of second included packet
	280	* @second_ttvn: tt version number of second included packet
	281	* @coded_len: length of network coded part of the payload
	282	*/
	283	struct batadv_coded_packet {
	284	struct batadv_header header;
	285	uint8_t first_ttvn;
	286	/* uint8_t first_dest[ETH_ALEN]; - saved in mac header destination */
	287	uint8_t first_source[ETH_ALEN];
	288	uint8_t first_orig_dest[ETH_ALEN];
	289	__be32 first_crc;
	290	uint8_t second_ttl;
	291	uint8_t second_ttvn;
	292	uint8_t second_dest[ETH_ALEN];
	293	uint8_t second_source[ETH_ALEN];
	294	uint8_t second_orig_dest[ETH_ALEN];
	295	__be32 second_crc;
e6a0b495	296	__be16 coded_len;
3c12de9a MH	297	};
3c12de9a MH	298
ef261577 ML	299	/**
	300	* struct batadv_unicast_tvlv - generic unicast packet with tvlv payload
	301	* @header: common batman packet header
	302	* @reserved: reserved field (for packet alignment)
	303	* @src: address of the source
	304	* @dst: address of the destination
	305	* @tvlv_len: length of tvlv data following the unicast tvlv header
	306	* @align: 2 bytes to align the header to a 4 byte boundry
	307	*/
	308	struct batadv_unicast_tvlv_packet {
	309	struct batadv_header header;
	310	uint8_t reserved;
	311	uint8_t dst[ETH_ALEN];
	312	uint8_t src[ETH_ALEN];
	313	__be16 tvlv_len;
	314	uint16_t align;
	315	};
	316
	317	/**
	318	* struct batadv_tvlv_hdr - base tvlv header struct
	319	* @type: tvlv container type (see batadv_tvlv_type)
	320	* @version: tvlv container version
	321	* @len: tvlv container length
	322	*/
	323	struct batadv_tvlv_hdr {
	324	uint8_t type;
	325	uint8_t version;
	326	__be16 len;
	327	};
	328
414254e3 ML	329	/**
	330	* struct batadv_tvlv_gateway_data - gateway data propagated through gw tvlv
	331	* container
	332	* @bandwidth_down: advertised uplink download bandwidth
	333	* @bandwidth_up: advertised uplink upload bandwidth
	334	*/
	335	struct batadv_tvlv_gateway_data {
	336	__be32 bandwidth_down;
	337	__be32 bandwidth_up;
	338	};
	339
e1bf0c14 ML	340	/**
	341	* struct batadv_tvlv_tt_data - tt data propagated through the tt tvlv container
	342	* @flags: translation table flags (see batadv_tt_data_flags)
	343	* @ttvn: translation table version number
ced72933 AQ	344	* @reserved: field reserved for future use
ced72933 AQ	345	* @crc: crc32 checksum of the local translation table
e1bf0c14 ML	346	*/
	347	struct batadv_tvlv_tt_data {
	348	uint8_t flags;
	349	uint8_t ttvn;
ced72933 AQ	350	uint16_t reserved;
ced72933 AQ	351	__be32 crc;
e1bf0c14 ML	352	};
	353
	354	/**
	355	* struct batadv_tvlv_tt_change - translation table diff data
	356	* @flags: status indicators concerning the non-mesh client (see
	357	* batadv_tt_client_flags)
	358	* @reserved: reserved field
	359	* @addr: mac address of non-mesh client that triggered this tt change
	360	*/
	361	struct batadv_tvlv_tt_change {
	362	uint8_t flags;
	363	uint8_t reserved;
	364	uint8_t addr[ETH_ALEN];
	365	};
	366
122edaa0 ML	367	/**
	368	* struct batadv_tvlv_roam_adv - roaming advertisement
	369	* @client: mac address of roaming client
	370	* @reserved: field reserved for future use
	371	*/
	372	struct batadv_tvlv_roam_adv {
	373	uint8_t client[ETH_ALEN];
	374	uint16_t reserved;
	375	};
	376
c6c8fea2	377	#endif /* _NET_BATMAN_ADV_PACKET_H_ */