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