[J-u-boot.git] / include / net.h

/*
 *	LiMon Monitor (LiMon) - Network.
 *
 *	Copyright 1994 - 2000 Neil Russell.
 *	(See License)
 *
 *
 * History
 *	9/16/00	  bor  adapted to TQM823L/STK8xxL board, RARP/TFTP boot added
 */

#ifndef __NET_H__
#define __NET_H__

#if defined(CONFIG_8xx)
#include <commproc.h>
# if !defined(CONFIG_NET_MULTI)
#  if defined(FEC_ENET) || defined(SCC_ENET)
#   define CONFIG_NET_MULTI
#  endif
# endif
#endif	/* CONFIG_8xx */

#if defined(CONFIG_MPC5xxx)
# if !defined(CONFIG_NET_MULTI)
#  if defined(CONFIG_MPC5xxx_FEC)
#   define CONFIG_NET_MULTI
#  endif
# endif
#endif	/* CONFIG_MPC5xxx */

#if !defined(CONFIG_NET_MULTI) && defined(CONFIG_CPM2)
#include <config.h>
#if defined(CONFIG_ETHER_ON_FCC)
#if defined(CONFIG_ETHER_ON_SCC)
#error "Ethernet not correctly defined"
#endif /* CONFIG_ETHER_ON_SCC */
#define CONFIG_NET_MULTI
#if (CONFIG_ETHER_INDEX == 1)
#define	CONFIG_ETHER_ON_FCC1
# define CONFIG_SYS_CMXFCR_MASK1	CONFIG_SYS_CMXFCR_MASK
# define CONFIG_SYS_CMXFCR_VALUE1	CONFIG_SYS_CMXFCR_VALUE
#elif (CONFIG_ETHER_INDEX == 2)
#define	CONFIG_ETHER_ON_FCC2
# define CONFIG_SYS_CMXFCR_MASK2	CONFIG_SYS_CMXFCR_MASK
# define CONFIG_SYS_CMXFCR_VALUE2	CONFIG_SYS_CMXFCR_VALUE
#elif (CONFIG_ETHER_INDEX == 3)
#define	CONFIG_ETHER_ON_FCC3
# define CONFIG_SYS_CMXFCR_MASK3	CONFIG_SYS_CMXFCR_MASK
# define CONFIG_SYS_CMXFCR_VALUE3	CONFIG_SYS_CMXFCR_VALUE
#endif /* CONFIG_ETHER_INDEX */
#endif /* CONFIG_ETHER_ON_FCC */
#endif /* !CONFIG_NET_MULTI && CONFIG_8260 */

#include <asm/byteorder.h>	/* for nton* / ntoh* stuff */


/*
 *	The number of receive packet buffers, and the required packet buffer
 *	alignment in memory.
 *
 */

#ifdef CONFIG_SYS_RX_ETH_BUFFER
# define PKTBUFSRX	CONFIG_SYS_RX_ETH_BUFFER
#else
# define PKTBUFSRX	4
#endif

#define PKTALIGN	32

typedef ulong		IPaddr_t;


/*
 * The current receive packet handler.  Called with a pointer to the
 * application packet, and a protocol type (PORT_BOOTPC or PORT_TFTP).
 * All other packets are dealt with without calling the handler.
 */
typedef void	rxhand_f(uchar *, unsigned, unsigned, unsigned);

/*
 *	A timeout handler.  Called after time interval has expired.
 */
typedef void	thand_f(void);

#define NAMESIZE 16

enum eth_state_t {
	ETH_STATE_INIT,
	ETH_STATE_PASSIVE,
	ETH_STATE_ACTIVE
};

struct eth_device {
	char name[NAMESIZE];
	unsigned char enetaddr[6];
	int iobase;
	int state;

	int  (*init) (struct eth_device*, bd_t*);
	int  (*send) (struct eth_device*, volatile void* packet, int length);
	int  (*recv) (struct eth_device*);
	void (*halt) (struct eth_device*);
#ifdef CONFIG_MCAST_TFTP
	int (*mcast) (struct eth_device*, u32 ip, u8 set);
#endif
	struct eth_device *next;
	void *priv;
};

extern int eth_initialize(bd_t *bis);		/* Initialize network subsystem */
extern int eth_register(struct eth_device* dev);/* Register network device	*/
extern void eth_try_another(int first_restart);	/* Change the device		*/
#ifdef CONFIG_NET_MULTI
extern void eth_set_current(void);		/* set nterface to ethcur var.  */
#endif
extern struct eth_device *eth_get_dev(void);	/* get the current device MAC	*/
extern struct eth_device *eth_get_dev_by_name(char *devname); /* get device	*/
extern int eth_get_dev_index (void);		/* get the device index         */
extern void eth_set_enetaddr(int num, char* a);	/* Set new MAC address		*/

extern int eth_init(bd_t *bis);			/* Initialize the device	*/
extern int eth_send(volatile void *packet, int length);	   /* Send a packet	*/
#ifdef CONFIG_API
extern int eth_receive(volatile void *packet, int length); /* Receive a packet	*/
#endif
extern int eth_rx(void);			/* Check for received packets	*/
extern void eth_halt(void);			/* stop SCC			*/
extern char *eth_get_name(void);		/* get name of current device	*/

