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/byteorder.h>      /* for nton* / ntoh* stuff */
  20
  21
  22 /*
  23  *      The number of receive packet buffers, and the required packet buffer
  24  *      alignment in memory.
  25  *
  26  */
  27
  28 #ifdef CONFIG_SYS_RX_ETH_BUFFER
  29 # define PKTBUFSRX      CONFIG_SYS_RX_ETH_BUFFER
  30 #else
  31 # define PKTBUFSRX      4
  32 #endif
  33
  34 #define PKTALIGN        32
  35
  36 /* IPv4 addresses are always 32 bits in size */
  37 typedef u32             IPaddr_t;
  38
  39
  40 /**
  41  * An incoming packet handler.
  42  * @param pkt    pointer to the application packet
  43  * @param dport  destination UDP port
  44  * @param sip    source IP address
  45  * @param sport  source UDP port
  46  * @param len    packet length
  47  */
  48 typedef void rxhand_f(uchar *pkt, unsigned dport,
  49                       IPaddr_t sip, unsigned sport,
  50                       unsigned len);
  51
  52 /**
  53  * An incoming ICMP packet handler.
  54  * @param type  ICMP type
  55  * @param code  ICMP code
  56  * @param dport destination UDP port
  57  * @param sip   source IP address
  58  * @param sport source UDP port
  59  * @param pkt   pointer to the ICMP packet data
  60  * @param len   packet length
  61  */
  62 typedef void rxhand_icmp_f(unsigned type, unsigned code, unsigned dport,
  63                 IPaddr_t sip, unsigned sport, uchar *pkt, unsigned len);
  64
  65 /*
  66  *      A timeout handler.  Called after time interval has expired.
  67  */
  68 typedef void    thand_f(void);
  69
  70 #define NAMESIZE 16
  71
  72 enum eth_state_t {
  73         ETH_STATE_INIT,
  74         ETH_STATE_PASSIVE,
  75         ETH_STATE_ACTIVE
  76 };
  77
  78 struct eth_device {
  79         char name[NAMESIZE];
  80         unsigned char enetaddr[6];
  81         int iobase;
  82         int state;
  83
  84         int  (*init) (struct eth_device*, bd_t*);
  85         int  (*send) (struct eth_device*, volatile void* packet, int length);
  86         int  (*recv) (struct eth_device*);
  87         void (*halt) (struct eth_device*);
  88 #ifdef CONFIG_MCAST_TFTP
  89         int (*mcast) (struct eth_device*, u32 ip, u8 set);
  90 #endif
  91         int  (*write_hwaddr) (struct eth_device*);
  92         struct eth_device *next;
  93         int index;
  94         void *priv;
  95 };
  96
  97 extern int eth_initialize(bd_t *bis);   /* Initialize network subsystem */
  98 extern int eth_register(struct eth_device* dev);/* Register network device */
  99 extern int eth_unregister(struct eth_device *dev);/* Remove network device */
 100 extern void eth_try_another(int first_restart); /* Change the device */
 101 extern void eth_set_current(void);              /* set nterface to ethcur var */
 102 extern struct eth_device *eth_get_dev(void);    /* get the current device MAC */
 103 extern struct eth_device *eth_get_dev_by_name(const char *devname);
 104 extern struct eth_device *eth_get_dev_by_index(int index); /* get dev @ index */
 105 extern int eth_get_dev_index (void);            /* get the device index */
 106 extern void eth_parse_enetaddr(const char *addr, uchar *enetaddr);
 107 extern int eth_getenv_enetaddr(char *name, uchar *enetaddr);
 108 extern int eth_setenv_enetaddr(char *name, const uchar *enetaddr);
 109
 110 /*
 111  * Get the hardware address for an ethernet interface .
 112  * Args:
 113  *      base_name - base name for device (normally "eth")
 114  *      index - device index number (0 for first)
 115  *      enetaddr - returns 6 byte hardware address
 116  * Returns:
 117  *      Return true if the address is valid.
 118  */
 119 extern int eth_getenv_enetaddr_by_index(const char *base_name, int index,
 120                                         uchar *enetaddr);
 121
 122 extern int usb_eth_initialize(bd_t *bi);
 123 extern int eth_init(bd_t *bis);                 /* Initialize the device */
 124 extern int eth_send(volatile void *packet, int length);    /* Send a packet */
 125
 126 #ifdef CONFIG_API
 127 extern int eth_receive(volatile void *packet, int length); /* Receive a packet*/
 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) header.
 198  */
 199 typedef struct {
 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 } IP_t;
 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 (IP_t) - 8)
 223 #define IP_HDR_SIZE             (sizeof (IP_t))
 224
 225
 226 /*
 227  *      Address Resolution Protocol (ARP) header.
 228  */
 229 typedef struct
 230 {
 231         ushort          ar_hrd;         /* Format of hardware address   */
 232 #   define ARP_ETHER        1           /* Ethernet  hardware address   */
 233         ushort          ar_pro;         /* Format of protocol address   */
 234         uchar           ar_hln;         /* Length of hardware address   */
 235         uchar           ar_pln;         /* Length of protocol address   */
 236         ushort          ar_op;          /* Operation                    */
 237 #   define ARPOP_REQUEST    1           /* Request  to resolve  address */
 238 #   define ARPOP_REPLY      2           /* Response to previous request */
 239
 240 #   define RARPOP_REQUEST   3           /* Request  to resolve  address */
 241 #   define RARPOP_REPLY     4           /* Response to previous request */
 242
 243         /*
 244          * The remaining fields are variable in size, according to
 245          * the sizes above, and are defined as appropriate for
 246          * specific hardware/protocol combinations.
 247          */
 248         uchar           ar_data[0];
 249 #if 0
 250         uchar           ar_sha[];       /* Sender hardware address      */
 251         uchar           ar_spa[];       /* Sender protocol address      */
 252         uchar           ar_tha[];       /* Target hardware address      */
 253         uchar           ar_tpa[];       /* Target protocol address      */
 254 #endif /* 0 */
 255 } ARP_t;
 256
 257 #define ARP_HDR_SIZE    (8+20)          /* Size assuming ethernet       */
 258
 259 /*
 260  * ICMP stuff (just enough to handle (host) redirect messages)
 261  */
 262 #define ICMP_ECHO_REPLY         0       /* Echo reply                   */
 263 #define ICMP_NOT_REACH          3       /* Detination unreachable       */
 264 #define ICMP_REDIRECT           5       /* Redirect (change route)      */
 265 #define ICMP_ECHO_REQUEST       8       /* Echo request                 */
 266
 267 /* Codes for REDIRECT. */
 268 #define ICMP_REDIR_NET          0       /* Redirect Net                 */
 269 #define ICMP_REDIR_HOST         1       /* Redirect Host                */
 270
 271 /* Codes for NOT_REACH */
 272 #define ICMP_NOT_REACH_PORT     3       /* Port unreachable             */
 273
 274 typedef struct icmphdr {
 275         uchar           type;
 276         uchar           code;
 277         ushort          checksum;
 278         union {
 279                 struct {
 280                         ushort  id;
 281                         ushort  sequence;
 282                 } echo;
 283                 ulong   gateway;
 284                 struct {
 285                         ushort  __unused;
 286                         ushort  mtu;
 287                 } frag;
 288                 uchar data[0];
 289         } un;
 290 } ICMP_t;
 291
 292
 293 /*
 294  * Maximum packet size; used to allocate packet storage.
 295  * TFTP packets can be 524 bytes + IP header + ethernet header.
 296  * Lets be conservative, and go for 38 * 16.  (Must also be
 297  * a multiple of 32 bytes).
 298  */
 299 /*
 300  * AS.HARNOIS : Better to set PKTSIZE to maximum size because
 301  * traffic type is not always controlled
 302  * maximum packet size =  1518
 303  * maximum packet size and multiple of 32 bytes =  1536
 304  */
 305 #define PKTSIZE                 1518
 306 #define PKTSIZE_ALIGN           1536
 307 /*#define PKTSIZE               608*/
 308
 309 /*
 310  * Maximum receive ring size; that is, the number of packets
 311  * we can buffer before overflow happens. Basically, this just
 312  * needs to be enough to prevent a packet being discarded while
 313  * we are processing the previous one.
 314  */
 315 #define RINGSZ          4
 316 #define RINGSZ_LOG2     2
 317
 318 /**********************************************************************/
 319 /*
 320  *      Globals.
 321  *
 322  * Note:
 323  *
 324  * All variables of type IPaddr_t are stored in NETWORK byte order
 325  * (big endian).
 326  */
 327
 328 /* net.c */
 329 /** BOOTP EXTENTIONS **/
 330 extern IPaddr_t         NetOurGatewayIP;        /* Our gateway IP addresse      */
 331 extern IPaddr_t         NetOurSubnetMask;       /* Our subnet mask (0 = unknown)*/
 332 extern IPaddr_t         NetOurDNSIP;     /* Our Domain Name Server (0 = unknown)*/
 333 #if defined(CONFIG_BOOTP_DNS2)
 334 extern IPaddr_t         NetOurDNS2IP;    /* Our 2nd Domain Name Server (0 = unknown)*/
 335 #endif
 336 extern char             NetOurNISDomain[32];    /* Our NIS domain               */
 337 extern char             NetOurHostName[32];     /* Our hostname                 */
 338 extern char             NetOurRootPath[64];     /* Our root path                */
 339 extern ushort           NetBootFileSize;        /* Our boot file size in blocks */
 340 /** END OF BOOTP EXTENTIONS **/
 341 extern ulong            NetBootFileXferSize;    /* size of bootfile in bytes    */
 342 extern uchar            NetOurEther[6];         /* Our ethernet address         */
 343 extern uchar            NetServerEther[6];      /* Boot server enet address     */
 344 extern IPaddr_t         NetOurIP;               /* Our    IP addr (0 = unknown) */
 345 extern IPaddr_t         NetServerIP;            /* Server IP addr (0 = unknown) */
 346 extern volatile uchar * NetTxPacket;            /* THE transmit packet          */
 347 extern volatile uchar * NetRxPackets[PKTBUFSRX];/* Receive packets              */
 348 extern volatile uchar * NetRxPacket;            /* Current receive packet       */
 349 extern int              NetRxPacketLen;         /* Current rx packet length     */
 350 extern unsigned         NetIPID;                /* IP ID (counting)             */
 351 extern uchar            NetBcastAddr[6];        /* Ethernet boardcast address   */
 352 extern uchar            NetEtherNullAddr[6];
 353
 354 #define VLAN_NONE       4095                    /* untagged                     */
 355 #define VLAN_IDMASK     0x0fff                  /* mask of valid vlan id        */
 356 extern ushort           NetOurVLAN;             /* Our VLAN                     */
 357 extern ushort           NetOurNativeVLAN;       /* Our Native VLAN              */
 358
 359 extern uchar            NetCDPAddr[6];          /* Ethernet CDP address         */
 360 extern ushort           CDPNativeVLAN;          /* CDP returned native VLAN     */
 361 extern ushort           CDPApplianceVLAN;       /* CDP returned appliance VLAN  */
 362
 363 extern int              NetState;               /* Network loop state           */
 364 #define NETLOOP_CONTINUE        1
 365 #define NETLOOP_RESTART         2
 366 #define NETLOOP_SUCCESS         3
 367 #define NETLOOP_FAIL            4
 368
 369 extern int              NetRestartWrap;         /* Tried all network devices    */
 370
 371 enum proto_t {
 372         BOOTP, RARP, ARP, TFTPGET, DHCP, PING, DNS, NFS, CDP, NETCONS, SNTP,
 373         TFTPSRV, TFTPPUT
 374 };
 375
 376 /* from net/net.c */
 377 extern char     BootFile[128];                  /* Boot File name               */
 378
 379 #if defined(CONFIG_CMD_DNS)
 380 extern char *NetDNSResolve;             /* The host to resolve  */
 381 extern char *NetDNSenvvar;              /* the env var to put the ip into */
 382 #endif
 383
 384 #if defined(CONFIG_CMD_PING)
 385 extern IPaddr_t NetPingIP;                      /* the ip address to ping               */
 386 #endif
 387
 388 #if defined(CONFIG_CMD_CDP)
 389 /* when CDP completes these hold the return values */
 390 extern ushort CDPNativeVLAN;
 391 extern ushort CDPApplianceVLAN;
 392 #endif
 393
 394 #if defined(CONFIG_CMD_SNTP)
 395 extern IPaddr_t NetNtpServerIP;                 /* the ip address to NTP        */
 396 extern int NetTimeOffset;                       /* offset time from UTC         */
 397 #endif
 398
 399 /* Initialize the network adapter */
 400 extern int NetLoop(enum proto_t);
 401
 402 /* Shutdown adapters and cleanup */
 403 extern void     NetStop(void);
 404
 405 /* Load failed.  Start again. */
 406 extern void     NetStartAgain(void);
 407
 408 /* Get size of the ethernet header when we send */
 409 extern int      NetEthHdrSize(void);
 410
 411 /* Set ethernet header; returns the size of the header */
 412 extern int      NetSetEther(volatile uchar *, uchar *, uint);
 413
 414 /* Set IP header */
 415 extern void     NetSetIP(volatile uchar *, IPaddr_t, int, int, int);
 416
 417 /* Checksum */
 418 extern int      NetCksumOk(uchar *, int);       /* Return true if cksum OK      */
 419 extern uint     NetCksum(uchar *, int);         /* Calculate the checksum       */
 420
 421 /* Set callbacks */
 422 extern void     NetSetHandler(rxhand_f *);      /* Set RX packet handler        */
 423 extern void net_set_icmp_handler(rxhand_icmp_f *f); /* Set ICMP RX handler */
 424 extern void     NetSetTimeout(ulong, thand_f *);/* Set timeout handler          */
 425
 426 /* Transmit "NetTxPacket" */
 427 extern void     NetSendPacket(volatile uchar *, int);
 428
 429 /* Transmit UDP packet, performing ARP request if needed */
 430 extern int      NetSendUDPPacket(uchar *ether, IPaddr_t dest, int dport, int sport, int len);
 431
 432 /* Processes a received packet */
 433 extern void     NetReceive(volatile uchar *, int);
 434
 435 /*
 436  * Check if autoload is enabled. If so, use either NFS or TFTP to download
 437  * the boot file.
 438  */
 439 void net_auto_load(void);
 440
 441 /*
 442  * The following functions are a bit ugly, but necessary to deal with
 443  * alignment restrictions on ARM.
 444  *
 445  * We're using inline functions, which had the smallest memory
 446  * footprint in our tests.
 447  */
 448 /* return IP *in network byteorder* */
 449 static inline IPaddr_t NetReadIP(volatile void *from)
 450 {
 451         IPaddr_t ip;
 452         memcpy((void*)&ip, (void*)from, sizeof(ip));
 453         return ip;
 454 }
 455
 456 /* return ulong *in network byteorder* */
 457 static inline ulong NetReadLong(ulong *from)
 458 {
 459         ulong l;
 460         memcpy((void*)&l, (void*)from, sizeof(l));
 461         return l;
 462 }
 463
 464 /* write IP *in network byteorder* */
 465 static inline void NetWriteIP(void *to, IPaddr_t ip)
 466 {
 467         memcpy(to, (void*)&ip, sizeof(ip));
 468 }
 469
 470 /* copy IP */
 471 static inline void NetCopyIP(volatile void *to, void *from)
 472 {
 473         memcpy((void*)to, from, sizeof(IPaddr_t));
 474 }
 475
 476 /* copy ulong */
 477 static inline void NetCopyLong(ulong *to, ulong *from)
 478 {
 479         memcpy((void*)to, (void*)from, sizeof(ulong));
 480 }
 481
 482 /**
 483  * is_zero_ether_addr - Determine if give Ethernet address is all zeros.
 484  * @addr: Pointer to a six-byte array containing the Ethernet address
 485  *
 486  * Return true if the address is all zeroes.
 487  */
 488 static inline int is_zero_ether_addr(const u8 *addr)
 489 {
 490         return !(addr[0] | addr[1] | addr[2] | addr[3] | addr[4] | addr[5]);
 491 }
 492
 493 /**
 494  * is_multicast_ether_addr - Determine if the Ethernet address is a multicast.
 495  * @addr: Pointer to a six-byte array containing the Ethernet address
 496  *
 497  * Return true if the address is a multicast address.
 498  * By definition the broadcast address is also a multicast address.
 499  */
 500 static inline int is_multicast_ether_addr(const u8 *addr)
 501 {
 502         return (0x01 & addr[0]);
 503 }
 504
 505 /*
 506  * is_broadcast_ether_addr - Determine if the Ethernet address is broadcast
 507  * @addr: Pointer to a six-byte array containing the Ethernet address
 508  *
 509  * Return true if the address is the broadcast address.
 510  */
 511 static inline int is_broadcast_ether_addr(const u8 *addr)
 512 {
 513         return (addr[0] & addr[1] & addr[2] & addr[3] & addr[4] & addr[5]) == 0xff;
 514 }
 515
 516 /*
 517  * is_valid_ether_addr - Determine if the given Ethernet address is valid
 518  * @addr: Pointer to a six-byte array containing the Ethernet address
 519  *
 520  * Check that the Ethernet address (MAC) is not 00:00:00:00:00:00, is not
 521  * a multicast address, and is not FF:FF:FF:FF:FF:FF.
 522  *
 523  * Return true if the address is valid.
 524  */
 525 static inline int is_valid_ether_addr(const u8 *addr)
 526 {
 527         /* FF:FF:FF:FF:FF:FF is a multicast address so we don't need to
 528          * explicitly check for it here. */
 529         return !is_multicast_ether_addr(addr) && !is_zero_ether_addr(addr);
 530 }
 531
 532 /* Convert an IP address to a string */
 533 extern void     ip_to_string (IPaddr_t x, char *s);
 534
 535 /* Convert a string to ip address */
 536 extern IPaddr_t string_to_ip(const char *s);
 537
 538 /* Convert a VLAN id to a string */
 539 extern void     VLAN_to_string (ushort x, char *s);
 540
 541 /* Convert a string to a vlan id */
 542 extern ushort string_to_VLAN(const char *s);
 543
 544 /* read a VLAN id from an environment variable */
 545 extern ushort getenv_VLAN(char *);
 546
 547 /* copy a filename (allow for "..." notation, limit length) */
 548 extern void     copy_filename (char *dst, const char *src, int size);
 549
 550 /* get a random source port */
 551 extern unsigned int random_port(void);
 552
 553 /**********************************************************************/
 554
 555 #endif /* __NET_H__ */