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_8xx)
16 #include <commproc.h>
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 */
23
24 #if defined(CONFIG_MPC5xxx)
25 # if !defined(CONFIG_NET_MULTI)
26 # if defined(CONFIG_MPC5xxx_FEC)
27 # define CONFIG_NET_MULTI
28 # endif
29 # endif
30 #endif /* CONFIG_MPC5xxx */
31
32 #if !defined(CONFIG_NET_MULTI) && defined(CONFIG_CPM2)
33 #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 CONFIG_SYS_CMXFCR_MASK1 CONFIG_SYS_CMXFCR_MASK
42 # define CONFIG_SYS_CMXFCR_VALUE1 CONFIG_SYS_CMXFCR_VALUE
43 #elif (CONFIG_ETHER_INDEX == 2)
44 #define CONFIG_ETHER_ON_FCC2
45 # define CONFIG_SYS_CMXFCR_MASK2 CONFIG_SYS_CMXFCR_MASK
46 # define CONFIG_SYS_CMXFCR_VALUE2 CONFIG_SYS_CMXFCR_VALUE
47 #elif (CONFIG_ETHER_INDEX == 3)
48 #define CONFIG_ETHER_ON_FCC3
49 # define CONFIG_SYS_CMXFCR_MASK3 CONFIG_SYS_CMXFCR_MASK
50 # define CONFIG_SYS_CMXFCR_VALUE3 CONFIG_SYS_CMXFCR_VALUE
51 #endif /* CONFIG_ETHER_INDEX */
52 #endif /* CONFIG_ETHER_ON_FCC */
53 #endif /* !CONFIG_NET_MULTI && CONFIG_8260 */
54
55 #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
64 #ifdef CONFIG_SYS_RX_ETH_BUFFER
65 # define PKTBUFSRX CONFIG_SYS_RX_ETH_BUFFER
66 #else
67 # define PKTBUFSRX 4
68 #endif
69
70 #define PKTALIGN 32
71
72 typedef ulong IPaddr_t;
73
74
75 /*
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 */
80 typedef void rxhand_f(uchar *, unsigned, unsigned, unsigned);
81
82 /*
83 * A timeout handler. Called after time interval has expired.
84 */
85 typedef void thand_f(void);
86
87 #define NAMESIZE 16
88
89 enum eth_state_t {
90 ETH_STATE_INIT,
91 ETH_STATE_PASSIVE,
92 ETH_STATE_ACTIVE
93 };
94
95 struct 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* packet, int length);
103 int (*recv) (struct eth_device*);
104 void (*halt) (struct eth_device*);
105 #ifdef CONFIG_MCAST_TFTP
106 int (*mcast) (struct eth_device*, u32 ip, u8 set);
107 #endif
108 int (*write_hwaddr) (struct eth_device*);
109 struct eth_device *next;
110 void *priv;
111 };
112
113 extern int eth_initialize(bd_t *bis); /* Initialize network subsystem */
114 extern int eth_register(struct eth_device* dev);/* Register network device */
115 extern void eth_try_another(int first_restart); /* Change the device */
116 #ifdef CONFIG_NET_MULTI
117 extern void eth_set_current(void); /* set nterface to ethcur var */
118 #endif
119 extern struct eth_device *eth_get_dev(void); /* get the current device MAC */
120 extern struct eth_device *eth_get_dev_by_name(char *devname); /* get device */
121 extern struct eth_device *eth_get_dev_by_index(int index); /* get dev @ index */
122 extern int eth_get_dev_index (void); /* get the device index */
123 extern void eth_parse_enetaddr(const char *addr, uchar *enetaddr);
124 extern int eth_getenv_enetaddr(char *name, uchar *enetaddr);
125 extern int eth_setenv_enetaddr(char *name, const uchar *enetaddr);
126 extern int eth_getenv_enetaddr_by_index(int index, uchar *enetaddr);
127
128 extern int eth_init(bd_t *bis); /* Initialize the device */
129 extern int eth_send(volatile void *packet, int length); /* Send a packet */
130 #ifdef CONFIG_API
131 extern int eth_receive(volatile void *packet, int length); /* Receive a packet*/
132 #endif
133 extern int eth_rx(void); /* Check for received packets */
134 extern void eth_halt(void); /* stop SCC */
135 extern char *eth_get_name(void); /* get name of current device */
136
137 #ifdef CONFIG_MCAST_TFTP
138 int eth_mcast_join( IPaddr_t mcast_addr, u8 join);
139 u32 ether_crc (size_t len, unsigned char const *p);
140 #endif
141
142
143 /**********************************************************************/
144 /*
145 * Protocol headers.
146 */
147
148 /*
149 * Ethernet header
150 */
151 typedef struct {
152 uchar et_dest[6]; /* Destination node */
153 uchar et_src[6]; /* Source node */
154 ushort et_protlen; /* Protocol or length */
155 uchar et_dsap; /* 802 DSAP */
156 uchar et_ssap; /* 802 SSAP */
157 uchar et_ctl; /* 802 control */
158 uchar et_snap1; /* SNAP */
159 uchar et_snap2;
160 uchar et_snap3;
161 ushort et_prot; /* 802 protocol */
162 } Ethernet_t;
163
164 #define ETHER_HDR_SIZE 14 /* Ethernet header size */
165 #define E802_HDR_SIZE 22 /* 802 ethernet header size */
166
167 /*
168 * Ethernet header
169 */
170 typedef struct {
171 uchar vet_dest[6]; /* Destination node */
172 uchar vet_src[6]; /* Source node */
173 ushort vet_vlan_type; /* PROT_VLAN */
174 ushort vet_tag; /* TAG of VLAN */
175 ushort vet_type; /* protocol type */
176 } VLAN_Ethernet_t;
177
178 #define VLAN_ETHER_HDR_SIZE 18 /* VLAN Ethernet header size */
179
180 #define PROT_IP 0x0800 /* IP protocol */
181 #define PROT_ARP 0x0806 /* IP ARP protocol */
182 #define PROT_RARP 0x8035 /* IP ARP protocol */
183 #define PROT_VLAN 0x8100 /* IEEE 802.1q protocol */
184
185 #define IPPROTO_ICMP 1 /* Internet Control Message Protocol */
186 #define IPPROTO_UDP 17 /* User Datagram Protocol */
187
188 /*
189 * Internet Protocol (IP) header.
190 */
191 typedef struct {
192 uchar ip_hl_v; /* header length and version */
193 uchar ip_tos; /* type of service */
194 ushort ip_len; /* total length */
195 ushort ip_id; /* identification */
196 ushort ip_off; /* fragment offset field */
197 uchar ip_ttl; /* time to live */
198 uchar ip_p; /* protocol */
199 ushort ip_sum; /* checksum */
200 IPaddr_t ip_src; /* Source IP address */
201 IPaddr_t ip_dst; /* Destination IP address */
202 ushort udp_src; /* UDP source port */
203 ushort udp_dst; /* UDP destination port */
204 ushort udp_len; /* Length of UDP packet */
205 ushort udp_xsum; /* Checksum */
206 } IP_t;
207
208 #define IP_OFFS 0x1fff /* ip offset *= 8 */
209 #define IP_FLAGS 0xe000 /* first 3 bits */
210 #define IP_FLAGS_RES 0x8000 /* reserved */
211 #define IP_FLAGS_DFRAG 0x4000 /* don't fragments */
212 #define IP_FLAGS_MFRAG 0x2000 /* more fragments */
213
214 #define IP_HDR_SIZE_NO_UDP (sizeof (IP_t) - 8)
215 #define IP_HDR_SIZE (sizeof (IP_t))
216
217
218 /*
219 * Address Resolution Protocol (ARP) header.
220 */
221 typedef struct
222 {
223 ushort ar_hrd; /* Format of hardware address */
224 # define ARP_ETHER 1 /* Ethernet hardware address */
225 ushort ar_pro; /* Format of protocol address */
226 uchar ar_hln; /* Length of hardware address */
227 uchar ar_pln; /* Length of protocol address */
228 ushort ar_op; /* Operation */
229 # define ARPOP_REQUEST 1 /* Request to resolve address */
230 # define ARPOP_REPLY 2 /* Response to previous request */
231
232 # define RARPOP_REQUEST 3 /* Request to resolve address */
233 # define RARPOP_REPLY 4 /* Response to previous request */
234
235 /*
236 * The remaining fields are variable in size, according to
237 * the sizes above, and are defined as appropriate for
238 * specific hardware/protocol combinations.
239 */
240 uchar ar_data[0];
241 #if 0
242 uchar ar_sha[]; /* Sender hardware address */
243 uchar ar_spa[]; /* Sender protocol address */
244 uchar ar_tha[]; /* Target hardware address */
245 uchar ar_tpa[]; /* Target protocol address */
246 #endif /* 0 */
247 } ARP_t;
248
249 #define ARP_HDR_SIZE (8+20) /* Size assuming ethernet */
250
251 /*
252 * ICMP stuff (just enough to handle (host) redirect messages)
253 */
254 #define ICMP_ECHO_REPLY 0 /* Echo reply */
255 #define ICMP_REDIRECT 5 /* Redirect (change route) */
256 #define ICMP_ECHO_REQUEST 8 /* Echo request */
257
258 /* Codes for REDIRECT. */
259 #define ICMP_REDIR_NET 0 /* Redirect Net */
260 #define ICMP_REDIR_HOST 1 /* Redirect Host */
261
262 typedef struct icmphdr {
263 uchar type;
264 uchar code;
265 ushort checksum;
266 union {
267 struct {
268 ushort id;
269 ushort sequence;
270 } echo;
271 ulong gateway;
272 struct {
273 ushort __unused;
274 ushort mtu;
275 } frag;
276 } un;
277 } ICMP_t;
278
279
280 /*
281 * Maximum packet size; used to allocate packet storage.
282 * TFTP packets can be 524 bytes + IP header + ethernet header.
283 * Lets be conservative, and go for 38 * 16. (Must also be
284 * a multiple of 32 bytes).
285 */
286 /*
287 * AS.HARNOIS : Better to set PKTSIZE to maximum size because
288 * traffic type is not always controlled
289 * maximum packet size = 1518
290 * maximum packet size and multiple of 32 bytes = 1536
291 */
292 #define PKTSIZE 1518
293 #define PKTSIZE_ALIGN 1536
294 /*#define PKTSIZE 608*/
295
296 /*
297 * Maximum receive ring size; that is, the number of packets
298 * we can buffer before overflow happens. Basically, this just
299 * needs to be enough to prevent a packet being discarded while
300 * we are processing the previous one.
301 */
302 #define RINGSZ 4
303 #define RINGSZ_LOG2 2
304
305 /**********************************************************************/
306 /*
307 * Globals.
308 *
309 * Note:
310 *
311 * All variables of type IPaddr_t are stored in NETWORK byte order
312 * (big endian).
313 */
314
315 /* net.c */
316 /** BOOTP EXTENTIONS **/
317 extern IPaddr_t NetOurGatewayIP; /* Our gateway IP addresse */
318 extern IPaddr_t NetOurSubnetMask; /* Our subnet mask (0 = unknown)*/
319 extern IPaddr_t NetOurDNSIP; /* Our Domain Name Server (0 = unknown)*/
320 #if defined(CONFIG_BOOTP_DNS2)
321 extern IPaddr_t NetOurDNS2IP; /* Our 2nd Domain Name Server (0 = unknown)*/
322 #endif
323 extern char NetOurNISDomain[32]; /* Our NIS domain */
324 extern char NetOurHostName[32]; /* Our hostname */
325 extern char NetOurRootPath[64]; /* Our root path */
326 extern ushort NetBootFileSize; /* Our boot file size in blocks */
327 /** END OF BOOTP EXTENTIONS **/
328 extern ulong NetBootFileXferSize; /* size of bootfile in bytes */
329 extern uchar NetOurEther[6]; /* Our ethernet address */
330 extern uchar NetServerEther[6]; /* Boot server enet address */
331 extern IPaddr_t NetOurIP; /* Our IP addr (0 = unknown) */
332 extern IPaddr_t NetServerIP; /* Server IP addr (0 = unknown) */
333 extern volatile uchar * NetTxPacket; /* THE transmit packet */
334 extern volatile uchar * NetRxPackets[PKTBUFSRX];/* Receive packets */
335 extern volatile uchar * NetRxPacket; /* Current receive packet */
336 extern int NetRxPacketLen; /* Current rx packet length */
337 extern unsigned NetIPID; /* IP ID (counting) */
338 extern uchar NetBcastAddr[6]; /* Ethernet boardcast address */
339 extern uchar NetEtherNullAddr[6];
340
341 #define VLAN_NONE 4095 /* untagged */
342 #define VLAN_IDMASK 0x0fff /* mask of valid vlan id */
343 extern ushort NetOurVLAN; /* Our VLAN */
344 extern ushort NetOurNativeVLAN; /* Our Native VLAN */
345
346 extern uchar NetCDPAddr[6]; /* Ethernet CDP address */
347 extern ushort CDPNativeVLAN; /* CDP returned native VLAN */
348 extern ushort CDPApplianceVLAN; /* CDP returned appliance VLAN */
349
350 extern int NetState; /* Network loop state */
351 #define NETLOOP_CONTINUE 1
352 #define NETLOOP_RESTART 2
353 #define NETLOOP_SUCCESS 3
354 #define NETLOOP_FAIL 4
355
356 #ifdef CONFIG_NET_MULTI
357 extern int NetRestartWrap; /* Tried all network devices */
358 #endif
359
360 typedef enum { BOOTP, RARP, ARP, TFTP, DHCP, PING, DNS, NFS, CDP, NETCONS, SNTP } proto_t;
361
362 /* from net/net.c */
363 extern char BootFile[128]; /* Boot File name */
364
365 #if defined(CONFIG_CMD_DNS)
366 extern char *NetDNSResolve; /* The host to resolve */
367 extern char *NetDNSenvvar; /* the env var to put the ip into */
368 #endif
369
370 #if defined(CONFIG_CMD_PING)
371 extern IPaddr_t NetPingIP; /* the ip address to ping */
372 #endif
373
374 #if defined(CONFIG_CMD_CDP)
375 /* when CDP completes these hold the return values */
376 extern ushort CDPNativeVLAN;
377 extern ushort CDPApplianceVLAN;
378 #endif
379
380 #if defined(CONFIG_CMD_SNTP)
381 extern IPaddr_t NetNtpServerIP; /* the ip address to NTP */
382 extern int NetTimeOffset; /* offset time from UTC */
383 #endif
384
385 /* Initialize the network adapter */
386 extern int NetLoop(proto_t);
387
388 /* Shutdown adapters and cleanup */
389 extern void NetStop(void);
390
391 /* Load failed. Start again. */
392 extern void NetStartAgain(void);
393
394 /* Get size of the ethernet header when we send */
395 extern int NetEthHdrSize(void);
396
397 /* Set ethernet header; returns the size of the header */
398 extern int NetSetEther(volatile uchar *, uchar *, uint);
399
400 /* Set IP header */
401 extern void NetSetIP(volatile uchar *, IPaddr_t, int, int, int);
402
403 /* Checksum */
404 extern int NetCksumOk(uchar *, int); /* Return true if cksum OK */
405 extern uint NetCksum(uchar *, int); /* Calculate the checksum */
406
407 /* Set callbacks */
408 extern void NetSetHandler(rxhand_f *); /* Set RX packet handler */
409 extern void NetSetTimeout(ulong, thand_f *);/* Set timeout handler */
410
411 /* Transmit "NetTxPacket" */
412 extern void NetSendPacket(volatile uchar *, int);
413
414 /* Transmit UDP packet, performing ARP request if needed */
415 extern int NetSendUDPPacket(uchar *ether, IPaddr_t dest, int dport, int sport, int len);
416
417 /* Processes a received packet */
418 extern void NetReceive(volatile uchar *, int);
419
420 /*
421 * The following functions are a bit ugly, but necessary to deal with
422 * alignment restrictions on ARM.
423 *
424 * We're using inline functions, which had the smallest memory
425 * footprint in our tests.
426 */
427 /* return IP *in network byteorder* */
NetReadIP(volatile void * from)428 static inline IPaddr_t NetReadIP(volatile void *from)
429 {
430 IPaddr_t ip;
431 memcpy((void*)&ip, (void*)from, sizeof(ip));
432 return ip;
433 }
434
435 /* return ulong *in network byteorder* */
NetReadLong(ulong * from)436 static inline ulong NetReadLong(ulong *from)
437 {
438 ulong l;
439 memcpy((void*)&l, (void*)from, sizeof(l));
440 return l;
441 }
442
443 /* write IP *in network byteorder* */
NetWriteIP(void * to,IPaddr_t ip)444 static inline void NetWriteIP(void *to, IPaddr_t ip)
445 {
446 memcpy(to, (void*)&ip, sizeof(ip));
447 }
448
449 /* copy IP */
NetCopyIP(volatile void * to,void * from)450 static inline void NetCopyIP(volatile void *to, void *from)
451 {
452 memcpy((void*)to, from, sizeof(IPaddr_t));
453 }
454
455 /* copy ulong */
NetCopyLong(ulong * to,ulong * from)456 static inline void NetCopyLong(ulong *to, ulong *from)
457 {
458 memcpy((void*)to, (void*)from, sizeof(ulong));
459 }
460
461 /**
462 * is_zero_ether_addr - Determine if give Ethernet address is all zeros.
463 * @addr: Pointer to a six-byte array containing the Ethernet address
464 *
465 * Return true if the address is all zeroes.
466 */
is_zero_ether_addr(const u8 * addr)467 static inline int is_zero_ether_addr(const u8 *addr)
468 {
469 return !(addr[0] | addr[1] | addr[2] | addr[3] | addr[4] | addr[5]);
470 }
471
472 /**
473 * is_multicast_ether_addr - Determine if the Ethernet address is a multicast.
474 * @addr: Pointer to a six-byte array containing the Ethernet address
475 *
476 * Return true if the address is a multicast address.
477 * By definition the broadcast address is also a multicast address.
478 */
is_multicast_ether_addr(const u8 * addr)479 static inline int is_multicast_ether_addr(const u8 *addr)
480 {
481 return (0x01 & addr[0]);
482 }
483
484 /**
485 * is_valid_ether_addr - Determine if the given Ethernet address is valid
486 * @addr: Pointer to a six-byte array containing the Ethernet address
487 *
488 * Check that the Ethernet address (MAC) is not 00:00:00:00:00:00, is not
489 * a multicast address, and is not FF:FF:FF:FF:FF:FF.
490 *
491 * Return true if the address is valid.
492 */
is_valid_ether_addr(const u8 * addr)493 static inline int is_valid_ether_addr(const u8 * addr)
494 {
495 /* FF:FF:FF:FF:FF:FF is a multicast address so we don't need to
496 * explicitly check for it here. */
497 return !is_multicast_ether_addr(addr) && !is_zero_ether_addr(addr);
498 }
499
500 /* Convert an IP address to a string */
501 extern void ip_to_string (IPaddr_t x, char *s);
502
503 /* Convert a string to ip address */
504 extern IPaddr_t string_to_ip(char *s);
505
506 /* Convert a VLAN id to a string */
507 extern void VLAN_to_string (ushort x, char *s);
508
509 /* Convert a string to a vlan id */
510 extern ushort string_to_VLAN(char *s);
511
512 /* read a VLAN id from an environment variable */
513 extern ushort getenv_VLAN(char *);
514
515 /* copy a filename (allow for "..." notation, limit length) */
516 extern void copy_filename (char *dst, char *src, int size);
517
518 /* get a random source port */
519 extern unsigned int random_port(void);
520
521 /**********************************************************************/
522
523 #endif /* __NET_H__ */
524