blob: 95ef8ab83c3f0ac3c9f3f3a1cfb7b3125d9ca225 [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
Remy Bohmer23cd1382009-07-29 18:18:43 +0200128extern int usb_eth_initialize(bd_t *bi);
Andy Fleming5dc0cf62009-02-11 15:10:31 -0600129extern int eth_init(bd_t *bis); /* Initialize the device */
130extern int eth_send(volatile void *packet, int length); /* Send a packet */
Remy Bohmer23cd1382009-07-29 18:18:43 +0200131
Rafal Jaworowskif85b6072007-12-27 18:19:02 +0100132#ifdef CONFIG_API
Andy Fleming5dc0cf62009-02-11 15:10:31 -0600133extern int eth_receive(volatile void *packet, int length); /* Receive a packet*/
Rafal Jaworowskif85b6072007-12-27 18:19:02 +0100134#endif
Andy Fleming5dc0cf62009-02-11 15:10:31 -0600135extern int eth_rx(void); /* Check for received packets */
136extern void eth_halt(void); /* stop SCC */
137extern char *eth_get_name(void); /* get name of current device */
wdenk2d966952002-10-31 22:12:35 +0000138
David Updegraff53a5c422007-06-11 10:41:07 -0500139#ifdef CONFIG_MCAST_TFTP
140int eth_mcast_join( IPaddr_t mcast_addr, u8 join);
141u32 ether_crc (size_t len, unsigned char const *p);
142#endif
143
wdenk2d966952002-10-31 22:12:35 +0000144
145/**********************************************************************/
146/*
147 * Protocol headers.
148 */
149
150/*
151 * Ethernet header
152 */
153typedef struct {
154 uchar et_dest[6]; /* Destination node */
155 uchar et_src[6]; /* Source node */
156 ushort et_protlen; /* Protocol or length */
157 uchar et_dsap; /* 802 DSAP */
158 uchar et_ssap; /* 802 SSAP */
159 uchar et_ctl; /* 802 control */
160 uchar et_snap1; /* SNAP */
161 uchar et_snap2;
162 uchar et_snap3;
163 ushort et_prot; /* 802 protocol */
164} Ethernet_t;
165
166#define ETHER_HDR_SIZE 14 /* Ethernet header size */
167#define E802_HDR_SIZE 22 /* 802 ethernet header size */
wdenka3d991b2004-04-15 21:48:45 +0000168
169/*
170 * Ethernet header
171 */
172typedef struct {
173 uchar vet_dest[6]; /* Destination node */
174 uchar vet_src[6]; /* Source node */
175 ushort vet_vlan_type; /* PROT_VLAN */
176 ushort vet_tag; /* TAG of VLAN */
177 ushort vet_type; /* protocol type */
178} VLAN_Ethernet_t;
179
180#define VLAN_ETHER_HDR_SIZE 18 /* VLAN Ethernet header size */
181
wdenk2d966952002-10-31 22:12:35 +0000182#define PROT_IP 0x0800 /* IP protocol */
183#define PROT_ARP 0x0806 /* IP ARP protocol */
184#define PROT_RARP 0x8035 /* IP ARP protocol */
wdenka3d991b2004-04-15 21:48:45 +0000185#define PROT_VLAN 0x8100 /* IEEE 802.1q protocol */
wdenk2d966952002-10-31 22:12:35 +0000186
187#define IPPROTO_ICMP 1 /* Internet Control Message Protocol */
188#define IPPROTO_UDP 17 /* User Datagram Protocol */
189
190/*
191 * Internet Protocol (IP) header.
192 */
193typedef struct {
194 uchar ip_hl_v; /* header length and version */
195 uchar ip_tos; /* type of service */
196 ushort ip_len; /* total length */
197 ushort ip_id; /* identification */
198 ushort ip_off; /* fragment offset field */
199 uchar ip_ttl; /* time to live */
200 uchar ip_p; /* protocol */
201 ushort ip_sum; /* checksum */
202 IPaddr_t ip_src; /* Source IP address */
203 IPaddr_t ip_dst; /* Destination IP address */
204 ushort udp_src; /* UDP source port */
205 ushort udp_dst; /* UDP destination port */
206 ushort udp_len; /* Length of UDP packet */
207 ushort udp_xsum; /* Checksum */
208} IP_t;
209
Peter Tysere0c07b82008-12-01 16:26:20 -0600210#define IP_OFFS 0x1fff /* ip offset *= 8 */
211#define IP_FLAGS 0xe000 /* first 3 bits */
212#define IP_FLAGS_RES 0x8000 /* reserved */
213#define IP_FLAGS_DFRAG 0x4000 /* don't fragments */
214#define IP_FLAGS_MFRAG 0x2000 /* more fragments */
215
wdenk2d966952002-10-31 22:12:35 +0000216#define IP_HDR_SIZE_NO_UDP (sizeof (IP_t) - 8)
217#define IP_HDR_SIZE (sizeof (IP_t))
218
219
220/*
221 * Address Resolution Protocol (ARP) header.
222 */
223typedef struct
224{
225 ushort ar_hrd; /* Format of hardware address */
226# define ARP_ETHER 1 /* Ethernet hardware address */
227 ushort ar_pro; /* Format of protocol address */
228 uchar ar_hln; /* Length of hardware address */
229 uchar ar_pln; /* Length of protocol address */
230 ushort ar_op; /* Operation */
231# define ARPOP_REQUEST 1 /* Request to resolve address */
232# define ARPOP_REPLY 2 /* Response to previous request */
233
234# define RARPOP_REQUEST 3 /* Request to resolve address */
235# define RARPOP_REPLY 4 /* Response to previous request */
236
237 /*
wdenk8bde7f72003-06-27 21:31:46 +0000238 * The remaining fields are variable in size, according to
239 * the sizes above, and are defined as appropriate for
240 * specific hardware/protocol combinations.
wdenk2d966952002-10-31 22:12:35 +0000241 */
242 uchar ar_data[0];
243#if 0
244 uchar ar_sha[]; /* Sender hardware address */
245 uchar ar_spa[]; /* Sender protocol address */
246 uchar ar_tha[]; /* Target hardware address */
247 uchar ar_tpa[]; /* Target protocol address */
248#endif /* 0 */
249} ARP_t;
250
251#define ARP_HDR_SIZE (8+20) /* Size assuming ethernet */
252
253/*
254 * ICMP stuff (just enough to handle (host) redirect messages)
255 */
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200256#define ICMP_ECHO_REPLY 0 /* Echo reply */
wdenk2d966952002-10-31 22:12:35 +0000257#define ICMP_REDIRECT 5 /* Redirect (change route) */
wdenk73a8b272003-06-05 19:27:42 +0000258#define ICMP_ECHO_REQUEST 8 /* Echo request */
wdenk2d966952002-10-31 22:12:35 +0000259
260/* Codes for REDIRECT. */
261#define ICMP_REDIR_NET 0 /* Redirect Net */
262#define ICMP_REDIR_HOST 1 /* Redirect Host */
263
264typedef struct icmphdr {
265 uchar type;
266 uchar code;
267 ushort checksum;
268 union {
269 struct {
270 ushort id;
271 ushort sequence;
272 } echo;
273 ulong gateway;
274 struct {
275 ushort __unused;
276 ushort mtu;
277 } frag;
278 } un;
279} ICMP_t;
280
281
wdenk2d966952002-10-31 22:12:35 +0000282/*
283 * Maximum packet size; used to allocate packet storage.
284 * TFTP packets can be 524 bytes + IP header + ethernet header.
285 * Lets be conservative, and go for 38 * 16. (Must also be
286 * a multiple of 32 bytes).
287 */
288/*
289 * AS.HARNOIS : Better to set PKTSIZE to maximum size because
290 * traffic type is not always controlled
291 * maximum packet size = 1518
292 * maximum packet size and multiple of 32 bytes = 1536
293 */
294#define PKTSIZE 1518
295#define PKTSIZE_ALIGN 1536
296/*#define PKTSIZE 608*/
297
298/*
299 * Maximum receive ring size; that is, the number of packets
300 * we can buffer before overflow happens. Basically, this just
301 * needs to be enough to prevent a packet being discarded while
302 * we are processing the previous one.
303 */
304#define RINGSZ 4
305#define RINGSZ_LOG2 2
306
307/**********************************************************************/
308/*
309 * Globals.
310 *
311 * Note:
312 *
313 * All variables of type IPaddr_t are stored in NETWORK byte order
314 * (big endian).
315 */
316
317/* net.c */
318/** BOOTP EXTENTIONS **/
319extern IPaddr_t NetOurGatewayIP; /* Our gateway IP addresse */
320extern IPaddr_t NetOurSubnetMask; /* Our subnet mask (0 = unknown)*/
321extern IPaddr_t NetOurDNSIP; /* Our Domain Name Server (0 = unknown)*/
Jon Loeliger1fe80d72007-07-09 22:08:34 -0500322#if defined(CONFIG_BOOTP_DNS2)
stroesefe389a82003-08-28 14:17:32 +0000323extern IPaddr_t NetOurDNS2IP; /* Our 2nd Domain Name Server (0 = unknown)*/
324#endif
wdenk2d966952002-10-31 22:12:35 +0000325extern char NetOurNISDomain[32]; /* Our NIS domain */
326extern char NetOurHostName[32]; /* Our hostname */
327extern char NetOurRootPath[64]; /* Our root path */
328extern ushort NetBootFileSize; /* Our boot file size in blocks */
329/** END OF BOOTP EXTENTIONS **/
330extern ulong NetBootFileXferSize; /* size of bootfile in bytes */
331extern uchar NetOurEther[6]; /* Our ethernet address */
332extern uchar NetServerEther[6]; /* Boot server enet address */
333extern IPaddr_t NetOurIP; /* Our IP addr (0 = unknown) */
334extern IPaddr_t NetServerIP; /* Server IP addr (0 = unknown) */
335extern volatile uchar * NetTxPacket; /* THE transmit packet */
336extern volatile uchar * NetRxPackets[PKTBUFSRX];/* Receive packets */
Mike Frysingerd9bec9f2009-07-18 21:04:08 -0400337extern volatile uchar * NetRxPacket; /* Current receive packet */
338extern int NetRxPacketLen; /* Current rx packet length */
wdenk2d966952002-10-31 22:12:35 +0000339extern unsigned NetIPID; /* IP ID (counting) */
340extern uchar NetBcastAddr[6]; /* Ethernet boardcast address */
wdenk68ceb292004-08-02 21:11:11 +0000341extern uchar NetEtherNullAddr[6];
wdenk2d966952002-10-31 22:12:35 +0000342
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200343#define VLAN_NONE 4095 /* untagged */
344#define VLAN_IDMASK 0x0fff /* mask of valid vlan id */
345extern ushort NetOurVLAN; /* Our VLAN */
346extern ushort NetOurNativeVLAN; /* Our Native VLAN */
wdenka3d991b2004-04-15 21:48:45 +0000347
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200348extern uchar NetCDPAddr[6]; /* Ethernet CDP address */
wdenka3d991b2004-04-15 21:48:45 +0000349extern ushort CDPNativeVLAN; /* CDP returned native VLAN */
350extern ushort CDPApplianceVLAN; /* CDP returned appliance VLAN */
351
wdenk2d966952002-10-31 22:12:35 +0000352extern int NetState; /* Network loop state */
353#define NETLOOP_CONTINUE 1
354#define NETLOOP_RESTART 2
355#define NETLOOP_SUCCESS 3
356#define NETLOOP_FAIL 4
357
358#ifdef CONFIG_NET_MULTI
359extern int NetRestartWrap; /* Tried all network devices */
360#endif
361
wdenkea287de2005-04-01 00:25:43 +0000362typedef enum { BOOTP, RARP, ARP, TFTP, DHCP, PING, DNS, NFS, CDP, NETCONS, SNTP } proto_t;
wdenk2d966952002-10-31 22:12:35 +0000363
364/* from net/net.c */
365extern char BootFile[128]; /* Boot File name */
366
Robin Getz1a32bf42009-07-20 14:53:54 -0400367#if defined(CONFIG_CMD_DNS)
368extern char *NetDNSResolve; /* The host to resolve */
369extern char *NetDNSenvvar; /* the env var to put the ip into */
370#endif
371
Jon Loeliger639221c2007-07-09 17:15:49 -0500372#if defined(CONFIG_CMD_PING)
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200373extern IPaddr_t NetPingIP; /* the ip address to ping */
wdenk73a8b272003-06-05 19:27:42 +0000374#endif
375
Jon Loeliger639221c2007-07-09 17:15:49 -0500376#if defined(CONFIG_CMD_CDP)
wdenka3d991b2004-04-15 21:48:45 +0000377/* when CDP completes these hold the return values */
378extern ushort CDPNativeVLAN;
379extern ushort CDPApplianceVLAN;
380#endif
381
Jon Loeliger639221c2007-07-09 17:15:49 -0500382#if defined(CONFIG_CMD_SNTP)
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200383extern IPaddr_t NetNtpServerIP; /* the ip address to NTP */
wdenkea287de2005-04-01 00:25:43 +0000384extern int NetTimeOffset; /* offset time from UTC */
385#endif
386
wdenk2d966952002-10-31 22:12:35 +0000387/* Initialize the network adapter */
388extern int NetLoop(proto_t);
389
390/* Shutdown adapters and cleanup */
391extern void NetStop(void);
392
393/* Load failed. Start again. */
394extern void NetStartAgain(void);
395
wdenka3d991b2004-04-15 21:48:45 +0000396/* Get size of the ethernet header when we send */
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200397extern int NetEthHdrSize(void);
wdenka3d991b2004-04-15 21:48:45 +0000398
399/* Set ethernet header; returns the size of the header */
400extern int NetSetEther(volatile uchar *, uchar *, uint);
wdenk2d966952002-10-31 22:12:35 +0000401
402/* Set IP header */
403extern void NetSetIP(volatile uchar *, IPaddr_t, int, int, int);
404
405/* Checksum */
406extern int NetCksumOk(uchar *, int); /* Return true if cksum OK */
407extern uint NetCksum(uchar *, int); /* Calculate the checksum */
408
409/* Set callbacks */
410extern void NetSetHandler(rxhand_f *); /* Set RX packet handler */
wdenk3e01d752004-10-09 21:56:21 +0000411extern void NetSetTimeout(ulong, thand_f *);/* Set timeout handler */
wdenk2d966952002-10-31 22:12:35 +0000412
413/* Transmit "NetTxPacket" */
414extern void NetSendPacket(volatile uchar *, int);
415
wdenk73a8b272003-06-05 19:27:42 +0000416/* Transmit UDP packet, performing ARP request if needed */
417extern int NetSendUDPPacket(uchar *ether, IPaddr_t dest, int dport, int sport, int len);
418
wdenk2d966952002-10-31 22:12:35 +0000419/* Processes a received packet */
420extern void NetReceive(volatile uchar *, int);
421
wdenk2d966952002-10-31 22:12:35 +0000422/*
423 * The following functions are a bit ugly, but necessary to deal with
424 * alignment restrictions on ARM.
425 *
426 * We're using inline functions, which had the smallest memory
427 * footprint in our tests.
428 */
429/* return IP *in network byteorder* */
Anatolij Gustschin33a4a702008-04-30 13:34:40 +0200430static inline IPaddr_t NetReadIP(volatile void *from)
wdenk2d966952002-10-31 22:12:35 +0000431{
432 IPaddr_t ip;
Anatolij Gustschin33a4a702008-04-30 13:34:40 +0200433 memcpy((void*)&ip, (void*)from, sizeof(ip));
wdenk2d966952002-10-31 22:12:35 +0000434 return ip;
435}
436
437/* return ulong *in network byteorder* */
438static inline ulong NetReadLong(ulong *from)
439{
440 ulong l;
441 memcpy((void*)&l, (void*)from, sizeof(l));
442 return l;
443}
444
445/* write IP *in network byteorder* */
446static inline void NetWriteIP(void *to, IPaddr_t ip)
447{
448 memcpy(to, (void*)&ip, sizeof(ip));
449}
450
451/* copy IP */
Anatolij Gustschin33a4a702008-04-30 13:34:40 +0200452static inline void NetCopyIP(volatile void *to, void *from)
wdenk2d966952002-10-31 22:12:35 +0000453{
Anatolij Gustschin33a4a702008-04-30 13:34:40 +0200454 memcpy((void*)to, from, sizeof(IPaddr_t));
wdenk2d966952002-10-31 22:12:35 +0000455}
456
457/* copy ulong */
458static inline void NetCopyLong(ulong *to, ulong *from)
459{
460 memcpy((void*)to, (void*)from, sizeof(ulong));
461}
462
Mike Rapoport50cca8b2007-08-12 08:48:27 +0300463/**
464 * is_zero_ether_addr - Determine if give Ethernet address is all zeros.
465 * @addr: Pointer to a six-byte array containing the Ethernet address
466 *
467 * Return true if the address is all zeroes.
468 */
469static inline int is_zero_ether_addr(const u8 *addr)
470{
471 return !(addr[0] | addr[1] | addr[2] | addr[3] | addr[4] | addr[5]);
472}
473
474/**
475 * is_multicast_ether_addr - Determine if the Ethernet address is a multicast.
476 * @addr: Pointer to a six-byte array containing the Ethernet address
477 *
478 * Return true if the address is a multicast address.
479 * By definition the broadcast address is also a multicast address.
480 */
481static inline int is_multicast_ether_addr(const u8 *addr)
482{
483 return (0x01 & addr[0]);
484}
485
Remy Bohmer23cd1382009-07-29 18:18:43 +0200486/*
487 * is_broadcast_ether_addr - Determine if the Ethernet address is broadcast
488 * @addr: Pointer to a six-byte array containing the Ethernet address
489 *
490 * Return true if the address is the broadcast address.
491 */
492static inline int is_broadcast_ether_addr(const u8 *addr)
493{
494 return (addr[0] & addr[1] & addr[2] & addr[3] & addr[4] & addr[5]) == 0xff;
495}
496
497/*
Mike Frysinger75edebe2009-01-27 16:53:39 -0500498 * is_valid_ether_addr - Determine if the given Ethernet address is valid
499 * @addr: Pointer to a six-byte array containing the Ethernet address
500 *
501 * Check that the Ethernet address (MAC) is not 00:00:00:00:00:00, is not
502 * a multicast address, and is not FF:FF:FF:FF:FF:FF.
503 *
504 * Return true if the address is valid.
505 */
Remy Bohmer23cd1382009-07-29 18:18:43 +0200506static inline int is_valid_ether_addr(const u8 *addr)
Mike Frysinger75edebe2009-01-27 16:53:39 -0500507{
508 /* FF:FF:FF:FF:FF:FF is a multicast address so we don't need to
509 * explicitly check for it here. */
510 return !is_multicast_ether_addr(addr) && !is_zero_ether_addr(addr);
511}
512
wdenk2d966952002-10-31 22:12:35 +0000513/* Convert an IP address to a string */
514extern void ip_to_string (IPaddr_t x, char *s);
515
wdenk73a8b272003-06-05 19:27:42 +0000516/* Convert a string to ip address */
Mike Frysinger908c6b62010-10-20 07:16:58 -0400517extern IPaddr_t string_to_ip(const char *s);
wdenk73a8b272003-06-05 19:27:42 +0000518
wdenka3d991b2004-04-15 21:48:45 +0000519/* Convert a VLAN id to a string */
520extern void VLAN_to_string (ushort x, char *s);
521
522/* Convert a string to a vlan id */
Mike Frysinger2e3ef6e2010-10-20 07:16:48 -0400523extern ushort string_to_VLAN(const char *s);
wdenka3d991b2004-04-15 21:48:45 +0000524
wdenka3d991b2004-04-15 21:48:45 +0000525/* read a VLAN id from an environment variable */
526extern ushort getenv_VLAN(char *);
527
wdenk2d966952002-10-31 22:12:35 +0000528/* copy a filename (allow for "..." notation, limit length) */
Mike Frysingerb920ee92010-10-20 07:16:40 -0400529extern void copy_filename (char *dst, const char *src, int size);
wdenk2d966952002-10-31 22:12:35 +0000530
Mike Frysinger91b469c2009-09-02 04:18:55 -0400531/* get a random source port */
532extern unsigned int random_port(void);
533
wdenk2d966952002-10-31 22:12:35 +0000534/**********************************************************************/
535
536#endif /* __NET_H__ */