xref: /rk3399_rockchip-uboot/include/net.h (revision 9b0e35cb4889eb04a7ea5dd648d73df0bf37cc68)
12d966958Swdenk /*
22d966958Swdenk  *	LiMon Monitor (LiMon) - Network.
32d966958Swdenk  *
42d966958Swdenk  *	Copyright 1994 - 2000 Neil Russell.
52d966958Swdenk  *	(See License)
62ea91039SWolfgang Denk  *	SPDX-License-Identifier:	GPL-2.0
72d966958Swdenk  *
82d966958Swdenk  * History
92d966958Swdenk  *	9/16/00	  bor  adapted to TQM823L/STK8xxL board, RARP/TFTP boot added
102d966958Swdenk  */
112d966958Swdenk 
122d966958Swdenk #ifndef __NET_H__
132d966958Swdenk #define __NET_H__
142d966958Swdenk 
1571f95118Swdenk #if defined(CONFIG_8xx)
162d966958Swdenk #include <commproc.h>
1771f95118Swdenk #endif	/* CONFIG_8xx */
18aacf9a49Swdenk 
192c4b3c19SEric Nelson #include <asm/cache.h>
202d966958Swdenk #include <asm/byteorder.h>	/* for nton* / ntoh* stuff */
212d966958Swdenk 
224ef8d53cSJoe Hershberger #define DEBUG_LL_STATE 0	/* Link local state machine changes */
234ef8d53cSJoe Hershberger #define DEBUG_DEV_PKT 0		/* Packets or info directed to the device */
244ef8d53cSJoe Hershberger #define DEBUG_NET_PKT 0		/* Packets on info on the network at large */
254ef8d53cSJoe Hershberger #define DEBUG_INT_STATE 0	/* Internal network state changes */
262d966958Swdenk 
272d966958Swdenk /*
282d966958Swdenk  *	The number of receive packet buffers, and the required packet buffer
292d966958Swdenk  *	alignment in memory.
302d966958Swdenk  *
312d966958Swdenk  */
322d966958Swdenk 
336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #ifdef CONFIG_SYS_RX_ETH_BUFFER
346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD # define PKTBUFSRX	CONFIG_SYS_RX_ETH_BUFFER
351d0350edSwdenk #else
36c6028835Sstroese # define PKTBUFSRX	4
371d0350edSwdenk #endif
381d0350edSwdenk 
392c4b3c19SEric Nelson #define PKTALIGN	ARCH_DMA_MINALIGN
402d966958Swdenk 
41ea45cb0aSMatthias Weisser /* IPv4 addresses are always 32 bits in size */
423d49412dSKim Phillips typedef __be32		IPaddr_t;
432d966958Swdenk 
442d966958Swdenk 
4503eb129fSLuca Ceresoli /**
4603eb129fSLuca Ceresoli  * An incoming packet handler.
4703eb129fSLuca Ceresoli  * @param pkt    pointer to the application packet
4803eb129fSLuca Ceresoli  * @param dport  destination UDP port
4903eb129fSLuca Ceresoli  * @param sip    source IP address
5003eb129fSLuca Ceresoli  * @param sport  source UDP port
5103eb129fSLuca Ceresoli  * @param len    packet length
522d966958Swdenk  */
5303eb129fSLuca Ceresoli typedef void rxhand_f(uchar *pkt, unsigned dport,
5403eb129fSLuca Ceresoli 		      IPaddr_t sip, unsigned sport,
5503eb129fSLuca Ceresoli 		      unsigned len);
562d966958Swdenk 
574793ee65SSimon Glass /**
584793ee65SSimon Glass  * An incoming ICMP packet handler.
594793ee65SSimon Glass  * @param type	ICMP type
604793ee65SSimon Glass  * @param code	ICMP code
614793ee65SSimon Glass  * @param dport	destination UDP port
624793ee65SSimon Glass  * @param sip	source IP address
634793ee65SSimon Glass  * @param sport	source UDP port
644793ee65SSimon Glass  * @param pkt	pointer to the ICMP packet data
654793ee65SSimon Glass  * @param len	packet length
664793ee65SSimon Glass  */
674793ee65SSimon Glass typedef void rxhand_icmp_f(unsigned type, unsigned code, unsigned dport,
684793ee65SSimon Glass 		IPaddr_t sip, unsigned sport, uchar *pkt, unsigned len);
694793ee65SSimon Glass 
702d966958Swdenk /*
712d966958Swdenk  *	A timeout handler.  Called after time interval has expired.
722d966958Swdenk  */
732d966958Swdenk typedef void	thand_f(void);
742d966958Swdenk 
752d966958Swdenk enum eth_state_t {
762d966958Swdenk 	ETH_STATE_INIT,
772d966958Swdenk 	ETH_STATE_PASSIVE,
782d966958Swdenk 	ETH_STATE_ACTIVE
792d966958Swdenk };
802d966958Swdenk 
812d966958Swdenk struct eth_device {
82f6add132SMike Frysinger 	char name[16];
832d966958Swdenk 	unsigned char enetaddr[6];
8416ae7827SMichal Simek 	phys_addr_t iobase;
852d966958Swdenk 	int state;
862d966958Swdenk 
872d966958Swdenk 	int  (*init) (struct eth_device *, bd_t *);
88db288a96SJoe Hershberger 	int  (*send) (struct eth_device *, void *packet, int length);
892d966958Swdenk 	int  (*recv) (struct eth_device *);
902d966958Swdenk 	void (*halt) (struct eth_device *);
9153a5c424SDavid Updegraff #ifdef CONFIG_MCAST_TFTP
929c4cffacSClaudiu Manoil 	int (*mcast) (struct eth_device *, const u8 *enetaddr, u8 set);
9353a5c424SDavid Updegraff #endif
94ecee9324SBen Warren 	int  (*write_hwaddr) (struct eth_device *);
952d966958Swdenk 	struct eth_device *next;
96fea7dcaeSMichael Walle 	int index;
972d966958Swdenk 	void *priv;
982d966958Swdenk };
992d966958Swdenk 
1002d966958Swdenk extern int eth_initialize(bd_t *bis);	/* Initialize network subsystem */
1012d966958Swdenk extern int eth_register(struct eth_device* dev);/* Register network device */
102e7e982d6SVincent Palatin extern int eth_unregister(struct eth_device *dev);/* Remove network device */
1032d966958Swdenk extern void eth_try_another(int first_restart);	/* Change the device */
1045dc0cf68SAndy Fleming extern void eth_set_current(void);		/* set nterface to ethcur var */
10506370590SKim Phillips 
106f8be7d65SJoe Hershberger /* get the current device MAC */
10706370590SKim Phillips extern struct eth_device *eth_current;
10806370590SKim Phillips 
109f8be7d65SJoe Hershberger static inline __attribute__((always_inline))
110f8be7d65SJoe Hershberger struct eth_device *eth_get_dev(void)
111f8be7d65SJoe Hershberger {
112f8be7d65SJoe Hershberger 	return eth_current;
113f8be7d65SJoe Hershberger }
114d7fb9bcfSBen Warren extern struct eth_device *eth_get_dev_by_name(const char *devname);
1155dc0cf68SAndy Fleming extern struct eth_device *eth_get_dev_by_index(int index); /* get dev @ index */
116a3d991bdSwdenk extern int eth_get_dev_index(void);		/* get the device index */
1173f6e6993SMike Frysinger extern void eth_parse_enetaddr(const char *addr, uchar *enetaddr);
1183f6e6993SMike Frysinger extern int eth_getenv_enetaddr(char *name, uchar *enetaddr);
1193f6e6993SMike Frysinger extern int eth_setenv_enetaddr(char *name, const uchar *enetaddr);
1207616e785SSimon Glass 
1217616e785SSimon Glass /*
1227616e785SSimon Glass  * Get the hardware address for an ethernet interface .
1237616e785SSimon Glass  * Args:
1247616e785SSimon Glass  *	base_name - base name for device (normally "eth")
1257616e785SSimon Glass  *	index - device index number (0 for first)
1267616e785SSimon Glass  *	enetaddr - returns 6 byte hardware address
1277616e785SSimon Glass  * Returns:
1287616e785SSimon Glass  *	Return true if the address is valid.
1297616e785SSimon Glass  */
1307616e785SSimon Glass extern int eth_getenv_enetaddr_by_index(const char *base_name, int index,
1317616e785SSimon Glass 					uchar *enetaddr);
1322d966958Swdenk 
13323cd1385SRemy Bohmer extern int usb_eth_initialize(bd_t *bi);
1342d966958Swdenk extern int eth_init(bd_t *bis);			/* Initialize the device */
135db288a96SJoe Hershberger extern int eth_send(void *packet, int length);	   /* Send a packet */
13623cd1385SRemy Bohmer 
137f85b6071SRafal Jaworowski #ifdef CONFIG_API
138db288a96SJoe Hershberger extern int eth_receive(void *packet, int length); /* Receive a packet*/
139db288a96SJoe Hershberger extern void (*push_packet)(void *packet, int length);
140f85b6071SRafal Jaworowski #endif
1412d966958Swdenk extern int eth_rx(void);			/* Check for received packets */
1422d966958Swdenk extern void eth_halt(void);			/* stop SCC */
1435bb226e8Swdenk extern char *eth_get_name(void);		/* get name of current device */
1442d966958Swdenk 
145f8be7d65SJoe Hershberger /* Set active state */
146f8be7d65SJoe Hershberger static inline __attribute__((always_inline)) int eth_init_state_only(bd_t *bis)
147f8be7d65SJoe Hershberger {
148f8be7d65SJoe Hershberger 	eth_get_dev()->state = ETH_STATE_ACTIVE;
149f8be7d65SJoe Hershberger 
150f8be7d65SJoe Hershberger 	return 0;
151f8be7d65SJoe Hershberger }
152f8be7d65SJoe Hershberger /* Set passive state */
153f8be7d65SJoe Hershberger static inline __attribute__((always_inline)) void eth_halt_state_only(void)
154f8be7d65SJoe Hershberger {
155f8be7d65SJoe Hershberger 	eth_get_dev()->state = ETH_STATE_PASSIVE;
156f8be7d65SJoe Hershberger }
157f8be7d65SJoe Hershberger 
1587616e785SSimon Glass /*
1597616e785SSimon Glass  * Set the hardware address for an ethernet interface based on 'eth%daddr'
1607616e785SSimon Glass  * environment variable (or just 'ethaddr' if eth_number is 0).
1617616e785SSimon Glass  * Args:
1627616e785SSimon Glass  *	base_name - base name for device (normally "eth")
1637616e785SSimon Glass  *	eth_number - value of %d (0 for first device of this type)
1647616e785SSimon Glass  * Returns:
1657616e785SSimon Glass  *	0 is success, non-zero is error status from driver.
1667616e785SSimon Glass  */
1677616e785SSimon Glass int eth_write_hwaddr(struct eth_device *dev, const char *base_name,
1687616e785SSimon Glass 		     int eth_number);
1697616e785SSimon Glass 
17053a5c424SDavid Updegraff #ifdef CONFIG_MCAST_TFTP
17153a5c424SDavid Updegraff int eth_mcast_join(IPaddr_t mcast_addr, u8 join);
17253a5c424SDavid Updegraff u32 ether_crc(size_t len, unsigned char const *p);
17353a5c424SDavid Updegraff #endif
17453a5c424SDavid Updegraff 
1752d966958Swdenk 
1762d966958Swdenk /**********************************************************************/
1772d966958Swdenk /*
1782d966958Swdenk  *	Protocol headers.
1792d966958Swdenk  */
1802d966958Swdenk 
1812d966958Swdenk /*
1822d966958Swdenk  *	Ethernet header
1832d966958Swdenk  */
184cb487f56SJoe Hershberger 
185cb487f56SJoe Hershberger struct ethernet_hdr {
186cb487f56SJoe Hershberger 	uchar		et_dest[6];	/* Destination node		*/
187cb487f56SJoe Hershberger 	uchar		et_src[6];	/* Source node			*/
188cb487f56SJoe Hershberger 	ushort		et_protlen;	/* Protocol or length		*/
189cb487f56SJoe Hershberger };
190cb487f56SJoe Hershberger 
191cb487f56SJoe Hershberger /* Ethernet header size */
192cb487f56SJoe Hershberger #define ETHER_HDR_SIZE	(sizeof(struct ethernet_hdr))
193cb487f56SJoe Hershberger 
194cb487f56SJoe Hershberger struct e802_hdr {
1952d966958Swdenk 	uchar		et_dest[6];	/* Destination node		*/
1962d966958Swdenk 	uchar		et_src[6];	/* Source node			*/
1972d966958Swdenk 	ushort		et_protlen;	/* Protocol or length		*/
1982d966958Swdenk 	uchar		et_dsap;	/* 802 DSAP			*/
1992d966958Swdenk 	uchar		et_ssap;	/* 802 SSAP			*/
2002d966958Swdenk 	uchar		et_ctl;		/* 802 control			*/
2012d966958Swdenk 	uchar		et_snap1;	/* SNAP				*/
2022d966958Swdenk 	uchar		et_snap2;
2032d966958Swdenk 	uchar		et_snap3;
2042d966958Swdenk 	ushort		et_prot;	/* 802 protocol			*/
205cb487f56SJoe Hershberger };
2062d966958Swdenk 
207da5ebe2cSJoe Hershberger /* 802 + SNAP + ethernet header size */
208cb487f56SJoe Hershberger #define E802_HDR_SIZE	(sizeof(struct e802_hdr))
209a3d991bdSwdenk 
210a3d991bdSwdenk /*
211da5ebe2cSJoe Hershberger  *	Virtual LAN Ethernet header
212a3d991bdSwdenk  */
213c68cca35SJoe Hershberger struct vlan_ethernet_hdr {
214a3d991bdSwdenk 	uchar		vet_dest[6];	/* Destination node		*/
215a3d991bdSwdenk 	uchar		vet_src[6];	/* Source node			*/
216a3d991bdSwdenk 	ushort		vet_vlan_type;	/* PROT_VLAN			*/
217a3d991bdSwdenk 	ushort		vet_tag;	/* TAG of VLAN			*/
218a3d991bdSwdenk 	ushort		vet_type;	/* protocol type		*/
219c68cca35SJoe Hershberger };
220a3d991bdSwdenk 
221c68cca35SJoe Hershberger /* VLAN Ethernet header size */
222c68cca35SJoe Hershberger #define VLAN_ETHER_HDR_SIZE	(sizeof(struct vlan_ethernet_hdr))
223a3d991bdSwdenk 
2242d966958Swdenk #define PROT_IP		0x0800		/* IP protocol			*/
2252d966958Swdenk #define PROT_ARP	0x0806		/* IP ARP protocol		*/
2262d966958Swdenk #define PROT_RARP	0x8035		/* IP ARP protocol		*/
227a3d991bdSwdenk #define PROT_VLAN	0x8100		/* IEEE 802.1q protocol		*/
2282d966958Swdenk 
2292d966958Swdenk #define IPPROTO_ICMP	 1	/* Internet Control Message Protocol	*/
2302d966958Swdenk #define IPPROTO_UDP	17	/* User Datagram Protocol		*/
2312d966958Swdenk 
2322d966958Swdenk /*
233c5c59df0SJoe Hershberger  *	Internet Protocol (IP) header.
234c5c59df0SJoe Hershberger  */
235c5c59df0SJoe Hershberger struct ip_hdr {
236c5c59df0SJoe Hershberger 	uchar		ip_hl_v;	/* header length and version	*/
237c5c59df0SJoe Hershberger 	uchar		ip_tos;		/* type of service		*/
238c5c59df0SJoe Hershberger 	ushort		ip_len;		/* total length			*/
239c5c59df0SJoe Hershberger 	ushort		ip_id;		/* identification		*/
240c5c59df0SJoe Hershberger 	ushort		ip_off;		/* fragment offset field	*/
241c5c59df0SJoe Hershberger 	uchar		ip_ttl;		/* time to live			*/
242c5c59df0SJoe Hershberger 	uchar		ip_p;		/* protocol			*/
243c5c59df0SJoe Hershberger 	ushort		ip_sum;		/* checksum			*/
244c5c59df0SJoe Hershberger 	IPaddr_t	ip_src;		/* Source IP address		*/
245c5c59df0SJoe Hershberger 	IPaddr_t	ip_dst;		/* Destination IP address	*/
246c5c59df0SJoe Hershberger };
247c5c59df0SJoe Hershberger 
248c5c59df0SJoe Hershberger #define IP_OFFS		0x1fff /* ip offset *= 8 */
249c5c59df0SJoe Hershberger #define IP_FLAGS	0xe000 /* first 3 bits */
250c5c59df0SJoe Hershberger #define IP_FLAGS_RES	0x8000 /* reserved */
251c5c59df0SJoe Hershberger #define IP_FLAGS_DFRAG	0x4000 /* don't fragments */
252c5c59df0SJoe Hershberger #define IP_FLAGS_MFRAG	0x2000 /* more fragments */
253c5c59df0SJoe Hershberger 
254c5c59df0SJoe Hershberger #define IP_HDR_SIZE		(sizeof(struct ip_hdr))
255c5c59df0SJoe Hershberger 
256c5c59df0SJoe Hershberger /*
257594c26f8SJoe Hershberger  *	Internet Protocol (IP) + UDP header.
2582d966958Swdenk  */
259594c26f8SJoe Hershberger struct ip_udp_hdr {
2602d966958Swdenk 	uchar		ip_hl_v;	/* header length and version	*/
2612d966958Swdenk 	uchar		ip_tos;		/* type of service		*/
2622d966958Swdenk 	ushort		ip_len;		/* total length			*/
2632d966958Swdenk 	ushort		ip_id;		/* identification		*/
2642d966958Swdenk 	ushort		ip_off;		/* fragment offset field	*/
2652d966958Swdenk 	uchar		ip_ttl;		/* time to live			*/
2662d966958Swdenk 	uchar		ip_p;		/* protocol			*/
2672d966958Swdenk 	ushort		ip_sum;		/* checksum			*/
2682d966958Swdenk 	IPaddr_t	ip_src;		/* Source IP address		*/
2692d966958Swdenk 	IPaddr_t	ip_dst;		/* Destination IP address	*/
2702d966958Swdenk 	ushort		udp_src;	/* UDP source port		*/
2712d966958Swdenk 	ushort		udp_dst;	/* UDP destination port		*/
2722d966958Swdenk 	ushort		udp_len;	/* Length of UDP packet		*/
2732d966958Swdenk 	ushort		udp_xsum;	/* Checksum			*/
274594c26f8SJoe Hershberger };
2752d966958Swdenk 
276594c26f8SJoe Hershberger #define IP_UDP_HDR_SIZE		(sizeof(struct ip_udp_hdr))
277c5c59df0SJoe Hershberger #define UDP_HDR_SIZE		(IP_UDP_HDR_SIZE - IP_HDR_SIZE)
2782d966958Swdenk 
2792d966958Swdenk /*
2802d966958Swdenk  *	Address Resolution Protocol (ARP) header.
2812d966958Swdenk  */
282738853bbSJoe Hershberger struct arp_hdr {
2832d966958Swdenk 	ushort		ar_hrd;		/* Format of hardware address	*/
2842d966958Swdenk #   define ARP_ETHER	    1		/* Ethernet  hardware address	*/
2852d966958Swdenk 	ushort		ar_pro;		/* Format of protocol address	*/
2862d966958Swdenk 	uchar		ar_hln;		/* Length of hardware address	*/
287674bb249SJoe Hershberger #   define ARP_HLEN	6
2882d966958Swdenk 	uchar		ar_pln;		/* Length of protocol address	*/
289674bb249SJoe Hershberger #   define ARP_PLEN	4
2902d966958Swdenk 	ushort		ar_op;		/* Operation			*/
2912d966958Swdenk #   define ARPOP_REQUEST    1		/* Request  to resolve  address	*/
2922d966958Swdenk #   define ARPOP_REPLY	    2		/* Response to previous request	*/
2932d966958Swdenk 
2942d966958Swdenk #   define RARPOP_REQUEST   3		/* Request  to resolve  address	*/
2952d966958Swdenk #   define RARPOP_REPLY	    4		/* Response to previous request */
2962d966958Swdenk 
2972d966958Swdenk 	/*
2982d966958Swdenk 	 * The remaining fields are variable in size, according to
2992d966958Swdenk 	 * the sizes above, and are defined as appropriate for
3002d966958Swdenk 	 * specific hardware/protocol combinations.
3012d966958Swdenk 	 */
3022d966958Swdenk 	uchar		ar_data[0];
303674bb249SJoe Hershberger #define ar_sha		ar_data[0]
304674bb249SJoe Hershberger #define ar_spa		ar_data[ARP_HLEN]
305674bb249SJoe Hershberger #define ar_tha		ar_data[ARP_HLEN + ARP_PLEN]
306674bb249SJoe Hershberger #define ar_tpa		ar_data[ARP_HLEN + ARP_PLEN + ARP_HLEN]
3072d966958Swdenk #if 0
3082d966958Swdenk 	uchar		ar_sha[];	/* Sender hardware address	*/
3092d966958Swdenk 	uchar		ar_spa[];	/* Sender protocol address	*/
3102d966958Swdenk 	uchar		ar_tha[];	/* Target hardware address	*/
3112d966958Swdenk 	uchar		ar_tpa[];	/* Target protocol address	*/
3122d966958Swdenk #endif /* 0 */
313738853bbSJoe Hershberger };
3142d966958Swdenk 
3152d966958Swdenk #define ARP_HDR_SIZE	(8+20)		/* Size assuming ethernet	*/
3162d966958Swdenk 
3172d966958Swdenk /*
3182d966958Swdenk  * ICMP stuff (just enough to handle (host) redirect messages)
3192d966958Swdenk  */
32073a8b27cSwdenk #define ICMP_ECHO_REPLY		0	/* Echo reply			*/
3214793ee65SSimon Glass #define ICMP_NOT_REACH		3	/* Detination unreachable	*/
3222d966958Swdenk #define ICMP_REDIRECT		5	/* Redirect (change route)	*/
32373a8b27cSwdenk #define ICMP_ECHO_REQUEST	8	/* Echo request			*/
3242d966958Swdenk 
3252d966958Swdenk /* Codes for REDIRECT. */
3262d966958Swdenk #define ICMP_REDIR_NET		0	/* Redirect Net			*/
3272d966958Swdenk #define ICMP_REDIR_HOST		1	/* Redirect Host		*/
3282d966958Swdenk 
3294793ee65SSimon Glass /* Codes for NOT_REACH */
3304793ee65SSimon Glass #define ICMP_NOT_REACH_PORT	3	/* Port unreachable		*/
3314793ee65SSimon Glass 
332e0a63079SJoe Hershberger struct icmp_hdr {
3332d966958Swdenk 	uchar		type;
3342d966958Swdenk 	uchar		code;
3352d966958Swdenk 	ushort		checksum;
3362d966958Swdenk 	union {
3372d966958Swdenk 		struct {
3382d966958Swdenk 			ushort	id;
3392d966958Swdenk 			ushort	sequence;
3402d966958Swdenk 		} echo;
3412d966958Swdenk 		ulong	gateway;
3422d966958Swdenk 		struct {
3436e840ebcSJeroen Hofstee 			ushort	unused;
3442d966958Swdenk 			ushort	mtu;
3452d966958Swdenk 		} frag;
3464793ee65SSimon Glass 		uchar data[0];
3472d966958Swdenk 	} un;
348e0a63079SJoe Hershberger };
3492d966958Swdenk 
350e0a63079SJoe Hershberger #define ICMP_HDR_SIZE		(sizeof(struct icmp_hdr))
351e0a63079SJoe Hershberger #define IP_ICMP_HDR_SIZE	(IP_HDR_SIZE + ICMP_HDR_SIZE)
3522d966958Swdenk 
3532d966958Swdenk /*
3542d966958Swdenk  * Maximum packet size; used to allocate packet storage.
3552d966958Swdenk  * TFTP packets can be 524 bytes + IP header + ethernet header.
3562d966958Swdenk  * Lets be conservative, and go for 38 * 16.  (Must also be
3572d966958Swdenk  * a multiple of 32 bytes).
3582d966958Swdenk  */
3592d966958Swdenk /*
3602d966958Swdenk  * AS.HARNOIS : Better to set PKTSIZE to maximum size because
3612d966958Swdenk  * traffic type is not always controlled
3622d966958Swdenk  * maximum packet size =  1518
3632d966958Swdenk  * maximum packet size and multiple of 32 bytes =  1536
3642d966958Swdenk  */
3652d966958Swdenk #define PKTSIZE			1518
3662d966958Swdenk #define PKTSIZE_ALIGN		1536
3672d966958Swdenk /*#define PKTSIZE		608*/
3682d966958Swdenk 
3692d966958Swdenk /*
3702d966958Swdenk  * Maximum receive ring size; that is, the number of packets
3712d966958Swdenk  * we can buffer before overflow happens. Basically, this just
3722d966958Swdenk  * needs to be enough to prevent a packet being discarded while
3732d966958Swdenk  * we are processing the previous one.
3742d966958Swdenk  */
3752d966958Swdenk #define RINGSZ		4
3762d966958Swdenk #define RINGSZ_LOG2	2
3772d966958Swdenk 
3782d966958Swdenk /**********************************************************************/
3792d966958Swdenk /*
3802d966958Swdenk  *	Globals.
3812d966958Swdenk  *
3822d966958Swdenk  * Note:
3832d966958Swdenk  *
3842d966958Swdenk  * All variables of type IPaddr_t are stored in NETWORK byte order
3852d966958Swdenk  * (big endian).
3862d966958Swdenk  */
3872d966958Swdenk 
3882d966958Swdenk /* net.c */
3892d966958Swdenk /** BOOTP EXTENTIONS **/
390b28e28bbSJoe Hershberger extern IPaddr_t NetOurGatewayIP;	/* Our gateway IP address */
3912d966958Swdenk extern IPaddr_t NetOurSubnetMask;	/* Our subnet mask (0 = unknown) */
3922d966958Swdenk extern IPaddr_t NetOurDNSIP;	/* Our Domain Name Server (0 = unknown) */
3931fe80d79SJon Loeliger #if defined(CONFIG_BOOTP_DNS2)
394fe389a82Sstroese extern IPaddr_t NetOurDNS2IP;	/* Our 2nd Domain Name Server (0 = unknown) */
395fe389a82Sstroese #endif
3962d966958Swdenk extern char	NetOurNISDomain[32];	/* Our NIS domain */
3972d966958Swdenk extern char	NetOurHostName[32];	/* Our hostname */
3982d966958Swdenk extern char	NetOurRootPath[64];	/* Our root path */
3992d966958Swdenk extern ushort	NetBootFileSize;	/* Our boot file size in blocks */
4002d966958Swdenk /** END OF BOOTP EXTENTIONS **/
4012d966958Swdenk extern ulong		NetBootFileXferSize;	/* size of bootfile in bytes */
4022d966958Swdenk extern uchar		NetOurEther[6];		/* Our ethernet address */
4032d966958Swdenk extern uchar		NetServerEther[6];	/* Boot server enet address */
4042d966958Swdenk extern IPaddr_t		NetOurIP;	/* Our    IP addr (0 = unknown) */
4052d966958Swdenk extern IPaddr_t		NetServerIP;	/* Server IP addr (0 = unknown) */
406db288a96SJoe Hershberger extern uchar		*NetTxPacket;		/* THE transmit packet */
407db288a96SJoe Hershberger extern uchar		*NetRxPackets[PKTBUFSRX]; /* Receive packets */
408db288a96SJoe Hershberger extern uchar		*NetRxPacket;		/* Current receive packet */
409d9bec9f4SMike Frysinger extern int		NetRxPacketLen;		/* Current rx packet length */
4102d966958Swdenk extern unsigned		NetIPID;		/* IP ID (counting) */
4112d966958Swdenk extern uchar		NetBcastAddr[6];	/* Ethernet boardcast address */
41268ceb29eSwdenk extern uchar		NetEtherNullAddr[6];
4132d966958Swdenk 
414a3d991bdSwdenk #define VLAN_NONE	4095			/* untagged */
415a3d991bdSwdenk #define VLAN_IDMASK	0x0fff			/* mask of valid vlan id */
416a3d991bdSwdenk extern ushort		NetOurVLAN;		/* Our VLAN */
417a3d991bdSwdenk extern ushort		NetOurNativeVLAN;	/* Our Native VLAN */
418a3d991bdSwdenk 
4192d966958Swdenk extern int		NetRestartWrap;		/* Tried all network devices */
4202d966958Swdenk 
421e4bf0c5cSSimon Glass enum proto_t {
422e4bf0c5cSSimon Glass 	BOOTP, RARP, ARP, TFTPGET, DHCP, PING, DNS, NFS, CDP, NETCONS, SNTP,
423d22c338eSJoe Hershberger 	TFTPSRV, TFTPPUT, LINKLOCAL
424e4bf0c5cSSimon Glass };
4252d966958Swdenk 
4262d966958Swdenk /* from net/net.c */
4272d966958Swdenk extern char	BootFile[128];			/* Boot File name */
4282d966958Swdenk 
4291a32bf41SRobin Getz #if defined(CONFIG_CMD_DNS)
4301a32bf41SRobin Getz extern char *NetDNSResolve;		/* The host to resolve  */
4311a32bf41SRobin Getz extern char *NetDNSenvvar;		/* the env var to put the ip into */
4321a32bf41SRobin Getz #endif
4331a32bf41SRobin Getz 
434639221c7SJon Loeliger #if defined(CONFIG_CMD_PING)
43573a8b27cSwdenk extern IPaddr_t	NetPingIP;			/* the ip address to ping */
43673a8b27cSwdenk #endif
43773a8b27cSwdenk 
438639221c7SJon Loeliger #if defined(CONFIG_CMD_CDP)
439a3d991bdSwdenk /* when CDP completes these hold the return values */
440f575ae1fSJoe Hershberger extern ushort CDPNativeVLAN;		/* CDP returned native VLAN */
441f575ae1fSJoe Hershberger extern ushort CDPApplianceVLAN;		/* CDP returned appliance VLAN */
44217351883SJoe Hershberger 
44317351883SJoe Hershberger /*
44417351883SJoe Hershberger  * Check for a CDP packet by examining the received MAC address field
44517351883SJoe Hershberger  */
44617351883SJoe Hershberger static inline int is_cdp_packet(const uchar *et_addr)
44717351883SJoe Hershberger {
44817351883SJoe Hershberger 	extern const uchar NetCDPAddr[6];
44917351883SJoe Hershberger 
45017351883SJoe Hershberger 	return memcmp(et_addr, NetCDPAddr, 6) == 0;
45117351883SJoe Hershberger }
452a3d991bdSwdenk #endif
453a3d991bdSwdenk 
454639221c7SJon Loeliger #if defined(CONFIG_CMD_SNTP)
455ea287debSwdenk extern IPaddr_t	NetNtpServerIP;			/* the ip address to NTP */
456ea287debSwdenk extern int NetTimeOffset;			/* offset time from UTC */
457ea287debSwdenk #endif
458ea287debSwdenk 
45913dfe943SJoe Hershberger #if defined(CONFIG_MCAST_TFTP)
46013dfe943SJoe Hershberger extern IPaddr_t Mcast_addr;
46113dfe943SJoe Hershberger #endif
46213dfe943SJoe Hershberger 
4632d966958Swdenk /* Initialize the network adapter */
46446c495d5SJoe Hershberger extern void net_init(void);
465e4bf0c5cSSimon Glass extern int NetLoop(enum proto_t);
4662d966958Swdenk 
4672d966958Swdenk /* Shutdown adapters and cleanup */
4682d966958Swdenk extern void	NetStop(void);
4692d966958Swdenk 
4702d966958Swdenk /* Load failed.	 Start again. */
4712d966958Swdenk extern void	NetStartAgain(void);
4722d966958Swdenk 
473a3d991bdSwdenk /* Get size of the ethernet header when we send */
474a3d991bdSwdenk extern int	NetEthHdrSize(void);
475a3d991bdSwdenk 
476a3d991bdSwdenk /* Set ethernet header; returns the size of the header */
477db288a96SJoe Hershberger extern int NetSetEther(uchar *, uchar *, uint);
478e7111015SJoe Hershberger extern int net_update_ether(struct ethernet_hdr *et, uchar *addr, uint prot);
4792d966958Swdenk 
4802d966958Swdenk /* Set IP header */
4814b11c916SJoe Hershberger extern void net_set_ip_header(uchar *pkt, IPaddr_t dest, IPaddr_t source);
4824b11c916SJoe Hershberger extern void net_set_udp_header(uchar *pkt, IPaddr_t dest, int dport,
4834b11c916SJoe Hershberger 				int sport, int len);
4842d966958Swdenk 
485*9b0e35cbSSimon Glass /**
486*9b0e35cbSSimon Glass  * compute_ip_checksum() - Compute IP checksum
487*9b0e35cbSSimon Glass  *
488*9b0e35cbSSimon Glass  * @addr:	Address to check (must be 16-bit aligned)
489*9b0e35cbSSimon Glass  * @nbytes:	Number of bytes to check (normally a multiple of 2)
490*9b0e35cbSSimon Glass  * @return 16-bit IP checksum
491*9b0e35cbSSimon Glass  */
492*9b0e35cbSSimon Glass unsigned compute_ip_checksum(const void *addr, unsigned nbytes);
493*9b0e35cbSSimon Glass 
494*9b0e35cbSSimon Glass /**
495*9b0e35cbSSimon Glass  * add_ip_checksums() - add two IP checksums
496*9b0e35cbSSimon Glass  *
497*9b0e35cbSSimon Glass  * @offset:	Offset of first sum (if odd we do a byte-swap)
498*9b0e35cbSSimon Glass  * @sum:	First checksum
499*9b0e35cbSSimon Glass  * @new_sum:	New checksum to add
500*9b0e35cbSSimon Glass  * @return updated 16-bit IP checksum
501*9b0e35cbSSimon Glass  */
502*9b0e35cbSSimon Glass unsigned add_ip_checksums(unsigned offset, unsigned sum, unsigned new_sum);
503*9b0e35cbSSimon Glass 
504*9b0e35cbSSimon Glass /**
505*9b0e35cbSSimon Glass  * ip_checksum_ok() - check if a checksum is correct
506*9b0e35cbSSimon Glass  *
507*9b0e35cbSSimon Glass  * This works by making sure the checksum sums to 0
508*9b0e35cbSSimon Glass  *
509*9b0e35cbSSimon Glass  * @addr:	Address to check (must be 16-bit aligned)
510*9b0e35cbSSimon Glass  * @nbytes:	Number of bytes to check (normally a multiple of 2)
511*9b0e35cbSSimon Glass  * @return true if the checksum matches, false if not
512*9b0e35cbSSimon Glass  */
513*9b0e35cbSSimon Glass int ip_checksum_ok(const void *addr, unsigned nbytes);
514*9b0e35cbSSimon Glass 
5152d966958Swdenk /* Checksum */
5162d966958Swdenk extern int	NetCksumOk(uchar *, int);	/* Return true if cksum OK */
5172d966958Swdenk extern uint	NetCksum(uchar *, int);		/* Calculate the checksum */
5182d966958Swdenk 
519d280d3f4SJoe Hershberger /* Callbacks */
520ece223b5SJoe Hershberger extern rxhand_f *net_get_udp_handler(void);	/* Get UDP RX packet handler */
521ece223b5SJoe Hershberger extern void net_set_udp_handler(rxhand_f *);	/* Set UDP RX packet handler */
522ece223b5SJoe Hershberger extern rxhand_f *net_get_arp_handler(void);	/* Get ARP RX packet handler */
523ece223b5SJoe Hershberger extern void net_set_arp_handler(rxhand_f *);	/* Set ARP RX packet handler */
5244793ee65SSimon Glass extern void net_set_icmp_handler(rxhand_icmp_f *f); /* Set ICMP RX handler */
5253e01d75fSwdenk extern void	NetSetTimeout(ulong, thand_f *);/* Set timeout handler */
5262d966958Swdenk 
52722f6e99dSJoe Hershberger /* Network loop state */
52822f6e99dSJoe Hershberger enum net_loop_state {
52922f6e99dSJoe Hershberger 	NETLOOP_CONTINUE,
53022f6e99dSJoe Hershberger 	NETLOOP_RESTART,
53122f6e99dSJoe Hershberger 	NETLOOP_SUCCESS,
53222f6e99dSJoe Hershberger 	NETLOOP_FAIL
53322f6e99dSJoe Hershberger };
53422f6e99dSJoe Hershberger extern enum net_loop_state net_state;
53522f6e99dSJoe Hershberger 
53606370590SKim Phillips static inline void net_set_state(enum net_loop_state state)
53706370590SKim Phillips {
5384ef8d53cSJoe Hershberger 	debug_cond(DEBUG_INT_STATE, "--- NetState set to %d\n", state);
53922f6e99dSJoe Hershberger 	net_state = state;
54022f6e99dSJoe Hershberger }
54122f6e99dSJoe Hershberger 
542e94070c4SJoe Hershberger /* Transmit a packet */
543adf5d93eSJoe Hershberger static inline void NetSendPacket(uchar *pkt, int len)
544adf5d93eSJoe Hershberger {
545adf5d93eSJoe Hershberger 	(void) eth_send(pkt, len);
546adf5d93eSJoe Hershberger }
5472d966958Swdenk 
548206d07fdSJoe Hershberger /*
549e94070c4SJoe Hershberger  * Transmit "NetTxPacket" as UDP packet, performing ARP request if needed
550ece223b5SJoe Hershberger  *  (ether will be populated)
551206d07fdSJoe Hershberger  *
552206d07fdSJoe Hershberger  * @param ether Raw packet buffer
553206d07fdSJoe Hershberger  * @param dest IP address to send the datagram to
554206d07fdSJoe Hershberger  * @param dport Destination UDP port
555206d07fdSJoe Hershberger  * @param sport Source UDP port
556206d07fdSJoe Hershberger  * @param payload_len Length of data after the UDP header
557206d07fdSJoe Hershberger  */
558b28e28bbSJoe Hershberger extern int NetSendUDPPacket(uchar *ether, IPaddr_t dest, int dport,
559206d07fdSJoe Hershberger 			int sport, int payload_len);
56073a8b27cSwdenk 
5612d966958Swdenk /* Processes a received packet */
562db288a96SJoe Hershberger extern void NetReceive(uchar *, int);
5632d966958Swdenk 
56448522bb5SJoe Hershberger #ifdef CONFIG_NETCONSOLE
56548522bb5SJoe Hershberger void NcStart(void);
5668a0eccb1SJoe Hershberger int nc_input_packet(uchar *pkt, IPaddr_t src_ip, unsigned dest_port,
5678a0eccb1SJoe Hershberger 	unsigned src_port, unsigned len);
56848522bb5SJoe Hershberger #endif
56948522bb5SJoe Hershberger 
570f8be7d65SJoe Hershberger static inline __attribute__((always_inline)) int eth_is_on_demand_init(void)
571f8be7d65SJoe Hershberger {
572f8be7d65SJoe Hershberger #ifdef CONFIG_NETCONSOLE
573f8be7d65SJoe Hershberger 	extern enum proto_t net_loop_last_protocol;
574f8be7d65SJoe Hershberger 
575f8be7d65SJoe Hershberger 	return net_loop_last_protocol != NETCONS;
576f8be7d65SJoe Hershberger #else
577f8be7d65SJoe Hershberger 	return 1;
578f8be7d65SJoe Hershberger #endif
579f8be7d65SJoe Hershberger }
580f8be7d65SJoe Hershberger 
581f8be7d65SJoe Hershberger static inline void eth_set_last_protocol(int protocol)
582f8be7d65SJoe Hershberger {
583f8be7d65SJoe Hershberger #ifdef CONFIG_NETCONSOLE
584f8be7d65SJoe Hershberger 	extern enum proto_t net_loop_last_protocol;
585f8be7d65SJoe Hershberger 
586f8be7d65SJoe Hershberger 	net_loop_last_protocol = protocol;
587f8be7d65SJoe Hershberger #endif
588f8be7d65SJoe Hershberger }
589f8be7d65SJoe Hershberger 
5902d966958Swdenk /*
591e4a3d57dSSimon Glass  * Check if autoload is enabled. If so, use either NFS or TFTP to download
592e4a3d57dSSimon Glass  * the boot file.
593e4a3d57dSSimon Glass  */
594e4a3d57dSSimon Glass void net_auto_load(void);
595e4a3d57dSSimon Glass 
596e4a3d57dSSimon Glass /*
5972d966958Swdenk  * The following functions are a bit ugly, but necessary to deal with
5982d966958Swdenk  * alignment restrictions on ARM.
5992d966958Swdenk  *
6002d966958Swdenk  * We're using inline functions, which had the smallest memory
6012d966958Swdenk  * footprint in our tests.
6022d966958Swdenk  */
6032d966958Swdenk /* return IP *in network byteorder* */
604db288a96SJoe Hershberger static inline IPaddr_t NetReadIP(void *from)
6052d966958Swdenk {
6062d966958Swdenk 	IPaddr_t ip;
607b28e28bbSJoe Hershberger 
60833a4a70dSAnatolij Gustschin 	memcpy((void *)&ip, (void *)from, sizeof(ip));
6092d966958Swdenk 	return ip;
6102d966958Swdenk }
6112d966958Swdenk 
6122d966958Swdenk /* return ulong *in network byteorder* */
6132d966958Swdenk static inline ulong NetReadLong(ulong *from)
6142d966958Swdenk {
6152d966958Swdenk 	ulong l;
616b28e28bbSJoe Hershberger 
6172d966958Swdenk 	memcpy((void *)&l, (void *)from, sizeof(l));
6182d966958Swdenk 	return l;
6192d966958Swdenk }
6202d966958Swdenk 
6212d966958Swdenk /* write IP *in network byteorder* */
6222d966958Swdenk static inline void NetWriteIP(void *to, IPaddr_t ip)
6232d966958Swdenk {
6242d966958Swdenk 	memcpy(to, (void *)&ip, sizeof(ip));
6252d966958Swdenk }
6262d966958Swdenk 
6272d966958Swdenk /* copy IP */
628db288a96SJoe Hershberger static inline void NetCopyIP(void *to, void *from)
6292d966958Swdenk {
63033a4a70dSAnatolij Gustschin 	memcpy((void *)to, from, sizeof(IPaddr_t));
6312d966958Swdenk }
6322d966958Swdenk 
6332d966958Swdenk /* copy ulong */
6342d966958Swdenk static inline void NetCopyLong(ulong *to, ulong *from)
6352d966958Swdenk {
6362d966958Swdenk 	memcpy((void *)to, (void *)from, sizeof(ulong));
6372d966958Swdenk }
6382d966958Swdenk 
63950cca8b9SMike Rapoport /**
64050cca8b9SMike Rapoport  * is_zero_ether_addr - Determine if give Ethernet address is all zeros.
64150cca8b9SMike Rapoport  * @addr: Pointer to a six-byte array containing the Ethernet address
64250cca8b9SMike Rapoport  *
64350cca8b9SMike Rapoport  * Return true if the address is all zeroes.
64450cca8b9SMike Rapoport  */
64550cca8b9SMike Rapoport static inline int is_zero_ether_addr(const u8 *addr)
64650cca8b9SMike Rapoport {
64750cca8b9SMike Rapoport 	return !(addr[0] | addr[1] | addr[2] | addr[3] | addr[4] | addr[5]);
64850cca8b9SMike Rapoport }
64950cca8b9SMike Rapoport 
65050cca8b9SMike Rapoport /**
65150cca8b9SMike Rapoport  * is_multicast_ether_addr - Determine if the Ethernet address is a multicast.
65250cca8b9SMike Rapoport  * @addr: Pointer to a six-byte array containing the Ethernet address
65350cca8b9SMike Rapoport  *
65450cca8b9SMike Rapoport  * Return true if the address is a multicast address.
65550cca8b9SMike Rapoport  * By definition the broadcast address is also a multicast address.
65650cca8b9SMike Rapoport  */
65750cca8b9SMike Rapoport static inline int is_multicast_ether_addr(const u8 *addr)
65850cca8b9SMike Rapoport {
659b28e28bbSJoe Hershberger 	return 0x01 & addr[0];
66050cca8b9SMike Rapoport }
66150cca8b9SMike Rapoport 
66223cd1385SRemy Bohmer /*
66323cd1385SRemy Bohmer  * is_broadcast_ether_addr - Determine if the Ethernet address is broadcast
66423cd1385SRemy Bohmer  * @addr: Pointer to a six-byte array containing the Ethernet address
66523cd1385SRemy Bohmer  *
66623cd1385SRemy Bohmer  * Return true if the address is the broadcast address.
66723cd1385SRemy Bohmer  */
66823cd1385SRemy Bohmer static inline int is_broadcast_ether_addr(const u8 *addr)
66923cd1385SRemy Bohmer {
670b28e28bbSJoe Hershberger 	return (addr[0] & addr[1] & addr[2] & addr[3] & addr[4] & addr[5]) ==
671b28e28bbSJoe Hershberger 		0xff;
67223cd1385SRemy Bohmer }
67323cd1385SRemy Bohmer 
67423cd1385SRemy Bohmer /*
67575edebe3SMike Frysinger  * is_valid_ether_addr - Determine if the given Ethernet address is valid
67675edebe3SMike Frysinger  * @addr: Pointer to a six-byte array containing the Ethernet address
67775edebe3SMike Frysinger  *
67875edebe3SMike Frysinger  * Check that the Ethernet address (MAC) is not 00:00:00:00:00:00, is not
67975edebe3SMike Frysinger  * a multicast address, and is not FF:FF:FF:FF:FF:FF.
68075edebe3SMike Frysinger  *
68175edebe3SMike Frysinger  * Return true if the address is valid.
68275edebe3SMike Frysinger  */
68375edebe3SMike Frysinger static inline int is_valid_ether_addr(const u8 *addr)
68475edebe3SMike Frysinger {
68575edebe3SMike Frysinger 	/* FF:FF:FF:FF:FF:FF is a multicast address so we don't need to
68675edebe3SMike Frysinger 	 * explicitly check for it here. */
68775edebe3SMike Frysinger 	return !is_multicast_ether_addr(addr) && !is_zero_ether_addr(addr);
68875edebe3SMike Frysinger }
68975edebe3SMike Frysinger 
690da384a9dSMasahiro Yamada /**
691da384a9dSMasahiro Yamada  * eth_random_addr - Generate software assigned random Ethernet address
692da384a9dSMasahiro Yamada  * @addr: Pointer to a six-byte array containing the Ethernet address
693da384a9dSMasahiro Yamada  *
694da384a9dSMasahiro Yamada  * Generate a random Ethernet address (MAC) that is not multicast
695da384a9dSMasahiro Yamada  * and has the local assigned bit set.
696da384a9dSMasahiro Yamada  */
697da384a9dSMasahiro Yamada static inline void eth_random_addr(uchar *addr)
698da384a9dSMasahiro Yamada {
699da384a9dSMasahiro Yamada 	int i;
700da384a9dSMasahiro Yamada 	unsigned int seed = get_timer(0);
701da384a9dSMasahiro Yamada 
702da384a9dSMasahiro Yamada 	for (i = 0; i < 6; i++)
703da384a9dSMasahiro Yamada 		addr[i] = rand_r(&seed);
704da384a9dSMasahiro Yamada 
705da384a9dSMasahiro Yamada 	addr[0] &= 0xfe;	/* clear multicast bit */
706da384a9dSMasahiro Yamada 	addr[0] |= 0x02;	/* set local assignment bit (IEEE802) */
707da384a9dSMasahiro Yamada }
708da384a9dSMasahiro Yamada 
7092d966958Swdenk /* Convert an IP address to a string */
7102d966958Swdenk extern void ip_to_string(IPaddr_t x, char *s);
7112d966958Swdenk 
71273a8b27cSwdenk /* Convert a string to ip address */
713908c6b62SMike Frysinger extern IPaddr_t string_to_ip(const char *s);
71473a8b27cSwdenk 
715a3d991bdSwdenk /* Convert a VLAN id to a string */
716a3d991bdSwdenk extern void VLAN_to_string(ushort x, char *s);
717a3d991bdSwdenk 
718a3d991bdSwdenk /* Convert a string to a vlan id */
7192e3ef6e4SMike Frysinger extern ushort string_to_VLAN(const char *s);
720a3d991bdSwdenk 
721a3d991bdSwdenk /* read a VLAN id from an environment variable */
722a3d991bdSwdenk extern ushort getenv_VLAN(char *);
723a3d991bdSwdenk 
7242d966958Swdenk /* copy a filename (allow for "..." notation, limit length) */
725b920ee9dSMike Frysinger extern void copy_filename(char *dst, const char *src, int size);
7262d966958Swdenk 
72791b469c9SMike Frysinger /* get a random source port */
72891b469c9SMike Frysinger extern unsigned int random_port(void);
72991b469c9SMike Frysinger 
730ea5427e2SSimon Glass /* Update U-Boot over TFTP */
731ea5427e2SSimon Glass extern int update_tftp(ulong addr);
732ea5427e2SSimon Glass 
7332d966958Swdenk /**********************************************************************/
7342d966958Swdenk 
7352d966958Swdenk #endif /* __NET_H__ */
736