[u-boot.git] / net / Kconfig

#
# Network configuration
#

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 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 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_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 || ARCH_RENESAS)
	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

source "net/lwip/Kconfig"

if NET || NET_LWIP

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 operating system over the network, using the PXE (Preboot
	  Execution Environment) protocol.

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 WGET
	bool "Enable wget"
	select PROT_TCP if NET
	select PROT_TCP_LWIP if NET_LWIP
	select PROT_DNS_LWIP if NET_LWIP
	help
	  Selecting this will enable wget, an interface to send HTTP requests
	  via the network stack.

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.

endif   # if NET || NET_LWIP

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