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