include/net.h

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