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