blob: 13da69b7c145c872842730fdb07eef20c306d2ec [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
Patrick Wildt36ea0ca2020-10-07 11:03:30 +020047/* Number of packets processed together */
48#define ETH_PACKETS_BATCH_RECV 32
49
oliver@schinagl.nla40db6d2016-11-25 16:30:19 +010050/* ARP hardware address length */
51#define ARP_HLEN 6
oliver@schinagl.nl9f455bc2016-11-25 16:30:20 +010052/*
53 * The size of a MAC address in string form, each digit requires two chars
54 * and five separator characters to form '00:00:00:00:00:00'.
55 */
56#define ARP_HLEN_ASCII (ARP_HLEN * 2) + (ARP_HLEN - 1)
oliver@schinagl.nla40db6d2016-11-25 16:30:19 +010057
Matthias Weisserea45cb02011-12-03 03:29:44 +000058/* IPv4 addresses are always 32 bits in size */
Joe Hershberger049a95a2015-04-08 01:41:01 -050059struct in_addr {
60 __be32 s_addr;
61};
wdenk2d966952002-10-31 22:12:35 +000062
Luca Ceresoli03eb1292011-04-18 06:19:50 +000063/**
Simon Glass77f4e472019-12-28 10:44:43 -070064 * do_tftpb - Run the tftpboot command
65 *
66 * @cmdtp: Command information for tftpboot
67 * @flag: Command flags (CMD_FLAG_...)
68 * @argc: Number of arguments
69 * @argv: List of arguments
70 * @return result (see enum command_ret_t)
71 */
Simon Glass09140112020-05-10 11:40:03 -060072int do_tftpb(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]);
Simon Glass77f4e472019-12-28 10:44:43 -070073
74/**
Luca Ceresoli03eb1292011-04-18 06:19:50 +000075 * An incoming packet handler.
76 * @param pkt pointer to the application packet
77 * @param dport destination UDP port
78 * @param sip source IP address
79 * @param sport source UDP port
80 * @param len packet length
wdenk2d966952002-10-31 22:12:35 +000081 */
Luca Ceresoli03eb1292011-04-18 06:19:50 +000082typedef void rxhand_f(uchar *pkt, unsigned dport,
Joe Hershberger049a95a2015-04-08 01:41:01 -050083 struct in_addr sip, unsigned sport,
Luca Ceresoli03eb1292011-04-18 06:19:50 +000084 unsigned len);
wdenk2d966952002-10-31 22:12:35 +000085
Simon Glass4793ee62011-10-24 18:00:01 +000086/**
87 * An incoming ICMP packet handler.
88 * @param type ICMP type
89 * @param code ICMP code
90 * @param dport destination UDP port
91 * @param sip source IP address
92 * @param sport source UDP port
93 * @param pkt pointer to the ICMP packet data
94 * @param len packet length
95 */
96typedef void rxhand_icmp_f(unsigned type, unsigned code, unsigned dport,
Joe Hershberger049a95a2015-04-08 01:41:01 -050097 struct in_addr sip, unsigned sport, uchar *pkt, unsigned len);
Simon Glass4793ee62011-10-24 18:00:01 +000098
wdenk2d966952002-10-31 22:12:35 +000099/*
100 * A timeout handler. Called after time interval has expired.
101 */
102typedef void thand_f(void);
103
wdenk2d966952002-10-31 22:12:35 +0000104enum eth_state_t {
105 ETH_STATE_INIT,
106 ETH_STATE_PASSIVE,
107 ETH_STATE_ACTIVE
108};
109
Joe Hershberger05c3e682015-03-22 17:09:10 -0500110#ifdef CONFIG_DM_ETH
111/**
112 * struct eth_pdata - Platform data for Ethernet MAC controllers
113 *
114 * @iobase: The base address of the hardware registers
115 * @enetaddr: The Ethernet MAC address that is loaded from EEPROM or env
Simon Glassc74c8e62015-04-05 16:07:39 -0600116 * @phy_interface: PHY interface to use - see PHY_INTERFACE_MODE_...
Alexey Brodkinf74264d2016-01-13 16:59:35 +0300117 * @max_speed: Maximum speed of Ethernet connection supported by MAC
Simon Glasscaa4daa2020-12-03 16:55:18 -0700118 * @priv_pdata: device specific plat
Joe Hershberger05c3e682015-03-22 17:09:10 -0500119 */
120struct eth_pdata {
121 phys_addr_t iobase;
oliver@schinagl.nla40db6d2016-11-25 16:30:19 +0100122 unsigned char enetaddr[ARP_HLEN];
Simon Glassc74c8e62015-04-05 16:07:39 -0600123 int phy_interface;
Alexey Brodkinf74264d2016-01-13 16:59:35 +0300124 int max_speed;
Faiz Abbas3c6add92019-03-18 13:54:31 +0530125 void *priv_pdata;
Joe Hershberger05c3e682015-03-22 17:09:10 -0500126};
127
Simon Glassa1ca92e2015-07-06 16:47:49 -0600128enum eth_recv_flags {
129 /*
130 * Check hardware device for new packets (otherwise only return those
131 * which are already in the memory buffer ready to process)
132 */
133 ETH_RECV_CHECK_DEVICE = 1 << 0,
134};
135
Joe Hershberger05c3e682015-03-22 17:09:10 -0500136/**
137 * struct eth_ops - functions of Ethernet MAC controllers
138 *
139 * start: Prepare the hardware to send and receive packets
140 * send: Send the bytes passed in "packet" as a packet on the wire
Joe Hershberger17591402015-03-22 17:09:12 -0500141 * recv: Check if the hardware received a packet. If so, set the pointer to the
142 * packet buffer in the packetp parameter. If not, return an error or 0 to
Joe Hershberger63c97292015-04-03 20:09:46 -0500143 * indicate that the hardware receive FIFO is empty. If 0 is returned, the
144 * network stack will not process the empty packet, but free_pkt() will be
145 * called if supplied
146 * free_pkt: Give the driver an opportunity to manage its packet buffer memory
147 * when the network stack is finished processing it. This will only be
148 * called when no error was returned from recv - optional
Joe Hershberger05c3e682015-03-22 17:09:10 -0500149 * stop: Stop the hardware from looking for packets - may be called even if
150 * state == PASSIVE
151 * mcast: Join or leave a multicast group (for TFTP) - optional
152 * write_hwaddr: Write a MAC address to the hardware (used to pass it to Linux
153 * on some platforms like ARM). This function expects the
Simon Glassb86f7952015-07-06 16:47:55 -0600154 * eth_pdata::enetaddr field to be populated. The method can
155 * return -ENOSYS to indicate that this is not implemented for
156 this hardware - optional.
Joe Hershberger05c3e682015-03-22 17:09:10 -0500157 * read_rom_hwaddr: Some devices have a backup of the MAC address stored in a
158 * ROM on the board. This is how the driver should expose it
159 * to the network stack. This function should fill in the
160 * eth_pdata::enetaddr field - optional
161 */
162struct eth_ops {
163 int (*start)(struct udevice *dev);
164 int (*send)(struct udevice *dev, void *packet, int length);
Simon Glassa1ca92e2015-07-06 16:47:49 -0600165 int (*recv)(struct udevice *dev, int flags, uchar **packetp);
Joe Hershberger63c97292015-04-03 20:09:46 -0500166 int (*free_pkt)(struct udevice *dev, uchar *packet, int length);
Joe Hershberger05c3e682015-03-22 17:09:10 -0500167 void (*stop)(struct udevice *dev);
Joe Hershberger05c3e682015-03-22 17:09:10 -0500168 int (*mcast)(struct udevice *dev, const u8 *enetaddr, int join);
Joe Hershberger05c3e682015-03-22 17:09:10 -0500169 int (*write_hwaddr)(struct udevice *dev);
170 int (*read_rom_hwaddr)(struct udevice *dev);
171};
172
173#define eth_get_ops(dev) ((struct eth_ops *)(dev)->driver->ops)
174
175struct udevice *eth_get_dev(void); /* get the current device */
Joe Hershbergere58780d2015-03-22 17:09:16 -0500176/*
177 * The devname can be either an exact name given by the driver or device tree
178 * or it can be an alias of the form "eth%d"
179 */
180struct udevice *eth_get_dev_by_name(const char *devname);
Joe Hershberger05c3e682015-03-22 17:09:10 -0500181unsigned char *eth_get_ethaddr(void); /* get the current device MAC */
Bernhard Nortmanneaa8a192015-09-14 15:29:43 +0200182
Joe Hershberger05c3e682015-03-22 17:09:10 -0500183/* Used only when NetConsole is enabled */
Bernhard Nortmanneaa8a192015-09-14 15:29:43 +0200184int eth_is_active(struct udevice *dev); /* Test device for active state */
Joe Hershberger05c3e682015-03-22 17:09:10 -0500185int eth_init_state_only(void); /* Set active state */
186void eth_halt_state_only(void); /* Set passive state */
187#endif
188
189#ifndef CONFIG_DM_ETH
wdenk2d966952002-10-31 22:12:35 +0000190struct eth_device {
Pankaj Bansal1666fa52018-08-02 16:31:29 +0530191#define ETH_NAME_LEN 20
oliver@schinagl.nl2c07c322016-11-25 16:30:21 +0100192 char name[ETH_NAME_LEN];
oliver@schinagl.nla40db6d2016-11-25 16:30:19 +0100193 unsigned char enetaddr[ARP_HLEN];
Michal Simek16ae7822015-01-14 16:00:39 +0100194 phys_addr_t iobase;
wdenk2d966952002-10-31 22:12:35 +0000195 int state;
196
Simon Glass90526e92020-05-10 11:39:56 -0600197 int (*init)(struct eth_device *eth, struct bd_info *bd);
Joe Hershbergera34f2072015-04-08 01:41:20 -0500198 int (*send)(struct eth_device *, void *packet, int length);
199 int (*recv)(struct eth_device *);
200 void (*halt)(struct eth_device *);
Chris Packham67bb9842018-11-26 21:00:29 +1300201 int (*mcast)(struct eth_device *, const u8 *enetaddr, int join);
Simon Glass90526e92020-05-10 11:39:56 -0600202 int (*write_hwaddr)(struct eth_device *eth);
wdenk2d966952002-10-31 22:12:35 +0000203 struct eth_device *next;
Michael Wallefea7dca2011-10-27 11:31:35 +0000204 int index;
wdenk2d966952002-10-31 22:12:35 +0000205 void *priv;
206};
207
Joe Hershbergerff997432015-03-22 17:09:02 -0500208int eth_register(struct eth_device *dev);/* Register network device */
209int eth_unregister(struct eth_device *dev);/* Remove network device */
Kim Phillips06370592012-10-29 13:34:33 +0000210
Kim Phillips06370592012-10-29 13:34:33 +0000211extern struct eth_device *eth_current;
212
Fabio Estevam92163872015-11-08 22:25:14 -0200213static __always_inline struct eth_device *eth_get_dev(void)
Joe Hershbergerf8be7d62012-08-03 10:59:08 +0000214{
Joe Hershbergerf8be7d62012-08-03 10:59:08 +0000215 return eth_current;
216}
Joe Hershberger84eb1fb2015-03-22 17:09:03 -0500217struct eth_device *eth_get_dev_by_name(const char *devname);
218struct eth_device *eth_get_dev_by_index(int index); /* get dev @ index */
Joe Hershberger8b2c9a72015-03-22 17:09:00 -0500219
Joe Hershberger84eb1fb2015-03-22 17:09:03 -0500220/* get the current device MAC */
Joe Hershberger8b2c9a72015-03-22 17:09:00 -0500221static inline unsigned char *eth_get_ethaddr(void)
222{
223 if (eth_current)
224 return eth_current->enetaddr;
225 return NULL;
226}
227
Bernhard Nortmanneaa8a192015-09-14 15:29:43 +0200228/* Used only when NetConsole is enabled */
229int eth_is_active(struct eth_device *dev); /* Test device for active state */
Joe Hershbergerf8be7d62012-08-03 10:59:08 +0000230/* Set active state */
Fabio Estevam92163872015-11-08 22:25:14 -0200231static __always_inline int eth_init_state_only(void)
Joe Hershbergerf8be7d62012-08-03 10:59:08 +0000232{
233 eth_get_dev()->state = ETH_STATE_ACTIVE;
234
235 return 0;
236}
237/* Set passive state */
Fabio Estevam92163872015-11-08 22:25:14 -0200238static __always_inline void eth_halt_state_only(void)
Joe Hershbergerf8be7d62012-08-03 10:59:08 +0000239{
240 eth_get_dev()->state = ETH_STATE_PASSIVE;
241}
242
Simon Glass7616e782011-06-13 16:13:10 -0700243/*
244 * Set the hardware address for an ethernet interface based on 'eth%daddr'
245 * environment variable (or just 'ethaddr' if eth_number is 0).
246 * Args:
247 * base_name - base name for device (normally "eth")
248 * eth_number - value of %d (0 for first device of this type)
249 * Returns:
250 * 0 is success, non-zero is error status from driver.
251 */
252int eth_write_hwaddr(struct eth_device *dev, const char *base_name,
253 int eth_number);
254
Simon Glass90526e92020-05-10 11:39:56 -0600255int usb_eth_initialize(struct bd_info *bi);
Joe Hershberger05c3e682015-03-22 17:09:10 -0500256#endif
Joe Hershberger84eb1fb2015-03-22 17:09:03 -0500257
Joe Hershbergerd2eaec62015-03-22 17:09:06 -0500258int eth_initialize(void); /* Initialize network subsystem */
Joe Hershberger84eb1fb2015-03-22 17:09:03 -0500259void eth_try_another(int first_restart); /* Change the device */
260void eth_set_current(void); /* set nterface to ethcur var */
261
262int eth_get_dev_index(void); /* get the device index */
Joe Hershberger84eb1fb2015-03-22 17:09:03 -0500263
Roger Quadros5350bc82016-03-18 13:18:11 +0200264/**
Simon Glassfd1e9592017-08-03 12:22:11 -0600265 * eth_env_set_enetaddr_by_index() - set the MAC address environment variable
Roger Quadros5350bc82016-03-18 13:18:11 +0200266 *
267 * This sets up an environment variable with the given MAC address (@enetaddr).
268 * The environment variable to be set is defined by <@base_name><@index>addr.
269 * If @index is 0 it is omitted. For common Ethernet this means ethaddr,
270 * eth1addr, etc.
271 *
272 * @base_name: Base name for variable, typically "eth"
273 * @index: Index of interface being updated (>=0)
274 * @enetaddr: Pointer to MAC address to put into the variable
275 * @return 0 if OK, other value on error
276 */
Simon Glassfd1e9592017-08-03 12:22:11 -0600277int eth_env_set_enetaddr_by_index(const char *base_name, int index,
Roger Quadros5350bc82016-03-18 13:18:11 +0200278 uchar *enetaddr);
279
280
Joe Hershberger84eb1fb2015-03-22 17:09:03 -0500281/*
Mugunthan V Nd4a37552016-11-18 11:09:15 +0530282 * Initialize USB ethernet device with CONFIG_DM_ETH
283 * Returns:
284 * 0 is success, non-zero is error status.
285 */
286int usb_ether_init(void);
287
288/*
Joe Hershberger84eb1fb2015-03-22 17:09:03 -0500289 * Get the hardware address for an ethernet interface .
290 * Args:
291 * base_name - base name for device (normally "eth")
292 * index - device index number (0 for first)
293 * enetaddr - returns 6 byte hardware address
294 * Returns:
295 * Return true if the address is valid.
296 */
Simon Glass35affd72017-08-03 12:22:14 -0600297int eth_env_get_enetaddr_by_index(const char *base_name, int index,
Joe Hershberger84eb1fb2015-03-22 17:09:03 -0500298 uchar *enetaddr);
299
Joe Hershbergerd2eaec62015-03-22 17:09:06 -0500300int eth_init(void); /* Initialize the device */
Joe Hershberger84eb1fb2015-03-22 17:09:03 -0500301int eth_send(void *packet, int length); /* Send a packet */
302
Alexander Graf0efe1bc2016-05-06 21:01:01 +0200303#if defined(CONFIG_API) || defined(CONFIG_EFI_LOADER)
Joe Hershberger84eb1fb2015-03-22 17:09:03 -0500304int eth_receive(void *packet, int length); /* Receive a packet*/
305extern void (*push_packet)(void *packet, int length);
306#endif
307int eth_rx(void); /* Check for received packets */
308void eth_halt(void); /* stop SCC */
309const char *eth_get_name(void); /* get name of current device */
Joe Hershberger049a95a2015-04-08 01:41:01 -0500310int eth_mcast_join(struct in_addr mcast_addr, int join);
wdenk2d966952002-10-31 22:12:35 +0000311
312/**********************************************************************/
313/*
314 * Protocol headers.
315 */
316
317/*
318 * Ethernet header
319 */
Joe Hershbergercb487f52012-05-23 07:58:06 +0000320
321struct ethernet_hdr {
oliver@schinagl.nla40db6d2016-11-25 16:30:19 +0100322 u8 et_dest[ARP_HLEN]; /* Destination node */
323 u8 et_src[ARP_HLEN]; /* Source node */
324 u16 et_protlen; /* Protocol or length */
Denis Pynkin704f3ac2017-07-21 19:28:42 +0300325} __attribute__((packed));
Joe Hershbergercb487f52012-05-23 07:58:06 +0000326
327/* Ethernet header size */
328#define ETHER_HDR_SIZE (sizeof(struct ethernet_hdr))
329
Bin Menga7c3d5e2015-03-20 17:12:18 +0800330#define ETH_FCS_LEN 4 /* Octets in the FCS */
331
Joe Hershbergercb487f52012-05-23 07:58:06 +0000332struct e802_hdr {
oliver@schinagl.nla40db6d2016-11-25 16:30:19 +0100333 u8 et_dest[ARP_HLEN]; /* Destination node */
334 u8 et_src[ARP_HLEN]; /* Source node */
335 u16 et_protlen; /* Protocol or length */
336 u8 et_dsap; /* 802 DSAP */
337 u8 et_ssap; /* 802 SSAP */
338 u8 et_ctl; /* 802 control */
339 u8 et_snap1; /* SNAP */
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500340 u8 et_snap2;
341 u8 et_snap3;
oliver@schinagl.nla40db6d2016-11-25 16:30:19 +0100342 u16 et_prot; /* 802 protocol */
Denis Pynkin704f3ac2017-07-21 19:28:42 +0300343} __attribute__((packed));
wdenk2d966952002-10-31 22:12:35 +0000344
Joe Hershbergerda5ebe22012-05-23 07:58:11 +0000345/* 802 + SNAP + ethernet header size */
Joe Hershbergercb487f52012-05-23 07:58:06 +0000346#define E802_HDR_SIZE (sizeof(struct e802_hdr))
wdenka3d991b2004-04-15 21:48:45 +0000347
348/*
Joe Hershbergerda5ebe22012-05-23 07:58:11 +0000349 * Virtual LAN Ethernet header
wdenka3d991b2004-04-15 21:48:45 +0000350 */
Joe Hershbergerc68cca32012-05-23 07:58:07 +0000351struct vlan_ethernet_hdr {
oliver@schinagl.nla40db6d2016-11-25 16:30:19 +0100352 u8 vet_dest[ARP_HLEN]; /* Destination node */
353 u8 vet_src[ARP_HLEN]; /* Source node */
354 u16 vet_vlan_type; /* PROT_VLAN */
355 u16 vet_tag; /* TAG of VLAN */
356 u16 vet_type; /* protocol type */
Denis Pynkin704f3ac2017-07-21 19:28:42 +0300357} __attribute__((packed));
wdenka3d991b2004-04-15 21:48:45 +0000358
Joe Hershbergerc68cca32012-05-23 07:58:07 +0000359/* VLAN Ethernet header size */
360#define VLAN_ETHER_HDR_SIZE (sizeof(struct vlan_ethernet_hdr))
wdenka3d991b2004-04-15 21:48:45 +0000361
wdenk2d966952002-10-31 22:12:35 +0000362#define PROT_IP 0x0800 /* IP protocol */
363#define PROT_ARP 0x0806 /* IP ARP protocol */
Lothar Feltend8970da2018-06-22 22:29:54 +0200364#define PROT_WOL 0x0842 /* ether-wake WoL protocol */
wdenk2d966952002-10-31 22:12:35 +0000365#define PROT_RARP 0x8035 /* IP ARP protocol */
wdenka3d991b2004-04-15 21:48:45 +0000366#define PROT_VLAN 0x8100 /* IEEE 802.1q protocol */
Stefan Roese99d4c6d2016-02-10 07:22:10 +0100367#define PROT_IPV6 0x86dd /* IPv6 over bluebook */
368#define PROT_PPP_SES 0x8864 /* PPPoE session messages */
Samuel Mendoza-Jonasf641a8a2019-06-18 11:37:17 +1000369#define PROT_NCSI 0x88f8 /* NC-SI control packets */
wdenk2d966952002-10-31 22:12:35 +0000370
371#define IPPROTO_ICMP 1 /* Internet Control Message Protocol */
372#define IPPROTO_UDP 17 /* User Datagram Protocol */
373
374/*
Joe Hershbergerc5c59df2012-05-23 07:58:05 +0000375 * Internet Protocol (IP) header.
376 */
377struct ip_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 */
Denis Pynkin704f3ac2017-07-21 19:28:42 +0300388} __attribute__((packed));
Joe Hershbergerc5c59df2012-05-23 07:58:05 +0000389
390#define IP_OFFS 0x1fff /* ip offset *= 8 */
391#define IP_FLAGS 0xe000 /* first 3 bits */
392#define IP_FLAGS_RES 0x8000 /* reserved */
393#define IP_FLAGS_DFRAG 0x4000 /* don't fragments */
394#define IP_FLAGS_MFRAG 0x2000 /* more fragments */
395
396#define IP_HDR_SIZE (sizeof(struct ip_hdr))
397
398/*
Joe Hershberger594c26f2012-05-23 07:58:04 +0000399 * Internet Protocol (IP) + UDP header.
wdenk2d966952002-10-31 22:12:35 +0000400 */
Joe Hershberger594c26f2012-05-23 07:58:04 +0000401struct ip_udp_hdr {
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500402 u8 ip_hl_v; /* header length and version */
403 u8 ip_tos; /* type of service */
404 u16 ip_len; /* total length */
405 u16 ip_id; /* identification */
406 u16 ip_off; /* fragment offset field */
407 u8 ip_ttl; /* time to live */
408 u8 ip_p; /* protocol */
409 u16 ip_sum; /* checksum */
Joe Hershberger049a95a2015-04-08 01:41:01 -0500410 struct in_addr ip_src; /* Source IP address */
411 struct in_addr ip_dst; /* Destination IP address */
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500412 u16 udp_src; /* UDP source port */
413 u16 udp_dst; /* UDP destination port */
414 u16 udp_len; /* Length of UDP packet */
415 u16 udp_xsum; /* Checksum */
Denis Pynkin704f3ac2017-07-21 19:28:42 +0300416} __attribute__((packed));
wdenk2d966952002-10-31 22:12:35 +0000417
Joe Hershberger594c26f2012-05-23 07:58:04 +0000418#define IP_UDP_HDR_SIZE (sizeof(struct ip_udp_hdr))
Joe Hershbergerc5c59df2012-05-23 07:58:05 +0000419#define UDP_HDR_SIZE (IP_UDP_HDR_SIZE - IP_HDR_SIZE)
wdenk2d966952002-10-31 22:12:35 +0000420
421/*
422 * Address Resolution Protocol (ARP) header.
423 */
Joe Hershberger738853b2012-05-23 07:58:08 +0000424struct arp_hdr {
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500425 u16 ar_hrd; /* Format of hardware address */
wdenk2d966952002-10-31 22:12:35 +0000426# define ARP_ETHER 1 /* Ethernet hardware address */
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500427 u16 ar_pro; /* Format of protocol address */
428 u8 ar_hln; /* Length of hardware address */
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500429 u8 ar_pln; /* Length of protocol address */
Joe Hershberger674bb242012-05-23 07:58:17 +0000430# define ARP_PLEN 4
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500431 u16 ar_op; /* Operation */
wdenk2d966952002-10-31 22:12:35 +0000432# define ARPOP_REQUEST 1 /* Request to resolve address */
433# define ARPOP_REPLY 2 /* Response to previous request */
434
435# define RARPOP_REQUEST 3 /* Request to resolve address */
436# define RARPOP_REPLY 4 /* Response to previous request */
437
438 /*
wdenk8bde7f72003-06-27 21:31:46 +0000439 * The remaining fields are variable in size, according to
440 * the sizes above, and are defined as appropriate for
441 * specific hardware/protocol combinations.
wdenk2d966952002-10-31 22:12:35 +0000442 */
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500443 u8 ar_data[0];
Joe Hershberger674bb242012-05-23 07:58:17 +0000444#define ar_sha ar_data[0]
445#define ar_spa ar_data[ARP_HLEN]
446#define ar_tha ar_data[ARP_HLEN + ARP_PLEN]
447#define ar_tpa ar_data[ARP_HLEN + ARP_PLEN + ARP_HLEN]
wdenk2d966952002-10-31 22:12:35 +0000448#if 0
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500449 u8 ar_sha[]; /* Sender hardware address */
450 u8 ar_spa[]; /* Sender protocol address */
451 u8 ar_tha[]; /* Target hardware address */
452 u8 ar_tpa[]; /* Target protocol address */
wdenk2d966952002-10-31 22:12:35 +0000453#endif /* 0 */
Denis Pynkin704f3ac2017-07-21 19:28:42 +0300454} __attribute__((packed));
wdenk2d966952002-10-31 22:12:35 +0000455
456#define ARP_HDR_SIZE (8+20) /* Size assuming ethernet */
457
458/*
459 * ICMP stuff (just enough to handle (host) redirect messages)
460 */
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200461#define ICMP_ECHO_REPLY 0 /* Echo reply */
Simon Glass4793ee62011-10-24 18:00:01 +0000462#define ICMP_NOT_REACH 3 /* Detination unreachable */
wdenk2d966952002-10-31 22:12:35 +0000463#define ICMP_REDIRECT 5 /* Redirect (change route) */
wdenk73a8b272003-06-05 19:27:42 +0000464#define ICMP_ECHO_REQUEST 8 /* Echo request */
wdenk2d966952002-10-31 22:12:35 +0000465
466/* Codes for REDIRECT. */
467#define ICMP_REDIR_NET 0 /* Redirect Net */
468#define ICMP_REDIR_HOST 1 /* Redirect Host */
469
Simon Glass4793ee62011-10-24 18:00:01 +0000470/* Codes for NOT_REACH */
471#define ICMP_NOT_REACH_PORT 3 /* Port unreachable */
472
Joe Hershbergere0a63072012-05-23 07:58:09 +0000473struct icmp_hdr {
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500474 u8 type;
475 u8 code;
476 u16 checksum;
wdenk2d966952002-10-31 22:12:35 +0000477 union {
478 struct {
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500479 u16 id;
480 u16 sequence;
wdenk2d966952002-10-31 22:12:35 +0000481 } echo;
Sergey Temerkhanov5917e7d2015-04-08 01:41:22 -0500482 u32 gateway;
wdenk2d966952002-10-31 22:12:35 +0000483 struct {
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500484 u16 unused;
485 u16 mtu;
wdenk2d966952002-10-31 22:12:35 +0000486 } frag;
Sergey Temerkhanov717234e2015-04-08 01:41:23 -0500487 u8 data[0];
wdenk2d966952002-10-31 22:12:35 +0000488 } un;
Denis Pynkin704f3ac2017-07-21 19:28:42 +0300489} __attribute__((packed));
wdenk2d966952002-10-31 22:12:35 +0000490
Joe Hershbergere0a63072012-05-23 07:58:09 +0000491#define ICMP_HDR_SIZE (sizeof(struct icmp_hdr))
492#define IP_ICMP_HDR_SIZE (IP_HDR_SIZE + ICMP_HDR_SIZE)
wdenk2d966952002-10-31 22:12:35 +0000493
wdenk2d966952002-10-31 22:12:35 +0000494/*
Stefan Agner700877a2016-04-13 16:38:02 -0700495 * Maximum packet size; used to allocate packet storage. Use
496 * the maxium Ethernet frame size as specified by the Ethernet
497 * standard including the 802.1Q tag (VLAN tagging).
498 * maximum packet size = 1522
wdenk2d966952002-10-31 22:12:35 +0000499 * maximum packet size and multiple of 32 bytes = 1536
500 */
Stefan Agner700877a2016-04-13 16:38:02 -0700501#define PKTSIZE 1522
wdenk2d966952002-10-31 22:12:35 +0000502#define PKTSIZE_ALIGN 1536
wdenk2d966952002-10-31 22:12:35 +0000503
504/*
505 * Maximum receive ring size; that is, the number of packets
506 * we can buffer before overflow happens. Basically, this just
507 * needs to be enough to prevent a packet being discarded while
508 * we are processing the previous one.
509 */
510#define RINGSZ 4
511#define RINGSZ_LOG2 2
512
513/**********************************************************************/
514/*
515 * Globals.
516 *
517 * Note:
518 *
Joe Hershberger049a95a2015-04-08 01:41:01 -0500519 * All variables of type struct in_addr are stored in NETWORK byte order
wdenk2d966952002-10-31 22:12:35 +0000520 * (big endian).
521 */
522
523/* net.c */
524/** BOOTP EXTENTIONS **/
Joe Hershberger049a95a2015-04-08 01:41:01 -0500525extern struct in_addr net_gateway; /* Our gateway IP address */
526extern struct in_addr net_netmask; /* Our subnet mask (0 = unknown) */
527/* Our Domain Name Server (0 = unknown) */
528extern struct in_addr net_dns_server;
Jon Loeliger1fe80d72007-07-09 22:08:34 -0500529#if defined(CONFIG_BOOTP_DNS2)
Joe Hershberger049a95a2015-04-08 01:41:01 -0500530/* Our 2nd Domain Name Server (0 = unknown) */
531extern struct in_addr net_dns_server2;
stroesefe389a82003-08-28 14:17:32 +0000532#endif
Joe Hershberger586cbe52015-04-08 01:41:03 -0500533extern char net_nis_domain[32]; /* Our IS domain */
534extern char net_hostname[32]; /* Our hostname */
535extern char net_root_path[64]; /* Our root path */
wdenk2d966952002-10-31 22:12:35 +0000536/** END OF BOOTP EXTENTIONS **/
oliver@schinagl.nla40db6d2016-11-25 16:30:19 +0100537extern u8 net_ethaddr[ARP_HLEN]; /* Our ethernet address */
538extern u8 net_server_ethaddr[ARP_HLEN]; /* Boot server enet address */
Joe Hershberger049a95a2015-04-08 01:41:01 -0500539extern struct in_addr net_ip; /* Our IP addr (0 = unknown) */
540extern struct in_addr net_server_ip; /* Server IP addr (0 = unknown) */
Joe Hershberger1203fcc2015-04-08 01:41:05 -0500541extern uchar *net_tx_packet; /* THE transmit packet */
Joe Hershberger2a504df2015-03-22 17:09:11 -0500542extern uchar *net_rx_packets[PKTBUFSRX]; /* Receive packets */
Joe Hershberger1203fcc2015-04-08 01:41:05 -0500543extern uchar *net_rx_packet; /* Current receive packet */
544extern int net_rx_packet_len; /* Current rx packet length */
oliver@schinagl.nla40db6d2016-11-25 16:30:19 +0100545extern const u8 net_bcast_ethaddr[ARP_HLEN]; /* Ethernet broadcast address */
546extern const u8 net_null_ethaddr[ARP_HLEN];
wdenk2d966952002-10-31 22:12:35 +0000547
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000548#define VLAN_NONE 4095 /* untagged */
549#define VLAN_IDMASK 0x0fff /* mask of valid vlan id */
Joe Hershberger4fd50552015-04-08 01:41:17 -0500550extern ushort net_our_vlan; /* Our VLAN */
551extern ushort net_native_vlan; /* Our Native VLAN */
wdenka3d991b2004-04-15 21:48:45 +0000552
Joe Hershbergerbc0571f2015-04-08 01:41:21 -0500553extern int net_restart_wrap; /* Tried all network devices */
wdenk2d966952002-10-31 22:12:35 +0000554
Simon Glasse4bf0c52011-10-24 18:00:02 +0000555enum proto_t {
556 BOOTP, RARP, ARP, TFTPGET, DHCP, PING, DNS, NFS, CDP, NETCONS, SNTP,
Philippe Reynesb43ea1b2020-09-18 14:13:00 +0200557 TFTPSRV, TFTPPUT, LINKLOCAL, FASTBOOT, WOL, UDP
Simon Glasse4bf0c52011-10-24 18:00:02 +0000558};
wdenk2d966952002-10-31 22:12:35 +0000559
Jacob Stiffler11a69ff2015-09-30 10:12:05 -0400560extern char net_boot_file_name[1024];/* Boot File name */
Alexander Graf449312c2018-06-15 10:29:27 +0200561/* Indicates whether the file name was specified on the command line */
562extern bool net_boot_file_name_explicit;
Joe Hershberger14111572015-04-08 01:41:02 -0500563/* The actual transferred size of the bootfile (in bytes) */
564extern u32 net_boot_file_size;
565/* Boot file size in blocks as reported by the DHCP server */
566extern u32 net_boot_file_expected_size_in_blocks;
wdenk2d966952002-10-31 22:12:35 +0000567
Robin Getz1a32bf42009-07-20 14:53:54 -0400568#if defined(CONFIG_CMD_DNS)
Joe Hershberger786eac52015-04-08 01:41:15 -0500569extern char *net_dns_resolve; /* The host to resolve */
570extern char *net_dns_env_var; /* the env var to put the ip into */
Robin Getz1a32bf42009-07-20 14:53:54 -0400571#endif
572
Jon Loeliger639221c2007-07-09 17:15:49 -0500573#if defined(CONFIG_CMD_PING)
Joe Hershberger049a95a2015-04-08 01:41:01 -0500574extern struct in_addr net_ping_ip; /* the ip address to ping */
wdenk73a8b272003-06-05 19:27:42 +0000575#endif
576
Jon Loeliger639221c2007-07-09 17:15:49 -0500577#if defined(CONFIG_CMD_CDP)
wdenka3d991b2004-04-15 21:48:45 +0000578/* when CDP completes these hold the return values */
Joe Hershberger6aede5b2015-04-08 01:41:14 -0500579extern ushort cdp_native_vlan; /* CDP returned native VLAN */
580extern ushort cdp_appliance_vlan; /* CDP returned appliance VLAN */
Joe Hershberger17351882012-05-23 07:58:00 +0000581
582/*
583 * Check for a CDP packet by examining the received MAC address field
584 */
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500585static inline int is_cdp_packet(const uchar *ethaddr)
Joe Hershberger17351882012-05-23 07:58:00 +0000586{
oliver@schinagl.nla40db6d2016-11-25 16:30:19 +0100587 extern const u8 net_cdp_ethaddr[ARP_HLEN];
Joe Hershberger17351882012-05-23 07:58:00 +0000588
oliver@schinagl.nla40db6d2016-11-25 16:30:19 +0100589 return memcmp(ethaddr, net_cdp_ethaddr, ARP_HLEN) == 0;
Joe Hershberger17351882012-05-23 07:58:00 +0000590}
wdenka3d991b2004-04-15 21:48:45 +0000591#endif
592
Jon Loeliger639221c2007-07-09 17:15:49 -0500593#if defined(CONFIG_CMD_SNTP)
Joe Hershberger049a95a2015-04-08 01:41:01 -0500594extern struct in_addr net_ntp_server; /* the ip address to NTP */
Joe Hershbergerbc0571f2015-04-08 01:41:21 -0500595extern int net_ntp_time_offset; /* offset time from UTC */
wdenkea287de2005-04-01 00:25:43 +0000596#endif
597
wdenk2d966952002-10-31 22:12:35 +0000598/* Initialize the network adapter */
Sean Andersonc3f02782020-09-12 17:45:43 -0400599int net_init(void);
Joe Hershbergerbc0571f2015-04-08 01:41:21 -0500600int net_loop(enum proto_t);
wdenk2d966952002-10-31 22:12:35 +0000601
602/* Load failed. Start again. */
Joe Hershbergerbc0571f2015-04-08 01:41:21 -0500603int net_start_again(void);
wdenk2d966952002-10-31 22:12:35 +0000604
wdenka3d991b2004-04-15 21:48:45 +0000605/* Get size of the ethernet header when we send */
Joe Hershberger1203fcc2015-04-08 01:41:05 -0500606int net_eth_hdr_size(void);
wdenka3d991b2004-04-15 21:48:45 +0000607
608/* Set ethernet header; returns the size of the header */
Joe Hershberger1203fcc2015-04-08 01:41:05 -0500609int net_set_ether(uchar *xet, const uchar *dest_ethaddr, uint prot);
Joe Hershbergerff997432015-03-22 17:09:02 -0500610int net_update_ether(struct ethernet_hdr *et, uchar *addr, uint prot);
wdenk2d966952002-10-31 22:12:35 +0000611
612/* Set IP header */
Duncan Hare5d457ec2018-06-24 15:40:41 -0700613void net_set_ip_header(uchar *pkt, struct in_addr dest, struct in_addr source,
614 u16 pkt_len, u8 proto);
Joe Hershberger049a95a2015-04-08 01:41:01 -0500615void net_set_udp_header(uchar *pkt, struct in_addr dest, int dport,
Joe Hershberger4b11c912012-05-23 07:59:07 +0000616 int sport, int len);
wdenk2d966952002-10-31 22:12:35 +0000617
Simon Glass9b0e35c2015-01-19 22:16:07 -0700618/**
619 * compute_ip_checksum() - Compute IP checksum
620 *
621 * @addr: Address to check (must be 16-bit aligned)
622 * @nbytes: Number of bytes to check (normally a multiple of 2)
623 * @return 16-bit IP checksum
624 */
625unsigned compute_ip_checksum(const void *addr, unsigned nbytes);
626
627/**
628 * add_ip_checksums() - add two IP checksums
629 *
630 * @offset: Offset of first sum (if odd we do a byte-swap)
631 * @sum: First checksum
632 * @new_sum: New checksum to add
633 * @return updated 16-bit IP checksum
634 */
635unsigned add_ip_checksums(unsigned offset, unsigned sum, unsigned new_sum);
636
637/**
638 * ip_checksum_ok() - check if a checksum is correct
639 *
640 * This works by making sure the checksum sums to 0
641 *
642 * @addr: Address to check (must be 16-bit aligned)
643 * @nbytes: Number of bytes to check (normally a multiple of 2)
644 * @return true if the checksum matches, false if not
645 */
646int ip_checksum_ok(const void *addr, unsigned nbytes);
647
Joe Hershbergerd280d3f2012-05-23 07:58:01 +0000648/* Callbacks */
Joe Hershbergerff997432015-03-22 17:09:02 -0500649rxhand_f *net_get_udp_handler(void); /* Get UDP RX packet handler */
650void net_set_udp_handler(rxhand_f *); /* Set UDP RX packet handler */
651rxhand_f *net_get_arp_handler(void); /* Get ARP RX packet handler */
652void net_set_arp_handler(rxhand_f *); /* Set ARP RX packet handler */
Joe Hershberger3f02c982018-09-26 16:48:58 -0500653bool arp_is_waiting(void); /* Waiting for ARP reply? */
Joe Hershbergerff997432015-03-22 17:09:02 -0500654void net_set_icmp_handler(rxhand_icmp_f *f); /* Set ICMP RX handler */
Joe Hershbergerbc0571f2015-04-08 01:41:21 -0500655void net_set_timeout_handler(ulong, thand_f *);/* Set timeout handler */
wdenk2d966952002-10-31 22:12:35 +0000656
Joe Hershberger22f6e992012-05-23 07:59:14 +0000657/* Network loop state */
658enum net_loop_state {
659 NETLOOP_CONTINUE,
660 NETLOOP_RESTART,
661 NETLOOP_SUCCESS,
662 NETLOOP_FAIL
663};
Kim Phillips06370592012-10-29 13:34:33 +0000664extern enum net_loop_state net_state;
665
Joe Hershberger22f6e992012-05-23 07:59:14 +0000666static inline void net_set_state(enum net_loop_state state)
667{
Joe Hershberger4ef8d532012-05-23 08:01:04 +0000668 debug_cond(DEBUG_INT_STATE, "--- NetState set to %d\n", state);
Joe Hershberger22f6e992012-05-23 07:59:14 +0000669 net_state = state;
670}
671
Joe Hershbergerac3f26c2018-09-26 16:49:02 -0500672/*
673 * net_get_async_tx_pkt_buf - Get a packet buffer that is not in use for
674 * sending an asynchronous reply
675 *
676 * returns - ptr to packet buffer
677 */
678uchar * net_get_async_tx_pkt_buf(void);
679
Joe Hershbergere94070c2012-05-23 07:59:24 +0000680/* Transmit a packet */
Joe Hershberger1203fcc2015-04-08 01:41:05 -0500681static inline void net_send_packet(uchar *pkt, int len)
Joe Hershbergeradf5d932012-05-23 07:59:13 +0000682{
Joe Hershberger60304592015-03-22 17:09:24 -0500683 /* Currently no way to return errors from eth_send() */
Joe Hershbergeradf5d932012-05-23 07:59:13 +0000684 (void) eth_send(pkt, len);
685}
wdenk2d966952002-10-31 22:12:35 +0000686
Joe Hershberger206d07f2012-05-23 07:58:10 +0000687/*
Joe Hershberger1203fcc2015-04-08 01:41:05 -0500688 * Transmit "net_tx_packet" as UDP packet, performing ARP request if needed
Joe Hershbergerece223b2012-05-23 07:59:15 +0000689 * (ether will be populated)
Joe Hershberger206d07f2012-05-23 07:58:10 +0000690 *
691 * @param ether Raw packet buffer
692 * @param dest IP address to send the datagram to
693 * @param dport Destination UDP port
694 * @param sport Source UDP port
695 * @param payload_len Length of data after the UDP header
696 */
Duncan Hare5d457ec2018-06-24 15:40:41 -0700697int net_send_ip_packet(uchar *ether, struct in_addr dest, int dport, int sport,
698 int payload_len, int proto, u8 action, u32 tcp_seq_num,
699 u32 tcp_ack_num);
Joe Hershberger1203fcc2015-04-08 01:41:05 -0500700int net_send_udp_packet(uchar *ether, struct in_addr dest, int dport,
Joe Hershberger206d07f2012-05-23 07:58:10 +0000701 int sport, int payload_len);
wdenk73a8b272003-06-05 19:27:42 +0000702
wdenk2d966952002-10-31 22:12:35 +0000703/* Processes a received packet */
Joe Hershberger2a504df2015-03-22 17:09:11 -0500704void net_process_received_packet(uchar *in_packet, int len);
wdenk2d966952002-10-31 22:12:35 +0000705
Jason Kridner99761e52018-03-07 05:40:43 -0500706#if defined(CONFIG_NETCONSOLE) && !defined(CONFIG_SPL_BUILD)
Joe Hershberger6a38a5f2015-04-08 01:41:16 -0500707void nc_start(void);
Joe Hershberger049a95a2015-04-08 01:41:01 -0500708int nc_input_packet(uchar *pkt, struct in_addr src_ip, unsigned dest_port,
Joe Hershberger8a0eccb2012-09-18 10:01:32 +0000709 unsigned src_port, unsigned len);
Joe Hershberger48522bb2012-05-15 08:59:08 +0000710#endif
711
Fabio Estevam92163872015-11-08 22:25:14 -0200712static __always_inline int eth_is_on_demand_init(void)
Joe Hershbergerf8be7d62012-08-03 10:59:08 +0000713{
Jason Kridner99761e52018-03-07 05:40:43 -0500714#if defined(CONFIG_NETCONSOLE) && !defined(CONFIG_SPL_BUILD)
Joe Hershbergerf8be7d62012-08-03 10:59:08 +0000715 extern enum proto_t net_loop_last_protocol;
716
717 return net_loop_last_protocol != NETCONS;
718#else
719 return 1;
720#endif
721}
722
723static inline void eth_set_last_protocol(int protocol)
724{
Jason Kridner99761e52018-03-07 05:40:43 -0500725#if defined(CONFIG_NETCONSOLE) && !defined(CONFIG_SPL_BUILD)
Joe Hershbergerf8be7d62012-08-03 10:59:08 +0000726 extern enum proto_t net_loop_last_protocol;
727
728 net_loop_last_protocol = protocol;
729#endif
730}
731
wdenk2d966952002-10-31 22:12:35 +0000732/*
Simon Glasse4a3d572011-10-27 06:24:32 +0000733 * Check if autoload is enabled. If so, use either NFS or TFTP to download
734 * the boot file.
735 */
736void net_auto_load(void);
737
738/*
wdenk2d966952002-10-31 22:12:35 +0000739 * The following functions are a bit ugly, but necessary to deal with
740 * alignment restrictions on ARM.
741 *
742 * We're using inline functions, which had the smallest memory
743 * footprint in our tests.
744 */
745/* return IP *in network byteorder* */
Joe Hershberger049a95a2015-04-08 01:41:01 -0500746static inline struct in_addr net_read_ip(void *from)
wdenk2d966952002-10-31 22:12:35 +0000747{
Joe Hershberger049a95a2015-04-08 01:41:01 -0500748 struct in_addr ip;
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000749
750 memcpy((void *)&ip, (void *)from, sizeof(ip));
wdenk2d966952002-10-31 22:12:35 +0000751 return ip;
752}
753
754/* return ulong *in network byteorder* */
Heinrich Schuchardtbbfc5622019-07-14 22:02:13 +0200755static inline u32 net_read_u32(void *from)
wdenk2d966952002-10-31 22:12:35 +0000756{
Sergey Temerkhanov5917e7d2015-04-08 01:41:22 -0500757 u32 l;
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000758
759 memcpy((void *)&l, (void *)from, sizeof(l));
wdenk2d966952002-10-31 22:12:35 +0000760 return l;
761}
762
763/* write IP *in network byteorder* */
Joe Hershberger049a95a2015-04-08 01:41:01 -0500764static inline void net_write_ip(void *to, struct in_addr ip)
wdenk2d966952002-10-31 22:12:35 +0000765{
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000766 memcpy(to, (void *)&ip, sizeof(ip));
wdenk2d966952002-10-31 22:12:35 +0000767}
768
769/* copy IP */
Joe Hershberger049a95a2015-04-08 01:41:01 -0500770static inline void net_copy_ip(void *to, void *from)
wdenk2d966952002-10-31 22:12:35 +0000771{
Joe Hershberger049a95a2015-04-08 01:41:01 -0500772 memcpy((void *)to, from, sizeof(struct in_addr));
wdenk2d966952002-10-31 22:12:35 +0000773}
774
775/* copy ulong */
Heinrich Schuchardtbbfc5622019-07-14 22:02:13 +0200776static inline void net_copy_u32(void *to, void *from)
wdenk2d966952002-10-31 22:12:35 +0000777{
Sergey Temerkhanov5917e7d2015-04-08 01:41:22 -0500778 memcpy((void *)to, (void *)from, sizeof(u32));
wdenk2d966952002-10-31 22:12:35 +0000779}
780
Mike Rapoport50cca8b2007-08-12 08:48:27 +0300781/**
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500782 * is_zero_ethaddr - Determine if give Ethernet address is all zeros.
Mike Rapoport50cca8b2007-08-12 08:48:27 +0300783 * @addr: Pointer to a six-byte array containing the Ethernet address
784 *
785 * Return true if the address is all zeroes.
786 */
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500787static inline int is_zero_ethaddr(const u8 *addr)
Mike Rapoport50cca8b2007-08-12 08:48:27 +0300788{
789 return !(addr[0] | addr[1] | addr[2] | addr[3] | addr[4] | addr[5]);
790}
791
792/**
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500793 * is_multicast_ethaddr - Determine if the Ethernet address is a multicast.
Mike Rapoport50cca8b2007-08-12 08:48:27 +0300794 * @addr: Pointer to a six-byte array containing the Ethernet address
795 *
796 * Return true if the address is a multicast address.
797 * By definition the broadcast address is also a multicast address.
798 */
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500799static inline int is_multicast_ethaddr(const u8 *addr)
Mike Rapoport50cca8b2007-08-12 08:48:27 +0300800{
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000801 return 0x01 & addr[0];
Mike Rapoport50cca8b2007-08-12 08:48:27 +0300802}
803
Remy Bohmer23cd1382009-07-29 18:18:43 +0200804/*
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500805 * is_broadcast_ethaddr - Determine if the Ethernet address is broadcast
Remy Bohmer23cd1382009-07-29 18:18:43 +0200806 * @addr: Pointer to a six-byte array containing the Ethernet address
807 *
808 * Return true if the address is the broadcast address.
809 */
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500810static inline int is_broadcast_ethaddr(const u8 *addr)
Remy Bohmer23cd1382009-07-29 18:18:43 +0200811{
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000812 return (addr[0] & addr[1] & addr[2] & addr[3] & addr[4] & addr[5]) ==
813 0xff;
Remy Bohmer23cd1382009-07-29 18:18:43 +0200814}
815
816/*
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500817 * is_valid_ethaddr - Determine if the given Ethernet address is valid
Mike Frysinger75edebe2009-01-27 16:53:39 -0500818 * @addr: Pointer to a six-byte array containing the Ethernet address
819 *
820 * Check that the Ethernet address (MAC) is not 00:00:00:00:00:00, is not
821 * a multicast address, and is not FF:FF:FF:FF:FF:FF.
822 *
823 * Return true if the address is valid.
824 */
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500825static inline int is_valid_ethaddr(const u8 *addr)
Mike Frysinger75edebe2009-01-27 16:53:39 -0500826{
827 /* FF:FF:FF:FF:FF:FF is a multicast address so we don't need to
828 * explicitly check for it here. */
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500829 return !is_multicast_ethaddr(addr) && !is_zero_ethaddr(addr);
Mike Frysinger75edebe2009-01-27 16:53:39 -0500830}
831
Masahiro Yamadada384a92014-04-18 19:09:48 +0900832/**
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500833 * net_random_ethaddr - Generate software assigned random Ethernet address
Masahiro Yamadada384a92014-04-18 19:09:48 +0900834 * @addr: Pointer to a six-byte array containing the Ethernet address
835 *
836 * Generate a random Ethernet address (MAC) that is not multicast
837 * and has the local assigned bit set.
838 */
Joe Hershberger0adb5b72015-04-08 01:41:04 -0500839static inline void net_random_ethaddr(uchar *addr)
Masahiro Yamadada384a92014-04-18 19:09:48 +0900840{
841 int i;
Michael Walle12c2a312019-08-27 10:13:52 +0200842 unsigned int seed = get_ticks();
Masahiro Yamadada384a92014-04-18 19:09:48 +0900843
844 for (i = 0; i < 6; i++)
845 addr[i] = rand_r(&seed);
846
847 addr[0] &= 0xfe; /* clear multicast bit */
848 addr[0] |= 0x02; /* set local assignment bit (IEEE802) */
849}
850
Joe Hershbergerfb8977c2019-09-13 19:21:16 -0500851/**
852 * string_to_enetaddr() - Parse a MAC address
853 *
854 * Convert a string MAC address
855 *
856 * Implemented in lib/net_utils.c (built unconditionally)
857 *
858 * @addr: MAC address in aa:bb:cc:dd:ee:ff format, where each part is a 2-digit
859 * hex value
860 * @enetaddr: Place to put MAC address (6 bytes)
861 */
862void string_to_enetaddr(const char *addr, uint8_t *enetaddr);
863
wdenk2d966952002-10-31 22:12:35 +0000864/* Convert an IP address to a string */
Joe Hershberger049a95a2015-04-08 01:41:01 -0500865void ip_to_string(struct in_addr x, char *s);
wdenk2d966952002-10-31 22:12:35 +0000866
Simon Glass8d5babb2019-11-14 12:57:21 -0700867/**
868 * string_to_ip() - Convert a string to ip address
869 *
Joe Hershbergerd7243212019-09-13 19:29:41 -0500870 * Implemented in lib/net_utils.c (built unconditionally)
871 *
872 * @s: Input string to parse
873 * @return: in_addr struct containing the parsed IP address
Simon Glass8d5babb2019-11-14 12:57:21 -0700874 */
Joe Hershberger049a95a2015-04-08 01:41:01 -0500875struct in_addr string_to_ip(const char *s);
wdenk73a8b272003-06-05 19:27:42 +0000876
wdenka3d991b2004-04-15 21:48:45 +0000877/* Convert a VLAN id to a string */
Joe Hershberger4fd50552015-04-08 01:41:17 -0500878void vlan_to_string(ushort x, char *s);
wdenka3d991b2004-04-15 21:48:45 +0000879
880/* Convert a string to a vlan id */
Joe Hershberger4fd50552015-04-08 01:41:17 -0500881ushort string_to_vlan(const char *s);
wdenka3d991b2004-04-15 21:48:45 +0000882
wdenka3d991b2004-04-15 21:48:45 +0000883/* read a VLAN id from an environment variable */
Simon Glass723806c2017-08-03 12:22:15 -0600884ushort env_get_vlan(char *);
wdenka3d991b2004-04-15 21:48:45 +0000885
wdenk2d966952002-10-31 22:12:35 +0000886/* copy a filename (allow for "..." notation, limit length) */
Joe Hershbergerff997432015-03-22 17:09:02 -0500887void copy_filename(char *dst, const char *src, int size);
wdenk2d966952002-10-31 22:12:35 +0000888
Joe Hershberger3a66fcb2018-07-03 19:36:39 -0500889/* check if serverip is specified in filename from the command line */
890int is_serverip_in_cmd(void);
891
Joe Hershberger6ab12832018-07-03 19:36:43 -0500892/**
893 * net_parse_bootfile - Parse the bootfile env var / cmd line param
894 *
895 * @param ipaddr - a pointer to the ipaddr to populate if included in bootfile
896 * @param filename - a pointer to the string to save the filename part
897 * @param max_len - The longest - 1 that the filename part can be
898 *
899 * return 1 if parsed, 0 if bootfile is empty
900 */
901int net_parse_bootfile(struct in_addr *ipaddr, char *filename, int max_len);
902
Lukasz Majewskic7ff5522015-08-24 00:21:47 +0200903/**
904 * update_tftp - Update firmware over TFTP (via DFU)
905 *
906 * This function updates board's firmware via TFTP
907 *
908 * @param addr - memory address where data is stored
909 * @param interface - the DFU medium name - e.g. "mmc"
910 * @param devstring - the DFU medium number - e.g. "1"
911 *
912 * @return - 0 on success, other value on failure
913 */
914int update_tftp(ulong addr, char *interface, char *devstring);
Simon Glassea5427e2013-05-15 06:23:54 +0000915
Simon Glass8d5babb2019-11-14 12:57:21 -0700916/**
917 * env_get_ip() - Convert an environment value to to an ip address
918 *
919 * @var: Environment variable to convert. The value of this variable must be
920 * in the format format a.b.c.d, where each value is a decimal number from
921 * 0 to 255
922 * @return IP address, or 0 if invalid
923 */
924static inline struct in_addr env_get_ip(char *var)
925{
926 return string_to_ip(env_get(var));
927}
Simon Glass5e6267a2019-12-28 10:44:48 -0700928
929/**
930 * reset_phy() - Reset the Ethernet PHY
931 *
932 * This should be implemented by boards if CONFIG_RESET_PHY_R is enabled
933 */
934void reset_phy(void);
935
wdenk2d966952002-10-31 22:12:35 +0000936#endif /* __NET_H__ */