net.h 28.2 KB
Newer Older
1
/* SPDX-License-Identifier: GPL-2.0 */
wdenk's avatar
wdenk committed
2
3
4
5
6
7
8
9
10
11
12
13
14
/*
 *	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__

15
#include <linux/types.h>
16
#include <asm/cache.h>
wdenk's avatar
wdenk committed
17
#include <asm/byteorder.h>	/* for nton* / ntoh* stuff */
Simon Glass's avatar
Simon Glass committed
18
#include <env.h>
19
20
#include <log.h>
#include <time.h>
21
#include <linux/if_ether.h>
22
#include <rand.h>
wdenk's avatar
wdenk committed
23

24
struct bd_info;
25
struct cmd_tbl;
26
struct udevice;
27

28
29
30
31
#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 */
wdenk's avatar
wdenk committed
32
33
34
35
36
37
38

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

39
40
#ifdef CONFIG_SYS_RX_ETH_BUFFER
# define PKTBUFSRX	CONFIG_SYS_RX_ETH_BUFFER
wdenk's avatar
wdenk committed
41
#else
stroese's avatar
stroese committed
42
# define PKTBUFSRX	4
wdenk's avatar
wdenk committed
43
44
#endif

45
#define PKTALIGN	ARCH_DMA_MINALIGN
wdenk's avatar
wdenk committed
46

47
48
49
/* Number of packets processed together */
#define ETH_PACKETS_BATCH_RECV	32

50
51
/* ARP hardware address length */
#define ARP_HLEN 6
52
53
54
55
56
/*
 * The size of a MAC address in string form, each digit requires two chars
 * and five separator characters to form '00:00:00:00:00:00'.
 */
#define ARP_HLEN_ASCII (ARP_HLEN * 2) + (ARP_HLEN - 1)
57

58
/* IPv4 addresses are always 32 bits in size */
59
60
61
struct in_addr {
	__be32 s_addr;
};
wdenk's avatar
wdenk committed
62

Simon Glass's avatar
Simon Glass committed
63
64
65
66
67
68
69
70
71
/**
 * do_tftpb - Run the tftpboot command
 *
 * @cmdtp: Command information for tftpboot
 * @flag: Command flags (CMD_FLAG_...)
 * @argc: Number of arguments
 * @argv: List of arguments
 * @return result (see enum command_ret_t)
 */
72
int do_tftpb(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]);
Simon Glass's avatar
Simon Glass committed
73

74
75
76
77
78
79
80
/**
 * 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
wdenk's avatar
wdenk committed
81
 */
82
typedef void rxhand_f(uchar *pkt, unsigned dport,
83
		      struct in_addr sip, unsigned sport,
84
		      unsigned len);
wdenk's avatar
wdenk committed
85

86
87
88
89
90
91
92
93
94
95
96
/**
 * 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,
97
		struct in_addr sip, unsigned sport, uchar *pkt, unsigned len);
98

wdenk's avatar
wdenk committed
99
100
101
102
103
104
105
106
107
108
109
/*
 *	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
};

110
111
112
113
114
115
#ifdef CONFIG_DM_ETH
/**
 * struct eth_pdata - Platform data for Ethernet MAC controllers
 *
 * @iobase: The base address of the hardware registers
 * @enetaddr: The Ethernet MAC address that is loaded from EEPROM or env
116
 * @phy_interface: PHY interface to use - see PHY_INTERFACE_MODE_...
117
 * @max_speed: Maximum speed of Ethernet connection supported by MAC
118
 * @priv_pdata: device specific plat
119
120
121
 */
struct eth_pdata {
	phys_addr_t iobase;
122
	unsigned char enetaddr[ARP_HLEN];
123
	int phy_interface;
124
	int max_speed;
Faiz Abbas's avatar
Faiz Abbas committed
125
	void *priv_pdata;
126
127
};

128
129
130
131
132
133
134
135
enum eth_recv_flags {
	/*
	 * Check hardware device for new packets (otherwise only return those
	 * which are already in the memory buffer ready to process)
	 */
	ETH_RECV_CHECK_DEVICE		= 1 << 0,
};

