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