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
93 #include <environment.h>
96 #include <net/fastboot.h>
98 #if defined(CONFIG_LED_STATUS)
100 #include <status_led.h>
102 #include <watchdog.h>
103 #include <linux/compiler.h>
107 #if defined(CONFIG_CMD_DNS)
110 #include "link_local.h"
114 #if defined(CONFIG_CMD_SNTP)
117 #if defined(CONFIG_CMD_WOL)
121 /** BOOTP EXTENTIONS **/
123 /* Our subnet mask (0=unknown) */
124 struct in_addr net_netmask;
125 /* Our gateways IP address */
126 struct in_addr net_gateway;
127 /* Our DNS IP address */
128 struct in_addr net_dns_server;
129 #if defined(CONFIG_BOOTP_DNS2)
130 /* Our 2nd DNS IP address */
131 struct in_addr net_dns_server2;
134 #ifdef CONFIG_MCAST_TFTP /* Multicast TFTP */
135 struct in_addr net_mcast_addr;
138 /** END OF BOOTP EXTENTIONS **/
140 /* Our ethernet address */
142 /* Boot server enet address */
143 u8 net_server_ethaddr[6];
144 /* Our IP addr (0 = unknown) */
145 struct in_addr net_ip;
146 /* Server IP addr (0 = unknown) */
147 struct in_addr net_server_ip;
148 /* Current receive packet */
149 uchar *net_rx_packet;
150 /* Current rx packet length */
151 int net_rx_packet_len;
153 static unsigned net_ip_id;
154 /* Ethernet bcast address */
155 const u8 net_bcast_ethaddr[6] = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
156 const u8 net_null_ethaddr[6];
157 #if defined(CONFIG_API) || defined(CONFIG_EFI_LOADER)
158 void (*push_packet)(void *, int len) = 0;
160 /* Network loop state */
161 enum net_loop_state net_state;
162 /* Tried all network devices */
163 int net_restart_wrap;
164 /* Network loop restarted */
165 static int net_restarted;
166 /* At least one device configured */
167 static int net_dev_exists;
169 /* XXX in both little & big endian machines 0xFFFF == ntohs(-1) */
170 /* default is without VLAN */
171 ushort net_our_vlan = 0xFFFF;
173 ushort net_native_vlan = 0xFFFF;
176 char net_boot_file_name[1024];
177 /* Indicates whether the file name was specified on the command line */
178 bool net_boot_file_name_explicit;
179 /* The actual transferred size of the bootfile (in bytes) */
180 u32 net_boot_file_size;
181 /* Boot file size in blocks as reported by the DHCP server */
182 u32 net_boot_file_expected_size_in_blocks;
184 #if defined(CONFIG_CMD_SNTP)
185 /* NTP server IP address */
186 struct in_addr net_ntp_server;
187 /* offset time from UTC */
188 int net_ntp_time_offset;
191 static uchar net_pkt_buf[(PKTBUFSRX+1) * PKTSIZE_ALIGN + PKTALIGN];
192 /* Receive packets */
193 uchar *net_rx_packets[PKTBUFSRX];
194 /* Current UDP RX packet handler */
195 static rxhand_f *udp_packet_handler;
196 /* Current ARP RX packet handler */
197 static rxhand_f *arp_packet_handler;
198 #ifdef CONFIG_CMD_TFTPPUT
199 /* Current ICMP rx handler */
200 static rxhand_icmp_f *packet_icmp_handler;
202 /* Current timeout handler */
203 static thand_f *time_handler;
204 /* Time base value */
205 static ulong time_start;
206 /* Current timeout value */
207 static ulong time_delta;
208 /* THE transmit packet */
209 uchar *net_tx_packet;
211 static int net_check_prereq(enum proto_t protocol);
213 static int net_try_count;
215 int __maybe_unused net_busy_flag;
217 /**********************************************************************/
219 static int on_ipaddr(const char *name, const char *value, enum env_op op,
222 if (flags & H_PROGRAMMATIC)
225 net_ip = string_to_ip(value);
229 U_BOOT_ENV_CALLBACK(ipaddr, on_ipaddr);
231 static int on_gatewayip(const char *name, const char *value, enum env_op op,
234 if (flags & H_PROGRAMMATIC)
237 net_gateway = string_to_ip(value);
241 U_BOOT_ENV_CALLBACK(gatewayip, on_gatewayip);
243 static int on_netmask(const char *name, const char *value, enum env_op op,
246 if (flags & H_PROGRAMMATIC)
249 net_netmask = string_to_ip(value);
253 U_BOOT_ENV_CALLBACK(netmask, on_netmask);
255 static int on_serverip(const char *name, const char *value, enum env_op op,
258 if (flags & H_PROGRAMMATIC)
261 net_server_ip = string_to_ip(value);
265 U_BOOT_ENV_CALLBACK(serverip, on_serverip);
267 static int on_nvlan(const char *name, const char *value, enum env_op op,
270 if (flags & H_PROGRAMMATIC)
273 net_native_vlan = string_to_vlan(value);
277 U_BOOT_ENV_CALLBACK(nvlan, on_nvlan);
279 static int on_vlan(const char *name, const char *value, enum env_op op,
282 if (flags & H_PROGRAMMATIC)
285 net_our_vlan = string_to_vlan(value);
289 U_BOOT_ENV_CALLBACK(vlan, on_vlan);
291 #if defined(CONFIG_CMD_DNS)
292 static int on_dnsip(const char *name, const char *value, enum env_op op,
295 if (flags & H_PROGRAMMATIC)
298 net_dns_server = string_to_ip(value);
302 U_BOOT_ENV_CALLBACK(dnsip, on_dnsip);
306 * Check if autoload is enabled. If so, use either NFS or TFTP to download
309 void net_auto_load(void)
311 #if defined(CONFIG_CMD_NFS)
312 const char *s = env_get("autoload");
314 if (s != NULL && strcmp(s, "NFS") == 0) {
315 if (net_check_prereq(NFS)) {
316 /* We aren't expecting to get a serverip, so just accept the assigned IP */
317 #ifdef CONFIG_BOOTP_SERVERIP
318 net_set_state(NETLOOP_SUCCESS);
320 printf("Cannot autoload with NFS\n");
321 net_set_state(NETLOOP_FAIL);
326 * Use NFS to load the bootfile.
332 if (env_get_yesno("autoload") == 0) {
334 * Just use BOOTP/RARP to configure system;
335 * Do not use TFTP to load the bootfile.
337 net_set_state(NETLOOP_SUCCESS);
340 if (net_check_prereq(TFTPGET)) {
341 /* We aren't expecting to get a serverip, so just accept the assigned IP */
342 #ifdef CONFIG_BOOTP_SERVERIP
343 net_set_state(NETLOOP_SUCCESS);
345 printf("Cannot autoload with TFTPGET\n");
346 net_set_state(NETLOOP_FAIL);
353 static void net_init_loop(void)
356 memcpy(net_ethaddr, eth_get_ethaddr(), 6);
361 static void net_clear_handlers(void)
363 net_set_udp_handler(NULL);
364 net_set_arp_handler(NULL);
365 net_set_timeout_handler(0, NULL);
368 static void net_cleanup_loop(void)
370 net_clear_handlers();
375 static int first_call = 1;
379 * Setup packet buffers, aligned correctly.
383 net_tx_packet = &net_pkt_buf[0] + (PKTALIGN - 1);
384 net_tx_packet -= (ulong)net_tx_packet % PKTALIGN;
385 for (i = 0; i < PKTBUFSRX; i++) {
386 net_rx_packets[i] = net_tx_packet +
387 (i + 1) * PKTSIZE_ALIGN;
390 net_clear_handlers();
392 /* Only need to setup buffer pointers once. */
399 /**********************************************************************/
401 * Main network processing loop.
404 int net_loop(enum proto_t protocol)
407 enum net_loop_state prev_net_state = net_state;
412 debug_cond(DEBUG_INT_STATE, "--- net_loop Entry\n");
414 bootstage_mark_name(BOOTSTAGE_ID_ETH_START, "eth_start");
416 if (eth_is_on_demand_init() || protocol != NETCONS) {
425 eth_init_state_only();
428 #ifdef CONFIG_USB_KEYBOARD
431 net_set_state(NETLOOP_CONTINUE);
434 * Start the ball rolling with the given start function. From
435 * here on, this code is a state machine driven by received
436 * packets and timer events.
438 debug_cond(DEBUG_INT_STATE, "--- net_loop Init\n");
441 switch (net_check_prereq(protocol)) {
443 /* network not configured */
445 net_set_state(prev_net_state);
449 /* network device not configured */
454 net_boot_file_size = 0;
457 #ifdef CONFIG_CMD_TFTPPUT
460 /* always use ARP to get server ethernet address */
461 tftp_start(protocol);
463 #ifdef CONFIG_CMD_TFTPSRV
468 #ifdef CONFIG_UDP_FUNCTION_FASTBOOT
470 fastboot_start_server();
473 #if defined(CONFIG_CMD_DHCP)
477 dhcp_request(); /* Basically same as BOOTP */
487 #if defined(CONFIG_CMD_RARP)
494 #if defined(CONFIG_CMD_PING)
499 #if defined(CONFIG_CMD_NFS)
504 #if defined(CONFIG_CMD_CDP)
509 #if defined(CONFIG_NETCONSOLE) && !defined(CONFIG_SPL_BUILD)
514 #if defined(CONFIG_CMD_SNTP)
519 #if defined(CONFIG_CMD_DNS)
524 #if defined(CONFIG_CMD_LINK_LOCAL)
529 #if defined(CONFIG_CMD_WOL)
541 #if defined(CONFIG_MII) || defined(CONFIG_CMD_MII)
542 #if defined(CONFIG_SYS_FAULT_ECHO_LINK_DOWN) && \
543 defined(CONFIG_LED_STATUS) && \
544 defined(CONFIG_LED_STATUS_RED)
546 * Echo the inverted link state to the fault LED.
548 if (miiphy_link(eth_get_dev()->name, CONFIG_SYS_FAULT_MII_ADDR))
549 status_led_set(CONFIG_LED_STATUS_RED, CONFIG_LED_STATUS_OFF);
551 status_led_set(CONFIG_LED_STATUS_RED, CONFIG_LED_STATUS_ON);
552 #endif /* CONFIG_SYS_FAULT_ECHO_LINK_DOWN, ... */
553 #endif /* CONFIG_MII, ... */
554 #ifdef CONFIG_USB_KEYBOARD
559 * Main packet reception loop. Loop receiving packets until
560 * someone sets `net_state' to a state that terminates.
564 #ifdef CONFIG_SHOW_ACTIVITY
567 if (arp_timeout_check() > 0)
568 time_start = get_timer(0);
571 * Check the ethernet for a new packet. The ethernet
572 * receive routine will process it.
573 * Most drivers return the most recent packet size, but not
574 * errors that may have happened.
579 * Abort if ctrl-c was pressed.
582 /* cancel any ARP that may not have completed */
583 net_arp_wait_packet_ip.s_addr = 0;
587 /* Invalidate the last protocol */
588 eth_set_last_protocol(BOOTP);
591 /* include a debug print as well incase the debug
592 messages are directed to stderr */
593 debug_cond(DEBUG_INT_STATE, "--- net_loop Abort!\n");
599 * Check for a timeout, and run the timeout handler
603 ((get_timer(0) - time_start) > time_delta)) {
606 #if defined(CONFIG_MII) || defined(CONFIG_CMD_MII)
607 #if defined(CONFIG_SYS_FAULT_ECHO_LINK_DOWN) && \
608 defined(CONFIG_LED_STATUS) && \
609 defined(CONFIG_LED_STATUS_RED)
611 * Echo the inverted link state to the fault LED.
613 if (miiphy_link(eth_get_dev()->name,
614 CONFIG_SYS_FAULT_MII_ADDR))
615 status_led_set(CONFIG_LED_STATUS_RED,
616 CONFIG_LED_STATUS_OFF);
618 status_led_set(CONFIG_LED_STATUS_RED,
619 CONFIG_LED_STATUS_ON);
620 #endif /* CONFIG_SYS_FAULT_ECHO_LINK_DOWN, ... */
621 #endif /* CONFIG_MII, ... */
622 debug_cond(DEBUG_INT_STATE, "--- net_loop timeout\n");
624 time_handler = (thand_f *)0;
628 if (net_state == NETLOOP_FAIL)
629 ret = net_start_again();
632 case NETLOOP_RESTART:
636 case NETLOOP_SUCCESS:
638 if (net_boot_file_size > 0) {
639 printf("Bytes transferred = %d (%x hex)\n",
640 net_boot_file_size, net_boot_file_size);
641 env_set_hex("filesize", net_boot_file_size);
642 env_set_hex("fileaddr", load_addr);
644 if (protocol != NETCONS)
647 eth_halt_state_only();
649 eth_set_last_protocol(protocol);
651 ret = net_boot_file_size;
652 debug_cond(DEBUG_INT_STATE, "--- net_loop Success!\n");
657 /* Invalidate the last protocol */
658 eth_set_last_protocol(BOOTP);
659 debug_cond(DEBUG_INT_STATE, "--- net_loop Fail!\n");
663 case NETLOOP_CONTINUE:
669 #ifdef CONFIG_USB_KEYBOARD
672 #ifdef CONFIG_CMD_TFTPPUT
673 /* Clear out the handlers */
674 net_set_udp_handler(NULL);
675 net_set_icmp_handler(NULL);
677 net_set_state(prev_net_state);
681 /**********************************************************************/
683 static void start_again_timeout_handler(void)
685 net_set_state(NETLOOP_RESTART);
688 int net_start_again(void)
691 int retry_forever = 0;
692 unsigned long retrycnt = 0;
695 nretry = env_get("netretry");
697 if (!strcmp(nretry, "yes"))
699 else if (!strcmp(nretry, "no"))
701 else if (!strcmp(nretry, "once"))
704 retrycnt = simple_strtoul(nretry, NULL, 0);
710 if ((!retry_forever) && (net_try_count > retrycnt)) {
712 net_set_state(NETLOOP_FAIL);
714 * We don't provide a way for the protocol to return an error,
715 * but this is almost always the reason.
723 #if !defined(CONFIG_NET_DO_NOT_TRY_ANOTHER)
724 eth_try_another(!net_restarted);
727 if (net_restart_wrap) {
728 net_restart_wrap = 0;
729 if (net_dev_exists) {
730 net_set_timeout_handler(10000UL,
731 start_again_timeout_handler);
732 net_set_udp_handler(NULL);
734 net_set_state(NETLOOP_FAIL);
737 net_set_state(NETLOOP_RESTART);
742 /**********************************************************************/
747 static void dummy_handler(uchar *pkt, unsigned dport,
748 struct in_addr sip, unsigned sport,
753 rxhand_f *net_get_udp_handler(void)
755 return udp_packet_handler;
758 void net_set_udp_handler(rxhand_f *f)
760 debug_cond(DEBUG_INT_STATE, "--- net_loop UDP handler set (%p)\n", f);
762 udp_packet_handler = dummy_handler;
764 udp_packet_handler = f;
767 rxhand_f *net_get_arp_handler(void)
769 return arp_packet_handler;
772 void net_set_arp_handler(rxhand_f *f)
774 debug_cond(DEBUG_INT_STATE, "--- net_loop ARP handler set (%p)\n", f);
776 arp_packet_handler = dummy_handler;
778 arp_packet_handler = f;
781 #ifdef CONFIG_CMD_TFTPPUT
782 void net_set_icmp_handler(rxhand_icmp_f *f)
784 packet_icmp_handler = f;
788 void net_set_timeout_handler(ulong iv, thand_f *f)
791 debug_cond(DEBUG_INT_STATE,
792 "--- net_loop timeout handler cancelled\n");
793 time_handler = (thand_f *)0;
795 debug_cond(DEBUG_INT_STATE,
796 "--- net_loop timeout handler set (%p)\n", f);
798 time_start = get_timer(0);
799 time_delta = iv * CONFIG_SYS_HZ / 1000;
803 uchar *net_get_async_tx_pkt_buf(void)
805 if (arp_is_waiting())
806 return arp_tx_packet; /* If we are waiting, we already sent */
808 return net_tx_packet;
811 int net_send_udp_packet(uchar *ether, struct in_addr dest, int dport, int sport,
814 return net_send_ip_packet(ether, dest, dport, sport, payload_len,
815 IPPROTO_UDP, 0, 0, 0);
818 int net_send_ip_packet(uchar *ether, struct in_addr dest, int dport, int sport,
819 int payload_len, int proto, u8 action, u32 tcp_seq_num,
826 /* make sure the net_tx_packet is initialized (net_init() was called) */
827 assert(net_tx_packet != NULL);
828 if (net_tx_packet == NULL)
831 /* convert to new style broadcast */
832 if (dest.s_addr == 0)
833 dest.s_addr = 0xFFFFFFFF;
835 /* if broadcast, make the ether address a broadcast and don't do ARP */
836 if (dest.s_addr == 0xFFFFFFFF)
837 ether = (uchar *)net_bcast_ethaddr;
839 pkt = (uchar *)net_tx_packet;
841 eth_hdr_size = net_set_ether(pkt, ether, PROT_IP);
845 net_set_udp_header(pkt + eth_hdr_size, dest, dport, sport,
847 pkt_hdr_size = eth_hdr_size + IP_UDP_HDR_SIZE;
853 /* if MAC address was not discovered yet, do an ARP request */
854 if (memcmp(ether, net_null_ethaddr, 6) == 0) {
855 debug_cond(DEBUG_DEV_PKT, "sending ARP for %pI4\n", &dest);
857 /* save the ip and eth addr for the packet to send after arp */
858 net_arp_wait_packet_ip = dest;
859 arp_wait_packet_ethaddr = ether;
861 /* size of the waiting packet */
862 arp_wait_tx_packet_size = pkt_hdr_size + payload_len;
864 /* and do the ARP request */
866 arp_wait_timer_start = get_timer(0);
868 return 1; /* waiting */
870 debug_cond(DEBUG_DEV_PKT, "sending UDP to %pI4/%pM\n",
872 net_send_packet(net_tx_packet, pkt_hdr_size + payload_len);
873 return 0; /* transmitted */
877 #ifdef CONFIG_IP_DEFRAG
879 * This function collects fragments in a single packet, according
880 * to the algorithm in RFC815. It returns NULL or the pointer to
881 * a complete packet, in static storage
883 #ifndef CONFIG_NET_MAXDEFRAG
884 #define CONFIG_NET_MAXDEFRAG 16384
886 #define IP_PKTSIZE (CONFIG_NET_MAXDEFRAG)
888 #define IP_MAXUDP (IP_PKTSIZE - IP_HDR_SIZE)
891 * this is the packet being assembled, either data or frag control.
892 * Fragments go by 8 bytes, so this union must be 8 bytes long
895 /* first_byte is address of this structure */
896 u16 last_byte; /* last byte in this hole + 1 (begin of next hole) */
897 u16 next_hole; /* index of next (in 8-b blocks), 0 == none */
898 u16 prev_hole; /* index of prev, 0 == none */
902 static struct ip_udp_hdr *__net_defragment(struct ip_udp_hdr *ip, int *lenp)
904 static uchar pkt_buff[IP_PKTSIZE] __aligned(PKTALIGN);
905 static u16 first_hole, total_len;
906 struct hole *payload, *thisfrag, *h, *newh;
907 struct ip_udp_hdr *localip = (struct ip_udp_hdr *)pkt_buff;
908 uchar *indata = (uchar *)ip;
909 int offset8, start, len, done = 0;
910 u16 ip_off = ntohs(ip->ip_off);
912 /* payload starts after IP header, this fragment is in there */
913 payload = (struct hole *)(pkt_buff + IP_HDR_SIZE);
914 offset8 = (ip_off & IP_OFFS);
915 thisfrag = payload + offset8;
917 len = ntohs(ip->ip_len) - IP_HDR_SIZE;
919 if (start + len > IP_MAXUDP) /* fragment extends too far */
922 if (!total_len || localip->ip_id != ip->ip_id) {
923 /* new (or different) packet, reset structs */
925 payload[0].last_byte = ~0;
926 payload[0].next_hole = 0;
927 payload[0].prev_hole = 0;
929 /* any IP header will work, copy the first we received */
930 memcpy(localip, ip, IP_HDR_SIZE);
934 * What follows is the reassembly algorithm. We use the payload
935 * array as a linked list of hole descriptors, as each hole starts
936 * at a multiple of 8 bytes. However, last byte can be whatever value,
937 * so it is represented as byte count, not as 8-byte blocks.
940 h = payload + first_hole;
941 while (h->last_byte < start) {
943 /* no hole that far away */
946 h = payload + h->next_hole;
949 /* last fragment may be 1..7 bytes, the "+7" forces acceptance */
950 if (offset8 + ((len + 7) / 8) <= h - payload) {
951 /* no overlap with holes (dup fragment?) */
955 if (!(ip_off & IP_FLAGS_MFRAG)) {
956 /* no more fragmentss: truncate this (last) hole */
957 total_len = start + len;
958 h->last_byte = start + len;
962 * There is some overlap: fix the hole list. This code doesn't
963 * deal with a fragment that overlaps with two different holes
964 * (thus being a superset of a previously-received fragment).
967 if ((h >= thisfrag) && (h->last_byte <= start + len)) {
968 /* complete overlap with hole: remove hole */
969 if (!h->prev_hole && !h->next_hole) {
970 /* last remaining hole */
972 } else if (!h->prev_hole) {
974 first_hole = h->next_hole;
975 payload[h->next_hole].prev_hole = 0;
976 } else if (!h->next_hole) {
978 payload[h->prev_hole].next_hole = 0;
980 /* in the middle of the list */
981 payload[h->next_hole].prev_hole = h->prev_hole;
982 payload[h->prev_hole].next_hole = h->next_hole;
985 } else if (h->last_byte <= start + len) {
986 /* overlaps with final part of the hole: shorten this hole */
987 h->last_byte = start;
989 } else if (h >= thisfrag) {
990 /* overlaps with initial part of the hole: move this hole */
991 newh = thisfrag + (len / 8);
995 payload[h->next_hole].prev_hole = (h - payload);
997 payload[h->prev_hole].next_hole = (h - payload);
999 first_hole = (h - payload);
1002 /* fragment sits in the middle: split the hole */
1003 newh = thisfrag + (len / 8);
1005 h->last_byte = start;
1006 h->next_hole = (newh - payload);
1007 newh->prev_hole = (h - payload);
1008 if (newh->next_hole)
1009 payload[newh->next_hole].prev_hole = (newh - payload);
1012 /* finally copy this fragment and possibly return whole packet */
1013 memcpy((uchar *)thisfrag, indata + IP_HDR_SIZE, len);
1017 localip->ip_len = htons(total_len);
1018 *lenp = total_len + IP_HDR_SIZE;
1022 static inline struct ip_udp_hdr *net_defragment(struct ip_udp_hdr *ip,
1025 u16 ip_off = ntohs(ip->ip_off);
1026 if (!(ip_off & (IP_OFFS | IP_FLAGS_MFRAG)))
1027 return ip; /* not a fragment */
1028 return __net_defragment(ip, lenp);
1031 #else /* !CONFIG_IP_DEFRAG */
1033 static inline struct ip_udp_hdr *net_defragment(struct ip_udp_hdr *ip,
1036 u16 ip_off = ntohs(ip->ip_off);
1037 if (!(ip_off & (IP_OFFS | IP_FLAGS_MFRAG)))
1038 return ip; /* not a fragment */
1044 * Receive an ICMP packet. We deal with REDIRECT and PING here, and silently
1047 * @parma ip IP packet containing the ICMP
1049 static void receive_icmp(struct ip_udp_hdr *ip, int len,
1050 struct in_addr src_ip, struct ethernet_hdr *et)
1052 struct icmp_hdr *icmph = (struct icmp_hdr *)&ip->udp_src;
1054 switch (icmph->type) {
1056 if (icmph->code != ICMP_REDIR_HOST)
1058 printf(" ICMP Host Redirect to %pI4 ",
1059 &icmph->un.gateway);
1062 #if defined(CONFIG_CMD_PING)
1063 ping_receive(et, ip, len);
1065 #ifdef CONFIG_CMD_TFTPPUT
1066 if (packet_icmp_handler)
1067 packet_icmp_handler(icmph->type, icmph->code,
1068 ntohs(ip->udp_dst), src_ip,
1069 ntohs(ip->udp_src), icmph->un.data,
1070 ntohs(ip->udp_len));
1076 void net_process_received_packet(uchar *in_packet, int len)
1078 struct ethernet_hdr *et;
1079 struct ip_udp_hdr *ip;
1080 struct in_addr dst_ip;
1081 struct in_addr src_ip;
1083 #if defined(CONFIG_CMD_CDP)
1086 ushort cti = 0, vlanid = VLAN_NONE, myvlanid, mynvlanid;
1088 debug_cond(DEBUG_NET_PKT, "packet received\n");
1090 net_rx_packet = in_packet;
1091 net_rx_packet_len = len;
1092 et = (struct ethernet_hdr *)in_packet;
1094 /* too small packet? */
1095 if (len < ETHER_HDR_SIZE)
1098 #if defined(CONFIG_API) || defined(CONFIG_EFI_LOADER)
1100 (*push_packet)(in_packet, len);
1105 #if defined(CONFIG_CMD_CDP)
1106 /* keep track if packet is CDP */
1107 iscdp = is_cdp_packet(et->et_dest);
1110 myvlanid = ntohs(net_our_vlan);
1111 if (myvlanid == (ushort)-1)
1112 myvlanid = VLAN_NONE;
1113 mynvlanid = ntohs(net_native_vlan);
1114 if (mynvlanid == (ushort)-1)
1115 mynvlanid = VLAN_NONE;
1117 eth_proto = ntohs(et->et_protlen);
1119 if (eth_proto < 1514) {
1120 struct e802_hdr *et802 = (struct e802_hdr *)et;
1122 * Got a 802.2 packet. Check the other protocol field.
1123 * XXX VLAN over 802.2+SNAP not implemented!
1125 eth_proto = ntohs(et802->et_prot);
1127 ip = (struct ip_udp_hdr *)(in_packet + E802_HDR_SIZE);
1128 len -= E802_HDR_SIZE;
1130 } else if (eth_proto != PROT_VLAN) { /* normal packet */
1131 ip = (struct ip_udp_hdr *)(in_packet + ETHER_HDR_SIZE);
1132 len -= ETHER_HDR_SIZE;
1134 } else { /* VLAN packet */
1135 struct vlan_ethernet_hdr *vet =
1136 (struct vlan_ethernet_hdr *)et;
1138 debug_cond(DEBUG_NET_PKT, "VLAN packet received\n");
1140 /* too small packet? */
1141 if (len < VLAN_ETHER_HDR_SIZE)
1144 /* if no VLAN active */
1145 if ((ntohs(net_our_vlan) & VLAN_IDMASK) == VLAN_NONE
1146 #if defined(CONFIG_CMD_CDP)
1152 cti = ntohs(vet->vet_tag);
1153 vlanid = cti & VLAN_IDMASK;
1154 eth_proto = ntohs(vet->vet_type);
1156 ip = (struct ip_udp_hdr *)(in_packet + VLAN_ETHER_HDR_SIZE);
1157 len -= VLAN_ETHER_HDR_SIZE;
1160 debug_cond(DEBUG_NET_PKT, "Receive from protocol 0x%x\n", eth_proto);
1162 #if defined(CONFIG_CMD_CDP)
1164 cdp_receive((uchar *)ip, len);
1169 if ((myvlanid & VLAN_IDMASK) != VLAN_NONE) {
1170 if (vlanid == VLAN_NONE)
1171 vlanid = (mynvlanid & VLAN_IDMASK);
1173 if (vlanid != (myvlanid & VLAN_IDMASK))
1177 switch (eth_proto) {
1179 arp_receive(et, ip, len);
1182 #ifdef CONFIG_CMD_RARP
1184 rarp_receive(ip, len);
1188 debug_cond(DEBUG_NET_PKT, "Got IP\n");
1189 /* Before we start poking the header, make sure it is there */
1190 if (len < IP_UDP_HDR_SIZE) {
1191 debug("len bad %d < %lu\n", len,
1192 (ulong)IP_UDP_HDR_SIZE);
1195 /* Check the packet length */
1196 if (len < ntohs(ip->ip_len)) {
1197 debug("len bad %d < %d\n", len, ntohs(ip->ip_len));
1200 len = ntohs(ip->ip_len);
1201 debug_cond(DEBUG_NET_PKT, "len=%d, v=%02x\n",
1202 len, ip->ip_hl_v & 0xff);
1204 /* Can't deal with anything except IPv4 */
1205 if ((ip->ip_hl_v & 0xf0) != 0x40)
1207 /* Can't deal with IP options (headers != 20 bytes) */
1208 if ((ip->ip_hl_v & 0x0f) > 0x05)
1210 /* Check the Checksum of the header */
1211 if (!ip_checksum_ok((uchar *)ip, IP_HDR_SIZE)) {
1212 debug("checksum bad\n");
1215 /* If it is not for us, ignore it */
1216 dst_ip = net_read_ip(&ip->ip_dst);
1217 if (net_ip.s_addr && dst_ip.s_addr != net_ip.s_addr &&
1218 dst_ip.s_addr != 0xFFFFFFFF) {
1219 #ifdef CONFIG_MCAST_TFTP
1220 if (net_mcast_addr != dst_ip)
1224 /* Read source IP address for later use */
1225 src_ip = net_read_ip(&ip->ip_src);
1227 * The function returns the unchanged packet if it's not
1228 * a fragment, and either the complete packet or NULL if
1229 * it is a fragment (if !CONFIG_IP_DEFRAG, it returns NULL)
1231 ip = net_defragment(ip, &len);
1235 * watch for ICMP host redirects
1237 * There is no real handler code (yet). We just watch
1238 * for ICMP host redirect messages. In case anybody
1239 * sees these messages: please contact me
1240 * (wd@denx.de), or - even better - send me the
1241 * necessary fixes :-)
1243 * Note: in all cases where I have seen this so far
1244 * it was a problem with the router configuration,
1245 * for instance when a router was configured in the
1246 * BOOTP reply, but the TFTP server was on the same
1247 * subnet. So this is probably a warning that your
1248 * configuration might be wrong. But I'm not really
1249 * sure if there aren't any other situations.
1251 * Simon Glass <sjg@chromium.org>: We get an ICMP when
1252 * we send a tftp packet to a dead connection, or when
1253 * there is no server at the other end.
1255 if (ip->ip_p == IPPROTO_ICMP) {
1256 receive_icmp(ip, len, src_ip, et);
1258 } else if (ip->ip_p != IPPROTO_UDP) { /* Only UDP packets */
1262 debug_cond(DEBUG_DEV_PKT,
1263 "received UDP (to=%pI4, from=%pI4, len=%d)\n",
1264 &dst_ip, &src_ip, len);
1266 #ifdef CONFIG_UDP_CHECKSUM
1267 if (ip->udp_xsum != 0) {
1273 xsum += (ntohs(ip->udp_len));
1274 xsum += (ntohl(ip->ip_src.s_addr) >> 16) & 0x0000ffff;
1275 xsum += (ntohl(ip->ip_src.s_addr) >> 0) & 0x0000ffff;
1276 xsum += (ntohl(ip->ip_dst.s_addr) >> 16) & 0x0000ffff;
1277 xsum += (ntohl(ip->ip_dst.s_addr) >> 0) & 0x0000ffff;
1279 sumlen = ntohs(ip->udp_len);
1280 sumptr = (ushort *)&(ip->udp_src);
1282 while (sumlen > 1) {
1285 sumdata = *sumptr++;
1286 xsum += ntohs(sumdata);
1292 sumdata = *(unsigned char *)sumptr;
1293 sumdata = (sumdata << 8) & 0xff00;
1296 while ((xsum >> 16) != 0) {
1297 xsum = (xsum & 0x0000ffff) +
1298 ((xsum >> 16) & 0x0000ffff);
1300 if ((xsum != 0x00000000) && (xsum != 0x0000ffff)) {
1301 printf(" UDP wrong checksum %08lx %08x\n",
1302 xsum, ntohs(ip->udp_xsum));
1308 #if defined(CONFIG_NETCONSOLE) && !defined(CONFIG_SPL_BUILD)
1309 nc_input_packet((uchar *)ip + IP_UDP_HDR_SIZE,
1313 ntohs(ip->udp_len) - UDP_HDR_SIZE);
1316 * IP header OK. Pass the packet to the current handler.
1318 (*udp_packet_handler)((uchar *)ip + IP_UDP_HDR_SIZE,
1322 ntohs(ip->udp_len) - UDP_HDR_SIZE);
1324 #ifdef CONFIG_CMD_WOL
1326 wol_receive(ip, len);
1332 /**********************************************************************/
1334 static int net_check_prereq(enum proto_t protocol)
1338 #if defined(CONFIG_CMD_PING)
1340 if (net_ping_ip.s_addr == 0) {
1341 puts("*** ERROR: ping address not given\n");
1346 #if defined(CONFIG_CMD_SNTP)
1348 if (net_ntp_server.s_addr == 0) {
1349 puts("*** ERROR: NTP server address not given\n");
1354 #if defined(CONFIG_CMD_DNS)
1356 if (net_dns_server.s_addr == 0) {
1357 puts("*** ERROR: DNS server address not given\n");
1362 #if defined(CONFIG_CMD_NFS)
1368 if (net_server_ip.s_addr == 0 && !is_serverip_in_cmd()) {
1369 puts("*** ERROR: `serverip' not set\n");
1372 #if defined(CONFIG_CMD_PING) || defined(CONFIG_CMD_SNTP) || \
1373 defined(CONFIG_CMD_DNS)
1381 if (net_ip.s_addr == 0) {
1382 puts("*** ERROR: `ipaddr' not set\n");
1387 #ifdef CONFIG_CMD_RARP
1394 if (memcmp(net_ethaddr, "\0\0\0\0\0\0", 6) == 0) {
1395 int num = eth_get_dev_index();
1399 puts("*** ERROR: No ethernet found.\n");
1402 puts("*** ERROR: `ethaddr' not set\n");
1405 printf("*** ERROR: `eth%daddr' not set\n",
1419 /**********************************************************************/
1422 net_eth_hdr_size(void)
1426 myvlanid = ntohs(net_our_vlan);
1427 if (myvlanid == (ushort)-1)
1428 myvlanid = VLAN_NONE;
1430 return ((myvlanid & VLAN_IDMASK) == VLAN_NONE) ? ETHER_HDR_SIZE :
1431 VLAN_ETHER_HDR_SIZE;
1434 int net_set_ether(uchar *xet, const uchar *dest_ethaddr, uint prot)
1436 struct ethernet_hdr *et = (struct ethernet_hdr *)xet;
1439 myvlanid = ntohs(net_our_vlan);
1440 if (myvlanid == (ushort)-1)
1441 myvlanid = VLAN_NONE;
1443 memcpy(et->et_dest, dest_ethaddr, 6);
1444 memcpy(et->et_src, net_ethaddr, 6);
1445 if ((myvlanid & VLAN_IDMASK) == VLAN_NONE) {
1446 et->et_protlen = htons(prot);
1447 return ETHER_HDR_SIZE;
1449 struct vlan_ethernet_hdr *vet =
1450 (struct vlan_ethernet_hdr *)xet;
1452 vet->vet_vlan_type = htons(PROT_VLAN);
1453 vet->vet_tag = htons((0 << 5) | (myvlanid & VLAN_IDMASK));
1454 vet->vet_type = htons(prot);
1455 return VLAN_ETHER_HDR_SIZE;
1459 int net_update_ether(struct ethernet_hdr *et, uchar *addr, uint prot)
1463 memcpy(et->et_dest, addr, 6);
1464 memcpy(et->et_src, net_ethaddr, 6);
1465 protlen = ntohs(et->et_protlen);
1466 if (protlen == PROT_VLAN) {
1467 struct vlan_ethernet_hdr *vet =
1468 (struct vlan_ethernet_hdr *)et;
1469 vet->vet_type = htons(prot);
1470 return VLAN_ETHER_HDR_SIZE;
1471 } else if (protlen > 1514) {
1472 et->et_protlen = htons(prot);
1473 return ETHER_HDR_SIZE;
1476 struct e802_hdr *et802 = (struct e802_hdr *)et;
1477 et802->et_prot = htons(prot);
1478 return E802_HDR_SIZE;
1482 void net_set_ip_header(uchar *pkt, struct in_addr dest, struct in_addr source,
1483 u16 pkt_len, u8 proto)
1485 struct ip_udp_hdr *ip = (struct ip_udp_hdr *)pkt;
1488 * Construct an IP header.
1490 /* IP_HDR_SIZE / 4 (not including UDP) */
1493 ip->ip_len = htons(pkt_len);
1495 ip->ip_id = htons(net_ip_id++);
1496 ip->ip_off = htons(IP_FLAGS_DFRAG); /* Don't fragment */
1499 /* already in network byte order */
1500 net_copy_ip((void *)&ip->ip_src, &source);
1501 /* already in network byte order */
1502 net_copy_ip((void *)&ip->ip_dst, &dest);
1504 ip->ip_sum = compute_ip_checksum(ip, IP_HDR_SIZE);
1507 void net_set_udp_header(uchar *pkt, struct in_addr dest, int dport, int sport,
1510 struct ip_udp_hdr *ip = (struct ip_udp_hdr *)pkt;
1513 * If the data is an odd number of bytes, zero the
1514 * byte after the last byte so that the checksum
1518 pkt[IP_UDP_HDR_SIZE + len] = 0;
1520 net_set_ip_header(pkt, dest, net_ip, IP_UDP_HDR_SIZE + len,
1523 ip->udp_src = htons(sport);
1524 ip->udp_dst = htons(dport);
1525 ip->udp_len = htons(UDP_HDR_SIZE + len);
1529 void copy_filename(char *dst, const char *src, int size)
1531 if (src && *src && (*src == '"')) {
1536 while ((--size > 0) && src && *src && (*src != '"'))
1541 int is_serverip_in_cmd(void)
1543 return !!strchr(net_boot_file_name, ':');
1546 int net_parse_bootfile(struct in_addr *ipaddr, char *filename, int max_len)
1550 if (net_boot_file_name[0] == '\0')
1553 colon = strchr(net_boot_file_name, ':');
1556 *ipaddr = string_to_ip(net_boot_file_name);
1557 strncpy(filename, colon + 1, max_len);
1559 strncpy(filename, net_boot_file_name, max_len);
1561 filename[max_len - 1] = '\0';
1566 #if defined(CONFIG_CMD_NFS) || \
1567 defined(CONFIG_CMD_SNTP) || \
1568 defined(CONFIG_CMD_DNS)
1570 * make port a little random (1024-17407)
1571 * This keeps the math somewhat trivial to compute, and seems to work with
1572 * all supported protocols/clients/servers
1574 unsigned int random_port(void)
1576 return 1024 + (get_timer(0) % 0x4000);
1580 void ip_to_string(struct in_addr x, char *s)
1582 x.s_addr = ntohl(x.s_addr);
1583 sprintf(s, "%d.%d.%d.%d",
1584 (int) ((x.s_addr >> 24) & 0xff),
1585 (int) ((x.s_addr >> 16) & 0xff),
1586 (int) ((x.s_addr >> 8) & 0xff),
1587 (int) ((x.s_addr >> 0) & 0xff)
1591 void vlan_to_string(ushort x, char *s)
1595 if (x == (ushort)-1)
1601 sprintf(s, "%d", x & VLAN_IDMASK);
1604 ushort string_to_vlan(const char *s)
1609 return htons(VLAN_NONE);
1611 if (*s < '0' || *s > '9')
1614 id = (ushort)simple_strtoul(s, NULL, 10);
1619 ushort env_get_vlan(char *var)
1621 return string_to_vlan(env_get(var));