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>
97 #if defined(CONFIG_CMD_PCAP)
101 #if defined(CONFIG_LED_STATUS)
103 #include <status_led.h>
105 #include <watchdog.h>
106 #include <linux/compiler.h>
110 #if defined(CONFIG_CMD_DNS)
113 #include "link_local.h"
117 #if defined(CONFIG_CMD_WOL)
121 /** BOOTP EXTENTIONS **/
123 /* Our subnet mask (0=unknown) */
124 struct in_addr net_netmask;
125 /* Our gateways IP address */
126 struct in_addr net_gateway;
127 /* Our DNS IP address */
128 struct in_addr net_dns_server;
129 #if defined(CONFIG_BOOTP_DNS2)
130 /* Our 2nd DNS IP address */
131 struct in_addr net_dns_server2;
134 /** END OF BOOTP EXTENTIONS **/
136 /* Our ethernet address */
138 /* Boot server enet address */
139 u8 net_server_ethaddr[6];
140 /* Our IP addr (0 = unknown) */
141 struct in_addr net_ip;
142 /* Server IP addr (0 = unknown) */
143 struct in_addr net_server_ip;
144 /* Current receive packet */
145 uchar *net_rx_packet;
146 /* Current rx packet length */
147 int net_rx_packet_len;
149 static unsigned net_ip_id;
150 /* Ethernet bcast address */
151 const u8 net_bcast_ethaddr[6] = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
152 const u8 net_null_ethaddr[6];
153 #if defined(CONFIG_API) || defined(CONFIG_EFI_LOADER)
154 void (*push_packet)(void *, int len) = 0;
156 /* Network loop state */
157 enum net_loop_state net_state;
158 /* Tried all network devices */
159 int net_restart_wrap;
160 /* Network loop restarted */
161 static int net_restarted;
162 /* At least one device configured */
163 static int net_dev_exists;
165 /* XXX in both little & big endian machines 0xFFFF == ntohs(-1) */
166 /* default is without VLAN */
167 ushort net_our_vlan = 0xFFFF;
169 ushort net_native_vlan = 0xFFFF;
172 char net_boot_file_name[1024];
173 /* Indicates whether the file name was specified on the command line */
174 bool net_boot_file_name_explicit;
175 /* The actual transferred size of the bootfile (in bytes) */
176 u32 net_boot_file_size;
177 /* Boot file size in blocks as reported by the DHCP server */
178 u32 net_boot_file_expected_size_in_blocks;
180 static uchar net_pkt_buf[(PKTBUFSRX+1) * PKTSIZE_ALIGN + PKTALIGN];
181 /* Receive packets */
182 uchar *net_rx_packets[PKTBUFSRX];
183 /* Current UDP RX packet handler */
184 static rxhand_f *udp_packet_handler;
185 /* Current ARP RX packet handler */
186 static rxhand_f *arp_packet_handler;
187 #ifdef CONFIG_CMD_TFTPPUT
188 /* Current ICMP rx handler */
189 static rxhand_icmp_f *packet_icmp_handler;
191 /* Current timeout handler */
192 static thand_f *time_handler;
193 /* Time base value */
194 static ulong time_start;
195 /* Current timeout value */
196 static ulong time_delta;
197 /* THE transmit packet */
198 uchar *net_tx_packet;
200 static int net_check_prereq(enum proto_t protocol);
202 static int net_try_count;
204 int __maybe_unused net_busy_flag;
206 /**********************************************************************/
208 static int on_ipaddr(const char *name, const char *value, enum env_op op,
211 if (flags & H_PROGRAMMATIC)
214 net_ip = string_to_ip(value);
218 U_BOOT_ENV_CALLBACK(ipaddr, on_ipaddr);
220 static int on_gatewayip(const char *name, const char *value, enum env_op op,
223 if (flags & H_PROGRAMMATIC)
226 net_gateway = string_to_ip(value);
230 U_BOOT_ENV_CALLBACK(gatewayip, on_gatewayip);
232 static int on_netmask(const char *name, const char *value, enum env_op op,
235 if (flags & H_PROGRAMMATIC)
238 net_netmask = string_to_ip(value);
242 U_BOOT_ENV_CALLBACK(netmask, on_netmask);
244 static int on_serverip(const char *name, const char *value, enum env_op op,
247 if (flags & H_PROGRAMMATIC)
250 net_server_ip = string_to_ip(value);
254 U_BOOT_ENV_CALLBACK(serverip, on_serverip);
256 static int on_nvlan(const char *name, const char *value, enum env_op op,
259 if (flags & H_PROGRAMMATIC)
262 net_native_vlan = string_to_vlan(value);
266 U_BOOT_ENV_CALLBACK(nvlan, on_nvlan);
268 static int on_vlan(const char *name, const char *value, enum env_op op,
271 if (flags & H_PROGRAMMATIC)
274 net_our_vlan = string_to_vlan(value);
278 U_BOOT_ENV_CALLBACK(vlan, on_vlan);
280 #if defined(CONFIG_CMD_DNS)
281 static int on_dnsip(const char *name, const char *value, enum env_op op,
284 if (flags & H_PROGRAMMATIC)
287 net_dns_server = string_to_ip(value);
291 U_BOOT_ENV_CALLBACK(dnsip, on_dnsip);
295 * Check if autoload is enabled. If so, use either NFS or TFTP to download
298 void net_auto_load(void)
300 #if defined(CONFIG_CMD_NFS) && !defined(CONFIG_SPL_BUILD)
301 const char *s = env_get("autoload");
303 if (s != NULL && strcmp(s, "NFS") == 0) {
304 if (net_check_prereq(NFS)) {
305 /* We aren't expecting to get a serverip, so just accept the assigned IP */
306 if (IS_ENABLED(CONFIG_BOOTP_SERVERIP)) {
307 net_set_state(NETLOOP_SUCCESS);
309 printf("Cannot autoload with NFS\n");
310 net_set_state(NETLOOP_FAIL);
315 * Use NFS to load the bootfile.
321 if (env_get_yesno("autoload") == 0) {
323 * Just use BOOTP/RARP to configure system;
324 * Do not use TFTP to load the bootfile.
326 net_set_state(NETLOOP_SUCCESS);
329 if (net_check_prereq(TFTPGET)) {
330 /* We aren't expecting to get a serverip, so just accept the assigned IP */
331 if (IS_ENABLED(CONFIG_BOOTP_SERVERIP)) {
332 net_set_state(NETLOOP_SUCCESS);
334 printf("Cannot autoload with TFTPGET\n");
335 net_set_state(NETLOOP_FAIL);
342 static int net_init_loop(void)
345 memcpy(net_ethaddr, eth_get_ethaddr(), 6);
348 * Not ideal, but there's no way to get the actual error, and I
349 * don't feel like fixing all the users of eth_get_dev to deal
357 static void net_clear_handlers(void)
359 net_set_udp_handler(NULL);
360 net_set_arp_handler(NULL);
361 net_set_timeout_handler(0, NULL);
364 static void net_cleanup_loop(void)
366 net_clear_handlers();
371 static int first_call = 1;
375 * Setup packet buffers, aligned correctly.
379 net_tx_packet = &net_pkt_buf[0] + (PKTALIGN - 1);
380 net_tx_packet -= (ulong)net_tx_packet % PKTALIGN;
381 for (i = 0; i < PKTBUFSRX; i++) {
382 net_rx_packets[i] = net_tx_packet +
383 (i + 1) * PKTSIZE_ALIGN;
386 net_clear_handlers();
388 /* Only need to setup buffer pointers once. */
392 return net_init_loop();
395 /**********************************************************************/
397 * Main network processing loop.
400 int net_loop(enum proto_t protocol)
403 enum net_loop_state prev_net_state = net_state;
405 #if defined(CONFIG_CMD_PING)
406 if (protocol != PING)
407 net_ping_ip.s_addr = 0;
412 debug_cond(DEBUG_INT_STATE, "--- net_loop Entry\n");
414 #ifdef CONFIG_PHY_NCSI
415 if (phy_interface_is_ncsi() && protocol != NCSI && !ncsi_active()) {
416 printf("%s: configuring NCSI first\n", __func__);
417 if (net_loop(NCSI) < 0)
419 eth_init_state_only();
424 bootstage_mark_name(BOOTSTAGE_ID_ETH_START, "eth_start");
426 if (eth_is_on_demand_init()) {
435 eth_init_state_only();
439 #ifdef CONFIG_USB_KEYBOARD
442 net_set_state(NETLOOP_CONTINUE);
445 * Start the ball rolling with the given start function. From
446 * here on, this code is a state machine driven by received
447 * packets and timer events.
449 debug_cond(DEBUG_INT_STATE, "--- net_loop Init\n");
452 switch (net_check_prereq(protocol)) {
454 /* network not configured */
456 net_set_state(prev_net_state);
460 /* network device not configured */
465 net_boot_file_size = 0;
467 #ifdef CONFIG_CMD_TFTPBOOT
469 #ifdef CONFIG_CMD_TFTPPUT
472 /* always use ARP to get server ethernet address */
473 tftp_start(protocol);
476 #ifdef CONFIG_CMD_TFTPSRV
481 #ifdef CONFIG_UDP_FUNCTION_FASTBOOT
483 fastboot_start_server();
486 #if defined(CONFIG_CMD_DHCP)
490 dhcp_request(); /* Basically same as BOOTP */
493 #if defined(CONFIG_CMD_BOOTP)
500 #if defined(CONFIG_CMD_RARP)
507 #if defined(CONFIG_CMD_PING)
512 #if defined(CONFIG_CMD_NFS) && !defined(CONFIG_SPL_BUILD)
517 #if defined(CONFIG_CMD_CDP)
522 #if defined(CONFIG_NETCONSOLE) && !defined(CONFIG_SPL_BUILD)
527 #if defined(CONFIG_CMD_DNS)
532 #if defined(CONFIG_CMD_LINK_LOCAL)
537 #if defined(CONFIG_CMD_WOL)
542 #if defined(CONFIG_PHY_NCSI)
544 ncsi_probe_packages();
551 if (IS_ENABLED(CONFIG_PROT_UDP) && protocol == UDP)
557 #if defined(CONFIG_MII) || defined(CONFIG_CMD_MII)
558 #if defined(CONFIG_SYS_FAULT_ECHO_LINK_DOWN) && \
559 defined(CONFIG_LED_STATUS) && \
560 defined(CONFIG_LED_STATUS_RED)
562 * Echo the inverted link state to the fault LED.
564 if (miiphy_link(eth_get_dev()->name, CONFIG_SYS_FAULT_MII_ADDR))
565 status_led_set(CONFIG_LED_STATUS_RED, CONFIG_LED_STATUS_OFF);
567 status_led_set(CONFIG_LED_STATUS_RED, CONFIG_LED_STATUS_ON);
568 #endif /* CONFIG_SYS_FAULT_ECHO_LINK_DOWN, ... */
569 #endif /* CONFIG_MII, ... */
570 #ifdef CONFIG_USB_KEYBOARD
575 * Main packet reception loop. Loop receiving packets until
576 * someone sets `net_state' to a state that terminates.
580 if (arp_timeout_check() > 0)
581 time_start = get_timer(0);
584 * Check the ethernet for a new packet. The ethernet
585 * receive routine will process it.
586 * Most drivers return the most recent packet size, but not
587 * errors that may have happened.
592 * Abort if ctrl-c was pressed.
595 /* cancel any ARP that may not have completed */
596 net_arp_wait_packet_ip.s_addr = 0;
600 /* Invalidate the last protocol */
601 eth_set_last_protocol(BOOTP);
604 /* include a debug print as well incase the debug
605 messages are directed to stderr */
606 debug_cond(DEBUG_INT_STATE, "--- net_loop Abort!\n");
612 * Check for a timeout, and run the timeout handler
616 ((get_timer(0) - time_start) > time_delta)) {
619 #if defined(CONFIG_MII) || defined(CONFIG_CMD_MII)
620 #if defined(CONFIG_SYS_FAULT_ECHO_LINK_DOWN) && \
621 defined(CONFIG_LED_STATUS) && \
622 defined(CONFIG_LED_STATUS_RED)
624 * Echo the inverted link state to the fault LED.
626 if (miiphy_link(eth_get_dev()->name,
627 CONFIG_SYS_FAULT_MII_ADDR))
628 status_led_set(CONFIG_LED_STATUS_RED,
629 CONFIG_LED_STATUS_OFF);
631 status_led_set(CONFIG_LED_STATUS_RED,
632 CONFIG_LED_STATUS_ON);
633 #endif /* CONFIG_SYS_FAULT_ECHO_LINK_DOWN, ... */
634 #endif /* CONFIG_MII, ... */
635 debug_cond(DEBUG_INT_STATE, "--- net_loop timeout\n");
637 time_handler = (thand_f *)0;
641 if (net_state == NETLOOP_FAIL)
642 ret = net_start_again();
645 case NETLOOP_RESTART:
649 case NETLOOP_SUCCESS:
651 if (net_boot_file_size > 0) {
652 printf("Bytes transferred = %d (%x hex)\n",
653 net_boot_file_size, net_boot_file_size);
654 env_set_hex("filesize", net_boot_file_size);
655 env_set_hex("fileaddr", image_load_addr);
657 if (protocol != NETCONS && protocol != NCSI)
660 eth_halt_state_only();
662 eth_set_last_protocol(protocol);
664 ret = net_boot_file_size;
665 debug_cond(DEBUG_INT_STATE, "--- net_loop Success!\n");
670 /* Invalidate the last protocol */
671 eth_set_last_protocol(BOOTP);
672 debug_cond(DEBUG_INT_STATE, "--- net_loop Fail!\n");
676 case NETLOOP_CONTINUE:
682 #ifdef CONFIG_USB_KEYBOARD
685 #ifdef CONFIG_CMD_TFTPPUT
686 /* Clear out the handlers */
687 net_set_udp_handler(NULL);
688 net_set_icmp_handler(NULL);
690 net_set_state(prev_net_state);
692 #if defined(CONFIG_CMD_PCAP)
699 /**********************************************************************/
701 static void start_again_timeout_handler(void)
703 net_set_state(NETLOOP_RESTART);
706 int net_start_again(void)
709 int retry_forever = 0;
710 unsigned long retrycnt = 0;
713 nretry = env_get("netretry");
715 if (!strcmp(nretry, "yes"))
717 else if (!strcmp(nretry, "no"))
719 else if (!strcmp(nretry, "once"))
722 retrycnt = simple_strtoul(nretry, NULL, 0);
728 if ((!retry_forever) && (net_try_count > retrycnt)) {
730 net_set_state(NETLOOP_FAIL);
732 * We don't provide a way for the protocol to return an error,
733 * but this is almost always the reason.
741 #if !defined(CONFIG_NET_DO_NOT_TRY_ANOTHER)
742 eth_try_another(!net_restarted);
745 if (net_restart_wrap) {
746 net_restart_wrap = 0;
747 if (net_dev_exists) {
748 net_set_timeout_handler(10000UL,
749 start_again_timeout_handler);
750 net_set_udp_handler(NULL);
752 net_set_state(NETLOOP_FAIL);
755 net_set_state(NETLOOP_RESTART);
760 /**********************************************************************/
765 static void dummy_handler(uchar *pkt, unsigned dport,
766 struct in_addr sip, unsigned sport,
771 rxhand_f *net_get_udp_handler(void)
773 return udp_packet_handler;
776 void net_set_udp_handler(rxhand_f *f)
778 debug_cond(DEBUG_INT_STATE, "--- net_loop UDP handler set (%p)\n", f);
780 udp_packet_handler = dummy_handler;
782 udp_packet_handler = f;
785 rxhand_f *net_get_arp_handler(void)
787 return arp_packet_handler;
790 void net_set_arp_handler(rxhand_f *f)
792 debug_cond(DEBUG_INT_STATE, "--- net_loop ARP handler set (%p)\n", f);
794 arp_packet_handler = dummy_handler;
796 arp_packet_handler = f;
799 #ifdef CONFIG_CMD_TFTPPUT
800 void net_set_icmp_handler(rxhand_icmp_f *f)
802 packet_icmp_handler = f;
806 void net_set_timeout_handler(ulong iv, thand_f *f)
809 debug_cond(DEBUG_INT_STATE,
810 "--- net_loop timeout handler cancelled\n");
811 time_handler = (thand_f *)0;
813 debug_cond(DEBUG_INT_STATE,
814 "--- net_loop timeout handler set (%p)\n", f);
816 time_start = get_timer(0);
817 time_delta = iv * CONFIG_SYS_HZ / 1000;
821 uchar *net_get_async_tx_pkt_buf(void)
823 if (arp_is_waiting())
824 return arp_tx_packet; /* If we are waiting, we already sent */
826 return net_tx_packet;
829 int net_send_udp_packet(uchar *ether, struct in_addr dest, int dport, int sport,
832 return net_send_ip_packet(ether, dest, dport, sport, payload_len,
833 IPPROTO_UDP, 0, 0, 0);
836 int net_send_ip_packet(uchar *ether, struct in_addr dest, int dport, int sport,
837 int payload_len, int proto, u8 action, u32 tcp_seq_num,
844 /* make sure the net_tx_packet is initialized (net_init() was called) */
845 assert(net_tx_packet != NULL);
846 if (net_tx_packet == NULL)
849 /* convert to new style broadcast */
850 if (dest.s_addr == 0)
851 dest.s_addr = 0xFFFFFFFF;
853 /* if broadcast, make the ether address a broadcast and don't do ARP */
854 if (dest.s_addr == 0xFFFFFFFF)
855 ether = (uchar *)net_bcast_ethaddr;
857 pkt = (uchar *)net_tx_packet;
859 eth_hdr_size = net_set_ether(pkt, ether, PROT_IP);
863 net_set_udp_header(pkt + eth_hdr_size, dest, dport, sport,
865 pkt_hdr_size = eth_hdr_size + IP_UDP_HDR_SIZE;
871 /* if MAC address was not discovered yet, do an ARP request */
872 if (memcmp(ether, net_null_ethaddr, 6) == 0) {
873 debug_cond(DEBUG_DEV_PKT, "sending ARP for %pI4\n", &dest);
875 /* save the ip and eth addr for the packet to send after arp */
876 net_arp_wait_packet_ip = dest;
877 arp_wait_packet_ethaddr = ether;
879 /* size of the waiting packet */
880 arp_wait_tx_packet_size = pkt_hdr_size + payload_len;
882 /* and do the ARP request */
884 arp_wait_timer_start = get_timer(0);
886 return 1; /* waiting */
888 debug_cond(DEBUG_DEV_PKT, "sending UDP to %pI4/%pM\n",
890 net_send_packet(net_tx_packet, pkt_hdr_size + payload_len);
891 return 0; /* transmitted */
895 #ifdef CONFIG_IP_DEFRAG
897 * This function collects fragments in a single packet, according
898 * to the algorithm in RFC815. It returns NULL or the pointer to
899 * a complete packet, in static storage
901 #define IP_PKTSIZE (CONFIG_NET_MAXDEFRAG)
903 #define IP_MAXUDP (IP_PKTSIZE - IP_HDR_SIZE)
906 * this is the packet being assembled, either data or frag control.
907 * Fragments go by 8 bytes, so this union must be 8 bytes long
910 /* first_byte is address of this structure */
911 u16 last_byte; /* last byte in this hole + 1 (begin of next hole) */
912 u16 next_hole; /* index of next (in 8-b blocks), 0 == none */
913 u16 prev_hole; /* index of prev, 0 == none */
917 static struct ip_udp_hdr *__net_defragment(struct ip_udp_hdr *ip, int *lenp)
919 static uchar pkt_buff[IP_PKTSIZE] __aligned(PKTALIGN);
920 static u16 first_hole, total_len;
921 struct hole *payload, *thisfrag, *h, *newh;
922 struct ip_udp_hdr *localip = (struct ip_udp_hdr *)pkt_buff;
923 uchar *indata = (uchar *)ip;
924 int offset8, start, len, done = 0;
925 u16 ip_off = ntohs(ip->ip_off);
927 if (ip->ip_len < IP_MIN_FRAG_DATAGRAM_SIZE)
930 /* payload starts after IP header, this fragment is in there */
931 payload = (struct hole *)(pkt_buff + IP_HDR_SIZE);
932 offset8 = (ip_off & IP_OFFS);
933 thisfrag = payload + offset8;
935 len = ntohs(ip->ip_len) - IP_HDR_SIZE;
937 if (start + len > IP_MAXUDP) /* fragment extends too far */
940 if (!total_len || localip->ip_id != ip->ip_id) {
941 /* new (or different) packet, reset structs */
943 payload[0].last_byte = ~0;
944 payload[0].next_hole = 0;
945 payload[0].prev_hole = 0;
947 /* any IP header will work, copy the first we received */
948 memcpy(localip, ip, IP_HDR_SIZE);
952 * What follows is the reassembly algorithm. We use the payload
953 * array as a linked list of hole descriptors, as each hole starts
954 * at a multiple of 8 bytes. However, last byte can be whatever value,
955 * so it is represented as byte count, not as 8-byte blocks.
958 h = payload + first_hole;
959 while (h->last_byte < start) {
961 /* no hole that far away */
964 h = payload + h->next_hole;
967 /* last fragment may be 1..7 bytes, the "+7" forces acceptance */
968 if (offset8 + ((len + 7) / 8) <= h - payload) {
969 /* no overlap with holes (dup fragment?) */
973 if (!(ip_off & IP_FLAGS_MFRAG)) {
974 /* no more fragmentss: truncate this (last) hole */
975 total_len = start + len;
976 h->last_byte = start + len;
980 * There is some overlap: fix the hole list. This code doesn't
981 * deal with a fragment that overlaps with two different holes
982 * (thus being a superset of a previously-received fragment).
985 if ((h >= thisfrag) && (h->last_byte <= start + len)) {
986 /* complete overlap with hole: remove hole */
987 if (!h->prev_hole && !h->next_hole) {
988 /* last remaining hole */
990 } else if (!h->prev_hole) {
992 first_hole = h->next_hole;
993 payload[h->next_hole].prev_hole = 0;
994 } else if (!h->next_hole) {
996 payload[h->prev_hole].next_hole = 0;
998 /* in the middle of the list */
999 payload[h->next_hole].prev_hole = h->prev_hole;
1000 payload[h->prev_hole].next_hole = h->next_hole;
1003 } else if (h->last_byte <= start + len) {
1004 /* overlaps with final part of the hole: shorten this hole */
1005 h->last_byte = start;
1007 } else if (h >= thisfrag) {
1008 /* overlaps with initial part of the hole: move this hole */
1009 newh = thisfrag + (len / 8);
1013 payload[h->next_hole].prev_hole = (h - payload);
1015 payload[h->prev_hole].next_hole = (h - payload);
1017 first_hole = (h - payload);
1020 /* fragment sits in the middle: split the hole */
1021 newh = thisfrag + (len / 8);
1023 h->last_byte = start;
1024 h->next_hole = (newh - payload);
1025 newh->prev_hole = (h - payload);
1026 if (newh->next_hole)
1027 payload[newh->next_hole].prev_hole = (newh - payload);
1030 /* finally copy this fragment and possibly return whole packet */
1031 memcpy((uchar *)thisfrag, indata + IP_HDR_SIZE, len);
1035 localip->ip_len = htons(total_len);
1036 *lenp = total_len + IP_HDR_SIZE;
1040 static inline struct ip_udp_hdr *net_defragment(struct ip_udp_hdr *ip,
1043 u16 ip_off = ntohs(ip->ip_off);
1044 if (!(ip_off & (IP_OFFS | IP_FLAGS_MFRAG)))
1045 return ip; /* not a fragment */
1046 return __net_defragment(ip, lenp);
1049 #else /* !CONFIG_IP_DEFRAG */
1051 static inline struct ip_udp_hdr *net_defragment(struct ip_udp_hdr *ip,
1054 u16 ip_off = ntohs(ip->ip_off);
1055 if (!(ip_off & (IP_OFFS | IP_FLAGS_MFRAG)))
1056 return ip; /* not a fragment */
1062 * Receive an ICMP packet. We deal with REDIRECT and PING here, and silently
1065 * @parma ip IP packet containing the ICMP
1067 static void receive_icmp(struct ip_udp_hdr *ip, int len,
1068 struct in_addr src_ip, struct ethernet_hdr *et)
1070 struct icmp_hdr *icmph = (struct icmp_hdr *)&ip->udp_src;
1072 switch (icmph->type) {
1074 if (icmph->code != ICMP_REDIR_HOST)
1076 printf(" ICMP Host Redirect to %pI4 ",
1077 &icmph->un.gateway);
1080 #if defined(CONFIG_CMD_PING)
1081 ping_receive(et, ip, len);
1083 #ifdef CONFIG_CMD_TFTPPUT
1084 if (packet_icmp_handler)
1085 packet_icmp_handler(icmph->type, icmph->code,
1086 ntohs(ip->udp_dst), src_ip,
1087 ntohs(ip->udp_src), icmph->un.data,
1088 ntohs(ip->udp_len));
1094 void net_process_received_packet(uchar *in_packet, int len)
1096 struct ethernet_hdr *et;
1097 struct ip_udp_hdr *ip;
1098 struct in_addr dst_ip;
1099 struct in_addr src_ip;
1101 #if defined(CONFIG_CMD_CDP)
1104 ushort cti = 0, vlanid = VLAN_NONE, myvlanid, mynvlanid;
1106 debug_cond(DEBUG_NET_PKT, "packet received\n");
1108 #if defined(CONFIG_CMD_PCAP)
1109 pcap_post(in_packet, len, false);
1111 net_rx_packet = in_packet;
1112 net_rx_packet_len = len;
1113 et = (struct ethernet_hdr *)in_packet;
1115 /* too small packet? */
1116 if (len < ETHER_HDR_SIZE)
1119 #if defined(CONFIG_API) || defined(CONFIG_EFI_LOADER)
1121 (*push_packet)(in_packet, len);
1126 #if defined(CONFIG_CMD_CDP)
1127 /* keep track if packet is CDP */
1128 iscdp = is_cdp_packet(et->et_dest);
1131 myvlanid = ntohs(net_our_vlan);
1132 if (myvlanid == (ushort)-1)
1133 myvlanid = VLAN_NONE;
1134 mynvlanid = ntohs(net_native_vlan);
1135 if (mynvlanid == (ushort)-1)
1136 mynvlanid = VLAN_NONE;
1138 eth_proto = ntohs(et->et_protlen);
1140 if (eth_proto < 1514) {
1141 struct e802_hdr *et802 = (struct e802_hdr *)et;
1143 * Got a 802.2 packet. Check the other protocol field.
1144 * XXX VLAN over 802.2+SNAP not implemented!
1146 eth_proto = ntohs(et802->et_prot);
1148 ip = (struct ip_udp_hdr *)(in_packet + E802_HDR_SIZE);
1149 len -= E802_HDR_SIZE;
1151 } else if (eth_proto != PROT_VLAN) { /* normal packet */
1152 ip = (struct ip_udp_hdr *)(in_packet + ETHER_HDR_SIZE);
1153 len -= ETHER_HDR_SIZE;
1155 } else { /* VLAN packet */
1156 struct vlan_ethernet_hdr *vet =
1157 (struct vlan_ethernet_hdr *)et;
1159 debug_cond(DEBUG_NET_PKT, "VLAN packet received\n");
1161 /* too small packet? */
1162 if (len < VLAN_ETHER_HDR_SIZE)
1165 /* if no VLAN active */
1166 if ((ntohs(net_our_vlan) & VLAN_IDMASK) == VLAN_NONE
1167 #if defined(CONFIG_CMD_CDP)
1173 cti = ntohs(vet->vet_tag);
1174 vlanid = cti & VLAN_IDMASK;
1175 eth_proto = ntohs(vet->vet_type);
1177 ip = (struct ip_udp_hdr *)(in_packet + VLAN_ETHER_HDR_SIZE);
1178 len -= VLAN_ETHER_HDR_SIZE;
1181 debug_cond(DEBUG_NET_PKT, "Receive from protocol 0x%x\n", eth_proto);
1183 #if defined(CONFIG_CMD_CDP)
1185 cdp_receive((uchar *)ip, len);
1190 if ((myvlanid & VLAN_IDMASK) != VLAN_NONE) {
1191 if (vlanid == VLAN_NONE)
1192 vlanid = (mynvlanid & VLAN_IDMASK);
1194 if (vlanid != (myvlanid & VLAN_IDMASK))
1198 switch (eth_proto) {
1200 arp_receive(et, ip, len);
1203 #ifdef CONFIG_CMD_RARP
1205 rarp_receive(ip, len);
1209 debug_cond(DEBUG_NET_PKT, "Got IP\n");
1210 /* Before we start poking the header, make sure it is there */
1211 if (len < IP_UDP_HDR_SIZE) {
1212 debug("len bad %d < %lu\n", len,
1213 (ulong)IP_UDP_HDR_SIZE);
1216 /* Check the packet length */
1217 if (len < ntohs(ip->ip_len)) {
1218 debug("len bad %d < %d\n", len, ntohs(ip->ip_len));
1221 len = ntohs(ip->ip_len);
1222 debug_cond(DEBUG_NET_PKT, "len=%d, v=%02x\n",
1223 len, ip->ip_hl_v & 0xff);
1225 /* Can't deal with anything except IPv4 */
1226 if ((ip->ip_hl_v & 0xf0) != 0x40)
1228 /* Can't deal with IP options (headers != 20 bytes) */
1229 if ((ip->ip_hl_v & 0x0f) > 0x05)
1231 /* Check the Checksum of the header */
1232 if (!ip_checksum_ok((uchar *)ip, IP_HDR_SIZE)) {
1233 debug("checksum bad\n");
1236 /* If it is not for us, ignore it */
1237 dst_ip = net_read_ip(&ip->ip_dst);
1238 if (net_ip.s_addr && dst_ip.s_addr != net_ip.s_addr &&
1239 dst_ip.s_addr != 0xFFFFFFFF) {
1242 /* Read source IP address for later use */
1243 src_ip = net_read_ip(&ip->ip_src);
1245 * The function returns the unchanged packet if it's not
1246 * a fragment, and either the complete packet or NULL if
1247 * it is a fragment (if !CONFIG_IP_DEFRAG, it returns NULL)
1249 ip = net_defragment(ip, &len);
1253 * watch for ICMP host redirects
1255 * There is no real handler code (yet). We just watch
1256 * for ICMP host redirect messages. In case anybody
1257 * sees these messages: please contact me
1258 * (wd@denx.de), or - even better - send me the
1259 * necessary fixes :-)
1261 * Note: in all cases where I have seen this so far
1262 * it was a problem with the router configuration,
1263 * for instance when a router was configured in the
1264 * BOOTP reply, but the TFTP server was on the same
1265 * subnet. So this is probably a warning that your
1266 * configuration might be wrong. But I'm not really
1267 * sure if there aren't any other situations.
1269 * Simon Glass <sjg@chromium.org>: We get an ICMP when
1270 * we send a tftp packet to a dead connection, or when
1271 * there is no server at the other end.
1273 if (ip->ip_p == IPPROTO_ICMP) {
1274 receive_icmp(ip, len, src_ip, et);
1276 } else if (ip->ip_p != IPPROTO_UDP) { /* Only UDP packets */
1280 if (ntohs(ip->udp_len) < UDP_HDR_SIZE || ntohs(ip->udp_len) > ntohs(ip->ip_len))
1283 debug_cond(DEBUG_DEV_PKT,
1284 "received UDP (to=%pI4, from=%pI4, len=%d)\n",
1285 &dst_ip, &src_ip, len);
1287 if (IS_ENABLED(CONFIG_UDP_CHECKSUM) && ip->udp_xsum != 0) {
1293 xsum += (ntohs(ip->udp_len));
1294 xsum += (ntohl(ip->ip_src.s_addr) >> 16) & 0x0000ffff;
1295 xsum += (ntohl(ip->ip_src.s_addr) >> 0) & 0x0000ffff;
1296 xsum += (ntohl(ip->ip_dst.s_addr) >> 16) & 0x0000ffff;
1297 xsum += (ntohl(ip->ip_dst.s_addr) >> 0) & 0x0000ffff;
1299 sumlen = ntohs(ip->udp_len);
1300 sumptr = (u8 *)&ip->udp_src;
1302 while (sumlen > 1) {
1303 /* inlined ntohs() to avoid alignment errors */
1304 xsum += (sumptr[0] << 8) + sumptr[1];
1309 xsum += (sumptr[0] << 8) + sumptr[0];
1310 while ((xsum >> 16) != 0) {
1311 xsum = (xsum & 0x0000ffff) +
1312 ((xsum >> 16) & 0x0000ffff);
1314 if ((xsum != 0x00000000) && (xsum != 0x0000ffff)) {
1315 printf(" UDP wrong checksum %08lx %08x\n",
1316 xsum, ntohs(ip->udp_xsum));
1321 #if defined(CONFIG_NETCONSOLE) && !defined(CONFIG_SPL_BUILD)
1322 nc_input_packet((uchar *)ip + IP_UDP_HDR_SIZE,
1326 ntohs(ip->udp_len) - UDP_HDR_SIZE);
1329 * IP header OK. Pass the packet to the current handler.
1331 (*udp_packet_handler)((uchar *)ip + IP_UDP_HDR_SIZE,
1335 ntohs(ip->udp_len) - UDP_HDR_SIZE);
1337 #ifdef CONFIG_CMD_WOL
1339 wol_receive(ip, len);
1342 #ifdef CONFIG_PHY_NCSI
1344 ncsi_receive(et, ip, len);
1350 /**********************************************************************/
1352 static int net_check_prereq(enum proto_t protocol)
1356 #if defined(CONFIG_CMD_PING)
1358 if (net_ping_ip.s_addr == 0) {
1359 puts("*** ERROR: ping address not given\n");
1364 #if defined(CONFIG_CMD_DNS)
1366 if (net_dns_server.s_addr == 0) {
1367 puts("*** ERROR: DNS server address not given\n");
1372 #if defined(CONFIG_PROT_UDP)
1379 #if defined(CONFIG_CMD_NFS)
1385 if (net_server_ip.s_addr == 0 && !is_serverip_in_cmd()) {
1386 puts("*** ERROR: `serverip' not set\n");
1389 #if defined(CONFIG_CMD_PING) || \
1390 defined(CONFIG_CMD_DNS) || defined(CONFIG_PROT_UDP)
1398 if (net_ip.s_addr == 0) {
1399 puts("*** ERROR: `ipaddr' not set\n");
1404 #ifdef CONFIG_CMD_RARP
1407 #ifdef CONFIG_PHY_NCSI
1414 if (memcmp(net_ethaddr, "\0\0\0\0\0\0", 6) == 0) {
1415 int num = eth_get_dev_index();
1419 puts("*** ERROR: No ethernet found.\n");
1422 puts("*** ERROR: `ethaddr' not set\n");
1425 printf("*** ERROR: `eth%daddr' not set\n",
1439 /**********************************************************************/
1442 net_eth_hdr_size(void)
1446 myvlanid = ntohs(net_our_vlan);
1447 if (myvlanid == (ushort)-1)
1448 myvlanid = VLAN_NONE;
1450 return ((myvlanid & VLAN_IDMASK) == VLAN_NONE) ? ETHER_HDR_SIZE :
1451 VLAN_ETHER_HDR_SIZE;
1454 int net_set_ether(uchar *xet, const uchar *dest_ethaddr, uint prot)
1456 struct ethernet_hdr *et = (struct ethernet_hdr *)xet;
1459 myvlanid = ntohs(net_our_vlan);
1460 if (myvlanid == (ushort)-1)
1461 myvlanid = VLAN_NONE;
1463 memcpy(et->et_dest, dest_ethaddr, 6);
1464 memcpy(et->et_src, net_ethaddr, 6);
1465 if ((myvlanid & VLAN_IDMASK) == VLAN_NONE) {
1466 et->et_protlen = htons(prot);
1467 return ETHER_HDR_SIZE;
1469 struct vlan_ethernet_hdr *vet =
1470 (struct vlan_ethernet_hdr *)xet;
1472 vet->vet_vlan_type = htons(PROT_VLAN);
1473 vet->vet_tag = htons((0 << 5) | (myvlanid & VLAN_IDMASK));
1474 vet->vet_type = htons(prot);
1475 return VLAN_ETHER_HDR_SIZE;
1479 int net_update_ether(struct ethernet_hdr *et, uchar *addr, uint prot)
1483 memcpy(et->et_dest, addr, 6);
1484 memcpy(et->et_src, net_ethaddr, 6);
1485 protlen = ntohs(et->et_protlen);
1486 if (protlen == PROT_VLAN) {
1487 struct vlan_ethernet_hdr *vet =
1488 (struct vlan_ethernet_hdr *)et;
1489 vet->vet_type = htons(prot);
1490 return VLAN_ETHER_HDR_SIZE;
1491 } else if (protlen > 1514) {
1492 et->et_protlen = htons(prot);
1493 return ETHER_HDR_SIZE;
1496 struct e802_hdr *et802 = (struct e802_hdr *)et;
1497 et802->et_prot = htons(prot);
1498 return E802_HDR_SIZE;
1502 void net_set_ip_header(uchar *pkt, struct in_addr dest, struct in_addr source,
1503 u16 pkt_len, u8 proto)
1505 struct ip_udp_hdr *ip = (struct ip_udp_hdr *)pkt;
1508 * Construct an IP header.
1510 /* IP_HDR_SIZE / 4 (not including UDP) */
1513 ip->ip_len = htons(pkt_len);
1515 ip->ip_id = htons(net_ip_id++);
1516 ip->ip_off = htons(IP_FLAGS_DFRAG); /* Don't fragment */
1519 /* already in network byte order */
1520 net_copy_ip((void *)&ip->ip_src, &source);
1521 /* already in network byte order */
1522 net_copy_ip((void *)&ip->ip_dst, &dest);
1524 ip->ip_sum = compute_ip_checksum(ip, IP_HDR_SIZE);
1527 void net_set_udp_header(uchar *pkt, struct in_addr dest, int dport, int sport,
1530 struct ip_udp_hdr *ip = (struct ip_udp_hdr *)pkt;
1533 * If the data is an odd number of bytes, zero the
1534 * byte after the last byte so that the checksum
1538 pkt[IP_UDP_HDR_SIZE + len] = 0;
1540 net_set_ip_header(pkt, dest, net_ip, IP_UDP_HDR_SIZE + len,
1543 ip->udp_src = htons(sport);
1544 ip->udp_dst = htons(dport);
1545 ip->udp_len = htons(UDP_HDR_SIZE + len);
1549 void copy_filename(char *dst, const char *src, int size)
1551 if (src && *src && (*src == '"')) {
1556 while ((--size > 0) && src && *src && (*src != '"'))
1561 int is_serverip_in_cmd(void)
1563 return !!strchr(net_boot_file_name, ':');
1566 int net_parse_bootfile(struct in_addr *ipaddr, char *filename, int max_len)
1572 if (net_boot_file_name[0] == '\0')
1575 colon = strchr(net_boot_file_name, ':');
1577 ip = string_to_ip(net_boot_file_name);
1578 if (ipaddr && ip.s_addr)
1582 strncpy(filename, colon + 1, max_len);
1584 strncpy(filename, net_boot_file_name, max_len);
1586 filename[max_len - 1] = '\0';
1591 void ip_to_string(struct in_addr x, char *s)
1593 x.s_addr = ntohl(x.s_addr);
1594 sprintf(s, "%d.%d.%d.%d",
1595 (int) ((x.s_addr >> 24) & 0xff),
1596 (int) ((x.s_addr >> 16) & 0xff),
1597 (int) ((x.s_addr >> 8) & 0xff),
1598 (int) ((x.s_addr >> 0) & 0xff)
1602 void vlan_to_string(ushort x, char *s)
1606 if (x == (ushort)-1)
1612 sprintf(s, "%d", x & VLAN_IDMASK);
1615 ushort string_to_vlan(const char *s)
1620 return htons(VLAN_NONE);
1622 if (*s < '0' || *s > '9')
1625 id = (ushort)dectoul(s, NULL);
1630 ushort env_get_vlan(char *var)
1632 return string_to_vlan(env_get(var));