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 int eth_get_dev_index (void); /* get the device index */ 121 extern void eth_set_enetaddr(int num, char* a); /* Set new MAC address */ 122 123 extern int eth_init(bd_t *bis); /* Initialize the device */ 124 extern int eth_send(volatile void *packet, int length); /* Send a packet */ 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 #ifdef CONFIG_MCAST_TFTP 133 int eth_mcast_join( IPaddr_t mcast_addr, u8 join); 134 u32 ether_crc (size_t len, unsigned char const *p); 135 #endif 136 137 138 /**********************************************************************/ 139 /* 140 * Protocol headers. 141 */ 142 143 /* 144 * Ethernet header 145 */ 146 typedef struct { 147 uchar et_dest[6]; /* Destination node */ 148 uchar et_src[6]; /* Source node */ 149 ushort et_protlen; /* Protocol or length */ 150 uchar et_dsap; /* 802 DSAP */ 151 uchar et_ssap; /* 802 SSAP */ 152 uchar et_ctl; /* 802 control */ 153 uchar et_snap1; /* SNAP */ 154 uchar et_snap2; 155 uchar et_snap3; 156 ushort et_prot; /* 802 protocol */ 157 } Ethernet_t; 158 159 #define ETHER_HDR_SIZE 14 /* Ethernet header size */ 160 #define E802_HDR_SIZE 22 /* 802 ethernet header size */ 161 162 /* 163 * Ethernet header 164 */ 165 typedef struct { 166 uchar vet_dest[6]; /* Destination node */ 167 uchar vet_src[6]; /* Source node */ 168 ushort vet_vlan_type; /* PROT_VLAN */ 169 ushort vet_tag; /* TAG of VLAN */ 170 ushort vet_type; /* protocol type */ 171 } VLAN_Ethernet_t; 172 173 #define VLAN_ETHER_HDR_SIZE 18 /* VLAN Ethernet header size */ 174 175 #define PROT_IP 0x0800 /* IP protocol */ 176 #define PROT_ARP 0x0806 /* IP ARP protocol */ 177 #define PROT_RARP 0x8035 /* IP ARP protocol */ 178 #define PROT_VLAN 0x8100 /* IEEE 802.1q protocol */ 179 180 #define IPPROTO_ICMP 1 /* Internet Control Message Protocol */ 181 #define IPPROTO_UDP 17 /* User Datagram Protocol */ 182 183 /* 184 * Internet Protocol (IP) header. 185 */ 186 typedef struct { 187 uchar ip_hl_v; /* header length and version */ 188 uchar ip_tos; /* type of service */ 189 ushort ip_len; /* total length */ 190 ushort ip_id; /* identification */ 191 ushort ip_off; /* fragment offset field */ 192 uchar ip_ttl; /* time to live */ 193 uchar ip_p; /* protocol */ 194 ushort ip_sum; /* checksum */ 195 IPaddr_t ip_src; /* Source IP address */ 196 IPaddr_t ip_dst; /* Destination IP address */ 197 ushort udp_src; /* UDP source port */ 198 ushort udp_dst; /* UDP destination port */ 199 ushort udp_len; /* Length of UDP packet */ 200 ushort udp_xsum; /* Checksum */ 201 } IP_t; 202 203 #define IP_HDR_SIZE_NO_UDP (sizeof (IP_t) - 8) 204 #define IP_HDR_SIZE (sizeof (IP_t)) 205 206 207 /* 208 * Address Resolution Protocol (ARP) header. 209 */ 210 typedef struct 211 { 212 ushort ar_hrd; /* Format of hardware address */ 213 # define ARP_ETHER 1 /* Ethernet hardware address */ 214 ushort ar_pro; /* Format of protocol address */ 215 uchar ar_hln; /* Length of hardware address */ 216 uchar ar_pln; /* Length of protocol address */ 217 ushort ar_op; /* Operation */ 218 # define ARPOP_REQUEST 1 /* Request to resolve address */ 219 # define ARPOP_REPLY 2 /* Response to previous request */ 220 221 # define RARPOP_REQUEST 3 /* Request to resolve address */ 222 # define RARPOP_REPLY 4 /* Response to previous request */ 223 224 /* 225 * The remaining fields are variable in size, according to 226 * the sizes above, and are defined as appropriate for 227 * specific hardware/protocol combinations. 228 */ 229 uchar ar_data[0]; 230 #if 0 231 uchar ar_sha[]; /* Sender hardware address */ 232 uchar ar_spa[]; /* Sender protocol address */ 233 uchar ar_tha[]; /* Target hardware address */ 234 uchar ar_tpa[]; /* Target protocol address */ 235 #endif /* 0 */ 236 } ARP_t; 237 238 #define ARP_HDR_SIZE (8+20) /* Size assuming ethernet */ 239 240 /* 241 * ICMP stuff (just enough to handle (host) redirect messages) 242 */ 243 #define ICMP_ECHO_REPLY 0 /* Echo reply */ 244 #define ICMP_REDIRECT 5 /* Redirect (change route) */ 245 #define ICMP_ECHO_REQUEST 8 /* Echo request */ 246 247 /* Codes for REDIRECT. */ 248 #define ICMP_REDIR_NET 0 /* Redirect Net */ 249 #define ICMP_REDIR_HOST 1 /* Redirect Host */ 250 251 typedef struct icmphdr { 252 uchar type; 253 uchar code; 254 ushort checksum; 255 union { 256 struct { 257 ushort id; 258 ushort sequence; 259 } echo; 260 ulong gateway; 261 struct { 262 ushort __unused; 263 ushort mtu; 264 } frag; 265 } un; 266 } ICMP_t; 267 268 269 /* 270 * Maximum packet size; used to allocate packet storage. 271 * TFTP packets can be 524 bytes + IP header + ethernet header. 272 * Lets be conservative, and go for 38 * 16. (Must also be 273 * a multiple of 32 bytes). 274 */ 275 /* 276 * AS.HARNOIS : Better to set PKTSIZE to maximum size because 277 * traffic type is not always controlled 278 * maximum packet size = 1518 279 * maximum packet size and multiple of 32 bytes = 1536 280 */ 281 #define PKTSIZE 1518 282 #define PKTSIZE_ALIGN 1536 283 /*#define PKTSIZE 608*/ 284 285 /* 286 * Maximum receive ring size; that is, the number of packets 287 * we can buffer before overflow happens. Basically, this just 288 * needs to be enough to prevent a packet being discarded while 289 * we are processing the previous one. 290 */ 291 #define RINGSZ 4 292 #define RINGSZ_LOG2 2 293 294 /**********************************************************************/ 295 /* 296 * Globals. 297 * 298 * Note: 299 * 300 * All variables of type IPaddr_t are stored in NETWORK byte order 301 * (big endian). 302 */ 303 304 /* net.c */ 305 /** BOOTP EXTENTIONS **/ 306 extern IPaddr_t NetOurGatewayIP; /* Our gateway IP addresse */ 307 extern IPaddr_t NetOurSubnetMask; /* Our subnet mask (0 = unknown)*/ 308 extern IPaddr_t NetOurDNSIP; /* Our Domain Name Server (0 = unknown)*/ 309 #if defined(CONFIG_BOOTP_DNS2) 310 extern IPaddr_t NetOurDNS2IP; /* Our 2nd Domain Name Server (0 = unknown)*/ 311 #endif 312 extern char NetOurNISDomain[32]; /* Our NIS domain */ 313 extern char NetOurHostName[32]; /* Our hostname */ 314 extern char NetOurRootPath[64]; /* Our root path */ 315 extern ushort NetBootFileSize; /* Our boot file size in blocks */ 316 /** END OF BOOTP EXTENTIONS **/ 317 extern ulong NetBootFileXferSize; /* size of bootfile in bytes */ 318 extern uchar NetOurEther[6]; /* Our ethernet address */ 319 extern uchar NetServerEther[6]; /* Boot server enet address */ 320 extern IPaddr_t NetOurIP; /* Our IP addr (0 = unknown) */ 321 extern IPaddr_t NetServerIP; /* Server IP addr (0 = unknown) */ 322 extern volatile uchar * NetTxPacket; /* THE transmit packet */ 323 extern volatile uchar * NetRxPackets[PKTBUFSRX];/* Receive packets */ 324 extern volatile uchar * NetRxPkt; /* Current receive packet */ 325 extern int NetRxPktLen; /* Current rx packet length */ 326 extern unsigned NetIPID; /* IP ID (counting) */ 327 extern uchar NetBcastAddr[6]; /* Ethernet boardcast address */ 328 extern uchar NetEtherNullAddr[6]; 329 330 #define VLAN_NONE 4095 /* untagged */ 331 #define VLAN_IDMASK 0x0fff /* mask of valid vlan id */ 332 extern ushort NetOurVLAN; /* Our VLAN */ 333 extern ushort NetOurNativeVLAN; /* Our Native VLAN */ 334 335 extern uchar NetCDPAddr[6]; /* Ethernet CDP address */ 336 extern ushort CDPNativeVLAN; /* CDP returned native VLAN */ 337 extern ushort CDPApplianceVLAN; /* CDP returned appliance VLAN */ 338 339 extern int NetState; /* Network loop state */ 340 #define NETLOOP_CONTINUE 1 341 #define NETLOOP_RESTART 2 342 #define NETLOOP_SUCCESS 3 343 #define NETLOOP_FAIL 4 344 345 #ifdef CONFIG_NET_MULTI 346 extern int NetRestartWrap; /* Tried all network devices */ 347 #endif 348 349 typedef enum { BOOTP, RARP, ARP, TFTP, DHCP, PING, DNS, NFS, CDP, NETCONS, SNTP } proto_t; 350 351 /* from net/net.c */ 352 extern char BootFile[128]; /* Boot File name */ 353 354 #if defined(CONFIG_CMD_PING) 355 extern IPaddr_t NetPingIP; /* the ip address to ping */ 356 #endif 357 358 #if defined(CONFIG_CMD_CDP) 359 /* when CDP completes these hold the return values */ 360 extern ushort CDPNativeVLAN; 361 extern ushort CDPApplianceVLAN; 362 #endif 363 364 #if defined(CONFIG_CMD_SNTP) 365 extern IPaddr_t NetNtpServerIP; /* the ip address to NTP */ 366 extern int NetTimeOffset; /* offset time from UTC */ 367 #endif 368 369 /* Initialize the network adapter */ 370 extern int NetLoop(proto_t); 371 372 /* Shutdown adapters and cleanup */ 373 extern void NetStop(void); 374 375 /* Load failed. Start again. */ 376 extern void NetStartAgain(void); 377 378 /* Get size of the ethernet header when we send */ 379 extern int NetEthHdrSize(void); 380 381 /* Set ethernet header; returns the size of the header */ 382 extern int NetSetEther(volatile uchar *, uchar *, uint); 383 384 /* Set IP header */ 385 extern void NetSetIP(volatile uchar *, IPaddr_t, int, int, int); 386 387 /* Checksum */ 388 extern int NetCksumOk(uchar *, int); /* Return true if cksum OK */ 389 extern uint NetCksum(uchar *, int); /* Calculate the checksum */ 390 391 /* Set callbacks */ 392 extern void NetSetHandler(rxhand_f *); /* Set RX packet handler */ 393 extern void NetSetTimeout(ulong, thand_f *);/* Set timeout handler */ 394 395 /* Transmit "NetTxPacket" */ 396 extern void NetSendPacket(volatile uchar *, int); 397 398 /* Transmit UDP packet, performing ARP request if needed */ 399 extern int NetSendUDPPacket(uchar *ether, IPaddr_t dest, int dport, int sport, int len); 400 401 /* Processes a received packet */ 402 extern void NetReceive(volatile uchar *, int); 403 404 /* Print an IP address on the console */ 405 extern void print_IPaddr (IPaddr_t); 406 407 /* 408 * The following functions are a bit ugly, but necessary to deal with 409 * alignment restrictions on ARM. 410 * 411 * We're using inline functions, which had the smallest memory 412 * footprint in our tests. 413 */ 414 /* return IP *in network byteorder* */ 415 static inline IPaddr_t NetReadIP(volatile void *from) 416 { 417 IPaddr_t ip; 418 memcpy((void*)&ip, (void*)from, sizeof(ip)); 419 return ip; 420 } 421 422 /* return ulong *in network byteorder* */ 423 static inline ulong NetReadLong(ulong *from) 424 { 425 ulong l; 426 memcpy((void*)&l, (void*)from, sizeof(l)); 427 return l; 428 } 429 430 /* write IP *in network byteorder* */ 431 static inline void NetWriteIP(void *to, IPaddr_t ip) 432 { 433 memcpy(to, (void*)&ip, sizeof(ip)); 434 } 435 436 /* copy IP */ 437 static inline void NetCopyIP(volatile void *to, void *from) 438 { 439 memcpy((void*)to, from, sizeof(IPaddr_t)); 440 } 441 442 /* copy ulong */ 443 static inline void NetCopyLong(ulong *to, ulong *from) 444 { 445 memcpy((void*)to, (void*)from, sizeof(ulong)); 446 } 447 448 /** 449 * is_zero_ether_addr - Determine if give Ethernet address is all zeros. 450 * @addr: Pointer to a six-byte array containing the Ethernet address 451 * 452 * Return true if the address is all zeroes. 453 */ 454 static inline int is_zero_ether_addr(const u8 *addr) 455 { 456 return !(addr[0] | addr[1] | addr[2] | addr[3] | addr[4] | addr[5]); 457 } 458 459 /** 460 * is_multicast_ether_addr - Determine if the Ethernet address is a multicast. 461 * @addr: Pointer to a six-byte array containing the Ethernet address 462 * 463 * Return true if the address is a multicast address. 464 * By definition the broadcast address is also a multicast address. 465 */ 466 static inline int is_multicast_ether_addr(const u8 *addr) 467 { 468 return (0x01 & addr[0]); 469 } 470 471 /* Convert an IP address to a string */ 472 extern void ip_to_string (IPaddr_t x, char *s); 473 474 /* Convert a string to ip address */ 475 extern IPaddr_t string_to_ip(char *s); 476 477 /* Convert a VLAN id to a string */ 478 extern void VLAN_to_string (ushort x, char *s); 479 480 /* Convert a string to a vlan id */ 481 extern ushort string_to_VLAN(char *s); 482 483 /* read an IP address from a environment variable */ 484 extern IPaddr_t getenv_IPaddr (char *); 485 486 /* read a VLAN id from an environment variable */ 487 extern ushort getenv_VLAN(char *); 488 489 /* copy a filename (allow for "..." notation, limit length) */ 490 extern void copy_filename (char *dst, char *src, int size); 491 492 /**********************************************************************/ 493 494 #endif /* __NET_H__ */ 495