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

/*
 *	The number of receive packet buffers, and the required packet buffer
 *	alignment in memory.
 *
 */
38
#define PKTBUFSRX	CONFIG_SYS_RX_ETH_BUFFER
39
#define PKTALIGN	ARCH_DMA_MINALIGN
wdenk's avatar
wdenk committed
40

41
42
43
/* Number of packets processed together */
#define ETH_PACKETS_BATCH_RECV	32

44
45
/* ARP hardware address length */
#define ARP_HLEN 6
46
47
48
49
50
/*
 * 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)
51

52
/* IPv4 addresses are always 32 bits in size */
53
54
55
struct in_addr {
	__be32 s_addr;
};
wdenk's avatar
wdenk committed
56

Simon Glass's avatar
Simon Glass committed
57
58
59
60
61
62
63
/**
 * do_tftpb - Run the tftpboot command
 *
 * @cmdtp: Command information for tftpboot
 * @flag: Command flags (CMD_FLAG_...)
 * @argc: Number of arguments
 * @argv: List of arguments
64
 * Return: result (see enum command_ret_t)
Simon Glass's avatar
Simon Glass committed
65
 */
66
int do_tftpb(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]);
Simon Glass's avatar
Simon Glass committed
67

Simon Glass's avatar
Simon Glass committed
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
/**
 * dhcp_run() - Run DHCP on the current ethernet device
 *
 * This sets the autoload variable, then puts it back to similar to its original
 * state (y, n or unset).
 *
 * @addr: Address to load the file into (0 if @autoload is false)
 * @fname: Filename of file to load (NULL if @autoload is false or to use the
 * default filename)
 * @autoload: true to load the file, false to just get the network IP
 * @return 0 if OK, -EINVAL if the environment failed, -ENOENT if ant file was
 * not found
 */
int dhcp_run(ulong addr, const char *fname, bool autoload);

83
84
85
86
87
88
89
/**
 * 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
90
 */
91
typedef void rxhand_f(uchar *pkt, unsigned dport,
92
		      struct in_addr sip, unsigned sport,
93
		      unsigned len);
wdenk's avatar
wdenk committed
94

95
96
97
98
99
100
101
102
103
104
105
/**
 * 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,
106
		struct in_addr sip, unsigned sport, uchar *pkt, unsigned len);
107

wdenk's avatar
wdenk committed
108
109
110
111
112
113
114
115
116
117
118
/*
 *	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
};

119
120
121
122
123
/**
 * 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
124
 * @phy_interface: PHY interface to use - see PHY_INTERFACE_MODE_...
125
 * @max_speed: Maximum speed of Ethernet connection supported by MAC
126
 * @priv_pdata: device specific plat
127
128
129
 */
struct eth_pdata {
	phys_addr_t iobase;
130
	unsigned char enetaddr[ARP_HLEN];
131
	int phy_interface;
132
	int max_speed;
Faiz Abbas's avatar
Faiz Abbas committed
133
	void *priv_pdata;
134
135
};

136
137
138
139
140
141
142
143
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,
};

144
145
146
147
148
/**
 * 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
149
150
 * 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
151
152
153
154
155
156
 *	 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
157
158
159
160
161
 * 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
162
163
164
 *		 eth_pdata::enetaddr field to be populated. The method can
 *		 return -ENOSYS to indicate that this is not implemented for
		 this hardware - optional.
165
166
167
168
 * 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
169
 * set_promisc: Enable or Disable promiscuous mode
170
171
172
173
 */
struct eth_ops {
	int (*start)(struct udevice *dev);
	int (*send)(struct udevice *dev, void *packet, int length);
174
	int (*recv)(struct udevice *dev, int flags, uchar **packetp);
175
	int (*free_pkt)(struct udevice *dev, uchar *packet, int length);
176
177
178
179
	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);
180
	int (*set_promisc)(struct udevice *dev, bool enable);
181
182
183
184
185
};

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

