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