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