blob: 237c932be3341350f235c4debf9999ec5d487343 [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
Andy Flemingecfb9872009-02-11 15:10:31 -0600100extern int eth_initialize(bd_t *bis); /* Initialize network subsystem */
101extern int eth_register(struct eth_device* dev);/* Register network device */
Vincent Palatin451be502012-01-09 08:32:36 +0000102extern int eth_unregister(struct eth_device *dev);/* Remove network device */
Andy Flemingecfb9872009-02-11 15:10:31 -0600103extern void eth_try_another(int first_restart); /* Change the device */
Andy Flemingecfb9872009-02-11 15:10:31 -0600104extern void eth_set_current(void); /* set nterface to ethcur var */
Kim Phillips40c2c032012-10-29 13:34:33 +0000105
Joe Hershberger9f374062012-08-03 10:59:08 +0000106/* get the current device MAC */
Kim Phillips40c2c032012-10-29 13:34:33 +0000107extern struct eth_device *eth_current;
108
Joe Hershberger9f374062012-08-03 10:59:08 +0000109static inline __attribute__((always_inline))
110struct eth_device *eth_get_dev(void)
111{
Joe Hershberger9f374062012-08-03 10:59:08 +0000112 return eth_current;
113}
Ben Warren97824d62010-07-29 12:56:11 -0700114extern struct eth_device *eth_get_dev_by_name(const char *devname);
Andy Flemingecfb9872009-02-11 15:10:31 -0600115extern struct eth_device *eth_get_dev_by_index(int index); /* get dev @ index */
Joe Hershberger290549f2012-05-15 08:59:05 +0000116extern int eth_get_dev_index(void); /* get the device index */
Mike Frysingerc34319c2009-01-29 19:43:44 -0500117extern void eth_parse_enetaddr(const char *addr, uchar *enetaddr);
118extern int eth_getenv_enetaddr(char *name, uchar *enetaddr);
119extern int eth_setenv_enetaddr(char *name, const uchar *enetaddr);
Simon Glass62b36c92011-06-13 16:13:10 -0700120
121/*
122 * Get the hardware address for an ethernet interface .
123 * Args:
124 * base_name - base name for device (normally "eth")
125 * index - device index number (0 for first)
126 * enetaddr - returns 6 byte hardware address
127 * Returns:
128 * Return true if the address is valid.
129 */
130extern int eth_getenv_enetaddr_by_index(const char *base_name, int index,
131 uchar *enetaddr);
wdenk2d966952002-10-31 22:12:35 +0000132
Remy Bohmerdf063442009-07-29 18:18:43 +0200133extern int usb_eth_initialize(bd_t *bi);
Andy Flemingecfb9872009-02-11 15:10:31 -0600134extern int eth_init(bd_t *bis); /* Initialize the device */
Joe Hershberger4b7747e2012-05-15 08:59:04 +0000135extern int eth_send(void *packet, int length); /* Send a packet */
Remy Bohmerdf063442009-07-29 18:18:43 +0200136
Rafal Jaworowski1f2c9a42007-12-27 18:19:02 +0100137#ifdef CONFIG_API
Joe Hershberger4b7747e2012-05-15 08:59:04 +0000138extern int eth_receive(void *packet, int length); /* Receive a packet*/
139extern void (*push_packet)(void *packet, int length);
Rafal Jaworowski1f2c9a42007-12-27 18:19:02 +0100140#endif
Andy Flemingecfb9872009-02-11 15:10:31 -0600141extern int eth_rx(void); /* Check for received packets */
142extern void eth_halt(void); /* stop SCC */
143extern char *eth_get_name(void); /* get name of current device */
wdenk2d966952002-10-31 22:12:35 +0000144
Joe Hershberger9f374062012-08-03 10:59:08 +0000145/* Set active state */
146static inline __attribute__((always_inline)) int eth_init_state_only(bd_t *bis)
147{
148 eth_get_dev()->state = ETH_STATE_ACTIVE;
149
150 return 0;
151}
152/* Set passive state */
153static inline __attribute__((always_inline)) void eth_halt_state_only(void)
154{
155 eth_get_dev()->state = ETH_STATE_PASSIVE;
156}
157
Simon Glass62b36c92011-06-13 16:13:10 -0700158/*
159 * Set the hardware address for an ethernet interface based on 'eth%daddr'
160 * environment variable (or just 'ethaddr' if eth_number is 0).
161 * Args:
162 * base_name - base name for device (normally "eth")
163 * eth_number - value of %d (0 for first device of this type)
164 * Returns:
165 * 0 is success, non-zero is error status from driver.
166 */
167int eth_write_hwaddr(struct eth_device *dev, const char *base_name,
168 int eth_number);
169
David Updegraff7280da72007-06-11 10:41:07 -0500170#ifdef CONFIG_MCAST_TFTP
Joe Hershberger290549f2012-05-15 08:59:05 +0000171int eth_mcast_join(IPaddr_t mcast_addr, u8 join);
172u32 ether_crc(size_t len, unsigned char const *p);
David Updegraff7280da72007-06-11 10:41:07 -0500173#endif
174
wdenk2d966952002-10-31 22:12:35 +0000175
176/**********************************************************************/
177/*
178 * Protocol headers.
179 */
180
181/*
182 * Ethernet header
183 */
Joe Hershberger1178f412012-05-23 07:58:06 +0000184
185struct ethernet_hdr {
186 uchar et_dest[6]; /* Destination node */
187 uchar et_src[6]; /* Source node */
188 ushort et_protlen; /* Protocol or length */
189};
190
191/* Ethernet header size */
192#define ETHER_HDR_SIZE (sizeof(struct ethernet_hdr))
193
Bin Mengb1a5e1f2015-03-20 17:12:18 +0800194#define ETH_FCS_LEN 4 /* Octets in the FCS */
195
Joe Hershberger1178f412012-05-23 07:58:06 +0000196struct e802_hdr {
wdenk2d966952002-10-31 22:12:35 +0000197 uchar et_dest[6]; /* Destination node */
198 uchar et_src[6]; /* Source node */
199 ushort et_protlen; /* Protocol or length */
200 uchar et_dsap; /* 802 DSAP */
201 uchar et_ssap; /* 802 SSAP */
202 uchar et_ctl; /* 802 control */
203 uchar et_snap1; /* SNAP */
204 uchar et_snap2;
205 uchar et_snap3;
206 ushort et_prot; /* 802 protocol */
Joe Hershberger1178f412012-05-23 07:58:06 +0000207};
wdenk2d966952002-10-31 22:12:35 +0000208
Joe Hershbergerc17fa982012-05-23 07:58:11 +0000209/* 802 + SNAP + ethernet header size */
Joe Hershberger1178f412012-05-23 07:58:06 +0000210#define E802_HDR_SIZE (sizeof(struct e802_hdr))
wdenk145d2c12004-04-15 21:48:45 +0000211
212/*
Joe Hershbergerc17fa982012-05-23 07:58:11 +0000213 * Virtual LAN Ethernet header
wdenk145d2c12004-04-15 21:48:45 +0000214 */
Joe Hershbergerb43784c2012-05-23 07:58:07 +0000215struct vlan_ethernet_hdr {
wdenk145d2c12004-04-15 21:48:45 +0000216 uchar vet_dest[6]; /* Destination node */
217 uchar vet_src[6]; /* Source node */
218 ushort vet_vlan_type; /* PROT_VLAN */
219 ushort vet_tag; /* TAG of VLAN */
220 ushort vet_type; /* protocol type */
Joe Hershbergerb43784c2012-05-23 07:58:07 +0000221};
wdenk145d2c12004-04-15 21:48:45 +0000222
Joe Hershbergerb43784c2012-05-23 07:58:07 +0000223/* VLAN Ethernet header size */
224#define VLAN_ETHER_HDR_SIZE (sizeof(struct vlan_ethernet_hdr))
wdenk145d2c12004-04-15 21:48:45 +0000225
wdenk2d966952002-10-31 22:12:35 +0000226#define PROT_IP 0x0800 /* IP protocol */
227#define PROT_ARP 0x0806 /* IP ARP protocol */
228#define PROT_RARP 0x8035 /* IP ARP protocol */
wdenk145d2c12004-04-15 21:48:45 +0000229#define PROT_VLAN 0x8100 /* IEEE 802.1q protocol */
wdenk2d966952002-10-31 22:12:35 +0000230
231#define IPPROTO_ICMP 1 /* Internet Control Message Protocol */
232#define IPPROTO_UDP 17 /* User Datagram Protocol */
233
234/*
Joe Hershbergerc686fa12012-05-23 07:58:05 +0000235 * Internet Protocol (IP) header.
wdenk2d966952002-10-31 22:12:35 +0000236 */
Joe Hershbergerc686fa12012-05-23 07:58:05 +0000237struct ip_hdr {
wdenk2d966952002-10-31 22:12:35 +0000238 uchar ip_hl_v; /* header length and version */
239 uchar ip_tos; /* type of service */
240 ushort ip_len; /* total length */
241 ushort ip_id; /* identification */
242 ushort ip_off; /* fragment offset field */
243 uchar ip_ttl; /* time to live */
244 uchar ip_p; /* protocol */
245 ushort ip_sum; /* checksum */
246 IPaddr_t ip_src; /* Source IP address */
247 IPaddr_t ip_dst; /* Destination IP address */
Joe Hershberger6fe8b452012-05-23 07:58:04 +0000248};
wdenk2d966952002-10-31 22:12:35 +0000249
Peter Tyser0885bf02008-12-01 16:26:20 -0600250#define IP_OFFS 0x1fff /* ip offset *= 8 */
251#define IP_FLAGS 0xe000 /* first 3 bits */
252#define IP_FLAGS_RES 0x8000 /* reserved */
253#define IP_FLAGS_DFRAG 0x4000 /* don't fragments */
254#define IP_FLAGS_MFRAG 0x2000 /* more fragments */
255
Joe Hershbergerc686fa12012-05-23 07:58:05 +0000256#define IP_HDR_SIZE (sizeof(struct ip_hdr))
257
258/*
259 * Internet Protocol (IP) + UDP header.
260 */
261struct ip_udp_hdr {
262 uchar ip_hl_v; /* header length and version */
263 uchar ip_tos; /* type of service */
264 ushort ip_len; /* total length */
265 ushort ip_id; /* identification */
266 ushort ip_off; /* fragment offset field */
267 uchar ip_ttl; /* time to live */
268 uchar ip_p; /* protocol */
269 ushort ip_sum; /* checksum */
270 IPaddr_t ip_src; /* Source IP address */
271 IPaddr_t ip_dst; /* Destination IP address */
272 ushort udp_src; /* UDP source port */
273 ushort udp_dst; /* UDP destination port */
274 ushort udp_len; /* Length of UDP packet */
275 ushort udp_xsum; /* Checksum */
276};
wdenk2d966952002-10-31 22:12:35 +0000277
Joe Hershberger6fe8b452012-05-23 07:58:04 +0000278#define IP_UDP_HDR_SIZE (sizeof(struct ip_udp_hdr))
Joe Hershbergerc686fa12012-05-23 07:58:05 +0000279#define UDP_HDR_SIZE (IP_UDP_HDR_SIZE - IP_HDR_SIZE)
wdenk2d966952002-10-31 22:12:35 +0000280
281/*
282 * Address Resolution Protocol (ARP) header.
283 */
Joe Hershbergerde15d0932012-05-23 07:58:08 +0000284struct arp_hdr {
wdenk2d966952002-10-31 22:12:35 +0000285 ushort ar_hrd; /* Format of hardware address */
286# define ARP_ETHER 1 /* Ethernet hardware address */
287 ushort ar_pro; /* Format of protocol address */
288 uchar ar_hln; /* Length of hardware address */
Joe Hershberger2f787492012-05-23 07:58:17 +0000289# define ARP_HLEN 6
wdenk2d966952002-10-31 22:12:35 +0000290 uchar ar_pln; /* Length of protocol address */
Joe Hershberger2f787492012-05-23 07:58:17 +0000291# define ARP_PLEN 4
wdenk2d966952002-10-31 22:12:35 +0000292 ushort ar_op; /* Operation */
293# define ARPOP_REQUEST 1 /* Request to resolve address */
294# define ARPOP_REPLY 2 /* Response to previous request */
295
296# define RARPOP_REQUEST 3 /* Request to resolve address */
297# define RARPOP_REPLY 4 /* Response to previous request */
298
299 /*
wdenk57b2d802003-06-27 21:31:46 +0000300 * The remaining fields are variable in size, according to
301 * the sizes above, and are defined as appropriate for
302 * specific hardware/protocol combinations.
wdenk2d966952002-10-31 22:12:35 +0000303 */
304 uchar ar_data[0];
Joe Hershberger2f787492012-05-23 07:58:17 +0000305#define ar_sha ar_data[0]
306#define ar_spa ar_data[ARP_HLEN]
307#define ar_tha ar_data[ARP_HLEN + ARP_PLEN]
308#define ar_tpa ar_data[ARP_HLEN + ARP_PLEN + ARP_HLEN]
wdenk2d966952002-10-31 22:12:35 +0000309#if 0
310 uchar ar_sha[]; /* Sender hardware address */
311 uchar ar_spa[]; /* Sender protocol address */
312 uchar ar_tha[]; /* Target hardware address */
313 uchar ar_tpa[]; /* Target protocol address */
314#endif /* 0 */
Joe Hershbergerde15d0932012-05-23 07:58:08 +0000315};
wdenk2d966952002-10-31 22:12:35 +0000316
317#define ARP_HDR_SIZE (8+20) /* Size assuming ethernet */
318
319/*
320 * ICMP stuff (just enough to handle (host) redirect messages)
321 */
Wolfgang Denka1be4762008-05-20 16:00:29 +0200322#define ICMP_ECHO_REPLY 0 /* Echo reply */
Simon Glass230467c2011-10-24 18:00:01 +0000323#define ICMP_NOT_REACH 3 /* Detination unreachable */
wdenk2d966952002-10-31 22:12:35 +0000324#define ICMP_REDIRECT 5 /* Redirect (change route) */
wdenke6466f62003-06-05 19:27:42 +0000325#define ICMP_ECHO_REQUEST 8 /* Echo request */
wdenk2d966952002-10-31 22:12:35 +0000326
327/* Codes for REDIRECT. */
328#define ICMP_REDIR_NET 0 /* Redirect Net */
329#define ICMP_REDIR_HOST 1 /* Redirect Host */
330
Simon Glass230467c2011-10-24 18:00:01 +0000331/* Codes for NOT_REACH */
332#define ICMP_NOT_REACH_PORT 3 /* Port unreachable */
333
Joe Hershberger78495612012-05-23 07:58:09 +0000334struct icmp_hdr {
wdenk2d966952002-10-31 22:12:35 +0000335 uchar type;
336 uchar code;
337 ushort checksum;
338 union {
339 struct {
340 ushort id;
341 ushort sequence;
342 } echo;
343 ulong gateway;
344 struct {
Jeroen Hofstee9a1ad002013-08-10 16:52:47 +0200345 ushort unused;
wdenk2d966952002-10-31 22:12:35 +0000346 ushort mtu;
347 } frag;
Simon Glass230467c2011-10-24 18:00:01 +0000348 uchar data[0];
wdenk2d966952002-10-31 22:12:35 +0000349 } un;
Joe Hershberger78495612012-05-23 07:58:09 +0000350};
wdenk2d966952002-10-31 22:12:35 +0000351
Joe Hershberger78495612012-05-23 07:58:09 +0000352#define ICMP_HDR_SIZE (sizeof(struct icmp_hdr))
353#define IP_ICMP_HDR_SIZE (IP_HDR_SIZE + ICMP_HDR_SIZE)
wdenk2d966952002-10-31 22:12:35 +0000354
wdenk2d966952002-10-31 22:12:35 +0000355/*
356 * Maximum packet size; used to allocate packet storage.
357 * TFTP packets can be 524 bytes + IP header + ethernet header.
358 * Lets be conservative, and go for 38 * 16. (Must also be
359 * a multiple of 32 bytes).
360 */
361/*
362 * AS.HARNOIS : Better to set PKTSIZE to maximum size because
363 * traffic type is not always controlled
364 * maximum packet size = 1518
365 * maximum packet size and multiple of 32 bytes = 1536
366 */
367#define PKTSIZE 1518
368#define PKTSIZE_ALIGN 1536
369/*#define PKTSIZE 608*/
370
371/*
372 * Maximum receive ring size; that is, the number of packets
373 * we can buffer before overflow happens. Basically, this just
374 * needs to be enough to prevent a packet being discarded while
375 * we are processing the previous one.
376 */
377#define RINGSZ 4
378#define RINGSZ_LOG2 2
379
380/**********************************************************************/
381/*
382 * Globals.
383 *
384 * Note:
385 *
386 * All variables of type IPaddr_t are stored in NETWORK byte order
387 * (big endian).
388 */
389
390/* net.c */
391/** BOOTP EXTENTIONS **/
Joe Hershberger290549f2012-05-15 08:59:05 +0000392extern IPaddr_t NetOurGatewayIP; /* Our gateway IP address */
393extern IPaddr_t NetOurSubnetMask; /* Our subnet mask (0 = unknown) */
394extern IPaddr_t NetOurDNSIP; /* Our Domain Name Server (0 = unknown) */
Jon Loeliger5336a762007-07-09 22:08:34 -0500395#if defined(CONFIG_BOOTP_DNS2)
Joe Hershberger290549f2012-05-15 08:59:05 +0000396extern IPaddr_t NetOurDNS2IP; /* Our 2nd Domain Name Server (0 = unknown) */
stroesee0aadfb2003-08-28 14:17:32 +0000397#endif
Joe Hershberger290549f2012-05-15 08:59:05 +0000398extern char NetOurNISDomain[32]; /* Our NIS domain */
399extern char NetOurHostName[32]; /* Our hostname */
400extern char NetOurRootPath[64]; /* Our root path */
401extern ushort NetBootFileSize; /* Our boot file size in blocks */
wdenk2d966952002-10-31 22:12:35 +0000402/** END OF BOOTP EXTENTIONS **/
Joe Hershberger290549f2012-05-15 08:59:05 +0000403extern ulong NetBootFileXferSize; /* size of bootfile in bytes */
404extern uchar NetOurEther[6]; /* Our ethernet address */
405extern uchar NetServerEther[6]; /* Boot server enet address */
406extern IPaddr_t NetOurIP; /* Our IP addr (0 = unknown) */
407extern IPaddr_t NetServerIP; /* Server IP addr (0 = unknown) */
Joe Hershberger4b7747e2012-05-15 08:59:04 +0000408extern uchar *NetTxPacket; /* THE transmit packet */
Joe Hershberger290549f2012-05-15 08:59:05 +0000409extern uchar *NetRxPackets[PKTBUFSRX]; /* Receive packets */
Joe Hershberger4b7747e2012-05-15 08:59:04 +0000410extern uchar *NetRxPacket; /* Current receive packet */
Joe Hershberger290549f2012-05-15 08:59:05 +0000411extern int NetRxPacketLen; /* Current rx packet length */
412extern unsigned NetIPID; /* IP ID (counting) */
413extern uchar NetBcastAddr[6]; /* Ethernet boardcast address */
wdenkb8fb6192004-08-02 21:11:11 +0000414extern uchar NetEtherNullAddr[6];
wdenk2d966952002-10-31 22:12:35 +0000415
Joe Hershberger290549f2012-05-15 08:59:05 +0000416#define VLAN_NONE 4095 /* untagged */
417#define VLAN_IDMASK 0x0fff /* mask of valid vlan id */
418extern ushort NetOurVLAN; /* Our VLAN */
419extern ushort NetOurNativeVLAN; /* Our Native VLAN */
wdenk145d2c12004-04-15 21:48:45 +0000420
Joe Hershberger290549f2012-05-15 08:59:05 +0000421extern int NetRestartWrap; /* Tried all network devices */
wdenk2d966952002-10-31 22:12:35 +0000422
Simon Glassd6c5f552011-10-24 18:00:02 +0000423enum proto_t {
424 BOOTP, RARP, ARP, TFTPGET, DHCP, PING, DNS, NFS, CDP, NETCONS, SNTP,
Joe Hershbergerb35a3a62012-05-23 08:00:12 +0000425 TFTPSRV, TFTPPUT, LINKLOCAL
Simon Glassd6c5f552011-10-24 18:00:02 +0000426};
wdenk2d966952002-10-31 22:12:35 +0000427
428/* from net/net.c */
Joe Hershberger290549f2012-05-15 08:59:05 +0000429extern char BootFile[128]; /* Boot File name */
wdenk2d966952002-10-31 22:12:35 +0000430
Robin Getz82f0d232009-07-20 14:53:54 -0400431#if defined(CONFIG_CMD_DNS)
432extern char *NetDNSResolve; /* The host to resolve */
433extern char *NetDNSenvvar; /* the env var to put the ip into */
434#endif
435
Jon Loeliger2517d972007-07-09 17:15:49 -0500436#if defined(CONFIG_CMD_PING)
Joe Hershberger290549f2012-05-15 08:59:05 +0000437extern IPaddr_t NetPingIP; /* the ip address to ping */
wdenke6466f62003-06-05 19:27:42 +0000438#endif
439
Jon Loeliger2517d972007-07-09 17:15:49 -0500440#if defined(CONFIG_CMD_CDP)
wdenk145d2c12004-04-15 21:48:45 +0000441/* when CDP completes these hold the return values */
Joe Hershbergera4215b02012-05-23 07:57:59 +0000442extern ushort CDPNativeVLAN; /* CDP returned native VLAN */
443extern ushort CDPApplianceVLAN; /* CDP returned appliance VLAN */
Joe Hershberger00c62a82012-05-23 07:58:00 +0000444
445/*
446 * Check for a CDP packet by examining the received MAC address field
447 */
448static inline int is_cdp_packet(const uchar *et_addr)
449{
450 extern const uchar NetCDPAddr[6];
451
452 return memcmp(et_addr, NetCDPAddr, 6) == 0;
453}
wdenk145d2c12004-04-15 21:48:45 +0000454#endif
455
Jon Loeliger2517d972007-07-09 17:15:49 -0500456#if defined(CONFIG_CMD_SNTP)
Joe Hershberger290549f2012-05-15 08:59:05 +0000457extern IPaddr_t NetNtpServerIP; /* the ip address to NTP */
458extern int NetTimeOffset; /* offset time from UTC */
wdenkb4ad9622005-04-01 00:25:43 +0000459#endif
460
Joe Hershberger3a29e5a2012-05-15 08:59:12 +0000461#if defined(CONFIG_MCAST_TFTP)
462extern IPaddr_t Mcast_addr;
463#endif
464
wdenk2d966952002-10-31 22:12:35 +0000465/* Initialize the network adapter */
Joe Hershberger017e5c42012-05-23 07:59:22 +0000466extern void net_init(void);
Simon Glassd6c5f552011-10-24 18:00:02 +0000467extern int NetLoop(enum proto_t);
wdenk2d966952002-10-31 22:12:35 +0000468
469/* Shutdown adapters and cleanup */
470extern void NetStop(void);
471
472/* Load failed. Start again. */
473extern void NetStartAgain(void);
474
wdenk145d2c12004-04-15 21:48:45 +0000475/* Get size of the ethernet header when we send */
Wolfgang Denka1be4762008-05-20 16:00:29 +0200476extern int NetEthHdrSize(void);
wdenk145d2c12004-04-15 21:48:45 +0000477
478/* Set ethernet header; returns the size of the header */
Joe Hershberger4b7747e2012-05-15 08:59:04 +0000479extern int NetSetEther(uchar *, uchar *, uint);
Joe Hershberger530cd6b2012-05-23 07:59:16 +0000480extern int net_update_ether(struct ethernet_hdr *et, uchar *addr, uint prot);
wdenk2d966952002-10-31 22:12:35 +0000481
482/* Set IP header */
Joe Hershberger2ed5b492012-05-23 07:59:07 +0000483extern void net_set_ip_header(uchar *pkt, IPaddr_t dest, IPaddr_t source);
484extern void net_set_udp_header(uchar *pkt, IPaddr_t dest, int dport,
485 int sport, int len);
wdenk2d966952002-10-31 22:12:35 +0000486
Simon Glass00153912015-01-19 22:16:07 -0700487/**
488 * compute_ip_checksum() - Compute IP checksum
489 *
490 * @addr: Address to check (must be 16-bit aligned)
491 * @nbytes: Number of bytes to check (normally a multiple of 2)
492 * @return 16-bit IP checksum
493 */
494unsigned compute_ip_checksum(const void *addr, unsigned nbytes);
495
496/**
497 * add_ip_checksums() - add two IP checksums
498 *
499 * @offset: Offset of first sum (if odd we do a byte-swap)
500 * @sum: First checksum
501 * @new_sum: New checksum to add
502 * @return updated 16-bit IP checksum
503 */
504unsigned add_ip_checksums(unsigned offset, unsigned sum, unsigned new_sum);
505
506/**
507 * ip_checksum_ok() - check if a checksum is correct
508 *
509 * This works by making sure the checksum sums to 0
510 *
511 * @addr: Address to check (must be 16-bit aligned)
512 * @nbytes: Number of bytes to check (normally a multiple of 2)
513 * @return true if the checksum matches, false if not
514 */
515int ip_checksum_ok(const void *addr, unsigned nbytes);
516
Joe Hershbergeraae05082012-05-23 07:58:01 +0000517/* Callbacks */
Joe Hershbergerf50357b2012-05-23 07:59:15 +0000518extern rxhand_f *net_get_udp_handler(void); /* Get UDP RX packet handler */
519extern void net_set_udp_handler(rxhand_f *); /* Set UDP RX packet handler */
520extern rxhand_f *net_get_arp_handler(void); /* Get ARP RX packet handler */
521extern void net_set_arp_handler(rxhand_f *); /* Set ARP RX packet handler */
Simon Glass230467c2011-10-24 18:00:01 +0000522extern void net_set_icmp_handler(rxhand_icmp_f *f); /* Set ICMP RX handler */
Joe Hershberger290549f2012-05-15 08:59:05 +0000523extern void NetSetTimeout(ulong, thand_f *);/* Set timeout handler */
wdenk2d966952002-10-31 22:12:35 +0000524
Joe Hershbergerd4bb76a2012-05-23 07:59:14 +0000525/* Network loop state */
526enum net_loop_state {
527 NETLOOP_CONTINUE,
528 NETLOOP_RESTART,
529 NETLOOP_SUCCESS,
530 NETLOOP_FAIL
531};
Kim Phillips40c2c032012-10-29 13:34:33 +0000532extern enum net_loop_state net_state;
533
Joe Hershbergerd4bb76a2012-05-23 07:59:14 +0000534static inline void net_set_state(enum net_loop_state state)
535{
Joe Hershberger05a377b2012-05-23 08:01:04 +0000536 debug_cond(DEBUG_INT_STATE, "--- NetState set to %d\n", state);
Joe Hershbergerd4bb76a2012-05-23 07:59:14 +0000537 net_state = state;
538}
539
Joe Hershbergerde8205a2012-05-23 07:59:24 +0000540/* Transmit a packet */
Joe Hershbergerebe3ca82012-05-23 07:59:13 +0000541static inline void NetSendPacket(uchar *pkt, int len)
542{
543 (void) eth_send(pkt, len);
544}
wdenk2d966952002-10-31 22:12:35 +0000545
Joe Hershberger1a6b8d82012-05-23 07:58:10 +0000546/*
Joe Hershbergerde8205a2012-05-23 07:59:24 +0000547 * Transmit "NetTxPacket" as UDP packet, performing ARP request if needed
Joe Hershbergerf50357b2012-05-23 07:59:15 +0000548 * (ether will be populated)
Joe Hershberger1a6b8d82012-05-23 07:58:10 +0000549 *
550 * @param ether Raw packet buffer
551 * @param dest IP address to send the datagram to
552 * @param dport Destination UDP port
553 * @param sport Source UDP port
554 * @param payload_len Length of data after the UDP header
555 */
Joe Hershbergerde8205a2012-05-23 07:59:24 +0000556extern int NetSendUDPPacket(uchar *ether, IPaddr_t dest, int dport,
Joe Hershberger1a6b8d82012-05-23 07:58:10 +0000557 int sport, int payload_len);
wdenke6466f62003-06-05 19:27:42 +0000558
wdenk2d966952002-10-31 22:12:35 +0000559/* Processes a received packet */
Joe Hershberger4b7747e2012-05-15 08:59:04 +0000560extern void NetReceive(uchar *, int);
wdenk2d966952002-10-31 22:12:35 +0000561
Joe Hershberger77001b432012-05-15 08:59:08 +0000562#ifdef CONFIG_NETCONSOLE
563void NcStart(void);
Joe Hershberger58cd2182012-09-18 10:01:32 +0000564int nc_input_packet(uchar *pkt, IPaddr_t src_ip, unsigned dest_port,
565 unsigned src_port, unsigned len);
Joe Hershberger77001b432012-05-15 08:59:08 +0000566#endif
567
Joe Hershberger9f374062012-08-03 10:59:08 +0000568static inline __attribute__((always_inline)) int eth_is_on_demand_init(void)
569{
570#ifdef CONFIG_NETCONSOLE
571 extern enum proto_t net_loop_last_protocol;
572
573 return net_loop_last_protocol != NETCONS;
574#else
575 return 1;
576#endif
577}
578
579static inline void eth_set_last_protocol(int protocol)
580{
581#ifdef CONFIG_NETCONSOLE
582 extern enum proto_t net_loop_last_protocol;
583
584 net_loop_last_protocol = protocol;
585#endif
586}
587
wdenk2d966952002-10-31 22:12:35 +0000588/*
Simon Glass5234ad12011-10-27 06:24:32 +0000589 * Check if autoload is enabled. If so, use either NFS or TFTP to download
590 * the boot file.
591 */
592void net_auto_load(void);
593
594/*
wdenk2d966952002-10-31 22:12:35 +0000595 * The following functions are a bit ugly, but necessary to deal with
596 * alignment restrictions on ARM.
597 *
598 * We're using inline functions, which had the smallest memory
599 * footprint in our tests.
600 */
601/* return IP *in network byteorder* */
Joe Hershberger4b7747e2012-05-15 08:59:04 +0000602static inline IPaddr_t NetReadIP(void *from)
wdenk2d966952002-10-31 22:12:35 +0000603{
604 IPaddr_t ip;
Joe Hershberger290549f2012-05-15 08:59:05 +0000605
606 memcpy((void *)&ip, (void *)from, sizeof(ip));
wdenk2d966952002-10-31 22:12:35 +0000607 return ip;
608}
609
610/* return ulong *in network byteorder* */
611static inline ulong NetReadLong(ulong *from)
612{
613 ulong l;
Joe Hershberger290549f2012-05-15 08:59:05 +0000614
615 memcpy((void *)&l, (void *)from, sizeof(l));
wdenk2d966952002-10-31 22:12:35 +0000616 return l;
617}
618
619/* write IP *in network byteorder* */
620static inline void NetWriteIP(void *to, IPaddr_t ip)
621{
Joe Hershberger290549f2012-05-15 08:59:05 +0000622 memcpy(to, (void *)&ip, sizeof(ip));
wdenk2d966952002-10-31 22:12:35 +0000623}
624
625/* copy IP */
Joe Hershberger4b7747e2012-05-15 08:59:04 +0000626static inline void NetCopyIP(void *to, void *from)
wdenk2d966952002-10-31 22:12:35 +0000627{
Joe Hershberger290549f2012-05-15 08:59:05 +0000628 memcpy((void *)to, from, sizeof(IPaddr_t));
wdenk2d966952002-10-31 22:12:35 +0000629}
630
631/* copy ulong */
632static inline void NetCopyLong(ulong *to, ulong *from)
633{
Joe Hershberger290549f2012-05-15 08:59:05 +0000634 memcpy((void *)to, (void *)from, sizeof(ulong));
wdenk2d966952002-10-31 22:12:35 +0000635}
636
Mike Rapoporte54d6c12007-08-12 08:48:27 +0300637/**
638 * is_zero_ether_addr - Determine if give Ethernet address is all zeros.
639 * @addr: Pointer to a six-byte array containing the Ethernet address
640 *
641 * Return true if the address is all zeroes.
642 */
643static inline int is_zero_ether_addr(const u8 *addr)
644{
645 return !(addr[0] | addr[1] | addr[2] | addr[3] | addr[4] | addr[5]);
646}
647
648/**
649 * is_multicast_ether_addr - Determine if the Ethernet address is a multicast.
650 * @addr: Pointer to a six-byte array containing the Ethernet address
651 *
652 * Return true if the address is a multicast address.
653 * By definition the broadcast address is also a multicast address.
654 */
655static inline int is_multicast_ether_addr(const u8 *addr)
656{
Joe Hershberger290549f2012-05-15 08:59:05 +0000657 return 0x01 & addr[0];
Mike Rapoporte54d6c12007-08-12 08:48:27 +0300658}
659
Remy Bohmerdf063442009-07-29 18:18:43 +0200660/*
661 * is_broadcast_ether_addr - Determine if the Ethernet address is broadcast
662 * @addr: Pointer to a six-byte array containing the Ethernet address
663 *
664 * Return true if the address is the broadcast address.
665 */
666static inline int is_broadcast_ether_addr(const u8 *addr)
667{
Joe Hershberger290549f2012-05-15 08:59:05 +0000668 return (addr[0] & addr[1] & addr[2] & addr[3] & addr[4] & addr[5]) ==
669 0xff;
Remy Bohmerdf063442009-07-29 18:18:43 +0200670}
671
672/*
Mike Frysinger2a02f5c2009-01-27 16:53:39 -0500673 * is_valid_ether_addr - Determine if the given Ethernet address is valid
674 * @addr: Pointer to a six-byte array containing the Ethernet address
675 *
676 * Check that the Ethernet address (MAC) is not 00:00:00:00:00:00, is not
677 * a multicast address, and is not FF:FF:FF:FF:FF:FF.
678 *
679 * Return true if the address is valid.
680 */
Remy Bohmerdf063442009-07-29 18:18:43 +0200681static inline int is_valid_ether_addr(const u8 *addr)
Mike Frysinger2a02f5c2009-01-27 16:53:39 -0500682{
683 /* FF:FF:FF:FF:FF:FF is a multicast address so we don't need to
684 * explicitly check for it here. */
685 return !is_multicast_ether_addr(addr) && !is_zero_ether_addr(addr);
686}
687
Masahiro Yamada0b16e652014-04-18 19:09:48 +0900688/**
689 * eth_random_addr - Generate software assigned random Ethernet address
690 * @addr: Pointer to a six-byte array containing the Ethernet address
691 *
692 * Generate a random Ethernet address (MAC) that is not multicast
693 * and has the local assigned bit set.
694 */
695static inline void eth_random_addr(uchar *addr)
696{
697 int i;
698 unsigned int seed = get_timer(0);
699
700 for (i = 0; i < 6; i++)
701 addr[i] = rand_r(&seed);
702
703 addr[0] &= 0xfe; /* clear multicast bit */
704 addr[0] |= 0x02; /* set local assignment bit (IEEE802) */
705}
706
wdenk2d966952002-10-31 22:12:35 +0000707/* Convert an IP address to a string */
Joe Hershberger290549f2012-05-15 08:59:05 +0000708extern void ip_to_string(IPaddr_t x, char *s);
wdenk2d966952002-10-31 22:12:35 +0000709
wdenke6466f62003-06-05 19:27:42 +0000710/* Convert a string to ip address */
Mike Frysingerbb1ecce2010-10-20 07:16:58 -0400711extern IPaddr_t string_to_ip(const char *s);
wdenke6466f62003-06-05 19:27:42 +0000712
wdenk145d2c12004-04-15 21:48:45 +0000713/* Convert a VLAN id to a string */
Joe Hershberger290549f2012-05-15 08:59:05 +0000714extern void VLAN_to_string(ushort x, char *s);
wdenk145d2c12004-04-15 21:48:45 +0000715
716/* Convert a string to a vlan id */
Mike Frysinger89c73922010-10-20 07:16:48 -0400717extern ushort string_to_VLAN(const char *s);
wdenk145d2c12004-04-15 21:48:45 +0000718
wdenk145d2c12004-04-15 21:48:45 +0000719/* read a VLAN id from an environment variable */
720extern ushort getenv_VLAN(char *);
721
wdenk2d966952002-10-31 22:12:35 +0000722/* copy a filename (allow for "..." notation, limit length) */
Joe Hershberger290549f2012-05-15 08:59:05 +0000723extern void copy_filename(char *dst, const char *src, int size);
wdenk2d966952002-10-31 22:12:35 +0000724
Mike Frysinger59cb1e72009-09-02 04:18:55 -0400725/* get a random source port */
726extern unsigned int random_port(void);
727
Simon Glassd1892ac2013-05-15 06:23:54 +0000728/* Update U-Boot over TFTP */
729extern int update_tftp(ulong addr);
730
wdenk2d966952002-10-31 22:12:35 +0000731/**********************************************************************/
732
733#endif /* __NET_H__ */