1 // SPDX-License-Identifier: GPL-2.0
3 * Copied from Linux Monitor (LiMon) - Networking.
5 * Copyright 1994 - 2000 Neil Russell.
7 * Copyright 2000 Roland Borde
8 * Copyright 2000 Paolo Scaffardi
15 * The user interface supports commands for BOOTP, RARP, and TFTP.
16 * Also, we support ARP internally. Depending on available data,
17 * these interact as follows:
21 * Prerequisites: - own ethernet address
22 * We want: - own IP address
23 * - TFTP server IP address
29 * Prerequisites: - own ethernet address
30 * We want: - own IP address
35 * Prerequisites: - own ethernet address
36 * We want: - own IP address
37 * - TFTP server IP address
42 * Prerequisites: - own ethernet address
44 * - TFTP server IP address
45 * We want: - TFTP server ethernet address
50 * Prerequisites: - own ethernet address
51 * We want: - IP, Netmask, ServerIP, Gateway IP
52 * - bootfilename, lease time
57 * Prerequisites: - own ethernet address
59 * - TFTP server IP address
60 * - TFTP server ethernet address
61 * - name of bootfile (if unknown, we use a default name
62 * derived from our own IP address)
63 * We want: - load the boot file
68 * Prerequisites: - own ethernet address
70 * - name of bootfile (if unknown, we use a default name
71 * derived from our own IP address)
72 * We want: - load the boot file
78 * Prerequisites: - own ethernet address
79 * We want: - magic packet or timeout
84 #include <bootstage.h>
88 #include <env_internal.h>
95 #include <net/fastboot_udp.h>
96 #include <net/fastboot_tcp.h>
99 #if defined(CONFIG_CMD_PCAP)
100 #include <net/pcap.h>
103 #if defined(CONFIG_LED_STATUS)
105 #include <status_led.h>
107 #include <watchdog.h>
108 #include <linux/compiler.h>
109 #include <test/test.h>
111 #include <net/wget.h>
115 #if defined(CONFIG_CMD_DNS)
118 #include "link_local.h"
122 #if defined(CONFIG_CMD_WOL)
126 #include "net_rand.h"
128 /** BOOTP EXTENTIONS **/
130 /* Our subnet mask (0=unknown) */
131 struct in_addr net_netmask;
132 /* Our gateways IP address */
133 struct in_addr net_gateway;
134 /* Our DNS IP address */
135 struct in_addr net_dns_server;
136 #if defined(CONFIG_BOOTP_DNS2)
137 /* Our 2nd DNS IP address */
138 struct in_addr net_dns_server2;
140 /* Indicates whether the pxe path prefix / config file was specified in dhcp option */
141 char *pxelinux_configfile;
143 /** END OF BOOTP EXTENTIONS **/
145 /* Our ethernet address */
147 /* Boot server enet address */
148 u8 net_server_ethaddr[6];
149 /* Our IP addr (0 = unknown) */
150 struct in_addr net_ip;
151 /* Server IP addr (0 = unknown) */
152 struct in_addr net_server_ip;
153 /* Current receive packet */
154 uchar *net_rx_packet;
155 /* Current rx packet length */
156 int net_rx_packet_len;
158 static unsigned net_ip_id;
159 /* Ethernet bcast address */
160 const u8 net_bcast_ethaddr[6] = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
161 const u8 net_null_ethaddr[6];
162 #if defined(CONFIG_API) || defined(CONFIG_EFI_LOADER)
163 void (*push_packet)(void *, int len) = 0;
165 /* Network loop state */
166 enum net_loop_state net_state;
167 /* Tried all network devices */
168 int net_restart_wrap;
169 /* Network loop restarted */
170 static int net_restarted;
171 /* At least one device configured */
172 static int net_dev_exists;
174 /* XXX in both little & big endian machines 0xFFFF == ntohs(-1) */
175 /* default is without VLAN */
176 ushort net_our_vlan = 0xFFFF;
178 ushort net_native_vlan = 0xFFFF;
181 char net_boot_file_name[1024];
182 /* Indicates whether the file name was specified on the command line */
183 bool net_boot_file_name_explicit;
184 /* The actual transferred size of the bootfile (in bytes) */
185 u32 net_boot_file_size;
186 /* Boot file size in blocks as reported by the DHCP server */
187 u32 net_boot_file_expected_size_in_blocks;
189 static uchar net_pkt_buf[(PKTBUFSRX+1) * PKTSIZE_ALIGN + PKTALIGN];
190 /* Receive packets */
191 uchar *net_rx_packets[PKTBUFSRX];
192 /* Current UDP RX packet handler */
193 static rxhand_f *udp_packet_handler;
194 /* Current ARP RX packet handler */
195 static rxhand_f *arp_packet_handler;
196 #ifdef CONFIG_CMD_TFTPPUT
197 /* Current ICMP rx handler */
198 static rxhand_icmp_f *packet_icmp_handler;
200 /* Current timeout handler */
201 static thand_f *time_handler;
202 /* Time base value */
203 static ulong time_start;
204 /* Current timeout value */
205 static ulong time_delta;
206 /* THE transmit packet */
207 uchar *net_tx_packet;
209 static int net_check_prereq(enum proto_t protocol);
211 static int net_try_count;
213 int __maybe_unused net_busy_flag;
215 /**********************************************************************/
217 static int on_ipaddr(const char *name, const char *value, enum env_op op,
220 if (flags & H_PROGRAMMATIC)
223 net_ip = string_to_ip(value);
227 U_BOOT_ENV_CALLBACK(ipaddr, on_ipaddr);
229 static int on_gatewayip(const char *name, const char *value, enum env_op op,
232 if (flags & H_PROGRAMMATIC)
235 net_gateway = string_to_ip(value);
239 U_BOOT_ENV_CALLBACK(gatewayip, on_gatewayip);
241 static int on_netmask(const char *name, const char *value, enum env_op op,
244 if (flags & H_PROGRAMMATIC)
247 net_netmask = string_to_ip(value);
251 U_BOOT_ENV_CALLBACK(netmask, on_netmask);
253 static int on_serverip(const char *name, const char *value, enum env_op op,
256 if (flags & H_PROGRAMMATIC)
259 net_server_ip = string_to_ip(value);
263 U_BOOT_ENV_CALLBACK(serverip, on_serverip);
265 static int on_nvlan(const char *name, const char *value, enum env_op op,
268 if (flags & H_PROGRAMMATIC)
271 net_native_vlan = string_to_vlan(value);
275 U_BOOT_ENV_CALLBACK(nvlan, on_nvlan);
277 static int on_vlan(const char *name, const char *value, enum env_op op,
280 if (flags & H_PROGRAMMATIC)
283 net_our_vlan = string_to_vlan(value);
287 U_BOOT_ENV_CALLBACK(vlan, on_vlan);
289 #if defined(CONFIG_CMD_DNS)
290 static int on_dnsip(const char *name, const char *value, enum env_op op,
293 if (flags & H_PROGRAMMATIC)
296 net_dns_server = string_to_ip(value);
300 U_BOOT_ENV_CALLBACK(dnsip, on_dnsip);
304 * Check if autoload is enabled. If so, use either NFS or TFTP to download
307 void net_auto_load(void)
309 #if defined(CONFIG_CMD_NFS) && !defined(CONFIG_SPL_BUILD)
310 const char *s = env_get("autoload");
312 if (s != NULL && strcmp(s, "NFS") == 0) {
313 if (net_check_prereq(NFS)) {
314 /* We aren't expecting to get a serverip, so just accept the assigned IP */
315 if (IS_ENABLED(CONFIG_BOOTP_SERVERIP)) {
316 net_set_state(NETLOOP_SUCCESS);
318 printf("Cannot autoload with NFS\n");
319 net_set_state(NETLOOP_FAIL);
324 * Use NFS to load the bootfile.
330 if (env_get_yesno("autoload") == 0) {
332 * Just use BOOTP/RARP to configure system;
333 * Do not use TFTP to load the bootfile.
335 net_set_state(NETLOOP_SUCCESS);
338 if (net_check_prereq(TFTPGET)) {
339 /* We aren't expecting to get a serverip, so just accept the assigned IP */
340 if (IS_ENABLED(CONFIG_BOOTP_SERVERIP)) {
341 net_set_state(NETLOOP_SUCCESS);
343 printf("Cannot autoload with TFTPGET\n");
344 net_set_state(NETLOOP_FAIL);
351 static int net_init_loop(void)
353 static bool first_call = true;
356 memcpy(net_ethaddr, eth_get_ethaddr(), 6);
358 if (IS_ENABLED(CONFIG_IPV6)) {
359 ip6_make_lladdr(&net_link_local_ip6, net_ethaddr);
360 if (!memcmp(&net_ip6, &net_null_addr_ip6,
361 sizeof(struct in6_addr)))
362 memcpy(&net_ip6, &net_link_local_ip6,
363 sizeof(struct in6_addr));
368 * Not ideal, but there's no way to get the actual error, and I
369 * don't feel like fixing all the users of eth_get_dev to deal
374 if (IS_ENABLED(CONFIG_IPV6_ROUTER_DISCOVERY))
375 if (first_call && use_ip6) {
377 srand_mac(); /* This is for rand used in ip6_send_rs. */
383 static void net_clear_handlers(void)
385 net_set_udp_handler(NULL);
386 net_set_arp_handler(NULL);
387 net_set_timeout_handler(0, NULL);
390 static void net_cleanup_loop(void)
392 net_clear_handlers();
397 static int first_call = 1;
401 * Setup packet buffers, aligned correctly.
405 net_tx_packet = &net_pkt_buf[0] + (PKTALIGN - 1);
406 net_tx_packet -= (ulong)net_tx_packet % PKTALIGN;
407 for (i = 0; i < PKTBUFSRX; i++) {
408 net_rx_packets[i] = net_tx_packet +
409 (i + 1) * PKTSIZE_ALIGN;
413 net_clear_handlers();
415 /* Only need to setup buffer pointers once. */
417 if (IS_ENABLED(CONFIG_PROT_TCP))
418 tcp_set_tcp_state(TCP_CLOSED);
421 return net_init_loop();
424 /**********************************************************************/
426 * Main network processing loop.
429 int net_loop(enum proto_t protocol)
432 enum net_loop_state prev_net_state = net_state;
434 #if defined(CONFIG_CMD_PING)
435 if (protocol != PING)
436 net_ping_ip.s_addr = 0;
441 debug_cond(DEBUG_INT_STATE, "--- net_loop Entry\n");
443 #ifdef CONFIG_PHY_NCSI
444 if (phy_interface_is_ncsi() && protocol != NCSI && !ncsi_active()) {
445 printf("%s: configuring NCSI first\n", __func__);
446 if (net_loop(NCSI) < 0)
448 eth_init_state_only();
453 bootstage_mark_name(BOOTSTAGE_ID_ETH_START, "eth_start");
455 if (eth_is_on_demand_init()) {
464 eth_init_state_only();
468 #ifdef CONFIG_USB_KEYBOARD
471 net_set_state(NETLOOP_CONTINUE);
474 * Start the ball rolling with the given start function. From
475 * here on, this code is a state machine driven by received
476 * packets and timer events.
478 debug_cond(DEBUG_INT_STATE, "--- net_loop Init\n");
481 if (!test_eth_enabled())
484 switch (net_check_prereq(protocol)) {
486 /* network not configured */
488 net_set_state(prev_net_state);
492 /* network device not configured */
497 net_boot_file_size = 0;
499 #ifdef CONFIG_CMD_TFTPBOOT
501 #ifdef CONFIG_CMD_TFTPPUT
504 /* always use ARP to get server ethernet address */
505 tftp_start(protocol);
508 #ifdef CONFIG_CMD_TFTPSRV
513 #if CONFIG_IS_ENABLED(UDP_FUNCTION_FASTBOOT)
515 fastboot_udp_start_server();
518 #if CONFIG_IS_ENABLED(TCP_FUNCTION_FASTBOOT)
520 fastboot_tcp_start_server();
523 #if defined(CONFIG_CMD_DHCP)
527 dhcp_request(); /* Basically same as BOOTP */
531 if (IS_ENABLED(CONFIG_CMD_DHCP6))
534 #if defined(CONFIG_CMD_BOOTP)
541 #if defined(CONFIG_CMD_RARP)
548 #if defined(CONFIG_CMD_PING)
553 #if defined(CONFIG_CMD_PING6)
558 #if defined(CONFIG_CMD_NFS) && !defined(CONFIG_SPL_BUILD)
563 #if defined(CONFIG_CMD_WGET)
568 #if defined(CONFIG_CMD_CDP)
573 #if defined(CONFIG_NETCONSOLE) && !defined(CONFIG_SPL_BUILD)
578 #if defined(CONFIG_CMD_DNS)
583 #if defined(CONFIG_CMD_LINK_LOCAL)
588 #if defined(CONFIG_CMD_WOL)
593 #if defined(CONFIG_PHY_NCSI)
595 ncsi_probe_packages();
599 if (IS_ENABLED(CONFIG_IPV6_ROUTER_DISCOVERY))
606 if (IS_ENABLED(CONFIG_PROT_UDP) && protocol == UDP)
612 #if defined(CONFIG_MII) || defined(CONFIG_CMD_MII)
613 #if defined(CONFIG_SYS_FAULT_ECHO_LINK_DOWN) && \
614 defined(CONFIG_LED_STATUS) && \
615 defined(CONFIG_LED_STATUS_RED)
617 * Echo the inverted link state to the fault LED.
619 if (miiphy_link(eth_get_dev()->name, CONFIG_SYS_FAULT_MII_ADDR))
620 status_led_set(CONFIG_LED_STATUS_RED, CONFIG_LED_STATUS_OFF);
622 status_led_set(CONFIG_LED_STATUS_RED, CONFIG_LED_STATUS_ON);
623 #endif /* CONFIG_SYS_FAULT_ECHO_LINK_DOWN, ... */
624 #endif /* CONFIG_MII, ... */
625 #ifdef CONFIG_USB_KEYBOARD
630 * Main packet reception loop. Loop receiving packets until
631 * someone sets `net_state' to a state that terminates.
635 if (arp_timeout_check() > 0)
636 time_start = get_timer(0);
638 if (IS_ENABLED(CONFIG_IPV6)) {
639 if (use_ip6 && (ndisc_timeout_check() > 0))
640 time_start = get_timer(0);
644 * Check the ethernet for a new packet. The ethernet
645 * receive routine will process it.
646 * Most drivers return the most recent packet size, but not
647 * errors that may have happened.
652 * Abort if ctrl-c was pressed.
655 /* cancel any ARP that may not have completed */
656 net_arp_wait_packet_ip.s_addr = 0;
660 /* Invalidate the last protocol */
661 eth_set_last_protocol(BOOTP);
664 /* include a debug print as well incase the debug
665 messages are directed to stderr */
666 debug_cond(DEBUG_INT_STATE, "--- net_loop Abort!\n");
672 * Check for a timeout, and run the timeout handler
676 ((get_timer(0) - time_start) > time_delta)) {
679 #if defined(CONFIG_MII) || defined(CONFIG_CMD_MII)
680 #if defined(CONFIG_SYS_FAULT_ECHO_LINK_DOWN) && \
681 defined(CONFIG_LED_STATUS) && \
682 defined(CONFIG_LED_STATUS_RED)
684 * Echo the inverted link state to the fault LED.
686 if (miiphy_link(eth_get_dev()->name,
687 CONFIG_SYS_FAULT_MII_ADDR))
688 status_led_set(CONFIG_LED_STATUS_RED,
689 CONFIG_LED_STATUS_OFF);
691 status_led_set(CONFIG_LED_STATUS_RED,
692 CONFIG_LED_STATUS_ON);
693 #endif /* CONFIG_SYS_FAULT_ECHO_LINK_DOWN, ... */
694 #endif /* CONFIG_MII, ... */
695 debug_cond(DEBUG_INT_STATE, "--- net_loop timeout\n");
697 time_handler = (thand_f *)0;
699 } else if (IS_ENABLED(CONFIG_IPV6_ROUTER_DISCOVERY))
700 if (time_handler && protocol == RS)
701 if (!ip6_is_unspecified_addr(&net_gateway6) &&
702 net_prefix_length != 0) {
703 net_set_state(NETLOOP_SUCCESS);
704 net_set_timeout_handler(0, NULL);
707 if (net_state == NETLOOP_FAIL)
708 ret = net_start_again();
711 case NETLOOP_RESTART:
715 case NETLOOP_SUCCESS:
717 if (net_boot_file_size > 0) {
718 printf("Bytes transferred = %u (%x hex)\n",
719 net_boot_file_size, net_boot_file_size);
720 env_set_hex("filesize", net_boot_file_size);
721 env_set_hex("fileaddr", image_load_addr);
723 if (protocol != NETCONS && protocol != NCSI)
726 eth_halt_state_only();
728 eth_set_last_protocol(protocol);
730 ret = net_boot_file_size;
731 debug_cond(DEBUG_INT_STATE, "--- net_loop Success!\n");
736 /* Invalidate the last protocol */
737 eth_set_last_protocol(BOOTP);
738 debug_cond(DEBUG_INT_STATE, "--- net_loop Fail!\n");
742 case NETLOOP_CONTINUE:
748 #ifdef CONFIG_USB_KEYBOARD
751 #ifdef CONFIG_CMD_TFTPPUT
752 /* Clear out the handlers */
753 net_set_udp_handler(NULL);
754 net_set_icmp_handler(NULL);
756 net_set_state(prev_net_state);
758 #if defined(CONFIG_CMD_PCAP)
765 /**********************************************************************/
767 static void start_again_timeout_handler(void)
769 net_set_state(NETLOOP_RESTART);
772 int net_start_again(void)
775 int retry_forever = 0;
776 unsigned long retrycnt = 0;
779 nretry = env_get("netretry");
781 if (!strcmp(nretry, "yes"))
783 else if (!strcmp(nretry, "no"))
785 else if (!strcmp(nretry, "once"))
788 retrycnt = simple_strtoul(nretry, NULL, 0);
794 if ((!retry_forever) && (net_try_count > retrycnt)) {
796 net_set_state(NETLOOP_FAIL);
798 * We don't provide a way for the protocol to return an error,
799 * but this is almost always the reason.
807 #if !defined(CONFIG_NET_DO_NOT_TRY_ANOTHER)
808 eth_try_another(!net_restarted);
811 if (net_restart_wrap) {
812 net_restart_wrap = 0;
813 if (net_dev_exists) {
814 net_set_timeout_handler(10000UL,
815 start_again_timeout_handler);
816 net_set_udp_handler(NULL);
818 net_set_state(NETLOOP_FAIL);
821 net_set_state(NETLOOP_RESTART);
826 /**********************************************************************/
831 static void dummy_handler(uchar *pkt, unsigned dport,
832 struct in_addr sip, unsigned sport,
837 rxhand_f *net_get_udp_handler(void)
839 return udp_packet_handler;
842 void net_set_udp_handler(rxhand_f *f)
844 debug_cond(DEBUG_INT_STATE, "--- net_loop UDP handler set (%p)\n", f);
846 udp_packet_handler = dummy_handler;
848 udp_packet_handler = f;
851 rxhand_f *net_get_arp_handler(void)
853 return arp_packet_handler;
856 void net_set_arp_handler(rxhand_f *f)
858 debug_cond(DEBUG_INT_STATE, "--- net_loop ARP handler set (%p)\n", f);
860 arp_packet_handler = dummy_handler;
862 arp_packet_handler = f;
865 #ifdef CONFIG_CMD_TFTPPUT
866 void net_set_icmp_handler(rxhand_icmp_f *f)
868 packet_icmp_handler = f;
872 void net_set_timeout_handler(ulong iv, thand_f *f)
875 debug_cond(DEBUG_INT_STATE,
876 "--- net_loop timeout handler cancelled\n");
877 time_handler = (thand_f *)0;
879 debug_cond(DEBUG_INT_STATE,
880 "--- net_loop timeout handler set (%p)\n", f);
882 time_start = get_timer(0);
883 time_delta = iv * CONFIG_SYS_HZ / 1000;
887 uchar *net_get_async_tx_pkt_buf(void)
889 if (arp_is_waiting())
890 return arp_tx_packet; /* If we are waiting, we already sent */
892 return net_tx_packet;
895 int net_send_udp_packet(uchar *ether, struct in_addr dest, int dport, int sport,
898 return net_send_ip_packet(ether, dest, dport, sport, payload_len,
899 IPPROTO_UDP, 0, 0, 0);
902 #if defined(CONFIG_PROT_TCP)
903 int net_send_tcp_packet(int payload_len, int dport, int sport, u8 action,
904 u32 tcp_seq_num, u32 tcp_ack_num)
906 return net_send_ip_packet(net_server_ethaddr, net_server_ip, dport,
907 sport, payload_len, IPPROTO_TCP, action,
908 tcp_seq_num, tcp_ack_num);
912 int net_send_ip_packet(uchar *ether, struct in_addr dest, int dport, int sport,
913 int payload_len, int proto, u8 action, u32 tcp_seq_num,
920 /* make sure the net_tx_packet is initialized (net_init() was called) */
921 assert(net_tx_packet != NULL);
922 if (net_tx_packet == NULL)
925 /* convert to new style broadcast */
926 if (dest.s_addr == 0)
927 dest.s_addr = 0xFFFFFFFF;
929 /* if broadcast, make the ether address a broadcast and don't do ARP */
930 if (dest.s_addr == 0xFFFFFFFF)
931 ether = (uchar *)net_bcast_ethaddr;
933 pkt = (uchar *)net_tx_packet;
935 eth_hdr_size = net_set_ether(pkt, ether, PROT_IP);
939 net_set_udp_header(pkt + eth_hdr_size, dest, dport, sport,
941 pkt_hdr_size = eth_hdr_size + IP_UDP_HDR_SIZE;
943 #if defined(CONFIG_PROT_TCP)
945 pkt_hdr_size = eth_hdr_size
946 + tcp_set_tcp_header(pkt + eth_hdr_size, dport, sport,
947 payload_len, action, tcp_seq_num,
955 /* if MAC address was not discovered yet, do an ARP request */
956 if (memcmp(ether, net_null_ethaddr, 6) == 0) {
957 debug_cond(DEBUG_DEV_PKT, "sending ARP for %pI4\n", &dest);
959 /* save the ip and eth addr for the packet to send after arp */
960 net_arp_wait_packet_ip = dest;
961 arp_wait_packet_ethaddr = ether;
963 /* size of the waiting packet */
964 arp_wait_tx_packet_size = pkt_hdr_size + payload_len;
966 /* and do the ARP request */
968 arp_wait_timer_start = get_timer(0);
970 return 1; /* waiting */
972 debug_cond(DEBUG_DEV_PKT, "sending UDP to %pI4/%pM\n",
974 net_send_packet(net_tx_packet, pkt_hdr_size + payload_len);
975 return 0; /* transmitted */
979 #ifdef CONFIG_IP_DEFRAG
981 * This function collects fragments in a single packet, according
982 * to the algorithm in RFC815. It returns NULL or the pointer to
983 * a complete packet, in static storage
985 #define IP_PKTSIZE (CONFIG_NET_MAXDEFRAG)
987 #define IP_MAXUDP (IP_PKTSIZE - IP_HDR_SIZE)
990 * this is the packet being assembled, either data or frag control.
991 * Fragments go by 8 bytes, so this union must be 8 bytes long
994 /* first_byte is address of this structure */
995 u16 last_byte; /* last byte in this hole + 1 (begin of next hole) */
996 u16 next_hole; /* index of next (in 8-b blocks), 0 == none */
997 u16 prev_hole; /* index of prev, 0 == none */
1001 static struct ip_udp_hdr *__net_defragment(struct ip_udp_hdr *ip, int *lenp)
1003 static uchar pkt_buff[IP_PKTSIZE] __aligned(PKTALIGN);
1004 static u16 first_hole, total_len;
1005 struct hole *payload, *thisfrag, *h, *newh;
1006 struct ip_udp_hdr *localip = (struct ip_udp_hdr *)pkt_buff;
1007 uchar *indata = (uchar *)ip;
1008 int offset8, start, len, done = 0;
1009 u16 ip_off = ntohs(ip->ip_off);
1012 * Calling code already rejected <, but we don't have to deal
1013 * with an IP fragment with no payload.
1015 if (ntohs(ip->ip_len) <= IP_HDR_SIZE)
1018 /* payload starts after IP header, this fragment is in there */
1019 payload = (struct hole *)(pkt_buff + IP_HDR_SIZE);
1020 offset8 = (ip_off & IP_OFFS);
1021 thisfrag = payload + offset8;
1022 start = offset8 * 8;
1023 len = ntohs(ip->ip_len) - IP_HDR_SIZE;
1025 /* All but last fragment must have a multiple-of-8 payload. */
1026 if ((len & 7) && (ip_off & IP_FLAGS_MFRAG))
1029 if (start + len > IP_MAXUDP) /* fragment extends too far */
1032 if (!total_len || localip->ip_id != ip->ip_id) {
1033 /* new (or different) packet, reset structs */
1035 payload[0].last_byte = ~0;
1036 payload[0].next_hole = 0;
1037 payload[0].prev_hole = 0;
1039 /* any IP header will work, copy the first we received */
1040 memcpy(localip, ip, IP_HDR_SIZE);
1044 * What follows is the reassembly algorithm. We use the payload
1045 * array as a linked list of hole descriptors, as each hole starts
1046 * at a multiple of 8 bytes. However, last byte can be whatever value,
1047 * so it is represented as byte count, not as 8-byte blocks.
1050 h = payload + first_hole;
1051 while (h->last_byte < start) {
1052 if (!h->next_hole) {
1053 /* no hole that far away */
1056 h = payload + h->next_hole;
1059 /* last fragment may be 1..7 bytes, the "+7" forces acceptance */
1060 if (offset8 + ((len + 7) / 8) <= h - payload) {
1061 /* no overlap with holes (dup fragment?) */
1065 if (!(ip_off & IP_FLAGS_MFRAG)) {
1066 /* no more fragmentss: truncate this (last) hole */
1067 total_len = start + len;
1068 h->last_byte = start + len;
1072 * There is some overlap: fix the hole list. This code deals
1073 * with a fragment that overlaps with two different holes
1074 * (thus being a superset of a previously-received fragment)
1075 * by only using the part of the fragment that fits in the
1078 if (h->last_byte < start + len)
1079 len = h->last_byte - start;
1081 if ((h >= thisfrag) && (h->last_byte <= start + len)) {
1082 /* complete overlap with hole: remove hole */
1083 if (!h->prev_hole && !h->next_hole) {
1084 /* last remaining hole */
1086 } else if (!h->prev_hole) {
1088 first_hole = h->next_hole;
1089 payload[h->next_hole].prev_hole = 0;
1090 } else if (!h->next_hole) {
1092 payload[h->prev_hole].next_hole = 0;
1094 /* in the middle of the list */
1095 payload[h->next_hole].prev_hole = h->prev_hole;
1096 payload[h->prev_hole].next_hole = h->next_hole;
1099 } else if (h->last_byte <= start + len) {
1100 /* overlaps with final part of the hole: shorten this hole */
1101 h->last_byte = start;
1103 } else if (h >= thisfrag) {
1104 /* overlaps with initial part of the hole: move this hole */
1105 newh = thisfrag + (len / 8);
1109 payload[h->next_hole].prev_hole = (h - payload);
1111 payload[h->prev_hole].next_hole = (h - payload);
1113 first_hole = (h - payload);
1116 /* fragment sits in the middle: split the hole */
1117 newh = thisfrag + (len / 8);
1119 h->last_byte = start;
1120 h->next_hole = (newh - payload);
1121 newh->prev_hole = (h - payload);
1122 if (newh->next_hole)
1123 payload[newh->next_hole].prev_hole = (newh - payload);
1126 /* finally copy this fragment and possibly return whole packet */
1127 memcpy((uchar *)thisfrag, indata + IP_HDR_SIZE, len);
1131 *lenp = total_len + IP_HDR_SIZE;
1132 localip->ip_len = htons(*lenp);
1136 static inline struct ip_udp_hdr *net_defragment(struct ip_udp_hdr *ip,
1139 u16 ip_off = ntohs(ip->ip_off);
1140 if (!(ip_off & (IP_OFFS | IP_FLAGS_MFRAG)))
1141 return ip; /* not a fragment */
1142 return __net_defragment(ip, lenp);
1145 #else /* !CONFIG_IP_DEFRAG */
1147 static inline struct ip_udp_hdr *net_defragment(struct ip_udp_hdr *ip,
1150 u16 ip_off = ntohs(ip->ip_off);
1151 if (!(ip_off & (IP_OFFS | IP_FLAGS_MFRAG)))
1152 return ip; /* not a fragment */
1158 * Receive an ICMP packet. We deal with REDIRECT and PING here, and silently
1161 * @parma ip IP packet containing the ICMP
1163 static void receive_icmp(struct ip_udp_hdr *ip, int len,
1164 struct in_addr src_ip, struct ethernet_hdr *et)
1166 struct icmp_hdr *icmph = (struct icmp_hdr *)&ip->udp_src;
1168 switch (icmph->type) {
1170 if (icmph->code != ICMP_REDIR_HOST)
1172 printf(" ICMP Host Redirect to %pI4 ",
1173 &icmph->un.gateway);
1176 #if defined(CONFIG_CMD_PING)
1177 ping_receive(et, ip, len);
1179 #ifdef CONFIG_CMD_TFTPPUT
1180 if (packet_icmp_handler)
1181 packet_icmp_handler(icmph->type, icmph->code,
1182 ntohs(ip->udp_dst), src_ip,
1183 ntohs(ip->udp_src), icmph->un.data,
1184 ntohs(ip->udp_len));
1190 void net_process_received_packet(uchar *in_packet, int len)
1192 struct ethernet_hdr *et;
1193 struct ip_udp_hdr *ip;
1194 struct in_addr dst_ip;
1195 struct in_addr src_ip;
1197 #if defined(CONFIG_CMD_CDP)
1200 ushort cti = 0, vlanid = VLAN_NONE, myvlanid, mynvlanid;
1202 debug_cond(DEBUG_NET_PKT, "packet received\n");
1203 if (DEBUG_NET_PKT_TRACE)
1204 print_hex_dump_bytes("rx: ", DUMP_PREFIX_OFFSET, in_packet,
1207 #if defined(CONFIG_CMD_PCAP)
1208 pcap_post(in_packet, len, false);
1210 net_rx_packet = in_packet;
1211 net_rx_packet_len = len;
1212 et = (struct ethernet_hdr *)in_packet;
1214 /* too small packet? */
1215 if (len < ETHER_HDR_SIZE)
1218 #if defined(CONFIG_API) || defined(CONFIG_EFI_LOADER)
1220 (*push_packet)(in_packet, len);
1225 #if defined(CONFIG_CMD_CDP)
1226 /* keep track if packet is CDP */
1227 iscdp = is_cdp_packet(et->et_dest);
1230 myvlanid = ntohs(net_our_vlan);
1231 if (myvlanid == (ushort)-1)
1232 myvlanid = VLAN_NONE;
1233 mynvlanid = ntohs(net_native_vlan);
1234 if (mynvlanid == (ushort)-1)
1235 mynvlanid = VLAN_NONE;
1237 eth_proto = ntohs(et->et_protlen);
1239 if (eth_proto < 1514) {
1240 struct e802_hdr *et802 = (struct e802_hdr *)et;
1242 * Got a 802.2 packet. Check the other protocol field.
1243 * XXX VLAN over 802.2+SNAP not implemented!
1245 eth_proto = ntohs(et802->et_prot);
1247 ip = (struct ip_udp_hdr *)(in_packet + E802_HDR_SIZE);
1248 len -= E802_HDR_SIZE;
1250 } else if (eth_proto != PROT_VLAN) { /* normal packet */
1251 ip = (struct ip_udp_hdr *)(in_packet + ETHER_HDR_SIZE);
1252 len -= ETHER_HDR_SIZE;
1254 } else { /* VLAN packet */
1255 struct vlan_ethernet_hdr *vet =
1256 (struct vlan_ethernet_hdr *)et;
1258 debug_cond(DEBUG_NET_PKT, "VLAN packet received\n");
1260 /* too small packet? */
1261 if (len < VLAN_ETHER_HDR_SIZE)
1264 /* if no VLAN active */
1265 if ((ntohs(net_our_vlan) & VLAN_IDMASK) == VLAN_NONE
1266 #if defined(CONFIG_CMD_CDP)
1272 cti = ntohs(vet->vet_tag);
1273 vlanid = cti & VLAN_IDMASK;
1274 eth_proto = ntohs(vet->vet_type);
1276 ip = (struct ip_udp_hdr *)(in_packet + VLAN_ETHER_HDR_SIZE);
1277 len -= VLAN_ETHER_HDR_SIZE;
1280 debug_cond(DEBUG_NET_PKT, "Receive from protocol 0x%x\n", eth_proto);
1282 #if defined(CONFIG_CMD_CDP)
1284 cdp_receive((uchar *)ip, len);
1289 if ((myvlanid & VLAN_IDMASK) != VLAN_NONE) {
1290 if (vlanid == VLAN_NONE)
1291 vlanid = (mynvlanid & VLAN_IDMASK);
1293 if (vlanid != (myvlanid & VLAN_IDMASK))
1297 switch (eth_proto) {
1299 arp_receive(et, ip, len);
1302 #ifdef CONFIG_CMD_RARP
1304 rarp_receive(ip, len);
1307 #if IS_ENABLED(CONFIG_IPV6)
1309 net_ip6_handler(et, (struct ip6_hdr *)ip, len);
1313 debug_cond(DEBUG_NET_PKT, "Got IP\n");
1314 /* Before we start poking the header, make sure it is there */
1315 if (len < IP_HDR_SIZE) {
1316 debug("len bad %d < %lu\n", len,
1317 (ulong)IP_HDR_SIZE);
1320 /* Check the packet length */
1321 if (len < ntohs(ip->ip_len)) {
1322 debug("len bad %d < %d\n", len, ntohs(ip->ip_len));
1325 len = ntohs(ip->ip_len);
1326 if (len < IP_HDR_SIZE) {
1327 debug("bad ip->ip_len %d < %d\n", len, (int)IP_HDR_SIZE);
1330 debug_cond(DEBUG_NET_PKT, "len=%d, v=%02x\n",
1331 len, ip->ip_hl_v & 0xff);
1333 /* Can't deal with anything except IPv4 */
1334 if ((ip->ip_hl_v & 0xf0) != 0x40)
1336 /* Can't deal with IP options (headers != 20 bytes) */
1337 if ((ip->ip_hl_v & 0x0f) != 0x05)
1339 /* Check the Checksum of the header */
1340 if (!ip_checksum_ok((uchar *)ip, IP_HDR_SIZE)) {
1341 debug("checksum bad\n");
1344 /* If it is not for us, ignore it */
1345 dst_ip = net_read_ip(&ip->ip_dst);
1346 if (net_ip.s_addr && dst_ip.s_addr != net_ip.s_addr &&
1347 dst_ip.s_addr != 0xFFFFFFFF) {
1350 /* Read source IP address for later use */
1351 src_ip = net_read_ip(&ip->ip_src);
1353 * The function returns the unchanged packet if it's not
1354 * a fragment, and either the complete packet or NULL if
1355 * it is a fragment (if !CONFIG_IP_DEFRAG, it returns NULL)
1357 ip = net_defragment(ip, &len);
1361 * watch for ICMP host redirects
1363 * There is no real handler code (yet). We just watch
1364 * for ICMP host redirect messages. In case anybody
1365 * sees these messages: please contact me
1367 * necessary fixes :-)
1369 * Note: in all cases where I have seen this so far
1370 * it was a problem with the router configuration,
1371 * for instance when a router was configured in the
1372 * BOOTP reply, but the TFTP server was on the same
1373 * subnet. So this is probably a warning that your
1374 * configuration might be wrong. But I'm not really
1375 * sure if there aren't any other situations.
1378 * we send a tftp packet to a dead connection, or when
1379 * there is no server at the other end.
1381 if (ip->ip_p == IPPROTO_ICMP) {
1382 receive_icmp(ip, len, src_ip, et);
1384 #if defined(CONFIG_PROT_TCP)
1385 } else if (ip->ip_p == IPPROTO_TCP) {
1386 debug_cond(DEBUG_DEV_PKT,
1387 "TCP PH (to=%pI4, from=%pI4, len=%d)\n",
1388 &dst_ip, &src_ip, len);
1390 rxhand_tcp_f((union tcp_build_pkt *)ip, len);
1393 } else if (ip->ip_p != IPPROTO_UDP) { /* Only UDP packets */
1397 if (ntohs(ip->udp_len) < UDP_HDR_SIZE || ntohs(ip->udp_len) > len - IP_HDR_SIZE)
1400 debug_cond(DEBUG_DEV_PKT,
1401 "received UDP (to=%pI4, from=%pI4, len=%d)\n",
1402 &dst_ip, &src_ip, len);
1404 if (IS_ENABLED(CONFIG_UDP_CHECKSUM) && ip->udp_xsum != 0) {
1410 xsum += (ntohs(ip->udp_len));
1411 xsum += (ntohl(ip->ip_src.s_addr) >> 16) & 0x0000ffff;
1412 xsum += (ntohl(ip->ip_src.s_addr) >> 0) & 0x0000ffff;
1413 xsum += (ntohl(ip->ip_dst.s_addr) >> 16) & 0x0000ffff;
1414 xsum += (ntohl(ip->ip_dst.s_addr) >> 0) & 0x0000ffff;
1416 sumlen = ntohs(ip->udp_len);
1417 sumptr = (u8 *)&ip->udp_src;
1419 while (sumlen > 1) {
1420 /* inlined ntohs() to avoid alignment errors */
1421 xsum += (sumptr[0] << 8) + sumptr[1];
1426 xsum += (sumptr[0] << 8) + sumptr[0];
1427 while ((xsum >> 16) != 0) {
1428 xsum = (xsum & 0x0000ffff) +
1429 ((xsum >> 16) & 0x0000ffff);
1431 if ((xsum != 0x00000000) && (xsum != 0x0000ffff)) {
1432 printf(" UDP wrong checksum %08lx %08x\n",
1433 xsum, ntohs(ip->udp_xsum));
1438 #if defined(CONFIG_NETCONSOLE) && !defined(CONFIG_SPL_BUILD)
1439 nc_input_packet((uchar *)ip + IP_UDP_HDR_SIZE,
1443 ntohs(ip->udp_len) - UDP_HDR_SIZE);
1446 * IP header OK. Pass the packet to the current handler.
1448 (*udp_packet_handler)((uchar *)ip + IP_UDP_HDR_SIZE,
1452 ntohs(ip->udp_len) - UDP_HDR_SIZE);
1454 #ifdef CONFIG_CMD_WOL
1456 wol_receive(ip, len);
1459 #ifdef CONFIG_PHY_NCSI
1461 ncsi_receive(et, ip, len);
1467 /**********************************************************************/
1469 static int net_check_prereq(enum proto_t protocol)
1473 #if defined(CONFIG_CMD_PING)
1475 if (net_ping_ip.s_addr == 0) {
1476 puts("*** ERROR: ping address not given\n");
1481 #if defined(CONFIG_CMD_PING6)
1483 if (ip6_is_unspecified_addr(&net_ping_ip6)) {
1484 puts("*** ERROR: ping address not given\n");
1489 #if defined(CONFIG_CMD_DNS)
1491 if (net_dns_server.s_addr == 0) {
1492 puts("*** ERROR: DNS server address not given\n");
1497 #if defined(CONFIG_PROT_UDP)
1504 #if defined(CONFIG_CMD_NFS)
1510 if (IS_ENABLED(CONFIG_IPV6) && use_ip6) {
1511 if (!memcmp(&net_server_ip6, &net_null_addr_ip6,
1512 sizeof(struct in6_addr)) &&
1513 !strchr(net_boot_file_name, '[')) {
1514 puts("*** ERROR: `serverip6' not set\n");
1517 } else if (net_server_ip.s_addr == 0 && !is_serverip_in_cmd()) {
1518 puts("*** ERROR: `serverip' not set\n");
1521 #if defined(CONFIG_CMD_PING) || \
1522 defined(CONFIG_CMD_DNS) || defined(CONFIG_PROT_UDP)
1531 if (IS_ENABLED(CONFIG_IPV6) && use_ip6) {
1532 if (!memcmp(&net_link_local_ip6, &net_null_addr_ip6,
1533 sizeof(struct in6_addr))) {
1534 puts("*** ERROR: `ip6addr` not set\n");
1537 } else if (net_ip.s_addr == 0) {
1538 puts("*** ERROR: `ipaddr' not set\n");
1543 #ifdef CONFIG_CMD_RARP
1546 #ifdef CONFIG_PHY_NCSI
1553 if (memcmp(net_ethaddr, "\0\0\0\0\0\0", 6) == 0) {
1554 int num = eth_get_dev_index();
1558 puts("*** ERROR: No ethernet found.\n");
1561 puts("*** ERROR: `ethaddr' not set\n");
1564 printf("*** ERROR: `eth%daddr' not set\n",
1578 /**********************************************************************/
1581 net_eth_hdr_size(void)
1585 myvlanid = ntohs(net_our_vlan);
1586 if (myvlanid == (ushort)-1)
1587 myvlanid = VLAN_NONE;
1589 return ((myvlanid & VLAN_IDMASK) == VLAN_NONE) ? ETHER_HDR_SIZE :
1590 VLAN_ETHER_HDR_SIZE;
1593 int net_set_ether(uchar *xet, const uchar *dest_ethaddr, uint prot)
1595 struct ethernet_hdr *et = (struct ethernet_hdr *)xet;
1598 myvlanid = ntohs(net_our_vlan);
1599 if (myvlanid == (ushort)-1)
1600 myvlanid = VLAN_NONE;
1602 memcpy(et->et_dest, dest_ethaddr, 6);
1603 memcpy(et->et_src, net_ethaddr, 6);
1604 if ((myvlanid & VLAN_IDMASK) == VLAN_NONE) {
1605 et->et_protlen = htons(prot);
1606 return ETHER_HDR_SIZE;
1608 struct vlan_ethernet_hdr *vet =
1609 (struct vlan_ethernet_hdr *)xet;
1611 vet->vet_vlan_type = htons(PROT_VLAN);
1612 vet->vet_tag = htons((0 << 5) | (myvlanid & VLAN_IDMASK));
1613 vet->vet_type = htons(prot);
1614 return VLAN_ETHER_HDR_SIZE;
1618 int net_update_ether(struct ethernet_hdr *et, uchar *addr, uint prot)
1622 memcpy(et->et_dest, addr, 6);
1623 memcpy(et->et_src, net_ethaddr, 6);
1624 protlen = ntohs(et->et_protlen);
1625 if (protlen == PROT_VLAN) {
1626 struct vlan_ethernet_hdr *vet =
1627 (struct vlan_ethernet_hdr *)et;
1628 vet->vet_type = htons(prot);
1629 return VLAN_ETHER_HDR_SIZE;
1630 } else if (protlen > 1514) {
1631 et->et_protlen = htons(prot);
1632 return ETHER_HDR_SIZE;
1635 struct e802_hdr *et802 = (struct e802_hdr *)et;
1636 et802->et_prot = htons(prot);
1637 return E802_HDR_SIZE;
1641 void net_set_ip_header(uchar *pkt, struct in_addr dest, struct in_addr source,
1642 u16 pkt_len, u8 proto)
1644 struct ip_udp_hdr *ip = (struct ip_udp_hdr *)pkt;
1647 * Construct an IP header.
1649 /* IP_HDR_SIZE / 4 (not including UDP) */
1652 ip->ip_len = htons(pkt_len);
1654 ip->ip_id = htons(net_ip_id++);
1655 ip->ip_off = htons(IP_FLAGS_DFRAG); /* Don't fragment */
1658 /* already in network byte order */
1659 net_copy_ip((void *)&ip->ip_src, &source);
1660 /* already in network byte order */
1661 net_copy_ip((void *)&ip->ip_dst, &dest);
1663 ip->ip_sum = compute_ip_checksum(ip, IP_HDR_SIZE);
1666 void net_set_udp_header(uchar *pkt, struct in_addr dest, int dport, int sport,
1669 struct ip_udp_hdr *ip = (struct ip_udp_hdr *)pkt;
1672 * If the data is an odd number of bytes, zero the
1673 * byte after the last byte so that the checksum
1677 pkt[IP_UDP_HDR_SIZE + len] = 0;
1679 net_set_ip_header(pkt, dest, net_ip, IP_UDP_HDR_SIZE + len,
1682 ip->udp_src = htons(sport);
1683 ip->udp_dst = htons(dport);
1684 ip->udp_len = htons(UDP_HDR_SIZE + len);
1688 void copy_filename(char *dst, const char *src, int size)
1690 if (src && *src && (*src == '"')) {
1695 while ((--size > 0) && src && *src && (*src != '"'))
1700 int is_serverip_in_cmd(void)
1702 return !!strchr(net_boot_file_name, ':');
1705 int net_parse_bootfile(struct in_addr *ipaddr, char *filename, int max_len)
1711 if (net_boot_file_name[0] == '\0')
1714 colon = strchr(net_boot_file_name, ':');
1716 ip = string_to_ip(net_boot_file_name);
1717 if (ipaddr && ip.s_addr)
1721 strncpy(filename, colon + 1, max_len);
1723 strncpy(filename, net_boot_file_name, max_len);
1725 filename[max_len - 1] = '\0';
1730 void ip_to_string(struct in_addr x, char *s)
1732 x.s_addr = ntohl(x.s_addr);
1733 sprintf(s, "%d.%d.%d.%d",
1734 (int) ((x.s_addr >> 24) & 0xff),
1735 (int) ((x.s_addr >> 16) & 0xff),
1736 (int) ((x.s_addr >> 8) & 0xff),
1737 (int) ((x.s_addr >> 0) & 0xff)
1741 void vlan_to_string(ushort x, char *s)
1745 if (x == (ushort)-1)
1751 sprintf(s, "%d", x & VLAN_IDMASK);
1754 ushort string_to_vlan(const char *s)
1759 return htons(VLAN_NONE);
1761 if (*s < '0' || *s > '9')
1764 id = (ushort)dectoul(s, NULL);
1769 ushort env_get_vlan(char *var)
1771 return string_to_vlan(env_get(var));