136
137
138
139
140
/**
 * struct eth_ops - functions of Ethernet MAC controllers
 *
 * start: Prepare the hardware to send and receive packets
 * send: Send the bytes passed in "packet" as a packet on the wire
141
142
 * recv: Check if the hardware received a packet. If so, set the pointer to the
 *	 packet buffer in the packetp parameter. If not, return an error or 0 to
143
144
145
146
147
148
 *	 indicate that the hardware receive FIFO is empty. If 0 is returned, the
 *	 network stack will not process the empty packet, but free_pkt() will be
 *	 called if supplied
 * free_pkt: Give the driver an opportunity to manage its packet buffer memory
 *	     when the network stack is finished processing it. This will only be
 *	     called when no error was returned from recv - optional
149
150
151
152
153
 * stop: Stop the hardware from looking for packets - may be called even if
 *	 state == PASSIVE
 * mcast: Join or leave a multicast group (for TFTP) - optional
 * write_hwaddr: Write a MAC address to the hardware (used to pass it to Linux
 *		 on some platforms like ARM). This function expects the
154
155
156
 *		 eth_pdata::enetaddr field to be populated. The method can
 *		 return -ENOSYS to indicate that this is not implemented for
		 this hardware - optional.
157
158
159
160
 * read_rom_hwaddr: Some devices have a backup of the MAC address stored in a
 *		    ROM on the board. This is how the driver should expose it
 *		    to the network stack. This function should fill in the
 *		    eth_pdata::enetaddr field - optional
161
 * set_promisc: Enable or Disable promiscuous mode
162
163
164
165
 */
struct eth_ops {
	int (*start)(struct udevice *dev);
	int (*send)(struct udevice *dev, void *packet, int length);
166
	int (*recv)(struct udevice *dev, int flags, uchar **packetp);
167
	int (*free_pkt)(struct udevice *dev, uchar *packet, int length);
168
169
170
171
	void (*stop)(struct udevice *dev);
	int (*mcast)(struct udevice *dev, const u8 *enetaddr, int join);
	int (*write_hwaddr)(struct udevice *dev);
	int (*read_rom_hwaddr)(struct udevice *dev);
172
	int (*set_promisc)(struct udevice *dev, bool enable);
173
174
175
176
177
};

#define eth_get_ops(dev) ((struct eth_ops *)(dev)->driver->ops)

struct udevice *eth_get_dev(void); /* get the current device */
178
179
180
181
182
/*
 * The devname can be either an exact name given by the driver or device tree
 * or it can be an alias of the form "eth%d"
 */
struct udevice *eth_get_dev_by_name(const char *devname);
183
unsigned char *eth_get_ethaddr(void); /* get the current device MAC */
184

185
/* Used only when NetConsole is enabled */
186
int eth_is_active(struct udevice *dev); /* Test device for active state */
187
188
189
190
191
int eth_init_state_only(void); /* Set active state */
void eth_halt_state_only(void); /* Set passive state */
#endif

#ifndef CONFIG_DM_ETH
wdenk's avatar
wdenk committed
192
struct eth_device {
193
#define ETH_NAME_LEN 20
194
	char name[ETH_NAME_LEN];
195
	unsigned char enetaddr[ARP_HLEN];
196
	phys_addr_t iobase;
wdenk's avatar
wdenk committed
197
198
	int state;

199
	int (*init)(struct eth_device *eth, struct bd_info *bd);
200
201
202
	int (*send)(struct eth_device *, void *packet, int length);
	int (*recv)(struct eth_device *);
	void (*halt)(struct eth_device *);
Chris Packham's avatar
Chris Packham committed
203
	int (*mcast)(struct eth_device *, const u8 *enetaddr, int join);
204
	int (*write_hwaddr)(struct eth_device *eth);
wdenk's avatar
wdenk committed
205
	struct eth_device *next;
206
	int index;
wdenk's avatar
wdenk committed
207
208
209
	void *priv;
};

210
211
int eth_register(struct eth_device *dev);/* Register network device */
int eth_unregister(struct eth_device *dev);/* Remove network device */
Kim Phillips's avatar
Kim Phillips committed
212
213
214

extern struct eth_device *eth_current;

215
static __always_inline struct eth_device *eth_get_dev(void)
216
217
218
{
	return eth_current;
}
219
220
struct eth_device *eth_get_dev_by_name(const char *devname);
struct eth_device *eth_get_dev_by_index(int index); /* get dev @ index */
221

222
/* get the current device MAC */
223
224
225
226
227
228
229
static inline unsigned char *eth_get_ethaddr(void)
{
	if (eth_current)
		return eth_current->enetaddr;
	return NULL;
}

230
231
/* Used only when NetConsole is enabled */
int eth_is_active(struct eth_device *dev); /* Test device for active state */
232
/* Set active state */
233
static __always_inline int eth_init_state_only(void)
234
235
236
237
238
239
{
	eth_get_dev()->state = ETH_STATE_ACTIVE;

	return 0;
}
/* Set passive state */
240
static __always_inline void eth_halt_state_only(void)
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
{
	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);

