1 /* SPDX-License-Identifier: GPL-2.0 */
3 * LiMon Monitor (LiMon) - Network.
5 * Copyright 1994 - 2000 Neil Russell.
9 * 9/16/00 bor adapted to TQM823L/STK8xxL board, RARP/TFTP boot added
15 #include <linux/types.h>
16 #include <asm/cache.h>
17 #include <asm/byteorder.h> /* for nton* / ntoh* stuff */
21 #include <linux/if_ether.h>
28 #define DEBUG_LL_STATE 0 /* Link local state machine changes */
29 #define DEBUG_DEV_PKT 0 /* Packets or info directed to the device */
30 #define DEBUG_NET_PKT 0 /* Packets on info on the network at large */
31 #define DEBUG_INT_STATE 0 /* Internal network state changes */
34 * The number of receive packet buffers, and the required packet buffer
35 * alignment in memory.
39 #ifdef CONFIG_SYS_RX_ETH_BUFFER
40 # define PKTBUFSRX CONFIG_SYS_RX_ETH_BUFFER
45 #define PKTALIGN ARCH_DMA_MINALIGN
47 /* ARP hardware address length */
50 * The size of a MAC address in string form, each digit requires two chars
51 * and five separator characters to form '00:00:00:00:00:00'.
53 #define ARP_HLEN_ASCII (ARP_HLEN * 2) + (ARP_HLEN - 1)
55 /* IPv4 addresses are always 32 bits in size */
61 * do_tftpb - Run the tftpboot command
63 * @cmdtp: Command information for tftpboot
64 * @flag: Command flags (CMD_FLAG_...)
65 * @argc: Number of arguments
66 * @argv: List of arguments
67 * @return result (see enum command_ret_t)
69 int do_tftpb(struct cmd_tbl_s
*cmdtp
, int flag
, int argc
, char *const argv
[]);
72 * An incoming packet handler.
73 * @param pkt pointer to the application packet
74 * @param dport destination UDP port
75 * @param sip source IP address
76 * @param sport source UDP port
77 * @param len packet length
79 typedef void rxhand_f(uchar
*pkt
, unsigned dport
,
80 struct in_addr sip
, unsigned sport
,
84 * An incoming ICMP packet handler.
85 * @param type ICMP type
86 * @param code ICMP code
87 * @param dport destination UDP port
88 * @param sip source IP address
89 * @param sport source UDP port
90 * @param pkt pointer to the ICMP packet data
91 * @param len packet length
93 typedef void rxhand_icmp_f(unsigned type
, unsigned code
, unsigned dport
,
94 struct in_addr sip
, unsigned sport
, uchar
*pkt
, unsigned len
);
97 * A timeout handler. Called after time interval has expired.
99 typedef void thand_f(void);
109 * struct eth_pdata - Platform data for Ethernet MAC controllers
111 * @iobase: The base address of the hardware registers
112 * @enetaddr: The Ethernet MAC address that is loaded from EEPROM or env
113 * @phy_interface: PHY interface to use - see PHY_INTERFACE_MODE_...
114 * @max_speed: Maximum speed of Ethernet connection supported by MAC
115 * @priv_pdata: device specific platdata
119 unsigned char enetaddr
[ARP_HLEN
];
125 enum eth_recv_flags
{
127 * Check hardware device for new packets (otherwise only return those
128 * which are already in the memory buffer ready to process)
130 ETH_RECV_CHECK_DEVICE
= 1 << 0,
134 * struct eth_ops - functions of Ethernet MAC controllers
136 * start: Prepare the hardware to send and receive packets
137 * send: Send the bytes passed in "packet" as a packet on the wire
138 * recv: Check if the hardware received a packet. If so, set the pointer to the
139 * packet buffer in the packetp parameter. If not, return an error or 0 to
140 * indicate that the hardware receive FIFO is empty. If 0 is returned, the
141 * network stack will not process the empty packet, but free_pkt() will be
143 * free_pkt: Give the driver an opportunity to manage its packet buffer memory
144 * when the network stack is finished processing it. This will only be
145 * called when no error was returned from recv - optional
146 * stop: Stop the hardware from looking for packets - may be called even if
148 * mcast: Join or leave a multicast group (for TFTP) - optional
149 * write_hwaddr: Write a MAC address to the hardware (used to pass it to Linux
150 * on some platforms like ARM). This function expects the
151 * eth_pdata::enetaddr field to be populated. The method can
152 * return -ENOSYS to indicate that this is not implemented for
153 this hardware - optional.
154 * read_rom_hwaddr: Some devices have a backup of the MAC address stored in a
155 * ROM on the board. This is how the driver should expose it
156 * to the network stack. This function should fill in the
157 * eth_pdata::enetaddr field - optional
160 int (*start
)(struct udevice
*dev
);
161 int (*send
)(struct udevice
*dev
, void *packet
, int length
);
162 int (*recv
)(struct udevice
*dev
, int flags
, uchar
**packetp
);
163 int (*free_pkt
)(struct udevice
*dev
, uchar
*packet
, int length
);
164 void (*stop
)(struct udevice
*dev
);
165 int (*mcast
)(struct udevice
*dev
, const u8
*enetaddr
, int join
);
166 int (*write_hwaddr
)(struct udevice
*dev
);
167 int (*read_rom_hwaddr
)(struct udevice
*dev
);
170 #define eth_get_ops(dev) ((struct eth_ops *)(dev)->driver->ops)
172 struct udevice
*eth_get_dev(void); /* get the current device */
174 * The devname can be either an exact name given by the driver or device tree
175 * or it can be an alias of the form "eth%d"
177 struct udevice
*eth_get_dev_by_name(const char *devname
);
178 unsigned char *eth_get_ethaddr(void); /* get the current device MAC */
180 /* Used only when NetConsole is enabled */
181 int eth_is_active(struct udevice
*dev
); /* Test device for active state */
182 int eth_init_state_only(void); /* Set active state */
183 void eth_halt_state_only(void); /* Set passive state */
186 #ifndef CONFIG_DM_ETH
188 #define ETH_NAME_LEN 20
189 char name
[ETH_NAME_LEN
];
190 unsigned char enetaddr
[ARP_HLEN
];
194 int (*init
)(struct eth_device
*eth
, struct bd_info
*bd
);
195 int (*send
)(struct eth_device
*, void *packet
, int length
);
196 int (*recv
)(struct eth_device
*);
197 void (*halt
)(struct eth_device
*);
198 int (*mcast
)(struct eth_device
*, const u8
*enetaddr
, int join
);
199 int (*write_hwaddr
)(struct eth_device
*eth
);
200 struct eth_device
*next
;
205 int eth_register(struct eth_device
*dev
);/* Register network device */
206 int eth_unregister(struct eth_device
*dev
);/* Remove network device */
208 extern struct eth_device
*eth_current
;
210 static __always_inline
struct eth_device
*eth_get_dev(void)
214 struct eth_device
*eth_get_dev_by_name(const char *devname
);
215 struct eth_device
*eth_get_dev_by_index(int index
); /* get dev @ index */
217 /* get the current device MAC */
218 static inline unsigned char *eth_get_ethaddr(void)
221 return eth_current
->enetaddr
;
225 /* Used only when NetConsole is enabled */
226 int eth_is_active(struct eth_device
*dev
); /* Test device for active state */
227 /* Set active state */
228 static __always_inline
int eth_init_state_only(void)
230 eth_get_dev()->state
= ETH_STATE_ACTIVE
;
234 /* Set passive state */
235 static __always_inline
void eth_halt_state_only(void)
237 eth_get_dev()->state
= ETH_STATE_PASSIVE
;
241 * Set the hardware address for an ethernet interface based on 'eth%daddr'
242 * environment variable (or just 'ethaddr' if eth_number is 0).
244 * base_name - base name for device (normally "eth")
245 * eth_number - value of %d (0 for first device of this type)
247 * 0 is success, non-zero is error status from driver.
249 int eth_write_hwaddr(struct eth_device
*dev
, const char *base_name
,
252 int usb_eth_initialize(struct bd_info
*bi
);
255 int eth_initialize(void); /* Initialize network subsystem */
256 void eth_try_another(int first_restart
); /* Change the device */
257 void eth_set_current(void); /* set nterface to ethcur var */
259 int eth_get_dev_index(void); /* get the device index */
262 * eth_env_set_enetaddr_by_index() - set the MAC address environment variable
264 * This sets up an environment variable with the given MAC address (@enetaddr).
265 * The environment variable to be set is defined by <@base_name><@index>addr.
266 * If @index is 0 it is omitted. For common Ethernet this means ethaddr,
269 * @base_name: Base name for variable, typically "eth"
270 * @index: Index of interface being updated (>=0)
271 * @enetaddr: Pointer to MAC address to put into the variable
272 * @return 0 if OK, other value on error
274 int eth_env_set_enetaddr_by_index(const char *base_name
, int index
,
279 * Initialize USB ethernet device with CONFIG_DM_ETH
281 * 0 is success, non-zero is error status.
283 int usb_ether_init(void);
286 * Get the hardware address for an ethernet interface .
288 * base_name - base name for device (normally "eth")
289 * index - device index number (0 for first)
290 * enetaddr - returns 6 byte hardware address
292 * Return true if the address is valid.
294 int eth_env_get_enetaddr_by_index(const char *base_name
, int index
,
297 int eth_init(void); /* Initialize the device */
298 int eth_send(void *packet
, int length
); /* Send a packet */
300 #if defined(CONFIG_API) || defined(CONFIG_EFI_LOADER)
301 int eth_receive(void *packet
, int length
); /* Receive a packet*/
302 extern void (*push_packet
)(void *packet
, int length
);
304 int eth_rx(void); /* Check for received packets */
305 void eth_halt(void); /* stop SCC */
306 const char *eth_get_name(void); /* get name of current device */
307 int eth_mcast_join(struct in_addr mcast_addr
, int join
);
309 /**********************************************************************/
318 struct ethernet_hdr
{
319 u8 et_dest
[ARP_HLEN
]; /* Destination node */
320 u8 et_src
[ARP_HLEN
]; /* Source node */
321 u16 et_protlen
; /* Protocol or length */
322 } __attribute__((packed
));
324 /* Ethernet header size */
325 #define ETHER_HDR_SIZE (sizeof(struct ethernet_hdr))
327 #define ETH_FCS_LEN 4 /* Octets in the FCS */
330 u8 et_dest
[ARP_HLEN
]; /* Destination node */
331 u8 et_src
[ARP_HLEN
]; /* Source node */
332 u16 et_protlen
; /* Protocol or length */
333 u8 et_dsap
; /* 802 DSAP */
334 u8 et_ssap
; /* 802 SSAP */
335 u8 et_ctl
; /* 802 control */
336 u8 et_snap1
; /* SNAP */
339 u16 et_prot
; /* 802 protocol */
340 } __attribute__((packed
));
342 /* 802 + SNAP + ethernet header size */
343 #define E802_HDR_SIZE (sizeof(struct e802_hdr))
346 * Virtual LAN Ethernet header
348 struct vlan_ethernet_hdr
{
349 u8 vet_dest
[ARP_HLEN
]; /* Destination node */
350 u8 vet_src
[ARP_HLEN
]; /* Source node */
351 u16 vet_vlan_type
; /* PROT_VLAN */
352 u16 vet_tag
; /* TAG of VLAN */
353 u16 vet_type
; /* protocol type */
354 } __attribute__((packed
));
356 /* VLAN Ethernet header size */
357 #define VLAN_ETHER_HDR_SIZE (sizeof(struct vlan_ethernet_hdr))
359 #define PROT_IP 0x0800 /* IP protocol */
360 #define PROT_ARP 0x0806 /* IP ARP protocol */
361 #define PROT_WOL 0x0842 /* ether-wake WoL protocol */
362 #define PROT_RARP 0x8035 /* IP ARP protocol */
363 #define PROT_VLAN 0x8100 /* IEEE 802.1q protocol */
364 #define PROT_IPV6 0x86dd /* IPv6 over bluebook */
365 #define PROT_PPP_SES 0x8864 /* PPPoE session messages */
366 #define PROT_NCSI 0x88f8 /* NC-SI control packets */
368 #define IPPROTO_ICMP 1 /* Internet Control Message Protocol */
369 #define IPPROTO_UDP 17 /* User Datagram Protocol */
372 * Internet Protocol (IP) header.
375 u8 ip_hl_v
; /* header length and version */
376 u8 ip_tos
; /* type of service */
377 u16 ip_len
; /* total length */
378 u16 ip_id
; /* identification */
379 u16 ip_off
; /* fragment offset field */
380 u8 ip_ttl
; /* time to live */
381 u8 ip_p
; /* protocol */
382 u16 ip_sum
; /* checksum */
383 struct in_addr ip_src
; /* Source IP address */
384 struct in_addr ip_dst
; /* Destination IP address */
385 } __attribute__((packed
));
387 #define IP_OFFS 0x1fff /* ip offset *= 8 */
388 #define IP_FLAGS 0xe000 /* first 3 bits */
389 #define IP_FLAGS_RES 0x8000 /* reserved */
390 #define IP_FLAGS_DFRAG 0x4000 /* don't fragments */
391 #define IP_FLAGS_MFRAG 0x2000 /* more fragments */
393 #define IP_HDR_SIZE (sizeof(struct ip_hdr))
396 * Internet Protocol (IP) + UDP header.
399 u8 ip_hl_v
; /* header length and version */
400 u8 ip_tos
; /* type of service */
401 u16 ip_len
; /* total length */
402 u16 ip_id
; /* identification */
403 u16 ip_off
; /* fragment offset field */
404 u8 ip_ttl
; /* time to live */
405 u8 ip_p
; /* protocol */
406 u16 ip_sum
; /* checksum */
407 struct in_addr ip_src
; /* Source IP address */
408 struct in_addr ip_dst
; /* Destination IP address */
409 u16 udp_src
; /* UDP source port */
410 u16 udp_dst
; /* UDP destination port */
411 u16 udp_len
; /* Length of UDP packet */
412 u16 udp_xsum
; /* Checksum */
413 } __attribute__((packed
));
415 #define IP_UDP_HDR_SIZE (sizeof(struct ip_udp_hdr))
416 #define UDP_HDR_SIZE (IP_UDP_HDR_SIZE - IP_HDR_SIZE)
419 * Address Resolution Protocol (ARP) header.
422 u16 ar_hrd
; /* Format of hardware address */
423 # define ARP_ETHER 1 /* Ethernet hardware address */
424 u16 ar_pro
; /* Format of protocol address */
425 u8 ar_hln
; /* Length of hardware address */
426 u8 ar_pln
; /* Length of protocol address */
428 u16 ar_op
; /* Operation */
429 # define ARPOP_REQUEST 1 /* Request to resolve address */
430 # define ARPOP_REPLY 2 /* Response to previous request */
432 # define RARPOP_REQUEST 3 /* Request to resolve address */
433 # define RARPOP_REPLY 4 /* Response to previous request */
436 * The remaining fields are variable in size, according to
437 * the sizes above, and are defined as appropriate for
438 * specific hardware/protocol combinations.
441 #define ar_sha ar_data[0]
442 #define ar_spa ar_data[ARP_HLEN]
443 #define ar_tha ar_data[ARP_HLEN + ARP_PLEN]
444 #define ar_tpa ar_data[ARP_HLEN + ARP_PLEN + ARP_HLEN]
446 u8 ar_sha
[]; /* Sender hardware address */
447 u8 ar_spa
[]; /* Sender protocol address */
448 u8 ar_tha
[]; /* Target hardware address */
449 u8 ar_tpa
[]; /* Target protocol address */
451 } __attribute__((packed
));
453 #define ARP_HDR_SIZE (8+20) /* Size assuming ethernet */
456 * ICMP stuff (just enough to handle (host) redirect messages)
458 #define ICMP_ECHO_REPLY 0 /* Echo reply */
459 #define ICMP_NOT_REACH 3 /* Detination unreachable */
460 #define ICMP_REDIRECT 5 /* Redirect (change route) */
461 #define ICMP_ECHO_REQUEST 8 /* Echo request */
463 /* Codes for REDIRECT. */
464 #define ICMP_REDIR_NET 0 /* Redirect Net */
465 #define ICMP_REDIR_HOST 1 /* Redirect Host */
467 /* Codes for NOT_REACH */
468 #define ICMP_NOT_REACH_PORT 3 /* Port unreachable */
486 } __attribute__((packed
));
488 #define ICMP_HDR_SIZE (sizeof(struct icmp_hdr))
489 #define IP_ICMP_HDR_SIZE (IP_HDR_SIZE + ICMP_HDR_SIZE)
492 * Maximum packet size; used to allocate packet storage. Use
493 * the maxium Ethernet frame size as specified by the Ethernet
494 * standard including the 802.1Q tag (VLAN tagging).
495 * maximum packet size = 1522
496 * maximum packet size and multiple of 32 bytes = 1536
499 #define PKTSIZE_ALIGN 1536
502 * Maximum receive ring size; that is, the number of packets
503 * we can buffer before overflow happens. Basically, this just
504 * needs to be enough to prevent a packet being discarded while
505 * we are processing the previous one.
508 #define RINGSZ_LOG2 2
510 /**********************************************************************/
516 * All variables of type struct in_addr are stored in NETWORK byte order
521 /** BOOTP EXTENTIONS **/
522 extern struct in_addr net_gateway
; /* Our gateway IP address */
523 extern struct in_addr net_netmask
; /* Our subnet mask (0 = unknown) */
524 /* Our Domain Name Server (0 = unknown) */
525 extern struct in_addr net_dns_server
;
526 #if defined(CONFIG_BOOTP_DNS2)
527 /* Our 2nd Domain Name Server (0 = unknown) */
528 extern struct in_addr net_dns_server2
;
530 extern char net_nis_domain
[32]; /* Our IS domain */
531 extern char net_hostname
[32]; /* Our hostname */
532 extern char net_root_path
[64]; /* Our root path */
533 /** END OF BOOTP EXTENTIONS **/
534 extern u8 net_ethaddr
[ARP_HLEN
]; /* Our ethernet address */
535 extern u8 net_server_ethaddr
[ARP_HLEN
]; /* Boot server enet address */
536 extern struct in_addr net_ip
; /* Our IP addr (0 = unknown) */
537 extern struct in_addr net_server_ip
; /* Server IP addr (0 = unknown) */
538 extern uchar
*net_tx_packet
; /* THE transmit packet */
539 extern uchar
*net_rx_packets
[PKTBUFSRX
]; /* Receive packets */
540 extern uchar
*net_rx_packet
; /* Current receive packet */
541 extern int net_rx_packet_len
; /* Current rx packet length */
542 extern const u8 net_bcast_ethaddr
[ARP_HLEN
]; /* Ethernet broadcast address */
543 extern const u8 net_null_ethaddr
[ARP_HLEN
];
545 #define VLAN_NONE 4095 /* untagged */
546 #define VLAN_IDMASK 0x0fff /* mask of valid vlan id */
547 extern ushort net_our_vlan
; /* Our VLAN */
548 extern ushort net_native_vlan
; /* Our Native VLAN */
550 extern int net_restart_wrap
; /* Tried all network devices */
553 BOOTP
, RARP
, ARP
, TFTPGET
, DHCP
, PING
, DNS
, NFS
, CDP
, NETCONS
, SNTP
,
554 TFTPSRV
, TFTPPUT
, LINKLOCAL
, FASTBOOT
, WOL
557 extern char net_boot_file_name
[1024];/* Boot File name */
558 /* Indicates whether the file name was specified on the command line */
559 extern bool net_boot_file_name_explicit
;
560 /* The actual transferred size of the bootfile (in bytes) */
561 extern u32 net_boot_file_size
;
562 /* Boot file size in blocks as reported by the DHCP server */
563 extern u32 net_boot_file_expected_size_in_blocks
;
565 #if defined(CONFIG_CMD_DNS)
566 extern char *net_dns_resolve
; /* The host to resolve */
567 extern char *net_dns_env_var
; /* the env var to put the ip into */
570 #if defined(CONFIG_CMD_PING)
571 extern struct in_addr net_ping_ip
; /* the ip address to ping */
574 #if defined(CONFIG_CMD_CDP)
575 /* when CDP completes these hold the return values */
576 extern ushort cdp_native_vlan
; /* CDP returned native VLAN */
577 extern ushort cdp_appliance_vlan
; /* CDP returned appliance VLAN */
580 * Check for a CDP packet by examining the received MAC address field
582 static inline int is_cdp_packet(const uchar
*ethaddr
)
584 extern const u8 net_cdp_ethaddr
[ARP_HLEN
];
586 return memcmp(ethaddr
, net_cdp_ethaddr
, ARP_HLEN
) == 0;
590 #if defined(CONFIG_CMD_SNTP)
591 extern struct in_addr net_ntp_server
; /* the ip address to NTP */
592 extern int net_ntp_time_offset
; /* offset time from UTC */
595 /* Initialize the network adapter */
597 int net_loop(enum proto_t
);
599 /* Load failed. Start again. */
600 int net_start_again(void);
602 /* Get size of the ethernet header when we send */
603 int net_eth_hdr_size(void);
605 /* Set ethernet header; returns the size of the header */
606 int net_set_ether(uchar
*xet
, const uchar
*dest_ethaddr
, uint prot
);
607 int net_update_ether(struct ethernet_hdr
*et
, uchar
*addr
, uint prot
);
610 void net_set_ip_header(uchar
*pkt
, struct in_addr dest
, struct in_addr source
,
611 u16 pkt_len
, u8 proto
);
612 void net_set_udp_header(uchar
*pkt
, struct in_addr dest
, int dport
,
616 * compute_ip_checksum() - Compute IP checksum
618 * @addr: Address to check (must be 16-bit aligned)
619 * @nbytes: Number of bytes to check (normally a multiple of 2)
620 * @return 16-bit IP checksum
622 unsigned compute_ip_checksum(const void *addr
, unsigned nbytes
);
625 * add_ip_checksums() - add two IP checksums
627 * @offset: Offset of first sum (if odd we do a byte-swap)
628 * @sum: First checksum
629 * @new_sum: New checksum to add
630 * @return updated 16-bit IP checksum
632 unsigned add_ip_checksums(unsigned offset
, unsigned sum
, unsigned new_sum
);
635 * ip_checksum_ok() - check if a checksum is correct
637 * This works by making sure the checksum sums to 0
639 * @addr: Address to check (must be 16-bit aligned)
640 * @nbytes: Number of bytes to check (normally a multiple of 2)
641 * @return true if the checksum matches, false if not
643 int ip_checksum_ok(const void *addr
, unsigned nbytes
);
646 rxhand_f
*net_get_udp_handler(void); /* Get UDP RX packet handler */
647 void net_set_udp_handler(rxhand_f
*); /* Set UDP RX packet handler */
648 rxhand_f
*net_get_arp_handler(void); /* Get ARP RX packet handler */
649 void net_set_arp_handler(rxhand_f
*); /* Set ARP RX packet handler */
650 bool arp_is_waiting(void); /* Waiting for ARP reply? */
651 void net_set_icmp_handler(rxhand_icmp_f
*f
); /* Set ICMP RX handler */
652 void net_set_timeout_handler(ulong
, thand_f
*);/* Set timeout handler */
654 /* Network loop state */
655 enum net_loop_state
{
661 extern enum net_loop_state net_state
;
663 static inline void net_set_state(enum net_loop_state state
)
665 debug_cond(DEBUG_INT_STATE
, "--- NetState set to %d\n", state
);
670 * net_get_async_tx_pkt_buf - Get a packet buffer that is not in use for
671 * sending an asynchronous reply
673 * returns - ptr to packet buffer
675 uchar
* net_get_async_tx_pkt_buf(void);
677 /* Transmit a packet */
678 static inline void net_send_packet(uchar
*pkt
, int len
)
680 /* Currently no way to return errors from eth_send() */
681 (void) eth_send(pkt
, len
);
685 * Transmit "net_tx_packet" as UDP packet, performing ARP request if needed
686 * (ether will be populated)
688 * @param ether Raw packet buffer
689 * @param dest IP address to send the datagram to
690 * @param dport Destination UDP port
691 * @param sport Source UDP port
692 * @param payload_len Length of data after the UDP header
694 int net_send_ip_packet(uchar
*ether
, struct in_addr dest
, int dport
, int sport
,
695 int payload_len
, int proto
, u8 action
, u32 tcp_seq_num
,
697 int net_send_udp_packet(uchar
*ether
, struct in_addr dest
, int dport
,
698 int sport
, int payload_len
);
700 /* Processes a received packet */
701 void net_process_received_packet(uchar
*in_packet
, int len
);
703 #if defined(CONFIG_NETCONSOLE) && !defined(CONFIG_SPL_BUILD)
705 int nc_input_packet(uchar
*pkt
, struct in_addr src_ip
, unsigned dest_port
,
706 unsigned src_port
, unsigned len
);
709 static __always_inline
int eth_is_on_demand_init(void)
711 #if defined(CONFIG_NETCONSOLE) && !defined(CONFIG_SPL_BUILD)
712 extern enum proto_t net_loop_last_protocol
;
714 return net_loop_last_protocol
!= NETCONS
;
720 static inline void eth_set_last_protocol(int protocol
)
722 #if defined(CONFIG_NETCONSOLE) && !defined(CONFIG_SPL_BUILD)
723 extern enum proto_t net_loop_last_protocol
;
725 net_loop_last_protocol
= protocol
;
730 * Check if autoload is enabled. If so, use either NFS or TFTP to download
733 void net_auto_load(void);
736 * The following functions are a bit ugly, but necessary to deal with
737 * alignment restrictions on ARM.
739 * We're using inline functions, which had the smallest memory
740 * footprint in our tests.
742 /* return IP *in network byteorder* */
743 static inline struct in_addr
net_read_ip(void *from
)
747 memcpy((void *)&ip
, (void *)from
, sizeof(ip
));
751 /* return ulong *in network byteorder* */
752 static inline u32
net_read_u32(void *from
)
756 memcpy((void *)&l
, (void *)from
, sizeof(l
));
760 /* write IP *in network byteorder* */
761 static inline void net_write_ip(void *to
, struct in_addr ip
)
763 memcpy(to
, (void *)&ip
, sizeof(ip
));
767 static inline void net_copy_ip(void *to
, void *from
)
769 memcpy((void *)to
, from
, sizeof(struct in_addr
));
773 static inline void net_copy_u32(void *to
, void *from
)
775 memcpy((void *)to
, (void *)from
, sizeof(u32
));
779 * is_zero_ethaddr - Determine if give Ethernet address is all zeros.
780 * @addr: Pointer to a six-byte array containing the Ethernet address
782 * Return true if the address is all zeroes.
784 static inline int is_zero_ethaddr(const u8
*addr
)
786 return !(addr
[0] | addr
[1] | addr
[2] | addr
[3] | addr
[4] | addr
[5]);
790 * is_multicast_ethaddr - Determine if the Ethernet address is a multicast.
791 * @addr: Pointer to a six-byte array containing the Ethernet address
793 * Return true if the address is a multicast address.
794 * By definition the broadcast address is also a multicast address.
796 static inline int is_multicast_ethaddr(const u8
*addr
)
798 return 0x01 & addr
[0];
802 * is_broadcast_ethaddr - Determine if the Ethernet address is broadcast
803 * @addr: Pointer to a six-byte array containing the Ethernet address
805 * Return true if the address is the broadcast address.
807 static inline int is_broadcast_ethaddr(const u8
*addr
)
809 return (addr
[0] & addr
[1] & addr
[2] & addr
[3] & addr
[4] & addr
[5]) ==
814 * is_valid_ethaddr - Determine if the given Ethernet address is valid
815 * @addr: Pointer to a six-byte array containing the Ethernet address
817 * Check that the Ethernet address (MAC) is not 00:00:00:00:00:00, is not
818 * a multicast address, and is not FF:FF:FF:FF:FF:FF.
820 * Return true if the address is valid.
822 static inline int is_valid_ethaddr(const u8
*addr
)
824 /* FF:FF:FF:FF:FF:FF is a multicast address so we don't need to
825 * explicitly check for it here. */
826 return !is_multicast_ethaddr(addr
) && !is_zero_ethaddr(addr
);
830 * net_random_ethaddr - Generate software assigned random Ethernet address
831 * @addr: Pointer to a six-byte array containing the Ethernet address
833 * Generate a random Ethernet address (MAC) that is not multicast
834 * and has the local assigned bit set.
836 static inline void net_random_ethaddr(uchar
*addr
)
839 unsigned int seed
= get_ticks();
841 for (i
= 0; i
< 6; i
++)
842 addr
[i
] = rand_r(&seed
);
844 addr
[0] &= 0xfe; /* clear multicast bit */
845 addr
[0] |= 0x02; /* set local assignment bit (IEEE802) */
849 * string_to_enetaddr() - Parse a MAC address
851 * Convert a string MAC address
853 * Implemented in lib/net_utils.c (built unconditionally)
855 * @addr: MAC address in aa:bb:cc:dd:ee:ff format, where each part is a 2-digit
857 * @enetaddr: Place to put MAC address (6 bytes)
859 void string_to_enetaddr(const char *addr
, uint8_t *enetaddr
);
861 /* Convert an IP address to a string */
862 void ip_to_string(struct in_addr x
, char *s
);
865 * string_to_ip() - Convert a string to ip address
867 * Implemented in lib/net_utils.c (built unconditionally)
869 * @s: Input string to parse
870 * @return: in_addr struct containing the parsed IP address
872 struct in_addr
string_to_ip(const char *s
);
874 /* Convert a VLAN id to a string */
875 void vlan_to_string(ushort x
, char *s
);
877 /* Convert a string to a vlan id */
878 ushort
string_to_vlan(const char *s
);
880 /* read a VLAN id from an environment variable */
881 ushort
env_get_vlan(char *);
883 /* copy a filename (allow for "..." notation, limit length) */
884 void copy_filename(char *dst
, const char *src
, int size
);
886 /* check if serverip is specified in filename from the command line */
887 int is_serverip_in_cmd(void);
890 * net_parse_bootfile - Parse the bootfile env var / cmd line param
892 * @param ipaddr - a pointer to the ipaddr to populate if included in bootfile
893 * @param filename - a pointer to the string to save the filename part
894 * @param max_len - The longest - 1 that the filename part can be
896 * return 1 if parsed, 0 if bootfile is empty
898 int net_parse_bootfile(struct in_addr
*ipaddr
, char *filename
, int max_len
);
900 /* get a random source port */
901 unsigned int random_port(void);
904 * update_tftp - Update firmware over TFTP (via DFU)
906 * This function updates board's firmware via TFTP
908 * @param addr - memory address where data is stored
909 * @param interface - the DFU medium name - e.g. "mmc"
910 * @param devstring - the DFU medium number - e.g. "1"
912 * @return - 0 on success, other value on failure
914 int update_tftp(ulong addr
, char *interface
, char *devstring
);
917 * env_get_ip() - Convert an environment value to to an ip address
919 * @var: Environment variable to convert. The value of this variable must be
920 * in the format format a.b.c.d, where each value is a decimal number from
922 * @return IP address, or 0 if invalid
924 static inline struct in_addr
env_get_ip(char *var
)
926 return string_to_ip(env_get(var
));
930 * reset_phy() - Reset the Ethernet PHY
932 * This should be implemented by boards if CONFIG_RESET_PHY_R is enabled
934 void reset_phy(void);
936 #endif /* __NET_H__ */