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