257
int usb_eth_initialize(struct bd_info *bi);
258
#endif
259

260
int eth_initialize(void);		/* Initialize network subsystem */
261
262
263
void eth_try_another(int first_restart);	/* Change the device */
void eth_set_current(void);		/* set nterface to ethcur var */

264
int eth_get_dev_index(void);		/* get the device index */
265

266
/**
267
 * eth_env_set_enetaddr_by_index() - set the MAC address environment variable
268
269
270
271
272
273
274
275
276
277
278
 *
 * This sets up an environment variable with the given MAC address (@enetaddr).
 * The environment variable to be set is defined by <@base_name><@index>addr.
 * If @index is 0 it is omitted. For common Ethernet this means ethaddr,
 * eth1addr, etc.
 *
 * @base_name:  Base name for variable, typically "eth"
 * @index:      Index of interface being updated (>=0)
 * @enetaddr:   Pointer to MAC address to put into the variable
 * @return 0 if OK, other value on error
 */
279
int eth_env_set_enetaddr_by_index(const char *base_name, int index,
280
281
282
				 uchar *enetaddr);


283
284
285
286
287
288
289
/*
 * Initialize USB ethernet device with CONFIG_DM_ETH
 * Returns:
 *	0 is success, non-zero is error status.
 */
int usb_ether_init(void);

290
291
292
293
294
295
296
297
298
/*
 * 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.
 */
299
int eth_env_get_enetaddr_by_index(const char *base_name, int index,
300
				 uchar *enetaddr);
301

302
int eth_init(void);			/* Initialize the device */
303
int eth_send(void *packet, int length);	   /* Send a packet */
304

305
#if defined(CONFIG_API) || defined(CONFIG_EFI_LOADER)
306
int eth_receive(void *packet, int length); /* Receive a packet*/
307
extern void (*push_packet)(void *packet, int length);
308
#endif
309
310
int eth_rx(void);			/* Check for received packets */
void eth_halt(void);			/* stop SCC */
311
const char *eth_get_name(void);		/* get name of current device */
312
int eth_mcast_join(struct in_addr mcast_addr, int join);
wdenk's avatar
wdenk committed
313
314
315
316
317
318
319
320
321

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

/*
 *	Ethernet header
 */
322
323

struct ethernet_hdr {
324
325
326
	u8		et_dest[ARP_HLEN];	/* Destination node	*/
	u8		et_src[ARP_HLEN];	/* Source node		*/
	u16		et_protlen;		/* Protocol or length	*/
327
} __attribute__((packed));
328
329
330
331

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

332
333
#define ETH_FCS_LEN	4		/* Octets in the FCS		*/

334
struct e802_hdr {
335
336
337
338
339
340
341
	u8		et_dest[ARP_HLEN];	/* Destination node	*/
	u8		et_src[ARP_HLEN];	/* Source node		*/
	u16		et_protlen;		/* Protocol or length	*/
	u8		et_dsap;		/* 802 DSAP		*/
	u8		et_ssap;		/* 802 SSAP		*/
	u8		et_ctl;			/* 802 control		*/
	u8		et_snap1;		/* SNAP			*/
342
343
	u8		et_snap2;
	u8		et_snap3;
344
	u16		et_prot;		/* 802 protocol		*/
345
} __attribute__((packed));
wdenk's avatar
wdenk committed
346

347
/* 802 + SNAP + ethernet header size */
348
#define E802_HDR_SIZE	(sizeof(struct e802_hdr))
349
350

/*
351
 *	Virtual LAN Ethernet header
352
 */
353
struct vlan_ethernet_hdr {
354
355
356
357
358
	u8		vet_dest[ARP_HLEN];	/* Destination node	*/
	u8		vet_src[ARP_HLEN];	/* Source node		*/
	u16		vet_vlan_type;		/* PROT_VLAN		*/
	u16		vet_tag;		/* TAG of VLAN		*/
	u16		vet_type;		/* protocol type	*/
359
} __attribute__((packed));
360

361
362
/* VLAN Ethernet header size */
#define VLAN_ETHER_HDR_SIZE	(sizeof(struct vlan_ethernet_hdr))
363

