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