struct udevice *eth_get_dev(void); /* get the current device */
186
187
188
189
190
/*
 * 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);
191
unsigned char *eth_get_ethaddr(void); /* get the current device MAC */
192

193
/* Used only when NetConsole is enabled */
194
int eth_is_active(struct udevice *dev); /* Test device for active state */
195
196
int eth_init_state_only(void); /* Set active state */
void eth_halt_state_only(void); /* Set passive state */
197

198
int eth_initialize(void);		/* Initialize network subsystem */
199
200
201
void eth_try_another(int first_restart);	/* Change the device */
void eth_set_current(void);		/* set nterface to ethcur var */

202
int eth_get_dev_index(void);		/* get the device index */
203

204
/**
205
 * eth_env_set_enetaddr_by_index() - set the MAC address environment variable
206
207
208
209
210
211
212
213
214
 *
 * 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
215
 * Return: 0 if OK, other value on error
216
 */
217
int eth_env_set_enetaddr_by_index(const char *base_name, int index,
218
219
220
				 uchar *enetaddr);


221
222
223
224
225
226
227
/*
 * Initialize USB ethernet device with CONFIG_DM_ETH
 * Returns:
 *	0 is success, non-zero is error status.
 */
int usb_ether_init(void);

228
229
230
231
232
233
234
235
236
/*
 * 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.
 */
237
int eth_env_get_enetaddr_by_index(const char *base_name, int index,
238
				 uchar *enetaddr);
239

240
int eth_init(void);			/* Initialize the device */
241
int eth_send(void *packet, int length);	   /* Send a packet */
242

243
#if defined(CONFIG_API) || defined(CONFIG_EFI_LOADER)
244
int eth_receive(void *packet, int length); /* Receive a packet*/
245
extern void (*push_packet)(void *packet, int length);
246
#endif
247
248
int eth_rx(void);			/* Check for received packets */
void eth_halt(void);			/* stop SCC */
249
const char *eth_get_name(void);		/* get name of current device */
250
int eth_mcast_join(struct in_addr mcast_addr, int join);
wdenk's avatar
wdenk committed
251
252
253
254
255
256
257
258
259

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

/*
 *	Ethernet header
 */
260
261

struct ethernet_hdr {
262
263
264
	u8		et_dest[ARP_HLEN];	/* Destination node	*/
	u8		et_src[ARP_HLEN];	/* Source node		*/
	u16		et_protlen;		/* Protocol or length	*/
265
} __attribute__((packed));
266
267
268
269

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

270
271
#define ETH_FCS_LEN	4		/* Octets in the FCS		*/

272
struct e802_hdr {
273
274
275
276
277
278
279
	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			*/
280
281
	u8		et_snap2;
	u8		et_snap3;
282
	u16		et_prot;		/* 802 protocol		*/
283
} __attribute__((packed));
wdenk's avatar
wdenk committed
284

285
/* 802 + SNAP + ethernet header size */
286
#define E802_HDR_SIZE	(sizeof(struct e802_hdr))
287
288

/*
289
 *	Virtual LAN Ethernet header
290
 */
291
struct vlan_ethernet_hdr {
292
293
294
295
296
	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	*/
297
} __attribute__((packed));
298

299
300
/* VLAN Ethernet header size */
#define VLAN_ETHER_HDR_SIZE	(sizeof(struct vlan_ethernet_hdr))
301

wdenk's avatar
wdenk committed
302
303
#define PROT_IP		0x0800		/* IP protocol			*/
#define PROT_ARP	0x0806		/* IP ARP protocol		*/
304
#define PROT_WOL	0x0842		/* ether-wake WoL protocol	*/
wdenk's avatar
wdenk committed
305
#define PROT_RARP	0x8035		/* IP ARP protocol		*/
306
#define PROT_VLAN	0x8100		/* IEEE 802.1q protocol		*/
307
308
#define PROT_IPV6	0x86dd		/* IPv6 over bluebook		*/
#define PROT_PPP_SES	0x8864		/* PPPoE session messages	*/
309
#define PROT_NCSI	0x88f8		/* NC-SI control packets        */
wdenk's avatar
wdenk committed
310
311