wdenk's avatar
wdenk committed
364
365
#define PROT_IP		0x0800		/* IP protocol			*/
#define PROT_ARP	0x0806		/* IP ARP protocol		*/
366
#define PROT_WOL	0x0842		/* ether-wake WoL protocol	*/
wdenk's avatar
wdenk committed
367
#define PROT_RARP	0x8035		/* IP ARP protocol		*/
368
#define PROT_VLAN	0x8100		/* IEEE 802.1q protocol		*/
369
370
#define PROT_IPV6	0x86dd		/* IPv6 over bluebook		*/
#define PROT_PPP_SES	0x8864		/* PPPoE session messages	*/
371
#define PROT_NCSI	0x88f8		/* NC-SI control packets        */
wdenk's avatar
wdenk committed
372
373
374
375
376

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

/*
377
 *	Internet Protocol (IP) header.
wdenk's avatar
wdenk committed
378
 */
379
struct ip_hdr {
380
381
382
383
384
385
386
387
	u8		ip_hl_v;	/* header length and version	*/
	u8		ip_tos;		/* type of service		*/
	u16		ip_len;		/* total length			*/
	u16		ip_id;		/* identification		*/
	u16		ip_off;		/* fragment offset field	*/
	u8		ip_ttl;		/* time to live			*/
	u8		ip_p;		/* protocol			*/
	u16		ip_sum;		/* checksum			*/
388
389
	struct in_addr	ip_src;		/* Source IP address		*/
	struct in_addr	ip_dst;		/* Destination IP address	*/
390
} __attribute__((packed));
wdenk's avatar
wdenk committed
391

Peter Tyser's avatar
Peter Tyser committed
392
393
394
395
396
397
#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 */

398
399
400
401
402
403
#define IP_HDR_SIZE		(sizeof(struct ip_hdr))

/*
 *	Internet Protocol (IP) + UDP header.
 */
struct ip_udp_hdr {
404
405
406
407
408
409
410
411
	u8		ip_hl_v;	/* header length and version	*/
	u8		ip_tos;		/* type of service		*/
	u16		ip_len;		/* total length			*/
	u16		ip_id;		/* identification		*/
	u16		ip_off;		/* fragment offset field	*/
	u8		ip_ttl;		/* time to live			*/
	u8		ip_p;		/* protocol			*/
	u16		ip_sum;		/* checksum			*/
412
413
	struct in_addr	ip_src;		/* Source IP address		*/
	struct in_addr	ip_dst;		/* Destination IP address	*/
414
415
416
417
	u16		udp_src;	/* UDP source port		*/
	u16		udp_dst;	/* UDP destination port		*/
	u16		udp_len;	/* Length of UDP packet		*/
	u16		udp_xsum;	/* Checksum			*/
418
} __attribute__((packed));
wdenk's avatar
wdenk committed
419

420
#define IP_UDP_HDR_SIZE		(sizeof(struct ip_udp_hdr))
421
#define UDP_HDR_SIZE		(IP_UDP_HDR_SIZE - IP_HDR_SIZE)
wdenk's avatar
wdenk committed
422
423
424
425

/*
 *	Address Resolution Protocol (ARP) header.
 */
426
struct arp_hdr {
427
	u16		ar_hrd;		/* Format of hardware address	*/
wdenk's avatar
wdenk committed
428
#   define ARP_ETHER	    1		/* Ethernet  hardware address	*/
429
430
431
	u16		ar_pro;		/* Format of protocol address	*/
	u8		ar_hln;		/* Length of hardware address	*/
	u8		ar_pln;		/* Length of protocol address	*/
432
#   define ARP_PLEN	4
433
	u16		ar_op;		/* Operation			*/
wdenk's avatar
wdenk committed
434
435
436
437
438
439
440
#   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 */

	/*
wdenk's avatar
wdenk committed
441
442
443
	 * The remaining fields are variable in size, according to
	 * the sizes above, and are defined as appropriate for
	 * specific hardware/protocol combinations.
wdenk's avatar
wdenk committed
444
	 */
445
	u8		ar_data[0];
446
447
448
449
#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]
wdenk's avatar
wdenk committed
450
#if 0
451
452
453
454
	u8		ar_sha[];	/* Sender hardware address	*/
	u8		ar_spa[];	/* Sender protocol address	*/
	u8		ar_tha[];	/* Target hardware address	*/
	u8		ar_tpa[];	/* Target protocol address	*/
wdenk's avatar
wdenk committed
455
#endif /* 0 */
456
} __attribute__((packed));
wdenk's avatar
wdenk committed
457
458
459
460
461
462

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

/*
 * ICMP stuff (just enough to handle (host) redirect messages)
 */
