blob: ab571eb3ee49d4a488a1ec5a69ac49bc61972964 [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
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +020041# define CONFIG_SYS_CMXFCR_MASK1 CONFIG_SYS_CMXFCR_MASK
42# define CONFIG_SYS_CMXFCR_VALUE1 CONFIG_SYS_CMXFCR_VALUE
wdenkaacf9a42003-01-17 16:27:01 +000043#elif (CONFIG_ETHER_INDEX == 2)
44#define CONFIG_ETHER_ON_FCC2
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +020045# define CONFIG_SYS_CMXFCR_MASK2 CONFIG_SYS_CMXFCR_MASK
46# define CONFIG_SYS_CMXFCR_VALUE2 CONFIG_SYS_CMXFCR_VALUE
wdenkaacf9a42003-01-17 16:27:01 +000047#elif (CONFIG_ETHER_INDEX == 3)
48#define CONFIG_ETHER_ON_FCC3
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +020049# define CONFIG_SYS_CMXFCR_MASK3 CONFIG_SYS_CMXFCR_MASK
50# define CONFIG_SYS_CMXFCR_VALUE3 CONFIG_SYS_CMXFCR_VALUE
wdenkaacf9a42003-01-17 16:27:01 +000051#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
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +020064#ifdef CONFIG_SYS_RX_ETH_BUFFER
65# define PKTBUFSRX CONFIG_SYS_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
Ben Warrenecee9322010-04-26 11:11:46 -0700108 int (*write_hwaddr) (struct eth_device*);
wdenk2d966952002-10-31 22:12:35 +0000109 struct eth_device *next;
110 void *priv;
111};
112
Andy Fleming5dc0cf62009-02-11 15:10:31 -0600113extern int eth_initialize(bd_t *bis); /* Initialize network subsystem */
114extern int eth_register(struct eth_device* dev);/* Register network device */
115extern void eth_try_another(int first_restart); /* Change the device */
wdenka3d991b2004-04-15 21:48:45 +0000116#ifdef CONFIG_NET_MULTI
Andy Fleming5dc0cf62009-02-11 15:10:31 -0600117extern void eth_set_current(void); /* set nterface to ethcur var */
wdenka3d991b2004-04-15 21:48:45 +0000118#endif
Andy Fleming5dc0cf62009-02-11 15:10:31 -0600119extern struct eth_device *eth_get_dev(void); /* get the current device MAC */
Ben Warrend7fb9bc2010-07-29 12:56:11 -0700120extern struct eth_device *eth_get_dev_by_name(const char *devname);
Andy Fleming5dc0cf62009-02-11 15:10:31 -0600121extern struct eth_device *eth_get_dev_by_index(int index); /* get dev @ index */
122extern int eth_get_dev_index (void); /* get the device index */
Mike Frysinger3f6e6992009-01-29 19:43:44 -0500123extern void eth_parse_enetaddr(const char *addr, uchar *enetaddr);
124extern int eth_getenv_enetaddr(char *name, uchar *enetaddr);
125extern int eth_setenv_enetaddr(char *name, const uchar *enetaddr);
Mike Frysinger86848a72009-07-15 21:31:28 -0400126extern int eth_getenv_enetaddr_by_index(int index, uchar *enetaddr);
wdenk2d966952002-10-31 22:12:35 +0000127
Andy Fleming5dc0cf62009-02-11 15:10:31 -0600128extern int eth_init(bd_t *bis); /* Initialize the device */
129extern int eth_send(volatile void *packet, int length); /* Send a packet */
Rafal Jaworowskif85b6072007-12-27 18:19:02 +0100130#ifdef CONFIG_API
Andy Fleming5dc0cf62009-02-11 15:10:31 -0600131extern int eth_receive(volatile void *packet, int length); /* Receive a packet*/
Rafal Jaworowskif85b6072007-12-27 18:19:02 +0100132#endif
Andy Fleming5dc0cf62009-02-11 15:10:31 -0600133extern int eth_rx(void); /* Check for received packets */
134extern void eth_halt(void); /* stop SCC */
135extern char *eth_get_name(void); /* get name of current device */
wdenk2d966952002-10-31 22:12:35 +0000136
David Updegraff53a5c422007-06-11 10:41:07 -0500137#ifdef CONFIG_MCAST_TFTP
138int eth_mcast_join( IPaddr_t mcast_addr, u8 join);
139u32 ether_crc (size_t len, unsigned char const *p);
140#endif
141
wdenk2d966952002-10-31 22:12:35 +0000142
143/**********************************************************************/
144/*
145 * Protocol headers.
146 */
147
148/*
149 * Ethernet header
150 */
151typedef 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 */
wdenka3d991b2004-04-15 21:48:45 +0000166
167/*
168 * Ethernet header
169 */
170typedef 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
wdenk2d966952002-10-31 22:12:35 +0000180#define PROT_IP 0x0800 /* IP protocol */
181#define PROT_ARP 0x0806 /* IP ARP protocol */
182#define PROT_RARP 0x8035 /* IP ARP protocol */
wdenka3d991b2004-04-15 21:48:45 +0000183#define PROT_VLAN 0x8100 /* IEEE 802.1q protocol */
wdenk2d966952002-10-31 22:12:35 +0000184
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 */
191typedef 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
Peter Tysere0c07b82008-12-01 16:26:20 -0600208#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
wdenk2d966952002-10-31 22:12:35 +0000214#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 */
221typedef 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 /*
wdenk8bde7f72003-06-27 21:31:46 +0000236 * The remaining fields are variable in size, according to
237 * the sizes above, and are defined as appropriate for
238 * specific hardware/protocol combinations.
wdenk2d966952002-10-31 22:12:35 +0000239 */
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 */
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200254#define ICMP_ECHO_REPLY 0 /* Echo reply */
wdenk2d966952002-10-31 22:12:35 +0000255#define ICMP_REDIRECT 5 /* Redirect (change route) */
wdenk73a8b272003-06-05 19:27:42 +0000256#define ICMP_ECHO_REQUEST 8 /* Echo request */
wdenk2d966952002-10-31 22:12:35 +0000257
258/* Codes for REDIRECT. */
259#define ICMP_REDIR_NET 0 /* Redirect Net */
260#define ICMP_REDIR_HOST 1 /* Redirect Host */
261
262typedef 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
wdenk2d966952002-10-31 22:12:35 +0000280/*
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 **/
317extern IPaddr_t NetOurGatewayIP; /* Our gateway IP addresse */
318extern IPaddr_t NetOurSubnetMask; /* Our subnet mask (0 = unknown)*/
319extern IPaddr_t NetOurDNSIP; /* Our Domain Name Server (0 = unknown)*/
Jon Loeliger1fe80d72007-07-09 22:08:34 -0500320#if defined(CONFIG_BOOTP_DNS2)
stroesefe389a82003-08-28 14:17:32 +0000321extern IPaddr_t NetOurDNS2IP; /* Our 2nd Domain Name Server (0 = unknown)*/
322#endif
wdenk2d966952002-10-31 22:12:35 +0000323extern char NetOurNISDomain[32]; /* Our NIS domain */
324extern char NetOurHostName[32]; /* Our hostname */
325extern char NetOurRootPath[64]; /* Our root path */
326extern ushort NetBootFileSize; /* Our boot file size in blocks */
327/** END OF BOOTP EXTENTIONS **/
328extern ulong NetBootFileXferSize; /* size of bootfile in bytes */
329extern uchar NetOurEther[6]; /* Our ethernet address */
330extern uchar NetServerEther[6]; /* Boot server enet address */
331extern IPaddr_t NetOurIP; /* Our IP addr (0 = unknown) */
332extern IPaddr_t NetServerIP; /* Server IP addr (0 = unknown) */
333extern volatile uchar * NetTxPacket; /* THE transmit packet */
334extern volatile uchar * NetRxPackets[PKTBUFSRX];/* Receive packets */
Mike Frysingerd9bec9f2009-07-18 21:04:08 -0400335extern volatile uchar * NetRxPacket; /* Current receive packet */
336extern int NetRxPacketLen; /* Current rx packet length */
wdenk2d966952002-10-31 22:12:35 +0000337extern unsigned NetIPID; /* IP ID (counting) */
338extern uchar NetBcastAddr[6]; /* Ethernet boardcast address */
wdenk68ceb292004-08-02 21:11:11 +0000339extern uchar NetEtherNullAddr[6];
wdenk2d966952002-10-31 22:12:35 +0000340
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200341#define VLAN_NONE 4095 /* untagged */
342#define VLAN_IDMASK 0x0fff /* mask of valid vlan id */
343extern ushort NetOurVLAN; /* Our VLAN */
344extern ushort NetOurNativeVLAN; /* Our Native VLAN */
wdenka3d991b2004-04-15 21:48:45 +0000345
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200346extern uchar NetCDPAddr[6]; /* Ethernet CDP address */
wdenka3d991b2004-04-15 21:48:45 +0000347extern ushort CDPNativeVLAN; /* CDP returned native VLAN */
348extern ushort CDPApplianceVLAN; /* CDP returned appliance VLAN */
349
wdenk2d966952002-10-31 22:12:35 +0000350extern 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
357extern int NetRestartWrap; /* Tried all network devices */
358#endif
359
wdenkea287de2005-04-01 00:25:43 +0000360typedef enum { BOOTP, RARP, ARP, TFTP, DHCP, PING, DNS, NFS, CDP, NETCONS, SNTP } proto_t;
wdenk2d966952002-10-31 22:12:35 +0000361
362/* from net/net.c */
363extern char BootFile[128]; /* Boot File name */
364
Robin Getz1a32bf42009-07-20 14:53:54 -0400365#if defined(CONFIG_CMD_DNS)
366extern char *NetDNSResolve; /* The host to resolve */
367extern char *NetDNSenvvar; /* the env var to put the ip into */
368#endif
369
Jon Loeliger639221c2007-07-09 17:15:49 -0500370#if defined(CONFIG_CMD_PING)
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200371extern IPaddr_t NetPingIP; /* the ip address to ping */
wdenk73a8b272003-06-05 19:27:42 +0000372#endif
373
Jon Loeliger639221c2007-07-09 17:15:49 -0500374#if defined(CONFIG_CMD_CDP)
wdenka3d991b2004-04-15 21:48:45 +0000375/* when CDP completes these hold the return values */
376extern ushort CDPNativeVLAN;
377extern ushort CDPApplianceVLAN;
378#endif
379
Jon Loeliger639221c2007-07-09 17:15:49 -0500380#if defined(CONFIG_CMD_SNTP)
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200381extern IPaddr_t NetNtpServerIP; /* the ip address to NTP */
wdenkea287de2005-04-01 00:25:43 +0000382extern int NetTimeOffset; /* offset time from UTC */
383#endif
384
wdenk2d966952002-10-31 22:12:35 +0000385/* Initialize the network adapter */
386extern int NetLoop(proto_t);
387
388/* Shutdown adapters and cleanup */
389extern void NetStop(void);
390
391/* Load failed. Start again. */
392extern void NetStartAgain(void);
393
wdenka3d991b2004-04-15 21:48:45 +0000394/* Get size of the ethernet header when we send */
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200395extern int NetEthHdrSize(void);
wdenka3d991b2004-04-15 21:48:45 +0000396
397/* Set ethernet header; returns the size of the header */
398extern int NetSetEther(volatile uchar *, uchar *, uint);
wdenk2d966952002-10-31 22:12:35 +0000399
400/* Set IP header */
401extern void NetSetIP(volatile uchar *, IPaddr_t, int, int, int);
402
403/* Checksum */
404extern int NetCksumOk(uchar *, int); /* Return true if cksum OK */
405extern uint NetCksum(uchar *, int); /* Calculate the checksum */
406
407/* Set callbacks */
408extern void NetSetHandler(rxhand_f *); /* Set RX packet handler */
wdenk3e01d752004-10-09 21:56:21 +0000409extern void NetSetTimeout(ulong, thand_f *);/* Set timeout handler */
wdenk2d966952002-10-31 22:12:35 +0000410
411/* Transmit "NetTxPacket" */
412extern void NetSendPacket(volatile uchar *, int);
413
wdenk73a8b272003-06-05 19:27:42 +0000414/* Transmit UDP packet, performing ARP request if needed */
415extern int NetSendUDPPacket(uchar *ether, IPaddr_t dest, int dport, int sport, int len);
416
wdenk2d966952002-10-31 22:12:35 +0000417/* Processes a received packet */
418extern void NetReceive(volatile uchar *, int);
419
wdenk2d966952002-10-31 22:12:35 +0000420/*
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* */
Anatolij Gustschin33a4a702008-04-30 13:34:40 +0200428static inline IPaddr_t NetReadIP(volatile void *from)
wdenk2d966952002-10-31 22:12:35 +0000429{
430 IPaddr_t ip;
Anatolij Gustschin33a4a702008-04-30 13:34:40 +0200431 memcpy((void*)&ip, (void*)from, sizeof(ip));
wdenk2d966952002-10-31 22:12:35 +0000432 return ip;
433}
434
435/* return ulong *in network byteorder* */
436static 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* */
444static inline void NetWriteIP(void *to, IPaddr_t ip)
445{
446 memcpy(to, (void*)&ip, sizeof(ip));
447}
448
449/* copy IP */
Anatolij Gustschin33a4a702008-04-30 13:34:40 +0200450static inline void NetCopyIP(volatile void *to, void *from)
wdenk2d966952002-10-31 22:12:35 +0000451{
Anatolij Gustschin33a4a702008-04-30 13:34:40 +0200452 memcpy((void*)to, from, sizeof(IPaddr_t));
wdenk2d966952002-10-31 22:12:35 +0000453}
454
455/* copy ulong */
456static inline void NetCopyLong(ulong *to, ulong *from)
457{
458 memcpy((void*)to, (void*)from, sizeof(ulong));
459}
460
Mike Rapoport50cca8b2007-08-12 08:48:27 +0300461/**
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 */
467static 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 */
479static inline int is_multicast_ether_addr(const u8 *addr)
480{
481 return (0x01 & addr[0]);
482}
483
Mike Frysinger75edebe2009-01-27 16:53:39 -0500484/**
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 */
493static 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
wdenk2d966952002-10-31 22:12:35 +0000500/* Convert an IP address to a string */
501extern void ip_to_string (IPaddr_t x, char *s);
502
wdenk73a8b272003-06-05 19:27:42 +0000503/* Convert a string to ip address */
504extern IPaddr_t string_to_ip(char *s);
505
wdenka3d991b2004-04-15 21:48:45 +0000506/* Convert a VLAN id to a string */
507extern void VLAN_to_string (ushort x, char *s);
508
509/* Convert a string to a vlan id */
510extern ushort string_to_VLAN(char *s);
511
wdenka3d991b2004-04-15 21:48:45 +0000512/* read a VLAN id from an environment variable */
513extern ushort getenv_VLAN(char *);
514
wdenk2d966952002-10-31 22:12:35 +0000515/* copy a filename (allow for "..." notation, limit length) */
Wolfgang Denk77ddac92005-10-13 16:45:02 +0200516extern void copy_filename (char *dst, char *src, int size);
wdenk2d966952002-10-31 22:12:35 +0000517
Mike Frysinger91b469c2009-09-02 04:18:55 -0400518/* get a random source port */
519extern unsigned int random_port(void);
520
wdenk2d966952002-10-31 22:12:35 +0000521/**********************************************************************/
522
523#endif /* __NET_H__ */