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