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