[J-u-boot.git] / net / Kconfig

#
# Network configuration
#

menuconfig NET
	bool "Networking support"
	default y
	imply NETDEVICES

if NET

config ARP_TIMEOUT
	int "Milliseconds before trying ARP again"
	default 5000

config NET_RETRY_COUNT
	int "Number of timeouts before giving up"
	default 5
	help
	  This variable defines the number of retries for network operations
	  like ARP, RARP, TFTP, or BOOTP before giving up the operation.

config PROT_UDP
	bool "Enable generic udp framework"
	help
	  Enable a generic udp framework that allows defining a custom
	  handler for udp protocol.

config BOOTDEV_ETH
	bool "Enable bootdev for ethernet"
	depends on BOOTSTD
	default y
	help
	  Provide a bootdev for ethernet so that is it possible to boot
	  an operationg system over the network, using the PXE (Preboot
	  Execution Environment) protocol.

config BOOTP_SEND_HOSTNAME
	bool "Send hostname to DNS server"
	help
	  Some DHCP servers are capable to do a dynamic update of a
	  DNS server. To do this, they need the hostname of the DHCP
	  requester.
	  If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
	  of the "hostname" environment variable is passed as
	  option 12 to the DHCP server.

config NET_RANDOM_ETHADDR
	bool "Random ethaddr if unset"
	help
	  Selecting this will allow the Ethernet interface to function even
	  when the ethaddr variable for that interface is unset.  In this case,
	  a random MAC address in the locally administered address space is
	  generated. It will be saved to the appropriate environment variable,
	  too.

config NETCONSOLE
	bool "NetConsole support"
	help
	  Support the 'nc' input/output device for networked console.
	  See doc/usage/netconsole.rst for details.

config IP_DEFRAG
	bool "Support IP datagram reassembly"
	help
	  Selecting this will enable IP datagram reassembly according
	  to the algorithm in RFC815.

config NET_MAXDEFRAG
	int "Size of buffer used for IP datagram reassembly"
	depends on IP_DEFRAG
	default 16384
	range 1024 65536
	help
	  This defines the size of the statically allocated buffer
	  used for reassembly, and thus an upper bound for the size of
	  IP datagrams that can be received.

config SYS_FAULT_ECHO_LINK_DOWN
	bool "Echo the inverted Ethernet link state to the fault LED"
	help
	  Echo the inverted Ethernet link state to the fault LED.  Note, if
	  this option is active, then CONFIG_SYS_FAULT_MII_ADDR also needs to
	  be configured.

config TFTP_BLOCKSIZE
	int "TFTP block size"
	default 1468
	help
	  Default TFTP block size.
	  The MTU is typically 1500 for ethernet, so a TFTP block of
	  1468 (MTU minus eth.hdrs) provides a good throughput with
	  almost-MTU block sizes.
	  You can also activate CONFIG_IP_DEFRAG to set a larger block.

config TFTP_PORT
	bool "Set TFTP UDP source/destination ports via the environment"
	help
	  If this is defined, the environment variable tftpsrcp is used to
	  supply the TFTP UDP source port value.  If tftpsrcp isn't defined,
	  the normal pseudo-random port number generator is used.

	  Also, the environment variable tftpdstp is used to supply the TFTP
	  UDP destination port value.  If tftpdstp isn't defined, the normal
	  port 69 is used.

	  The purpose for tftpsrcp is to allow a TFTP server to blindly start
	  the TFTP transfer using the pre-configured target IP address and UDP
	  port. This has the effect of "punching through" the (Windows XP)
	  firewall, allowing the remainder of the TFTP transfer to proceed
	  normally.  A better solution is to properly configure the firewall,
	  but sometimes that is not allowed.

config TFTP_WINDOWSIZE
	int "TFTP window size"
	default 1
	help
	  Default TFTP window size.
	  RFC7440 defines an optional window size of transmits,
	  before an ack response is required.
	  The default TFTP implementation implies a window size of 1.