#ifdef CONFIG_MCAST_TFTP
int eth_mcast_join( IPaddr_t mcast_addr, u8 join);
u32 ether_crc (size_t len, unsigned char const *p);
#endif


/**********************************************************************/
/*
 *	Protocol headers.
 */

/*
 *	Ethernet header
 */
typedef struct {
	uchar		et_dest[6];	/* Destination node		*/
	uchar		et_src[6];	/* Source node			*/
	ushort		et_protlen;	/* Protocol or length		*/
	uchar		et_dsap;	/* 802 DSAP			*/
	uchar		et_ssap;	/* 802 SSAP			*/
	uchar		et_ctl;		/* 802 control			*/
	uchar		et_snap1;	/* SNAP				*/
	uchar		et_snap2;
	uchar		et_snap3;
	ushort		et_prot;	/* 802 protocol			*/
} Ethernet_t;

#define ETHER_HDR_SIZE	14		/* Ethernet header size		*/
#define E802_HDR_SIZE	22		/* 802 ethernet header size	*/

/*
 *	Ethernet header
 */
typedef struct {
	uchar		vet_dest[6];	/* Destination node		*/
	uchar		vet_src[6];	/* Source node			*/
	ushort		vet_vlan_type;	/* PROT_VLAN			*/
	ushort		vet_tag;	/* TAG of VLAN			*/
	ushort		vet_type;	/* protocol type		*/
} VLAN_Ethernet_t;

#define VLAN_ETHER_HDR_SIZE	18	/* VLAN Ethernet header size	*/

#define PROT_IP		0x0800		/* IP protocol			*/
#define PROT_ARP	0x0806		/* IP ARP protocol		*/
#define PROT_RARP	0x8035		/* IP ARP protocol		*/
#define PROT_VLAN	0x8100		/* IEEE 802.1q protocol		*/

#define IPPROTO_ICMP	 1	/* Internet Control Message Protocol	*/
#define IPPROTO_UDP	17	/* User Datagram Protocol		*/

/*
 *	Internet Protocol (IP) header.
 */
typedef struct {
	uchar		ip_hl_v;	/* header length and version	*/
	uchar		ip_tos;		/* type of service		*/
	ushort		ip_len;		/* total length			*/
	ushort		ip_id;		/* identification		*/
	ushort		ip_off;		/* fragment offset field	*/
	uchar		ip_ttl;		/* time to live			*/
	uchar		ip_p;		/* protocol			*/
	ushort		ip_sum;		/* checksum			*/
	IPaddr_t	ip_src;		/* Source IP address		*/
	IPaddr_t	ip_dst;		/* Destination IP address	*/
	ushort		udp_src;	/* UDP source port		*/
	ushort		udp_dst;	/* UDP destination port		*/
	ushort		udp_len;	/* Length of UDP packet		*/
	ushort		udp_xsum;	/* Checksum			*/
} IP_t;

#define IP_OFFS		0x1fff /* ip offset *= 8 */
#define IP_FLAGS	0xe000 /* first 3 bits */
#define IP_FLAGS_RES	0x8000 /* reserved */
#define IP_FLAGS_DFRAG	0x4000 /* don't fragments */
#define IP_FLAGS_MFRAG	0x2000 /* more fragments */

#define IP_HDR_SIZE_NO_UDP	(sizeof (IP_t) - 8)
#define IP_HDR_SIZE		(sizeof (IP_t))


/*
 *	Address Resolution Protocol (ARP) header.
 */
typedef struct
{
	ushort		ar_hrd;		/* Format of hardware address	*/
#   define ARP_ETHER	    1		/* Ethernet  hardware address	*/
	ushort		ar_pro;		/* Format of protocol address	*/
	uchar		ar_hln;		/* Length of hardware address	*/
	uchar		ar_pln;		/* Length of protocol address	*/
	ushort		ar_op;		/* Operation			*/
#   define ARPOP_REQUEST    1		/* Request  to resolve  address	*/
#   define ARPOP_REPLY	    2		/* Response to previous request	*/

#   define RARPOP_REQUEST   3		/* Request  to resolve  address	*/
#   define RARPOP_REPLY	    4		/* Response to previous request */

	/*
	 * The remaining fields are variable in size, according to
	 * the sizes above, and are defined as appropriate for
	 * specific hardware/protocol combinations.
	 */
	uchar		ar_data[0];
#if 0
	uchar		ar_sha[];	/* Sender hardware address	*/
	uchar		ar_spa[];	/* Sender protocol address	*/
	uchar		ar_tha[];	/* Target hardware address	*/
	uchar		ar_tpa[];	/* Target protocol address	*/
#endif /* 0 */
} ARP_t;

#define ARP_HDR_SIZE	(8+20)		/* Size assuming ethernet	*/

/*
 * ICMP stuff (just enough to handle (host) redirect messages)
 */
#define ICMP_ECHO_REPLY		0	/* Echo reply			*/
#define ICMP_REDIRECT		5	/* Redirect (change route)	*/
#define ICMP_ECHO_REQUEST	8	/* Echo request			*/

/* Codes for REDIRECT. */
#define ICMP_REDIR_NET		0	/* Redirect Net			*/
#define ICMP_REDIR_HOST		1	/* Redirect Host		*/

typedef struct icmphdr {
	uchar		type;
	uchar		code;
	ushort		checksum;
	union {
		struct {
			ushort	id;
			ushort	sequence;
		} echo;
		ulong	gateway;
		struct {
			ushort	__unused;
			ushort	mtu;
		} frag;
	} un;
} ICMP_t;


