]> git.ipfire.org Git - people/ms/u-boot.git/blame - include/net.h
* Fix CONFIG_NET_MULTI support in include/net.h
[people/ms/u-boot.git] / include / net.h
CommitLineData
2d966958
WD
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
71f95118 15#if defined(CONFIG_8xx)
2d966958 16#include <commproc.h>
71f95118
WD
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 */
aacf9a49
WD
23
24#if !defined(CONFIG_NET_MULTI) && defined(CONFIG_8260)
25#include <config.h>
26#if defined(CONFIG_ETHER_ON_FCC)
27#if defined(CONFIG_ETHER_ON_SCC)
28#error "Ethernet not correctly defined"
29#endif /* CONFIG_ETHER_ON_SCC */
30#define CONFIG_NET_MULTI
31#if (CONFIG_ETHER_INDEX == 1)
32#define CONFIG_ETHER_ON_FCC1
33# define CFG_CMXFCR_MASK1 CFG_CMXFCR_MASK
34# define CFG_CMXFCR_VALUE1 CFG_CMXFCR_VALUE
35#elif (CONFIG_ETHER_INDEX == 2)
36#define CONFIG_ETHER_ON_FCC2
37# define CFG_CMXFCR_MASK2 CFG_CMXFCR_MASK
38# define CFG_CMXFCR_VALUE2 CFG_CMXFCR_VALUE
39#elif (CONFIG_ETHER_INDEX == 3)
40#define CONFIG_ETHER_ON_FCC3
41# define CFG_CMXFCR_MASK3 CFG_CMXFCR_MASK
42# define CFG_CMXFCR_VALUE3 CFG_CMXFCR_VALUE
43#endif /* CONFIG_ETHER_INDEX */
44#endif /* CONFIG_ETHER_ON_FCC */
45#endif /* !CONFIG_NET_MULTI && CONFIG_8260 */
46
2d966958
WD
47#include <asm/byteorder.h> /* for nton* / ntoh* stuff */
48
49
50/*
51 * The number of receive packet buffers, and the required packet buffer
52 * alignment in memory.
53 *
54 */
55
c6028835
SR
56#ifdef CFG_RX_ETH_BUFFER
57# define PKTBUFSRX CFG_RX_ETH_BUFFER
1d0350ed 58#else
c6028835 59# define PKTBUFSRX 4
1d0350ed
WD
60#endif
61
2d966958
WD
62#define PKTALIGN 32
63
64typedef ulong IPaddr_t;
65
66
67
68/*
69 * The current receive packet handler. Called with a pointer to the
70 * application packet, and a protocol type (PORT_BOOTPC or PORT_TFTP).
71 * All other packets are dealt with without calling the handler.
72 */
73typedef void rxhand_f(uchar *, unsigned, unsigned, unsigned);
74
75/*
76 * A timeout handler. Called after time interval has expired.
77 */
78typedef void thand_f(void);
79
2d966958
WD
80#define NAMESIZE 16
81
82enum eth_state_t {
83 ETH_STATE_INIT,
84 ETH_STATE_PASSIVE,
85 ETH_STATE_ACTIVE
86};
87
88struct eth_device {
89 char name[NAMESIZE];
90 unsigned char enetaddr[6];
91 int iobase;
92 int state;
93
94 int (*init) (struct eth_device*, bd_t*);
95 int (*send) (struct eth_device*, volatile void* pachet, int length);
96 int (*recv) (struct eth_device*);
97 void (*halt) (struct eth_device*);
98
99 struct eth_device *next;
100 void *priv;
101};
102
103extern int eth_initialize(bd_t *bis); /* Initialize network subsystem */
104extern int eth_register(struct eth_device* dev);/* Register network device */
105extern void eth_try_another(int first_restart); /* Change the device */
106extern struct eth_device *eth_get_dev(void); /* get the current device MAC */
107extern void eth_set_enetaddr(int num, char* a); /* Set new MAC address */
2d966958
WD
108
109extern int eth_init(bd_t *bis); /* Initialize the device */
110extern int eth_send(volatile void *packet, int length); /* Send a packet */
111extern int eth_rx(void); /* Check for received packets */
112extern void eth_halt(void); /* stop SCC */
113
114
115/**********************************************************************/
116/*
117 * Protocol headers.
118 */
119
120/*
121 * Ethernet header
122 */
123typedef struct {
124 uchar et_dest[6]; /* Destination node */
125 uchar et_src[6]; /* Source node */
126 ushort et_protlen; /* Protocol or length */
127 uchar et_dsap; /* 802 DSAP */
128 uchar et_ssap; /* 802 SSAP */
129 uchar et_ctl; /* 802 control */
130 uchar et_snap1; /* SNAP */
131 uchar et_snap2;
132 uchar et_snap3;
133 ushort et_prot; /* 802 protocol */
134} Ethernet_t;
135
136#define ETHER_HDR_SIZE 14 /* Ethernet header size */
137#define E802_HDR_SIZE 22 /* 802 ethernet header size */
138#define PROT_IP 0x0800 /* IP protocol */
139#define PROT_ARP 0x0806 /* IP ARP protocol */
140#define PROT_RARP 0x8035 /* IP ARP protocol */
141
142#define IPPROTO_ICMP 1 /* Internet Control Message Protocol */
143#define IPPROTO_UDP 17 /* User Datagram Protocol */
144
145/*
146 * Internet Protocol (IP) header.
147 */
148typedef struct {
149 uchar ip_hl_v; /* header length and version */
150 uchar ip_tos; /* type of service */
151 ushort ip_len; /* total length */
152 ushort ip_id; /* identification */
153 ushort ip_off; /* fragment offset field */
154 uchar ip_ttl; /* time to live */
155 uchar ip_p; /* protocol */
156 ushort ip_sum; /* checksum */
157 IPaddr_t ip_src; /* Source IP address */
158 IPaddr_t ip_dst; /* Destination IP address */
159 ushort udp_src; /* UDP source port */
160 ushort udp_dst; /* UDP destination port */
161 ushort udp_len; /* Length of UDP packet */
162 ushort udp_xsum; /* Checksum */
163} IP_t;
164
165#define IP_HDR_SIZE_NO_UDP (sizeof (IP_t) - 8)
166#define IP_HDR_SIZE (sizeof (IP_t))
167
168
169/*
170 * Address Resolution Protocol (ARP) header.
171 */
172typedef struct
173{
174 ushort ar_hrd; /* Format of hardware address */
175# define ARP_ETHER 1 /* Ethernet hardware address */
176 ushort ar_pro; /* Format of protocol address */
177 uchar ar_hln; /* Length of hardware address */
178 uchar ar_pln; /* Length of protocol address */
179 ushort ar_op; /* Operation */
180# define ARPOP_REQUEST 1 /* Request to resolve address */
181# define ARPOP_REPLY 2 /* Response to previous request */
182
183# define RARPOP_REQUEST 3 /* Request to resolve address */
184# define RARPOP_REPLY 4 /* Response to previous request */
185
186 /*
187 * The remaining fields are variable in size, according to
188 * the sizes above, and are defined as appropriate for
189 * specific hardware/protocol combinations.
190 */
191 uchar ar_data[0];
192#if 0
193 uchar ar_sha[]; /* Sender hardware address */
194 uchar ar_spa[]; /* Sender protocol address */
195 uchar ar_tha[]; /* Target hardware address */
196 uchar ar_tpa[]; /* Target protocol address */
197#endif /* 0 */
198} ARP_t;
199
200#define ARP_HDR_SIZE (8+20) /* Size assuming ethernet */
201
202/*
203 * ICMP stuff (just enough to handle (host) redirect messages)
204 */
73a8b27c 205#define ICMP_ECHO_REPLY 0 /* Echo reply */
2d966958 206#define ICMP_REDIRECT 5 /* Redirect (change route) */
73a8b27c 207#define ICMP_ECHO_REQUEST 8 /* Echo request */
2d966958
WD
208
209/* Codes for REDIRECT. */
210#define ICMP_REDIR_NET 0 /* Redirect Net */
211#define ICMP_REDIR_HOST 1 /* Redirect Host */
212
213typedef struct icmphdr {
214 uchar type;
215 uchar code;
216 ushort checksum;
217 union {
218 struct {
219 ushort id;
220 ushort sequence;
221 } echo;
222 ulong gateway;
223 struct {
224 ushort __unused;
225 ushort mtu;
226 } frag;
227 } un;
228} ICMP_t;
229
230
231
232/*
233 * Maximum packet size; used to allocate packet storage.
234 * TFTP packets can be 524 bytes + IP header + ethernet header.
235 * Lets be conservative, and go for 38 * 16. (Must also be
236 * a multiple of 32 bytes).
237 */
238/*
239 * AS.HARNOIS : Better to set PKTSIZE to maximum size because
240 * traffic type is not always controlled
241 * maximum packet size = 1518
242 * maximum packet size and multiple of 32 bytes = 1536
243 */
244#define PKTSIZE 1518
245#define PKTSIZE_ALIGN 1536
246/*#define PKTSIZE 608*/
247
248/*
249 * Maximum receive ring size; that is, the number of packets
250 * we can buffer before overflow happens. Basically, this just
251 * needs to be enough to prevent a packet being discarded while
252 * we are processing the previous one.
253 */
254#define RINGSZ 4
255#define RINGSZ_LOG2 2
256
257/**********************************************************************/
258/*
259 * Globals.
260 *
261 * Note:
262 *
263 * All variables of type IPaddr_t are stored in NETWORK byte order
264 * (big endian).
265 */
266
267/* net.c */
268/** BOOTP EXTENTIONS **/
269extern IPaddr_t NetOurGatewayIP; /* Our gateway IP addresse */
270extern IPaddr_t NetOurSubnetMask; /* Our subnet mask (0 = unknown)*/
271extern IPaddr_t NetOurDNSIP; /* Our Domain Name Server (0 = unknown)*/
272extern char NetOurNISDomain[32]; /* Our NIS domain */
273extern char NetOurHostName[32]; /* Our hostname */
274extern char NetOurRootPath[64]; /* Our root path */
275extern ushort NetBootFileSize; /* Our boot file size in blocks */
276/** END OF BOOTP EXTENTIONS **/
277extern ulong NetBootFileXferSize; /* size of bootfile in bytes */
278extern uchar NetOurEther[6]; /* Our ethernet address */
279extern uchar NetServerEther[6]; /* Boot server enet address */
280extern IPaddr_t NetOurIP; /* Our IP addr (0 = unknown) */
281extern IPaddr_t NetServerIP; /* Server IP addr (0 = unknown) */
282extern volatile uchar * NetTxPacket; /* THE transmit packet */
283extern volatile uchar * NetRxPackets[PKTBUFSRX];/* Receive packets */
284extern volatile uchar * NetRxPkt; /* Current receive packet */
285extern int NetRxPktLen; /* Current rx packet length */
286extern unsigned NetIPID; /* IP ID (counting) */
287extern uchar NetBcastAddr[6]; /* Ethernet boardcast address */
288
289extern int NetState; /* Network loop state */
290#define NETLOOP_CONTINUE 1
291#define NETLOOP_RESTART 2
292#define NETLOOP_SUCCESS 3
293#define NETLOOP_FAIL 4
294
295#ifdef CONFIG_NET_MULTI
296extern int NetRestartWrap; /* Tried all network devices */
297#endif
298
73a8b27c 299typedef enum { BOOTP, RARP, ARP, TFTP, DHCP, PING, DNS } proto_t;
2d966958
WD
300
301/* from net/net.c */
302extern char BootFile[128]; /* Boot File name */
303
73a8b27c
WD
304#if (CONFIG_COMMANDS & CFG_CMD_PING)
305extern IPaddr_t NetPingIP; /* the ip address to ping */
306#endif
307
2d966958
WD
308/* Initialize the network adapter */
309extern int NetLoop(proto_t);
310
311/* Shutdown adapters and cleanup */
312extern void NetStop(void);
313
314/* Load failed. Start again. */
315extern void NetStartAgain(void);
316
317/* Set ethernet header */
318extern void NetSetEther(volatile uchar *, uchar *, uint);
319
320/* Set IP header */
321extern void NetSetIP(volatile uchar *, IPaddr_t, int, int, int);
322
323/* Checksum */
324extern int NetCksumOk(uchar *, int); /* Return true if cksum OK */
325extern uint NetCksum(uchar *, int); /* Calculate the checksum */
326
327/* Set callbacks */
328extern void NetSetHandler(rxhand_f *); /* Set RX packet handler */
329extern void NetSetTimeout(int, thand_f *); /* Set timeout handler */
330
331/* Transmit "NetTxPacket" */
332extern void NetSendPacket(volatile uchar *, int);
333
73a8b27c
WD
334/* Transmit UDP packet, performing ARP request if needed */
335extern int NetSendUDPPacket(uchar *ether, IPaddr_t dest, int dport, int sport, int len);
336
2d966958
WD
337/* Processes a received packet */
338extern void NetReceive(volatile uchar *, int);
339
340/* Print an IP address on the console */
341extern void print_IPaddr (IPaddr_t);
342
343/*
344 * The following functions are a bit ugly, but necessary to deal with
345 * alignment restrictions on ARM.
346 *
347 * We're using inline functions, which had the smallest memory
348 * footprint in our tests.
349 */
350/* return IP *in network byteorder* */
351static inline IPaddr_t NetReadIP(void *from)
352{
353 IPaddr_t ip;
354 memcpy((void*)&ip, from, sizeof(ip));
355 return ip;
356}
357
358/* return ulong *in network byteorder* */
359static inline ulong NetReadLong(ulong *from)
360{
361 ulong l;
362 memcpy((void*)&l, (void*)from, sizeof(l));
363 return l;
364}
365
366/* write IP *in network byteorder* */
367static inline void NetWriteIP(void *to, IPaddr_t ip)
368{
369 memcpy(to, (void*)&ip, sizeof(ip));
370}
371
372/* copy IP */
373static inline void NetCopyIP(void *to, void *from)
374{
375 memcpy(to, from, sizeof(IPaddr_t));
376}
377
378/* copy ulong */
379static inline void NetCopyLong(ulong *to, ulong *from)
380{
381 memcpy((void*)to, (void*)from, sizeof(ulong));
382}
383
384/* Convert an IP address to a string */
385extern void ip_to_string (IPaddr_t x, char *s);
386
73a8b27c
WD
387/* Convert a string to ip address */
388extern IPaddr_t string_to_ip(char *s);
389
2d966958
WD
390/* read an IP address from a environment variable */
391extern IPaddr_t getenv_IPaddr (char *);
392
393/* copy a filename (allow for "..." notation, limit length) */
394extern void copy_filename (uchar *dst, uchar *src, int size);
395
396/**********************************************************************/
397
398#endif /* __NET_H__ */