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