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/cache.h>
20 #include <asm/byteorder.h> /* for nton* / ntoh* stuff */
24 * The number of receive packet buffers, and the required packet buffer
25 * alignment in memory.
29 #ifdef CONFIG_SYS_RX_ETH_BUFFER
30 # define PKTBUFSRX CONFIG_SYS_RX_ETH_BUFFER
35 #define PKTALIGN ARCH_DMA_MINALIGN
37 /* IPv4 addresses are always 32 bits in size */
42 * An incoming packet handler.
43 * @param pkt pointer to the application packet
44 * @param dport destination UDP port
45 * @param sip source IP address
46 * @param sport source UDP port
47 * @param len packet length
49 typedef void rxhand_f(uchar *pkt, unsigned dport,
50 IPaddr_t sip, unsigned sport,
54 * An incoming ICMP packet handler.
55 * @param type ICMP type
56 * @param code ICMP code
57 * @param dport destination UDP port
58 * @param sip source IP address
59 * @param sport source UDP port
60 * @param pkt pointer to the ICMP packet data
61 * @param len packet length
63 typedef void rxhand_icmp_f(unsigned type, unsigned code, unsigned dport,
64 IPaddr_t sip, unsigned sport, uchar *pkt, unsigned len);
67 * A timeout handler. Called after time interval has expired.
69 typedef void thand_f(void);
79 unsigned char enetaddr[6];
83 int (*init) (struct eth_device *, bd_t *);
84 int (*send) (struct eth_device *, void *packet, int length);
85 int (*recv) (struct eth_device *);
86 void (*halt) (struct eth_device *);
87 #ifdef CONFIG_MCAST_TFTP
88 int (*mcast) (struct eth_device *, u32 ip, u8 set);
90 int (*write_hwaddr) (struct eth_device *);
91 struct eth_device *next;
96 extern int eth_initialize(bd_t *bis); /* Initialize network subsystem */
97 extern int eth_register(struct eth_device* dev);/* Register network device */
98 extern int eth_unregister(struct eth_device *dev);/* Remove network device */
99 extern void eth_try_another(int first_restart); /* Change the device */
100 extern void eth_set_current(void); /* set nterface to ethcur var */
101 extern struct eth_device *eth_get_dev(void); /* get the current device MAC */
102 extern struct eth_device *eth_get_dev_by_name(const char *devname);
103 extern struct eth_device *eth_get_dev_by_index(int index); /* get dev @ index */
104 extern int eth_get_dev_index(void); /* get the device index */
105 extern void eth_parse_enetaddr(const char *addr, uchar *enetaddr);
106 extern int eth_getenv_enetaddr(char *name, uchar *enetaddr);
107 extern int eth_setenv_enetaddr(char *name, const uchar *enetaddr);
110 * Get the hardware address for an ethernet interface .
112 * base_name - base name for device (normally "eth")
113 * index - device index number (0 for first)
114 * enetaddr - returns 6 byte hardware address
116 * Return true if the address is valid.
118 extern int eth_getenv_enetaddr_by_index(const char *base_name, int index,
121 extern int usb_eth_initialize(bd_t *bi);
122 extern int eth_init(bd_t *bis); /* Initialize the device */
123 extern int eth_send(void *packet, int length); /* Send a packet */
126 extern int eth_receive(void *packet, int length); /* Receive a packet*/
127 extern void (*push_packet)(void *packet, int length);
129 extern int eth_rx(void); /* Check for received packets */
130 extern void eth_halt(void); /* stop SCC */
131 extern char *eth_get_name(void); /* get name of current device */
134 * Set the hardware address for an ethernet interface based on 'eth%daddr'
135 * environment variable (or just 'ethaddr' if eth_number is 0).
137 * base_name - base name for device (normally "eth")
138 * eth_number - value of %d (0 for first device of this type)
140 * 0 is success, non-zero is error status from driver.
142 int eth_write_hwaddr(struct eth_device *dev, const char *base_name,
145 #ifdef CONFIG_MCAST_TFTP
146 int eth_mcast_join(IPaddr_t mcast_addr, u8 join);
147 u32 ether_crc(size_t len, unsigned char const *p);
151 /**********************************************************************/
160 struct ethernet_hdr {
161 uchar et_dest[6]; /* Destination node */
162 uchar et_src[6]; /* Source node */
163 ushort et_protlen; /* Protocol or length */
166 /* Ethernet header size */
167 #define ETHER_HDR_SIZE (sizeof(struct ethernet_hdr))
170 uchar et_dest[6]; /* Destination node */
171 uchar et_src[6]; /* Source node */
172 ushort et_protlen; /* Protocol or length */
173 uchar et_dsap; /* 802 DSAP */
174 uchar et_ssap; /* 802 SSAP */
175 uchar et_ctl; /* 802 control */
176 uchar et_snap1; /* SNAP */
179 ushort et_prot; /* 802 protocol */
182 /* 802 ethernet header size */
183 #define E802_HDR_SIZE (sizeof(struct e802_hdr))
189 uchar vet_dest[6]; /* Destination node */
190 uchar vet_src[6]; /* Source node */
191 ushort vet_vlan_type; /* PROT_VLAN */
192 ushort vet_tag; /* TAG of VLAN */
193 ushort vet_type; /* protocol type */
196 #define VLAN_ETHER_HDR_SIZE 18 /* VLAN Ethernet header size */
198 #define PROT_IP 0x0800 /* IP protocol */
199 #define PROT_ARP 0x0806 /* IP ARP protocol */
200 #define PROT_RARP 0x8035 /* IP ARP protocol */
201 #define PROT_VLAN 0x8100 /* IEEE 802.1q protocol */
203 #define IPPROTO_ICMP 1 /* Internet Control Message Protocol */
204 #define IPPROTO_UDP 17 /* User Datagram Protocol */
207 * Internet Protocol (IP) header.
210 uchar ip_hl_v; /* header length and version */
211 uchar ip_tos; /* type of service */
212 ushort ip_len; /* total length */
213 ushort ip_id; /* identification */
214 ushort ip_off; /* fragment offset field */
215 uchar ip_ttl; /* time to live */
216 uchar ip_p; /* protocol */
217 ushort ip_sum; /* checksum */
218 IPaddr_t ip_src; /* Source IP address */
219 IPaddr_t ip_dst; /* Destination IP address */
222 #define IP_OFFS 0x1fff /* ip offset *= 8 */
223 #define IP_FLAGS 0xe000 /* first 3 bits */
224 #define IP_FLAGS_RES 0x8000 /* reserved */
225 #define IP_FLAGS_DFRAG 0x4000 /* don't fragments */
226 #define IP_FLAGS_MFRAG 0x2000 /* more fragments */
228 #define IP_HDR_SIZE (sizeof(struct ip_hdr))
231 * Internet Protocol (IP) + UDP header.
234 uchar ip_hl_v; /* header length and version */
235 uchar ip_tos; /* type of service */
236 ushort ip_len; /* total length */
237 ushort ip_id; /* identification */
238 ushort ip_off; /* fragment offset field */
239 uchar ip_ttl; /* time to live */
240 uchar ip_p; /* protocol */
241 ushort ip_sum; /* checksum */
242 IPaddr_t ip_src; /* Source IP address */
243 IPaddr_t ip_dst; /* Destination IP address */
244 ushort udp_src; /* UDP source port */
245 ushort udp_dst; /* UDP destination port */
246 ushort udp_len; /* Length of UDP packet */
247 ushort udp_xsum; /* Checksum */
250 #define IP_UDP_HDR_SIZE (sizeof(struct ip_udp_hdr))
251 #define UDP_HDR_SIZE (IP_UDP_HDR_SIZE - IP_HDR_SIZE)
254 * Address Resolution Protocol (ARP) header.
258 ushort ar_hrd; /* Format of hardware address */
259 # define ARP_ETHER 1 /* Ethernet hardware address */
260 ushort ar_pro; /* Format of protocol address */
261 uchar ar_hln; /* Length of hardware address */
262 uchar ar_pln; /* Length of protocol address */
263 ushort ar_op; /* Operation */
264 # define ARPOP_REQUEST 1 /* Request to resolve address */
265 # define ARPOP_REPLY 2 /* Response to previous request */
267 # define RARPOP_REQUEST 3 /* Request to resolve address */
268 # define RARPOP_REPLY 4 /* Response to previous request */
271 * The remaining fields are variable in size, according to
272 * the sizes above, and are defined as appropriate for
273 * specific hardware/protocol combinations.
277 uchar ar_sha[]; /* Sender hardware address */
278 uchar ar_spa[]; /* Sender protocol address */
279 uchar ar_tha[]; /* Target hardware address */
280 uchar ar_tpa[]; /* Target protocol address */
284 #define ARP_HDR_SIZE (8+20) /* Size assuming ethernet */
287 * ICMP stuff (just enough to handle (host) redirect messages)
289 #define ICMP_ECHO_REPLY 0 /* Echo reply */
290 #define ICMP_NOT_REACH 3 /* Detination unreachable */
291 #define ICMP_REDIRECT 5 /* Redirect (change route) */
292 #define ICMP_ECHO_REQUEST 8 /* Echo request */
294 /* Codes for REDIRECT. */
295 #define ICMP_REDIR_NET 0 /* Redirect Net */
296 #define ICMP_REDIR_HOST 1 /* Redirect Host */
298 /* Codes for NOT_REACH */
299 #define ICMP_NOT_REACH_PORT 3 /* Port unreachable */
301 typedef struct icmphdr {
321 * Maximum packet size; used to allocate packet storage.
322 * TFTP packets can be 524 bytes + IP header + ethernet header.
323 * Lets be conservative, and go for 38 * 16. (Must also be
324 * a multiple of 32 bytes).
327 * AS.HARNOIS : Better to set PKTSIZE to maximum size because
328 * traffic type is not always controlled
329 * maximum packet size = 1518
330 * maximum packet size and multiple of 32 bytes = 1536
333 #define PKTSIZE_ALIGN 1536
334 /*#define PKTSIZE 608*/
337 * Maximum receive ring size; that is, the number of packets
338 * we can buffer before overflow happens. Basically, this just
339 * needs to be enough to prevent a packet being discarded while
340 * we are processing the previous one.
343 #define RINGSZ_LOG2 2
345 /**********************************************************************/
351 * All variables of type IPaddr_t are stored in NETWORK byte order
356 /** BOOTP EXTENTIONS **/
357 extern IPaddr_t NetOurGatewayIP; /* Our gateway IP address */
358 extern IPaddr_t NetOurSubnetMask; /* Our subnet mask (0 = unknown) */
359 extern IPaddr_t NetOurDNSIP; /* Our Domain Name Server (0 = unknown) */
360 #if defined(CONFIG_BOOTP_DNS2)
361 extern IPaddr_t NetOurDNS2IP; /* Our 2nd Domain Name Server (0 = unknown) */
363 extern char NetOurNISDomain[32]; /* Our NIS domain */
364 extern char NetOurHostName[32]; /* Our hostname */
365 extern char NetOurRootPath[64]; /* Our root path */
366 extern ushort NetBootFileSize; /* Our boot file size in blocks */
367 /** END OF BOOTP EXTENTIONS **/
368 extern ulong NetBootFileXferSize; /* size of bootfile in bytes */
369 extern uchar NetOurEther[6]; /* Our ethernet address */
370 extern uchar NetServerEther[6]; /* Boot server enet address */
371 extern IPaddr_t NetOurIP; /* Our IP addr (0 = unknown) */
372 extern IPaddr_t NetServerIP; /* Server IP addr (0 = unknown) */
373 extern uchar *NetTxPacket; /* THE transmit packet */
374 extern uchar *NetRxPackets[PKTBUFSRX]; /* Receive packets */
375 extern uchar *NetRxPacket; /* Current receive packet */
376 extern int NetRxPacketLen; /* Current rx packet length */
377 extern unsigned NetIPID; /* IP ID (counting) */
378 extern uchar NetBcastAddr[6]; /* Ethernet boardcast address */
379 extern uchar NetEtherNullAddr[6];
381 #define VLAN_NONE 4095 /* untagged */
382 #define VLAN_IDMASK 0x0fff /* mask of valid vlan id */
383 extern ushort NetOurVLAN; /* Our VLAN */
384 extern ushort NetOurNativeVLAN; /* Our Native VLAN */
386 extern int NetState; /* Network loop state */
387 #define NETLOOP_CONTINUE 1
388 #define NETLOOP_RESTART 2
389 #define NETLOOP_SUCCESS 3
390 #define NETLOOP_FAIL 4
392 extern int NetRestartWrap; /* Tried all network devices */
395 BOOTP, RARP, ARP, TFTPGET, DHCP, PING, DNS, NFS, CDP, NETCONS, SNTP,
400 extern char BootFile[128]; /* Boot File name */
402 #if defined(CONFIG_CMD_DNS)
403 extern char *NetDNSResolve; /* The host to resolve */
404 extern char *NetDNSenvvar; /* the env var to put the ip into */
407 #if defined(CONFIG_CMD_PING)
408 extern IPaddr_t NetPingIP; /* the ip address to ping */
411 #if defined(CONFIG_CMD_CDP)
412 /* when CDP completes these hold the return values */
413 extern ushort CDPNativeVLAN; /* CDP returned native VLAN */
414 extern ushort CDPApplianceVLAN; /* CDP returned appliance VLAN */
417 * Check for a CDP packet by examining the received MAC address field
419 static inline int is_cdp_packet(const uchar *et_addr)
421 extern const uchar NetCDPAddr[6];
423 return memcmp(et_addr, NetCDPAddr, 6) == 0;
427 #if defined(CONFIG_CMD_SNTP)
428 extern IPaddr_t NetNtpServerIP; /* the ip address to NTP */
429 extern int NetTimeOffset; /* offset time from UTC */
432 #if defined(CONFIG_MCAST_TFTP)
433 extern IPaddr_t Mcast_addr;
436 /* Initialize the network adapter */
437 extern int NetLoop(enum proto_t);
439 /* Shutdown adapters and cleanup */
440 extern void NetStop(void);
442 /* Load failed. Start again. */
443 extern void NetStartAgain(void);
445 /* Get size of the ethernet header when we send */
446 extern int NetEthHdrSize(void);
448 /* Set ethernet header; returns the size of the header */
449 extern int NetSetEther(uchar *, uchar *, uint);
452 extern void NetSetIP(uchar *, IPaddr_t, int, int, int);
455 extern int NetCksumOk(uchar *, int); /* Return true if cksum OK */
456 extern uint NetCksum(uchar *, int); /* Calculate the checksum */
459 extern rxhand_f *NetGetHandler(void); /* Get RX packet handler */
460 extern void NetSetHandler(rxhand_f *); /* Set RX packet handler */
461 extern void net_set_icmp_handler(rxhand_icmp_f *f); /* Set ICMP RX handler */
462 extern void NetSetTimeout(ulong, thand_f *);/* Set timeout handler */
464 /* Transmit "NetTxPacket" */
465 extern void NetSendPacket(uchar *, int);
467 /* Transmit UDP packet, performing ARP request if needed */
468 extern int NetSendUDPPacket(uchar *ether, IPaddr_t dest, int dport,
471 /* Processes a received packet */
472 extern void NetReceive(uchar *, int);
474 #ifdef CONFIG_NETCONSOLE
476 int nc_input_packet(uchar *pkt, unsigned dest, unsigned src, unsigned len);
480 * Check if autoload is enabled. If so, use either NFS or TFTP to download
483 void net_auto_load(void);
486 * The following functions are a bit ugly, but necessary to deal with
487 * alignment restrictions on ARM.
489 * We're using inline functions, which had the smallest memory
490 * footprint in our tests.
492 /* return IP *in network byteorder* */
493 static inline IPaddr_t NetReadIP(void *from)
497 memcpy((void *)&ip, (void *)from, sizeof(ip));
501 /* return ulong *in network byteorder* */
502 static inline ulong NetReadLong(ulong *from)
506 memcpy((void *)&l, (void *)from, sizeof(l));
510 /* write IP *in network byteorder* */
511 static inline void NetWriteIP(void *to, IPaddr_t ip)
513 memcpy(to, (void *)&ip, sizeof(ip));
517 static inline void NetCopyIP(void *to, void *from)
519 memcpy((void *)to, from, sizeof(IPaddr_t));
523 static inline void NetCopyLong(ulong *to, ulong *from)
525 memcpy((void *)to, (void *)from, sizeof(ulong));
529 * is_zero_ether_addr - Determine if give Ethernet address is all zeros.
530 * @addr: Pointer to a six-byte array containing the Ethernet address
532 * Return true if the address is all zeroes.
534 static inline int is_zero_ether_addr(const u8 *addr)
536 return !(addr[0] | addr[1] | addr[2] | addr[3] | addr[4] | addr[5]);
540 * is_multicast_ether_addr - Determine if the Ethernet address is a multicast.
541 * @addr: Pointer to a six-byte array containing the Ethernet address
543 * Return true if the address is a multicast address.
544 * By definition the broadcast address is also a multicast address.
546 static inline int is_multicast_ether_addr(const u8 *addr)
548 return 0x01 & addr[0];
552 * is_broadcast_ether_addr - Determine if the Ethernet address is broadcast
553 * @addr: Pointer to a six-byte array containing the Ethernet address
555 * Return true if the address is the broadcast address.
557 static inline int is_broadcast_ether_addr(const u8 *addr)
559 return (addr[0] & addr[1] & addr[2] & addr[3] & addr[4] & addr[5]) ==
564 * is_valid_ether_addr - Determine if the given Ethernet address is valid
565 * @addr: Pointer to a six-byte array containing the Ethernet address
567 * Check that the Ethernet address (MAC) is not 00:00:00:00:00:00, is not
568 * a multicast address, and is not FF:FF:FF:FF:FF:FF.
570 * Return true if the address is valid.
572 static inline int is_valid_ether_addr(const u8 *addr)
574 /* FF:FF:FF:FF:FF:FF is a multicast address so we don't need to
575 * explicitly check for it here. */
576 return !is_multicast_ether_addr(addr) && !is_zero_ether_addr(addr);
579 /* Convert an IP address to a string */
580 extern void ip_to_string(IPaddr_t x, char *s);
582 /* Convert a string to ip address */
583 extern IPaddr_t string_to_ip(const char *s);
585 /* Convert a VLAN id to a string */
586 extern void VLAN_to_string(ushort x, char *s);
588 /* Convert a string to a vlan id */
589 extern ushort string_to_VLAN(const char *s);
591 /* read a VLAN id from an environment variable */
592 extern ushort getenv_VLAN(char *);
594 /* copy a filename (allow for "..." notation, limit length) */
595 extern void copy_filename(char *dst, const char *src, int size);
597 /* get a random source port */
598 extern unsigned int random_port(void);
600 /**********************************************************************/
602 #endif /* __NET_H__ */