include/net.h

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