]>
Commit | Line | Data |
---|---|---|
f739fcd8 | 1 | /* SPDX-License-Identifier: GPL-2.0 */ |
2d966958 WD |
2 | /* |
3 | * LiMon Monitor (LiMon) - Network. | |
4 | * | |
5 | * Copyright 1994 - 2000 Neil Russell. | |
6 | * (See License) | |
2d966958 WD |
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 | ||
90526e9f | 15 | #include <linux/types.h> |
2c4b3c19 | 16 | #include <asm/cache.h> |
2d966958 | 17 | #include <asm/byteorder.h> /* for nton* / ntoh* stuff */ |
9fb625ce | 18 | #include <env.h> |
798962ce | 19 | #include <hexdump.h> |
c3dc39a2 SG |
20 | #include <log.h> |
21 | #include <time.h> | |
dda52510 | 22 | #include <linux/if_ether.h> |
840ef4d4 | 23 | #include <rand.h> |
2d966958 | 24 | |
90526e9f | 25 | struct bd_info; |
09140113 | 26 | struct cmd_tbl; |
90526e9f | 27 | struct udevice; |
c3dc39a2 | 28 | |
4ef8d53c JH |
29 | #define DEBUG_LL_STATE 0 /* Link local state machine changes */ |
30 | #define DEBUG_DEV_PKT 0 /* Packets or info directed to the device */ | |
31 | #define DEBUG_NET_PKT 0 /* Packets on info on the network at large */ | |
32 | #define DEBUG_INT_STATE 0 /* Internal network state changes */ | |
798962ce | 33 | #define DEBUG_NET_PKT_TRACE 0 /* Trace all packet data */ |
2d966958 WD |
34 | |
35 | /* | |
36 | * The number of receive packet buffers, and the required packet buffer | |
37 | * alignment in memory. | |
38 | * | |
39 | */ | |
0b956e39 | 40 | #define PKTBUFSRX CONFIG_SYS_RX_ETH_BUFFER |
2c4b3c19 | 41 | #define PKTALIGN ARCH_DMA_MINALIGN |
2d966958 | 42 | |
36ea0cab PW |
43 | /* Number of packets processed together */ |
44 | #define ETH_PACKETS_BATCH_RECV 32 | |
45 | ||
a40db6d5 | 46 | /* ARP hardware address length */ |
47 | #define ARP_HLEN 6 | |
9f455bcb | 48 | /* |
49 | * The size of a MAC address in string form, each digit requires two chars | |
50 | * and five separator characters to form '00:00:00:00:00:00'. | |
51 | */ | |
52 | #define ARP_HLEN_ASCII (ARP_HLEN * 2) + (ARP_HLEN - 1) | |
a40db6d5 | 53 | |
ea45cb0a | 54 | /* IPv4 addresses are always 32 bits in size */ |
049a95a7 JH |
55 | struct in_addr { |
56 | __be32 s_addr; | |
57 | }; | |
2d966958 | 58 | |
77f4e477 SG |
59 | /** |
60 | * do_tftpb - Run the tftpboot command | |
61 | * | |
62 | * @cmdtp: Command information for tftpboot | |
63 | * @flag: Command flags (CMD_FLAG_...) | |
64 | * @argc: Number of arguments | |
65 | * @argv: List of arguments | |
185f812c | 66 | * Return: result (see enum command_ret_t) |
77f4e477 | 67 | */ |
09140113 | 68 | int do_tftpb(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]); |
77f4e477 | 69 | |
c8c3fd24 SG |
70 | /** |
71 | * dhcp_run() - Run DHCP on the current ethernet device | |
72 | * | |
73 | * This sets the autoload variable, then puts it back to similar to its original | |
74 | * state (y, n or unset). | |
75 | * | |
76 | * @addr: Address to load the file into (0 if @autoload is false) | |
77 | * @fname: Filename of file to load (NULL if @autoload is false or to use the | |
78 | * default filename) | |
79 | * @autoload: true to load the file, false to just get the network IP | |
80 | * @return 0 if OK, -EINVAL if the environment failed, -ENOENT if ant file was | |
81 | * not found | |
82 | */ | |
83 | int dhcp_run(ulong addr, const char *fname, bool autoload); | |
84 | ||
03eb129f LC |
85 | /** |
86 | * An incoming packet handler. | |
87 | * @param pkt pointer to the application packet | |
88 | * @param dport destination UDP port | |
89 | * @param sip source IP address | |
90 | * @param sport source UDP port | |
91 | * @param len packet length | |
2d966958 | 92 | */ |
03eb129f | 93 | typedef void rxhand_f(uchar *pkt, unsigned dport, |
049a95a7 | 94 | struct in_addr sip, unsigned sport, |
03eb129f | 95 | unsigned len); |
2d966958 | 96 | |
4793ee65 SG |
97 | /** |
98 | * An incoming ICMP packet handler. | |
99 | * @param type ICMP type | |
100 | * @param code ICMP code | |
101 | * @param dport destination UDP port | |
102 | * @param sip source IP address | |
103 | * @param sport source UDP port | |
104 | * @param pkt pointer to the ICMP packet data | |
105 | * @param len packet length | |
106 | */ | |
107 | typedef void rxhand_icmp_f(unsigned type, unsigned code, unsigned dport, | |
049a95a7 | 108 | struct in_addr sip, unsigned sport, uchar *pkt, unsigned len); |
4793ee65 | 109 | |
2d966958 WD |
110 | /* |
111 | * A timeout handler. Called after time interval has expired. | |
112 | */ | |
113 | typedef void thand_f(void); | |
114 | ||
2d966958 WD |
115 | enum eth_state_t { |
116 | ETH_STATE_INIT, | |
117 | ETH_STATE_PASSIVE, | |
118 | ETH_STATE_ACTIVE | |
119 | }; | |
120 | ||
05c3e68f JH |
121 | /** |
122 | * struct eth_pdata - Platform data for Ethernet MAC controllers | |
123 | * | |
124 | * @iobase: The base address of the hardware registers | |
125 | * @enetaddr: The Ethernet MAC address that is loaded from EEPROM or env | |
c74c8e66 | 126 | * @phy_interface: PHY interface to use - see PHY_INTERFACE_MODE_... |
f74264d6 | 127 | * @max_speed: Maximum speed of Ethernet connection supported by MAC |
caa4daa2 | 128 | * @priv_pdata: device specific plat |
05c3e68f JH |
129 | */ |
130 | struct eth_pdata { | |
131 | phys_addr_t iobase; | |
a40db6d5 | 132 | unsigned char enetaddr[ARP_HLEN]; |
c74c8e66 | 133 | int phy_interface; |
f74264d6 | 134 | int max_speed; |
3c6add98 | 135 | void *priv_pdata; |
05c3e68f JH |
136 | }; |
137 | ||
a1ca92ea SG |
138 | enum eth_recv_flags { |
139 | /* | |
140 | * Check hardware device for new packets (otherwise only return those | |
141 | * which are already in the memory buffer ready to process) | |
142 | */ | |
143 | ETH_RECV_CHECK_DEVICE = 1 << 0, | |
144 | }; | |
145 | ||
05c3e68f JH |
146 | /** |
147 | * struct eth_ops - functions of Ethernet MAC controllers | |
148 | * | |
149 | * start: Prepare the hardware to send and receive packets | |
150 | * send: Send the bytes passed in "packet" as a packet on the wire | |
17591405 JH |
151 | * recv: Check if the hardware received a packet. If so, set the pointer to the |
152 | * packet buffer in the packetp parameter. If not, return an error or 0 to | |
63c9729a JH |
153 | * indicate that the hardware receive FIFO is empty. If 0 is returned, the |
154 | * network stack will not process the empty packet, but free_pkt() will be | |
155 | * called if supplied | |
156 | * free_pkt: Give the driver an opportunity to manage its packet buffer memory | |
157 | * when the network stack is finished processing it. This will only be | |
158 | * called when no error was returned from recv - optional | |
05c3e68f JH |
159 | * stop: Stop the hardware from looking for packets - may be called even if |
160 | * state == PASSIVE | |
161 | * mcast: Join or leave a multicast group (for TFTP) - optional | |
162 | * write_hwaddr: Write a MAC address to the hardware (used to pass it to Linux | |
163 | * on some platforms like ARM). This function expects the | |
b86f795a SG |
164 | * eth_pdata::enetaddr field to be populated. The method can |
165 | * return -ENOSYS to indicate that this is not implemented for | |
166 | this hardware - optional. | |
05c3e68f JH |
167 | * read_rom_hwaddr: Some devices have a backup of the MAC address stored in a |
168 | * ROM on the board. This is how the driver should expose it | |
169 | * to the network stack. This function should fill in the | |
170 | * eth_pdata::enetaddr field - optional | |
631f3afb | 171 | * set_promisc: Enable or Disable promiscuous mode |
c85e96d0 IC |
172 | * get_sset_count: Number of statistics counters |
173 | * get_string: Names of the statistic counters | |
174 | * get_stats: The values of the statistic counters | |
05c3e68f JH |
175 | */ |
176 | struct eth_ops { | |
177 | int (*start)(struct udevice *dev); | |
178 | int (*send)(struct udevice *dev, void *packet, int length); | |
a1ca92ea | 179 | int (*recv)(struct udevice *dev, int flags, uchar **packetp); |
63c9729a | 180 | int (*free_pkt)(struct udevice *dev, uchar *packet, int length); |
05c3e68f | 181 | void (*stop)(struct udevice *dev); |
05c3e68f | 182 | int (*mcast)(struct udevice *dev, const u8 *enetaddr, int join); |
05c3e68f JH |
183 | int (*write_hwaddr)(struct udevice *dev); |
184 | int (*read_rom_hwaddr)(struct udevice *dev); | |
631f3afb | 185 | int (*set_promisc)(struct udevice *dev, bool enable); |
c85e96d0 IC |
186 | int (*get_sset_count)(struct udevice *dev); |
187 | void (*get_strings)(struct udevice *dev, u8 *data); | |
188 | void (*get_stats)(struct udevice *dev, u64 *data); | |
05c3e68f JH |
189 | }; |
190 | ||
191 | #define eth_get_ops(dev) ((struct eth_ops *)(dev)->driver->ops) | |
192 | ||
193 | struct udevice *eth_get_dev(void); /* get the current device */ | |
e58780dc JH |
194 | /* |
195 | * The devname can be either an exact name given by the driver or device tree | |
196 | * or it can be an alias of the form "eth%d" | |
197 | */ | |
198 | struct udevice *eth_get_dev_by_name(const char *devname); | |
05c3e68f | 199 | unsigned char *eth_get_ethaddr(void); /* get the current device MAC */ |
eaa8a195 | 200 | |
05c3e68f | 201 | /* Used only when NetConsole is enabled */ |
eaa8a195 | 202 | int eth_is_active(struct udevice *dev); /* Test device for active state */ |
05c3e68f JH |
203 | int eth_init_state_only(void); /* Set active state */ |
204 | void eth_halt_state_only(void); /* Set passive state */ | |
84eb1fba | 205 | |
d2eaec60 | 206 | int eth_initialize(void); /* Initialize network subsystem */ |
84eb1fba JH |
207 | void eth_try_another(int first_restart); /* Change the device */ |
208 | void eth_set_current(void); /* set nterface to ethcur var */ | |
209 | ||
ff997432 | 210 | int eth_get_dev_index(void); /* get the device index */ |
7616e785 | 211 | |
5350bc8f | 212 | /** |
fd1e959e | 213 | * eth_env_set_enetaddr_by_index() - set the MAC address environment variable |
5350bc8f RQ |
214 | * |
215 | * This sets up an environment variable with the given MAC address (@enetaddr). | |
216 | * The environment variable to be set is defined by <@base_name><@index>addr. | |
217 | * If @index is 0 it is omitted. For common Ethernet this means ethaddr, | |
218 | * eth1addr, etc. | |
219 | * | |
220 | * @base_name: Base name for variable, typically "eth" | |
221 | * @index: Index of interface being updated (>=0) | |
222 | * @enetaddr: Pointer to MAC address to put into the variable | |
185f812c | 223 | * Return: 0 if OK, other value on error |
5350bc8f | 224 | */ |
fd1e959e | 225 | int eth_env_set_enetaddr_by_index(const char *base_name, int index, |
5350bc8f RQ |
226 | uchar *enetaddr); |
227 | ||
228 | ||
d4a37553 M |
229 | /* |
230 | * Initialize USB ethernet device with CONFIG_DM_ETH | |
231 | * Returns: | |
232 | * 0 is success, non-zero is error status. | |
233 | */ | |
234 | int usb_ether_init(void); | |
235 | ||
7616e785 SG |
236 | /* |
237 | * Get the hardware address for an ethernet interface . | |
238 | * Args: | |
239 | * base_name - base name for device (normally "eth") | |
240 | * index - device index number (0 for first) | |
241 | * enetaddr - returns 6 byte hardware address | |
242 | * Returns: | |
243 | * Return true if the address is valid. | |
244 | */ | |
35affd7a | 245 | int eth_env_get_enetaddr_by_index(const char *base_name, int index, |
ff997432 | 246 | uchar *enetaddr); |
5dc0cf68 | 247 | |
d2eaec60 | 248 | int eth_init(void); /* Initialize the device */ |
ff997432 | 249 | int eth_send(void *packet, int length); /* Send a packet */ |
23cd1385 | 250 | |
0efe1bcf | 251 | #if defined(CONFIG_API) || defined(CONFIG_EFI_LOADER) |
ff997432 | 252 | int eth_receive(void *packet, int length); /* Receive a packet*/ |
db288a96 | 253 | extern void (*push_packet)(void *packet, int length); |
f85b6071 | 254 | #endif |
ff997432 JH |
255 | int eth_rx(void); /* Check for received packets */ |
256 | void eth_halt(void); /* stop SCC */ | |
84eb1fba | 257 | const char *eth_get_name(void); /* get name of current device */ |
049a95a7 | 258 | int eth_mcast_join(struct in_addr mcast_addr, int join); |
2d966958 WD |
259 | |
260 | /**********************************************************************/ | |
261 | /* | |
262 | * Protocol headers. | |
263 | */ | |
264 | ||
265 | /* | |
266 | * Ethernet header | |
267 | */ | |
cb487f56 JH |
268 | |
269 | struct ethernet_hdr { | |
a40db6d5 | 270 | u8 et_dest[ARP_HLEN]; /* Destination node */ |
271 | u8 et_src[ARP_HLEN]; /* Source node */ | |
272 | u16 et_protlen; /* Protocol or length */ | |
704f3acf | 273 | } __attribute__((packed)); |
cb487f56 JH |
274 | |
275 | /* Ethernet header size */ | |
276 | #define ETHER_HDR_SIZE (sizeof(struct ethernet_hdr)) | |
277 | ||
a7c3d5e2 BM |
278 | #define ETH_FCS_LEN 4 /* Octets in the FCS */ |
279 | ||
cb487f56 | 280 | struct e802_hdr { |
a40db6d5 | 281 | u8 et_dest[ARP_HLEN]; /* Destination node */ |
282 | u8 et_src[ARP_HLEN]; /* Source node */ | |
283 | u16 et_protlen; /* Protocol or length */ | |
284 | u8 et_dsap; /* 802 DSAP */ | |
285 | u8 et_ssap; /* 802 SSAP */ | |
286 | u8 et_ctl; /* 802 control */ | |
287 | u8 et_snap1; /* SNAP */ | |
717234e0 ST |
288 | u8 et_snap2; |
289 | u8 et_snap3; | |
a40db6d5 | 290 | u16 et_prot; /* 802 protocol */ |
704f3acf | 291 | } __attribute__((packed)); |
2d966958 | 292 | |
da5ebe2c | 293 | /* 802 + SNAP + ethernet header size */ |
cb487f56 | 294 | #define E802_HDR_SIZE (sizeof(struct e802_hdr)) |
a3d991bd WD |
295 | |
296 | /* | |
da5ebe2c | 297 | * Virtual LAN Ethernet header |
a3d991bd | 298 | */ |
c68cca35 | 299 | struct vlan_ethernet_hdr { |
a40db6d5 | 300 | u8 vet_dest[ARP_HLEN]; /* Destination node */ |
301 | u8 vet_src[ARP_HLEN]; /* Source node */ | |
302 | u16 vet_vlan_type; /* PROT_VLAN */ | |
303 | u16 vet_tag; /* TAG of VLAN */ | |
304 | u16 vet_type; /* protocol type */ | |
704f3acf | 305 | } __attribute__((packed)); |
a3d991bd | 306 | |
c68cca35 JH |
307 | /* VLAN Ethernet header size */ |
308 | #define VLAN_ETHER_HDR_SIZE (sizeof(struct vlan_ethernet_hdr)) | |
a3d991bd | 309 | |
2d966958 WD |
310 | #define PROT_IP 0x0800 /* IP protocol */ |
311 | #define PROT_ARP 0x0806 /* IP ARP protocol */ | |
d8970dae | 312 | #define PROT_WOL 0x0842 /* ether-wake WoL protocol */ |
2d966958 | 313 | #define PROT_RARP 0x8035 /* IP ARP protocol */ |
a3d991bd | 314 | #define PROT_VLAN 0x8100 /* IEEE 802.1q protocol */ |
99d4c6d3 SR |
315 | #define PROT_IPV6 0x86dd /* IPv6 over bluebook */ |
316 | #define PROT_PPP_SES 0x8864 /* PPPoE session messages */ | |
f641a8ac | 317 | #define PROT_NCSI 0x88f8 /* NC-SI control packets */ |
2d966958 WD |
318 | |
319 | #define IPPROTO_ICMP 1 /* Internet Control Message Protocol */ | |
a3bf193b | 320 | #define IPPROTO_TCP 6 /* Transmission Control Protocol */ |
2d966958 WD |
321 | #define IPPROTO_UDP 17 /* User Datagram Protocol */ |
322 | ||
323 | /* | |
c5c59df0 | 324 | * Internet Protocol (IP) header. |
2d966958 | 325 | */ |
c5c59df0 | 326 | struct ip_hdr { |
717234e0 ST |
327 | u8 ip_hl_v; /* header length and version */ |
328 | u8 ip_tos; /* type of service */ | |
329 | u16 ip_len; /* total length */ | |
330 | u16 ip_id; /* identification */ | |
331 | u16 ip_off; /* fragment offset field */ | |
332 | u8 ip_ttl; /* time to live */ | |
333 | u8 ip_p; /* protocol */ | |
334 | u16 ip_sum; /* checksum */ | |
049a95a7 JH |
335 | struct in_addr ip_src; /* Source IP address */ |
336 | struct in_addr ip_dst; /* Destination IP address */ | |
704f3acf | 337 | } __attribute__((packed)); |
2d966958 | 338 | |
e0c07b86 PT |
339 | #define IP_OFFS 0x1fff /* ip offset *= 8 */ |
340 | #define IP_FLAGS 0xe000 /* first 3 bits */ | |
341 | #define IP_FLAGS_RES 0x8000 /* reserved */ | |
342 | #define IP_FLAGS_DFRAG 0x4000 /* don't fragments */ | |
343 | #define IP_FLAGS_MFRAG 0x2000 /* more fragments */ | |
344 | ||
c5c59df0 JH |
345 | #define IP_HDR_SIZE (sizeof(struct ip_hdr)) |
346 | ||
b85d130e FE |
347 | #define IP_MIN_FRAG_DATAGRAM_SIZE (IP_HDR_SIZE + 8) |
348 | ||
c5c59df0 JH |
349 | /* |
350 | * Internet Protocol (IP) + UDP header. | |
351 | */ | |
352 | struct ip_udp_hdr { | |
717234e0 ST |
353 | u8 ip_hl_v; /* header length and version */ |
354 | u8 ip_tos; /* type of service */ | |
355 | u16 ip_len; /* total length */ | |
356 | u16 ip_id; /* identification */ | |
357 | u16 ip_off; /* fragment offset field */ | |
358 | u8 ip_ttl; /* time to live */ | |
359 | u8 ip_p; /* protocol */ | |
360 | u16 ip_sum; /* checksum */ | |
049a95a7 JH |
361 | struct in_addr ip_src; /* Source IP address */ |
362 | struct in_addr ip_dst; /* Destination IP address */ | |
717234e0 ST |
363 | u16 udp_src; /* UDP source port */ |
364 | u16 udp_dst; /* UDP destination port */ | |
365 | u16 udp_len; /* Length of UDP packet */ | |
366 | u16 udp_xsum; /* Checksum */ | |
704f3acf | 367 | } __attribute__((packed)); |
2d966958 | 368 | |
594c26f8 | 369 | #define IP_UDP_HDR_SIZE (sizeof(struct ip_udp_hdr)) |
c5c59df0 | 370 | #define UDP_HDR_SIZE (IP_UDP_HDR_SIZE - IP_HDR_SIZE) |
2d966958 WD |
371 | |
372 | /* | |
373 | * Address Resolution Protocol (ARP) header. | |
374 | */ | |
738853bb | 375 | struct arp_hdr { |
717234e0 | 376 | u16 ar_hrd; /* Format of hardware address */ |
2d966958 | 377 | # define ARP_ETHER 1 /* Ethernet hardware address */ |
717234e0 ST |
378 | u16 ar_pro; /* Format of protocol address */ |
379 | u8 ar_hln; /* Length of hardware address */ | |
717234e0 | 380 | u8 ar_pln; /* Length of protocol address */ |
674bb249 | 381 | # define ARP_PLEN 4 |
717234e0 | 382 | u16 ar_op; /* Operation */ |
2d966958 WD |
383 | # define ARPOP_REQUEST 1 /* Request to resolve address */ |
384 | # define ARPOP_REPLY 2 /* Response to previous request */ | |
385 | ||
386 | # define RARPOP_REQUEST 3 /* Request to resolve address */ | |
387 | # define RARPOP_REPLY 4 /* Response to previous request */ | |
388 | ||
389 | /* | |
8bde7f77 WD |
390 | * The remaining fields are variable in size, according to |
391 | * the sizes above, and are defined as appropriate for | |
392 | * specific hardware/protocol combinations. | |
2d966958 | 393 | */ |
717234e0 | 394 | u8 ar_data[0]; |
674bb249 JH |
395 | #define ar_sha ar_data[0] |
396 | #define ar_spa ar_data[ARP_HLEN] | |
397 | #define ar_tha ar_data[ARP_HLEN + ARP_PLEN] | |
398 | #define ar_tpa ar_data[ARP_HLEN + ARP_PLEN + ARP_HLEN] | |
2d966958 | 399 | #if 0 |
717234e0 ST |
400 | u8 ar_sha[]; /* Sender hardware address */ |
401 | u8 ar_spa[]; /* Sender protocol address */ | |
402 | u8 ar_tha[]; /* Target hardware address */ | |
403 | u8 ar_tpa[]; /* Target protocol address */ | |
2d966958 | 404 | #endif /* 0 */ |
704f3acf | 405 | } __attribute__((packed)); |
2d966958 WD |
406 | |
407 | #define ARP_HDR_SIZE (8+20) /* Size assuming ethernet */ | |
408 | ||
409 | /* | |
410 | * ICMP stuff (just enough to handle (host) redirect messages) | |
411 | */ | |
53677ef1 | 412 | #define ICMP_ECHO_REPLY 0 /* Echo reply */ |
4793ee65 | 413 | #define ICMP_NOT_REACH 3 /* Detination unreachable */ |
2d966958 | 414 | #define ICMP_REDIRECT 5 /* Redirect (change route) */ |
73a8b27c | 415 | #define ICMP_ECHO_REQUEST 8 /* Echo request */ |
2d966958 WD |
416 | |
417 | /* Codes for REDIRECT. */ | |
418 | #define ICMP_REDIR_NET 0 /* Redirect Net */ | |
419 | #define ICMP_REDIR_HOST 1 /* Redirect Host */ | |
420 | ||
4793ee65 SG |
421 | /* Codes for NOT_REACH */ |
422 | #define ICMP_NOT_REACH_PORT 3 /* Port unreachable */ | |
423 | ||
e0a63079 | 424 | struct icmp_hdr { |
717234e0 ST |
425 | u8 type; |
426 | u8 code; | |
427 | u16 checksum; | |
2d966958 WD |
428 | union { |
429 | struct { | |
717234e0 ST |
430 | u16 id; |
431 | u16 sequence; | |
2d966958 | 432 | } echo; |
5917e7d1 | 433 | u32 gateway; |
2d966958 | 434 | struct { |
717234e0 ST |
435 | u16 unused; |
436 | u16 mtu; | |
2d966958 | 437 | } frag; |
717234e0 | 438 | u8 data[0]; |
2d966958 | 439 | } un; |
704f3acf | 440 | } __attribute__((packed)); |
2d966958 | 441 | |
e0a63079 JH |
442 | #define ICMP_HDR_SIZE (sizeof(struct icmp_hdr)) |
443 | #define IP_ICMP_HDR_SIZE (IP_HDR_SIZE + ICMP_HDR_SIZE) | |
2d966958 | 444 | |
2d966958 | 445 | /* |
700877a6 SA |
446 | * Maximum packet size; used to allocate packet storage. Use |
447 | * the maxium Ethernet frame size as specified by the Ethernet | |
448 | * standard including the 802.1Q tag (VLAN tagging). | |
449 | * maximum packet size = 1522 | |
2d966958 WD |
450 | * maximum packet size and multiple of 32 bytes = 1536 |
451 | */ | |
700877a6 | 452 | #define PKTSIZE 1522 |
fc054d56 | 453 | #ifndef CONFIG_DM_DSA |
2d966958 | 454 | #define PKTSIZE_ALIGN 1536 |
fc054d56 CM |
455 | #else |
456 | /* Maximum DSA tagging overhead (headroom and/or tailroom) */ | |
457 | #define DSA_MAX_OVR 256 | |
458 | #define PKTSIZE_ALIGN (1536 + DSA_MAX_OVR) | |
459 | #endif | |
2d966958 WD |
460 | |
461 | /* | |
462 | * Maximum receive ring size; that is, the number of packets | |
463 | * we can buffer before overflow happens. Basically, this just | |
464 | * needs to be enough to prevent a packet being discarded while | |
465 | * we are processing the previous one. | |
466 | */ | |
467 | #define RINGSZ 4 | |
468 | #define RINGSZ_LOG2 2 | |
469 | ||
470 | /**********************************************************************/ | |
471 | /* | |
472 | * Globals. | |
473 | * | |
474 | * Note: | |
475 | * | |
049a95a7 | 476 | * All variables of type struct in_addr are stored in NETWORK byte order |
2d966958 WD |
477 | * (big endian). |
478 | */ | |
479 | ||
480 | /* net.c */ | |
481 | /** BOOTP EXTENTIONS **/ | |
049a95a7 JH |
482 | extern struct in_addr net_gateway; /* Our gateway IP address */ |
483 | extern struct in_addr net_netmask; /* Our subnet mask (0 = unknown) */ | |
484 | /* Our Domain Name Server (0 = unknown) */ | |
485 | extern struct in_addr net_dns_server; | |
1fe80d79 | 486 | #if defined(CONFIG_BOOTP_DNS2) |
049a95a7 JH |
487 | /* Our 2nd Domain Name Server (0 = unknown) */ |
488 | extern struct in_addr net_dns_server2; | |
fe389a82 | 489 | #endif |
586cbe51 JH |
490 | extern char net_nis_domain[32]; /* Our IS domain */ |
491 | extern char net_hostname[32]; /* Our hostname */ | |
5e6e41b3 AK |
492 | #ifdef CONFIG_NET |
493 | extern char net_root_path[CONFIG_BOOTP_MAX_ROOT_PATH_LEN]; /* Our root path */ | |
494 | #endif | |
a0245818 SE |
495 | /* Indicates whether the pxe path prefix / config file was specified in dhcp option */ |
496 | extern char *pxelinux_configfile; | |
2d966958 | 497 | /** END OF BOOTP EXTENTIONS **/ |
a40db6d5 | 498 | extern u8 net_ethaddr[ARP_HLEN]; /* Our ethernet address */ |
499 | extern u8 net_server_ethaddr[ARP_HLEN]; /* Boot server enet address */ | |
049a95a7 JH |
500 | extern struct in_addr net_ip; /* Our IP addr (0 = unknown) */ |
501 | extern struct in_addr net_server_ip; /* Server IP addr (0 = unknown) */ | |
1203fcce | 502 | extern uchar *net_tx_packet; /* THE transmit packet */ |
2a504df0 | 503 | extern uchar *net_rx_packets[PKTBUFSRX]; /* Receive packets */ |
1203fcce JH |
504 | extern uchar *net_rx_packet; /* Current receive packet */ |
505 | extern int net_rx_packet_len; /* Current rx packet length */ | |
a40db6d5 | 506 | extern const u8 net_bcast_ethaddr[ARP_HLEN]; /* Ethernet broadcast address */ |
507 | extern const u8 net_null_ethaddr[ARP_HLEN]; | |
2d966958 | 508 | |
b28e28bb JH |
509 | #define VLAN_NONE 4095 /* untagged */ |
510 | #define VLAN_IDMASK 0x0fff /* mask of valid vlan id */ | |
4fd5055f JH |
511 | extern ushort net_our_vlan; /* Our VLAN */ |
512 | extern ushort net_native_vlan; /* Our Native VLAN */ | |
a3d991bd | 513 | |
bc0571fc | 514 | extern int net_restart_wrap; /* Tried all network devices */ |
2d966958 | 515 | |
e4bf0c5c | 516 | enum proto_t { |
a0245818 | 517 | BOOTP, RARP, ARP, TFTPGET, DHCP, DHCP6, PING, PING6, DNS, NFS, CDP, |
443d3191 | 518 | NETCONS, SNTP, TFTPSRV, TFTPPUT, LINKLOCAL, FASTBOOT_UDP, FASTBOOT_TCP, |
6de98b60 | 519 | WOL, UDP, NCSI, WGET, RS |
e4bf0c5c | 520 | }; |
2d966958 | 521 | |
11a69ff8 | 522 | extern char net_boot_file_name[1024];/* Boot File name */ |
449312c1 AG |
523 | /* Indicates whether the file name was specified on the command line */ |
524 | extern bool net_boot_file_name_explicit; | |
1411157d JH |
525 | /* The actual transferred size of the bootfile (in bytes) */ |
526 | extern u32 net_boot_file_size; | |
527 | /* Boot file size in blocks as reported by the DHCP server */ | |
528 | extern u32 net_boot_file_expected_size_in_blocks; | |
2d966958 | 529 | |
1a32bf41 | 530 | #if defined(CONFIG_CMD_DNS) |
786eac5f JH |
531 | extern char *net_dns_resolve; /* The host to resolve */ |
532 | extern char *net_dns_env_var; /* the env var to put the ip into */ | |
1a32bf41 RG |
533 | #endif |
534 | ||
639221c7 | 535 | #if defined(CONFIG_CMD_PING) |
049a95a7 | 536 | extern struct in_addr net_ping_ip; /* the ip address to ping */ |
73a8b27c WD |
537 | #endif |
538 | ||
639221c7 | 539 | #if defined(CONFIG_CMD_CDP) |
a3d991bd | 540 | /* when CDP completes these hold the return values */ |
6aede5b7 JH |
541 | extern ushort cdp_native_vlan; /* CDP returned native VLAN */ |
542 | extern ushort cdp_appliance_vlan; /* CDP returned appliance VLAN */ | |
17351883 JH |
543 | |
544 | /* | |
545 | * Check for a CDP packet by examining the received MAC address field | |
546 | */ | |
0adb5b76 | 547 | static inline int is_cdp_packet(const uchar *ethaddr) |
17351883 | 548 | { |
a40db6d5 | 549 | extern const u8 net_cdp_ethaddr[ARP_HLEN]; |
17351883 | 550 | |
a40db6d5 | 551 | return memcmp(ethaddr, net_cdp_ethaddr, ARP_HLEN) == 0; |
17351883 | 552 | } |
a3d991bd WD |
553 | #endif |
554 | ||
639221c7 | 555 | #if defined(CONFIG_CMD_SNTP) |
049a95a7 | 556 | extern struct in_addr net_ntp_server; /* the ip address to NTP */ |
bc0571fc | 557 | extern int net_ntp_time_offset; /* offset time from UTC */ |
ea287deb WD |
558 | #endif |
559 | ||
2d966958 | 560 | /* Initialize the network adapter */ |
c3f0278e | 561 | int net_init(void); |
bc0571fc | 562 | int net_loop(enum proto_t); |
2d966958 WD |
563 | |
564 | /* Load failed. Start again. */ | |
bc0571fc | 565 | int net_start_again(void); |
2d966958 | 566 | |
a3d991bd | 567 | /* Get size of the ethernet header when we send */ |
1203fcce | 568 | int net_eth_hdr_size(void); |
a3d991bd WD |
569 | |
570 | /* Set ethernet header; returns the size of the header */ | |
1203fcce | 571 | int net_set_ether(uchar *xet, const uchar *dest_ethaddr, uint prot); |
ff997432 | 572 | int net_update_ether(struct ethernet_hdr *et, uchar *addr, uint prot); |
2d966958 WD |
573 | |
574 | /* Set IP header */ | |
5d457ecb DH |
575 | void net_set_ip_header(uchar *pkt, struct in_addr dest, struct in_addr source, |
576 | u16 pkt_len, u8 proto); | |
049a95a7 | 577 | void net_set_udp_header(uchar *pkt, struct in_addr dest, int dport, |
4b11c916 | 578 | int sport, int len); |
2d966958 | 579 | |
9b0e35cb SG |
580 | /** |
581 | * compute_ip_checksum() - Compute IP checksum | |
582 | * | |
583 | * @addr: Address to check (must be 16-bit aligned) | |
584 | * @nbytes: Number of bytes to check (normally a multiple of 2) | |
185f812c | 585 | * Return: 16-bit IP checksum |
9b0e35cb SG |
586 | */ |
587 | unsigned compute_ip_checksum(const void *addr, unsigned nbytes); | |
588 | ||
589 | /** | |
590 | * add_ip_checksums() - add two IP checksums | |
591 | * | |
592 | * @offset: Offset of first sum (if odd we do a byte-swap) | |
593 | * @sum: First checksum | |
594 | * @new_sum: New checksum to add | |
185f812c | 595 | * Return: updated 16-bit IP checksum |
9b0e35cb SG |
596 | */ |
597 | unsigned add_ip_checksums(unsigned offset, unsigned sum, unsigned new_sum); | |
598 | ||
599 | /** | |
600 | * ip_checksum_ok() - check if a checksum is correct | |
601 | * | |
602 | * This works by making sure the checksum sums to 0 | |
603 | * | |
604 | * @addr: Address to check (must be 16-bit aligned) | |
605 | * @nbytes: Number of bytes to check (normally a multiple of 2) | |
185f812c | 606 | * Return: true if the checksum matches, false if not |
9b0e35cb SG |
607 | */ |
608 | int ip_checksum_ok(const void *addr, unsigned nbytes); | |
609 | ||
d280d3f4 | 610 | /* Callbacks */ |
ff997432 JH |
611 | rxhand_f *net_get_udp_handler(void); /* Get UDP RX packet handler */ |
612 | void net_set_udp_handler(rxhand_f *); /* Set UDP RX packet handler */ | |
613 | rxhand_f *net_get_arp_handler(void); /* Get ARP RX packet handler */ | |
614 | void net_set_arp_handler(rxhand_f *); /* Set ARP RX packet handler */ | |
3f02c98b | 615 | bool arp_is_waiting(void); /* Waiting for ARP reply? */ |
ff997432 | 616 | void net_set_icmp_handler(rxhand_icmp_f *f); /* Set ICMP RX handler */ |
bc0571fc | 617 | void net_set_timeout_handler(ulong, thand_f *);/* Set timeout handler */ |
2d966958 | 618 | |
22f6e99d JH |
619 | /* Network loop state */ |
620 | enum net_loop_state { | |
621 | NETLOOP_CONTINUE, | |
622 | NETLOOP_RESTART, | |
623 | NETLOOP_SUCCESS, | |
624 | NETLOOP_FAIL | |
625 | }; | |
06370590 KP |
626 | extern enum net_loop_state net_state; |
627 | ||
22f6e99d JH |
628 | static inline void net_set_state(enum net_loop_state state) |
629 | { | |
4ef8d53c | 630 | debug_cond(DEBUG_INT_STATE, "--- NetState set to %d\n", state); |
22f6e99d JH |
631 | net_state = state; |
632 | } | |
633 | ||
ac3f26cc JH |
634 | /* |
635 | * net_get_async_tx_pkt_buf - Get a packet buffer that is not in use for | |
636 | * sending an asynchronous reply | |
637 | * | |
638 | * returns - ptr to packet buffer | |
639 | */ | |
640 | uchar * net_get_async_tx_pkt_buf(void); | |
641 | ||
e94070c4 | 642 | /* Transmit a packet */ |
1203fcce | 643 | static inline void net_send_packet(uchar *pkt, int len) |
adf5d93e | 644 | { |
798962ce SA |
645 | if (DEBUG_NET_PKT_TRACE) |
646 | print_hex_dump_bytes("tx: ", DUMP_PREFIX_OFFSET, pkt, len); | |
60304592 | 647 | /* Currently no way to return errors from eth_send() */ |
adf5d93e JH |
648 | (void) eth_send(pkt, len); |
649 | } | |
2d966958 | 650 | |
a3bf193b YCLP |
651 | /** |
652 | * net_send_ip_packet() - Transmit "net_tx_packet" as UDP or TCP packet, | |
653 | * send ARP request if needed (ether will be populated) | |
654 | * @ether: Raw packet buffer | |
655 | * @dest: IP address to send the datagram to | |
656 | * @dport: Destination UDP port | |
657 | * @sport: Source UDP port | |
658 | * @payload_len: Length of data after the UDP header | |
659 | * @action: TCP action to be performed | |
660 | * @tcp_seq_num: TCP sequence number of this transmission | |
661 | * @tcp_ack_num: TCP stream acknolegement number | |
206d07fd | 662 | * |
a3bf193b | 663 | * Return: 0 on success, other value on failure |
206d07fd | 664 | */ |
5d457ecb DH |
665 | int net_send_ip_packet(uchar *ether, struct in_addr dest, int dport, int sport, |
666 | int payload_len, int proto, u8 action, u32 tcp_seq_num, | |
667 | u32 tcp_ack_num); | |
a3bf193b YCLP |
668 | /** |
669 | * net_send_tcp_packet() - Transmit TCP packet. | |
670 | * @payload_len: length of payload | |
671 | * @dport: Destination TCP port | |
672 | * @sport: Source TCP port | |
673 | * @action: TCP action to be performed | |
674 | * @tcp_seq_num: TCP sequence number of this transmission | |
675 | * @tcp_ack_num: TCP stream acknolegement number | |
676 | * | |
677 | * Return: 0 on success, other value on failure | |
678 | */ | |
679 | int net_send_tcp_packet(int payload_len, int dport, int sport, u8 action, | |
680 | u32 tcp_seq_num, u32 tcp_ack_num); | |
1203fcce | 681 | int net_send_udp_packet(uchar *ether, struct in_addr dest, int dport, |
206d07fd | 682 | int sport, int payload_len); |
73a8b27c | 683 | |
2d966958 | 684 | /* Processes a received packet */ |
2a504df0 | 685 | void net_process_received_packet(uchar *in_packet, int len); |
2d966958 | 686 | |
99761e53 | 687 | #if defined(CONFIG_NETCONSOLE) && !defined(CONFIG_SPL_BUILD) |
6a38a5f3 | 688 | void nc_start(void); |
049a95a7 | 689 | int nc_input_packet(uchar *pkt, struct in_addr src_ip, unsigned dest_port, |
8a0eccb1 | 690 | unsigned src_port, unsigned len); |
48522bb5 JH |
691 | #endif |
692 | ||
92163873 | 693 | static __always_inline int eth_is_on_demand_init(void) |
f8be7d65 | 694 | { |
99761e53 | 695 | #if defined(CONFIG_NETCONSOLE) && !defined(CONFIG_SPL_BUILD) |
f8be7d65 JH |
696 | extern enum proto_t net_loop_last_protocol; |
697 | ||
698 | return net_loop_last_protocol != NETCONS; | |
699 | #else | |
700 | return 1; | |
701 | #endif | |
702 | } | |
703 | ||
704 | static inline void eth_set_last_protocol(int protocol) | |
705 | { | |
99761e53 | 706 | #if defined(CONFIG_NETCONSOLE) && !defined(CONFIG_SPL_BUILD) |
f8be7d65 JH |
707 | extern enum proto_t net_loop_last_protocol; |
708 | ||
709 | net_loop_last_protocol = protocol; | |
710 | #endif | |
711 | } | |
712 | ||
e4a3d57d SG |
713 | /* |
714 | * Check if autoload is enabled. If so, use either NFS or TFTP to download | |
715 | * the boot file. | |
716 | */ | |
717 | void net_auto_load(void); | |
718 | ||
2d966958 WD |
719 | /* |
720 | * The following functions are a bit ugly, but necessary to deal with | |
721 | * alignment restrictions on ARM. | |
722 | * | |
723 | * We're using inline functions, which had the smallest memory | |
724 | * footprint in our tests. | |
725 | */ | |
726 | /* return IP *in network byteorder* */ | |
049a95a7 | 727 | static inline struct in_addr net_read_ip(void *from) |
2d966958 | 728 | { |
049a95a7 | 729 | struct in_addr ip; |
b28e28bb JH |
730 | |
731 | memcpy((void *)&ip, (void *)from, sizeof(ip)); | |
2d966958 WD |
732 | return ip; |
733 | } | |
734 | ||
735 | /* return ulong *in network byteorder* */ | |
bbfc5627 | 736 | static inline u32 net_read_u32(void *from) |
2d966958 | 737 | { |
5917e7d1 | 738 | u32 l; |
b28e28bb JH |
739 | |
740 | memcpy((void *)&l, (void *)from, sizeof(l)); | |
2d966958 WD |
741 | return l; |
742 | } | |
743 | ||
744 | /* write IP *in network byteorder* */ | |
049a95a7 | 745 | static inline void net_write_ip(void *to, struct in_addr ip) |
2d966958 | 746 | { |
b28e28bb | 747 | memcpy(to, (void *)&ip, sizeof(ip)); |
2d966958 WD |
748 | } |
749 | ||
750 | /* copy IP */ | |
049a95a7 | 751 | static inline void net_copy_ip(void *to, void *from) |
2d966958 | 752 | { |
049a95a7 | 753 | memcpy((void *)to, from, sizeof(struct in_addr)); |
2d966958 WD |
754 | } |
755 | ||
756 | /* copy ulong */ | |
bbfc5627 | 757 | static inline void net_copy_u32(void *to, void *from) |
2d966958 | 758 | { |
5917e7d1 | 759 | memcpy((void *)to, (void *)from, sizeof(u32)); |
2d966958 WD |
760 | } |
761 | ||
50cca8b9 | 762 | /** |
0adb5b76 | 763 | * is_zero_ethaddr - Determine if give Ethernet address is all zeros. |
50cca8b9 MR |
764 | * @addr: Pointer to a six-byte array containing the Ethernet address |
765 | * | |
766 | * Return true if the address is all zeroes. | |
767 | */ | |
0adb5b76 | 768 | static inline int is_zero_ethaddr(const u8 *addr) |
50cca8b9 MR |
769 | { |
770 | return !(addr[0] | addr[1] | addr[2] | addr[3] | addr[4] | addr[5]); | |
771 | } | |
772 | ||
773 | /** | |
0adb5b76 | 774 | * is_multicast_ethaddr - Determine if the Ethernet address is a multicast. |
50cca8b9 MR |
775 | * @addr: Pointer to a six-byte array containing the Ethernet address |
776 | * | |
777 | * Return true if the address is a multicast address. | |
778 | * By definition the broadcast address is also a multicast address. | |
779 | */ | |
0adb5b76 | 780 | static inline int is_multicast_ethaddr(const u8 *addr) |
50cca8b9 | 781 | { |
b28e28bb | 782 | return 0x01 & addr[0]; |
50cca8b9 MR |
783 | } |
784 | ||
23cd1385 | 785 | /* |
0adb5b76 | 786 | * is_broadcast_ethaddr - Determine if the Ethernet address is broadcast |
23cd1385 RB |
787 | * @addr: Pointer to a six-byte array containing the Ethernet address |
788 | * | |
789 | * Return true if the address is the broadcast address. | |
790 | */ | |
0adb5b76 | 791 | static inline int is_broadcast_ethaddr(const u8 *addr) |
23cd1385 | 792 | { |
b28e28bb JH |
793 | return (addr[0] & addr[1] & addr[2] & addr[3] & addr[4] & addr[5]) == |
794 | 0xff; | |
23cd1385 RB |
795 | } |
796 | ||
797 | /* | |
0adb5b76 | 798 | * is_valid_ethaddr - Determine if the given Ethernet address is valid |
75edebe3 MF |
799 | * @addr: Pointer to a six-byte array containing the Ethernet address |
800 | * | |
801 | * Check that the Ethernet address (MAC) is not 00:00:00:00:00:00, is not | |
802 | * a multicast address, and is not FF:FF:FF:FF:FF:FF. | |
803 | * | |
804 | * Return true if the address is valid. | |
805 | */ | |
0adb5b76 | 806 | static inline int is_valid_ethaddr(const u8 *addr) |
75edebe3 MF |
807 | { |
808 | /* FF:FF:FF:FF:FF:FF is a multicast address so we don't need to | |
809 | * explicitly check for it here. */ | |
0adb5b76 | 810 | return !is_multicast_ethaddr(addr) && !is_zero_ethaddr(addr); |
75edebe3 MF |
811 | } |
812 | ||
da384a9d | 813 | /** |
0adb5b76 | 814 | * net_random_ethaddr - Generate software assigned random Ethernet address |
da384a9d MY |
815 | * @addr: Pointer to a six-byte array containing the Ethernet address |
816 | * | |
817 | * Generate a random Ethernet address (MAC) that is not multicast | |
818 | * and has the local assigned bit set. | |
819 | */ | |
0adb5b76 | 820 | static inline void net_random_ethaddr(uchar *addr) |
da384a9d MY |
821 | { |
822 | int i; | |
12c2a310 | 823 | unsigned int seed = get_ticks(); |
da384a9d MY |
824 | |
825 | for (i = 0; i < 6; i++) | |
826 | addr[i] = rand_r(&seed); | |
827 | ||
828 | addr[0] &= 0xfe; /* clear multicast bit */ | |
829 | addr[0] |= 0x02; /* set local assignment bit (IEEE802) */ | |
830 | } | |
831 | ||
fb8977c5 JH |
832 | /** |
833 | * string_to_enetaddr() - Parse a MAC address | |
834 | * | |
835 | * Convert a string MAC address | |
836 | * | |
837 | * Implemented in lib/net_utils.c (built unconditionally) | |
838 | * | |
839 | * @addr: MAC address in aa:bb:cc:dd:ee:ff format, where each part is a 2-digit | |
840 | * hex value | |
841 | * @enetaddr: Place to put MAC address (6 bytes) | |
842 | */ | |
843 | void string_to_enetaddr(const char *addr, uint8_t *enetaddr); | |
844 | ||
2d966958 | 845 | /* Convert an IP address to a string */ |
049a95a7 | 846 | void ip_to_string(struct in_addr x, char *s); |
2d966958 | 847 | |
8d5babb4 SG |
848 | /** |
849 | * string_to_ip() - Convert a string to ip address | |
850 | * | |
d724321f JH |
851 | * Implemented in lib/net_utils.c (built unconditionally) |
852 | * | |
853 | * @s: Input string to parse | |
854 | * @return: in_addr struct containing the parsed IP address | |
8d5babb4 | 855 | */ |
049a95a7 | 856 | struct in_addr string_to_ip(const char *s); |
73a8b27c | 857 | |
a3d991bd | 858 | /* Convert a VLAN id to a string */ |
4fd5055f | 859 | void vlan_to_string(ushort x, char *s); |
a3d991bd WD |
860 | |
861 | /* Convert a string to a vlan id */ | |
4fd5055f | 862 | ushort string_to_vlan(const char *s); |
a3d991bd | 863 | |
a3d991bd | 864 | /* read a VLAN id from an environment variable */ |
723806cc | 865 | ushort env_get_vlan(char *); |
a3d991bd | 866 | |
2d966958 | 867 | /* copy a filename (allow for "..." notation, limit length) */ |
ff997432 | 868 | void copy_filename(char *dst, const char *src, int size); |
2d966958 | 869 | |
3a66fcb7 JH |
870 | /* check if serverip is specified in filename from the command line */ |
871 | int is_serverip_in_cmd(void); | |
872 | ||
6ab12830 JH |
873 | /** |
874 | * net_parse_bootfile - Parse the bootfile env var / cmd line param | |
875 | * | |
876 | * @param ipaddr - a pointer to the ipaddr to populate if included in bootfile | |
877 | * @param filename - a pointer to the string to save the filename part | |
878 | * @param max_len - The longest - 1 that the filename part can be | |
879 | * | |
880 | * return 1 if parsed, 0 if bootfile is empty | |
881 | */ | |
882 | int net_parse_bootfile(struct in_addr *ipaddr, char *filename, int max_len); | |
883 | ||
c7ff5528 LM |
884 | /** |
885 | * update_tftp - Update firmware over TFTP (via DFU) | |
886 | * | |
887 | * This function updates board's firmware via TFTP | |
888 | * | |
889 | * @param addr - memory address where data is stored | |
890 | * @param interface - the DFU medium name - e.g. "mmc" | |
891 | * @param devstring - the DFU medium number - e.g. "1" | |
892 | * | |
185f812c | 893 | * Return: - 0 on success, other value on failure |
c7ff5528 LM |
894 | */ |
895 | int update_tftp(ulong addr, char *interface, char *devstring); | |
ea5427e2 | 896 | |
8d5babb4 SG |
897 | /** |
898 | * env_get_ip() - Convert an environment value to to an ip address | |
899 | * | |
900 | * @var: Environment variable to convert. The value of this variable must be | |
901 | * in the format format a.b.c.d, where each value is a decimal number from | |
902 | * 0 to 255 | |
185f812c | 903 | * Return: IP address, or 0 if invalid |
8d5babb4 SG |
904 | */ |
905 | static inline struct in_addr env_get_ip(char *var) | |
906 | { | |
907 | return string_to_ip(env_get(var)); | |
908 | } | |
5e6267af SG |
909 | |
910 | /** | |
911 | * reset_phy() - Reset the Ethernet PHY | |
912 | * | |
913 | * This should be implemented by boards if CONFIG_RESET_PHY_R is enabled | |
914 | */ | |
915 | void reset_phy(void); | |
916 | ||
70dd8865 SG |
917 | #if CONFIG_IS_ENABLED(NET) |
918 | /** | |
919 | * eth_set_enable_bootdevs() - Enable or disable binding of Ethernet bootdevs | |
920 | * | |
921 | * These get in the way of bootstd testing, so are normally disabled by tests. | |
922 | * This provide control of this setting. It only affects binding of Ethernet | |
923 | * devices, so if that has already happened, this flag does nothing. | |
924 | * | |
925 | * @enable: true to enable binding of bootdevs when binding new Ethernet | |
926 | * devices, false to disable it | |
927 | */ | |
928 | void eth_set_enable_bootdevs(bool enable); | |
929 | #else | |
930 | static inline void eth_set_enable_bootdevs(bool enable) {} | |
931 | #endif | |
932 | ||
8cf18da1 MK |
933 | /** |
934 | * wget_with_dns() - runs dns host IP address resulution before wget | |
935 | * | |
936 | * @dst_addr: destination address to download the file | |
937 | * @uri: uri string of target file of wget | |
938 | * Return: downloaded file size, negative if failed | |
939 | */ | |
940 | int wget_with_dns(ulong dst_addr, char *uri); | |
941 | ||
f01c961e MK |
942 | /** |
943 | * wget_validate_uri() - varidate the uri | |
944 | * | |
945 | * @uri: uri string of target file of wget | |
946 | * Return: true if uri is valid, false if uri is invalid | |
947 | */ | |
948 | bool wget_validate_uri(char *uri); | |
949 | ||
2d966958 | 950 | #endif /* __NET_H__ */ |