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 struct ip_hdr { 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 }; 211 212 #define IP_OFFS 0x1fff /* ip offset *= 8 */ 213 #define IP_FLAGS 0xe000 /* first 3 bits */ 214 #define IP_FLAGS_RES 0x8000 /* reserved */ 215 #define IP_FLAGS_DFRAG 0x4000 /* don't fragments */ 216 #define IP_FLAGS_MFRAG 0x2000 /* more fragments */ 217 218 #define IP_HDR_SIZE (sizeof(struct ip_hdr)) 219 220 /* 221 * Internet Protocol (IP) + UDP header. 222 */ 223 struct ip_udp_hdr { 224 uchar ip_hl_v; /* header length and version */ 225 uchar ip_tos; /* type of service */ 226 ushort ip_len; /* total length */ 227 ushort ip_id; /* identification */ 228 ushort ip_off; /* fragment offset field */ 229 uchar ip_ttl; /* time to live */ 230 uchar ip_p; /* protocol */ 231 ushort ip_sum; /* checksum */ 232 IPaddr_t ip_src; /* Source IP address */ 233 IPaddr_t ip_dst; /* Destination IP address */ 234 ushort udp_src; /* UDP source port */ 235 ushort udp_dst; /* UDP destination port */ 236 ushort udp_len; /* Length of UDP packet */ 237 ushort udp_xsum; /* Checksum */ 238 }; 239 240 #define IP_UDP_HDR_SIZE (sizeof(struct ip_udp_hdr)) 241 #define UDP_HDR_SIZE (IP_UDP_HDR_SIZE - IP_HDR_SIZE) 242 243 /* 244 * Address Resolution Protocol (ARP) header. 245 */ 246 typedef struct 247 { 248 ushort ar_hrd; /* Format of hardware address */ 249 # define ARP_ETHER 1 /* Ethernet hardware address */ 250 ushort ar_pro; /* Format of protocol address */ 251 uchar ar_hln; /* Length of hardware address */ 252 uchar ar_pln; /* Length of protocol address */ 253 ushort ar_op; /* Operation */ 254 # define ARPOP_REQUEST 1 /* Request to resolve address */ 255 # define ARPOP_REPLY 2 /* Response to previous request */ 256 257 # define RARPOP_REQUEST 3 /* Request to resolve address */ 258 # define RARPOP_REPLY 4 /* Response to previous request */ 259 260 /* 261 * The remaining fields are variable in size, according to 262 * the sizes above, and are defined as appropriate for 263 * specific hardware/protocol combinations. 264 */ 265 uchar ar_data[0]; 266 #if 0 267 uchar ar_sha[]; /* Sender hardware address */ 268 uchar ar_spa[]; /* Sender protocol address */ 269 uchar ar_tha[]; /* Target hardware address */ 270 uchar ar_tpa[]; /* Target protocol address */ 271 #endif /* 0 */ 272 } ARP_t; 273 274 #define ARP_HDR_SIZE (8+20) /* Size assuming ethernet */ 275 276 /* 277 * ICMP stuff (just enough to handle (host) redirect messages) 278 */ 279 #define ICMP_ECHO_REPLY 0 /* Echo reply */ 280 #define ICMP_NOT_REACH 3 /* Detination unreachable */ 281 #define ICMP_REDIRECT 5 /* Redirect (change route) */ 282 #define ICMP_ECHO_REQUEST 8 /* Echo request */ 283 284 /* Codes for REDIRECT. */ 285 #define ICMP_REDIR_NET 0 /* Redirect Net */ 286 #define ICMP_REDIR_HOST 1 /* Redirect Host */ 287 288 /* Codes for NOT_REACH */ 289 #define ICMP_NOT_REACH_PORT 3 /* Port unreachable */ 290 291 typedef struct icmphdr { 292 uchar type; 293 uchar code; 294 ushort checksum; 295 union { 296 struct { 297 ushort id; 298 ushort sequence; 299 } echo; 300 ulong gateway; 301 struct { 302 ushort __unused; 303 ushort mtu; 304 } frag; 305 uchar data[0]; 306 } un; 307 } ICMP_t; 308 309 310 /* 311 * Maximum packet size; used to allocate packet storage. 312 * TFTP packets can be 524 bytes + IP header + ethernet header. 313 * Lets be conservative, and go for 38 * 16. (Must also be 314 * a multiple of 32 bytes). 315 */ 316 /* 317 * AS.HARNOIS : Better to set PKTSIZE to maximum size because 318 * traffic type is not always controlled 319 * maximum packet size = 1518 320 * maximum packet size and multiple of 32 bytes = 1536 321 */ 322 #define PKTSIZE 1518 323 #define PKTSIZE_ALIGN 1536 324 /*#define PKTSIZE 608*/ 325 326 /* 327 * Maximum receive ring size; that is, the number of packets 328 * we can buffer before overflow happens. Basically, this just 329 * needs to be enough to prevent a packet being discarded while 330 * we are processing the previous one. 331 */ 332 #define RINGSZ 4 333 #define RINGSZ_LOG2 2 334 335 /**********************************************************************/ 336 /* 337 * Globals. 338 * 339 * Note: 340 * 341 * All variables of type IPaddr_t are stored in NETWORK byte order 342 * (big endian). 343 */ 344 345 /* net.c */ 346 /** BOOTP EXTENTIONS **/ 347 extern IPaddr_t NetOurGatewayIP; /* Our gateway IP address */ 348 extern IPaddr_t NetOurSubnetMask; /* Our subnet mask (0 = unknown) */ 349 extern IPaddr_t NetOurDNSIP; /* Our Domain Name Server (0 = unknown) */ 350 #if defined(CONFIG_BOOTP_DNS2) 351 extern IPaddr_t NetOurDNS2IP; /* Our 2nd Domain Name Server (0 = unknown) */ 352 #endif 353 extern char NetOurNISDomain[32]; /* Our NIS domain */ 354 extern char NetOurHostName[32]; /* Our hostname */ 355 extern char NetOurRootPath[64]; /* Our root path */ 356 extern ushort NetBootFileSize; /* Our boot file size in blocks */ 357 /** END OF BOOTP EXTENTIONS **/ 358 extern ulong NetBootFileXferSize; /* size of bootfile in bytes */ 359 extern uchar NetOurEther[6]; /* Our ethernet address */ 360 extern uchar NetServerEther[6]; /* Boot server enet address */ 361 extern IPaddr_t NetOurIP; /* Our IP addr (0 = unknown) */ 362 extern IPaddr_t NetServerIP; /* Server IP addr (0 = unknown) */ 363 extern uchar *NetTxPacket; /* THE transmit packet */ 364 extern uchar *NetRxPackets[PKTBUFSRX]; /* Receive packets */ 365 extern uchar *NetRxPacket; /* Current receive packet */ 366 extern int NetRxPacketLen; /* Current rx packet length */ 367 extern unsigned NetIPID; /* IP ID (counting) */ 368 extern uchar NetBcastAddr[6]; /* Ethernet boardcast address */ 369 extern uchar NetEtherNullAddr[6]; 370 371 #define VLAN_NONE 4095 /* untagged */ 372 #define VLAN_IDMASK 0x0fff /* mask of valid vlan id */ 373 extern ushort NetOurVLAN; /* Our VLAN */ 374 extern ushort NetOurNativeVLAN; /* Our Native VLAN */ 375 376 extern int NetState; /* Network loop state */ 377 #define NETLOOP_CONTINUE 1 378 #define NETLOOP_RESTART 2 379 #define NETLOOP_SUCCESS 3 380 #define NETLOOP_FAIL 4 381 382 extern int NetRestartWrap; /* Tried all network devices */ 383 384 enum proto_t { 385 BOOTP, RARP, ARP, TFTPGET, DHCP, PING, DNS, NFS, CDP, NETCONS, SNTP, 386 TFTPSRV, TFTPPUT 387 }; 388 389 /* from net/net.c */ 390 extern char BootFile[128]; /* Boot File name */ 391 392 #if defined(CONFIG_CMD_DNS) 393 extern char *NetDNSResolve; /* The host to resolve */ 394 extern char *NetDNSenvvar; /* the env var to put the ip into */ 395 #endif 396 397 #if defined(CONFIG_CMD_PING) 398 extern IPaddr_t NetPingIP; /* the ip address to ping */ 399 #endif 400 401 #if defined(CONFIG_CMD_CDP) 402 /* when CDP completes these hold the return values */ 403 extern ushort CDPNativeVLAN; /* CDP returned native VLAN */ 404 extern ushort CDPApplianceVLAN; /* CDP returned appliance VLAN */ 405 406 /* 407 * Check for a CDP packet by examining the received MAC address field 408 */ 409 static inline int is_cdp_packet(const uchar *et_addr) 410 { 411 extern const uchar NetCDPAddr[6]; 412 413 return memcmp(et_addr, NetCDPAddr, 6) == 0; 414 } 415 #endif 416 417 #if defined(CONFIG_CMD_SNTP) 418 extern IPaddr_t NetNtpServerIP; /* the ip address to NTP */ 419 extern int NetTimeOffset; /* offset time from UTC */ 420 #endif 421 422 #if defined(CONFIG_MCAST_TFTP) 423 extern IPaddr_t Mcast_addr; 424 #endif 425 426 /* Initialize the network adapter */ 427 extern int NetLoop(enum proto_t); 428 429 /* Shutdown adapters and cleanup */ 430 extern void NetStop(void); 431 432 /* Load failed. Start again. */ 433 extern void NetStartAgain(void); 434 435 /* Get size of the ethernet header when we send */ 436 extern int NetEthHdrSize(void); 437 438 /* Set ethernet header; returns the size of the header */ 439 extern int NetSetEther(uchar *, uchar *, uint); 440 441 /* Set IP header */ 442 extern void NetSetIP(uchar *, IPaddr_t, int, int, int); 443 444 /* Checksum */ 445 extern int NetCksumOk(uchar *, int); /* Return true if cksum OK */ 446 extern uint NetCksum(uchar *, int); /* Calculate the checksum */ 447 448 /* Callbacks */ 449 extern rxhand_f *NetGetHandler(void); /* Get RX packet handler */ 450 extern void NetSetHandler(rxhand_f *); /* Set RX packet handler */ 451 extern void net_set_icmp_handler(rxhand_icmp_f *f); /* Set ICMP RX handler */ 452 extern void NetSetTimeout(ulong, thand_f *);/* Set timeout handler */ 453 454 /* Transmit "NetTxPacket" */ 455 extern void NetSendPacket(uchar *, int); 456 457 /* Transmit UDP packet, performing ARP request if needed */ 458 extern int NetSendUDPPacket(uchar *ether, IPaddr_t dest, int dport, 459 int sport, int len); 460 461 /* Processes a received packet */ 462 extern void NetReceive(uchar *, int); 463 464 #ifdef CONFIG_NETCONSOLE 465 void NcStart(void); 466 int nc_input_packet(uchar *pkt, unsigned dest, unsigned src, unsigned len); 467 #endif 468 469 /* 470 * Check if autoload is enabled. If so, use either NFS or TFTP to download 471 * the boot file. 472 */ 473 void net_auto_load(void); 474 475 /* 476 * The following functions are a bit ugly, but necessary to deal with 477 * alignment restrictions on ARM. 478 * 479 * We're using inline functions, which had the smallest memory 480 * footprint in our tests. 481 */ 482 /* return IP *in network byteorder* */ 483 static inline IPaddr_t NetReadIP(void *from) 484 { 485 IPaddr_t ip; 486 487 memcpy((void *)&ip, (void *)from, sizeof(ip)); 488 return ip; 489 } 490 491 /* return ulong *in network byteorder* */ 492 static inline ulong NetReadLong(ulong *from) 493 { 494 ulong l; 495 496 memcpy((void *)&l, (void *)from, sizeof(l)); 497 return l; 498 } 499 500 /* write IP *in network byteorder* */ 501 static inline void NetWriteIP(void *to, IPaddr_t ip) 502 { 503 memcpy(to, (void *)&ip, sizeof(ip)); 504 } 505 506 /* copy IP */ 507 static inline void NetCopyIP(void *to, void *from) 508 { 509 memcpy((void *)to, from, sizeof(IPaddr_t)); 510 } 511 512 /* copy ulong */ 513 static inline void NetCopyLong(ulong *to, ulong *from) 514 { 515 memcpy((void *)to, (void *)from, sizeof(ulong)); 516 } 517 518 /** 519 * is_zero_ether_addr - Determine if give Ethernet address is all zeros. 520 * @addr: Pointer to a six-byte array containing the Ethernet address 521 * 522 * Return true if the address is all zeroes. 523 */ 524 static inline int is_zero_ether_addr(const u8 *addr) 525 { 526 return !(addr[0] | addr[1] | addr[2] | addr[3] | addr[4] | addr[5]); 527 } 528 529 /** 530 * is_multicast_ether_addr - Determine if the Ethernet address is a multicast. 531 * @addr: Pointer to a six-byte array containing the Ethernet address 532 * 533 * Return true if the address is a multicast address. 534 * By definition the broadcast address is also a multicast address. 535 */ 536 static inline int is_multicast_ether_addr(const u8 *addr) 537 { 538 return 0x01 & addr[0]; 539 } 540 541 /* 542 * is_broadcast_ether_addr - Determine if the Ethernet address is broadcast 543 * @addr: Pointer to a six-byte array containing the Ethernet address 544 * 545 * Return true if the address is the broadcast address. 546 */ 547 static inline int is_broadcast_ether_addr(const u8 *addr) 548 { 549 return (addr[0] & addr[1] & addr[2] & addr[3] & addr[4] & addr[5]) == 550 0xff; 551 } 552 553 /* 554 * is_valid_ether_addr - Determine if the given Ethernet address is valid 555 * @addr: Pointer to a six-byte array containing the Ethernet address 556 * 557 * Check that the Ethernet address (MAC) is not 00:00:00:00:00:00, is not 558 * a multicast address, and is not FF:FF:FF:FF:FF:FF. 559 * 560 * Return true if the address is valid. 561 */ 562 static inline int is_valid_ether_addr(const u8 *addr) 563 { 564 /* FF:FF:FF:FF:FF:FF is a multicast address so we don't need to 565 * explicitly check for it here. */ 566 return !is_multicast_ether_addr(addr) && !is_zero_ether_addr(addr); 567 } 568 569 /* Convert an IP address to a string */ 570 extern void ip_to_string(IPaddr_t x, char *s); 571 572 /* Convert a string to ip address */ 573 extern IPaddr_t string_to_ip(const char *s); 574 575 /* Convert a VLAN id to a string */ 576 extern void VLAN_to_string(ushort x, char *s); 577 578 /* Convert a string to a vlan id */ 579 extern ushort string_to_VLAN(const char *s); 580 581 /* read a VLAN id from an environment variable */ 582 extern ushort getenv_VLAN(char *); 583 584 /* copy a filename (allow for "..." notation, limit length) */ 585 extern void copy_filename(char *dst, const char *src, int size); 586 587 /* get a random source port */ 588 extern unsigned int random_port(void); 589 590 /**********************************************************************/ 591 592 #endif /* __NET_H__ */ 593