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