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>
98 #include <net/fastboot.h>
100 #if defined(CONFIG_CMD_PCAP)
101 #include <net/pcap.h>
103 #if defined(CONFIG_LED_STATUS)
105 #include <status_led.h>
107 #include <watchdog.h>
108 #include <linux/compiler.h>
112 #if defined(CONFIG_CMD_DNS)
115 #include "link_local.h"
119 #if defined(CONFIG_CMD_SNTP)
122 #if defined(CONFIG_CMD_WOL)
126 /** BOOTP EXTENTIONS **/
128 /* Our subnet mask (0=unknown) */
129 struct in_addr net_netmask;
130 /* Our gateways IP address */
131 struct in_addr net_gateway;
132 /* Our DNS IP address */
133 struct in_addr net_dns_server;
134 #if defined(CONFIG_BOOTP_DNS2)
135 /* Our 2nd DNS IP address */
136 struct in_addr net_dns_server2;
139 /** END OF BOOTP EXTENTIONS **/
141 /* Our ethernet address */
143 /* Boot server enet address */
144 u8 net_server_ethaddr[6];
145 /* Our IP addr (0 = unknown) */
146 struct in_addr net_ip;
147 /* Server IP addr (0 = unknown) */
148 struct in_addr net_server_ip;
149 /* Current receive packet */
150 uchar *net_rx_packet;
151 /* Current rx packet length */
152 int net_rx_packet_len;
154 static unsigned net_ip_id;
155 /* Ethernet bcast address */
156 const u8 net_bcast_ethaddr[6] = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
157 const u8 net_null_ethaddr[6];
158 #if defined(CONFIG_API) || defined(CONFIG_EFI_LOADER)
159 void (*push_packet)(void *, int len) = 0;
161 /* Network loop state */
162 enum net_loop_state net_state;
163 /* Tried all network devices */
164 int net_restart_wrap;
165 /* Network loop restarted */
166 static int net_restarted;
167 /* At least one device configured */
168 static int net_dev_exists;
170 /* XXX in both little & big endian machines 0xFFFF == ntohs(-1) */
171 /* default is without VLAN */
172 ushort net_our_vlan = 0xFFFF;
174 ushort net_native_vlan = 0xFFFF;
177 char net_boot_file_name[1024];
178 /* Indicates whether the file name was specified on the command line */
179 bool net_boot_file_name_explicit;
180 /* The actual transferred size of the bootfile (in bytes) */
181 u32 net_boot_file_size;
182 /* Boot file size in blocks as reported by the DHCP server */
183 u32 net_boot_file_expected_size_in_blocks;
185 #if defined(CONFIG_CMD_SNTP)
186 /* NTP server IP address */
187 struct in_addr net_ntp_server;
188 /* offset time from UTC */
189 int net_ntp_time_offset;
192 static uchar net_pkt_buf[(PKTBUFSRX+1) * PKTSIZE_ALIGN + PKTALIGN];
193 /* Receive packets */
194 uchar *net_rx_packets[PKTBUFSRX];
195 /* Current UDP RX packet handler */
196 static rxhand_f *udp_packet_handler;
197 /* Current ARP RX packet handler */
198 static rxhand_f *arp_packet_handler;
199 #ifdef CONFIG_CMD_TFTPPUT
200 /* Current ICMP rx handler */
201 static rxhand_icmp_f *packet_icmp_handler;
203 /* Current timeout handler */
204 static thand_f *time_handler;
205 /* Time base value */
206 static ulong time_start;
207 /* Current timeout value */
208 static ulong time_delta;
209 /* THE transmit packet */
210 uchar *net_tx_packet;
212 static int net_check_prereq(enum proto_t protocol);
214 static int net_try_count;
216 int __maybe_unused net_busy_flag;
218 /**********************************************************************/
220 static int on_ipaddr(const char *name, const char *value, enum env_op op,
223 if (flags & H_PROGRAMMATIC)
226 net_ip = string_to_ip(value);
230 U_BOOT_ENV_CALLBACK(ipaddr, on_ipaddr);
232 static int on_gatewayip(const char *name, const char *value, enum env_op op,
235 if (flags & H_PROGRAMMATIC)
238 net_gateway = string_to_ip(value);
242 U_BOOT_ENV_CALLBACK(gatewayip, on_gatewayip);
244 static int on_netmask(const char *name, const char *value, enum env_op op,
247 if (flags & H_PROGRAMMATIC)
250 net_netmask = string_to_ip(value);
254 U_BOOT_ENV_CALLBACK(netmask, on_netmask);
256 static int on_serverip(const char *name, const char *value, enum env_op op,
259 if (flags & H_PROGRAMMATIC)
262 net_server_ip = string_to_ip(value);
266 U_BOOT_ENV_CALLBACK(serverip, on_serverip);
268 static int on_nvlan(const char *name, const char *value, enum env_op op,
271 if (flags & H_PROGRAMMATIC)
274 net_native_vlan = string_to_vlan(value);
278 U_BOOT_ENV_CALLBACK(nvlan, on_nvlan);
280 static int on_vlan(const char *name, const char *value, enum env_op op,
283 if (flags & H_PROGRAMMATIC)
286 net_our_vlan = string_to_vlan(value);
290 U_BOOT_ENV_CALLBACK(vlan, on_vlan);
292 #if defined(CONFIG_CMD_DNS)
293 static int on_dnsip(const char *name, const char *value, enum env_op op,
296 if (flags & H_PROGRAMMATIC)
299 net_dns_server = string_to_ip(value);
303 U_BOOT_ENV_CALLBACK(dnsip, on_dnsip);
307 * Check if autoload is enabled. If so, use either NFS or TFTP to download
310 void net_auto_load(void)
312 #if defined(CONFIG_CMD_NFS) && !defined(CONFIG_SPL_BUILD)
313 const char *s = env_get("autoload");
315 if (s != NULL && strcmp(s, "NFS") == 0) {
316 if (net_check_prereq(NFS)) {
317 /* We aren't expecting to get a serverip, so just accept the assigned IP */
318 #ifdef CONFIG_BOOTP_SERVERIP
319 net_set_state(NETLOOP_SUCCESS);
321 printf("Cannot autoload with NFS\n");
322 net_set_state(NETLOOP_FAIL);
327 * Use NFS to load the bootfile.
333 if (env_get_yesno("autoload") == 0) {
335 * Just use BOOTP/RARP to configure system;
336 * Do not use TFTP to load the bootfile.
338 net_set_state(NETLOOP_SUCCESS);
341 if (net_check_prereq(TFTPGET)) {
342 /* We aren't expecting to get a serverip, so just accept the assigned IP */
343 #ifdef CONFIG_BOOTP_SERVERIP
344 net_set_state(NETLOOP_SUCCESS);
346 printf("Cannot autoload with TFTPGET\n");
347 net_set_state(NETLOOP_FAIL);
354 static void net_init_loop(void)
357 memcpy(net_ethaddr, eth_get_ethaddr(), 6);
362 static void net_clear_handlers(void)
364 net_set_udp_handler(NULL);
365 net_set_arp_handler(NULL);
366 net_set_timeout_handler(0, NULL);
369 static void net_cleanup_loop(void)
371 net_clear_handlers();
376 static int first_call = 1;
380 * Setup packet buffers, aligned correctly.
384 net_tx_packet = &net_pkt_buf[0] + (PKTALIGN - 1);
385 net_tx_packet -= (ulong)net_tx_packet % PKTALIGN;
386 for (i = 0; i < PKTBUFSRX; i++) {
387 net_rx_packets[i] = net_tx_packet +
388 (i + 1) * PKTSIZE_ALIGN;
391 net_clear_handlers();
393 /* Only need to setup buffer pointers once. */
400 /**********************************************************************/
402 * Main network processing loop.
405 int net_loop(enum proto_t protocol)
408 enum net_loop_state prev_net_state = net_state;
413 debug_cond(DEBUG_INT_STATE, "--- net_loop Entry\n");
415 bootstage_mark_name(BOOTSTAGE_ID_ETH_START, "eth_start");
417 if (eth_is_on_demand_init() || protocol != NETCONS) {
426 eth_init_state_only();
429 #ifdef CONFIG_USB_KEYBOARD
432 net_set_state(NETLOOP_CONTINUE);
435 * Start the ball rolling with the given start function. From
436 * here on, this code is a state machine driven by received
437 * packets and timer events.
439 debug_cond(DEBUG_INT_STATE, "--- net_loop Init\n");
442 switch (net_check_prereq(protocol)) {
444 /* network not configured */
446 net_set_state(prev_net_state);
450 /* network device not configured */
455 net_boot_file_size = 0;
458 #ifdef CONFIG_CMD_TFTPPUT
461 /* always use ARP to get server ethernet address */
462 tftp_start(protocol);
464 #ifdef CONFIG_CMD_TFTPSRV
469 #ifdef CONFIG_UDP_FUNCTION_FASTBOOT
471 fastboot_start_server();
474 #if defined(CONFIG_CMD_DHCP)
478 dhcp_request(); /* Basically same as BOOTP */
488 #if defined(CONFIG_CMD_RARP)
495 #if defined(CONFIG_CMD_PING)
500 #if defined(CONFIG_CMD_NFS) && !defined(CONFIG_SPL_BUILD)
505 #if defined(CONFIG_CMD_CDP)
510 #if defined(CONFIG_NETCONSOLE) && !defined(CONFIG_SPL_BUILD)
515 #if defined(CONFIG_CMD_SNTP)
520 #if defined(CONFIG_CMD_DNS)
525 #if defined(CONFIG_CMD_LINK_LOCAL)
530 #if defined(CONFIG_CMD_WOL)
542 #if defined(CONFIG_MII) || defined(CONFIG_CMD_MII)
543 #if defined(CONFIG_SYS_FAULT_ECHO_LINK_DOWN) && \
544 defined(CONFIG_LED_STATUS) && \
545 defined(CONFIG_LED_STATUS_RED)
547 * Echo the inverted link state to the fault LED.
549 if (miiphy_link(eth_get_dev()->name, CONFIG_SYS_FAULT_MII_ADDR))
550 status_led_set(CONFIG_LED_STATUS_RED, CONFIG_LED_STATUS_OFF);
552 status_led_set(CONFIG_LED_STATUS_RED, CONFIG_LED_STATUS_ON);
553 #endif /* CONFIG_SYS_FAULT_ECHO_LINK_DOWN, ... */
554 #endif /* CONFIG_MII, ... */
555 #ifdef CONFIG_USB_KEYBOARD
560 * Main packet reception loop. Loop receiving packets until
561 * someone sets `net_state' to a state that terminates.
565 if (arp_timeout_check() > 0)
566 time_start = get_timer(0);
569 * Check the ethernet for a new packet. The ethernet
570 * receive routine will process it.
571 * Most drivers return the most recent packet size, but not
572 * errors that may have happened.
577 * Abort if ctrl-c was pressed.
580 /* cancel any ARP that may not have completed */
581 net_arp_wait_packet_ip.s_addr = 0;
585 /* Invalidate the last protocol */
586 eth_set_last_protocol(BOOTP);
589 /* include a debug print as well incase the debug
590 messages are directed to stderr */
591 debug_cond(DEBUG_INT_STATE, "--- net_loop Abort!\n");
597 * Check for a timeout, and run the timeout handler
601 ((get_timer(0) - time_start) > time_delta)) {
604 #if defined(CONFIG_MII) || defined(CONFIG_CMD_MII)
605 #if defined(CONFIG_SYS_FAULT_ECHO_LINK_DOWN) && \
606 defined(CONFIG_LED_STATUS) && \
607 defined(CONFIG_LED_STATUS_RED)
609 * Echo the inverted link state to the fault LED.
611 if (miiphy_link(eth_get_dev()->name,
612 CONFIG_SYS_FAULT_MII_ADDR))
613 status_led_set(CONFIG_LED_STATUS_RED,
614 CONFIG_LED_STATUS_OFF);
616 status_led_set(CONFIG_LED_STATUS_RED,
617 CONFIG_LED_STATUS_ON);
618 #endif /* CONFIG_SYS_FAULT_ECHO_LINK_DOWN, ... */
619 #endif /* CONFIG_MII, ... */
620 debug_cond(DEBUG_INT_STATE, "--- net_loop timeout\n");
622 time_handler = (thand_f *)0;
626 if (net_state == NETLOOP_FAIL)
627 ret = net_start_again();
630 case NETLOOP_RESTART:
634 case NETLOOP_SUCCESS:
636 if (net_boot_file_size > 0) {
637 printf("Bytes transferred = %d (%x hex)\n",
638 net_boot_file_size, net_boot_file_size);
639 env_set_hex("filesize", net_boot_file_size);
640 env_set_hex("fileaddr", image_load_addr);
642 if (protocol != NETCONS)
645 eth_halt_state_only();
647 eth_set_last_protocol(protocol);
649 ret = net_boot_file_size;
650 debug_cond(DEBUG_INT_STATE, "--- net_loop Success!\n");
655 /* Invalidate the last protocol */
656 eth_set_last_protocol(BOOTP);
657 debug_cond(DEBUG_INT_STATE, "--- net_loop Fail!\n");
661 case NETLOOP_CONTINUE:
667 #ifdef CONFIG_USB_KEYBOARD
670 #ifdef CONFIG_CMD_TFTPPUT
671 /* Clear out the handlers */
672 net_set_udp_handler(NULL);
673 net_set_icmp_handler(NULL);
675 net_set_state(prev_net_state);
677 #if defined(CONFIG_CMD_PCAP)
684 /**********************************************************************/
686 static void start_again_timeout_handler(void)
688 net_set_state(NETLOOP_RESTART);
691 int net_start_again(void)
694 int retry_forever = 0;
695 unsigned long retrycnt = 0;
698 nretry = env_get("netretry");
700 if (!strcmp(nretry, "yes"))
702 else if (!strcmp(nretry, "no"))
704 else if (!strcmp(nretry, "once"))
707 retrycnt = simple_strtoul(nretry, NULL, 0);
713 if ((!retry_forever) && (net_try_count > retrycnt)) {
715 net_set_state(NETLOOP_FAIL);
717 * We don't provide a way for the protocol to return an error,
718 * but this is almost always the reason.
726 #if !defined(CONFIG_NET_DO_NOT_TRY_ANOTHER)
727 eth_try_another(!net_restarted);
730 if (net_restart_wrap) {
731 net_restart_wrap = 0;
732 if (net_dev_exists) {
733 net_set_timeout_handler(10000UL,
734 start_again_timeout_handler);
735 net_set_udp_handler(NULL);
737 net_set_state(NETLOOP_FAIL);
740 net_set_state(NETLOOP_RESTART);
745 /**********************************************************************/
750 static void dummy_handler(uchar *pkt, unsigned dport,
751 struct in_addr sip, unsigned sport,
756 rxhand_f *net_get_udp_handler(void)
758 return udp_packet_handler;
761 void net_set_udp_handler(rxhand_f *f)
763 debug_cond(DEBUG_INT_STATE, "--- net_loop UDP handler set (%p)\n", f);
765 udp_packet_handler = dummy_handler;
767 udp_packet_handler = f;
770 rxhand_f *net_get_arp_handler(void)
772 return arp_packet_handler;
775 void net_set_arp_handler(rxhand_f *f)
777 debug_cond(DEBUG_INT_STATE, "--- net_loop ARP handler set (%p)\n", f);
779 arp_packet_handler = dummy_handler;
781 arp_packet_handler = f;
784 #ifdef CONFIG_CMD_TFTPPUT
785 void net_set_icmp_handler(rxhand_icmp_f *f)
787 packet_icmp_handler = f;
791 void net_set_timeout_handler(ulong iv, thand_f *f)
794 debug_cond(DEBUG_INT_STATE,
795 "--- net_loop timeout handler cancelled\n");
796 time_handler = (thand_f *)0;
798 debug_cond(DEBUG_INT_STATE,
799 "--- net_loop timeout handler set (%p)\n", f);
801 time_start = get_timer(0);
802 time_delta = iv * CONFIG_SYS_HZ / 1000;
806 uchar *net_get_async_tx_pkt_buf(void)
808 if (arp_is_waiting())
809 return arp_tx_packet; /* If we are waiting, we already sent */
811 return net_tx_packet;
814 int net_send_udp_packet(uchar *ether, struct in_addr dest, int dport, int sport,
817 return net_send_ip_packet(ether, dest, dport, sport, payload_len,
818 IPPROTO_UDP, 0, 0, 0);
821 int net_send_ip_packet(uchar *ether, struct in_addr dest, int dport, int sport,
822 int payload_len, int proto, u8 action, u32 tcp_seq_num,
829 /* make sure the net_tx_packet is initialized (net_init() was called) */
830 assert(net_tx_packet != NULL);
831 if (net_tx_packet == NULL)
834 /* convert to new style broadcast */
835 if (dest.s_addr == 0)
836 dest.s_addr = 0xFFFFFFFF;
838 /* if broadcast, make the ether address a broadcast and don't do ARP */
839 if (dest.s_addr == 0xFFFFFFFF)
840 ether = (uchar *)net_bcast_ethaddr;
842 pkt = (uchar *)net_tx_packet;
844 eth_hdr_size = net_set_ether(pkt, ether, PROT_IP);
848 net_set_udp_header(pkt + eth_hdr_size, dest, dport, sport,
850 pkt_hdr_size = eth_hdr_size + IP_UDP_HDR_SIZE;
856 /* if MAC address was not discovered yet, do an ARP request */
857 if (memcmp(ether, net_null_ethaddr, 6) == 0) {
858 debug_cond(DEBUG_DEV_PKT, "sending ARP for %pI4\n", &dest);
860 /* save the ip and eth addr for the packet to send after arp */
861 net_arp_wait_packet_ip = dest;
862 arp_wait_packet_ethaddr = ether;
864 /* size of the waiting packet */
865 arp_wait_tx_packet_size = pkt_hdr_size + payload_len;
867 /* and do the ARP request */
869 arp_wait_timer_start = get_timer(0);
871 return 1; /* waiting */
873 debug_cond(DEBUG_DEV_PKT, "sending UDP to %pI4/%pM\n",
875 net_send_packet(net_tx_packet, pkt_hdr_size + payload_len);
876 return 0; /* transmitted */
880 #ifdef CONFIG_IP_DEFRAG
882 * This function collects fragments in a single packet, according
883 * to the algorithm in RFC815. It returns NULL or the pointer to
884 * a complete packet, in static storage
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 #if defined(CONFIG_CMD_PCAP)
1091 pcap_post(in_packet, len, false);
1093 net_rx_packet = in_packet;
1094 net_rx_packet_len = len;
1095 et = (struct ethernet_hdr *)in_packet;
1097 /* too small packet? */
1098 if (len < ETHER_HDR_SIZE)
1101 #if defined(CONFIG_API) || defined(CONFIG_EFI_LOADER)
1103 (*push_packet)(in_packet, len);
1108 #if defined(CONFIG_CMD_CDP)
1109 /* keep track if packet is CDP */
1110 iscdp = is_cdp_packet(et->et_dest);
1113 myvlanid = ntohs(net_our_vlan);
1114 if (myvlanid == (ushort)-1)
1115 myvlanid = VLAN_NONE;
1116 mynvlanid = ntohs(net_native_vlan);
1117 if (mynvlanid == (ushort)-1)
1118 mynvlanid = VLAN_NONE;
1120 eth_proto = ntohs(et->et_protlen);
1122 if (eth_proto < 1514) {
1123 struct e802_hdr *et802 = (struct e802_hdr *)et;
1125 * Got a 802.2 packet. Check the other protocol field.
1126 * XXX VLAN over 802.2+SNAP not implemented!
1128 eth_proto = ntohs(et802->et_prot);
1130 ip = (struct ip_udp_hdr *)(in_packet + E802_HDR_SIZE);
1131 len -= E802_HDR_SIZE;
1133 } else if (eth_proto != PROT_VLAN) { /* normal packet */
1134 ip = (struct ip_udp_hdr *)(in_packet + ETHER_HDR_SIZE);
1135 len -= ETHER_HDR_SIZE;
1137 } else { /* VLAN packet */
1138 struct vlan_ethernet_hdr *vet =
1139 (struct vlan_ethernet_hdr *)et;
1141 debug_cond(DEBUG_NET_PKT, "VLAN packet received\n");
1143 /* too small packet? */
1144 if (len < VLAN_ETHER_HDR_SIZE)
1147 /* if no VLAN active */
1148 if ((ntohs(net_our_vlan) & VLAN_IDMASK) == VLAN_NONE
1149 #if defined(CONFIG_CMD_CDP)
1155 cti = ntohs(vet->vet_tag);
1156 vlanid = cti & VLAN_IDMASK;
1157 eth_proto = ntohs(vet->vet_type);
1159 ip = (struct ip_udp_hdr *)(in_packet + VLAN_ETHER_HDR_SIZE);
1160 len -= VLAN_ETHER_HDR_SIZE;
1163 debug_cond(DEBUG_NET_PKT, "Receive from protocol 0x%x\n", eth_proto);
1165 #if defined(CONFIG_CMD_CDP)
1167 cdp_receive((uchar *)ip, len);
1172 if ((myvlanid & VLAN_IDMASK) != VLAN_NONE) {
1173 if (vlanid == VLAN_NONE)
1174 vlanid = (mynvlanid & VLAN_IDMASK);
1176 if (vlanid != (myvlanid & VLAN_IDMASK))
1180 switch (eth_proto) {
1182 arp_receive(et, ip, len);
1185 #ifdef CONFIG_CMD_RARP
1187 rarp_receive(ip, len);
1191 debug_cond(DEBUG_NET_PKT, "Got IP\n");
1192 /* Before we start poking the header, make sure it is there */
1193 if (len < IP_UDP_HDR_SIZE) {
1194 debug("len bad %d < %lu\n", len,
1195 (ulong)IP_UDP_HDR_SIZE);
1198 /* Check the packet length */
1199 if (len < ntohs(ip->ip_len)) {
1200 debug("len bad %d < %d\n", len, ntohs(ip->ip_len));
1203 len = ntohs(ip->ip_len);
1204 debug_cond(DEBUG_NET_PKT, "len=%d, v=%02x\n",
1205 len, ip->ip_hl_v & 0xff);
1207 /* Can't deal with anything except IPv4 */
1208 if ((ip->ip_hl_v & 0xf0) != 0x40)
1210 /* Can't deal with IP options (headers != 20 bytes) */
1211 if ((ip->ip_hl_v & 0x0f) > 0x05)
1213 /* Check the Checksum of the header */
1214 if (!ip_checksum_ok((uchar *)ip, IP_HDR_SIZE)) {
1215 debug("checksum bad\n");
1218 /* If it is not for us, ignore it */
1219 dst_ip = net_read_ip(&ip->ip_dst);
1220 if (net_ip.s_addr && dst_ip.s_addr != net_ip.s_addr &&
1221 dst_ip.s_addr != 0xFFFFFFFF) {
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 if (ntohs(ip->udp_len) < UDP_HDR_SIZE || ntohs(ip->udp_len) > ntohs(ip->ip_len))
1265 debug_cond(DEBUG_DEV_PKT,
1266 "received UDP (to=%pI4, from=%pI4, len=%d)\n",
1267 &dst_ip, &src_ip, len);
1269 #ifdef CONFIG_UDP_CHECKSUM
1270 if (ip->udp_xsum != 0) {
1276 xsum += (ntohs(ip->udp_len));
1277 xsum += (ntohl(ip->ip_src.s_addr) >> 16) & 0x0000ffff;
1278 xsum += (ntohl(ip->ip_src.s_addr) >> 0) & 0x0000ffff;
1279 xsum += (ntohl(ip->ip_dst.s_addr) >> 16) & 0x0000ffff;
1280 xsum += (ntohl(ip->ip_dst.s_addr) >> 0) & 0x0000ffff;
1282 sumlen = ntohs(ip->udp_len);
1283 sumptr = (u8 *)&ip->udp_src;
1285 while (sumlen > 1) {
1286 /* inlined ntohs() to avoid alignment errors */
1287 xsum += (sumptr[0] << 8) + sumptr[1];
1292 xsum += (sumptr[0] << 8) + sumptr[0];
1293 while ((xsum >> 16) != 0) {
1294 xsum = (xsum & 0x0000ffff) +
1295 ((xsum >> 16) & 0x0000ffff);
1297 if ((xsum != 0x00000000) && (xsum != 0x0000ffff)) {
1298 printf(" UDP wrong checksum %08lx %08x\n",
1299 xsum, ntohs(ip->udp_xsum));
1305 #if defined(CONFIG_NETCONSOLE) && !defined(CONFIG_SPL_BUILD)
1306 nc_input_packet((uchar *)ip + IP_UDP_HDR_SIZE,
1310 ntohs(ip->udp_len) - UDP_HDR_SIZE);
1313 * IP header OK. Pass the packet to the current handler.
1315 (*udp_packet_handler)((uchar *)ip + IP_UDP_HDR_SIZE,
1319 ntohs(ip->udp_len) - UDP_HDR_SIZE);
1321 #ifdef CONFIG_CMD_WOL
1323 wol_receive(ip, len);
1329 /**********************************************************************/
1331 static int net_check_prereq(enum proto_t protocol)
1335 #if defined(CONFIG_CMD_PING)
1337 if (net_ping_ip.s_addr == 0) {
1338 puts("*** ERROR: ping address not given\n");
1343 #if defined(CONFIG_CMD_SNTP)
1345 if (net_ntp_server.s_addr == 0) {
1346 puts("*** ERROR: NTP server address not given\n");
1351 #if defined(CONFIG_CMD_DNS)
1353 if (net_dns_server.s_addr == 0) {
1354 puts("*** ERROR: DNS server address not given\n");
1359 #if defined(CONFIG_CMD_NFS)
1365 if (net_server_ip.s_addr == 0 && !is_serverip_in_cmd()) {
1366 puts("*** ERROR: `serverip' not set\n");
1369 #if defined(CONFIG_CMD_PING) || defined(CONFIG_CMD_SNTP) || \
1370 defined(CONFIG_CMD_DNS)
1378 if (net_ip.s_addr == 0) {
1379 puts("*** ERROR: `ipaddr' not set\n");
1384 #ifdef CONFIG_CMD_RARP
1391 if (memcmp(net_ethaddr, "\0\0\0\0\0\0", 6) == 0) {
1392 int num = eth_get_dev_index();
1396 puts("*** ERROR: No ethernet found.\n");
1399 puts("*** ERROR: `ethaddr' not set\n");
1402 printf("*** ERROR: `eth%daddr' not set\n",
1416 /**********************************************************************/
1419 net_eth_hdr_size(void)
1423 myvlanid = ntohs(net_our_vlan);
1424 if (myvlanid == (ushort)-1)
1425 myvlanid = VLAN_NONE;
1427 return ((myvlanid & VLAN_IDMASK) == VLAN_NONE) ? ETHER_HDR_SIZE :
1428 VLAN_ETHER_HDR_SIZE;
1431 int net_set_ether(uchar *xet, const uchar *dest_ethaddr, uint prot)
1433 struct ethernet_hdr *et = (struct ethernet_hdr *)xet;
1436 myvlanid = ntohs(net_our_vlan);
1437 if (myvlanid == (ushort)-1)
1438 myvlanid = VLAN_NONE;
1440 memcpy(et->et_dest, dest_ethaddr, 6);
1441 memcpy(et->et_src, net_ethaddr, 6);
1442 if ((myvlanid & VLAN_IDMASK) == VLAN_NONE) {
1443 et->et_protlen = htons(prot);
1444 return ETHER_HDR_SIZE;
1446 struct vlan_ethernet_hdr *vet =
1447 (struct vlan_ethernet_hdr *)xet;
1449 vet->vet_vlan_type = htons(PROT_VLAN);
1450 vet->vet_tag = htons((0 << 5) | (myvlanid & VLAN_IDMASK));
1451 vet->vet_type = htons(prot);
1452 return VLAN_ETHER_HDR_SIZE;
1456 int net_update_ether(struct ethernet_hdr *et, uchar *addr, uint prot)
1460 memcpy(et->et_dest, addr, 6);
1461 memcpy(et->et_src, net_ethaddr, 6);
1462 protlen = ntohs(et->et_protlen);
1463 if (protlen == PROT_VLAN) {
1464 struct vlan_ethernet_hdr *vet =
1465 (struct vlan_ethernet_hdr *)et;
1466 vet->vet_type = htons(prot);
1467 return VLAN_ETHER_HDR_SIZE;
1468 } else if (protlen > 1514) {
1469 et->et_protlen = htons(prot);
1470 return ETHER_HDR_SIZE;
1473 struct e802_hdr *et802 = (struct e802_hdr *)et;
1474 et802->et_prot = htons(prot);
1475 return E802_HDR_SIZE;
1479 void net_set_ip_header(uchar *pkt, struct in_addr dest, struct in_addr source,
1480 u16 pkt_len, u8 proto)
1482 struct ip_udp_hdr *ip = (struct ip_udp_hdr *)pkt;
1485 * Construct an IP header.
1487 /* IP_HDR_SIZE / 4 (not including UDP) */
1490 ip->ip_len = htons(pkt_len);
1492 ip->ip_id = htons(net_ip_id++);
1493 ip->ip_off = htons(IP_FLAGS_DFRAG); /* Don't fragment */
1496 /* already in network byte order */
1497 net_copy_ip((void *)&ip->ip_src, &source);
1498 /* already in network byte order */
1499 net_copy_ip((void *)&ip->ip_dst, &dest);
1501 ip->ip_sum = compute_ip_checksum(ip, IP_HDR_SIZE);
1504 void net_set_udp_header(uchar *pkt, struct in_addr dest, int dport, int sport,
1507 struct ip_udp_hdr *ip = (struct ip_udp_hdr *)pkt;
1510 * If the data is an odd number of bytes, zero the
1511 * byte after the last byte so that the checksum
1515 pkt[IP_UDP_HDR_SIZE + len] = 0;
1517 net_set_ip_header(pkt, dest, net_ip, IP_UDP_HDR_SIZE + len,
1520 ip->udp_src = htons(sport);
1521 ip->udp_dst = htons(dport);
1522 ip->udp_len = htons(UDP_HDR_SIZE + len);
1526 void copy_filename(char *dst, const char *src, int size)
1528 if (src && *src && (*src == '"')) {
1533 while ((--size > 0) && src && *src && (*src != '"'))
1538 int is_serverip_in_cmd(void)
1540 return !!strchr(net_boot_file_name, ':');
1543 int net_parse_bootfile(struct in_addr *ipaddr, char *filename, int max_len)
1547 if (net_boot_file_name[0] == '\0')
1550 colon = strchr(net_boot_file_name, ':');
1553 *ipaddr = string_to_ip(net_boot_file_name);
1554 strncpy(filename, colon + 1, max_len);
1556 strncpy(filename, net_boot_file_name, max_len);
1558 filename[max_len - 1] = '\0';
1563 #if defined(CONFIG_CMD_NFS) || \
1564 defined(CONFIG_CMD_SNTP) || \
1565 defined(CONFIG_CMD_DNS)
1567 * make port a little random (1024-17407)
1568 * This keeps the math somewhat trivial to compute, and seems to work with
1569 * all supported protocols/clients/servers
1571 unsigned int random_port(void)
1573 return 1024 + (get_timer(0) % 0x4000);
1577 void ip_to_string(struct in_addr x, char *s)
1579 x.s_addr = ntohl(x.s_addr);
1580 sprintf(s, "%d.%d.%d.%d",
1581 (int) ((x.s_addr >> 24) & 0xff),
1582 (int) ((x.s_addr >> 16) & 0xff),
1583 (int) ((x.s_addr >> 8) & 0xff),
1584 (int) ((x.s_addr >> 0) & 0xff)
1588 void vlan_to_string(ushort x, char *s)
1592 if (x == (ushort)-1)
1598 sprintf(s, "%d", x & VLAN_IDMASK);
1601 ushort string_to_vlan(const char *s)
1606 return htons(VLAN_NONE);
1608 if (*s < '0' || *s > '9')
1611 id = (ushort)simple_strtoul(s, NULL, 10);
1616 ushort env_get_vlan(char *var)
1618 return string_to_vlan(env_get(var));