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