include/net.h

   1 /*
   2  *      LiMon Monitor (LiMon) - Network.
   3  *
   4  *      Copyright 1994 - 2000 Neil Russell.
   5  *      (See License)
   6  *
   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
  23 /*
  24  *      The number of receive packet buffers, and the required packet buffer
  25  *      alignment in memory.
  26  *
  27  */
  28
  29 #ifdef CONFIG_SYS_RX_ETH_BUFFER
  30 # define PKTBUFSRX      CONFIG_SYS_RX_ETH_BUFFER
  31 #else
  32 # define PKTBUFSRX      4
  33 #endif
  34
  35 #define PKTALIGN        ARCH_DMA_MINALIGN
  36
  37 /* IPv4 addresses are always 32 bits in size */
  38 typedef u32             IPaddr_t;
  39
  40
  41 /**
  42  * An incoming packet handler.
  43  * @param pkt    pointer to the application packet
  44  * @param dport  destination UDP port
  45  * @param sip    source IP address
  46  * @param sport  source UDP port
  47  * @param len    packet length
  48  */
  49 typedef void rxhand_f(uchar *pkt, unsigned dport,
  50                       IPaddr_t sip, unsigned sport,
  51                       unsigned len);
  52
  53 /**
  54  * An incoming ICMP packet handler.
  55  * @param type  ICMP type
  56  * @param code  ICMP code
  57  * @param dport destination UDP port
  58  * @param sip   source IP address
  59  * @param sport source UDP port
  60  * @param pkt   pointer to the ICMP packet data
  61  * @param len   packet length
  62  */
  63 typedef void rxhand_icmp_f(unsigned type, unsigned code, unsigned dport,
  64                 IPaddr_t sip, unsigned sport, uchar *pkt, unsigned len);
  65
  66 /*
  67  *      A timeout handler.  Called after time interval has expired.
  68  */
  69 typedef void    thand_f(void);
  70
  71 enum eth_state_t {
  72         ETH_STATE_INIT,
  73         ETH_STATE_PASSIVE,
  74         ETH_STATE_ACTIVE
  75 };
  76
  77 struct eth_device {
  78         char name[16];
  79         unsigned char enetaddr[6];
  80         int iobase;
  81         int state;
  82
  83         int  (*init) (struct eth_device *, bd_t *);
  84         int  (*send) (struct eth_device *, void *packet, int length);
  85         int  (*recv) (struct eth_device *);
  86         void (*halt) (struct eth_device *);
  87 #ifdef CONFIG_MCAST_TFTP
  88         int (*mcast) (struct eth_device *, u32 ip, u8 set);
  89 #endif
  90         int  (*write_hwaddr) (struct eth_device *);
  91         struct eth_device *next;
  92         int index;
  93         void *priv;
  94 };
  95
  96 extern int eth_initialize(bd_t *bis);   /* Initialize network subsystem */
  97 extern int eth_register(struct eth_device* dev);/* Register network device */
  98 extern int eth_unregister(struct eth_device *dev);/* Remove network device */
  99 extern void eth_try_another(int first_restart); /* Change the device */
 100 extern void eth_set_current(void);              /* set nterface to ethcur var */
 101 extern struct eth_device *eth_get_dev(void);    /* get the current device MAC */
 102 extern struct eth_device *eth_get_dev_by_name(const char *devname);
 103 extern struct eth_device *eth_get_dev_by_index(int index); /* get dev @ index */
 104 extern int eth_get_dev_index(void);             /* get the device index */
 105 extern void eth_parse_enetaddr(const char *addr, uchar *enetaddr);
 106 extern int eth_getenv_enetaddr(char *name, uchar *enetaddr);
 107 extern int eth_setenv_enetaddr(char *name, const uchar *enetaddr);
 108
 109 /*
 110  * Get the hardware address for an ethernet interface .
 111  * Args:
 112  *      base_name - base name for device (normally "eth")
 113  *      index - device index number (0 for first)
 114  *      enetaddr - returns 6 byte hardware address
 115  * Returns:
 116  *      Return true if the address is valid.
 117  */
 118 extern int eth_getenv_enetaddr_by_index(const char *base_name, int index,
 119                                         uchar *enetaddr);
 120
 121 extern int usb_eth_initialize(bd_t *bi);
 122 extern int eth_init(bd_t *bis);                 /* Initialize the device */
 123 extern int eth_send(void *packet, int length);     /* Send a packet */
 124
 125 #ifdef CONFIG_API
 126 extern int eth_receive(void *packet, int length); /* Receive a packet*/
 127 extern void (*push_packet)(void *packet, int length);
 128 #endif
 129 extern int eth_rx(void);                        /* Check for received packets */
 130 extern void eth_halt(void);                     /* stop SCC */
 131 extern char *eth_get_name(void);                /* get name of current device */
 132
 133 /*
 134  * Set the hardware address for an ethernet interface based on 'eth%daddr'
 135  * environment variable (or just 'ethaddr' if eth_number is 0).
 136  * Args:
 137  *      base_name - base name for device (normally "eth")
 138  *      eth_number - value of %d (0 for first device of this type)
 139  * Returns:
 140  *      0 is success, non-zero is error status from driver.
 141  */
 142 int eth_write_hwaddr(struct eth_device *dev, const char *base_name,
 143                      int eth_number);
 144
 145 #ifdef CONFIG_MCAST_TFTP
 146 int eth_mcast_join(IPaddr_t mcast_addr, u8 join);
 147 u32 ether_crc(size_t len, unsigned char const *p);
 148 #endif
 149
 150
 151 /**********************************************************************/
 152 /*
 153  *      Protocol headers.
 154  */
 155
 156 /*
 157  *      Ethernet header
 158  */
 159 typedef struct {
 160         uchar           et_dest[6];     /* Destination node             */
 161         uchar           et_src[6];      /* Source node                  */
 162         ushort          et_protlen;     /* Protocol or length           */
 163         uchar           et_dsap;        /* 802 DSAP                     */
 164         uchar           et_ssap;        /* 802 SSAP                     */
 165         uchar           et_ctl;         /* 802 control                  */
 166         uchar           et_snap1;       /* SNAP                         */
 167         uchar           et_snap2;
 168         uchar           et_snap3;
 169         ushort          et_prot;        /* 802 protocol                 */
 170 } Ethernet_t;
 171
 172 #define ETHER_HDR_SIZE  14              /* Ethernet header size         */
 173 #define E802_HDR_SIZE   22              /* 802 ethernet header size     */
 174
 175 /*
 176  *      Ethernet header
 177  */
 178 typedef struct {
 179         uchar           vet_dest[6];    /* Destination node             */
 180         uchar           vet_src[6];     /* Source node                  */
 181         ushort          vet_vlan_type;  /* PROT_VLAN                    */
 182         ushort          vet_tag;        /* TAG of VLAN                  */
 183         ushort          vet_type;       /* protocol type                */
 184 } VLAN_Ethernet_t;
 185
 186 #define VLAN_ETHER_HDR_SIZE     18      /* VLAN Ethernet header size    */
 187
 188 #define PROT_IP         0x0800          /* IP protocol                  */
 189 #define PROT_ARP        0x0806          /* IP ARP protocol              */
 190 #define PROT_RARP       0x8035          /* IP ARP protocol              */
 191 #define PROT_VLAN       0x8100          /* IEEE 802.1q protocol         */
 192
 193 #define IPPROTO_ICMP     1      /* Internet Control Message Protocol    */
 194 #define IPPROTO_UDP     17      /* User Datagram Protocol               */
 195
 196 /*
 197  *      Internet Protocol (IP) + UDP header.
 198  */
 199 struct ip_udp_hdr {
 200         uchar           ip_hl_v;        /* header length and version    */
 201         uchar           ip_tos;         /* type of service              */
 202         ushort          ip_len;         /* total length                 */
 203         ushort          ip_id;          /* identification               */
 204         ushort          ip_off;         /* fragment offset field        */
 205         uchar           ip_ttl;         /* time to live                 */
 206         uchar           ip_p;           /* protocol                     */
 207         ushort          ip_sum;         /* checksum                     */
 208         IPaddr_t        ip_src;         /* Source IP address            */
 209         IPaddr_t        ip_dst;         /* Destination IP address       */
 210         ushort          udp_src;        /* UDP source port              */
 211         ushort          udp_dst;        /* UDP destination port         */
 212         ushort          udp_len;        /* Length of UDP packet         */
 213         ushort          udp_xsum;       /* Checksum                     */
 214 };
 215
 216 #define IP_OFFS         0x1fff /* ip offset *= 8 */
 217 #define IP_FLAGS        0xe000 /* first 3 bits */
 218 #define IP_FLAGS_RES    0x8000 /* reserved */
 219 #define IP_FLAGS_DFRAG  0x4000 /* don't fragments */
 220 #define IP_FLAGS_MFRAG  0x2000 /* more fragments */
 221
 222 #define IP_HDR_SIZE_NO_UDP      (sizeof(struct ip_udp_hdr) - 8)
 223
 224 #define IP_UDP_HDR_SIZE         (sizeof(struct ip_udp_hdr))
 225 #define UDP_HDR_SIZE            (IP_UDP_HDR_SIZE - IP_HDR_SIZE_NO_UDP)
 226
 227 /*
 228  *      Address Resolution Protocol (ARP) header.
 229  */
 230 typedef struct
 231 {
 232         ushort          ar_hrd;         /* Format of hardware address   */
 233 #   define ARP_ETHER        1           /* Ethernet  hardware address   */
 234         ushort          ar_pro;         /* Format of protocol address   */
 235         uchar           ar_hln;         /* Length of hardware address   */
 236         uchar           ar_pln;         /* Length of protocol address   */
 237         ushort          ar_op;          /* Operation                    */
 238 #   define ARPOP_REQUEST    1           /* Request  to resolve  address */
 239 #   define ARPOP_REPLY      2           /* Response to previous request */
 240
 241 #   define RARPOP_REQUEST   3           /* Request  to resolve  address */
 242 #   define RARPOP_REPLY     4           /* Response to previous request */
 243
 244         /*
 245          * The remaining fields are variable in size, according to
 246          * the sizes above, and are defined as appropriate for
 247          * specific hardware/protocol combinations.
 248          */
 249         uchar           ar_data[0];
 250 #if 0
 251         uchar           ar_sha[];       /* Sender hardware address      */
 252         uchar           ar_spa[];       /* Sender protocol address      */
 253         uchar           ar_tha[];       /* Target hardware address      */
 254         uchar           ar_tpa[];       /* Target protocol address      */
 255 #endif /* 0 */
 256 } ARP_t;
 257
 258 #define ARP_HDR_SIZE    (8+20)          /* Size assuming ethernet       */
 259
 260 /*
 261  * ICMP stuff (just enough to handle (host) redirect messages)
 262  */
 263 #define ICMP_ECHO_REPLY         0       /* Echo reply                   */
 264 #define ICMP_NOT_REACH          3       /* Detination unreachable       */
 265 #define ICMP_REDIRECT           5       /* Redirect (change route)      */
 266 #define ICMP_ECHO_REQUEST       8       /* Echo request                 */
 267
 268 /* Codes for REDIRECT. */
 269 #define ICMP_REDIR_NET          0       /* Redirect Net                 */
 270 #define ICMP_REDIR_HOST         1       /* Redirect Host                */
 271
 272 /* Codes for NOT_REACH */
 273 #define ICMP_NOT_REACH_PORT     3       /* Port unreachable             */
 274
 275 typedef struct icmphdr {
 276         uchar           type;
 277         uchar           code;
 278         ushort          checksum;
 279         union {
 280                 struct {
 281                         ushort  id;
 282                         ushort  sequence;
 283                 } echo;
 284                 ulong   gateway;
 285                 struct {
 286                         ushort  __unused;
 287                         ushort  mtu;
 288                 } frag;
 289                 uchar data[0];
 290         } un;
 291 } ICMP_t;
 292
 293
 294 /*
 295  * Maximum packet size; used to allocate packet storage.
 296  * TFTP packets can be 524 bytes + IP header + ethernet header.
 297  * Lets be conservative, and go for 38 * 16.  (Must also be
 298  * a multiple of 32 bytes).
 299  */
 300 /*
 301  * AS.HARNOIS : Better to set PKTSIZE to maximum size because
 302  * traffic type is not always controlled
 303  * maximum packet size =  1518
 304  * maximum packet size and multiple of 32 bytes =  1536
 305  */
 306 #define PKTSIZE                 1518
 307 #define PKTSIZE_ALIGN           1536
 308 /*#define PKTSIZE               608*/
 309
 310 /*
 311  * Maximum receive ring size; that is, the number of packets
 312  * we can buffer before overflow happens. Basically, this just
 313  * needs to be enough to prevent a packet being discarded while
 314  * we are processing the previous one.
 315  */
 316 #define RINGSZ          4
 317 #define RINGSZ_LOG2     2
 318
 319 /**********************************************************************/
 320 /*
 321  *      Globals.
 322  *
 323  * Note:
 324  *
 325  * All variables of type IPaddr_t are stored in NETWORK byte order
 326  * (big endian).
 327  */
 328
 329 /* net.c */
 330 /** BOOTP EXTENTIONS **/
 331 extern IPaddr_t NetOurGatewayIP;        /* Our gateway IP address */
 332 extern IPaddr_t NetOurSubnetMask;       /* Our subnet mask (0 = unknown) */
 333 extern IPaddr_t NetOurDNSIP;    /* Our Domain Name Server (0 = unknown) */
 334 #if defined(CONFIG_BOOTP_DNS2)
 335 extern IPaddr_t NetOurDNS2IP;   /* Our 2nd Domain Name Server (0 = unknown) */
 336 #endif
 337 extern char     NetOurNISDomain[32];    /* Our NIS domain */
 338 extern char     NetOurHostName[32];     /* Our hostname */
 339 extern char     NetOurRootPath[64];     /* Our root path */
 340 extern ushort   NetBootFileSize;        /* Our boot file size in blocks */
 341 /** END OF BOOTP EXTENTIONS **/
 342 extern ulong            NetBootFileXferSize;    /* size of bootfile in bytes */
 343 extern uchar            NetOurEther[6];         /* Our ethernet address */
 344 extern uchar            NetServerEther[6];      /* Boot server enet address */
 345 extern IPaddr_t         NetOurIP;       /* Our    IP addr (0 = unknown) */
 346 extern IPaddr_t         NetServerIP;    /* Server IP addr (0 = unknown) */
 347 extern uchar            *NetTxPacket;           /* THE transmit packet */
 348 extern uchar            *NetRxPackets[PKTBUFSRX]; /* Receive packets */
 349 extern uchar            *NetRxPacket;           /* Current receive packet */
 350 extern int              NetRxPacketLen;         /* Current rx packet length */
 351 extern unsigned         NetIPID;                /* IP ID (counting) */
 352 extern uchar            NetBcastAddr[6];        /* Ethernet boardcast address */
 353 extern uchar            NetEtherNullAddr[6];
 354
 355 #define VLAN_NONE       4095                    /* untagged */
 356 #define VLAN_IDMASK     0x0fff                  /* mask of valid vlan id */
 357 extern ushort           NetOurVLAN;             /* Our VLAN */
 358 extern ushort           NetOurNativeVLAN;       /* Our Native VLAN */
 359
 360 extern int              NetState;               /* Network loop state */
 361 #define NETLOOP_CONTINUE        1
 362 #define NETLOOP_RESTART         2
 363 #define NETLOOP_SUCCESS         3
 364 #define NETLOOP_FAIL            4
 365
 366 extern int              NetRestartWrap;         /* Tried all network devices */
 367
 368 enum proto_t {
 369         BOOTP, RARP, ARP, TFTPGET, DHCP, PING, DNS, NFS, CDP, NETCONS, SNTP,
 370         TFTPSRV, TFTPPUT
 371 };
 372
 373 /* from net/net.c */
 374 extern char     BootFile[128];                  /* Boot File name */
 375
 376 #if defined(CONFIG_CMD_DNS)
 377 extern char *NetDNSResolve;             /* The host to resolve  */
 378 extern char *NetDNSenvvar;              /* the env var to put the ip into */
 379 #endif
 380
 381 #if defined(CONFIG_CMD_PING)
 382 extern IPaddr_t NetPingIP;                      /* the ip address to ping */
 383 #endif
 384
 385 #if defined(CONFIG_CMD_CDP)
 386 /* when CDP completes these hold the return values */
 387 extern ushort CDPNativeVLAN;            /* CDP returned native VLAN */
 388 extern ushort CDPApplianceVLAN;         /* CDP returned appliance VLAN */
 389
 390 /*
 391  * Check for a CDP packet by examining the received MAC address field
 392  */
 393 static inline int is_cdp_packet(const uchar *et_addr)
 394 {
 395         extern const uchar NetCDPAddr[6];
 396
 397         return memcmp(et_addr, NetCDPAddr, 6) == 0;
 398 }
 399 #endif
 400
 401 #if defined(CONFIG_CMD_SNTP)
 402 extern IPaddr_t NetNtpServerIP;                 /* the ip address to NTP */
 403 extern int NetTimeOffset;                       /* offset time from UTC */
 404 #endif
 405
 406 #if defined(CONFIG_MCAST_TFTP)
 407 extern IPaddr_t Mcast_addr;
 408 #endif
 409
 410 /* Initialize the network adapter */
 411 extern int NetLoop(enum proto_t);
 412
 413 /* Shutdown adapters and cleanup */
 414 extern void     NetStop(void);
 415
 416 /* Load failed.  Start again. */
 417 extern void     NetStartAgain(void);
 418
 419 /* Get size of the ethernet header when we send */
 420 extern int      NetEthHdrSize(void);
 421
 422 /* Set ethernet header; returns the size of the header */
 423 extern int NetSetEther(uchar *, uchar *, uint);
 424
 425 /* Set IP header */
 426 extern void NetSetIP(uchar *, IPaddr_t, int, int, int);
 427
 428 /* Checksum */
 429 extern int      NetCksumOk(uchar *, int);       /* Return true if cksum OK */
 430 extern uint     NetCksum(uchar *, int);         /* Calculate the checksum */
 431
 432 /* Callbacks */
 433 extern rxhand_f *NetGetHandler(void);           /* Get RX packet handler */
 434 extern void     NetSetHandler(rxhand_f *);      /* Set RX packet handler */
 435 extern void net_set_icmp_handler(rxhand_icmp_f *f); /* Set ICMP RX handler */
 436 extern void     NetSetTimeout(ulong, thand_f *);/* Set timeout handler */
 437
 438 /* Transmit "NetTxPacket" */
 439 extern void NetSendPacket(uchar *, int);
 440
 441 /* Transmit UDP packet, performing ARP request if needed */
 442 extern int      NetSendUDPPacket(uchar *ether, IPaddr_t dest, int dport,
 443                         int sport, int len);
 444
 445 /* Processes a received packet */
 446 extern void NetReceive(uchar *, int);
 447
 448 #ifdef CONFIG_NETCONSOLE
 449 void NcStart(void);
 450 int nc_input_packet(uchar *pkt, unsigned dest, unsigned src, unsigned len);
 451 #endif
 452
 453 /*
 454  * Check if autoload is enabled. If so, use either NFS or TFTP to download
 455  * the boot file.
 456  */
 457 void net_auto_load(void);
 458
 459 /*
 460  * The following functions are a bit ugly, but necessary to deal with
 461  * alignment restrictions on ARM.
 462  *
 463  * We're using inline functions, which had the smallest memory
 464  * footprint in our tests.
 465  */
 466 /* return IP *in network byteorder* */
 467 static inline IPaddr_t NetReadIP(void *from)
 468 {
 469         IPaddr_t ip;
 470
 471         memcpy((void *)&ip, (void *)from, sizeof(ip));
 472         return ip;
 473 }
 474
 475 /* return ulong *in network byteorder* */
 476 static inline ulong NetReadLong(ulong *from)
 477 {
 478         ulong l;
 479
 480         memcpy((void *)&l, (void *)from, sizeof(l));
 481         return l;
 482 }
 483
 484 /* write IP *in network byteorder* */
 485 static inline void NetWriteIP(void *to, IPaddr_t ip)
 486 {
 487         memcpy(to, (void *)&ip, sizeof(ip));
 488 }
 489
 490 /* copy IP */
 491 static inline void NetCopyIP(void *to, void *from)
 492 {
 493         memcpy((void *)to, from, sizeof(IPaddr_t));
 494 }
 495
 496 /* copy ulong */
 497 static inline void NetCopyLong(ulong *to, ulong *from)
 498 {
 499         memcpy((void *)to, (void *)from, sizeof(ulong));
 500 }
 501
 502 /**
 503  * is_zero_ether_addr - Determine if give Ethernet address is all zeros.
 504  * @addr: Pointer to a six-byte array containing the Ethernet address
 505  *
 506  * Return true if the address is all zeroes.
 507  */
 508 static inline int is_zero_ether_addr(const u8 *addr)
 509 {
 510         return !(addr[0] | addr[1] | addr[2] | addr[3] | addr[4] | addr[5]);
 511 }
 512
 513 /**
 514  * is_multicast_ether_addr - Determine if the Ethernet address is a multicast.
 515  * @addr: Pointer to a six-byte array containing the Ethernet address
 516  *
 517  * Return true if the address is a multicast address.
 518  * By definition the broadcast address is also a multicast address.
 519  */
 520 static inline int is_multicast_ether_addr(const u8 *addr)
 521 {
 522         return 0x01 & addr[0];
 523 }
 524
 525 /*
 526  * is_broadcast_ether_addr - Determine if the Ethernet address is broadcast
 527  * @addr: Pointer to a six-byte array containing the Ethernet address
 528  *
 529  * Return true if the address is the broadcast address.
 530  */
 531 static inline int is_broadcast_ether_addr(const u8 *addr)
 532 {
 533         return (addr[0] & addr[1] & addr[2] & addr[3] & addr[4] & addr[5]) ==
 534                 0xff;
 535 }
 536
 537 /*
 538  * is_valid_ether_addr - Determine if the given Ethernet address is valid
 539  * @addr: Pointer to a six-byte array containing the Ethernet address
 540  *
 541  * Check that the Ethernet address (MAC) is not 00:00:00:00:00:00, is not
 542  * a multicast address, and is not FF:FF:FF:FF:FF:FF.
 543  *
 544  * Return true if the address is valid.
 545  */
 546 static inline int is_valid_ether_addr(const u8 *addr)
 547 {
 548         /* FF:FF:FF:FF:FF:FF is a multicast address so we don't need to
 549          * explicitly check for it here. */
 550         return !is_multicast_ether_addr(addr) && !is_zero_ether_addr(addr);
 551 }
 552
 553 /* Convert an IP address to a string */
 554 extern void ip_to_string(IPaddr_t x, char *s);
 555
 556 /* Convert a string to ip address */
 557 extern IPaddr_t string_to_ip(const char *s);
 558
 559 /* Convert a VLAN id to a string */
 560 extern void VLAN_to_string(ushort x, char *s);
 561
 562 /* Convert a string to a vlan id */
 563 extern ushort string_to_VLAN(const char *s);
 564
 565 /* read a VLAN id from an environment variable */
 566 extern ushort getenv_VLAN(char *);
 567
 568 /* copy a filename (allow for "..." notation, limit length) */
 569 extern void copy_filename(char *dst, const char *src, int size);
 570
 571 /* get a random source port */
 572 extern unsigned int random_port(void);
 573
 574 /**********************************************************************/
 575
 576 #endif /* __NET_H__ */