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