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