net.h 20.7 KB
Newer Older
W
wdenk 已提交
1 2 3 4 5
/*
 *	LiMon Monitor (LiMon) - Network.
 *
 *	Copyright 1994 - 2000 Neil Russell.
 *	(See License)
6
 *	SPDX-License-Identifier:	GPL-2.0
W
wdenk 已提交
7 8 9 10 11 12 13 14
 *
 * History
 *	9/16/00	  bor  adapted to TQM823L/STK8xxL board, RARP/TFTP boot added
 */

#ifndef __NET_H__
#define __NET_H__

15
#if defined(CONFIG_8xx)
W
wdenk 已提交
16
#include <commproc.h>
17
#endif	/* CONFIG_8xx */
W
wdenk 已提交
18

19
#include <asm/cache.h>
W
wdenk 已提交
20 21
#include <asm/byteorder.h>	/* for nton* / ntoh* stuff */

22 23 24 25
#define DEBUG_LL_STATE 0	/* Link local state machine changes */
#define DEBUG_DEV_PKT 0		/* Packets or info directed to the device */
#define DEBUG_NET_PKT 0		/* Packets on info on the network at large */
#define DEBUG_INT_STATE 0	/* Internal network state changes */
W
wdenk 已提交
26 27 28 29 30 31 32

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

33 34
#ifdef CONFIG_SYS_RX_ETH_BUFFER
# define PKTBUFSRX	CONFIG_SYS_RX_ETH_BUFFER
W
wdenk 已提交
35
#else
S
stroese 已提交
36
# define PKTBUFSRX	4
W
wdenk 已提交
37 38
#endif

39
#define PKTALIGN	ARCH_DMA_MINALIGN
W
wdenk 已提交
40

41
/* IPv4 addresses are always 32 bits in size */
K
Kim Phillips 已提交
42
typedef __be32		IPaddr_t;
W
wdenk 已提交
43 44


45 46 47 48 49 50 51
/**
 * An incoming packet handler.
 * @param pkt    pointer to the application packet
 * @param dport  destination UDP port
 * @param sip    source IP address
 * @param sport  source UDP port
 * @param len    packet length
W
wdenk 已提交
52
 */
53 54 55
typedef void rxhand_f(uchar *pkt, unsigned dport,
		      IPaddr_t sip, unsigned sport,
		      unsigned len);
W
wdenk 已提交
56

57 58 59 60 61 62 63 64 65 66 67 68 69
/**
 * An incoming ICMP packet handler.
 * @param type	ICMP type
 * @param code	ICMP code
 * @param dport	destination UDP port
 * @param sip	source IP address
 * @param sport	source UDP port
 * @param pkt	pointer to the ICMP packet data
 * @param len	packet length
 */
typedef void rxhand_icmp_f(unsigned type, unsigned code, unsigned dport,
		IPaddr_t sip, unsigned sport, uchar *pkt, unsigned len);

W
wdenk 已提交
70 71 72 73 74 75 76 77 78 79 80 81
/*
 *	A timeout handler.  Called after time interval has expired.
 */
typedef void	thand_f(void);

enum eth_state_t {
	ETH_STATE_INIT,
	ETH_STATE_PASSIVE,
	ETH_STATE_ACTIVE
};

struct eth_device {
82
	char name[16];
W
wdenk 已提交
83
	unsigned char enetaddr[6];
84
	phys_addr_t iobase;
W
wdenk 已提交
85 86
	int state;

87 88 89 90
	int  (*init) (struct eth_device *, bd_t *);
	int  (*send) (struct eth_device *, void *packet, int length);
	int  (*recv) (struct eth_device *);
	void (*halt) (struct eth_device *);
D
David Updegraff 已提交
91
#ifdef CONFIG_MCAST_TFTP
92
	int (*mcast) (struct eth_device *, const u8 *enetaddr, u8 set);
D
David Updegraff 已提交
93
#endif
94
	int  (*write_hwaddr) (struct eth_device *);
W
wdenk 已提交
95
	struct eth_device *next;
M
Michael Walle 已提交
96
	int index;
W
wdenk 已提交
97 98 99
	void *priv;
};

