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