#define IPPROTO_ICMP	 1	/* Internet Control Message Protocol	*/
312
#define IPPROTO_TCP	6	/* Transmission Control Protocol	*/
wdenk's avatar
wdenk committed
313
314
315
#define IPPROTO_UDP	17	/* User Datagram Protocol		*/

/*
316
 *	Internet Protocol (IP) header.
wdenk's avatar
wdenk committed
317
 */
318
struct ip_hdr {
319
320
321
322
323
324
325
326
	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			*/
327
328
	struct in_addr	ip_src;		/* Source IP address		*/
	struct in_addr	ip_dst;		/* Destination IP address	*/
329
} __attribute__((packed));
wdenk's avatar
wdenk committed
330

Peter Tyser's avatar
Peter Tyser committed
331
332
333
334
335
336
#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 */

337
338
#define IP_HDR_SIZE		(sizeof(struct ip_hdr))

339
340
#define IP_MIN_FRAG_DATAGRAM_SIZE	(IP_HDR_SIZE + 8)

341
342
343
344
/*
 *	Internet Protocol (IP) + UDP header.
 */
struct ip_udp_hdr {
345
346
347
348
349
350
351
352
	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			*/
353
354
	struct in_addr	ip_src;		/* Source IP address		*/
	struct in_addr	ip_dst;		/* Destination IP address	*/
355
356
357
358
	u16		udp_src;	/* UDP source port		*/
	u16		udp_dst;	/* UDP destination port		*/
	u16		udp_len;	/* Length of UDP packet		*/
	u16		udp_xsum;	/* Checksum			*/
359
} __attribute__((packed));
wdenk's avatar
wdenk committed
360

361
#define IP_UDP_HDR_SIZE		(sizeof(struct ip_udp_hdr))
362
#define UDP_HDR_SIZE		(IP_UDP_HDR_SIZE - IP_HDR_SIZE)
wdenk's avatar
wdenk committed
363
364
365
366

/*
 *	Address Resolution Protocol (ARP) header.
 */
367
struct arp_hdr {
368
	u16		ar_hrd;		/* Format of hardware address	*/
wdenk's avatar
wdenk committed
369
#   define ARP_ETHER	    1		/* Ethernet  hardware address	*/
370
371
372
	u16		ar_pro;		/* Format of protocol address	*/
	u8		ar_hln;		/* Length of hardware address	*/
	u8		ar_pln;		/* Length of protocol address	*/
373
#   define ARP_PLEN	4
374
	u16		ar_op;		/* Operation			*/
wdenk's avatar
wdenk committed
375
376
377
378
379
380
381
#   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
382
383
384
	 * 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
385
	 */
386
	u8		ar_data[0];
387
388
389
390
#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
391
#if 0
392
393
394
395
	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
396
#endif /* 0 */
397
} __attribute__((packed));
wdenk's avatar
wdenk committed
398
399
400
401
402
403

#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
404
#define ICMP_ECHO_REPLY		0	/* Echo reply			*/
405
#define ICMP_NOT_REACH		3	/* Detination unreachable	*/
wdenk's avatar
wdenk committed
406
#define ICMP_REDIRECT		5	/* Redirect (change route)	*/
wdenk's avatar
wdenk committed
407
#define ICMP_ECHO_REQUEST	8	/* Echo request			*/
wdenk's avatar
wdenk committed
408
409
410
411
412

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

413
414
415
/* Codes for NOT_REACH */
#define ICMP_NOT_REACH_PORT	3	/* Port unreachable		*/

