xref: /openbmc/u-boot/include/net.h (revision 1a05b5f9)
1 /*
2  *	LiMon Monitor (LiMon) - Network.
3  *
4  *	Copyright 1994 - 2000 Neil Russell.
5  *	(See License)
6  *
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 typedef __be32		IPaddr_t;
43 
44 
45 /**
46  * An incoming packet handler.
47  * @param pkt    pointer to the application packet
48  * @param dport  destination UDP port
49  * @param sip    source IP address
50  * @param sport  source UDP port
51  * @param len    packet length
52  */
53 typedef void rxhand_f(uchar *pkt, unsigned dport,
54 		      IPaddr_t sip, unsigned sport,
55 		      unsigned len);
56 
57 /**
58  * An incoming ICMP packet handler.
59  * @param type	ICMP type
60  * @param code	ICMP code
61  * @param dport	destination UDP port
62  * @param sip	source IP address
63  * @param sport	source UDP port
64  * @param pkt	pointer to the ICMP packet data
65  * @param len	packet length
66  */
67 typedef void rxhand_icmp_f(unsigned type, unsigned code, unsigned dport,
68 		IPaddr_t sip, unsigned sport, uchar *pkt, unsigned len);
69 
70 /*
71  *	A timeout handler.  Called after time interval has expired.
72  */
73 typedef void	thand_f(void);
74 
75 enum eth_state_t {
76 	ETH_STATE_INIT,
77 	ETH_STATE_PASSIVE,
78 	ETH_STATE_ACTIVE
79 };
80 
81 struct eth_device {
82 	char name[16];
83 	unsigned char enetaddr[6];
84 	int iobase;
85 	int state;
86 
87 	int  (*init) (struct eth_device *, bd_t *);
88 	int  (*send) (struct eth_device *, void *packet, int length);
89 	int  (*recv) (struct eth_device *);
90 	void (*halt) (struct eth_device *);
91 #ifdef CONFIG_MCAST_TFTP
92 	int (*mcast) (struct eth_device *, u32 ip, u8 set);
93 #endif
94 	int  (*write_hwaddr) (struct eth_device *);
95 	struct eth_device *next;
96 	int index;
97 	void *priv;
98 };
99 
100 extern int eth_initialize(bd_t *bis);	/* Initialize network subsystem */
101 extern int eth_register(struct eth_device* dev);/* Register network device */
102 extern int eth_unregister(struct eth_device *dev);/* Remove network device */
103 extern void eth_try_another(int first_restart);	/* Change the device */
104 extern void eth_set_current(void);		/* set nterface to ethcur var */
105 
106 /* get the current device MAC */
107 extern struct eth_device *eth_current;
108 
109 static inline __attribute__((always_inline))
110 struct eth_device *eth_get_dev(void)
111 {
112 	return eth_current;
113 }
114 extern struct eth_device *eth_get_dev_by_name(const char *devname);
115 extern struct eth_device *eth_get_dev_by_index(int index); /* get dev @ index */
116 extern int eth_get_dev_index(void);		/* get the device index */
117 extern void eth_parse_enetaddr(const char *addr, uchar *enetaddr);
118 extern int eth_getenv_enetaddr(char *name, uchar *enetaddr);
119 extern int eth_setenv_enetaddr(char *name, const uchar *enetaddr);
120 
121 /*
122  * Get the hardware address for an ethernet interface .
123  * Args:
124  *	base_name - base name for device (normally "eth")
125  *	index - device index number (0 for first)
126  *	enetaddr - returns 6 byte hardware address
127  * Returns:
128  *	Return true if the address is valid.
129  */
130 extern int eth_getenv_enetaddr_by_index(const char *base_name, int index,
131 					uchar *enetaddr);
132 
133 #ifdef CONFIG_RANDOM_MACADDR
134 /*
135  * The u-boot policy does not allow hardcoded ethernet addresses. Under the
136  * following circumstances a random generated address is allowed:
137  *  - in emergency cases, where you need a working network connection to set
138  *    the ethernet address.
139  *    Eg. you want a rescue boot and don't have a serial port to access the
140  *    CLI to set environment variables.
141  *
142  * In these cases, we generate a random locally administered ethernet address.
143  *
144  * Args:
145  *  enetaddr - returns 6 byte hardware address
146  */
147 extern void eth_random_enetaddr(uchar *enetaddr);
148 #endif
149 
150 extern int usb_eth_initialize(bd_t *bi);
151 extern int eth_init(bd_t *bis);			/* Initialize the device */
152 extern int eth_send(void *packet, int length);	   /* Send a packet */
153 
154 #ifdef CONFIG_API
155 extern int eth_receive(void *packet, int length); /* Receive a packet*/
156 extern void (*push_packet)(void *packet, int length);
157 #endif
158 extern int eth_rx(void);			/* Check for received packets */
159 extern void eth_halt(void);			/* stop SCC */
160 extern char *eth_get_name(void);		/* get name of current device */
161 
162 /* Set active state */
163 static inline __attribute__((always_inline)) int eth_init_state_only(bd_t *bis)
164 {
165 	eth_get_dev()->state = ETH_STATE_ACTIVE;
166 
167 	return 0;
168 }
169 /* Set passive state */
170 static inline __attribute__((always_inline)) void eth_halt_state_only(void)
171 {
172 	eth_get_dev()->state = ETH_STATE_PASSIVE;
173 }
174 
175 /*
176  * Set the hardware address for an ethernet interface based on 'eth%daddr'
177  * environment variable (or just 'ethaddr' if eth_number is 0).
178  * Args:
179  *	base_name - base name for device (normally "eth")
180  *	eth_number - value of %d (0 for first device of this type)
181  * Returns:
182  *	0 is success, non-zero is error status from driver.
183  */
184 int eth_write_hwaddr(struct eth_device *dev, const char *base_name,
185 		     int eth_number);
186 
187 #ifdef CONFIG_MCAST_TFTP
188 int eth_mcast_join(IPaddr_t mcast_addr, u8 join);
189 u32 ether_crc(size_t len, unsigned char const *p);
190 #endif
191 
192 
193 /**********************************************************************/
194 /*
195  *	Protocol headers.
196  */
197 
198 /*
199  *	Ethernet header
200  */
201 
202 struct ethernet_hdr {
203 	uchar		et_dest[6];	/* Destination node		*/
204 	uchar		et_src[6];	/* Source node			*/
205 	ushort		et_protlen;	/* Protocol or length		*/
206 };
207 
208 /* Ethernet header size */
209 #define ETHER_HDR_SIZE	(sizeof(struct ethernet_hdr))
210 
211 struct e802_hdr {
212 	uchar		et_dest[6];	/* Destination node		*/
213 	uchar		et_src[6];	/* Source node			*/
214 	ushort		et_protlen;	/* Protocol or length		*/
215 	uchar		et_dsap;	/* 802 DSAP			*/
216 	uchar		et_ssap;	/* 802 SSAP			*/
217 	uchar		et_ctl;		/* 802 control			*/
218 	uchar		et_snap1;	/* SNAP				*/
219 	uchar		et_snap2;
220 	uchar		et_snap3;
221 	ushort		et_prot;	/* 802 protocol			*/
222 };
223 
224 /* 802 + SNAP + ethernet header size */
225 #define E802_HDR_SIZE	(sizeof(struct e802_hdr))
226 
227 /*
228  *	Virtual LAN Ethernet header
229  */
230 struct vlan_ethernet_hdr {
231 	uchar		vet_dest[6];	/* Destination node		*/
232 	uchar		vet_src[6];	/* Source node			*/
233 	ushort		vet_vlan_type;	/* PROT_VLAN			*/
234 	ushort		vet_tag;	/* TAG of VLAN			*/
235 	ushort		vet_type;	/* protocol type		*/
236 };
237 
238 /* VLAN Ethernet header size */
239 #define VLAN_ETHER_HDR_SIZE	(sizeof(struct vlan_ethernet_hdr))
240 
241 #define PROT_IP		0x0800		/* IP protocol			*/
242 #define PROT_ARP	0x0806		/* IP ARP protocol		*/
243 #define PROT_RARP	0x8035		/* IP ARP protocol		*/
244 #define PROT_VLAN	0x8100		/* IEEE 802.1q protocol		*/
245 
246 #define IPPROTO_ICMP	 1	/* Internet Control Message Protocol	*/
247 #define IPPROTO_UDP	17	/* User Datagram Protocol		*/
248 
249 /*
250  *	Internet Protocol (IP) header.
251  */
252 struct ip_hdr {
253 	uchar		ip_hl_v;	/* header length and version	*/
254 	uchar		ip_tos;		/* type of service		*/
255 	ushort		ip_len;		/* total length			*/
256 	ushort		ip_id;		/* identification		*/
257 	ushort		ip_off;		/* fragment offset field	*/
258 	uchar		ip_ttl;		/* time to live			*/
259 	uchar		ip_p;		/* protocol			*/
260 	ushort		ip_sum;		/* checksum			*/
261 	IPaddr_t	ip_src;		/* Source IP address		*/
262 	IPaddr_t	ip_dst;		/* Destination IP address	*/
263 };
264 
265 #define IP_OFFS		0x1fff /* ip offset *= 8 */
266 #define IP_FLAGS	0xe000 /* first 3 bits */
267 #define IP_FLAGS_RES	0x8000 /* reserved */
268 #define IP_FLAGS_DFRAG	0x4000 /* don't fragments */
269 #define IP_FLAGS_MFRAG	0x2000 /* more fragments */
270 
271 #define IP_HDR_SIZE		(sizeof(struct ip_hdr))
272 
273 /*
274  *	Internet Protocol (IP) + UDP header.
275  */
276 struct ip_udp_hdr {
277 	uchar		ip_hl_v;	/* header length and version	*/
278 	uchar		ip_tos;		/* type of service		*/
279 	ushort		ip_len;		/* total length			*/
280 	ushort		ip_id;		/* identification		*/
281 	ushort		ip_off;		/* fragment offset field	*/
282 	uchar		ip_ttl;		/* time to live			*/
283 	uchar		ip_p;		/* protocol			*/
284 	ushort		ip_sum;		/* checksum			*/
285 	IPaddr_t	ip_src;		/* Source IP address		*/
286 	IPaddr_t	ip_dst;		/* Destination IP address	*/
287 	ushort		udp_src;	/* UDP source port		*/
288 	ushort		udp_dst;	/* UDP destination port		*/
289 	ushort		udp_len;	/* Length of UDP packet		*/
290 	ushort		udp_xsum;	/* Checksum			*/
291 };
292 
293 #define IP_UDP_HDR_SIZE		(sizeof(struct ip_udp_hdr))
294 #define UDP_HDR_SIZE		(IP_UDP_HDR_SIZE - IP_HDR_SIZE)
295 
296 /*
297  *	Address Resolution Protocol (ARP) header.
298  */
299 struct arp_hdr {
300 	ushort		ar_hrd;		/* Format of hardware address	*/
301 #   define ARP_ETHER	    1		/* Ethernet  hardware address	*/
302 	ushort		ar_pro;		/* Format of protocol address	*/
303 	uchar		ar_hln;		/* Length of hardware address	*/
304 #   define ARP_HLEN	6
305 	uchar		ar_pln;		/* Length of protocol address	*/
306 #   define ARP_PLEN	4
307 	ushort		ar_op;		/* Operation			*/
308 #   define ARPOP_REQUEST    1		/* Request  to resolve  address	*/
309 #   define ARPOP_REPLY	    2		/* Response to previous request	*/
310 
311 #   define RARPOP_REQUEST   3		/* Request  to resolve  address	*/
312 #   define RARPOP_REPLY	    4		/* Response to previous request */
313 
314 	/*
315 	 * The remaining fields are variable in size, according to
316 	 * the sizes above, and are defined as appropriate for
317 	 * specific hardware/protocol combinations.
318 	 */
319 	uchar		ar_data[0];
320 #define ar_sha		ar_data[0]
321 #define ar_spa		ar_data[ARP_HLEN]
322 #define ar_tha		ar_data[ARP_HLEN + ARP_PLEN]
323 #define ar_tpa		ar_data[ARP_HLEN + ARP_PLEN + ARP_HLEN]
324 #if 0
325 	uchar		ar_sha[];	/* Sender hardware address	*/
326 	uchar		ar_spa[];	/* Sender protocol address	*/
327 	uchar		ar_tha[];	/* Target hardware address	*/
328 	uchar		ar_tpa[];	/* Target protocol address	*/
329 #endif /* 0 */
330 };
331 
332 #define ARP_HDR_SIZE	(8+20)		/* Size assuming ethernet	*/
333 
334 /*
335  * ICMP stuff (just enough to handle (host) redirect messages)
336  */
337 #define ICMP_ECHO_REPLY		0	/* Echo reply			*/
338 #define ICMP_NOT_REACH		3	/* Detination unreachable	*/
339 #define ICMP_REDIRECT		5	/* Redirect (change route)	*/
340 #define ICMP_ECHO_REQUEST	8	/* Echo request			*/
341 
342 /* Codes for REDIRECT. */
343 #define ICMP_REDIR_NET		0	/* Redirect Net			*/
344 #define ICMP_REDIR_HOST		1	/* Redirect Host		*/
345 
346 /* Codes for NOT_REACH */
347 #define ICMP_NOT_REACH_PORT	3	/* Port unreachable		*/
348 
349 struct icmp_hdr {
350 	uchar		type;
351 	uchar		code;
352 	ushort		checksum;
353 	union {
354 		struct {
355 			ushort	id;
356 			ushort	sequence;
357 		} echo;
358 		ulong	gateway;
359 		struct {
360 			ushort	unused;
361 			ushort	mtu;
362 		} frag;
363 		uchar data[0];
364 	} un;
365 };
366 
367 #define ICMP_HDR_SIZE		(sizeof(struct icmp_hdr))
368 #define IP_ICMP_HDR_SIZE	(IP_HDR_SIZE + ICMP_HDR_SIZE)
369 
370 /*
371  * Maximum packet size; used to allocate packet storage.
372  * TFTP packets can be 524 bytes + IP header + ethernet header.
373  * Lets be conservative, and go for 38 * 16.  (Must also be
374  * a multiple of 32 bytes).
375  */
376 /*
377  * AS.HARNOIS : Better to set PKTSIZE to maximum size because
378  * traffic type is not always controlled
379  * maximum packet size =  1518
380  * maximum packet size and multiple of 32 bytes =  1536
381  */
382 #define PKTSIZE			1518
383 #define PKTSIZE_ALIGN		1536
384 /*#define PKTSIZE		608*/
385 
386 /*
387  * Maximum receive ring size; that is, the number of packets
388  * we can buffer before overflow happens. Basically, this just
389  * needs to be enough to prevent a packet being discarded while
390  * we are processing the previous one.
391  */
392 #define RINGSZ		4
393 #define RINGSZ_LOG2	2
394 
395 /**********************************************************************/
396 /*
397  *	Globals.
398  *
399  * Note:
400  *
401  * All variables of type IPaddr_t are stored in NETWORK byte order
402  * (big endian).
403  */
404 
405 /* net.c */
406 /** BOOTP EXTENTIONS **/
407 extern IPaddr_t NetOurGatewayIP;	/* Our gateway IP address */
408 extern IPaddr_t NetOurSubnetMask;	/* Our subnet mask (0 = unknown) */
409 extern IPaddr_t NetOurDNSIP;	/* Our Domain Name Server (0 = unknown) */
410 #if defined(CONFIG_BOOTP_DNS2)
411 extern IPaddr_t NetOurDNS2IP;	/* Our 2nd Domain Name Server (0 = unknown) */
412 #endif
413 extern char	NetOurNISDomain[32];	/* Our NIS domain */
414 extern char	NetOurHostName[32];	/* Our hostname */
415 extern char	NetOurRootPath[64];	/* Our root path */
416 extern ushort	NetBootFileSize;	/* Our boot file size in blocks */
417 /** END OF BOOTP EXTENTIONS **/
418 extern ulong		NetBootFileXferSize;	/* size of bootfile in bytes */
419 extern uchar		NetOurEther[6];		/* Our ethernet address */
420 extern uchar		NetServerEther[6];	/* Boot server enet address */
421 extern IPaddr_t		NetOurIP;	/* Our    IP addr (0 = unknown) */
422 extern IPaddr_t		NetServerIP;	/* Server IP addr (0 = unknown) */
423 extern uchar		*NetTxPacket;		/* THE transmit packet */
424 extern uchar		*NetRxPackets[PKTBUFSRX]; /* Receive packets */
425 extern uchar		*NetRxPacket;		/* Current receive packet */
426 extern int		NetRxPacketLen;		/* Current rx packet length */
427 extern unsigned		NetIPID;		/* IP ID (counting) */
428 extern uchar		NetBcastAddr[6];	/* Ethernet boardcast address */
429 extern uchar		NetEtherNullAddr[6];
430 
431 #define VLAN_NONE	4095			/* untagged */
432 #define VLAN_IDMASK	0x0fff			/* mask of valid vlan id */
433 extern ushort		NetOurVLAN;		/* Our VLAN */
434 extern ushort		NetOurNativeVLAN;	/* Our Native VLAN */
435 
436 extern int		NetRestartWrap;		/* Tried all network devices */
437 
438 enum proto_t {
439 	BOOTP, RARP, ARP, TFTPGET, DHCP, PING, DNS, NFS, CDP, NETCONS, SNTP,
440 	TFTPSRV, TFTPPUT, LINKLOCAL
441 };
442 
443 /* from net/net.c */
444 extern char	BootFile[128];			/* Boot File name */
445 
446 #if defined(CONFIG_CMD_DNS)
447 extern char *NetDNSResolve;		/* The host to resolve  */
448 extern char *NetDNSenvvar;		/* the env var to put the ip into */
449 #endif
450 
451 #if defined(CONFIG_CMD_PING)
452 extern IPaddr_t	NetPingIP;			/* the ip address to ping */
453 #endif
454 
455 #if defined(CONFIG_CMD_CDP)
456 /* when CDP completes these hold the return values */
457 extern ushort CDPNativeVLAN;		/* CDP returned native VLAN */
458 extern ushort CDPApplianceVLAN;		/* CDP returned appliance VLAN */
459 
460 /*
461  * Check for a CDP packet by examining the received MAC address field
462  */
463 static inline int is_cdp_packet(const uchar *et_addr)
464 {
465 	extern const uchar NetCDPAddr[6];
466 
467 	return memcmp(et_addr, NetCDPAddr, 6) == 0;
468 }
469 #endif
470 
471 #if defined(CONFIG_CMD_SNTP)
472 extern IPaddr_t	NetNtpServerIP;			/* the ip address to NTP */
473 extern int NetTimeOffset;			/* offset time from UTC */
474 #endif
475 
476 #if defined(CONFIG_MCAST_TFTP)
477 extern IPaddr_t Mcast_addr;
478 #endif
479 
480 /* Initialize the network adapter */
481 extern void net_init(void);
482 extern int NetLoop(enum proto_t);
483 
484 /* Shutdown adapters and cleanup */
485 extern void	NetStop(void);
486 
487 /* Load failed.	 Start again. */
488 extern void	NetStartAgain(void);
489 
490 /* Get size of the ethernet header when we send */
491 extern int	NetEthHdrSize(void);
492 
493 /* Set ethernet header; returns the size of the header */
494 extern int NetSetEther(uchar *, uchar *, uint);
495 extern int net_update_ether(struct ethernet_hdr *et, uchar *addr, uint prot);
496 
497 /* Set IP header */
498 extern void net_set_ip_header(uchar *pkt, IPaddr_t dest, IPaddr_t source);
499 extern void net_set_udp_header(uchar *pkt, IPaddr_t dest, int dport,
500 				int sport, int len);
501 
502 /* Checksum */
503 extern int	NetCksumOk(uchar *, int);	/* Return true if cksum OK */
504 extern uint	NetCksum(uchar *, int);		/* Calculate the checksum */
505 
506 /* Callbacks */
507 extern rxhand_f *net_get_udp_handler(void);	/* Get UDP RX packet handler */
508 extern void net_set_udp_handler(rxhand_f *);	/* Set UDP RX packet handler */
509 extern rxhand_f *net_get_arp_handler(void);	/* Get ARP RX packet handler */
510 extern void net_set_arp_handler(rxhand_f *);	/* Set ARP RX packet handler */
511 extern void net_set_icmp_handler(rxhand_icmp_f *f); /* Set ICMP RX handler */
512 extern void	NetSetTimeout(ulong, thand_f *);/* Set timeout handler */
513 
514 /* Network loop state */
515 enum net_loop_state {
516 	NETLOOP_CONTINUE,
517 	NETLOOP_RESTART,
518 	NETLOOP_SUCCESS,
519 	NETLOOP_FAIL
520 };
521 extern enum net_loop_state net_state;
522 
523 static inline void net_set_state(enum net_loop_state state)
524 {
525 	debug_cond(DEBUG_INT_STATE, "--- NetState set to %d\n", state);
526 	net_state = state;
527 }
528 
529 /* Transmit a packet */
530 static inline void NetSendPacket(uchar *pkt, int len)
531 {
532 	(void) eth_send(pkt, len);
533 }
534 
535 /*
536  * Transmit "NetTxPacket" as UDP packet, performing ARP request if needed
537  *  (ether will be populated)
538  *
539  * @param ether Raw packet buffer
540  * @param dest IP address to send the datagram to
541  * @param dport Destination UDP port
542  * @param sport Source UDP port
543  * @param payload_len Length of data after the UDP header
544  */
545 extern int NetSendUDPPacket(uchar *ether, IPaddr_t dest, int dport,
546 			int sport, int payload_len);
547 
548 /* Processes a received packet */
549 extern void NetReceive(uchar *, int);
550 
551 #ifdef CONFIG_NETCONSOLE
552 void NcStart(void);
553 int nc_input_packet(uchar *pkt, IPaddr_t src_ip, unsigned dest_port,
554 	unsigned src_port, unsigned len);
555 #endif
556 
557 static inline __attribute__((always_inline)) int eth_is_on_demand_init(void)
558 {
559 #ifdef CONFIG_NETCONSOLE
560 	extern enum proto_t net_loop_last_protocol;
561 
562 	return net_loop_last_protocol != NETCONS;
563 #else
564 	return 1;
565 #endif
566 }
567 
568 static inline void eth_set_last_protocol(int protocol)
569 {
570 #ifdef CONFIG_NETCONSOLE
571 	extern enum proto_t net_loop_last_protocol;
572 
573 	net_loop_last_protocol = protocol;
574 #endif
575 }
576 
577 /*
578  * Check if autoload is enabled. If so, use either NFS or TFTP to download
579  * the boot file.
580  */
581 void net_auto_load(void);
582 
583 /*
584  * The following functions are a bit ugly, but necessary to deal with
585  * alignment restrictions on ARM.
586  *
587  * We're using inline functions, which had the smallest memory
588  * footprint in our tests.
589  */
590 /* return IP *in network byteorder* */
591 static inline IPaddr_t NetReadIP(void *from)
592 {
593 	IPaddr_t ip;
594 
595 	memcpy((void *)&ip, (void *)from, sizeof(ip));
596 	return ip;
597 }
598 
599 /* return ulong *in network byteorder* */
600 static inline ulong NetReadLong(ulong *from)
601 {
602 	ulong l;
603 
604 	memcpy((void *)&l, (void *)from, sizeof(l));
605 	return l;
606 }
607 
608 /* write IP *in network byteorder* */
609 static inline void NetWriteIP(void *to, IPaddr_t ip)
610 {
611 	memcpy(to, (void *)&ip, sizeof(ip));
612 }
613 
614 /* copy IP */
615 static inline void NetCopyIP(void *to, void *from)
616 {
617 	memcpy((void *)to, from, sizeof(IPaddr_t));
618 }
619 
620 /* copy ulong */
621 static inline void NetCopyLong(ulong *to, ulong *from)
622 {
623 	memcpy((void *)to, (void *)from, sizeof(ulong));
624 }
625 
626 /**
627  * is_zero_ether_addr - Determine if give Ethernet address is all zeros.
628  * @addr: Pointer to a six-byte array containing the Ethernet address
629  *
630  * Return true if the address is all zeroes.
631  */
632 static inline int is_zero_ether_addr(const u8 *addr)
633 {
634 	return !(addr[0] | addr[1] | addr[2] | addr[3] | addr[4] | addr[5]);
635 }
636 
637 /**
638  * is_multicast_ether_addr - Determine if the Ethernet address is a multicast.
639  * @addr: Pointer to a six-byte array containing the Ethernet address
640  *
641  * Return true if the address is a multicast address.
642  * By definition the broadcast address is also a multicast address.
643  */
644 static inline int is_multicast_ether_addr(const u8 *addr)
645 {
646 	return 0x01 & addr[0];
647 }
648 
649 /*
650  * is_broadcast_ether_addr - Determine if the Ethernet address is broadcast
651  * @addr: Pointer to a six-byte array containing the Ethernet address
652  *
653  * Return true if the address is the broadcast address.
654  */
655 static inline int is_broadcast_ether_addr(const u8 *addr)
656 {
657 	return (addr[0] & addr[1] & addr[2] & addr[3] & addr[4] & addr[5]) ==
658 		0xff;
659 }
660 
661 /*
662  * is_valid_ether_addr - Determine if the given Ethernet address is valid
663  * @addr: Pointer to a six-byte array containing the Ethernet address
664  *
665  * Check that the Ethernet address (MAC) is not 00:00:00:00:00:00, is not
666  * a multicast address, and is not FF:FF:FF:FF:FF:FF.
667  *
668  * Return true if the address is valid.
669  */
670 static inline int is_valid_ether_addr(const u8 *addr)
671 {
672 	/* FF:FF:FF:FF:FF:FF is a multicast address so we don't need to
673 	 * explicitly check for it here. */
674 	return !is_multicast_ether_addr(addr) && !is_zero_ether_addr(addr);
675 }
676 
677 /* Convert an IP address to a string */
678 extern void ip_to_string(IPaddr_t x, char *s);
679 
680 /* Convert a string to ip address */
681 extern IPaddr_t string_to_ip(const char *s);
682 
683 /* Convert a VLAN id to a string */
684 extern void VLAN_to_string(ushort x, char *s);
685 
686 /* Convert a string to a vlan id */
687 extern ushort string_to_VLAN(const char *s);
688 
689 /* read a VLAN id from an environment variable */
690 extern ushort getenv_VLAN(char *);
691 
692 /* copy a filename (allow for "..." notation, limit length) */
693 extern void copy_filename(char *dst, const char *src, int size);
694 
695 /* get a random source port */
696 extern unsigned int random_port(void);
697 
698 /* Update U-Boot over TFTP */
699 extern int update_tftp(ulong addr);
700 
701 /**********************************************************************/
702 
703 #endif /* __NET_H__ */
704