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/byteorder.h> /* for nton* / ntoh* stuff */ 20 21 22 /* 23 * The number of receive packet buffers, and the required packet buffer 24 * alignment in memory. 25 * 26 */ 27 28 #ifdef CONFIG_SYS_RX_ETH_BUFFER 29 # define PKTBUFSRX CONFIG_SYS_RX_ETH_BUFFER 30 #else 31 # define PKTBUFSRX 4 32 #endif 33 34 #define PKTALIGN 32 35 36 /* IPv4 addresses are always 32 bits in size */ 37 typedef u32 IPaddr_t; 38 39 40 /** 41 * An incoming packet handler. 42 * @param pkt pointer to the application packet 43 * @param dport destination UDP port 44 * @param sip source IP address 45 * @param sport source UDP port 46 * @param len packet length 47 */ 48 typedef void rxhand_f(uchar *pkt, unsigned dport, 49 IPaddr_t sip, unsigned sport, 50 unsigned len); 51 52 /** 53 * An incoming ICMP packet handler. 54 * @param type ICMP type 55 * @param code ICMP code 56 * @param dport destination UDP port 57 * @param sip source IP address 58 * @param sport source UDP port 59 * @param pkt pointer to the ICMP packet data 60 * @param len packet length 61 */ 62 typedef void rxhand_icmp_f(unsigned type, unsigned code, unsigned dport, 63 IPaddr_t sip, unsigned sport, uchar *pkt, unsigned len); 64 65 /* 66 * A timeout handler. Called after time interval has expired. 67 */ 68 typedef void thand_f(void); 69 70 #define NAMESIZE 16 71 72 enum eth_state_t { 73 ETH_STATE_INIT, 74 ETH_STATE_PASSIVE, 75 ETH_STATE_ACTIVE 76 }; 77 78 struct eth_device { 79 char name[NAMESIZE]; 80 unsigned char enetaddr[6]; 81 int iobase; 82 int state; 83 84 int (*init) (struct eth_device*, bd_t*); 85 int (*send) (struct eth_device*, volatile void* packet, int length); 86 int (*recv) (struct eth_device*); 87 void (*halt) (struct eth_device*); 88 #ifdef CONFIG_MCAST_TFTP 89 int (*mcast) (struct eth_device*, u32 ip, u8 set); 90 #endif 91 int (*write_hwaddr) (struct eth_device*); 92 struct eth_device *next; 93 int index; 94 void *priv; 95 }; 96 97 extern int eth_initialize(bd_t *bis); /* Initialize network subsystem */ 98 extern int eth_register(struct eth_device* dev);/* Register 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(volatile void *packet, int length); /* Send a packet */ 124 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 /* 133 * Set the hardware address for an ethernet interface based on 'eth%daddr' 134 * environment variable (or just 'ethaddr' if eth_number is 0). 135 * Args: 136 * base_name - base name for device (normally "eth") 137 * eth_number - value of %d (0 for first device of this type) 138 * Returns: 139 * 0 is success, non-zero is error status from driver. 140 */ 141 int eth_write_hwaddr(struct eth_device *dev, const char *base_name, 142 int eth_number); 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_NOT_REACH 3 /* Detination unreachable */ 263 #define ICMP_REDIRECT 5 /* Redirect (change route) */ 264 #define ICMP_ECHO_REQUEST 8 /* Echo request */ 265 266 /* Codes for REDIRECT. */ 267 #define ICMP_REDIR_NET 0 /* Redirect Net */ 268 #define ICMP_REDIR_HOST 1 /* Redirect Host */ 269 270 /* Codes for NOT_REACH */ 271 #define ICMP_NOT_REACH_PORT 3 /* Port unreachable */ 272 273 typedef struct icmphdr { 274 uchar type; 275 uchar code; 276 ushort checksum; 277 union { 278 struct { 279 ushort id; 280 ushort sequence; 281 } echo; 282 ulong gateway; 283 struct { 284 ushort __unused; 285 ushort mtu; 286 } frag; 287 uchar data[0]; 288 } un; 289 } ICMP_t; 290 291 292 /* 293 * Maximum packet size; used to allocate packet storage. 294 * TFTP packets can be 524 bytes + IP header + ethernet header. 295 * Lets be conservative, and go for 38 * 16. (Must also be 296 * a multiple of 32 bytes). 297 */ 298 /* 299 * AS.HARNOIS : Better to set PKTSIZE to maximum size because 300 * traffic type is not always controlled 301 * maximum packet size = 1518 302 * maximum packet size and multiple of 32 bytes = 1536 303 */ 304 #define PKTSIZE 1518 305 #define PKTSIZE_ALIGN 1536 306 /*#define PKTSIZE 608*/ 307 308 /* 309 * Maximum receive ring size; that is, the number of packets 310 * we can buffer before overflow happens. Basically, this just 311 * needs to be enough to prevent a packet being discarded while 312 * we are processing the previous one. 313 */ 314 #define RINGSZ 4 315 #define RINGSZ_LOG2 2 316 317 /**********************************************************************/ 318 /* 319 * Globals. 320 * 321 * Note: 322 * 323 * All variables of type IPaddr_t are stored in NETWORK byte order 324 * (big endian). 325 */ 326 327 /* net.c */ 328 /** BOOTP EXTENTIONS **/ 329 extern IPaddr_t NetOurGatewayIP; /* Our gateway IP addresse */ 330 extern IPaddr_t NetOurSubnetMask; /* Our subnet mask (0 = unknown)*/ 331 extern IPaddr_t NetOurDNSIP; /* Our Domain Name Server (0 = unknown)*/ 332 #if defined(CONFIG_BOOTP_DNS2) 333 extern IPaddr_t NetOurDNS2IP; /* Our 2nd Domain Name Server (0 = unknown)*/ 334 #endif 335 extern char NetOurNISDomain[32]; /* Our NIS domain */ 336 extern char NetOurHostName[32]; /* Our hostname */ 337 extern char NetOurRootPath[64]; /* Our root path */ 338 extern ushort NetBootFileSize; /* Our boot file size in blocks */ 339 /** END OF BOOTP EXTENTIONS **/ 340 extern ulong NetBootFileXferSize; /* size of bootfile in bytes */ 341 extern uchar NetOurEther[6]; /* Our ethernet address */ 342 extern uchar NetServerEther[6]; /* Boot server enet address */ 343 extern IPaddr_t NetOurIP; /* Our IP addr (0 = unknown) */ 344 extern IPaddr_t NetServerIP; /* Server IP addr (0 = unknown) */ 345 extern volatile uchar * NetTxPacket; /* THE transmit packet */ 346 extern volatile uchar * NetRxPackets[PKTBUFSRX];/* Receive packets */ 347 extern volatile uchar * NetRxPacket; /* Current receive packet */ 348 extern int NetRxPacketLen; /* Current rx packet length */ 349 extern unsigned NetIPID; /* IP ID (counting) */ 350 extern uchar NetBcastAddr[6]; /* Ethernet boardcast address */ 351 extern uchar NetEtherNullAddr[6]; 352 353 #define VLAN_NONE 4095 /* untagged */ 354 #define VLAN_IDMASK 0x0fff /* mask of valid vlan id */ 355 extern ushort NetOurVLAN; /* Our VLAN */ 356 extern ushort NetOurNativeVLAN; /* Our Native VLAN */ 357 358 extern uchar NetCDPAddr[6]; /* Ethernet CDP address */ 359 extern ushort CDPNativeVLAN; /* CDP returned native VLAN */ 360 extern ushort CDPApplianceVLAN; /* CDP returned appliance VLAN */ 361 362 extern int NetState; /* Network loop state */ 363 #define NETLOOP_CONTINUE 1 364 #define NETLOOP_RESTART 2 365 #define NETLOOP_SUCCESS 3 366 #define NETLOOP_FAIL 4 367 368 extern int NetRestartWrap; /* Tried all network devices */ 369 370 enum proto_t { 371 BOOTP, RARP, ARP, TFTPGET, DHCP, PING, DNS, NFS, CDP, NETCONS, SNTP, 372 TFTPSRV, TFTPPUT 373 }; 374 375 /* from net/net.c */ 376 extern char BootFile[128]; /* Boot File name */ 377 378 #if defined(CONFIG_CMD_DNS) 379 extern char *NetDNSResolve; /* The host to resolve */ 380 extern char *NetDNSenvvar; /* the env var to put the ip into */ 381 #endif 382 383 #if defined(CONFIG_CMD_PING) 384 extern IPaddr_t NetPingIP; /* the ip address to ping */ 385 #endif 386 387 #if defined(CONFIG_CMD_CDP) 388 /* when CDP completes these hold the return values */ 389 extern ushort CDPNativeVLAN; 390 extern ushort CDPApplianceVLAN; 391 #endif 392 393 #if defined(CONFIG_CMD_SNTP) 394 extern IPaddr_t NetNtpServerIP; /* the ip address to NTP */ 395 extern int NetTimeOffset; /* offset time from UTC */ 396 #endif 397 398 /* Initialize the network adapter */ 399 extern int NetLoop(enum proto_t); 400 401 /* Shutdown adapters and cleanup */ 402 extern void NetStop(void); 403 404 /* Load failed. Start again. */ 405 extern void NetStartAgain(void); 406 407 /* Get size of the ethernet header when we send */ 408 extern int NetEthHdrSize(void); 409 410 /* Set ethernet header; returns the size of the header */ 411 extern int NetSetEther(volatile uchar *, uchar *, uint); 412 413 /* Set IP header */ 414 extern void NetSetIP(volatile uchar *, IPaddr_t, int, int, int); 415 416 /* Checksum */ 417 extern int NetCksumOk(uchar *, int); /* Return true if cksum OK */ 418 extern uint NetCksum(uchar *, int); /* Calculate the checksum */ 419 420 /* Set callbacks */ 421 extern void NetSetHandler(rxhand_f *); /* Set RX packet handler */ 422 extern void net_set_icmp_handler(rxhand_icmp_f *f); /* Set ICMP RX handler */ 423 extern void NetSetTimeout(ulong, thand_f *);/* Set timeout handler */ 424 425 /* Transmit "NetTxPacket" */ 426 extern void NetSendPacket(volatile uchar *, int); 427 428 /* Transmit UDP packet, performing ARP request if needed */ 429 extern int NetSendUDPPacket(uchar *ether, IPaddr_t dest, int dport, int sport, int len); 430 431 /* Processes a received packet */ 432 extern void NetReceive(volatile uchar *, int); 433 434 /* 435 * Check if autoload is enabled. If so, use either NFS or TFTP to download 436 * the boot file. 437 */ 438 void net_auto_load(void); 439 440 /* 441 * The following functions are a bit ugly, but necessary to deal with 442 * alignment restrictions on ARM. 443 * 444 * We're using inline functions, which had the smallest memory 445 * footprint in our tests. 446 */ 447 /* return IP *in network byteorder* */ 448 static inline IPaddr_t NetReadIP(volatile void *from) 449 { 450 IPaddr_t ip; 451 memcpy((void*)&ip, (void*)from, sizeof(ip)); 452 return ip; 453 } 454 455 /* return ulong *in network byteorder* */ 456 static inline ulong NetReadLong(ulong *from) 457 { 458 ulong l; 459 memcpy((void*)&l, (void*)from, sizeof(l)); 460 return l; 461 } 462 463 /* write IP *in network byteorder* */ 464 static inline void NetWriteIP(void *to, IPaddr_t ip) 465 { 466 memcpy(to, (void*)&ip, sizeof(ip)); 467 } 468 469 /* copy IP */ 470 static inline void NetCopyIP(volatile void *to, void *from) 471 { 472 memcpy((void*)to, from, sizeof(IPaddr_t)); 473 } 474 475 /* copy ulong */ 476 static inline void NetCopyLong(ulong *to, ulong *from) 477 { 478 memcpy((void*)to, (void*)from, sizeof(ulong)); 479 } 480 481 /** 482 * is_zero_ether_addr - Determine if give Ethernet address is all zeros. 483 * @addr: Pointer to a six-byte array containing the Ethernet address 484 * 485 * Return true if the address is all zeroes. 486 */ 487 static inline int is_zero_ether_addr(const u8 *addr) 488 { 489 return !(addr[0] | addr[1] | addr[2] | addr[3] | addr[4] | addr[5]); 490 } 491 492 /** 493 * is_multicast_ether_addr - Determine if the Ethernet address is a multicast. 494 * @addr: Pointer to a six-byte array containing the Ethernet address 495 * 496 * Return true if the address is a multicast address. 497 * By definition the broadcast address is also a multicast address. 498 */ 499 static inline int is_multicast_ether_addr(const u8 *addr) 500 { 501 return (0x01 & addr[0]); 502 } 503 504 /* 505 * is_broadcast_ether_addr - Determine if the Ethernet address is broadcast 506 * @addr: Pointer to a six-byte array containing the Ethernet address 507 * 508 * Return true if the address is the broadcast address. 509 */ 510 static inline int is_broadcast_ether_addr(const u8 *addr) 511 { 512 return (addr[0] & addr[1] & addr[2] & addr[3] & addr[4] & addr[5]) == 0xff; 513 } 514 515 /* 516 * is_valid_ether_addr - Determine if the given Ethernet address is valid 517 * @addr: Pointer to a six-byte array containing the Ethernet address 518 * 519 * Check that the Ethernet address (MAC) is not 00:00:00:00:00:00, is not 520 * a multicast address, and is not FF:FF:FF:FF:FF:FF. 521 * 522 * Return true if the address is valid. 523 */ 524 static inline int is_valid_ether_addr(const u8 *addr) 525 { 526 /* FF:FF:FF:FF:FF:FF is a multicast address so we don't need to 527 * explicitly check for it here. */ 528 return !is_multicast_ether_addr(addr) && !is_zero_ether_addr(addr); 529 } 530 531 /* Convert an IP address to a string */ 532 extern void ip_to_string (IPaddr_t x, char *s); 533 534 /* Convert a string to ip address */ 535 extern IPaddr_t string_to_ip(const char *s); 536 537 /* Convert a VLAN id to a string */ 538 extern void VLAN_to_string (ushort x, char *s); 539 540 /* Convert a string to a vlan id */ 541 extern ushort string_to_VLAN(const char *s); 542 543 /* read a VLAN id from an environment variable */ 544 extern ushort getenv_VLAN(char *); 545 546 /* copy a filename (allow for "..." notation, limit length) */ 547 extern void copy_filename (char *dst, const char *src, int size); 548 549 /* get a random source port */ 550 extern unsigned int random_port(void); 551 552 /**********************************************************************/ 553 554 #endif /* __NET_H__ */ 555