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