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