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