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