/*
 * Maximum packet size; used to allocate packet storage.
 * TFTP packets can be 524 bytes + IP header + ethernet header.
 * Lets be conservative, and go for 38 * 16.  (Must also be
 * a multiple of 32 bytes).
 */
/*
 * AS.HARNOIS : Better to set PKTSIZE to maximum size because
 * traffic type is not always controlled
 * maximum packet size =  1518
 * maximum packet size and multiple of 32 bytes =  1536
 */
#define PKTSIZE			1518
#define PKTSIZE_ALIGN		1536
/*#define PKTSIZE		608*/

/*
 * Maximum receive ring size; that is, the number of packets
 * we can buffer before overflow happens. Basically, this just
 * needs to be enough to prevent a packet being discarded while
 * we are processing the previous one.
 */
#define RINGSZ		4
#define RINGSZ_LOG2	2

/**********************************************************************/
/*
 *	Globals.
 *
 * Note:
 *
 * All variables of type IPaddr_t are stored in NETWORK byte order
 * (big endian).
 */

/* net.c */
/** BOOTP EXTENTIONS **/
extern IPaddr_t		NetOurGatewayIP;	/* Our gateway IP addresse	*/
extern IPaddr_t		NetOurSubnetMask;	/* Our subnet mask (0 = unknown)*/
extern IPaddr_t		NetOurDNSIP;	 /* Our Domain Name Server (0 = unknown)*/
#if defined(CONFIG_BOOTP_DNS2)
extern IPaddr_t		NetOurDNS2IP;	 /* Our 2nd Domain Name Server (0 = unknown)*/
#endif
extern char		NetOurNISDomain[32];	/* Our NIS domain		*/
extern char		NetOurHostName[32];	/* Our hostname			*/
extern char		NetOurRootPath[64];	/* Our root path		*/
extern ushort		NetBootFileSize;	/* Our boot file size in blocks	*/
/** END OF BOOTP EXTENTIONS **/
extern ulong		NetBootFileXferSize;	/* size of bootfile in bytes	*/
extern uchar		NetOurEther[6];		/* Our ethernet address		*/
extern uchar		NetServerEther[6];	/* Boot server enet address	*/
extern IPaddr_t		NetOurIP;		/* Our    IP addr (0 = unknown)	*/
extern IPaddr_t		NetServerIP;		/* Server IP addr (0 = unknown)	*/
extern volatile uchar * NetTxPacket;		/* THE transmit packet		*/
extern volatile uchar * NetRxPackets[PKTBUFSRX];/* Receive packets		*/
extern volatile uchar * NetRxPkt;		/* Current receive packet	*/
extern int		NetRxPktLen;		/* Current rx packet length	*/
extern unsigned		NetIPID;		/* IP ID (counting)		*/
extern uchar		NetBcastAddr[6];	/* Ethernet boardcast address	*/
extern uchar		NetEtherNullAddr[6];

#define VLAN_NONE	4095			/* untagged			*/
#define VLAN_IDMASK	0x0fff			/* mask of valid vlan id	*/
extern ushort		NetOurVLAN;		/* Our VLAN			*/
extern ushort		NetOurNativeVLAN;	/* Our Native VLAN		*/

extern uchar		NetCDPAddr[6];		/* Ethernet CDP address		*/
extern ushort		CDPNativeVLAN;		/* CDP returned native VLAN	*/
extern ushort		CDPApplianceVLAN;	/* CDP returned appliance VLAN	*/

extern int		NetState;		/* Network loop state		*/
#define NETLOOP_CONTINUE	1
#define NETLOOP_RESTART		2
#define NETLOOP_SUCCESS		3
#define NETLOOP_FAIL		4

#ifdef CONFIG_NET_MULTI
extern int		NetRestartWrap;		/* Tried all network devices	*/
#endif

typedef enum { BOOTP, RARP, ARP, TFTP, DHCP, PING, DNS, NFS, CDP, NETCONS, SNTP } proto_t;

/* from net/net.c */
extern char	BootFile[128];			/* Boot File name		*/

#if defined(CONFIG_CMD_PING)
extern IPaddr_t	NetPingIP;			/* the ip address to ping		*/
#endif

#if defined(CONFIG_CMD_CDP)
/* when CDP completes these hold the return values */
extern ushort CDPNativeVLAN;
extern ushort CDPApplianceVLAN;
#endif

#if defined(CONFIG_CMD_SNTP)
extern IPaddr_t	NetNtpServerIP;			/* the ip address to NTP	*/
extern int NetTimeOffset;			/* offset time from UTC		*/
#endif

/* Initialize the network adapter */
extern int	NetLoop(proto_t);

/* Shutdown adapters and cleanup */
extern void	NetStop(void);

/* Load failed.	 Start again. */
extern void	NetStartAgain(void);

/* Get size of the ethernet header when we send */
extern int	NetEthHdrSize(void);

/* Set ethernet header; returns the size of the header */
extern int	NetSetEther(volatile uchar *, uchar *, uint);

/* Set IP header */
extern void	NetSetIP(volatile uchar *, IPaddr_t, int, int, int);

