blob: df5b64844ad012f60def7ea1022e007c16075720 [file] [log] [blame]
wdenk2d966952002-10-31 22:12:35 +00001/*
2 * LiMon Monitor (LiMon) - Network.
3 *
4 * Copyright 1994 - 2000 Neil Russell.
5 * (See License)
Wolfgang Denkdb065922014-09-30 10:44:01 +02006 * SPDX-License-Identifier: GPL-2.0
wdenk2d966952002-10-31 22:12:35 +00007 *
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
wdenk7a428cc2003-06-15 22:40:42 +000015#if defined(CONFIG_8xx)
wdenk2d966952002-10-31 22:12:35 +000016#include <commproc.h>
wdenk7a428cc2003-06-15 22:40:42 +000017#endif /* CONFIG_8xx */
wdenkeda42082003-01-17 16:27:01 +000018
Eric Nelson23343a12012-03-15 18:33:24 +000019#include <asm/cache.h>
wdenk2d966952002-10-31 22:12:35 +000020#include <asm/byteorder.h> /* for nton* / ntoh* stuff */
21
Joe Hershberger05a377b2012-05-23 08:01:04 +000022#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 */
wdenk2d966952002-10-31 22:12:35 +000026
27/*
28 * The number of receive packet buffers, and the required packet buffer
29 * alignment in memory.
30 *
31 */
32
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +020033#ifdef CONFIG_SYS_RX_ETH_BUFFER
34# define PKTBUFSRX CONFIG_SYS_RX_ETH_BUFFER
wdenk2582f6b2002-11-11 21:14:20 +000035#else
stroese14331ad2003-06-05 15:38:29 +000036# define PKTBUFSRX 4
wdenk2582f6b2002-11-11 21:14:20 +000037#endif
38
Eric Nelson23343a12012-03-15 18:33:24 +000039#define PKTALIGN ARCH_DMA_MINALIGN
wdenk2d966952002-10-31 22:12:35 +000040
Matthias Weisser6cc63262011-12-03 03:29:44 +000041/* IPv4 addresses are always 32 bits in size */
Kim Phillips6025cd22013-01-16 18:09:11 -060042typedef __be32 IPaddr_t;
wdenk2d966952002-10-31 22:12:35 +000043
44
Luca Ceresoli428ab362011-04-18 06:19:50 +000045/**
46 * An incoming packet handler.
47 * @param pkt pointer to the application packet
48 * @param dport destination UDP port
49 * @param sip source IP address
50 * @param sport source UDP port
51 * @param len packet length
wdenk2d966952002-10-31 22:12:35 +000052 */
Luca Ceresoli428ab362011-04-18 06:19:50 +000053typedef void rxhand_f(uchar *pkt, unsigned dport,
54 IPaddr_t sip, unsigned sport,
55 unsigned len);
wdenk2d966952002-10-31 22:12:35 +000056
Simon Glass230467c2011-10-24 18:00:01 +000057/**
58 * An incoming ICMP packet handler.
59 * @param type ICMP type
60 * @param code ICMP code
61 * @param dport destination UDP port
62 * @param sip source IP address
63 * @param sport source UDP port
64 * @param pkt pointer to the ICMP packet data
65 * @param len packet length
66 */
67typedef void rxhand_icmp_f(unsigned type, unsigned code, unsigned dport,
68 IPaddr_t sip, unsigned sport, uchar *pkt, unsigned len);
69
wdenk2d966952002-10-31 22:12:35 +000070/*
71 * A timeout handler. Called after time interval has expired.
72 */
73typedef void thand_f(void);
74
wdenk2d966952002-10-31 22:12:35 +000075enum eth_state_t {
76 ETH_STATE_INIT,
77 ETH_STATE_PASSIVE,
78 ETH_STATE_ACTIVE
79};
80
81struct eth_device {
Mike Frysinger6b300dc2011-11-10 14:11:04 +000082 char name[16];
wdenk2d966952002-10-31 22:12:35 +000083 unsigned char enetaddr[6];
Michal Simek66106f92015-01-14 16:00:39 +010084 phys_addr_t iobase;
wdenk2d966952002-10-31 22:12:35 +000085 int state;
86
Joe Hershberger290549f2012-05-15 08:59:05 +000087 int (*init) (struct eth_device *, bd_t *);
88 int (*send) (struct eth_device *, void *packet, int length);
89 int (*recv) (struct eth_device *);
90 void (*halt) (struct eth_device *);
David Updegraff7280da72007-06-11 10:41:07 -050091#ifdef CONFIG_MCAST_TFTP
Claudiu Manoil5c473572013-09-30 12:44:39 +030092 int (*mcast) (struct eth_device *, const u8 *enetaddr, u8 set);
David Updegraff7280da72007-06-11 10:41:07 -050093#endif
Joe Hershberger290549f2012-05-15 08:59:05 +000094 int (*write_hwaddr) (struct eth_device *);
wdenk2d966952002-10-31 22:12:35 +000095 struct eth_device *next;
Michael Walle391da4c2011-10-27 11:31:35 +000096 int index;
wdenk2d966952002-10-31 22:12:35 +000097 void *priv;
98};
99
Joe Hershbergerb79dda32015-03-22 17:09:02 -0500100int eth_register(struct eth_device *dev);/* Register network device */
101int eth_unregister(struct eth_device *dev);/* Remove network device */
Kim Phillips40c2c032012-10-29 13:34:33 +0000102
Kim Phillips40c2c032012-10-29 13:34:33 +0000103extern struct eth_device *eth_current;
104
Joe Hershberger9f374062012-08-03 10:59:08 +0000105static inline __attribute__((always_inline))
106struct eth_device *eth_get_dev(void)
107{
Joe Hershberger9f374062012-08-03 10:59:08 +0000108 return eth_current;
109}
Joe Hershbergere1e8a8c2015-03-22 17:09:03 -0500110struct eth_device *eth_get_dev_by_name(const char *devname);
111struct eth_device *eth_get_dev_by_index(int index); /* get dev @ index */
Joe Hershberger11cd5a02015-03-22 17:09:00 -0500112
Joe Hershbergere1e8a8c2015-03-22 17:09:03 -0500113/* get the current device MAC */
Joe Hershberger11cd5a02015-03-22 17:09:00 -0500114static inline unsigned char *eth_get_ethaddr(void)
115{
116 if (eth_current)
117 return eth_current->enetaddr;
118 return NULL;
119}
120
Joe Hershbergere1e8a8c2015-03-22 17:09:03 -0500121/* Set active state */
Joe Hershberger3dbe17e2015-03-22 17:09:06 -0500122static inline __attribute__((always_inline)) int eth_init_state_only(void)
Joe Hershbergere1e8a8c2015-03-22 17:09:03 -0500123{
124 eth_get_dev()->state = ETH_STATE_ACTIVE;
125
126 return 0;
127}
128/* Set passive state */
129static inline __attribute__((always_inline)) void eth_halt_state_only(void)
130{
131 eth_get_dev()->state = ETH_STATE_PASSIVE;
132}
133
134/*
135 * Set the hardware address for an ethernet interface based on 'eth%daddr'
136 * environment variable (or just 'ethaddr' if eth_number is 0).
137 * Args:
138 * base_name - base name for device (normally "eth")
139 * eth_number - value of %d (0 for first device of this type)
140 * Returns:
141 * 0 is success, non-zero is error status from driver.
142 */
143int eth_write_hwaddr(struct eth_device *dev, const char *base_name,
144 int eth_number);
145
146int usb_eth_initialize(bd_t *bi);
147
Joe Hershberger3dbe17e2015-03-22 17:09:06 -0500148int eth_initialize(void); /* Initialize network subsystem */
Joe Hershbergere1e8a8c2015-03-22 17:09:03 -0500149void eth_try_another(int first_restart); /* Change the device */
150void eth_set_current(void); /* set nterface to ethcur var */
151
Joe Hershbergerb79dda32015-03-22 17:09:02 -0500152int eth_get_dev_index(void); /* get the device index */
153void eth_parse_enetaddr(const char *addr, uchar *enetaddr);
154int eth_getenv_enetaddr(char *name, uchar *enetaddr);
155int eth_setenv_enetaddr(char *name, const uchar *enetaddr);
Simon Glass62b36c92011-06-13 16:13:10 -0700156
157/*
158 * Get the hardware address for an ethernet interface .
159 * Args:
160 * base_name - base name for device (normally "eth")
161 * index - device index number (0 for first)
162 * enetaddr - returns 6 byte hardware address
163 * Returns:
164 * Return true if the address is valid.
165 */
Joe Hershbergerb79dda32015-03-22 17:09:02 -0500166int eth_getenv_enetaddr_by_index(const char *base_name, int index,
167 uchar *enetaddr);
wdenk2d966952002-10-31 22:12:35 +0000168
Joe Hershberger3dbe17e2015-03-22 17:09:06 -0500169int eth_init(void); /* Initialize the device */
Joe Hershbergerb79dda32015-03-22 17:09:02 -0500170int eth_send(void *packet, int length); /* Send a packet */
Remy Bohmerdf063442009-07-29 18:18:43 +0200171
Rafal Jaworowski1f2c9a42007-12-27 18:19:02 +0100172#ifdef CONFIG_API
Joe Hershbergerb79dda32015-03-22 17:09:02 -0500173int eth_receive(void *packet, int length); /* Receive a packet*/
Joe Hershberger4b7747e2012-05-15 08:59:04 +0000174extern void (*push_packet)(void *packet, int length);
Rafal Jaworowski1f2c9a42007-12-27 18:19:02 +0100175#endif
Joe Hershbergerb79dda32015-03-22 17:09:02 -0500176int eth_rx(void); /* Check for received packets */
177void eth_halt(void); /* stop SCC */
Joe Hershbergere1e8a8c2015-03-22 17:09:03 -0500178const char *eth_get_name(void); /* get name of current device */
Simon Glass62b36c92011-06-13 16:13:10 -0700179
David Updegraff7280da72007-06-11 10:41:07 -0500180#ifdef CONFIG_MCAST_TFTP
Joe Hershbergeraca1c312015-03-22 17:09:05 -0500181int eth_mcast_join(IPaddr_t mcast_addr, int join);
Joe Hershberger290549f2012-05-15 08:59:05 +0000182u32 ether_crc(size_t len, unsigned char const *p);
David Updegraff7280da72007-06-11 10:41:07 -0500183#endif
184
wdenk2d966952002-10-31 22:12:35 +0000185
186/**********************************************************************/
187/*
188 * Protocol headers.
189 */
190
191/*
192 * Ethernet header
193 */
Joe Hershberger1178f412012-05-23 07:58:06 +0000194
195struct ethernet_hdr {
196 uchar et_dest[6]; /* Destination node */
197 uchar et_src[6]; /* Source node */
198 ushort et_protlen; /* Protocol or length */
199};
200
201/* Ethernet header size */
202#define ETHER_HDR_SIZE (sizeof(struct ethernet_hdr))
203
Bin Mengb1a5e1f2015-03-20 17:12:18 +0800204#define ETH_FCS_LEN 4 /* Octets in the FCS */
205
Joe Hershberger1178f412012-05-23 07:58:06 +0000206struct e802_hdr {
wdenk2d966952002-10-31 22:12:35 +0000207 uchar et_dest[6]; /* Destination node */
208 uchar et_src[6]; /* Source node */
209 ushort et_protlen; /* Protocol or length */
210 uchar et_dsap; /* 802 DSAP */
211 uchar et_ssap; /* 802 SSAP */
212 uchar et_ctl; /* 802 control */
213 uchar et_snap1; /* SNAP */
214 uchar et_snap2;
215 uchar et_snap3;
216 ushort et_prot; /* 802 protocol */
Joe Hershberger1178f412012-05-23 07:58:06 +0000217};
wdenk2d966952002-10-31 22:12:35 +0000218
Joe Hershbergerc17fa982012-05-23 07:58:11 +0000219/* 802 + SNAP + ethernet header size */
Joe Hershberger1178f412012-05-23 07:58:06 +0000220#define E802_HDR_SIZE (sizeof(struct e802_hdr))
wdenk145d2c12004-04-15 21:48:45 +0000221
222/*
Joe Hershbergerc17fa982012-05-23 07:58:11 +0000223 * Virtual LAN Ethernet header
wdenk145d2c12004-04-15 21:48:45 +0000224 */
Joe Hershbergerb43784c2012-05-23 07:58:07 +0000225struct vlan_ethernet_hdr {
wdenk145d2c12004-04-15 21:48:45 +0000226 uchar vet_dest[6]; /* Destination node */
227 uchar vet_src[6]; /* Source node */
228 ushort vet_vlan_type; /* PROT_VLAN */
229 ushort vet_tag; /* TAG of VLAN */
230 ushort vet_type; /* protocol type */
Joe Hershbergerb43784c2012-05-23 07:58:07 +0000231};
wdenk145d2c12004-04-15 21:48:45 +0000232
Joe Hershbergerb43784c2012-05-23 07:58:07 +0000233/* VLAN Ethernet header size */
234#define VLAN_ETHER_HDR_SIZE (sizeof(struct vlan_ethernet_hdr))
wdenk145d2c12004-04-15 21:48:45 +0000235
wdenk2d966952002-10-31 22:12:35 +0000236#define PROT_IP 0x0800 /* IP protocol */
237#define PROT_ARP 0x0806 /* IP ARP protocol */
238#define PROT_RARP 0x8035 /* IP ARP protocol */
wdenk145d2c12004-04-15 21:48:45 +0000239#define PROT_VLAN 0x8100 /* IEEE 802.1q protocol */
wdenk2d966952002-10-31 22:12:35 +0000240
241#define IPPROTO_ICMP 1 /* Internet Control Message Protocol */
242#define IPPROTO_UDP 17 /* User Datagram Protocol */
243
244/*
Joe Hershbergerc686fa12012-05-23 07:58:05 +0000245 * Internet Protocol (IP) header.
wdenk2d966952002-10-31 22:12:35 +0000246 */
Joe Hershbergerc686fa12012-05-23 07:58:05 +0000247struct ip_hdr {
wdenk2d966952002-10-31 22:12:35 +0000248 uchar ip_hl_v; /* header length and version */
249 uchar ip_tos; /* type of service */
250 ushort ip_len; /* total length */
251 ushort ip_id; /* identification */
252 ushort ip_off; /* fragment offset field */
253 uchar ip_ttl; /* time to live */
254 uchar ip_p; /* protocol */
255 ushort ip_sum; /* checksum */
256 IPaddr_t ip_src; /* Source IP address */
257 IPaddr_t ip_dst; /* Destination IP address */
Joe Hershberger6fe8b452012-05-23 07:58:04 +0000258};
wdenk2d966952002-10-31 22:12:35 +0000259
Peter Tyser0885bf02008-12-01 16:26:20 -0600260#define IP_OFFS 0x1fff /* ip offset *= 8 */
261#define IP_FLAGS 0xe000 /* first 3 bits */
262#define IP_FLAGS_RES 0x8000 /* reserved */
263#define IP_FLAGS_DFRAG 0x4000 /* don't fragments */
264#define IP_FLAGS_MFRAG 0x2000 /* more fragments */
265
Joe Hershbergerc686fa12012-05-23 07:58:05 +0000266#define IP_HDR_SIZE (sizeof(struct ip_hdr))
267
268/*
269 * Internet Protocol (IP) + UDP header.
270 */
271struct ip_udp_hdr {
272 uchar ip_hl_v; /* header length and version */
273 uchar ip_tos; /* type of service */
274 ushort ip_len; /* total length */
275 ushort ip_id; /* identification */
276 ushort ip_off; /* fragment offset field */
277 uchar ip_ttl; /* time to live */
278 uchar ip_p; /* protocol */
279 ushort ip_sum; /* checksum */
280 IPaddr_t ip_src; /* Source IP address */
281 IPaddr_t ip_dst; /* Destination IP address */
282 ushort udp_src; /* UDP source port */
283 ushort udp_dst; /* UDP destination port */
284 ushort udp_len; /* Length of UDP packet */
285 ushort udp_xsum; /* Checksum */
286};
wdenk2d966952002-10-31 22:12:35 +0000287
Joe Hershberger6fe8b452012-05-23 07:58:04 +0000288#define IP_UDP_HDR_SIZE (sizeof(struct ip_udp_hdr))
Joe Hershbergerc686fa12012-05-23 07:58:05 +0000289#define UDP_HDR_SIZE (IP_UDP_HDR_SIZE - IP_HDR_SIZE)
wdenk2d966952002-10-31 22:12:35 +0000290
291/*
292 * Address Resolution Protocol (ARP) header.
293 */
Joe Hershbergerde15d0932012-05-23 07:58:08 +0000294struct arp_hdr {
wdenk2d966952002-10-31 22:12:35 +0000295 ushort ar_hrd; /* Format of hardware address */
296# define ARP_ETHER 1 /* Ethernet hardware address */
297 ushort ar_pro; /* Format of protocol address */
298 uchar ar_hln; /* Length of hardware address */
Joe Hershberger2f787492012-05-23 07:58:17 +0000299# define ARP_HLEN 6
wdenk2d966952002-10-31 22:12:35 +0000300 uchar ar_pln; /* Length of protocol address */
Joe Hershberger2f787492012-05-23 07:58:17 +0000301# define ARP_PLEN 4
wdenk2d966952002-10-31 22:12:35 +0000302 ushort ar_op; /* Operation */
303# define ARPOP_REQUEST 1 /* Request to resolve address */
304# define ARPOP_REPLY 2 /* Response to previous request */
305
306# define RARPOP_REQUEST 3 /* Request to resolve address */
307# define RARPOP_REPLY 4 /* Response to previous request */
308
309 /*
wdenk57b2d802003-06-27 21:31:46 +0000310 * The remaining fields are variable in size, according to
311 * the sizes above, and are defined as appropriate for
312 * specific hardware/protocol combinations.
wdenk2d966952002-10-31 22:12:35 +0000313 */
314 uchar ar_data[0];
Joe Hershberger2f787492012-05-23 07:58:17 +0000315#define ar_sha ar_data[0]
316#define ar_spa ar_data[ARP_HLEN]
317#define ar_tha ar_data[ARP_HLEN + ARP_PLEN]
318#define ar_tpa ar_data[ARP_HLEN + ARP_PLEN + ARP_HLEN]
wdenk2d966952002-10-31 22:12:35 +0000319#if 0
320 uchar ar_sha[]; /* Sender hardware address */
321 uchar ar_spa[]; /* Sender protocol address */
322 uchar ar_tha[]; /* Target hardware address */
323 uchar ar_tpa[]; /* Target protocol address */
324#endif /* 0 */
Joe Hershbergerde15d0932012-05-23 07:58:08 +0000325};
wdenk2d966952002-10-31 22:12:35 +0000326
327#define ARP_HDR_SIZE (8+20) /* Size assuming ethernet */
328
329/*
330 * ICMP stuff (just enough to handle (host) redirect messages)
331 */
Wolfgang Denka1be4762008-05-20 16:00:29 +0200332#define ICMP_ECHO_REPLY 0 /* Echo reply */
Simon Glass230467c2011-10-24 18:00:01 +0000333#define ICMP_NOT_REACH 3 /* Detination unreachable */
wdenk2d966952002-10-31 22:12:35 +0000334#define ICMP_REDIRECT 5 /* Redirect (change route) */
wdenke6466f62003-06-05 19:27:42 +0000335#define ICMP_ECHO_REQUEST 8 /* Echo request */
wdenk2d966952002-10-31 22:12:35 +0000336
337/* Codes for REDIRECT. */
338#define ICMP_REDIR_NET 0 /* Redirect Net */
339#define ICMP_REDIR_HOST 1 /* Redirect Host */
340
Simon Glass230467c2011-10-24 18:00:01 +0000341/* Codes for NOT_REACH */
342#define ICMP_NOT_REACH_PORT 3 /* Port unreachable */
343
Joe Hershberger78495612012-05-23 07:58:09 +0000344struct icmp_hdr {
wdenk2d966952002-10-31 22:12:35 +0000345 uchar type;
346 uchar code;
347 ushort checksum;
348 union {
349 struct {
350 ushort id;
351 ushort sequence;
352 } echo;
353 ulong gateway;
354 struct {
Jeroen Hofstee9a1ad002013-08-10 16:52:47 +0200355 ushort unused;
wdenk2d966952002-10-31 22:12:35 +0000356 ushort mtu;
357 } frag;
Simon Glass230467c2011-10-24 18:00:01 +0000358 uchar data[0];
wdenk2d966952002-10-31 22:12:35 +0000359 } un;
Joe Hershberger78495612012-05-23 07:58:09 +0000360};
wdenk2d966952002-10-31 22:12:35 +0000361
Joe Hershberger78495612012-05-23 07:58:09 +0000362#define ICMP_HDR_SIZE (sizeof(struct icmp_hdr))
363#define IP_ICMP_HDR_SIZE (IP_HDR_SIZE + ICMP_HDR_SIZE)
wdenk2d966952002-10-31 22:12:35 +0000364
wdenk2d966952002-10-31 22:12:35 +0000365/*
366 * Maximum packet size; used to allocate packet storage.
367 * TFTP packets can be 524 bytes + IP header + ethernet header.
368 * Lets be conservative, and go for 38 * 16. (Must also be
369 * a multiple of 32 bytes).
370 */
371/*
372 * AS.HARNOIS : Better to set PKTSIZE to maximum size because
373 * traffic type is not always controlled
374 * maximum packet size = 1518
375 * maximum packet size and multiple of 32 bytes = 1536
376 */
377#define PKTSIZE 1518
378#define PKTSIZE_ALIGN 1536
379/*#define PKTSIZE 608*/
380
381/*
382 * Maximum receive ring size; that is, the number of packets
383 * we can buffer before overflow happens. Basically, this just
384 * needs to be enough to prevent a packet being discarded while
385 * we are processing the previous one.
386 */
387#define RINGSZ 4
388#define RINGSZ_LOG2 2
389
390/**********************************************************************/
391/*
392 * Globals.
393 *
394 * Note:
395 *
396 * All variables of type IPaddr_t are stored in NETWORK byte order
397 * (big endian).
398 */
399
400/* net.c */
401/** BOOTP EXTENTIONS **/
Joe Hershberger290549f2012-05-15 08:59:05 +0000402extern IPaddr_t NetOurGatewayIP; /* Our gateway IP address */
403extern IPaddr_t NetOurSubnetMask; /* Our subnet mask (0 = unknown) */
404extern IPaddr_t NetOurDNSIP; /* Our Domain Name Server (0 = unknown) */
Jon Loeliger5336a762007-07-09 22:08:34 -0500405#if defined(CONFIG_BOOTP_DNS2)
Joe Hershberger290549f2012-05-15 08:59:05 +0000406extern IPaddr_t NetOurDNS2IP; /* Our 2nd Domain Name Server (0 = unknown) */
stroesee0aadfb2003-08-28 14:17:32 +0000407#endif
Joe Hershberger290549f2012-05-15 08:59:05 +0000408extern char NetOurNISDomain[32]; /* Our NIS domain */
409extern char NetOurHostName[32]; /* Our hostname */
410extern char NetOurRootPath[64]; /* Our root path */
411extern ushort NetBootFileSize; /* Our boot file size in blocks */
wdenk2d966952002-10-31 22:12:35 +0000412/** END OF BOOTP EXTENTIONS **/
Joe Hershberger290549f2012-05-15 08:59:05 +0000413extern ulong NetBootFileXferSize; /* size of bootfile in bytes */
414extern uchar NetOurEther[6]; /* Our ethernet address */
415extern uchar NetServerEther[6]; /* Boot server enet address */
416extern IPaddr_t NetOurIP; /* Our IP addr (0 = unknown) */
417extern IPaddr_t NetServerIP; /* Server IP addr (0 = unknown) */
Joe Hershberger4b7747e2012-05-15 08:59:04 +0000418extern uchar *NetTxPacket; /* THE transmit packet */
Joe Hershberger290549f2012-05-15 08:59:05 +0000419extern uchar *NetRxPackets[PKTBUFSRX]; /* Receive packets */
Joe Hershberger4b7747e2012-05-15 08:59:04 +0000420extern uchar *NetRxPacket; /* Current receive packet */
Joe Hershberger290549f2012-05-15 08:59:05 +0000421extern int NetRxPacketLen; /* Current rx packet length */
422extern unsigned NetIPID; /* IP ID (counting) */
423extern uchar NetBcastAddr[6]; /* Ethernet boardcast address */
wdenkb8fb6192004-08-02 21:11:11 +0000424extern uchar NetEtherNullAddr[6];
wdenk2d966952002-10-31 22:12:35 +0000425
Joe Hershberger290549f2012-05-15 08:59:05 +0000426#define VLAN_NONE 4095 /* untagged */
427#define VLAN_IDMASK 0x0fff /* mask of valid vlan id */
428extern ushort NetOurVLAN; /* Our VLAN */
429extern ushort NetOurNativeVLAN; /* Our Native VLAN */
wdenk145d2c12004-04-15 21:48:45 +0000430
Joe Hershberger290549f2012-05-15 08:59:05 +0000431extern int NetRestartWrap; /* Tried all network devices */
wdenk2d966952002-10-31 22:12:35 +0000432
Simon Glassd6c5f552011-10-24 18:00:02 +0000433enum proto_t {
434 BOOTP, RARP, ARP, TFTPGET, DHCP, PING, DNS, NFS, CDP, NETCONS, SNTP,
Joe Hershbergerb35a3a62012-05-23 08:00:12 +0000435 TFTPSRV, TFTPPUT, LINKLOCAL
Simon Glassd6c5f552011-10-24 18:00:02 +0000436};
wdenk2d966952002-10-31 22:12:35 +0000437
438/* from net/net.c */
Joe Hershberger290549f2012-05-15 08:59:05 +0000439extern char BootFile[128]; /* Boot File name */
wdenk2d966952002-10-31 22:12:35 +0000440
Robin Getz82f0d232009-07-20 14:53:54 -0400441#if defined(CONFIG_CMD_DNS)
442extern char *NetDNSResolve; /* The host to resolve */
443extern char *NetDNSenvvar; /* the env var to put the ip into */
444#endif
445
Jon Loeliger2517d972007-07-09 17:15:49 -0500446#if defined(CONFIG_CMD_PING)
Joe Hershberger290549f2012-05-15 08:59:05 +0000447extern IPaddr_t NetPingIP; /* the ip address to ping */
wdenke6466f62003-06-05 19:27:42 +0000448#endif
449
Jon Loeliger2517d972007-07-09 17:15:49 -0500450#if defined(CONFIG_CMD_CDP)
wdenk145d2c12004-04-15 21:48:45 +0000451/* when CDP completes these hold the return values */
Joe Hershbergera4215b02012-05-23 07:57:59 +0000452extern ushort CDPNativeVLAN; /* CDP returned native VLAN */
453extern ushort CDPApplianceVLAN; /* CDP returned appliance VLAN */
Joe Hershberger00c62a82012-05-23 07:58:00 +0000454
455/*
456 * Check for a CDP packet by examining the received MAC address field
457 */
458static inline int is_cdp_packet(const uchar *et_addr)
459{
460 extern const uchar NetCDPAddr[6];
461
462 return memcmp(et_addr, NetCDPAddr, 6) == 0;
463}
wdenk145d2c12004-04-15 21:48:45 +0000464#endif
465
Jon Loeliger2517d972007-07-09 17:15:49 -0500466#if defined(CONFIG_CMD_SNTP)
Joe Hershberger290549f2012-05-15 08:59:05 +0000467extern IPaddr_t NetNtpServerIP; /* the ip address to NTP */
468extern int NetTimeOffset; /* offset time from UTC */
wdenkb4ad9622005-04-01 00:25:43 +0000469#endif
470
Joe Hershberger3a29e5a2012-05-15 08:59:12 +0000471#if defined(CONFIG_MCAST_TFTP)
472extern IPaddr_t Mcast_addr;
473#endif
474
wdenk2d966952002-10-31 22:12:35 +0000475/* Initialize the network adapter */
Joe Hershbergerb79dda32015-03-22 17:09:02 -0500476void net_init(void);
477int NetLoop(enum proto_t);
wdenk2d966952002-10-31 22:12:35 +0000478
479/* Shutdown adapters and cleanup */
Joe Hershbergerb79dda32015-03-22 17:09:02 -0500480void NetStop(void);
wdenk2d966952002-10-31 22:12:35 +0000481
482/* Load failed. Start again. */
Joe Hershbergerb79dda32015-03-22 17:09:02 -0500483void NetStartAgain(void);
wdenk2d966952002-10-31 22:12:35 +0000484
wdenk145d2c12004-04-15 21:48:45 +0000485/* Get size of the ethernet header when we send */
Joe Hershbergerb79dda32015-03-22 17:09:02 -0500486int NetEthHdrSize(void);
wdenk145d2c12004-04-15 21:48:45 +0000487
488/* Set ethernet header; returns the size of the header */
Joe Hershbergerb79dda32015-03-22 17:09:02 -0500489int NetSetEther(uchar *, uchar *, uint);
490int net_update_ether(struct ethernet_hdr *et, uchar *addr, uint prot);
wdenk2d966952002-10-31 22:12:35 +0000491
492/* Set IP header */
Joe Hershbergerb79dda32015-03-22 17:09:02 -0500493void net_set_ip_header(uchar *pkt, IPaddr_t dest, IPaddr_t source);
494void net_set_udp_header(uchar *pkt, IPaddr_t dest, int dport,
Joe Hershberger2ed5b492012-05-23 07:59:07 +0000495 int sport, int len);
wdenk2d966952002-10-31 22:12:35 +0000496
Simon Glass00153912015-01-19 22:16:07 -0700497/**
498 * compute_ip_checksum() - Compute IP checksum
499 *
500 * @addr: Address to check (must be 16-bit aligned)
501 * @nbytes: Number of bytes to check (normally a multiple of 2)
502 * @return 16-bit IP checksum
503 */
504unsigned compute_ip_checksum(const void *addr, unsigned nbytes);
505
506/**
507 * add_ip_checksums() - add two IP checksums
508 *
509 * @offset: Offset of first sum (if odd we do a byte-swap)
510 * @sum: First checksum
511 * @new_sum: New checksum to add
512 * @return updated 16-bit IP checksum
513 */
514unsigned add_ip_checksums(unsigned offset, unsigned sum, unsigned new_sum);
515
516/**
517 * ip_checksum_ok() - check if a checksum is correct
518 *
519 * This works by making sure the checksum sums to 0
520 *
521 * @addr: Address to check (must be 16-bit aligned)
522 * @nbytes: Number of bytes to check (normally a multiple of 2)
523 * @return true if the checksum matches, false if not
524 */
525int ip_checksum_ok(const void *addr, unsigned nbytes);
526
Joe Hershbergeraae05082012-05-23 07:58:01 +0000527/* Callbacks */
Joe Hershbergerb79dda32015-03-22 17:09:02 -0500528rxhand_f *net_get_udp_handler(void); /* Get UDP RX packet handler */
529void net_set_udp_handler(rxhand_f *); /* Set UDP RX packet handler */
530rxhand_f *net_get_arp_handler(void); /* Get ARP RX packet handler */
531void net_set_arp_handler(rxhand_f *); /* Set ARP RX packet handler */
532void net_set_icmp_handler(rxhand_icmp_f *f); /* Set ICMP RX handler */
533void NetSetTimeout(ulong, thand_f *);/* Set timeout handler */
wdenk2d966952002-10-31 22:12:35 +0000534
Joe Hershbergerd4bb76a2012-05-23 07:59:14 +0000535/* Network loop state */
536enum net_loop_state {
537 NETLOOP_CONTINUE,
538 NETLOOP_RESTART,
539 NETLOOP_SUCCESS,
540 NETLOOP_FAIL
541};
Kim Phillips40c2c032012-10-29 13:34:33 +0000542extern enum net_loop_state net_state;
543
Joe Hershbergerd4bb76a2012-05-23 07:59:14 +0000544static inline void net_set_state(enum net_loop_state state)
545{
Joe Hershberger05a377b2012-05-23 08:01:04 +0000546 debug_cond(DEBUG_INT_STATE, "--- NetState set to %d\n", state);
Joe Hershbergerd4bb76a2012-05-23 07:59:14 +0000547 net_state = state;
548}
549
Joe Hershbergerde8205a2012-05-23 07:59:24 +0000550/* Transmit a packet */
Joe Hershbergerebe3ca82012-05-23 07:59:13 +0000551static inline void NetSendPacket(uchar *pkt, int len)
552{
553 (void) eth_send(pkt, len);
554}
wdenk2d966952002-10-31 22:12:35 +0000555
Joe Hershberger1a6b8d82012-05-23 07:58:10 +0000556/*
Joe Hershbergerde8205a2012-05-23 07:59:24 +0000557 * Transmit "NetTxPacket" as UDP packet, performing ARP request if needed
Joe Hershbergerf50357b2012-05-23 07:59:15 +0000558 * (ether will be populated)
Joe Hershberger1a6b8d82012-05-23 07:58:10 +0000559 *
560 * @param ether Raw packet buffer
561 * @param dest IP address to send the datagram to
562 * @param dport Destination UDP port
563 * @param sport Source UDP port
564 * @param payload_len Length of data after the UDP header
565 */
Joe Hershbergerb79dda32015-03-22 17:09:02 -0500566int NetSendUDPPacket(uchar *ether, IPaddr_t dest, int dport,
Joe Hershberger1a6b8d82012-05-23 07:58:10 +0000567 int sport, int payload_len);
wdenke6466f62003-06-05 19:27:42 +0000568
wdenk2d966952002-10-31 22:12:35 +0000569/* Processes a received packet */
Joe Hershbergerb79dda32015-03-22 17:09:02 -0500570void NetReceive(uchar *, int);
wdenk2d966952002-10-31 22:12:35 +0000571
Joe Hershberger77001b432012-05-15 08:59:08 +0000572#ifdef CONFIG_NETCONSOLE
573void NcStart(void);
Joe Hershberger58cd2182012-09-18 10:01:32 +0000574int nc_input_packet(uchar *pkt, IPaddr_t src_ip, unsigned dest_port,
575 unsigned src_port, unsigned len);
Joe Hershberger77001b432012-05-15 08:59:08 +0000576#endif
577
Joe Hershberger9f374062012-08-03 10:59:08 +0000578static inline __attribute__((always_inline)) int eth_is_on_demand_init(void)
579{
580#ifdef CONFIG_NETCONSOLE
581 extern enum proto_t net_loop_last_protocol;
582
583 return net_loop_last_protocol != NETCONS;
584#else
585 return 1;
586#endif
587}
588
589static inline void eth_set_last_protocol(int protocol)
590{
591#ifdef CONFIG_NETCONSOLE
592 extern enum proto_t net_loop_last_protocol;
593
594 net_loop_last_protocol = protocol;
595#endif
596}
597
wdenk2d966952002-10-31 22:12:35 +0000598/*
Simon Glass5234ad12011-10-27 06:24:32 +0000599 * Check if autoload is enabled. If so, use either NFS or TFTP to download
600 * the boot file.
601 */
602void net_auto_load(void);
603
604/*
wdenk2d966952002-10-31 22:12:35 +0000605 * The following functions are a bit ugly, but necessary to deal with
606 * alignment restrictions on ARM.
607 *
608 * We're using inline functions, which had the smallest memory
609 * footprint in our tests.
610 */
611/* return IP *in network byteorder* */
Joe Hershberger4b7747e2012-05-15 08:59:04 +0000612static inline IPaddr_t NetReadIP(void *from)
wdenk2d966952002-10-31 22:12:35 +0000613{
614 IPaddr_t ip;
Joe Hershberger290549f2012-05-15 08:59:05 +0000615
616 memcpy((void *)&ip, (void *)from, sizeof(ip));
wdenk2d966952002-10-31 22:12:35 +0000617 return ip;
618}
619
620/* return ulong *in network byteorder* */
621static inline ulong NetReadLong(ulong *from)
622{
623 ulong l;
Joe Hershberger290549f2012-05-15 08:59:05 +0000624
625 memcpy((void *)&l, (void *)from, sizeof(l));
wdenk2d966952002-10-31 22:12:35 +0000626 return l;
627}
628
629/* write IP *in network byteorder* */
630static inline void NetWriteIP(void *to, IPaddr_t ip)
631{
Joe Hershberger290549f2012-05-15 08:59:05 +0000632 memcpy(to, (void *)&ip, sizeof(ip));
wdenk2d966952002-10-31 22:12:35 +0000633}
634
635/* copy IP */
Joe Hershberger4b7747e2012-05-15 08:59:04 +0000636static inline void NetCopyIP(void *to, void *from)
wdenk2d966952002-10-31 22:12:35 +0000637{
Joe Hershberger290549f2012-05-15 08:59:05 +0000638 memcpy((void *)to, from, sizeof(IPaddr_t));
wdenk2d966952002-10-31 22:12:35 +0000639}
640
641/* copy ulong */
642static inline void NetCopyLong(ulong *to, ulong *from)
643{
Joe Hershberger290549f2012-05-15 08:59:05 +0000644 memcpy((void *)to, (void *)from, sizeof(ulong));
wdenk2d966952002-10-31 22:12:35 +0000645}
646
Mike Rapoporte54d6c12007-08-12 08:48:27 +0300647/**
648 * is_zero_ether_addr - Determine if give Ethernet address is all zeros.
649 * @addr: Pointer to a six-byte array containing the Ethernet address
650 *
651 * Return true if the address is all zeroes.
652 */
653static inline int is_zero_ether_addr(const u8 *addr)
654{
655 return !(addr[0] | addr[1] | addr[2] | addr[3] | addr[4] | addr[5]);
656}
657
658/**
659 * is_multicast_ether_addr - Determine if the Ethernet address is a multicast.
660 * @addr: Pointer to a six-byte array containing the Ethernet address
661 *
662 * Return true if the address is a multicast address.
663 * By definition the broadcast address is also a multicast address.
664 */
665static inline int is_multicast_ether_addr(const u8 *addr)
666{
Joe Hershberger290549f2012-05-15 08:59:05 +0000667 return 0x01 & addr[0];
Mike Rapoporte54d6c12007-08-12 08:48:27 +0300668}
669
Remy Bohmerdf063442009-07-29 18:18:43 +0200670/*
671 * is_broadcast_ether_addr - Determine if the Ethernet address is broadcast
672 * @addr: Pointer to a six-byte array containing the Ethernet address
673 *
674 * Return true if the address is the broadcast address.
675 */
676static inline int is_broadcast_ether_addr(const u8 *addr)
677{
Joe Hershberger290549f2012-05-15 08:59:05 +0000678 return (addr[0] & addr[1] & addr[2] & addr[3] & addr[4] & addr[5]) ==
679 0xff;
Remy Bohmerdf063442009-07-29 18:18:43 +0200680}
681
682/*
Mike Frysinger2a02f5c2009-01-27 16:53:39 -0500683 * is_valid_ether_addr - Determine if the given Ethernet address is valid
684 * @addr: Pointer to a six-byte array containing the Ethernet address
685 *
686 * Check that the Ethernet address (MAC) is not 00:00:00:00:00:00, is not
687 * a multicast address, and is not FF:FF:FF:FF:FF:FF.
688 *
689 * Return true if the address is valid.
690 */
Remy Bohmerdf063442009-07-29 18:18:43 +0200691static inline int is_valid_ether_addr(const u8 *addr)
Mike Frysinger2a02f5c2009-01-27 16:53:39 -0500692{
693 /* FF:FF:FF:FF:FF:FF is a multicast address so we don't need to
694 * explicitly check for it here. */
695 return !is_multicast_ether_addr(addr) && !is_zero_ether_addr(addr);
696}
697
Masahiro Yamada0b16e652014-04-18 19:09:48 +0900698/**
699 * eth_random_addr - Generate software assigned random Ethernet address
700 * @addr: Pointer to a six-byte array containing the Ethernet address
701 *
702 * Generate a random Ethernet address (MAC) that is not multicast
703 * and has the local assigned bit set.
704 */
705static inline void eth_random_addr(uchar *addr)
706{
707 int i;
708 unsigned int seed = get_timer(0);
709
710 for (i = 0; i < 6; i++)
711 addr[i] = rand_r(&seed);
712
713 addr[0] &= 0xfe; /* clear multicast bit */
714 addr[0] |= 0x02; /* set local assignment bit (IEEE802) */
715}
716
wdenk2d966952002-10-31 22:12:35 +0000717/* Convert an IP address to a string */
Joe Hershbergerb79dda32015-03-22 17:09:02 -0500718void ip_to_string(IPaddr_t x, char *s);
wdenk2d966952002-10-31 22:12:35 +0000719
wdenke6466f62003-06-05 19:27:42 +0000720/* Convert a string to ip address */
Joe Hershbergerb79dda32015-03-22 17:09:02 -0500721IPaddr_t string_to_ip(const char *s);
wdenke6466f62003-06-05 19:27:42 +0000722
wdenk145d2c12004-04-15 21:48:45 +0000723/* Convert a VLAN id to a string */
Joe Hershbergerb79dda32015-03-22 17:09:02 -0500724void VLAN_to_string(ushort x, char *s);
wdenk145d2c12004-04-15 21:48:45 +0000725
726/* Convert a string to a vlan id */
Joe Hershbergerb79dda32015-03-22 17:09:02 -0500727ushort string_to_VLAN(const char *s);
wdenk145d2c12004-04-15 21:48:45 +0000728
wdenk145d2c12004-04-15 21:48:45 +0000729/* read a VLAN id from an environment variable */
Joe Hershbergerb79dda32015-03-22 17:09:02 -0500730ushort getenv_VLAN(char *);
wdenk145d2c12004-04-15 21:48:45 +0000731
wdenk2d966952002-10-31 22:12:35 +0000732/* copy a filename (allow for "..." notation, limit length) */
Joe Hershbergerb79dda32015-03-22 17:09:02 -0500733void copy_filename(char *dst, const char *src, int size);
wdenk2d966952002-10-31 22:12:35 +0000734
Mike Frysinger59cb1e72009-09-02 04:18:55 -0400735/* get a random source port */
Joe Hershbergerb79dda32015-03-22 17:09:02 -0500736unsigned int random_port(void);
Mike Frysinger59cb1e72009-09-02 04:18:55 -0400737
Simon Glassd1892ac2013-05-15 06:23:54 +0000738/* Update U-Boot over TFTP */
Joe Hershbergerb79dda32015-03-22 17:09:02 -0500739int update_tftp(ulong addr);
Simon Glassd1892ac2013-05-15 06:23:54 +0000740
wdenk2d966952002-10-31 22:12:35 +0000741/**********************************************************************/
742
743#endif /* __NET_H__ */