416
struct icmp_hdr {
417
418
419
	u8		type;
	u8		code;
	u16		checksum;
wdenk's avatar
wdenk committed
420
421
	union {
		struct {
422
423
			u16	id;
			u16	sequence;
wdenk's avatar
wdenk committed
424
		} echo;
425
		u32	gateway;
wdenk's avatar
wdenk committed
426
		struct {
427
428
			u16	unused;
			u16	mtu;
wdenk's avatar
wdenk committed
429
		} frag;
430
		u8 data[0];
wdenk's avatar
wdenk committed
431
	} un;
432
} __attribute__((packed));
wdenk's avatar
wdenk committed
433

434
435
#define ICMP_HDR_SIZE		(sizeof(struct icmp_hdr))
#define IP_ICMP_HDR_SIZE	(IP_HDR_SIZE + ICMP_HDR_SIZE)
wdenk's avatar
wdenk committed
436
437

/*
438
439
440
441
 * 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
442
443
 * maximum packet size and multiple of 32 bytes =  1536
 */
444
#define PKTSIZE			1522
445
#ifndef CONFIG_DM_DSA
wdenk's avatar
wdenk committed
446
#define PKTSIZE_ALIGN		1536
447
448
449
450
451
#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
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467

/*
 * 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:
 *
468
 * All variables of type struct in_addr are stored in NETWORK byte order
wdenk's avatar
wdenk committed
469
470
471
472
473
 * (big endian).
 */

/* net.c */
/** BOOTP EXTENTIONS **/
474
475
476
477
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;
478
#if defined(CONFIG_BOOTP_DNS2)
479
480
/* Our 2nd Domain Name Server (0 = unknown) */
extern struct in_addr net_dns_server2;
481
#endif
482
483
extern char	net_nis_domain[32];	/* Our IS domain */
extern char	net_hostname[32];	/* Our hostname */
484
485
486
#ifdef CONFIG_NET
extern char	net_root_path[CONFIG_BOOTP_MAX_ROOT_PATH_LEN];	/* Our root path */
#endif
wdenk's avatar
wdenk committed
487
/** END OF BOOTP EXTENTIONS **/
488
489
extern u8		net_ethaddr[ARP_HLEN];		/* Our ethernet address */
extern u8		net_server_ethaddr[ARP_HLEN];	/* Boot server enet address */
490
491
extern struct in_addr	net_ip;		/* Our    IP addr (0 = unknown) */
extern struct in_addr	net_server_ip;	/* Server IP addr (0 = unknown) */
492
extern uchar		*net_tx_packet;		/* THE transmit packet */
493
extern uchar		*net_rx_packets[PKTBUFSRX]; /* Receive packets */
494
495
extern uchar		*net_rx_packet;		/* Current receive packet */
extern int		net_rx_packet_len;	/* Current rx packet length */
496
497
extern const u8		net_bcast_ethaddr[ARP_HLEN];	/* Ethernet broadcast address */
extern const u8		net_null_ethaddr[ARP_HLEN];
wdenk's avatar
wdenk committed
498

499
500
#define VLAN_NONE	4095			/* untagged */
#define VLAN_IDMASK	0x0fff			/* mask of valid vlan id */
501
502
extern ushort		net_our_vlan;		/* Our VLAN */
extern ushort		net_native_vlan;	/* Our Native VLAN */
503

504
extern int		net_restart_wrap;	/* Tried all network devices */
wdenk's avatar
wdenk committed
505

506
enum proto_t {
507
508
	BOOTP, RARP, ARP, TFTPGET, DHCP, PING, PING6, DNS, NFS, CDP, NETCONS,
	SNTP, TFTPSRV, TFTPPUT, LINKLOCAL, FASTBOOT, WOL, UDP, NCSI, WGET
509
};
wdenk's avatar
wdenk committed
510

511
extern char	net_boot_file_name[1024];/* Boot File name */
512
513
/* Indicates whether the file name was specified on the command line */
extern bool	net_boot_file_name_explicit;
514
515
516
517
/* 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
518

Robin Getz's avatar
Robin Getz committed
519
#if defined(CONFIG_CMD_DNS)
520
521
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
522
523
#endif

524
#if defined(CONFIG_CMD_PING)
525
extern struct in_addr net_ping_ip;	/* the ip address to ping */
wdenk's avatar
wdenk committed
526
527
#endif