/* Checksum */
extern int	NetCksumOk(uchar *, int);	/* Return true if cksum OK	*/
extern uint	NetCksum(uchar *, int);		/* Calculate the checksum	*/

/* Set callbacks */
extern void	NetSetHandler(rxhand_f *);	/* Set RX packet handler	*/
extern void	NetSetTimeout(ulong, thand_f *);/* Set timeout handler		*/

/* Transmit "NetTxPacket" */
extern void	NetSendPacket(volatile uchar *, int);

/* Transmit UDP packet, performing ARP request if needed */
extern int	NetSendUDPPacket(uchar *ether, IPaddr_t dest, int dport, int sport, int len);

/* Processes a received packet */
extern void	NetReceive(volatile uchar *, int);

/* Print an IP address on the console */
extern void	print_IPaddr (IPaddr_t);

/*
 * The following functions are a bit ugly, but necessary to deal with
 * alignment restrictions on ARM.
 *
 * We're using inline functions, which had the smallest memory
 * footprint in our tests.
 */
/* return IP *in network byteorder* */
static inline IPaddr_t NetReadIP(volatile void *from)
{
	IPaddr_t ip;
	memcpy((void*)&ip, (void*)from, sizeof(ip));
	return ip;
}

/* return ulong *in network byteorder* */
static inline ulong NetReadLong(ulong *from)
{
	ulong l;
	memcpy((void*)&l, (void*)from, sizeof(l));
	return l;
}

/* write IP *in network byteorder* */
static inline void NetWriteIP(void *to, IPaddr_t ip)
{
	memcpy(to, (void*)&ip, sizeof(ip));
}

/* copy IP */
static inline void NetCopyIP(volatile void *to, void *from)
{
	memcpy((void*)to, from, sizeof(IPaddr_t));
}

/* copy ulong */
static inline void NetCopyLong(ulong *to, ulong *from)
{
	memcpy((void*)to, (void*)from, sizeof(ulong));
}

/**
 * is_zero_ether_addr - Determine if give Ethernet address is all zeros.
 * @addr: Pointer to a six-byte array containing the Ethernet address
 *
 * Return true if the address is all zeroes.
 */
static inline int is_zero_ether_addr(const u8 *addr)
{
	return !(addr[0] | addr[1] | addr[2] | addr[3] | addr[4] | addr[5]);
}

/**
 * is_multicast_ether_addr - Determine if the Ethernet address is a multicast.
 * @addr: Pointer to a six-byte array containing the Ethernet address
 *
 * Return true if the address is a multicast address.
 * By definition the broadcast address is also a multicast address.
 */
static inline int is_multicast_ether_addr(const u8 *addr)
{
	return (0x01 & addr[0]);
}

/* Convert an IP address to a string */
extern void	ip_to_string (IPaddr_t x, char *s);

/* Convert a string to ip address */
extern IPaddr_t string_to_ip(char *s);

/* Convert a VLAN id to a string */
extern void	VLAN_to_string (ushort x, char *s);

/* Convert a string to a vlan id */
extern ushort string_to_VLAN(char *s);

/* read an IP address from a environment variable */
extern IPaddr_t getenv_IPaddr (char *);

/* read a VLAN id from an environment variable */
extern ushort getenv_VLAN(char *);

/* copy a filename (allow for "..." notation, limit length) */
extern void	copy_filename (char *dst, char *src, int size);

/**********************************************************************/

#endif /* __NET_H__ */
Commit	Line	Data
2d966958 WD	1	/*
	2	* LiMon Monitor (LiMon) - Network.
	3	*
	4	* Copyright 1994 - 2000 Neil Russell.
	5	* (See License)
	6	*
	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
71f95118	15	#if defined(CONFIG_8xx)
2d966958	16	#include <commproc.h>
71f95118 WD	17	# if !defined(CONFIG_NET_MULTI)
	18	# if defined(FEC_ENET) \|\| defined(SCC_ENET)
	19	# define CONFIG_NET_MULTI
	20	# endif
	21	# endif
	22	#endif /* CONFIG_8xx */
aacf9a49	23
cbd8a35c	24	#if defined(CONFIG_MPC5xxx)
77846748	25	# if !defined(CONFIG_NET_MULTI)
cbd8a35c	26	# if defined(CONFIG_MPC5xxx_FEC)
77846748 WD	27	# define CONFIG_NET_MULTI
	28	# endif
	29	# endif
cbd8a35c	30	#endif /* CONFIG_MPC5xxx */
77846748	31
9c4c5ae3	32	#if !defined(CONFIG_NET_MULTI) && defined(CONFIG_CPM2)
aacf9a49 WD	33	#include <config.h>
	34	#if defined(CONFIG_ETHER_ON_FCC)
	35	#if defined(CONFIG_ETHER_ON_SCC)
	36	#error "Ethernet not correctly defined"
	37	#endif /* CONFIG_ETHER_ON_SCC */
	38	#define CONFIG_NET_MULTI
	39	#if (CONFIG_ETHER_INDEX == 1)
	40	#define CONFIG_ETHER_ON_FCC1
