include/net.h

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