blob: 603452ab3281ec9adb54652c11c3755a69ed2faf [file] [log] [blame]
wdenk2d966952002-10-31 22:12:35 +00001/*
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
wdenk71f95112003-06-15 22:40:42 +000015#if defined(CONFIG_8xx)
wdenk2d966952002-10-31 22:12:35 +000016#include <commproc.h>
wdenk71f95112003-06-15 22:40:42 +000017# 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 */
wdenkaacf9a42003-01-17 16:27:01 +000023
wdenkcbd8a352004-02-24 02:00:03 +000024#if defined(CONFIG_MPC5xxx)
wdenk77846742003-07-26 08:08:08 +000025# if !defined(CONFIG_NET_MULTI)
wdenkcbd8a352004-02-24 02:00:03 +000026# if defined(CONFIG_MPC5xxx_FEC)
wdenk77846742003-07-26 08:08:08 +000027# define CONFIG_NET_MULTI
28# endif
29# endif
wdenkcbd8a352004-02-24 02:00:03 +000030#endif /* CONFIG_MPC5xxx */
wdenk77846742003-07-26 08:08:08 +000031
Jon Loeliger9c4c5ae2005-07-23 10:37:35 -050032#if !defined(CONFIG_NET_MULTI) && defined(CONFIG_CPM2)
wdenkaacf9a42003-01-17 16:27:01 +000033#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
wdenk2d966952002-10-31 22:12:35 +000055#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
stroesec6028832003-06-05 15:38:29 +000064#ifdef CFG_RX_ETH_BUFFER
65# define PKTBUFSRX CFG_RX_ETH_BUFFER
wdenk1d0350e2002-11-11 21:14:20 +000066#else
stroesec6028832003-06-05 15:38:29 +000067# define PKTBUFSRX 4
wdenk1d0350e2002-11-11 21:14:20 +000068#endif
69
wdenk2d966952002-10-31 22:12:35 +000070#define PKTALIGN 32
71
72typedef ulong IPaddr_t;
73
74
wdenk2d966952002-10-31 22:12:35 +000075/*
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 */
80typedef void rxhand_f(uchar *, unsigned, unsigned, unsigned);
81
82/*
83 * A timeout handler. Called after time interval has expired.
84 */
85typedef void thand_f(void);
86
wdenk2d966952002-10-31 22:12:35 +000087#define NAMESIZE 16
88
89enum eth_state_t {
90 ETH_STATE_INIT,
91 ETH_STATE_PASSIVE,
92 ETH_STATE_ACTIVE
93};
94
95struct 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*);
David Updegraff53a5c422007-06-11 10:41:07 -0500102 int (*send) (struct eth_device*, volatile void* packet, int length);
wdenk2d966952002-10-31 22:12:35 +0000103 int (*recv) (struct eth_device*);
104 void (*halt) (struct eth_device*);
David Updegraff53a5c422007-06-11 10:41:07 -0500105#ifdef CONFIG_MCAST_TFTP
106 int (*mcast) (struct eth_device*, u32 ip, u8 set);
107#endif
wdenk2d966952002-10-31 22:12:35 +0000108 struct eth_device *next;
109 void *priv;
110};
111
112extern int eth_initialize(bd_t *bis); /* Initialize network subsystem */
113extern int eth_register(struct eth_device* dev);/* Register network device */
114extern void eth_try_another(int first_restart); /* Change the device */
wdenka3d991b2004-04-15 21:48:45 +0000115#ifdef CONFIG_NET_MULTI
116extern void eth_set_current(void); /* set nterface to ethcur var. */
117#endif
wdenk2d966952002-10-31 22:12:35 +0000118extern struct eth_device *eth_get_dev(void); /* get the current device MAC */
Marian Balakowicz63ff0042005-10-28 22:30:33 +0200119extern struct eth_device *eth_get_dev_by_name(char *devname); /* get device */
wdenka3d991b2004-04-15 21:48:45 +0000120extern int eth_get_dev_index (void); /* get the device index */
wdenk2d966952002-10-31 22:12:35 +0000121extern void eth_set_enetaddr(int num, char* a); /* Set new MAC address */
wdenk2d966952002-10-31 22:12:35 +0000122
123extern int eth_init(bd_t *bis); /* Initialize the device */
124extern int eth_send(volatile void *packet, int length); /* Send a packet */
125extern int eth_rx(void); /* Check for received packets */
126extern void eth_halt(void); /* stop SCC */
wdenk5bb226e2003-11-17 21:14:37 +0000127extern char *eth_get_name(void); /* get name of current device */
wdenk2d966952002-10-31 22:12:35 +0000128
David Updegraff53a5c422007-06-11 10:41:07 -0500129#ifdef CONFIG_MCAST_TFTP
130int eth_mcast_join( IPaddr_t mcast_addr, u8 join);
131u32 ether_crc (size_t len, unsigned char const *p);
132#endif
133
wdenk2d966952002-10-31 22:12:35 +0000134
135/**********************************************************************/
136/*
137 * Protocol headers.
138 */
139
140/*
141 * Ethernet header
142 */
143typedef struct {
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 */
151 uchar et_snap2;
152 uchar et_snap3;
153 ushort et_prot; /* 802 protocol */
154} Ethernet_t;
155
156#define ETHER_HDR_SIZE 14 /* Ethernet header size */
157#define E802_HDR_SIZE 22 /* 802 ethernet header size */
wdenka3d991b2004-04-15 21:48:45 +0000158
159/*
160 * Ethernet header
161 */
162typedef struct {
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 */
168} VLAN_Ethernet_t;
169
170#define VLAN_ETHER_HDR_SIZE 18 /* VLAN Ethernet header size */
171
wdenk2d966952002-10-31 22:12:35 +0000172#define PROT_IP 0x0800 /* IP protocol */
173#define PROT_ARP 0x0806 /* IP ARP protocol */
174#define PROT_RARP 0x8035 /* IP ARP protocol */
wdenka3d991b2004-04-15 21:48:45 +0000175#define PROT_VLAN 0x8100 /* IEEE 802.1q protocol */
wdenk2d966952002-10-31 22:12:35 +0000176
177#define IPPROTO_ICMP 1 /* Internet Control Message Protocol */
178#define IPPROTO_UDP 17 /* User Datagram Protocol */
179
180/*
181 * Internet Protocol (IP) header.
182 */
183typedef struct {
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 */
198} IP_t;
199
200#define IP_HDR_SIZE_NO_UDP (sizeof (IP_t) - 8)
201#define IP_HDR_SIZE (sizeof (IP_t))
202
203
204/*
205 * Address Resolution Protocol (ARP) header.
206 */
207typedef struct
208{
209 ushort ar_hrd; /* Format of hardware address */
210# define ARP_ETHER 1 /* Ethernet hardware address */
211 ushort ar_pro; /* Format of protocol address */
212 uchar ar_hln; /* Length of hardware address */
213 uchar ar_pln; /* Length of protocol address */
214 ushort ar_op; /* Operation */
215# define ARPOP_REQUEST 1 /* Request to resolve address */
216# define ARPOP_REPLY 2 /* Response to previous request */
217
218# define RARPOP_REQUEST 3 /* Request to resolve address */
219# define RARPOP_REPLY 4 /* Response to previous request */
220
221 /*
wdenk8bde7f72003-06-27 21:31:46 +0000222 * The remaining fields are variable in size, according to
223 * the sizes above, and are defined as appropriate for
224 * specific hardware/protocol combinations.
wdenk2d966952002-10-31 22:12:35 +0000225 */
226 uchar ar_data[0];
227#if 0
228 uchar ar_sha[]; /* Sender hardware address */
229 uchar ar_spa[]; /* Sender protocol address */
230 uchar ar_tha[]; /* Target hardware address */
231 uchar ar_tpa[]; /* Target protocol address */
232#endif /* 0 */
233} ARP_t;
234
235#define ARP_HDR_SIZE (8+20) /* Size assuming ethernet */
236
237/*
238 * ICMP stuff (just enough to handle (host) redirect messages)
239 */
wdenk73a8b272003-06-05 19:27:42 +0000240#define ICMP_ECHO_REPLY 0 /* Echo reply */
wdenk2d966952002-10-31 22:12:35 +0000241#define ICMP_REDIRECT 5 /* Redirect (change route) */
wdenk73a8b272003-06-05 19:27:42 +0000242#define ICMP_ECHO_REQUEST 8 /* Echo request */
wdenk2d966952002-10-31 22:12:35 +0000243
244/* Codes for REDIRECT. */
245#define ICMP_REDIR_NET 0 /* Redirect Net */
246#define ICMP_REDIR_HOST 1 /* Redirect Host */
247
248typedef struct icmphdr {
249 uchar type;
250 uchar code;
251 ushort checksum;
252 union {
253 struct {
254 ushort id;
255 ushort sequence;
256 } echo;
257 ulong gateway;
258 struct {
259 ushort __unused;
260 ushort mtu;
261 } frag;
262 } un;
263} ICMP_t;
264
265
wdenk2d966952002-10-31 22:12:35 +0000266/*
267 * Maximum packet size; used to allocate packet storage.
268 * TFTP packets can be 524 bytes + IP header + ethernet header.
269 * Lets be conservative, and go for 38 * 16. (Must also be
270 * a multiple of 32 bytes).
271 */
272/*
273 * AS.HARNOIS : Better to set PKTSIZE to maximum size because
274 * traffic type is not always controlled
275 * maximum packet size = 1518
276 * maximum packet size and multiple of 32 bytes = 1536
277 */
278#define PKTSIZE 1518
279#define PKTSIZE_ALIGN 1536
280/*#define PKTSIZE 608*/
281
282/*
283 * Maximum receive ring size; that is, the number of packets
284 * we can buffer before overflow happens. Basically, this just
285 * needs to be enough to prevent a packet being discarded while
286 * we are processing the previous one.
287 */
288#define RINGSZ 4
289#define RINGSZ_LOG2 2
290
291/**********************************************************************/
292/*
293 * Globals.
294 *
295 * Note:
296 *
297 * All variables of type IPaddr_t are stored in NETWORK byte order
298 * (big endian).
299 */
300
301/* net.c */
302/** BOOTP EXTENTIONS **/
303extern IPaddr_t NetOurGatewayIP; /* Our gateway IP addresse */
304extern IPaddr_t NetOurSubnetMask; /* Our subnet mask (0 = unknown)*/
305extern IPaddr_t NetOurDNSIP; /* Our Domain Name Server (0 = unknown)*/
Jon Loeliger1fe80d72007-07-09 22:08:34 -0500306#if defined(CONFIG_BOOTP_DNS2)
stroesefe389a82003-08-28 14:17:32 +0000307extern IPaddr_t NetOurDNS2IP; /* Our 2nd Domain Name Server (0 = unknown)*/
308#endif
wdenk2d966952002-10-31 22:12:35 +0000309extern char NetOurNISDomain[32]; /* Our NIS domain */
310extern char NetOurHostName[32]; /* Our hostname */
311extern char NetOurRootPath[64]; /* Our root path */
312extern ushort NetBootFileSize; /* Our boot file size in blocks */
313/** END OF BOOTP EXTENTIONS **/
314extern ulong NetBootFileXferSize; /* size of bootfile in bytes */
315extern uchar NetOurEther[6]; /* Our ethernet address */
316extern uchar NetServerEther[6]; /* Boot server enet address */
317extern IPaddr_t NetOurIP; /* Our IP addr (0 = unknown) */
318extern IPaddr_t NetServerIP; /* Server IP addr (0 = unknown) */
319extern volatile uchar * NetTxPacket; /* THE transmit packet */
320extern volatile uchar * NetRxPackets[PKTBUFSRX];/* Receive packets */
321extern volatile uchar * NetRxPkt; /* Current receive packet */
322extern int NetRxPktLen; /* Current rx packet length */
323extern unsigned NetIPID; /* IP ID (counting) */
324extern uchar NetBcastAddr[6]; /* Ethernet boardcast address */
wdenk68ceb292004-08-02 21:11:11 +0000325extern uchar NetEtherNullAddr[6];
wdenk2d966952002-10-31 22:12:35 +0000326
wdenka3d991b2004-04-15 21:48:45 +0000327#define VLAN_NONE 4095 /* untagged */
328#define VLAN_IDMASK 0x0fff /* mask of valid vlan id */
329extern ushort NetOurVLAN; /* Our VLAN */
330extern ushort NetOurNativeVLAN; /* Our Native VLAN */
331
332extern uchar NetCDPAddr[6]; /* Ethernet CDP address */
333extern ushort CDPNativeVLAN; /* CDP returned native VLAN */
334extern ushort CDPApplianceVLAN; /* CDP returned appliance VLAN */
335
wdenk2d966952002-10-31 22:12:35 +0000336extern int NetState; /* Network loop state */
337#define NETLOOP_CONTINUE 1
338#define NETLOOP_RESTART 2
339#define NETLOOP_SUCCESS 3
340#define NETLOOP_FAIL 4
341
342#ifdef CONFIG_NET_MULTI
343extern int NetRestartWrap; /* Tried all network devices */
344#endif
345
wdenkea287de2005-04-01 00:25:43 +0000346typedef enum { BOOTP, RARP, ARP, TFTP, DHCP, PING, DNS, NFS, CDP, NETCONS, SNTP } proto_t;
wdenk2d966952002-10-31 22:12:35 +0000347
348/* from net/net.c */
349extern char BootFile[128]; /* Boot File name */
350
Jon Loeliger639221c2007-07-09 17:15:49 -0500351#if defined(CONFIG_CMD_PING)
wdenk73a8b272003-06-05 19:27:42 +0000352extern IPaddr_t NetPingIP; /* the ip address to ping */
353#endif
354
Jon Loeliger639221c2007-07-09 17:15:49 -0500355#if defined(CONFIG_CMD_CDP)
wdenka3d991b2004-04-15 21:48:45 +0000356/* when CDP completes these hold the return values */
357extern ushort CDPNativeVLAN;
358extern ushort CDPApplianceVLAN;
359#endif
360
Jon Loeliger639221c2007-07-09 17:15:49 -0500361#if defined(CONFIG_CMD_SNTP)
wdenkea287de2005-04-01 00:25:43 +0000362extern IPaddr_t NetNtpServerIP; /* the ip address to NTP */
363extern int NetTimeOffset; /* offset time from UTC */
364#endif
365
wdenk2d966952002-10-31 22:12:35 +0000366/* Initialize the network adapter */
367extern int NetLoop(proto_t);
368
369/* Shutdown adapters and cleanup */
370extern void NetStop(void);
371
372/* Load failed. Start again. */
373extern void NetStartAgain(void);
374
wdenka3d991b2004-04-15 21:48:45 +0000375/* Get size of the ethernet header when we send */
376extern int NetEthHdrSize(void);
377
378/* Set ethernet header; returns the size of the header */
379extern int NetSetEther(volatile uchar *, uchar *, uint);
wdenk2d966952002-10-31 22:12:35 +0000380
381/* Set IP header */
382extern void NetSetIP(volatile uchar *, IPaddr_t, int, int, int);
383
384/* Checksum */
385extern int NetCksumOk(uchar *, int); /* Return true if cksum OK */
386extern uint NetCksum(uchar *, int); /* Calculate the checksum */
387
388/* Set callbacks */
389extern void NetSetHandler(rxhand_f *); /* Set RX packet handler */
wdenk3e01d752004-10-09 21:56:21 +0000390extern void NetSetTimeout(ulong, thand_f *);/* Set timeout handler */
wdenk2d966952002-10-31 22:12:35 +0000391
392/* Transmit "NetTxPacket" */
393extern void NetSendPacket(volatile uchar *, int);
394
wdenk73a8b272003-06-05 19:27:42 +0000395/* Transmit UDP packet, performing ARP request if needed */
396extern int NetSendUDPPacket(uchar *ether, IPaddr_t dest, int dport, int sport, int len);
397
wdenk2d966952002-10-31 22:12:35 +0000398/* Processes a received packet */
399extern void NetReceive(volatile uchar *, int);
400
401/* Print an IP address on the console */
402extern void print_IPaddr (IPaddr_t);
403
404/*
405 * The following functions are a bit ugly, but necessary to deal with
406 * alignment restrictions on ARM.
407 *
408 * We're using inline functions, which had the smallest memory
409 * footprint in our tests.
410 */
411/* return IP *in network byteorder* */
412static inline IPaddr_t NetReadIP(void *from)
413{
414 IPaddr_t ip;
415 memcpy((void*)&ip, from, sizeof(ip));
416 return ip;
417}
418
419/* return ulong *in network byteorder* */
420static inline ulong NetReadLong(ulong *from)
421{
422 ulong l;
423 memcpy((void*)&l, (void*)from, sizeof(l));
424 return l;
425}
426
427/* write IP *in network byteorder* */
428static inline void NetWriteIP(void *to, IPaddr_t ip)
429{
430 memcpy(to, (void*)&ip, sizeof(ip));
431}
432
433/* copy IP */
434static inline void NetCopyIP(void *to, void *from)
435{
436 memcpy(to, from, sizeof(IPaddr_t));
437}
438
439/* copy ulong */
440static inline void NetCopyLong(ulong *to, ulong *from)
441{
442 memcpy((void*)to, (void*)from, sizeof(ulong));
443}
444
Mike Rapoport50cca8b2007-08-12 08:48:27 +0300445/**
446 * is_zero_ether_addr - Determine if give Ethernet address is all zeros.
447 * @addr: Pointer to a six-byte array containing the Ethernet address
448 *
449 * Return true if the address is all zeroes.
450 */
451static inline int is_zero_ether_addr(const u8 *addr)
452{
453 return !(addr[0] | addr[1] | addr[2] | addr[3] | addr[4] | addr[5]);
454}
455
456/**
457 * is_multicast_ether_addr - Determine if the Ethernet address is a multicast.
458 * @addr: Pointer to a six-byte array containing the Ethernet address
459 *
460 * Return true if the address is a multicast address.
461 * By definition the broadcast address is also a multicast address.
462 */
463static inline int is_multicast_ether_addr(const u8 *addr)
464{
465 return (0x01 & addr[0]);
466}
467
wdenk2d966952002-10-31 22:12:35 +0000468/* Convert an IP address to a string */
469extern void ip_to_string (IPaddr_t x, char *s);
470
wdenk73a8b272003-06-05 19:27:42 +0000471/* Convert a string to ip address */
472extern IPaddr_t string_to_ip(char *s);
473
wdenka3d991b2004-04-15 21:48:45 +0000474/* Convert a VLAN id to a string */
475extern void VLAN_to_string (ushort x, char *s);
476
477/* Convert a string to a vlan id */
478extern ushort string_to_VLAN(char *s);
479
wdenk2d966952002-10-31 22:12:35 +0000480/* read an IP address from a environment variable */
481extern IPaddr_t getenv_IPaddr (char *);
482
wdenka3d991b2004-04-15 21:48:45 +0000483/* read a VLAN id from an environment variable */
484extern ushort getenv_VLAN(char *);
485
wdenk2d966952002-10-31 22:12:35 +0000486/* copy a filename (allow for "..." notation, limit length) */
Wolfgang Denk77ddac92005-10-13 16:45:02 +0200487extern void copy_filename (char *dst, char *src, int size);
wdenk2d966952002-10-31 22:12:35 +0000488
489/**********************************************************************/
490
491#endif /* __NET_H__ */