Tom Rini | 70df9d6 | 2018-05-07 17:02:21 -0400 | [diff] [blame] | 1 | /* SPDX-License-Identifier: GPL-2.0 */ |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 2 | /* |
| 3 | * LiMon Monitor (LiMon) - Network. |
| 4 | * |
| 5 | * Copyright 1994 - 2000 Neil Russell. |
| 6 | * (See License) |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 7 | * |
| 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 Glass | 274e0b0 | 2020-05-10 11:39:56 -0600 | [diff] [blame] | 15 | #include <linux/types.h> |
Eric Nelson | 23343a1 | 2012-03-15 18:33:24 +0000 | [diff] [blame] | 16 | #include <asm/cache.h> |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 17 | #include <asm/byteorder.h> /* for nton* / ntoh* stuff */ |
Simon Glass | 5e6201b | 2019-08-01 09:46:51 -0600 | [diff] [blame] | 18 | #include <env.h> |
Simon Glass | 1e26864 | 2020-05-10 11:39:55 -0600 | [diff] [blame] | 19 | #include <log.h> |
| 20 | #include <time.h> |
Bin Meng | 2ccb8b0 | 2018-07-31 02:55:22 -0700 | [diff] [blame] | 21 | #include <linux/if_ether.h> |
Simon Glass | ecd1f81 | 2019-11-14 12:57:13 -0700 | [diff] [blame] | 22 | #include <rand.h> |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 23 | |
Simon Glass | 274e0b0 | 2020-05-10 11:39:56 -0600 | [diff] [blame] | 24 | struct bd_info; |
Simon Glass | ed38aef | 2020-05-10 11:40:03 -0600 | [diff] [blame] | 25 | struct cmd_tbl; |
Simon Glass | 274e0b0 | 2020-05-10 11:39:56 -0600 | [diff] [blame] | 26 | struct udevice; |
Simon Glass | 1e26864 | 2020-05-10 11:39:55 -0600 | [diff] [blame] | 27 | |
Joe Hershberger | 05a377b | 2012-05-23 08:01:04 +0000 | [diff] [blame] | 28 | #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 */ |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 32 | |
| 33 | /* |
| 34 | * The number of receive packet buffers, and the required packet buffer |
| 35 | * alignment in memory. |
| 36 | * |
| 37 | */ |
Tom Rini | f9d5e83 | 2022-03-18 08:38:25 -0400 | [diff] [blame] | 38 | #define PKTBUFSRX CONFIG_SYS_RX_ETH_BUFFER |
Eric Nelson | 23343a1 | 2012-03-15 18:33:24 +0000 | [diff] [blame] | 39 | #define PKTALIGN ARCH_DMA_MINALIGN |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 40 | |
Patrick Wildt | d47430a | 2020-10-07 11:03:30 +0200 | [diff] [blame] | 41 | /* Number of packets processed together */ |
| 42 | #define ETH_PACKETS_BATCH_RECV 32 |
| 43 | |
oliver@schinagl.nl | 496904b | 2016-11-25 16:30:19 +0100 | [diff] [blame] | 44 | /* ARP hardware address length */ |
| 45 | #define ARP_HLEN 6 |
oliver@schinagl.nl | 0522360 | 2016-11-25 16:30:20 +0100 | [diff] [blame] | 46 | /* |
| 47 | * The size of a MAC address in string form, each digit requires two chars |
| 48 | * and five separator characters to form '00:00:00:00:00:00'. |
| 49 | */ |
| 50 | #define ARP_HLEN_ASCII (ARP_HLEN * 2) + (ARP_HLEN - 1) |
oliver@schinagl.nl | 496904b | 2016-11-25 16:30:19 +0100 | [diff] [blame] | 51 | |
Matthias Weisser | 6cc6326 | 2011-12-03 03:29:44 +0000 | [diff] [blame] | 52 | /* IPv4 addresses are always 32 bits in size */ |
Joe Hershberger | 5874dec | 2015-04-08 01:41:01 -0500 | [diff] [blame] | 53 | struct in_addr { |
| 54 | __be32 s_addr; |
| 55 | }; |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 56 | |
Luca Ceresoli | 428ab36 | 2011-04-18 06:19:50 +0000 | [diff] [blame] | 57 | /** |
Simon Glass | 6e51ee1 | 2019-12-28 10:44:43 -0700 | [diff] [blame] | 58 | * do_tftpb - Run the tftpboot command |
| 59 | * |
| 60 | * @cmdtp: Command information for tftpboot |
| 61 | * @flag: Command flags (CMD_FLAG_...) |
| 62 | * @argc: Number of arguments |
| 63 | * @argv: List of arguments |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 64 | * Return: result (see enum command_ret_t) |
Simon Glass | 6e51ee1 | 2019-12-28 10:44:43 -0700 | [diff] [blame] | 65 | */ |
Simon Glass | ed38aef | 2020-05-10 11:40:03 -0600 | [diff] [blame] | 66 | int do_tftpb(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]); |
Simon Glass | 6e51ee1 | 2019-12-28 10:44:43 -0700 | [diff] [blame] | 67 | |
| 68 | /** |
Luca Ceresoli | 428ab36 | 2011-04-18 06:19:50 +0000 | [diff] [blame] | 69 | * An incoming packet handler. |
| 70 | * @param pkt pointer to the application packet |
| 71 | * @param dport destination UDP port |
| 72 | * @param sip source IP address |
| 73 | * @param sport source UDP port |
| 74 | * @param len packet length |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 75 | */ |
Luca Ceresoli | 428ab36 | 2011-04-18 06:19:50 +0000 | [diff] [blame] | 76 | typedef void rxhand_f(uchar *pkt, unsigned dport, |
Joe Hershberger | 5874dec | 2015-04-08 01:41:01 -0500 | [diff] [blame] | 77 | struct in_addr sip, unsigned sport, |
Luca Ceresoli | 428ab36 | 2011-04-18 06:19:50 +0000 | [diff] [blame] | 78 | unsigned len); |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 79 | |
Simon Glass | 230467c | 2011-10-24 18:00:01 +0000 | [diff] [blame] | 80 | /** |
| 81 | * An incoming ICMP packet handler. |
| 82 | * @param type ICMP type |
| 83 | * @param code ICMP code |
| 84 | * @param dport destination UDP port |
| 85 | * @param sip source IP address |
| 86 | * @param sport source UDP port |
| 87 | * @param pkt pointer to the ICMP packet data |
| 88 | * @param len packet length |
| 89 | */ |
| 90 | typedef void rxhand_icmp_f(unsigned type, unsigned code, unsigned dport, |
Joe Hershberger | 5874dec | 2015-04-08 01:41:01 -0500 | [diff] [blame] | 91 | struct in_addr sip, unsigned sport, uchar *pkt, unsigned len); |
Simon Glass | 230467c | 2011-10-24 18:00:01 +0000 | [diff] [blame] | 92 | |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 93 | /* |
| 94 | * A timeout handler. Called after time interval has expired. |
| 95 | */ |
| 96 | typedef void thand_f(void); |
| 97 | |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 98 | enum eth_state_t { |
| 99 | ETH_STATE_INIT, |
| 100 | ETH_STATE_PASSIVE, |
| 101 | ETH_STATE_ACTIVE |
| 102 | }; |
| 103 | |
Joe Hershberger | c7eceaf | 2015-03-22 17:09:10 -0500 | [diff] [blame] | 104 | #ifdef CONFIG_DM_ETH |
| 105 | /** |
| 106 | * struct eth_pdata - Platform data for Ethernet MAC controllers |
| 107 | * |
| 108 | * @iobase: The base address of the hardware registers |
| 109 | * @enetaddr: The Ethernet MAC address that is loaded from EEPROM or env |
Simon Glass | dbad346 | 2015-04-05 16:07:39 -0600 | [diff] [blame] | 110 | * @phy_interface: PHY interface to use - see PHY_INTERFACE_MODE_... |
Alexey Brodkin | 4384ea4 | 2016-01-13 16:59:35 +0300 | [diff] [blame] | 111 | * @max_speed: Maximum speed of Ethernet connection supported by MAC |
Simon Glass | 71fa5b4 | 2020-12-03 16:55:18 -0700 | [diff] [blame] | 112 | * @priv_pdata: device specific plat |
Joe Hershberger | c7eceaf | 2015-03-22 17:09:10 -0500 | [diff] [blame] | 113 | */ |
| 114 | struct eth_pdata { |
| 115 | phys_addr_t iobase; |
oliver@schinagl.nl | 496904b | 2016-11-25 16:30:19 +0100 | [diff] [blame] | 116 | unsigned char enetaddr[ARP_HLEN]; |
Simon Glass | dbad346 | 2015-04-05 16:07:39 -0600 | [diff] [blame] | 117 | int phy_interface; |
Alexey Brodkin | 4384ea4 | 2016-01-13 16:59:35 +0300 | [diff] [blame] | 118 | int max_speed; |
Faiz Abbas | 69dace3 | 2019-03-18 13:54:31 +0530 | [diff] [blame] | 119 | void *priv_pdata; |
Joe Hershberger | c7eceaf | 2015-03-22 17:09:10 -0500 | [diff] [blame] | 120 | }; |
| 121 | |
Simon Glass | dc6eda3 | 2015-07-06 16:47:49 -0600 | [diff] [blame] | 122 | enum eth_recv_flags { |
| 123 | /* |
| 124 | * Check hardware device for new packets (otherwise only return those |
| 125 | * which are already in the memory buffer ready to process) |
| 126 | */ |
| 127 | ETH_RECV_CHECK_DEVICE = 1 << 0, |
| 128 | }; |
| 129 | |
Joe Hershberger | c7eceaf | 2015-03-22 17:09:10 -0500 | [diff] [blame] | 130 | /** |
| 131 | * struct eth_ops - functions of Ethernet MAC controllers |
| 132 | * |
| 133 | * start: Prepare the hardware to send and receive packets |
| 134 | * send: Send the bytes passed in "packet" as a packet on the wire |
Joe Hershberger | 8207c54 | 2015-03-22 17:09:12 -0500 | [diff] [blame] | 135 | * recv: Check if the hardware received a packet. If so, set the pointer to the |
| 136 | * packet buffer in the packetp parameter. If not, return an error or 0 to |
Joe Hershberger | a892dc1 | 2015-04-03 20:09:46 -0500 | [diff] [blame] | 137 | * indicate that the hardware receive FIFO is empty. If 0 is returned, the |
| 138 | * network stack will not process the empty packet, but free_pkt() will be |
| 139 | * called if supplied |
| 140 | * free_pkt: Give the driver an opportunity to manage its packet buffer memory |
| 141 | * when the network stack is finished processing it. This will only be |
| 142 | * called when no error was returned from recv - optional |
Joe Hershberger | c7eceaf | 2015-03-22 17:09:10 -0500 | [diff] [blame] | 143 | * stop: Stop the hardware from looking for packets - may be called even if |
| 144 | * state == PASSIVE |
| 145 | * mcast: Join or leave a multicast group (for TFTP) - optional |
| 146 | * write_hwaddr: Write a MAC address to the hardware (used to pass it to Linux |
| 147 | * on some platforms like ARM). This function expects the |
Simon Glass | c91b2b7 | 2015-07-06 16:47:55 -0600 | [diff] [blame] | 148 | * eth_pdata::enetaddr field to be populated. The method can |
| 149 | * return -ENOSYS to indicate that this is not implemented for |
| 150 | this hardware - optional. |
Joe Hershberger | c7eceaf | 2015-03-22 17:09:10 -0500 | [diff] [blame] | 151 | * read_rom_hwaddr: Some devices have a backup of the MAC address stored in a |
| 152 | * ROM on the board. This is how the driver should expose it |
| 153 | * to the network stack. This function should fill in the |
| 154 | * eth_pdata::enetaddr field - optional |
Tim Harvey | ea6b6bb | 2021-06-30 16:50:05 -0700 | [diff] [blame] | 155 | * set_promisc: Enable or Disable promiscuous mode |
Joe Hershberger | c7eceaf | 2015-03-22 17:09:10 -0500 | [diff] [blame] | 156 | */ |
| 157 | struct eth_ops { |
| 158 | int (*start)(struct udevice *dev); |
| 159 | int (*send)(struct udevice *dev, void *packet, int length); |
Simon Glass | dc6eda3 | 2015-07-06 16:47:49 -0600 | [diff] [blame] | 160 | int (*recv)(struct udevice *dev, int flags, uchar **packetp); |
Joe Hershberger | a892dc1 | 2015-04-03 20:09:46 -0500 | [diff] [blame] | 161 | int (*free_pkt)(struct udevice *dev, uchar *packet, int length); |
Joe Hershberger | c7eceaf | 2015-03-22 17:09:10 -0500 | [diff] [blame] | 162 | void (*stop)(struct udevice *dev); |
Joe Hershberger | c7eceaf | 2015-03-22 17:09:10 -0500 | [diff] [blame] | 163 | int (*mcast)(struct udevice *dev, const u8 *enetaddr, int join); |
Joe Hershberger | c7eceaf | 2015-03-22 17:09:10 -0500 | [diff] [blame] | 164 | int (*write_hwaddr)(struct udevice *dev); |
| 165 | int (*read_rom_hwaddr)(struct udevice *dev); |
Tim Harvey | ea6b6bb | 2021-06-30 16:50:05 -0700 | [diff] [blame] | 166 | int (*set_promisc)(struct udevice *dev, bool enable); |
Joe Hershberger | c7eceaf | 2015-03-22 17:09:10 -0500 | [diff] [blame] | 167 | }; |
| 168 | |
| 169 | #define eth_get_ops(dev) ((struct eth_ops *)(dev)->driver->ops) |
| 170 | |
| 171 | struct udevice *eth_get_dev(void); /* get the current device */ |
Joe Hershberger | 279d2f6 | 2015-03-22 17:09:16 -0500 | [diff] [blame] | 172 | /* |
| 173 | * The devname can be either an exact name given by the driver or device tree |
| 174 | * or it can be an alias of the form "eth%d" |
| 175 | */ |
| 176 | struct udevice *eth_get_dev_by_name(const char *devname); |
Joe Hershberger | c7eceaf | 2015-03-22 17:09:10 -0500 | [diff] [blame] | 177 | unsigned char *eth_get_ethaddr(void); /* get the current device MAC */ |
Bernhard Nortmann | 8de9d12 | 2015-09-14 15:29:43 +0200 | [diff] [blame] | 178 | |
Joe Hershberger | c7eceaf | 2015-03-22 17:09:10 -0500 | [diff] [blame] | 179 | /* Used only when NetConsole is enabled */ |
Bernhard Nortmann | 8de9d12 | 2015-09-14 15:29:43 +0200 | [diff] [blame] | 180 | int eth_is_active(struct udevice *dev); /* Test device for active state */ |
Joe Hershberger | c7eceaf | 2015-03-22 17:09:10 -0500 | [diff] [blame] | 181 | int eth_init_state_only(void); /* Set active state */ |
| 182 | void eth_halt_state_only(void); /* Set passive state */ |
| 183 | #endif |
| 184 | |
| 185 | #ifndef CONFIG_DM_ETH |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 186 | struct eth_device { |
Pankaj Bansal | b08a033 | 2018-08-02 16:31:29 +0530 | [diff] [blame] | 187 | #define ETH_NAME_LEN 20 |
oliver@schinagl.nl | 4493327 | 2016-11-25 16:30:21 +0100 | [diff] [blame] | 188 | char name[ETH_NAME_LEN]; |
oliver@schinagl.nl | 496904b | 2016-11-25 16:30:19 +0100 | [diff] [blame] | 189 | unsigned char enetaddr[ARP_HLEN]; |
Michal Simek | 66106f9 | 2015-01-14 16:00:39 +0100 | [diff] [blame] | 190 | phys_addr_t iobase; |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 191 | int state; |
| 192 | |
Simon Glass | 274e0b0 | 2020-05-10 11:39:56 -0600 | [diff] [blame] | 193 | int (*init)(struct eth_device *eth, struct bd_info *bd); |
Joe Hershberger | 7581157 | 2015-04-08 01:41:20 -0500 | [diff] [blame] | 194 | int (*send)(struct eth_device *, void *packet, int length); |
| 195 | int (*recv)(struct eth_device *); |
| 196 | void (*halt)(struct eth_device *); |
Chris Packham | a55ef7f | 2018-11-26 21:00:29 +1300 | [diff] [blame] | 197 | int (*mcast)(struct eth_device *, const u8 *enetaddr, int join); |
Simon Glass | 274e0b0 | 2020-05-10 11:39:56 -0600 | [diff] [blame] | 198 | int (*write_hwaddr)(struct eth_device *eth); |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 199 | struct eth_device *next; |
Michael Walle | 391da4c | 2011-10-27 11:31:35 +0000 | [diff] [blame] | 200 | int index; |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 201 | void *priv; |
| 202 | }; |
| 203 | |
Joe Hershberger | b79dda3 | 2015-03-22 17:09:02 -0500 | [diff] [blame] | 204 | int eth_register(struct eth_device *dev);/* Register network device */ |
| 205 | int eth_unregister(struct eth_device *dev);/* Remove network device */ |
Kim Phillips | 40c2c03 | 2012-10-29 13:34:33 +0000 | [diff] [blame] | 206 | |
Kim Phillips | 40c2c03 | 2012-10-29 13:34:33 +0000 | [diff] [blame] | 207 | extern struct eth_device *eth_current; |
| 208 | |
Fabio Estevam | cff6536 | 2015-11-08 22:25:14 -0200 | [diff] [blame] | 209 | static __always_inline struct eth_device *eth_get_dev(void) |
Joe Hershberger | 9f37406 | 2012-08-03 10:59:08 +0000 | [diff] [blame] | 210 | { |
Joe Hershberger | 9f37406 | 2012-08-03 10:59:08 +0000 | [diff] [blame] | 211 | return eth_current; |
| 212 | } |
Joe Hershberger | e1e8a8c | 2015-03-22 17:09:03 -0500 | [diff] [blame] | 213 | struct eth_device *eth_get_dev_by_name(const char *devname); |
| 214 | struct eth_device *eth_get_dev_by_index(int index); /* get dev @ index */ |
Joe Hershberger | 11cd5a0 | 2015-03-22 17:09:00 -0500 | [diff] [blame] | 215 | |
Joe Hershberger | e1e8a8c | 2015-03-22 17:09:03 -0500 | [diff] [blame] | 216 | /* get the current device MAC */ |
Joe Hershberger | 11cd5a0 | 2015-03-22 17:09:00 -0500 | [diff] [blame] | 217 | static inline unsigned char *eth_get_ethaddr(void) |
| 218 | { |
| 219 | if (eth_current) |
| 220 | return eth_current->enetaddr; |
| 221 | return NULL; |
| 222 | } |
| 223 | |
Bernhard Nortmann | 8de9d12 | 2015-09-14 15:29:43 +0200 | [diff] [blame] | 224 | /* Used only when NetConsole is enabled */ |
| 225 | int eth_is_active(struct eth_device *dev); /* Test device for active state */ |
Joe Hershberger | e1e8a8c | 2015-03-22 17:09:03 -0500 | [diff] [blame] | 226 | /* Set active state */ |
Fabio Estevam | cff6536 | 2015-11-08 22:25:14 -0200 | [diff] [blame] | 227 | static __always_inline int eth_init_state_only(void) |
Joe Hershberger | e1e8a8c | 2015-03-22 17:09:03 -0500 | [diff] [blame] | 228 | { |
| 229 | eth_get_dev()->state = ETH_STATE_ACTIVE; |
| 230 | |
| 231 | return 0; |
| 232 | } |
| 233 | /* Set passive state */ |
Fabio Estevam | cff6536 | 2015-11-08 22:25:14 -0200 | [diff] [blame] | 234 | static __always_inline void eth_halt_state_only(void) |
Joe Hershberger | e1e8a8c | 2015-03-22 17:09:03 -0500 | [diff] [blame] | 235 | { |
| 236 | eth_get_dev()->state = ETH_STATE_PASSIVE; |
| 237 | } |
| 238 | |
| 239 | /* |
| 240 | * Set the hardware address for an ethernet interface based on 'eth%daddr' |
| 241 | * environment variable (or just 'ethaddr' if eth_number is 0). |
| 242 | * Args: |
| 243 | * base_name - base name for device (normally "eth") |
| 244 | * eth_number - value of %d (0 for first device of this type) |
| 245 | * Returns: |
| 246 | * 0 is success, non-zero is error status from driver. |
| 247 | */ |
| 248 | int eth_write_hwaddr(struct eth_device *dev, const char *base_name, |
| 249 | int eth_number); |
| 250 | |
Simon Glass | 274e0b0 | 2020-05-10 11:39:56 -0600 | [diff] [blame] | 251 | int usb_eth_initialize(struct bd_info *bi); |
Joe Hershberger | c7eceaf | 2015-03-22 17:09:10 -0500 | [diff] [blame] | 252 | #endif |
Joe Hershberger | e1e8a8c | 2015-03-22 17:09:03 -0500 | [diff] [blame] | 253 | |
Joe Hershberger | 3dbe17e | 2015-03-22 17:09:06 -0500 | [diff] [blame] | 254 | int eth_initialize(void); /* Initialize network subsystem */ |
Joe Hershberger | e1e8a8c | 2015-03-22 17:09:03 -0500 | [diff] [blame] | 255 | void eth_try_another(int first_restart); /* Change the device */ |
| 256 | void eth_set_current(void); /* set nterface to ethcur var */ |
| 257 | |
Joe Hershberger | b79dda3 | 2015-03-22 17:09:02 -0500 | [diff] [blame] | 258 | int eth_get_dev_index(void); /* get the device index */ |
Simon Glass | 62b36c9 | 2011-06-13 16:13:10 -0700 | [diff] [blame] | 259 | |
Roger Quadros | 1e9df6b | 2016-03-18 13:18:11 +0200 | [diff] [blame] | 260 | /** |
Simon Glass | 8551d55 | 2017-08-03 12:22:11 -0600 | [diff] [blame] | 261 | * eth_env_set_enetaddr_by_index() - set the MAC address environment variable |
Roger Quadros | 1e9df6b | 2016-03-18 13:18:11 +0200 | [diff] [blame] | 262 | * |
| 263 | * This sets up an environment variable with the given MAC address (@enetaddr). |
| 264 | * The environment variable to be set is defined by <@base_name><@index>addr. |
| 265 | * If @index is 0 it is omitted. For common Ethernet this means ethaddr, |
| 266 | * eth1addr, etc. |
| 267 | * |
| 268 | * @base_name: Base name for variable, typically "eth" |
| 269 | * @index: Index of interface being updated (>=0) |
| 270 | * @enetaddr: Pointer to MAC address to put into the variable |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 271 | * Return: 0 if OK, other value on error |
Roger Quadros | 1e9df6b | 2016-03-18 13:18:11 +0200 | [diff] [blame] | 272 | */ |
Simon Glass | 8551d55 | 2017-08-03 12:22:11 -0600 | [diff] [blame] | 273 | int eth_env_set_enetaddr_by_index(const char *base_name, int index, |
Roger Quadros | 1e9df6b | 2016-03-18 13:18:11 +0200 | [diff] [blame] | 274 | uchar *enetaddr); |
| 275 | |
| 276 | |
Simon Glass | 62b36c9 | 2011-06-13 16:13:10 -0700 | [diff] [blame] | 277 | /* |
Mugunthan V N | 095b761 | 2016-11-18 11:09:15 +0530 | [diff] [blame] | 278 | * Initialize USB ethernet device with CONFIG_DM_ETH |
| 279 | * Returns: |
| 280 | * 0 is success, non-zero is error status. |
| 281 | */ |
| 282 | int usb_ether_init(void); |
| 283 | |
| 284 | /* |
Simon Glass | 62b36c9 | 2011-06-13 16:13:10 -0700 | [diff] [blame] | 285 | * Get the hardware address for an ethernet interface . |
| 286 | * Args: |
| 287 | * base_name - base name for device (normally "eth") |
| 288 | * index - device index number (0 for first) |
| 289 | * enetaddr - returns 6 byte hardware address |
| 290 | * Returns: |
| 291 | * Return true if the address is valid. |
| 292 | */ |
Simon Glass | 399a9ce | 2017-08-03 12:22:14 -0600 | [diff] [blame] | 293 | int eth_env_get_enetaddr_by_index(const char *base_name, int index, |
Joe Hershberger | b79dda3 | 2015-03-22 17:09:02 -0500 | [diff] [blame] | 294 | uchar *enetaddr); |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 295 | |
Joe Hershberger | 3dbe17e | 2015-03-22 17:09:06 -0500 | [diff] [blame] | 296 | int eth_init(void); /* Initialize the device */ |
Joe Hershberger | b79dda3 | 2015-03-22 17:09:02 -0500 | [diff] [blame] | 297 | int eth_send(void *packet, int length); /* Send a packet */ |
Remy Bohmer | df06344 | 2009-07-29 18:18:43 +0200 | [diff] [blame] | 298 | |
Alexander Graf | 94c4b99 | 2016-05-06 21:01:01 +0200 | [diff] [blame] | 299 | #if defined(CONFIG_API) || defined(CONFIG_EFI_LOADER) |
Joe Hershberger | b79dda3 | 2015-03-22 17:09:02 -0500 | [diff] [blame] | 300 | int eth_receive(void *packet, int length); /* Receive a packet*/ |
Joe Hershberger | 4b7747e | 2012-05-15 08:59:04 +0000 | [diff] [blame] | 301 | extern void (*push_packet)(void *packet, int length); |
Rafal Jaworowski | 1f2c9a4 | 2007-12-27 18:19:02 +0100 | [diff] [blame] | 302 | #endif |
Joe Hershberger | b79dda3 | 2015-03-22 17:09:02 -0500 | [diff] [blame] | 303 | int eth_rx(void); /* Check for received packets */ |
| 304 | void eth_halt(void); /* stop SCC */ |
Joe Hershberger | e1e8a8c | 2015-03-22 17:09:03 -0500 | [diff] [blame] | 305 | const char *eth_get_name(void); /* get name of current device */ |
Joe Hershberger | 5874dec | 2015-04-08 01:41:01 -0500 | [diff] [blame] | 306 | int eth_mcast_join(struct in_addr mcast_addr, int join); |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 307 | |
| 308 | /**********************************************************************/ |
| 309 | /* |
| 310 | * Protocol headers. |
| 311 | */ |
| 312 | |
| 313 | /* |
| 314 | * Ethernet header |
| 315 | */ |
Joe Hershberger | 1178f41 | 2012-05-23 07:58:06 +0000 | [diff] [blame] | 316 | |
| 317 | struct ethernet_hdr { |
oliver@schinagl.nl | 496904b | 2016-11-25 16:30:19 +0100 | [diff] [blame] | 318 | u8 et_dest[ARP_HLEN]; /* Destination node */ |
| 319 | u8 et_src[ARP_HLEN]; /* Source node */ |
| 320 | u16 et_protlen; /* Protocol or length */ |
Denis Pynkin | 4c7a6e0 | 2017-07-21 19:28:42 +0300 | [diff] [blame] | 321 | } __attribute__((packed)); |
Joe Hershberger | 1178f41 | 2012-05-23 07:58:06 +0000 | [diff] [blame] | 322 | |
| 323 | /* Ethernet header size */ |
| 324 | #define ETHER_HDR_SIZE (sizeof(struct ethernet_hdr)) |
| 325 | |
Bin Meng | b1a5e1f | 2015-03-20 17:12:18 +0800 | [diff] [blame] | 326 | #define ETH_FCS_LEN 4 /* Octets in the FCS */ |
| 327 | |
Joe Hershberger | 1178f41 | 2012-05-23 07:58:06 +0000 | [diff] [blame] | 328 | struct e802_hdr { |
oliver@schinagl.nl | 496904b | 2016-11-25 16:30:19 +0100 | [diff] [blame] | 329 | u8 et_dest[ARP_HLEN]; /* Destination node */ |
| 330 | u8 et_src[ARP_HLEN]; /* Source node */ |
| 331 | u16 et_protlen; /* Protocol or length */ |
| 332 | u8 et_dsap; /* 802 DSAP */ |
| 333 | u8 et_ssap; /* 802 SSAP */ |
| 334 | u8 et_ctl; /* 802 control */ |
| 335 | u8 et_snap1; /* SNAP */ |
Sergey Temerkhanov | 4c00eeb | 2015-04-08 01:41:23 -0500 | [diff] [blame] | 336 | u8 et_snap2; |
| 337 | u8 et_snap3; |
oliver@schinagl.nl | 496904b | 2016-11-25 16:30:19 +0100 | [diff] [blame] | 338 | u16 et_prot; /* 802 protocol */ |
Denis Pynkin | 4c7a6e0 | 2017-07-21 19:28:42 +0300 | [diff] [blame] | 339 | } __attribute__((packed)); |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 340 | |
Joe Hershberger | c17fa98 | 2012-05-23 07:58:11 +0000 | [diff] [blame] | 341 | /* 802 + SNAP + ethernet header size */ |
Joe Hershberger | 1178f41 | 2012-05-23 07:58:06 +0000 | [diff] [blame] | 342 | #define E802_HDR_SIZE (sizeof(struct e802_hdr)) |
wdenk | 145d2c1 | 2004-04-15 21:48:45 +0000 | [diff] [blame] | 343 | |
| 344 | /* |
Joe Hershberger | c17fa98 | 2012-05-23 07:58:11 +0000 | [diff] [blame] | 345 | * Virtual LAN Ethernet header |
wdenk | 145d2c1 | 2004-04-15 21:48:45 +0000 | [diff] [blame] | 346 | */ |
Joe Hershberger | b43784c | 2012-05-23 07:58:07 +0000 | [diff] [blame] | 347 | struct vlan_ethernet_hdr { |
oliver@schinagl.nl | 496904b | 2016-11-25 16:30:19 +0100 | [diff] [blame] | 348 | u8 vet_dest[ARP_HLEN]; /* Destination node */ |
| 349 | u8 vet_src[ARP_HLEN]; /* Source node */ |
| 350 | u16 vet_vlan_type; /* PROT_VLAN */ |
| 351 | u16 vet_tag; /* TAG of VLAN */ |
| 352 | u16 vet_type; /* protocol type */ |
Denis Pynkin | 4c7a6e0 | 2017-07-21 19:28:42 +0300 | [diff] [blame] | 353 | } __attribute__((packed)); |
wdenk | 145d2c1 | 2004-04-15 21:48:45 +0000 | [diff] [blame] | 354 | |
Joe Hershberger | b43784c | 2012-05-23 07:58:07 +0000 | [diff] [blame] | 355 | /* VLAN Ethernet header size */ |
| 356 | #define VLAN_ETHER_HDR_SIZE (sizeof(struct vlan_ethernet_hdr)) |
wdenk | 145d2c1 | 2004-04-15 21:48:45 +0000 | [diff] [blame] | 357 | |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 358 | #define PROT_IP 0x0800 /* IP protocol */ |
| 359 | #define PROT_ARP 0x0806 /* IP ARP protocol */ |
Lothar Felten | 776fc10 | 2018-06-22 22:29:54 +0200 | [diff] [blame] | 360 | #define PROT_WOL 0x0842 /* ether-wake WoL protocol */ |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 361 | #define PROT_RARP 0x8035 /* IP ARP protocol */ |
wdenk | 145d2c1 | 2004-04-15 21:48:45 +0000 | [diff] [blame] | 362 | #define PROT_VLAN 0x8100 /* IEEE 802.1q protocol */ |
Stefan Roese | 96c1904 | 2016-02-10 07:22:10 +0100 | [diff] [blame] | 363 | #define PROT_IPV6 0x86dd /* IPv6 over bluebook */ |
| 364 | #define PROT_PPP_SES 0x8864 /* PPPoE session messages */ |
Samuel Mendoza-Jonas | 2325c44 | 2019-06-18 11:37:17 +1000 | [diff] [blame] | 365 | #define PROT_NCSI 0x88f8 /* NC-SI control packets */ |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 366 | |
| 367 | #define IPPROTO_ICMP 1 /* Internet Control Message Protocol */ |
Ying-Chun Liu (PaulLiu) | 41efed1 | 2022-11-08 14:17:28 +0800 | [diff] [blame] | 368 | #define IPPROTO_TCP 6 /* Transmission Control Protocol */ |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 369 | #define IPPROTO_UDP 17 /* User Datagram Protocol */ |
| 370 | |
| 371 | /* |
Joe Hershberger | c686fa1 | 2012-05-23 07:58:05 +0000 | [diff] [blame] | 372 | * Internet Protocol (IP) header. |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 373 | */ |
Joe Hershberger | c686fa1 | 2012-05-23 07:58:05 +0000 | [diff] [blame] | 374 | struct ip_hdr { |
Sergey Temerkhanov | 4c00eeb | 2015-04-08 01:41:23 -0500 | [diff] [blame] | 375 | 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 Hershberger | 5874dec | 2015-04-08 01:41:01 -0500 | [diff] [blame] | 383 | struct in_addr ip_src; /* Source IP address */ |
| 384 | struct in_addr ip_dst; /* Destination IP address */ |
Denis Pynkin | 4c7a6e0 | 2017-07-21 19:28:42 +0300 | [diff] [blame] | 385 | } __attribute__((packed)); |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 386 | |
Peter Tyser | 0885bf0 | 2008-12-01 16:26:20 -0600 | [diff] [blame] | 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 | |
Joe Hershberger | c686fa1 | 2012-05-23 07:58:05 +0000 | [diff] [blame] | 393 | #define IP_HDR_SIZE (sizeof(struct ip_hdr)) |
| 394 | |
Fabio Estevam | a0aaa32 | 2022-05-26 11:14:37 -0300 | [diff] [blame] | 395 | #define IP_MIN_FRAG_DATAGRAM_SIZE (IP_HDR_SIZE + 8) |
| 396 | |
Joe Hershberger | c686fa1 | 2012-05-23 07:58:05 +0000 | [diff] [blame] | 397 | /* |
| 398 | * Internet Protocol (IP) + UDP header. |
| 399 | */ |
| 400 | struct ip_udp_hdr { |
Sergey Temerkhanov | 4c00eeb | 2015-04-08 01:41:23 -0500 | [diff] [blame] | 401 | u8 ip_hl_v; /* header length and version */ |
| 402 | u8 ip_tos; /* type of service */ |
| 403 | u16 ip_len; /* total length */ |
| 404 | u16 ip_id; /* identification */ |
| 405 | u16 ip_off; /* fragment offset field */ |
| 406 | u8 ip_ttl; /* time to live */ |
| 407 | u8 ip_p; /* protocol */ |
| 408 | u16 ip_sum; /* checksum */ |
Joe Hershberger | 5874dec | 2015-04-08 01:41:01 -0500 | [diff] [blame] | 409 | struct in_addr ip_src; /* Source IP address */ |
| 410 | struct in_addr ip_dst; /* Destination IP address */ |
Sergey Temerkhanov | 4c00eeb | 2015-04-08 01:41:23 -0500 | [diff] [blame] | 411 | u16 udp_src; /* UDP source port */ |
| 412 | u16 udp_dst; /* UDP destination port */ |
| 413 | u16 udp_len; /* Length of UDP packet */ |
| 414 | u16 udp_xsum; /* Checksum */ |
Denis Pynkin | 4c7a6e0 | 2017-07-21 19:28:42 +0300 | [diff] [blame] | 415 | } __attribute__((packed)); |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 416 | |
Joe Hershberger | 6fe8b45 | 2012-05-23 07:58:04 +0000 | [diff] [blame] | 417 | #define IP_UDP_HDR_SIZE (sizeof(struct ip_udp_hdr)) |
Joe Hershberger | c686fa1 | 2012-05-23 07:58:05 +0000 | [diff] [blame] | 418 | #define UDP_HDR_SIZE (IP_UDP_HDR_SIZE - IP_HDR_SIZE) |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 419 | |
| 420 | /* |
| 421 | * Address Resolution Protocol (ARP) header. |
| 422 | */ |
Joe Hershberger | de15d093 | 2012-05-23 07:58:08 +0000 | [diff] [blame] | 423 | struct arp_hdr { |
Sergey Temerkhanov | 4c00eeb | 2015-04-08 01:41:23 -0500 | [diff] [blame] | 424 | u16 ar_hrd; /* Format of hardware address */ |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 425 | # define ARP_ETHER 1 /* Ethernet hardware address */ |
Sergey Temerkhanov | 4c00eeb | 2015-04-08 01:41:23 -0500 | [diff] [blame] | 426 | u16 ar_pro; /* Format of protocol address */ |
| 427 | u8 ar_hln; /* Length of hardware address */ |
Sergey Temerkhanov | 4c00eeb | 2015-04-08 01:41:23 -0500 | [diff] [blame] | 428 | u8 ar_pln; /* Length of protocol address */ |
Joe Hershberger | 2f78749 | 2012-05-23 07:58:17 +0000 | [diff] [blame] | 429 | # define ARP_PLEN 4 |
Sergey Temerkhanov | 4c00eeb | 2015-04-08 01:41:23 -0500 | [diff] [blame] | 430 | u16 ar_op; /* Operation */ |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 431 | # define ARPOP_REQUEST 1 /* Request to resolve address */ |
| 432 | # define ARPOP_REPLY 2 /* Response to previous request */ |
| 433 | |
| 434 | # define RARPOP_REQUEST 3 /* Request to resolve address */ |
| 435 | # define RARPOP_REPLY 4 /* Response to previous request */ |
| 436 | |
| 437 | /* |
wdenk | 57b2d80 | 2003-06-27 21:31:46 +0000 | [diff] [blame] | 438 | * The remaining fields are variable in size, according to |
| 439 | * the sizes above, and are defined as appropriate for |
| 440 | * specific hardware/protocol combinations. |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 441 | */ |
Sergey Temerkhanov | 4c00eeb | 2015-04-08 01:41:23 -0500 | [diff] [blame] | 442 | u8 ar_data[0]; |
Joe Hershberger | 2f78749 | 2012-05-23 07:58:17 +0000 | [diff] [blame] | 443 | #define ar_sha ar_data[0] |
| 444 | #define ar_spa ar_data[ARP_HLEN] |
| 445 | #define ar_tha ar_data[ARP_HLEN + ARP_PLEN] |
| 446 | #define ar_tpa ar_data[ARP_HLEN + ARP_PLEN + ARP_HLEN] |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 447 | #if 0 |
Sergey Temerkhanov | 4c00eeb | 2015-04-08 01:41:23 -0500 | [diff] [blame] | 448 | u8 ar_sha[]; /* Sender hardware address */ |
| 449 | u8 ar_spa[]; /* Sender protocol address */ |
| 450 | u8 ar_tha[]; /* Target hardware address */ |
| 451 | u8 ar_tpa[]; /* Target protocol address */ |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 452 | #endif /* 0 */ |
Denis Pynkin | 4c7a6e0 | 2017-07-21 19:28:42 +0300 | [diff] [blame] | 453 | } __attribute__((packed)); |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 454 | |
| 455 | #define ARP_HDR_SIZE (8+20) /* Size assuming ethernet */ |
| 456 | |
| 457 | /* |
| 458 | * ICMP stuff (just enough to handle (host) redirect messages) |
| 459 | */ |
Wolfgang Denk | a1be476 | 2008-05-20 16:00:29 +0200 | [diff] [blame] | 460 | #define ICMP_ECHO_REPLY 0 /* Echo reply */ |
Simon Glass | 230467c | 2011-10-24 18:00:01 +0000 | [diff] [blame] | 461 | #define ICMP_NOT_REACH 3 /* Detination unreachable */ |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 462 | #define ICMP_REDIRECT 5 /* Redirect (change route) */ |
wdenk | e6466f6 | 2003-06-05 19:27:42 +0000 | [diff] [blame] | 463 | #define ICMP_ECHO_REQUEST 8 /* Echo request */ |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 464 | |
| 465 | /* Codes for REDIRECT. */ |
| 466 | #define ICMP_REDIR_NET 0 /* Redirect Net */ |
| 467 | #define ICMP_REDIR_HOST 1 /* Redirect Host */ |
| 468 | |
Simon Glass | 230467c | 2011-10-24 18:00:01 +0000 | [diff] [blame] | 469 | /* Codes for NOT_REACH */ |
| 470 | #define ICMP_NOT_REACH_PORT 3 /* Port unreachable */ |
| 471 | |
Joe Hershberger | 7849561 | 2012-05-23 07:58:09 +0000 | [diff] [blame] | 472 | struct icmp_hdr { |
Sergey Temerkhanov | 4c00eeb | 2015-04-08 01:41:23 -0500 | [diff] [blame] | 473 | u8 type; |
| 474 | u8 code; |
| 475 | u16 checksum; |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 476 | union { |
| 477 | struct { |
Sergey Temerkhanov | 4c00eeb | 2015-04-08 01:41:23 -0500 | [diff] [blame] | 478 | u16 id; |
| 479 | u16 sequence; |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 480 | } echo; |
Sergey Temerkhanov | bf5ad64 | 2015-04-08 01:41:22 -0500 | [diff] [blame] | 481 | u32 gateway; |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 482 | struct { |
Sergey Temerkhanov | 4c00eeb | 2015-04-08 01:41:23 -0500 | [diff] [blame] | 483 | u16 unused; |
| 484 | u16 mtu; |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 485 | } frag; |
Sergey Temerkhanov | 4c00eeb | 2015-04-08 01:41:23 -0500 | [diff] [blame] | 486 | u8 data[0]; |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 487 | } un; |
Denis Pynkin | 4c7a6e0 | 2017-07-21 19:28:42 +0300 | [diff] [blame] | 488 | } __attribute__((packed)); |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 489 | |
Joe Hershberger | 7849561 | 2012-05-23 07:58:09 +0000 | [diff] [blame] | 490 | #define ICMP_HDR_SIZE (sizeof(struct icmp_hdr)) |
| 491 | #define IP_ICMP_HDR_SIZE (IP_HDR_SIZE + ICMP_HDR_SIZE) |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 492 | |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 493 | /* |
Stefan Agner | d93400a | 2016-04-13 16:38:02 -0700 | [diff] [blame] | 494 | * Maximum packet size; used to allocate packet storage. Use |
| 495 | * the maxium Ethernet frame size as specified by the Ethernet |
| 496 | * standard including the 802.1Q tag (VLAN tagging). |
| 497 | * maximum packet size = 1522 |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 498 | * maximum packet size and multiple of 32 bytes = 1536 |
| 499 | */ |
Stefan Agner | d93400a | 2016-04-13 16:38:02 -0700 | [diff] [blame] | 500 | #define PKTSIZE 1522 |
Claudiu Manoil | c0566c2 | 2021-01-25 14:23:53 +0200 | [diff] [blame] | 501 | #ifndef CONFIG_DM_DSA |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 502 | #define PKTSIZE_ALIGN 1536 |
Claudiu Manoil | c0566c2 | 2021-01-25 14:23:53 +0200 | [diff] [blame] | 503 | #else |
| 504 | /* Maximum DSA tagging overhead (headroom and/or tailroom) */ |
| 505 | #define DSA_MAX_OVR 256 |
| 506 | #define PKTSIZE_ALIGN (1536 + DSA_MAX_OVR) |
| 507 | #endif |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 508 | |
| 509 | /* |
| 510 | * Maximum receive ring size; that is, the number of packets |
| 511 | * we can buffer before overflow happens. Basically, this just |
| 512 | * needs to be enough to prevent a packet being discarded while |
| 513 | * we are processing the previous one. |
| 514 | */ |
| 515 | #define RINGSZ 4 |
| 516 | #define RINGSZ_LOG2 2 |
| 517 | |
| 518 | /**********************************************************************/ |
| 519 | /* |
| 520 | * Globals. |
| 521 | * |
| 522 | * Note: |
| 523 | * |
Joe Hershberger | 5874dec | 2015-04-08 01:41:01 -0500 | [diff] [blame] | 524 | * All variables of type struct in_addr are stored in NETWORK byte order |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 525 | * (big endian). |
| 526 | */ |
| 527 | |
| 528 | /* net.c */ |
| 529 | /** BOOTP EXTENTIONS **/ |
Joe Hershberger | 5874dec | 2015-04-08 01:41:01 -0500 | [diff] [blame] | 530 | extern struct in_addr net_gateway; /* Our gateway IP address */ |
| 531 | extern struct in_addr net_netmask; /* Our subnet mask (0 = unknown) */ |
| 532 | /* Our Domain Name Server (0 = unknown) */ |
| 533 | extern struct in_addr net_dns_server; |
Jon Loeliger | 5336a76 | 2007-07-09 22:08:34 -0500 | [diff] [blame] | 534 | #if defined(CONFIG_BOOTP_DNS2) |
Joe Hershberger | 5874dec | 2015-04-08 01:41:01 -0500 | [diff] [blame] | 535 | /* Our 2nd Domain Name Server (0 = unknown) */ |
| 536 | extern struct in_addr net_dns_server2; |
stroese | e0aadfb | 2003-08-28 14:17:32 +0000 | [diff] [blame] | 537 | #endif |
Joe Hershberger | 6d23643 | 2015-04-08 01:41:03 -0500 | [diff] [blame] | 538 | extern char net_nis_domain[32]; /* Our IS domain */ |
| 539 | extern char net_hostname[32]; /* Our hostname */ |
Andre Kalb | e9926e5 | 2022-01-28 09:40:32 +0100 | [diff] [blame] | 540 | #ifdef CONFIG_NET |
| 541 | extern char net_root_path[CONFIG_BOOTP_MAX_ROOT_PATH_LEN]; /* Our root path */ |
| 542 | #endif |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 543 | /** END OF BOOTP EXTENTIONS **/ |
oliver@schinagl.nl | 496904b | 2016-11-25 16:30:19 +0100 | [diff] [blame] | 544 | extern u8 net_ethaddr[ARP_HLEN]; /* Our ethernet address */ |
| 545 | extern u8 net_server_ethaddr[ARP_HLEN]; /* Boot server enet address */ |
Joe Hershberger | 5874dec | 2015-04-08 01:41:01 -0500 | [diff] [blame] | 546 | extern struct in_addr net_ip; /* Our IP addr (0 = unknown) */ |
| 547 | extern struct in_addr net_server_ip; /* Server IP addr (0 = unknown) */ |
Joe Hershberger | a8ca4f6 | 2015-04-08 01:41:05 -0500 | [diff] [blame] | 548 | extern uchar *net_tx_packet; /* THE transmit packet */ |
Joe Hershberger | f77abc5 | 2015-03-22 17:09:11 -0500 | [diff] [blame] | 549 | extern uchar *net_rx_packets[PKTBUFSRX]; /* Receive packets */ |
Joe Hershberger | a8ca4f6 | 2015-04-08 01:41:05 -0500 | [diff] [blame] | 550 | extern uchar *net_rx_packet; /* Current receive packet */ |
| 551 | extern int net_rx_packet_len; /* Current rx packet length */ |
oliver@schinagl.nl | 496904b | 2016-11-25 16:30:19 +0100 | [diff] [blame] | 552 | extern const u8 net_bcast_ethaddr[ARP_HLEN]; /* Ethernet broadcast address */ |
| 553 | extern const u8 net_null_ethaddr[ARP_HLEN]; |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 554 | |
Joe Hershberger | 290549f | 2012-05-15 08:59:05 +0000 | [diff] [blame] | 555 | #define VLAN_NONE 4095 /* untagged */ |
| 556 | #define VLAN_IDMASK 0x0fff /* mask of valid vlan id */ |
Joe Hershberger | 013d387 | 2015-04-08 01:41:17 -0500 | [diff] [blame] | 557 | extern ushort net_our_vlan; /* Our VLAN */ |
| 558 | extern ushort net_native_vlan; /* Our Native VLAN */ |
wdenk | 145d2c1 | 2004-04-15 21:48:45 +0000 | [diff] [blame] | 559 | |
Joe Hershberger | c80b41b0 | 2015-04-08 01:41:21 -0500 | [diff] [blame] | 560 | extern int net_restart_wrap; /* Tried all network devices */ |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 561 | |
Simon Glass | d6c5f55 | 2011-10-24 18:00:02 +0000 | [diff] [blame] | 562 | enum proto_t { |
Viacheslav Mitrofanov | e03c8aa | 2022-12-02 12:18:08 +0300 | [diff] [blame] | 563 | BOOTP, RARP, ARP, TFTPGET, DHCP, PING, PING6, DNS, NFS, CDP, NETCONS, |
| 564 | SNTP, TFTPSRV, TFTPPUT, LINKLOCAL, FASTBOOT, WOL, UDP, NCSI, WGET |
Simon Glass | d6c5f55 | 2011-10-24 18:00:02 +0000 | [diff] [blame] | 565 | }; |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 566 | |
Jacob Stiffler | ae80c2e | 2015-09-30 10:12:05 -0400 | [diff] [blame] | 567 | extern char net_boot_file_name[1024];/* Boot File name */ |
Alexander Graf | f43bf5d | 2018-06-15 10:29:27 +0200 | [diff] [blame] | 568 | /* Indicates whether the file name was specified on the command line */ |
| 569 | extern bool net_boot_file_name_explicit; |
Joe Hershberger | 290c899 | 2015-04-08 01:41:02 -0500 | [diff] [blame] | 570 | /* The actual transferred size of the bootfile (in bytes) */ |
| 571 | extern u32 net_boot_file_size; |
| 572 | /* Boot file size in blocks as reported by the DHCP server */ |
| 573 | extern u32 net_boot_file_expected_size_in_blocks; |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 574 | |
Robin Getz | 82f0d23 | 2009-07-20 14:53:54 -0400 | [diff] [blame] | 575 | #if defined(CONFIG_CMD_DNS) |
Joe Hershberger | f725e34 | 2015-04-08 01:41:15 -0500 | [diff] [blame] | 576 | extern char *net_dns_resolve; /* The host to resolve */ |
| 577 | extern char *net_dns_env_var; /* the env var to put the ip into */ |
Robin Getz | 82f0d23 | 2009-07-20 14:53:54 -0400 | [diff] [blame] | 578 | #endif |
| 579 | |
Jon Loeliger | 2517d97 | 2007-07-09 17:15:49 -0500 | [diff] [blame] | 580 | #if defined(CONFIG_CMD_PING) |
Joe Hershberger | 5874dec | 2015-04-08 01:41:01 -0500 | [diff] [blame] | 581 | extern struct in_addr net_ping_ip; /* the ip address to ping */ |
wdenk | e6466f6 | 2003-06-05 19:27:42 +0000 | [diff] [blame] | 582 | #endif |
| 583 | |
Jon Loeliger | 2517d97 | 2007-07-09 17:15:49 -0500 | [diff] [blame] | 584 | #if defined(CONFIG_CMD_CDP) |
wdenk | 145d2c1 | 2004-04-15 21:48:45 +0000 | [diff] [blame] | 585 | /* when CDP completes these hold the return values */ |
Joe Hershberger | 527336f | 2015-04-08 01:41:14 -0500 | [diff] [blame] | 586 | extern ushort cdp_native_vlan; /* CDP returned native VLAN */ |
| 587 | extern ushort cdp_appliance_vlan; /* CDP returned appliance VLAN */ |
Joe Hershberger | 00c62a8 | 2012-05-23 07:58:00 +0000 | [diff] [blame] | 588 | |
| 589 | /* |
| 590 | * Check for a CDP packet by examining the received MAC address field |
| 591 | */ |
Joe Hershberger | 8ecdbed | 2015-04-08 01:41:04 -0500 | [diff] [blame] | 592 | static inline int is_cdp_packet(const uchar *ethaddr) |
Joe Hershberger | 00c62a8 | 2012-05-23 07:58:00 +0000 | [diff] [blame] | 593 | { |
oliver@schinagl.nl | 496904b | 2016-11-25 16:30:19 +0100 | [diff] [blame] | 594 | extern const u8 net_cdp_ethaddr[ARP_HLEN]; |
Joe Hershberger | 00c62a8 | 2012-05-23 07:58:00 +0000 | [diff] [blame] | 595 | |
oliver@schinagl.nl | 496904b | 2016-11-25 16:30:19 +0100 | [diff] [blame] | 596 | return memcmp(ethaddr, net_cdp_ethaddr, ARP_HLEN) == 0; |
Joe Hershberger | 00c62a8 | 2012-05-23 07:58:00 +0000 | [diff] [blame] | 597 | } |
wdenk | 145d2c1 | 2004-04-15 21:48:45 +0000 | [diff] [blame] | 598 | #endif |
| 599 | |
Jon Loeliger | 2517d97 | 2007-07-09 17:15:49 -0500 | [diff] [blame] | 600 | #if defined(CONFIG_CMD_SNTP) |
Joe Hershberger | 5874dec | 2015-04-08 01:41:01 -0500 | [diff] [blame] | 601 | extern struct in_addr net_ntp_server; /* the ip address to NTP */ |
Joe Hershberger | c80b41b0 | 2015-04-08 01:41:21 -0500 | [diff] [blame] | 602 | extern int net_ntp_time_offset; /* offset time from UTC */ |
wdenk | b4ad962 | 2005-04-01 00:25:43 +0000 | [diff] [blame] | 603 | #endif |
| 604 | |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 605 | /* Initialize the network adapter */ |
Sean Anderson | 35e8298 | 2020-09-12 17:45:43 -0400 | [diff] [blame] | 606 | int net_init(void); |
Joe Hershberger | c80b41b0 | 2015-04-08 01:41:21 -0500 | [diff] [blame] | 607 | int net_loop(enum proto_t); |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 608 | |
| 609 | /* Load failed. Start again. */ |
Joe Hershberger | c80b41b0 | 2015-04-08 01:41:21 -0500 | [diff] [blame] | 610 | int net_start_again(void); |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 611 | |
wdenk | 145d2c1 | 2004-04-15 21:48:45 +0000 | [diff] [blame] | 612 | /* Get size of the ethernet header when we send */ |
Joe Hershberger | a8ca4f6 | 2015-04-08 01:41:05 -0500 | [diff] [blame] | 613 | int net_eth_hdr_size(void); |
wdenk | 145d2c1 | 2004-04-15 21:48:45 +0000 | [diff] [blame] | 614 | |
| 615 | /* Set ethernet header; returns the size of the header */ |
Joe Hershberger | a8ca4f6 | 2015-04-08 01:41:05 -0500 | [diff] [blame] | 616 | int net_set_ether(uchar *xet, const uchar *dest_ethaddr, uint prot); |
Joe Hershberger | b79dda3 | 2015-03-22 17:09:02 -0500 | [diff] [blame] | 617 | int net_update_ether(struct ethernet_hdr *et, uchar *addr, uint prot); |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 618 | |
| 619 | /* Set IP header */ |
Duncan Hare | f1447c9 | 2018-06-24 15:40:41 -0700 | [diff] [blame] | 620 | void net_set_ip_header(uchar *pkt, struct in_addr dest, struct in_addr source, |
| 621 | u16 pkt_len, u8 proto); |
Joe Hershberger | 5874dec | 2015-04-08 01:41:01 -0500 | [diff] [blame] | 622 | void net_set_udp_header(uchar *pkt, struct in_addr dest, int dport, |
Joe Hershberger | 2ed5b49 | 2012-05-23 07:59:07 +0000 | [diff] [blame] | 623 | int sport, int len); |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 624 | |
Simon Glass | 0015391 | 2015-01-19 22:16:07 -0700 | [diff] [blame] | 625 | /** |
| 626 | * compute_ip_checksum() - Compute IP checksum |
| 627 | * |
| 628 | * @addr: Address to check (must be 16-bit aligned) |
| 629 | * @nbytes: Number of bytes to check (normally a multiple of 2) |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 630 | * Return: 16-bit IP checksum |
Simon Glass | 0015391 | 2015-01-19 22:16:07 -0700 | [diff] [blame] | 631 | */ |
| 632 | unsigned compute_ip_checksum(const void *addr, unsigned nbytes); |
| 633 | |
| 634 | /** |
| 635 | * add_ip_checksums() - add two IP checksums |
| 636 | * |
| 637 | * @offset: Offset of first sum (if odd we do a byte-swap) |
| 638 | * @sum: First checksum |
| 639 | * @new_sum: New checksum to add |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 640 | * Return: updated 16-bit IP checksum |
Simon Glass | 0015391 | 2015-01-19 22:16:07 -0700 | [diff] [blame] | 641 | */ |
| 642 | unsigned add_ip_checksums(unsigned offset, unsigned sum, unsigned new_sum); |
| 643 | |
| 644 | /** |
| 645 | * ip_checksum_ok() - check if a checksum is correct |
| 646 | * |
| 647 | * This works by making sure the checksum sums to 0 |
| 648 | * |
| 649 | * @addr: Address to check (must be 16-bit aligned) |
| 650 | * @nbytes: Number of bytes to check (normally a multiple of 2) |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 651 | * Return: true if the checksum matches, false if not |
Simon Glass | 0015391 | 2015-01-19 22:16:07 -0700 | [diff] [blame] | 652 | */ |
| 653 | int ip_checksum_ok(const void *addr, unsigned nbytes); |
| 654 | |
Joe Hershberger | aae0508 | 2012-05-23 07:58:01 +0000 | [diff] [blame] | 655 | /* Callbacks */ |
Joe Hershberger | b79dda3 | 2015-03-22 17:09:02 -0500 | [diff] [blame] | 656 | rxhand_f *net_get_udp_handler(void); /* Get UDP RX packet handler */ |
| 657 | void net_set_udp_handler(rxhand_f *); /* Set UDP RX packet handler */ |
| 658 | rxhand_f *net_get_arp_handler(void); /* Get ARP RX packet handler */ |
| 659 | void net_set_arp_handler(rxhand_f *); /* Set ARP RX packet handler */ |
Joe Hershberger | 5641f67 | 2018-09-26 16:48:58 -0500 | [diff] [blame] | 660 | bool arp_is_waiting(void); /* Waiting for ARP reply? */ |
Joe Hershberger | b79dda3 | 2015-03-22 17:09:02 -0500 | [diff] [blame] | 661 | void net_set_icmp_handler(rxhand_icmp_f *f); /* Set ICMP RX handler */ |
Joe Hershberger | c80b41b0 | 2015-04-08 01:41:21 -0500 | [diff] [blame] | 662 | void net_set_timeout_handler(ulong, thand_f *);/* Set timeout handler */ |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 663 | |
Joe Hershberger | d4bb76a | 2012-05-23 07:59:14 +0000 | [diff] [blame] | 664 | /* Network loop state */ |
| 665 | enum net_loop_state { |
| 666 | NETLOOP_CONTINUE, |
| 667 | NETLOOP_RESTART, |
| 668 | NETLOOP_SUCCESS, |
| 669 | NETLOOP_FAIL |
| 670 | }; |
Kim Phillips | 40c2c03 | 2012-10-29 13:34:33 +0000 | [diff] [blame] | 671 | extern enum net_loop_state net_state; |
| 672 | |
Joe Hershberger | d4bb76a | 2012-05-23 07:59:14 +0000 | [diff] [blame] | 673 | static inline void net_set_state(enum net_loop_state state) |
| 674 | { |
Joe Hershberger | 05a377b | 2012-05-23 08:01:04 +0000 | [diff] [blame] | 675 | debug_cond(DEBUG_INT_STATE, "--- NetState set to %d\n", state); |
Joe Hershberger | d4bb76a | 2012-05-23 07:59:14 +0000 | [diff] [blame] | 676 | net_state = state; |
| 677 | } |
| 678 | |
Joe Hershberger | e79a518 | 2018-09-26 16:49:02 -0500 | [diff] [blame] | 679 | /* |
| 680 | * net_get_async_tx_pkt_buf - Get a packet buffer that is not in use for |
| 681 | * sending an asynchronous reply |
| 682 | * |
| 683 | * returns - ptr to packet buffer |
| 684 | */ |
| 685 | uchar * net_get_async_tx_pkt_buf(void); |
| 686 | |
Joe Hershberger | de8205a | 2012-05-23 07:59:24 +0000 | [diff] [blame] | 687 | /* Transmit a packet */ |
Joe Hershberger | a8ca4f6 | 2015-04-08 01:41:05 -0500 | [diff] [blame] | 688 | static inline void net_send_packet(uchar *pkt, int len) |
Joe Hershberger | ebe3ca8 | 2012-05-23 07:59:13 +0000 | [diff] [blame] | 689 | { |
Joe Hershberger | f4dc96a | 2015-03-22 17:09:24 -0500 | [diff] [blame] | 690 | /* Currently no way to return errors from eth_send() */ |
Joe Hershberger | ebe3ca8 | 2012-05-23 07:59:13 +0000 | [diff] [blame] | 691 | (void) eth_send(pkt, len); |
| 692 | } |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 693 | |
Ying-Chun Liu (PaulLiu) | 41efed1 | 2022-11-08 14:17:28 +0800 | [diff] [blame] | 694 | /** |
| 695 | * net_send_ip_packet() - Transmit "net_tx_packet" as UDP or TCP packet, |
| 696 | * send ARP request if needed (ether will be populated) |
| 697 | * @ether: Raw packet buffer |
| 698 | * @dest: IP address to send the datagram to |
| 699 | * @dport: Destination UDP port |
| 700 | * @sport: Source UDP port |
| 701 | * @payload_len: Length of data after the UDP header |
| 702 | * @action: TCP action to be performed |
| 703 | * @tcp_seq_num: TCP sequence number of this transmission |
| 704 | * @tcp_ack_num: TCP stream acknolegement number |
Joe Hershberger | 1a6b8d8 | 2012-05-23 07:58:10 +0000 | [diff] [blame] | 705 | * |
Ying-Chun Liu (PaulLiu) | 41efed1 | 2022-11-08 14:17:28 +0800 | [diff] [blame] | 706 | * Return: 0 on success, other value on failure |
Joe Hershberger | 1a6b8d8 | 2012-05-23 07:58:10 +0000 | [diff] [blame] | 707 | */ |
Duncan Hare | f1447c9 | 2018-06-24 15:40:41 -0700 | [diff] [blame] | 708 | int net_send_ip_packet(uchar *ether, struct in_addr dest, int dport, int sport, |
| 709 | int payload_len, int proto, u8 action, u32 tcp_seq_num, |
| 710 | u32 tcp_ack_num); |
Ying-Chun Liu (PaulLiu) | 41efed1 | 2022-11-08 14:17:28 +0800 | [diff] [blame] | 711 | /** |
| 712 | * net_send_tcp_packet() - Transmit TCP packet. |
| 713 | * @payload_len: length of payload |
| 714 | * @dport: Destination TCP port |
| 715 | * @sport: Source TCP port |
| 716 | * @action: TCP action to be performed |
| 717 | * @tcp_seq_num: TCP sequence number of this transmission |
| 718 | * @tcp_ack_num: TCP stream acknolegement number |
| 719 | * |
| 720 | * Return: 0 on success, other value on failure |
| 721 | */ |
| 722 | int net_send_tcp_packet(int payload_len, int dport, int sport, u8 action, |
| 723 | u32 tcp_seq_num, u32 tcp_ack_num); |
Joe Hershberger | a8ca4f6 | 2015-04-08 01:41:05 -0500 | [diff] [blame] | 724 | int net_send_udp_packet(uchar *ether, struct in_addr dest, int dport, |
Joe Hershberger | 1a6b8d8 | 2012-05-23 07:58:10 +0000 | [diff] [blame] | 725 | int sport, int payload_len); |
wdenk | e6466f6 | 2003-06-05 19:27:42 +0000 | [diff] [blame] | 726 | |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 727 | /* Processes a received packet */ |
Joe Hershberger | f77abc5 | 2015-03-22 17:09:11 -0500 | [diff] [blame] | 728 | void net_process_received_packet(uchar *in_packet, int len); |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 729 | |
Jason Kridner | 5c218d2 | 2018-03-07 05:40:43 -0500 | [diff] [blame] | 730 | #if defined(CONFIG_NETCONSOLE) && !defined(CONFIG_SPL_BUILD) |
Joe Hershberger | d02aa6b | 2015-04-08 01:41:16 -0500 | [diff] [blame] | 731 | void nc_start(void); |
Joe Hershberger | 5874dec | 2015-04-08 01:41:01 -0500 | [diff] [blame] | 732 | int nc_input_packet(uchar *pkt, struct in_addr src_ip, unsigned dest_port, |
Joe Hershberger | 58cd218 | 2012-09-18 10:01:32 +0000 | [diff] [blame] | 733 | unsigned src_port, unsigned len); |
Joe Hershberger | 77001b43 | 2012-05-15 08:59:08 +0000 | [diff] [blame] | 734 | #endif |
| 735 | |
Fabio Estevam | cff6536 | 2015-11-08 22:25:14 -0200 | [diff] [blame] | 736 | static __always_inline int eth_is_on_demand_init(void) |
Joe Hershberger | 9f37406 | 2012-08-03 10:59:08 +0000 | [diff] [blame] | 737 | { |
Jason Kridner | 5c218d2 | 2018-03-07 05:40:43 -0500 | [diff] [blame] | 738 | #if defined(CONFIG_NETCONSOLE) && !defined(CONFIG_SPL_BUILD) |
Joe Hershberger | 9f37406 | 2012-08-03 10:59:08 +0000 | [diff] [blame] | 739 | extern enum proto_t net_loop_last_protocol; |
| 740 | |
| 741 | return net_loop_last_protocol != NETCONS; |
| 742 | #else |
| 743 | return 1; |
| 744 | #endif |
| 745 | } |
| 746 | |
| 747 | static inline void eth_set_last_protocol(int protocol) |
| 748 | { |
Jason Kridner | 5c218d2 | 2018-03-07 05:40:43 -0500 | [diff] [blame] | 749 | #if defined(CONFIG_NETCONSOLE) && !defined(CONFIG_SPL_BUILD) |
Joe Hershberger | 9f37406 | 2012-08-03 10:59:08 +0000 | [diff] [blame] | 750 | extern enum proto_t net_loop_last_protocol; |
| 751 | |
| 752 | net_loop_last_protocol = protocol; |
| 753 | #endif |
| 754 | } |
| 755 | |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 756 | /* |
Simon Glass | 5234ad1 | 2011-10-27 06:24:32 +0000 | [diff] [blame] | 757 | * Check if autoload is enabled. If so, use either NFS or TFTP to download |
| 758 | * the boot file. |
| 759 | */ |
| 760 | void net_auto_load(void); |
| 761 | |
| 762 | /* |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 763 | * The following functions are a bit ugly, but necessary to deal with |
| 764 | * alignment restrictions on ARM. |
| 765 | * |
| 766 | * We're using inline functions, which had the smallest memory |
| 767 | * footprint in our tests. |
| 768 | */ |
| 769 | /* return IP *in network byteorder* */ |
Joe Hershberger | 5874dec | 2015-04-08 01:41:01 -0500 | [diff] [blame] | 770 | static inline struct in_addr net_read_ip(void *from) |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 771 | { |
Joe Hershberger | 5874dec | 2015-04-08 01:41:01 -0500 | [diff] [blame] | 772 | struct in_addr ip; |
Joe Hershberger | 290549f | 2012-05-15 08:59:05 +0000 | [diff] [blame] | 773 | |
| 774 | memcpy((void *)&ip, (void *)from, sizeof(ip)); |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 775 | return ip; |
| 776 | } |
| 777 | |
| 778 | /* return ulong *in network byteorder* */ |
Heinrich Schuchardt | f620e61 | 2019-07-14 22:02:13 +0200 | [diff] [blame] | 779 | static inline u32 net_read_u32(void *from) |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 780 | { |
Sergey Temerkhanov | bf5ad64 | 2015-04-08 01:41:22 -0500 | [diff] [blame] | 781 | u32 l; |
Joe Hershberger | 290549f | 2012-05-15 08:59:05 +0000 | [diff] [blame] | 782 | |
| 783 | memcpy((void *)&l, (void *)from, sizeof(l)); |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 784 | return l; |
| 785 | } |
| 786 | |
| 787 | /* write IP *in network byteorder* */ |
Joe Hershberger | 5874dec | 2015-04-08 01:41:01 -0500 | [diff] [blame] | 788 | static inline void net_write_ip(void *to, struct in_addr ip) |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 789 | { |
Joe Hershberger | 290549f | 2012-05-15 08:59:05 +0000 | [diff] [blame] | 790 | memcpy(to, (void *)&ip, sizeof(ip)); |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 791 | } |
| 792 | |
| 793 | /* copy IP */ |
Joe Hershberger | 5874dec | 2015-04-08 01:41:01 -0500 | [diff] [blame] | 794 | static inline void net_copy_ip(void *to, void *from) |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 795 | { |
Joe Hershberger | 5874dec | 2015-04-08 01:41:01 -0500 | [diff] [blame] | 796 | memcpy((void *)to, from, sizeof(struct in_addr)); |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 797 | } |
| 798 | |
| 799 | /* copy ulong */ |
Heinrich Schuchardt | f620e61 | 2019-07-14 22:02:13 +0200 | [diff] [blame] | 800 | static inline void net_copy_u32(void *to, void *from) |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 801 | { |
Sergey Temerkhanov | bf5ad64 | 2015-04-08 01:41:22 -0500 | [diff] [blame] | 802 | memcpy((void *)to, (void *)from, sizeof(u32)); |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 803 | } |
| 804 | |
Mike Rapoport | e54d6c1 | 2007-08-12 08:48:27 +0300 | [diff] [blame] | 805 | /** |
Joe Hershberger | 8ecdbed | 2015-04-08 01:41:04 -0500 | [diff] [blame] | 806 | * is_zero_ethaddr - Determine if give Ethernet address is all zeros. |
Mike Rapoport | e54d6c1 | 2007-08-12 08:48:27 +0300 | [diff] [blame] | 807 | * @addr: Pointer to a six-byte array containing the Ethernet address |
| 808 | * |
| 809 | * Return true if the address is all zeroes. |
| 810 | */ |
Joe Hershberger | 8ecdbed | 2015-04-08 01:41:04 -0500 | [diff] [blame] | 811 | static inline int is_zero_ethaddr(const u8 *addr) |
Mike Rapoport | e54d6c1 | 2007-08-12 08:48:27 +0300 | [diff] [blame] | 812 | { |
| 813 | return !(addr[0] | addr[1] | addr[2] | addr[3] | addr[4] | addr[5]); |
| 814 | } |
| 815 | |
| 816 | /** |
Joe Hershberger | 8ecdbed | 2015-04-08 01:41:04 -0500 | [diff] [blame] | 817 | * is_multicast_ethaddr - Determine if the Ethernet address is a multicast. |
Mike Rapoport | e54d6c1 | 2007-08-12 08:48:27 +0300 | [diff] [blame] | 818 | * @addr: Pointer to a six-byte array containing the Ethernet address |
| 819 | * |
| 820 | * Return true if the address is a multicast address. |
| 821 | * By definition the broadcast address is also a multicast address. |
| 822 | */ |
Joe Hershberger | 8ecdbed | 2015-04-08 01:41:04 -0500 | [diff] [blame] | 823 | static inline int is_multicast_ethaddr(const u8 *addr) |
Mike Rapoport | e54d6c1 | 2007-08-12 08:48:27 +0300 | [diff] [blame] | 824 | { |
Joe Hershberger | 290549f | 2012-05-15 08:59:05 +0000 | [diff] [blame] | 825 | return 0x01 & addr[0]; |
Mike Rapoport | e54d6c1 | 2007-08-12 08:48:27 +0300 | [diff] [blame] | 826 | } |
| 827 | |
Remy Bohmer | df06344 | 2009-07-29 18:18:43 +0200 | [diff] [blame] | 828 | /* |
Joe Hershberger | 8ecdbed | 2015-04-08 01:41:04 -0500 | [diff] [blame] | 829 | * is_broadcast_ethaddr - Determine if the Ethernet address is broadcast |
Remy Bohmer | df06344 | 2009-07-29 18:18:43 +0200 | [diff] [blame] | 830 | * @addr: Pointer to a six-byte array containing the Ethernet address |
| 831 | * |
| 832 | * Return true if the address is the broadcast address. |
| 833 | */ |
Joe Hershberger | 8ecdbed | 2015-04-08 01:41:04 -0500 | [diff] [blame] | 834 | static inline int is_broadcast_ethaddr(const u8 *addr) |
Remy Bohmer | df06344 | 2009-07-29 18:18:43 +0200 | [diff] [blame] | 835 | { |
Joe Hershberger | 290549f | 2012-05-15 08:59:05 +0000 | [diff] [blame] | 836 | return (addr[0] & addr[1] & addr[2] & addr[3] & addr[4] & addr[5]) == |
| 837 | 0xff; |
Remy Bohmer | df06344 | 2009-07-29 18:18:43 +0200 | [diff] [blame] | 838 | } |
| 839 | |
| 840 | /* |
Joe Hershberger | 8ecdbed | 2015-04-08 01:41:04 -0500 | [diff] [blame] | 841 | * is_valid_ethaddr - Determine if the given Ethernet address is valid |
Mike Frysinger | 2a02f5c | 2009-01-27 16:53:39 -0500 | [diff] [blame] | 842 | * @addr: Pointer to a six-byte array containing the Ethernet address |
| 843 | * |
| 844 | * Check that the Ethernet address (MAC) is not 00:00:00:00:00:00, is not |
| 845 | * a multicast address, and is not FF:FF:FF:FF:FF:FF. |
| 846 | * |
| 847 | * Return true if the address is valid. |
| 848 | */ |
Joe Hershberger | 8ecdbed | 2015-04-08 01:41:04 -0500 | [diff] [blame] | 849 | static inline int is_valid_ethaddr(const u8 *addr) |
Mike Frysinger | 2a02f5c | 2009-01-27 16:53:39 -0500 | [diff] [blame] | 850 | { |
| 851 | /* FF:FF:FF:FF:FF:FF is a multicast address so we don't need to |
| 852 | * explicitly check for it here. */ |
Joe Hershberger | 8ecdbed | 2015-04-08 01:41:04 -0500 | [diff] [blame] | 853 | return !is_multicast_ethaddr(addr) && !is_zero_ethaddr(addr); |
Mike Frysinger | 2a02f5c | 2009-01-27 16:53:39 -0500 | [diff] [blame] | 854 | } |
| 855 | |
Masahiro Yamada | 0b16e65 | 2014-04-18 19:09:48 +0900 | [diff] [blame] | 856 | /** |
Joe Hershberger | 8ecdbed | 2015-04-08 01:41:04 -0500 | [diff] [blame] | 857 | * net_random_ethaddr - Generate software assigned random Ethernet address |
Masahiro Yamada | 0b16e65 | 2014-04-18 19:09:48 +0900 | [diff] [blame] | 858 | * @addr: Pointer to a six-byte array containing the Ethernet address |
| 859 | * |
| 860 | * Generate a random Ethernet address (MAC) that is not multicast |
| 861 | * and has the local assigned bit set. |
| 862 | */ |
Joe Hershberger | 8ecdbed | 2015-04-08 01:41:04 -0500 | [diff] [blame] | 863 | static inline void net_random_ethaddr(uchar *addr) |
Masahiro Yamada | 0b16e65 | 2014-04-18 19:09:48 +0900 | [diff] [blame] | 864 | { |
| 865 | int i; |
Michael Walle | eff9c90 | 2019-08-27 10:13:52 +0200 | [diff] [blame] | 866 | unsigned int seed = get_ticks(); |
Masahiro Yamada | 0b16e65 | 2014-04-18 19:09:48 +0900 | [diff] [blame] | 867 | |
| 868 | for (i = 0; i < 6; i++) |
| 869 | addr[i] = rand_r(&seed); |
| 870 | |
| 871 | addr[0] &= 0xfe; /* clear multicast bit */ |
| 872 | addr[0] |= 0x02; /* set local assignment bit (IEEE802) */ |
| 873 | } |
| 874 | |
Joe Hershberger | 8e7545e | 2019-09-13 19:21:16 -0500 | [diff] [blame] | 875 | /** |
| 876 | * string_to_enetaddr() - Parse a MAC address |
| 877 | * |
| 878 | * Convert a string MAC address |
| 879 | * |
| 880 | * Implemented in lib/net_utils.c (built unconditionally) |
| 881 | * |
| 882 | * @addr: MAC address in aa:bb:cc:dd:ee:ff format, where each part is a 2-digit |
| 883 | * hex value |
| 884 | * @enetaddr: Place to put MAC address (6 bytes) |
| 885 | */ |
| 886 | void string_to_enetaddr(const char *addr, uint8_t *enetaddr); |
| 887 | |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 888 | /* Convert an IP address to a string */ |
Joe Hershberger | 5874dec | 2015-04-08 01:41:01 -0500 | [diff] [blame] | 889 | void ip_to_string(struct in_addr x, char *s); |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 890 | |
Simon Glass | 15595db | 2019-11-14 12:57:21 -0700 | [diff] [blame] | 891 | /** |
| 892 | * string_to_ip() - Convert a string to ip address |
| 893 | * |
Joe Hershberger | 9c71be9 | 2019-09-13 19:29:41 -0500 | [diff] [blame] | 894 | * Implemented in lib/net_utils.c (built unconditionally) |
| 895 | * |
| 896 | * @s: Input string to parse |
| 897 | * @return: in_addr struct containing the parsed IP address |
Simon Glass | 15595db | 2019-11-14 12:57:21 -0700 | [diff] [blame] | 898 | */ |
Joe Hershberger | 5874dec | 2015-04-08 01:41:01 -0500 | [diff] [blame] | 899 | struct in_addr string_to_ip(const char *s); |
wdenk | e6466f6 | 2003-06-05 19:27:42 +0000 | [diff] [blame] | 900 | |
wdenk | 145d2c1 | 2004-04-15 21:48:45 +0000 | [diff] [blame] | 901 | /* Convert a VLAN id to a string */ |
Joe Hershberger | 013d387 | 2015-04-08 01:41:17 -0500 | [diff] [blame] | 902 | void vlan_to_string(ushort x, char *s); |
wdenk | 145d2c1 | 2004-04-15 21:48:45 +0000 | [diff] [blame] | 903 | |
| 904 | /* Convert a string to a vlan id */ |
Joe Hershberger | 013d387 | 2015-04-08 01:41:17 -0500 | [diff] [blame] | 905 | ushort string_to_vlan(const char *s); |
wdenk | 145d2c1 | 2004-04-15 21:48:45 +0000 | [diff] [blame] | 906 | |
wdenk | 145d2c1 | 2004-04-15 21:48:45 +0000 | [diff] [blame] | 907 | /* read a VLAN id from an environment variable */ |
Simon Glass | da1a134 | 2017-08-03 12:22:15 -0600 | [diff] [blame] | 908 | ushort env_get_vlan(char *); |
wdenk | 145d2c1 | 2004-04-15 21:48:45 +0000 | [diff] [blame] | 909 | |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 910 | /* copy a filename (allow for "..." notation, limit length) */ |
Joe Hershberger | b79dda3 | 2015-03-22 17:09:02 -0500 | [diff] [blame] | 911 | void copy_filename(char *dst, const char *src, int size); |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 912 | |
Joe Hershberger | f559f1c | 2018-07-03 19:36:39 -0500 | [diff] [blame] | 913 | /* check if serverip is specified in filename from the command line */ |
| 914 | int is_serverip_in_cmd(void); |
| 915 | |
Joe Hershberger | 9cb7b02 | 2018-07-03 19:36:43 -0500 | [diff] [blame] | 916 | /** |
| 917 | * net_parse_bootfile - Parse the bootfile env var / cmd line param |
| 918 | * |
| 919 | * @param ipaddr - a pointer to the ipaddr to populate if included in bootfile |
| 920 | * @param filename - a pointer to the string to save the filename part |
| 921 | * @param max_len - The longest - 1 that the filename part can be |
| 922 | * |
| 923 | * return 1 if parsed, 0 if bootfile is empty |
| 924 | */ |
| 925 | int net_parse_bootfile(struct in_addr *ipaddr, char *filename, int max_len); |
| 926 | |
Lukasz Majewski | e32125a | 2015-08-24 00:21:47 +0200 | [diff] [blame] | 927 | /** |
| 928 | * update_tftp - Update firmware over TFTP (via DFU) |
| 929 | * |
| 930 | * This function updates board's firmware via TFTP |
| 931 | * |
| 932 | * @param addr - memory address where data is stored |
| 933 | * @param interface - the DFU medium name - e.g. "mmc" |
| 934 | * @param devstring - the DFU medium number - e.g. "1" |
| 935 | * |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 936 | * Return: - 0 on success, other value on failure |
Lukasz Majewski | e32125a | 2015-08-24 00:21:47 +0200 | [diff] [blame] | 937 | */ |
| 938 | int update_tftp(ulong addr, char *interface, char *devstring); |
Simon Glass | d1892ac | 2013-05-15 06:23:54 +0000 | [diff] [blame] | 939 | |
Simon Glass | 15595db | 2019-11-14 12:57:21 -0700 | [diff] [blame] | 940 | /** |
| 941 | * env_get_ip() - Convert an environment value to to an ip address |
| 942 | * |
| 943 | * @var: Environment variable to convert. The value of this variable must be |
| 944 | * in the format format a.b.c.d, where each value is a decimal number from |
| 945 | * 0 to 255 |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 946 | * Return: IP address, or 0 if invalid |
Simon Glass | 15595db | 2019-11-14 12:57:21 -0700 | [diff] [blame] | 947 | */ |
| 948 | static inline struct in_addr env_get_ip(char *var) |
| 949 | { |
| 950 | return string_to_ip(env_get(var)); |
| 951 | } |
Simon Glass | 0c36441 | 2019-12-28 10:44:48 -0700 | [diff] [blame] | 952 | |
| 953 | /** |
| 954 | * reset_phy() - Reset the Ethernet PHY |
| 955 | * |
| 956 | * This should be implemented by boards if CONFIG_RESET_PHY_R is enabled |
| 957 | */ |
| 958 | void reset_phy(void); |
| 959 | |
wdenk | 2d96695 | 2002-10-31 22:12:35 +0000 | [diff] [blame] | 960 | #endif /* __NET_H__ */ |