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