100 101
int eth_register(struct eth_device *dev);/* Register network device */
int eth_unregister(struct eth_device *dev);/* Remove network device */
K
Kim Phillips 已提交
102 103 104

extern struct eth_device *eth_current;

105 106 107 108 109
static inline __attribute__((always_inline))
struct eth_device *eth_get_dev(void)
{
	return eth_current;
}
110 111
struct eth_device *eth_get_dev_by_name(const char *devname);
struct eth_device *eth_get_dev_by_index(int index); /* get dev @ index */
112

113
/* get the current device MAC */
114 115 116 117 118 119 120
static inline unsigned char *eth_get_ethaddr(void)
{
	if (eth_current)
		return eth_current->enetaddr;
	return NULL;
}

121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
/* Set active state */
static inline __attribute__((always_inline)) int eth_init_state_only(bd_t *bis)
{
	eth_get_dev()->state = ETH_STATE_ACTIVE;

	return 0;
}
/* Set passive state */
static inline __attribute__((always_inline)) void eth_halt_state_only(void)
{
	eth_get_dev()->state = ETH_STATE_PASSIVE;
}

/*
 * Set the hardware address for an ethernet interface based on 'eth%daddr'
 * environment variable (or just 'ethaddr' if eth_number is 0).
 * Args:
 *	base_name - base name for device (normally "eth")
 *	eth_number - value of %d (0 for first device of this type)
 * Returns:
 *	0 is success, non-zero is error status from driver.
 */
int eth_write_hwaddr(struct eth_device *dev, const char *base_name,
		     int eth_number);

int usb_eth_initialize(bd_t *bi);

int eth_initialize(bd_t *bis);	/* Initialize network subsystem */
void eth_try_another(int first_restart);	/* Change the device */
void eth_set_current(void);		/* set nterface to ethcur var */

152 153 154 155
int eth_get_dev_index(void);		/* get the device index */
void eth_parse_enetaddr(const char *addr, uchar *enetaddr);
int eth_getenv_enetaddr(char *name, uchar *enetaddr);
int eth_setenv_enetaddr(char *name, const uchar *enetaddr);
156 157 158 159 160 161 162 163 164 165

/*
 * Get the hardware address for an ethernet interface .
 * Args:
 *	base_name - base name for device (normally "eth")
 *	index - device index number (0 for first)
 *	enetaddr - returns 6 byte hardware address
 * Returns:
 *	Return true if the address is valid.
 */
166 167
int eth_getenv_enetaddr_by_index(const char *base_name, int index,
				 uchar *enetaddr);
168

169 170
int eth_init(bd_t *bis);			/* Initialize the device */
int eth_send(void *packet, int length);	   /* Send a packet */
171

172
#ifdef CONFIG_API
173
int eth_receive(void *packet, int length); /* Receive a packet*/
174
extern void (*push_packet)(void *packet, int length);
175
#endif
176 177
int eth_rx(void);			/* Check for received packets */
void eth_halt(void);			/* stop SCC */
178
const char *eth_get_name(void);		/* get name of current device */
179

D
David Updegraff 已提交
180
#ifdef CONFIG_MCAST_TFTP
181 182
int eth_mcast_join(IPaddr_t mcast_addr, u8 join);
u32 ether_crc(size_t len, unsigned char const *p);
D
David Updegraff 已提交
183 184
#endif

W
wdenk 已提交
185 186 187 188 189 190 191 192 193

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

/*
 *	Ethernet header
 */
194 195 196 197 198 199 200 201 202 203

struct ethernet_hdr {
	uchar		et_dest[6];	/* Destination node		*/
	uchar		et_src[6];	/* Source node			*/
	ushort		et_protlen;	/* Protocol or length		*/
};

/* Ethernet header size */
#define ETHER_HDR_SIZE	(sizeof(struct ethernet_hdr))

204 205
#define ETH_FCS_LEN	4		/* Octets in the FCS		*/

206
struct e802_hdr {
W
wdenk 已提交
207 208 209 210 211 212 213 214 215 216
	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			*/
217
};
W
wdenk 已提交
218

219
/* 802 + SNAP + ethernet header size */
220
#define E802_HDR_SIZE	(sizeof(struct e802_hdr))
221 222

/*
223
 *	Virtual LAN Ethernet header
224
 */
