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