528
#if defined(CONFIG_CMD_CDP)
529
/* when CDP completes these hold the return values */
530
531
extern ushort cdp_native_vlan;		/* CDP returned native VLAN */
extern ushort cdp_appliance_vlan;	/* CDP returned appliance VLAN */
532
533
534
535

/*
 * Check for a CDP packet by examining the received MAC address field
 */
536
static inline int is_cdp_packet(const uchar *ethaddr)
537
{
538
	extern const u8 net_cdp_ethaddr[ARP_HLEN];
539

540
	return memcmp(ethaddr, net_cdp_ethaddr, ARP_HLEN) == 0;
541
}
542
543
#endif

544
#if defined(CONFIG_CMD_SNTP)
545
extern struct in_addr	net_ntp_server;		/* the ip address to NTP */
546
extern int net_ntp_time_offset;			/* offset time from UTC */
wdenk's avatar
wdenk committed
547
548
#endif

wdenk's avatar
wdenk committed
549
/* Initialize the network adapter */
550
int net_init(void);
551
int net_loop(enum proto_t);
wdenk's avatar
wdenk committed
552
553

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

556
/* Get size of the ethernet header when we send */
557
int net_eth_hdr_size(void);
558
559

/* Set ethernet header; returns the size of the header */
560
int net_set_ether(uchar *xet, const uchar *dest_ethaddr, uint prot);
561
int net_update_ether(struct ethernet_hdr *et, uchar *addr, uint prot);
wdenk's avatar
wdenk committed
562
563

/* Set IP header */
564
565
void net_set_ip_header(uchar *pkt, struct in_addr dest, struct in_addr source,
		       u16 pkt_len, u8 proto);
566
void net_set_udp_header(uchar *pkt, struct in_addr dest, int dport,
567
				int sport, int len);
wdenk's avatar
wdenk committed
568

569
570
571
572
573
/**
 * 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)
574
 * Return: 16-bit IP checksum
575
576
577
578
579
580
581
582
583
 */
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
584
 * Return: updated 16-bit IP checksum
585
586
587
588
589
590
591
592
593
594
 */
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)
595
 * Return: true if the checksum matches, false if not
596
597
598
 */
int ip_checksum_ok(const void *addr, unsigned nbytes);

Joe Hershberger's avatar
Joe Hershberger committed
599
/* Callbacks */
600
601
602
603
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 */
604
bool arp_is_waiting(void);		/* Waiting for ARP reply? */
605
void net_set_icmp_handler(rxhand_icmp_f *f); /* Set ICMP RX handler */
606
void net_set_timeout_handler(ulong, thand_f *);/* Set timeout handler */
wdenk's avatar
wdenk committed
607

608
609
610
611
612
613
614
/* Network loop state */
enum net_loop_state {
	NETLOOP_CONTINUE,
	NETLOOP_RESTART,
	NETLOOP_SUCCESS,
	NETLOOP_FAIL
};
Kim Phillips's avatar
Kim Phillips committed
615
616
extern enum net_loop_state net_state;

617
618
static inline void net_set_state(enum net_loop_state state)
{
619
	debug_cond(DEBUG_INT_STATE, "--- NetState set to %d\n", state);
620
621
622
	net_state = state;
}

623
624
625
626
627
628
629
630
/*
 * 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);

631
/* Transmit a packet */
632
static inline void net_send_packet(uchar *pkt, int len)
633
{
Joe Hershberger's avatar
Joe Hershberger committed
634
	/* Currently no way to return errors from eth_send() */
635
636
	(void) eth_send(pkt, len);
}
wdenk's avatar
wdenk committed
637

