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