Wolfgang Denk's avatar
Wolfgang Denk committed
463
#define ICMP_ECHO_REPLY		0	/* Echo reply			*/
464
#define ICMP_NOT_REACH		3	/* Detination unreachable	*/
wdenk's avatar
wdenk committed
465
#define ICMP_REDIRECT		5	/* Redirect (change route)	*/
wdenk's avatar
wdenk committed
466
#define ICMP_ECHO_REQUEST	8	/* Echo request			*/
wdenk's avatar
wdenk committed
467
468
469
470
471

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

472
473
474
/* Codes for NOT_REACH */
#define ICMP_NOT_REACH_PORT	3	/* Port unreachable		*/

475
struct icmp_hdr {
476
477
478
	u8		type;
	u8		code;
	u16		checksum;
wdenk's avatar
wdenk committed
479
480
	union {
		struct {
481
482
			u16	id;
			u16	sequence;
wdenk's avatar
wdenk committed
483
		} echo;
484
		u32	gateway;
wdenk's avatar
wdenk committed
485
		struct {
486
487
			u16	unused;
			u16	mtu;
wdenk's avatar
wdenk committed
488
		} frag;
489
		u8 data[0];
wdenk's avatar
wdenk committed
490
	} un;
491
} __attribute__((packed));
wdenk's avatar
wdenk committed
492

493
494
#define ICMP_HDR_SIZE		(sizeof(struct icmp_hdr))
#define IP_ICMP_HDR_SIZE	(IP_HDR_SIZE + ICMP_HDR_SIZE)
wdenk's avatar
wdenk committed
495
496

/*
497
498
499
500
 * Maximum packet size; used to allocate packet storage. Use
 * the maxium Ethernet frame size as specified by the Ethernet
 * standard including the 802.1Q tag (VLAN tagging).
 * maximum packet size =  1522
wdenk's avatar
wdenk committed
501
502
 * maximum packet size and multiple of 32 bytes =  1536
 */
503
#define PKTSIZE			1522
504
#ifndef CONFIG_DM_DSA
wdenk's avatar
wdenk committed
505
#define PKTSIZE_ALIGN		1536
506
507
508
509
510
#else
/* Maximum DSA tagging overhead (headroom and/or tailroom) */
#define DSA_MAX_OVR		256
#define PKTSIZE_ALIGN		(1536 + DSA_MAX_OVR)
#endif
wdenk's avatar
wdenk committed
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526

/*
 * 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:
 *
527
 * All variables of type struct in_addr are stored in NETWORK byte order
wdenk's avatar
wdenk committed
528
529
530
531
532
 * (big endian).
 */

/* net.c */
/** BOOTP EXTENTIONS **/
533
534
535
536
extern struct in_addr net_gateway;	/* Our gateway IP address */
extern struct in_addr net_netmask;	/* Our subnet mask (0 = unknown) */
/* Our Domain Name Server (0 = unknown) */
extern struct in_addr net_dns_server;
537
#if defined(CONFIG_BOOTP_DNS2)
538
539
/* Our 2nd Domain Name Server (0 = unknown) */
extern struct in_addr net_dns_server2;
540
#endif
541
542
543
extern char	net_nis_domain[32];	/* Our IS domain */
extern char	net_hostname[32];	/* Our hostname */
extern char	net_root_path[64];	/* Our root path */
wdenk's avatar
wdenk committed
544
/** END OF BOOTP EXTENTIONS **/
545
546
extern u8		net_ethaddr[ARP_HLEN];		/* Our ethernet address */
extern u8		net_server_ethaddr[ARP_HLEN];	/* Boot server enet address */
547
548
extern struct in_addr	net_ip;		/* Our    IP addr (0 = unknown) */
extern struct in_addr	net_server_ip;	/* Server IP addr (0 = unknown) */
549
extern uchar		*net_tx_packet;		/* THE transmit packet */
550
extern uchar		*net_rx_packets[PKTBUFSRX]; /* Receive packets */
551
552
extern uchar		*net_rx_packet;		/* Current receive packet */
extern int		net_rx_packet_len;	/* Current rx packet length */
553
554
extern const u8		net_bcast_ethaddr[ARP_HLEN];	/* Ethernet broadcast address */
extern const u8		net_null_ethaddr[ARP_HLEN];
wdenk's avatar
wdenk committed
555

556
557
#define VLAN_NONE	4095			/* untagged */
#define VLAN_IDMASK	0x0fff			/* mask of valid vlan id */
558
559
extern ushort		net_our_vlan;		/* Our VLAN */
extern ushort		net_native_vlan;	/* Our Native VLAN */
560

