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