6d0f6bcf JCPV	41	# define CONFIG_SYS_CMXFCR_MASK1 CONFIG_SYS_CMXFCR_MASK
6d0f6bcf JCPV	42	# define CONFIG_SYS_CMXFCR_VALUE1 CONFIG_SYS_CMXFCR_VALUE
aacf9a49 WD	43	#elif (CONFIG_ETHER_INDEX == 2)
aacf9a49 WD	44	#define CONFIG_ETHER_ON_FCC2
6d0f6bcf JCPV	45	# define CONFIG_SYS_CMXFCR_MASK2 CONFIG_SYS_CMXFCR_MASK
6d0f6bcf JCPV	46	# define CONFIG_SYS_CMXFCR_VALUE2 CONFIG_SYS_CMXFCR_VALUE
aacf9a49 WD	47	#elif (CONFIG_ETHER_INDEX == 3)
aacf9a49 WD	48	#define CONFIG_ETHER_ON_FCC3
6d0f6bcf JCPV	49	# define CONFIG_SYS_CMXFCR_MASK3 CONFIG_SYS_CMXFCR_MASK
6d0f6bcf JCPV	50	# define CONFIG_SYS_CMXFCR_VALUE3 CONFIG_SYS_CMXFCR_VALUE
aacf9a49 WD	51	#endif /* CONFIG_ETHER_INDEX */
	52	#endif /* CONFIG_ETHER_ON_FCC */
	53	#endif /* !CONFIG_NET_MULTI && CONFIG_8260 */
	54
2d966958 WD	55	#include <asm/byteorder.h> /* for nton* / ntoh* stuff */
	56
	57
	58	/*
	59	* The number of receive packet buffers, and the required packet buffer
	60	* alignment in memory.
	61	*
	62	*/
	63
6d0f6bcf JCPV	64	#ifdef CONFIG_SYS_RX_ETH_BUFFER
6d0f6bcf JCPV	65	# define PKTBUFSRX CONFIG_SYS_RX_ETH_BUFFER
1d0350ed	66	#else
c6028835	67	# define PKTBUFSRX 4
1d0350ed WD	68	#endif
1d0350ed WD	69
2d966958 WD	70	#define PKTALIGN 32
	71
	72	typedef ulong IPaddr_t;
	73
	74
2d966958 WD	75	/*
	76	* The current receive packet handler. Called with a pointer to the
	77	* application packet, and a protocol type (PORT_BOOTPC or PORT_TFTP).
	78	* All other packets are dealt with without calling the handler.
	79	*/
	80	typedef void rxhand_f(uchar *, unsigned, unsigned, unsigned);
	81
	82	/*
	83	* A timeout handler. Called after time interval has expired.
	84	*/
	85	typedef void thand_f(void);
	86
2d966958 WD	87	#define NAMESIZE 16
	88
	89	enum eth_state_t {
	90	ETH_STATE_INIT,
	91	ETH_STATE_PASSIVE,
	92	ETH_STATE_ACTIVE
	93	};
	94
	95	struct eth_device {
	96	char name[NAMESIZE];
	97	unsigned char enetaddr[6];
	98	int iobase;
	99	int state;
	100
	101	int (init) (struct eth_device, bd_t*);
53a5c424	102	int (send) (struct eth_device, volatile void* packet, int length);
2d966958 WD	103	int (recv) (struct eth_device);
2d966958 WD	104	void (halt) (struct eth_device);
53a5c424 DU	105	#ifdef CONFIG_MCAST_TFTP
	106	int (mcast) (struct eth_device, u32 ip, u8 set);
	107	#endif
2d966958 WD	108	struct eth_device *next;
	109	void *priv;
	110	};
	111
	112	extern int eth_initialize(bd_t bis); / Initialize network subsystem */
	113	extern int eth_register(struct eth_device* dev);/* Register network device */
	114	extern void eth_try_another(int first_restart); /* Change the device */
a3d991bd WD	115	#ifdef CONFIG_NET_MULTI
	116	extern void eth_set_current(void); /* set nterface to ethcur var. */
	117	#endif
2d966958	118	extern struct eth_device eth_get_dev(void); / get the current device MAC */
63ff004c	119	extern struct eth_device eth_get_dev_by_name(char devname); /* get device */
a3d991bd	120	extern int eth_get_dev_index (void); /* get the device index */
2d966958	121	extern void eth_set_enetaddr(int num, char* a); /* Set new MAC address */
2d966958 WD	122
	123	extern int eth_init(bd_t bis); / Initialize the device */
	124	extern int eth_send(volatile void packet, int length); / Send a packet */
f85b6071 RJ	125	#ifdef CONFIG_API
	126	extern int eth_receive(volatile void packet, int length); / Receive a packet */
	127	#endif
2d966958 WD	128	extern int eth_rx(void); /* Check for received packets */
2d966958 WD	129	extern void eth_halt(void); /* stop SCC */
5bb226e8	130	extern char eth_get_name(void); / get name of current device */
2d966958	131
53a5c424 DU	132	#ifdef CONFIG_MCAST_TFTP
	133	int eth_mcast_join( IPaddr_t mcast_addr, u8 join);
	134	u32 ether_crc (size_t len, unsigned char const *p);
	135	#endif
	136