561
extern int		net_restart_wrap;	/* Tried all network devices */
wdenk's avatar
wdenk committed
562

563
564
enum proto_t {
	BOOTP, RARP, ARP, TFTPGET, DHCP, PING, DNS, NFS, CDP, NETCONS, SNTP,
565
	TFTPSRV, TFTPPUT, LINKLOCAL, FASTBOOT, WOL, UDP
566
};
wdenk's avatar
wdenk committed
567

568
extern char	net_boot_file_name[1024];/* Boot File name */
569
570
/* Indicates whether the file name was specified on the command line */
extern bool	net_boot_file_name_explicit;
571
572
573
574
/* The actual transferred size of the bootfile (in bytes) */
extern u32	net_boot_file_size;
/* Boot file size in blocks as reported by the DHCP server */
extern u32	net_boot_file_expected_size_in_blocks;
wdenk's avatar
wdenk committed
575

Robin Getz's avatar
Robin Getz committed
576
#if defined(CONFIG_CMD_DNS)
577
578
extern char *net_dns_resolve;		/* The host to resolve  */
extern char *net_dns_env_var;		/* the env var to put the ip into */
Robin Getz's avatar
Robin Getz committed
579
580
#endif

581
#if defined(CONFIG_CMD_PING)
582
extern struct in_addr net_ping_ip;	/* the ip address to ping */
wdenk's avatar
wdenk committed
583
584
#endif

585
#if defined(CONFIG_CMD_CDP)
586
/* when CDP completes these hold the return values */
587
588
extern ushort cdp_native_vlan;		/* CDP returned native VLAN */
extern ushort cdp_appliance_vlan;	/* CDP returned appliance VLAN */
589
590
591
592

/*
 * Check for a CDP packet by examining the received MAC address field
 */
593
static inline int is_cdp_packet(const uchar *ethaddr)
594
{
595
	extern const u8 net_cdp_ethaddr[ARP_HLEN];
596

597
	return memcmp(ethaddr, net_cdp_ethaddr, ARP_HLEN) == 0;
598
}
599
600
#endif

601
#if defined(CONFIG_CMD_SNTP)
602
extern struct in_addr	net_ntp_server;		/* the ip address to NTP */
603
extern int net_ntp_time_offset;			/* offset time from UTC */
wdenk's avatar
wdenk committed
604
605
#endif

wdenk's avatar
wdenk committed
606
/* Initialize the network adapter */
607
int net_init(void);
608
int net_loop(enum proto_t);
wdenk's avatar
wdenk committed
609
610

/* Load failed.	 Start again. */
611
int net_start_again(void);
wdenk's avatar
wdenk committed
612

613
/* Get size of the ethernet header when we send */
614
int net_eth_hdr_size(void);
615
616

/* Set ethernet header; returns the size of the header */
617
int net_set_ether(uchar *xet, const uchar *dest_ethaddr, uint prot);
618
int net_update_ether(struct ethernet_hdr *et, uchar *addr, uint prot);
wdenk's avatar
wdenk committed
619
620

/* Set IP header */
621
622
void net_set_ip_header(uchar *pkt, struct in_addr dest, struct in_addr source,
		       u16 pkt_len, u8 proto);
623
void net_set_udp_header(uchar *pkt, struct in_addr dest, int dport,
624
				int sport, int len);
wdenk's avatar
wdenk committed
625

626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
/**
 * 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);

Joe Hershberger's avatar
Joe Hershberger committed
656
/* Callbacks */
657
658
659
660
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 */
661
bool arp_is_waiting(void);		/* Waiting for ARP reply? */
662
void net_set_icmp_handler(rxhand_icmp_f *f); /* Set ICMP RX handler */
663
void net_set_timeout_handler(ulong, thand_f *);/* Set timeout handler */
wdenk's avatar
wdenk committed
664

665
666
667
668
669
670
671
/* Network loop state */
enum net_loop_state {
	NETLOOP_CONTINUE,
	NETLOOP_RESTART,
	NETLOOP_SUCCESS,
	NETLOOP_FAIL
};
Kim Phillips's avatar
Kim Phillips committed
672
673
extern enum net_loop_state net_state;

674
675
static inline void net_set_state(enum net_loop_state state)
{
676
	debug_cond(DEBUG_INT_STATE, "--- NetState set to %d\n", state);
677
678
679
	net_state = state;
}

680
681
682
683
684
685
686
687
/*
 * net_get_async_tx_pkt_buf - Get a packet buffer that is not in use for
 *			      sending an asynchronous reply
 *
 * returns - ptr to packet buffer
 */
