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