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
78 * Prerequisites: - own ethernet address
79 * We want: - magic packet or timeout
85 #include <bootstage.h>
89 #include <env_internal.h>
94 #include <net/fastboot.h>
96 #if defined(CONFIG_CMD_PCAP)
100 #if defined(CONFIG_LED_STATUS)
102 #include <status_led.h>
104 #include <watchdog.h>
105 #include <linux/compiler.h>
109 #if defined(CONFIG_CMD_DNS)
112 #include "link_local.h"
116 #if defined(CONFIG_CMD_WOL)
120 /** BOOTP EXTENTIONS **/
122 /* Our subnet mask (0=unknown) */
123 struct in_addr net_netmask;
124 /* Our gateways IP address */
125 struct in_addr net_gateway;
126 /* Our DNS IP address */
127 struct in_addr net_dns_server;
128 #if defined(CONFIG_BOOTP_DNS2)
129 /* Our 2nd DNS IP address */
130 struct in_addr net_dns_server2;
133 /** END OF BOOTP EXTENTIONS **/
135 /* Our ethernet address */
137 /* Boot server enet address */
138 u8 net_server_ethaddr[6];
139 /* Our IP addr (0 = unknown) */
140 struct in_addr net_ip;
141 /* Server IP addr (0 = unknown) */
142 struct in_addr net_server_ip;
143 /* Current receive packet */
144 uchar *net_rx_packet;
145 /* Current rx packet length */
146 int net_rx_packet_len;
148 static unsigned net_ip_id;
149 /* Ethernet bcast address */
150 const u8 net_bcast_ethaddr[6] = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
151 const u8 net_null_ethaddr[6];
152 #if defined(CONFIG_API) || defined(CONFIG_EFI_LOADER)
153 void (*push_packet)(void *, int len) = 0;
155 /* Network loop state */
156 enum net_loop_state net_state;
157 /* Tried all network devices */
158 int net_restart_wrap;
159 /* Network loop restarted */
160 static int net_restarted;
161 /* At least one device configured */
162 static int net_dev_exists;
164 /* XXX in both little & big endian machines 0xFFFF == ntohs(-1) */
165 /* default is without VLAN */
166 ushort net_our_vlan = 0xFFFF;
168 ushort net_native_vlan = 0xFFFF;
171 char net_boot_file_name[1024];
172 /* Indicates whether the file name was specified on the command line */
173 bool net_boot_file_name_explicit;
174 /* The actual transferred size of the bootfile (in bytes) */
175 u32 net_boot_file_size;
176 /* Boot file size in blocks as reported by the DHCP server */
177 u32 net_boot_file_expected_size_in_blocks;
179 static uchar net_pkt_buf[(PKTBUFSRX+1) * PKTSIZE_ALIGN + PKTALIGN];
180 /* Receive packets */
181 uchar *net_rx_packets[PKTBUFSRX];
182 /* Current UDP RX packet handler */
183 static rxhand_f *udp_packet_handler;
184 /* Current ARP RX packet handler */
185 static rxhand_f *arp_packet_handler;
186 #ifdef CONFIG_CMD_TFTPPUT
187 /* Current ICMP rx handler */
188 static rxhand_icmp_f *packet_icmp_handler;
190 /* Current timeout handler */
191 static thand_f *time_handler;
192 /* Time base value */
193 static ulong time_start;
194 /* Current timeout value */
195 static ulong time_delta;
196 /* THE transmit packet */
197 uchar *net_tx_packet;
199 static int net_check_prereq(enum proto_t protocol);
201 static int net_try_count;
203 int __maybe_unused net_busy_flag;
205 /**********************************************************************/
207 static int on_ipaddr(const char *name, const char *value, enum env_op op,
210 if (flags & H_PROGRAMMATIC)
213 net_ip = string_to_ip(value);
217 U_BOOT_ENV_CALLBACK(ipaddr, on_ipaddr);
219 static int on_gatewayip(const char *name, const char *value, enum env_op op,
222 if (flags & H_PROGRAMMATIC)
225 net_gateway = string_to_ip(value);
229 U_BOOT_ENV_CALLBACK(gatewayip, on_gatewayip);
231 static int on_netmask(const char *name, const char *value, enum env_op op,
234 if (flags & H_PROGRAMMATIC)
237 net_netmask = string_to_ip(value);
241 U_BOOT_ENV_CALLBACK(netmask, on_netmask);
243 static int on_serverip(const char *name, const char *value, enum env_op op,
246 if (flags & H_PROGRAMMATIC)
249 net_server_ip = string_to_ip(value);
253 U_BOOT_ENV_CALLBACK(serverip, on_serverip);
255 static int on_nvlan(const char *name, const char *value, enum env_op op,
258 if (flags & H_PROGRAMMATIC)
261 net_native_vlan = string_to_vlan(value);
265 U_BOOT_ENV_CALLBACK(nvlan, on_nvlan);
267 static int on_vlan(const char *name, const char *value, enum env_op op,
270 if (flags & H_PROGRAMMATIC)
273 net_our_vlan = string_to_vlan(value);
277 U_BOOT_ENV_CALLBACK(vlan, on_vlan);
279 #if defined(CONFIG_CMD_DNS)
280 static int on_dnsip(const char *name, const char *value, enum env_op op,
283 if (flags & H_PROGRAMMATIC)
286 net_dns_server = string_to_ip(value);
290 U_BOOT_ENV_CALLBACK(dnsip, on_dnsip);
294 * Check if autoload is enabled. If so, use either NFS or TFTP to download
297 void net_auto_load(void)
299 #if defined(CONFIG_CMD_NFS) && !defined(CONFIG_SPL_BUILD)
300 const char *s = env_get("autoload");
302 if (s != NULL && strcmp(s, "NFS") == 0) {
303 if (net_check_prereq(NFS)) {
304 /* We aren't expecting to get a serverip, so just accept the assigned IP */
305 if (IS_ENABLED(CONFIG_BOOTP_SERVERIP)) {
306 net_set_state(NETLOOP_SUCCESS);
308 printf("Cannot autoload with NFS\n");
309 net_set_state(NETLOOP_FAIL);
314 * Use NFS to load the bootfile.
320 if (env_get_yesno("autoload") == 0) {
322 * Just use BOOTP/RARP to configure system;
323 * Do not use TFTP to load the bootfile.
325 net_set_state(NETLOOP_SUCCESS);
328 if (net_check_prereq(TFTPGET)) {
329 /* We aren't expecting to get a serverip, so just accept the assigned IP */
330 if (IS_ENABLED(CONFIG_BOOTP_SERVERIP)) {
331 net_set_state(NETLOOP_SUCCESS);
333 printf("Cannot autoload with TFTPGET\n");
334 net_set_state(NETLOOP_FAIL);
341 static int net_init_loop(void)
344 memcpy(net_ethaddr, eth_get_ethaddr(), 6);
347 * Not ideal, but there's no way to get the actual error, and I
348 * don't feel like fixing all the users of eth_get_dev to deal
356 static void net_clear_handlers(void)
358 net_set_udp_handler(NULL);
359 net_set_arp_handler(NULL);
360 net_set_timeout_handler(0, NULL);
363 static void net_cleanup_loop(void)
365 net_clear_handlers();
370 static int first_call = 1;
374 * Setup packet buffers, aligned correctly.
378 net_tx_packet = &net_pkt_buf[0] + (PKTALIGN - 1);
379 net_tx_packet -= (ulong)net_tx_packet % PKTALIGN;
380 for (i = 0; i < PKTBUFSRX; i++) {
381 net_rx_packets[i] = net_tx_packet +
382 (i + 1) * PKTSIZE_ALIGN;
385 net_clear_handlers();
387 /* Only need to setup buffer pointers once. */
391 return net_init_loop();
394 /**********************************************************************/
396 * Main network processing loop.
399 int net_loop(enum proto_t protocol)
402 enum net_loop_state prev_net_state = net_state;
404 #if defined(CONFIG_CMD_PING)
405 if (protocol != PING)
406 net_ping_ip.s_addr = 0;
411 debug_cond(DEBUG_INT_STATE, "--- net_loop Entry\n");
413 bootstage_mark_name(BOOTSTAGE_ID_ETH_START, "eth_start");
415 if (eth_is_on_demand_init()) {
424 eth_init_state_only();
427 #ifdef CONFIG_USB_KEYBOARD
430 net_set_state(NETLOOP_CONTINUE);
433 * Start the ball rolling with the given start function. From
434 * here on, this code is a state machine driven by received
435 * packets and timer events.
437 debug_cond(DEBUG_INT_STATE, "--- net_loop Init\n");
440 switch (net_check_prereq(protocol)) {
442 /* network not configured */
444 net_set_state(prev_net_state);
448 /* network device not configured */
453 net_boot_file_size = 0;
455 #ifdef CONFIG_CMD_TFTPBOOT
457 #ifdef CONFIG_CMD_TFTPPUT
460 /* always use ARP to get server ethernet address */
461 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 */
481 #if defined(CONFIG_CMD_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_DNS)
520 #if defined(CONFIG_CMD_LINK_LOCAL)
525 #if defined(CONFIG_CMD_WOL)
534 if (IS_ENABLED(CONFIG_PROT_UDP) && protocol == UDP)
540 #if defined(CONFIG_MII) || defined(CONFIG_CMD_MII)
541 #if defined(CONFIG_SYS_FAULT_ECHO_LINK_DOWN) && \
542 defined(CONFIG_LED_STATUS) && \
543 defined(CONFIG_LED_STATUS_RED)
545 * Echo the inverted link state to the fault LED.
547 if (miiphy_link(eth_get_dev()->name, CONFIG_SYS_FAULT_MII_ADDR))
548 status_led_set(CONFIG_LED_STATUS_RED, CONFIG_LED_STATUS_OFF);
550 status_led_set(CONFIG_LED_STATUS_RED, CONFIG_LED_STATUS_ON);
551 #endif /* CONFIG_SYS_FAULT_ECHO_LINK_DOWN, ... */
552 #endif /* CONFIG_MII, ... */
553 #ifdef CONFIG_USB_KEYBOARD
558 * Main packet reception loop. Loop receiving packets until
559 * someone sets `net_state' to a state that terminates.
563 if (arp_timeout_check() > 0)
564 time_start = get_timer(0);
567 * Check the ethernet for a new packet. The ethernet
568 * receive routine will process it.
569 * Most drivers return the most recent packet size, but not
570 * errors that may have happened.
575 * Abort if ctrl-c was pressed.
578 /* cancel any ARP that may not have completed */
579 net_arp_wait_packet_ip.s_addr = 0;
583 /* Invalidate the last protocol */
584 eth_set_last_protocol(BOOTP);
587 /* include a debug print as well incase the debug
588 messages are directed to stderr */
589 debug_cond(DEBUG_INT_STATE, "--- net_loop Abort!\n");
595 * Check for a timeout, and run the timeout handler
599 ((get_timer(0) - time_start) > time_delta)) {
602 #if defined(CONFIG_MII) || defined(CONFIG_CMD_MII)
603 #if defined(CONFIG_SYS_FAULT_ECHO_LINK_DOWN) && \
604 defined(CONFIG_LED_STATUS) && \
605 defined(CONFIG_LED_STATUS_RED)
607 * Echo the inverted link state to the fault LED.
609 if (miiphy_link(eth_get_dev()->name,
610 CONFIG_SYS_FAULT_MII_ADDR))
611 status_led_set(CONFIG_LED_STATUS_RED,
612 CONFIG_LED_STATUS_OFF);
614 status_led_set(CONFIG_LED_STATUS_RED,
615 CONFIG_LED_STATUS_ON);
616 #endif /* CONFIG_SYS_FAULT_ECHO_LINK_DOWN, ... */
617 #endif /* CONFIG_MII, ... */
618 debug_cond(DEBUG_INT_STATE, "--- net_loop timeout\n");
620 time_handler = (thand_f *)0;
624 if (net_state == NETLOOP_FAIL)
625 ret = net_start_again();
628 case NETLOOP_RESTART:
632 case NETLOOP_SUCCESS:
634 if (net_boot_file_size > 0) {
635 printf("Bytes transferred = %d (%x hex)\n",
636 net_boot_file_size, net_boot_file_size);
637 env_set_hex("filesize", net_boot_file_size);
638 env_set_hex("fileaddr", image_load_addr);
640 if (protocol != NETCONS)
643 eth_halt_state_only();
645 eth_set_last_protocol(protocol);
647 ret = net_boot_file_size;
648 debug_cond(DEBUG_INT_STATE, "--- net_loop Success!\n");
653 /* Invalidate the last protocol */
654 eth_set_last_protocol(BOOTP);
655 debug_cond(DEBUG_INT_STATE, "--- net_loop Fail!\n");
659 case NETLOOP_CONTINUE:
665 #ifdef CONFIG_USB_KEYBOARD
668 #ifdef CONFIG_CMD_TFTPPUT
669 /* Clear out the handlers */
670 net_set_udp_handler(NULL);
671 net_set_icmp_handler(NULL);
673 net_set_state(prev_net_state);
675 #if defined(CONFIG_CMD_PCAP)
682 /**********************************************************************/
684 static void start_again_timeout_handler(void)
686 net_set_state(NETLOOP_RESTART);
689 int net_start_again(void)
692 int retry_forever = 0;
693 unsigned long retrycnt = 0;
696 nretry = env_get("netretry");
698 if (!strcmp(nretry, "yes"))
700 else if (!strcmp(nretry, "no"))
702 else if (!strcmp(nretry, "once"))
705 retrycnt = simple_strtoul(nretry, NULL, 0);
711 if ((!retry_forever) && (net_try_count > retrycnt)) {
713 net_set_state(NETLOOP_FAIL);
715 * We don't provide a way for the protocol to return an error,
716 * but this is almost always the reason.
724 #if !defined(CONFIG_NET_DO_NOT_TRY_ANOTHER)
725 eth_try_another(!net_restarted);
728 if (net_restart_wrap) {
729 net_restart_wrap = 0;
730 if (net_dev_exists) {
731 net_set_timeout_handler(10000UL,
732 start_again_timeout_handler);
733 net_set_udp_handler(NULL);
735 net_set_state(NETLOOP_FAIL);
738 net_set_state(NETLOOP_RESTART);
743 /**********************************************************************/
748 static void dummy_handler(uchar *pkt, unsigned dport,
749 struct in_addr sip, unsigned sport,
754 rxhand_f *net_get_udp_handler(void)
756 return udp_packet_handler;
759 void net_set_udp_handler(rxhand_f *f)
761 debug_cond(DEBUG_INT_STATE, "--- net_loop UDP handler set (%p)\n", f);
763 udp_packet_handler = dummy_handler;
765 udp_packet_handler = f;
768 rxhand_f *net_get_arp_handler(void)
770 return arp_packet_handler;
773 void net_set_arp_handler(rxhand_f *f)
775 debug_cond(DEBUG_INT_STATE, "--- net_loop ARP handler set (%p)\n", f);
777 arp_packet_handler = dummy_handler;
779 arp_packet_handler = f;
782 #ifdef CONFIG_CMD_TFTPPUT
783 void net_set_icmp_handler(rxhand_icmp_f *f)
785 packet_icmp_handler = f;
789 void net_set_timeout_handler(ulong iv, thand_f *f)
792 debug_cond(DEBUG_INT_STATE,
793 "--- net_loop timeout handler cancelled\n");
794 time_handler = (thand_f *)0;
796 debug_cond(DEBUG_INT_STATE,
797 "--- net_loop timeout handler set (%p)\n", f);
799 time_start = get_timer(0);
800 time_delta = iv * CONFIG_SYS_HZ / 1000;
804 uchar *net_get_async_tx_pkt_buf(void)
806 if (arp_is_waiting())
807 return arp_tx_packet; /* If we are waiting, we already sent */
809 return net_tx_packet;
812 int net_send_udp_packet(uchar *ether, struct in_addr dest, int dport, int sport,
815 return net_send_ip_packet(ether, dest, dport, sport, payload_len,
816 IPPROTO_UDP, 0, 0, 0);
819 int net_send_ip_packet(uchar *ether, struct in_addr dest, int dport, int sport,
820 int payload_len, int proto, u8 action, u32 tcp_seq_num,
827 /* make sure the net_tx_packet is initialized (net_init() was called) */
828 assert(net_tx_packet != NULL);
829 if (net_tx_packet == NULL)
832 /* convert to new style broadcast */
833 if (dest.s_addr == 0)
834 dest.s_addr = 0xFFFFFFFF;
836 /* if broadcast, make the ether address a broadcast and don't do ARP */
837 if (dest.s_addr == 0xFFFFFFFF)
838 ether = (uchar *)net_bcast_ethaddr;
840 pkt = (uchar *)net_tx_packet;
842 eth_hdr_size = net_set_ether(pkt, ether, PROT_IP);
846 net_set_udp_header(pkt + eth_hdr_size, dest, dport, sport,
848 pkt_hdr_size = eth_hdr_size + IP_UDP_HDR_SIZE;
854 /* if MAC address was not discovered yet, do an ARP request */
855 if (memcmp(ether, net_null_ethaddr, 6) == 0) {
856 debug_cond(DEBUG_DEV_PKT, "sending ARP for %pI4\n", &dest);
858 /* save the ip and eth addr for the packet to send after arp */
859 net_arp_wait_packet_ip = dest;
860 arp_wait_packet_ethaddr = ether;
862 /* size of the waiting packet */
863 arp_wait_tx_packet_size = pkt_hdr_size + payload_len;
865 /* and do the ARP request */
867 arp_wait_timer_start = get_timer(0);
869 return 1; /* waiting */
871 debug_cond(DEBUG_DEV_PKT, "sending UDP to %pI4/%pM\n",
873 net_send_packet(net_tx_packet, pkt_hdr_size + payload_len);
874 return 0; /* transmitted */
878 #ifdef CONFIG_IP_DEFRAG
880 * This function collects fragments in a single packet, according
881 * to the algorithm in RFC815. It returns NULL or the pointer to
882 * a complete packet, in static storage
884 #define IP_PKTSIZE (CONFIG_NET_MAXDEFRAG)
886 #define IP_MAXUDP (IP_PKTSIZE - IP_HDR_SIZE)
889 * this is the packet being assembled, either data or frag control.
890 * Fragments go by 8 bytes, so this union must be 8 bytes long
893 /* first_byte is address of this structure */
894 u16 last_byte; /* last byte in this hole + 1 (begin of next hole) */
895 u16 next_hole; /* index of next (in 8-b blocks), 0 == none */
896 u16 prev_hole; /* index of prev, 0 == none */
900 static struct ip_udp_hdr *__net_defragment(struct ip_udp_hdr *ip, int *lenp)
902 static uchar pkt_buff[IP_PKTSIZE] __aligned(PKTALIGN);
903 static u16 first_hole, total_len;
904 struct hole *payload, *thisfrag, *h, *newh;
905 struct ip_udp_hdr *localip = (struct ip_udp_hdr *)pkt_buff;
906 uchar *indata = (uchar *)ip;
907 int offset8, start, len, done = 0;
908 u16 ip_off = ntohs(ip->ip_off);
910 /* payload starts after IP header, this fragment is in there */
911 payload = (struct hole *)(pkt_buff + IP_HDR_SIZE);
912 offset8 = (ip_off & IP_OFFS);
913 thisfrag = payload + offset8;
915 len = ntohs(ip->ip_len) - IP_HDR_SIZE;
917 if (start + len > IP_MAXUDP) /* fragment extends too far */
920 if (!total_len || localip->ip_id != ip->ip_id) {
921 /* new (or different) packet, reset structs */
923 payload[0].last_byte = ~0;
924 payload[0].next_hole = 0;
925 payload[0].prev_hole = 0;
927 /* any IP header will work, copy the first we received */
928 memcpy(localip, ip, IP_HDR_SIZE);
932 * What follows is the reassembly algorithm. We use the payload
933 * array as a linked list of hole descriptors, as each hole starts
934 * at a multiple of 8 bytes. However, last byte can be whatever value,
935 * so it is represented as byte count, not as 8-byte blocks.
938 h = payload + first_hole;
939 while (h->last_byte < start) {
941 /* no hole that far away */
944 h = payload + h->next_hole;
947 /* last fragment may be 1..7 bytes, the "+7" forces acceptance */
948 if (offset8 + ((len + 7) / 8) <= h - payload) {
949 /* no overlap with holes (dup fragment?) */
953 if (!(ip_off & IP_FLAGS_MFRAG)) {
954 /* no more fragmentss: truncate this (last) hole */
955 total_len = start + len;
956 h->last_byte = start + len;
960 * There is some overlap: fix the hole list. This code doesn't
961 * deal with a fragment that overlaps with two different holes
962 * (thus being a superset of a previously-received fragment).
965 if ((h >= thisfrag) && (h->last_byte <= start + len)) {
966 /* complete overlap with hole: remove hole */
967 if (!h->prev_hole && !h->next_hole) {
968 /* last remaining hole */
970 } else if (!h->prev_hole) {
972 first_hole = h->next_hole;
973 payload[h->next_hole].prev_hole = 0;
974 } else if (!h->next_hole) {
976 payload[h->prev_hole].next_hole = 0;
978 /* in the middle of the list */
979 payload[h->next_hole].prev_hole = h->prev_hole;
980 payload[h->prev_hole].next_hole = h->next_hole;
983 } else if (h->last_byte <= start + len) {
984 /* overlaps with final part of the hole: shorten this hole */
985 h->last_byte = start;
987 } else if (h >= thisfrag) {
988 /* overlaps with initial part of the hole: move this hole */
989 newh = thisfrag + (len / 8);
993 payload[h->next_hole].prev_hole = (h - payload);
995 payload[h->prev_hole].next_hole = (h - payload);
997 first_hole = (h - payload);
1000 /* fragment sits in the middle: split the hole */
1001 newh = thisfrag + (len / 8);
1003 h->last_byte = start;
1004 h->next_hole = (newh - payload);
1005 newh->prev_hole = (h - payload);
1006 if (newh->next_hole)
1007 payload[newh->next_hole].prev_hole = (newh - payload);
1010 /* finally copy this fragment and possibly return whole packet */
1011 memcpy((uchar *)thisfrag, indata + IP_HDR_SIZE, len);
1015 localip->ip_len = htons(total_len);
1016 *lenp = total_len + IP_HDR_SIZE;
1020 static inline struct ip_udp_hdr *net_defragment(struct ip_udp_hdr *ip,
1023 u16 ip_off = ntohs(ip->ip_off);
1024 if (!(ip_off & (IP_OFFS | IP_FLAGS_MFRAG)))
1025 return ip; /* not a fragment */
1026 return __net_defragment(ip, lenp);
1029 #else /* !CONFIG_IP_DEFRAG */
1031 static inline struct ip_udp_hdr *net_defragment(struct ip_udp_hdr *ip,
1034 u16 ip_off = ntohs(ip->ip_off);
1035 if (!(ip_off & (IP_OFFS | IP_FLAGS_MFRAG)))
1036 return ip; /* not a fragment */
1042 * Receive an ICMP packet. We deal with REDIRECT and PING here, and silently
1045 * @parma ip IP packet containing the ICMP
1047 static void receive_icmp(struct ip_udp_hdr *ip, int len,
1048 struct in_addr src_ip, struct ethernet_hdr *et)
1050 struct icmp_hdr *icmph = (struct icmp_hdr *)&ip->udp_src;
1052 switch (icmph->type) {
1054 if (icmph->code != ICMP_REDIR_HOST)
1056 printf(" ICMP Host Redirect to %pI4 ",
1057 &icmph->un.gateway);
1060 #if defined(CONFIG_CMD_PING)
1061 ping_receive(et, ip, len);
1063 #ifdef CONFIG_CMD_TFTPPUT
1064 if (packet_icmp_handler)
1065 packet_icmp_handler(icmph->type, icmph->code,
1066 ntohs(ip->udp_dst), src_ip,
1067 ntohs(ip->udp_src), icmph->un.data,
1068 ntohs(ip->udp_len));
1074 void net_process_received_packet(uchar *in_packet, int len)
1076 struct ethernet_hdr *et;
1077 struct ip_udp_hdr *ip;
1078 struct in_addr dst_ip;
1079 struct in_addr src_ip;
1081 #if defined(CONFIG_CMD_CDP)
1084 ushort cti = 0, vlanid = VLAN_NONE, myvlanid, mynvlanid;
1086 debug_cond(DEBUG_NET_PKT, "packet received\n");
1088 #if defined(CONFIG_CMD_PCAP)
1089 pcap_post(in_packet, len, false);
1091 net_rx_packet = in_packet;
1092 net_rx_packet_len = len;
1093 et = (struct ethernet_hdr *)in_packet;
1095 /* too small packet? */
1096 if (len < ETHER_HDR_SIZE)
1099 #if defined(CONFIG_API) || defined(CONFIG_EFI_LOADER)
1101 (*push_packet)(in_packet, len);
1106 #if defined(CONFIG_CMD_CDP)
1107 /* keep track if packet is CDP */
1108 iscdp = is_cdp_packet(et->et_dest);
1111 myvlanid = ntohs(net_our_vlan);
1112 if (myvlanid == (ushort)-1)
1113 myvlanid = VLAN_NONE;
1114 mynvlanid = ntohs(net_native_vlan);
1115 if (mynvlanid == (ushort)-1)
1116 mynvlanid = VLAN_NONE;
1118 eth_proto = ntohs(et->et_protlen);
1120 if (eth_proto < 1514) {
1121 struct e802_hdr *et802 = (struct e802_hdr *)et;
1123 * Got a 802.2 packet. Check the other protocol field.
1124 * XXX VLAN over 802.2+SNAP not implemented!
1126 eth_proto = ntohs(et802->et_prot);
1128 ip = (struct ip_udp_hdr *)(in_packet + E802_HDR_SIZE);
1129 len -= E802_HDR_SIZE;
1131 } else if (eth_proto != PROT_VLAN) { /* normal packet */
1132 ip = (struct ip_udp_hdr *)(in_packet + ETHER_HDR_SIZE);
1133 len -= ETHER_HDR_SIZE;
1135 } else { /* VLAN packet */
1136 struct vlan_ethernet_hdr *vet =
1137 (struct vlan_ethernet_hdr *)et;
1139 debug_cond(DEBUG_NET_PKT, "VLAN packet received\n");
1141 /* too small packet? */
1142 if (len < VLAN_ETHER_HDR_SIZE)
1145 /* if no VLAN active */
1146 if ((ntohs(net_our_vlan) & VLAN_IDMASK) == VLAN_NONE
1147 #if defined(CONFIG_CMD_CDP)
1153 cti = ntohs(vet->vet_tag);
1154 vlanid = cti & VLAN_IDMASK;
1155 eth_proto = ntohs(vet->vet_type);
1157 ip = (struct ip_udp_hdr *)(in_packet + VLAN_ETHER_HDR_SIZE);
1158 len -= VLAN_ETHER_HDR_SIZE;
1161 debug_cond(DEBUG_NET_PKT, "Receive from protocol 0x%x\n", eth_proto);
1163 #if defined(CONFIG_CMD_CDP)
1165 cdp_receive((uchar *)ip, len);
1170 if ((myvlanid & VLAN_IDMASK) != VLAN_NONE) {
1171 if (vlanid == VLAN_NONE)
1172 vlanid = (mynvlanid & VLAN_IDMASK);
1174 if (vlanid != (myvlanid & VLAN_IDMASK))
1178 switch (eth_proto) {
1180 arp_receive(et, ip, len);
1183 #ifdef CONFIG_CMD_RARP
1185 rarp_receive(ip, len);
1189 debug_cond(DEBUG_NET_PKT, "Got IP\n");
1190 /* Before we start poking the header, make sure it is there */
1191 if (len < IP_UDP_HDR_SIZE) {
1192 debug("len bad %d < %lu\n", len,
1193 (ulong)IP_UDP_HDR_SIZE);
1196 /* Check the packet length */
1197 if (len < ntohs(ip->ip_len)) {
1198 debug("len bad %d < %d\n", len, ntohs(ip->ip_len));
1201 len = ntohs(ip->ip_len);
1202 debug_cond(DEBUG_NET_PKT, "len=%d, v=%02x\n",
1203 len, ip->ip_hl_v & 0xff);
1205 /* Can't deal with anything except IPv4 */
1206 if ((ip->ip_hl_v & 0xf0) != 0x40)
1208 /* Can't deal with IP options (headers != 20 bytes) */
1209 if ((ip->ip_hl_v & 0x0f) > 0x05)
1211 /* Check the Checksum of the header */
1212 if (!ip_checksum_ok((uchar *)ip, IP_HDR_SIZE)) {
1213 debug("checksum bad\n");
1216 /* If it is not for us, ignore it */
1217 dst_ip = net_read_ip(&ip->ip_dst);
1218 if (net_ip.s_addr && dst_ip.s_addr != net_ip.s_addr &&
1219 dst_ip.s_addr != 0xFFFFFFFF) {
1222 /* Read source IP address for later use */
1223 src_ip = net_read_ip(&ip->ip_src);
1225 * The function returns the unchanged packet if it's not
1226 * a fragment, and either the complete packet or NULL if
1227 * it is a fragment (if !CONFIG_IP_DEFRAG, it returns NULL)
1229 ip = net_defragment(ip, &len);
1233 * watch for ICMP host redirects
1235 * There is no real handler code (yet). We just watch
1236 * for ICMP host redirect messages. In case anybody
1237 * sees these messages: please contact me
1238 * (wd@denx.de), or - even better - send me the
1239 * necessary fixes :-)
1241 * Note: in all cases where I have seen this so far
1242 * it was a problem with the router configuration,
1243 * for instance when a router was configured in the
1244 * BOOTP reply, but the TFTP server was on the same
1245 * subnet. So this is probably a warning that your
1246 * configuration might be wrong. But I'm not really
1247 * sure if there aren't any other situations.
1249 * Simon Glass <sjg@chromium.org>: We get an ICMP when
1250 * we send a tftp packet to a dead connection, or when
1251 * there is no server at the other end.
1253 if (ip->ip_p == IPPROTO_ICMP) {
1254 receive_icmp(ip, len, src_ip, et);
1256 } else if (ip->ip_p != IPPROTO_UDP) { /* Only UDP packets */
1260 if (ntohs(ip->udp_len) < UDP_HDR_SIZE || ntohs(ip->udp_len) > ntohs(ip->ip_len))
1263 debug_cond(DEBUG_DEV_PKT,
1264 "received UDP (to=%pI4, from=%pI4, len=%d)\n",
1265 &dst_ip, &src_ip, len);
1267 if (IS_ENABLED(CONFIG_UDP_CHECKSUM) && 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 = (u8 *)&ip->udp_src;
1282 while (sumlen > 1) {
1283 /* inlined ntohs() to avoid alignment errors */
1284 xsum += (sumptr[0] << 8) + sumptr[1];
1289 xsum += (sumptr[0] << 8) + sumptr[0];
1290 while ((xsum >> 16) != 0) {
1291 xsum = (xsum & 0x0000ffff) +
1292 ((xsum >> 16) & 0x0000ffff);
1294 if ((xsum != 0x00000000) && (xsum != 0x0000ffff)) {
1295 printf(" UDP wrong checksum %08lx %08x\n",
1296 xsum, ntohs(ip->udp_xsum));
1301 #if defined(CONFIG_NETCONSOLE) && !defined(CONFIG_SPL_BUILD)
1302 nc_input_packet((uchar *)ip + IP_UDP_HDR_SIZE,
1306 ntohs(ip->udp_len) - UDP_HDR_SIZE);
1309 * IP header OK. Pass the packet to the current handler.
1311 (*udp_packet_handler)((uchar *)ip + IP_UDP_HDR_SIZE,
1315 ntohs(ip->udp_len) - UDP_HDR_SIZE);
1317 #ifdef CONFIG_CMD_WOL
1319 wol_receive(ip, len);
1325 /**********************************************************************/
1327 static int net_check_prereq(enum proto_t protocol)
1331 #if defined(CONFIG_CMD_PING)
1333 if (net_ping_ip.s_addr == 0) {
1334 puts("*** ERROR: ping address not given\n");
1339 #if defined(CONFIG_CMD_DNS)
1341 if (net_dns_server.s_addr == 0) {
1342 puts("*** ERROR: DNS server address not given\n");
1347 #if defined(CONFIG_PROT_UDP)
1354 #if defined(CONFIG_CMD_NFS)
1360 if (net_server_ip.s_addr == 0 && !is_serverip_in_cmd()) {
1361 puts("*** ERROR: `serverip' not set\n");
1364 #if defined(CONFIG_CMD_PING) || \
1365 defined(CONFIG_CMD_DNS) || defined(CONFIG_PROT_UDP)
1373 if (net_ip.s_addr == 0) {
1374 puts("*** ERROR: `ipaddr' not set\n");
1379 #ifdef CONFIG_CMD_RARP
1386 if (memcmp(net_ethaddr, "\0\0\0\0\0\0", 6) == 0) {
1387 int num = eth_get_dev_index();
1391 puts("*** ERROR: No ethernet found.\n");
1394 puts("*** ERROR: `ethaddr' not set\n");
1397 printf("*** ERROR: `eth%daddr' not set\n",
1411 /**********************************************************************/
1414 net_eth_hdr_size(void)
1418 myvlanid = ntohs(net_our_vlan);
1419 if (myvlanid == (ushort)-1)
1420 myvlanid = VLAN_NONE;
1422 return ((myvlanid & VLAN_IDMASK) == VLAN_NONE) ? ETHER_HDR_SIZE :
1423 VLAN_ETHER_HDR_SIZE;
1426 int net_set_ether(uchar *xet, const uchar *dest_ethaddr, uint prot)
1428 struct ethernet_hdr *et = (struct ethernet_hdr *)xet;
1431 myvlanid = ntohs(net_our_vlan);
1432 if (myvlanid == (ushort)-1)
1433 myvlanid = VLAN_NONE;
1435 memcpy(et->et_dest, dest_ethaddr, 6);
1436 memcpy(et->et_src, net_ethaddr, 6);
1437 if ((myvlanid & VLAN_IDMASK) == VLAN_NONE) {
1438 et->et_protlen = htons(prot);
1439 return ETHER_HDR_SIZE;
1441 struct vlan_ethernet_hdr *vet =
1442 (struct vlan_ethernet_hdr *)xet;
1444 vet->vet_vlan_type = htons(PROT_VLAN);
1445 vet->vet_tag = htons((0 << 5) | (myvlanid & VLAN_IDMASK));
1446 vet->vet_type = htons(prot);
1447 return VLAN_ETHER_HDR_SIZE;
1451 int net_update_ether(struct ethernet_hdr *et, uchar *addr, uint prot)
1455 memcpy(et->et_dest, addr, 6);
1456 memcpy(et->et_src, net_ethaddr, 6);
1457 protlen = ntohs(et->et_protlen);
1458 if (protlen == PROT_VLAN) {
1459 struct vlan_ethernet_hdr *vet =
1460 (struct vlan_ethernet_hdr *)et;
1461 vet->vet_type = htons(prot);
1462 return VLAN_ETHER_HDR_SIZE;
1463 } else if (protlen > 1514) {
1464 et->et_protlen = htons(prot);
1465 return ETHER_HDR_SIZE;
1468 struct e802_hdr *et802 = (struct e802_hdr *)et;
1469 et802->et_prot = htons(prot);
1470 return E802_HDR_SIZE;
1474 void net_set_ip_header(uchar *pkt, struct in_addr dest, struct in_addr source,
1475 u16 pkt_len, u8 proto)
1477 struct ip_udp_hdr *ip = (struct ip_udp_hdr *)pkt;
1480 * Construct an IP header.
1482 /* IP_HDR_SIZE / 4 (not including UDP) */
1485 ip->ip_len = htons(pkt_len);
1487 ip->ip_id = htons(net_ip_id++);
1488 ip->ip_off = htons(IP_FLAGS_DFRAG); /* Don't fragment */
1491 /* already in network byte order */
1492 net_copy_ip((void *)&ip->ip_src, &source);
1493 /* already in network byte order */
1494 net_copy_ip((void *)&ip->ip_dst, &dest);
1496 ip->ip_sum = compute_ip_checksum(ip, IP_HDR_SIZE);
1499 void net_set_udp_header(uchar *pkt, struct in_addr dest, int dport, int sport,
1502 struct ip_udp_hdr *ip = (struct ip_udp_hdr *)pkt;
1505 * If the data is an odd number of bytes, zero the
1506 * byte after the last byte so that the checksum
1510 pkt[IP_UDP_HDR_SIZE + len] = 0;
1512 net_set_ip_header(pkt, dest, net_ip, IP_UDP_HDR_SIZE + len,
1515 ip->udp_src = htons(sport);
1516 ip->udp_dst = htons(dport);
1517 ip->udp_len = htons(UDP_HDR_SIZE + len);
1521 void copy_filename(char *dst, const char *src, int size)
1523 if (src && *src && (*src == '"')) {
1528 while ((--size > 0) && src && *src && (*src != '"'))
1533 int is_serverip_in_cmd(void)
1535 return !!strchr(net_boot_file_name, ':');
1538 int net_parse_bootfile(struct in_addr *ipaddr, char *filename, int max_len)
1544 if (net_boot_file_name[0] == '\0')
1547 colon = strchr(net_boot_file_name, ':');
1549 ip = string_to_ip(net_boot_file_name);
1550 if (ipaddr && ip.s_addr)
1554 strncpy(filename, colon + 1, max_len);
1556 strncpy(filename, net_boot_file_name, max_len);
1558 filename[max_len - 1] = '\0';
1563 void ip_to_string(struct in_addr x, char *s)
1565 x.s_addr = ntohl(x.s_addr);
1566 sprintf(s, "%d.%d.%d.%d",
1567 (int) ((x.s_addr >> 24) & 0xff),
1568 (int) ((x.s_addr >> 16) & 0xff),
1569 (int) ((x.s_addr >> 8) & 0xff),
1570 (int) ((x.s_addr >> 0) & 0xff)
1574 void vlan_to_string(ushort x, char *s)
1578 if (x == (ushort)-1)
1584 sprintf(s, "%d", x & VLAN_IDMASK);
1587 ushort string_to_vlan(const char *s)
1592 return htons(VLAN_NONE);
1594 if (*s < '0' || *s > '9')
1597 id = (ushort)dectoul(s, NULL);
1602 ushort env_get_vlan(char *var)
1604 return string_to_vlan(env_get(var));