blob: 05800c4422ef7e8d58d5e3844aaa9c26ca80f379 [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 Denk2ea91032014-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
wdenk71f95112003-06-15 22:40:42 +000015#if defined(CONFIG_8xx)
wdenk2d966952002-10-31 22:12:35 +000016#include <commproc.h>
wdenk71f95112003-06-15 22:40:42 +000017#endif /* CONFIG_8xx */
wdenkaacf9a42003-01-17 16:27:01 +000018
Eric Nelson2c4b3c12012-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 Hershberger4ef8d532012-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-VILLARD6d0f6bc2008-10-16 15:01:15 +020033#ifdef CONFIG_SYS_RX_ETH_BUFFER
34# define PKTBUFSRX CONFIG_SYS_RX_ETH_BUFFER
wdenk1d0350e2002-11-11 21:14:20 +000035#else
stroesec6028832003-06-05 15:38:29 +000036# define PKTBUFSRX 4
wdenk1d0350e2002-11-11 21:14:20 +000037#endif
38
Eric Nelson2c4b3c12012-03-15 18:33:24 +000039#define PKTALIGN ARCH_DMA_MINALIGN
wdenk2d966952002-10-31 22:12:35 +000040
Matthias Weisserea45cb02011-12-03 03:29:44 +000041/* IPv4 addresses are always 32 bits in size */
Joe Hershberger049a95a2015-04-08 01:41:01 -050042struct in_addr {
43 __be32 s_addr;
44};
wdenk2d966952002-10-31 22:12:35 +000045
Luca Ceresoli03eb1292011-04-18 06:19:50 +000046/**
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
wdenk2d966952002-10-31 22:12:35 +000053 */
Luca Ceresoli03eb1292011-04-18 06:19:50 +000054typedef void rxhand_f(uchar *pkt, unsigned dport,
Joe Hershberger049a95a2015-04-08 01:41:01 -050055 struct in_addr sip, unsigned sport,
Luca Ceresoli03eb1292011-04-18 06:19:50 +000056 unsigned len);
wdenk2d966952002-10-31 22:12:35 +000057
Simon Glass4793ee62011-10-24 18:00:01 +000058/**
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,
Joe Hershberger049a95a2015-04-08 01:41:01 -050069 struct in_addr sip, unsigned sport, uchar *pkt, unsigned len);
Simon Glass4793ee62011-10-24 18:00:01 +000070
wdenk2d966952002-10-31 22:12:35 +000071/*
72 * A timeout handler. Called after time interval has expired.
73 */
74typedef void thand_f(void);
75
wdenk2d966952002-10-31 22:12:35 +000076enum eth_state_t {
77 ETH_STATE_INIT,
78 ETH_STATE_PASSIVE,
79 ETH_STATE_ACTIVE
80};
81
Joe Hershberger05c3e682015-03-22 17:09:10 -050082#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
Simon Glassc74c8e62015-04-05 16:07:39 -060088 * @phy_interface: PHY interface to use - see PHY_INTERFACE_MODE_...
Alexey Brodkinf74264d2016-01-13 16:59:35 +030089 * @max_speed: Maximum speed of Ethernet connection supported by MAC
Joe Hershberger05c3e682015-03-22 17:09:10 -050090 */
91struct eth_pdata {
92 phys_addr_t iobase;
93 unsigned char enetaddr[6];
Simon Glassc74c8e62015-04-05 16:07:39 -060094 int phy_interface;
Alexey Brodkinf74264d2016-01-13 16:59:35 +030095 int max_speed;
Joe Hershberger05c3e682015-03-22 17:09:10 -050096};
97
Simon Glassa1ca92e2015-07-06 16:47:49 -060098enum eth_recv_flags {
99 /*
100 * Check hardware device for new packets (otherwise only return those
101 * which are already in the memory buffer ready to process)
102 */
103 ETH_RECV_CHECK_DEVICE = 1 << 0,
104};
105
Joe Hershberger05c3e682015-03-22 17:09:10 -0500106/**
107 * struct eth_ops - functions of Ethernet MAC controllers
108 *
109 * start: Prepare the hardware to send and receive packets
110 * send: Send the bytes passed in "packet" as a packet on the wire
Joe Hershberger17591402015-03-22 17:09:12 -0500111 * recv: Check if the hardware received a packet. If so, set the pointer to the
112 * packet buffer in the packetp parameter. If not, return an error or 0 to
Joe Hershberger63c97292015-04-03 20:09:46 -0500113 * indicate that the hardware receive FIFO is empty. If 0 is returned, the
114 * network stack will not process the empty packet, but free_pkt() will be
115 * called if supplied
116 * free_pkt: Give the driver an opportunity to manage its packet buffer memory
117 * when the network stack is finished processing it. This will only be
118 * called when no error was returned from recv - optional
Joe Hershberger05c3e682015-03-22 17:09:10 -0500119 * stop: Stop the hardware from looking for packets - may be called even if
120 * state == PASSIVE
121 * mcast: Join or leave a multicast group (for TFTP) - optional
122 * write_hwaddr: Write a MAC address to the hardware (used to pass it to Linux
123 * on some platforms like ARM). This function expects the
Simon Glassb86f7952015-07-06 16:47:55 -0600124 * eth_pdata::enetaddr field to be populated. The method can
125 * return -ENOSYS to indicate that this is not implemented for
126 this hardware - optional.
Joe Hershberger05c3e682015-03-22 17:09:10 -0500127 * read_rom_hwaddr: Some devices have a backup of the MAC address stored in a
128 * ROM on the board. This is how the driver should expose it
129 * to the network stack. This function should fill in the
130 * eth_pdata::enetaddr field - optional
131 */
132struct eth_ops {
133 int (*start)(struct udevice *dev);
134 int (*send)(struct udevice *dev, void *packet, int length);
Simon Glassa1ca92e2015-07-06 16:47:49 -0600135 int (*recv)(struct udevice *dev, int flags, uchar **packetp);
Joe Hershberger63c97292015-04-03 20:09:46 -0500136 int (*free_pkt)(struct udevice *dev, uchar *packet, int length);
Joe Hershberger05c3e682015-03-22 17:09:10 -0500137 void (*stop)(struct udevice *dev);
138#ifdef CONFIG_MCAST_TFTP
139 int (*mcast)(struct udevice *dev, const u8 *enetaddr, int join);
140#endif
141 int (*write_hwaddr)(struct udevice *dev);
142 int (*read_rom_hwaddr)(struct udevice *dev);
143};
144
145#define eth_get_ops(dev) ((struct eth_ops *)(dev)->driver->ops)
146
147struct udevice *eth_get_dev(void); /* get the current device */
Joe Hershbergere58780d2015-03-22 17:09:16 -0500148/*
149 * The devname can be either an exact name given by the driver or device tree
150 * or it can be an alias of the form "eth%d"
151 */
152struct udevice *eth_get_dev_by_name(const char *devname);
Joe Hershberger05c3e682015-03-22 17:09:10 -0500153unsigned char *eth_get_ethaddr(void); /* get the current device MAC */
Bernhard Nortmanneaa8a192015-09-14 15:29:43 +0200154
Joe Hershberger05c3e682015-03-22 17:09:10 -0500155/* Used only when NetConsole is enabled */
Bernhard Nortmanneaa8a192015-09-14 15:29:43 +0200156int eth_is_active(struct udevice *dev); /* Test device for active state */
Joe Hershberger05c3e682015-03-22 17:09:10 -0500157int eth_init_state_only(void); /* Set active state */
158void eth_halt_state_only(void); /* Set passive state */
159#endif
160
161#ifndef CONFIG_DM_ETH
wdenk2d966952002-10-31 22:12:35 +0000162struct eth_device {
Mike Frysingerf6add132011-11-10 14:11:04 +0000163 char name[16];
wdenk2d966952002-10-31 22:12:35 +0000164 unsigned char enetaddr[6];
Michal Simek16ae7822015-01-14 16:00:39 +0100165 phys_addr_t iobase;
wdenk2d966952002-10-31 22:12:35 +0000166 int state;
167
Joe Hershbergera34f2072015-04-08 01:41:20 -0500168 int (*init)(struct eth_device *, bd_t *);
169 int (*send)(struct eth_device *, void *packet, int length);
170 int (*recv)(struct eth_device *);
171 void (*halt)(struct eth_device *);
David Updegraff53a5c422007-06-11 10:41:07 -0500172#ifdef CONFIG_MCAST_TFTP
Joe Hershbergera34f2072015-04-08 01:41:20 -0500173 int (*mcast)(struct eth_device *, const u8 *enetaddr, u8 set);
David Updegraff53a5c422007-06-11 10:41:07 -0500174#endif
Joe Hershbergera34f2072015-04-08 01:41:20 -0500175 int (*write_hwaddr)(struct eth_device *);
wdenk2d966952002-10-31 22:12:35 +0000176 struct eth_device *next;
Michael Wallefea7dca2011-10-27 11:31:35 +0000177 int index;
wdenk2d966952002-10-31 22:12:35 +0000178 void *priv;
179};
180
Joe Hershbergerff997432015-03-22 17:09:02 -0500181int eth_register(struct eth_device *dev);/* Register network device */
182int eth_unregister(struct eth_device *dev);/* Remove network device */
Kim Phillips06370592012-10-29 13:34:33 +0000183
Kim Phillips06370592012-10-29 13:34:33 +0000184extern struct eth_device *eth_current;
185
Fabio Estevam92163872015-11-08 22:25:14 -0200186static __always_inline struct eth_device *eth_get_dev(void)
Joe Hershbergerf8be7d62012-08-03 10:59:08 +0000187{
Joe Hershbergerf8be7d62012-08-03 10:59:08 +0000188 return eth_current;
189}
Joe Hershberger84eb1fb2015-03-22 17:09:03 -0500190struct eth_device *eth_get_dev_by_name(const char *devname);
191struct eth_device *eth_get_dev_by_index(int index); /* get dev @ index */
Joe Hershberger8b2c9a72015-03-22 17:09:00 -0500192
Joe Hershberger84eb1fb2015-03-22 17:09:03 -0500193/* get the current device MAC */
Joe Hershberger8b2c9a72015-03-22 17:09:00 -0500194static inline unsigned char *eth_get_ethaddr(void)
195{
196 if (eth_current)
197 return eth_current->enetaddr;
198 return NULL;
199}
200
Bernhard Nortmanneaa8a192015-09-14 15:29:43 +0200201/* Used only when NetConsole is enabled */
202int eth_is_active(struct eth_device *dev); /* Test device for active state */
Joe Hershbergerf8be7d62012-08-03 10:59:08 +0000203/* Set active state */
Fabio Estevam92163872015-11-08 22:25:14 -0200204static __always_inline int eth_init_state_only(void)
Joe Hershbergerf8be7d62012-08-03 10:59:08 +0000205{
206 eth_get_dev()->state = ETH_STATE_ACTIVE;
207
208 return 0;
209}
210/* Set passive state */
Fabio Estevam92163872015-11-08 22:25:14 -0200211static __always_inline void eth_halt_state_only(void)
Joe Hershbergerf8be7d62012-08-03 10:59:08 +0000212{
213 eth_get_dev()->state = ETH_STATE_PASSIVE;
214}
215
Simon Glass7616e782011-06-13 16:13:10 -0700216/*
217 * Set the hardware address for an ethernet interface based on 'eth%daddr'
218 * environment variable (or just 'ethaddr' if eth_number is 0).
219 * Args:
220 * base_name - base name for device (normally "eth")
221 * eth_number - value of %d (0 for first device of this type)
222 * Returns:
223 * 0 is success, non-zero is error status from driver.
224 */
225int eth_write_hwaddr(struct eth_device *dev, const char *base_name,
226 int eth_number);
227
Joe Hershberger84eb1fb2015-03-22 17:09:03 -0500228int usb_eth_initialize(bd_t *bi);
Joe Hershberger05c3e682015-03-22 17:09:10 -0500229#endif
Joe Hershberger84eb1fb2015-03-22 17:09:03 -0500230
Joe Hershbergerd2eaec62015-03-22 17:09:06 -0500231int eth_initialize(void); /* Initialize network subsystem */
Joe Hershberger84eb1fb2015-03-22 17:09:03 -0500232void eth_try_another(int first_restart); /* Change the device */
233void eth_set_current(void); /* set nterface to ethcur var */
234
235int eth_get_dev_index(void); /* get the device index */
236void eth_parse_enetaddr(const char *addr, uchar *enetaddr);
Josh Wu219cc942015-09-01 18:22:55 +0800237int eth_getenv_enetaddr(const char *name, uchar *enetaddr);
238int eth_setenv_enetaddr(const char *name, const uchar *enetaddr);
Joe Hershberger84eb1fb2015-03-22 17:09:03 -0500239
Roger Quadros5350bc82016-03-18 13:18:11 +0200240/**
241 * eth_setenv_enetaddr_by_index() - set the MAC address envrionment variable
242 *
243 * This sets up an environment variable with the given MAC address (@enetaddr).
244 * The environment variable to be set is defined by <@base_name><@index>addr.
245 * If @index is 0 it is omitted. For common Ethernet this means ethaddr,
246 * eth1addr, etc.
247 *
248 * @base_name: Base name for variable, typically "eth"
249 * @index: Index of interface being updated (>=0)
250 * @enetaddr: Pointer to MAC address to put into the variable
251 * @return 0 if OK, other value on error
252 */
253int eth_setenv_enetaddr_by_index(const char *base_name, int index,
254 uchar *enetaddr);
255
256
Joe Hershberger84eb1fb2015-03-22 17:09:03 -0500257/*
258 * Get the hardware address for an ethernet interface .
259 * Args:
260 * base_name - base name for device (normally "eth")
261 * index - device index number (0 for first)
262 * enetaddr - returns 6 byte hardware address
263 * Returns:
264 * Return true if the address is valid.
265 */
266int eth_getenv_enetaddr_by_index(const char *base_name, int index,
267 uchar *enetaddr);
268
Joe Hershbergerd2eaec62015-03-22 17:09:06 -0500269int eth_init(void); /* Initialize the device */
Joe Hershberger84eb1fb2015-03-22 17:09:03 -0500270int eth_send(void *packet, int length); /* Send a packet */
271
272#ifdef CONFIG_API
273int eth_receive(void *packet, int length); /* Receive a packet*/
274extern void (*push_packet)(void *packet, int length);
275#endif
276int eth_rx(void); /* Check for received packets */
277void eth_halt(void); /* stop SCC */
278const char *eth_get_name(void); /* get name of current device */
279
David Updegraff53a5c422007-06-11 10:41:07 -0500280#ifdef CONFIG_MCAST_TFTP
Joe Hershberger049a95a2015-04-08 01:41:01 -0500281int eth_mcast_join(struct in_addr mcast_addr, int join);
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000282u32 ether_crc(size_t len, unsigned char const *p);
David Updegraff53a5c422007-06-11 10:41:07 -0500283#endif
284
wdenk2d966952002-10-31 22:12:35 +0000285
286/**********************************************************************/
287/*
288 * Protocol headers.
289 */
290
291/*
292 * Ethernet header
293 */
Joe Hershbergercb487f52012-05-23 07:58:06 +0000294
295struct ethernet_hdr {
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500296 u8 et_dest[6]; /* Destination node */
297 u8 et_src[6]; /* Source node */
298 u16 et_protlen; /* Protocol or length */
Joe Hershbergercb487f52012-05-23 07:58:06 +0000299};
300
301/* Ethernet header size */
302#define ETHER_HDR_SIZE (sizeof(struct ethernet_hdr))
303
Bin Menga7c3d5e2015-03-20 17:12:18 +0800304#define ETH_FCS_LEN 4 /* Octets in the FCS */
305
Joe Hershbergercb487f52012-05-23 07:58:06 +0000306struct e802_hdr {
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500307 u8 et_dest[6]; /* Destination node */
308 u8 et_src[6]; /* Source node */
309 u16 et_protlen; /* Protocol or length */
310 u8 et_dsap; /* 802 DSAP */
311 u8 et_ssap; /* 802 SSAP */
312 u8 et_ctl; /* 802 control */
313 u8 et_snap1; /* SNAP */
314 u8 et_snap2;
315 u8 et_snap3;
316 u16 et_prot; /* 802 protocol */
Joe Hershbergercb487f52012-05-23 07:58:06 +0000317};
wdenk2d966952002-10-31 22:12:35 +0000318
Joe Hershbergerda5ebe22012-05-23 07:58:11 +0000319/* 802 + SNAP + ethernet header size */
Joe Hershbergercb487f52012-05-23 07:58:06 +0000320#define E802_HDR_SIZE (sizeof(struct e802_hdr))
wdenka3d991b2004-04-15 21:48:45 +0000321
322/*
Joe Hershbergerda5ebe22012-05-23 07:58:11 +0000323 * Virtual LAN Ethernet header
wdenka3d991b2004-04-15 21:48:45 +0000324 */
Joe Hershbergerc68cca32012-05-23 07:58:07 +0000325struct vlan_ethernet_hdr {
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500326 u8 vet_dest[6]; /* Destination node */
327 u8 vet_src[6]; /* Source node */
328 u16 vet_vlan_type; /* PROT_VLAN */
329 u16 vet_tag; /* TAG of VLAN */
330 u16 vet_type; /* protocol type */
Joe Hershbergerc68cca32012-05-23 07:58:07 +0000331};
wdenka3d991b2004-04-15 21:48:45 +0000332
Joe Hershbergerc68cca32012-05-23 07:58:07 +0000333/* VLAN Ethernet header size */
334#define VLAN_ETHER_HDR_SIZE (sizeof(struct vlan_ethernet_hdr))
wdenka3d991b2004-04-15 21:48:45 +0000335
wdenk2d966952002-10-31 22:12:35 +0000336#define PROT_IP 0x0800 /* IP protocol */
337#define PROT_ARP 0x0806 /* IP ARP protocol */
338#define PROT_RARP 0x8035 /* IP ARP protocol */
wdenka3d991b2004-04-15 21:48:45 +0000339#define PROT_VLAN 0x8100 /* IEEE 802.1q protocol */
Stefan Roese99d4c6d2016-02-10 07:22:10 +0100340#define PROT_IPV6 0x86dd /* IPv6 over bluebook */
341#define PROT_PPP_SES 0x8864 /* PPPoE session messages */
wdenk2d966952002-10-31 22:12:35 +0000342
343#define IPPROTO_ICMP 1 /* Internet Control Message Protocol */
344#define IPPROTO_UDP 17 /* User Datagram Protocol */
345
346/*
Joe Hershbergerc5c59df2012-05-23 07:58:05 +0000347 * Internet Protocol (IP) header.
348 */
349struct ip_hdr {
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500350 u8 ip_hl_v; /* header length and version */
351 u8 ip_tos; /* type of service */
352 u16 ip_len; /* total length */
353 u16 ip_id; /* identification */
354 u16 ip_off; /* fragment offset field */
355 u8 ip_ttl; /* time to live */
356 u8 ip_p; /* protocol */
357 u16 ip_sum; /* checksum */
Joe Hershberger049a95a2015-04-08 01:41:01 -0500358 struct in_addr ip_src; /* Source IP address */
359 struct in_addr ip_dst; /* Destination IP address */
Joe Hershbergerc5c59df2012-05-23 07:58:05 +0000360};
361
362#define IP_OFFS 0x1fff /* ip offset *= 8 */
363#define IP_FLAGS 0xe000 /* first 3 bits */
364#define IP_FLAGS_RES 0x8000 /* reserved */
365#define IP_FLAGS_DFRAG 0x4000 /* don't fragments */
366#define IP_FLAGS_MFRAG 0x2000 /* more fragments */
367
368#define IP_HDR_SIZE (sizeof(struct ip_hdr))
369
370/*
Joe Hershberger594c26f2012-05-23 07:58:04 +0000371 * Internet Protocol (IP) + UDP header.
wdenk2d966952002-10-31 22:12:35 +0000372 */
Joe Hershberger594c26f2012-05-23 07:58:04 +0000373struct ip_udp_hdr {
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500374 u8 ip_hl_v; /* header length and version */
375 u8 ip_tos; /* type of service */
376 u16 ip_len; /* total length */
377 u16 ip_id; /* identification */
378 u16 ip_off; /* fragment offset field */
379 u8 ip_ttl; /* time to live */
380 u8 ip_p; /* protocol */
381 u16 ip_sum; /* checksum */
Joe Hershberger049a95a2015-04-08 01:41:01 -0500382 struct in_addr ip_src; /* Source IP address */
383 struct in_addr ip_dst; /* Destination IP address */
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500384 u16 udp_src; /* UDP source port */
385 u16 udp_dst; /* UDP destination port */
386 u16 udp_len; /* Length of UDP packet */
387 u16 udp_xsum; /* Checksum */
Joe Hershberger594c26f2012-05-23 07:58:04 +0000388};
wdenk2d966952002-10-31 22:12:35 +0000389
Joe Hershberger594c26f2012-05-23 07:58:04 +0000390#define IP_UDP_HDR_SIZE (sizeof(struct ip_udp_hdr))
Joe Hershbergerc5c59df2012-05-23 07:58:05 +0000391#define UDP_HDR_SIZE (IP_UDP_HDR_SIZE - IP_HDR_SIZE)
wdenk2d966952002-10-31 22:12:35 +0000392
393/*
394 * Address Resolution Protocol (ARP) header.
395 */
Joe Hershberger738853b2012-05-23 07:58:08 +0000396struct arp_hdr {
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500397 u16 ar_hrd; /* Format of hardware address */
wdenk2d966952002-10-31 22:12:35 +0000398# define ARP_ETHER 1 /* Ethernet hardware address */
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500399 u16 ar_pro; /* Format of protocol address */
400 u8 ar_hln; /* Length of hardware address */
Joe Hershberger674bb242012-05-23 07:58:17 +0000401# define ARP_HLEN 6
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500402 u8 ar_pln; /* Length of protocol address */
Joe Hershberger674bb242012-05-23 07:58:17 +0000403# define ARP_PLEN 4
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500404 u16 ar_op; /* Operation */
wdenk2d966952002-10-31 22:12:35 +0000405# define ARPOP_REQUEST 1 /* Request to resolve address */
406# define ARPOP_REPLY 2 /* Response to previous request */
407
408# define RARPOP_REQUEST 3 /* Request to resolve address */
409# define RARPOP_REPLY 4 /* Response to previous request */
410
411 /*
wdenk8bde7f72003-06-27 21:31:46 +0000412 * The remaining fields are variable in size, according to
413 * the sizes above, and are defined as appropriate for
414 * specific hardware/protocol combinations.
wdenk2d966952002-10-31 22:12:35 +0000415 */
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500416 u8 ar_data[0];
Joe Hershberger674bb242012-05-23 07:58:17 +0000417#define ar_sha ar_data[0]
418#define ar_spa ar_data[ARP_HLEN]
419#define ar_tha ar_data[ARP_HLEN + ARP_PLEN]
420#define ar_tpa ar_data[ARP_HLEN + ARP_PLEN + ARP_HLEN]
wdenk2d966952002-10-31 22:12:35 +0000421#if 0
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500422 u8 ar_sha[]; /* Sender hardware address */
423 u8 ar_spa[]; /* Sender protocol address */
424 u8 ar_tha[]; /* Target hardware address */
425 u8 ar_tpa[]; /* Target protocol address */
wdenk2d966952002-10-31 22:12:35 +0000426#endif /* 0 */
Joe Hershberger738853b2012-05-23 07:58:08 +0000427};
wdenk2d966952002-10-31 22:12:35 +0000428
429#define ARP_HDR_SIZE (8+20) /* Size assuming ethernet */
430
431/*
432 * ICMP stuff (just enough to handle (host) redirect messages)
433 */
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200434#define ICMP_ECHO_REPLY 0 /* Echo reply */
Simon Glass4793ee62011-10-24 18:00:01 +0000435#define ICMP_NOT_REACH 3 /* Detination unreachable */
wdenk2d966952002-10-31 22:12:35 +0000436#define ICMP_REDIRECT 5 /* Redirect (change route) */
wdenk73a8b272003-06-05 19:27:42 +0000437#define ICMP_ECHO_REQUEST 8 /* Echo request */
wdenk2d966952002-10-31 22:12:35 +0000438
439/* Codes for REDIRECT. */
440#define ICMP_REDIR_NET 0 /* Redirect Net */
441#define ICMP_REDIR_HOST 1 /* Redirect Host */
442
Simon Glass4793ee62011-10-24 18:00:01 +0000443/* Codes for NOT_REACH */
444#define ICMP_NOT_REACH_PORT 3 /* Port unreachable */
445
Joe Hershbergere0a63072012-05-23 07:58:09 +0000446struct icmp_hdr {
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500447 u8 type;
448 u8 code;
449 u16 checksum;
wdenk2d966952002-10-31 22:12:35 +0000450 union {
451 struct {
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500452 u16 id;
453 u16 sequence;
wdenk2d966952002-10-31 22:12:35 +0000454 } echo;
Sergey Temerkhanov5917e7d2015-04-08 01:41:22 -0500455 u32 gateway;
wdenk2d966952002-10-31 22:12:35 +0000456 struct {
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500457 u16 unused;
458 u16 mtu;
wdenk2d966952002-10-31 22:12:35 +0000459 } frag;
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500460 u8 data[0];
wdenk2d966952002-10-31 22:12:35 +0000461 } un;
Joe Hershbergere0a63072012-05-23 07:58:09 +0000462};
wdenk2d966952002-10-31 22:12:35 +0000463
Joe Hershbergere0a63072012-05-23 07:58:09 +0000464#define ICMP_HDR_SIZE (sizeof(struct icmp_hdr))
465#define IP_ICMP_HDR_SIZE (IP_HDR_SIZE + ICMP_HDR_SIZE)
wdenk2d966952002-10-31 22:12:35 +0000466
wdenk2d966952002-10-31 22:12:35 +0000467/*
Stefan Agner700877a2016-04-13 16:38:02 -0700468 * Maximum packet size; used to allocate packet storage. Use
469 * the maxium Ethernet frame size as specified by the Ethernet
470 * standard including the 802.1Q tag (VLAN tagging).
471 * maximum packet size = 1522
wdenk2d966952002-10-31 22:12:35 +0000472 * maximum packet size and multiple of 32 bytes = 1536
473 */
Stefan Agner700877a2016-04-13 16:38:02 -0700474#define PKTSIZE 1522
wdenk2d966952002-10-31 22:12:35 +0000475#define PKTSIZE_ALIGN 1536
wdenk2d966952002-10-31 22:12:35 +0000476
477/*
478 * Maximum receive ring size; that is, the number of packets
479 * we can buffer before overflow happens. Basically, this just
480 * needs to be enough to prevent a packet being discarded while
481 * we are processing the previous one.
482 */
483#define RINGSZ 4
484#define RINGSZ_LOG2 2
485
486/**********************************************************************/
487/*
488 * Globals.
489 *
490 * Note:
491 *
Joe Hershberger049a95a2015-04-08 01:41:01 -0500492 * All variables of type struct in_addr are stored in NETWORK byte order
wdenk2d966952002-10-31 22:12:35 +0000493 * (big endian).
494 */
495
496/* net.c */
497/** BOOTP EXTENTIONS **/
Joe Hershberger049a95a2015-04-08 01:41:01 -0500498extern struct in_addr net_gateway; /* Our gateway IP address */
499extern struct in_addr net_netmask; /* Our subnet mask (0 = unknown) */
500/* Our Domain Name Server (0 = unknown) */
501extern struct in_addr net_dns_server;
Jon Loeliger1fe80d72007-07-09 22:08:34 -0500502#if defined(CONFIG_BOOTP_DNS2)
Joe Hershberger049a95a2015-04-08 01:41:01 -0500503/* Our 2nd Domain Name Server (0 = unknown) */
504extern struct in_addr net_dns_server2;
stroesefe389a82003-08-28 14:17:32 +0000505#endif
Joe Hershberger586cbe52015-04-08 01:41:03 -0500506extern char net_nis_domain[32]; /* Our IS domain */
507extern char net_hostname[32]; /* Our hostname */
508extern char net_root_path[64]; /* Our root path */
wdenk2d966952002-10-31 22:12:35 +0000509/** END OF BOOTP EXTENTIONS **/
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500510extern u8 net_ethaddr[6]; /* Our ethernet address */
511extern u8 net_server_ethaddr[6]; /* Boot server enet address */
Joe Hershberger049a95a2015-04-08 01:41:01 -0500512extern struct in_addr net_ip; /* Our IP addr (0 = unknown) */
513extern struct in_addr net_server_ip; /* Server IP addr (0 = unknown) */
Joe Hershberger1203fcc2015-04-08 01:41:05 -0500514extern uchar *net_tx_packet; /* THE transmit packet */
Joe Hershberger2a504df2015-03-22 17:09:11 -0500515extern uchar *net_rx_packets[PKTBUFSRX]; /* Receive packets */
Joe Hershberger1203fcc2015-04-08 01:41:05 -0500516extern uchar *net_rx_packet; /* Current receive packet */
517extern int net_rx_packet_len; /* Current rx packet length */
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500518extern const u8 net_bcast_ethaddr[6]; /* Ethernet broadcast address */
519extern const u8 net_null_ethaddr[6];
wdenk2d966952002-10-31 22:12:35 +0000520
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000521#define VLAN_NONE 4095 /* untagged */
522#define VLAN_IDMASK 0x0fff /* mask of valid vlan id */
Joe Hershberger4fd50552015-04-08 01:41:17 -0500523extern ushort net_our_vlan; /* Our VLAN */
524extern ushort net_native_vlan; /* Our Native VLAN */
wdenka3d991b2004-04-15 21:48:45 +0000525
Joe Hershbergerbc0571f2015-04-08 01:41:21 -0500526extern int net_restart_wrap; /* Tried all network devices */
wdenk2d966952002-10-31 22:12:35 +0000527
Simon Glasse4bf0c52011-10-24 18:00:02 +0000528enum proto_t {
529 BOOTP, RARP, ARP, TFTPGET, DHCP, PING, DNS, NFS, CDP, NETCONS, SNTP,
Joe Hershbergerd22c3382012-05-23 08:00:12 +0000530 TFTPSRV, TFTPPUT, LINKLOCAL
Simon Glasse4bf0c52011-10-24 18:00:02 +0000531};
wdenk2d966952002-10-31 22:12:35 +0000532
Jacob Stiffler11a69ff2015-09-30 10:12:05 -0400533extern char net_boot_file_name[1024];/* Boot File name */
Joe Hershberger14111572015-04-08 01:41:02 -0500534/* The actual transferred size of the bootfile (in bytes) */
535extern u32 net_boot_file_size;
536/* Boot file size in blocks as reported by the DHCP server */
537extern u32 net_boot_file_expected_size_in_blocks;
wdenk2d966952002-10-31 22:12:35 +0000538
Robin Getz1a32bf42009-07-20 14:53:54 -0400539#if defined(CONFIG_CMD_DNS)
Joe Hershberger786eac52015-04-08 01:41:15 -0500540extern char *net_dns_resolve; /* The host to resolve */
541extern char *net_dns_env_var; /* the env var to put the ip into */
Robin Getz1a32bf42009-07-20 14:53:54 -0400542#endif
543
Jon Loeliger639221c2007-07-09 17:15:49 -0500544#if defined(CONFIG_CMD_PING)
Joe Hershberger049a95a2015-04-08 01:41:01 -0500545extern struct in_addr net_ping_ip; /* the ip address to ping */
wdenk73a8b272003-06-05 19:27:42 +0000546#endif
547
Jon Loeliger639221c2007-07-09 17:15:49 -0500548#if defined(CONFIG_CMD_CDP)
wdenka3d991b2004-04-15 21:48:45 +0000549/* when CDP completes these hold the return values */
Joe Hershberger6aede5b2015-04-08 01:41:14 -0500550extern ushort cdp_native_vlan; /* CDP returned native VLAN */
551extern ushort cdp_appliance_vlan; /* CDP returned appliance VLAN */
Joe Hershberger17351882012-05-23 07:58:00 +0000552
553/*
554 * Check for a CDP packet by examining the received MAC address field
555 */
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500556static inline int is_cdp_packet(const uchar *ethaddr)
Joe Hershberger17351882012-05-23 07:58:00 +0000557{
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500558 extern const u8 net_cdp_ethaddr[6];
Joe Hershberger17351882012-05-23 07:58:00 +0000559
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500560 return memcmp(ethaddr, net_cdp_ethaddr, 6) == 0;
Joe Hershberger17351882012-05-23 07:58:00 +0000561}
wdenka3d991b2004-04-15 21:48:45 +0000562#endif
563
Jon Loeliger639221c2007-07-09 17:15:49 -0500564#if defined(CONFIG_CMD_SNTP)
Joe Hershberger049a95a2015-04-08 01:41:01 -0500565extern struct in_addr net_ntp_server; /* the ip address to NTP */
Joe Hershbergerbc0571f2015-04-08 01:41:21 -0500566extern int net_ntp_time_offset; /* offset time from UTC */
wdenkea287de2005-04-01 00:25:43 +0000567#endif
568
Joe Hershberger13dfe942012-05-15 08:59:12 +0000569#if defined(CONFIG_MCAST_TFTP)
Joe Hershberger049a95a2015-04-08 01:41:01 -0500570extern struct in_addr net_mcast_addr;
Joe Hershberger13dfe942012-05-15 08:59:12 +0000571#endif
572
wdenk2d966952002-10-31 22:12:35 +0000573/* Initialize the network adapter */
Joe Hershbergerff997432015-03-22 17:09:02 -0500574void net_init(void);
Joe Hershbergerbc0571f2015-04-08 01:41:21 -0500575int net_loop(enum proto_t);
wdenk2d966952002-10-31 22:12:35 +0000576
577/* Load failed. Start again. */
Joe Hershbergerbc0571f2015-04-08 01:41:21 -0500578int net_start_again(void);
wdenk2d966952002-10-31 22:12:35 +0000579
wdenka3d991b2004-04-15 21:48:45 +0000580/* Get size of the ethernet header when we send */
Joe Hershberger1203fcc2015-04-08 01:41:05 -0500581int net_eth_hdr_size(void);
wdenka3d991b2004-04-15 21:48:45 +0000582
583/* Set ethernet header; returns the size of the header */
Joe Hershberger1203fcc2015-04-08 01:41:05 -0500584int net_set_ether(uchar *xet, const uchar *dest_ethaddr, uint prot);
Joe Hershbergerff997432015-03-22 17:09:02 -0500585int net_update_ether(struct ethernet_hdr *et, uchar *addr, uint prot);
wdenk2d966952002-10-31 22:12:35 +0000586
587/* Set IP header */
Joe Hershberger049a95a2015-04-08 01:41:01 -0500588void net_set_ip_header(uchar *pkt, struct in_addr dest, struct in_addr source);
589void net_set_udp_header(uchar *pkt, struct in_addr dest, int dport,
Joe Hershberger4b11c912012-05-23 07:59:07 +0000590 int sport, int len);
wdenk2d966952002-10-31 22:12:35 +0000591
Simon Glass9b0e35c2015-01-19 22:16:07 -0700592/**
593 * compute_ip_checksum() - Compute IP checksum
594 *
595 * @addr: Address to check (must be 16-bit aligned)
596 * @nbytes: Number of bytes to check (normally a multiple of 2)
597 * @return 16-bit IP checksum
598 */
599unsigned compute_ip_checksum(const void *addr, unsigned nbytes);
600
601/**
602 * add_ip_checksums() - add two IP checksums
603 *
604 * @offset: Offset of first sum (if odd we do a byte-swap)
605 * @sum: First checksum
606 * @new_sum: New checksum to add
607 * @return updated 16-bit IP checksum
608 */
609unsigned add_ip_checksums(unsigned offset, unsigned sum, unsigned new_sum);
610
611/**
612 * ip_checksum_ok() - check if a checksum is correct
613 *
614 * This works by making sure the checksum sums to 0
615 *
616 * @addr: Address to check (must be 16-bit aligned)
617 * @nbytes: Number of bytes to check (normally a multiple of 2)
618 * @return true if the checksum matches, false if not
619 */
620int ip_checksum_ok(const void *addr, unsigned nbytes);
621
Joe Hershbergerd280d3f2012-05-23 07:58:01 +0000622/* Callbacks */
Joe Hershbergerff997432015-03-22 17:09:02 -0500623rxhand_f *net_get_udp_handler(void); /* Get UDP RX packet handler */
624void net_set_udp_handler(rxhand_f *); /* Set UDP RX packet handler */
625rxhand_f *net_get_arp_handler(void); /* Get ARP RX packet handler */
626void net_set_arp_handler(rxhand_f *); /* Set ARP RX packet handler */
627void net_set_icmp_handler(rxhand_icmp_f *f); /* Set ICMP RX handler */
Joe Hershbergerbc0571f2015-04-08 01:41:21 -0500628void net_set_timeout_handler(ulong, thand_f *);/* Set timeout handler */
wdenk2d966952002-10-31 22:12:35 +0000629
Joe Hershberger22f6e992012-05-23 07:59:14 +0000630/* Network loop state */
631enum net_loop_state {
632 NETLOOP_CONTINUE,
633 NETLOOP_RESTART,
634 NETLOOP_SUCCESS,
635 NETLOOP_FAIL
636};
Kim Phillips06370592012-10-29 13:34:33 +0000637extern enum net_loop_state net_state;
638
Joe Hershberger22f6e992012-05-23 07:59:14 +0000639static inline void net_set_state(enum net_loop_state state)
640{
Joe Hershberger4ef8d532012-05-23 08:01:04 +0000641 debug_cond(DEBUG_INT_STATE, "--- NetState set to %d\n", state);
Joe Hershberger22f6e992012-05-23 07:59:14 +0000642 net_state = state;
643}
644
Joe Hershbergere94070c2012-05-23 07:59:24 +0000645/* Transmit a packet */
Joe Hershberger1203fcc2015-04-08 01:41:05 -0500646static inline void net_send_packet(uchar *pkt, int len)
Joe Hershbergeradf5d932012-05-23 07:59:13 +0000647{
Joe Hershberger60304592015-03-22 17:09:24 -0500648 /* Currently no way to return errors from eth_send() */
Joe Hershbergeradf5d932012-05-23 07:59:13 +0000649 (void) eth_send(pkt, len);
650}
wdenk2d966952002-10-31 22:12:35 +0000651
Joe Hershberger206d07f2012-05-23 07:58:10 +0000652/*
Joe Hershberger1203fcc2015-04-08 01:41:05 -0500653 * Transmit "net_tx_packet" as UDP packet, performing ARP request if needed
Joe Hershbergerece223b2012-05-23 07:59:15 +0000654 * (ether will be populated)
Joe Hershberger206d07f2012-05-23 07:58:10 +0000655 *
656 * @param ether Raw packet buffer
657 * @param dest IP address to send the datagram to
658 * @param dport Destination UDP port
659 * @param sport Source UDP port
660 * @param payload_len Length of data after the UDP header
661 */
Joe Hershberger1203fcc2015-04-08 01:41:05 -0500662int net_send_udp_packet(uchar *ether, struct in_addr dest, int dport,
Joe Hershberger206d07f2012-05-23 07:58:10 +0000663 int sport, int payload_len);
wdenk73a8b272003-06-05 19:27:42 +0000664
wdenk2d966952002-10-31 22:12:35 +0000665/* Processes a received packet */
Joe Hershberger2a504df2015-03-22 17:09:11 -0500666void net_process_received_packet(uchar *in_packet, int len);
wdenk2d966952002-10-31 22:12:35 +0000667
Joe Hershberger48522bb2012-05-15 08:59:08 +0000668#ifdef CONFIG_NETCONSOLE
Joe Hershberger6a38a5f2015-04-08 01:41:16 -0500669void nc_start(void);
Joe Hershberger049a95a2015-04-08 01:41:01 -0500670int nc_input_packet(uchar *pkt, struct in_addr src_ip, unsigned dest_port,
Joe Hershberger8a0eccb2012-09-18 10:01:32 +0000671 unsigned src_port, unsigned len);
Joe Hershberger48522bb2012-05-15 08:59:08 +0000672#endif
673
Fabio Estevam92163872015-11-08 22:25:14 -0200674static __always_inline int eth_is_on_demand_init(void)
Joe Hershbergerf8be7d62012-08-03 10:59:08 +0000675{
676#ifdef CONFIG_NETCONSOLE
677 extern enum proto_t net_loop_last_protocol;
678
679 return net_loop_last_protocol != NETCONS;
680#else
681 return 1;
682#endif
683}
684
685static inline void eth_set_last_protocol(int protocol)
686{
687#ifdef CONFIG_NETCONSOLE
688 extern enum proto_t net_loop_last_protocol;
689
690 net_loop_last_protocol = protocol;
691#endif
692}
693
wdenk2d966952002-10-31 22:12:35 +0000694/*
Simon Glasse4a3d572011-10-27 06:24:32 +0000695 * Check if autoload is enabled. If so, use either NFS or TFTP to download
696 * the boot file.
697 */
698void net_auto_load(void);
699
700/*
wdenk2d966952002-10-31 22:12:35 +0000701 * The following functions are a bit ugly, but necessary to deal with
702 * alignment restrictions on ARM.
703 *
704 * We're using inline functions, which had the smallest memory
705 * footprint in our tests.
706 */
707/* return IP *in network byteorder* */
Joe Hershberger049a95a2015-04-08 01:41:01 -0500708static inline struct in_addr net_read_ip(void *from)
wdenk2d966952002-10-31 22:12:35 +0000709{
Joe Hershberger049a95a2015-04-08 01:41:01 -0500710 struct in_addr ip;
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000711
712 memcpy((void *)&ip, (void *)from, sizeof(ip));
wdenk2d966952002-10-31 22:12:35 +0000713 return ip;
714}
715
716/* return ulong *in network byteorder* */
Sergey Temerkhanov5917e7d2015-04-08 01:41:22 -0500717static inline u32 net_read_u32(u32 *from)
wdenk2d966952002-10-31 22:12:35 +0000718{
Sergey Temerkhanov5917e7d2015-04-08 01:41:22 -0500719 u32 l;
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000720
721 memcpy((void *)&l, (void *)from, sizeof(l));
wdenk2d966952002-10-31 22:12:35 +0000722 return l;
723}
724
725/* write IP *in network byteorder* */
Joe Hershberger049a95a2015-04-08 01:41:01 -0500726static inline void net_write_ip(void *to, struct in_addr ip)
wdenk2d966952002-10-31 22:12:35 +0000727{
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000728 memcpy(to, (void *)&ip, sizeof(ip));
wdenk2d966952002-10-31 22:12:35 +0000729}
730
731/* copy IP */
Joe Hershberger049a95a2015-04-08 01:41:01 -0500732static inline void net_copy_ip(void *to, void *from)
wdenk2d966952002-10-31 22:12:35 +0000733{
Joe Hershberger049a95a2015-04-08 01:41:01 -0500734 memcpy((void *)to, from, sizeof(struct in_addr));
wdenk2d966952002-10-31 22:12:35 +0000735}
736
737/* copy ulong */
Sergey Temerkhanov5917e7d2015-04-08 01:41:22 -0500738static inline void net_copy_u32(u32 *to, u32 *from)
wdenk2d966952002-10-31 22:12:35 +0000739{
Sergey Temerkhanov5917e7d2015-04-08 01:41:22 -0500740 memcpy((void *)to, (void *)from, sizeof(u32));
wdenk2d966952002-10-31 22:12:35 +0000741}
742
Mike Rapoport50cca8b2007-08-12 08:48:27 +0300743/**
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500744 * is_zero_ethaddr - Determine if give Ethernet address is all zeros.
Mike Rapoport50cca8b2007-08-12 08:48:27 +0300745 * @addr: Pointer to a six-byte array containing the Ethernet address
746 *
747 * Return true if the address is all zeroes.
748 */
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500749static inline int is_zero_ethaddr(const u8 *addr)
Mike Rapoport50cca8b2007-08-12 08:48:27 +0300750{
751 return !(addr[0] | addr[1] | addr[2] | addr[3] | addr[4] | addr[5]);
752}
753
754/**
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500755 * is_multicast_ethaddr - Determine if the Ethernet address is a multicast.
Mike Rapoport50cca8b2007-08-12 08:48:27 +0300756 * @addr: Pointer to a six-byte array containing the Ethernet address
757 *
758 * Return true if the address is a multicast address.
759 * By definition the broadcast address is also a multicast address.
760 */
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500761static inline int is_multicast_ethaddr(const u8 *addr)
Mike Rapoport50cca8b2007-08-12 08:48:27 +0300762{
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000763 return 0x01 & addr[0];
Mike Rapoport50cca8b2007-08-12 08:48:27 +0300764}
765
Remy Bohmer23cd1382009-07-29 18:18:43 +0200766/*
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500767 * is_broadcast_ethaddr - Determine if the Ethernet address is broadcast
Remy Bohmer23cd1382009-07-29 18:18:43 +0200768 * @addr: Pointer to a six-byte array containing the Ethernet address
769 *
770 * Return true if the address is the broadcast address.
771 */
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500772static inline int is_broadcast_ethaddr(const u8 *addr)
Remy Bohmer23cd1382009-07-29 18:18:43 +0200773{
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000774 return (addr[0] & addr[1] & addr[2] & addr[3] & addr[4] & addr[5]) ==
775 0xff;
Remy Bohmer23cd1382009-07-29 18:18:43 +0200776}
777
778/*
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500779 * is_valid_ethaddr - Determine if the given Ethernet address is valid
Mike Frysinger75edebe2009-01-27 16:53:39 -0500780 * @addr: Pointer to a six-byte array containing the Ethernet address
781 *
782 * Check that the Ethernet address (MAC) is not 00:00:00:00:00:00, is not
783 * a multicast address, and is not FF:FF:FF:FF:FF:FF.
784 *
785 * Return true if the address is valid.
786 */
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500787static inline int is_valid_ethaddr(const u8 *addr)
Mike Frysinger75edebe2009-01-27 16:53:39 -0500788{
789 /* FF:FF:FF:FF:FF:FF is a multicast address so we don't need to
790 * explicitly check for it here. */
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500791 return !is_multicast_ethaddr(addr) && !is_zero_ethaddr(addr);
Mike Frysinger75edebe2009-01-27 16:53:39 -0500792}
793
Masahiro Yamadada384a92014-04-18 19:09:48 +0900794/**
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500795 * net_random_ethaddr - Generate software assigned random Ethernet address
Masahiro Yamadada384a92014-04-18 19:09:48 +0900796 * @addr: Pointer to a six-byte array containing the Ethernet address
797 *
798 * Generate a random Ethernet address (MAC) that is not multicast
799 * and has the local assigned bit set.
800 */
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500801static inline void net_random_ethaddr(uchar *addr)
Masahiro Yamadada384a92014-04-18 19:09:48 +0900802{
803 int i;
804 unsigned int seed = get_timer(0);
805
806 for (i = 0; i < 6; i++)
807 addr[i] = rand_r(&seed);
808
809 addr[0] &= 0xfe; /* clear multicast bit */
810 addr[0] |= 0x02; /* set local assignment bit (IEEE802) */
811}
812
wdenk2d966952002-10-31 22:12:35 +0000813/* Convert an IP address to a string */
Joe Hershberger049a95a2015-04-08 01:41:01 -0500814void ip_to_string(struct in_addr x, char *s);
wdenk2d966952002-10-31 22:12:35 +0000815
wdenk73a8b272003-06-05 19:27:42 +0000816/* Convert a string to ip address */
Joe Hershberger049a95a2015-04-08 01:41:01 -0500817struct in_addr string_to_ip(const char *s);
wdenk73a8b272003-06-05 19:27:42 +0000818
wdenka3d991b2004-04-15 21:48:45 +0000819/* Convert a VLAN id to a string */
Joe Hershberger4fd50552015-04-08 01:41:17 -0500820void vlan_to_string(ushort x, char *s);
wdenka3d991b2004-04-15 21:48:45 +0000821
822/* Convert a string to a vlan id */
Joe Hershberger4fd50552015-04-08 01:41:17 -0500823ushort string_to_vlan(const char *s);
wdenka3d991b2004-04-15 21:48:45 +0000824
wdenka3d991b2004-04-15 21:48:45 +0000825/* read a VLAN id from an environment variable */
Joe Hershberger4fd50552015-04-08 01:41:17 -0500826ushort getenv_vlan(char *);
wdenka3d991b2004-04-15 21:48:45 +0000827
wdenk2d966952002-10-31 22:12:35 +0000828/* copy a filename (allow for "..." notation, limit length) */
Joe Hershbergerff997432015-03-22 17:09:02 -0500829void copy_filename(char *dst, const char *src, int size);
wdenk2d966952002-10-31 22:12:35 +0000830
Mike Frysinger91b469c2009-09-02 04:18:55 -0400831/* get a random source port */
Joe Hershbergerff997432015-03-22 17:09:02 -0500832unsigned int random_port(void);
Mike Frysinger91b469c2009-09-02 04:18:55 -0400833
Lukasz Majewskic7ff5522015-08-24 00:21:47 +0200834/**
835 * update_tftp - Update firmware over TFTP (via DFU)
836 *
837 * This function updates board's firmware via TFTP
838 *
839 * @param addr - memory address where data is stored
840 * @param interface - the DFU medium name - e.g. "mmc"
841 * @param devstring - the DFU medium number - e.g. "1"
842 *
843 * @return - 0 on success, other value on failure
844 */
845int update_tftp(ulong addr, char *interface, char *devstring);
Simon Glassea5427e2013-05-15 06:23:54 +0000846
wdenk2d966952002-10-31 22:12:35 +0000847/**********************************************************************/
848
849#endif /* __NET_H__ */