2d966958 WD	137
	138	/**********************************************************************/
	139	/*
	140	* Protocol headers.
	141	*/
	142
	143	/*
	144	* Ethernet header
	145	*/
	146	typedef struct {
	147	uchar et_dest[6]; /* Destination node */
	148	uchar et_src[6]; /* Source node */
	149	ushort et_protlen; /* Protocol or length */
	150	uchar et_dsap; /* 802 DSAP */
	151	uchar et_ssap; /* 802 SSAP */
	152	uchar et_ctl; /* 802 control */
	153	uchar et_snap1; /* SNAP */
	154	uchar et_snap2;
	155	uchar et_snap3;
	156	ushort et_prot; /* 802 protocol */
	157	} Ethernet_t;
	158
	159	#define ETHER_HDR_SIZE 14 /* Ethernet header size */
	160	#define E802_HDR_SIZE 22 /* 802 ethernet header size */
a3d991bd WD	161
	162	/*
	163	* Ethernet header
	164	*/
	165	typedef struct {
	166	uchar vet_dest[6]; /* Destination node */
	167	uchar vet_src[6]; /* Source node */
	168	ushort vet_vlan_type; /* PROT_VLAN */
	169	ushort vet_tag; /* TAG of VLAN */
	170	ushort vet_type; /* protocol type */
	171	} VLAN_Ethernet_t;
	172
	173	#define VLAN_ETHER_HDR_SIZE 18 /* VLAN Ethernet header size */
	174
2d966958 WD	175	#define PROT_IP 0x0800 /* IP protocol */
	176	#define PROT_ARP 0x0806 /* IP ARP protocol */
	177	#define PROT_RARP 0x8035 /* IP ARP protocol */
a3d991bd	178	#define PROT_VLAN 0x8100 /* IEEE 802.1q protocol */
2d966958 WD	179
	180	#define IPPROTO_ICMP 1 /* Internet Control Message Protocol */
	181	#define IPPROTO_UDP 17 /* User Datagram Protocol */
	182
	183	/*
	184	* Internet Protocol (IP) header.
	185	*/
	186	typedef struct {
	187	uchar ip_hl_v; /* header length and version */
	188	uchar ip_tos; /* type of service */
	189	ushort ip_len; /* total length */
	190	ushort ip_id; /* identification */
	191	ushort ip_off; /* fragment offset field */
	192	uchar ip_ttl; /* time to live */
	193	uchar ip_p; /* protocol */
	194	ushort ip_sum; /* checksum */
	195	IPaddr_t ip_src; /* Source IP address */
	196	IPaddr_t ip_dst; /* Destination IP address */
	197	ushort udp_src; /* UDP source port */
	198	ushort udp_dst; /* UDP destination port */
	199	ushort udp_len; /* Length of UDP packet */
	200	ushort udp_xsum; /* Checksum */
	201	} IP_t;
	202
e0c07b86 PT	203	#define IP_OFFS 0x1fff /* ip offset = 8 /
	204	#define IP_FLAGS 0xe000 /* first 3 bits */
	205	#define IP_FLAGS_RES 0x8000 /* reserved */
	206	#define IP_FLAGS_DFRAG 0x4000 /* don't fragments */
	207	#define IP_FLAGS_MFRAG 0x2000 /* more fragments */
	208
2d966958 WD	209	#define IP_HDR_SIZE_NO_UDP (sizeof (IP_t) - 8)
	210	#define IP_HDR_SIZE (sizeof (IP_t))
	211
	212
	213	/*
	214	* Address Resolution Protocol (ARP) header.
	215	*/
	216	typedef struct
	217	{
	218	ushort ar_hrd; /* Format of hardware address */
	219	# define ARP_ETHER 1 /* Ethernet hardware address */
	220	ushort ar_pro; /* Format of protocol address */
	221	uchar ar_hln; /* Length of hardware address */
	222	uchar ar_pln; /* Length of protocol address */
	223	ushort ar_op; /* Operation */
	224	# define ARPOP_REQUEST 1 /* Request to resolve address */
	225	# define ARPOP_REPLY 2 /* Response to previous request */
	226
	227	# define RARPOP_REQUEST 3 /* Request to resolve address */
	228	# define RARPOP_REPLY 4 /* Response to previous request */
	229
	230	/*
8bde7f77 WD	231	* The remaining fields are variable in size, according to
	232	* the sizes above, and are defined as appropriate for
	233	* specific hardware/protocol combinations.
2d966958 WD	234	*/
	235	uchar ar_data[0];
	236	#if 0
	237	uchar ar_sha[]; /* Sender hardware address */
	238	uchar ar_spa[]; /* Sender protocol address */
	239	uchar ar_tha[]; /* Target hardware address */
	240	uchar ar_tpa[]; /* Target protocol address */
	241	#endif /* 0 */
	242	} ARP_t;
	243
	244	#define ARP_HDR_SIZE (8+20) /* Size assuming ethernet */
	245
	246	/*
	247	* ICMP stuff (just enough to handle (host) redirect messages)
	248	*/
53677ef1	249	#define ICMP_ECHO_REPLY 0 /* Echo reply */
2d966958	250	#define ICMP_REDIRECT 5 /* Redirect (change route) */
73a8b27c	251	#define ICMP_ECHO_REQUEST 8 /* Echo request */
2d966958 WD	252
	253	/* Codes for REDIRECT. */
	254	#define ICMP_REDIR_NET 0 /* Redirect Net */
	255	#define ICMP_REDIR_HOST 1 /* Redirect Host */
	256
	257	typedef struct icmphdr {
	258	uchar type;
	259	uchar code;
	260	ushort checksum;
	261	union {
	262	struct {
	263	ushort id;
	264	ushort sequence;
	265	} echo;
	266	ulong gateway;
	267	struct {
	268	ushort __unused;
	269	ushort mtu;
	270	} frag;
	271	} un;
	272	} ICMP_t;
	273
	274