225
struct vlan_ethernet_hdr {
226 227 228 229 230
	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		*/
231
};
232

233 234
/* VLAN Ethernet header size */
#define VLAN_ETHER_HDR_SIZE	(sizeof(struct vlan_ethernet_hdr))
235

W
wdenk 已提交
236 237 238
#define PROT_IP		0x0800		/* IP protocol			*/
#define PROT_ARP	0x0806		/* IP ARP protocol		*/
#define PROT_RARP	0x8035		/* IP ARP protocol		*/
239
#define PROT_VLAN	0x8100		/* IEEE 802.1q protocol		*/
W
wdenk 已提交
240 241 242 243 244

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

/*
245
 *	Internet Protocol (IP) header.
W
wdenk 已提交
246
 */
247
struct ip_hdr {
W
wdenk 已提交
248 249 250 251 252 253 254 255 256 257
	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	*/
J
Joe Hershberger 已提交
258
};
W
wdenk 已提交
259

P
Peter Tyser 已提交
260 261 262 263 264 265
#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 */

266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286
#define IP_HDR_SIZE		(sizeof(struct ip_hdr))

/*
 *	Internet Protocol (IP) + UDP header.
 */
struct ip_udp_hdr {
	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			*/
};
W
wdenk 已提交
287

J
Joe Hershberger 已提交
288
#define IP_UDP_HDR_SIZE		(sizeof(struct ip_udp_hdr))
289
#define UDP_HDR_SIZE		(IP_UDP_HDR_SIZE - IP_HDR_SIZE)
W
wdenk 已提交
290 291 292 293

/*
 *	Address Resolution Protocol (ARP) header.
 */
294
struct arp_hdr {
W
wdenk 已提交
295 296 297 298
	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	*/
299
#   define ARP_HLEN	6
W
wdenk 已提交
300
	uchar		ar_pln;		/* Length of protocol address	*/
301
#   define ARP_PLEN	4
W
wdenk 已提交
302 303 304 305 306 307 308 309
	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 */

	/*
W
wdenk 已提交
310 311 312
	 * The remaining fields are variable in size, according to
	 * the sizes above, and are defined as appropriate for
	 * specific hardware/protocol combinations.
W
wdenk 已提交
313 314
	 */
	uchar		ar_data[0];
315 316 317 318
#define ar_sha		ar_data[0]
#define ar_spa		ar_data[ARP_HLEN]
#define ar_tha		ar_data[ARP_HLEN + ARP_PLEN]
#define ar_tpa		ar_data[ARP_HLEN + ARP_PLEN + ARP_HLEN]
W
wdenk 已提交
319 320 321 322 323 324
#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 */
325
};
W
wdenk 已提交
326 327 328 329 330 331

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

/*
 * ICMP stuff (just enough to handle (host) redirect messages)
 */
W
Wolfgang Denk 已提交
332
#define ICMP_ECHO_REPLY		0	/* Echo reply			*/
333
#define ICMP_NOT_REACH		3	/* Detination unreachable	*/
W
wdenk 已提交
334
#define ICMP_REDIRECT		5	/* Redirect (change route)	*/
W
wdenk 已提交
335
#define ICMP_ECHO_REQUEST	8	/* Echo request			*/
W
wdenk 已提交
336 337 338 339 340

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

341 342 343
/* Codes for NOT_REACH */
#define ICMP_NOT_REACH_PORT	3	/* Port unreachable		*/

344
struct icmp_hdr {
W
wdenk 已提交
345 346 347 348 349 350 351 352 353 354
	uchar		type;
	uchar		code;
	ushort		checksum;
	union {
		struct {
			ushort	id;
			ushort	sequence;
		} echo;
		ulong	gateway;
		struct {
355
			ushort	unused;
W
wdenk 已提交
356 357
			ushort	mtu;
		} frag;
358
		uchar data[0];
W
wdenk 已提交
359
	} un;
360
};
W
wdenk 已提交
361

362 363
#define ICMP_HDR_SIZE		(sizeof(struct icmp_hdr))
#define IP_ICMP_HDR_SIZE	(IP_HDR_SIZE + ICMP_HDR_SIZE)
W
wdenk 已提交
364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401

/*
 * 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 **/
