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