blob: 96719480097f55863ceb50b0e8b79e463c859b52 [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*);
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
110extern int eth_initialize(bd_t *bis); /* Initialize network subsystem */
111extern int eth_register(struct eth_device* dev);/* Register network device */
112extern void eth_try_another(int first_restart); /* Change the device */
wdenka3d991b2004-04-15 21:48:45 +0000113#ifdef CONFIG_NET_MULTI
114extern void eth_set_current(void); /* set nterface to ethcur var. */
115#endif
wdenk2d966952002-10-31 22:12:35 +0000116extern struct eth_device *eth_get_dev(void); /* get the current device MAC */
Marian Balakowicz63ff0042005-10-28 22:30:33 +0200117extern struct eth_device *eth_get_dev_by_name(char *devname); /* get device */
wdenka3d991b2004-04-15 21:48:45 +0000118extern int eth_get_dev_index (void); /* get the device index */
wdenk2d966952002-10-31 22:12:35 +0000119extern void eth_set_enetaddr(int num, char* a); /* Set new MAC address */
wdenk2d966952002-10-31 22:12:35 +0000120
121extern int eth_init(bd_t *bis); /* Initialize the device */
122extern int eth_send(volatile void *packet, int length); /* Send a packet */
123extern int eth_rx(void); /* Check for received packets */
124extern void eth_halt(void); /* stop SCC */
wdenk5bb226e2003-11-17 21:14:37 +0000125extern char *eth_get_name(void); /* get name of current device */
wdenk2d966952002-10-31 22:12:35 +0000126
127
128/**********************************************************************/
129/*
130 * Protocol headers.
131 */
132
133/*
134 * Ethernet header
135 */
136typedef struct {
137 uchar et_dest[6]; /* Destination node */
138 uchar et_src[6]; /* Source node */
139 ushort et_protlen; /* Protocol or length */
140 uchar et_dsap; /* 802 DSAP */
141 uchar et_ssap; /* 802 SSAP */
142 uchar et_ctl; /* 802 control */
143 uchar et_snap1; /* SNAP */
144 uchar et_snap2;
145 uchar et_snap3;
146 ushort et_prot; /* 802 protocol */
147} Ethernet_t;
148
149#define ETHER_HDR_SIZE 14 /* Ethernet header size */
150#define E802_HDR_SIZE 22 /* 802 ethernet header size */
wdenka3d991b2004-04-15 21:48:45 +0000151
152/*
153 * Ethernet header
154 */
155typedef struct {
156 uchar vet_dest[6]; /* Destination node */
157 uchar vet_src[6]; /* Source node */
158 ushort vet_vlan_type; /* PROT_VLAN */
159 ushort vet_tag; /* TAG of VLAN */
160 ushort vet_type; /* protocol type */
161} VLAN_Ethernet_t;
162
163#define VLAN_ETHER_HDR_SIZE 18 /* VLAN Ethernet header size */
164
wdenk2d966952002-10-31 22:12:35 +0000165#define PROT_IP 0x0800 /* IP protocol */
166#define PROT_ARP 0x0806 /* IP ARP protocol */
167#define PROT_RARP 0x8035 /* IP ARP protocol */
wdenka3d991b2004-04-15 21:48:45 +0000168#define PROT_VLAN 0x8100 /* IEEE 802.1q protocol */
wdenk2d966952002-10-31 22:12:35 +0000169
170#define IPPROTO_ICMP 1 /* Internet Control Message Protocol */
171#define IPPROTO_UDP 17 /* User Datagram Protocol */
172
173/*
174 * Internet Protocol (IP) header.
175 */
176typedef struct {
177 uchar ip_hl_v; /* header length and version */
178 uchar ip_tos; /* type of service */
179 ushort ip_len; /* total length */
180 ushort ip_id; /* identification */
181 ushort ip_off; /* fragment offset field */
182 uchar ip_ttl; /* time to live */
183 uchar ip_p; /* protocol */
184 ushort ip_sum; /* checksum */
185 IPaddr_t ip_src; /* Source IP address */
186 IPaddr_t ip_dst; /* Destination IP address */
187 ushort udp_src; /* UDP source port */
188 ushort udp_dst; /* UDP destination port */
189 ushort udp_len; /* Length of UDP packet */
190 ushort udp_xsum; /* Checksum */
191} IP_t;
192
193#define IP_HDR_SIZE_NO_UDP (sizeof (IP_t) - 8)
194#define IP_HDR_SIZE (sizeof (IP_t))
195
196
197/*
198 * Address Resolution Protocol (ARP) header.
199 */
200typedef struct
201{
202 ushort ar_hrd; /* Format of hardware address */
203# define ARP_ETHER 1 /* Ethernet hardware address */
204 ushort ar_pro; /* Format of protocol address */
205 uchar ar_hln; /* Length of hardware address */
206 uchar ar_pln; /* Length of protocol address */
207 ushort ar_op; /* Operation */
208# define ARPOP_REQUEST 1 /* Request to resolve address */
209# define ARPOP_REPLY 2 /* Response to previous request */
210
211# define RARPOP_REQUEST 3 /* Request to resolve address */
212# define RARPOP_REPLY 4 /* Response to previous request */
213
214 /*
wdenk8bde7f72003-06-27 21:31:46 +0000215 * The remaining fields are variable in size, according to
216 * the sizes above, and are defined as appropriate for
217 * specific hardware/protocol combinations.
wdenk2d966952002-10-31 22:12:35 +0000218 */
219 uchar ar_data[0];
220#if 0
221 uchar ar_sha[]; /* Sender hardware address */
222 uchar ar_spa[]; /* Sender protocol address */
223 uchar ar_tha[]; /* Target hardware address */
224 uchar ar_tpa[]; /* Target protocol address */
225#endif /* 0 */
226} ARP_t;
227
228#define ARP_HDR_SIZE (8+20) /* Size assuming ethernet */
229
230/*
231 * ICMP stuff (just enough to handle (host) redirect messages)
232 */
wdenk73a8b272003-06-05 19:27:42 +0000233#define ICMP_ECHO_REPLY 0 /* Echo reply */
wdenk2d966952002-10-31 22:12:35 +0000234#define ICMP_REDIRECT 5 /* Redirect (change route) */
wdenk73a8b272003-06-05 19:27:42 +0000235#define ICMP_ECHO_REQUEST 8 /* Echo request */
wdenk2d966952002-10-31 22:12:35 +0000236
237/* Codes for REDIRECT. */
238#define ICMP_REDIR_NET 0 /* Redirect Net */
239#define ICMP_REDIR_HOST 1 /* Redirect Host */
240
241typedef struct icmphdr {
242 uchar type;
243 uchar code;
244 ushort checksum;
245 union {
246 struct {
247 ushort id;
248 ushort sequence;
249 } echo;
250 ulong gateway;
251 struct {
252 ushort __unused;
253 ushort mtu;
254 } frag;
255 } un;
256} ICMP_t;
257
258
wdenk2d966952002-10-31 22:12:35 +0000259/*
260 * Maximum packet size; used to allocate packet storage.
261 * TFTP packets can be 524 bytes + IP header + ethernet header.
262 * Lets be conservative, and go for 38 * 16. (Must also be
263 * a multiple of 32 bytes).
264 */
265/*
266 * AS.HARNOIS : Better to set PKTSIZE to maximum size because
267 * traffic type is not always controlled
268 * maximum packet size = 1518
269 * maximum packet size and multiple of 32 bytes = 1536
270 */
271#define PKTSIZE 1518
272#define PKTSIZE_ALIGN 1536
273/*#define PKTSIZE 608*/
274
275/*
276 * Maximum receive ring size; that is, the number of packets
277 * we can buffer before overflow happens. Basically, this just
278 * needs to be enough to prevent a packet being discarded while
279 * we are processing the previous one.
280 */
281#define RINGSZ 4
282#define RINGSZ_LOG2 2
283
284/**********************************************************************/
285/*
286 * Globals.
287 *
288 * Note:
289 *
290 * All variables of type IPaddr_t are stored in NETWORK byte order
291 * (big endian).
292 */
293
294/* net.c */
295/** BOOTP EXTENTIONS **/
296extern IPaddr_t NetOurGatewayIP; /* Our gateway IP addresse */
297extern IPaddr_t NetOurSubnetMask; /* Our subnet mask (0 = unknown)*/
298extern IPaddr_t NetOurDNSIP; /* Our Domain Name Server (0 = unknown)*/
Jon Loeliger1fe80d72007-07-09 22:08:34 -0500299#if defined(CONFIG_BOOTP_DNS2)
stroesefe389a82003-08-28 14:17:32 +0000300extern IPaddr_t NetOurDNS2IP; /* Our 2nd Domain Name Server (0 = unknown)*/
301#endif
wdenk2d966952002-10-31 22:12:35 +0000302extern char NetOurNISDomain[32]; /* Our NIS domain */
303extern char NetOurHostName[32]; /* Our hostname */
304extern char NetOurRootPath[64]; /* Our root path */
305extern ushort NetBootFileSize; /* Our boot file size in blocks */
306/** END OF BOOTP EXTENTIONS **/
307extern ulong NetBootFileXferSize; /* size of bootfile in bytes */
308extern uchar NetOurEther[6]; /* Our ethernet address */
309extern uchar NetServerEther[6]; /* Boot server enet address */
310extern IPaddr_t NetOurIP; /* Our IP addr (0 = unknown) */
311extern IPaddr_t NetServerIP; /* Server IP addr (0 = unknown) */
312extern volatile uchar * NetTxPacket; /* THE transmit packet */
313extern volatile uchar * NetRxPackets[PKTBUFSRX];/* Receive packets */
314extern volatile uchar * NetRxPkt; /* Current receive packet */
315extern int NetRxPktLen; /* Current rx packet length */
316extern unsigned NetIPID; /* IP ID (counting) */
317extern uchar NetBcastAddr[6]; /* Ethernet boardcast address */
wdenk68ceb292004-08-02 21:11:11 +0000318extern uchar NetEtherNullAddr[6];
wdenk2d966952002-10-31 22:12:35 +0000319
wdenka3d991b2004-04-15 21:48:45 +0000320#define VLAN_NONE 4095 /* untagged */
321#define VLAN_IDMASK 0x0fff /* mask of valid vlan id */
322extern ushort NetOurVLAN; /* Our VLAN */
323extern ushort NetOurNativeVLAN; /* Our Native VLAN */
324
325extern uchar NetCDPAddr[6]; /* Ethernet CDP address */
326extern ushort CDPNativeVLAN; /* CDP returned native VLAN */
327extern ushort CDPApplianceVLAN; /* CDP returned appliance VLAN */
328
wdenk2d966952002-10-31 22:12:35 +0000329extern int NetState; /* Network loop state */
330#define NETLOOP_CONTINUE 1
331#define NETLOOP_RESTART 2
332#define NETLOOP_SUCCESS 3
333#define NETLOOP_FAIL 4
334
335#ifdef CONFIG_NET_MULTI
336extern int NetRestartWrap; /* Tried all network devices */
337#endif
338
wdenkea287de2005-04-01 00:25:43 +0000339typedef enum { BOOTP, RARP, ARP, TFTP, DHCP, PING, DNS, NFS, CDP, NETCONS, SNTP } proto_t;
wdenk2d966952002-10-31 22:12:35 +0000340
341/* from net/net.c */
342extern char BootFile[128]; /* Boot File name */
343
Jon Loeliger639221c2007-07-09 17:15:49 -0500344#if defined(CONFIG_CMD_PING)
wdenk73a8b272003-06-05 19:27:42 +0000345extern IPaddr_t NetPingIP; /* the ip address to ping */
346#endif
347
Jon Loeliger639221c2007-07-09 17:15:49 -0500348#if defined(CONFIG_CMD_CDP)
wdenka3d991b2004-04-15 21:48:45 +0000349/* when CDP completes these hold the return values */
350extern ushort CDPNativeVLAN;
351extern ushort CDPApplianceVLAN;
352#endif
353
Jon Loeliger639221c2007-07-09 17:15:49 -0500354#if defined(CONFIG_CMD_SNTP)
wdenkea287de2005-04-01 00:25:43 +0000355extern IPaddr_t NetNtpServerIP; /* the ip address to NTP */
356extern int NetTimeOffset; /* offset time from UTC */
357#endif
358
wdenk2d966952002-10-31 22:12:35 +0000359/* Initialize the network adapter */
360extern int NetLoop(proto_t);
361
362/* Shutdown adapters and cleanup */
363extern void NetStop(void);
364
365/* Load failed. Start again. */
366extern void NetStartAgain(void);
367
wdenka3d991b2004-04-15 21:48:45 +0000368/* Get size of the ethernet header when we send */
369extern int NetEthHdrSize(void);
370
371/* Set ethernet header; returns the size of the header */
372extern int NetSetEther(volatile uchar *, uchar *, uint);
wdenk2d966952002-10-31 22:12:35 +0000373
374/* Set IP header */
375extern void NetSetIP(volatile uchar *, IPaddr_t, int, int, int);
376
377/* Checksum */
378extern int NetCksumOk(uchar *, int); /* Return true if cksum OK */
379extern uint NetCksum(uchar *, int); /* Calculate the checksum */
380
381/* Set callbacks */
382extern void NetSetHandler(rxhand_f *); /* Set RX packet handler */
wdenk3e01d752004-10-09 21:56:21 +0000383extern void NetSetTimeout(ulong, thand_f *);/* Set timeout handler */
wdenk2d966952002-10-31 22:12:35 +0000384
385/* Transmit "NetTxPacket" */
386extern void NetSendPacket(volatile uchar *, int);
387
wdenk73a8b272003-06-05 19:27:42 +0000388/* Transmit UDP packet, performing ARP request if needed */
389extern int NetSendUDPPacket(uchar *ether, IPaddr_t dest, int dport, int sport, int len);
390
wdenk2d966952002-10-31 22:12:35 +0000391/* Processes a received packet */
392extern void NetReceive(volatile uchar *, int);
393
394/* Print an IP address on the console */
395extern void print_IPaddr (IPaddr_t);
396
397/*
398 * The following functions are a bit ugly, but necessary to deal with
399 * alignment restrictions on ARM.
400 *
401 * We're using inline functions, which had the smallest memory
402 * footprint in our tests.
403 */
404/* return IP *in network byteorder* */
405static inline IPaddr_t NetReadIP(void *from)
406{
407 IPaddr_t ip;
408 memcpy((void*)&ip, from, sizeof(ip));
409 return ip;
410}
411
412/* return ulong *in network byteorder* */
413static inline ulong NetReadLong(ulong *from)
414{
415 ulong l;
416 memcpy((void*)&l, (void*)from, sizeof(l));
417 return l;
418}
419
420/* write IP *in network byteorder* */
421static inline void NetWriteIP(void *to, IPaddr_t ip)
422{
423 memcpy(to, (void*)&ip, sizeof(ip));
424}
425
426/* copy IP */
427static inline void NetCopyIP(void *to, void *from)
428{
429 memcpy(to, from, sizeof(IPaddr_t));
430}
431
432/* copy ulong */
433static inline void NetCopyLong(ulong *to, ulong *from)
434{
435 memcpy((void*)to, (void*)from, sizeof(ulong));
436}
437
438/* Convert an IP address to a string */
439extern void ip_to_string (IPaddr_t x, char *s);
440
wdenk73a8b272003-06-05 19:27:42 +0000441/* Convert a string to ip address */
442extern IPaddr_t string_to_ip(char *s);
443
wdenka3d991b2004-04-15 21:48:45 +0000444/* Convert a VLAN id to a string */
445extern void VLAN_to_string (ushort x, char *s);
446
447/* Convert a string to a vlan id */
448extern ushort string_to_VLAN(char *s);
449
wdenk2d966952002-10-31 22:12:35 +0000450/* read an IP address from a environment variable */
451extern IPaddr_t getenv_IPaddr (char *);
452
wdenka3d991b2004-04-15 21:48:45 +0000453/* read a VLAN id from an environment variable */
454extern ushort getenv_VLAN(char *);
455
wdenk2d966952002-10-31 22:12:35 +0000456/* copy a filename (allow for "..." notation, limit length) */
Wolfgang Denk77ddac92005-10-13 16:45:02 +0200457extern void copy_filename (char *dst, char *src, int size);
wdenk2d966952002-10-31 22:12:35 +0000458
459/**********************************************************************/
460
461#endif /* __NET_H__ */