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