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_NET_MULTI) && defined(CONFIG_8xx) 16 #include <commproc.h> 17 #if defined(FEC_ENET) || defined(SCC_ENET) 18 #define CONFIG_NET_MULTI 19 #endif 20 #endif 21 22 #if !defined(CONFIG_NET_MULTI) && defined(CONFIG_8260) 23 #include <config.h> 24 #if defined(CONFIG_ETHER_ON_FCC) 25 #if defined(CONFIG_ETHER_ON_SCC) 26 #error "Ethernet not correctly defined" 27 #endif /* CONFIG_ETHER_ON_SCC */ 28 #define CONFIG_NET_MULTI 29 #if (CONFIG_ETHER_INDEX == 1) 30 #define CONFIG_ETHER_ON_FCC1 31 # define CFG_CMXFCR_MASK1 CFG_CMXFCR_MASK 32 # define CFG_CMXFCR_VALUE1 CFG_CMXFCR_VALUE 33 #elif (CONFIG_ETHER_INDEX == 2) 34 #define CONFIG_ETHER_ON_FCC2 35 # define CFG_CMXFCR_MASK2 CFG_CMXFCR_MASK 36 # define CFG_CMXFCR_VALUE2 CFG_CMXFCR_VALUE 37 #elif (CONFIG_ETHER_INDEX == 3) 38 #define CONFIG_ETHER_ON_FCC3 39 # define CFG_CMXFCR_MASK3 CFG_CMXFCR_MASK 40 # define CFG_CMXFCR_VALUE3 CFG_CMXFCR_VALUE 41 #endif /* CONFIG_ETHER_INDEX */ 42 #endif /* CONFIG_ETHER_ON_FCC */ 43 #endif /* !CONFIG_NET_MULTI && CONFIG_8260 */ 44 45 #include <asm/byteorder.h> /* for nton* / ntoh* stuff */ 46 47 48 /* 49 * The number of receive packet buffers, and the required packet buffer 50 * alignment in memory. 51 * 52 */ 53 54 #ifndef CONFIG_EEPRO100 55 #define PKTBUFSRX 4 56 #else 57 #define PKTBUFSRX 8 58 #endif 59 60 #define PKTALIGN 32 61 62 typedef ulong IPaddr_t; 63 64 65 66 /* 67 * The current receive packet handler. Called with a pointer to the 68 * application packet, and a protocol type (PORT_BOOTPC or PORT_TFTP). 69 * All other packets are dealt with without calling the handler. 70 */ 71 typedef void rxhand_f(uchar *, unsigned, unsigned, unsigned); 72 73 /* 74 * A timeout handler. Called after time interval has expired. 75 */ 76 typedef void thand_f(void); 77 78 #ifdef CONFIG_NET_MULTI 79 80 #define NAMESIZE 16 81 82 enum eth_state_t { 83 ETH_STATE_INIT, 84 ETH_STATE_PASSIVE, 85 ETH_STATE_ACTIVE 86 }; 87 88 struct eth_device { 89 char name[NAMESIZE]; 90 unsigned char enetaddr[6]; 91 int iobase; 92 int state; 93 94 int (*init) (struct eth_device*, bd_t*); 95 int (*send) (struct eth_device*, volatile void* pachet, int length); 96 int (*recv) (struct eth_device*); 97 void (*halt) (struct eth_device*); 98 99 struct eth_device *next; 100 void *priv; 101 }; 102 103 extern int eth_initialize(bd_t *bis); /* Initialize network subsystem */ 104 extern int eth_register(struct eth_device* dev);/* Register network device */ 105 extern void eth_try_another(int first_restart); /* Change the device */ 106 extern struct eth_device *eth_get_dev(void); /* get the current device MAC */ 107 extern void eth_set_enetaddr(int num, char* a); /* Set new MAC address */ 108 #endif 109 110 extern int eth_init(bd_t *bis); /* Initialize the device */ 111 extern int eth_send(volatile void *packet, int length); /* Send a packet */ 112 extern int eth_rx(void); /* Check for received packets */ 113 extern void eth_halt(void); /* stop SCC */ 114 115 116 /**********************************************************************/ 117 /* 118 * Protocol headers. 119 */ 120 121 /* 122 * Ethernet header 123 */ 124 typedef struct { 125 uchar et_dest[6]; /* Destination node */ 126 uchar et_src[6]; /* Source node */ 127 ushort et_protlen; /* Protocol or length */ 128 uchar et_dsap; /* 802 DSAP */ 129 uchar et_ssap; /* 802 SSAP */ 130 uchar et_ctl; /* 802 control */ 131 uchar et_snap1; /* SNAP */ 132 uchar et_snap2; 133 uchar et_snap3; 134 ushort et_prot; /* 802 protocol */ 135 } Ethernet_t; 136 137 #define ETHER_HDR_SIZE 14 /* Ethernet header size */ 138 #define E802_HDR_SIZE 22 /* 802 ethernet header size */ 139 #define PROT_IP 0x0800 /* IP protocol */ 140 #define PROT_ARP 0x0806 /* IP ARP protocol */ 141 #define PROT_RARP 0x8035 /* IP ARP protocol */ 142 143 #define IPPROTO_ICMP 1 /* Internet Control Message Protocol */ 144 #define IPPROTO_UDP 17 /* User Datagram Protocol */ 145 146 /* 147 * Internet Protocol (IP) header. 148 */ 149 typedef struct { 150 uchar ip_hl_v; /* header length and version */ 151 uchar ip_tos; /* type of service */ 152 ushort ip_len; /* total length */ 153 ushort ip_id; /* identification */ 154 ushort ip_off; /* fragment offset field */ 155 uchar ip_ttl; /* time to live */ 156 uchar ip_p; /* protocol */ 157 ushort ip_sum; /* checksum */ 158 IPaddr_t ip_src; /* Source IP address */ 159 IPaddr_t ip_dst; /* Destination IP address */ 160 ushort udp_src; /* UDP source port */ 161 ushort udp_dst; /* UDP destination port */ 162 ushort udp_len; /* Length of UDP packet */ 163 ushort udp_xsum; /* Checksum */ 164 } IP_t; 165 166 #define IP_HDR_SIZE_NO_UDP (sizeof (IP_t) - 8) 167 #define IP_HDR_SIZE (sizeof (IP_t)) 168 169 170 /* 171 * Address Resolution Protocol (ARP) header. 172 */ 173 typedef struct 174 { 175 ushort ar_hrd; /* Format of hardware address */ 176 # define ARP_ETHER 1 /* Ethernet hardware address */ 177 ushort ar_pro; /* Format of protocol address */ 178 uchar ar_hln; /* Length of hardware address */ 179 uchar ar_pln; /* Length of protocol address */ 180 ushort ar_op; /* Operation */ 181 # define ARPOP_REQUEST 1 /* Request to resolve address */ 182 # define ARPOP_REPLY 2 /* Response to previous request */ 183 184 # define RARPOP_REQUEST 3 /* Request to resolve address */ 185 # define RARPOP_REPLY 4 /* Response to previous request */ 186 187 /* 188 * The remaining fields are variable in size, according to 189 * the sizes above, and are defined as appropriate for 190 * specific hardware/protocol combinations. 191 */ 192 uchar ar_data[0]; 193 #if 0 194 uchar ar_sha[]; /* Sender hardware address */ 195 uchar ar_spa[]; /* Sender protocol address */ 196 uchar ar_tha[]; /* Target hardware address */ 197 uchar ar_tpa[]; /* Target protocol address */ 198 #endif /* 0 */ 199 } ARP_t; 200 201 #define ARP_HDR_SIZE (8+20) /* Size assuming ethernet */ 202 203 /* 204 * ICMP stuff (just enough to handle (host) redirect messages) 205 */ 206 #define ICMP_REDIRECT 5 /* Redirect (change route) */ 207 208 /* Codes for REDIRECT. */ 209 #define ICMP_REDIR_NET 0 /* Redirect Net */ 210 #define ICMP_REDIR_HOST 1 /* Redirect Host */ 211 212 typedef struct icmphdr { 213 uchar type; 214 uchar code; 215 ushort checksum; 216 union { 217 struct { 218 ushort id; 219 ushort sequence; 220 } echo; 221 ulong gateway; 222 struct { 223 ushort __unused; 224 ushort mtu; 225 } frag; 226 } un; 227 } ICMP_t; 228 229 230 231 /* 232 * Maximum packet size; used to allocate packet storage. 233 * TFTP packets can be 524 bytes + IP header + ethernet header. 234 * Lets be conservative, and go for 38 * 16. (Must also be 235 * a multiple of 32 bytes). 236 */ 237 /* 238 * AS.HARNOIS : Better to set PKTSIZE to maximum size because 239 * traffic type is not always controlled 240 * maximum packet size = 1518 241 * maximum packet size and multiple of 32 bytes = 1536 242 */ 243 #define PKTSIZE 1518 244 #define PKTSIZE_ALIGN 1536 245 /*#define PKTSIZE 608*/ 246 247 /* 248 * Maximum receive ring size; that is, the number of packets 249 * we can buffer before overflow happens. Basically, this just 250 * needs to be enough to prevent a packet being discarded while 251 * we are processing the previous one. 252 */ 253 #define RINGSZ 4 254 #define RINGSZ_LOG2 2 255 256 /**********************************************************************/ 257 /* 258 * Globals. 259 * 260 * Note: 261 * 262 * All variables of type IPaddr_t are stored in NETWORK byte order 263 * (big endian). 264 */ 265 266 /* net.c */ 267 /** BOOTP EXTENTIONS **/ 268 extern IPaddr_t NetOurGatewayIP; /* Our gateway IP addresse */ 269 extern IPaddr_t NetOurSubnetMask; /* Our subnet mask (0 = unknown)*/ 270 extern IPaddr_t NetOurDNSIP; /* Our Domain Name Server (0 = unknown)*/ 271 extern char NetOurNISDomain[32]; /* Our NIS domain */ 272 extern char NetOurHostName[32]; /* Our hostname */ 273 extern char NetOurRootPath[64]; /* Our root path */ 274 extern ushort NetBootFileSize; /* Our boot file size in blocks */ 275 /** END OF BOOTP EXTENTIONS **/ 276 extern ulong NetBootFileXferSize; /* size of bootfile in bytes */ 277 extern uchar NetOurEther[6]; /* Our ethernet address */ 278 extern uchar NetServerEther[6]; /* Boot server enet address */ 279 extern IPaddr_t NetOurIP; /* Our IP addr (0 = unknown) */ 280 extern IPaddr_t NetServerIP; /* Server IP addr (0 = unknown) */ 281 extern volatile uchar * NetTxPacket; /* THE transmit packet */ 282 extern volatile uchar * NetRxPackets[PKTBUFSRX];/* Receive packets */ 283 extern volatile uchar * NetRxPkt; /* Current receive packet */ 284 extern int NetRxPktLen; /* Current rx packet length */ 285 extern unsigned NetIPID; /* IP ID (counting) */ 286 extern uchar NetBcastAddr[6]; /* Ethernet boardcast address */ 287 288 extern int NetState; /* Network loop state */ 289 #define NETLOOP_CONTINUE 1 290 #define NETLOOP_RESTART 2 291 #define NETLOOP_SUCCESS 3 292 #define NETLOOP_FAIL 4 293 294 #ifdef CONFIG_NET_MULTI 295 extern int NetRestartWrap; /* Tried all network devices */ 296 #endif 297 298 typedef enum { BOOTP, RARP, ARP, TFTP, DHCP } proto_t; 299 300 /* from net/net.c */ 301 extern char BootFile[128]; /* Boot File name */ 302 303 /* Initialize the network adapter */ 304 extern int NetLoop(proto_t); 305 306 /* Shutdown adapters and cleanup */ 307 extern void NetStop(void); 308 309 /* Load failed. Start again. */ 310 extern void NetStartAgain(void); 311 312 /* Set ethernet header */ 313 extern void NetSetEther(volatile uchar *, uchar *, uint); 314 315 /* Set IP header */ 316 extern void NetSetIP(volatile uchar *, IPaddr_t, int, int, int); 317 318 /* Checksum */ 319 extern int NetCksumOk(uchar *, int); /* Return true if cksum OK */ 320 extern uint NetCksum(uchar *, int); /* Calculate the checksum */ 321 322 /* Set callbacks */ 323 extern void NetSetHandler(rxhand_f *); /* Set RX packet handler */ 324 extern void NetSetTimeout(int, thand_f *); /* Set timeout handler */ 325 326 /* Transmit "NetTxPacket" */ 327 extern void NetSendPacket(volatile uchar *, int); 328 329 /* Processes a received packet */ 330 extern void NetReceive(volatile uchar *, int); 331 332 /* Print an IP address on the console */ 333 extern void print_IPaddr (IPaddr_t); 334 335 /* 336 * The following functions are a bit ugly, but necessary to deal with 337 * alignment restrictions on ARM. 338 * 339 * We're using inline functions, which had the smallest memory 340 * footprint in our tests. 341 */ 342 /* return IP *in network byteorder* */ 343 static inline IPaddr_t NetReadIP(void *from) 344 { 345 IPaddr_t ip; 346 memcpy((void*)&ip, from, sizeof(ip)); 347 return ip; 348 } 349 350 /* return ulong *in network byteorder* */ 351 static inline ulong NetReadLong(ulong *from) 352 { 353 ulong l; 354 memcpy((void*)&l, (void*)from, sizeof(l)); 355 return l; 356 } 357 358 /* write IP *in network byteorder* */ 359 static inline void NetWriteIP(void *to, IPaddr_t ip) 360 { 361 memcpy(to, (void*)&ip, sizeof(ip)); 362 } 363 364 /* copy IP */ 365 static inline void NetCopyIP(void *to, void *from) 366 { 367 memcpy(to, from, sizeof(IPaddr_t)); 368 } 369 370 /* copy ulong */ 371 static inline void NetCopyLong(ulong *to, ulong *from) 372 { 373 memcpy((void*)to, (void*)from, sizeof(ulong)); 374 } 375 376 /* Convert an IP address to a string */ 377 extern void ip_to_string (IPaddr_t x, char *s); 378 379 /* read an IP address from a environment variable */ 380 extern IPaddr_t getenv_IPaddr (char *); 381 382 /* copy a filename (allow for "..." notation, limit length) */ 383 extern void copy_filename (uchar *dst, uchar *src, int size); 384 385 /**********************************************************************/ 386 387 #endif /* __NET_H__ */ 388