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