]> git.ipfire.org Git - people/ms/u-boot.git/blame - include/net.h
tegra: config: Allow Chrome OS environment settings to be included
[people/ms/u-boot.git] / include / net.h
CommitLineData
2d966958
WD
1/*
2 * LiMon Monitor (LiMon) - Network.
3 *
4 * Copyright 1994 - 2000 Neil Russell.
5 * (See License)
2ea91039 6 * SPDX-License-Identifier: GPL-2.0
2d966958
WD
7 *
8 * History
9 * 9/16/00 bor adapted to TQM823L/STK8xxL board, RARP/TFTP boot added
10 */
11
12#ifndef __NET_H__
13#define __NET_H__
14
71f95118 15#if defined(CONFIG_8xx)
2d966958 16#include <commproc.h>
71f95118 17#endif /* CONFIG_8xx */
aacf9a49 18
2c4b3c19 19#include <asm/cache.h>
2d966958
WD
20#include <asm/byteorder.h> /* for nton* / ntoh* stuff */
21
4ef8d53c
JH
22#define DEBUG_LL_STATE 0 /* Link local state machine changes */
23#define DEBUG_DEV_PKT 0 /* Packets or info directed to the device */
24#define DEBUG_NET_PKT 0 /* Packets on info on the network at large */
25#define DEBUG_INT_STATE 0 /* Internal network state changes */
2d966958
WD
26
27/*
28 * The number of receive packet buffers, and the required packet buffer
29 * alignment in memory.
30 *
31 */
32
6d0f6bcf
JCPV
33#ifdef CONFIG_SYS_RX_ETH_BUFFER
34# define PKTBUFSRX CONFIG_SYS_RX_ETH_BUFFER
1d0350ed 35#else
c6028835 36# define PKTBUFSRX 4
1d0350ed
WD
37#endif
38
2c4b3c19 39#define PKTALIGN ARCH_DMA_MINALIGN
2d966958 40
ea45cb0a 41/* IPv4 addresses are always 32 bits in size */
049a95a7
JH
42struct in_addr {
43 __be32 s_addr;
44};
2d966958 45
03eb129f
LC
46/**
47 * An incoming packet handler.
48 * @param pkt pointer to the application packet
49 * @param dport destination UDP port
50 * @param sip source IP address
51 * @param sport source UDP port
52 * @param len packet length
2d966958 53 */
03eb129f 54typedef void rxhand_f(uchar *pkt, unsigned dport,
049a95a7 55 struct in_addr sip, unsigned sport,
03eb129f 56 unsigned len);
2d966958 57
4793ee65
SG
58/**
59 * An incoming ICMP packet handler.
60 * @param type ICMP type
61 * @param code ICMP code
62 * @param dport destination UDP port
63 * @param sip source IP address
64 * @param sport source UDP port
65 * @param pkt pointer to the ICMP packet data
66 * @param len packet length
67 */
68typedef void rxhand_icmp_f(unsigned type, unsigned code, unsigned dport,
049a95a7 69 struct in_addr sip, unsigned sport, uchar *pkt, unsigned len);
4793ee65 70
2d966958
WD
71/*
72 * A timeout handler. Called after time interval has expired.
73 */
74typedef void thand_f(void);
75
2d966958
WD
76enum eth_state_t {
77 ETH_STATE_INIT,
78 ETH_STATE_PASSIVE,
79 ETH_STATE_ACTIVE
80};
81
05c3e68f
JH
82#ifdef CONFIG_DM_ETH
83/**
84 * struct eth_pdata - Platform data for Ethernet MAC controllers
85 *
86 * @iobase: The base address of the hardware registers
87 * @enetaddr: The Ethernet MAC address that is loaded from EEPROM or env
c74c8e66 88 * @phy_interface: PHY interface to use - see PHY_INTERFACE_MODE_...
05c3e68f
JH
89 */
90struct eth_pdata {
91 phys_addr_t iobase;
92 unsigned char enetaddr[6];
c74c8e66 93 int phy_interface;
05c3e68f
JH
94};
95
96/**
97 * struct eth_ops - functions of Ethernet MAC controllers
98 *
99 * start: Prepare the hardware to send and receive packets
100 * send: Send the bytes passed in "packet" as a packet on the wire
17591405
JH
101 * recv: Check if the hardware received a packet. If so, set the pointer to the
102 * packet buffer in the packetp parameter. If not, return an error or 0 to
63c9729a
JH
103 * indicate that the hardware receive FIFO is empty. If 0 is returned, the
104 * network stack will not process the empty packet, but free_pkt() will be
105 * called if supplied
106 * free_pkt: Give the driver an opportunity to manage its packet buffer memory
107 * when the network stack is finished processing it. This will only be
108 * called when no error was returned from recv - optional
05c3e68f
JH
109 * stop: Stop the hardware from looking for packets - may be called even if
110 * state == PASSIVE
111 * mcast: Join or leave a multicast group (for TFTP) - optional
112 * write_hwaddr: Write a MAC address to the hardware (used to pass it to Linux
113 * on some platforms like ARM). This function expects the
114 * eth_pdata::enetaddr field to be populated - optional
115 * read_rom_hwaddr: Some devices have a backup of the MAC address stored in a
116 * ROM on the board. This is how the driver should expose it
117 * to the network stack. This function should fill in the
118 * eth_pdata::enetaddr field - optional
119 */
120struct eth_ops {
121 int (*start)(struct udevice *dev);
122 int (*send)(struct udevice *dev, void *packet, int length);
17591405 123 int (*recv)(struct udevice *dev, uchar **packetp);
63c9729a 124 int (*free_pkt)(struct udevice *dev, uchar *packet, int length);
05c3e68f
JH
125 void (*stop)(struct udevice *dev);
126#ifdef CONFIG_MCAST_TFTP
127 int (*mcast)(struct udevice *dev, const u8 *enetaddr, int join);
128#endif
129 int (*write_hwaddr)(struct udevice *dev);
130 int (*read_rom_hwaddr)(struct udevice *dev);
131};
132
133#define eth_get_ops(dev) ((struct eth_ops *)(dev)->driver->ops)
134
135struct udevice *eth_get_dev(void); /* get the current device */
e58780dc
JH
136/*
137 * The devname can be either an exact name given by the driver or device tree
138 * or it can be an alias of the form "eth%d"
139 */
140struct udevice *eth_get_dev_by_name(const char *devname);
05c3e68f
JH
141unsigned char *eth_get_ethaddr(void); /* get the current device MAC */
142/* Used only when NetConsole is enabled */
143int eth_init_state_only(void); /* Set active state */
144void eth_halt_state_only(void); /* Set passive state */
145#endif
146
147#ifndef CONFIG_DM_ETH
2d966958 148struct eth_device {
f6add132 149 char name[16];
2d966958 150 unsigned char enetaddr[6];
16ae7827 151 phys_addr_t iobase;
2d966958
WD
152 int state;
153
a34f2075
JH
154 int (*init)(struct eth_device *, bd_t *);
155 int (*send)(struct eth_device *, void *packet, int length);
156 int (*recv)(struct eth_device *);
157 void (*halt)(struct eth_device *);
53a5c424 158#ifdef CONFIG_MCAST_TFTP
a34f2075 159 int (*mcast)(struct eth_device *, const u8 *enetaddr, u8 set);
53a5c424 160#endif
a34f2075 161 int (*write_hwaddr)(struct eth_device *);
2d966958 162 struct eth_device *next;
fea7dcae 163 int index;
2d966958
WD
164 void *priv;
165};
166
ff997432
JH
167int eth_register(struct eth_device *dev);/* Register network device */
168int eth_unregister(struct eth_device *dev);/* Remove network device */
06370590 169
06370590
KP
170extern struct eth_device *eth_current;
171
f8be7d65
JH
172static inline __attribute__((always_inline))
173struct eth_device *eth_get_dev(void)
174{
f8be7d65
JH
175 return eth_current;
176}
84eb1fba
JH
177struct eth_device *eth_get_dev_by_name(const char *devname);
178struct eth_device *eth_get_dev_by_index(int index); /* get dev @ index */
8b2c9a71 179
84eb1fba 180/* get the current device MAC */
8b2c9a71
JH
181static inline unsigned char *eth_get_ethaddr(void)
182{
183 if (eth_current)
184 return eth_current->enetaddr;
185 return NULL;
186}
187
84eb1fba 188/* Set active state */
d2eaec60 189static inline __attribute__((always_inline)) int eth_init_state_only(void)
84eb1fba
JH
190{
191 eth_get_dev()->state = ETH_STATE_ACTIVE;
192
193 return 0;
194}
195/* Set passive state */
196static inline __attribute__((always_inline)) void eth_halt_state_only(void)
197{
198 eth_get_dev()->state = ETH_STATE_PASSIVE;
199}
200
201/*
202 * Set the hardware address for an ethernet interface based on 'eth%daddr'
203 * environment variable (or just 'ethaddr' if eth_number is 0).
204 * Args:
205 * base_name - base name for device (normally "eth")
206 * eth_number - value of %d (0 for first device of this type)
207 * Returns:
208 * 0 is success, non-zero is error status from driver.
209 */
210int eth_write_hwaddr(struct eth_device *dev, const char *base_name,
211 int eth_number);
212
213int usb_eth_initialize(bd_t *bi);
05c3e68f 214#endif
84eb1fba 215
d2eaec60 216int eth_initialize(void); /* Initialize network subsystem */
84eb1fba
JH
217void eth_try_another(int first_restart); /* Change the device */
218void eth_set_current(void); /* set nterface to ethcur var */
219
ff997432
JH
220int eth_get_dev_index(void); /* get the device index */
221void eth_parse_enetaddr(const char *addr, uchar *enetaddr);
222int eth_getenv_enetaddr(char *name, uchar *enetaddr);
223int eth_setenv_enetaddr(char *name, const uchar *enetaddr);
7616e785
SG
224
225/*
226 * Get the hardware address for an ethernet interface .
227 * Args:
228 * base_name - base name for device (normally "eth")
229 * index - device index number (0 for first)
230 * enetaddr - returns 6 byte hardware address
231 * Returns:
232 * Return true if the address is valid.
233 */
ff997432
JH
234int eth_getenv_enetaddr_by_index(const char *base_name, int index,
235 uchar *enetaddr);
5dc0cf68 236
d2eaec60 237int eth_init(void); /* Initialize the device */
ff997432 238int eth_send(void *packet, int length); /* Send a packet */
23cd1385 239
f85b6071 240#ifdef CONFIG_API
ff997432 241int eth_receive(void *packet, int length); /* Receive a packet*/
db288a96 242extern void (*push_packet)(void *packet, int length);
f85b6071 243#endif
ff997432
JH
244int eth_rx(void); /* Check for received packets */
245void eth_halt(void); /* stop SCC */
84eb1fba 246const char *eth_get_name(void); /* get name of current device */
7616e785 247
53a5c424 248#ifdef CONFIG_MCAST_TFTP
049a95a7 249int eth_mcast_join(struct in_addr mcast_addr, int join);
b28e28bb 250u32 ether_crc(size_t len, unsigned char const *p);
53a5c424
DU
251#endif
252
2d966958
WD
253
254/**********************************************************************/
255/*
256 * Protocol headers.
257 */
258
259/*
260 * Ethernet header
261 */
cb487f56
JH
262
263struct ethernet_hdr {
717234e0
ST
264 u8 et_dest[6]; /* Destination node */
265 u8 et_src[6]; /* Source node */
266 u16 et_protlen; /* Protocol or length */
cb487f56
JH
267};
268
269/* Ethernet header size */
270#define ETHER_HDR_SIZE (sizeof(struct ethernet_hdr))
271
a7c3d5e2
BM
272#define ETH_FCS_LEN 4 /* Octets in the FCS */
273
cb487f56 274struct e802_hdr {
717234e0
ST
275 u8 et_dest[6]; /* Destination node */
276 u8 et_src[6]; /* Source node */
277 u16 et_protlen; /* Protocol or length */
278 u8 et_dsap; /* 802 DSAP */
279 u8 et_ssap; /* 802 SSAP */
280 u8 et_ctl; /* 802 control */
281 u8 et_snap1; /* SNAP */
282 u8 et_snap2;
283 u8 et_snap3;
284 u16 et_prot; /* 802 protocol */
cb487f56 285};
2d966958 286
da5ebe2c 287/* 802 + SNAP + ethernet header size */
cb487f56 288#define E802_HDR_SIZE (sizeof(struct e802_hdr))
a3d991bd
WD
289
290/*
da5ebe2c 291 * Virtual LAN Ethernet header
a3d991bd 292 */
c68cca35 293struct vlan_ethernet_hdr {
717234e0
ST
294 u8 vet_dest[6]; /* Destination node */
295 u8 vet_src[6]; /* Source node */
296 u16 vet_vlan_type; /* PROT_VLAN */
297 u16 vet_tag; /* TAG of VLAN */
298 u16 vet_type; /* protocol type */
c68cca35 299};
a3d991bd 300
c68cca35
JH
301/* VLAN Ethernet header size */
302#define VLAN_ETHER_HDR_SIZE (sizeof(struct vlan_ethernet_hdr))
a3d991bd 303
2d966958
WD
304#define PROT_IP 0x0800 /* IP protocol */
305#define PROT_ARP 0x0806 /* IP ARP protocol */
306#define PROT_RARP 0x8035 /* IP ARP protocol */
a3d991bd 307#define PROT_VLAN 0x8100 /* IEEE 802.1q protocol */
2d966958
WD
308
309#define IPPROTO_ICMP 1 /* Internet Control Message Protocol */
310#define IPPROTO_UDP 17 /* User Datagram Protocol */
311
312/*
c5c59df0 313 * Internet Protocol (IP) header.
2d966958 314 */
c5c59df0 315struct ip_hdr {
717234e0
ST
316 u8 ip_hl_v; /* header length and version */
317 u8 ip_tos; /* type of service */
318 u16 ip_len; /* total length */
319 u16 ip_id; /* identification */
320 u16 ip_off; /* fragment offset field */
321 u8 ip_ttl; /* time to live */
322 u8 ip_p; /* protocol */
323 u16 ip_sum; /* checksum */
049a95a7
JH
324 struct in_addr ip_src; /* Source IP address */
325 struct in_addr ip_dst; /* Destination IP address */
594c26f8 326};
2d966958 327
e0c07b86
PT
328#define IP_OFFS 0x1fff /* ip offset *= 8 */
329#define IP_FLAGS 0xe000 /* first 3 bits */
330#define IP_FLAGS_RES 0x8000 /* reserved */
331#define IP_FLAGS_DFRAG 0x4000 /* don't fragments */
332#define IP_FLAGS_MFRAG 0x2000 /* more fragments */
333
c5c59df0
JH
334#define IP_HDR_SIZE (sizeof(struct ip_hdr))
335
336/*
337 * Internet Protocol (IP) + UDP header.
338 */
339struct ip_udp_hdr {
717234e0
ST
340 u8 ip_hl_v; /* header length and version */
341 u8 ip_tos; /* type of service */
342 u16 ip_len; /* total length */
343 u16 ip_id; /* identification */
344 u16 ip_off; /* fragment offset field */
345 u8 ip_ttl; /* time to live */
346 u8 ip_p; /* protocol */
347 u16 ip_sum; /* checksum */
049a95a7
JH
348 struct in_addr ip_src; /* Source IP address */
349 struct in_addr ip_dst; /* Destination IP address */
717234e0
ST
350 u16 udp_src; /* UDP source port */
351 u16 udp_dst; /* UDP destination port */
352 u16 udp_len; /* Length of UDP packet */
353 u16 udp_xsum; /* Checksum */
c5c59df0 354};
2d966958 355
594c26f8 356#define IP_UDP_HDR_SIZE (sizeof(struct ip_udp_hdr))
c5c59df0 357#define UDP_HDR_SIZE (IP_UDP_HDR_SIZE - IP_HDR_SIZE)
2d966958
WD
358
359/*
360 * Address Resolution Protocol (ARP) header.
361 */
738853bb 362struct arp_hdr {
717234e0 363 u16 ar_hrd; /* Format of hardware address */
2d966958 364# define ARP_ETHER 1 /* Ethernet hardware address */
717234e0
ST
365 u16 ar_pro; /* Format of protocol address */
366 u8 ar_hln; /* Length of hardware address */
674bb249 367# define ARP_HLEN 6
717234e0 368 u8 ar_pln; /* Length of protocol address */
674bb249 369# define ARP_PLEN 4
717234e0 370 u16 ar_op; /* Operation */
2d966958
WD
371# define ARPOP_REQUEST 1 /* Request to resolve address */
372# define ARPOP_REPLY 2 /* Response to previous request */
373
374# define RARPOP_REQUEST 3 /* Request to resolve address */
375# define RARPOP_REPLY 4 /* Response to previous request */
376
377 /*
8bde7f77
WD
378 * The remaining fields are variable in size, according to
379 * the sizes above, and are defined as appropriate for
380 * specific hardware/protocol combinations.
2d966958 381 */
717234e0 382 u8 ar_data[0];
674bb249
JH
383#define ar_sha ar_data[0]
384#define ar_spa ar_data[ARP_HLEN]
385#define ar_tha ar_data[ARP_HLEN + ARP_PLEN]
386#define ar_tpa ar_data[ARP_HLEN + ARP_PLEN + ARP_HLEN]
2d966958 387#if 0
717234e0
ST
388 u8 ar_sha[]; /* Sender hardware address */
389 u8 ar_spa[]; /* Sender protocol address */
390 u8 ar_tha[]; /* Target hardware address */
391 u8 ar_tpa[]; /* Target protocol address */
2d966958 392#endif /* 0 */
738853bb 393};
2d966958
WD
394
395#define ARP_HDR_SIZE (8+20) /* Size assuming ethernet */
396
397/*
398 * ICMP stuff (just enough to handle (host) redirect messages)
399 */
53677ef1 400#define ICMP_ECHO_REPLY 0 /* Echo reply */
4793ee65 401#define ICMP_NOT_REACH 3 /* Detination unreachable */
2d966958 402#define ICMP_REDIRECT 5 /* Redirect (change route) */
73a8b27c 403#define ICMP_ECHO_REQUEST 8 /* Echo request */
2d966958
WD
404
405/* Codes for REDIRECT. */
406#define ICMP_REDIR_NET 0 /* Redirect Net */
407#define ICMP_REDIR_HOST 1 /* Redirect Host */
408
4793ee65
SG
409/* Codes for NOT_REACH */
410#define ICMP_NOT_REACH_PORT 3 /* Port unreachable */
411
e0a63079 412struct icmp_hdr {
717234e0
ST
413 u8 type;
414 u8 code;
415 u16 checksum;
2d966958
WD
416 union {
417 struct {
717234e0
ST
418 u16 id;
419 u16 sequence;
2d966958 420 } echo;
5917e7d1 421 u32 gateway;
2d966958 422 struct {
717234e0
ST
423 u16 unused;
424 u16 mtu;
2d966958 425 } frag;
717234e0 426 u8 data[0];
2d966958 427 } un;
e0a63079 428};
2d966958 429
e0a63079
JH
430#define ICMP_HDR_SIZE (sizeof(struct icmp_hdr))
431#define IP_ICMP_HDR_SIZE (IP_HDR_SIZE + ICMP_HDR_SIZE)
2d966958 432
2d966958
WD
433/*
434 * Maximum packet size; used to allocate packet storage.
435 * TFTP packets can be 524 bytes + IP header + ethernet header.
436 * Lets be conservative, and go for 38 * 16. (Must also be
437 * a multiple of 32 bytes).
438 */
439/*
440 * AS.HARNOIS : Better to set PKTSIZE to maximum size because
441 * traffic type is not always controlled
442 * maximum packet size = 1518
443 * maximum packet size and multiple of 32 bytes = 1536
444 */
445#define PKTSIZE 1518
446#define PKTSIZE_ALIGN 1536
447/*#define PKTSIZE 608*/
448
449/*
450 * Maximum receive ring size; that is, the number of packets
451 * we can buffer before overflow happens. Basically, this just
452 * needs to be enough to prevent a packet being discarded while
453 * we are processing the previous one.
454 */
455#define RINGSZ 4
456#define RINGSZ_LOG2 2
457
458/**********************************************************************/
459/*
460 * Globals.
461 *
462 * Note:
463 *
049a95a7 464 * All variables of type struct in_addr are stored in NETWORK byte order
2d966958
WD
465 * (big endian).
466 */
467
468/* net.c */
469/** BOOTP EXTENTIONS **/
049a95a7
JH
470extern struct in_addr net_gateway; /* Our gateway IP address */
471extern struct in_addr net_netmask; /* Our subnet mask (0 = unknown) */
472/* Our Domain Name Server (0 = unknown) */
473extern struct in_addr net_dns_server;
1fe80d79 474#if defined(CONFIG_BOOTP_DNS2)
049a95a7
JH
475/* Our 2nd Domain Name Server (0 = unknown) */
476extern struct in_addr net_dns_server2;
fe389a82 477#endif
586cbe51
JH
478extern char net_nis_domain[32]; /* Our IS domain */
479extern char net_hostname[32]; /* Our hostname */
480extern char net_root_path[64]; /* Our root path */
2d966958 481/** END OF BOOTP EXTENTIONS **/
0adb5b76
JH
482extern u8 net_ethaddr[6]; /* Our ethernet address */
483extern u8 net_server_ethaddr[6]; /* Boot server enet address */
049a95a7
JH
484extern struct in_addr net_ip; /* Our IP addr (0 = unknown) */
485extern struct in_addr net_server_ip; /* Server IP addr (0 = unknown) */
1203fcce 486extern uchar *net_tx_packet; /* THE transmit packet */
2a504df0 487extern uchar *net_rx_packets[PKTBUFSRX]; /* Receive packets */
1203fcce
JH
488extern uchar *net_rx_packet; /* Current receive packet */
489extern int net_rx_packet_len; /* Current rx packet length */
0adb5b76
JH
490extern const u8 net_bcast_ethaddr[6]; /* Ethernet broadcast address */
491extern const u8 net_null_ethaddr[6];
2d966958 492
b28e28bb
JH
493#define VLAN_NONE 4095 /* untagged */
494#define VLAN_IDMASK 0x0fff /* mask of valid vlan id */
4fd5055f
JH
495extern ushort net_our_vlan; /* Our VLAN */
496extern ushort net_native_vlan; /* Our Native VLAN */
a3d991bd 497
bc0571fc 498extern int net_restart_wrap; /* Tried all network devices */
2d966958 499
e4bf0c5c
SG
500enum proto_t {
501 BOOTP, RARP, ARP, TFTPGET, DHCP, PING, DNS, NFS, CDP, NETCONS, SNTP,
d22c338e 502 TFTPSRV, TFTPPUT, LINKLOCAL
e4bf0c5c 503};
2d966958 504
1411157d
JH
505extern char net_boot_file_name[128];/* Boot File name */
506/* The actual transferred size of the bootfile (in bytes) */
507extern u32 net_boot_file_size;
508/* Boot file size in blocks as reported by the DHCP server */
509extern u32 net_boot_file_expected_size_in_blocks;
2d966958 510
1a32bf41 511#if defined(CONFIG_CMD_DNS)
786eac5f
JH
512extern char *net_dns_resolve; /* The host to resolve */
513extern char *net_dns_env_var; /* the env var to put the ip into */
1a32bf41
RG
514#endif
515
639221c7 516#if defined(CONFIG_CMD_PING)
049a95a7 517extern struct in_addr net_ping_ip; /* the ip address to ping */
73a8b27c
WD
518#endif
519
639221c7 520#if defined(CONFIG_CMD_CDP)
a3d991bd 521/* when CDP completes these hold the return values */
6aede5b7
JH
522extern ushort cdp_native_vlan; /* CDP returned native VLAN */
523extern ushort cdp_appliance_vlan; /* CDP returned appliance VLAN */
17351883
JH
524
525/*
526 * Check for a CDP packet by examining the received MAC address field
527 */
0adb5b76 528static inline int is_cdp_packet(const uchar *ethaddr)
17351883 529{
0adb5b76 530 extern const u8 net_cdp_ethaddr[6];
17351883 531
0adb5b76 532 return memcmp(ethaddr, net_cdp_ethaddr, 6) == 0;
17351883 533}
a3d991bd
WD
534#endif
535
639221c7 536#if defined(CONFIG_CMD_SNTP)
049a95a7 537extern struct in_addr net_ntp_server; /* the ip address to NTP */
bc0571fc 538extern int net_ntp_time_offset; /* offset time from UTC */
ea287deb
WD
539#endif
540
13dfe943 541#if defined(CONFIG_MCAST_TFTP)
049a95a7 542extern struct in_addr net_mcast_addr;
13dfe943
JH
543#endif
544
2d966958 545/* Initialize the network adapter */
ff997432 546void net_init(void);
bc0571fc 547int net_loop(enum proto_t);
2d966958
WD
548
549/* Load failed. Start again. */
bc0571fc 550int net_start_again(void);
2d966958 551
a3d991bd 552/* Get size of the ethernet header when we send */
1203fcce 553int net_eth_hdr_size(void);
a3d991bd
WD
554
555/* Set ethernet header; returns the size of the header */
1203fcce 556int net_set_ether(uchar *xet, const uchar *dest_ethaddr, uint prot);
ff997432 557int net_update_ether(struct ethernet_hdr *et, uchar *addr, uint prot);
2d966958
WD
558
559/* Set IP header */
049a95a7
JH
560void net_set_ip_header(uchar *pkt, struct in_addr dest, struct in_addr source);
561void net_set_udp_header(uchar *pkt, struct in_addr dest, int dport,
4b11c916 562 int sport, int len);
2d966958 563
9b0e35cb
SG
564/**
565 * compute_ip_checksum() - Compute IP checksum
566 *
567 * @addr: Address to check (must be 16-bit aligned)
568 * @nbytes: Number of bytes to check (normally a multiple of 2)
569 * @return 16-bit IP checksum
570 */
571unsigned compute_ip_checksum(const void *addr, unsigned nbytes);
572
573/**
574 * add_ip_checksums() - add two IP checksums
575 *
576 * @offset: Offset of first sum (if odd we do a byte-swap)
577 * @sum: First checksum
578 * @new_sum: New checksum to add
579 * @return updated 16-bit IP checksum
580 */
581unsigned add_ip_checksums(unsigned offset, unsigned sum, unsigned new_sum);
582
583/**
584 * ip_checksum_ok() - check if a checksum is correct
585 *
586 * This works by making sure the checksum sums to 0
587 *
588 * @addr: Address to check (must be 16-bit aligned)
589 * @nbytes: Number of bytes to check (normally a multiple of 2)
590 * @return true if the checksum matches, false if not
591 */
592int ip_checksum_ok(const void *addr, unsigned nbytes);
593
d280d3f4 594/* Callbacks */
ff997432
JH
595rxhand_f *net_get_udp_handler(void); /* Get UDP RX packet handler */
596void net_set_udp_handler(rxhand_f *); /* Set UDP RX packet handler */
597rxhand_f *net_get_arp_handler(void); /* Get ARP RX packet handler */
598void net_set_arp_handler(rxhand_f *); /* Set ARP RX packet handler */
599void net_set_icmp_handler(rxhand_icmp_f *f); /* Set ICMP RX handler */
bc0571fc 600void net_set_timeout_handler(ulong, thand_f *);/* Set timeout handler */
2d966958 601
22f6e99d
JH
602/* Network loop state */
603enum net_loop_state {
604 NETLOOP_CONTINUE,
605 NETLOOP_RESTART,
606 NETLOOP_SUCCESS,
607 NETLOOP_FAIL
608};
06370590
KP
609extern enum net_loop_state net_state;
610
22f6e99d
JH
611static inline void net_set_state(enum net_loop_state state)
612{
4ef8d53c 613 debug_cond(DEBUG_INT_STATE, "--- NetState set to %d\n", state);
22f6e99d
JH
614 net_state = state;
615}
616
e94070c4 617/* Transmit a packet */
1203fcce 618static inline void net_send_packet(uchar *pkt, int len)
adf5d93e 619{
60304592 620 /* Currently no way to return errors from eth_send() */
adf5d93e
JH
621 (void) eth_send(pkt, len);
622}
2d966958 623
206d07fd 624/*
1203fcce 625 * Transmit "net_tx_packet" as UDP packet, performing ARP request if needed
ece223b5 626 * (ether will be populated)
206d07fd
JH
627 *
628 * @param ether Raw packet buffer
629 * @param dest IP address to send the datagram to
630 * @param dport Destination UDP port
631 * @param sport Source UDP port
632 * @param payload_len Length of data after the UDP header
633 */
1203fcce 634int net_send_udp_packet(uchar *ether, struct in_addr dest, int dport,
206d07fd 635 int sport, int payload_len);
73a8b27c 636
2d966958 637/* Processes a received packet */
2a504df0 638void net_process_received_packet(uchar *in_packet, int len);
2d966958 639
48522bb5 640#ifdef CONFIG_NETCONSOLE
6a38a5f3 641void nc_start(void);
049a95a7 642int nc_input_packet(uchar *pkt, struct in_addr src_ip, unsigned dest_port,
8a0eccb1 643 unsigned src_port, unsigned len);
48522bb5
JH
644#endif
645
f8be7d65
JH
646static inline __attribute__((always_inline)) int eth_is_on_demand_init(void)
647{
648#ifdef CONFIG_NETCONSOLE
649 extern enum proto_t net_loop_last_protocol;
650
651 return net_loop_last_protocol != NETCONS;
652#else
653 return 1;
654#endif
655}
656
657static inline void eth_set_last_protocol(int protocol)
658{
659#ifdef CONFIG_NETCONSOLE
660 extern enum proto_t net_loop_last_protocol;
661
662 net_loop_last_protocol = protocol;
663#endif
664}
665
e4a3d57d
SG
666/*
667 * Check if autoload is enabled. If so, use either NFS or TFTP to download
668 * the boot file.
669 */
670void net_auto_load(void);
671
2d966958
WD
672/*
673 * The following functions are a bit ugly, but necessary to deal with
674 * alignment restrictions on ARM.
675 *
676 * We're using inline functions, which had the smallest memory
677 * footprint in our tests.
678 */
679/* return IP *in network byteorder* */
049a95a7 680static inline struct in_addr net_read_ip(void *from)
2d966958 681{
049a95a7 682 struct in_addr ip;
b28e28bb
JH
683
684 memcpy((void *)&ip, (void *)from, sizeof(ip));
2d966958
WD
685 return ip;
686}
687
688/* return ulong *in network byteorder* */
5917e7d1 689static inline u32 net_read_u32(u32 *from)
2d966958 690{
5917e7d1 691 u32 l;
b28e28bb
JH
692
693 memcpy((void *)&l, (void *)from, sizeof(l));
2d966958
WD
694 return l;
695}
696
697/* write IP *in network byteorder* */
049a95a7 698static inline void net_write_ip(void *to, struct in_addr ip)
2d966958 699{
b28e28bb 700 memcpy(to, (void *)&ip, sizeof(ip));
2d966958
WD
701}
702
703/* copy IP */
049a95a7 704static inline void net_copy_ip(void *to, void *from)
2d966958 705{
049a95a7 706 memcpy((void *)to, from, sizeof(struct in_addr));
2d966958
WD
707}
708
709/* copy ulong */
5917e7d1 710static inline void net_copy_u32(u32 *to, u32 *from)
2d966958 711{
5917e7d1 712 memcpy((void *)to, (void *)from, sizeof(u32));
2d966958
WD
713}
714
50cca8b9 715/**
0adb5b76 716 * is_zero_ethaddr - Determine if give Ethernet address is all zeros.
50cca8b9
MR
717 * @addr: Pointer to a six-byte array containing the Ethernet address
718 *
719 * Return true if the address is all zeroes.
720 */
0adb5b76 721static inline int is_zero_ethaddr(const u8 *addr)
50cca8b9
MR
722{
723 return !(addr[0] | addr[1] | addr[2] | addr[3] | addr[4] | addr[5]);
724}
725
726/**
0adb5b76 727 * is_multicast_ethaddr - Determine if the Ethernet address is a multicast.
50cca8b9
MR
728 * @addr: Pointer to a six-byte array containing the Ethernet address
729 *
730 * Return true if the address is a multicast address.
731 * By definition the broadcast address is also a multicast address.
732 */
0adb5b76 733static inline int is_multicast_ethaddr(const u8 *addr)
50cca8b9 734{
b28e28bb 735 return 0x01 & addr[0];
50cca8b9
MR
736}
737
23cd1385 738/*
0adb5b76 739 * is_broadcast_ethaddr - Determine if the Ethernet address is broadcast
23cd1385
RB
740 * @addr: Pointer to a six-byte array containing the Ethernet address
741 *
742 * Return true if the address is the broadcast address.
743 */
0adb5b76 744static inline int is_broadcast_ethaddr(const u8 *addr)
23cd1385 745{
b28e28bb
JH
746 return (addr[0] & addr[1] & addr[2] & addr[3] & addr[4] & addr[5]) ==
747 0xff;
23cd1385
RB
748}
749
750/*
0adb5b76 751 * is_valid_ethaddr - Determine if the given Ethernet address is valid
75edebe3
MF
752 * @addr: Pointer to a six-byte array containing the Ethernet address
753 *
754 * Check that the Ethernet address (MAC) is not 00:00:00:00:00:00, is not
755 * a multicast address, and is not FF:FF:FF:FF:FF:FF.
756 *
757 * Return true if the address is valid.
758 */
0adb5b76 759static inline int is_valid_ethaddr(const u8 *addr)
75edebe3
MF
760{
761 /* FF:FF:FF:FF:FF:FF is a multicast address so we don't need to
762 * explicitly check for it here. */
0adb5b76 763 return !is_multicast_ethaddr(addr) && !is_zero_ethaddr(addr);
75edebe3
MF
764}
765
da384a9d 766/**
0adb5b76 767 * net_random_ethaddr - Generate software assigned random Ethernet address
da384a9d
MY
768 * @addr: Pointer to a six-byte array containing the Ethernet address
769 *
770 * Generate a random Ethernet address (MAC) that is not multicast
771 * and has the local assigned bit set.
772 */
0adb5b76 773static inline void net_random_ethaddr(uchar *addr)
da384a9d
MY
774{
775 int i;
776 unsigned int seed = get_timer(0);
777
778 for (i = 0; i < 6; i++)
779 addr[i] = rand_r(&seed);
780
781 addr[0] &= 0xfe; /* clear multicast bit */
782 addr[0] |= 0x02; /* set local assignment bit (IEEE802) */
783}
784
2d966958 785/* Convert an IP address to a string */
049a95a7 786void ip_to_string(struct in_addr x, char *s);
2d966958 787
73a8b27c 788/* Convert a string to ip address */
049a95a7 789struct in_addr string_to_ip(const char *s);
73a8b27c 790
a3d991bd 791/* Convert a VLAN id to a string */
4fd5055f 792void vlan_to_string(ushort x, char *s);
a3d991bd
WD
793
794/* Convert a string to a vlan id */
4fd5055f 795ushort string_to_vlan(const char *s);
a3d991bd 796
a3d991bd 797/* read a VLAN id from an environment variable */
4fd5055f 798ushort getenv_vlan(char *);
a3d991bd 799
2d966958 800/* copy a filename (allow for "..." notation, limit length) */
ff997432 801void copy_filename(char *dst, const char *src, int size);
2d966958 802
91b469c9 803/* get a random source port */
ff997432 804unsigned int random_port(void);
91b469c9 805
ea5427e2 806/* Update U-Boot over TFTP */
ff997432 807int update_tftp(ulong addr);
ea5427e2 808
2d966958
WD
809/**********************************************************************/
810
811#endif /* __NET_H__ */