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