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
83 #include <bootstage.h>
87 #include <env_internal.h>
94 #include <net/fastboot_udp.h>
95 #include <net/fastboot_tcp.h>
98 #if defined(CONFIG_CMD_PCAP)
102 #if defined(CONFIG_LED_STATUS)
104 #include <status_led.h>
106 #include <watchdog.h>
107 #include <linux/compiler.h>
108 #include <test/test.h>
110 #include <net/wget.h>
114 #if defined(CONFIG_CMD_DNS)
117 #include "link_local.h"
121 #if defined(CONFIG_CMD_WOL)
125 #include "net_rand.h"
127 /** BOOTP EXTENTIONS **/
129 /* Our subnet mask (0=unknown) */
130 struct in_addr net_netmask;
131 /* Our gateways IP address */
132 struct in_addr net_gateway;
133 /* Our DNS IP address */
134 struct in_addr net_dns_server;
135 #if defined(CONFIG_BOOTP_DNS2)
136 /* Our 2nd DNS IP address */
137 struct in_addr net_dns_server2;
139 /* Indicates whether the pxe path prefix / config file was specified in dhcp option */
140 char *pxelinux_configfile;
142 /** END OF BOOTP EXTENTIONS **/
144 /* Our ethernet address */
146 /* Boot server enet address */
147 u8 net_server_ethaddr[6];
148 /* Our IP addr (0 = unknown) */
149 struct in_addr net_ip;
150 /* Server IP addr (0 = unknown) */
151 struct in_addr net_server_ip;
152 /* Current receive packet */
153 uchar *net_rx_packet;
154 /* Current rx packet length */
155 int net_rx_packet_len;
157 static unsigned net_ip_id;
158 /* Ethernet bcast address */
159 const u8 net_bcast_ethaddr[6] = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
160 const u8 net_null_ethaddr[6];
161 #if defined(CONFIG_API) || defined(CONFIG_EFI_LOADER)
162 void (*push_packet)(void *, int len) = 0;
164 /* Network loop state */
165 enum net_loop_state net_state;
166 /* Tried all network devices */
167 int net_restart_wrap;
168 /* Network loop restarted */
169 static int net_restarted;
170 /* At least one device configured */
171 static int net_dev_exists;
173 /* XXX in both little & big endian machines 0xFFFF == ntohs(-1) */
174 /* default is without VLAN */
175 ushort net_our_vlan = 0xFFFF;
177 ushort net_native_vlan = 0xFFFF;
180 char net_boot_file_name[1024];
181 /* Indicates whether the file name was specified on the command line */
182 bool net_boot_file_name_explicit;
183 /* The actual transferred size of the bootfile (in bytes) */
184 u32 net_boot_file_size;
185 /* Boot file size in blocks as reported by the DHCP server */
186 u32 net_boot_file_expected_size_in_blocks;
188 static uchar net_pkt_buf[(PKTBUFSRX+1) * PKTSIZE_ALIGN + PKTALIGN];
189 /* Receive packets */
190 uchar *net_rx_packets[PKTBUFSRX];
191 /* Current UDP RX packet handler */
192 static rxhand_f *udp_packet_handler;
193 /* Current ARP RX packet handler */
194 static rxhand_f *arp_packet_handler;
195 #ifdef CONFIG_CMD_TFTPPUT
196 /* Current ICMP rx handler */
197 static rxhand_icmp_f *packet_icmp_handler;
199 /* Current timeout handler */
200 static thand_f *time_handler;
201 /* Time base value */
202 static ulong time_start;
203 /* Current timeout value */
204 static ulong time_delta;
205 /* THE transmit packet */
206 uchar *net_tx_packet;
208 static int net_check_prereq(enum proto_t protocol);
210 static int net_try_count;
212 int __maybe_unused net_busy_flag;
214 /**********************************************************************/
216 static int on_ipaddr(const char *name, const char *value, enum env_op op,
219 if (flags & H_PROGRAMMATIC)
222 net_ip = string_to_ip(value);
226 U_BOOT_ENV_CALLBACK(ipaddr, on_ipaddr);
228 static int on_gatewayip(const char *name, const char *value, enum env_op op,
231 if (flags & H_PROGRAMMATIC)
234 net_gateway = string_to_ip(value);
238 U_BOOT_ENV_CALLBACK(gatewayip, on_gatewayip);
240 static int on_netmask(const char *name, const char *value, enum env_op op,
243 if (flags & H_PROGRAMMATIC)
246 net_netmask = string_to_ip(value);
250 U_BOOT_ENV_CALLBACK(netmask, on_netmask);
252 static int on_serverip(const char *name, const char *value, enum env_op op,
255 if (flags & H_PROGRAMMATIC)
258 net_server_ip = string_to_ip(value);
262 U_BOOT_ENV_CALLBACK(serverip, on_serverip);
264 static int on_nvlan(const char *name, const char *value, enum env_op op,
267 if (flags & H_PROGRAMMATIC)
270 net_native_vlan = string_to_vlan(value);
274 U_BOOT_ENV_CALLBACK(nvlan, on_nvlan);
276 static int on_vlan(const char *name, const char *value, enum env_op op,
279 if (flags & H_PROGRAMMATIC)
282 net_our_vlan = string_to_vlan(value);
286 U_BOOT_ENV_CALLBACK(vlan, on_vlan);
288 #if defined(CONFIG_CMD_DNS)
289 static int on_dnsip(const char *name, const char *value, enum env_op op,
292 if (flags & H_PROGRAMMATIC)
295 net_dns_server = string_to_ip(value);
299 U_BOOT_ENV_CALLBACK(dnsip, on_dnsip);
303 * Check if autoload is enabled. If so, use either NFS or TFTP to download
306 void net_auto_load(void)
308 #if defined(CONFIG_CMD_NFS) && !defined(CONFIG_SPL_BUILD)
309 const char *s = env_get("autoload");
311 if (s != NULL && strcmp(s, "NFS") == 0) {
312 if (net_check_prereq(NFS)) {
313 /* We aren't expecting to get a serverip, so just accept the assigned IP */
314 if (IS_ENABLED(CONFIG_BOOTP_SERVERIP)) {
315 net_set_state(NETLOOP_SUCCESS);
317 printf("Cannot autoload with NFS\n");
318 net_set_state(NETLOOP_FAIL);
323 * Use NFS to load the bootfile.
329 if (env_get_yesno("autoload") == 0) {
331 * Just use BOOTP/RARP to configure system;
332 * Do not use TFTP to load the bootfile.
334 net_set_state(NETLOOP_SUCCESS);
337 if (IS_ENABLED(CONFIG_CMD_TFTPBOOT)) {
338 if (net_check_prereq(TFTPGET)) {
340 * We aren't expecting to get a serverip, so just
341 * accept the assigned IP
343 if (IS_ENABLED(CONFIG_BOOTP_SERVERIP)) {
344 net_set_state(NETLOOP_SUCCESS);
346 printf("Cannot autoload with TFTPGET\n");
347 net_set_state(NETLOOP_FAIL);
355 static int net_init_loop(void)
357 static bool first_call = true;
360 memcpy(net_ethaddr, eth_get_ethaddr(), 6);
362 if (IS_ENABLED(CONFIG_IPV6)) {
363 ip6_make_lladdr(&net_link_local_ip6, net_ethaddr);
364 if (!memcmp(&net_ip6, &net_null_addr_ip6,
365 sizeof(struct in6_addr)))
366 memcpy(&net_ip6, &net_link_local_ip6,
367 sizeof(struct in6_addr));
372 * Not ideal, but there's no way to get the actual error, and I
373 * don't feel like fixing all the users of eth_get_dev to deal
378 if (IS_ENABLED(CONFIG_IPV6_ROUTER_DISCOVERY))
379 if (first_call && use_ip6) {
381 srand_mac(); /* This is for rand used in ip6_send_rs. */
387 static void net_clear_handlers(void)
389 net_set_udp_handler(NULL);
390 net_set_arp_handler(NULL);
391 net_set_timeout_handler(0, NULL);
394 static void net_cleanup_loop(void)
396 net_clear_handlers();
401 static int first_call = 1;
405 * Setup packet buffers, aligned correctly.
409 net_tx_packet = &net_pkt_buf[0] + (PKTALIGN - 1);
410 net_tx_packet -= (ulong)net_tx_packet % PKTALIGN;
411 for (i = 0; i < PKTBUFSRX; i++) {
412 net_rx_packets[i] = net_tx_packet +
413 (i + 1) * PKTSIZE_ALIGN;
417 net_clear_handlers();
419 /* Only need to setup buffer pointers once. */
421 if (IS_ENABLED(CONFIG_PROT_TCP))
422 tcp_set_tcp_state(TCP_CLOSED);
425 return net_init_loop();
428 /**********************************************************************/
430 * Main network processing loop.
433 int net_loop(enum proto_t protocol)
436 enum net_loop_state prev_net_state = net_state;
438 #if defined(CONFIG_CMD_PING)
439 if (protocol != PING)
440 net_ping_ip.s_addr = 0;
445 debug_cond(DEBUG_INT_STATE, "--- net_loop Entry\n");
447 #ifdef CONFIG_PHY_NCSI
448 if (phy_interface_is_ncsi() && protocol != NCSI && !ncsi_active()) {
449 printf("%s: configuring NCSI first\n", __func__);
450 if (net_loop(NCSI) < 0)
452 eth_init_state_only();
457 bootstage_mark_name(BOOTSTAGE_ID_ETH_START, "eth_start");
459 if (eth_is_on_demand_init()) {
468 eth_init_state_only();
472 #ifdef CONFIG_USB_KEYBOARD
475 net_set_state(NETLOOP_CONTINUE);
478 * Start the ball rolling with the given start function. From
479 * here on, this code is a state machine driven by received
480 * packets and timer events.
482 debug_cond(DEBUG_INT_STATE, "--- net_loop Init\n");
485 if (!test_eth_enabled())
488 switch (net_check_prereq(protocol)) {
490 /* network not configured */
492 net_set_state(prev_net_state);
496 /* network device not configured */
501 net_boot_file_size = 0;
503 #ifdef CONFIG_CMD_TFTPBOOT
505 #ifdef CONFIG_CMD_TFTPPUT
508 /* always use ARP to get server ethernet address */
509 tftp_start(protocol);
512 #ifdef CONFIG_CMD_TFTPSRV
517 #if CONFIG_IS_ENABLED(UDP_FUNCTION_FASTBOOT)
519 fastboot_udp_start_server();
522 #if CONFIG_IS_ENABLED(TCP_FUNCTION_FASTBOOT)
524 fastboot_tcp_start_server();
527 #if defined(CONFIG_CMD_DHCP)
531 dhcp_request(); /* Basically same as BOOTP */
535 if (IS_ENABLED(CONFIG_CMD_DHCP6))
538 #if defined(CONFIG_CMD_BOOTP)
545 #if defined(CONFIG_CMD_RARP)
552 #if defined(CONFIG_CMD_PING)
557 #if defined(CONFIG_CMD_PING6)
562 #if defined(CONFIG_CMD_NFS) && !defined(CONFIG_SPL_BUILD)
567 #if defined(CONFIG_CMD_WGET)
572 #if defined(CONFIG_CMD_CDP)
577 #if defined(CONFIG_NETCONSOLE) && !defined(CONFIG_SPL_BUILD)
582 #if defined(CONFIG_CMD_DNS)
587 #if defined(CONFIG_CMD_LINK_LOCAL)
592 #if defined(CONFIG_CMD_WOL)
597 #if defined(CONFIG_PHY_NCSI)
599 ncsi_probe_packages();
603 if (IS_ENABLED(CONFIG_IPV6_ROUTER_DISCOVERY))
610 if (IS_ENABLED(CONFIG_PROT_UDP) && protocol == UDP)
616 #if defined(CONFIG_MII) || defined(CONFIG_CMD_MII)
617 #if defined(CONFIG_SYS_FAULT_ECHO_LINK_DOWN) && \
618 defined(CONFIG_LED_STATUS) && \
619 defined(CONFIG_LED_STATUS_RED)
621 * Echo the inverted link state to the fault LED.
623 if (miiphy_link(eth_get_dev()->name, CONFIG_SYS_FAULT_MII_ADDR))
624 status_led_set(CONFIG_LED_STATUS_RED, CONFIG_LED_STATUS_OFF);
626 status_led_set(CONFIG_LED_STATUS_RED, CONFIG_LED_STATUS_ON);
627 #endif /* CONFIG_SYS_FAULT_ECHO_LINK_DOWN, ... */
628 #endif /* CONFIG_MII, ... */
629 #ifdef CONFIG_USB_KEYBOARD
634 * Main packet reception loop. Loop receiving packets until
635 * someone sets `net_state' to a state that terminates.
639 if (arp_timeout_check() > 0)
640 time_start = get_timer(0);
642 if (IS_ENABLED(CONFIG_IPV6)) {
643 if (use_ip6 && (ndisc_timeout_check() > 0))
644 time_start = get_timer(0);
648 * Check the ethernet for a new packet. The ethernet
649 * receive routine will process it.
650 * Most drivers return the most recent packet size, but not
651 * errors that may have happened.
656 * Abort if ctrl-c was pressed.
659 /* cancel any ARP that may not have completed */
660 net_arp_wait_packet_ip.s_addr = 0;
664 /* Invalidate the last protocol */
665 eth_set_last_protocol(BOOTP);
668 /* include a debug print as well incase the debug
669 messages are directed to stderr */
670 debug_cond(DEBUG_INT_STATE, "--- net_loop Abort!\n");
676 * Check for a timeout, and run the timeout handler
680 ((get_timer(0) - time_start) > time_delta)) {
683 #if defined(CONFIG_MII) || defined(CONFIG_CMD_MII)
684 #if defined(CONFIG_SYS_FAULT_ECHO_LINK_DOWN) && \
685 defined(CONFIG_LED_STATUS) && \
686 defined(CONFIG_LED_STATUS_RED)
688 * Echo the inverted link state to the fault LED.
690 if (miiphy_link(eth_get_dev()->name,
691 CONFIG_SYS_FAULT_MII_ADDR))
692 status_led_set(CONFIG_LED_STATUS_RED,
693 CONFIG_LED_STATUS_OFF);
695 status_led_set(CONFIG_LED_STATUS_RED,
696 CONFIG_LED_STATUS_ON);
697 #endif /* CONFIG_SYS_FAULT_ECHO_LINK_DOWN, ... */
698 #endif /* CONFIG_MII, ... */
699 debug_cond(DEBUG_INT_STATE, "--- net_loop timeout\n");
701 time_handler = (thand_f *)0;
703 } else if (IS_ENABLED(CONFIG_IPV6_ROUTER_DISCOVERY))
704 if (time_handler && protocol == RS)
705 if (!ip6_is_unspecified_addr(&net_gateway6) &&
706 net_prefix_length != 0) {
707 net_set_state(NETLOOP_SUCCESS);
708 net_set_timeout_handler(0, NULL);
711 if (net_state == NETLOOP_FAIL)
712 ret = net_start_again();
715 case NETLOOP_RESTART:
719 case NETLOOP_SUCCESS:
721 if (net_boot_file_size > 0) {
722 printf("Bytes transferred = %u (%x hex)\n",
723 net_boot_file_size, net_boot_file_size);
724 env_set_hex("filesize", net_boot_file_size);
725 env_set_hex("fileaddr", image_load_addr);
727 if (protocol != NETCONS && protocol != NCSI)
730 eth_halt_state_only();
732 eth_set_last_protocol(protocol);
734 ret = net_boot_file_size;
735 debug_cond(DEBUG_INT_STATE, "--- net_loop Success!\n");
740 /* Invalidate the last protocol */
741 eth_set_last_protocol(BOOTP);
742 debug_cond(DEBUG_INT_STATE, "--- net_loop Fail!\n");
746 case NETLOOP_CONTINUE:
752 #ifdef CONFIG_USB_KEYBOARD
755 #ifdef CONFIG_CMD_TFTPPUT
756 /* Clear out the handlers */
757 net_set_udp_handler(NULL);
758 net_set_icmp_handler(NULL);
760 net_set_state(prev_net_state);
762 #if defined(CONFIG_CMD_PCAP)
769 /**********************************************************************/
771 static void start_again_timeout_handler(void)
773 net_set_state(NETLOOP_RESTART);
776 int net_start_again(void)
779 int retry_forever = 0;
780 unsigned long retrycnt = 0;
783 nretry = env_get("netretry");
785 if (!strcmp(nretry, "yes"))
787 else if (!strcmp(nretry, "no"))
789 else if (!strcmp(nretry, "once"))
792 retrycnt = simple_strtoul(nretry, NULL, 0);
798 if ((!retry_forever) && (net_try_count > retrycnt)) {
800 net_set_state(NETLOOP_FAIL);
802 * We don't provide a way for the protocol to return an error,
803 * but this is almost always the reason.
811 #if !defined(CONFIG_NET_DO_NOT_TRY_ANOTHER)
812 eth_try_another(!net_restarted);
815 if (net_restart_wrap) {
816 net_restart_wrap = 0;
817 if (net_dev_exists) {
818 net_set_timeout_handler(10000UL,
819 start_again_timeout_handler);
820 net_set_udp_handler(NULL);
822 net_set_state(NETLOOP_FAIL);
825 net_set_state(NETLOOP_RESTART);
830 /**********************************************************************/
835 static void dummy_handler(uchar *pkt, unsigned dport,
836 struct in_addr sip, unsigned sport,
841 rxhand_f *net_get_udp_handler(void)
843 return udp_packet_handler;
846 void net_set_udp_handler(rxhand_f *f)
848 debug_cond(DEBUG_INT_STATE, "--- net_loop UDP handler set (%p)\n", f);
850 udp_packet_handler = dummy_handler;
852 udp_packet_handler = f;
855 rxhand_f *net_get_arp_handler(void)
857 return arp_packet_handler;
860 void net_set_arp_handler(rxhand_f *f)
862 debug_cond(DEBUG_INT_STATE, "--- net_loop ARP handler set (%p)\n", f);
864 arp_packet_handler = dummy_handler;
866 arp_packet_handler = f;
869 #ifdef CONFIG_CMD_TFTPPUT
870 void net_set_icmp_handler(rxhand_icmp_f *f)
872 packet_icmp_handler = f;
876 void net_set_timeout_handler(ulong iv, thand_f *f)
879 debug_cond(DEBUG_INT_STATE,
880 "--- net_loop timeout handler cancelled\n");
881 time_handler = (thand_f *)0;
883 debug_cond(DEBUG_INT_STATE,
884 "--- net_loop timeout handler set (%p)\n", f);
886 time_start = get_timer(0);
887 time_delta = iv * CONFIG_SYS_HZ / 1000;
891 uchar *net_get_async_tx_pkt_buf(void)
893 if (arp_is_waiting())
894 return arp_tx_packet; /* If we are waiting, we already sent */
896 return net_tx_packet;
899 int net_send_udp_packet(uchar *ether, struct in_addr dest, int dport, int sport,
902 return net_send_ip_packet(ether, dest, dport, sport, payload_len,
903 IPPROTO_UDP, 0, 0, 0);
906 #if defined(CONFIG_PROT_TCP)
907 int net_send_tcp_packet(int payload_len, int dport, int sport, u8 action,
908 u32 tcp_seq_num, u32 tcp_ack_num)
910 return net_send_ip_packet(net_server_ethaddr, net_server_ip, dport,
911 sport, payload_len, IPPROTO_TCP, action,
912 tcp_seq_num, tcp_ack_num);
916 int net_send_ip_packet(uchar *ether, struct in_addr dest, int dport, int sport,
917 int payload_len, int proto, u8 action, u32 tcp_seq_num,
924 /* make sure the net_tx_packet is initialized (net_init() was called) */
925 assert(net_tx_packet != NULL);
926 if (net_tx_packet == NULL)
929 /* convert to new style broadcast */
930 if (dest.s_addr == 0)
931 dest.s_addr = 0xFFFFFFFF;
933 /* if broadcast, make the ether address a broadcast and don't do ARP */
934 if (dest.s_addr == 0xFFFFFFFF)
935 ether = (uchar *)net_bcast_ethaddr;
937 pkt = (uchar *)net_tx_packet;
939 eth_hdr_size = net_set_ether(pkt, ether, PROT_IP);
943 net_set_udp_header(pkt + eth_hdr_size, dest, dport, sport,
945 pkt_hdr_size = eth_hdr_size + IP_UDP_HDR_SIZE;
947 #if defined(CONFIG_PROT_TCP)
949 pkt_hdr_size = eth_hdr_size
950 + tcp_set_tcp_header(pkt + eth_hdr_size, dport, sport,
951 payload_len, action, tcp_seq_num,
959 /* if MAC address was not discovered yet, do an ARP request */
960 if (memcmp(ether, net_null_ethaddr, 6) == 0) {
961 debug_cond(DEBUG_DEV_PKT, "sending ARP for %pI4\n", &dest);
963 /* save the ip and eth addr for the packet to send after arp */
964 net_arp_wait_packet_ip = dest;
965 arp_wait_packet_ethaddr = ether;
967 /* size of the waiting packet */
968 arp_wait_tx_packet_size = pkt_hdr_size + payload_len;
970 /* and do the ARP request */
972 arp_wait_timer_start = get_timer(0);
974 return 1; /* waiting */
976 debug_cond(DEBUG_DEV_PKT, "sending UDP to %pI4/%pM\n",
978 net_send_packet(net_tx_packet, pkt_hdr_size + payload_len);
979 return 0; /* transmitted */
983 #ifdef CONFIG_IP_DEFRAG
985 * This function collects fragments in a single packet, according
986 * to the algorithm in RFC815. It returns NULL or the pointer to
987 * a complete packet, in static storage
989 #define IP_PKTSIZE (CONFIG_NET_MAXDEFRAG)
991 #define IP_MAXUDP (IP_PKTSIZE - IP_HDR_SIZE)
994 * this is the packet being assembled, either data or frag control.
995 * Fragments go by 8 bytes, so this union must be 8 bytes long
998 /* first_byte is address of this structure */
999 u16 last_byte; /* last byte in this hole + 1 (begin of next hole) */
1000 u16 next_hole; /* index of next (in 8-b blocks), 0 == none */
1001 u16 prev_hole; /* index of prev, 0 == none */
1005 static struct ip_udp_hdr *__net_defragment(struct ip_udp_hdr *ip, int *lenp)
1007 static uchar pkt_buff[IP_PKTSIZE] __aligned(PKTALIGN);
1008 static u16 first_hole, total_len;
1009 struct hole *payload, *thisfrag, *h, *newh;
1010 struct ip_udp_hdr *localip = (struct ip_udp_hdr *)pkt_buff;
1011 uchar *indata = (uchar *)ip;
1012 int offset8, start, len, done = 0;
1013 u16 ip_off = ntohs(ip->ip_off);
1016 * Calling code already rejected <, but we don't have to deal
1017 * with an IP fragment with no payload.
1019 if (ntohs(ip->ip_len) <= IP_HDR_SIZE)
1022 /* payload starts after IP header, this fragment is in there */
1023 payload = (struct hole *)(pkt_buff + IP_HDR_SIZE);
1024 offset8 = (ip_off & IP_OFFS);
1025 thisfrag = payload + offset8;
1026 start = offset8 * 8;
1027 len = ntohs(ip->ip_len) - IP_HDR_SIZE;
1029 /* All but last fragment must have a multiple-of-8 payload. */
1030 if ((len & 7) && (ip_off & IP_FLAGS_MFRAG))
1033 if (start + len > IP_MAXUDP) /* fragment extends too far */
1036 if (!total_len || localip->ip_id != ip->ip_id) {
1037 /* new (or different) packet, reset structs */
1039 payload[0].last_byte = ~0;
1040 payload[0].next_hole = 0;
1041 payload[0].prev_hole = 0;
1043 /* any IP header will work, copy the first we received */
1044 memcpy(localip, ip, IP_HDR_SIZE);
1048 * What follows is the reassembly algorithm. We use the payload
1049 * array as a linked list of hole descriptors, as each hole starts
1050 * at a multiple of 8 bytes. However, last byte can be whatever value,
1051 * so it is represented as byte count, not as 8-byte blocks.
1054 h = payload + first_hole;
1055 while (h->last_byte < start) {
1056 if (!h->next_hole) {
1057 /* no hole that far away */
1060 h = payload + h->next_hole;
1063 /* last fragment may be 1..7 bytes, the "+7" forces acceptance */
1064 if (offset8 + ((len + 7) / 8) <= h - payload) {
1065 /* no overlap with holes (dup fragment?) */
1069 if (!(ip_off & IP_FLAGS_MFRAG)) {
1070 /* no more fragmentss: truncate this (last) hole */
1071 total_len = start + len;
1072 h->last_byte = start + len;
1076 * There is some overlap: fix the hole list. This code deals
1077 * with a fragment that overlaps with two different holes
1078 * (thus being a superset of a previously-received fragment)
1079 * by only using the part of the fragment that fits in the
1082 if (h->last_byte < start + len)
1083 len = h->last_byte - start;
1085 if ((h >= thisfrag) && (h->last_byte <= start + len)) {
1086 /* complete overlap with hole: remove hole */
1087 if (!h->prev_hole && !h->next_hole) {
1088 /* last remaining hole */
1090 } else if (!h->prev_hole) {
1092 first_hole = h->next_hole;
1093 payload[h->next_hole].prev_hole = 0;
1094 } else if (!h->next_hole) {
1096 payload[h->prev_hole].next_hole = 0;
1098 /* in the middle of the list */
1099 payload[h->next_hole].prev_hole = h->prev_hole;
1100 payload[h->prev_hole].next_hole = h->next_hole;
1103 } else if (h->last_byte <= start + len) {
1104 /* overlaps with final part of the hole: shorten this hole */
1105 h->last_byte = start;
1107 } else if (h >= thisfrag) {
1108 /* overlaps with initial part of the hole: move this hole */
1109 newh = thisfrag + (len / 8);
1113 payload[h->next_hole].prev_hole = (h - payload);
1115 payload[h->prev_hole].next_hole = (h - payload);
1117 first_hole = (h - payload);
1120 /* fragment sits in the middle: split the hole */
1121 newh = thisfrag + (len / 8);
1123 h->last_byte = start;
1124 h->next_hole = (newh - payload);
1125 newh->prev_hole = (h - payload);
1126 if (newh->next_hole)
1127 payload[newh->next_hole].prev_hole = (newh - payload);
1130 /* finally copy this fragment and possibly return whole packet */
1131 memcpy((uchar *)thisfrag, indata + IP_HDR_SIZE, len);
1135 *lenp = total_len + IP_HDR_SIZE;
1136 localip->ip_len = htons(*lenp);
1140 static inline struct ip_udp_hdr *net_defragment(struct ip_udp_hdr *ip,
1143 u16 ip_off = ntohs(ip->ip_off);
1144 if (!(ip_off & (IP_OFFS | IP_FLAGS_MFRAG)))
1145 return ip; /* not a fragment */
1146 return __net_defragment(ip, lenp);
1149 #else /* !CONFIG_IP_DEFRAG */
1151 static inline struct ip_udp_hdr *net_defragment(struct ip_udp_hdr *ip,
1154 u16 ip_off = ntohs(ip->ip_off);
1155 if (!(ip_off & (IP_OFFS | IP_FLAGS_MFRAG)))
1156 return ip; /* not a fragment */
1162 * Receive an ICMP packet. We deal with REDIRECT and PING here, and silently
1165 * @parma ip IP packet containing the ICMP
1167 static void receive_icmp(struct ip_udp_hdr *ip, int len,
1168 struct in_addr src_ip, struct ethernet_hdr *et)
1170 struct icmp_hdr *icmph = (struct icmp_hdr *)&ip->udp_src;
1172 switch (icmph->type) {
1174 if (icmph->code != ICMP_REDIR_HOST)
1176 printf(" ICMP Host Redirect to %pI4 ",
1177 &icmph->un.gateway);
1180 #if defined(CONFIG_CMD_PING)
1181 ping_receive(et, ip, len);
1183 #ifdef CONFIG_CMD_TFTPPUT
1184 if (packet_icmp_handler)
1185 packet_icmp_handler(icmph->type, icmph->code,
1186 ntohs(ip->udp_dst), src_ip,
1187 ntohs(ip->udp_src), icmph->un.data,
1188 ntohs(ip->udp_len));
1194 void net_process_received_packet(uchar *in_packet, int len)
1196 struct ethernet_hdr *et;
1197 struct ip_udp_hdr *ip;
1198 struct in_addr dst_ip;
1199 struct in_addr src_ip;
1201 #if defined(CONFIG_CMD_CDP)
1204 ushort cti = 0, vlanid = VLAN_NONE, myvlanid, mynvlanid;
1206 debug_cond(DEBUG_NET_PKT, "packet received\n");
1207 if (DEBUG_NET_PKT_TRACE)
1208 print_hex_dump_bytes("rx: ", DUMP_PREFIX_OFFSET, in_packet,
1211 #if defined(CONFIG_CMD_PCAP)
1212 pcap_post(in_packet, len, false);
1214 net_rx_packet = in_packet;
1215 net_rx_packet_len = len;
1216 et = (struct ethernet_hdr *)in_packet;
1218 /* too small packet? */
1219 if (len < ETHER_HDR_SIZE)
1222 #if defined(CONFIG_API) || defined(CONFIG_EFI_LOADER)
1224 (*push_packet)(in_packet, len);
1229 #if defined(CONFIG_CMD_CDP)
1230 /* keep track if packet is CDP */
1231 iscdp = is_cdp_packet(et->et_dest);
1234 myvlanid = ntohs(net_our_vlan);
1235 if (myvlanid == (ushort)-1)
1236 myvlanid = VLAN_NONE;
1237 mynvlanid = ntohs(net_native_vlan);
1238 if (mynvlanid == (ushort)-1)
1239 mynvlanid = VLAN_NONE;
1241 eth_proto = ntohs(et->et_protlen);
1243 if (eth_proto < 1514) {
1244 struct e802_hdr *et802 = (struct e802_hdr *)et;
1246 * Got a 802.2 packet. Check the other protocol field.
1247 * XXX VLAN over 802.2+SNAP not implemented!
1249 eth_proto = ntohs(et802->et_prot);
1251 ip = (struct ip_udp_hdr *)(in_packet + E802_HDR_SIZE);
1252 len -= E802_HDR_SIZE;
1254 } else if (eth_proto != PROT_VLAN) { /* normal packet */
1255 ip = (struct ip_udp_hdr *)(in_packet + ETHER_HDR_SIZE);
1256 len -= ETHER_HDR_SIZE;
1258 } else { /* VLAN packet */
1259 struct vlan_ethernet_hdr *vet =
1260 (struct vlan_ethernet_hdr *)et;
1262 debug_cond(DEBUG_NET_PKT, "VLAN packet received\n");
1264 /* too small packet? */
1265 if (len < VLAN_ETHER_HDR_SIZE)
1268 /* if no VLAN active */
1269 if ((ntohs(net_our_vlan) & VLAN_IDMASK) == VLAN_NONE
1270 #if defined(CONFIG_CMD_CDP)
1276 cti = ntohs(vet->vet_tag);
1277 vlanid = cti & VLAN_IDMASK;
1278 eth_proto = ntohs(vet->vet_type);
1280 ip = (struct ip_udp_hdr *)(in_packet + VLAN_ETHER_HDR_SIZE);
1281 len -= VLAN_ETHER_HDR_SIZE;
1284 debug_cond(DEBUG_NET_PKT, "Receive from protocol 0x%x\n", eth_proto);
1286 #if defined(CONFIG_CMD_CDP)
1288 cdp_receive((uchar *)ip, len);
1293 if ((myvlanid & VLAN_IDMASK) != VLAN_NONE) {
1294 if (vlanid == VLAN_NONE)
1295 vlanid = (mynvlanid & VLAN_IDMASK);
1297 if (vlanid != (myvlanid & VLAN_IDMASK))
1301 switch (eth_proto) {
1303 arp_receive(et, ip, len);
1306 #ifdef CONFIG_CMD_RARP
1308 rarp_receive(ip, len);
1311 #if IS_ENABLED(CONFIG_IPV6)
1313 net_ip6_handler(et, (struct ip6_hdr *)ip, len);
1317 debug_cond(DEBUG_NET_PKT, "Got IP\n");
1318 /* Before we start poking the header, make sure it is there */
1319 if (len < IP_HDR_SIZE) {
1320 debug("len bad %d < %lu\n", len,
1321 (ulong)IP_HDR_SIZE);
1324 /* Check the packet length */
1325 if (len < ntohs(ip->ip_len)) {
1326 debug("len bad %d < %d\n", len, ntohs(ip->ip_len));
1329 len = ntohs(ip->ip_len);
1330 if (len < IP_HDR_SIZE) {
1331 debug("bad ip->ip_len %d < %d\n", len, (int)IP_HDR_SIZE);
1334 debug_cond(DEBUG_NET_PKT, "len=%d, v=%02x\n",
1335 len, ip->ip_hl_v & 0xff);
1337 /* Can't deal with anything except IPv4 */
1338 if ((ip->ip_hl_v & 0xf0) != 0x40)
1340 /* Can't deal with IP options (headers != 20 bytes) */
1341 if ((ip->ip_hl_v & 0x0f) != 0x05)
1343 /* Check the Checksum of the header */
1344 if (!ip_checksum_ok((uchar *)ip, IP_HDR_SIZE)) {
1345 debug("checksum bad\n");
1348 /* If it is not for us, ignore it */
1349 dst_ip = net_read_ip(&ip->ip_dst);
1350 if (net_ip.s_addr && dst_ip.s_addr != net_ip.s_addr &&
1351 dst_ip.s_addr != 0xFFFFFFFF) {
1354 /* Read source IP address for later use */
1355 src_ip = net_read_ip(&ip->ip_src);
1357 * The function returns the unchanged packet if it's not
1358 * a fragment, and either the complete packet or NULL if
1359 * it is a fragment (if !CONFIG_IP_DEFRAG, it returns NULL)
1361 ip = net_defragment(ip, &len);
1365 * watch for ICMP host redirects
1367 * There is no real handler code (yet). We just watch
1368 * for ICMP host redirect messages. In case anybody
1369 * sees these messages: please contact me
1371 * necessary fixes :-)
1373 * Note: in all cases where I have seen this so far
1374 * it was a problem with the router configuration,
1375 * for instance when a router was configured in the
1376 * BOOTP reply, but the TFTP server was on the same
1377 * subnet. So this is probably a warning that your
1378 * configuration might be wrong. But I'm not really
1379 * sure if there aren't any other situations.
1382 * we send a tftp packet to a dead connection, or when
1383 * there is no server at the other end.
1385 if (ip->ip_p == IPPROTO_ICMP) {
1386 receive_icmp(ip, len, src_ip, et);
1388 #if defined(CONFIG_PROT_TCP)
1389 } else if (ip->ip_p == IPPROTO_TCP) {
1390 debug_cond(DEBUG_DEV_PKT,
1391 "TCP PH (to=%pI4, from=%pI4, len=%d)\n",
1392 &dst_ip, &src_ip, len);
1394 rxhand_tcp_f((union tcp_build_pkt *)ip, len);
1397 } else if (ip->ip_p != IPPROTO_UDP) { /* Only UDP packets */
1401 if (ntohs(ip->udp_len) < UDP_HDR_SIZE || ntohs(ip->udp_len) > len - IP_HDR_SIZE)
1404 debug_cond(DEBUG_DEV_PKT,
1405 "received UDP (to=%pI4, from=%pI4, len=%d)\n",
1406 &dst_ip, &src_ip, len);
1408 if (IS_ENABLED(CONFIG_UDP_CHECKSUM) && ip->udp_xsum != 0) {
1414 xsum += (ntohs(ip->udp_len));
1415 xsum += (ntohl(ip->ip_src.s_addr) >> 16) & 0x0000ffff;
1416 xsum += (ntohl(ip->ip_src.s_addr) >> 0) & 0x0000ffff;
1417 xsum += (ntohl(ip->ip_dst.s_addr) >> 16) & 0x0000ffff;
1418 xsum += (ntohl(ip->ip_dst.s_addr) >> 0) & 0x0000ffff;
1420 sumlen = ntohs(ip->udp_len);
1421 sumptr = (u8 *)&ip->udp_src;
1423 while (sumlen > 1) {
1424 /* inlined ntohs() to avoid alignment errors */
1425 xsum += (sumptr[0] << 8) + sumptr[1];
1430 xsum += (sumptr[0] << 8) + sumptr[0];
1431 while ((xsum >> 16) != 0) {
1432 xsum = (xsum & 0x0000ffff) +
1433 ((xsum >> 16) & 0x0000ffff);
1435 if ((xsum != 0x00000000) && (xsum != 0x0000ffff)) {
1436 printf(" UDP wrong checksum %08lx %08x\n",
1437 xsum, ntohs(ip->udp_xsum));
1442 #if defined(CONFIG_NETCONSOLE) && !defined(CONFIG_SPL_BUILD)
1443 nc_input_packet((uchar *)ip + IP_UDP_HDR_SIZE,
1447 ntohs(ip->udp_len) - UDP_HDR_SIZE);
1450 * IP header OK. Pass the packet to the current handler.
1452 (*udp_packet_handler)((uchar *)ip + IP_UDP_HDR_SIZE,
1456 ntohs(ip->udp_len) - UDP_HDR_SIZE);
1458 #ifdef CONFIG_CMD_WOL
1460 wol_receive(ip, len);
1463 #ifdef CONFIG_PHY_NCSI
1465 ncsi_receive(et, ip, len);
1471 /**********************************************************************/
1473 static int net_check_prereq(enum proto_t protocol)
1477 #if defined(CONFIG_CMD_PING)
1479 if (net_ping_ip.s_addr == 0) {
1480 puts("*** ERROR: ping address not given\n");
1485 #if defined(CONFIG_CMD_PING6)
1487 if (ip6_is_unspecified_addr(&net_ping_ip6)) {
1488 puts("*** ERROR: ping address not given\n");
1493 #if defined(CONFIG_CMD_DNS)
1495 if (net_dns_server.s_addr == 0) {
1496 puts("*** ERROR: DNS server address not given\n");
1501 #if defined(CONFIG_PROT_UDP)
1508 #if defined(CONFIG_CMD_NFS)
1514 if (IS_ENABLED(CONFIG_IPV6) && use_ip6) {
1515 if (!memcmp(&net_server_ip6, &net_null_addr_ip6,
1516 sizeof(struct in6_addr)) &&
1517 !strchr(net_boot_file_name, '[')) {
1518 puts("*** ERROR: `serverip6' not set\n");
1521 } else if (net_server_ip.s_addr == 0 && !is_serverip_in_cmd()) {
1522 puts("*** ERROR: `serverip' not set\n");
1525 #if defined(CONFIG_CMD_PING) || \
1526 defined(CONFIG_CMD_DNS) || defined(CONFIG_PROT_UDP)
1535 if (IS_ENABLED(CONFIG_IPV6) && use_ip6) {
1536 if (!memcmp(&net_link_local_ip6, &net_null_addr_ip6,
1537 sizeof(struct in6_addr))) {
1538 puts("*** ERROR: `ip6addr` not set\n");
1541 } else if (net_ip.s_addr == 0) {
1542 puts("*** ERROR: `ipaddr' not set\n");
1547 #ifdef CONFIG_CMD_RARP
1550 #ifdef CONFIG_PHY_NCSI
1557 if (memcmp(net_ethaddr, "\0\0\0\0\0\0", 6) == 0) {
1558 int num = eth_get_dev_index();
1562 puts("*** ERROR: No ethernet found.\n");
1565 puts("*** ERROR: `ethaddr' not set\n");
1568 printf("*** ERROR: `eth%daddr' not set\n",
1582 /**********************************************************************/
1585 net_eth_hdr_size(void)
1589 myvlanid = ntohs(net_our_vlan);
1590 if (myvlanid == (ushort)-1)
1591 myvlanid = VLAN_NONE;
1593 return ((myvlanid & VLAN_IDMASK) == VLAN_NONE) ? ETHER_HDR_SIZE :
1594 VLAN_ETHER_HDR_SIZE;
1597 int net_set_ether(uchar *xet, const uchar *dest_ethaddr, uint prot)
1599 struct ethernet_hdr *et = (struct ethernet_hdr *)xet;
1602 myvlanid = ntohs(net_our_vlan);
1603 if (myvlanid == (ushort)-1)
1604 myvlanid = VLAN_NONE;
1606 memcpy(et->et_dest, dest_ethaddr, 6);
1607 memcpy(et->et_src, net_ethaddr, 6);
1608 if ((myvlanid & VLAN_IDMASK) == VLAN_NONE) {
1609 et->et_protlen = htons(prot);
1610 return ETHER_HDR_SIZE;
1612 struct vlan_ethernet_hdr *vet =
1613 (struct vlan_ethernet_hdr *)xet;
1615 vet->vet_vlan_type = htons(PROT_VLAN);
1616 vet->vet_tag = htons((0 << 5) | (myvlanid & VLAN_IDMASK));
1617 vet->vet_type = htons(prot);
1618 return VLAN_ETHER_HDR_SIZE;
1622 int net_update_ether(struct ethernet_hdr *et, uchar *addr, uint prot)
1626 memcpy(et->et_dest, addr, 6);
1627 memcpy(et->et_src, net_ethaddr, 6);
1628 protlen = ntohs(et->et_protlen);
1629 if (protlen == PROT_VLAN) {
1630 struct vlan_ethernet_hdr *vet =
1631 (struct vlan_ethernet_hdr *)et;
1632 vet->vet_type = htons(prot);
1633 return VLAN_ETHER_HDR_SIZE;
1634 } else if (protlen > 1514) {
1635 et->et_protlen = htons(prot);
1636 return ETHER_HDR_SIZE;
1639 struct e802_hdr *et802 = (struct e802_hdr *)et;
1640 et802->et_prot = htons(prot);
1641 return E802_HDR_SIZE;
1645 void net_set_ip_header(uchar *pkt, struct in_addr dest, struct in_addr source,
1646 u16 pkt_len, u8 proto)
1648 struct ip_udp_hdr *ip = (struct ip_udp_hdr *)pkt;
1651 * Construct an IP header.
1653 /* IP_HDR_SIZE / 4 (not including UDP) */
1656 ip->ip_len = htons(pkt_len);
1658 ip->ip_id = htons(net_ip_id++);
1659 ip->ip_off = htons(IP_FLAGS_DFRAG); /* Don't fragment */
1662 /* already in network byte order */
1663 net_copy_ip((void *)&ip->ip_src, &source);
1664 /* already in network byte order */
1665 net_copy_ip((void *)&ip->ip_dst, &dest);
1667 ip->ip_sum = compute_ip_checksum(ip, IP_HDR_SIZE);
1670 void net_set_udp_header(uchar *pkt, struct in_addr dest, int dport, int sport,
1673 struct ip_udp_hdr *ip = (struct ip_udp_hdr *)pkt;
1676 * If the data is an odd number of bytes, zero the
1677 * byte after the last byte so that the checksum
1681 pkt[IP_UDP_HDR_SIZE + len] = 0;
1683 net_set_ip_header(pkt, dest, net_ip, IP_UDP_HDR_SIZE + len,
1686 ip->udp_src = htons(sport);
1687 ip->udp_dst = htons(dport);
1688 ip->udp_len = htons(UDP_HDR_SIZE + len);
1692 void copy_filename(char *dst, const char *src, int size)
1694 if (src && *src && (*src == '"')) {
1699 while ((--size > 0) && src && *src && (*src != '"'))
1704 int is_serverip_in_cmd(void)
1706 return !!strchr(net_boot_file_name, ':');
1709 int net_parse_bootfile(struct in_addr *ipaddr, char *filename, int max_len)
1715 if (net_boot_file_name[0] == '\0')
1718 colon = strchr(net_boot_file_name, ':');
1720 ip = string_to_ip(net_boot_file_name);
1721 if (ipaddr && ip.s_addr)
1725 strncpy(filename, colon + 1, max_len);
1727 strncpy(filename, net_boot_file_name, max_len);
1729 filename[max_len - 1] = '\0';
1734 void ip_to_string(struct in_addr x, char *s)
1736 x.s_addr = ntohl(x.s_addr);
1737 sprintf(s, "%d.%d.%d.%d",
1738 (int) ((x.s_addr >> 24) & 0xff),
1739 (int) ((x.s_addr >> 16) & 0xff),
1740 (int) ((x.s_addr >> 8) & 0xff),
1741 (int) ((x.s_addr >> 0) & 0xff)
1745 void vlan_to_string(ushort x, char *s)
1749 if (x == (ushort)-1)
1755 sprintf(s, "%d", x & VLAN_IDMASK);
1758 ushort string_to_vlan(const char *s)
1763 return htons(VLAN_NONE);
1765 if (*s < '0' || *s > '9')
1768 id = (ushort)dectoul(s, NULL);
1773 ushort env_get_vlan(char *var)
1775 return string_to_vlan(env_get(var));