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