config TFTP_TSIZE
	bool "Track TFTP transfers based on file size option"
	depends on CMD_TFTPBOOT
	default y if (ARCH_OMAP2PLUS || ARCH_K3)
	help
	  By default, TFTP progress bar is increased for each received UDP
	  frame, which can lead into long time being spent for sending
	  data over the UART. Enabling this option, TFTP queries the file
	  size from server, and if supported, limits the progress bar to
	  50 characters total which fits on single line.

config SERVERIP_FROM_PROXYDHCP
	bool "Get serverip value from Proxy DHCP response"
	help
	  Allows bootfile config to be fetched from Proxy DHCP server
		while IP is obtained from main DHCP server.

config SERVERIP_FROM_PROXYDHCP_DELAY_MS
	int "# of additional milliseconds to wait for ProxyDHCP response"
	default 100
	help
	  Amount of additional time to wait for ProxyDHCP response after
		receiving response from main DHCP server. Has no effect if
		SERVERIP_FROM_PROXYDHCP is false.

config KEEP_SERVERADDR
	bool "Write the server's MAC address to 'serveraddr'"
	default y if SANDBOX
	help
	  Keeps the server's MAC address, in the env 'serveraddr'
	  for passing to bootargs (like Linux's netconsole option). If this is
	  enabled, when an ARP reply is received, the server's IP address is
	  written there.

config UDP_CHECKSUM
	bool "Check the UDP checksum"
	default y if SANDBOX
	help
	  Enable this to verify the checksum on UDP packets. If the checksum
	  is wrong then the packet is discarded and an error is shown, like
	  "UDP wrong checksum 29374a23 30ff3826"

config BOOTP_SERVERIP
	bool "Use the 'serverip' env var for tftp, not bootp"
	help
	  Enable this if the TFTP server will be the 'serverip' environment
	  variable, not the BOOTP server. This affects the operation of both
	  bootp and tftp.

config BOOTP_MAX_ROOT_PATH_LEN
	int "Option 17 root path length"
	default 64
	help
	  Select maximal length of option 17 root path.

config USE_GATEWAYIP
	bool "Set a default 'gateway' value in the environment"
	help
	  Defines a default value for the IP address of the default router
	  where packets to other networks are sent to.  (Environment variable
	  "gatewayip")

config GATEWAYIP
	string "Value of the default 'gateway' value in the environment"
	depends on USE_GATEWAYIP

config USE_IPADDR
	bool "Set a default 'ipaddr' value in the environment"
	help
	  Define a default value for the IP address to use for the default
	  Ethernet interface, in case this is not determined through e.g.
	  bootp.  (Environment variable "ipaddr")

config IPADDR
	string "Value of the default 'ipaddr' value in the environment"
	depends on USE_IPADDR

config USE_NETMASK
	bool "Set a default 'netmask' value in the environment"
	help
	  Defines a default value for the subnet mask (or routing prefix) which
	  is used to determine if an IP address belongs to the local subnet or
	  needs to be forwarded through a router.  (Environment variable "netmask")

config NETMASK
	string "Value of the default 'netmask' value in the environment"
	depends on USE_NETMASK

config USE_ROOTPATH
	bool "Set a default 'rootpath' value in the environment"

config ROOTPATH
	string "Value of the default 'rootpath' value in the environment"
	depends on USE_ROOTPATH
	default "/opt/nfsroot"

config USE_SERVERIP
	bool "Set a default 'serverip' value in the environment"
	help
	  Defines a default value for the IP address of a TFTP server to
	  contact when using the "tftboot" command.  (Environment variable
	  "serverip")

config SERVERIP
	string "Value of the default 'serverip' value in the environment"
	depends on USE_SERVERIP

config PROT_TCP
	bool "TCP stack"
	help
	  Enable a generic tcp framework that allows defining a custom
	  handler for tcp protocol.

config PROT_TCP_SACK
	bool "TCP SACK support"
	depends on PROT_TCP
	help
	  TCP protocol with SACK. SACK means selective acknowledgements.
	  By turning this option on TCP will learn what segments are already
	  received. So that it improves TCP's retransmission efficiency.
	  This option should be turn on if you want to achieve the fastest
	  file transfer possible.

config IPV6
	bool "IPv6 support"
	help
	  Enable IPv6 support. It includes Neighbour Discovery protocol, ICMPv6
	  and auxiliary stuff to make it work. Since it is enabled u-boot
	  network subsystem can get and handle incoming packets and send packets
	  through IPv6 network. It allows to use environment variables such as
	  ip6addr, serverip6. If a u-boot command is capable to parse an IPv6
	  address and find it, it will force using IPv6 in the network stack.

endif   # if NET

config SYS_RX_ETH_BUFFER
	int "Number of receive packet buffers"
	default 4
	help
	  Defines the number of Ethernet receive buffers. On some Ethernet
	  controllers it is recommended to set this value to 8 or even higher,
	  since all buffers can be full shortly after enabling the interface on
	  high Ethernet traffic.
Commit	Line	Data
ed36323f MY	1	#
	2	# Network configuration
	3	#
	4
	5	menuconfig NET
	6	bool "Networking support"
3b3ea2c5	7	default y
f4449038	8	imply NETDEVICES
ed36323f MY	9
	10	if NET
	11
5d4e863b TR	12	config ARP_TIMEOUT
	13	int "Milliseconds before trying ARP again"
	14	default 5000
	15
01d1b99c TR	16	config NET_RETRY_COUNT
	17	int "Number of timeouts before giving up"
	18	default 5
	19	help
	20	This variable defines the number of retries for network operations
	21	like ARP, RARP, TFTP, or BOOTP before giving up the operation.
	22
b43ea1bf PR	23	config PROT_UDP
	24	bool "Enable generic udp framework"
	25	help
	26	Enable a generic udp framework that allows defining a custom
	27	handler for udp protocol.
4fd8d077 SG	28
	29	config BOOTDEV_ETH
	30	bool "Enable bootdev for ethernet"
	31	depends on BOOTSTD
	32	default y
	33	help
	34	Provide a bootdev for ethernet so that is it possible to boot
	35	an operationg system over the network, using the PXE (Preboot
	36	Execution Environment) protocol.
b43ea1bf	37
3275f26b AF	38	config BOOTP_SEND_HOSTNAME
	39	bool "Send hostname to DNS server"
	40	help
	41	Some DHCP servers are capable to do a dynamic update of a
	42	DNS server. To do this, they need the hostname of the DHCP
	43	requester.
	44	If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
608a88c2 AM	45	of the "hostname" environment variable is passed as
608a88c2 AM	46	option 12 to the DHCP server.
3275f26b	47
bef1014b JH	48	config NET_RANDOM_ETHADDR
	49	bool "Random ethaddr if unset"
	50	help
381e6e54 MS	51	Selecting this will allow the Ethernet interface to function even
	52	when the ethaddr variable for that interface is unset. In this case,
	53	a random MAC address in the locally administered address space is
	54	generated. It will be saved to the appropriate environment variable,
	55	too.
bef1014b	56
26660748 BN	57	config NETCONSOLE
	58	bool "NetConsole support"
	59	help
	60	Support the 'nc' input/output device for networked console.
b5712acb	61	See doc/usage/netconsole.rst for details.
26660748	62
3f6bcdf6 MV	63	config IP_DEFRAG
3f6bcdf6 MV	64	bool "Support IP datagram reassembly"
3f6bcdf6 MV	65	help
	66	Selecting this will enable IP datagram reassembly according
	67	to the algorithm in RFC815.
	68
215df01d RV	69	config NET_MAXDEFRAG
	70	int "Size of buffer used for IP datagram reassembly"
	71	depends on IP_DEFRAG
	72	default 16384
	73	range 1024 65536
	74	help
	75	This defines the size of the statically allocated buffer
	76	used for reassembly, and thus an upper bound for the size of
	77	IP datagrams that can be received.
	78
1d5686ac TR	79	config SYS_FAULT_ECHO_LINK_DOWN
	80	bool "Echo the inverted Ethernet link state to the fault LED"
	81	help
	82	Echo the inverted Ethernet link state to the fault LED. Note, if
	83	this option is active, then CONFIG_SYS_FAULT_MII_ADDR also needs to
	84	be configured.
	85
b618b370 MV	86	config TFTP_BLOCKSIZE
b618b370 MV	87	int "TFTP block size"
16cdc2da	88	default 1468
b618b370 MV	89	help
b618b370 MV	90	Default TFTP block size.
421de7fe PD	91	The MTU is typically 1500 for ethernet, so a TFTP block of
	92	1468 (MTU minus eth.hdrs) provides a good throughput with
	93	almost-MTU block sizes.
	94	You can also activate CONFIG_IP_DEFRAG to set a larger block.
b618b370	95
5842c810 TR	96	config TFTP_PORT
	97	bool "Set TFTP UDP source/destination ports via the environment"
	98	help
	99	If this is defined, the environment variable tftpsrcp is used to
	100	supply the TFTP UDP source port value. If tftpsrcp isn't defined,
	101	the normal pseudo-random port number generator is used.
	102
	103	Also, the environment variable tftpdstp is used to supply the TFTP
	104	UDP destination port value. If tftpdstp isn't defined, the normal
	105	port 69 is used.
	106
	107	The purpose for tftpsrcp is to allow a TFTP server to blindly start
	108	the TFTP transfer using the pre-configured target IP address and UDP
	109	port. This has the effect of "punching through" the (Windows XP)
	110	firewall, allowing the remainder of the TFTP transfer to proceed
	111	normally. A better solution is to properly configure the firewall,
	112	but sometimes that is not allowed.
	113
cc6b87ec RF	114	config TFTP_WINDOWSIZE
	115	int "TFTP window size"
	116	default 1
	117	help
	118	Default TFTP window size.
	119	RFC7440 defines an optional window size of transmits,
	120	before an ack response is required.
	121	The default TFTP implementation implies a window size of 1.
	122
2509493c TK	123	config TFTP_TSIZE
	124	bool "Track TFTP transfers based on file size option"
	125	depends on CMD_TFTPBOOT
	126	default y if (ARCH_OMAP2PLUS \|\| ARCH_K3)
	127	help
	128	By default, TFTP progress bar is increased for each received UDP
	129	frame, which can lead into long time being spent for sending
	130	data over the UART. Enabling this option, TFTP queries the file
	131	size from server, and if supported, limits the progress bar to
	132	50 characters total which fits on single line.
	133
c8e251f8 LF	134	config SERVERIP_FROM_PROXYDHCP
	135	bool "Get serverip value from Proxy DHCP response"
	136	help
	137	Allows bootfile config to be fetched from Proxy DHCP server
	138	while IP is obtained from main DHCP server.
	139
	140	config SERVERIP_FROM_PROXYDHCP_DELAY_MS
	141	int "# of additional milliseconds to wait for ProxyDHCP response"
	142	default 100
	143	help
	144	Amount of additional time to wait for ProxyDHCP response after
	145	receiving response from main DHCP server. Has no effect if
	146	SERVERIP_FROM_PROXYDHCP is false.
	147
3df6cd4d SG	148	config KEEP_SERVERADDR
	149	bool "Write the server's MAC address to 'serveraddr'"
	150	default y if SANDBOX
	151	help
	152	Keeps the server's MAC address, in the env 'serveraddr'
	153	for passing to bootargs (like Linux's netconsole option). If this is
	154	enabled, when an ARP reply is received, the server's IP address is
	155	written there.
	156
4b37fd14 SG	157	config UDP_CHECKSUM
4b37fd14 SG	158	bool "Check the UDP checksum"
d6b318de	159	default y if SANDBOX
4b37fd14 SG	160	help
4b37fd14 SG	161	Enable this to verify the checksum on UDP packets. If the checksum
3c07d639	162	is wrong then the packet is discarded and an error is shown, like
4b37fd14 SG	163	"UDP wrong checksum 29374a23 30ff3826"
4b37fd14 SG	164
d3877fba SG	165	config BOOTP_SERVERIP
	166	bool "Use the 'serverip' env var for tftp, not bootp"
	167	help
	168	Enable this if the TFTP server will be the 'serverip' environment
	169	variable, not the BOOTP server. This affects the operation of both
	170	bootp and tftp.
	171
5e6e41b3 AK	172	config BOOTP_MAX_ROOT_PATH_LEN
	173	int "Option 17 root path length"
	174	default 64
	175	help
	176	Select maximal length of option 17 root path.
	177
54f80dd2 TR	178	config USE_GATEWAYIP
	179	bool "Set a default 'gateway' value in the environment"
	180	help
	181	Defines a default value for the IP address of the default router
	182	where packets to other networks are sent to. (Environment variable
	183	"gatewayip")
	184
	185	config GATEWAYIP
	186	string "Value of the default 'gateway' value in the environment"
	187	depends on USE_GATEWAYIP
	188
	189	config USE_IPADDR
	190	bool "Set a default 'ipaddr' value in the environment"
	191	help
	192	Define a default value for the IP address to use for the default
	193	Ethernet interface, in case this is not determined through e.g.
	194	bootp. (Environment variable "ipaddr")
	195
	196	config IPADDR
	197	string "Value of the default 'ipaddr' value in the environment"
	198	depends on USE_IPADDR
	199
	200	config USE_NETMASK
	201	bool "Set a default 'netmask' value in the environment"
	202	help
	203	Defines a default value for the subnet mask (or routing prefix) which
	204	is used to determine if an IP address belongs to the local subnet or
	205	needs to be forwarded through a router. (Environment variable "netmask")
	206
	207	config NETMASK
	208	string "Value of the default 'netmask' value in the environment"
	209	depends on USE_NETMASK
	210
	211	config USE_ROOTPATH
	212	bool "Set a default 'rootpath' value in the environment"
	213
	214	config ROOTPATH
	215	string "Value of the default 'rootpath' value in the environment"
	216	depends on USE_ROOTPATH
	217	default "/opt/nfsroot"
	218
	219	config USE_SERVERIP
	220	bool "Set a default 'serverip' value in the environment"
	221	help
	222	Defines a default value for the IP address of a TFTP server to
	223	contact when using the "tftboot" command. (Environment variable
	224	"serverip")
	225
	226	config SERVERIP
	227	string "Value of the default 'serverip' value in the environment"
	228	depends on USE_SERVERIP
	229
a3bf193b YCLP	230	config PROT_TCP
	231	bool "TCP stack"
	232	help
	233	Enable a generic tcp framework that allows defining a custom
	234	handler for tcp protocol.
	235
	236	config PROT_TCP_SACK
	237	bool "TCP SACK support"
	238	depends on PROT_TCP
	239	help
	240	TCP protocol with SACK. SACK means selective acknowledgements.
	241	By turning this option on TCP will learn what segments are already
	242	received. So that it improves TCP's retransmission efficiency.
	243	This option should be turn on if you want to achieve the fastest
	244	file transfer possible.
	245
3cc04a3a VM	246	config IPV6
	247	bool "IPv6 support"
	248	help
	249	Enable IPv6 support. It includes Neighbour Discovery protocol, ICMPv6
	250	and auxiliary stuff to make it work. Since it is enabled u-boot
	251	network subsystem can get and handle incoming packets and send packets
	252	through IPv6 network. It allows to use environment variables such as
	253	ip6addr, serverip6. If a u-boot command is capable to parse an IPv6
	254	address and find it, it will force using IPv6 in the network stack.
	255
ed36323f	256	endif # if NET
0b956e39 TR	257
	258	config SYS_RX_ETH_BUFFER
	259	int "Number of receive packet buffers"
	260	default 4
	261	help
	262	Defines the number of Ethernet receive buffers. On some Ethernet
	263	controllers it is recommended to set this value to 8 or even higher,
	264	since all buffers can be full shortly after enabling the interface on
	265	high Ethernet traffic.