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