blob: 1bf9867f8cf8efaf70528d1e4e892034701e9857 [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
Simon Glass90526e92020-05-10 11:39:56 -060015#include <linux/types.h>
Eric Nelson2c4b3c12012-03-15 18:33:24 +000016#include <asm/cache.h>
wdenk2d966952002-10-31 22:12:35 +000017#include <asm/byteorder.h> /* for nton* / ntoh* stuff */
Simon Glass9fb625c2019-08-01 09:46:51 -060018#include <env.h>
Simon Glassc3dc39a2020-05-10 11:39:55 -060019#include <log.h>
20#include <time.h>
Bin Mengdda52512018-07-31 02:55:22 -070021#include <linux/if_ether.h>
Simon Glass840ef4d2019-11-14 12:57:13 -070022#include <rand.h>
wdenk2d966952002-10-31 22:12:35 +000023
Simon Glass90526e92020-05-10 11:39:56 -060024struct bd_info;
Simon Glass09140112020-05-10 11:40:03 -060025struct cmd_tbl;
Simon Glass90526e92020-05-10 11:39:56 -060026struct udevice;
Simon Glassc3dc39a2020-05-10 11:39:55 -060027
Joe Hershberger4ef8d532012-05-23 08:01:04 +000028#define DEBUG_LL_STATE 0 /* Link local state machine changes */
29#define DEBUG_DEV_PKT 0 /* Packets or info directed to the device */
30#define DEBUG_NET_PKT 0 /* Packets on info on the network at large */
31#define DEBUG_INT_STATE 0 /* Internal network state changes */
wdenk2d966952002-10-31 22:12:35 +000032
33/*
34 * The number of receive packet buffers, and the required packet buffer
35 * alignment in memory.
36 *
37 */
38
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +020039#ifdef CONFIG_SYS_RX_ETH_BUFFER
40# define PKTBUFSRX CONFIG_SYS_RX_ETH_BUFFER
wdenk1d0350e2002-11-11 21:14:20 +000041#else
stroesec6028832003-06-05 15:38:29 +000042# define PKTBUFSRX 4
wdenk1d0350e2002-11-11 21:14:20 +000043#endif
44
Eric Nelson2c4b3c12012-03-15 18:33:24 +000045#define PKTALIGN ARCH_DMA_MINALIGN
wdenk2d966952002-10-31 22:12:35 +000046
oliver@schinagl.nla40db6d2016-11-25 16:30:19 +010047/* ARP hardware address length */
48#define ARP_HLEN 6
oliver@schinagl.nl9f455bc2016-11-25 16:30:20 +010049/*
50 * The size of a MAC address in string form, each digit requires two chars
51 * and five separator characters to form '00:00:00:00:00:00'.
52 */
53#define ARP_HLEN_ASCII (ARP_HLEN * 2) + (ARP_HLEN - 1)
oliver@schinagl.nla40db6d2016-11-25 16:30:19 +010054
Matthias Weisserea45cb02011-12-03 03:29:44 +000055/* IPv4 addresses are always 32 bits in size */
Joe Hershberger049a95a2015-04-08 01:41:01 -050056struct in_addr {
57 __be32 s_addr;
58};
wdenk2d966952002-10-31 22:12:35 +000059
Luca Ceresoli03eb1292011-04-18 06:19:50 +000060/**
Simon Glass77f4e472019-12-28 10:44:43 -070061 * do_tftpb - Run the tftpboot command
62 *
63 * @cmdtp: Command information for tftpboot
64 * @flag: Command flags (CMD_FLAG_...)
65 * @argc: Number of arguments
66 * @argv: List of arguments
67 * @return result (see enum command_ret_t)
68 */
Simon Glass09140112020-05-10 11:40:03 -060069int do_tftpb(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]);
Simon Glass77f4e472019-12-28 10:44:43 -070070
71/**
Luca Ceresoli03eb1292011-04-18 06:19:50 +000072 * An incoming packet handler.
73 * @param pkt pointer to the application packet
74 * @param dport destination UDP port
75 * @param sip source IP address
76 * @param sport source UDP port
77 * @param len packet length
wdenk2d966952002-10-31 22:12:35 +000078 */
Luca Ceresoli03eb1292011-04-18 06:19:50 +000079typedef void rxhand_f(uchar *pkt, unsigned dport,
Joe Hershberger049a95a2015-04-08 01:41:01 -050080 struct in_addr sip, unsigned sport,
Luca Ceresoli03eb1292011-04-18 06:19:50 +000081 unsigned len);
wdenk2d966952002-10-31 22:12:35 +000082
Simon Glass4793ee62011-10-24 18:00:01 +000083/**
84 * An incoming ICMP packet handler.
85 * @param type ICMP type
86 * @param code ICMP code
87 * @param dport destination UDP port
88 * @param sip source IP address
89 * @param sport source UDP port
90 * @param pkt pointer to the ICMP packet data
91 * @param len packet length
92 */
93typedef void rxhand_icmp_f(unsigned type, unsigned code, unsigned dport,
Joe Hershberger049a95a2015-04-08 01:41:01 -050094 struct in_addr sip, unsigned sport, uchar *pkt, unsigned len);
Simon Glass4793ee62011-10-24 18:00:01 +000095
wdenk2d966952002-10-31 22:12:35 +000096/*
97 * A timeout handler. Called after time interval has expired.
98 */
99typedef void thand_f(void);
100
wdenk2d966952002-10-31 22:12:35 +0000101enum eth_state_t {
102 ETH_STATE_INIT,
103 ETH_STATE_PASSIVE,
104 ETH_STATE_ACTIVE
105};
106
Joe Hershberger05c3e682015-03-22 17:09:10 -0500107#ifdef CONFIG_DM_ETH
108/**
109 * struct eth_pdata - Platform data for Ethernet MAC controllers
110 *
111 * @iobase: The base address of the hardware registers
112 * @enetaddr: The Ethernet MAC address that is loaded from EEPROM or env
Simon Glassc74c8e62015-04-05 16:07:39 -0600113 * @phy_interface: PHY interface to use - see PHY_INTERFACE_MODE_...
Alexey Brodkinf74264d2016-01-13 16:59:35 +0300114 * @max_speed: Maximum speed of Ethernet connection supported by MAC
Faiz Abbas3c6add92019-03-18 13:54:31 +0530115 * @priv_pdata: device specific platdata
Joe Hershberger05c3e682015-03-22 17:09:10 -0500116 */
117struct eth_pdata {
118 phys_addr_t iobase;
oliver@schinagl.nla40db6d2016-11-25 16:30:19 +0100119 unsigned char enetaddr[ARP_HLEN];
Simon Glassc74c8e62015-04-05 16:07:39 -0600120 int phy_interface;
Alexey Brodkinf74264d2016-01-13 16:59:35 +0300121 int max_speed;
Faiz Abbas3c6add92019-03-18 13:54:31 +0530122 void *priv_pdata;
Joe Hershberger05c3e682015-03-22 17:09:10 -0500123};
124
Simon Glassa1ca92e2015-07-06 16:47:49 -0600125enum eth_recv_flags {
126 /*
127 * Check hardware device for new packets (otherwise only return those
128 * which are already in the memory buffer ready to process)
129 */
130 ETH_RECV_CHECK_DEVICE = 1 << 0,
131};
132
Joe Hershberger05c3e682015-03-22 17:09:10 -0500133/**
134 * struct eth_ops - functions of Ethernet MAC controllers
135 *
136 * start: Prepare the hardware to send and receive packets
137 * send: Send the bytes passed in "packet" as a packet on the wire
Joe Hershberger17591402015-03-22 17:09:12 -0500138 * recv: Check if the hardware received a packet. If so, set the pointer to the
139 * packet buffer in the packetp parameter. If not, return an error or 0 to
Joe Hershberger63c97292015-04-03 20:09:46 -0500140 * indicate that the hardware receive FIFO is empty. If 0 is returned, the
141 * network stack will not process the empty packet, but free_pkt() will be
142 * called if supplied
143 * free_pkt: Give the driver an opportunity to manage its packet buffer memory
144 * when the network stack is finished processing it. This will only be
145 * called when no error was returned from recv - optional
Joe Hershberger05c3e682015-03-22 17:09:10 -0500146 * stop: Stop the hardware from looking for packets - may be called even if
147 * state == PASSIVE
148 * mcast: Join or leave a multicast group (for TFTP) - optional
149 * write_hwaddr: Write a MAC address to the hardware (used to pass it to Linux
150 * on some platforms like ARM). This function expects the
Simon Glassb86f7952015-07-06 16:47:55 -0600151 * eth_pdata::enetaddr field to be populated. The method can
152 * return -ENOSYS to indicate that this is not implemented for
153 this hardware - optional.
Joe Hershberger05c3e682015-03-22 17:09:10 -0500154 * read_rom_hwaddr: Some devices have a backup of the MAC address stored in a
155 * ROM on the board. This is how the driver should expose it
156 * to the network stack. This function should fill in the
157 * eth_pdata::enetaddr field - optional
158 */
159struct eth_ops {
160 int (*start)(struct udevice *dev);
161 int (*send)(struct udevice *dev, void *packet, int length);
Simon Glassa1ca92e2015-07-06 16:47:49 -0600162 int (*recv)(struct udevice *dev, int flags, uchar **packetp);
Joe Hershberger63c97292015-04-03 20:09:46 -0500163 int (*free_pkt)(struct udevice *dev, uchar *packet, int length);
Joe Hershberger05c3e682015-03-22 17:09:10 -0500164 void (*stop)(struct udevice *dev);
Joe Hershberger05c3e682015-03-22 17:09:10 -0500165 int (*mcast)(struct udevice *dev, const u8 *enetaddr, int join);
Joe Hershberger05c3e682015-03-22 17:09:10 -0500166 int (*write_hwaddr)(struct udevice *dev);
167 int (*read_rom_hwaddr)(struct udevice *dev);
168};
169
170#define eth_get_ops(dev) ((struct eth_ops *)(dev)->driver->ops)
171
172struct udevice *eth_get_dev(void); /* get the current device */
Joe Hershbergere58780d2015-03-22 17:09:16 -0500173/*
174 * The devname can be either an exact name given by the driver or device tree
175 * or it can be an alias of the form "eth%d"
176 */
177struct udevice *eth_get_dev_by_name(const char *devname);
Joe Hershberger05c3e682015-03-22 17:09:10 -0500178unsigned char *eth_get_ethaddr(void); /* get the current device MAC */
Bernhard Nortmanneaa8a192015-09-14 15:29:43 +0200179
Joe Hershberger05c3e682015-03-22 17:09:10 -0500180/* Used only when NetConsole is enabled */
Bernhard Nortmanneaa8a192015-09-14 15:29:43 +0200181int eth_is_active(struct udevice *dev); /* Test device for active state */
Joe Hershberger05c3e682015-03-22 17:09:10 -0500182int eth_init_state_only(void); /* Set active state */
183void eth_halt_state_only(void); /* Set passive state */
184#endif
185
186#ifndef CONFIG_DM_ETH
wdenk2d966952002-10-31 22:12:35 +0000187struct eth_device {
Pankaj Bansal1666fa52018-08-02 16:31:29 +0530188#define ETH_NAME_LEN 20
oliver@schinagl.nl2c07c322016-11-25 16:30:21 +0100189 char name[ETH_NAME_LEN];
oliver@schinagl.nla40db6d2016-11-25 16:30:19 +0100190 unsigned char enetaddr[ARP_HLEN];
Michal Simek16ae7822015-01-14 16:00:39 +0100191 phys_addr_t iobase;
wdenk2d966952002-10-31 22:12:35 +0000192 int state;
193
Simon Glass90526e92020-05-10 11:39:56 -0600194 int (*init)(struct eth_device *eth, struct bd_info *bd);
Joe Hershbergera34f2072015-04-08 01:41:20 -0500195 int (*send)(struct eth_device *, void *packet, int length);
196 int (*recv)(struct eth_device *);
197 void (*halt)(struct eth_device *);
Chris Packham67bb9842018-11-26 21:00:29 +1300198 int (*mcast)(struct eth_device *, const u8 *enetaddr, int join);
Simon Glass90526e92020-05-10 11:39:56 -0600199 int (*write_hwaddr)(struct eth_device *eth);
wdenk2d966952002-10-31 22:12:35 +0000200 struct eth_device *next;
Michael Wallefea7dca2011-10-27 11:31:35 +0000201 int index;
wdenk2d966952002-10-31 22:12:35 +0000202 void *priv;
203};
204
Joe Hershbergerff997432015-03-22 17:09:02 -0500205int eth_register(struct eth_device *dev);/* Register network device */
206int eth_unregister(struct eth_device *dev);/* Remove network device */
Kim Phillips06370592012-10-29 13:34:33 +0000207
Kim Phillips06370592012-10-29 13:34:33 +0000208extern struct eth_device *eth_current;
209
Fabio Estevam92163872015-11-08 22:25:14 -0200210static __always_inline struct eth_device *eth_get_dev(void)
Joe Hershbergerf8be7d62012-08-03 10:59:08 +0000211{
Joe Hershbergerf8be7d62012-08-03 10:59:08 +0000212 return eth_current;
213}
Joe Hershberger84eb1fb2015-03-22 17:09:03 -0500214struct eth_device *eth_get_dev_by_name(const char *devname);
215struct eth_device *eth_get_dev_by_index(int index); /* get dev @ index */
Joe Hershberger8b2c9a72015-03-22 17:09:00 -0500216
Joe Hershberger84eb1fb2015-03-22 17:09:03 -0500217/* get the current device MAC */
Joe Hershberger8b2c9a72015-03-22 17:09:00 -0500218static inline unsigned char *eth_get_ethaddr(void)
219{
220 if (eth_current)
221 return eth_current->enetaddr;
222 return NULL;
223}
224
Bernhard Nortmanneaa8a192015-09-14 15:29:43 +0200225/* Used only when NetConsole is enabled */
226int eth_is_active(struct eth_device *dev); /* Test device for active state */
Joe Hershbergerf8be7d62012-08-03 10:59:08 +0000227/* Set active state */
Fabio Estevam92163872015-11-08 22:25:14 -0200228static __always_inline int eth_init_state_only(void)
Joe Hershbergerf8be7d62012-08-03 10:59:08 +0000229{
230 eth_get_dev()->state = ETH_STATE_ACTIVE;
231
232 return 0;
233}
234/* Set passive state */
Fabio Estevam92163872015-11-08 22:25:14 -0200235static __always_inline void eth_halt_state_only(void)
Joe Hershbergerf8be7d62012-08-03 10:59:08 +0000236{
237 eth_get_dev()->state = ETH_STATE_PASSIVE;
238}
239
Simon Glass7616e782011-06-13 16:13:10 -0700240/*
241 * Set the hardware address for an ethernet interface based on 'eth%daddr'
242 * environment variable (or just 'ethaddr' if eth_number is 0).
243 * Args:
244 * base_name - base name for device (normally "eth")
245 * eth_number - value of %d (0 for first device of this type)
246 * Returns:
247 * 0 is success, non-zero is error status from driver.
248 */
249int eth_write_hwaddr(struct eth_device *dev, const char *base_name,
250 int eth_number);
251
Simon Glass90526e92020-05-10 11:39:56 -0600252int usb_eth_initialize(struct bd_info *bi);
Joe Hershberger05c3e682015-03-22 17:09:10 -0500253#endif
Joe Hershberger84eb1fb2015-03-22 17:09:03 -0500254
Joe Hershbergerd2eaec62015-03-22 17:09:06 -0500255int eth_initialize(void); /* Initialize network subsystem */
Joe Hershberger84eb1fb2015-03-22 17:09:03 -0500256void eth_try_another(int first_restart); /* Change the device */
257void eth_set_current(void); /* set nterface to ethcur var */
258
259int eth_get_dev_index(void); /* get the device index */
Joe Hershberger84eb1fb2015-03-22 17:09:03 -0500260
Roger Quadros5350bc82016-03-18 13:18:11 +0200261/**
Simon Glassfd1e9592017-08-03 12:22:11 -0600262 * eth_env_set_enetaddr_by_index() - set the MAC address environment variable
Roger Quadros5350bc82016-03-18 13:18:11 +0200263 *
264 * This sets up an environment variable with the given MAC address (@enetaddr).
265 * The environment variable to be set is defined by <@base_name><@index>addr.
266 * If @index is 0 it is omitted. For common Ethernet this means ethaddr,
267 * eth1addr, etc.
268 *
269 * @base_name: Base name for variable, typically "eth"
270 * @index: Index of interface being updated (>=0)
271 * @enetaddr: Pointer to MAC address to put into the variable
272 * @return 0 if OK, other value on error
273 */
Simon Glassfd1e9592017-08-03 12:22:11 -0600274int eth_env_set_enetaddr_by_index(const char *base_name, int index,
Roger Quadros5350bc82016-03-18 13:18:11 +0200275 uchar *enetaddr);
276
277
Joe Hershberger84eb1fb2015-03-22 17:09:03 -0500278/*
Mugunthan V Nd4a37552016-11-18 11:09:15 +0530279 * Initialize USB ethernet device with CONFIG_DM_ETH
280 * Returns:
281 * 0 is success, non-zero is error status.
282 */
283int usb_ether_init(void);
284
285/*
Joe Hershberger84eb1fb2015-03-22 17:09:03 -0500286 * Get the hardware address for an ethernet interface .
287 * Args:
288 * base_name - base name for device (normally "eth")
289 * index - device index number (0 for first)
290 * enetaddr - returns 6 byte hardware address
291 * Returns:
292 * Return true if the address is valid.
293 */
Simon Glass35affd72017-08-03 12:22:14 -0600294int eth_env_get_enetaddr_by_index(const char *base_name, int index,
Joe Hershberger84eb1fb2015-03-22 17:09:03 -0500295 uchar *enetaddr);
296
Joe Hershbergerd2eaec62015-03-22 17:09:06 -0500297int eth_init(void); /* Initialize the device */
Joe Hershberger84eb1fb2015-03-22 17:09:03 -0500298int eth_send(void *packet, int length); /* Send a packet */
299
Alexander Graf0efe1bc2016-05-06 21:01:01 +0200300#if defined(CONFIG_API) || defined(CONFIG_EFI_LOADER)
Joe Hershberger84eb1fb2015-03-22 17:09:03 -0500301int eth_receive(void *packet, int length); /* Receive a packet*/
302extern void (*push_packet)(void *packet, int length);
303#endif
304int eth_rx(void); /* Check for received packets */
305void eth_halt(void); /* stop SCC */
306const char *eth_get_name(void); /* get name of current device */
Joe Hershberger049a95a2015-04-08 01:41:01 -0500307int eth_mcast_join(struct in_addr mcast_addr, int join);
wdenk2d966952002-10-31 22:12:35 +0000308
309/**********************************************************************/
310/*
311 * Protocol headers.
312 */
313
314/*
315 * Ethernet header
316 */
Joe Hershbergercb487f52012-05-23 07:58:06 +0000317
318struct ethernet_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 */
Denis Pynkin704f3ac2017-07-21 19:28:42 +0300322} __attribute__((packed));
Joe Hershbergercb487f52012-05-23 07:58:06 +0000323
324/* Ethernet header size */
325#define ETHER_HDR_SIZE (sizeof(struct ethernet_hdr))
326
Bin Menga7c3d5e2015-03-20 17:12:18 +0800327#define ETH_FCS_LEN 4 /* Octets in the FCS */
328
Joe Hershbergercb487f52012-05-23 07:58:06 +0000329struct e802_hdr {
oliver@schinagl.nla40db6d2016-11-25 16:30:19 +0100330 u8 et_dest[ARP_HLEN]; /* Destination node */
331 u8 et_src[ARP_HLEN]; /* Source node */
332 u16 et_protlen; /* Protocol or length */
333 u8 et_dsap; /* 802 DSAP */
334 u8 et_ssap; /* 802 SSAP */
335 u8 et_ctl; /* 802 control */
336 u8 et_snap1; /* SNAP */
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500337 u8 et_snap2;
338 u8 et_snap3;
oliver@schinagl.nla40db6d2016-11-25 16:30:19 +0100339 u16 et_prot; /* 802 protocol */
Denis Pynkin704f3ac2017-07-21 19:28:42 +0300340} __attribute__((packed));
wdenk2d966952002-10-31 22:12:35 +0000341
Joe Hershbergerda5ebe22012-05-23 07:58:11 +0000342/* 802 + SNAP + ethernet header size */
Joe Hershbergercb487f52012-05-23 07:58:06 +0000343#define E802_HDR_SIZE (sizeof(struct e802_hdr))
wdenka3d991b2004-04-15 21:48:45 +0000344
345/*
Joe Hershbergerda5ebe22012-05-23 07:58:11 +0000346 * Virtual LAN Ethernet header
wdenka3d991b2004-04-15 21:48:45 +0000347 */
Joe Hershbergerc68cca32012-05-23 07:58:07 +0000348struct vlan_ethernet_hdr {
oliver@schinagl.nla40db6d2016-11-25 16:30:19 +0100349 u8 vet_dest[ARP_HLEN]; /* Destination node */
350 u8 vet_src[ARP_HLEN]; /* Source node */
351 u16 vet_vlan_type; /* PROT_VLAN */
352 u16 vet_tag; /* TAG of VLAN */
353 u16 vet_type; /* protocol type */
Denis Pynkin704f3ac2017-07-21 19:28:42 +0300354} __attribute__((packed));
wdenka3d991b2004-04-15 21:48:45 +0000355
Joe Hershbergerc68cca32012-05-23 07:58:07 +0000356/* VLAN Ethernet header size */
357#define VLAN_ETHER_HDR_SIZE (sizeof(struct vlan_ethernet_hdr))
wdenka3d991b2004-04-15 21:48:45 +0000358
wdenk2d966952002-10-31 22:12:35 +0000359#define PROT_IP 0x0800 /* IP protocol */
360#define PROT_ARP 0x0806 /* IP ARP protocol */
Lothar Feltend8970da2018-06-22 22:29:54 +0200361#define PROT_WOL 0x0842 /* ether-wake WoL protocol */
wdenk2d966952002-10-31 22:12:35 +0000362#define PROT_RARP 0x8035 /* IP ARP protocol */
wdenka3d991b2004-04-15 21:48:45 +0000363#define PROT_VLAN 0x8100 /* IEEE 802.1q protocol */
Stefan Roese99d4c6d2016-02-10 07:22:10 +0100364#define PROT_IPV6 0x86dd /* IPv6 over bluebook */
365#define PROT_PPP_SES 0x8864 /* PPPoE session messages */
Samuel Mendoza-Jonasf641a8a2019-06-18 11:37:17 +1000366#define PROT_NCSI 0x88f8 /* NC-SI control packets */
wdenk2d966952002-10-31 22:12:35 +0000367
368#define IPPROTO_ICMP 1 /* Internet Control Message Protocol */
369#define IPPROTO_UDP 17 /* User Datagram Protocol */
370
371/*
Joe Hershbergerc5c59df2012-05-23 07:58:05 +0000372 * Internet Protocol (IP) header.
373 */
374struct ip_hdr {
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500375 u8 ip_hl_v; /* header length and version */
376 u8 ip_tos; /* type of service */
377 u16 ip_len; /* total length */
378 u16 ip_id; /* identification */
379 u16 ip_off; /* fragment offset field */
380 u8 ip_ttl; /* time to live */
381 u8 ip_p; /* protocol */
382 u16 ip_sum; /* checksum */
Joe Hershberger049a95a2015-04-08 01:41:01 -0500383 struct in_addr ip_src; /* Source IP address */
384 struct in_addr ip_dst; /* Destination IP address */
Denis Pynkin704f3ac2017-07-21 19:28:42 +0300385} __attribute__((packed));
Joe Hershbergerc5c59df2012-05-23 07:58:05 +0000386
387#define IP_OFFS 0x1fff /* ip offset *= 8 */
388#define IP_FLAGS 0xe000 /* first 3 bits */
389#define IP_FLAGS_RES 0x8000 /* reserved */
390#define IP_FLAGS_DFRAG 0x4000 /* don't fragments */
391#define IP_FLAGS_MFRAG 0x2000 /* more fragments */
392
393#define IP_HDR_SIZE (sizeof(struct ip_hdr))
394
395/*
Joe Hershberger594c26f2012-05-23 07:58:04 +0000396 * Internet Protocol (IP) + UDP header.
wdenk2d966952002-10-31 22:12:35 +0000397 */
Joe Hershberger594c26f2012-05-23 07:58:04 +0000398struct ip_udp_hdr {
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500399 u8 ip_hl_v; /* header length and version */
400 u8 ip_tos; /* type of service */
401 u16 ip_len; /* total length */
402 u16 ip_id; /* identification */
403 u16 ip_off; /* fragment offset field */
404 u8 ip_ttl; /* time to live */
405 u8 ip_p; /* protocol */
406 u16 ip_sum; /* checksum */
Joe Hershberger049a95a2015-04-08 01:41:01 -0500407 struct in_addr ip_src; /* Source IP address */
408 struct in_addr ip_dst; /* Destination IP address */
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500409 u16 udp_src; /* UDP source port */
410 u16 udp_dst; /* UDP destination port */
411 u16 udp_len; /* Length of UDP packet */
412 u16 udp_xsum; /* Checksum */
Denis Pynkin704f3ac2017-07-21 19:28:42 +0300413} __attribute__((packed));
wdenk2d966952002-10-31 22:12:35 +0000414
Joe Hershberger594c26f2012-05-23 07:58:04 +0000415#define IP_UDP_HDR_SIZE (sizeof(struct ip_udp_hdr))
Joe Hershbergerc5c59df2012-05-23 07:58:05 +0000416#define UDP_HDR_SIZE (IP_UDP_HDR_SIZE - IP_HDR_SIZE)
wdenk2d966952002-10-31 22:12:35 +0000417
418/*
419 * Address Resolution Protocol (ARP) header.
420 */
Joe Hershberger738853b2012-05-23 07:58:08 +0000421struct arp_hdr {
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500422 u16 ar_hrd; /* Format of hardware address */
wdenk2d966952002-10-31 22:12:35 +0000423# define ARP_ETHER 1 /* Ethernet hardware address */
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500424 u16 ar_pro; /* Format of protocol address */
425 u8 ar_hln; /* Length of hardware address */
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500426 u8 ar_pln; /* Length of protocol address */
Joe Hershberger674bb242012-05-23 07:58:17 +0000427# define ARP_PLEN 4
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500428 u16 ar_op; /* Operation */
wdenk2d966952002-10-31 22:12:35 +0000429# define ARPOP_REQUEST 1 /* Request to resolve address */
430# define ARPOP_REPLY 2 /* Response to previous request */
431
432# define RARPOP_REQUEST 3 /* Request to resolve address */
433# define RARPOP_REPLY 4 /* Response to previous request */
434
435 /*
wdenk8bde7f72003-06-27 21:31:46 +0000436 * The remaining fields are variable in size, according to
437 * the sizes above, and are defined as appropriate for
438 * specific hardware/protocol combinations.
wdenk2d966952002-10-31 22:12:35 +0000439 */
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500440 u8 ar_data[0];
Joe Hershberger674bb242012-05-23 07:58:17 +0000441#define ar_sha ar_data[0]
442#define ar_spa ar_data[ARP_HLEN]
443#define ar_tha ar_data[ARP_HLEN + ARP_PLEN]
444#define ar_tpa ar_data[ARP_HLEN + ARP_PLEN + ARP_HLEN]
wdenk2d966952002-10-31 22:12:35 +0000445#if 0
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500446 u8 ar_sha[]; /* Sender hardware address */
447 u8 ar_spa[]; /* Sender protocol address */
448 u8 ar_tha[]; /* Target hardware address */
449 u8 ar_tpa[]; /* Target protocol address */
wdenk2d966952002-10-31 22:12:35 +0000450#endif /* 0 */
Denis Pynkin704f3ac2017-07-21 19:28:42 +0300451} __attribute__((packed));
wdenk2d966952002-10-31 22:12:35 +0000452
453#define ARP_HDR_SIZE (8+20) /* Size assuming ethernet */
454
455/*
456 * ICMP stuff (just enough to handle (host) redirect messages)
457 */
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200458#define ICMP_ECHO_REPLY 0 /* Echo reply */
Simon Glass4793ee62011-10-24 18:00:01 +0000459#define ICMP_NOT_REACH 3 /* Detination unreachable */
wdenk2d966952002-10-31 22:12:35 +0000460#define ICMP_REDIRECT 5 /* Redirect (change route) */
wdenk73a8b272003-06-05 19:27:42 +0000461#define ICMP_ECHO_REQUEST 8 /* Echo request */
wdenk2d966952002-10-31 22:12:35 +0000462
463/* Codes for REDIRECT. */
464#define ICMP_REDIR_NET 0 /* Redirect Net */
465#define ICMP_REDIR_HOST 1 /* Redirect Host */
466
Simon Glass4793ee62011-10-24 18:00:01 +0000467/* Codes for NOT_REACH */
468#define ICMP_NOT_REACH_PORT 3 /* Port unreachable */
469
Joe Hershbergere0a63072012-05-23 07:58:09 +0000470struct icmp_hdr {
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500471 u8 type;
472 u8 code;
473 u16 checksum;
wdenk2d966952002-10-31 22:12:35 +0000474 union {
475 struct {
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500476 u16 id;
477 u16 sequence;
wdenk2d966952002-10-31 22:12:35 +0000478 } echo;
Sergey Temerkhanov5917e7d2015-04-08 01:41:22 -0500479 u32 gateway;
wdenk2d966952002-10-31 22:12:35 +0000480 struct {
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500481 u16 unused;
482 u16 mtu;
wdenk2d966952002-10-31 22:12:35 +0000483 } frag;
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500484 u8 data[0];
wdenk2d966952002-10-31 22:12:35 +0000485 } un;
Denis Pynkin704f3ac2017-07-21 19:28:42 +0300486} __attribute__((packed));
wdenk2d966952002-10-31 22:12:35 +0000487
Joe Hershbergere0a63072012-05-23 07:58:09 +0000488#define ICMP_HDR_SIZE (sizeof(struct icmp_hdr))
489#define IP_ICMP_HDR_SIZE (IP_HDR_SIZE + ICMP_HDR_SIZE)
wdenk2d966952002-10-31 22:12:35 +0000490
wdenk2d966952002-10-31 22:12:35 +0000491/*
Stefan Agner700877a2016-04-13 16:38:02 -0700492 * Maximum packet size; used to allocate packet storage. Use
493 * the maxium Ethernet frame size as specified by the Ethernet
494 * standard including the 802.1Q tag (VLAN tagging).
495 * maximum packet size = 1522
wdenk2d966952002-10-31 22:12:35 +0000496 * maximum packet size and multiple of 32 bytes = 1536
497 */
Stefan Agner700877a2016-04-13 16:38:02 -0700498#define PKTSIZE 1522
wdenk2d966952002-10-31 22:12:35 +0000499#define PKTSIZE_ALIGN 1536
wdenk2d966952002-10-31 22:12:35 +0000500
501/*
502 * Maximum receive ring size; that is, the number of packets
503 * we can buffer before overflow happens. Basically, this just
504 * needs to be enough to prevent a packet being discarded while
505 * we are processing the previous one.
506 */
507#define RINGSZ 4
508#define RINGSZ_LOG2 2
509
510/**********************************************************************/
511/*
512 * Globals.
513 *
514 * Note:
515 *
Joe Hershberger049a95a2015-04-08 01:41:01 -0500516 * All variables of type struct in_addr are stored in NETWORK byte order
wdenk2d966952002-10-31 22:12:35 +0000517 * (big endian).
518 */
519
520/* net.c */
521/** BOOTP EXTENTIONS **/
Joe Hershberger049a95a2015-04-08 01:41:01 -0500522extern struct in_addr net_gateway; /* Our gateway IP address */
523extern struct in_addr net_netmask; /* Our subnet mask (0 = unknown) */
524/* Our Domain Name Server (0 = unknown) */
525extern struct in_addr net_dns_server;
Jon Loeliger1fe80d72007-07-09 22:08:34 -0500526#if defined(CONFIG_BOOTP_DNS2)
Joe Hershberger049a95a2015-04-08 01:41:01 -0500527/* Our 2nd Domain Name Server (0 = unknown) */
528extern struct in_addr net_dns_server2;
stroesefe389a82003-08-28 14:17:32 +0000529#endif
Joe Hershberger586cbe52015-04-08 01:41:03 -0500530extern char net_nis_domain[32]; /* Our IS domain */
531extern char net_hostname[32]; /* Our hostname */
532extern char net_root_path[64]; /* Our root path */
wdenk2d966952002-10-31 22:12:35 +0000533/** END OF BOOTP EXTENTIONS **/
oliver@schinagl.nla40db6d2016-11-25 16:30:19 +0100534extern u8 net_ethaddr[ARP_HLEN]; /* Our ethernet address */
535extern u8 net_server_ethaddr[ARP_HLEN]; /* Boot server enet address */
Joe Hershberger049a95a2015-04-08 01:41:01 -0500536extern struct in_addr net_ip; /* Our IP addr (0 = unknown) */
537extern struct in_addr net_server_ip; /* Server IP addr (0 = unknown) */
Joe Hershberger1203fcc2015-04-08 01:41:05 -0500538extern uchar *net_tx_packet; /* THE transmit packet */
Joe Hershberger2a504df2015-03-22 17:09:11 -0500539extern uchar *net_rx_packets[PKTBUFSRX]; /* Receive packets */
Joe Hershberger1203fcc2015-04-08 01:41:05 -0500540extern uchar *net_rx_packet; /* Current receive packet */
541extern int net_rx_packet_len; /* Current rx packet length */
oliver@schinagl.nla40db6d2016-11-25 16:30:19 +0100542extern const u8 net_bcast_ethaddr[ARP_HLEN]; /* Ethernet broadcast address */
543extern const u8 net_null_ethaddr[ARP_HLEN];
wdenk2d966952002-10-31 22:12:35 +0000544
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000545#define VLAN_NONE 4095 /* untagged */
546#define VLAN_IDMASK 0x0fff /* mask of valid vlan id */
Joe Hershberger4fd50552015-04-08 01:41:17 -0500547extern ushort net_our_vlan; /* Our VLAN */
548extern ushort net_native_vlan; /* Our Native VLAN */
wdenka3d991b2004-04-15 21:48:45 +0000549
Joe Hershbergerbc0571f2015-04-08 01:41:21 -0500550extern int net_restart_wrap; /* Tried all network devices */
wdenk2d966952002-10-31 22:12:35 +0000551
Simon Glasse4bf0c52011-10-24 18:00:02 +0000552enum proto_t {
553 BOOTP, RARP, ARP, TFTPGET, DHCP, PING, DNS, NFS, CDP, NETCONS, SNTP,
Lothar Feltend8970da2018-06-22 22:29:54 +0200554 TFTPSRV, TFTPPUT, LINKLOCAL, FASTBOOT, WOL
Simon Glasse4bf0c52011-10-24 18:00:02 +0000555};
wdenk2d966952002-10-31 22:12:35 +0000556
Jacob Stiffler11a69ff2015-09-30 10:12:05 -0400557extern char net_boot_file_name[1024];/* Boot File name */
Alexander Graf449312c2018-06-15 10:29:27 +0200558/* Indicates whether the file name was specified on the command line */
559extern bool net_boot_file_name_explicit;
Joe Hershberger14111572015-04-08 01:41:02 -0500560/* The actual transferred size of the bootfile (in bytes) */
561extern u32 net_boot_file_size;
562/* Boot file size in blocks as reported by the DHCP server */
563extern u32 net_boot_file_expected_size_in_blocks;
wdenk2d966952002-10-31 22:12:35 +0000564
Robin Getz1a32bf42009-07-20 14:53:54 -0400565#if defined(CONFIG_CMD_DNS)
Joe Hershberger786eac52015-04-08 01:41:15 -0500566extern char *net_dns_resolve; /* The host to resolve */
567extern char *net_dns_env_var; /* the env var to put the ip into */
Robin Getz1a32bf42009-07-20 14:53:54 -0400568#endif
569
Jon Loeliger639221c2007-07-09 17:15:49 -0500570#if defined(CONFIG_CMD_PING)
Joe Hershberger049a95a2015-04-08 01:41:01 -0500571extern struct in_addr net_ping_ip; /* the ip address to ping */
wdenk73a8b272003-06-05 19:27:42 +0000572#endif
573
Jon Loeliger639221c2007-07-09 17:15:49 -0500574#if defined(CONFIG_CMD_CDP)
wdenka3d991b2004-04-15 21:48:45 +0000575/* when CDP completes these hold the return values */
Joe Hershberger6aede5b2015-04-08 01:41:14 -0500576extern ushort cdp_native_vlan; /* CDP returned native VLAN */
577extern ushort cdp_appliance_vlan; /* CDP returned appliance VLAN */
Joe Hershberger17351882012-05-23 07:58:00 +0000578
579/*
580 * Check for a CDP packet by examining the received MAC address field
581 */
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500582static inline int is_cdp_packet(const uchar *ethaddr)
Joe Hershberger17351882012-05-23 07:58:00 +0000583{
oliver@schinagl.nla40db6d2016-11-25 16:30:19 +0100584 extern const u8 net_cdp_ethaddr[ARP_HLEN];
Joe Hershberger17351882012-05-23 07:58:00 +0000585
oliver@schinagl.nla40db6d2016-11-25 16:30:19 +0100586 return memcmp(ethaddr, net_cdp_ethaddr, ARP_HLEN) == 0;
Joe Hershberger17351882012-05-23 07:58:00 +0000587}
wdenka3d991b2004-04-15 21:48:45 +0000588#endif
589
Jon Loeliger639221c2007-07-09 17:15:49 -0500590#if defined(CONFIG_CMD_SNTP)
Joe Hershberger049a95a2015-04-08 01:41:01 -0500591extern struct in_addr net_ntp_server; /* the ip address to NTP */
Joe Hershbergerbc0571f2015-04-08 01:41:21 -0500592extern int net_ntp_time_offset; /* offset time from UTC */
wdenkea287de2005-04-01 00:25:43 +0000593#endif
594
wdenk2d966952002-10-31 22:12:35 +0000595/* Initialize the network adapter */
Joe Hershbergerff997432015-03-22 17:09:02 -0500596void net_init(void);
Joe Hershbergerbc0571f2015-04-08 01:41:21 -0500597int net_loop(enum proto_t);
wdenk2d966952002-10-31 22:12:35 +0000598
599/* Load failed. Start again. */
Joe Hershbergerbc0571f2015-04-08 01:41:21 -0500600int net_start_again(void);
wdenk2d966952002-10-31 22:12:35 +0000601
wdenka3d991b2004-04-15 21:48:45 +0000602/* Get size of the ethernet header when we send */
Joe Hershberger1203fcc2015-04-08 01:41:05 -0500603int net_eth_hdr_size(void);
wdenka3d991b2004-04-15 21:48:45 +0000604
605/* Set ethernet header; returns the size of the header */
Joe Hershberger1203fcc2015-04-08 01:41:05 -0500606int net_set_ether(uchar *xet, const uchar *dest_ethaddr, uint prot);
Joe Hershbergerff997432015-03-22 17:09:02 -0500607int net_update_ether(struct ethernet_hdr *et, uchar *addr, uint prot);
wdenk2d966952002-10-31 22:12:35 +0000608
609/* Set IP header */
Duncan Hare5d457ec2018-06-24 15:40:41 -0700610void net_set_ip_header(uchar *pkt, struct in_addr dest, struct in_addr source,
611 u16 pkt_len, u8 proto);
Joe Hershberger049a95a2015-04-08 01:41:01 -0500612void net_set_udp_header(uchar *pkt, struct in_addr dest, int dport,
Joe Hershberger4b11c912012-05-23 07:59:07 +0000613 int sport, int len);
wdenk2d966952002-10-31 22:12:35 +0000614
Simon Glass9b0e35c2015-01-19 22:16:07 -0700615/**
616 * compute_ip_checksum() - Compute IP checksum
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 16-bit IP checksum
621 */
622unsigned compute_ip_checksum(const void *addr, unsigned nbytes);
623
624/**
625 * add_ip_checksums() - add two IP checksums
626 *
627 * @offset: Offset of first sum (if odd we do a byte-swap)
628 * @sum: First checksum
629 * @new_sum: New checksum to add
630 * @return updated 16-bit IP checksum
631 */
632unsigned add_ip_checksums(unsigned offset, unsigned sum, unsigned new_sum);
633
634/**
635 * ip_checksum_ok() - check if a checksum is correct
636 *
637 * This works by making sure the checksum sums to 0
638 *
639 * @addr: Address to check (must be 16-bit aligned)
640 * @nbytes: Number of bytes to check (normally a multiple of 2)
641 * @return true if the checksum matches, false if not
642 */
643int ip_checksum_ok(const void *addr, unsigned nbytes);
644
Joe Hershbergerd280d3f2012-05-23 07:58:01 +0000645/* Callbacks */
Joe Hershbergerff997432015-03-22 17:09:02 -0500646rxhand_f *net_get_udp_handler(void); /* Get UDP RX packet handler */
647void net_set_udp_handler(rxhand_f *); /* Set UDP RX packet handler */
648rxhand_f *net_get_arp_handler(void); /* Get ARP RX packet handler */
649void net_set_arp_handler(rxhand_f *); /* Set ARP RX packet handler */
Joe Hershberger3f02c982018-09-26 16:48:58 -0500650bool arp_is_waiting(void); /* Waiting for ARP reply? */
Joe Hershbergerff997432015-03-22 17:09:02 -0500651void net_set_icmp_handler(rxhand_icmp_f *f); /* Set ICMP RX handler */
Joe Hershbergerbc0571f2015-04-08 01:41:21 -0500652void net_set_timeout_handler(ulong, thand_f *);/* Set timeout handler */
wdenk2d966952002-10-31 22:12:35 +0000653
Joe Hershberger22f6e992012-05-23 07:59:14 +0000654/* Network loop state */
655enum net_loop_state {
656 NETLOOP_CONTINUE,
657 NETLOOP_RESTART,
658 NETLOOP_SUCCESS,
659 NETLOOP_FAIL
660};
Kim Phillips06370592012-10-29 13:34:33 +0000661extern enum net_loop_state net_state;
662
Joe Hershberger22f6e992012-05-23 07:59:14 +0000663static inline void net_set_state(enum net_loop_state state)
664{
Joe Hershberger4ef8d532012-05-23 08:01:04 +0000665 debug_cond(DEBUG_INT_STATE, "--- NetState set to %d\n", state);
Joe Hershberger22f6e992012-05-23 07:59:14 +0000666 net_state = state;
667}
668
Joe Hershbergerac3f26c2018-09-26 16:49:02 -0500669/*
670 * net_get_async_tx_pkt_buf - Get a packet buffer that is not in use for
671 * sending an asynchronous reply
672 *
673 * returns - ptr to packet buffer
674 */
675uchar * net_get_async_tx_pkt_buf(void);
676
Joe Hershbergere94070c2012-05-23 07:59:24 +0000677/* Transmit a packet */
Joe Hershberger1203fcc2015-04-08 01:41:05 -0500678static inline void net_send_packet(uchar *pkt, int len)
Joe Hershbergeradf5d932012-05-23 07:59:13 +0000679{
Joe Hershberger60304592015-03-22 17:09:24 -0500680 /* Currently no way to return errors from eth_send() */
Joe Hershbergeradf5d932012-05-23 07:59:13 +0000681 (void) eth_send(pkt, len);
682}
wdenk2d966952002-10-31 22:12:35 +0000683
Joe Hershberger206d07f2012-05-23 07:58:10 +0000684/*
Joe Hershberger1203fcc2015-04-08 01:41:05 -0500685 * Transmit "net_tx_packet" as UDP packet, performing ARP request if needed
Joe Hershbergerece223b2012-05-23 07:59:15 +0000686 * (ether will be populated)
Joe Hershberger206d07f2012-05-23 07:58:10 +0000687 *
688 * @param ether Raw packet buffer
689 * @param dest IP address to send the datagram to
690 * @param dport Destination UDP port
691 * @param sport Source UDP port
692 * @param payload_len Length of data after the UDP header
693 */
Duncan Hare5d457ec2018-06-24 15:40:41 -0700694int net_send_ip_packet(uchar *ether, struct in_addr dest, int dport, int sport,
695 int payload_len, int proto, u8 action, u32 tcp_seq_num,
696 u32 tcp_ack_num);
Joe Hershberger1203fcc2015-04-08 01:41:05 -0500697int net_send_udp_packet(uchar *ether, struct in_addr dest, int dport,
Joe Hershberger206d07f2012-05-23 07:58:10 +0000698 int sport, int payload_len);
wdenk73a8b272003-06-05 19:27:42 +0000699
wdenk2d966952002-10-31 22:12:35 +0000700/* Processes a received packet */
Joe Hershberger2a504df2015-03-22 17:09:11 -0500701void net_process_received_packet(uchar *in_packet, int len);
wdenk2d966952002-10-31 22:12:35 +0000702
Jason Kridner99761e52018-03-07 05:40:43 -0500703#if defined(CONFIG_NETCONSOLE) && !defined(CONFIG_SPL_BUILD)
Joe Hershberger6a38a5f2015-04-08 01:41:16 -0500704void nc_start(void);
Joe Hershberger049a95a2015-04-08 01:41:01 -0500705int nc_input_packet(uchar *pkt, struct in_addr src_ip, unsigned dest_port,
Joe Hershberger8a0eccb2012-09-18 10:01:32 +0000706 unsigned src_port, unsigned len);
Joe Hershberger48522bb2012-05-15 08:59:08 +0000707#endif
708
Fabio Estevam92163872015-11-08 22:25:14 -0200709static __always_inline int eth_is_on_demand_init(void)
Joe Hershbergerf8be7d62012-08-03 10:59:08 +0000710{
Jason Kridner99761e52018-03-07 05:40:43 -0500711#if defined(CONFIG_NETCONSOLE) && !defined(CONFIG_SPL_BUILD)
Joe Hershbergerf8be7d62012-08-03 10:59:08 +0000712 extern enum proto_t net_loop_last_protocol;
713
714 return net_loop_last_protocol != NETCONS;
715#else
716 return 1;
717#endif
718}
719
720static inline void eth_set_last_protocol(int protocol)
721{
Jason Kridner99761e52018-03-07 05:40:43 -0500722#if defined(CONFIG_NETCONSOLE) && !defined(CONFIG_SPL_BUILD)
Joe Hershbergerf8be7d62012-08-03 10:59:08 +0000723 extern enum proto_t net_loop_last_protocol;
724
725 net_loop_last_protocol = protocol;
726#endif
727}
728
wdenk2d966952002-10-31 22:12:35 +0000729/*
Simon Glasse4a3d572011-10-27 06:24:32 +0000730 * Check if autoload is enabled. If so, use either NFS or TFTP to download
731 * the boot file.
732 */
733void net_auto_load(void);
734
735/*
wdenk2d966952002-10-31 22:12:35 +0000736 * The following functions are a bit ugly, but necessary to deal with
737 * alignment restrictions on ARM.
738 *
739 * We're using inline functions, which had the smallest memory
740 * footprint in our tests.
741 */
742/* return IP *in network byteorder* */
Joe Hershberger049a95a2015-04-08 01:41:01 -0500743static inline struct in_addr net_read_ip(void *from)
wdenk2d966952002-10-31 22:12:35 +0000744{
Joe Hershberger049a95a2015-04-08 01:41:01 -0500745 struct in_addr ip;
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000746
747 memcpy((void *)&ip, (void *)from, sizeof(ip));
wdenk2d966952002-10-31 22:12:35 +0000748 return ip;
749}
750
751/* return ulong *in network byteorder* */
Heinrich Schuchardtbbfc5622019-07-14 22:02:13 +0200752static inline u32 net_read_u32(void *from)
wdenk2d966952002-10-31 22:12:35 +0000753{
Sergey Temerkhanov5917e7d2015-04-08 01:41:22 -0500754 u32 l;
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000755
756 memcpy((void *)&l, (void *)from, sizeof(l));
wdenk2d966952002-10-31 22:12:35 +0000757 return l;
758}
759
760/* write IP *in network byteorder* */
Joe Hershberger049a95a2015-04-08 01:41:01 -0500761static inline void net_write_ip(void *to, struct in_addr ip)
wdenk2d966952002-10-31 22:12:35 +0000762{
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000763 memcpy(to, (void *)&ip, sizeof(ip));
wdenk2d966952002-10-31 22:12:35 +0000764}
765
766/* copy IP */
Joe Hershberger049a95a2015-04-08 01:41:01 -0500767static inline void net_copy_ip(void *to, void *from)
wdenk2d966952002-10-31 22:12:35 +0000768{
Joe Hershberger049a95a2015-04-08 01:41:01 -0500769 memcpy((void *)to, from, sizeof(struct in_addr));
wdenk2d966952002-10-31 22:12:35 +0000770}
771
772/* copy ulong */
Heinrich Schuchardtbbfc5622019-07-14 22:02:13 +0200773static inline void net_copy_u32(void *to, void *from)
wdenk2d966952002-10-31 22:12:35 +0000774{
Sergey Temerkhanov5917e7d2015-04-08 01:41:22 -0500775 memcpy((void *)to, (void *)from, sizeof(u32));
wdenk2d966952002-10-31 22:12:35 +0000776}
777
Mike Rapoport50cca8b2007-08-12 08:48:27 +0300778/**
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500779 * is_zero_ethaddr - Determine if give Ethernet address is all zeros.
Mike Rapoport50cca8b2007-08-12 08:48:27 +0300780 * @addr: Pointer to a six-byte array containing the Ethernet address
781 *
782 * Return true if the address is all zeroes.
783 */
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500784static inline int is_zero_ethaddr(const u8 *addr)
Mike Rapoport50cca8b2007-08-12 08:48:27 +0300785{
786 return !(addr[0] | addr[1] | addr[2] | addr[3] | addr[4] | addr[5]);
787}
788
789/**
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500790 * is_multicast_ethaddr - Determine if the Ethernet address is a multicast.
Mike Rapoport50cca8b2007-08-12 08:48:27 +0300791 * @addr: Pointer to a six-byte array containing the Ethernet address
792 *
793 * Return true if the address is a multicast address.
794 * By definition the broadcast address is also a multicast address.
795 */
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500796static inline int is_multicast_ethaddr(const u8 *addr)
Mike Rapoport50cca8b2007-08-12 08:48:27 +0300797{
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000798 return 0x01 & addr[0];
Mike Rapoport50cca8b2007-08-12 08:48:27 +0300799}
800
Remy Bohmer23cd1382009-07-29 18:18:43 +0200801/*
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500802 * is_broadcast_ethaddr - Determine if the Ethernet address is broadcast
Remy Bohmer23cd1382009-07-29 18:18:43 +0200803 * @addr: Pointer to a six-byte array containing the Ethernet address
804 *
805 * Return true if the address is the broadcast address.
806 */
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500807static inline int is_broadcast_ethaddr(const u8 *addr)
Remy Bohmer23cd1382009-07-29 18:18:43 +0200808{
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000809 return (addr[0] & addr[1] & addr[2] & addr[3] & addr[4] & addr[5]) ==
810 0xff;
Remy Bohmer23cd1382009-07-29 18:18:43 +0200811}
812
813/*
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500814 * is_valid_ethaddr - Determine if the given Ethernet address is valid
Mike Frysinger75edebe2009-01-27 16:53:39 -0500815 * @addr: Pointer to a six-byte array containing the Ethernet address
816 *
817 * Check that the Ethernet address (MAC) is not 00:00:00:00:00:00, is not
818 * a multicast address, and is not FF:FF:FF:FF:FF:FF.
819 *
820 * Return true if the address is valid.
821 */
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500822static inline int is_valid_ethaddr(const u8 *addr)
Mike Frysinger75edebe2009-01-27 16:53:39 -0500823{
824 /* FF:FF:FF:FF:FF:FF is a multicast address so we don't need to
825 * explicitly check for it here. */
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500826 return !is_multicast_ethaddr(addr) && !is_zero_ethaddr(addr);
Mike Frysinger75edebe2009-01-27 16:53:39 -0500827}
828
Masahiro Yamadada384a92014-04-18 19:09:48 +0900829/**
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500830 * net_random_ethaddr - Generate software assigned random Ethernet address
Masahiro Yamadada384a92014-04-18 19:09:48 +0900831 * @addr: Pointer to a six-byte array containing the Ethernet address
832 *
833 * Generate a random Ethernet address (MAC) that is not multicast
834 * and has the local assigned bit set.
835 */
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500836static inline void net_random_ethaddr(uchar *addr)
Masahiro Yamadada384a92014-04-18 19:09:48 +0900837{
838 int i;
Michael Walle12c2a312019-08-27 10:13:52 +0200839 unsigned int seed = get_ticks();
Masahiro Yamadada384a92014-04-18 19:09:48 +0900840
841 for (i = 0; i < 6; i++)
842 addr[i] = rand_r(&seed);
843
844 addr[0] &= 0xfe; /* clear multicast bit */
845 addr[0] |= 0x02; /* set local assignment bit (IEEE802) */
846}
847
Joe Hershbergerfb8977c2019-09-13 19:21:16 -0500848/**
849 * string_to_enetaddr() - Parse a MAC address
850 *
851 * Convert a string MAC address
852 *
853 * Implemented in lib/net_utils.c (built unconditionally)
854 *
855 * @addr: MAC address in aa:bb:cc:dd:ee:ff format, where each part is a 2-digit
856 * hex value
857 * @enetaddr: Place to put MAC address (6 bytes)
858 */
859void string_to_enetaddr(const char *addr, uint8_t *enetaddr);
860
wdenk2d966952002-10-31 22:12:35 +0000861/* Convert an IP address to a string */
Joe Hershberger049a95a2015-04-08 01:41:01 -0500862void ip_to_string(struct in_addr x, char *s);
wdenk2d966952002-10-31 22:12:35 +0000863
Simon Glass8d5babb2019-11-14 12:57:21 -0700864/**
865 * string_to_ip() - Convert a string to ip address
866 *
Joe Hershbergerd7243212019-09-13 19:29:41 -0500867 * Implemented in lib/net_utils.c (built unconditionally)
868 *
869 * @s: Input string to parse
870 * @return: in_addr struct containing the parsed IP address
Simon Glass8d5babb2019-11-14 12:57:21 -0700871 */
Joe Hershberger049a95a2015-04-08 01:41:01 -0500872struct in_addr string_to_ip(const char *s);
wdenk73a8b272003-06-05 19:27:42 +0000873
wdenka3d991b2004-04-15 21:48:45 +0000874/* Convert a VLAN id to a string */
Joe Hershberger4fd50552015-04-08 01:41:17 -0500875void vlan_to_string(ushort x, char *s);
wdenka3d991b2004-04-15 21:48:45 +0000876
877/* Convert a string to a vlan id */
Joe Hershberger4fd50552015-04-08 01:41:17 -0500878ushort string_to_vlan(const char *s);
wdenka3d991b2004-04-15 21:48:45 +0000879
wdenka3d991b2004-04-15 21:48:45 +0000880/* read a VLAN id from an environment variable */
Simon Glass723806c2017-08-03 12:22:15 -0600881ushort env_get_vlan(char *);
wdenka3d991b2004-04-15 21:48:45 +0000882
wdenk2d966952002-10-31 22:12:35 +0000883/* copy a filename (allow for "..." notation, limit length) */
Joe Hershbergerff997432015-03-22 17:09:02 -0500884void copy_filename(char *dst, const char *src, int size);
wdenk2d966952002-10-31 22:12:35 +0000885
Joe Hershberger3a66fcb2018-07-03 19:36:39 -0500886/* check if serverip is specified in filename from the command line */
887int is_serverip_in_cmd(void);
888
Joe Hershberger6ab12832018-07-03 19:36:43 -0500889/**
890 * net_parse_bootfile - Parse the bootfile env var / cmd line param
891 *
892 * @param ipaddr - a pointer to the ipaddr to populate if included in bootfile
893 * @param filename - a pointer to the string to save the filename part
894 * @param max_len - The longest - 1 that the filename part can be
895 *
896 * return 1 if parsed, 0 if bootfile is empty
897 */
898int net_parse_bootfile(struct in_addr *ipaddr, char *filename, int max_len);
899
Lukasz Majewskic7ff5522015-08-24 00:21:47 +0200900/**
901 * update_tftp - Update firmware over TFTP (via DFU)
902 *
903 * This function updates board's firmware via TFTP
904 *
905 * @param addr - memory address where data is stored
906 * @param interface - the DFU medium name - e.g. "mmc"
907 * @param devstring - the DFU medium number - e.g. "1"
908 *
909 * @return - 0 on success, other value on failure
910 */
911int update_tftp(ulong addr, char *interface, char *devstring);
Simon Glassea5427e2013-05-15 06:23:54 +0000912
Simon Glass8d5babb2019-11-14 12:57:21 -0700913/**
914 * env_get_ip() - Convert an environment value to to an ip address
915 *
916 * @var: Environment variable to convert. The value of this variable must be
917 * in the format format a.b.c.d, where each value is a decimal number from
918 * 0 to 255
919 * @return IP address, or 0 if invalid
920 */
921static inline struct in_addr env_get_ip(char *var)
922{
923 return string_to_ip(env_get(var));
924}
Simon Glass5e6267a2019-12-28 10:44:48 -0700925
926/**
927 * reset_phy() - Reset the Ethernet PHY
928 *
929 * This should be implemented by boards if CONFIG_RESET_PHY_R is enabled
930 */
931void reset_phy(void);
932
wdenk2d966952002-10-31 22:12:35 +0000933#endif /* __NET_H__ */