2 * LiMon Monitor (LiMon) - Network.
4 * Copyright 1994 - 2000 Neil Russell.
9 * 9/16/00 bor adapted to TQM823L/STK8xxL board, RARP/TFTP boot added
15 #if defined(CONFIG_8xx)
17 #endif /* CONFIG_8xx */
19 #include <asm/byteorder.h> /* for nton* / ntoh* stuff */
23 * The number of receive packet buffers, and the required packet buffer
24 * alignment in memory.
28 #ifdef CONFIG_SYS_RX_ETH_BUFFER
29 # define PKTBUFSRX CONFIG_SYS_RX_ETH_BUFFER
36 typedef ulong IPaddr_t;
40 * An incoming packet handler.
41 * @param pkt pointer to the application packet
42 * @param dport destination UDP port
43 * @param sip source IP address
44 * @param sport source UDP port
45 * @param len packet length
47 typedef void rxhand_f(uchar *pkt, unsigned dport,
48 IPaddr_t sip, unsigned sport,
52 * A timeout handler. Called after time interval has expired.
54 typedef void thand_f(void);
66 unsigned char enetaddr[6];
70 int (*init) (struct eth_device*, bd_t*);
71 int (*send) (struct eth_device*, volatile void* packet, int length);
72 int (*recv) (struct eth_device*);
73 void (*halt) (struct eth_device*);
74 #ifdef CONFIG_MCAST_TFTP
75 int (*mcast) (struct eth_device*, u32 ip, u8 set);
77 int (*write_hwaddr) (struct eth_device*);
78 struct eth_device *next;
82 extern int eth_initialize(bd_t *bis); /* Initialize network subsystem */
83 extern int eth_register(struct eth_device* dev);/* Register network device */
84 extern void eth_try_another(int first_restart); /* Change the device */
85 extern void eth_set_current(void); /* set nterface to ethcur var */
86 extern struct eth_device *eth_get_dev(void); /* get the current device MAC */
87 extern struct eth_device *eth_get_dev_by_name(const char *devname);
88 extern struct eth_device *eth_get_dev_by_index(int index); /* get dev @ index */
89 extern int eth_get_dev_index (void); /* get the device index */
90 extern void eth_parse_enetaddr(const char *addr, uchar *enetaddr);
91 extern int eth_getenv_enetaddr(char *name, uchar *enetaddr);
92 extern int eth_setenv_enetaddr(char *name, const uchar *enetaddr);
95 * Get the hardware address for an ethernet interface .
97 * base_name - base name for device (normally "eth")
98 * index - device index number (0 for first)
99 * enetaddr - returns 6 byte hardware address
101 * Return true if the address is valid.
103 extern int eth_getenv_enetaddr_by_index(const char *base_name, int index,
106 extern int usb_eth_initialize(bd_t *bi);
107 extern int eth_init(bd_t *bis); /* Initialize the device */
108 extern int eth_send(volatile void *packet, int length); /* Send a packet */
111 extern int eth_receive(volatile void *packet, int length); /* Receive a packet*/
113 extern int eth_rx(void); /* Check for received packets */
114 extern void eth_halt(void); /* stop SCC */
115 extern char *eth_get_name(void); /* get name of current device */
118 * Set the hardware address for an ethernet interface based on 'eth%daddr'
119 * environment variable (or just 'ethaddr' if eth_number is 0).
121 * base_name - base name for device (normally "eth")
122 * eth_number - value of %d (0 for first device of this type)
124 * 0 is success, non-zero is error status from driver.
126 int eth_write_hwaddr(struct eth_device *dev, const char *base_name,
129 #ifdef CONFIG_MCAST_TFTP
130 int eth_mcast_join( IPaddr_t mcast_addr, u8 join);
131 u32 ether_crc (size_t len, unsigned char const *p);
135 /**********************************************************************/
144 uchar et_dest[6]; /* Destination node */
145 uchar et_src[6]; /* Source node */
146 ushort et_protlen; /* Protocol or length */
147 uchar et_dsap; /* 802 DSAP */
148 uchar et_ssap; /* 802 SSAP */
149 uchar et_ctl; /* 802 control */
150 uchar et_snap1; /* SNAP */
153 ushort et_prot; /* 802 protocol */
156 #define ETHER_HDR_SIZE 14 /* Ethernet header size */
157 #define E802_HDR_SIZE 22 /* 802 ethernet header size */
163 uchar vet_dest[6]; /* Destination node */
164 uchar vet_src[6]; /* Source node */
165 ushort vet_vlan_type; /* PROT_VLAN */
166 ushort vet_tag; /* TAG of VLAN */
167 ushort vet_type; /* protocol type */
170 #define VLAN_ETHER_HDR_SIZE 18 /* VLAN Ethernet header size */
172 #define PROT_IP 0x0800 /* IP protocol */
173 #define PROT_ARP 0x0806 /* IP ARP protocol */
174 #define PROT_RARP 0x8035 /* IP ARP protocol */
175 #define PROT_VLAN 0x8100 /* IEEE 802.1q protocol */
177 #define IPPROTO_ICMP 1 /* Internet Control Message Protocol */
178 #define IPPROTO_UDP 17 /* User Datagram Protocol */
181 * Internet Protocol (IP) header.
184 uchar ip_hl_v; /* header length and version */
185 uchar ip_tos; /* type of service */
186 ushort ip_len; /* total length */
187 ushort ip_id; /* identification */
188 ushort ip_off; /* fragment offset field */
189 uchar ip_ttl; /* time to live */
190 uchar ip_p; /* protocol */
191 ushort ip_sum; /* checksum */
192 IPaddr_t ip_src; /* Source IP address */
193 IPaddr_t ip_dst; /* Destination IP address */
194 ushort udp_src; /* UDP source port */
195 ushort udp_dst; /* UDP destination port */
196 ushort udp_len; /* Length of UDP packet */
197 ushort udp_xsum; /* Checksum */
200 #define IP_OFFS 0x1fff /* ip offset *= 8 */
201 #define IP_FLAGS 0xe000 /* first 3 bits */
202 #define IP_FLAGS_RES 0x8000 /* reserved */
203 #define IP_FLAGS_DFRAG 0x4000 /* don't fragments */
204 #define IP_FLAGS_MFRAG 0x2000 /* more fragments */
206 #define IP_HDR_SIZE_NO_UDP (sizeof (IP_t) - 8)
207 #define IP_HDR_SIZE (sizeof (IP_t))
211 * Address Resolution Protocol (ARP) header.
215 ushort ar_hrd; /* Format of hardware address */
216 # define ARP_ETHER 1 /* Ethernet hardware address */
217 ushort ar_pro; /* Format of protocol address */
218 uchar ar_hln; /* Length of hardware address */
219 uchar ar_pln; /* Length of protocol address */
220 ushort ar_op; /* Operation */
221 # define ARPOP_REQUEST 1 /* Request to resolve address */
222 # define ARPOP_REPLY 2 /* Response to previous request */
224 # define RARPOP_REQUEST 3 /* Request to resolve address */
225 # define RARPOP_REPLY 4 /* Response to previous request */
228 * The remaining fields are variable in size, according to
229 * the sizes above, and are defined as appropriate for
230 * specific hardware/protocol combinations.
234 uchar ar_sha[]; /* Sender hardware address */
235 uchar ar_spa[]; /* Sender protocol address */
236 uchar ar_tha[]; /* Target hardware address */
237 uchar ar_tpa[]; /* Target protocol address */
241 #define ARP_HDR_SIZE (8+20) /* Size assuming ethernet */
244 * ICMP stuff (just enough to handle (host) redirect messages)
246 #define ICMP_ECHO_REPLY 0 /* Echo reply */
247 #define ICMP_REDIRECT 5 /* Redirect (change route) */
248 #define ICMP_ECHO_REQUEST 8 /* Echo request */
250 /* Codes for REDIRECT. */
251 #define ICMP_REDIR_NET 0 /* Redirect Net */
252 #define ICMP_REDIR_HOST 1 /* Redirect Host */
254 typedef struct icmphdr {
273 * Maximum packet size; used to allocate packet storage.
274 * TFTP packets can be 524 bytes + IP header + ethernet header.
275 * Lets be conservative, and go for 38 * 16. (Must also be
276 * a multiple of 32 bytes).
279 * AS.HARNOIS : Better to set PKTSIZE to maximum size because
280 * traffic type is not always controlled
281 * maximum packet size = 1518
282 * maximum packet size and multiple of 32 bytes = 1536
285 #define PKTSIZE_ALIGN 1536
286 /*#define PKTSIZE 608*/
289 * Maximum receive ring size; that is, the number of packets
290 * we can buffer before overflow happens. Basically, this just
291 * needs to be enough to prevent a packet being discarded while
292 * we are processing the previous one.
295 #define RINGSZ_LOG2 2
297 /**********************************************************************/
303 * All variables of type IPaddr_t are stored in NETWORK byte order
308 /** BOOTP EXTENTIONS **/
309 extern IPaddr_t NetOurGatewayIP; /* Our gateway IP addresse */
310 extern IPaddr_t NetOurSubnetMask; /* Our subnet mask (0 = unknown)*/
311 extern IPaddr_t NetOurDNSIP; /* Our Domain Name Server (0 = unknown)*/
312 #if defined(CONFIG_BOOTP_DNS2)
313 extern IPaddr_t NetOurDNS2IP; /* Our 2nd Domain Name Server (0 = unknown)*/
315 extern char NetOurNISDomain[32]; /* Our NIS domain */
316 extern char NetOurHostName[32]; /* Our hostname */
317 extern char NetOurRootPath[64]; /* Our root path */
318 extern ushort NetBootFileSize; /* Our boot file size in blocks */
319 /** END OF BOOTP EXTENTIONS **/
320 extern ulong NetBootFileXferSize; /* size of bootfile in bytes */
321 extern uchar NetOurEther[6]; /* Our ethernet address */
322 extern uchar NetServerEther[6]; /* Boot server enet address */
323 extern IPaddr_t NetOurIP; /* Our IP addr (0 = unknown) */
324 extern IPaddr_t NetServerIP; /* Server IP addr (0 = unknown) */
325 extern volatile uchar * NetTxPacket; /* THE transmit packet */
326 extern volatile uchar * NetRxPackets[PKTBUFSRX];/* Receive packets */
327 extern volatile uchar * NetRxPacket; /* Current receive packet */
328 extern int NetRxPacketLen; /* Current rx packet length */
329 extern unsigned NetIPID; /* IP ID (counting) */
330 extern uchar NetBcastAddr[6]; /* Ethernet boardcast address */
331 extern uchar NetEtherNullAddr[6];
333 #define VLAN_NONE 4095 /* untagged */
334 #define VLAN_IDMASK 0x0fff /* mask of valid vlan id */
335 extern ushort NetOurVLAN; /* Our VLAN */
336 extern ushort NetOurNativeVLAN; /* Our Native VLAN */
338 extern uchar NetCDPAddr[6]; /* Ethernet CDP address */
339 extern ushort CDPNativeVLAN; /* CDP returned native VLAN */
340 extern ushort CDPApplianceVLAN; /* CDP returned appliance VLAN */
342 extern int NetState; /* Network loop state */
343 #define NETLOOP_CONTINUE 1
344 #define NETLOOP_RESTART 2
345 #define NETLOOP_SUCCESS 3
346 #define NETLOOP_FAIL 4
348 extern int NetRestartWrap; /* Tried all network devices */
350 typedef enum { BOOTP, RARP, ARP, TFTP, DHCP, PING, DNS, NFS, CDP, NETCONS, SNTP,
354 extern char BootFile[128]; /* Boot File name */
356 #if defined(CONFIG_CMD_DNS)
357 extern char *NetDNSResolve; /* The host to resolve */
358 extern char *NetDNSenvvar; /* the env var to put the ip into */
361 #if defined(CONFIG_CMD_PING)
362 extern IPaddr_t NetPingIP; /* the ip address to ping */
365 #if defined(CONFIG_CMD_CDP)
366 /* when CDP completes these hold the return values */
367 extern ushort CDPNativeVLAN;
368 extern ushort CDPApplianceVLAN;
371 #if defined(CONFIG_CMD_SNTP)
372 extern IPaddr_t NetNtpServerIP; /* the ip address to NTP */
373 extern int NetTimeOffset; /* offset time from UTC */
376 /* Initialize the network adapter */
377 extern int NetLoop(proto_t);
379 /* Shutdown adapters and cleanup */
380 extern void NetStop(void);
382 /* Load failed. Start again. */
383 extern void NetStartAgain(void);
385 /* Get size of the ethernet header when we send */
386 extern int NetEthHdrSize(void);
388 /* Set ethernet header; returns the size of the header */
389 extern int NetSetEther(volatile uchar *, uchar *, uint);
392 extern void NetSetIP(volatile uchar *, IPaddr_t, int, int, int);
395 extern int NetCksumOk(uchar *, int); /* Return true if cksum OK */
396 extern uint NetCksum(uchar *, int); /* Calculate the checksum */
399 extern void NetSetHandler(rxhand_f *); /* Set RX packet handler */
400 extern void NetSetTimeout(ulong, thand_f *);/* Set timeout handler */
402 /* Transmit "NetTxPacket" */
403 extern void NetSendPacket(volatile uchar *, int);
405 /* Transmit UDP packet, performing ARP request if needed */
406 extern int NetSendUDPPacket(uchar *ether, IPaddr_t dest, int dport, int sport, int len);
408 /* Processes a received packet */
409 extern void NetReceive(volatile uchar *, int);
412 * The following functions are a bit ugly, but necessary to deal with
413 * alignment restrictions on ARM.
415 * We're using inline functions, which had the smallest memory
416 * footprint in our tests.
418 /* return IP *in network byteorder* */
419 static inline IPaddr_t NetReadIP(volatile void *from)
422 memcpy((void*)&ip, (void*)from, sizeof(ip));
426 /* return ulong *in network byteorder* */
427 static inline ulong NetReadLong(ulong *from)
430 memcpy((void*)&l, (void*)from, sizeof(l));
434 /* write IP *in network byteorder* */
435 static inline void NetWriteIP(void *to, IPaddr_t ip)
437 memcpy(to, (void*)&ip, sizeof(ip));
441 static inline void NetCopyIP(volatile void *to, void *from)
443 memcpy((void*)to, from, sizeof(IPaddr_t));
447 static inline void NetCopyLong(ulong *to, ulong *from)
449 memcpy((void*)to, (void*)from, sizeof(ulong));
453 * is_zero_ether_addr - Determine if give Ethernet address is all zeros.
454 * @addr: Pointer to a six-byte array containing the Ethernet address
456 * Return true if the address is all zeroes.
458 static inline int is_zero_ether_addr(const u8 *addr)
460 return !(addr[0] | addr[1] | addr[2] | addr[3] | addr[4] | addr[5]);
464 * is_multicast_ether_addr - Determine if the Ethernet address is a multicast.
465 * @addr: Pointer to a six-byte array containing the Ethernet address
467 * Return true if the address is a multicast address.
468 * By definition the broadcast address is also a multicast address.
470 static inline int is_multicast_ether_addr(const u8 *addr)
472 return (0x01 & addr[0]);
476 * is_broadcast_ether_addr - Determine if the Ethernet address is broadcast
477 * @addr: Pointer to a six-byte array containing the Ethernet address
479 * Return true if the address is the broadcast address.
481 static inline int is_broadcast_ether_addr(const u8 *addr)
483 return (addr[0] & addr[1] & addr[2] & addr[3] & addr[4] & addr[5]) == 0xff;
487 * is_valid_ether_addr - Determine if the given Ethernet address is valid
488 * @addr: Pointer to a six-byte array containing the Ethernet address
490 * Check that the Ethernet address (MAC) is not 00:00:00:00:00:00, is not
491 * a multicast address, and is not FF:FF:FF:FF:FF:FF.
493 * Return true if the address is valid.
495 static inline int is_valid_ether_addr(const u8 *addr)
497 /* FF:FF:FF:FF:FF:FF is a multicast address so we don't need to
498 * explicitly check for it here. */
499 return !is_multicast_ether_addr(addr) && !is_zero_ether_addr(addr);
502 /* Convert an IP address to a string */
503 extern void ip_to_string (IPaddr_t x, char *s);
505 /* Convert a string to ip address */
506 extern IPaddr_t string_to_ip(const char *s);
508 /* Convert a VLAN id to a string */
509 extern void VLAN_to_string (ushort x, char *s);
511 /* Convert a string to a vlan id */
512 extern ushort string_to_VLAN(const char *s);
514 /* read a VLAN id from an environment variable */
515 extern ushort getenv_VLAN(char *);
517 /* copy a filename (allow for "..." notation, limit length) */
518 extern void copy_filename (char *dst, const char *src, int size);
520 /* get a random source port */
521 extern unsigned int random_port(void);
523 /**********************************************************************/
525 #endif /* __NET_H__ */