[mirror_ubuntu-jammy-kernel.git] / net / batman-adv / Kconfig

# SPDX-License-Identifier: GPL-2.0
# Copyright (C) B.A.T.M.A.N. contributors:
#
# Marek Lindner, Simon Wunderlich

#
# B.A.T.M.A.N meshing protocol
#

config BATMAN_ADV
	tristate "B.A.T.M.A.N. Advanced Meshing Protocol"
	select LIBCRC32C
	help
	  B.A.T.M.A.N. (better approach to mobile ad-hoc networking) is
	  a routing protocol for multi-hop ad-hoc mesh networks. The
	  networks may be wired or wireless. See
	  https://www.open-mesh.org/ for more information and user space
	  tools.

config BATMAN_ADV_BATMAN_V
	bool "B.A.T.M.A.N. V protocol"
	depends on BATMAN_ADV && !(CFG80211=m && BATMAN_ADV=y)
	default y
	help
	  This option enables the B.A.T.M.A.N. V protocol, the successor
	  of the currently used B.A.T.M.A.N. IV protocol. The main
	  changes include splitting of the OGM protocol into a neighbor
	  discovery protocol (Echo Location Protocol, ELP) and a new OGM
	  Protocol OGMv2 for flooding protocol information through the
	  network, as well as a throughput based metric.
	  B.A.T.M.A.N. V is currently considered experimental and not
	  compatible to B.A.T.M.A.N. IV networks.

config BATMAN_ADV_BLA
	bool "Bridge Loop Avoidance"
	depends on BATMAN_ADV && INET
	select CRC16
	default y
	help
	  This option enables BLA (Bridge Loop Avoidance), a mechanism
	  to avoid Ethernet frames looping when mesh nodes are connected
	  to both the same LAN and the same mesh. If you will never use
	  more than one mesh node in the same LAN, you can safely remove
	  this feature and save some space.

config BATMAN_ADV_DAT
	bool "Distributed ARP Table"
	depends on BATMAN_ADV && INET
	default y
	help
	  This option enables DAT (Distributed ARP Table), a DHT based
	  mechanism that increases ARP reliability on sparse wireless
	  mesh networks. If you think that your network does not need
	  this option you can safely remove it and save some space.

config BATMAN_ADV_NC
	bool "Network Coding"
	depends on BATMAN_ADV
	help
	  This option enables network coding, a mechanism that aims to
	  increase the overall network throughput by fusing multiple
	  packets in one transmission.
	  Note that interfaces controlled by batman-adv must be manually
	  configured to have promiscuous mode enabled in order to make
	  network coding work.
	  If you think that your network does not need this feature you
	  can safely disable it and save some space.

config BATMAN_ADV_MCAST
	bool "Multicast optimisation"
	depends on BATMAN_ADV && INET && !(BRIDGE=m && BATMAN_ADV=y)
	default y
	help
	  This option enables the multicast optimisation which aims to
	  reduce the air overhead while improving the reliability of
	  multicast messages.

config BATMAN_ADV_DEBUG
	bool "B.A.T.M.A.N. debugging"
	depends on BATMAN_ADV
	help
	  This is an option for use by developers; most people should
	  say N here. This enables compilation of support for
	  outputting debugging information to the tracing buffer. The output is
	  controlled via the batadv netdev specific log_level setting.

config BATMAN_ADV_TRACING
	bool "B.A.T.M.A.N. tracing support"
	depends on BATMAN_ADV
	depends on EVENT_TRACING
	help
	  This is an option for use by developers; most people should
	  say N here. Select this option to gather traces like the debug
	  messages using the generic tracing infrastructure of the kernel.
	  BATMAN_ADV_DEBUG must also be selected to get trace events for
	  batadv_dbg.
Commit	Line	Data
9969ffa8	1	# SPDX-License-Identifier: GPL-2.0
cfa55c6d	2	# Copyright (C) B.A.T.M.A.N. contributors:
9969ffa8 SE	3	#
9969ffa8 SE	4	# Marek Lindner, Simon Wunderlich
9969ffa8	5
c6c8fea2 SE	6	#
	7	# B.A.T.M.A.N meshing protocol
	8	#
	9
	10	config BATMAN_ADV
	11	tristate "B.A.T.M.A.N. Advanced Meshing Protocol"
