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