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