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 <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 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 */ 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 */ 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 */ 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_RARP 0x8035 /* IP ARP protocol */ 348 #define PROT_VLAN 0x8100 /* IEEE 802.1q protocol */ 349 #define PROT_IPV6 0x86dd /* IPv6 over bluebook */ 350 #define PROT_PPP_SES 0x8864 /* PPPoE session messages */ 351 352 #define IPPROTO_ICMP 1 /* Internet Control Message Protocol */ 353 #define IPPROTO_UDP 17 /* User Datagram Protocol */ 354 355 /* 356 * Internet Protocol (IP) header. 357 */ 358 struct ip_hdr { 359 u8 ip_hl_v; /* header length and version */ 360 u8 ip_tos; /* type of service */ 361 u16 ip_len; /* total length */ 362 u16 ip_id; /* identification */ 363 u16 ip_off; /* fragment offset field */ 364 u8 ip_ttl; /* time to live */ 365 u8 ip_p; /* protocol */ 366 u16 ip_sum; /* checksum */ 367 struct in_addr ip_src; /* Source IP address */ 368 struct in_addr ip_dst; /* Destination IP address */ 369 } __attribute__((packed)); 370 371 #define IP_OFFS 0x1fff /* ip offset *= 8 */ 372 #define IP_FLAGS 0xe000 /* first 3 bits */ 373 #define IP_FLAGS_RES 0x8000 /* reserved */ 374 #define IP_FLAGS_DFRAG 0x4000 /* don't fragments */ 375 #define IP_FLAGS_MFRAG 0x2000 /* more fragments */ 376 377 #define IP_HDR_SIZE (sizeof(struct ip_hdr)) 378 379 /* 380 * Internet Protocol (IP) + UDP header. 381 */ 382 struct ip_udp_hdr { 383 u8 ip_hl_v; /* header length and version */ 384 u8 ip_tos; /* type of service */ 385 u16 ip_len; /* total length */ 386 u16 ip_id; /* identification */ 387 u16 ip_off; /* fragment offset field */ 388 u8 ip_ttl; /* time to live */ 389 u8 ip_p; /* protocol */ 390 u16 ip_sum; /* checksum */ 391 struct in_addr ip_src; /* Source IP address */ 392 struct in_addr ip_dst; /* Destination IP address */ 393 u16 udp_src; /* UDP source port */ 394 u16 udp_dst; /* UDP destination port */ 395 u16 udp_len; /* Length of UDP packet */ 396 u16 udp_xsum; /* Checksum */ 397 } __attribute__((packed)); 398 399 #define IP_UDP_HDR_SIZE (sizeof(struct ip_udp_hdr)) 400 #define UDP_HDR_SIZE (IP_UDP_HDR_SIZE - IP_HDR_SIZE) 401 402 /* 403 * Address Resolution Protocol (ARP) header. 404 */ 405 struct arp_hdr { 406 u16 ar_hrd; /* Format of hardware address */ 407 # define ARP_ETHER 1 /* Ethernet hardware address */ 408 u16 ar_pro; /* Format of protocol address */ 409 u8 ar_hln; /* Length of hardware address */ 410 u8 ar_pln; /* Length of protocol address */ 411 # define ARP_PLEN 4 412 u16 ar_op; /* Operation */ 413 # define ARPOP_REQUEST 1 /* Request to resolve address */ 414 # define ARPOP_REPLY 2 /* Response to previous request */ 415 416 # define RARPOP_REQUEST 3 /* Request to resolve address */ 417 # define RARPOP_REPLY 4 /* Response to previous request */ 418 419 /* 420 * The remaining fields are variable in size, according to 421 * the sizes above, and are defined as appropriate for 422 * specific hardware/protocol combinations. 423 */ 424 u8 ar_data[0]; 425 #define ar_sha ar_data[0] 426 #define ar_spa ar_data[ARP_HLEN] 427 #define ar_tha ar_data[ARP_HLEN + ARP_PLEN] 428 #define ar_tpa ar_data[ARP_HLEN + ARP_PLEN + ARP_HLEN] 429 #if 0 430 u8 ar_sha[]; /* Sender hardware address */ 431 u8 ar_spa[]; /* Sender protocol address */ 432 u8 ar_tha[]; /* Target hardware address */ 433 u8 ar_tpa[]; /* Target protocol address */ 434 #endif /* 0 */ 435 } __attribute__((packed)); 436 437 #define ARP_HDR_SIZE (8+20) /* Size assuming ethernet */ 438 439 /* 440 * ICMP stuff (just enough to handle (host) redirect messages) 441 */ 442 #define ICMP_ECHO_REPLY 0 /* Echo reply */ 443 #define ICMP_NOT_REACH 3 /* Detination unreachable */ 444 #define ICMP_REDIRECT 5 /* Redirect (change route) */ 445 #define ICMP_ECHO_REQUEST 8 /* Echo request */ 446 447 /* Codes for REDIRECT. */ 448 #define ICMP_REDIR_NET 0 /* Redirect Net */ 449 #define ICMP_REDIR_HOST 1 /* Redirect Host */ 450 451 /* Codes for NOT_REACH */ 452 #define ICMP_NOT_REACH_PORT 3 /* Port unreachable */ 453 454 struct icmp_hdr { 455 u8 type; 456 u8 code; 457 u16 checksum; 458 union { 459 struct { 460 u16 id; 461 u16 sequence; 462 } echo; 463 u32 gateway; 464 struct { 465 u16 unused; 466 u16 mtu; 467 } frag; 468 u8 data[0]; 469 } un; 470 } __attribute__((packed)); 471 472 #define ICMP_HDR_SIZE (sizeof(struct icmp_hdr)) 473 #define IP_ICMP_HDR_SIZE (IP_HDR_SIZE + ICMP_HDR_SIZE) 474 475 /* 476 * Maximum packet size; used to allocate packet storage. Use 477 * the maxium Ethernet frame size as specified by the Ethernet 478 * standard including the 802.1Q tag (VLAN tagging). 479 * maximum packet size = 1522 480 * maximum packet size and multiple of 32 bytes = 1536 481 */ 482 #define PKTSIZE 1522 483 #define PKTSIZE_ALIGN 1536 484 485 /* 486 * Maximum receive ring size; that is, the number of packets 487 * we can buffer before overflow happens. Basically, this just 488 * needs to be enough to prevent a packet being discarded while 489 * we are processing the previous one. 490 */ 491 #define RINGSZ 4 492 #define RINGSZ_LOG2 2 493 494 /**********************************************************************/ 495 /* 496 * Globals. 497 * 498 * Note: 499 * 500 * All variables of type struct in_addr are stored in NETWORK byte order 501 * (big endian). 502 */ 503 504 /* net.c */ 505 /** BOOTP EXTENTIONS **/ 506 extern struct in_addr net_gateway; /* Our gateway IP address */ 507 extern struct in_addr net_netmask; /* Our subnet mask (0 = unknown) */ 508 /* Our Domain Name Server (0 = unknown) */ 509 extern struct in_addr net_dns_server; 510 #if defined(CONFIG_BOOTP_DNS2) 511 /* Our 2nd Domain Name Server (0 = unknown) */ 512 extern struct in_addr net_dns_server2; 513 #endif 514 extern char net_nis_domain[32]; /* Our IS domain */ 515 extern char net_hostname[32]; /* Our hostname */ 516 extern char net_root_path[64]; /* Our root path */ 517 /** END OF BOOTP EXTENTIONS **/ 518 extern u8 net_ethaddr[ARP_HLEN]; /* Our ethernet address */ 519 extern u8 net_server_ethaddr[ARP_HLEN]; /* Boot server enet address */ 520 extern struct in_addr net_ip; /* Our IP addr (0 = unknown) */ 521 extern struct in_addr net_server_ip; /* Server IP addr (0 = unknown) */ 522 extern uchar *net_tx_packet; /* THE transmit packet */ 523 extern uchar *net_rx_packets[PKTBUFSRX]; /* Receive packets */ 524 extern uchar *net_rx_packet; /* Current receive packet */ 525 extern int net_rx_packet_len; /* Current rx packet length */ 526 extern const u8 net_bcast_ethaddr[ARP_HLEN]; /* Ethernet broadcast address */ 527 extern const u8 net_null_ethaddr[ARP_HLEN]; 528 529 #define VLAN_NONE 4095 /* untagged */ 530 #define VLAN_IDMASK 0x0fff /* mask of valid vlan id */ 531 extern ushort net_our_vlan; /* Our VLAN */ 532 extern ushort net_native_vlan; /* Our Native VLAN */ 533 534 extern int net_restart_wrap; /* Tried all network devices */ 535 536 enum proto_t { 537 BOOTP, RARP, ARP, TFTPGET, DHCP, PING, DNS, NFS, CDP, NETCONS, SNTP, 538 TFTPSRV, TFTPPUT, LINKLOCAL 539 }; 540 541 extern char net_boot_file_name[1024];/* Boot File name */ 542 /* The actual transferred size of the bootfile (in bytes) */ 543 extern u32 net_boot_file_size; 544 /* Boot file size in blocks as reported by the DHCP server */ 545 extern u32 net_boot_file_expected_size_in_blocks; 546 547 #if defined(CONFIG_CMD_DNS) 548 extern char *net_dns_resolve; /* The host to resolve */ 549 extern char *net_dns_env_var; /* the env var to put the ip into */ 550 #endif 551 552 #if defined(CONFIG_CMD_PING) 553 extern struct in_addr net_ping_ip; /* the ip address to ping */ 554 #endif 555 556 #if defined(CONFIG_CMD_CDP) 557 /* when CDP completes these hold the return values */ 558 extern ushort cdp_native_vlan; /* CDP returned native VLAN */ 559 extern ushort cdp_appliance_vlan; /* CDP returned appliance VLAN */ 560 561 /* 562 * Check for a CDP packet by examining the received MAC address field 563 */ 564 static inline int is_cdp_packet(const uchar *ethaddr) 565 { 566 extern const u8 net_cdp_ethaddr[ARP_HLEN]; 567 568 return memcmp(ethaddr, net_cdp_ethaddr, ARP_HLEN) == 0; 569 } 570 #endif 571 572 #if defined(CONFIG_CMD_SNTP) 573 extern struct in_addr net_ntp_server; /* the ip address to NTP */ 574 extern int net_ntp_time_offset; /* offset time from UTC */ 575 #endif 576 577 #if defined(CONFIG_MCAST_TFTP) 578 extern struct in_addr net_mcast_addr; 579 #endif 580 581 /* Initialize the network adapter */ 582 void net_init(void); 583 int net_loop(enum proto_t); 584 585 /* Load failed. Start again. */ 586 int net_start_again(void); 587 588 /* Get size of the ethernet header when we send */ 589 int net_eth_hdr_size(void); 590 591 /* Set ethernet header; returns the size of the header */ 592 int net_set_ether(uchar *xet, const uchar *dest_ethaddr, uint prot); 593 int net_update_ether(struct ethernet_hdr *et, uchar *addr, uint prot); 594 595 /* Set IP header */ 596 void net_set_ip_header(uchar *pkt, struct in_addr dest, struct in_addr source); 597 void net_set_udp_header(uchar *pkt, struct in_addr dest, int dport, 598 int sport, int len); 599 600 /** 601 * compute_ip_checksum() - Compute IP checksum 602 * 603 * @addr: Address to check (must be 16-bit aligned) 604 * @nbytes: Number of bytes to check (normally a multiple of 2) 605 * @return 16-bit IP checksum 606 */ 607 unsigned compute_ip_checksum(const void *addr, unsigned nbytes); 608 609 /** 610 * add_ip_checksums() - add two IP checksums 611 * 612 * @offset: Offset of first sum (if odd we do a byte-swap) 613 * @sum: First checksum 614 * @new_sum: New checksum to add 615 * @return updated 16-bit IP checksum 616 */ 617 unsigned add_ip_checksums(unsigned offset, unsigned sum, unsigned new_sum); 618 619 /** 620 * ip_checksum_ok() - check if a checksum is correct 621 * 622 * This works by making sure the checksum sums to 0 623 * 624 * @addr: Address to check (must be 16-bit aligned) 625 * @nbytes: Number of bytes to check (normally a multiple of 2) 626 * @return true if the checksum matches, false if not 627 */ 628 int ip_checksum_ok(const void *addr, unsigned nbytes); 629 630 /* Callbacks */ 631 rxhand_f *net_get_udp_handler(void); /* Get UDP RX packet handler */ 632 void net_set_udp_handler(rxhand_f *); /* Set UDP RX packet handler */ 633 rxhand_f *net_get_arp_handler(void); /* Get ARP RX packet handler */ 634 void net_set_arp_handler(rxhand_f *); /* Set ARP RX packet handler */ 635 void net_set_icmp_handler(rxhand_icmp_f *f); /* Set ICMP RX handler */ 636 void net_set_timeout_handler(ulong, thand_f *);/* Set timeout handler */ 637 638 /* Network loop state */ 639 enum net_loop_state { 640 NETLOOP_CONTINUE, 641 NETLOOP_RESTART, 642 NETLOOP_SUCCESS, 643 NETLOOP_FAIL 644 }; 645 extern enum net_loop_state net_state; 646 647 static inline void net_set_state(enum net_loop_state state) 648 { 649 debug_cond(DEBUG_INT_STATE, "--- NetState set to %d\n", state); 650 net_state = state; 651 } 652 653 /* Transmit a packet */ 654 static inline void net_send_packet(uchar *pkt, int len) 655 { 656 /* Currently no way to return errors from eth_send() */ 657 (void) eth_send(pkt, len); 658 } 659 660 /* 661 * Transmit "net_tx_packet" as UDP packet, performing ARP request if needed 662 * (ether will be populated) 663 * 664 * @param ether Raw packet buffer 665 * @param dest IP address to send the datagram to 666 * @param dport Destination UDP port 667 * @param sport Source UDP port 668 * @param payload_len Length of data after the UDP header 669 */ 670 int net_send_udp_packet(uchar *ether, struct in_addr dest, int dport, 671 int sport, int payload_len); 672 673 /* Processes a received packet */ 674 void net_process_received_packet(uchar *in_packet, int len); 675 676 #if defined(CONFIG_NETCONSOLE) && !defined(CONFIG_SPL_BUILD) 677 void nc_start(void); 678 int nc_input_packet(uchar *pkt, struct in_addr src_ip, unsigned dest_port, 679 unsigned src_port, unsigned len); 680 #endif 681 682 static __always_inline int eth_is_on_demand_init(void) 683 { 684 #if defined(CONFIG_NETCONSOLE) && !defined(CONFIG_SPL_BUILD) 685 extern enum proto_t net_loop_last_protocol; 686 687 return net_loop_last_protocol != NETCONS; 688 #else 689 return 1; 690 #endif 691 } 692 693 static inline void eth_set_last_protocol(int protocol) 694 { 695 #if defined(CONFIG_NETCONSOLE) && !defined(CONFIG_SPL_BUILD) 696 extern enum proto_t net_loop_last_protocol; 697 698 net_loop_last_protocol = protocol; 699 #endif 700 } 701 702 /* 703 * Check if autoload is enabled. If so, use either NFS or TFTP to download 704 * the boot file. 705 */ 706 void net_auto_load(void); 707 708 /* 709 * The following functions are a bit ugly, but necessary to deal with 710 * alignment restrictions on ARM. 711 * 712 * We're using inline functions, which had the smallest memory 713 * footprint in our tests. 714 */ 715 /* return IP *in network byteorder* */ 716 static inline struct in_addr net_read_ip(void *from) 717 { 718 struct in_addr ip; 719 720 memcpy((void *)&ip, (void *)from, sizeof(ip)); 721 return ip; 722 } 723 724 /* return ulong *in network byteorder* */ 725 static inline u32 net_read_u32(u32 *from) 726 { 727 u32 l; 728 729 memcpy((void *)&l, (void *)from, sizeof(l)); 730 return l; 731 } 732 733 /* write IP *in network byteorder* */ 734 static inline void net_write_ip(void *to, struct in_addr ip) 735 { 736 memcpy(to, (void *)&ip, sizeof(ip)); 737 } 738 739 /* copy IP */ 740 static inline void net_copy_ip(void *to, void *from) 741 { 742 memcpy((void *)to, from, sizeof(struct in_addr)); 743 } 744 745 /* copy ulong */ 746 static inline void net_copy_u32(u32 *to, u32 *from) 747 { 748 memcpy((void *)to, (void *)from, sizeof(u32)); 749 } 750 751 /** 752 * is_zero_ethaddr - Determine if give Ethernet address is all zeros. 753 * @addr: Pointer to a six-byte array containing the Ethernet address 754 * 755 * Return true if the address is all zeroes. 756 */ 757 static inline int is_zero_ethaddr(const u8 *addr) 758 { 759 return !(addr[0] | addr[1] | addr[2] | addr[3] | addr[4] | addr[5]); 760 } 761 762 /** 763 * is_multicast_ethaddr - Determine if the Ethernet address is a multicast. 764 * @addr: Pointer to a six-byte array containing the Ethernet address 765 * 766 * Return true if the address is a multicast address. 767 * By definition the broadcast address is also a multicast address. 768 */ 769 static inline int is_multicast_ethaddr(const u8 *addr) 770 { 771 return 0x01 & addr[0]; 772 } 773 774 /* 775 * is_broadcast_ethaddr - Determine if the Ethernet address is broadcast 776 * @addr: Pointer to a six-byte array containing the Ethernet address 777 * 778 * Return true if the address is the broadcast address. 779 */ 780 static inline int is_broadcast_ethaddr(const u8 *addr) 781 { 782 return (addr[0] & addr[1] & addr[2] & addr[3] & addr[4] & addr[5]) == 783 0xff; 784 } 785 786 /* 787 * is_valid_ethaddr - Determine if the given Ethernet address is valid 788 * @addr: Pointer to a six-byte array containing the Ethernet address 789 * 790 * Check that the Ethernet address (MAC) is not 00:00:00:00:00:00, is not 791 * a multicast address, and is not FF:FF:FF:FF:FF:FF. 792 * 793 * Return true if the address is valid. 794 */ 795 static inline int is_valid_ethaddr(const u8 *addr) 796 { 797 /* FF:FF:FF:FF:FF:FF is a multicast address so we don't need to 798 * explicitly check for it here. */ 799 return !is_multicast_ethaddr(addr) && !is_zero_ethaddr(addr); 800 } 801 802 /** 803 * net_random_ethaddr - Generate software assigned random Ethernet address 804 * @addr: Pointer to a six-byte array containing the Ethernet address 805 * 806 * Generate a random Ethernet address (MAC) that is not multicast 807 * and has the local assigned bit set. 808 */ 809 static inline void net_random_ethaddr(uchar *addr) 810 { 811 int i; 812 unsigned int seed = get_timer(0); 813 814 for (i = 0; i < 6; i++) 815 addr[i] = rand_r(&seed); 816 817 addr[0] &= 0xfe; /* clear multicast bit */ 818 addr[0] |= 0x02; /* set local assignment bit (IEEE802) */ 819 } 820 821 /* Convert an IP address to a string */ 822 void ip_to_string(struct in_addr x, char *s); 823 824 /* Convert a string to ip address */ 825 struct in_addr string_to_ip(const char *s); 826 827 /* Convert a VLAN id to a string */ 828 void vlan_to_string(ushort x, char *s); 829 830 /* Convert a string to a vlan id */ 831 ushort string_to_vlan(const char *s); 832 833 /* read a VLAN id from an environment variable */ 834 ushort env_get_vlan(char *); 835 836 /* copy a filename (allow for "..." notation, limit length) */ 837 void copy_filename(char *dst, const char *src, int size); 838 839 /* get a random source port */ 840 unsigned int random_port(void); 841 842 /** 843 * update_tftp - Update firmware over TFTP (via DFU) 844 * 845 * This function updates board's firmware via TFTP 846 * 847 * @param addr - memory address where data is stored 848 * @param interface - the DFU medium name - e.g. "mmc" 849 * @param devstring - the DFU medium number - e.g. "1" 850 * 851 * @return - 0 on success, other value on failure 852 */ 853 int update_tftp(ulong addr, char *interface, char *devstring); 854 855 /**********************************************************************/ 856 857 #endif /* __NET_H__ */ 858