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
9 * Copyright 2000-2002 Wolfgang Denk, wd@denx.de
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
77 * Prerequisites: - own ethernet address
79 * We want: - network time
84 * Prerequisites: - own ethernet address
85 * We want: - magic packet or timeout
91 #include <bootstage.h>
95 #include <env_internal.h>
99 #include <net/fastboot.h>
100 #include <net/tftp.h>
101 #if defined(CONFIG_CMD_PCAP)
102 #include <net/pcap.h>
104 #if defined(CONFIG_LED_STATUS)
106 #include <status_led.h>
108 #include <watchdog.h>
109 #include <linux/compiler.h>
113 #if defined(CONFIG_CMD_DNS)
116 #include "link_local.h"
120 #if defined(CONFIG_CMD_SNTP)
123 #if defined(CONFIG_CMD_WOL)
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;
140 /** END OF BOOTP EXTENTIONS **/
142 /* Our ethernet address */
144 /* Boot server enet address */
145 u8 net_server_ethaddr[6];
146 /* Our IP addr (0 = unknown) */
147 struct in_addr net_ip;
148 /* Server IP addr (0 = unknown) */
149 struct in_addr net_server_ip;
150 /* Current receive packet */
151 uchar *net_rx_packet;
152 /* Current rx packet length */
153 int net_rx_packet_len;
155 static unsigned net_ip_id;
156 /* Ethernet bcast address */
157 const u8 net_bcast_ethaddr[6] = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
158 const u8 net_null_ethaddr[6];
159 #if defined(CONFIG_API) || defined(CONFIG_EFI_LOADER)
160 void (*push_packet)(void *, int len) = 0;
162 /* Network loop state */
163 enum net_loop_state net_state;
164 /* Tried all network devices */
165 int net_restart_wrap;
166 /* Network loop restarted */
167 static int net_restarted;
168 /* At least one device configured */
169 static int net_dev_exists;
171 /* XXX in both little & big endian machines 0xFFFF == ntohs(-1) */
172 /* default is without VLAN */
173 ushort net_our_vlan = 0xFFFF;
175 ushort net_native_vlan = 0xFFFF;
178 char net_boot_file_name[1024];
179 /* Indicates whether the file name was specified on the command line */
180 bool net_boot_file_name_explicit;
181 /* The actual transferred size of the bootfile (in bytes) */
182 u32 net_boot_file_size;
183 /* Boot file size in blocks as reported by the DHCP server */
184 u32 net_boot_file_expected_size_in_blocks;
186 #if defined(CONFIG_CMD_SNTP)
187 /* NTP server IP address */
188 struct in_addr net_ntp_server;
189 /* offset time from UTC */
190 int net_ntp_time_offset;
193 static uchar net_pkt_buf[(PKTBUFSRX+1) * PKTSIZE_ALIGN + PKTALIGN];
194 /* Receive packets */
195 uchar *net_rx_packets[PKTBUFSRX];
196 /* Current UDP RX packet handler */
197 static rxhand_f *udp_packet_handler;
198 /* Current ARP RX packet handler */
199 static rxhand_f *arp_packet_handler;
200 #ifdef CONFIG_CMD_TFTPPUT
201 /* Current ICMP rx handler */
202 static rxhand_icmp_f *packet_icmp_handler;
204 /* Current timeout handler */
205 static thand_f *time_handler;
206 /* Time base value */
207 static ulong time_start;
208 /* Current timeout value */
209 static ulong time_delta;
210 /* THE transmit packet */
211 uchar *net_tx_packet;
213 static int net_check_prereq(enum proto_t protocol);
215 static int net_try_count;
217 int __maybe_unused net_busy_flag;
219 /**********************************************************************/
221 static int on_ipaddr(const char *name, const char *value, enum env_op op,
224 if (flags & H_PROGRAMMATIC)
227 net_ip = string_to_ip(value);
231 U_BOOT_ENV_CALLBACK(ipaddr, on_ipaddr);
233 static int on_gatewayip(const char *name, const char *value, enum env_op op,
236 if (flags & H_PROGRAMMATIC)
239 net_gateway = string_to_ip(value);
243 U_BOOT_ENV_CALLBACK(gatewayip, on_gatewayip);
245 static int on_netmask(const char *name, const char *value, enum env_op op,
248 if (flags & H_PROGRAMMATIC)
251 net_netmask = string_to_ip(value);
255 U_BOOT_ENV_CALLBACK(netmask, on_netmask);
257 static int on_serverip(const char *name, const char *value, enum env_op op,
260 if (flags & H_PROGRAMMATIC)
263 net_server_ip = string_to_ip(value);
267 U_BOOT_ENV_CALLBACK(serverip, on_serverip);
269 static int on_nvlan(const char *name, const char *value, enum env_op op,
272 if (flags & H_PROGRAMMATIC)
275 net_native_vlan = string_to_vlan(value);
279 U_BOOT_ENV_CALLBACK(nvlan, on_nvlan);
281 static int on_vlan(const char *name, const char *value, enum env_op op,
284 if (flags & H_PROGRAMMATIC)
287 net_our_vlan = string_to_vlan(value);
291 U_BOOT_ENV_CALLBACK(vlan, on_vlan);
293 #if defined(CONFIG_CMD_DNS)
294 static int on_dnsip(const char *name, const char *value, enum env_op op,
297 if (flags & H_PROGRAMMATIC)
300 net_dns_server = string_to_ip(value);
304 U_BOOT_ENV_CALLBACK(dnsip, on_dnsip);
308 * Check if autoload is enabled. If so, use either NFS or TFTP to download
311 void net_auto_load(void)
313 #if defined(CONFIG_CMD_NFS) && !defined(CONFIG_SPL_BUILD)
314 const char *s = env_get("autoload");
316 if (s != NULL && strcmp(s, "NFS") == 0) {
317 if (net_check_prereq(NFS)) {
318 /* We aren't expecting to get a serverip, so just accept the assigned IP */
319 #ifdef CONFIG_BOOTP_SERVERIP
320 net_set_state(NETLOOP_SUCCESS);
322 printf("Cannot autoload with NFS\n");
323 net_set_state(NETLOOP_FAIL);
328 * Use NFS to load the bootfile.
334 if (env_get_yesno("autoload") == 0) {
336 * Just use BOOTP/RARP to configure system;
337 * Do not use TFTP to load the bootfile.
339 net_set_state(NETLOOP_SUCCESS);
342 if (net_check_prereq(TFTPGET)) {
343 /* We aren't expecting to get a serverip, so just accept the assigned IP */
344 #ifdef CONFIG_BOOTP_SERVERIP
345 net_set_state(NETLOOP_SUCCESS);
347 printf("Cannot autoload with TFTPGET\n");
348 net_set_state(NETLOOP_FAIL);
355 static void net_init_loop(void)
358 memcpy(net_ethaddr, eth_get_ethaddr(), 6);
363 static void net_clear_handlers(void)
365 net_set_udp_handler(NULL);
366 net_set_arp_handler(NULL);
367 net_set_timeout_handler(0, NULL);
370 static void net_cleanup_loop(void)
372 net_clear_handlers();
377 static int first_call = 1;
381 * Setup packet buffers, aligned correctly.
385 net_tx_packet = &net_pkt_buf[0] + (PKTALIGN - 1);
386 net_tx_packet -= (ulong)net_tx_packet % PKTALIGN;
387 for (i = 0; i < PKTBUFSRX; i++) {
388 net_rx_packets[i] = net_tx_packet +
389 (i + 1) * PKTSIZE_ALIGN;
392 net_clear_handlers();
394 /* Only need to setup buffer pointers once. */
401 /**********************************************************************/
403 * Main network processing loop.
406 int net_loop(enum proto_t protocol)
409 enum net_loop_state prev_net_state = net_state;
414 debug_cond(DEBUG_INT_STATE, "--- net_loop Entry\n");
416 bootstage_mark_name(BOOTSTAGE_ID_ETH_START, "eth_start");
418 if (eth_is_on_demand_init() || protocol != NETCONS) {
427 eth_init_state_only();
430 #ifdef CONFIG_USB_KEYBOARD
433 net_set_state(NETLOOP_CONTINUE);
436 * Start the ball rolling with the given start function. From
437 * here on, this code is a state machine driven by received
438 * packets and timer events.
440 debug_cond(DEBUG_INT_STATE, "--- net_loop Init\n");
443 switch (net_check_prereq(protocol)) {
445 /* network not configured */
447 net_set_state(prev_net_state);
451 /* network device not configured */
456 net_boot_file_size = 0;
459 #ifdef CONFIG_CMD_TFTPPUT
462 /* always use ARP to get server ethernet address */
463 tftp_start(protocol);
465 #ifdef CONFIG_CMD_TFTPSRV
470 #ifdef CONFIG_UDP_FUNCTION_FASTBOOT
472 fastboot_start_server();
475 #if defined(CONFIG_CMD_DHCP)
479 dhcp_request(); /* Basically same as BOOTP */
489 #if defined(CONFIG_CMD_RARP)
496 #if defined(CONFIG_CMD_PING)
501 #if defined(CONFIG_CMD_NFS) && !defined(CONFIG_SPL_BUILD)
506 #if defined(CONFIG_CMD_CDP)
511 #if defined(CONFIG_NETCONSOLE) && !defined(CONFIG_SPL_BUILD)
516 #if defined(CONFIG_CMD_SNTP)
521 #if defined(CONFIG_CMD_DNS)
526 #if defined(CONFIG_CMD_LINK_LOCAL)
531 #if defined(CONFIG_CMD_WOL)
543 #if defined(CONFIG_MII) || defined(CONFIG_CMD_MII)
544 #if defined(CONFIG_SYS_FAULT_ECHO_LINK_DOWN) && \
545 defined(CONFIG_LED_STATUS) && \
546 defined(CONFIG_LED_STATUS_RED)
548 * Echo the inverted link state to the fault LED.
550 if (miiphy_link(eth_get_dev()->name, CONFIG_SYS_FAULT_MII_ADDR))
551 status_led_set(CONFIG_LED_STATUS_RED, CONFIG_LED_STATUS_OFF);
553 status_led_set(CONFIG_LED_STATUS_RED, CONFIG_LED_STATUS_ON);
554 #endif /* CONFIG_SYS_FAULT_ECHO_LINK_DOWN, ... */
555 #endif /* CONFIG_MII, ... */
556 #ifdef CONFIG_USB_KEYBOARD
561 * Main packet reception loop. Loop receiving packets until
562 * someone sets `net_state' to a state that terminates.
566 if (arp_timeout_check() > 0)
567 time_start = get_timer(0);
570 * Check the ethernet for a new packet. The ethernet
571 * receive routine will process it.
572 * Most drivers return the most recent packet size, but not
573 * errors that may have happened.
578 * Abort if ctrl-c was pressed.
581 /* cancel any ARP that may not have completed */
582 net_arp_wait_packet_ip.s_addr = 0;
586 /* Invalidate the last protocol */
587 eth_set_last_protocol(BOOTP);
590 /* include a debug print as well incase the debug
591 messages are directed to stderr */
592 debug_cond(DEBUG_INT_STATE, "--- net_loop Abort!\n");
598 * Check for a timeout, and run the timeout handler
602 ((get_timer(0) - time_start) > time_delta)) {
605 #if defined(CONFIG_MII) || defined(CONFIG_CMD_MII)
606 #if defined(CONFIG_SYS_FAULT_ECHO_LINK_DOWN) && \
607 defined(CONFIG_LED_STATUS) && \
608 defined(CONFIG_LED_STATUS_RED)
610 * Echo the inverted link state to the fault LED.
612 if (miiphy_link(eth_get_dev()->name,
613 CONFIG_SYS_FAULT_MII_ADDR))
614 status_led_set(CONFIG_LED_STATUS_RED,
615 CONFIG_LED_STATUS_OFF);
617 status_led_set(CONFIG_LED_STATUS_RED,
618 CONFIG_LED_STATUS_ON);
619 #endif /* CONFIG_SYS_FAULT_ECHO_LINK_DOWN, ... */
620 #endif /* CONFIG_MII, ... */
621 debug_cond(DEBUG_INT_STATE, "--- net_loop timeout\n");
623 time_handler = (thand_f *)0;
627 if (net_state == NETLOOP_FAIL)
628 ret = net_start_again();
631 case NETLOOP_RESTART:
635 case NETLOOP_SUCCESS:
637 if (net_boot_file_size > 0) {
638 printf("Bytes transferred = %d (%x hex)\n",
639 net_boot_file_size, net_boot_file_size);
640 env_set_hex("filesize", net_boot_file_size);
641 env_set_hex("fileaddr", image_load_addr);
643 if (protocol != NETCONS)
646 eth_halt_state_only();
648 eth_set_last_protocol(protocol);
650 ret = net_boot_file_size;
651 debug_cond(DEBUG_INT_STATE, "--- net_loop Success!\n");
656 /* Invalidate the last protocol */
657 eth_set_last_protocol(BOOTP);
658 debug_cond(DEBUG_INT_STATE, "--- net_loop Fail!\n");
662 case NETLOOP_CONTINUE:
668 #ifdef CONFIG_USB_KEYBOARD
671 #ifdef CONFIG_CMD_TFTPPUT
672 /* Clear out the handlers */
673 net_set_udp_handler(NULL);
674 net_set_icmp_handler(NULL);
676 net_set_state(prev_net_state);
678 #if defined(CONFIG_CMD_PCAP)
685 /**********************************************************************/
687 static void start_again_timeout_handler(void)
689 net_set_state(NETLOOP_RESTART);
692 int net_start_again(void)
695 int retry_forever = 0;
696 unsigned long retrycnt = 0;
699 nretry = env_get("netretry");
701 if (!strcmp(nretry, "yes"))
703 else if (!strcmp(nretry, "no"))
705 else if (!strcmp(nretry, "once"))
708 retrycnt = simple_strtoul(nretry, NULL, 0);
714 if ((!retry_forever) && (net_try_count > retrycnt)) {
716 net_set_state(NETLOOP_FAIL);
718 * We don't provide a way for the protocol to return an error,
719 * but this is almost always the reason.
727 #if !defined(CONFIG_NET_DO_NOT_TRY_ANOTHER)
728 eth_try_another(!net_restarted);
731 if (net_restart_wrap) {
732 net_restart_wrap = 0;
733 if (net_dev_exists) {
734 net_set_timeout_handler(10000UL,
735 start_again_timeout_handler);
736 net_set_udp_handler(NULL);
738 net_set_state(NETLOOP_FAIL);
741 net_set_state(NETLOOP_RESTART);
746 /**********************************************************************/
751 static void dummy_handler(uchar *pkt, unsigned dport,
752 struct in_addr sip, unsigned sport,
757 rxhand_f *net_get_udp_handler(void)
759 return udp_packet_handler;
762 void net_set_udp_handler(rxhand_f *f)
764 debug_cond(DEBUG_INT_STATE, "--- net_loop UDP handler set (%p)\n", f);
766 udp_packet_handler = dummy_handler;
768 udp_packet_handler = f;
771 rxhand_f *net_get_arp_handler(void)
773 return arp_packet_handler;
776 void net_set_arp_handler(rxhand_f *f)
778 debug_cond(DEBUG_INT_STATE, "--- net_loop ARP handler set (%p)\n", f);
780 arp_packet_handler = dummy_handler;
782 arp_packet_handler = f;
785 #ifdef CONFIG_CMD_TFTPPUT
786 void net_set_icmp_handler(rxhand_icmp_f *f)
788 packet_icmp_handler = f;
792 void net_set_timeout_handler(ulong iv, thand_f *f)
795 debug_cond(DEBUG_INT_STATE,
796 "--- net_loop timeout handler cancelled\n");
797 time_handler = (thand_f *)0;
799 debug_cond(DEBUG_INT_STATE,
800 "--- net_loop timeout handler set (%p)\n", f);
802 time_start = get_timer(0);
803 time_delta = iv * CONFIG_SYS_HZ / 1000;
807 uchar *net_get_async_tx_pkt_buf(void)
809 if (arp_is_waiting())
810 return arp_tx_packet; /* If we are waiting, we already sent */
812 return net_tx_packet;
815 int net_send_udp_packet(uchar *ether, struct in_addr dest, int dport, int sport,
818 return net_send_ip_packet(ether, dest, dport, sport, payload_len,
819 IPPROTO_UDP, 0, 0, 0);
822 int net_send_ip_packet(uchar *ether, struct in_addr dest, int dport, int sport,
823 int payload_len, int proto, u8 action, u32 tcp_seq_num,
830 /* make sure the net_tx_packet is initialized (net_init() was called) */
831 assert(net_tx_packet != NULL);
832 if (net_tx_packet == NULL)
835 /* convert to new style broadcast */
836 if (dest.s_addr == 0)
837 dest.s_addr = 0xFFFFFFFF;
839 /* if broadcast, make the ether address a broadcast and don't do ARP */
840 if (dest.s_addr == 0xFFFFFFFF)
841 ether = (uchar *)net_bcast_ethaddr;
843 pkt = (uchar *)net_tx_packet;
845 eth_hdr_size = net_set_ether(pkt, ether, PROT_IP);
849 net_set_udp_header(pkt + eth_hdr_size, dest, dport, sport,
851 pkt_hdr_size = eth_hdr_size + IP_UDP_HDR_SIZE;
857 /* if MAC address was not discovered yet, do an ARP request */
858 if (memcmp(ether, net_null_ethaddr, 6) == 0) {
859 debug_cond(DEBUG_DEV_PKT, "sending ARP for %pI4\n", &dest);
861 /* save the ip and eth addr for the packet to send after arp */
862 net_arp_wait_packet_ip = dest;
863 arp_wait_packet_ethaddr = ether;
865 /* size of the waiting packet */
866 arp_wait_tx_packet_size = pkt_hdr_size + payload_len;
868 /* and do the ARP request */
870 arp_wait_timer_start = get_timer(0);
872 return 1; /* waiting */
874 debug_cond(DEBUG_DEV_PKT, "sending UDP to %pI4/%pM\n",
876 net_send_packet(net_tx_packet, pkt_hdr_size + payload_len);
877 return 0; /* transmitted */
881 #ifdef CONFIG_IP_DEFRAG
883 * This function collects fragments in a single packet, according
884 * to the algorithm in RFC815. It returns NULL or the pointer to
885 * a complete packet, in static storage
887 #define IP_PKTSIZE (CONFIG_NET_MAXDEFRAG)
889 #define IP_MAXUDP (IP_PKTSIZE - IP_HDR_SIZE)
892 * this is the packet being assembled, either data or frag control.
893 * Fragments go by 8 bytes, so this union must be 8 bytes long
896 /* first_byte is address of this structure */
897 u16 last_byte; /* last byte in this hole + 1 (begin of next hole) */
898 u16 next_hole; /* index of next (in 8-b blocks), 0 == none */
899 u16 prev_hole; /* index of prev, 0 == none */
903 static struct ip_udp_hdr *__net_defragment(struct ip_udp_hdr *ip, int *lenp)
905 static uchar pkt_buff[IP_PKTSIZE] __aligned(PKTALIGN);
906 static u16 first_hole, total_len;
907 struct hole *payload, *thisfrag, *h, *newh;
908 struct ip_udp_hdr *localip = (struct ip_udp_hdr *)pkt_buff;
909 uchar *indata = (uchar *)ip;
910 int offset8, start, len, done = 0;
911 u16 ip_off = ntohs(ip->ip_off);
913 /* payload starts after IP header, this fragment is in there */
914 payload = (struct hole *)(pkt_buff + IP_HDR_SIZE);
915 offset8 = (ip_off & IP_OFFS);
916 thisfrag = payload + offset8;
918 len = ntohs(ip->ip_len) - IP_HDR_SIZE;
920 if (start + len > IP_MAXUDP) /* fragment extends too far */
923 if (!total_len || localip->ip_id != ip->ip_id) {
924 /* new (or different) packet, reset structs */
926 payload[0].last_byte = ~0;
927 payload[0].next_hole = 0;
928 payload[0].prev_hole = 0;
930 /* any IP header will work, copy the first we received */
931 memcpy(localip, ip, IP_HDR_SIZE);
935 * What follows is the reassembly algorithm. We use the payload
936 * array as a linked list of hole descriptors, as each hole starts
937 * at a multiple of 8 bytes. However, last byte can be whatever value,
938 * so it is represented as byte count, not as 8-byte blocks.
941 h = payload + first_hole;
942 while (h->last_byte < start) {
944 /* no hole that far away */
947 h = payload + h->next_hole;
950 /* last fragment may be 1..7 bytes, the "+7" forces acceptance */
951 if (offset8 + ((len + 7) / 8) <= h - payload) {
952 /* no overlap with holes (dup fragment?) */
956 if (!(ip_off & IP_FLAGS_MFRAG)) {
957 /* no more fragmentss: truncate this (last) hole */
958 total_len = start + len;
959 h->last_byte = start + len;
963 * There is some overlap: fix the hole list. This code doesn't
964 * deal with a fragment that overlaps with two different holes
965 * (thus being a superset of a previously-received fragment).
968 if ((h >= thisfrag) && (h->last_byte <= start + len)) {
969 /* complete overlap with hole: remove hole */
970 if (!h->prev_hole && !h->next_hole) {
971 /* last remaining hole */
973 } else if (!h->prev_hole) {
975 first_hole = h->next_hole;
976 payload[h->next_hole].prev_hole = 0;
977 } else if (!h->next_hole) {
979 payload[h->prev_hole].next_hole = 0;
981 /* in the middle of the list */
982 payload[h->next_hole].prev_hole = h->prev_hole;
983 payload[h->prev_hole].next_hole = h->next_hole;
986 } else if (h->last_byte <= start + len) {
987 /* overlaps with final part of the hole: shorten this hole */
988 h->last_byte = start;
990 } else if (h >= thisfrag) {
991 /* overlaps with initial part of the hole: move this hole */
992 newh = thisfrag + (len / 8);
996 payload[h->next_hole].prev_hole = (h - payload);
998 payload[h->prev_hole].next_hole = (h - payload);
1000 first_hole = (h - payload);
1003 /* fragment sits in the middle: split the hole */
1004 newh = thisfrag + (len / 8);
1006 h->last_byte = start;
1007 h->next_hole = (newh - payload);
1008 newh->prev_hole = (h - payload);
1009 if (newh->next_hole)
1010 payload[newh->next_hole].prev_hole = (newh - payload);
1013 /* finally copy this fragment and possibly return whole packet */
1014 memcpy((uchar *)thisfrag, indata + IP_HDR_SIZE, len);
1018 localip->ip_len = htons(total_len);
1019 *lenp = total_len + IP_HDR_SIZE;
1023 static inline struct ip_udp_hdr *net_defragment(struct ip_udp_hdr *ip,
1026 u16 ip_off = ntohs(ip->ip_off);
1027 if (!(ip_off & (IP_OFFS | IP_FLAGS_MFRAG)))
1028 return ip; /* not a fragment */
1029 return __net_defragment(ip, lenp);
1032 #else /* !CONFIG_IP_DEFRAG */
1034 static inline struct ip_udp_hdr *net_defragment(struct ip_udp_hdr *ip,
1037 u16 ip_off = ntohs(ip->ip_off);
1038 if (!(ip_off & (IP_OFFS | IP_FLAGS_MFRAG)))
1039 return ip; /* not a fragment */
1045 * Receive an ICMP packet. We deal with REDIRECT and PING here, and silently
1048 * @parma ip IP packet containing the ICMP
1050 static void receive_icmp(struct ip_udp_hdr *ip, int len,
1051 struct in_addr src_ip, struct ethernet_hdr *et)
1053 struct icmp_hdr *icmph = (struct icmp_hdr *)&ip->udp_src;
1055 switch (icmph->type) {
1057 if (icmph->code != ICMP_REDIR_HOST)
1059 printf(" ICMP Host Redirect to %pI4 ",
1060 &icmph->un.gateway);
1063 #if defined(CONFIG_CMD_PING)
1064 ping_receive(et, ip, len);
1066 #ifdef CONFIG_CMD_TFTPPUT
1067 if (packet_icmp_handler)
1068 packet_icmp_handler(icmph->type, icmph->code,
1069 ntohs(ip->udp_dst), src_ip,
1070 ntohs(ip->udp_src), icmph->un.data,
1071 ntohs(ip->udp_len));
1077 void net_process_received_packet(uchar *in_packet, int len)
1079 struct ethernet_hdr *et;
1080 struct ip_udp_hdr *ip;
1081 struct in_addr dst_ip;
1082 struct in_addr src_ip;
1084 #if defined(CONFIG_CMD_CDP)
1087 ushort cti = 0, vlanid = VLAN_NONE, myvlanid, mynvlanid;
1089 debug_cond(DEBUG_NET_PKT, "packet received\n");
1091 #if defined(CONFIG_CMD_PCAP)
1092 pcap_post(in_packet, len, false);
1094 net_rx_packet = in_packet;
1095 net_rx_packet_len = len;
1096 et = (struct ethernet_hdr *)in_packet;
1098 /* too small packet? */
1099 if (len < ETHER_HDR_SIZE)
1102 #if defined(CONFIG_API) || defined(CONFIG_EFI_LOADER)
1104 (*push_packet)(in_packet, len);
1109 #if defined(CONFIG_CMD_CDP)
1110 /* keep track if packet is CDP */
1111 iscdp = is_cdp_packet(et->et_dest);
1114 myvlanid = ntohs(net_our_vlan);
1115 if (myvlanid == (ushort)-1)
1116 myvlanid = VLAN_NONE;
1117 mynvlanid = ntohs(net_native_vlan);
1118 if (mynvlanid == (ushort)-1)
1119 mynvlanid = VLAN_NONE;
1121 eth_proto = ntohs(et->et_protlen);
1123 if (eth_proto < 1514) {
1124 struct e802_hdr *et802 = (struct e802_hdr *)et;
1126 * Got a 802.2 packet. Check the other protocol field.
1127 * XXX VLAN over 802.2+SNAP not implemented!
1129 eth_proto = ntohs(et802->et_prot);
1131 ip = (struct ip_udp_hdr *)(in_packet + E802_HDR_SIZE);
1132 len -= E802_HDR_SIZE;
1134 } else if (eth_proto != PROT_VLAN) { /* normal packet */
1135 ip = (struct ip_udp_hdr *)(in_packet + ETHER_HDR_SIZE);
1136 len -= ETHER_HDR_SIZE;
1138 } else { /* VLAN packet */
1139 struct vlan_ethernet_hdr *vet =
1140 (struct vlan_ethernet_hdr *)et;
1142 debug_cond(DEBUG_NET_PKT, "VLAN packet received\n");
1144 /* too small packet? */
1145 if (len < VLAN_ETHER_HDR_SIZE)
1148 /* if no VLAN active */
1149 if ((ntohs(net_our_vlan) & VLAN_IDMASK) == VLAN_NONE
1150 #if defined(CONFIG_CMD_CDP)
1156 cti = ntohs(vet->vet_tag);
1157 vlanid = cti & VLAN_IDMASK;
1158 eth_proto = ntohs(vet->vet_type);
1160 ip = (struct ip_udp_hdr *)(in_packet + VLAN_ETHER_HDR_SIZE);
1161 len -= VLAN_ETHER_HDR_SIZE;
1164 debug_cond(DEBUG_NET_PKT, "Receive from protocol 0x%x\n", eth_proto);
1166 #if defined(CONFIG_CMD_CDP)
1168 cdp_receive((uchar *)ip, len);
1173 if ((myvlanid & VLAN_IDMASK) != VLAN_NONE) {
1174 if (vlanid == VLAN_NONE)
1175 vlanid = (mynvlanid & VLAN_IDMASK);
1177 if (vlanid != (myvlanid & VLAN_IDMASK))
1181 switch (eth_proto) {
1183 arp_receive(et, ip, len);
1186 #ifdef CONFIG_CMD_RARP
1188 rarp_receive(ip, len);
1192 debug_cond(DEBUG_NET_PKT, "Got IP\n");
1193 /* Before we start poking the header, make sure it is there */
1194 if (len < IP_UDP_HDR_SIZE) {
1195 debug("len bad %d < %lu\n", len,
1196 (ulong)IP_UDP_HDR_SIZE);
1199 /* Check the packet length */
1200 if (len < ntohs(ip->ip_len)) {
1201 debug("len bad %d < %d\n", len, ntohs(ip->ip_len));
1204 len = ntohs(ip->ip_len);
1205 debug_cond(DEBUG_NET_PKT, "len=%d, v=%02x\n",
1206 len, ip->ip_hl_v & 0xff);
1208 /* Can't deal with anything except IPv4 */
1209 if ((ip->ip_hl_v & 0xf0) != 0x40)
1211 /* Can't deal with IP options (headers != 20 bytes) */
1212 if ((ip->ip_hl_v & 0x0f) > 0x05)
1214 /* Check the Checksum of the header */
1215 if (!ip_checksum_ok((uchar *)ip, IP_HDR_SIZE)) {
1216 debug("checksum bad\n");
1219 /* If it is not for us, ignore it */
1220 dst_ip = net_read_ip(&ip->ip_dst);
1221 if (net_ip.s_addr && dst_ip.s_addr != net_ip.s_addr &&
1222 dst_ip.s_addr != 0xFFFFFFFF) {
1225 /* Read source IP address for later use */
1226 src_ip = net_read_ip(&ip->ip_src);
1228 * The function returns the unchanged packet if it's not
1229 * a fragment, and either the complete packet or NULL if
1230 * it is a fragment (if !CONFIG_IP_DEFRAG, it returns NULL)
1232 ip = net_defragment(ip, &len);
1236 * watch for ICMP host redirects
1238 * There is no real handler code (yet). We just watch
1239 * for ICMP host redirect messages. In case anybody
1240 * sees these messages: please contact me
1241 * (wd@denx.de), or - even better - send me the
1242 * necessary fixes :-)
1244 * Note: in all cases where I have seen this so far
1245 * it was a problem with the router configuration,
1246 * for instance when a router was configured in the
1247 * BOOTP reply, but the TFTP server was on the same
1248 * subnet. So this is probably a warning that your
1249 * configuration might be wrong. But I'm not really
1250 * sure if there aren't any other situations.
1252 * Simon Glass <sjg@chromium.org>: We get an ICMP when
1253 * we send a tftp packet to a dead connection, or when
1254 * there is no server at the other end.
1256 if (ip->ip_p == IPPROTO_ICMP) {
1257 receive_icmp(ip, len, src_ip, et);
1259 } else if (ip->ip_p != IPPROTO_UDP) { /* Only UDP packets */
1263 if (ntohs(ip->udp_len) < UDP_HDR_SIZE || ntohs(ip->udp_len) > ntohs(ip->ip_len))
1266 debug_cond(DEBUG_DEV_PKT,
1267 "received UDP (to=%pI4, from=%pI4, len=%d)\n",
1268 &dst_ip, &src_ip, len);
1270 #ifdef CONFIG_UDP_CHECKSUM
1271 if (ip->udp_xsum != 0) {
1277 xsum += (ntohs(ip->udp_len));
1278 xsum += (ntohl(ip->ip_src.s_addr) >> 16) & 0x0000ffff;
1279 xsum += (ntohl(ip->ip_src.s_addr) >> 0) & 0x0000ffff;
1280 xsum += (ntohl(ip->ip_dst.s_addr) >> 16) & 0x0000ffff;
1281 xsum += (ntohl(ip->ip_dst.s_addr) >> 0) & 0x0000ffff;
1283 sumlen = ntohs(ip->udp_len);
1284 sumptr = (u8 *)&ip->udp_src;
1286 while (sumlen > 1) {
1287 /* inlined ntohs() to avoid alignment errors */
1288 xsum += (sumptr[0] << 8) + sumptr[1];
1293 xsum += (sumptr[0] << 8) + sumptr[0];
1294 while ((xsum >> 16) != 0) {
1295 xsum = (xsum & 0x0000ffff) +
1296 ((xsum >> 16) & 0x0000ffff);
1298 if ((xsum != 0x00000000) && (xsum != 0x0000ffff)) {
1299 printf(" UDP wrong checksum %08lx %08x\n",
1300 xsum, ntohs(ip->udp_xsum));
1306 #if defined(CONFIG_NETCONSOLE) && !defined(CONFIG_SPL_BUILD)
1307 nc_input_packet((uchar *)ip + IP_UDP_HDR_SIZE,
1311 ntohs(ip->udp_len) - UDP_HDR_SIZE);
1314 * IP header OK. Pass the packet to the current handler.
1316 (*udp_packet_handler)((uchar *)ip + IP_UDP_HDR_SIZE,
1320 ntohs(ip->udp_len) - UDP_HDR_SIZE);
1322 #ifdef CONFIG_CMD_WOL
1324 wol_receive(ip, len);
1330 /**********************************************************************/
1332 static int net_check_prereq(enum proto_t protocol)
1336 #if defined(CONFIG_CMD_PING)
1338 if (net_ping_ip.s_addr == 0) {
1339 puts("*** ERROR: ping address not given\n");
1344 #if defined(CONFIG_CMD_SNTP)
1346 if (net_ntp_server.s_addr == 0) {
1347 puts("*** ERROR: NTP server address not given\n");
1352 #if defined(CONFIG_CMD_DNS)
1354 if (net_dns_server.s_addr == 0) {
1355 puts("*** ERROR: DNS server address not given\n");
1360 #if defined(CONFIG_CMD_NFS)
1366 if (net_server_ip.s_addr == 0 && !is_serverip_in_cmd()) {
1367 puts("*** ERROR: `serverip' not set\n");
1370 #if defined(CONFIG_CMD_PING) || defined(CONFIG_CMD_SNTP) || \
1371 defined(CONFIG_CMD_DNS)
1379 if (net_ip.s_addr == 0) {
1380 puts("*** ERROR: `ipaddr' not set\n");
1385 #ifdef CONFIG_CMD_RARP
1392 if (memcmp(net_ethaddr, "\0\0\0\0\0\0", 6) == 0) {
1393 int num = eth_get_dev_index();
1397 puts("*** ERROR: No ethernet found.\n");
1400 puts("*** ERROR: `ethaddr' not set\n");
1403 printf("*** ERROR: `eth%daddr' not set\n",
1417 /**********************************************************************/
1420 net_eth_hdr_size(void)
1424 myvlanid = ntohs(net_our_vlan);
1425 if (myvlanid == (ushort)-1)
1426 myvlanid = VLAN_NONE;
1428 return ((myvlanid & VLAN_IDMASK) == VLAN_NONE) ? ETHER_HDR_SIZE :
1429 VLAN_ETHER_HDR_SIZE;
1432 int net_set_ether(uchar *xet, const uchar *dest_ethaddr, uint prot)
1434 struct ethernet_hdr *et = (struct ethernet_hdr *)xet;
1437 myvlanid = ntohs(net_our_vlan);
1438 if (myvlanid == (ushort)-1)
1439 myvlanid = VLAN_NONE;
1441 memcpy(et->et_dest, dest_ethaddr, 6);
1442 memcpy(et->et_src, net_ethaddr, 6);
1443 if ((myvlanid & VLAN_IDMASK) == VLAN_NONE) {
1444 et->et_protlen = htons(prot);
1445 return ETHER_HDR_SIZE;
1447 struct vlan_ethernet_hdr *vet =
1448 (struct vlan_ethernet_hdr *)xet;
1450 vet->vet_vlan_type = htons(PROT_VLAN);
1451 vet->vet_tag = htons((0 << 5) | (myvlanid & VLAN_IDMASK));
1452 vet->vet_type = htons(prot);
1453 return VLAN_ETHER_HDR_SIZE;
1457 int net_update_ether(struct ethernet_hdr *et, uchar *addr, uint prot)
1461 memcpy(et->et_dest, addr, 6);
1462 memcpy(et->et_src, net_ethaddr, 6);
1463 protlen = ntohs(et->et_protlen);
1464 if (protlen == PROT_VLAN) {
1465 struct vlan_ethernet_hdr *vet =
1466 (struct vlan_ethernet_hdr *)et;
1467 vet->vet_type = htons(prot);
1468 return VLAN_ETHER_HDR_SIZE;
1469 } else if (protlen > 1514) {
1470 et->et_protlen = htons(prot);
1471 return ETHER_HDR_SIZE;
1474 struct e802_hdr *et802 = (struct e802_hdr *)et;
1475 et802->et_prot = htons(prot);
1476 return E802_HDR_SIZE;
1480 void net_set_ip_header(uchar *pkt, struct in_addr dest, struct in_addr source,
1481 u16 pkt_len, u8 proto)
1483 struct ip_udp_hdr *ip = (struct ip_udp_hdr *)pkt;
1486 * Construct an IP header.
1488 /* IP_HDR_SIZE / 4 (not including UDP) */
1491 ip->ip_len = htons(pkt_len);
1493 ip->ip_id = htons(net_ip_id++);
1494 ip->ip_off = htons(IP_FLAGS_DFRAG); /* Don't fragment */
1497 /* already in network byte order */
1498 net_copy_ip((void *)&ip->ip_src, &source);
1499 /* already in network byte order */
1500 net_copy_ip((void *)&ip->ip_dst, &dest);
1502 ip->ip_sum = compute_ip_checksum(ip, IP_HDR_SIZE);
1505 void net_set_udp_header(uchar *pkt, struct in_addr dest, int dport, int sport,
1508 struct ip_udp_hdr *ip = (struct ip_udp_hdr *)pkt;
1511 * If the data is an odd number of bytes, zero the
1512 * byte after the last byte so that the checksum
1516 pkt[IP_UDP_HDR_SIZE + len] = 0;
1518 net_set_ip_header(pkt, dest, net_ip, IP_UDP_HDR_SIZE + len,
1521 ip->udp_src = htons(sport);
1522 ip->udp_dst = htons(dport);
1523 ip->udp_len = htons(UDP_HDR_SIZE + len);
1527 void copy_filename(char *dst, const char *src, int size)
1529 if (src && *src && (*src == '"')) {
1534 while ((--size > 0) && src && *src && (*src != '"'))
1539 int is_serverip_in_cmd(void)
1541 return !!strchr(net_boot_file_name, ':');
1544 int net_parse_bootfile(struct in_addr *ipaddr, char *filename, int max_len)
1548 if (net_boot_file_name[0] == '\0')
1551 colon = strchr(net_boot_file_name, ':');
1554 *ipaddr = string_to_ip(net_boot_file_name);
1555 strncpy(filename, colon + 1, max_len);
1557 strncpy(filename, net_boot_file_name, max_len);
1559 filename[max_len - 1] = '\0';
1564 #if defined(CONFIG_CMD_NFS) || \
1565 defined(CONFIG_CMD_SNTP) || \
1566 defined(CONFIG_CMD_DNS)
1568 * make port a little random (1024-17407)
1569 * This keeps the math somewhat trivial to compute, and seems to work with
1570 * all supported protocols/clients/servers
1572 unsigned int random_port(void)
1574 return 1024 + (get_timer(0) % 0x4000);
1578 void ip_to_string(struct in_addr x, char *s)
1580 x.s_addr = ntohl(x.s_addr);
1581 sprintf(s, "%d.%d.%d.%d",
1582 (int) ((x.s_addr >> 24) & 0xff),
1583 (int) ((x.s_addr >> 16) & 0xff),
1584 (int) ((x.s_addr >> 8) & 0xff),
1585 (int) ((x.s_addr >> 0) & 0xff)
1589 void vlan_to_string(ushort x, char *s)
1593 if (x == (ushort)-1)
1599 sprintf(s, "%d", x & VLAN_IDMASK);
1602 ushort string_to_vlan(const char *s)
1607 return htons(VLAN_NONE);
1609 if (*s < '0' || *s > '9')
1612 id = (ushort)simple_strtoul(s, NULL, 10);
1617 ushort env_get_vlan(char *var)
1619 return string_to_vlan(env_get(var));