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