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
94 #include <env_internal.h>
97 #include <net/fastboot.h>
99 #if defined(CONFIG_CMD_PCAP)
100 #include <net/pcap.h>
102 #if defined(CONFIG_LED_STATUS)
104 #include <status_led.h>
106 #include <watchdog.h>
107 #include <linux/compiler.h>
111 #if defined(CONFIG_CMD_DNS)
114 #include "link_local.h"
118 #if defined(CONFIG_CMD_SNTP)
121 #if defined(CONFIG_CMD_WOL)
125 /** BOOTP EXTENTIONS **/
127 /* Our subnet mask (0=unknown) */
128 struct in_addr net_netmask;
129 /* Our gateways IP address */
130 struct in_addr net_gateway;
131 /* Our DNS IP address */
132 struct in_addr net_dns_server;
133 #if defined(CONFIG_BOOTP_DNS2)
134 /* Our 2nd DNS IP address */
135 struct in_addr net_dns_server2;
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) && !defined(CONFIG_SPL_BUILD)
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) && !defined(CONFIG_SPL_BUILD)
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 if (arp_timeout_check() > 0)
565 time_start = get_timer(0);
568 * Check the ethernet for a new packet. The ethernet
569 * receive routine will process it.
570 * Most drivers return the most recent packet size, but not
571 * errors that may have happened.
576 * Abort if ctrl-c was pressed.
579 /* cancel any ARP that may not have completed */
580 net_arp_wait_packet_ip.s_addr = 0;
584 /* Invalidate the last protocol */
585 eth_set_last_protocol(BOOTP);
588 /* include a debug print as well incase the debug
589 messages are directed to stderr */
590 debug_cond(DEBUG_INT_STATE, "--- net_loop Abort!\n");
596 * Check for a timeout, and run the timeout handler
600 ((get_timer(0) - time_start) > time_delta)) {
603 #if defined(CONFIG_MII) || defined(CONFIG_CMD_MII)
604 #if defined(CONFIG_SYS_FAULT_ECHO_LINK_DOWN) && \
605 defined(CONFIG_LED_STATUS) && \
606 defined(CONFIG_LED_STATUS_RED)
608 * Echo the inverted link state to the fault LED.
610 if (miiphy_link(eth_get_dev()->name,
611 CONFIG_SYS_FAULT_MII_ADDR))
612 status_led_set(CONFIG_LED_STATUS_RED,
613 CONFIG_LED_STATUS_OFF);
615 status_led_set(CONFIG_LED_STATUS_RED,
616 CONFIG_LED_STATUS_ON);
617 #endif /* CONFIG_SYS_FAULT_ECHO_LINK_DOWN, ... */
618 #endif /* CONFIG_MII, ... */
619 debug_cond(DEBUG_INT_STATE, "--- net_loop timeout\n");
621 time_handler = (thand_f *)0;
625 if (net_state == NETLOOP_FAIL)
626 ret = net_start_again();
629 case NETLOOP_RESTART:
633 case NETLOOP_SUCCESS:
635 if (net_boot_file_size > 0) {
636 printf("Bytes transferred = %d (%x hex)\n",
637 net_boot_file_size, net_boot_file_size);
638 env_set_hex("filesize", net_boot_file_size);
639 env_set_hex("fileaddr", load_addr);
641 if (protocol != NETCONS)
644 eth_halt_state_only();
646 eth_set_last_protocol(protocol);
648 ret = net_boot_file_size;
649 debug_cond(DEBUG_INT_STATE, "--- net_loop Success!\n");
654 /* Invalidate the last protocol */
655 eth_set_last_protocol(BOOTP);
656 debug_cond(DEBUG_INT_STATE, "--- net_loop Fail!\n");
660 case NETLOOP_CONTINUE:
666 #ifdef CONFIG_USB_KEYBOARD
669 #ifdef CONFIG_CMD_TFTPPUT
670 /* Clear out the handlers */
671 net_set_udp_handler(NULL);
672 net_set_icmp_handler(NULL);
674 net_set_state(prev_net_state);
676 #if defined(CONFIG_CMD_PCAP)
683 /**********************************************************************/
685 static void start_again_timeout_handler(void)
687 net_set_state(NETLOOP_RESTART);
690 int net_start_again(void)
693 int retry_forever = 0;
694 unsigned long retrycnt = 0;
697 nretry = env_get("netretry");
699 if (!strcmp(nretry, "yes"))
701 else if (!strcmp(nretry, "no"))
703 else if (!strcmp(nretry, "once"))
706 retrycnt = simple_strtoul(nretry, NULL, 0);
712 if ((!retry_forever) && (net_try_count > retrycnt)) {
714 net_set_state(NETLOOP_FAIL);
716 * We don't provide a way for the protocol to return an error,
717 * but this is almost always the reason.
725 #if !defined(CONFIG_NET_DO_NOT_TRY_ANOTHER)
726 eth_try_another(!net_restarted);
729 if (net_restart_wrap) {
730 net_restart_wrap = 0;
731 if (net_dev_exists) {
732 net_set_timeout_handler(10000UL,
733 start_again_timeout_handler);
734 net_set_udp_handler(NULL);
736 net_set_state(NETLOOP_FAIL);
739 net_set_state(NETLOOP_RESTART);
744 /**********************************************************************/
749 static void dummy_handler(uchar *pkt, unsigned dport,
750 struct in_addr sip, unsigned sport,
755 rxhand_f *net_get_udp_handler(void)
757 return udp_packet_handler;
760 void net_set_udp_handler(rxhand_f *f)
762 debug_cond(DEBUG_INT_STATE, "--- net_loop UDP handler set (%p)\n", f);
764 udp_packet_handler = dummy_handler;
766 udp_packet_handler = f;
769 rxhand_f *net_get_arp_handler(void)
771 return arp_packet_handler;
774 void net_set_arp_handler(rxhand_f *f)
776 debug_cond(DEBUG_INT_STATE, "--- net_loop ARP handler set (%p)\n", f);
778 arp_packet_handler = dummy_handler;
780 arp_packet_handler = f;
783 #ifdef CONFIG_CMD_TFTPPUT
784 void net_set_icmp_handler(rxhand_icmp_f *f)
786 packet_icmp_handler = f;
790 void net_set_timeout_handler(ulong iv, thand_f *f)
793 debug_cond(DEBUG_INT_STATE,
794 "--- net_loop timeout handler cancelled\n");
795 time_handler = (thand_f *)0;
797 debug_cond(DEBUG_INT_STATE,
798 "--- net_loop timeout handler set (%p)\n", f);
800 time_start = get_timer(0);
801 time_delta = iv * CONFIG_SYS_HZ / 1000;
805 uchar *net_get_async_tx_pkt_buf(void)
807 if (arp_is_waiting())
808 return arp_tx_packet; /* If we are waiting, we already sent */
810 return net_tx_packet;
813 int net_send_udp_packet(uchar *ether, struct in_addr dest, int dport, int sport,
816 return net_send_ip_packet(ether, dest, dport, sport, payload_len,
817 IPPROTO_UDP, 0, 0, 0);
820 int net_send_ip_packet(uchar *ether, struct in_addr dest, int dport, int sport,
821 int payload_len, int proto, u8 action, u32 tcp_seq_num,
828 /* make sure the net_tx_packet is initialized (net_init() was called) */
829 assert(net_tx_packet != NULL);
830 if (net_tx_packet == NULL)
833 /* convert to new style broadcast */
834 if (dest.s_addr == 0)
835 dest.s_addr = 0xFFFFFFFF;
837 /* if broadcast, make the ether address a broadcast and don't do ARP */
838 if (dest.s_addr == 0xFFFFFFFF)
839 ether = (uchar *)net_bcast_ethaddr;
841 pkt = (uchar *)net_tx_packet;
843 eth_hdr_size = net_set_ether(pkt, ether, PROT_IP);
847 net_set_udp_header(pkt + eth_hdr_size, dest, dport, sport,
849 pkt_hdr_size = eth_hdr_size + IP_UDP_HDR_SIZE;
855 /* if MAC address was not discovered yet, do an ARP request */
856 if (memcmp(ether, net_null_ethaddr, 6) == 0) {
857 debug_cond(DEBUG_DEV_PKT, "sending ARP for %pI4\n", &dest);
859 /* save the ip and eth addr for the packet to send after arp */
860 net_arp_wait_packet_ip = dest;
861 arp_wait_packet_ethaddr = ether;
863 /* size of the waiting packet */
864 arp_wait_tx_packet_size = pkt_hdr_size + payload_len;
866 /* and do the ARP request */
868 arp_wait_timer_start = get_timer(0);
870 return 1; /* waiting */
872 debug_cond(DEBUG_DEV_PKT, "sending UDP to %pI4/%pM\n",
874 net_send_packet(net_tx_packet, pkt_hdr_size + payload_len);
875 return 0; /* transmitted */
879 #ifdef CONFIG_IP_DEFRAG
881 * This function collects fragments in a single packet, according
882 * to the algorithm in RFC815. It returns NULL or the pointer to
883 * a complete packet, in static storage
885 #ifndef CONFIG_NET_MAXDEFRAG
886 #define CONFIG_NET_MAXDEFRAG 16384
888 #define IP_PKTSIZE (CONFIG_NET_MAXDEFRAG)
890 #define IP_MAXUDP (IP_PKTSIZE - IP_HDR_SIZE)
893 * this is the packet being assembled, either data or frag control.
894 * Fragments go by 8 bytes, so this union must be 8 bytes long
897 /* first_byte is address of this structure */
898 u16 last_byte; /* last byte in this hole + 1 (begin of next hole) */
899 u16 next_hole; /* index of next (in 8-b blocks), 0 == none */
900 u16 prev_hole; /* index of prev, 0 == none */
904 static struct ip_udp_hdr *__net_defragment(struct ip_udp_hdr *ip, int *lenp)
906 static uchar pkt_buff[IP_PKTSIZE] __aligned(PKTALIGN);
907 static u16 first_hole, total_len;
908 struct hole *payload, *thisfrag, *h, *newh;
909 struct ip_udp_hdr *localip = (struct ip_udp_hdr *)pkt_buff;
910 uchar *indata = (uchar *)ip;
911 int offset8, start, len, done = 0;
912 u16 ip_off = ntohs(ip->ip_off);
914 /* payload starts after IP header, this fragment is in there */
915 payload = (struct hole *)(pkt_buff + IP_HDR_SIZE);
916 offset8 = (ip_off & IP_OFFS);
917 thisfrag = payload + offset8;
919 len = ntohs(ip->ip_len) - IP_HDR_SIZE;
921 if (start + len > IP_MAXUDP) /* fragment extends too far */
924 if (!total_len || localip->ip_id != ip->ip_id) {
925 /* new (or different) packet, reset structs */
927 payload[0].last_byte = ~0;
928 payload[0].next_hole = 0;
929 payload[0].prev_hole = 0;
931 /* any IP header will work, copy the first we received */
932 memcpy(localip, ip, IP_HDR_SIZE);
936 * What follows is the reassembly algorithm. We use the payload
937 * array as a linked list of hole descriptors, as each hole starts
938 * at a multiple of 8 bytes. However, last byte can be whatever value,
939 * so it is represented as byte count, not as 8-byte blocks.
942 h = payload + first_hole;
943 while (h->last_byte < start) {
945 /* no hole that far away */
948 h = payload + h->next_hole;
951 /* last fragment may be 1..7 bytes, the "+7" forces acceptance */
952 if (offset8 + ((len + 7) / 8) <= h - payload) {
953 /* no overlap with holes (dup fragment?) */
957 if (!(ip_off & IP_FLAGS_MFRAG)) {
958 /* no more fragmentss: truncate this (last) hole */
959 total_len = start + len;
960 h->last_byte = start + len;
964 * There is some overlap: fix the hole list. This code doesn't
965 * deal with a fragment that overlaps with two different holes
966 * (thus being a superset of a previously-received fragment).
969 if ((h >= thisfrag) && (h->last_byte <= start + len)) {
970 /* complete overlap with hole: remove hole */
971 if (!h->prev_hole && !h->next_hole) {
972 /* last remaining hole */
974 } else if (!h->prev_hole) {
976 first_hole = h->next_hole;
977 payload[h->next_hole].prev_hole = 0;
978 } else if (!h->next_hole) {
980 payload[h->prev_hole].next_hole = 0;
982 /* in the middle of the list */
983 payload[h->next_hole].prev_hole = h->prev_hole;
984 payload[h->prev_hole].next_hole = h->next_hole;
987 } else if (h->last_byte <= start + len) {
988 /* overlaps with final part of the hole: shorten this hole */
989 h->last_byte = start;
991 } else if (h >= thisfrag) {
992 /* overlaps with initial part of the hole: move this hole */
993 newh = thisfrag + (len / 8);
997 payload[h->next_hole].prev_hole = (h - payload);
999 payload[h->prev_hole].next_hole = (h - payload);
1001 first_hole = (h - payload);
1004 /* fragment sits in the middle: split the hole */
1005 newh = thisfrag + (len / 8);
1007 h->last_byte = start;
1008 h->next_hole = (newh - payload);
1009 newh->prev_hole = (h - payload);
1010 if (newh->next_hole)
1011 payload[newh->next_hole].prev_hole = (newh - payload);
1014 /* finally copy this fragment and possibly return whole packet */
1015 memcpy((uchar *)thisfrag, indata + IP_HDR_SIZE, len);
1019 localip->ip_len = htons(total_len);
1020 *lenp = total_len + IP_HDR_SIZE;
1024 static inline struct ip_udp_hdr *net_defragment(struct ip_udp_hdr *ip,
1027 u16 ip_off = ntohs(ip->ip_off);
1028 if (!(ip_off & (IP_OFFS | IP_FLAGS_MFRAG)))
1029 return ip; /* not a fragment */
1030 return __net_defragment(ip, lenp);
1033 #else /* !CONFIG_IP_DEFRAG */
1035 static inline struct ip_udp_hdr *net_defragment(struct ip_udp_hdr *ip,
1038 u16 ip_off = ntohs(ip->ip_off);
1039 if (!(ip_off & (IP_OFFS | IP_FLAGS_MFRAG)))
1040 return ip; /* not a fragment */
1046 * Receive an ICMP packet. We deal with REDIRECT and PING here, and silently
1049 * @parma ip IP packet containing the ICMP
1051 static void receive_icmp(struct ip_udp_hdr *ip, int len,
1052 struct in_addr src_ip, struct ethernet_hdr *et)
1054 struct icmp_hdr *icmph = (struct icmp_hdr *)&ip->udp_src;
1056 switch (icmph->type) {
1058 if (icmph->code != ICMP_REDIR_HOST)
1060 printf(" ICMP Host Redirect to %pI4 ",
1061 &icmph->un.gateway);
1064 #if defined(CONFIG_CMD_PING)
1065 ping_receive(et, ip, len);
1067 #ifdef CONFIG_CMD_TFTPPUT
1068 if (packet_icmp_handler)
1069 packet_icmp_handler(icmph->type, icmph->code,
1070 ntohs(ip->udp_dst), src_ip,
1071 ntohs(ip->udp_src), icmph->un.data,
1072 ntohs(ip->udp_len));
1078 void net_process_received_packet(uchar *in_packet, int len)
1080 struct ethernet_hdr *et;
1081 struct ip_udp_hdr *ip;
1082 struct in_addr dst_ip;
1083 struct in_addr src_ip;
1085 #if defined(CONFIG_CMD_CDP)
1088 ushort cti = 0, vlanid = VLAN_NONE, myvlanid, mynvlanid;
1090 debug_cond(DEBUG_NET_PKT, "packet received\n");
1092 #if defined(CONFIG_CMD_PCAP)
1093 pcap_post(in_packet, len, false);
1095 net_rx_packet = in_packet;
1096 net_rx_packet_len = len;
1097 et = (struct ethernet_hdr *)in_packet;
1099 /* too small packet? */
1100 if (len < ETHER_HDR_SIZE)
1103 #if defined(CONFIG_API) || defined(CONFIG_EFI_LOADER)
1105 (*push_packet)(in_packet, len);
1110 #if defined(CONFIG_CMD_CDP)
1111 /* keep track if packet is CDP */
1112 iscdp = is_cdp_packet(et->et_dest);
1115 myvlanid = ntohs(net_our_vlan);
1116 if (myvlanid == (ushort)-1)
1117 myvlanid = VLAN_NONE;
1118 mynvlanid = ntohs(net_native_vlan);
1119 if (mynvlanid == (ushort)-1)
1120 mynvlanid = VLAN_NONE;
1122 eth_proto = ntohs(et->et_protlen);
1124 if (eth_proto < 1514) {
1125 struct e802_hdr *et802 = (struct e802_hdr *)et;
1127 * Got a 802.2 packet. Check the other protocol field.
1128 * XXX VLAN over 802.2+SNAP not implemented!
1130 eth_proto = ntohs(et802->et_prot);
1132 ip = (struct ip_udp_hdr *)(in_packet + E802_HDR_SIZE);
1133 len -= E802_HDR_SIZE;
1135 } else if (eth_proto != PROT_VLAN) { /* normal packet */
1136 ip = (struct ip_udp_hdr *)(in_packet + ETHER_HDR_SIZE);
1137 len -= ETHER_HDR_SIZE;
1139 } else { /* VLAN packet */
1140 struct vlan_ethernet_hdr *vet =
1141 (struct vlan_ethernet_hdr *)et;
1143 debug_cond(DEBUG_NET_PKT, "VLAN packet received\n");
1145 /* too small packet? */
1146 if (len < VLAN_ETHER_HDR_SIZE)
1149 /* if no VLAN active */
1150 if ((ntohs(net_our_vlan) & VLAN_IDMASK) == VLAN_NONE
1151 #if defined(CONFIG_CMD_CDP)
1157 cti = ntohs(vet->vet_tag);
1158 vlanid = cti & VLAN_IDMASK;
1159 eth_proto = ntohs(vet->vet_type);
1161 ip = (struct ip_udp_hdr *)(in_packet + VLAN_ETHER_HDR_SIZE);
1162 len -= VLAN_ETHER_HDR_SIZE;
1165 debug_cond(DEBUG_NET_PKT, "Receive from protocol 0x%x\n", eth_proto);
1167 #if defined(CONFIG_CMD_CDP)
1169 cdp_receive((uchar *)ip, len);
1174 if ((myvlanid & VLAN_IDMASK) != VLAN_NONE) {
1175 if (vlanid == VLAN_NONE)
1176 vlanid = (mynvlanid & VLAN_IDMASK);
1178 if (vlanid != (myvlanid & VLAN_IDMASK))
1182 switch (eth_proto) {
1184 arp_receive(et, ip, len);
1187 #ifdef CONFIG_CMD_RARP
1189 rarp_receive(ip, len);
1193 debug_cond(DEBUG_NET_PKT, "Got IP\n");
1194 /* Before we start poking the header, make sure it is there */
1195 if (len < IP_UDP_HDR_SIZE) {
1196 debug("len bad %d < %lu\n", len,
1197 (ulong)IP_UDP_HDR_SIZE);
1200 /* Check the packet length */
1201 if (len < ntohs(ip->ip_len)) {
1202 debug("len bad %d < %d\n", len, ntohs(ip->ip_len));
1205 len = ntohs(ip->ip_len);
1206 debug_cond(DEBUG_NET_PKT, "len=%d, v=%02x\n",
1207 len, ip->ip_hl_v & 0xff);
1209 /* Can't deal with anything except IPv4 */
1210 if ((ip->ip_hl_v & 0xf0) != 0x40)
1212 /* Can't deal with IP options (headers != 20 bytes) */
1213 if ((ip->ip_hl_v & 0x0f) > 0x05)
1215 /* Check the Checksum of the header */
1216 if (!ip_checksum_ok((uchar *)ip, IP_HDR_SIZE)) {
1217 debug("checksum bad\n");
1220 /* If it is not for us, ignore it */
1221 dst_ip = net_read_ip(&ip->ip_dst);
1222 if (net_ip.s_addr && dst_ip.s_addr != net_ip.s_addr &&
1223 dst_ip.s_addr != 0xFFFFFFFF) {
1226 /* Read source IP address for later use */
1227 src_ip = net_read_ip(&ip->ip_src);
1229 * The function returns the unchanged packet if it's not
1230 * a fragment, and either the complete packet or NULL if
1231 * it is a fragment (if !CONFIG_IP_DEFRAG, it returns NULL)
1233 ip = net_defragment(ip, &len);
1237 * watch for ICMP host redirects
1239 * There is no real handler code (yet). We just watch
1240 * for ICMP host redirect messages. In case anybody
1241 * sees these messages: please contact me
1242 * (wd@denx.de), or - even better - send me the
1243 * necessary fixes :-)
1245 * Note: in all cases where I have seen this so far
1246 * it was a problem with the router configuration,
1247 * for instance when a router was configured in the
1248 * BOOTP reply, but the TFTP server was on the same
1249 * subnet. So this is probably a warning that your
1250 * configuration might be wrong. But I'm not really
1251 * sure if there aren't any other situations.
1253 * Simon Glass <sjg@chromium.org>: We get an ICMP when
1254 * we send a tftp packet to a dead connection, or when
1255 * there is no server at the other end.
1257 if (ip->ip_p == IPPROTO_ICMP) {
1258 receive_icmp(ip, len, src_ip, et);
1260 } else if (ip->ip_p != IPPROTO_UDP) { /* Only UDP packets */
1264 if (ntohs(ip->udp_len) < UDP_HDR_SIZE || ntohs(ip->udp_len) > ntohs(ip->ip_len))
1267 debug_cond(DEBUG_DEV_PKT,
1268 "received UDP (to=%pI4, from=%pI4, len=%d)\n",
1269 &dst_ip, &src_ip, len);
1271 #ifdef CONFIG_UDP_CHECKSUM
1272 if (ip->udp_xsum != 0) {
1278 xsum += (ntohs(ip->udp_len));
1279 xsum += (ntohl(ip->ip_src.s_addr) >> 16) & 0x0000ffff;
1280 xsum += (ntohl(ip->ip_src.s_addr) >> 0) & 0x0000ffff;
1281 xsum += (ntohl(ip->ip_dst.s_addr) >> 16) & 0x0000ffff;
1282 xsum += (ntohl(ip->ip_dst.s_addr) >> 0) & 0x0000ffff;
1284 sumlen = ntohs(ip->udp_len);
1285 sumptr = (u8 *)&ip->udp_src;
1287 while (sumlen > 1) {
1288 /* inlined ntohs() to avoid alignment errors */
1289 xsum += (sumptr[0] << 8) + sumptr[1];
1294 xsum += (sumptr[0] << 8) + sumptr[0];
1295 while ((xsum >> 16) != 0) {
1296 xsum = (xsum & 0x0000ffff) +
1297 ((xsum >> 16) & 0x0000ffff);
1299 if ((xsum != 0x00000000) && (xsum != 0x0000ffff)) {
1300 printf(" UDP wrong checksum %08lx %08x\n",
1301 xsum, ntohs(ip->udp_xsum));
1307 #if defined(CONFIG_NETCONSOLE) && !defined(CONFIG_SPL_BUILD)
1308 nc_input_packet((uchar *)ip + IP_UDP_HDR_SIZE,
1312 ntohs(ip->udp_len) - UDP_HDR_SIZE);
1315 * IP header OK. Pass the packet to the current handler.
1317 (*udp_packet_handler)((uchar *)ip + IP_UDP_HDR_SIZE,
1321 ntohs(ip->udp_len) - UDP_HDR_SIZE);
1323 #ifdef CONFIG_CMD_WOL
1325 wol_receive(ip, len);
1331 /**********************************************************************/
1333 static int net_check_prereq(enum proto_t protocol)
1337 #if defined(CONFIG_CMD_PING)
1339 if (net_ping_ip.s_addr == 0) {
1340 puts("*** ERROR: ping address not given\n");
1345 #if defined(CONFIG_CMD_SNTP)
1347 if (net_ntp_server.s_addr == 0) {
1348 puts("*** ERROR: NTP server address not given\n");
1353 #if defined(CONFIG_CMD_DNS)
1355 if (net_dns_server.s_addr == 0) {
1356 puts("*** ERROR: DNS server address not given\n");
1361 #if defined(CONFIG_CMD_NFS)
1367 if (net_server_ip.s_addr == 0 && !is_serverip_in_cmd()) {
1368 puts("*** ERROR: `serverip' not set\n");
1371 #if defined(CONFIG_CMD_PING) || defined(CONFIG_CMD_SNTP) || \
1372 defined(CONFIG_CMD_DNS)
1380 if (net_ip.s_addr == 0) {
1381 puts("*** ERROR: `ipaddr' not set\n");
1386 #ifdef CONFIG_CMD_RARP
1393 if (memcmp(net_ethaddr, "\0\0\0\0\0\0", 6) == 0) {
1394 int num = eth_get_dev_index();
1398 puts("*** ERROR: No ethernet found.\n");
1401 puts("*** ERROR: `ethaddr' not set\n");
1404 printf("*** ERROR: `eth%daddr' not set\n",
1418 /**********************************************************************/
1421 net_eth_hdr_size(void)
1425 myvlanid = ntohs(net_our_vlan);
1426 if (myvlanid == (ushort)-1)
1427 myvlanid = VLAN_NONE;
1429 return ((myvlanid & VLAN_IDMASK) == VLAN_NONE) ? ETHER_HDR_SIZE :
1430 VLAN_ETHER_HDR_SIZE;
1433 int net_set_ether(uchar *xet, const uchar *dest_ethaddr, uint prot)
1435 struct ethernet_hdr *et = (struct ethernet_hdr *)xet;
1438 myvlanid = ntohs(net_our_vlan);
1439 if (myvlanid == (ushort)-1)
1440 myvlanid = VLAN_NONE;
1442 memcpy(et->et_dest, dest_ethaddr, 6);
1443 memcpy(et->et_src, net_ethaddr, 6);
1444 if ((myvlanid & VLAN_IDMASK) == VLAN_NONE) {
1445 et->et_protlen = htons(prot);
1446 return ETHER_HDR_SIZE;
1448 struct vlan_ethernet_hdr *vet =
1449 (struct vlan_ethernet_hdr *)xet;
1451 vet->vet_vlan_type = htons(PROT_VLAN);
1452 vet->vet_tag = htons((0 << 5) | (myvlanid & VLAN_IDMASK));
1453 vet->vet_type = htons(prot);
1454 return VLAN_ETHER_HDR_SIZE;
1458 int net_update_ether(struct ethernet_hdr *et, uchar *addr, uint prot)
1462 memcpy(et->et_dest, addr, 6);
1463 memcpy(et->et_src, net_ethaddr, 6);
1464 protlen = ntohs(et->et_protlen);
1465 if (protlen == PROT_VLAN) {
1466 struct vlan_ethernet_hdr *vet =
1467 (struct vlan_ethernet_hdr *)et;
1468 vet->vet_type = htons(prot);
1469 return VLAN_ETHER_HDR_SIZE;
1470 } else if (protlen > 1514) {
1471 et->et_protlen = htons(prot);
1472 return ETHER_HDR_SIZE;
1475 struct e802_hdr *et802 = (struct e802_hdr *)et;
1476 et802->et_prot = htons(prot);
1477 return E802_HDR_SIZE;
1481 void net_set_ip_header(uchar *pkt, struct in_addr dest, struct in_addr source,
1482 u16 pkt_len, u8 proto)
1484 struct ip_udp_hdr *ip = (struct ip_udp_hdr *)pkt;
1487 * Construct an IP header.
1489 /* IP_HDR_SIZE / 4 (not including UDP) */
1492 ip->ip_len = htons(pkt_len);
1494 ip->ip_id = htons(net_ip_id++);
1495 ip->ip_off = htons(IP_FLAGS_DFRAG); /* Don't fragment */
1498 /* already in network byte order */
1499 net_copy_ip((void *)&ip->ip_src, &source);
1500 /* already in network byte order */
1501 net_copy_ip((void *)&ip->ip_dst, &dest);
1503 ip->ip_sum = compute_ip_checksum(ip, IP_HDR_SIZE);
1506 void net_set_udp_header(uchar *pkt, struct in_addr dest, int dport, int sport,
1509 struct ip_udp_hdr *ip = (struct ip_udp_hdr *)pkt;
1512 * If the data is an odd number of bytes, zero the
1513 * byte after the last byte so that the checksum
1517 pkt[IP_UDP_HDR_SIZE + len] = 0;
1519 net_set_ip_header(pkt, dest, net_ip, IP_UDP_HDR_SIZE + len,
1522 ip->udp_src = htons(sport);
1523 ip->udp_dst = htons(dport);
1524 ip->udp_len = htons(UDP_HDR_SIZE + len);
1528 void copy_filename(char *dst, const char *src, int size)
1530 if (src && *src && (*src == '"')) {
1535 while ((--size > 0) && src && *src && (*src != '"'))
1540 int is_serverip_in_cmd(void)
1542 return !!strchr(net_boot_file_name, ':');
1545 int net_parse_bootfile(struct in_addr *ipaddr, char *filename, int max_len)
1549 if (net_boot_file_name[0] == '\0')
1552 colon = strchr(net_boot_file_name, ':');
1555 *ipaddr = string_to_ip(net_boot_file_name);
1556 strncpy(filename, colon + 1, max_len);
1558 strncpy(filename, net_boot_file_name, max_len);
1560 filename[max_len - 1] = '\0';
1565 #if defined(CONFIG_CMD_NFS) || \
1566 defined(CONFIG_CMD_SNTP) || \
1567 defined(CONFIG_CMD_DNS)
1569 * make port a little random (1024-17407)
1570 * This keeps the math somewhat trivial to compute, and seems to work with
1571 * all supported protocols/clients/servers
1573 unsigned int random_port(void)
1575 return 1024 + (get_timer(0) % 0x4000);
1579 void ip_to_string(struct in_addr x, char *s)
1581 x.s_addr = ntohl(x.s_addr);
1582 sprintf(s, "%d.%d.%d.%d",
1583 (int) ((x.s_addr >> 24) & 0xff),
1584 (int) ((x.s_addr >> 16) & 0xff),
1585 (int) ((x.s_addr >> 8) & 0xff),
1586 (int) ((x.s_addr >> 0) & 0xff)
1590 void vlan_to_string(ushort x, char *s)
1594 if (x == (ushort)-1)
1600 sprintf(s, "%d", x & VLAN_IDMASK);
1603 ushort string_to_vlan(const char *s)
1608 return htons(VLAN_NONE);
1610 if (*s < '0' || *s > '9')
1613 id = (ushort)simple_strtoul(s, NULL, 10);
1618 ushort env_get_vlan(char *var)
1620 return string_to_vlan(env_get(var));