blob: 7684076af63c09e0bb523e144c8e8758217b54d2 [file] [log] [blame]
Tom Rinif739fcd2018-05-07 17:02:21 -04001/* SPDX-License-Identifier: GPL-2.0 */
wdenk2d966952002-10-31 22:12:35 +00002/*
3 * LiMon Monitor (LiMon) - Network.
4 *
5 * Copyright 1994 - 2000 Neil Russell.
6 * (See License)
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 */
Bin Mengdda52512018-07-31 02:55:22 -070017#include <linux/if_ether.h>
wdenk2d966952002-10-31 22:12:35 +000018
Joe Hershberger4ef8d532012-05-23 08:01:04 +000019#define DEBUG_LL_STATE 0 /* Link local state machine changes */
20#define DEBUG_DEV_PKT 0 /* Packets or info directed to the device */
21#define DEBUG_NET_PKT 0 /* Packets on info on the network at large */
22#define DEBUG_INT_STATE 0 /* Internal network state changes */
wdenk2d966952002-10-31 22:12:35 +000023
24/*
25 * The number of receive packet buffers, and the required packet buffer
26 * alignment in memory.
27 *
28 */
29
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +020030#ifdef CONFIG_SYS_RX_ETH_BUFFER
31# define PKTBUFSRX CONFIG_SYS_RX_ETH_BUFFER
wdenk1d0350e2002-11-11 21:14:20 +000032#else
stroesec6028832003-06-05 15:38:29 +000033# define PKTBUFSRX 4
wdenk1d0350e2002-11-11 21:14:20 +000034#endif
35
Eric Nelson2c4b3c12012-03-15 18:33:24 +000036#define PKTALIGN ARCH_DMA_MINALIGN
wdenk2d966952002-10-31 22:12:35 +000037
oliver@schinagl.nla40db6d2016-11-25 16:30:19 +010038/* ARP hardware address length */
39#define ARP_HLEN 6
oliver@schinagl.nl9f455bc2016-11-25 16:30:20 +010040/*
41 * The size of a MAC address in string form, each digit requires two chars
42 * and five separator characters to form '00:00:00:00:00:00'.
43 */
44#define ARP_HLEN_ASCII (ARP_HLEN * 2) + (ARP_HLEN - 1)
oliver@schinagl.nla40db6d2016-11-25 16:30:19 +010045
Matthias Weisserea45cb02011-12-03 03:29:44 +000046/* IPv4 addresses are always 32 bits in size */
Joe Hershberger049a95a2015-04-08 01:41:01 -050047struct in_addr {
48 __be32 s_addr;
49};
wdenk2d966952002-10-31 22:12:35 +000050
Luca Ceresoli03eb1292011-04-18 06:19:50 +000051/**
52 * An incoming packet handler.
53 * @param pkt pointer to the application packet
54 * @param dport destination UDP port
55 * @param sip source IP address
56 * @param sport source UDP port
57 * @param len packet length
wdenk2d966952002-10-31 22:12:35 +000058 */
Luca Ceresoli03eb1292011-04-18 06:19:50 +000059typedef void rxhand_f(uchar *pkt, unsigned dport,
Joe Hershberger049a95a2015-04-08 01:41:01 -050060 struct in_addr sip, unsigned sport,
Luca Ceresoli03eb1292011-04-18 06:19:50 +000061 unsigned len);
wdenk2d966952002-10-31 22:12:35 +000062
Simon Glass4793ee62011-10-24 18:00:01 +000063/**
64 * An incoming ICMP packet handler.
65 * @param type ICMP type
66 * @param code ICMP code
67 * @param dport destination UDP port
68 * @param sip source IP address
69 * @param sport source UDP port
70 * @param pkt pointer to the ICMP packet data
71 * @param len packet length
72 */
73typedef void rxhand_icmp_f(unsigned type, unsigned code, unsigned dport,
Joe Hershberger049a95a2015-04-08 01:41:01 -050074 struct in_addr sip, unsigned sport, uchar *pkt, unsigned len);
Simon Glass4793ee62011-10-24 18:00:01 +000075
wdenk2d966952002-10-31 22:12:35 +000076/*
77 * A timeout handler. Called after time interval has expired.
78 */
79typedef void thand_f(void);
80
wdenk2d966952002-10-31 22:12:35 +000081enum eth_state_t {
82 ETH_STATE_INIT,
83 ETH_STATE_PASSIVE,
84 ETH_STATE_ACTIVE
85};
86
Joe Hershberger05c3e682015-03-22 17:09:10 -050087#ifdef CONFIG_DM_ETH
88/**
89 * struct eth_pdata - Platform data for Ethernet MAC controllers
90 *
91 * @iobase: The base address of the hardware registers
92 * @enetaddr: The Ethernet MAC address that is loaded from EEPROM or env
Simon Glassc74c8e62015-04-05 16:07:39 -060093 * @phy_interface: PHY interface to use - see PHY_INTERFACE_MODE_...
Alexey Brodkinf74264d2016-01-13 16:59:35 +030094 * @max_speed: Maximum speed of Ethernet connection supported by MAC
Faiz Abbas3c6add92019-03-18 13:54:31 +053095 * @priv_pdata: device specific platdata
Joe Hershberger05c3e682015-03-22 17:09:10 -050096 */
97struct eth_pdata {
98 phys_addr_t iobase;
oliver@schinagl.nla40db6d2016-11-25 16:30:19 +010099 unsigned char enetaddr[ARP_HLEN];
Simon Glassc74c8e62015-04-05 16:07:39 -0600100 int phy_interface;
Alexey Brodkinf74264d2016-01-13 16:59:35 +0300101 int max_speed;
Faiz Abbas3c6add92019-03-18 13:54:31 +0530102 void *priv_pdata;
Joe Hershberger05c3e682015-03-22 17:09:10 -0500103};
104
Simon Glassa1ca92e2015-07-06 16:47:49 -0600105enum eth_recv_flags {
106 /*
107 * Check hardware device for new packets (otherwise only return those
108 * which are already in the memory buffer ready to process)
109 */
110 ETH_RECV_CHECK_DEVICE = 1 << 0,
111};
112
Joe Hershberger05c3e682015-03-22 17:09:10 -0500113/**
114 * struct eth_ops - functions of Ethernet MAC controllers
115 *
116 * start: Prepare the hardware to send and receive packets
117 * send: Send the bytes passed in "packet" as a packet on the wire
Joe Hershberger17591402015-03-22 17:09:12 -0500118 * recv: Check if the hardware received a packet. If so, set the pointer to the
119 * packet buffer in the packetp parameter. If not, return an error or 0 to
Joe Hershberger63c97292015-04-03 20:09:46 -0500120 * indicate that the hardware receive FIFO is empty. If 0 is returned, the
121 * network stack will not process the empty packet, but free_pkt() will be
122 * called if supplied
123 * free_pkt: Give the driver an opportunity to manage its packet buffer memory
124 * when the network stack is finished processing it. This will only be
125 * called when no error was returned from recv - optional
Joe Hershberger05c3e682015-03-22 17:09:10 -0500126 * stop: Stop the hardware from looking for packets - may be called even if
127 * state == PASSIVE
128 * mcast: Join or leave a multicast group (for TFTP) - optional
129 * write_hwaddr: Write a MAC address to the hardware (used to pass it to Linux
130 * on some platforms like ARM). This function expects the
Simon Glassb86f7952015-07-06 16:47:55 -0600131 * eth_pdata::enetaddr field to be populated. The method can
132 * return -ENOSYS to indicate that this is not implemented for
133 this hardware - optional.
Joe Hershberger05c3e682015-03-22 17:09:10 -0500134 * read_rom_hwaddr: Some devices have a backup of the MAC address stored in a
135 * ROM on the board. This is how the driver should expose it
136 * to the network stack. This function should fill in the
137 * eth_pdata::enetaddr field - optional
138 */
139struct eth_ops {
140 int (*start)(struct udevice *dev);
141 int (*send)(struct udevice *dev, void *packet, int length);
Simon Glassa1ca92e2015-07-06 16:47:49 -0600142 int (*recv)(struct udevice *dev, int flags, uchar **packetp);
Joe Hershberger63c97292015-04-03 20:09:46 -0500143 int (*free_pkt)(struct udevice *dev, uchar *packet, int length);
Joe Hershberger05c3e682015-03-22 17:09:10 -0500144 void (*stop)(struct udevice *dev);
Joe Hershberger05c3e682015-03-22 17:09:10 -0500145 int (*mcast)(struct udevice *dev, const u8 *enetaddr, int join);
Joe Hershberger05c3e682015-03-22 17:09:10 -0500146 int (*write_hwaddr)(struct udevice *dev);
147 int (*read_rom_hwaddr)(struct udevice *dev);
148};
149
150#define eth_get_ops(dev) ((struct eth_ops *)(dev)->driver->ops)
151
152struct udevice *eth_get_dev(void); /* get the current device */
Joe Hershbergere58780d2015-03-22 17:09:16 -0500153/*
154 * The devname can be either an exact name given by the driver or device tree
155 * or it can be an alias of the form "eth%d"
156 */
157struct udevice *eth_get_dev_by_name(const char *devname);
Joe Hershberger05c3e682015-03-22 17:09:10 -0500158unsigned char *eth_get_ethaddr(void); /* get the current device MAC */
Bernhard Nortmanneaa8a192015-09-14 15:29:43 +0200159
Joe Hershberger05c3e682015-03-22 17:09:10 -0500160/* Used only when NetConsole is enabled */
Bernhard Nortmanneaa8a192015-09-14 15:29:43 +0200161int eth_is_active(struct udevice *dev); /* Test device for active state */
Joe Hershberger05c3e682015-03-22 17:09:10 -0500162int eth_init_state_only(void); /* Set active state */
163void eth_halt_state_only(void); /* Set passive state */
164#endif
165
166#ifndef CONFIG_DM_ETH
wdenk2d966952002-10-31 22:12:35 +0000167struct eth_device {
Pankaj Bansal1666fa52018-08-02 16:31:29 +0530168#define ETH_NAME_LEN 20
oliver@schinagl.nl2c07c322016-11-25 16:30:21 +0100169 char name[ETH_NAME_LEN];
oliver@schinagl.nla40db6d2016-11-25 16:30:19 +0100170 unsigned char enetaddr[ARP_HLEN];
Michal Simek16ae7822015-01-14 16:00:39 +0100171 phys_addr_t iobase;
wdenk2d966952002-10-31 22:12:35 +0000172 int state;
173
Joe Hershbergera34f2072015-04-08 01:41:20 -0500174 int (*init)(struct eth_device *, bd_t *);
175 int (*send)(struct eth_device *, void *packet, int length);
176 int (*recv)(struct eth_device *);
177 void (*halt)(struct eth_device *);
Chris Packham67bb9842018-11-26 21:00:29 +1300178 int (*mcast)(struct eth_device *, const u8 *enetaddr, int join);
Joe Hershbergera34f2072015-04-08 01:41:20 -0500179 int (*write_hwaddr)(struct eth_device *);
wdenk2d966952002-10-31 22:12:35 +0000180 struct eth_device *next;
Michael Wallefea7dca2011-10-27 11:31:35 +0000181 int index;
wdenk2d966952002-10-31 22:12:35 +0000182 void *priv;
183};
184
Joe Hershbergerff997432015-03-22 17:09:02 -0500185int eth_register(struct eth_device *dev);/* Register network device */
186int eth_unregister(struct eth_device *dev);/* Remove network device */
Kim Phillips06370592012-10-29 13:34:33 +0000187
Kim Phillips06370592012-10-29 13:34:33 +0000188extern struct eth_device *eth_current;
189
Fabio Estevam92163872015-11-08 22:25:14 -0200190static __always_inline struct eth_device *eth_get_dev(void)
Joe Hershbergerf8be7d62012-08-03 10:59:08 +0000191{
Joe Hershbergerf8be7d62012-08-03 10:59:08 +0000192 return eth_current;
193}
Joe Hershberger84eb1fb2015-03-22 17:09:03 -0500194struct eth_device *eth_get_dev_by_name(const char *devname);
195struct eth_device *eth_get_dev_by_index(int index); /* get dev @ index */
Joe Hershberger8b2c9a72015-03-22 17:09:00 -0500196
Joe Hershberger84eb1fb2015-03-22 17:09:03 -0500197/* get the current device MAC */
Joe Hershberger8b2c9a72015-03-22 17:09:00 -0500198static inline unsigned char *eth_get_ethaddr(void)
199{
200 if (eth_current)
201 return eth_current->enetaddr;
202 return NULL;
203}
204
Bernhard Nortmanneaa8a192015-09-14 15:29:43 +0200205/* Used only when NetConsole is enabled */
206int eth_is_active(struct eth_device *dev); /* Test device for active state */
Joe Hershbergerf8be7d62012-08-03 10:59:08 +0000207/* Set active state */
Fabio Estevam92163872015-11-08 22:25:14 -0200208static __always_inline int eth_init_state_only(void)
Joe Hershbergerf8be7d62012-08-03 10:59:08 +0000209{
210 eth_get_dev()->state = ETH_STATE_ACTIVE;
211
212 return 0;
213}
214/* Set passive state */
Fabio Estevam92163872015-11-08 22:25:14 -0200215static __always_inline void eth_halt_state_only(void)
Joe Hershbergerf8be7d62012-08-03 10:59:08 +0000216{
217 eth_get_dev()->state = ETH_STATE_PASSIVE;
218}
219
Simon Glass7616e782011-06-13 16:13:10 -0700220/*
221 * Set the hardware address for an ethernet interface based on 'eth%daddr'
222 * environment variable (or just 'ethaddr' if eth_number is 0).
223 * Args:
224 * base_name - base name for device (normally "eth")
225 * eth_number - value of %d (0 for first device of this type)
226 * Returns:
227 * 0 is success, non-zero is error status from driver.
228 */
229int eth_write_hwaddr(struct eth_device *dev, const char *base_name,
230 int eth_number);
231
Joe Hershberger84eb1fb2015-03-22 17:09:03 -0500232int usb_eth_initialize(bd_t *bi);
Joe Hershberger05c3e682015-03-22 17:09:10 -0500233#endif
Joe Hershberger84eb1fb2015-03-22 17:09:03 -0500234
Joe Hershbergerd2eaec62015-03-22 17:09:06 -0500235int eth_initialize(void); /* Initialize network subsystem */
Joe Hershberger84eb1fb2015-03-22 17:09:03 -0500236void eth_try_another(int first_restart); /* Change the device */
237void eth_set_current(void); /* set nterface to ethcur var */
238
239int eth_get_dev_index(void); /* get the device index */
Joe Hershberger84eb1fb2015-03-22 17:09:03 -0500240
Roger Quadros5350bc82016-03-18 13:18:11 +0200241/**
Simon Glassfd1e9592017-08-03 12:22:11 -0600242 * eth_env_set_enetaddr_by_index() - set the MAC address environment variable
Roger Quadros5350bc82016-03-18 13:18:11 +0200243 *
244 * This sets up an environment variable with the given MAC address (@enetaddr).
245 * The environment variable to be set is defined by <@base_name><@index>addr.
246 * If @index is 0 it is omitted. For common Ethernet this means ethaddr,
247 * eth1addr, etc.
248 *
249 * @base_name: Base name for variable, typically "eth"
250 * @index: Index of interface being updated (>=0)
251 * @enetaddr: Pointer to MAC address to put into the variable
252 * @return 0 if OK, other value on error
253 */
Simon Glassfd1e9592017-08-03 12:22:11 -0600254int eth_env_set_enetaddr_by_index(const char *base_name, int index,
Roger Quadros5350bc82016-03-18 13:18:11 +0200255 uchar *enetaddr);
256
257
Joe Hershberger84eb1fb2015-03-22 17:09:03 -0500258/*
Mugunthan V Nd4a37552016-11-18 11:09:15 +0530259 * Initialize USB ethernet device with CONFIG_DM_ETH
260 * Returns:
261 * 0 is success, non-zero is error status.
262 */
263int usb_ether_init(void);
264
265/*
Joe Hershberger84eb1fb2015-03-22 17:09:03 -0500266 * Get the hardware address for an ethernet interface .
267 * Args:
268 * base_name - base name for device (normally "eth")
269 * index - device index number (0 for first)
270 * enetaddr - returns 6 byte hardware address
271 * Returns:
272 * Return true if the address is valid.
273 */
Simon Glass35affd72017-08-03 12:22:14 -0600274int eth_env_get_enetaddr_by_index(const char *base_name, int index,
Joe Hershberger84eb1fb2015-03-22 17:09:03 -0500275 uchar *enetaddr);
276
Joe Hershbergerd2eaec62015-03-22 17:09:06 -0500277int eth_init(void); /* Initialize the device */
Joe Hershberger84eb1fb2015-03-22 17:09:03 -0500278int eth_send(void *packet, int length); /* Send a packet */
279
Alexander Graf0efe1bc2016-05-06 21:01:01 +0200280#if defined(CONFIG_API) || defined(CONFIG_EFI_LOADER)
Joe Hershberger84eb1fb2015-03-22 17:09:03 -0500281int eth_receive(void *packet, int length); /* Receive a packet*/
282extern void (*push_packet)(void *packet, int length);
283#endif
284int eth_rx(void); /* Check for received packets */
285void eth_halt(void); /* stop SCC */
286const char *eth_get_name(void); /* get name of current device */
Joe Hershberger049a95a2015-04-08 01:41:01 -0500287int eth_mcast_join(struct in_addr mcast_addr, int join);
wdenk2d966952002-10-31 22:12:35 +0000288
289/**********************************************************************/
290/*
291 * Protocol headers.
292 */
293
294/*
295 * Ethernet header
296 */
Joe Hershbergercb487f52012-05-23 07:58:06 +0000297
298struct ethernet_hdr {
oliver@schinagl.nla40db6d2016-11-25 16:30:19 +0100299 u8 et_dest[ARP_HLEN]; /* Destination node */
300 u8 et_src[ARP_HLEN]; /* Source node */
301 u16 et_protlen; /* Protocol or length */
Denis Pynkin704f3ac2017-07-21 19:28:42 +0300302} __attribute__((packed));
Joe Hershbergercb487f52012-05-23 07:58:06 +0000303
304/* Ethernet header size */
305#define ETHER_HDR_SIZE (sizeof(struct ethernet_hdr))
306
Bin Menga7c3d5e2015-03-20 17:12:18 +0800307#define ETH_FCS_LEN 4 /* Octets in the FCS */
308
Joe Hershbergercb487f52012-05-23 07:58:06 +0000309struct e802_hdr {
oliver@schinagl.nla40db6d2016-11-25 16:30:19 +0100310 u8 et_dest[ARP_HLEN]; /* Destination node */
311 u8 et_src[ARP_HLEN]; /* Source node */
312 u16 et_protlen; /* Protocol or length */
313 u8 et_dsap; /* 802 DSAP */
314 u8 et_ssap; /* 802 SSAP */
315 u8 et_ctl; /* 802 control */
316 u8 et_snap1; /* SNAP */
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500317 u8 et_snap2;
318 u8 et_snap3;
oliver@schinagl.nla40db6d2016-11-25 16:30:19 +0100319 u16 et_prot; /* 802 protocol */
Denis Pynkin704f3ac2017-07-21 19:28:42 +0300320} __attribute__((packed));
wdenk2d966952002-10-31 22:12:35 +0000321
Joe Hershbergerda5ebe22012-05-23 07:58:11 +0000322/* 802 + SNAP + ethernet header size */
Joe Hershbergercb487f52012-05-23 07:58:06 +0000323#define E802_HDR_SIZE (sizeof(struct e802_hdr))
wdenka3d991b2004-04-15 21:48:45 +0000324
325/*
Joe Hershbergerda5ebe22012-05-23 07:58:11 +0000326 * Virtual LAN Ethernet header
wdenka3d991b2004-04-15 21:48:45 +0000327 */
Joe Hershbergerc68cca32012-05-23 07:58:07 +0000328struct vlan_ethernet_hdr {
oliver@schinagl.nla40db6d2016-11-25 16:30:19 +0100329 u8 vet_dest[ARP_HLEN]; /* Destination node */
330 u8 vet_src[ARP_HLEN]; /* Source node */
331 u16 vet_vlan_type; /* PROT_VLAN */
332 u16 vet_tag; /* TAG of VLAN */
333 u16 vet_type; /* protocol type */
Denis Pynkin704f3ac2017-07-21 19:28:42 +0300334} __attribute__((packed));
wdenka3d991b2004-04-15 21:48:45 +0000335
Joe Hershbergerc68cca32012-05-23 07:58:07 +0000336/* VLAN Ethernet header size */
337#define VLAN_ETHER_HDR_SIZE (sizeof(struct vlan_ethernet_hdr))
wdenka3d991b2004-04-15 21:48:45 +0000338
wdenk2d966952002-10-31 22:12:35 +0000339#define PROT_IP 0x0800 /* IP protocol */
340#define PROT_ARP 0x0806 /* IP ARP protocol */
Lothar Feltend8970da2018-06-22 22:29:54 +0200341#define PROT_WOL 0x0842 /* ether-wake WoL protocol */
wdenk2d966952002-10-31 22:12:35 +0000342#define PROT_RARP 0x8035 /* IP ARP protocol */
wdenka3d991b2004-04-15 21:48:45 +0000343#define PROT_VLAN 0x8100 /* IEEE 802.1q protocol */
Stefan Roese99d4c6d2016-02-10 07:22:10 +0100344#define PROT_IPV6 0x86dd /* IPv6 over bluebook */
345#define PROT_PPP_SES 0x8864 /* PPPoE session messages */
wdenk2d966952002-10-31 22:12:35 +0000346
347#define IPPROTO_ICMP 1 /* Internet Control Message Protocol */
348#define IPPROTO_UDP 17 /* User Datagram Protocol */
349
350/*
Joe Hershbergerc5c59df2012-05-23 07:58:05 +0000351 * Internet Protocol (IP) header.
352 */
353struct ip_hdr {
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500354 u8 ip_hl_v; /* header length and version */
355 u8 ip_tos; /* type of service */
356 u16 ip_len; /* total length */
357 u16 ip_id; /* identification */
358 u16 ip_off; /* fragment offset field */
359 u8 ip_ttl; /* time to live */
360 u8 ip_p; /* protocol */
361 u16 ip_sum; /* checksum */
Joe Hershberger049a95a2015-04-08 01:41:01 -0500362 struct in_addr ip_src; /* Source IP address */
363 struct in_addr ip_dst; /* Destination IP address */
Denis Pynkin704f3ac2017-07-21 19:28:42 +0300364} __attribute__((packed));
Joe Hershbergerc5c59df2012-05-23 07:58:05 +0000365
366#define IP_OFFS 0x1fff /* ip offset *= 8 */
367#define IP_FLAGS 0xe000 /* first 3 bits */
368#define IP_FLAGS_RES 0x8000 /* reserved */
369#define IP_FLAGS_DFRAG 0x4000 /* don't fragments */
370#define IP_FLAGS_MFRAG 0x2000 /* more fragments */
371
372#define IP_HDR_SIZE (sizeof(struct ip_hdr))
373
374/*
Joe Hershberger594c26f2012-05-23 07:58:04 +0000375 * Internet Protocol (IP) + UDP header.
wdenk2d966952002-10-31 22:12:35 +0000376 */
Joe Hershberger594c26f2012-05-23 07:58:04 +0000377struct ip_udp_hdr {
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500378 u8 ip_hl_v; /* header length and version */
379 u8 ip_tos; /* type of service */
380 u16 ip_len; /* total length */
381 u16 ip_id; /* identification */
382 u16 ip_off; /* fragment offset field */
383 u8 ip_ttl; /* time to live */
384 u8 ip_p; /* protocol */
385 u16 ip_sum; /* checksum */
Joe Hershberger049a95a2015-04-08 01:41:01 -0500386 struct in_addr ip_src; /* Source IP address */
387 struct in_addr ip_dst; /* Destination IP address */
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500388 u16 udp_src; /* UDP source port */
389 u16 udp_dst; /* UDP destination port */
390 u16 udp_len; /* Length of UDP packet */
391 u16 udp_xsum; /* Checksum */
Denis Pynkin704f3ac2017-07-21 19:28:42 +0300392} __attribute__((packed));
wdenk2d966952002-10-31 22:12:35 +0000393
Joe Hershberger594c26f2012-05-23 07:58:04 +0000394#define IP_UDP_HDR_SIZE (sizeof(struct ip_udp_hdr))
Joe Hershbergerc5c59df2012-05-23 07:58:05 +0000395#define UDP_HDR_SIZE (IP_UDP_HDR_SIZE - IP_HDR_SIZE)
wdenk2d966952002-10-31 22:12:35 +0000396
397/*
398 * Address Resolution Protocol (ARP) header.
399 */
Joe Hershberger738853b2012-05-23 07:58:08 +0000400struct arp_hdr {
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500401 u16 ar_hrd; /* Format of hardware address */
wdenk2d966952002-10-31 22:12:35 +0000402# define ARP_ETHER 1 /* Ethernet hardware address */
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500403 u16 ar_pro; /* Format of protocol address */
404 u8 ar_hln; /* Length of hardware address */
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500405 u8 ar_pln; /* Length of protocol address */
Joe Hershberger674bb242012-05-23 07:58:17 +0000406# define ARP_PLEN 4
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500407 u16 ar_op; /* Operation */
wdenk2d966952002-10-31 22:12:35 +0000408# define ARPOP_REQUEST 1 /* Request to resolve address */
409# define ARPOP_REPLY 2 /* Response to previous request */
410
411# define RARPOP_REQUEST 3 /* Request to resolve address */
412# define RARPOP_REPLY 4 /* Response to previous request */
413
414 /*
wdenk8bde7f72003-06-27 21:31:46 +0000415 * The remaining fields are variable in size, according to
416 * the sizes above, and are defined as appropriate for
417 * specific hardware/protocol combinations.
wdenk2d966952002-10-31 22:12:35 +0000418 */
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500419 u8 ar_data[0];
Joe Hershberger674bb242012-05-23 07:58:17 +0000420#define ar_sha ar_data[0]
421#define ar_spa ar_data[ARP_HLEN]
422#define ar_tha ar_data[ARP_HLEN + ARP_PLEN]
423#define ar_tpa ar_data[ARP_HLEN + ARP_PLEN + ARP_HLEN]
wdenk2d966952002-10-31 22:12:35 +0000424#if 0
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500425 u8 ar_sha[]; /* Sender hardware address */
426 u8 ar_spa[]; /* Sender protocol address */
427 u8 ar_tha[]; /* Target hardware address */
428 u8 ar_tpa[]; /* Target protocol address */
wdenk2d966952002-10-31 22:12:35 +0000429#endif /* 0 */
Denis Pynkin704f3ac2017-07-21 19:28:42 +0300430} __attribute__((packed));
wdenk2d966952002-10-31 22:12:35 +0000431
432#define ARP_HDR_SIZE (8+20) /* Size assuming ethernet */
433
434/*
435 * ICMP stuff (just enough to handle (host) redirect messages)
436 */
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200437#define ICMP_ECHO_REPLY 0 /* Echo reply */
Simon Glass4793ee62011-10-24 18:00:01 +0000438#define ICMP_NOT_REACH 3 /* Detination unreachable */
wdenk2d966952002-10-31 22:12:35 +0000439#define ICMP_REDIRECT 5 /* Redirect (change route) */
wdenk73a8b272003-06-05 19:27:42 +0000440#define ICMP_ECHO_REQUEST 8 /* Echo request */
wdenk2d966952002-10-31 22:12:35 +0000441
442/* Codes for REDIRECT. */
443#define ICMP_REDIR_NET 0 /* Redirect Net */
444#define ICMP_REDIR_HOST 1 /* Redirect Host */
445
Simon Glass4793ee62011-10-24 18:00:01 +0000446/* Codes for NOT_REACH */
447#define ICMP_NOT_REACH_PORT 3 /* Port unreachable */
448
Joe Hershbergere0a63072012-05-23 07:58:09 +0000449struct icmp_hdr {
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500450 u8 type;
451 u8 code;
452 u16 checksum;
wdenk2d966952002-10-31 22:12:35 +0000453 union {
454 struct {
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500455 u16 id;
456 u16 sequence;
wdenk2d966952002-10-31 22:12:35 +0000457 } echo;
Sergey Temerkhanov5917e7d2015-04-08 01:41:22 -0500458 u32 gateway;
wdenk2d966952002-10-31 22:12:35 +0000459 struct {
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500460 u16 unused;
461 u16 mtu;
wdenk2d966952002-10-31 22:12:35 +0000462 } frag;
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500463 u8 data[0];
wdenk2d966952002-10-31 22:12:35 +0000464 } un;
Denis Pynkin704f3ac2017-07-21 19:28:42 +0300465} __attribute__((packed));
wdenk2d966952002-10-31 22:12:35 +0000466
Joe Hershbergere0a63072012-05-23 07:58:09 +0000467#define ICMP_HDR_SIZE (sizeof(struct icmp_hdr))
468#define IP_ICMP_HDR_SIZE (IP_HDR_SIZE + ICMP_HDR_SIZE)
wdenk2d966952002-10-31 22:12:35 +0000469
wdenk2d966952002-10-31 22:12:35 +0000470/*
Stefan Agner700877a2016-04-13 16:38:02 -0700471 * Maximum packet size; used to allocate packet storage. Use
472 * the maxium Ethernet frame size as specified by the Ethernet
473 * standard including the 802.1Q tag (VLAN tagging).
474 * maximum packet size = 1522
wdenk2d966952002-10-31 22:12:35 +0000475 * maximum packet size and multiple of 32 bytes = 1536
476 */
Stefan Agner700877a2016-04-13 16:38:02 -0700477#define PKTSIZE 1522
wdenk2d966952002-10-31 22:12:35 +0000478#define PKTSIZE_ALIGN 1536
wdenk2d966952002-10-31 22:12:35 +0000479
480/*
481 * Maximum receive ring size; that is, the number of packets
482 * we can buffer before overflow happens. Basically, this just
483 * needs to be enough to prevent a packet being discarded while
484 * we are processing the previous one.
485 */
486#define RINGSZ 4
487#define RINGSZ_LOG2 2
488
489/**********************************************************************/
490/*
491 * Globals.
492 *
493 * Note:
494 *
Joe Hershberger049a95a2015-04-08 01:41:01 -0500495 * All variables of type struct in_addr are stored in NETWORK byte order
wdenk2d966952002-10-31 22:12:35 +0000496 * (big endian).
497 */
498
499/* net.c */
500/** BOOTP EXTENTIONS **/
Joe Hershberger049a95a2015-04-08 01:41:01 -0500501extern struct in_addr net_gateway; /* Our gateway IP address */
502extern struct in_addr net_netmask; /* Our subnet mask (0 = unknown) */
503/* Our Domain Name Server (0 = unknown) */
504extern struct in_addr net_dns_server;
Jon Loeliger1fe80d72007-07-09 22:08:34 -0500505#if defined(CONFIG_BOOTP_DNS2)
Joe Hershberger049a95a2015-04-08 01:41:01 -0500506/* Our 2nd Domain Name Server (0 = unknown) */
507extern struct in_addr net_dns_server2;
stroesefe389a82003-08-28 14:17:32 +0000508#endif
Joe Hershberger586cbe52015-04-08 01:41:03 -0500509extern char net_nis_domain[32]; /* Our IS domain */
510extern char net_hostname[32]; /* Our hostname */
511extern char net_root_path[64]; /* Our root path */
wdenk2d966952002-10-31 22:12:35 +0000512/** END OF BOOTP EXTENTIONS **/
oliver@schinagl.nla40db6d2016-11-25 16:30:19 +0100513extern u8 net_ethaddr[ARP_HLEN]; /* Our ethernet address */
514extern u8 net_server_ethaddr[ARP_HLEN]; /* Boot server enet address */
Joe Hershberger049a95a2015-04-08 01:41:01 -0500515extern struct in_addr net_ip; /* Our IP addr (0 = unknown) */
516extern struct in_addr net_server_ip; /* Server IP addr (0 = unknown) */
Joe Hershberger1203fcc2015-04-08 01:41:05 -0500517extern uchar *net_tx_packet; /* THE transmit packet */
Joe Hershberger2a504df2015-03-22 17:09:11 -0500518extern uchar *net_rx_packets[PKTBUFSRX]; /* Receive packets */
Joe Hershberger1203fcc2015-04-08 01:41:05 -0500519extern uchar *net_rx_packet; /* Current receive packet */
520extern int net_rx_packet_len; /* Current rx packet length */
oliver@schinagl.nla40db6d2016-11-25 16:30:19 +0100521extern const u8 net_bcast_ethaddr[ARP_HLEN]; /* Ethernet broadcast address */
522extern const u8 net_null_ethaddr[ARP_HLEN];
wdenk2d966952002-10-31 22:12:35 +0000523
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000524#define VLAN_NONE 4095 /* untagged */
525#define VLAN_IDMASK 0x0fff /* mask of valid vlan id */
Joe Hershberger4fd50552015-04-08 01:41:17 -0500526extern ushort net_our_vlan; /* Our VLAN */
527extern ushort net_native_vlan; /* Our Native VLAN */
wdenka3d991b2004-04-15 21:48:45 +0000528
Joe Hershbergerbc0571f2015-04-08 01:41:21 -0500529extern int net_restart_wrap; /* Tried all network devices */
wdenk2d966952002-10-31 22:12:35 +0000530
Simon Glasse4bf0c52011-10-24 18:00:02 +0000531enum proto_t {
532 BOOTP, RARP, ARP, TFTPGET, DHCP, PING, DNS, NFS, CDP, NETCONS, SNTP,
Lothar Feltend8970da2018-06-22 22:29:54 +0200533 TFTPSRV, TFTPPUT, LINKLOCAL, FASTBOOT, WOL
Simon Glasse4bf0c52011-10-24 18:00:02 +0000534};
wdenk2d966952002-10-31 22:12:35 +0000535
Jacob Stiffler11a69ff2015-09-30 10:12:05 -0400536extern char net_boot_file_name[1024];/* Boot File name */
Alexander Graf449312c2018-06-15 10:29:27 +0200537/* Indicates whether the file name was specified on the command line */
538extern bool net_boot_file_name_explicit;
Joe Hershberger14111572015-04-08 01:41:02 -0500539/* The actual transferred size of the bootfile (in bytes) */
540extern u32 net_boot_file_size;
541/* Boot file size in blocks as reported by the DHCP server */
542extern u32 net_boot_file_expected_size_in_blocks;
wdenk2d966952002-10-31 22:12:35 +0000543
Robin Getz1a32bf42009-07-20 14:53:54 -0400544#if defined(CONFIG_CMD_DNS)
Joe Hershberger786eac52015-04-08 01:41:15 -0500545extern char *net_dns_resolve; /* The host to resolve */
546extern char *net_dns_env_var; /* the env var to put the ip into */
Robin Getz1a32bf42009-07-20 14:53:54 -0400547#endif
548
Jon Loeliger639221c2007-07-09 17:15:49 -0500549#if defined(CONFIG_CMD_PING)
Joe Hershberger049a95a2015-04-08 01:41:01 -0500550extern struct in_addr net_ping_ip; /* the ip address to ping */
wdenk73a8b272003-06-05 19:27:42 +0000551#endif
552
Jon Loeliger639221c2007-07-09 17:15:49 -0500553#if defined(CONFIG_CMD_CDP)
wdenka3d991b2004-04-15 21:48:45 +0000554/* when CDP completes these hold the return values */
Joe Hershberger6aede5b2015-04-08 01:41:14 -0500555extern ushort cdp_native_vlan; /* CDP returned native VLAN */
556extern ushort cdp_appliance_vlan; /* CDP returned appliance VLAN */
Joe Hershberger17351882012-05-23 07:58:00 +0000557
558/*
559 * Check for a CDP packet by examining the received MAC address field
560 */
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500561static inline int is_cdp_packet(const uchar *ethaddr)
Joe Hershberger17351882012-05-23 07:58:00 +0000562{
oliver@schinagl.nla40db6d2016-11-25 16:30:19 +0100563 extern const u8 net_cdp_ethaddr[ARP_HLEN];
Joe Hershberger17351882012-05-23 07:58:00 +0000564
oliver@schinagl.nla40db6d2016-11-25 16:30:19 +0100565 return memcmp(ethaddr, net_cdp_ethaddr, ARP_HLEN) == 0;
Joe Hershberger17351882012-05-23 07:58:00 +0000566}
wdenka3d991b2004-04-15 21:48:45 +0000567#endif
568
Jon Loeliger639221c2007-07-09 17:15:49 -0500569#if defined(CONFIG_CMD_SNTP)
Joe Hershberger049a95a2015-04-08 01:41:01 -0500570extern struct in_addr net_ntp_server; /* the ip address to NTP */
Joe Hershbergerbc0571f2015-04-08 01:41:21 -0500571extern int net_ntp_time_offset; /* offset time from UTC */
wdenkea287de2005-04-01 00:25:43 +0000572#endif
573
wdenk2d966952002-10-31 22:12:35 +0000574/* Initialize the network adapter */
Joe Hershbergerff997432015-03-22 17:09:02 -0500575void net_init(void);
Joe Hershbergerbc0571f2015-04-08 01:41:21 -0500576int net_loop(enum proto_t);
wdenk2d966952002-10-31 22:12:35 +0000577
578/* Load failed. Start again. */
Joe Hershbergerbc0571f2015-04-08 01:41:21 -0500579int net_start_again(void);
wdenk2d966952002-10-31 22:12:35 +0000580
wdenka3d991b2004-04-15 21:48:45 +0000581/* Get size of the ethernet header when we send */
Joe Hershberger1203fcc2015-04-08 01:41:05 -0500582int net_eth_hdr_size(void);
wdenka3d991b2004-04-15 21:48:45 +0000583
584/* Set ethernet header; returns the size of the header */
Joe Hershberger1203fcc2015-04-08 01:41:05 -0500585int net_set_ether(uchar *xet, const uchar *dest_ethaddr, uint prot);
Joe Hershbergerff997432015-03-22 17:09:02 -0500586int net_update_ether(struct ethernet_hdr *et, uchar *addr, uint prot);
wdenk2d966952002-10-31 22:12:35 +0000587
588/* Set IP header */
Duncan Hare5d457ec2018-06-24 15:40:41 -0700589void net_set_ip_header(uchar *pkt, struct in_addr dest, struct in_addr source,
590 u16 pkt_len, u8 proto);
Joe Hershberger049a95a2015-04-08 01:41:01 -0500591void net_set_udp_header(uchar *pkt, struct in_addr dest, int dport,
Joe Hershberger4b11c912012-05-23 07:59:07 +0000592 int sport, int len);
wdenk2d966952002-10-31 22:12:35 +0000593
Simon Glass9b0e35c2015-01-19 22:16:07 -0700594/**
595 * compute_ip_checksum() - Compute IP checksum
596 *
597 * @addr: Address to check (must be 16-bit aligned)
598 * @nbytes: Number of bytes to check (normally a multiple of 2)
599 * @return 16-bit IP checksum
600 */
601unsigned compute_ip_checksum(const void *addr, unsigned nbytes);
602
603/**
604 * add_ip_checksums() - add two IP checksums
605 *
606 * @offset: Offset of first sum (if odd we do a byte-swap)
607 * @sum: First checksum
608 * @new_sum: New checksum to add
609 * @return updated 16-bit IP checksum
610 */
611unsigned add_ip_checksums(unsigned offset, unsigned sum, unsigned new_sum);
612
613/**
614 * ip_checksum_ok() - check if a checksum is correct
615 *
616 * This works by making sure the checksum sums to 0
617 *
618 * @addr: Address to check (must be 16-bit aligned)
619 * @nbytes: Number of bytes to check (normally a multiple of 2)
620 * @return true if the checksum matches, false if not
621 */
622int ip_checksum_ok(const void *addr, unsigned nbytes);
623
Joe Hershbergerd280d3f2012-05-23 07:58:01 +0000624/* Callbacks */
Joe Hershbergerff997432015-03-22 17:09:02 -0500625rxhand_f *net_get_udp_handler(void); /* Get UDP RX packet handler */
626void net_set_udp_handler(rxhand_f *); /* Set UDP RX packet handler */
627rxhand_f *net_get_arp_handler(void); /* Get ARP RX packet handler */
628void net_set_arp_handler(rxhand_f *); /* Set ARP RX packet handler */
Joe Hershberger3f02c982018-09-26 16:48:58 -0500629bool arp_is_waiting(void); /* Waiting for ARP reply? */
Joe Hershbergerff997432015-03-22 17:09:02 -0500630void net_set_icmp_handler(rxhand_icmp_f *f); /* Set ICMP RX handler */
Joe Hershbergerbc0571f2015-04-08 01:41:21 -0500631void net_set_timeout_handler(ulong, thand_f *);/* Set timeout handler */
wdenk2d966952002-10-31 22:12:35 +0000632
Joe Hershberger22f6e992012-05-23 07:59:14 +0000633/* Network loop state */
634enum net_loop_state {
635 NETLOOP_CONTINUE,
636 NETLOOP_RESTART,
637 NETLOOP_SUCCESS,
638 NETLOOP_FAIL
639};
Kim Phillips06370592012-10-29 13:34:33 +0000640extern enum net_loop_state net_state;
641
Joe Hershberger22f6e992012-05-23 07:59:14 +0000642static inline void net_set_state(enum net_loop_state state)
643{
Joe Hershberger4ef8d532012-05-23 08:01:04 +0000644 debug_cond(DEBUG_INT_STATE, "--- NetState set to %d\n", state);
Joe Hershberger22f6e992012-05-23 07:59:14 +0000645 net_state = state;
646}
647
Joe Hershbergerac3f26c2018-09-26 16:49:02 -0500648/*
649 * net_get_async_tx_pkt_buf - Get a packet buffer that is not in use for
650 * sending an asynchronous reply
651 *
652 * returns - ptr to packet buffer
653 */
654uchar * net_get_async_tx_pkt_buf(void);
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 */
Duncan Hare5d457ec2018-06-24 15:40:41 -0700673int net_send_ip_packet(uchar *ether, struct in_addr dest, int dport, int sport,
674 int payload_len, int proto, u8 action, u32 tcp_seq_num,
675 u32 tcp_ack_num);
Joe Hershberger1203fcc2015-04-08 01:41:05 -0500676int net_send_udp_packet(uchar *ether, struct in_addr dest, int dport,
Joe Hershberger206d07f2012-05-23 07:58:10 +0000677 int sport, int payload_len);
wdenk73a8b272003-06-05 19:27:42 +0000678
wdenk2d966952002-10-31 22:12:35 +0000679/* Processes a received packet */
Joe Hershberger2a504df2015-03-22 17:09:11 -0500680void net_process_received_packet(uchar *in_packet, int len);
wdenk2d966952002-10-31 22:12:35 +0000681
Jason Kridner99761e52018-03-07 05:40:43 -0500682#if defined(CONFIG_NETCONSOLE) && !defined(CONFIG_SPL_BUILD)
Joe Hershberger6a38a5f2015-04-08 01:41:16 -0500683void nc_start(void);
Joe Hershberger049a95a2015-04-08 01:41:01 -0500684int nc_input_packet(uchar *pkt, struct in_addr src_ip, unsigned dest_port,
Joe Hershberger8a0eccb2012-09-18 10:01:32 +0000685 unsigned src_port, unsigned len);
Joe Hershberger48522bb2012-05-15 08:59:08 +0000686#endif
687
Fabio Estevam92163872015-11-08 22:25:14 -0200688static __always_inline int eth_is_on_demand_init(void)
Joe Hershbergerf8be7d62012-08-03 10:59:08 +0000689{
Jason Kridner99761e52018-03-07 05:40:43 -0500690#if defined(CONFIG_NETCONSOLE) && !defined(CONFIG_SPL_BUILD)
Joe Hershbergerf8be7d62012-08-03 10:59:08 +0000691 extern enum proto_t net_loop_last_protocol;
692
693 return net_loop_last_protocol != NETCONS;
694#else
695 return 1;
696#endif
697}
698
699static inline void eth_set_last_protocol(int protocol)
700{
Jason Kridner99761e52018-03-07 05:40:43 -0500701#if defined(CONFIG_NETCONSOLE) && !defined(CONFIG_SPL_BUILD)
Joe Hershbergerf8be7d62012-08-03 10:59:08 +0000702 extern enum proto_t net_loop_last_protocol;
703
704 net_loop_last_protocol = protocol;
705#endif
706}
707
wdenk2d966952002-10-31 22:12:35 +0000708/*
Simon Glasse4a3d572011-10-27 06:24:32 +0000709 * Check if autoload is enabled. If so, use either NFS or TFTP to download
710 * the boot file.
711 */
712void net_auto_load(void);
713
714/*
wdenk2d966952002-10-31 22:12:35 +0000715 * The following functions are a bit ugly, but necessary to deal with
716 * alignment restrictions on ARM.
717 *
718 * We're using inline functions, which had the smallest memory
719 * footprint in our tests.
720 */
721/* return IP *in network byteorder* */
Joe Hershberger049a95a2015-04-08 01:41:01 -0500722static inline struct in_addr net_read_ip(void *from)
wdenk2d966952002-10-31 22:12:35 +0000723{
Joe Hershberger049a95a2015-04-08 01:41:01 -0500724 struct in_addr ip;
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000725
726 memcpy((void *)&ip, (void *)from, sizeof(ip));
wdenk2d966952002-10-31 22:12:35 +0000727 return ip;
728}
729
730/* return ulong *in network byteorder* */
Heinrich Schuchardtbbfc5622019-07-14 22:02:13 +0200731static inline u32 net_read_u32(void *from)
wdenk2d966952002-10-31 22:12:35 +0000732{
Sergey Temerkhanov5917e7d2015-04-08 01:41:22 -0500733 u32 l;
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000734
735 memcpy((void *)&l, (void *)from, sizeof(l));
wdenk2d966952002-10-31 22:12:35 +0000736 return l;
737}
738
739/* write IP *in network byteorder* */
Joe Hershberger049a95a2015-04-08 01:41:01 -0500740static inline void net_write_ip(void *to, struct in_addr ip)
wdenk2d966952002-10-31 22:12:35 +0000741{
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000742 memcpy(to, (void *)&ip, sizeof(ip));
wdenk2d966952002-10-31 22:12:35 +0000743}
744
745/* copy IP */
Joe Hershberger049a95a2015-04-08 01:41:01 -0500746static inline void net_copy_ip(void *to, void *from)
wdenk2d966952002-10-31 22:12:35 +0000747{
Joe Hershberger049a95a2015-04-08 01:41:01 -0500748 memcpy((void *)to, from, sizeof(struct in_addr));
wdenk2d966952002-10-31 22:12:35 +0000749}
750
751/* copy ulong */
Heinrich Schuchardtbbfc5622019-07-14 22:02:13 +0200752static inline void net_copy_u32(void *to, void *from)
wdenk2d966952002-10-31 22:12:35 +0000753{
Sergey Temerkhanov5917e7d2015-04-08 01:41:22 -0500754 memcpy((void *)to, (void *)from, sizeof(u32));
wdenk2d966952002-10-31 22:12:35 +0000755}
756
Mike Rapoport50cca8b2007-08-12 08:48:27 +0300757/**
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500758 * is_zero_ethaddr - Determine if give Ethernet address is all zeros.
Mike Rapoport50cca8b2007-08-12 08:48:27 +0300759 * @addr: Pointer to a six-byte array containing the Ethernet address
760 *
761 * Return true if the address is all zeroes.
762 */
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500763static inline int is_zero_ethaddr(const u8 *addr)
Mike Rapoport50cca8b2007-08-12 08:48:27 +0300764{
765 return !(addr[0] | addr[1] | addr[2] | addr[3] | addr[4] | addr[5]);
766}
767
768/**
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500769 * is_multicast_ethaddr - Determine if the Ethernet address is a multicast.
Mike Rapoport50cca8b2007-08-12 08:48:27 +0300770 * @addr: Pointer to a six-byte array containing the Ethernet address
771 *
772 * Return true if the address is a multicast address.
773 * By definition the broadcast address is also a multicast address.
774 */
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500775static inline int is_multicast_ethaddr(const u8 *addr)
Mike Rapoport50cca8b2007-08-12 08:48:27 +0300776{
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000777 return 0x01 & addr[0];
Mike Rapoport50cca8b2007-08-12 08:48:27 +0300778}
779
Remy Bohmer23cd1382009-07-29 18:18:43 +0200780/*
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500781 * is_broadcast_ethaddr - Determine if the Ethernet address is broadcast
Remy Bohmer23cd1382009-07-29 18:18:43 +0200782 * @addr: Pointer to a six-byte array containing the Ethernet address
783 *
784 * Return true if the address is the broadcast address.
785 */
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500786static inline int is_broadcast_ethaddr(const u8 *addr)
Remy Bohmer23cd1382009-07-29 18:18:43 +0200787{
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000788 return (addr[0] & addr[1] & addr[2] & addr[3] & addr[4] & addr[5]) ==
789 0xff;
Remy Bohmer23cd1382009-07-29 18:18:43 +0200790}
791
792/*
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500793 * is_valid_ethaddr - Determine if the given Ethernet address is valid
Mike Frysinger75edebe2009-01-27 16:53:39 -0500794 * @addr: Pointer to a six-byte array containing the Ethernet address
795 *
796 * Check that the Ethernet address (MAC) is not 00:00:00:00:00:00, is not
797 * a multicast address, and is not FF:FF:FF:FF:FF:FF.
798 *
799 * Return true if the address is valid.
800 */
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500801static inline int is_valid_ethaddr(const u8 *addr)
Mike Frysinger75edebe2009-01-27 16:53:39 -0500802{
803 /* FF:FF:FF:FF:FF:FF is a multicast address so we don't need to
804 * explicitly check for it here. */
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500805 return !is_multicast_ethaddr(addr) && !is_zero_ethaddr(addr);
Mike Frysinger75edebe2009-01-27 16:53:39 -0500806}
807
Masahiro Yamadada384a92014-04-18 19:09:48 +0900808/**
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500809 * net_random_ethaddr - Generate software assigned random Ethernet address
Masahiro Yamadada384a92014-04-18 19:09:48 +0900810 * @addr: Pointer to a six-byte array containing the Ethernet address
811 *
812 * Generate a random Ethernet address (MAC) that is not multicast
813 * and has the local assigned bit set.
814 */
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500815static inline void net_random_ethaddr(uchar *addr)
Masahiro Yamadada384a92014-04-18 19:09:48 +0900816{
817 int i;
818 unsigned int seed = get_timer(0);
819
820 for (i = 0; i < 6; i++)
821 addr[i] = rand_r(&seed);
822
823 addr[0] &= 0xfe; /* clear multicast bit */
824 addr[0] |= 0x02; /* set local assignment bit (IEEE802) */
825}
826
wdenk2d966952002-10-31 22:12:35 +0000827/* Convert an IP address to a string */
Joe Hershberger049a95a2015-04-08 01:41:01 -0500828void ip_to_string(struct in_addr x, char *s);
wdenk2d966952002-10-31 22:12:35 +0000829
wdenk73a8b272003-06-05 19:27:42 +0000830/* Convert a string to ip address */
Joe Hershberger049a95a2015-04-08 01:41:01 -0500831struct in_addr string_to_ip(const char *s);
wdenk73a8b272003-06-05 19:27:42 +0000832
wdenka3d991b2004-04-15 21:48:45 +0000833/* Convert a VLAN id to a string */
Joe Hershberger4fd50552015-04-08 01:41:17 -0500834void vlan_to_string(ushort x, char *s);
wdenka3d991b2004-04-15 21:48:45 +0000835
836/* Convert a string to a vlan id */
Joe Hershberger4fd50552015-04-08 01:41:17 -0500837ushort string_to_vlan(const char *s);
wdenka3d991b2004-04-15 21:48:45 +0000838
wdenka3d991b2004-04-15 21:48:45 +0000839/* read a VLAN id from an environment variable */
Simon Glass723806c2017-08-03 12:22:15 -0600840ushort env_get_vlan(char *);
wdenka3d991b2004-04-15 21:48:45 +0000841
wdenk2d966952002-10-31 22:12:35 +0000842/* copy a filename (allow for "..." notation, limit length) */
Joe Hershbergerff997432015-03-22 17:09:02 -0500843void copy_filename(char *dst, const char *src, int size);
wdenk2d966952002-10-31 22:12:35 +0000844
Joe Hershberger3a66fcb2018-07-03 19:36:39 -0500845/* check if serverip is specified in filename from the command line */
846int is_serverip_in_cmd(void);
847
Joe Hershberger6ab12832018-07-03 19:36:43 -0500848/**
849 * net_parse_bootfile - Parse the bootfile env var / cmd line param
850 *
851 * @param ipaddr - a pointer to the ipaddr to populate if included in bootfile
852 * @param filename - a pointer to the string to save the filename part
853 * @param max_len - The longest - 1 that the filename part can be
854 *
855 * return 1 if parsed, 0 if bootfile is empty
856 */
857int net_parse_bootfile(struct in_addr *ipaddr, char *filename, int max_len);
858
Mike Frysinger91b469c2009-09-02 04:18:55 -0400859/* get a random source port */
Joe Hershbergerff997432015-03-22 17:09:02 -0500860unsigned int random_port(void);
Mike Frysinger91b469c2009-09-02 04:18:55 -0400861
Lukasz Majewskic7ff5522015-08-24 00:21:47 +0200862/**
863 * update_tftp - Update firmware over TFTP (via DFU)
864 *
865 * This function updates board's firmware via TFTP
866 *
867 * @param addr - memory address where data is stored
868 * @param interface - the DFU medium name - e.g. "mmc"
869 * @param devstring - the DFU medium number - e.g. "1"
870 *
871 * @return - 0 on success, other value on failure
872 */
873int update_tftp(ulong addr, char *interface, char *devstring);
Simon Glassea5427e2013-05-15 06:23:54 +0000874
wdenk2d966952002-10-31 22:12:35 +0000875/**********************************************************************/
876
877#endif /* __NET_H__ */