uchar * net_get_async_tx_pkt_buf(void);

688
/* Transmit a packet */
689
static inline void net_send_packet(uchar *pkt, int len)
690
{
Joe Hershberger's avatar
Joe Hershberger committed
691
	/* Currently no way to return errors from eth_send() */
692
693
	(void) eth_send(pkt, len);
}
wdenk's avatar
wdenk committed
694

695
/*
696
 * Transmit "net_tx_packet" as UDP packet, performing ARP request if needed
697
 *  (ether will be populated)
698
699
700
701
702
703
704
 *
 * @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
 */
705
706
707
int net_send_ip_packet(uchar *ether, struct in_addr dest, int dport, int sport,
		       int payload_len, int proto, u8 action, u32 tcp_seq_num,
		       u32 tcp_ack_num);
708
int net_send_udp_packet(uchar *ether, struct in_addr dest, int dport,
709
			int sport, int payload_len);
wdenk's avatar
wdenk committed
710

wdenk's avatar
wdenk committed
711
/* Processes a received packet */
712
void net_process_received_packet(uchar *in_packet, int len);
wdenk's avatar
wdenk committed
713

714
#if defined(CONFIG_NETCONSOLE) && !defined(CONFIG_SPL_BUILD)
715
void nc_start(void);
716
int nc_input_packet(uchar *pkt, struct in_addr src_ip, unsigned dest_port,
717
	unsigned src_port, unsigned len);
718
719
#endif

720
static __always_inline int eth_is_on_demand_init(void)
721
{
722
#if defined(CONFIG_NETCONSOLE) && !defined(CONFIG_SPL_BUILD)
723
724
725
726
727
728
729
730
731
732
	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)
{
733
#if defined(CONFIG_NETCONSOLE) && !defined(CONFIG_SPL_BUILD)
734
735
736
737
738
739
	extern enum proto_t net_loop_last_protocol;

	net_loop_last_protocol = protocol;
#endif
}

740
741
742
743
744
745
/*
 * Check if autoload is enabled. If so, use either NFS or TFTP to download
 * the boot file.
 */
void net_auto_load(void);

wdenk's avatar
wdenk committed
746
747
748
749
750
751
752
753
/*
 * 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* */
754
static inline struct in_addr net_read_ip(void *from)
wdenk's avatar
wdenk committed
755
{
756
	struct in_addr ip;
757
758

	memcpy((void *)&ip, (void *)from, sizeof(ip));
wdenk's avatar
wdenk committed
759
760
761
762
	return ip;
}

/* return ulong *in network byteorder* */
763
static inline u32 net_read_u32(void *from)
wdenk's avatar
wdenk committed
764
{
765
	u32 l;
766
767

	memcpy((void *)&l, (void *)from, sizeof(l));
wdenk's avatar
wdenk committed
768
769
770
771
	return l;
}

/* write IP *in network byteorder* */
772
static inline void net_write_ip(void *to, struct in_addr ip)
wdenk's avatar
wdenk committed
773
{
774
	memcpy(to, (void *)&ip, sizeof(ip));
wdenk's avatar
wdenk committed
775
776
777
}

/* copy IP */
778
static inline void net_copy_ip(void *to, void *from)
wdenk's avatar
wdenk committed
779
{
780
	memcpy((void *)to, from, sizeof(struct in_addr));
wdenk's avatar
wdenk committed
781
782
783
}

/* copy ulong */
784
static inline void net_copy_u32(void *to, void *from)
wdenk's avatar
wdenk committed
785
{
786
	memcpy((void *)to, (void *)from, sizeof(u32));
wdenk's avatar
wdenk committed
787
788
}

789
/**
790
 * is_zero_ethaddr - Determine if give Ethernet address is all zeros.
791
792
793
794
 * @addr: Pointer to a six-byte array containing the Ethernet address
 *
 * Return true if the address is all zeroes.
 */
795
static inline int is_zero_ethaddr(const u8 *addr)
796
797
798
799
800
{
	return !(addr[0] | addr[1] | addr[2] | addr[3] | addr[4] | addr[5]);
}

/**
801
 * is_multicast_ethaddr - Determine if the Ethernet address is a multicast.
802
803
804
805
806
 * @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.
 */
807
static inline int is_multicast_ethaddr(const u8 *addr)
808
{
809
	return 0x01 & addr[0];
810
811
}