638
639
640
641
642
643
644
645
646
647
648
/**
 * net_send_ip_packet() - Transmit "net_tx_packet" as UDP or TCP packet,
 *                        send ARP request if needed (ether will be populated)
 * @ether: Raw packet buffer
 * @dest: IP address to send the datagram to
 * @dport: Destination UDP port
 * @sport: Source UDP port
 * @payload_len: Length of data after the UDP header
 * @action: TCP action to be performed
 * @tcp_seq_num: TCP sequence number of this transmission
 * @tcp_ack_num: TCP stream acknolegement number
649
 *
650
 * Return: 0 on success, other value on failure
651
 */
652
653
654
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);
655
656
657
658
659
660
661
662
663
664
665
666
667
/**
 * net_send_tcp_packet() - Transmit TCP packet.
 * @payload_len: length of payload
 * @dport: Destination TCP port
 * @sport: Source TCP port
 * @action: TCP action to be performed
 * @tcp_seq_num: TCP sequence number of this transmission
 * @tcp_ack_num: TCP stream acknolegement number
 *
 * Return: 0 on success, other value on failure
 */
int net_send_tcp_packet(int payload_len, int dport, int sport, u8 action,
			u32 tcp_seq_num, u32 tcp_ack_num);
668
int net_send_udp_packet(uchar *ether, struct in_addr dest, int dport,
669
			int sport, int payload_len);
wdenk's avatar
wdenk committed
670

wdenk's avatar
wdenk committed
671
/* Processes a received packet */
672
void net_process_received_packet(uchar *in_packet, int len);
wdenk's avatar
wdenk committed
673

674
#if defined(CONFIG_NETCONSOLE) && !defined(CONFIG_SPL_BUILD)
675
void nc_start(void);
676
int nc_input_packet(uchar *pkt, struct in_addr src_ip, unsigned dest_port,
677
	unsigned src_port, unsigned len);
678
679
#endif

680
static __always_inline int eth_is_on_demand_init(void)
681
{
682
#if defined(CONFIG_NETCONSOLE) && !defined(CONFIG_SPL_BUILD)
683
684
685
686
687
688
689
690
691
692
	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)
{
693
#if defined(CONFIG_NETCONSOLE) && !defined(CONFIG_SPL_BUILD)
694
695
696
697
698
699
	extern enum proto_t net_loop_last_protocol;

	net_loop_last_protocol = protocol;
#endif
}

700
701
702
703
704
705
/*
 * 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
706
707
708
709
710
711
712
713
/*
 * 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* */
714
static inline struct in_addr net_read_ip(void *from)
wdenk's avatar
wdenk committed
715
{
716
	struct in_addr ip;
717
718

	memcpy((void *)&ip, (void *)from, sizeof(ip));
wdenk's avatar
wdenk committed
719
720
721
722
	return ip;
}

/* return ulong *in network byteorder* */
723
static inline u32 net_read_u32(void *from)
wdenk's avatar
wdenk committed
724
{
725
	u32 l;
726
727

	memcpy((void *)&l, (void *)from, sizeof(l));
wdenk's avatar
wdenk committed
728
729
730
731
	return l;
}

/* write IP *in network byteorder* */
732
static inline void net_write_ip(void *to, struct in_addr ip)
wdenk's avatar
wdenk committed
733
{
734
	memcpy(to, (void *)&ip, sizeof(ip));
wdenk's avatar
wdenk committed
735
736
737
}

/* copy IP */
738
static inline void net_copy_ip(void *to, void *from)
wdenk's avatar
wdenk committed
739
{
740
	memcpy((void *)to, from, sizeof(struct in_addr));
wdenk's avatar
wdenk committed
741
742
743
}

/* copy ulong */
744
static inline void net_copy_u32(void *to, void *from)
wdenk's avatar
wdenk committed
745
{
746
	memcpy((void *)to, (void *)from, sizeof(u32));
wdenk's avatar
wdenk committed
747
748
}