2d966958 WD	275	/*
	276	* Maximum packet size; used to allocate packet storage.
	277	* TFTP packets can be 524 bytes + IP header + ethernet header.
	278	* Lets be conservative, and go for 38 * 16. (Must also be
	279	* a multiple of 32 bytes).
	280	*/
	281	/*
	282	* AS.HARNOIS : Better to set PKTSIZE to maximum size because
	283	* traffic type is not always controlled
	284	* maximum packet size = 1518
	285	* maximum packet size and multiple of 32 bytes = 1536
	286	*/
	287	#define PKTSIZE 1518
	288	#define PKTSIZE_ALIGN 1536
	289	/#define PKTSIZE 608/
	290
	291	/*
	292	* Maximum receive ring size; that is, the number of packets
	293	* we can buffer before overflow happens. Basically, this just
	294	* needs to be enough to prevent a packet being discarded while
	295	* we are processing the previous one.
	296	*/
	297	#define RINGSZ 4
	298	#define RINGSZ_LOG2 2
	299
	300	/**********************************************************************/
	301	/*
	302	* Globals.
	303	*
	304	* Note:
	305	*
	306	* All variables of type IPaddr_t are stored in NETWORK byte order
	307	* (big endian).
	308	*/
	309
	310	/* net.c */
	311	/ BOOTP EXTENTIONS /
	312	extern IPaddr_t NetOurGatewayIP; /* Our gateway IP addresse */
	313	extern IPaddr_t NetOurSubnetMask; /* Our subnet mask (0 = unknown)*/
	314	extern IPaddr_t NetOurDNSIP; /* Our Domain Name Server (0 = unknown)*/
1fe80d79	315	#if defined(CONFIG_BOOTP_DNS2)
fe389a82 SR	316	extern IPaddr_t NetOurDNS2IP; /* Our 2nd Domain Name Server (0 = unknown)*/
fe389a82 SR	317	#endif
2d966958 WD	318	extern char NetOurNISDomain[32]; /* Our NIS domain */
	319	extern char NetOurHostName[32]; /* Our hostname */
	320	extern char NetOurRootPath[64]; /* Our root path */
	321	extern ushort NetBootFileSize; /* Our boot file size in blocks */
	322	/ END OF BOOTP EXTENTIONS /
	323	extern ulong NetBootFileXferSize; /* size of bootfile in bytes */
	324	extern uchar NetOurEther[6]; /* Our ethernet address */
	325	extern uchar NetServerEther[6]; /* Boot server enet address */
	326	extern IPaddr_t NetOurIP; /* Our IP addr (0 = unknown) */
	327	extern IPaddr_t NetServerIP; /* Server IP addr (0 = unknown) */
	328	extern volatile uchar * NetTxPacket; /* THE transmit packet */
	329	extern volatile uchar * NetRxPackets[PKTBUFSRX];/* Receive packets */
	330	extern volatile uchar * NetRxPkt; /* Current receive packet */
	331	extern int NetRxPktLen; /* Current rx packet length */
	332	extern unsigned NetIPID; /* IP ID (counting) */
	333	extern uchar NetBcastAddr[6]; /* Ethernet boardcast address */
68ceb29e	334	extern uchar NetEtherNullAddr[6];
2d966958	335
53677ef1 WD	336	#define VLAN_NONE 4095 /* untagged */
	337	#define VLAN_IDMASK 0x0fff /* mask of valid vlan id */
	338	extern ushort NetOurVLAN; /* Our VLAN */
	339	extern ushort NetOurNativeVLAN; /* Our Native VLAN */
a3d991bd	340
53677ef1	341	extern uchar NetCDPAddr[6]; /* Ethernet CDP address */
a3d991bd WD	342	extern ushort CDPNativeVLAN; /* CDP returned native VLAN */
	343	extern ushort CDPApplianceVLAN; /* CDP returned appliance VLAN */
	344
2d966958 WD	345	extern int NetState; /* Network loop state */
	346	#define NETLOOP_CONTINUE 1
	347	#define NETLOOP_RESTART 2
	348	#define NETLOOP_SUCCESS 3
	349	#define NETLOOP_FAIL 4
	350
	351	#ifdef CONFIG_NET_MULTI
	352	extern int NetRestartWrap; /* Tried all network devices */
	353	#endif
	354
ea287deb	355	typedef enum { BOOTP, RARP, ARP, TFTP, DHCP, PING, DNS, NFS, CDP, NETCONS, SNTP } proto_t;
2d966958 WD	356
	357	/* from net/net.c */
	358	extern char BootFile[128]; /* Boot File name */
	359
639221c7	360	#if defined(CONFIG_CMD_PING)
53677ef1	361	extern IPaddr_t NetPingIP; /* the ip address to ping */
73a8b27c WD	362	#endif
73a8b27c WD	363
639221c7	364	#if defined(CONFIG_CMD_CDP)
a3d991bd WD	365	/* when CDP completes these hold the return values */
	366	extern ushort CDPNativeVLAN;
	367	extern ushort CDPApplianceVLAN;
	368	#endif
	369
