xref: /openbmc/u-boot/include/net.h (revision c916075f)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  *	LiMon Monitor (LiMon) - Network.
4  *
5  *	Copyright 1994 - 2000 Neil Russell.
6  *	(See License)
7  *
8  * History
9  *	9/16/00	  bor  adapted to TQM823L/STK8xxL board, RARP/TFTP boot added
10  */
11 
12 #ifndef __NET_H__
13 #define __NET_H__
14 
15 #include <asm/cache.h>
16 #include <asm/byteorder.h>	/* for nton* / ntoh* stuff */
17 #include <linux/if_ether.h>
18 
19 #define DEBUG_LL_STATE 0	/* Link local state machine changes */
20 #define DEBUG_DEV_PKT 0		/* Packets or info directed to the device */
21 #define DEBUG_NET_PKT 0		/* Packets on info on the network at large */
22 #define DEBUG_INT_STATE 0	/* Internal network state changes */
23 
24 /*
25  *	The number of receive packet buffers, and the required packet buffer
26  *	alignment in memory.
27  *
28  */
29 
30 #ifdef CONFIG_SYS_RX_ETH_BUFFER
31 # define PKTBUFSRX	CONFIG_SYS_RX_ETH_BUFFER
32 #else
33 # define PKTBUFSRX	4
34 #endif
35 
36 #define PKTALIGN	ARCH_DMA_MINALIGN
37 
38 /* ARP hardware address length */
39 #define ARP_HLEN 6
40 /*
41  * The size of a MAC address in string form, each digit requires two chars
42  * and five separator characters to form '00:00:00:00:00:00'.
43  */
44 #define ARP_HLEN_ASCII (ARP_HLEN * 2) + (ARP_HLEN - 1)
45 
46 /* IPv4 addresses are always 32 bits in size */
47 struct in_addr {
48 	__be32 s_addr;
49 };
50 
51 /**
52  * An incoming packet handler.
53  * @param pkt    pointer to the application packet
54  * @param dport  destination UDP port
55  * @param sip    source IP address
56  * @param sport  source UDP port
57  * @param len    packet length
58  */
59 typedef void rxhand_f(uchar *pkt, unsigned dport,
60 		      struct in_addr sip, unsigned sport,
61 		      unsigned len);
62 
63 /**
64  * An incoming ICMP packet handler.
65  * @param type	ICMP type
66  * @param code	ICMP code
67  * @param dport	destination UDP port
68  * @param sip	source IP address
69  * @param sport	source UDP port
70  * @param pkt	pointer to the ICMP packet data
71  * @param len	packet length
72  */
73 typedef void rxhand_icmp_f(unsigned type, unsigned code, unsigned dport,
74 		struct in_addr sip, unsigned sport, uchar *pkt, unsigned len);
75 
76 /*
77  *	A timeout handler.  Called after time interval has expired.
78  */
79 typedef void	thand_f(void);
80 
81 enum eth_state_t {
82 	ETH_STATE_INIT,
83 	ETH_STATE_PASSIVE,
84 	ETH_STATE_ACTIVE
85 };
86 
87 #ifdef CONFIG_DM_ETH
88 /**
89  * struct eth_pdata - Platform data for Ethernet MAC controllers
90  *
91  * @iobase: The base address of the hardware registers
92  * @enetaddr: The Ethernet MAC address that is loaded from EEPROM or env
93  * @phy_interface: PHY interface to use - see PHY_INTERFACE_MODE_...
94  * @max_speed: Maximum speed of Ethernet connection supported by MAC
95  */
96 struct eth_pdata {
97 	phys_addr_t iobase;
98 	unsigned char enetaddr[ARP_HLEN];
99 	int phy_interface;
100 	int max_speed;
101 };
102 
103 enum eth_recv_flags {
104 	/*
105 	 * Check hardware device for new packets (otherwise only return those
106 	 * which are already in the memory buffer ready to process)
107 	 */
108 	ETH_RECV_CHECK_DEVICE		= 1 << 0,
109 };
110 
111 /**
112  * struct eth_ops - functions of Ethernet MAC controllers
113  *
114  * start: Prepare the hardware to send and receive packets
115  * send: Send the bytes passed in "packet" as a packet on the wire
116  * recv: Check if the hardware received a packet. If so, set the pointer to the
117  *	 packet buffer in the packetp parameter. If not, return an error or 0 to
118  *	 indicate that the hardware receive FIFO is empty. If 0 is returned, the
119  *	 network stack will not process the empty packet, but free_pkt() will be
120  *	 called if supplied
121  * free_pkt: Give the driver an opportunity to manage its packet buffer memory
122  *	     when the network stack is finished processing it. This will only be
123  *	     called when no error was returned from recv - optional
124  * stop: Stop the hardware from looking for packets - may be called even if
125  *	 state == PASSIVE
126  * mcast: Join or leave a multicast group (for TFTP) - optional
127  * write_hwaddr: Write a MAC address to the hardware (used to pass it to Linux
128  *		 on some platforms like ARM). This function expects the
129  *		 eth_pdata::enetaddr field to be populated. The method can
130  *		 return -ENOSYS to indicate that this is not implemented for
131 		 this hardware - optional.
132  * read_rom_hwaddr: Some devices have a backup of the MAC address stored in a
133  *		    ROM on the board. This is how the driver should expose it
134  *		    to the network stack. This function should fill in the
135  *		    eth_pdata::enetaddr field - optional
136  */
137 struct eth_ops {
138 	int (*start)(struct udevice *dev);
139 	int (*send)(struct udevice *dev, void *packet, int length);
140 	int (*recv)(struct udevice *dev, int flags, uchar **packetp);
141 	int (*free_pkt)(struct udevice *dev, uchar *packet, int length);
142 	void (*stop)(struct udevice *dev);
143 	int (*mcast)(struct udevice *dev, const u8 *enetaddr, int join);
144 	int (*write_hwaddr)(struct udevice *dev);
145 	int (*read_rom_hwaddr)(struct udevice *dev);
146 };
147 
148 #define eth_get_ops(dev) ((struct eth_ops *)(dev)->driver->ops)
149 
150 struct udevice *eth_get_dev(void); /* get the current device */
151 /*
152  * The devname can be either an exact name given by the driver or device tree
153  * or it can be an alias of the form "eth%d"
154  */
155 struct udevice *eth_get_dev_by_name(const char *devname);
156 unsigned char *eth_get_ethaddr(void); /* get the current device MAC */
157 
158 /* Used only when NetConsole is enabled */
159 int eth_is_active(struct udevice *dev); /* Test device for active state */
160 int eth_init_state_only(void); /* Set active state */
161 void eth_halt_state_only(void); /* Set passive state */
162 #endif
163 
164 #ifndef CONFIG_DM_ETH
165 struct eth_device {
166 #define ETH_NAME_LEN 20
167 	char name[ETH_NAME_LEN];
168 	unsigned char enetaddr[ARP_HLEN];
169 	phys_addr_t iobase;
170 	int state;
171 
172 	int (*init)(struct eth_device *, bd_t *);
173 	int (*send)(struct eth_device *, void *packet, int length);
174 	int (*recv)(struct eth_device *);
175 	void (*halt)(struct eth_device *);
176 	int (*mcast)(struct eth_device *, const u8 *enetaddr, int join);
177 	int (*write_hwaddr)(struct eth_device *);
178 	struct eth_device *next;
179 	int index;
180 	void *priv;
181 };
182 
183 int eth_register(struct eth_device *dev);/* Register network device */
184 int eth_unregister(struct eth_device *dev);/* Remove network device */
185 
186 extern struct eth_device *eth_current;
187 
188 static __always_inline struct eth_device *eth_get_dev(void)
189 {
190 	return eth_current;
191 }
192 struct eth_device *eth_get_dev_by_name(const char *devname);
193 struct eth_device *eth_get_dev_by_index(int index); /* get dev @ index */
194 
195 /* get the current device MAC */
196 static inline unsigned char *eth_get_ethaddr(void)
197 {
198 	if (eth_current)
199 		return eth_current->enetaddr;
200 	return NULL;
201 }
202 
203 /* Used only when NetConsole is enabled */
204 int eth_is_active(struct eth_device *dev); /* Test device for active state */
205 /* Set active state */
206 static __always_inline int eth_init_state_only(void)
207 {
208 	eth_get_dev()->state = ETH_STATE_ACTIVE;
209 
210 	return 0;
211 }
212 /* Set passive state */
213 static __always_inline void eth_halt_state_only(void)
214 {
215 	eth_get_dev()->state = ETH_STATE_PASSIVE;
216 }
217 
218 /*
219  * Set the hardware address for an ethernet interface based on 'eth%daddr'
220  * environment variable (or just 'ethaddr' if eth_number is 0).
221  * Args:
222  *	base_name - base name for device (normally "eth")
223  *	eth_number - value of %d (0 for first device of this type)
224  * Returns:
225  *	0 is success, non-zero is error status from driver.
226  */
227 int eth_write_hwaddr(struct eth_device *dev, const char *base_name,
228 		     int eth_number);
229 
230 int usb_eth_initialize(bd_t *bi);
231 #endif
232 
233 int eth_initialize(void);		/* Initialize network subsystem */
234 void eth_try_another(int first_restart);	/* Change the device */
235 void eth_set_current(void);		/* set nterface to ethcur var */
236 
237 int eth_get_dev_index(void);		/* get the device index */
238 
239 /**
240  * eth_env_set_enetaddr_by_index() - set the MAC address environment variable
241  *
242  * This sets up an environment variable with the given MAC address (@enetaddr).
243  * The environment variable to be set is defined by <@base_name><@index>addr.
244  * If @index is 0 it is omitted. For common Ethernet this means ethaddr,
245  * eth1addr, etc.
246  *
247  * @base_name:  Base name for variable, typically "eth"
248  * @index:      Index of interface being updated (>=0)
249  * @enetaddr:   Pointer to MAC address to put into the variable
250  * @return 0 if OK, other value on error
251  */
252 int eth_env_set_enetaddr_by_index(const char *base_name, int index,
253 				 uchar *enetaddr);
254 
255 
256 /*
257  * Initialize USB ethernet device with CONFIG_DM_ETH
258  * Returns:
259  *	0 is success, non-zero is error status.
260  */
261 int usb_ether_init(void);
262 
263 /*
264  * Get the hardware address for an ethernet interface .
265  * Args:
266  *	base_name - base name for device (normally "eth")
267  *	index - device index number (0 for first)
268  *	enetaddr - returns 6 byte hardware address
269  * Returns:
270  *	Return true if the address is valid.
271  */
272 int eth_env_get_enetaddr_by_index(const char *base_name, int index,
273 				 uchar *enetaddr);
274 
275 int eth_init(void);			/* Initialize the device */
276 int eth_send(void *packet, int length);	   /* Send a packet */
277 
278 #if defined(CONFIG_API) || defined(CONFIG_EFI_LOADER)
279 int eth_receive(void *packet, int length); /* Receive a packet*/
280 extern void (*push_packet)(void *packet, int length);
281 #endif
282 int eth_rx(void);			/* Check for received packets */
283 void eth_halt(void);			/* stop SCC */
284 const char *eth_get_name(void);		/* get name of current device */
285 int eth_mcast_join(struct in_addr mcast_addr, int join);
286 
287 /**********************************************************************/
288 /*
289  *	Protocol headers.
290  */
291 
292 /*
293  *	Ethernet header
294  */
295 
296 struct ethernet_hdr {
297 	u8		et_dest[ARP_HLEN];	/* Destination node	*/
298 	u8		et_src[ARP_HLEN];	/* Source node		*/
299 	u16		et_protlen;		/* Protocol or length	*/
300 } __attribute__((packed));
301 
302 /* Ethernet header size */
303 #define ETHER_HDR_SIZE	(sizeof(struct ethernet_hdr))
304 
305 #define ETH_FCS_LEN	4		/* Octets in the FCS		*/
306 
307 struct e802_hdr {
308 	u8		et_dest[ARP_HLEN];	/* Destination node	*/
309 	u8		et_src[ARP_HLEN];	/* Source node		*/
310 	u16		et_protlen;		/* Protocol or length	*/
311 	u8		et_dsap;		/* 802 DSAP		*/
312 	u8		et_ssap;		/* 802 SSAP		*/
313 	u8		et_ctl;			/* 802 control		*/
314 	u8		et_snap1;		/* SNAP			*/
315 	u8		et_snap2;
316 	u8		et_snap3;
317 	u16		et_prot;		/* 802 protocol		*/
318 } __attribute__((packed));
319 
320 /* 802 + SNAP + ethernet header size */
321 #define E802_HDR_SIZE	(sizeof(struct e802_hdr))
322 
323 /*
324  *	Virtual LAN Ethernet header
325  */
326 struct vlan_ethernet_hdr {
327 	u8		vet_dest[ARP_HLEN];	/* Destination node	*/
328 	u8		vet_src[ARP_HLEN];	/* Source node		*/
329 	u16		vet_vlan_type;		/* PROT_VLAN		*/
330 	u16		vet_tag;		/* TAG of VLAN		*/
331 	u16		vet_type;		/* protocol type	*/
332 } __attribute__((packed));
333 
334 /* VLAN Ethernet header size */
335 #define VLAN_ETHER_HDR_SIZE	(sizeof(struct vlan_ethernet_hdr))
336 
337 #define PROT_IP		0x0800		/* IP protocol			*/
338 #define PROT_ARP	0x0806		/* IP ARP protocol		*/
339 #define PROT_WOL	0x0842		/* ether-wake WoL protocol	*/
340 #define PROT_RARP	0x8035		/* IP ARP protocol		*/
341 #define PROT_VLAN	0x8100		/* IEEE 802.1q protocol		*/
342 #define PROT_IPV6	0x86dd		/* IPv6 over bluebook		*/
343 #define PROT_PPP_SES	0x8864		/* PPPoE session messages	*/
344 #define PROT_NCSI	0x88f8		/* NC-SI control packets        */
345 
346 #define IPPROTO_ICMP	 1	/* Internet Control Message Protocol	*/
347 #define IPPROTO_UDP	17	/* User Datagram Protocol		*/
348 
349 /*
350  *	Internet Protocol (IP) header.
351  */
352 struct ip_hdr {
353 	u8		ip_hl_v;	/* header length and version	*/
354 	u8		ip_tos;		/* type of service		*/
355 	u16		ip_len;		/* total length			*/
356 	u16		ip_id;		/* identification		*/
357 	u16		ip_off;		/* fragment offset field	*/
358 	u8		ip_ttl;		/* time to live			*/
359 	u8		ip_p;		/* protocol			*/
360 	u16		ip_sum;		/* checksum			*/
361 	struct in_addr	ip_src;		/* Source IP address		*/
362 	struct in_addr	ip_dst;		/* Destination IP address	*/
363 } __attribute__((packed));
364 
365 #define IP_OFFS		0x1fff /* ip offset *= 8 */
366 #define IP_FLAGS	0xe000 /* first 3 bits */
367 #define IP_FLAGS_RES	0x8000 /* reserved */
368 #define IP_FLAGS_DFRAG	0x4000 /* don't fragments */
369 #define IP_FLAGS_MFRAG	0x2000 /* more fragments */
370 
371 #define IP_HDR_SIZE		(sizeof(struct ip_hdr))
372 
373 /*
374  *	Internet Protocol (IP) + UDP header.
375  */
376 struct ip_udp_hdr {
377 	u8		ip_hl_v;	/* header length and version	*/
378 	u8		ip_tos;		/* type of service		*/
379 	u16		ip_len;		/* total length			*/
380 	u16		ip_id;		/* identification		*/
381 	u16		ip_off;		/* fragment offset field	*/
382 	u8		ip_ttl;		/* time to live			*/
383 	u8		ip_p;		/* protocol			*/
384 	u16		ip_sum;		/* checksum			*/
385 	struct in_addr	ip_src;		/* Source IP address		*/
386 	struct in_addr	ip_dst;		/* Destination IP address	*/
387 	u16		udp_src;	/* UDP source port		*/
388 	u16		udp_dst;	/* UDP destination port		*/
389 	u16		udp_len;	/* Length of UDP packet		*/
390 	u16		udp_xsum;	/* Checksum			*/
391 } __attribute__((packed));
392 
393 #define IP_UDP_HDR_SIZE		(sizeof(struct ip_udp_hdr))
394 #define UDP_HDR_SIZE		(IP_UDP_HDR_SIZE - IP_HDR_SIZE)
395 
396 /*
397  *	Address Resolution Protocol (ARP) header.
398  */
399 struct arp_hdr {
400 	u16		ar_hrd;		/* Format of hardware address	*/
401 #   define ARP_ETHER	    1		/* Ethernet  hardware address	*/
402 	u16		ar_pro;		/* Format of protocol address	*/
403 	u8		ar_hln;		/* Length of hardware address	*/
404 	u8		ar_pln;		/* Length of protocol address	*/
405 #   define ARP_PLEN	4
406 	u16		ar_op;		/* Operation			*/
407 #   define ARPOP_REQUEST    1		/* Request  to resolve  address	*/
408 #   define ARPOP_REPLY	    2		/* Response to previous request	*/
409 
410 #   define RARPOP_REQUEST   3		/* Request  to resolve  address	*/
411 #   define RARPOP_REPLY	    4		/* Response to previous request */
412 
413 	/*
414 	 * The remaining fields are variable in size, according to
415 	 * the sizes above, and are defined as appropriate for
416 	 * specific hardware/protocol combinations.
417 	 */
418 	u8		ar_data[0];
419 #define ar_sha		ar_data[0]
420 #define ar_spa		ar_data[ARP_HLEN]
421 #define ar_tha		ar_data[ARP_HLEN + ARP_PLEN]
422 #define ar_tpa		ar_data[ARP_HLEN + ARP_PLEN + ARP_HLEN]
423 #if 0
424 	u8		ar_sha[];	/* Sender hardware address	*/
425 	u8		ar_spa[];	/* Sender protocol address	*/
426 	u8		ar_tha[];	/* Target hardware address	*/
427 	u8		ar_tpa[];	/* Target protocol address	*/
428 #endif /* 0 */
429 } __attribute__((packed));
430 
431 #define ARP_HDR_SIZE	(8+20)		/* Size assuming ethernet	*/
432 
433 /*
434  * ICMP stuff (just enough to handle (host) redirect messages)
435  */
436 #define ICMP_ECHO_REPLY		0	/* Echo reply			*/
437 #define ICMP_NOT_REACH		3	/* Detination unreachable	*/
438 #define ICMP_REDIRECT		5	/* Redirect (change route)	*/
439 #define ICMP_ECHO_REQUEST	8	/* Echo request			*/
440 
441 /* Codes for REDIRECT. */
442 #define ICMP_REDIR_NET		0	/* Redirect Net			*/
443 #define ICMP_REDIR_HOST		1	/* Redirect Host		*/
444 
445 /* Codes for NOT_REACH */
446 #define ICMP_NOT_REACH_PORT	3	/* Port unreachable		*/
447 
448 struct icmp_hdr {
449 	u8		type;
450 	u8		code;
451 	u16		checksum;
452 	union {
453 		struct {
454 			u16	id;
455 			u16	sequence;
456 		} echo;
457 		u32	gateway;
458 		struct {
459 			u16	unused;
460 			u16	mtu;
461 		} frag;
462 		u8 data[0];
463 	} un;
464 } __attribute__((packed));
465 
466 #define ICMP_HDR_SIZE		(sizeof(struct icmp_hdr))
467 #define IP_ICMP_HDR_SIZE	(IP_HDR_SIZE + ICMP_HDR_SIZE)
468 
469 /*
470  * Maximum packet size; used to allocate packet storage. Use
471  * the maxium Ethernet frame size as specified by the Ethernet
472  * standard including the 802.1Q tag (VLAN tagging).
473  * maximum packet size =  1522
474  * maximum packet size and multiple of 32 bytes =  1536
475  */
476 #define PKTSIZE			1522
477 #define PKTSIZE_ALIGN		1536
478 
479 /*
480  * Maximum receive ring size; that is, the number of packets
481  * we can buffer before overflow happens. Basically, this just
482  * needs to be enough to prevent a packet being discarded while
483  * we are processing the previous one.
484  */
485 #define RINGSZ		4
486 #define RINGSZ_LOG2	2
487 
488 /**********************************************************************/
489 /*
490  *	Globals.
491  *
492  * Note:
493  *
494  * All variables of type struct in_addr are stored in NETWORK byte order
495  * (big endian).
496  */
497 
498 /* net.c */
499 /** BOOTP EXTENTIONS **/
500 extern struct in_addr net_gateway;	/* Our gateway IP address */
501 extern struct in_addr net_netmask;	/* Our subnet mask (0 = unknown) */
502 /* Our Domain Name Server (0 = unknown) */
503 extern struct in_addr net_dns_server;
504 #if defined(CONFIG_BOOTP_DNS2)
505 /* Our 2nd Domain Name Server (0 = unknown) */
506 extern struct in_addr net_dns_server2;
507 #endif
508 extern char	net_nis_domain[32];	/* Our IS domain */
509 extern char	net_hostname[32];	/* Our hostname */
510 extern char	net_root_path[64];	/* Our root path */
511 /** END OF BOOTP EXTENTIONS **/
512 extern u8		net_ethaddr[ARP_HLEN];		/* Our ethernet address */
513 extern u8		net_server_ethaddr[ARP_HLEN];	/* Boot server enet address */
514 extern struct in_addr	net_ip;		/* Our    IP addr (0 = unknown) */
515 extern struct in_addr	net_server_ip;	/* Server IP addr (0 = unknown) */
516 extern uchar		*net_tx_packet;		/* THE transmit packet */
517 extern uchar		*net_rx_packets[PKTBUFSRX]; /* Receive packets */
518 extern uchar		*net_rx_packet;		/* Current receive packet */
519 extern int		net_rx_packet_len;	/* Current rx packet length */
520 extern const u8		net_bcast_ethaddr[ARP_HLEN];	/* Ethernet broadcast address */
521 extern const u8		net_null_ethaddr[ARP_HLEN];
522 
523 #define VLAN_NONE	4095			/* untagged */
524 #define VLAN_IDMASK	0x0fff			/* mask of valid vlan id */
525 extern ushort		net_our_vlan;		/* Our VLAN */
526 extern ushort		net_native_vlan;	/* Our Native VLAN */
527 
528 extern int		net_restart_wrap;	/* Tried all network devices */
529 
530 enum proto_t {
531 	BOOTP, RARP, ARP, TFTPGET, DHCP, PING, DNS, NFS, CDP, NETCONS, SNTP,
532 	TFTPSRV, TFTPPUT, LINKLOCAL, FASTBOOT, WOL, NCSI
533 };
534 
535 extern char	net_boot_file_name[1024];/* Boot File name */
536 /* Indicates whether the file name was specified on the command line */
537 extern bool	net_boot_file_name_explicit;
538 /* The actual transferred size of the bootfile (in bytes) */
539 extern u32	net_boot_file_size;
540 /* Boot file size in blocks as reported by the DHCP server */
541 extern u32	net_boot_file_expected_size_in_blocks;
542 
543 #if defined(CONFIG_CMD_DNS)
544 extern char *net_dns_resolve;		/* The host to resolve  */
545 extern char *net_dns_env_var;		/* the env var to put the ip into */
546 #endif
547 
548 #if defined(CONFIG_CMD_PING)
549 extern struct in_addr net_ping_ip;	/* the ip address to ping */
550 #endif
551 
552 #if defined(CONFIG_CMD_CDP)
553 /* when CDP completes these hold the return values */
554 extern ushort cdp_native_vlan;		/* CDP returned native VLAN */
555 extern ushort cdp_appliance_vlan;	/* CDP returned appliance VLAN */
556 
557 /*
558  * Check for a CDP packet by examining the received MAC address field
559  */
560 static inline int is_cdp_packet(const uchar *ethaddr)
561 {
562 	extern const u8 net_cdp_ethaddr[ARP_HLEN];
563 
564 	return memcmp(ethaddr, net_cdp_ethaddr, ARP_HLEN) == 0;
565 }
566 #endif
567 
568 #if defined(CONFIG_CMD_SNTP)
569 extern struct in_addr	net_ntp_server;		/* the ip address to NTP */
570 extern int net_ntp_time_offset;			/* offset time from UTC */
571 #endif
572 
573 /* Initialize the network adapter */
574 void net_init(void);
575 int net_loop(enum proto_t);
576 
577 /* Load failed.	 Start again. */
578 int net_start_again(void);
579 
580 /* Get size of the ethernet header when we send */
581 int net_eth_hdr_size(void);
582 
583 /* Set ethernet header; returns the size of the header */
584 int net_set_ether(uchar *xet, const uchar *dest_ethaddr, uint prot);
585 int net_update_ether(struct ethernet_hdr *et, uchar *addr, uint prot);
586 
587 /* Set IP header */
588 void net_set_ip_header(uchar *pkt, struct in_addr dest, struct in_addr source,
589 		       u16 pkt_len, u8 proto);
590 void net_set_udp_header(uchar *pkt, struct in_addr dest, int dport,
591 				int sport, int len);
592 
593 /**
594  * compute_ip_checksum() - Compute IP checksum
595  *
596  * @addr:	Address to check (must be 16-bit aligned)
597  * @nbytes:	Number of bytes to check (normally a multiple of 2)
598  * @return 16-bit IP checksum
599  */
600 unsigned compute_ip_checksum(const void *addr, unsigned nbytes);
601 
602 /**
603  * add_ip_checksums() - add two IP checksums
604  *
605  * @offset:	Offset of first sum (if odd we do a byte-swap)
606  * @sum:	First checksum
607  * @new_sum:	New checksum to add
608  * @return updated 16-bit IP checksum
609  */
610 unsigned add_ip_checksums(unsigned offset, unsigned sum, unsigned new_sum);
611 
612 /**
613  * ip_checksum_ok() - check if a checksum is correct
614  *
615  * This works by making sure the checksum sums to 0
616  *
617  * @addr:	Address to check (must be 16-bit aligned)
618  * @nbytes:	Number of bytes to check (normally a multiple of 2)
619  * @return true if the checksum matches, false if not
620  */
621 int ip_checksum_ok(const void *addr, unsigned nbytes);
622 
623 /* Callbacks */
624 rxhand_f *net_get_udp_handler(void);	/* Get UDP RX packet handler */
625 void net_set_udp_handler(rxhand_f *);	/* Set UDP RX packet handler */
626 rxhand_f *net_get_arp_handler(void);	/* Get ARP RX packet handler */
627 void net_set_arp_handler(rxhand_f *);	/* Set ARP RX packet handler */
628 bool arp_is_waiting(void);		/* Waiting for ARP reply? */
629 void net_set_icmp_handler(rxhand_icmp_f *f); /* Set ICMP RX handler */
630 void net_set_timeout_handler(ulong, thand_f *);/* Set timeout handler */
631 
632 /* Network loop state */
633 enum net_loop_state {
634 	NETLOOP_CONTINUE,
635 	NETLOOP_RESTART,
636 	NETLOOP_SUCCESS,
637 	NETLOOP_FAIL
638 };
639 extern enum net_loop_state net_state;
640 
641 static inline void net_set_state(enum net_loop_state state)
642 {
643 	debug_cond(DEBUG_INT_STATE, "--- NetState set to %d\n", state);
644 	net_state = state;
645 }
646 
647 /*
648  * net_get_async_tx_pkt_buf - Get a packet buffer that is not in use for
649  *			      sending an asynchronous reply
650  *
651  * returns - ptr to packet buffer
652  */
653 uchar * net_get_async_tx_pkt_buf(void);
654 
655 /* Transmit a packet */
656 static inline void net_send_packet(uchar *pkt, int len)
657 {
658 	/* Currently no way to return errors from eth_send() */
659 	(void) eth_send(pkt, len);
660 }
661 
662 /*
663  * Transmit "net_tx_packet" as UDP packet, performing ARP request if needed
664  *  (ether will be populated)
665  *
666  * @param ether Raw packet buffer
667  * @param dest IP address to send the datagram to
668  * @param dport Destination UDP port
669  * @param sport Source UDP port
670  * @param payload_len Length of data after the UDP header
671  */
672 int net_send_ip_packet(uchar *ether, struct in_addr dest, int dport, int sport,
673 		       int payload_len, int proto, u8 action, u32 tcp_seq_num,
674 		       u32 tcp_ack_num);
675 int net_send_udp_packet(uchar *ether, struct in_addr dest, int dport,
676 			int sport, int payload_len);
677 
678 /* Processes a received packet */
679 void net_process_received_packet(uchar *in_packet, int len);
680 
681 #if defined(CONFIG_NETCONSOLE) && !defined(CONFIG_SPL_BUILD)
682 void nc_start(void);
683 int nc_input_packet(uchar *pkt, struct in_addr src_ip, unsigned dest_port,
684 	unsigned src_port, unsigned len);
685 #endif
686 
687 static __always_inline int eth_is_on_demand_init(void)
688 {
689 #if defined(CONFIG_NETCONSOLE) && !defined(CONFIG_SPL_BUILD)
690 	extern enum proto_t net_loop_last_protocol;
691 
692 	return net_loop_last_protocol != NETCONS;
693 #else
694 	return 1;
695 #endif
696 }
697 
698 static inline void eth_set_last_protocol(int protocol)
699 {
700 #if defined(CONFIG_NETCONSOLE) && !defined(CONFIG_SPL_BUILD)
701 	extern enum proto_t net_loop_last_protocol;
702 
703 	net_loop_last_protocol = protocol;
704 #endif
705 }
706 
707 /*
708  * Check if autoload is enabled. If so, use either NFS or TFTP to download
709  * the boot file.
710  */
711 void net_auto_load(void);
712 
713 /*
714  * The following functions are a bit ugly, but necessary to deal with
715  * alignment restrictions on ARM.
716  *
717  * We're using inline functions, which had the smallest memory
718  * footprint in our tests.
719  */
720 /* return IP *in network byteorder* */
721 static inline struct in_addr net_read_ip(void *from)
722 {
723 	struct in_addr ip;
724 
725 	memcpy((void *)&ip, (void *)from, sizeof(ip));
726 	return ip;
727 }
728 
729 /* return ulong *in network byteorder* */
730 static inline u32 net_read_u32(u32 *from)
731 {
732 	u32 l;
733 
734 	memcpy((void *)&l, (void *)from, sizeof(l));
735 	return l;
736 }
737 
738 /* write IP *in network byteorder* */
739 static inline void net_write_ip(void *to, struct in_addr ip)
740 {
741 	memcpy(to, (void *)&ip, sizeof(ip));
742 }
743 
744 /* copy IP */
745 static inline void net_copy_ip(void *to, void *from)
746 {
747 	memcpy((void *)to, from, sizeof(struct in_addr));
748 }
749 
750 /* copy ulong */
751 static inline void net_copy_u32(u32 *to, u32 *from)
752 {
753 	memcpy((void *)to, (void *)from, sizeof(u32));
754 }
755 
756 /**
757  * is_zero_ethaddr - Determine if give Ethernet address is all zeros.
758  * @addr: Pointer to a six-byte array containing the Ethernet address
759  *
760  * Return true if the address is all zeroes.
761  */
762 static inline int is_zero_ethaddr(const u8 *addr)
763 {
764 	return !(addr[0] | addr[1] | addr[2] | addr[3] | addr[4] | addr[5]);
765 }
766 
767 /**
768  * is_multicast_ethaddr - Determine if the Ethernet address is a multicast.
769  * @addr: Pointer to a six-byte array containing the Ethernet address
770  *
771  * Return true if the address is a multicast address.
772  * By definition the broadcast address is also a multicast address.
773  */
774 static inline int is_multicast_ethaddr(const u8 *addr)
775 {
776 	return 0x01 & addr[0];
777 }
778 
779 /*
780  * is_broadcast_ethaddr - Determine if the Ethernet address is broadcast
781  * @addr: Pointer to a six-byte array containing the Ethernet address
782  *
783  * Return true if the address is the broadcast address.
784  */
785 static inline int is_broadcast_ethaddr(const u8 *addr)
786 {
787 	return (addr[0] & addr[1] & addr[2] & addr[3] & addr[4] & addr[5]) ==
788 		0xff;
789 }
790 
791 /*
792  * is_valid_ethaddr - Determine if the given Ethernet address is valid
793  * @addr: Pointer to a six-byte array containing the Ethernet address
794  *
795  * Check that the Ethernet address (MAC) is not 00:00:00:00:00:00, is not
796  * a multicast address, and is not FF:FF:FF:FF:FF:FF.
797  *
798  * Return true if the address is valid.
799  */
800 static inline int is_valid_ethaddr(const u8 *addr)
801 {
802 	/* FF:FF:FF:FF:FF:FF is a multicast address so we don't need to
803 	 * explicitly check for it here. */
804 	return !is_multicast_ethaddr(addr) && !is_zero_ethaddr(addr);
805 }
806 
807 /**
808  * net_random_ethaddr - Generate software assigned random Ethernet address
809  * @addr: Pointer to a six-byte array containing the Ethernet address
810  *
811  * Generate a random Ethernet address (MAC) that is not multicast
812  * and has the local assigned bit set.
813  */
814 static inline void net_random_ethaddr(uchar *addr)
815 {
816 	int i;
817 	unsigned int seed = get_timer(0);
818 
819 	for (i = 0; i < 6; i++)
820 		addr[i] = rand_r(&seed);
821 
822 	addr[0] &= 0xfe;	/* clear multicast bit */
823 	addr[0] |= 0x02;	/* set local assignment bit (IEEE802) */
824 }
825 
826 /* Convert an IP address to a string */
827 void ip_to_string(struct in_addr x, char *s);
828 
829 /* Convert a string to ip address */
830 struct in_addr string_to_ip(const char *s);
831 
832 /* Convert a VLAN id to a string */
833 void vlan_to_string(ushort x, char *s);
834 
835 /* Convert a string to a vlan id */
836 ushort string_to_vlan(const char *s);
837 
838 /* read a VLAN id from an environment variable */
839 ushort env_get_vlan(char *);
840 
841 /* copy a filename (allow for "..." notation, limit length) */
842 void copy_filename(char *dst, const char *src, int size);
843 
844 /* check if serverip is specified in filename from the command line */
845 int is_serverip_in_cmd(void);
846 
847 /**
848  * net_parse_bootfile - Parse the bootfile env var / cmd line param
849  *
850  * @param ipaddr - a pointer to the ipaddr to populate if included in bootfile
851  * @param filename - a pointer to the string to save the filename part
852  * @param max_len - The longest - 1 that the filename part can be
853  *
854  * return 1 if parsed, 0 if bootfile is empty
855  */
856 int net_parse_bootfile(struct in_addr *ipaddr, char *filename, int max_len);
857 
858 /* get a random source port */
859 unsigned int random_port(void);
860 
861 /**
862  * update_tftp - Update firmware over TFTP (via DFU)
863  *
864  * This function updates board's firmware via TFTP
865  *
866  * @param addr - memory address where data is stored
867  * @param interface - the DFU medium name - e.g. "mmc"
868  * @param devstring - the DFU medium number - e.g. "1"
869  *
870  * @return - 0 on success, other value on failure
871  */
872 int update_tftp(ulong addr, char *interface, char *devstring);
873 
874 /**********************************************************************/
875 
876 #endif /* __NET_H__ */
877