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