xref: /rk3399_rockchip-uboot/include/net.h (revision ff99743254c260e86b36bbbbfd1fe72a876c2ad9)
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 
100*ff997432SJoe Hershberger int eth_initialize(bd_t *bis);	/* Initialize network subsystem */
101*ff997432SJoe Hershberger int eth_register(struct eth_device *dev);/* Register network device */
102*ff997432SJoe Hershberger int eth_unregister(struct eth_device *dev);/* Remove network device */
103*ff997432SJoe Hershberger void eth_try_another(int first_restart);	/* Change the device */
104*ff997432SJoe Hershberger 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 }
1148b2c9a71SJoe Hershberger 
1158b2c9a71SJoe Hershberger static inline unsigned char *eth_get_ethaddr(void)
1168b2c9a71SJoe Hershberger {
1178b2c9a71SJoe Hershberger 	if (eth_current)
1188b2c9a71SJoe Hershberger 		return eth_current->enetaddr;
1198b2c9a71SJoe Hershberger 	return NULL;
1208b2c9a71SJoe Hershberger }
1218b2c9a71SJoe Hershberger 
122*ff997432SJoe Hershberger struct eth_device *eth_get_dev_by_name(const char *devname);
123*ff997432SJoe Hershberger struct eth_device *eth_get_dev_by_index(int index); /* get dev @ index */
124*ff997432SJoe Hershberger int eth_get_dev_index(void);		/* get the device index */
125*ff997432SJoe Hershberger void eth_parse_enetaddr(const char *addr, uchar *enetaddr);
126*ff997432SJoe Hershberger int eth_getenv_enetaddr(char *name, uchar *enetaddr);
127*ff997432SJoe Hershberger int eth_setenv_enetaddr(char *name, const uchar *enetaddr);
1287616e785SSimon Glass 
1297616e785SSimon Glass /*
1307616e785SSimon Glass  * Get the hardware address for an ethernet interface .
1317616e785SSimon Glass  * Args:
1327616e785SSimon Glass  *	base_name - base name for device (normally "eth")
1337616e785SSimon Glass  *	index - device index number (0 for first)
1347616e785SSimon Glass  *	enetaddr - returns 6 byte hardware address
1357616e785SSimon Glass  * Returns:
1367616e785SSimon Glass  *	Return true if the address is valid.
1377616e785SSimon Glass  */
138*ff997432SJoe Hershberger int eth_getenv_enetaddr_by_index(const char *base_name, int index,
1397616e785SSimon Glass 				 uchar *enetaddr);
1402d966958Swdenk 
141*ff997432SJoe Hershberger int usb_eth_initialize(bd_t *bi);
142*ff997432SJoe Hershberger int eth_init(bd_t *bis);			/* Initialize the device */
143*ff997432SJoe Hershberger int eth_send(void *packet, int length);	   /* Send a packet */
14423cd1385SRemy Bohmer 
145f85b6071SRafal Jaworowski #ifdef CONFIG_API
146*ff997432SJoe Hershberger int eth_receive(void *packet, int length); /* Receive a packet*/
147db288a96SJoe Hershberger extern void (*push_packet)(void *packet, int length);
148f85b6071SRafal Jaworowski #endif
149*ff997432SJoe Hershberger int eth_rx(void);			/* Check for received packets */
150*ff997432SJoe Hershberger void eth_halt(void);			/* stop SCC */
151*ff997432SJoe Hershberger char *eth_get_name(void);		/* get name of current device */
1522d966958Swdenk 
153f8be7d65SJoe Hershberger /* Set active state */
154f8be7d65SJoe Hershberger static inline __attribute__((always_inline)) int eth_init_state_only(bd_t *bis)
155f8be7d65SJoe Hershberger {
156f8be7d65SJoe Hershberger 	eth_get_dev()->state = ETH_STATE_ACTIVE;
157f8be7d65SJoe Hershberger 
158f8be7d65SJoe Hershberger 	return 0;
159f8be7d65SJoe Hershberger }
160f8be7d65SJoe Hershberger /* Set passive state */
161f8be7d65SJoe Hershberger static inline __attribute__((always_inline)) void eth_halt_state_only(void)
162f8be7d65SJoe Hershberger {
163f8be7d65SJoe Hershberger 	eth_get_dev()->state = ETH_STATE_PASSIVE;
164f8be7d65SJoe Hershberger }
165f8be7d65SJoe Hershberger 
1667616e785SSimon Glass /*
1677616e785SSimon Glass  * Set the hardware address for an ethernet interface based on 'eth%daddr'
1687616e785SSimon Glass  * environment variable (or just 'ethaddr' if eth_number is 0).
1697616e785SSimon Glass  * Args:
1707616e785SSimon Glass  *	base_name - base name for device (normally "eth")
1717616e785SSimon Glass  *	eth_number - value of %d (0 for first device of this type)
1727616e785SSimon Glass  * Returns:
1737616e785SSimon Glass  *	0 is success, non-zero is error status from driver.
1747616e785SSimon Glass  */
1757616e785SSimon Glass int eth_write_hwaddr(struct eth_device *dev, const char *base_name,
1767616e785SSimon Glass 		     int eth_number);
1777616e785SSimon Glass 
17853a5c424SDavid Updegraff #ifdef CONFIG_MCAST_TFTP
17953a5c424SDavid Updegraff int eth_mcast_join(IPaddr_t mcast_addr, u8 join);
18053a5c424SDavid Updegraff u32 ether_crc(size_t len, unsigned char const *p);
18153a5c424SDavid Updegraff #endif
18253a5c424SDavid Updegraff 
1832d966958Swdenk 
1842d966958Swdenk /**********************************************************************/
1852d966958Swdenk /*
1862d966958Swdenk  *	Protocol headers.
1872d966958Swdenk  */
1882d966958Swdenk 
1892d966958Swdenk /*
1902d966958Swdenk  *	Ethernet header
1912d966958Swdenk  */
192cb487f56SJoe Hershberger 
193cb487f56SJoe Hershberger struct ethernet_hdr {
194cb487f56SJoe Hershberger 	uchar		et_dest[6];	/* Destination node		*/
195cb487f56SJoe Hershberger 	uchar		et_src[6];	/* Source node			*/
196cb487f56SJoe Hershberger 	ushort		et_protlen;	/* Protocol or length		*/
197cb487f56SJoe Hershberger };
198cb487f56SJoe Hershberger 
199cb487f56SJoe Hershberger /* Ethernet header size */
200cb487f56SJoe Hershberger #define ETHER_HDR_SIZE	(sizeof(struct ethernet_hdr))
201cb487f56SJoe Hershberger 
202a7c3d5e2SBin Meng #define ETH_FCS_LEN	4		/* Octets in the FCS		*/
203a7c3d5e2SBin Meng 
204cb487f56SJoe Hershberger struct e802_hdr {
2052d966958Swdenk 	uchar		et_dest[6];	/* Destination node		*/
2062d966958Swdenk 	uchar		et_src[6];	/* Source node			*/
2072d966958Swdenk 	ushort		et_protlen;	/* Protocol or length		*/
2082d966958Swdenk 	uchar		et_dsap;	/* 802 DSAP			*/
2092d966958Swdenk 	uchar		et_ssap;	/* 802 SSAP			*/
2102d966958Swdenk 	uchar		et_ctl;		/* 802 control			*/
2112d966958Swdenk 	uchar		et_snap1;	/* SNAP				*/
2122d966958Swdenk 	uchar		et_snap2;
2132d966958Swdenk 	uchar		et_snap3;
2142d966958Swdenk 	ushort		et_prot;	/* 802 protocol			*/
215cb487f56SJoe Hershberger };
2162d966958Swdenk 
217da5ebe2cSJoe Hershberger /* 802 + SNAP + ethernet header size */
218cb487f56SJoe Hershberger #define E802_HDR_SIZE	(sizeof(struct e802_hdr))
219a3d991bdSwdenk 
220a3d991bdSwdenk /*
221da5ebe2cSJoe Hershberger  *	Virtual LAN Ethernet header
222a3d991bdSwdenk  */
223c68cca35SJoe Hershberger struct vlan_ethernet_hdr {
224a3d991bdSwdenk 	uchar		vet_dest[6];	/* Destination node		*/
225a3d991bdSwdenk 	uchar		vet_src[6];	/* Source node			*/
226a3d991bdSwdenk 	ushort		vet_vlan_type;	/* PROT_VLAN			*/
227a3d991bdSwdenk 	ushort		vet_tag;	/* TAG of VLAN			*/
228a3d991bdSwdenk 	ushort		vet_type;	/* protocol type		*/
229c68cca35SJoe Hershberger };
230a3d991bdSwdenk 
231c68cca35SJoe Hershberger /* VLAN Ethernet header size */
232c68cca35SJoe Hershberger #define VLAN_ETHER_HDR_SIZE	(sizeof(struct vlan_ethernet_hdr))
233a3d991bdSwdenk 
2342d966958Swdenk #define PROT_IP		0x0800		/* IP protocol			*/
2352d966958Swdenk #define PROT_ARP	0x0806		/* IP ARP protocol		*/
2362d966958Swdenk #define PROT_RARP	0x8035		/* IP ARP protocol		*/
237a3d991bdSwdenk #define PROT_VLAN	0x8100		/* IEEE 802.1q protocol		*/
2382d966958Swdenk 
2392d966958Swdenk #define IPPROTO_ICMP	 1	/* Internet Control Message Protocol	*/
2402d966958Swdenk #define IPPROTO_UDP	17	/* User Datagram Protocol		*/
2412d966958Swdenk 
2422d966958Swdenk /*
243c5c59df0SJoe Hershberger  *	Internet Protocol (IP) header.
244c5c59df0SJoe Hershberger  */
245c5c59df0SJoe Hershberger struct ip_hdr {
246c5c59df0SJoe Hershberger 	uchar		ip_hl_v;	/* header length and version	*/
247c5c59df0SJoe Hershberger 	uchar		ip_tos;		/* type of service		*/
248c5c59df0SJoe Hershberger 	ushort		ip_len;		/* total length			*/
249c5c59df0SJoe Hershberger 	ushort		ip_id;		/* identification		*/
250c5c59df0SJoe Hershberger 	ushort		ip_off;		/* fragment offset field	*/
251c5c59df0SJoe Hershberger 	uchar		ip_ttl;		/* time to live			*/
252c5c59df0SJoe Hershberger 	uchar		ip_p;		/* protocol			*/
253c5c59df0SJoe Hershberger 	ushort		ip_sum;		/* checksum			*/
254c5c59df0SJoe Hershberger 	IPaddr_t	ip_src;		/* Source IP address		*/
255c5c59df0SJoe Hershberger 	IPaddr_t	ip_dst;		/* Destination IP address	*/
256c5c59df0SJoe Hershberger };
257c5c59df0SJoe Hershberger 
258c5c59df0SJoe Hershberger #define IP_OFFS		0x1fff /* ip offset *= 8 */
259c5c59df0SJoe Hershberger #define IP_FLAGS	0xe000 /* first 3 bits */
260c5c59df0SJoe Hershberger #define IP_FLAGS_RES	0x8000 /* reserved */
261c5c59df0SJoe Hershberger #define IP_FLAGS_DFRAG	0x4000 /* don't fragments */
262c5c59df0SJoe Hershberger #define IP_FLAGS_MFRAG	0x2000 /* more fragments */
263c5c59df0SJoe Hershberger 
264c5c59df0SJoe Hershberger #define IP_HDR_SIZE		(sizeof(struct ip_hdr))
265c5c59df0SJoe Hershberger 
266c5c59df0SJoe Hershberger /*
267594c26f8SJoe Hershberger  *	Internet Protocol (IP) + UDP header.
2682d966958Swdenk  */
269594c26f8SJoe Hershberger struct ip_udp_hdr {
2702d966958Swdenk 	uchar		ip_hl_v;	/* header length and version	*/
2712d966958Swdenk 	uchar		ip_tos;		/* type of service		*/
2722d966958Swdenk 	ushort		ip_len;		/* total length			*/
2732d966958Swdenk 	ushort		ip_id;		/* identification		*/
2742d966958Swdenk 	ushort		ip_off;		/* fragment offset field	*/
2752d966958Swdenk 	uchar		ip_ttl;		/* time to live			*/
2762d966958Swdenk 	uchar		ip_p;		/* protocol			*/
2772d966958Swdenk 	ushort		ip_sum;		/* checksum			*/
2782d966958Swdenk 	IPaddr_t	ip_src;		/* Source IP address		*/
2792d966958Swdenk 	IPaddr_t	ip_dst;		/* Destination IP address	*/
2802d966958Swdenk 	ushort		udp_src;	/* UDP source port		*/
2812d966958Swdenk 	ushort		udp_dst;	/* UDP destination port		*/
2822d966958Swdenk 	ushort		udp_len;	/* Length of UDP packet		*/
2832d966958Swdenk 	ushort		udp_xsum;	/* Checksum			*/
284594c26f8SJoe Hershberger };
2852d966958Swdenk 
286594c26f8SJoe Hershberger #define IP_UDP_HDR_SIZE		(sizeof(struct ip_udp_hdr))
287c5c59df0SJoe Hershberger #define UDP_HDR_SIZE		(IP_UDP_HDR_SIZE - IP_HDR_SIZE)
2882d966958Swdenk 
2892d966958Swdenk /*
2902d966958Swdenk  *	Address Resolution Protocol (ARP) header.
2912d966958Swdenk  */
292738853bbSJoe Hershberger struct arp_hdr {
2932d966958Swdenk 	ushort		ar_hrd;		/* Format of hardware address	*/
2942d966958Swdenk #   define ARP_ETHER	    1		/* Ethernet  hardware address	*/
2952d966958Swdenk 	ushort		ar_pro;		/* Format of protocol address	*/
2962d966958Swdenk 	uchar		ar_hln;		/* Length of hardware address	*/
297674bb249SJoe Hershberger #   define ARP_HLEN	6
2982d966958Swdenk 	uchar		ar_pln;		/* Length of protocol address	*/
299674bb249SJoe Hershberger #   define ARP_PLEN	4
3002d966958Swdenk 	ushort		ar_op;		/* Operation			*/
3012d966958Swdenk #   define ARPOP_REQUEST    1		/* Request  to resolve  address	*/
3022d966958Swdenk #   define ARPOP_REPLY	    2		/* Response to previous request	*/
3032d966958Swdenk 
3042d966958Swdenk #   define RARPOP_REQUEST   3		/* Request  to resolve  address	*/
3052d966958Swdenk #   define RARPOP_REPLY	    4		/* Response to previous request */
3062d966958Swdenk 
3072d966958Swdenk 	/*
3082d966958Swdenk 	 * The remaining fields are variable in size, according to
3092d966958Swdenk 	 * the sizes above, and are defined as appropriate for
3102d966958Swdenk 	 * specific hardware/protocol combinations.
3112d966958Swdenk 	 */
3122d966958Swdenk 	uchar		ar_data[0];
313674bb249SJoe Hershberger #define ar_sha		ar_data[0]
314674bb249SJoe Hershberger #define ar_spa		ar_data[ARP_HLEN]
315674bb249SJoe Hershberger #define ar_tha		ar_data[ARP_HLEN + ARP_PLEN]
316674bb249SJoe Hershberger #define ar_tpa		ar_data[ARP_HLEN + ARP_PLEN + ARP_HLEN]
3172d966958Swdenk #if 0
3182d966958Swdenk 	uchar		ar_sha[];	/* Sender hardware address	*/
3192d966958Swdenk 	uchar		ar_spa[];	/* Sender protocol address	*/
3202d966958Swdenk 	uchar		ar_tha[];	/* Target hardware address	*/
3212d966958Swdenk 	uchar		ar_tpa[];	/* Target protocol address	*/
3222d966958Swdenk #endif /* 0 */
323738853bbSJoe Hershberger };
3242d966958Swdenk 
3252d966958Swdenk #define ARP_HDR_SIZE	(8+20)		/* Size assuming ethernet	*/
3262d966958Swdenk 
3272d966958Swdenk /*
3282d966958Swdenk  * ICMP stuff (just enough to handle (host) redirect messages)
3292d966958Swdenk  */
33073a8b27cSwdenk #define ICMP_ECHO_REPLY		0	/* Echo reply			*/
3314793ee65SSimon Glass #define ICMP_NOT_REACH		3	/* Detination unreachable	*/
3322d966958Swdenk #define ICMP_REDIRECT		5	/* Redirect (change route)	*/
33373a8b27cSwdenk #define ICMP_ECHO_REQUEST	8	/* Echo request			*/
3342d966958Swdenk 
3352d966958Swdenk /* Codes for REDIRECT. */
3362d966958Swdenk #define ICMP_REDIR_NET		0	/* Redirect Net			*/
3372d966958Swdenk #define ICMP_REDIR_HOST		1	/* Redirect Host		*/
3382d966958Swdenk 
3394793ee65SSimon Glass /* Codes for NOT_REACH */
3404793ee65SSimon Glass #define ICMP_NOT_REACH_PORT	3	/* Port unreachable		*/
3414793ee65SSimon Glass 
342e0a63079SJoe Hershberger struct icmp_hdr {
3432d966958Swdenk 	uchar		type;
3442d966958Swdenk 	uchar		code;
3452d966958Swdenk 	ushort		checksum;
3462d966958Swdenk 	union {
3472d966958Swdenk 		struct {
3482d966958Swdenk 			ushort	id;
3492d966958Swdenk 			ushort	sequence;
3502d966958Swdenk 		} echo;
3512d966958Swdenk 		ulong	gateway;
3522d966958Swdenk 		struct {
3536e840ebcSJeroen Hofstee 			ushort	unused;
3542d966958Swdenk 			ushort	mtu;
3552d966958Swdenk 		} frag;
3564793ee65SSimon Glass 		uchar data[0];
3572d966958Swdenk 	} un;
358e0a63079SJoe Hershberger };
3592d966958Swdenk 
360e0a63079SJoe Hershberger #define ICMP_HDR_SIZE		(sizeof(struct icmp_hdr))
361e0a63079SJoe Hershberger #define IP_ICMP_HDR_SIZE	(IP_HDR_SIZE + ICMP_HDR_SIZE)
3622d966958Swdenk 
3632d966958Swdenk /*
3642d966958Swdenk  * Maximum packet size; used to allocate packet storage.
3652d966958Swdenk  * TFTP packets can be 524 bytes + IP header + ethernet header.
3662d966958Swdenk  * Lets be conservative, and go for 38 * 16.  (Must also be
3672d966958Swdenk  * a multiple of 32 bytes).
3682d966958Swdenk  */
3692d966958Swdenk /*
3702d966958Swdenk  * AS.HARNOIS : Better to set PKTSIZE to maximum size because
3712d966958Swdenk  * traffic type is not always controlled
3722d966958Swdenk  * maximum packet size =  1518
3732d966958Swdenk  * maximum packet size and multiple of 32 bytes =  1536
3742d966958Swdenk  */
3752d966958Swdenk #define PKTSIZE			1518
3762d966958Swdenk #define PKTSIZE_ALIGN		1536
3772d966958Swdenk /*#define PKTSIZE		608*/
3782d966958Swdenk 
3792d966958Swdenk /*
3802d966958Swdenk  * Maximum receive ring size; that is, the number of packets
3812d966958Swdenk  * we can buffer before overflow happens. Basically, this just
3822d966958Swdenk  * needs to be enough to prevent a packet being discarded while
3832d966958Swdenk  * we are processing the previous one.
3842d966958Swdenk  */
3852d966958Swdenk #define RINGSZ		4
3862d966958Swdenk #define RINGSZ_LOG2	2
3872d966958Swdenk 
3882d966958Swdenk /**********************************************************************/
3892d966958Swdenk /*
3902d966958Swdenk  *	Globals.
3912d966958Swdenk  *
3922d966958Swdenk  * Note:
3932d966958Swdenk  *
3942d966958Swdenk  * All variables of type IPaddr_t are stored in NETWORK byte order
3952d966958Swdenk  * (big endian).
3962d966958Swdenk  */
3972d966958Swdenk 
3982d966958Swdenk /* net.c */
3992d966958Swdenk /** BOOTP EXTENTIONS **/
400b28e28bbSJoe Hershberger extern IPaddr_t NetOurGatewayIP;	/* Our gateway IP address */
4012d966958Swdenk extern IPaddr_t NetOurSubnetMask;	/* Our subnet mask (0 = unknown) */
4022d966958Swdenk extern IPaddr_t NetOurDNSIP;	/* Our Domain Name Server (0 = unknown) */
4031fe80d79SJon Loeliger #if defined(CONFIG_BOOTP_DNS2)
404fe389a82Sstroese extern IPaddr_t NetOurDNS2IP;	/* Our 2nd Domain Name Server (0 = unknown) */
405fe389a82Sstroese #endif
4062d966958Swdenk extern char	NetOurNISDomain[32];	/* Our NIS domain */
4072d966958Swdenk extern char	NetOurHostName[32];	/* Our hostname */
4082d966958Swdenk extern char	NetOurRootPath[64];	/* Our root path */
4092d966958Swdenk extern ushort	NetBootFileSize;	/* Our boot file size in blocks */
4102d966958Swdenk /** END OF BOOTP EXTENTIONS **/
4112d966958Swdenk extern ulong		NetBootFileXferSize;	/* size of bootfile in bytes */
4122d966958Swdenk extern uchar		NetOurEther[6];		/* Our ethernet address */
4132d966958Swdenk extern uchar		NetServerEther[6];	/* Boot server enet address */
4142d966958Swdenk extern IPaddr_t		NetOurIP;	/* Our    IP addr (0 = unknown) */
4152d966958Swdenk extern IPaddr_t		NetServerIP;	/* Server IP addr (0 = unknown) */
416db288a96SJoe Hershberger extern uchar		*NetTxPacket;		/* THE transmit packet */
417db288a96SJoe Hershberger extern uchar		*NetRxPackets[PKTBUFSRX]; /* Receive packets */
418db288a96SJoe Hershberger extern uchar		*NetRxPacket;		/* Current receive packet */
419d9bec9f4SMike Frysinger extern int		NetRxPacketLen;		/* Current rx packet length */
4202d966958Swdenk extern unsigned		NetIPID;		/* IP ID (counting) */
4212d966958Swdenk extern uchar		NetBcastAddr[6];	/* Ethernet boardcast address */
42268ceb29eSwdenk extern uchar		NetEtherNullAddr[6];
4232d966958Swdenk 
424a3d991bdSwdenk #define VLAN_NONE	4095			/* untagged */
425a3d991bdSwdenk #define VLAN_IDMASK	0x0fff			/* mask of valid vlan id */
426a3d991bdSwdenk extern ushort		NetOurVLAN;		/* Our VLAN */
427a3d991bdSwdenk extern ushort		NetOurNativeVLAN;	/* Our Native VLAN */
428a3d991bdSwdenk 
4292d966958Swdenk extern int		NetRestartWrap;		/* Tried all network devices */
4302d966958Swdenk 
431e4bf0c5cSSimon Glass enum proto_t {
432e4bf0c5cSSimon Glass 	BOOTP, RARP, ARP, TFTPGET, DHCP, PING, DNS, NFS, CDP, NETCONS, SNTP,
433d22c338eSJoe Hershberger 	TFTPSRV, TFTPPUT, LINKLOCAL
434e4bf0c5cSSimon Glass };
4352d966958Swdenk 
4362d966958Swdenk /* from net/net.c */
4372d966958Swdenk extern char	BootFile[128];			/* Boot File name */
4382d966958Swdenk 
4391a32bf41SRobin Getz #if defined(CONFIG_CMD_DNS)
4401a32bf41SRobin Getz extern char *NetDNSResolve;		/* The host to resolve  */
4411a32bf41SRobin Getz extern char *NetDNSenvvar;		/* the env var to put the ip into */
4421a32bf41SRobin Getz #endif
4431a32bf41SRobin Getz 
444639221c7SJon Loeliger #if defined(CONFIG_CMD_PING)
44573a8b27cSwdenk extern IPaddr_t	NetPingIP;			/* the ip address to ping */
44673a8b27cSwdenk #endif
44773a8b27cSwdenk 
448639221c7SJon Loeliger #if defined(CONFIG_CMD_CDP)
449a3d991bdSwdenk /* when CDP completes these hold the return values */
450f575ae1fSJoe Hershberger extern ushort CDPNativeVLAN;		/* CDP returned native VLAN */
451f575ae1fSJoe Hershberger extern ushort CDPApplianceVLAN;		/* CDP returned appliance VLAN */
45217351883SJoe Hershberger 
45317351883SJoe Hershberger /*
45417351883SJoe Hershberger  * Check for a CDP packet by examining the received MAC address field
45517351883SJoe Hershberger  */
45617351883SJoe Hershberger static inline int is_cdp_packet(const uchar *et_addr)
45717351883SJoe Hershberger {
45817351883SJoe Hershberger 	extern const uchar NetCDPAddr[6];
45917351883SJoe Hershberger 
46017351883SJoe Hershberger 	return memcmp(et_addr, NetCDPAddr, 6) == 0;
46117351883SJoe Hershberger }
462a3d991bdSwdenk #endif
463a3d991bdSwdenk 
464639221c7SJon Loeliger #if defined(CONFIG_CMD_SNTP)
465ea287debSwdenk extern IPaddr_t	NetNtpServerIP;			/* the ip address to NTP */
466ea287debSwdenk extern int NetTimeOffset;			/* offset time from UTC */
467ea287debSwdenk #endif
468ea287debSwdenk 
46913dfe943SJoe Hershberger #if defined(CONFIG_MCAST_TFTP)
47013dfe943SJoe Hershberger extern IPaddr_t Mcast_addr;
47113dfe943SJoe Hershberger #endif
47213dfe943SJoe Hershberger 
4732d966958Swdenk /* Initialize the network adapter */
474*ff997432SJoe Hershberger void net_init(void);
475*ff997432SJoe Hershberger int NetLoop(enum proto_t);
4762d966958Swdenk 
4772d966958Swdenk /* Shutdown adapters and cleanup */
478*ff997432SJoe Hershberger void	NetStop(void);
4792d966958Swdenk 
4802d966958Swdenk /* Load failed.	 Start again. */
481*ff997432SJoe Hershberger void	NetStartAgain(void);
4822d966958Swdenk 
483a3d991bdSwdenk /* Get size of the ethernet header when we send */
484*ff997432SJoe Hershberger int	NetEthHdrSize(void);
485a3d991bdSwdenk 
486a3d991bdSwdenk /* Set ethernet header; returns the size of the header */
487*ff997432SJoe Hershberger int NetSetEther(uchar *, uchar *, uint);
488*ff997432SJoe Hershberger int net_update_ether(struct ethernet_hdr *et, uchar *addr, uint prot);
4892d966958Swdenk 
4902d966958Swdenk /* Set IP header */
491*ff997432SJoe Hershberger void net_set_ip_header(uchar *pkt, IPaddr_t dest, IPaddr_t source);
492*ff997432SJoe Hershberger void net_set_udp_header(uchar *pkt, IPaddr_t dest, int dport,
4934b11c916SJoe Hershberger 				int sport, int len);
4942d966958Swdenk 
4959b0e35cbSSimon Glass /**
4969b0e35cbSSimon Glass  * compute_ip_checksum() - Compute IP checksum
4979b0e35cbSSimon Glass  *
4989b0e35cbSSimon Glass  * @addr:	Address to check (must be 16-bit aligned)
4999b0e35cbSSimon Glass  * @nbytes:	Number of bytes to check (normally a multiple of 2)
5009b0e35cbSSimon Glass  * @return 16-bit IP checksum
5019b0e35cbSSimon Glass  */
5029b0e35cbSSimon Glass unsigned compute_ip_checksum(const void *addr, unsigned nbytes);
5039b0e35cbSSimon Glass 
5049b0e35cbSSimon Glass /**
5059b0e35cbSSimon Glass  * add_ip_checksums() - add two IP checksums
5069b0e35cbSSimon Glass  *
5079b0e35cbSSimon Glass  * @offset:	Offset of first sum (if odd we do a byte-swap)
5089b0e35cbSSimon Glass  * @sum:	First checksum
5099b0e35cbSSimon Glass  * @new_sum:	New checksum to add
5109b0e35cbSSimon Glass  * @return updated 16-bit IP checksum
5119b0e35cbSSimon Glass  */
5129b0e35cbSSimon Glass unsigned add_ip_checksums(unsigned offset, unsigned sum, unsigned new_sum);
5139b0e35cbSSimon Glass 
5149b0e35cbSSimon Glass /**
5159b0e35cbSSimon Glass  * ip_checksum_ok() - check if a checksum is correct
5169b0e35cbSSimon Glass  *
5179b0e35cbSSimon Glass  * This works by making sure the checksum sums to 0
5189b0e35cbSSimon Glass  *
5199b0e35cbSSimon Glass  * @addr:	Address to check (must be 16-bit aligned)
5209b0e35cbSSimon Glass  * @nbytes:	Number of bytes to check (normally a multiple of 2)
5219b0e35cbSSimon Glass  * @return true if the checksum matches, false if not
5229b0e35cbSSimon Glass  */
5239b0e35cbSSimon Glass int ip_checksum_ok(const void *addr, unsigned nbytes);
5249b0e35cbSSimon Glass 
525d280d3f4SJoe Hershberger /* Callbacks */
526*ff997432SJoe Hershberger rxhand_f *net_get_udp_handler(void);	/* Get UDP RX packet handler */
527*ff997432SJoe Hershberger void net_set_udp_handler(rxhand_f *);	/* Set UDP RX packet handler */
528*ff997432SJoe Hershberger rxhand_f *net_get_arp_handler(void);	/* Get ARP RX packet handler */
529*ff997432SJoe Hershberger void net_set_arp_handler(rxhand_f *);	/* Set ARP RX packet handler */
530*ff997432SJoe Hershberger void net_set_icmp_handler(rxhand_icmp_f *f); /* Set ICMP RX handler */
531*ff997432SJoe Hershberger void	NetSetTimeout(ulong, thand_f *);/* Set timeout handler */
5322d966958Swdenk 
53322f6e99dSJoe Hershberger /* Network loop state */
53422f6e99dSJoe Hershberger enum net_loop_state {
53522f6e99dSJoe Hershberger 	NETLOOP_CONTINUE,
53622f6e99dSJoe Hershberger 	NETLOOP_RESTART,
53722f6e99dSJoe Hershberger 	NETLOOP_SUCCESS,
53822f6e99dSJoe Hershberger 	NETLOOP_FAIL
53922f6e99dSJoe Hershberger };
54022f6e99dSJoe Hershberger extern enum net_loop_state net_state;
54122f6e99dSJoe Hershberger 
54206370590SKim Phillips static inline void net_set_state(enum net_loop_state state)
54306370590SKim Phillips {
5444ef8d53cSJoe Hershberger 	debug_cond(DEBUG_INT_STATE, "--- NetState set to %d\n", state);
54522f6e99dSJoe Hershberger 	net_state = state;
54622f6e99dSJoe Hershberger }
54722f6e99dSJoe Hershberger 
548e94070c4SJoe Hershberger /* Transmit a packet */
549adf5d93eSJoe Hershberger static inline void NetSendPacket(uchar *pkt, int len)
550adf5d93eSJoe Hershberger {
551adf5d93eSJoe Hershberger 	(void) eth_send(pkt, len);
552adf5d93eSJoe Hershberger }
5532d966958Swdenk 
554206d07fdSJoe Hershberger /*
555e94070c4SJoe Hershberger  * Transmit "NetTxPacket" as UDP packet, performing ARP request if needed
556ece223b5SJoe Hershberger  *  (ether will be populated)
557206d07fdSJoe Hershberger  *
558206d07fdSJoe Hershberger  * @param ether Raw packet buffer
559206d07fdSJoe Hershberger  * @param dest IP address to send the datagram to
560206d07fdSJoe Hershberger  * @param dport Destination UDP port
561206d07fdSJoe Hershberger  * @param sport Source UDP port
562206d07fdSJoe Hershberger  * @param payload_len Length of data after the UDP header
563206d07fdSJoe Hershberger  */
564*ff997432SJoe Hershberger int NetSendUDPPacket(uchar *ether, IPaddr_t dest, int dport,
565206d07fdSJoe Hershberger 			int sport, int payload_len);
56673a8b27cSwdenk 
5672d966958Swdenk /* Processes a received packet */
568*ff997432SJoe Hershberger void NetReceive(uchar *, int);
5692d966958Swdenk 
57048522bb5SJoe Hershberger #ifdef CONFIG_NETCONSOLE
57148522bb5SJoe Hershberger void NcStart(void);
5728a0eccb1SJoe Hershberger int nc_input_packet(uchar *pkt, IPaddr_t src_ip, unsigned dest_port,
5738a0eccb1SJoe Hershberger 	unsigned src_port, unsigned len);
57448522bb5SJoe Hershberger #endif
57548522bb5SJoe Hershberger 
576f8be7d65SJoe Hershberger static inline __attribute__((always_inline)) int eth_is_on_demand_init(void)
577f8be7d65SJoe Hershberger {
578f8be7d65SJoe Hershberger #ifdef CONFIG_NETCONSOLE
579f8be7d65SJoe Hershberger 	extern enum proto_t net_loop_last_protocol;
580f8be7d65SJoe Hershberger 
581f8be7d65SJoe Hershberger 	return net_loop_last_protocol != NETCONS;
582f8be7d65SJoe Hershberger #else
583f8be7d65SJoe Hershberger 	return 1;
584f8be7d65SJoe Hershberger #endif
585f8be7d65SJoe Hershberger }
586f8be7d65SJoe Hershberger 
587f8be7d65SJoe Hershberger static inline void eth_set_last_protocol(int protocol)
588f8be7d65SJoe Hershberger {
589f8be7d65SJoe Hershberger #ifdef CONFIG_NETCONSOLE
590f8be7d65SJoe Hershberger 	extern enum proto_t net_loop_last_protocol;
591f8be7d65SJoe Hershberger 
592f8be7d65SJoe Hershberger 	net_loop_last_protocol = protocol;
593f8be7d65SJoe Hershberger #endif
594f8be7d65SJoe Hershberger }
595f8be7d65SJoe Hershberger 
5962d966958Swdenk /*
597e4a3d57dSSimon Glass  * Check if autoload is enabled. If so, use either NFS or TFTP to download
598e4a3d57dSSimon Glass  * the boot file.
599e4a3d57dSSimon Glass  */
600e4a3d57dSSimon Glass void net_auto_load(void);
601e4a3d57dSSimon Glass 
602e4a3d57dSSimon Glass /*
6032d966958Swdenk  * The following functions are a bit ugly, but necessary to deal with
6042d966958Swdenk  * alignment restrictions on ARM.
6052d966958Swdenk  *
6062d966958Swdenk  * We're using inline functions, which had the smallest memory
6072d966958Swdenk  * footprint in our tests.
6082d966958Swdenk  */
6092d966958Swdenk /* return IP *in network byteorder* */
610db288a96SJoe Hershberger static inline IPaddr_t NetReadIP(void *from)
6112d966958Swdenk {
6122d966958Swdenk 	IPaddr_t ip;
613b28e28bbSJoe Hershberger 
61433a4a70dSAnatolij Gustschin 	memcpy((void *)&ip, (void *)from, sizeof(ip));
6152d966958Swdenk 	return ip;
6162d966958Swdenk }
6172d966958Swdenk 
6182d966958Swdenk /* return ulong *in network byteorder* */
6192d966958Swdenk static inline ulong NetReadLong(ulong *from)
6202d966958Swdenk {
6212d966958Swdenk 	ulong l;
622b28e28bbSJoe Hershberger 
6232d966958Swdenk 	memcpy((void *)&l, (void *)from, sizeof(l));
6242d966958Swdenk 	return l;
6252d966958Swdenk }
6262d966958Swdenk 
6272d966958Swdenk /* write IP *in network byteorder* */
6282d966958Swdenk static inline void NetWriteIP(void *to, IPaddr_t ip)
6292d966958Swdenk {
6302d966958Swdenk 	memcpy(to, (void *)&ip, sizeof(ip));
6312d966958Swdenk }
6322d966958Swdenk 
6332d966958Swdenk /* copy IP */
634db288a96SJoe Hershberger static inline void NetCopyIP(void *to, void *from)
6352d966958Swdenk {
63633a4a70dSAnatolij Gustschin 	memcpy((void *)to, from, sizeof(IPaddr_t));
6372d966958Swdenk }
6382d966958Swdenk 
6392d966958Swdenk /* copy ulong */
6402d966958Swdenk static inline void NetCopyLong(ulong *to, ulong *from)
6412d966958Swdenk {
6422d966958Swdenk 	memcpy((void *)to, (void *)from, sizeof(ulong));
6432d966958Swdenk }
6442d966958Swdenk 
64550cca8b9SMike Rapoport /**
64650cca8b9SMike Rapoport  * is_zero_ether_addr - Determine if give Ethernet address is all zeros.
64750cca8b9SMike Rapoport  * @addr: Pointer to a six-byte array containing the Ethernet address
64850cca8b9SMike Rapoport  *
64950cca8b9SMike Rapoport  * Return true if the address is all zeroes.
65050cca8b9SMike Rapoport  */
65150cca8b9SMike Rapoport static inline int is_zero_ether_addr(const u8 *addr)
65250cca8b9SMike Rapoport {
65350cca8b9SMike Rapoport 	return !(addr[0] | addr[1] | addr[2] | addr[3] | addr[4] | addr[5]);
65450cca8b9SMike Rapoport }
65550cca8b9SMike Rapoport 
65650cca8b9SMike Rapoport /**
65750cca8b9SMike Rapoport  * is_multicast_ether_addr - Determine if the Ethernet address is a multicast.
65850cca8b9SMike Rapoport  * @addr: Pointer to a six-byte array containing the Ethernet address
65950cca8b9SMike Rapoport  *
66050cca8b9SMike Rapoport  * Return true if the address is a multicast address.
66150cca8b9SMike Rapoport  * By definition the broadcast address is also a multicast address.
66250cca8b9SMike Rapoport  */
66350cca8b9SMike Rapoport static inline int is_multicast_ether_addr(const u8 *addr)
66450cca8b9SMike Rapoport {
665b28e28bbSJoe Hershberger 	return 0x01 & addr[0];
66650cca8b9SMike Rapoport }
66750cca8b9SMike Rapoport 
66823cd1385SRemy Bohmer /*
66923cd1385SRemy Bohmer  * is_broadcast_ether_addr - Determine if the Ethernet address is broadcast
67023cd1385SRemy Bohmer  * @addr: Pointer to a six-byte array containing the Ethernet address
67123cd1385SRemy Bohmer  *
67223cd1385SRemy Bohmer  * Return true if the address is the broadcast address.
67323cd1385SRemy Bohmer  */
67423cd1385SRemy Bohmer static inline int is_broadcast_ether_addr(const u8 *addr)
67523cd1385SRemy Bohmer {
676b28e28bbSJoe Hershberger 	return (addr[0] & addr[1] & addr[2] & addr[3] & addr[4] & addr[5]) ==
677b28e28bbSJoe Hershberger 		0xff;
67823cd1385SRemy Bohmer }
67923cd1385SRemy Bohmer 
68023cd1385SRemy Bohmer /*
68175edebe3SMike Frysinger  * is_valid_ether_addr - Determine if the given Ethernet address is valid
68275edebe3SMike Frysinger  * @addr: Pointer to a six-byte array containing the Ethernet address
68375edebe3SMike Frysinger  *
68475edebe3SMike Frysinger  * Check that the Ethernet address (MAC) is not 00:00:00:00:00:00, is not
68575edebe3SMike Frysinger  * a multicast address, and is not FF:FF:FF:FF:FF:FF.
68675edebe3SMike Frysinger  *
68775edebe3SMike Frysinger  * Return true if the address is valid.
68875edebe3SMike Frysinger  */
68975edebe3SMike Frysinger static inline int is_valid_ether_addr(const u8 *addr)
69075edebe3SMike Frysinger {
69175edebe3SMike Frysinger 	/* FF:FF:FF:FF:FF:FF is a multicast address so we don't need to
69275edebe3SMike Frysinger 	 * explicitly check for it here. */
69375edebe3SMike Frysinger 	return !is_multicast_ether_addr(addr) && !is_zero_ether_addr(addr);
69475edebe3SMike Frysinger }
69575edebe3SMike Frysinger 
696da384a9dSMasahiro Yamada /**
697da384a9dSMasahiro Yamada  * eth_random_addr - Generate software assigned random Ethernet address
698da384a9dSMasahiro Yamada  * @addr: Pointer to a six-byte array containing the Ethernet address
699da384a9dSMasahiro Yamada  *
700da384a9dSMasahiro Yamada  * Generate a random Ethernet address (MAC) that is not multicast
701da384a9dSMasahiro Yamada  * and has the local assigned bit set.
702da384a9dSMasahiro Yamada  */
703da384a9dSMasahiro Yamada static inline void eth_random_addr(uchar *addr)
704da384a9dSMasahiro Yamada {
705da384a9dSMasahiro Yamada 	int i;
706da384a9dSMasahiro Yamada 	unsigned int seed = get_timer(0);
707da384a9dSMasahiro Yamada 
708da384a9dSMasahiro Yamada 	for (i = 0; i < 6; i++)
709da384a9dSMasahiro Yamada 		addr[i] = rand_r(&seed);
710da384a9dSMasahiro Yamada 
711da384a9dSMasahiro Yamada 	addr[0] &= 0xfe;	/* clear multicast bit */
712da384a9dSMasahiro Yamada 	addr[0] |= 0x02;	/* set local assignment bit (IEEE802) */
713da384a9dSMasahiro Yamada }
714da384a9dSMasahiro Yamada 
7152d966958Swdenk /* Convert an IP address to a string */
716*ff997432SJoe Hershberger void ip_to_string(IPaddr_t x, char *s);
7172d966958Swdenk 
71873a8b27cSwdenk /* Convert a string to ip address */
719*ff997432SJoe Hershberger IPaddr_t string_to_ip(const char *s);
72073a8b27cSwdenk 
721a3d991bdSwdenk /* Convert a VLAN id to a string */
722*ff997432SJoe Hershberger void VLAN_to_string(ushort x, char *s);
723a3d991bdSwdenk 
724a3d991bdSwdenk /* Convert a string to a vlan id */
725*ff997432SJoe Hershberger ushort string_to_VLAN(const char *s);
726a3d991bdSwdenk 
727a3d991bdSwdenk /* read a VLAN id from an environment variable */
728*ff997432SJoe Hershberger ushort getenv_VLAN(char *);
729a3d991bdSwdenk 
7302d966958Swdenk /* copy a filename (allow for "..." notation, limit length) */
731*ff997432SJoe Hershberger void copy_filename(char *dst, const char *src, int size);
7322d966958Swdenk 
73391b469c9SMike Frysinger /* get a random source port */
734*ff997432SJoe Hershberger unsigned int random_port(void);
73591b469c9SMike Frysinger 
736ea5427e2SSimon Glass /* Update U-Boot over TFTP */
737*ff997432SJoe Hershberger int update_tftp(ulong addr);
738ea5427e2SSimon Glass 
7392d966958Swdenk /**********************************************************************/
7402d966958Swdenk 
7412d966958Swdenk #endif /* __NET_H__ */
742