402 403 404
extern IPaddr_t NetOurGatewayIP;	/* Our gateway IP address */
extern IPaddr_t NetOurSubnetMask;	/* Our subnet mask (0 = unknown) */
extern IPaddr_t NetOurDNSIP;	/* Our Domain Name Server (0 = unknown) */
405
#if defined(CONFIG_BOOTP_DNS2)
406
extern IPaddr_t NetOurDNS2IP;	/* Our 2nd Domain Name Server (0 = unknown) */
407
#endif
408 409 410 411
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 */
W
wdenk 已提交
412
/** END OF BOOTP EXTENTIONS **/
413 414 415 416 417
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) */
418
extern uchar		*NetTxPacket;		/* THE transmit packet */
419
extern uchar		*NetRxPackets[PKTBUFSRX]; /* Receive packets */
420
extern uchar		*NetRxPacket;		/* Current receive packet */
421 422 423
extern int		NetRxPacketLen;		/* Current rx packet length */
extern unsigned		NetIPID;		/* IP ID (counting) */
extern uchar		NetBcastAddr[6];	/* Ethernet boardcast address */
424
extern uchar		NetEtherNullAddr[6];
W
wdenk 已提交
425

426 427 428 429
#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 */
430

431
extern int		NetRestartWrap;		/* Tried all network devices */
W
wdenk 已提交
432

S
Simon Glass 已提交
433 434
enum proto_t {
	BOOTP, RARP, ARP, TFTPGET, DHCP, PING, DNS, NFS, CDP, NETCONS, SNTP,
435
	TFTPSRV, TFTPPUT, LINKLOCAL
S
Simon Glass 已提交
436
};
W
wdenk 已提交
437 438

/* from net/net.c */
439
extern char	BootFile[128];			/* Boot File name */
W
wdenk 已提交
440

R
Robin Getz 已提交
441 442 443 444 445
#if defined(CONFIG_CMD_DNS)
extern char *NetDNSResolve;		/* The host to resolve  */
extern char *NetDNSenvvar;		/* the env var to put the ip into */
#endif

446
#if defined(CONFIG_CMD_PING)
447
extern IPaddr_t	NetPingIP;			/* the ip address to ping */
W
wdenk 已提交
448 449
#endif

450
#if defined(CONFIG_CMD_CDP)
451
/* when CDP completes these hold the return values */
J
Joe Hershberger 已提交
452 453
extern ushort CDPNativeVLAN;		/* CDP returned native VLAN */
extern ushort CDPApplianceVLAN;		/* CDP returned appliance VLAN */
454 455 456 457 458 459 460 461 462 463

/*
 * Check for a CDP packet by examining the received MAC address field
 */
static inline int is_cdp_packet(const uchar *et_addr)
{
	extern const uchar NetCDPAddr[6];

	return memcmp(et_addr, NetCDPAddr, 6) == 0;
}
464 465
#endif

466
#if defined(CONFIG_CMD_SNTP)
467 468
extern IPaddr_t	NetNtpServerIP;			/* the ip address to NTP */
extern int NetTimeOffset;			/* offset time from UTC */
W
wdenk 已提交
469 470
#endif

471 472 473 474
#if defined(CONFIG_MCAST_TFTP)
extern IPaddr_t Mcast_addr;
#endif

W
wdenk 已提交
475
/* Initialize the network adapter */
476 477
void net_init(void);
int NetLoop(enum proto_t);
W
wdenk 已提交
478 479

/* Shutdown adapters and cleanup */
480
void	NetStop(void);
W
wdenk 已提交
481 482

/* Load failed.	 Start again. */
483
void	NetStartAgain(void);
W
wdenk 已提交
484

485
/* Get size of the ethernet header when we send */
486
int	NetEthHdrSize(void);
487 488

/* Set ethernet header; returns the size of the header */
489 490
int NetSetEther(uchar *, uchar *, uint);
int net_update_ether(struct ethernet_hdr *et, uchar *addr, uint prot);
W
wdenk 已提交
491 492

/* Set IP header */
493 494
void net_set_ip_header(uchar *pkt, IPaddr_t dest, IPaddr_t source);
void net_set_udp_header(uchar *pkt, IPaddr_t dest, int dport,
495
				int sport, int len);
