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