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