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 #if defined(CONFIG_8xx) 16 #include <commproc.h> 17 #endif /* CONFIG_8xx */ 18 19 #include <asm/cache.h> 20 #include <asm/byteorder.h> /* for nton* / ntoh* stuff */ 21 22 #define DEBUG_LL_STATE 0 /* Link local state machine changes */ 23 #define DEBUG_DEV_PKT 0 /* Packets or info directed to the device */ 24 #define DEBUG_NET_PKT 0 /* Packets on info on the network at large */ 25 #define DEBUG_INT_STATE 0 /* Internal network state changes */ 26 27 /* 28 * The number of receive packet buffers, and the required packet buffer 29 * alignment in memory. 30 * 31 */ 32 33 #ifdef CONFIG_SYS_RX_ETH_BUFFER 34 # define PKTBUFSRX CONFIG_SYS_RX_ETH_BUFFER 35 #else 36 # define PKTBUFSRX 4 37 #endif 38 39 #define PKTALIGN ARCH_DMA_MINALIGN 40 41 /* ARP hardware address length */ 42 #define ARP_HLEN 6 43 44 /* IPv4 addresses are always 32 bits in size */ 45 struct in_addr { 46 __be32 s_addr; 47 }; 48 49 /** 50 * An incoming packet handler. 51 * @param pkt pointer to the application packet 52 * @param dport destination UDP port 53 * @param sip source IP address 54 * @param sport source UDP port 55 * @param len packet length 56 */ 57 typedef void rxhand_f(uchar *pkt, unsigned dport, 58 struct in_addr sip, unsigned sport, 59 unsigned len); 60 61 /** 62 * An incoming ICMP packet handler. 63 * @param type ICMP type 64 * @param code ICMP code 65 * @param dport destination UDP port 66 * @param sip source IP address 67 * @param sport source UDP port 68 * @param pkt pointer to the ICMP packet data 69 * @param len packet length 70 */ 71 typedef void rxhand_icmp_f(unsigned type, unsigned code, unsigned dport, 72 struct in_addr sip, unsigned sport, uchar *pkt, unsigned len); 73 74 /* 75 * A timeout handler. Called after time interval has expired. 76 */ 77 typedef void thand_f(void); 78 79 enum eth_state_t { 80 ETH_STATE_INIT, 81 ETH_STATE_PASSIVE, 82 ETH_STATE_ACTIVE 83 }; 84 85 #ifdef CONFIG_DM_ETH 86 /** 87 * struct eth_pdata - Platform data for Ethernet MAC controllers 88 * 89 * @iobase: The base address of the hardware registers 90 * @enetaddr: The Ethernet MAC address that is loaded from EEPROM or env 91 * @phy_interface: PHY interface to use - see PHY_INTERFACE_MODE_... 92 * @max_speed: Maximum speed of Ethernet connection supported by MAC 93 */ 94 struct eth_pdata { 95 phys_addr_t iobase; 96 unsigned char enetaddr[ARP_HLEN]; 97 int phy_interface; 98 int max_speed; 99 }; 100 101 enum eth_recv_flags { 102 /* 103 * Check hardware device for new packets (otherwise only return those 104 * which are already in the memory buffer ready to process) 105 */ 106 ETH_RECV_CHECK_DEVICE = 1 << 0, 107 }; 108 109 /** 110 * struct eth_ops - functions of Ethernet MAC controllers 111 * 112 * start: Prepare the hardware to send and receive packets 113 * send: Send the bytes passed in "packet" as a packet on the wire 114 * recv: Check if the hardware received a packet. If so, set the pointer to the 115 * packet buffer in the packetp parameter. If not, return an error or 0 to 116 * indicate that the hardware receive FIFO is empty. If 0 is returned, the 117 * network stack will not process the empty packet, but free_pkt() will be 118 * called if supplied 119 * free_pkt: Give the driver an opportunity to manage its packet buffer memory 120 * when the network stack is finished processing it. This will only be 121 * called when no error was returned from recv - optional 122 * stop: Stop the hardware from looking for packets - may be called even if 123 * state == PASSIVE 124 * mcast: Join or leave a multicast group (for TFTP) - optional 125 * write_hwaddr: Write a MAC address to the hardware (used to pass it to Linux 126 * on some platforms like ARM). This function expects the 127 * eth_pdata::enetaddr field to be populated. The method can 128 * return -ENOSYS to indicate that this is not implemented for 129 this hardware - optional. 130 * read_rom_hwaddr: Some devices have a backup of the MAC address stored in a 131 * ROM on the board. This is how the driver should expose it 132 * to the network stack. This function should fill in the 133 * eth_pdata::enetaddr field - optional 134 */ 135 struct eth_ops { 136 int (*start)(struct udevice *dev); 137 int (*send)(struct udevice *dev, void *packet, int length); 138 int (*recv)(struct udevice *dev, int flags, uchar **packetp); 139 int (*free_pkt)(struct udevice *dev, uchar *packet, int length); 140 void (*stop)(struct udevice *dev); 141 #ifdef CONFIG_MCAST_TFTP 142 int (*mcast)(struct udevice *dev, const u8 *enetaddr, int join); 143 #endif 144 int (*write_hwaddr)(struct udevice *dev); 145 int (*read_rom_hwaddr)(struct udevice *dev); 146 }; 147 148 #define eth_get_ops(dev) ((struct eth_ops *)(dev)->driver->ops) 149 150 struct udevice *eth_get_dev(void); /* get the current device */ 151 /* 152 * The devname can be either an exact name given by the driver or device tree 153 * or it can be an alias of the form "eth%d" 154 */ 155 struct udevice *eth_get_dev_by_name(const char *devname); 156 unsigned char *eth_get_ethaddr(void); /* get the current device MAC */ 157 158 /* Used only when NetConsole is enabled */ 159 int eth_is_active(struct udevice *dev); /* Test device for active state */ 160 int eth_init_state_only(void); /* Set active state */ 161 void eth_halt_state_only(void); /* Set passive state */ 162 #endif 163 164 #ifndef CONFIG_DM_ETH 165 struct eth_device { 166 char name[16]; 167 unsigned char enetaddr[ARP_HLEN]; 168 phys_addr_t iobase; 169 int state; 170 171 int (*init)(struct eth_device *, bd_t *); 172 int (*send)(struct eth_device *, void *packet, int length); 173 int (*recv)(struct eth_device *); 174 void (*halt)(struct eth_device *); 175 #ifdef CONFIG_MCAST_TFTP 176 int (*mcast)(struct eth_device *, const u8 *enetaddr, u8 set); 177 #endif 178 int (*write_hwaddr)(struct eth_device *); 179 struct eth_device *next; 180 int index; 181 void *priv; 182 }; 183 184 int eth_register(struct eth_device *dev);/* Register network device */ 185 int eth_unregister(struct eth_device *dev);/* Remove network device */ 186 187 extern struct eth_device *eth_current; 188 189 static __always_inline struct eth_device *eth_get_dev(void) 190 { 191 return eth_current; 192 } 193 struct eth_device *eth_get_dev_by_name(const char *devname); 194 struct eth_device *eth_get_dev_by_index(int index); /* get dev @ index */ 195 196 /* get the current device MAC */ 197 static inline unsigned char *eth_get_ethaddr(void) 198 { 199 if (eth_current) 200 return eth_current->enetaddr; 201 return NULL; 202 } 203 204 /* Used only when NetConsole is enabled */ 205 int eth_is_active(struct eth_device *dev); /* Test device for active state */ 206 /* Set active state */ 207 static __always_inline int eth_init_state_only(void) 208 { 209 eth_get_dev()->state = ETH_STATE_ACTIVE; 210 211 return 0; 212 } 213 /* Set passive state */ 214 static __always_inline void eth_halt_state_only(void) 215 { 216 eth_get_dev()->state = ETH_STATE_PASSIVE; 217 } 218 219 /* 220 * Set the hardware address for an ethernet interface based on 'eth%daddr' 221 * environment variable (or just 'ethaddr' if eth_number is 0). 222 * Args: 223 * base_name - base name for device (normally "eth") 224 * eth_number - value of %d (0 for first device of this type) 225 * Returns: 226 * 0 is success, non-zero is error status from driver. 227 */ 228 int eth_write_hwaddr(struct eth_device *dev, const char *base_name, 229 int eth_number); 230 231 int usb_eth_initialize(bd_t *bi); 232 #endif 233 234 int eth_initialize(void); /* Initialize network subsystem */ 235 void eth_try_another(int first_restart); /* Change the device */ 236 void eth_set_current(void); /* set nterface to ethcur var */ 237 238 int eth_get_dev_index(void); /* get the device index */ 239 void eth_parse_enetaddr(const char *addr, uchar *enetaddr); 240 int eth_getenv_enetaddr(const char *name, uchar *enetaddr); 241 int eth_setenv_enetaddr(const char *name, const uchar *enetaddr); 242 243 /** 244 * eth_setenv_enetaddr_by_index() - set the MAC address environment variable 245 * 246 * This sets up an environment variable with the given MAC address (@enetaddr). 247 * The environment variable to be set is defined by <@base_name><@index>addr. 248 * If @index is 0 it is omitted. For common Ethernet this means ethaddr, 249 * eth1addr, etc. 250 * 251 * @base_name: Base name for variable, typically "eth" 252 * @index: Index of interface being updated (>=0) 253 * @enetaddr: Pointer to MAC address to put into the variable 254 * @return 0 if OK, other value on error 255 */ 256 int eth_setenv_enetaddr_by_index(const char *base_name, int index, 257 uchar *enetaddr); 258 259 260 /* 261 * Initialize USB ethernet device with CONFIG_DM_ETH 262 * Returns: 263 * 0 is success, non-zero is error status. 264 */ 265 int usb_ether_init(void); 266 267 /* 268 * Get the hardware address for an ethernet interface . 269 * Args: 270 * base_name - base name for device (normally "eth") 271 * index - device index number (0 for first) 272 * enetaddr - returns 6 byte hardware address 273 * Returns: 274 * Return true if the address is valid. 275 */ 276 int eth_getenv_enetaddr_by_index(const char *base_name, int index, 277 uchar *enetaddr); 278 279 int eth_init(void); /* Initialize the device */ 280 int eth_send(void *packet, int length); /* Send a packet */ 281 282 #if defined(CONFIG_API) || defined(CONFIG_EFI_LOADER) 283 int eth_receive(void *packet, int length); /* Receive a packet*/ 284 extern void (*push_packet)(void *packet, int length); 285 #endif 286 int eth_rx(void); /* Check for received packets */ 287 void eth_halt(void); /* stop SCC */ 288 const char *eth_get_name(void); /* get name of current device */ 289 290 #ifdef CONFIG_MCAST_TFTP 291 int eth_mcast_join(struct in_addr mcast_addr, int join); 292 u32 ether_crc(size_t len, unsigned char const *p); 293 #endif 294 295 296 /**********************************************************************/ 297 /* 298 * Protocol headers. 299 */ 300 301 /* 302 * Ethernet header 303 */ 304 305 struct ethernet_hdr { 306 u8 et_dest[ARP_HLEN]; /* Destination node */ 307 u8 et_src[ARP_HLEN]; /* Source node */ 308 u16 et_protlen; /* Protocol or length */ 309 }; 310 311 /* Ethernet header size */ 312 #define ETHER_HDR_SIZE (sizeof(struct ethernet_hdr)) 313 314 #define ETH_FCS_LEN 4 /* Octets in the FCS */ 315 316 struct e802_hdr { 317 u8 et_dest[ARP_HLEN]; /* Destination node */ 318 u8 et_src[ARP_HLEN]; /* Source node */ 319 u16 et_protlen; /* Protocol or length */ 320 u8 et_dsap; /* 802 DSAP */ 321 u8 et_ssap; /* 802 SSAP */ 322 u8 et_ctl; /* 802 control */ 323 u8 et_snap1; /* SNAP */ 324 u8 et_snap2; 325 u8 et_snap3; 326 u16 et_prot; /* 802 protocol */ 327 }; 328 329 /* 802 + SNAP + ethernet header size */ 330 #define E802_HDR_SIZE (sizeof(struct e802_hdr)) 331 332 /* 333 * Virtual LAN Ethernet header 334 */ 335 struct vlan_ethernet_hdr { 336 u8 vet_dest[ARP_HLEN]; /* Destination node */ 337 u8 vet_src[ARP_HLEN]; /* Source node */ 338 u16 vet_vlan_type; /* PROT_VLAN */ 339 u16 vet_tag; /* TAG of VLAN */ 340 u16 vet_type; /* protocol type */ 341 }; 342 343 /* VLAN Ethernet header size */ 344 #define VLAN_ETHER_HDR_SIZE (sizeof(struct vlan_ethernet_hdr)) 345 346 #define PROT_IP 0x0800 /* IP protocol */ 347 #define PROT_ARP 0x0806 /* IP ARP 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 }; 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 }; 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 }; 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 }; 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 540 }; 541 542 extern char net_boot_file_name[1024];/* Boot File name */ 543 /* The actual transferred size of the bootfile (in bytes) */ 544 extern u32 net_boot_file_size; 545 /* Boot file size in blocks as reported by the DHCP server */ 546 extern u32 net_boot_file_expected_size_in_blocks; 547 548 #if defined(CONFIG_CMD_DNS) 549 extern char *net_dns_resolve; /* The host to resolve */ 550 extern char *net_dns_env_var; /* the env var to put the ip into */ 551 #endif 552 553 #if defined(CONFIG_CMD_PING) 554 extern struct in_addr net_ping_ip; /* the ip address to ping */ 555 #endif 556 557 #if defined(CONFIG_CMD_CDP) 558 /* when CDP completes these hold the return values */ 559 extern ushort cdp_native_vlan; /* CDP returned native VLAN */ 560 extern ushort cdp_appliance_vlan; /* CDP returned appliance VLAN */ 561 562 /* 563 * Check for a CDP packet by examining the received MAC address field 564 */ 565 static inline int is_cdp_packet(const uchar *ethaddr) 566 { 567 extern const u8 net_cdp_ethaddr[ARP_HLEN]; 568 569 return memcmp(ethaddr, net_cdp_ethaddr, ARP_HLEN) == 0; 570 } 571 #endif 572 573 #if defined(CONFIG_CMD_SNTP) 574 extern struct in_addr net_ntp_server; /* the ip address to NTP */ 575 extern int net_ntp_time_offset; /* offset time from UTC */ 576 #endif 577 578 #if defined(CONFIG_MCAST_TFTP) 579 extern struct in_addr net_mcast_addr; 580 #endif 581 582 /* Initialize the network adapter */ 583 void net_init(void); 584 int net_loop(enum proto_t); 585 586 /* Load failed. Start again. */ 587 int net_start_again(void); 588 589 /* Get size of the ethernet header when we send */ 590 int net_eth_hdr_size(void); 591 592 /* Set ethernet header; returns the size of the header */ 593 int net_set_ether(uchar *xet, const uchar *dest_ethaddr, uint prot); 594 int net_update_ether(struct ethernet_hdr *et, uchar *addr, uint prot); 595 596 /* Set IP header */ 597 void net_set_ip_header(uchar *pkt, struct in_addr dest, struct in_addr source); 598 void net_set_udp_header(uchar *pkt, struct in_addr dest, int dport, 599 int sport, int len); 600 601 /** 602 * compute_ip_checksum() - Compute IP checksum 603 * 604 * @addr: Address to check (must be 16-bit aligned) 605 * @nbytes: Number of bytes to check (normally a multiple of 2) 606 * @return 16-bit IP checksum 607 */ 608 unsigned compute_ip_checksum(const void *addr, unsigned nbytes); 609 610 /** 611 * add_ip_checksums() - add two IP checksums 612 * 613 * @offset: Offset of first sum (if odd we do a byte-swap) 614 * @sum: First checksum 615 * @new_sum: New checksum to add 616 * @return updated 16-bit IP checksum 617 */ 618 unsigned add_ip_checksums(unsigned offset, unsigned sum, unsigned new_sum); 619 620 /** 621 * ip_checksum_ok() - check if a checksum is correct 622 * 623 * This works by making sure the checksum sums to 0 624 * 625 * @addr: Address to check (must be 16-bit aligned) 626 * @nbytes: Number of bytes to check (normally a multiple of 2) 627 * @return true if the checksum matches, false if not 628 */ 629 int ip_checksum_ok(const void *addr, unsigned nbytes); 630 631 /* Callbacks */ 632 rxhand_f *net_get_udp_handler(void); /* Get UDP RX packet handler */ 633 void net_set_udp_handler(rxhand_f *); /* Set UDP RX packet handler */ 634 rxhand_f *net_get_arp_handler(void); /* Get ARP RX packet handler */ 635 void net_set_arp_handler(rxhand_f *); /* Set ARP RX packet handler */ 636 void net_set_icmp_handler(rxhand_icmp_f *f); /* Set ICMP RX handler */ 637 void net_set_timeout_handler(ulong, thand_f *);/* Set timeout handler */ 638 639 /* Network loop state */ 640 enum net_loop_state { 641 NETLOOP_CONTINUE, 642 NETLOOP_RESTART, 643 NETLOOP_SUCCESS, 644 NETLOOP_FAIL 645 }; 646 extern enum net_loop_state net_state; 647 648 static inline void net_set_state(enum net_loop_state state) 649 { 650 debug_cond(DEBUG_INT_STATE, "--- NetState set to %d\n", state); 651 net_state = state; 652 } 653 654 /* Transmit a packet */ 655 static inline void net_send_packet(uchar *pkt, int len) 656 { 657 /* Currently no way to return errors from eth_send() */ 658 (void) eth_send(pkt, len); 659 } 660 661 /* 662 * Transmit "net_tx_packet" as UDP packet, performing ARP request if needed 663 * (ether will be populated) 664 * 665 * @param ether Raw packet buffer 666 * @param dest IP address to send the datagram to 667 * @param dport Destination UDP port 668 * @param sport Source UDP port 669 * @param payload_len Length of data after the UDP header 670 */ 671 int net_send_udp_packet(uchar *ether, struct in_addr dest, int dport, 672 int sport, int payload_len); 673 674 /* Processes a received packet */ 675 void net_process_received_packet(uchar *in_packet, int len); 676 677 #ifdef CONFIG_NETCONSOLE 678 void nc_start(void); 679 int nc_input_packet(uchar *pkt, struct in_addr src_ip, unsigned dest_port, 680 unsigned src_port, unsigned len); 681 #endif 682 683 static __always_inline int eth_is_on_demand_init(void) 684 { 685 #ifdef CONFIG_NETCONSOLE 686 extern enum proto_t net_loop_last_protocol; 687 688 return net_loop_last_protocol != NETCONS; 689 #else 690 return 1; 691 #endif 692 } 693 694 static inline void eth_set_last_protocol(int protocol) 695 { 696 #ifdef CONFIG_NETCONSOLE 697 extern enum proto_t net_loop_last_protocol; 698 699 net_loop_last_protocol = protocol; 700 #endif 701 } 702 703 /* 704 * Check if autoload is enabled. If so, use either NFS or TFTP to download 705 * the boot file. 706 */ 707 void net_auto_load(void); 708 709 /* 710 * The following functions are a bit ugly, but necessary to deal with 711 * alignment restrictions on ARM. 712 * 713 * We're using inline functions, which had the smallest memory 714 * footprint in our tests. 715 */ 716 /* return IP *in network byteorder* */ 717 static inline struct in_addr net_read_ip(void *from) 718 { 719 struct in_addr ip; 720 721 memcpy((void *)&ip, (void *)from, sizeof(ip)); 722 return ip; 723 } 724 725 /* return ulong *in network byteorder* */ 726 static inline u32 net_read_u32(u32 *from) 727 { 728 u32 l; 729 730 memcpy((void *)&l, (void *)from, sizeof(l)); 731 return l; 732 } 733 734 /* write IP *in network byteorder* */ 735 static inline void net_write_ip(void *to, struct in_addr ip) 736 { 737 memcpy(to, (void *)&ip, sizeof(ip)); 738 } 739 740 /* copy IP */ 741 static inline void net_copy_ip(void *to, void *from) 742 { 743 memcpy((void *)to, from, sizeof(struct in_addr)); 744 } 745 746 /* copy ulong */ 747 static inline void net_copy_u32(u32 *to, u32 *from) 748 { 749 memcpy((void *)to, (void *)from, sizeof(u32)); 750 } 751 752 /** 753 * is_zero_ethaddr - Determine if give Ethernet address is all zeros. 754 * @addr: Pointer to a six-byte array containing the Ethernet address 755 * 756 * Return true if the address is all zeroes. 757 */ 758 static inline int is_zero_ethaddr(const u8 *addr) 759 { 760 return !(addr[0] | addr[1] | addr[2] | addr[3] | addr[4] | addr[5]); 761 } 762 763 /** 764 * is_multicast_ethaddr - Determine if the Ethernet address is a multicast. 765 * @addr: Pointer to a six-byte array containing the Ethernet address 766 * 767 * Return true if the address is a multicast address. 768 * By definition the broadcast address is also a multicast address. 769 */ 770 static inline int is_multicast_ethaddr(const u8 *addr) 771 { 772 return 0x01 & addr[0]; 773 } 774 775 /* 776 * is_broadcast_ethaddr - Determine if the Ethernet address is broadcast 777 * @addr: Pointer to a six-byte array containing the Ethernet address 778 * 779 * Return true if the address is the broadcast address. 780 */ 781 static inline int is_broadcast_ethaddr(const u8 *addr) 782 { 783 return (addr[0] & addr[1] & addr[2] & addr[3] & addr[4] & addr[5]) == 784 0xff; 785 } 786 787 /* 788 * is_valid_ethaddr - Determine if the given Ethernet address is valid 789 * @addr: Pointer to a six-byte array containing the Ethernet address 790 * 791 * Check that the Ethernet address (MAC) is not 00:00:00:00:00:00, is not 792 * a multicast address, and is not FF:FF:FF:FF:FF:FF. 793 * 794 * Return true if the address is valid. 795 */ 796 static inline int is_valid_ethaddr(const u8 *addr) 797 { 798 /* FF:FF:FF:FF:FF:FF is a multicast address so we don't need to 799 * explicitly check for it here. */ 800 return !is_multicast_ethaddr(addr) && !is_zero_ethaddr(addr); 801 } 802 803 /** 804 * net_random_ethaddr - Generate software assigned random Ethernet address 805 * @addr: Pointer to a six-byte array containing the Ethernet address 806 * 807 * Generate a random Ethernet address (MAC) that is not multicast 808 * and has the local assigned bit set. 809 */ 810 static inline void net_random_ethaddr(uchar *addr) 811 { 812 int i; 813 unsigned int seed = get_timer(0); 814 815 for (i = 0; i < 6; i++) 816 addr[i] = rand_r(&seed); 817 818 addr[0] &= 0xfe; /* clear multicast bit */ 819 addr[0] |= 0x02; /* set local assignment bit (IEEE802) */ 820 } 821 822 /* Convert an IP address to a string */ 823 void ip_to_string(struct in_addr x, char *s); 824 825 /* Convert a string to ip address */ 826 struct in_addr string_to_ip(const char *s); 827 828 /* Convert a VLAN id to a string */ 829 void vlan_to_string(ushort x, char *s); 830 831 /* Convert a string to a vlan id */ 832 ushort string_to_vlan(const char *s); 833 834 /* read a VLAN id from an environment variable */ 835 ushort getenv_vlan(char *); 836 837 /* copy a filename (allow for "..." notation, limit length) */ 838 void copy_filename(char *dst, const char *src, int size); 839 840 /* get a random source port */ 841 unsigned int random_port(void); 842 843 /** 844 * update_tftp - Update firmware over TFTP (via DFU) 845 * 846 * This function updates board's firmware via TFTP 847 * 848 * @param addr - memory address where data is stored 849 * @param interface - the DFU medium name - e.g. "mmc" 850 * @param devstring - the DFU medium number - e.g. "1" 851 * 852 * @return - 0 on success, other value on failure 853 */ 854 int update_tftp(ulong addr, char *interface, char *devstring); 855 856 /**********************************************************************/ 857 858 #endif /* __NET_H__ */ 859