W
wdenk 已提交
496

497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526
/**
 * compute_ip_checksum() - Compute IP checksum
 *
 * @addr:	Address to check (must be 16-bit aligned)
 * @nbytes:	Number of bytes to check (normally a multiple of 2)
 * @return 16-bit IP checksum
 */
unsigned compute_ip_checksum(const void *addr, unsigned nbytes);

/**
 * add_ip_checksums() - add two IP checksums
 *
 * @offset:	Offset of first sum (if odd we do a byte-swap)
 * @sum:	First checksum
 * @new_sum:	New checksum to add
 * @return updated 16-bit IP checksum
 */
unsigned add_ip_checksums(unsigned offset, unsigned sum, unsigned new_sum);

/**
 * ip_checksum_ok() - check if a checksum is correct
 *
 * This works by making sure the checksum sums to 0
 *
 * @addr:	Address to check (must be 16-bit aligned)
 * @nbytes:	Number of bytes to check (normally a multiple of 2)
 * @return true if the checksum matches, false if not
 */
int ip_checksum_ok(const void *addr, unsigned nbytes);

J
Joe Hershberger 已提交
527
/* Callbacks */
528 529 530 531 532 533
rxhand_f *net_get_udp_handler(void);	/* Get UDP RX packet handler */
void net_set_udp_handler(rxhand_f *);	/* Set UDP RX packet handler */
rxhand_f *net_get_arp_handler(void);	/* Get ARP RX packet handler */
void net_set_arp_handler(rxhand_f *);	/* Set ARP RX packet handler */
void net_set_icmp_handler(rxhand_icmp_f *f); /* Set ICMP RX handler */
void	NetSetTimeout(ulong, thand_f *);/* Set timeout handler */
W
wdenk 已提交
534

535 536 537 538 539 540 541
/* Network loop state */
enum net_loop_state {
	NETLOOP_CONTINUE,
	NETLOOP_RESTART,
	NETLOOP_SUCCESS,
	NETLOOP_FAIL
};
K
Kim Phillips 已提交
542 543
extern enum net_loop_state net_state;

544 545
static inline void net_set_state(enum net_loop_state state)
{
546
	debug_cond(DEBUG_INT_STATE, "--- NetState set to %d\n", state);
547 548 549
	net_state = state;
}

550
/* Transmit a packet */
551 552 553 554
static inline void NetSendPacket(uchar *pkt, int len)
{
	(void) eth_send(pkt, len);
}
W
wdenk 已提交
555

556
/*
557
 * Transmit "NetTxPacket" as UDP packet, performing ARP request if needed
558
 *  (ether will be populated)
559 560 561 562 563 564 565
 *
 * @param ether Raw packet buffer
 * @param dest IP address to send the datagram to
 * @param dport Destination UDP port
 * @param sport Source UDP port
 * @param payload_len Length of data after the UDP header
 */
566
int NetSendUDPPacket(uchar *ether, IPaddr_t dest, int dport,
567
			int sport, int payload_len);
W
wdenk 已提交
568

W
wdenk 已提交
569
/* Processes a received packet */
570
void NetReceive(uchar *, int);
W
wdenk 已提交
571

572 573
#ifdef CONFIG_NETCONSOLE
void NcStart(void);
574 575
int nc_input_packet(uchar *pkt, IPaddr_t src_ip, unsigned dest_port,
	unsigned src_port, unsigned len);
576 577
#endif

578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597
static inline __attribute__((always_inline)) int eth_is_on_demand_init(void)
{
#ifdef CONFIG_NETCONSOLE
	extern enum proto_t net_loop_last_protocol;

	return net_loop_last_protocol != NETCONS;
#else
	return 1;
#endif
}

static inline void eth_set_last_protocol(int protocol)
{
#ifdef CONFIG_NETCONSOLE
	extern enum proto_t net_loop_last_protocol;

	net_loop_last_protocol = protocol;
#endif
}

598 599 600 601 602 603
/*
 * Check if autoload is enabled. If so, use either NFS or TFTP to download
 * the boot file.
 */
void net_auto_load(void);

W
wdenk 已提交
604 605 606 607 608 609 610 611
/*
 * 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* */