639221c7	370	#if defined(CONFIG_CMD_SNTP)
53677ef1	371	extern IPaddr_t NetNtpServerIP; /* the ip address to NTP */
ea287deb WD	372	extern int NetTimeOffset; /* offset time from UTC */
	373	#endif
	374
2d966958 WD	375	/* Initialize the network adapter */
	376	extern int NetLoop(proto_t);
	377
	378	/* Shutdown adapters and cleanup */
	379	extern void NetStop(void);
	380
	381	/* Load failed. Start again. */
	382	extern void NetStartAgain(void);
	383
a3d991bd	384	/* Get size of the ethernet header when we send */
53677ef1	385	extern int NetEthHdrSize(void);
a3d991bd WD	386
	387	/* Set ethernet header; returns the size of the header */
	388	extern int NetSetEther(volatile uchar , uchar , uint);
2d966958 WD	389
	390	/* Set IP header */
	391	extern void NetSetIP(volatile uchar *, IPaddr_t, int, int, int);
	392
	393	/* Checksum */
	394	extern int NetCksumOk(uchar , int); / Return true if cksum OK */
	395	extern uint NetCksum(uchar , int); / Calculate the checksum */
	396
	397	/* Set callbacks */
	398	extern void NetSetHandler(rxhand_f ); / Set RX packet handler */
3e01d75f	399	extern void NetSetTimeout(ulong, thand_f );/ Set timeout handler */
2d966958 WD	400
	401	/* Transmit "NetTxPacket" */
	402	extern void NetSendPacket(volatile uchar *, int);
	403
73a8b27c WD	404	/* Transmit UDP packet, performing ARP request if needed */
	405	extern int NetSendUDPPacket(uchar *ether, IPaddr_t dest, int dport, int sport, int len);
	406
2d966958 WD	407	/* Processes a received packet */
	408	extern void NetReceive(volatile uchar *, int);
	409
	410	/* Print an IP address on the console */
	411	extern void print_IPaddr (IPaddr_t);
	412
	413	/*
	414	* The following functions are a bit ugly, but necessary to deal with
	415	* alignment restrictions on ARM.
	416	*
	417	* We're using inline functions, which had the smallest memory
	418	* footprint in our tests.
	419	*/
	420	/* return IP in network byteorder */
33a4a70d	421	static inline IPaddr_t NetReadIP(volatile void *from)
2d966958 WD	422	{
2d966958 WD	423	IPaddr_t ip;
33a4a70d	424	memcpy((void)&ip, (void)from, sizeof(ip));
2d966958 WD	425	return ip;
	426	}
	427
	428	/* return ulong in network byteorder */
	429	static inline ulong NetReadLong(ulong *from)
	430	{
	431	ulong l;
	432	memcpy((void)&l, (void)from, sizeof(l));
	433	return l;
	434	}
	435
	436	/* write IP in network byteorder */
	437	static inline void NetWriteIP(void *to, IPaddr_t ip)
	438	{
	439	memcpy(to, (void*)&ip, sizeof(ip));
	440	}
	441
	442	/* copy IP */
33a4a70d	443	static inline void NetCopyIP(volatile void to, void from)
2d966958	444	{
33a4a70d	445	memcpy((void*)to, from, sizeof(IPaddr_t));
2d966958 WD	446	}
	447
	448	/* copy ulong */
	449	static inline void NetCopyLong(ulong to, ulong from)
	450	{
	451	memcpy((void)to, (void)from, sizeof(ulong));
	452	}
	453
50cca8b9 MR	454	/**
	455	* is_zero_ether_addr - Determine if give Ethernet address is all zeros.
	456	* @addr: Pointer to a six-byte array containing the Ethernet address
	457	*
	458	* Return true if the address is all zeroes.
	459	*/
	460	static inline int is_zero_ether_addr(const u8 *addr)
	461	{
	462	return !(addr[0] \| addr[1] \| addr[2] \| addr[3] \| addr[4] \| addr[5]);
	463	}
	464
	465	/**
	466	* is_multicast_ether_addr - Determine if the Ethernet address is a multicast.
	467	* @addr: Pointer to a six-byte array containing the Ethernet address
	468	*
	469	* Return true if the address is a multicast address.
	470	* By definition the broadcast address is also a multicast address.
	471	*/
	472	static inline int is_multicast_ether_addr(const u8 *addr)
	473	{
	474	return (0x01 & addr[0]);
	475	}
	476
2d966958 WD	477	/* Convert an IP address to a string */
	478	extern void ip_to_string (IPaddr_t x, char *s);
	479
73a8b27c WD	480	/* Convert a string to ip address */
	481	extern IPaddr_t string_to_ip(char *s);
	482
a3d991bd WD	483	/* Convert a VLAN id to a string */
	484	extern void VLAN_to_string (ushort x, char *s);
	485
	486	/* Convert a string to a vlan id */
	487	extern ushort string_to_VLAN(char *s);
	488
2d966958 WD	489	/* read an IP address from a environment variable */
	490	extern IPaddr_t getenv_IPaddr (char *);
	491
a3d991bd WD	492	/* read a VLAN id from an environment variable */
	493	extern ushort getenv_VLAN(char *);
	494
2d966958	495	/* copy a filename (allow for "..." notation, limit length) */
77ddac94	496	extern void copy_filename (char dst, char src, int size);
2d966958 WD	497
	498	/**********************************************************************/
	499
	500	#endif /* __NET_H__ */