749
/**
750
 * is_zero_ethaddr - Determine if give Ethernet address is all zeros.
751
752
753
754
 * @addr: Pointer to a six-byte array containing the Ethernet address
 *
 * Return true if the address is all zeroes.
 */
755
static inline int is_zero_ethaddr(const u8 *addr)
756
757
758
759
760
{
	return !(addr[0] | addr[1] | addr[2] | addr[3] | addr[4] | addr[5]);
}

/**
761
 * is_multicast_ethaddr - Determine if the Ethernet address is a multicast.
762
763
764
765
766
 * @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.
 */
767
static inline int is_multicast_ethaddr(const u8 *addr)
768
{
769
	return 0x01 & addr[0];
770
771
}

772
/*
773
 * is_broadcast_ethaddr - Determine if the Ethernet address is broadcast
774
775
776
777
 * @addr: Pointer to a six-byte array containing the Ethernet address
 *
 * Return true if the address is the broadcast address.
 */
778
static inline int is_broadcast_ethaddr(const u8 *addr)
779
{
780
781
	return (addr[0] & addr[1] & addr[2] & addr[3] & addr[4] & addr[5]) ==
		0xff;
782
783
784
}

/*
785
 * is_valid_ethaddr - Determine if the given Ethernet address is valid
786
787
788
789
790
791
792
 * @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.
 */
793
static inline int is_valid_ethaddr(const u8 *addr)
794
795
796
{
	/* FF:FF:FF:FF:FF:FF is a multicast address so we don't need to
	 * explicitly check for it here. */
797
	return !is_multicast_ethaddr(addr) && !is_zero_ethaddr(addr);
798
799
}

800
/**
801
 * net_random_ethaddr - Generate software assigned random Ethernet address
802
803
804
805
806
 * @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.
 */
807
static inline void net_random_ethaddr(uchar *addr)
808
809
{
	int i;
810
	unsigned int seed = get_ticks();
811
812
813
814
815
816
817
818

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

819
820
821
822
823
824
825
826
827
828
829
830
831
/**
 * 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
832
/* Convert an IP address to a string */
833
void ip_to_string(struct in_addr x, char *s);
wdenk's avatar
wdenk committed
834

835
836
837
/**
 * string_to_ip() - Convert a string to ip address
 *
838
839
840
841
 * Implemented in lib/net_utils.c (built unconditionally)
 *
 * @s: Input string to parse
 * @return: in_addr struct containing the parsed IP address
842
 */
843
struct in_addr string_to_ip(const char *s);
wdenk's avatar
wdenk committed
844

845
/* Convert a VLAN id to a string */
846
void vlan_to_string(ushort x, char *s);
847
848

/* Convert a string to a vlan id */
849
ushort string_to_vlan(const char *s);
850
851

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

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

857
858
859
/* check if serverip is specified in filename from the command line */
int is_serverip_in_cmd(void);

860
861
862
863
864
865
866
867
868
869
870
/**
 * 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);

871
872
873
874
875
876
877
878
879
/**
 * 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"
 *
880
 * Return: - 0 on success, other value on failure
881
882
 */
int update_tftp(ulong addr, char *interface, char *devstring);
883

884
885
886
887
888
889
/**
 * 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
890
 * Return: IP address, or 0 if invalid
891
892
893
894
895
 */
static inline struct in_addr env_get_ip(char *var)
{
	return string_to_ip(env_get(var));
}
896
897
898
899
900
901
902
903

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

904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
#if CONFIG_IS_ENABLED(NET)
/**
 * eth_set_enable_bootdevs() - Enable or disable binding of Ethernet bootdevs
 *
 * These get in the way of bootstd testing, so are normally disabled by tests.
 * This provide control of this setting. It only affects binding of Ethernet
 * devices, so if that has already happened, this flag does nothing.
 *
 * @enable: true to enable binding of bootdevs when binding new Ethernet
 * devices, false to disable it
 */
void eth_set_enable_bootdevs(bool enable);
#else
static inline void eth_set_enable_bootdevs(bool enable) {}
#endif

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