612
static inline IPaddr_t NetReadIP(void *from)
W
wdenk 已提交
613 614
{
	IPaddr_t ip;
615 616

	memcpy((void *)&ip, (void *)from, sizeof(ip));
W
wdenk 已提交
617 618 619 620 621 622 623
	return ip;
}

/* return ulong *in network byteorder* */
static inline ulong NetReadLong(ulong *from)
{
	ulong l;
624 625

	memcpy((void *)&l, (void *)from, sizeof(l));
W
wdenk 已提交
626 627 628 629 630 631
	return l;
}

/* write IP *in network byteorder* */
static inline void NetWriteIP(void *to, IPaddr_t ip)
{
632
	memcpy(to, (void *)&ip, sizeof(ip));
W
wdenk 已提交
633 634 635
}

/* copy IP */
636
static inline void NetCopyIP(void *to, void *from)
W
wdenk 已提交
637
{
638
	memcpy((void *)to, from, sizeof(IPaddr_t));
W
wdenk 已提交
639 640 641 642 643
}

/* copy ulong */
static inline void NetCopyLong(ulong *to, ulong *from)
{
644
	memcpy((void *)to, (void *)from, sizeof(ulong));
W
wdenk 已提交
645 646
}

647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666
/**
 * 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)
{
667
	return 0x01 & addr[0];
668 669
}

670 671 672 673 674 675 676 677
/*
 * is_broadcast_ether_addr - Determine if the Ethernet address is broadcast
 * @addr: Pointer to a six-byte array containing the Ethernet address
 *
 * Return true if the address is the broadcast address.
 */
static inline int is_broadcast_ether_addr(const u8 *addr)
{
678 679
	return (addr[0] & addr[1] & addr[2] & addr[3] & addr[4] & addr[5]) ==
		0xff;
680 681 682
}

/*
683 684 685 686 687 688 689 690
 * is_valid_ether_addr - Determine if the given Ethernet address is valid
 * @addr: Pointer to a six-byte array containing the Ethernet address
 *
 * Check that the Ethernet address (MAC) is not 00:00:00:00:00:00, is not
 * a multicast address, and is not FF:FF:FF:FF:FF:FF.
 *
 * Return true if the address is valid.
 */
691
static inline int is_valid_ether_addr(const u8 *addr)
692 693 694 695 696 697
{
	/* FF:FF:FF:FF:FF:FF is a multicast address so we don't need to
	 * explicitly check for it here. */
	return !is_multicast_ether_addr(addr) && !is_zero_ether_addr(addr);
}

698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716
/**
 * eth_random_addr - Generate software assigned random Ethernet address
 * @addr: Pointer to a six-byte array containing the Ethernet address
 *
 * Generate a random Ethernet address (MAC) that is not multicast
 * and has the local assigned bit set.
 */
static inline void eth_random_addr(uchar *addr)
{
	int i;
	unsigned int seed = get_timer(0);

	for (i = 0; i < 6; i++)
		addr[i] = rand_r(&seed);

	addr[0] &= 0xfe;	/* clear multicast bit */
	addr[0] |= 0x02;	/* set local assignment bit (IEEE802) */
}

W
wdenk 已提交
717
/* Convert an IP address to a string */
718
void ip_to_string(IPaddr_t x, char *s);
W
wdenk 已提交
719

W
wdenk 已提交
720
/* Convert a string to ip address */
721
IPaddr_t string_to_ip(const char *s);
W
wdenk 已提交
722

723
/* Convert a VLAN id to a string */
724
void VLAN_to_string(ushort x, char *s);
725 726

/* Convert a string to a vlan id */
727
ushort string_to_VLAN(const char *s);
728 729

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

W
wdenk 已提交
732
/* copy a filename (allow for "..." notation, limit length) */
733
void copy_filename(char *dst, const char *src, int size);
W
wdenk 已提交
734

M
Mike Frysinger 已提交
735
/* get a random source port */
736
unsigned int random_port(void);
M
Mike Frysinger 已提交
737

S
Simon Glass 已提交
738
/* Update U-Boot over TFTP */
739
int update_tftp(ulong addr);
S
Simon Glass 已提交
740

W
wdenk 已提交
741 742 743
/**********************************************************************/

#endif /* __NET_H__ */