blob: 3101096e9a1c419325ca613b51e424d9fdebe73c [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
Eric Nelson2c4b3c12012-03-15 18:33:24 +000015#include <asm/cache.h>
wdenk2d966952002-10-31 22:12:35 +000016#include <asm/byteorder.h> /* for nton* / ntoh* stuff */
17
Joe Hershberger4ef8d532012-05-23 08:01:04 +000018#define DEBUG_LL_STATE 0 /* Link local state machine changes */
19#define DEBUG_DEV_PKT 0 /* Packets or info directed to the device */
20#define DEBUG_NET_PKT 0 /* Packets on info on the network at large */
21#define DEBUG_INT_STATE 0 /* Internal network state changes */
wdenk2d966952002-10-31 22:12:35 +000022
23/*
24 * The number of receive packet buffers, and the required packet buffer
25 * alignment in memory.
26 *
27 */
28
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +020029#ifdef CONFIG_SYS_RX_ETH_BUFFER
30# define PKTBUFSRX CONFIG_SYS_RX_ETH_BUFFER
wdenk1d0350e2002-11-11 21:14:20 +000031#else
stroesec6028832003-06-05 15:38:29 +000032# define PKTBUFSRX 4
wdenk1d0350e2002-11-11 21:14:20 +000033#endif
34
Eric Nelson2c4b3c12012-03-15 18:33:24 +000035#define PKTALIGN ARCH_DMA_MINALIGN
wdenk2d966952002-10-31 22:12:35 +000036
oliver@schinagl.nla40db6d2016-11-25 16:30:19 +010037/* ARP hardware address length */
38#define ARP_HLEN 6
oliver@schinagl.nl9f455bc2016-11-25 16:30:20 +010039/*
40 * The size of a MAC address in string form, each digit requires two chars
41 * and five separator characters to form '00:00:00:00:00:00'.
42 */
43#define ARP_HLEN_ASCII (ARP_HLEN * 2) + (ARP_HLEN - 1)
oliver@schinagl.nla40db6d2016-11-25 16:30:19 +010044
Matthias Weisserea45cb02011-12-03 03:29:44 +000045/* IPv4 addresses are always 32 bits in size */
Joe Hershberger049a95a2015-04-08 01:41:01 -050046struct in_addr {
47 __be32 s_addr;
48};
wdenk2d966952002-10-31 22:12:35 +000049
Luca Ceresoli03eb1292011-04-18 06:19:50 +000050/**
51 * An incoming packet handler.
52 * @param pkt pointer to the application packet
53 * @param dport destination UDP port
54 * @param sip source IP address
55 * @param sport source UDP port
56 * @param len packet length
wdenk2d966952002-10-31 22:12:35 +000057 */
Luca Ceresoli03eb1292011-04-18 06:19:50 +000058typedef void rxhand_f(uchar *pkt, unsigned dport,
Joe Hershberger049a95a2015-04-08 01:41:01 -050059 struct in_addr sip, unsigned sport,
Luca Ceresoli03eb1292011-04-18 06:19:50 +000060 unsigned len);
wdenk2d966952002-10-31 22:12:35 +000061
Simon Glass4793ee62011-10-24 18:00:01 +000062/**
63 * An incoming ICMP packet handler.
64 * @param type ICMP type
65 * @param code ICMP code
66 * @param dport destination UDP port
67 * @param sip source IP address
68 * @param sport source UDP port
69 * @param pkt pointer to the ICMP packet data
70 * @param len packet length
71 */
72typedef void rxhand_icmp_f(unsigned type, unsigned code, unsigned dport,
Joe Hershberger049a95a2015-04-08 01:41:01 -050073 struct in_addr sip, unsigned sport, uchar *pkt, unsigned len);
Simon Glass4793ee62011-10-24 18:00:01 +000074
wdenk2d966952002-10-31 22:12:35 +000075/*
76 * A timeout handler. Called after time interval has expired.
77 */
78typedef void thand_f(void);
79
wdenk2d966952002-10-31 22:12:35 +000080enum eth_state_t {
81 ETH_STATE_INIT,
82 ETH_STATE_PASSIVE,
83 ETH_STATE_ACTIVE
84};
85
Joe Hershberger05c3e682015-03-22 17:09:10 -050086#ifdef CONFIG_DM_ETH
87/**
88 * struct eth_pdata - Platform data for Ethernet MAC controllers
89 *
90 * @iobase: The base address of the hardware registers
91 * @enetaddr: The Ethernet MAC address that is loaded from EEPROM or env
Simon Glassc74c8e62015-04-05 16:07:39 -060092 * @phy_interface: PHY interface to use - see PHY_INTERFACE_MODE_...
Alexey Brodkinf74264d2016-01-13 16:59:35 +030093 * @max_speed: Maximum speed of Ethernet connection supported by MAC
Joe Hershberger05c3e682015-03-22 17:09:10 -050094 */
95struct eth_pdata {
96 phys_addr_t iobase;
oliver@schinagl.nla40db6d2016-11-25 16:30:19 +010097 unsigned char enetaddr[ARP_HLEN];
Simon Glassc74c8e62015-04-05 16:07:39 -060098 int phy_interface;
Alexey Brodkinf74264d2016-01-13 16:59:35 +030099 int max_speed;
Joe Hershberger05c3e682015-03-22 17:09:10 -0500100};
101
Simon Glassa1ca92e2015-07-06 16:47:49 -0600102enum eth_recv_flags {
103 /*
104 * Check hardware device for new packets (otherwise only return those
105 * which are already in the memory buffer ready to process)
106 */
107 ETH_RECV_CHECK_DEVICE = 1 << 0,
108};
109
Joe Hershberger05c3e682015-03-22 17:09:10 -0500110/**
111 * struct eth_ops - functions of Ethernet MAC controllers
112 *
113 * start: Prepare the hardware to send and receive packets
114 * send: Send the bytes passed in "packet" as a packet on the wire
Joe Hershberger17591402015-03-22 17:09:12 -0500115 * recv: Check if the hardware received a packet. If so, set the pointer to the
116 * packet buffer in the packetp parameter. If not, return an error or 0 to
Joe Hershberger63c97292015-04-03 20:09:46 -0500117 * indicate that the hardware receive FIFO is empty. If 0 is returned, the
118 * network stack will not process the empty packet, but free_pkt() will be
119 * called if supplied
120 * free_pkt: Give the driver an opportunity to manage its packet buffer memory
121 * when the network stack is finished processing it. This will only be
122 * called when no error was returned from recv - optional
Joe Hershberger05c3e682015-03-22 17:09:10 -0500123 * stop: Stop the hardware from looking for packets - may be called even if
124 * state == PASSIVE
125 * mcast: Join or leave a multicast group (for TFTP) - optional
126 * write_hwaddr: Write a MAC address to the hardware (used to pass it to Linux
127 * on some platforms like ARM). This function expects the
Simon Glassb86f7952015-07-06 16:47:55 -0600128 * eth_pdata::enetaddr field to be populated. The method can
129 * return -ENOSYS to indicate that this is not implemented for
130 this hardware - optional.
Joe Hershberger05c3e682015-03-22 17:09:10 -0500131 * read_rom_hwaddr: Some devices have a backup of the MAC address stored in a
132 * ROM on the board. This is how the driver should expose it
133 * to the network stack. This function should fill in the
134 * eth_pdata::enetaddr field - optional
135 */
136struct eth_ops {
137 int (*start)(struct udevice *dev);
138 int (*send)(struct udevice *dev, void *packet, int length);
Simon Glassa1ca92e2015-07-06 16:47:49 -0600139 int (*recv)(struct udevice *dev, int flags, uchar **packetp);
Joe Hershberger63c97292015-04-03 20:09:46 -0500140 int (*free_pkt)(struct udevice *dev, uchar *packet, int length);
Joe Hershberger05c3e682015-03-22 17:09:10 -0500141 void (*stop)(struct udevice *dev);
142#ifdef CONFIG_MCAST_TFTP
143 int (*mcast)(struct udevice *dev, const u8 *enetaddr, int join);
144#endif
145 int (*write_hwaddr)(struct udevice *dev);
146 int (*read_rom_hwaddr)(struct udevice *dev);
147};
148
149#define eth_get_ops(dev) ((struct eth_ops *)(dev)->driver->ops)
150
151struct udevice *eth_get_dev(void); /* get the current device */
Joe Hershbergere58780d2015-03-22 17:09:16 -0500152/*
153 * The devname can be either an exact name given by the driver or device tree
154 * or it can be an alias of the form "eth%d"
155 */
156struct udevice *eth_get_dev_by_name(const char *devname);
Joe Hershberger05c3e682015-03-22 17:09:10 -0500157unsigned char *eth_get_ethaddr(void); /* get the current device MAC */
Bernhard Nortmanneaa8a192015-09-14 15:29:43 +0200158
Joe Hershberger05c3e682015-03-22 17:09:10 -0500159/* Used only when NetConsole is enabled */
Bernhard Nortmanneaa8a192015-09-14 15:29:43 +0200160int eth_is_active(struct udevice *dev); /* Test device for active state */
Joe Hershberger05c3e682015-03-22 17:09:10 -0500161int eth_init_state_only(void); /* Set active state */
162void eth_halt_state_only(void); /* Set passive state */
163#endif
164
165#ifndef CONFIG_DM_ETH
wdenk2d966952002-10-31 22:12:35 +0000166struct eth_device {
oliver@schinagl.nl2c07c322016-11-25 16:30:21 +0100167#define ETH_NAME_LEN 16
168 char name[ETH_NAME_LEN];
oliver@schinagl.nla40db6d2016-11-25 16:30:19 +0100169 unsigned char enetaddr[ARP_HLEN];
Michal Simek16ae7822015-01-14 16:00:39 +0100170 phys_addr_t iobase;
wdenk2d966952002-10-31 22:12:35 +0000171 int state;
172
Joe Hershbergera34f2072015-04-08 01:41:20 -0500173 int (*init)(struct eth_device *, bd_t *);
174 int (*send)(struct eth_device *, void *packet, int length);
175 int (*recv)(struct eth_device *);
176 void (*halt)(struct eth_device *);
David Updegraff53a5c422007-06-11 10:41:07 -0500177#ifdef CONFIG_MCAST_TFTP
Joe Hershbergera34f2072015-04-08 01:41:20 -0500178 int (*mcast)(struct eth_device *, const u8 *enetaddr, u8 set);
David Updegraff53a5c422007-06-11 10:41:07 -0500179#endif
Joe Hershbergera34f2072015-04-08 01:41:20 -0500180 int (*write_hwaddr)(struct eth_device *);
wdenk2d966952002-10-31 22:12:35 +0000181 struct eth_device *next;
Michael Wallefea7dca2011-10-27 11:31:35 +0000182 int index;
wdenk2d966952002-10-31 22:12:35 +0000183 void *priv;
184};
185
Joe Hershbergerff997432015-03-22 17:09:02 -0500186int eth_register(struct eth_device *dev);/* Register network device */
187int eth_unregister(struct eth_device *dev);/* Remove network device */
Kim Phillips06370592012-10-29 13:34:33 +0000188
Kim Phillips06370592012-10-29 13:34:33 +0000189extern struct eth_device *eth_current;
190
Fabio Estevam92163872015-11-08 22:25:14 -0200191static __always_inline struct eth_device *eth_get_dev(void)
Joe Hershbergerf8be7d62012-08-03 10:59:08 +0000192{
Joe Hershbergerf8be7d62012-08-03 10:59:08 +0000193 return eth_current;
194}
Joe Hershberger84eb1fb2015-03-22 17:09:03 -0500195struct eth_device *eth_get_dev_by_name(const char *devname);
196struct eth_device *eth_get_dev_by_index(int index); /* get dev @ index */
Joe Hershberger8b2c9a72015-03-22 17:09:00 -0500197
Joe Hershberger84eb1fb2015-03-22 17:09:03 -0500198/* get the current device MAC */
Joe Hershberger8b2c9a72015-03-22 17:09:00 -0500199static inline unsigned char *eth_get_ethaddr(void)
200{
201 if (eth_current)
202 return eth_current->enetaddr;
203 return NULL;
204}
205
Bernhard Nortmanneaa8a192015-09-14 15:29:43 +0200206/* Used only when NetConsole is enabled */
207int eth_is_active(struct eth_device *dev); /* Test device for active state */
Joe Hershbergerf8be7d62012-08-03 10:59:08 +0000208/* Set active state */
Fabio Estevam92163872015-11-08 22:25:14 -0200209static __always_inline int eth_init_state_only(void)
Joe Hershbergerf8be7d62012-08-03 10:59:08 +0000210{
211 eth_get_dev()->state = ETH_STATE_ACTIVE;
212
213 return 0;
214}
215/* Set passive state */
Fabio Estevam92163872015-11-08 22:25:14 -0200216static __always_inline void eth_halt_state_only(void)
Joe Hershbergerf8be7d62012-08-03 10:59:08 +0000217{
218 eth_get_dev()->state = ETH_STATE_PASSIVE;
219}
220
Simon Glass7616e782011-06-13 16:13:10 -0700221/*
222 * Set the hardware address for an ethernet interface based on 'eth%daddr'
223 * environment variable (or just 'ethaddr' if eth_number is 0).
224 * Args:
225 * base_name - base name for device (normally "eth")
226 * eth_number - value of %d (0 for first device of this type)
227 * Returns:
228 * 0 is success, non-zero is error status from driver.
229 */
230int eth_write_hwaddr(struct eth_device *dev, const char *base_name,
231 int eth_number);
232
Joe Hershberger84eb1fb2015-03-22 17:09:03 -0500233int usb_eth_initialize(bd_t *bi);
Joe Hershberger05c3e682015-03-22 17:09:10 -0500234#endif
Joe Hershberger84eb1fb2015-03-22 17:09:03 -0500235
Joe Hershbergerd2eaec62015-03-22 17:09:06 -0500236int eth_initialize(void); /* Initialize network subsystem */
Joe Hershberger84eb1fb2015-03-22 17:09:03 -0500237void eth_try_another(int first_restart); /* Change the device */
238void eth_set_current(void); /* set nterface to ethcur var */
239
240int eth_get_dev_index(void); /* get the device index */
241void eth_parse_enetaddr(const char *addr, uchar *enetaddr);
Simon Glass35affd72017-08-03 12:22:14 -0600242int eth_env_get_enetaddr(const char *name, uchar *enetaddr);
Simon Glassfd1e9592017-08-03 12:22:11 -0600243int eth_env_set_enetaddr(const char *name, const uchar *enetaddr);
Joe Hershberger84eb1fb2015-03-22 17:09:03 -0500244
Roger Quadros5350bc82016-03-18 13:18:11 +0200245/**
Simon Glassfd1e9592017-08-03 12:22:11 -0600246 * eth_env_set_enetaddr_by_index() - set the MAC address environment variable
Roger Quadros5350bc82016-03-18 13:18:11 +0200247 *
248 * This sets up an environment variable with the given MAC address (@enetaddr).
249 * The environment variable to be set is defined by <@base_name><@index>addr.
250 * If @index is 0 it is omitted. For common Ethernet this means ethaddr,
251 * eth1addr, etc.
252 *
253 * @base_name: Base name for variable, typically "eth"
254 * @index: Index of interface being updated (>=0)
255 * @enetaddr: Pointer to MAC address to put into the variable
256 * @return 0 if OK, other value on error
257 */
Simon Glassfd1e9592017-08-03 12:22:11 -0600258int eth_env_set_enetaddr_by_index(const char *base_name, int index,
Roger Quadros5350bc82016-03-18 13:18:11 +0200259 uchar *enetaddr);
260
261
Joe Hershberger84eb1fb2015-03-22 17:09:03 -0500262/*
Mugunthan V Nd4a37552016-11-18 11:09:15 +0530263 * Initialize USB ethernet device with CONFIG_DM_ETH
264 * Returns:
265 * 0 is success, non-zero is error status.
266 */
267int usb_ether_init(void);
268
269/*
Joe Hershberger84eb1fb2015-03-22 17:09:03 -0500270 * Get the hardware address for an ethernet interface .
271 * Args:
272 * base_name - base name for device (normally "eth")
273 * index - device index number (0 for first)
274 * enetaddr - returns 6 byte hardware address
275 * Returns:
276 * Return true if the address is valid.
277 */
Simon Glass35affd72017-08-03 12:22:14 -0600278int eth_env_get_enetaddr_by_index(const char *base_name, int index,
Joe Hershberger84eb1fb2015-03-22 17:09:03 -0500279 uchar *enetaddr);
280
Joe Hershbergerd2eaec62015-03-22 17:09:06 -0500281int eth_init(void); /* Initialize the device */
Joe Hershberger84eb1fb2015-03-22 17:09:03 -0500282int eth_send(void *packet, int length); /* Send a packet */
283
Alexander Graf0efe1bc2016-05-06 21:01:01 +0200284#if defined(CONFIG_API) || defined(CONFIG_EFI_LOADER)
Joe Hershberger84eb1fb2015-03-22 17:09:03 -0500285int eth_receive(void *packet, int length); /* Receive a packet*/
286extern void (*push_packet)(void *packet, int length);
287#endif
288int eth_rx(void); /* Check for received packets */
289void eth_halt(void); /* stop SCC */
290const char *eth_get_name(void); /* get name of current device */
291
David Updegraff53a5c422007-06-11 10:41:07 -0500292#ifdef CONFIG_MCAST_TFTP
Joe Hershberger049a95a2015-04-08 01:41:01 -0500293int eth_mcast_join(struct in_addr mcast_addr, int join);
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000294u32 ether_crc(size_t len, unsigned char const *p);
David Updegraff53a5c422007-06-11 10:41:07 -0500295#endif
296
wdenk2d966952002-10-31 22:12:35 +0000297
298/**********************************************************************/
299/*
300 * Protocol headers.
301 */
302
303/*
304 * Ethernet header
305 */
Joe Hershbergercb487f52012-05-23 07:58:06 +0000306
307struct ethernet_hdr {
oliver@schinagl.nla40db6d2016-11-25 16:30:19 +0100308 u8 et_dest[ARP_HLEN]; /* Destination node */
309 u8 et_src[ARP_HLEN]; /* Source node */
310 u16 et_protlen; /* Protocol or length */
Denis Pynkin704f3ac2017-07-21 19:28:42 +0300311} __attribute__((packed));
Joe Hershbergercb487f52012-05-23 07:58:06 +0000312
313/* Ethernet header size */
314#define ETHER_HDR_SIZE (sizeof(struct ethernet_hdr))
315
Bin Menga7c3d5e2015-03-20 17:12:18 +0800316#define ETH_FCS_LEN 4 /* Octets in the FCS */
317
Joe Hershbergercb487f52012-05-23 07:58:06 +0000318struct e802_hdr {
oliver@schinagl.nla40db6d2016-11-25 16:30:19 +0100319 u8 et_dest[ARP_HLEN]; /* Destination node */
320 u8 et_src[ARP_HLEN]; /* Source node */
321 u16 et_protlen; /* Protocol or length */
322 u8 et_dsap; /* 802 DSAP */
323 u8 et_ssap; /* 802 SSAP */
324 u8 et_ctl; /* 802 control */
325 u8 et_snap1; /* SNAP */
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500326 u8 et_snap2;
327 u8 et_snap3;
oliver@schinagl.nla40db6d2016-11-25 16:30:19 +0100328 u16 et_prot; /* 802 protocol */
Denis Pynkin704f3ac2017-07-21 19:28:42 +0300329} __attribute__((packed));
wdenk2d966952002-10-31 22:12:35 +0000330
Joe Hershbergerda5ebe22012-05-23 07:58:11 +0000331/* 802 + SNAP + ethernet header size */
Joe Hershbergercb487f52012-05-23 07:58:06 +0000332#define E802_HDR_SIZE (sizeof(struct e802_hdr))
wdenka3d991b2004-04-15 21:48:45 +0000333
334/*
Joe Hershbergerda5ebe22012-05-23 07:58:11 +0000335 * Virtual LAN Ethernet header
wdenka3d991b2004-04-15 21:48:45 +0000336 */
Joe Hershbergerc68cca32012-05-23 07:58:07 +0000337struct vlan_ethernet_hdr {
oliver@schinagl.nla40db6d2016-11-25 16:30:19 +0100338 u8 vet_dest[ARP_HLEN]; /* Destination node */
339 u8 vet_src[ARP_HLEN]; /* Source node */
340 u16 vet_vlan_type; /* PROT_VLAN */
341 u16 vet_tag; /* TAG of VLAN */
342 u16 vet_type; /* protocol type */
Denis Pynkin704f3ac2017-07-21 19:28:42 +0300343} __attribute__((packed));
wdenka3d991b2004-04-15 21:48:45 +0000344
Joe Hershbergerc68cca32012-05-23 07:58:07 +0000345/* VLAN Ethernet header size */
346#define VLAN_ETHER_HDR_SIZE (sizeof(struct vlan_ethernet_hdr))
wdenka3d991b2004-04-15 21:48:45 +0000347
wdenk2d966952002-10-31 22:12:35 +0000348#define PROT_IP 0x0800 /* IP protocol */
349#define PROT_ARP 0x0806 /* IP ARP protocol */
350#define PROT_RARP 0x8035 /* IP ARP protocol */
wdenka3d991b2004-04-15 21:48:45 +0000351#define PROT_VLAN 0x8100 /* IEEE 802.1q protocol */
Stefan Roese99d4c6d2016-02-10 07:22:10 +0100352#define PROT_IPV6 0x86dd /* IPv6 over bluebook */
353#define PROT_PPP_SES 0x8864 /* PPPoE session messages */
wdenk2d966952002-10-31 22:12:35 +0000354
355#define IPPROTO_ICMP 1 /* Internet Control Message Protocol */
356#define IPPROTO_UDP 17 /* User Datagram Protocol */
357
358/*
Joe Hershbergerc5c59df2012-05-23 07:58:05 +0000359 * Internet Protocol (IP) header.
360 */
361struct ip_hdr {
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500362 u8 ip_hl_v; /* header length and version */
363 u8 ip_tos; /* type of service */
364 u16 ip_len; /* total length */
365 u16 ip_id; /* identification */
366 u16 ip_off; /* fragment offset field */
367 u8 ip_ttl; /* time to live */
368 u8 ip_p; /* protocol */
369 u16 ip_sum; /* checksum */
Joe Hershberger049a95a2015-04-08 01:41:01 -0500370 struct in_addr ip_src; /* Source IP address */
371 struct in_addr ip_dst; /* Destination IP address */
Denis Pynkin704f3ac2017-07-21 19:28:42 +0300372} __attribute__((packed));
Joe Hershbergerc5c59df2012-05-23 07:58:05 +0000373
374#define IP_OFFS 0x1fff /* ip offset *= 8 */
375#define IP_FLAGS 0xe000 /* first 3 bits */
376#define IP_FLAGS_RES 0x8000 /* reserved */
377#define IP_FLAGS_DFRAG 0x4000 /* don't fragments */
378#define IP_FLAGS_MFRAG 0x2000 /* more fragments */
379
380#define IP_HDR_SIZE (sizeof(struct ip_hdr))
381
382/*
Joe Hershberger594c26f2012-05-23 07:58:04 +0000383 * Internet Protocol (IP) + UDP header.
wdenk2d966952002-10-31 22:12:35 +0000384 */
Joe Hershberger594c26f2012-05-23 07:58:04 +0000385struct ip_udp_hdr {
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500386 u8 ip_hl_v; /* header length and version */
387 u8 ip_tos; /* type of service */
388 u16 ip_len; /* total length */
389 u16 ip_id; /* identification */
390 u16 ip_off; /* fragment offset field */
391 u8 ip_ttl; /* time to live */
392 u8 ip_p; /* protocol */
393 u16 ip_sum; /* checksum */
Joe Hershberger049a95a2015-04-08 01:41:01 -0500394 struct in_addr ip_src; /* Source IP address */
395 struct in_addr ip_dst; /* Destination IP address */
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500396 u16 udp_src; /* UDP source port */
397 u16 udp_dst; /* UDP destination port */
398 u16 udp_len; /* Length of UDP packet */
399 u16 udp_xsum; /* Checksum */
Denis Pynkin704f3ac2017-07-21 19:28:42 +0300400} __attribute__((packed));
wdenk2d966952002-10-31 22:12:35 +0000401
Joe Hershberger594c26f2012-05-23 07:58:04 +0000402#define IP_UDP_HDR_SIZE (sizeof(struct ip_udp_hdr))
Joe Hershbergerc5c59df2012-05-23 07:58:05 +0000403#define UDP_HDR_SIZE (IP_UDP_HDR_SIZE - IP_HDR_SIZE)
wdenk2d966952002-10-31 22:12:35 +0000404
405/*
406 * Address Resolution Protocol (ARP) header.
407 */
Joe Hershberger738853b2012-05-23 07:58:08 +0000408struct arp_hdr {
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500409 u16 ar_hrd; /* Format of hardware address */
wdenk2d966952002-10-31 22:12:35 +0000410# define ARP_ETHER 1 /* Ethernet hardware address */
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500411 u16 ar_pro; /* Format of protocol address */
412 u8 ar_hln; /* Length of hardware address */
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500413 u8 ar_pln; /* Length of protocol address */
Joe Hershberger674bb242012-05-23 07:58:17 +0000414# define ARP_PLEN 4
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500415 u16 ar_op; /* Operation */
wdenk2d966952002-10-31 22:12:35 +0000416# define ARPOP_REQUEST 1 /* Request to resolve address */
417# define ARPOP_REPLY 2 /* Response to previous request */
418
419# define RARPOP_REQUEST 3 /* Request to resolve address */
420# define RARPOP_REPLY 4 /* Response to previous request */
421
422 /*
wdenk8bde7f72003-06-27 21:31:46 +0000423 * The remaining fields are variable in size, according to
424 * the sizes above, and are defined as appropriate for
425 * specific hardware/protocol combinations.
wdenk2d966952002-10-31 22:12:35 +0000426 */
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500427 u8 ar_data[0];
Joe Hershberger674bb242012-05-23 07:58:17 +0000428#define ar_sha ar_data[0]
429#define ar_spa ar_data[ARP_HLEN]
430#define ar_tha ar_data[ARP_HLEN + ARP_PLEN]
431#define ar_tpa ar_data[ARP_HLEN + ARP_PLEN + ARP_HLEN]
wdenk2d966952002-10-31 22:12:35 +0000432#if 0
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500433 u8 ar_sha[]; /* Sender hardware address */
434 u8 ar_spa[]; /* Sender protocol address */
435 u8 ar_tha[]; /* Target hardware address */
436 u8 ar_tpa[]; /* Target protocol address */
wdenk2d966952002-10-31 22:12:35 +0000437#endif /* 0 */
Denis Pynkin704f3ac2017-07-21 19:28:42 +0300438} __attribute__((packed));
wdenk2d966952002-10-31 22:12:35 +0000439
440#define ARP_HDR_SIZE (8+20) /* Size assuming ethernet */
441
442/*
443 * ICMP stuff (just enough to handle (host) redirect messages)
444 */
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200445#define ICMP_ECHO_REPLY 0 /* Echo reply */
Simon Glass4793ee62011-10-24 18:00:01 +0000446#define ICMP_NOT_REACH 3 /* Detination unreachable */
wdenk2d966952002-10-31 22:12:35 +0000447#define ICMP_REDIRECT 5 /* Redirect (change route) */
wdenk73a8b272003-06-05 19:27:42 +0000448#define ICMP_ECHO_REQUEST 8 /* Echo request */
wdenk2d966952002-10-31 22:12:35 +0000449
450/* Codes for REDIRECT. */
451#define ICMP_REDIR_NET 0 /* Redirect Net */
452#define ICMP_REDIR_HOST 1 /* Redirect Host */
453
Simon Glass4793ee62011-10-24 18:00:01 +0000454/* Codes for NOT_REACH */
455#define ICMP_NOT_REACH_PORT 3 /* Port unreachable */
456
Joe Hershbergere0a63072012-05-23 07:58:09 +0000457struct icmp_hdr {
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500458 u8 type;
459 u8 code;
460 u16 checksum;
wdenk2d966952002-10-31 22:12:35 +0000461 union {
462 struct {
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500463 u16 id;
464 u16 sequence;
wdenk2d966952002-10-31 22:12:35 +0000465 } echo;
Sergey Temerkhanov5917e7d2015-04-08 01:41:22 -0500466 u32 gateway;
wdenk2d966952002-10-31 22:12:35 +0000467 struct {
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500468 u16 unused;
469 u16 mtu;
wdenk2d966952002-10-31 22:12:35 +0000470 } frag;
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500471 u8 data[0];
wdenk2d966952002-10-31 22:12:35 +0000472 } un;
Denis Pynkin704f3ac2017-07-21 19:28:42 +0300473} __attribute__((packed));
wdenk2d966952002-10-31 22:12:35 +0000474
Joe Hershbergere0a63072012-05-23 07:58:09 +0000475#define ICMP_HDR_SIZE (sizeof(struct icmp_hdr))
476#define IP_ICMP_HDR_SIZE (IP_HDR_SIZE + ICMP_HDR_SIZE)
wdenk2d966952002-10-31 22:12:35 +0000477
wdenk2d966952002-10-31 22:12:35 +0000478/*
Stefan Agner700877a2016-04-13 16:38:02 -0700479 * Maximum packet size; used to allocate packet storage. Use
480 * the maxium Ethernet frame size as specified by the Ethernet
481 * standard including the 802.1Q tag (VLAN tagging).
482 * maximum packet size = 1522
wdenk2d966952002-10-31 22:12:35 +0000483 * maximum packet size and multiple of 32 bytes = 1536
484 */
Stefan Agner700877a2016-04-13 16:38:02 -0700485#define PKTSIZE 1522
wdenk2d966952002-10-31 22:12:35 +0000486#define PKTSIZE_ALIGN 1536
wdenk2d966952002-10-31 22:12:35 +0000487
488/*
489 * Maximum receive ring size; that is, the number of packets
490 * we can buffer before overflow happens. Basically, this just
491 * needs to be enough to prevent a packet being discarded while
492 * we are processing the previous one.
493 */
494#define RINGSZ 4
495#define RINGSZ_LOG2 2
496
497/**********************************************************************/
498/*
499 * Globals.
500 *
501 * Note:
502 *
Joe Hershberger049a95a2015-04-08 01:41:01 -0500503 * All variables of type struct in_addr are stored in NETWORK byte order
wdenk2d966952002-10-31 22:12:35 +0000504 * (big endian).
505 */
506
507/* net.c */
508/** BOOTP EXTENTIONS **/
Joe Hershberger049a95a2015-04-08 01:41:01 -0500509extern struct in_addr net_gateway; /* Our gateway IP address */
510extern struct in_addr net_netmask; /* Our subnet mask (0 = unknown) */
511/* Our Domain Name Server (0 = unknown) */
512extern struct in_addr net_dns_server;
Jon Loeliger1fe80d72007-07-09 22:08:34 -0500513#if defined(CONFIG_BOOTP_DNS2)
Joe Hershberger049a95a2015-04-08 01:41:01 -0500514/* Our 2nd Domain Name Server (0 = unknown) */
515extern struct in_addr net_dns_server2;
stroesefe389a82003-08-28 14:17:32 +0000516#endif
Joe Hershberger586cbe52015-04-08 01:41:03 -0500517extern char net_nis_domain[32]; /* Our IS domain */
518extern char net_hostname[32]; /* Our hostname */
519extern char net_root_path[64]; /* Our root path */
wdenk2d966952002-10-31 22:12:35 +0000520/** END OF BOOTP EXTENTIONS **/
oliver@schinagl.nla40db6d2016-11-25 16:30:19 +0100521extern u8 net_ethaddr[ARP_HLEN]; /* Our ethernet address */
522extern u8 net_server_ethaddr[ARP_HLEN]; /* Boot server enet address */
Joe Hershberger049a95a2015-04-08 01:41:01 -0500523extern struct in_addr net_ip; /* Our IP addr (0 = unknown) */
524extern struct in_addr net_server_ip; /* Server IP addr (0 = unknown) */
Joe Hershberger1203fcc2015-04-08 01:41:05 -0500525extern uchar *net_tx_packet; /* THE transmit packet */
Joe Hershberger2a504df2015-03-22 17:09:11 -0500526extern uchar *net_rx_packets[PKTBUFSRX]; /* Receive packets */
Joe Hershberger1203fcc2015-04-08 01:41:05 -0500527extern uchar *net_rx_packet; /* Current receive packet */
528extern int net_rx_packet_len; /* Current rx packet length */
oliver@schinagl.nla40db6d2016-11-25 16:30:19 +0100529extern const u8 net_bcast_ethaddr[ARP_HLEN]; /* Ethernet broadcast address */
530extern const u8 net_null_ethaddr[ARP_HLEN];
wdenk2d966952002-10-31 22:12:35 +0000531
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000532#define VLAN_NONE 4095 /* untagged */
533#define VLAN_IDMASK 0x0fff /* mask of valid vlan id */
Joe Hershberger4fd50552015-04-08 01:41:17 -0500534extern ushort net_our_vlan; /* Our VLAN */
535extern ushort net_native_vlan; /* Our Native VLAN */
wdenka3d991b2004-04-15 21:48:45 +0000536
Joe Hershbergerbc0571f2015-04-08 01:41:21 -0500537extern int net_restart_wrap; /* Tried all network devices */
wdenk2d966952002-10-31 22:12:35 +0000538
Simon Glasse4bf0c52011-10-24 18:00:02 +0000539enum proto_t {
540 BOOTP, RARP, ARP, TFTPGET, DHCP, PING, DNS, NFS, CDP, NETCONS, SNTP,
Joe Hershbergerd22c3382012-05-23 08:00:12 +0000541 TFTPSRV, TFTPPUT, LINKLOCAL
Simon Glasse4bf0c52011-10-24 18:00:02 +0000542};
wdenk2d966952002-10-31 22:12:35 +0000543
Jacob Stiffler11a69ff2015-09-30 10:12:05 -0400544extern char net_boot_file_name[1024];/* Boot File name */
Joe Hershberger14111572015-04-08 01:41:02 -0500545/* The actual transferred size of the bootfile (in bytes) */
546extern u32 net_boot_file_size;
547/* Boot file size in blocks as reported by the DHCP server */
548extern u32 net_boot_file_expected_size_in_blocks;
wdenk2d966952002-10-31 22:12:35 +0000549
Robin Getz1a32bf42009-07-20 14:53:54 -0400550#if defined(CONFIG_CMD_DNS)
Joe Hershberger786eac52015-04-08 01:41:15 -0500551extern char *net_dns_resolve; /* The host to resolve */
552extern char *net_dns_env_var; /* the env var to put the ip into */
Robin Getz1a32bf42009-07-20 14:53:54 -0400553#endif
554
Jon Loeliger639221c2007-07-09 17:15:49 -0500555#if defined(CONFIG_CMD_PING)
Joe Hershberger049a95a2015-04-08 01:41:01 -0500556extern struct in_addr net_ping_ip; /* the ip address to ping */
wdenk73a8b272003-06-05 19:27:42 +0000557#endif
558
Jon Loeliger639221c2007-07-09 17:15:49 -0500559#if defined(CONFIG_CMD_CDP)
wdenka3d991b2004-04-15 21:48:45 +0000560/* when CDP completes these hold the return values */
Joe Hershberger6aede5b2015-04-08 01:41:14 -0500561extern ushort cdp_native_vlan; /* CDP returned native VLAN */
562extern ushort cdp_appliance_vlan; /* CDP returned appliance VLAN */
Joe Hershberger17351882012-05-23 07:58:00 +0000563
564/*
565 * Check for a CDP packet by examining the received MAC address field
566 */
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500567static inline int is_cdp_packet(const uchar *ethaddr)
Joe Hershberger17351882012-05-23 07:58:00 +0000568{
oliver@schinagl.nla40db6d2016-11-25 16:30:19 +0100569 extern const u8 net_cdp_ethaddr[ARP_HLEN];
Joe Hershberger17351882012-05-23 07:58:00 +0000570
oliver@schinagl.nla40db6d2016-11-25 16:30:19 +0100571 return memcmp(ethaddr, net_cdp_ethaddr, ARP_HLEN) == 0;
Joe Hershberger17351882012-05-23 07:58:00 +0000572}
wdenka3d991b2004-04-15 21:48:45 +0000573#endif
574
Jon Loeliger639221c2007-07-09 17:15:49 -0500575#if defined(CONFIG_CMD_SNTP)
Joe Hershberger049a95a2015-04-08 01:41:01 -0500576extern struct in_addr net_ntp_server; /* the ip address to NTP */
Joe Hershbergerbc0571f2015-04-08 01:41:21 -0500577extern int net_ntp_time_offset; /* offset time from UTC */
wdenkea287de2005-04-01 00:25:43 +0000578#endif
579
Joe Hershberger13dfe942012-05-15 08:59:12 +0000580#if defined(CONFIG_MCAST_TFTP)
Joe Hershberger049a95a2015-04-08 01:41:01 -0500581extern struct in_addr net_mcast_addr;
Joe Hershberger13dfe942012-05-15 08:59:12 +0000582#endif
583
wdenk2d966952002-10-31 22:12:35 +0000584/* Initialize the network adapter */
Joe Hershbergerff997432015-03-22 17:09:02 -0500585void net_init(void);
Joe Hershbergerbc0571f2015-04-08 01:41:21 -0500586int net_loop(enum proto_t);
wdenk2d966952002-10-31 22:12:35 +0000587
588/* Load failed. Start again. */
Joe Hershbergerbc0571f2015-04-08 01:41:21 -0500589int net_start_again(void);
wdenk2d966952002-10-31 22:12:35 +0000590
wdenka3d991b2004-04-15 21:48:45 +0000591/* Get size of the ethernet header when we send */
Joe Hershberger1203fcc2015-04-08 01:41:05 -0500592int net_eth_hdr_size(void);
wdenka3d991b2004-04-15 21:48:45 +0000593
594/* Set ethernet header; returns the size of the header */
Joe Hershberger1203fcc2015-04-08 01:41:05 -0500595int net_set_ether(uchar *xet, const uchar *dest_ethaddr, uint prot);
Joe Hershbergerff997432015-03-22 17:09:02 -0500596int net_update_ether(struct ethernet_hdr *et, uchar *addr, uint prot);
wdenk2d966952002-10-31 22:12:35 +0000597
598/* Set IP header */
Joe Hershberger049a95a2015-04-08 01:41:01 -0500599void net_set_ip_header(uchar *pkt, struct in_addr dest, struct in_addr source);
600void net_set_udp_header(uchar *pkt, struct in_addr dest, int dport,
Joe Hershberger4b11c912012-05-23 07:59:07 +0000601 int sport, int len);
wdenk2d966952002-10-31 22:12:35 +0000602
Simon Glass9b0e35c2015-01-19 22:16:07 -0700603/**
604 * compute_ip_checksum() - Compute IP checksum
605 *
606 * @addr: Address to check (must be 16-bit aligned)
607 * @nbytes: Number of bytes to check (normally a multiple of 2)
608 * @return 16-bit IP checksum
609 */
610unsigned compute_ip_checksum(const void *addr, unsigned nbytes);
611
612/**
613 * add_ip_checksums() - add two IP checksums
614 *
615 * @offset: Offset of first sum (if odd we do a byte-swap)
616 * @sum: First checksum
617 * @new_sum: New checksum to add
618 * @return updated 16-bit IP checksum
619 */
620unsigned add_ip_checksums(unsigned offset, unsigned sum, unsigned new_sum);
621
622/**
623 * ip_checksum_ok() - check if a checksum is correct
624 *
625 * This works by making sure the checksum sums to 0
626 *
627 * @addr: Address to check (must be 16-bit aligned)
628 * @nbytes: Number of bytes to check (normally a multiple of 2)
629 * @return true if the checksum matches, false if not
630 */
631int ip_checksum_ok(const void *addr, unsigned nbytes);
632
Joe Hershbergerd280d3f2012-05-23 07:58:01 +0000633/* Callbacks */
Joe Hershbergerff997432015-03-22 17:09:02 -0500634rxhand_f *net_get_udp_handler(void); /* Get UDP RX packet handler */
635void net_set_udp_handler(rxhand_f *); /* Set UDP RX packet handler */
636rxhand_f *net_get_arp_handler(void); /* Get ARP RX packet handler */
637void net_set_arp_handler(rxhand_f *); /* Set ARP RX packet handler */
638void net_set_icmp_handler(rxhand_icmp_f *f); /* Set ICMP RX handler */
Joe Hershbergerbc0571f2015-04-08 01:41:21 -0500639void net_set_timeout_handler(ulong, thand_f *);/* Set timeout handler */
wdenk2d966952002-10-31 22:12:35 +0000640
Joe Hershberger22f6e992012-05-23 07:59:14 +0000641/* Network loop state */
642enum net_loop_state {
643 NETLOOP_CONTINUE,
644 NETLOOP_RESTART,
645 NETLOOP_SUCCESS,
646 NETLOOP_FAIL
647};
Kim Phillips06370592012-10-29 13:34:33 +0000648extern enum net_loop_state net_state;
649
Joe Hershberger22f6e992012-05-23 07:59:14 +0000650static inline void net_set_state(enum net_loop_state state)
651{
Joe Hershberger4ef8d532012-05-23 08:01:04 +0000652 debug_cond(DEBUG_INT_STATE, "--- NetState set to %d\n", state);
Joe Hershberger22f6e992012-05-23 07:59:14 +0000653 net_state = state;
654}
655
Joe Hershbergere94070c2012-05-23 07:59:24 +0000656/* Transmit a packet */
Joe Hershberger1203fcc2015-04-08 01:41:05 -0500657static inline void net_send_packet(uchar *pkt, int len)
Joe Hershbergeradf5d932012-05-23 07:59:13 +0000658{
Joe Hershberger60304592015-03-22 17:09:24 -0500659 /* Currently no way to return errors from eth_send() */
Joe Hershbergeradf5d932012-05-23 07:59:13 +0000660 (void) eth_send(pkt, len);
661}
wdenk2d966952002-10-31 22:12:35 +0000662
Joe Hershberger206d07f2012-05-23 07:58:10 +0000663/*
Joe Hershberger1203fcc2015-04-08 01:41:05 -0500664 * Transmit "net_tx_packet" as UDP packet, performing ARP request if needed
Joe Hershbergerece223b2012-05-23 07:59:15 +0000665 * (ether will be populated)
Joe Hershberger206d07f2012-05-23 07:58:10 +0000666 *
667 * @param ether Raw packet buffer
668 * @param dest IP address to send the datagram to
669 * @param dport Destination UDP port
670 * @param sport Source UDP port
671 * @param payload_len Length of data after the UDP header
672 */
Joe Hershberger1203fcc2015-04-08 01:41:05 -0500673int net_send_udp_packet(uchar *ether, struct in_addr dest, int dport,
Joe Hershberger206d07f2012-05-23 07:58:10 +0000674 int sport, int payload_len);
wdenk73a8b272003-06-05 19:27:42 +0000675
wdenk2d966952002-10-31 22:12:35 +0000676/* Processes a received packet */
Joe Hershberger2a504df2015-03-22 17:09:11 -0500677void net_process_received_packet(uchar *in_packet, int len);
wdenk2d966952002-10-31 22:12:35 +0000678
Jason Kridner99761e52018-03-07 05:40:43 -0500679#if defined(CONFIG_NETCONSOLE) && !defined(CONFIG_SPL_BUILD)
Joe Hershberger6a38a5f2015-04-08 01:41:16 -0500680void nc_start(void);
Joe Hershberger049a95a2015-04-08 01:41:01 -0500681int nc_input_packet(uchar *pkt, struct in_addr src_ip, unsigned dest_port,
Joe Hershberger8a0eccb2012-09-18 10:01:32 +0000682 unsigned src_port, unsigned len);
Joe Hershberger48522bb2012-05-15 08:59:08 +0000683#endif
684
Fabio Estevam92163872015-11-08 22:25:14 -0200685static __always_inline int eth_is_on_demand_init(void)
Joe Hershbergerf8be7d62012-08-03 10:59:08 +0000686{
Jason Kridner99761e52018-03-07 05:40:43 -0500687#if defined(CONFIG_NETCONSOLE) && !defined(CONFIG_SPL_BUILD)
Joe Hershbergerf8be7d62012-08-03 10:59:08 +0000688 extern enum proto_t net_loop_last_protocol;
689
690 return net_loop_last_protocol != NETCONS;
691#else
692 return 1;
693#endif
694}
695
696static inline void eth_set_last_protocol(int protocol)
697{
Jason Kridner99761e52018-03-07 05:40:43 -0500698#if defined(CONFIG_NETCONSOLE) && !defined(CONFIG_SPL_BUILD)
Joe Hershbergerf8be7d62012-08-03 10:59:08 +0000699 extern enum proto_t net_loop_last_protocol;
700
701 net_loop_last_protocol = protocol;
702#endif
703}
704
wdenk2d966952002-10-31 22:12:35 +0000705/*
Simon Glasse4a3d572011-10-27 06:24:32 +0000706 * Check if autoload is enabled. If so, use either NFS or TFTP to download
707 * the boot file.
708 */
709void net_auto_load(void);
710
711/*
wdenk2d966952002-10-31 22:12:35 +0000712 * The following functions are a bit ugly, but necessary to deal with
713 * alignment restrictions on ARM.
714 *
715 * We're using inline functions, which had the smallest memory
716 * footprint in our tests.
717 */
718/* return IP *in network byteorder* */
Joe Hershberger049a95a2015-04-08 01:41:01 -0500719static inline struct in_addr net_read_ip(void *from)
wdenk2d966952002-10-31 22:12:35 +0000720{
Joe Hershberger049a95a2015-04-08 01:41:01 -0500721 struct in_addr ip;
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000722
723 memcpy((void *)&ip, (void *)from, sizeof(ip));
wdenk2d966952002-10-31 22:12:35 +0000724 return ip;
725}
726
727/* return ulong *in network byteorder* */
Sergey Temerkhanov5917e7d2015-04-08 01:41:22 -0500728static inline u32 net_read_u32(u32 *from)
wdenk2d966952002-10-31 22:12:35 +0000729{
Sergey Temerkhanov5917e7d2015-04-08 01:41:22 -0500730 u32 l;
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000731
732 memcpy((void *)&l, (void *)from, sizeof(l));
wdenk2d966952002-10-31 22:12:35 +0000733 return l;
734}
735
736/* write IP *in network byteorder* */
Joe Hershberger049a95a2015-04-08 01:41:01 -0500737static inline void net_write_ip(void *to, struct in_addr ip)
wdenk2d966952002-10-31 22:12:35 +0000738{
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000739 memcpy(to, (void *)&ip, sizeof(ip));
wdenk2d966952002-10-31 22:12:35 +0000740}
741
742/* copy IP */
Joe Hershberger049a95a2015-04-08 01:41:01 -0500743static inline void net_copy_ip(void *to, void *from)
wdenk2d966952002-10-31 22:12:35 +0000744{
Joe Hershberger049a95a2015-04-08 01:41:01 -0500745 memcpy((void *)to, from, sizeof(struct in_addr));
wdenk2d966952002-10-31 22:12:35 +0000746}
747
748/* copy ulong */
Sergey Temerkhanov5917e7d2015-04-08 01:41:22 -0500749static inline void net_copy_u32(u32 *to, u32 *from)
wdenk2d966952002-10-31 22:12:35 +0000750{
Sergey Temerkhanov5917e7d2015-04-08 01:41:22 -0500751 memcpy((void *)to, (void *)from, sizeof(u32));
wdenk2d966952002-10-31 22:12:35 +0000752}
753
Mike Rapoport50cca8b2007-08-12 08:48:27 +0300754/**
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500755 * is_zero_ethaddr - Determine if give Ethernet address is all zeros.
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 all zeroes.
759 */
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500760static inline int is_zero_ethaddr(const u8 *addr)
Mike Rapoport50cca8b2007-08-12 08:48:27 +0300761{
762 return !(addr[0] | addr[1] | addr[2] | addr[3] | addr[4] | addr[5]);
763}
764
765/**
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500766 * is_multicast_ethaddr - Determine if the Ethernet address is a multicast.
Mike Rapoport50cca8b2007-08-12 08:48:27 +0300767 * @addr: Pointer to a six-byte array containing the Ethernet address
768 *
769 * Return true if the address is a multicast address.
770 * By definition the broadcast address is also a multicast address.
771 */
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500772static inline int is_multicast_ethaddr(const u8 *addr)
Mike Rapoport50cca8b2007-08-12 08:48:27 +0300773{
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000774 return 0x01 & addr[0];
Mike Rapoport50cca8b2007-08-12 08:48:27 +0300775}
776
Remy Bohmer23cd1382009-07-29 18:18:43 +0200777/*
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500778 * is_broadcast_ethaddr - Determine if the Ethernet address is broadcast
Remy Bohmer23cd1382009-07-29 18:18:43 +0200779 * @addr: Pointer to a six-byte array containing the Ethernet address
780 *
781 * Return true if the address is the broadcast address.
782 */
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500783static inline int is_broadcast_ethaddr(const u8 *addr)
Remy Bohmer23cd1382009-07-29 18:18:43 +0200784{
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000785 return (addr[0] & addr[1] & addr[2] & addr[3] & addr[4] & addr[5]) ==
786 0xff;
Remy Bohmer23cd1382009-07-29 18:18:43 +0200787}
788
789/*
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500790 * is_valid_ethaddr - Determine if the given Ethernet address is valid
Mike Frysinger75edebe2009-01-27 16:53:39 -0500791 * @addr: Pointer to a six-byte array containing the Ethernet address
792 *
793 * Check that the Ethernet address (MAC) is not 00:00:00:00:00:00, is not
794 * a multicast address, and is not FF:FF:FF:FF:FF:FF.
795 *
796 * Return true if the address is valid.
797 */
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500798static inline int is_valid_ethaddr(const u8 *addr)
Mike Frysinger75edebe2009-01-27 16:53:39 -0500799{
800 /* FF:FF:FF:FF:FF:FF is a multicast address so we don't need to
801 * explicitly check for it here. */
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500802 return !is_multicast_ethaddr(addr) && !is_zero_ethaddr(addr);
Mike Frysinger75edebe2009-01-27 16:53:39 -0500803}
804
Masahiro Yamadada384a92014-04-18 19:09:48 +0900805/**
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500806 * net_random_ethaddr - Generate software assigned random Ethernet address
Masahiro Yamadada384a92014-04-18 19:09:48 +0900807 * @addr: Pointer to a six-byte array containing the Ethernet address
808 *
809 * Generate a random Ethernet address (MAC) that is not multicast
810 * and has the local assigned bit set.
811 */
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500812static inline void net_random_ethaddr(uchar *addr)
Masahiro Yamadada384a92014-04-18 19:09:48 +0900813{
814 int i;
815 unsigned int seed = get_timer(0);
816
817 for (i = 0; i < 6; i++)
818 addr[i] = rand_r(&seed);
819
820 addr[0] &= 0xfe; /* clear multicast bit */
821 addr[0] |= 0x02; /* set local assignment bit (IEEE802) */
822}
823
wdenk2d966952002-10-31 22:12:35 +0000824/* Convert an IP address to a string */
Joe Hershberger049a95a2015-04-08 01:41:01 -0500825void ip_to_string(struct in_addr x, char *s);
wdenk2d966952002-10-31 22:12:35 +0000826
wdenk73a8b272003-06-05 19:27:42 +0000827/* Convert a string to ip address */
Joe Hershberger049a95a2015-04-08 01:41:01 -0500828struct in_addr string_to_ip(const char *s);
wdenk73a8b272003-06-05 19:27:42 +0000829
wdenka3d991b2004-04-15 21:48:45 +0000830/* Convert a VLAN id to a string */
Joe Hershberger4fd50552015-04-08 01:41:17 -0500831void vlan_to_string(ushort x, char *s);
wdenka3d991b2004-04-15 21:48:45 +0000832
833/* Convert a string to a vlan id */
Joe Hershberger4fd50552015-04-08 01:41:17 -0500834ushort string_to_vlan(const char *s);
wdenka3d991b2004-04-15 21:48:45 +0000835
wdenka3d991b2004-04-15 21:48:45 +0000836/* read a VLAN id from an environment variable */
Simon Glass723806c2017-08-03 12:22:15 -0600837ushort env_get_vlan(char *);
wdenka3d991b2004-04-15 21:48:45 +0000838
wdenk2d966952002-10-31 22:12:35 +0000839/* copy a filename (allow for "..." notation, limit length) */
Joe Hershbergerff997432015-03-22 17:09:02 -0500840void copy_filename(char *dst, const char *src, int size);
wdenk2d966952002-10-31 22:12:35 +0000841
Mike Frysinger91b469c2009-09-02 04:18:55 -0400842/* get a random source port */
Joe Hershbergerff997432015-03-22 17:09:02 -0500843unsigned int random_port(void);
Mike Frysinger91b469c2009-09-02 04:18:55 -0400844
Lukasz Majewskic7ff5522015-08-24 00:21:47 +0200845/**
846 * update_tftp - Update firmware over TFTP (via DFU)
847 *
848 * This function updates board's firmware via TFTP
849 *
850 * @param addr - memory address where data is stored
851 * @param interface - the DFU medium name - e.g. "mmc"
852 * @param devstring - the DFU medium number - e.g. "1"
853 *
854 * @return - 0 on success, other value on failure
855 */
856int update_tftp(ulong addr, char *interface, char *devstring);
Simon Glassea5427e2013-05-15 06:23:54 +0000857
wdenk2d966952002-10-31 22:12:35 +0000858/**********************************************************************/
859
860#endif /* __NET_H__ */