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