include/net.h

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