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