95a066d8	12	select LIBCRC32C
10e3cd6a	13	help
bf69abad KK	14	B.A.T.M.A.N. (better approach to mobile ad-hoc networking) is
	15	a routing protocol for multi-hop ad-hoc mesh networks. The
	16	networks may be wired or wireless. See
	17	https://www.open-mesh.org/ for more information and user space
	18	tools.
c6c8fea2	19
d6f94d91	20	config BATMAN_ADV_BATMAN_V
951a06e7	21	bool "B.A.T.M.A.N. V protocol"
0566df30	22	depends on BATMAN_ADV && !(CFG80211=m && BATMAN_ADV=y)
18cfb44c	23	default y
d6f94d91 LL	24	help
	25	This option enables the B.A.T.M.A.N. V protocol, the successor
	26	of the currently used B.A.T.M.A.N. IV protocol. The main
	27	changes include splitting of the OGM protocol into a neighbor
	28	discovery protocol (Echo Location Protocol, ELP) and a new OGM
	29	Protocol OGMv2 for flooding protocol information through the
	30	network, as well as a throughput based metric.
	31	B.A.T.M.A.N. V is currently considered experimental and not
	32	compatible to B.A.T.M.A.N. IV networks.
	33
7a5cc242 SW	34	config BATMAN_ADV_BLA
7a5cc242 SW	35	bool "Bridge Loop Avoidance"
17224474	36	depends on BATMAN_ADV && INET
fb939135	37	select CRC16
7a5cc242 SW	38	default y
	39	help
	40	This option enables BLA (Bridge Loop Avoidance), a mechanism
	41	to avoid Ethernet frames looping when mesh nodes are connected
	42	to both the same LAN and the same mesh. If you will never use
	43	more than one mesh node in the same LAN, you can safely remove
	44	this feature and save some space.
c6c8fea2	45
17224474 AQ	46	config BATMAN_ADV_DAT
	47	bool "Distributed ARP Table"
	48	depends on BATMAN_ADV && INET
ab4e5853	49	default y
17224474 AQ	50	help
	51	This option enables DAT (Distributed ARP Table), a DHT based
	52	mechanism that increases ARP reliability on sparse wireless
	53	mesh networks. If you think that your network does not need
	54	this option you can safely remove it and save some space.
	55
d353d8d4 MH	56	config BATMAN_ADV_NC
	57	bool "Network Coding"
	58	depends on BATMAN_ADV
d353d8d4 MH	59	help
	60	This option enables network coding, a mechanism that aims to
	61	increase the overall network throughput by fusing multiple
	62	packets in one transmission.
	63	Note that interfaces controlled by batman-adv must be manually
	64	configured to have promiscuous mode enabled in order to make
	65	network coding work.
	66	If you think that your network does not need this feature you
	67	can safely disable it and save some space.
	68
c5caf4ef LL	69	config BATMAN_ADV_MCAST
c5caf4ef LL	70	bool "Multicast optimisation"
687937ab	71	depends on BATMAN_ADV && INET && !(BRIDGE=m && BATMAN_ADV=y)
016fd285	72	default y
c5caf4ef LL	73	help
	74	This option enables the multicast optimisation which aims to
	75	reduce the air overhead while improving the reliability of
	76	multicast messages.
	77
dc1cbd14 SE	78	config BATMAN_ADV_DEBUG
dc1cbd14 SE	79	bool "B.A.T.M.A.N. debugging"
0dacc7fa	80	depends on BATMAN_ADV
10e3cd6a	81	help
c6c8fea2 SE	82	This is an option for use by developers; most people should
c6c8fea2 SE	83	say N here. This enables compilation of support for
aff6f5a6 SE	84	outputting debugging information to the tracing buffer. The output is
aff6f5a6 SE	85	controlled via the batadv netdev specific log_level setting.
d331a739 SE	86
	87	config BATMAN_ADV_TRACING
	88	bool "B.A.T.M.A.N. tracing support"
	89	depends on BATMAN_ADV
	90	depends on EVENT_TRACING
	91	help
	92	This is an option for use by developers; most people should
	93	say N here. Select this option to gather traces like the debug
	94	messages using the generic tracing infrastructure of the kernel.
	95	BATMAN_ADV_DEBUG must also be selected to get trace events for
	96	batadv_dbg.