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