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