812
/*
813
 * is_broadcast_ethaddr - Determine if the Ethernet address is broadcast
814
815
816
817
 * @addr: Pointer to a six-byte array containing the Ethernet address
 *
 * Return true if the address is the broadcast address.
 */
818
static inline int is_broadcast_ethaddr(const u8 *addr)
819
{
820
821
	return (addr[0] & addr[1] & addr[2] & addr[3] & addr[4] & addr[5]) ==
		0xff;
822
823
824
}

/*
825
 * is_valid_ethaddr - Determine if the given Ethernet address is valid
826
827
828
829
830
831
832
 * @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.
 */
833
static inline int is_valid_ethaddr(const u8 *addr)
834
835
836
{
	/* FF:FF:FF:FF:FF:FF is a multicast address so we don't need to
	 * explicitly check for it here. */
837
	return !is_multicast_ethaddr(addr) && !is_zero_ethaddr(addr);
838
839
}

840
/**
841
 * net_random_ethaddr - Generate software assigned random Ethernet address
842
843
844
845
846
 * @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.
 */
847
static inline void net_random_ethaddr(uchar *addr)
848
849
{
	int i;
850
	unsigned int seed = get_ticks();
851
852
853
854
855
856
857
858

	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) */
}

859
860
861
862
863
864
865
866
867
868
869
870
871
/**
 * string_to_enetaddr() - Parse a MAC address
 *
 * Convert a string MAC address
 *
 * Implemented in lib/net_utils.c (built unconditionally)
 *
 * @addr: MAC address in aa:bb:cc:dd:ee:ff format, where each part is a 2-digit
 *	hex value
 * @enetaddr: Place to put MAC address (6 bytes)
 */
void string_to_enetaddr(const char *addr, uint8_t *enetaddr);

wdenk's avatar
wdenk committed
872
/* Convert an IP address to a string */
873
void ip_to_string(struct in_addr x, char *s);
wdenk's avatar
wdenk committed
874

875
876
877
/**
 * string_to_ip() - Convert a string to ip address
 *
878
879
880
881
 * Implemented in lib/net_utils.c (built unconditionally)
 *
 * @s: Input string to parse
 * @return: in_addr struct containing the parsed IP address
882
 */
883
struct in_addr string_to_ip(const char *s);
wdenk's avatar
wdenk committed
884

885
/* Convert a VLAN id to a string */
886
void vlan_to_string(ushort x, char *s);
887
888

/* Convert a string to a vlan id */
889
ushort string_to_vlan(const char *s);
890
891

/* read a VLAN id from an environment variable */
892
ushort env_get_vlan(char *);
893

wdenk's avatar
wdenk committed
894
/* copy a filename (allow for "..." notation, limit length) */
895
void copy_filename(char *dst, const char *src, int size);
wdenk's avatar
wdenk committed
896

897
898
899
/* check if serverip is specified in filename from the command line */
int is_serverip_in_cmd(void);

900
901
902
903
904
905
906
907
908
909
910
/**
 * net_parse_bootfile - Parse the bootfile env var / cmd line param
 *
 * @param ipaddr - a pointer to the ipaddr to populate if included in bootfile
 * @param filename - a pointer to the string to save the filename part
 * @param max_len - The longest - 1 that the filename part can be
 *
 * return 1 if parsed, 0 if bootfile is empty
 */
int net_parse_bootfile(struct in_addr *ipaddr, char *filename, int max_len);

911
912
913
914
915
916
917
918
919
920
921
922
/**
 * update_tftp - Update firmware over TFTP (via DFU)
 *
 * This function updates board's firmware via TFTP
 *
 * @param addr - memory address where data is stored
 * @param interface - the DFU medium name - e.g. "mmc"
 * @param devstring - the DFU medium number - e.g. "1"
 *
 * @return - 0 on success, other value on failure
 */
int update_tftp(ulong addr, char *interface, char *devstring);
923

924
925
926
927
928
929
930
931
932
933
934
935
/**
 * env_get_ip() - Convert an environment value to to an ip address
 *
 * @var: Environment variable to convert. The value of this variable must be
 *	in the format format a.b.c.d, where each value is a decimal number from
 *	0 to 255
 * @return IP address, or 0 if invalid
 */
static inline struct in_addr env_get_ip(char *var)
{
	return string_to_ip(env_get(var));
}
936
937
938
939
940
941
942
943

/**
 * reset_phy() - Reset the Ethernet PHY
 *
 * This should be implemented by boards if CONFIG_RESET_PHY_R is enabled
 */
void reset_phy(void);

wdenk's avatar
wdenk committed
944
#endif /* __NET_H__ */