blob: fa5d525f6d964c3a58d4af0cfd637c805fc19eae [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#endif /* CONFIG_8xx */
wdenkaacf9a42003-01-17 16:27:01 +000018
wdenk2d966952002-10-31 22:12:35 +000019#include <asm/byteorder.h> /* for nton* / ntoh* stuff */
20
21
22/*
23 * The number of receive packet buffers, and the required packet buffer
24 * alignment in memory.
25 *
26 */
27
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +020028#ifdef CONFIG_SYS_RX_ETH_BUFFER
29# define PKTBUFSRX CONFIG_SYS_RX_ETH_BUFFER
wdenk1d0350e2002-11-11 21:14:20 +000030#else
stroesec6028832003-06-05 15:38:29 +000031# define PKTBUFSRX 4
wdenk1d0350e2002-11-11 21:14:20 +000032#endif
33
wdenk2d966952002-10-31 22:12:35 +000034#define PKTALIGN 32
35
Matthias Weisserea45cb02011-12-03 03:29:44 +000036/* IPv4 addresses are always 32 bits in size */
37typedef u32 IPaddr_t;
wdenk2d966952002-10-31 22:12:35 +000038
39
Luca Ceresoli03eb1292011-04-18 06:19:50 +000040/**
41 * An incoming packet handler.
42 * @param pkt pointer to the application packet
43 * @param dport destination UDP port
44 * @param sip source IP address
45 * @param sport source UDP port
46 * @param len packet length
wdenk2d966952002-10-31 22:12:35 +000047 */
Luca Ceresoli03eb1292011-04-18 06:19:50 +000048typedef void rxhand_f(uchar *pkt, unsigned dport,
49 IPaddr_t sip, unsigned sport,
50 unsigned len);
wdenk2d966952002-10-31 22:12:35 +000051
Simon Glass4793ee62011-10-24 18:00:01 +000052/**
53 * An incoming ICMP packet handler.
54 * @param type ICMP type
55 * @param code ICMP code
56 * @param dport destination UDP port
57 * @param sip source IP address
58 * @param sport source UDP port
59 * @param pkt pointer to the ICMP packet data
60 * @param len packet length
61 */
62typedef void rxhand_icmp_f(unsigned type, unsigned code, unsigned dport,
63 IPaddr_t sip, unsigned sport, uchar *pkt, unsigned len);
64
wdenk2d966952002-10-31 22:12:35 +000065/*
66 * A timeout handler. Called after time interval has expired.
67 */
68typedef void thand_f(void);
69
wdenk2d966952002-10-31 22:12:35 +000070#define NAMESIZE 16
71
72enum eth_state_t {
73 ETH_STATE_INIT,
74 ETH_STATE_PASSIVE,
75 ETH_STATE_ACTIVE
76};
77
78struct eth_device {
79 char name[NAMESIZE];
80 unsigned char enetaddr[6];
81 int iobase;
82 int state;
83
84 int (*init) (struct eth_device*, bd_t*);
David Updegraff53a5c422007-06-11 10:41:07 -050085 int (*send) (struct eth_device*, volatile void* packet, int length);
wdenk2d966952002-10-31 22:12:35 +000086 int (*recv) (struct eth_device*);
87 void (*halt) (struct eth_device*);
David Updegraff53a5c422007-06-11 10:41:07 -050088#ifdef CONFIG_MCAST_TFTP
89 int (*mcast) (struct eth_device*, u32 ip, u8 set);
90#endif
Ben Warrenecee9322010-04-26 11:11:46 -070091 int (*write_hwaddr) (struct eth_device*);
wdenk2d966952002-10-31 22:12:35 +000092 struct eth_device *next;
93 void *priv;
94};
95
Andy Fleming5dc0cf62009-02-11 15:10:31 -060096extern int eth_initialize(bd_t *bis); /* Initialize network subsystem */
97extern int eth_register(struct eth_device* dev);/* Register network device */
98extern void eth_try_another(int first_restart); /* Change the device */
Andy Fleming5dc0cf62009-02-11 15:10:31 -060099extern void eth_set_current(void); /* set nterface to ethcur var */
Andy Fleming5dc0cf62009-02-11 15:10:31 -0600100extern struct eth_device *eth_get_dev(void); /* get the current device MAC */
Ben Warrend7fb9bc2010-07-29 12:56:11 -0700101extern struct eth_device *eth_get_dev_by_name(const char *devname);
Andy Fleming5dc0cf62009-02-11 15:10:31 -0600102extern struct eth_device *eth_get_dev_by_index(int index); /* get dev @ index */
103extern int eth_get_dev_index (void); /* get the device index */
Mike Frysinger3f6e6992009-01-29 19:43:44 -0500104extern void eth_parse_enetaddr(const char *addr, uchar *enetaddr);
105extern int eth_getenv_enetaddr(char *name, uchar *enetaddr);
106extern int eth_setenv_enetaddr(char *name, const uchar *enetaddr);
Simon Glass7616e782011-06-13 16:13:10 -0700107
108/*
109 * Get the hardware address for an ethernet interface .
110 * Args:
111 * base_name - base name for device (normally "eth")
112 * index - device index number (0 for first)
113 * enetaddr - returns 6 byte hardware address
114 * Returns:
115 * Return true if the address is valid.
116 */
117extern int eth_getenv_enetaddr_by_index(const char *base_name, int index,
118 uchar *enetaddr);
wdenk2d966952002-10-31 22:12:35 +0000119
Remy Bohmer23cd1382009-07-29 18:18:43 +0200120extern int usb_eth_initialize(bd_t *bi);
Andy Fleming5dc0cf62009-02-11 15:10:31 -0600121extern int eth_init(bd_t *bis); /* Initialize the device */
122extern int eth_send(volatile void *packet, int length); /* Send a packet */
Remy Bohmer23cd1382009-07-29 18:18:43 +0200123
Rafal Jaworowskif85b6072007-12-27 18:19:02 +0100124#ifdef CONFIG_API
Andy Fleming5dc0cf62009-02-11 15:10:31 -0600125extern int eth_receive(volatile void *packet, int length); /* Receive a packet*/
Rafal Jaworowskif85b6072007-12-27 18:19:02 +0100126#endif
Andy Fleming5dc0cf62009-02-11 15:10:31 -0600127extern int eth_rx(void); /* Check for received packets */
128extern void eth_halt(void); /* stop SCC */
129extern char *eth_get_name(void); /* get name of current device */
wdenk2d966952002-10-31 22:12:35 +0000130
Simon Glass7616e782011-06-13 16:13:10 -0700131/*
132 * Set the hardware address for an ethernet interface based on 'eth%daddr'
133 * environment variable (or just 'ethaddr' if eth_number is 0).
134 * Args:
135 * base_name - base name for device (normally "eth")
136 * eth_number - value of %d (0 for first device of this type)
137 * Returns:
138 * 0 is success, non-zero is error status from driver.
139 */
140int eth_write_hwaddr(struct eth_device *dev, const char *base_name,
141 int eth_number);
142
David Updegraff53a5c422007-06-11 10:41:07 -0500143#ifdef CONFIG_MCAST_TFTP
144int eth_mcast_join( IPaddr_t mcast_addr, u8 join);
145u32 ether_crc (size_t len, unsigned char const *p);
146#endif
147
wdenk2d966952002-10-31 22:12:35 +0000148
149/**********************************************************************/
150/*
151 * Protocol headers.
152 */
153
154/*
155 * Ethernet header
156 */
157typedef struct {
158 uchar et_dest[6]; /* Destination node */
159 uchar et_src[6]; /* Source node */
160 ushort et_protlen; /* Protocol or length */
161 uchar et_dsap; /* 802 DSAP */
162 uchar et_ssap; /* 802 SSAP */
163 uchar et_ctl; /* 802 control */
164 uchar et_snap1; /* SNAP */
165 uchar et_snap2;
166 uchar et_snap3;
167 ushort et_prot; /* 802 protocol */
168} Ethernet_t;
169
170#define ETHER_HDR_SIZE 14 /* Ethernet header size */
171#define E802_HDR_SIZE 22 /* 802 ethernet header size */
wdenka3d991b2004-04-15 21:48:45 +0000172
173/*
174 * Ethernet header
175 */
176typedef struct {
177 uchar vet_dest[6]; /* Destination node */
178 uchar vet_src[6]; /* Source node */
179 ushort vet_vlan_type; /* PROT_VLAN */
180 ushort vet_tag; /* TAG of VLAN */
181 ushort vet_type; /* protocol type */
182} VLAN_Ethernet_t;
183
184#define VLAN_ETHER_HDR_SIZE 18 /* VLAN Ethernet header size */
185
wdenk2d966952002-10-31 22:12:35 +0000186#define PROT_IP 0x0800 /* IP protocol */
187#define PROT_ARP 0x0806 /* IP ARP protocol */
188#define PROT_RARP 0x8035 /* IP ARP protocol */
wdenka3d991b2004-04-15 21:48:45 +0000189#define PROT_VLAN 0x8100 /* IEEE 802.1q protocol */
wdenk2d966952002-10-31 22:12:35 +0000190
191#define IPPROTO_ICMP 1 /* Internet Control Message Protocol */
192#define IPPROTO_UDP 17 /* User Datagram Protocol */
193
194/*
195 * Internet Protocol (IP) header.
196 */
197typedef struct {
198 uchar ip_hl_v; /* header length and version */
199 uchar ip_tos; /* type of service */
200 ushort ip_len; /* total length */
201 ushort ip_id; /* identification */
202 ushort ip_off; /* fragment offset field */
203 uchar ip_ttl; /* time to live */
204 uchar ip_p; /* protocol */
205 ushort ip_sum; /* checksum */
206 IPaddr_t ip_src; /* Source IP address */
207 IPaddr_t ip_dst; /* Destination IP address */
208 ushort udp_src; /* UDP source port */
209 ushort udp_dst; /* UDP destination port */
210 ushort udp_len; /* Length of UDP packet */
211 ushort udp_xsum; /* Checksum */
212} IP_t;
213
Peter Tysere0c07b82008-12-01 16:26:20 -0600214#define IP_OFFS 0x1fff /* ip offset *= 8 */
215#define IP_FLAGS 0xe000 /* first 3 bits */
216#define IP_FLAGS_RES 0x8000 /* reserved */
217#define IP_FLAGS_DFRAG 0x4000 /* don't fragments */
218#define IP_FLAGS_MFRAG 0x2000 /* more fragments */
219
wdenk2d966952002-10-31 22:12:35 +0000220#define IP_HDR_SIZE_NO_UDP (sizeof (IP_t) - 8)
221#define IP_HDR_SIZE (sizeof (IP_t))
222
223
224/*
225 * Address Resolution Protocol (ARP) header.
226 */
227typedef struct
228{
229 ushort ar_hrd; /* Format of hardware address */
230# define ARP_ETHER 1 /* Ethernet hardware address */
231 ushort ar_pro; /* Format of protocol address */
232 uchar ar_hln; /* Length of hardware address */
233 uchar ar_pln; /* Length of protocol address */
234 ushort ar_op; /* Operation */
235# define ARPOP_REQUEST 1 /* Request to resolve address */
236# define ARPOP_REPLY 2 /* Response to previous request */
237
238# define RARPOP_REQUEST 3 /* Request to resolve address */
239# define RARPOP_REPLY 4 /* Response to previous request */
240
241 /*
wdenk8bde7f72003-06-27 21:31:46 +0000242 * The remaining fields are variable in size, according to
243 * the sizes above, and are defined as appropriate for
244 * specific hardware/protocol combinations.
wdenk2d966952002-10-31 22:12:35 +0000245 */
246 uchar ar_data[0];
247#if 0
248 uchar ar_sha[]; /* Sender hardware address */
249 uchar ar_spa[]; /* Sender protocol address */
250 uchar ar_tha[]; /* Target hardware address */
251 uchar ar_tpa[]; /* Target protocol address */
252#endif /* 0 */
253} ARP_t;
254
255#define ARP_HDR_SIZE (8+20) /* Size assuming ethernet */
256
257/*
258 * ICMP stuff (just enough to handle (host) redirect messages)
259 */
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200260#define ICMP_ECHO_REPLY 0 /* Echo reply */
Simon Glass4793ee62011-10-24 18:00:01 +0000261#define ICMP_NOT_REACH 3 /* Detination unreachable */
wdenk2d966952002-10-31 22:12:35 +0000262#define ICMP_REDIRECT 5 /* Redirect (change route) */
wdenk73a8b272003-06-05 19:27:42 +0000263#define ICMP_ECHO_REQUEST 8 /* Echo request */
wdenk2d966952002-10-31 22:12:35 +0000264
265/* Codes for REDIRECT. */
266#define ICMP_REDIR_NET 0 /* Redirect Net */
267#define ICMP_REDIR_HOST 1 /* Redirect Host */
268
Simon Glass4793ee62011-10-24 18:00:01 +0000269/* Codes for NOT_REACH */
270#define ICMP_NOT_REACH_PORT 3 /* Port unreachable */
271
wdenk2d966952002-10-31 22:12:35 +0000272typedef struct icmphdr {
273 uchar type;
274 uchar code;
275 ushort checksum;
276 union {
277 struct {
278 ushort id;
279 ushort sequence;
280 } echo;
281 ulong gateway;
282 struct {
283 ushort __unused;
284 ushort mtu;
285 } frag;
Simon Glass4793ee62011-10-24 18:00:01 +0000286 uchar data[0];
wdenk2d966952002-10-31 22:12:35 +0000287 } un;
288} ICMP_t;
289
290
wdenk2d966952002-10-31 22:12:35 +0000291/*
292 * Maximum packet size; used to allocate packet storage.
293 * TFTP packets can be 524 bytes + IP header + ethernet header.
294 * Lets be conservative, and go for 38 * 16. (Must also be
295 * a multiple of 32 bytes).
296 */
297/*
298 * AS.HARNOIS : Better to set PKTSIZE to maximum size because
299 * traffic type is not always controlled
300 * maximum packet size = 1518
301 * maximum packet size and multiple of 32 bytes = 1536
302 */
303#define PKTSIZE 1518
304#define PKTSIZE_ALIGN 1536
305/*#define PKTSIZE 608*/
306
307/*
308 * Maximum receive ring size; that is, the number of packets
309 * we can buffer before overflow happens. Basically, this just
310 * needs to be enough to prevent a packet being discarded while
311 * we are processing the previous one.
312 */
313#define RINGSZ 4
314#define RINGSZ_LOG2 2
315
316/**********************************************************************/
317/*
318 * Globals.
319 *
320 * Note:
321 *
322 * All variables of type IPaddr_t are stored in NETWORK byte order
323 * (big endian).
324 */
325
326/* net.c */
327/** BOOTP EXTENTIONS **/
328extern IPaddr_t NetOurGatewayIP; /* Our gateway IP addresse */
329extern IPaddr_t NetOurSubnetMask; /* Our subnet mask (0 = unknown)*/
330extern IPaddr_t NetOurDNSIP; /* Our Domain Name Server (0 = unknown)*/
Jon Loeliger1fe80d72007-07-09 22:08:34 -0500331#if defined(CONFIG_BOOTP_DNS2)
stroesefe389a82003-08-28 14:17:32 +0000332extern IPaddr_t NetOurDNS2IP; /* Our 2nd Domain Name Server (0 = unknown)*/
333#endif
wdenk2d966952002-10-31 22:12:35 +0000334extern char NetOurNISDomain[32]; /* Our NIS domain */
335extern char NetOurHostName[32]; /* Our hostname */
336extern char NetOurRootPath[64]; /* Our root path */
337extern ushort NetBootFileSize; /* Our boot file size in blocks */
338/** END OF BOOTP EXTENTIONS **/
339extern ulong NetBootFileXferSize; /* size of bootfile in bytes */
340extern uchar NetOurEther[6]; /* Our ethernet address */
341extern uchar NetServerEther[6]; /* Boot server enet address */
342extern IPaddr_t NetOurIP; /* Our IP addr (0 = unknown) */
343extern IPaddr_t NetServerIP; /* Server IP addr (0 = unknown) */
344extern volatile uchar * NetTxPacket; /* THE transmit packet */
345extern volatile uchar * NetRxPackets[PKTBUFSRX];/* Receive packets */
Mike Frysingerd9bec9f2009-07-18 21:04:08 -0400346extern volatile uchar * NetRxPacket; /* Current receive packet */
347extern int NetRxPacketLen; /* Current rx packet length */
wdenk2d966952002-10-31 22:12:35 +0000348extern unsigned NetIPID; /* IP ID (counting) */
349extern uchar NetBcastAddr[6]; /* Ethernet boardcast address */
wdenk68ceb292004-08-02 21:11:11 +0000350extern uchar NetEtherNullAddr[6];
wdenk2d966952002-10-31 22:12:35 +0000351
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200352#define VLAN_NONE 4095 /* untagged */
353#define VLAN_IDMASK 0x0fff /* mask of valid vlan id */
354extern ushort NetOurVLAN; /* Our VLAN */
355extern ushort NetOurNativeVLAN; /* Our Native VLAN */
wdenka3d991b2004-04-15 21:48:45 +0000356
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200357extern uchar NetCDPAddr[6]; /* Ethernet CDP address */
wdenka3d991b2004-04-15 21:48:45 +0000358extern ushort CDPNativeVLAN; /* CDP returned native VLAN */
359extern ushort CDPApplianceVLAN; /* CDP returned appliance VLAN */
360
wdenk2d966952002-10-31 22:12:35 +0000361extern int NetState; /* Network loop state */
362#define NETLOOP_CONTINUE 1
363#define NETLOOP_RESTART 2
364#define NETLOOP_SUCCESS 3
365#define NETLOOP_FAIL 4
366
wdenk2d966952002-10-31 22:12:35 +0000367extern int NetRestartWrap; /* Tried all network devices */
wdenk2d966952002-10-31 22:12:35 +0000368
Simon Glasse4bf0c52011-10-24 18:00:02 +0000369enum proto_t {
370 BOOTP, RARP, ARP, TFTPGET, DHCP, PING, DNS, NFS, CDP, NETCONS, SNTP,
Simon Glass58f317d2011-10-24 18:00:05 +0000371 TFTPSRV, TFTPPUT
Simon Glasse4bf0c52011-10-24 18:00:02 +0000372};
wdenk2d966952002-10-31 22:12:35 +0000373
374/* from net/net.c */
375extern char BootFile[128]; /* Boot File name */
376
Robin Getz1a32bf42009-07-20 14:53:54 -0400377#if defined(CONFIG_CMD_DNS)
378extern char *NetDNSResolve; /* The host to resolve */
379extern char *NetDNSenvvar; /* the env var to put the ip into */
380#endif
381
Jon Loeliger639221c2007-07-09 17:15:49 -0500382#if defined(CONFIG_CMD_PING)
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200383extern IPaddr_t NetPingIP; /* the ip address to ping */
wdenk73a8b272003-06-05 19:27:42 +0000384#endif
385
Jon Loeliger639221c2007-07-09 17:15:49 -0500386#if defined(CONFIG_CMD_CDP)
wdenka3d991b2004-04-15 21:48:45 +0000387/* when CDP completes these hold the return values */
388extern ushort CDPNativeVLAN;
389extern ushort CDPApplianceVLAN;
390#endif
391
Jon Loeliger639221c2007-07-09 17:15:49 -0500392#if defined(CONFIG_CMD_SNTP)
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200393extern IPaddr_t NetNtpServerIP; /* the ip address to NTP */
wdenkea287de2005-04-01 00:25:43 +0000394extern int NetTimeOffset; /* offset time from UTC */
395#endif
396
wdenk2d966952002-10-31 22:12:35 +0000397/* Initialize the network adapter */
Simon Glasse4bf0c52011-10-24 18:00:02 +0000398extern int NetLoop(enum proto_t);
wdenk2d966952002-10-31 22:12:35 +0000399
400/* Shutdown adapters and cleanup */
401extern void NetStop(void);
402
403/* Load failed. Start again. */
404extern void NetStartAgain(void);
405
wdenka3d991b2004-04-15 21:48:45 +0000406/* Get size of the ethernet header when we send */
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200407extern int NetEthHdrSize(void);
wdenka3d991b2004-04-15 21:48:45 +0000408
409/* Set ethernet header; returns the size of the header */
410extern int NetSetEther(volatile uchar *, uchar *, uint);
wdenk2d966952002-10-31 22:12:35 +0000411
412/* Set IP header */
413extern void NetSetIP(volatile uchar *, IPaddr_t, int, int, int);
414
415/* Checksum */
416extern int NetCksumOk(uchar *, int); /* Return true if cksum OK */
417extern uint NetCksum(uchar *, int); /* Calculate the checksum */
418
419/* Set callbacks */
420extern void NetSetHandler(rxhand_f *); /* Set RX packet handler */
Simon Glass4793ee62011-10-24 18:00:01 +0000421extern void net_set_icmp_handler(rxhand_icmp_f *f); /* Set ICMP RX handler */
wdenk3e01d752004-10-09 21:56:21 +0000422extern void NetSetTimeout(ulong, thand_f *);/* Set timeout handler */
wdenk2d966952002-10-31 22:12:35 +0000423
424/* Transmit "NetTxPacket" */
425extern void NetSendPacket(volatile uchar *, int);
426
wdenk73a8b272003-06-05 19:27:42 +0000427/* Transmit UDP packet, performing ARP request if needed */
428extern int NetSendUDPPacket(uchar *ether, IPaddr_t dest, int dport, int sport, int len);
429
wdenk2d966952002-10-31 22:12:35 +0000430/* Processes a received packet */
431extern void NetReceive(volatile uchar *, int);
432
wdenk2d966952002-10-31 22:12:35 +0000433/*
Simon Glasse4a3d572011-10-27 06:24:32 +0000434 * Check if autoload is enabled. If so, use either NFS or TFTP to download
435 * the boot file.
436 */
437void net_auto_load(void);
438
439/*
wdenk2d966952002-10-31 22:12:35 +0000440 * The following functions are a bit ugly, but necessary to deal with
441 * alignment restrictions on ARM.
442 *
443 * We're using inline functions, which had the smallest memory
444 * footprint in our tests.
445 */
446/* return IP *in network byteorder* */
Anatolij Gustschin33a4a702008-04-30 13:34:40 +0200447static inline IPaddr_t NetReadIP(volatile void *from)
wdenk2d966952002-10-31 22:12:35 +0000448{
449 IPaddr_t ip;
Anatolij Gustschin33a4a702008-04-30 13:34:40 +0200450 memcpy((void*)&ip, (void*)from, sizeof(ip));
wdenk2d966952002-10-31 22:12:35 +0000451 return ip;
452}
453
454/* return ulong *in network byteorder* */
455static inline ulong NetReadLong(ulong *from)
456{
457 ulong l;
458 memcpy((void*)&l, (void*)from, sizeof(l));
459 return l;
460}
461
462/* write IP *in network byteorder* */
463static inline void NetWriteIP(void *to, IPaddr_t ip)
464{
465 memcpy(to, (void*)&ip, sizeof(ip));
466}
467
468/* copy IP */
Anatolij Gustschin33a4a702008-04-30 13:34:40 +0200469static inline void NetCopyIP(volatile void *to, void *from)
wdenk2d966952002-10-31 22:12:35 +0000470{
Anatolij Gustschin33a4a702008-04-30 13:34:40 +0200471 memcpy((void*)to, from, sizeof(IPaddr_t));
wdenk2d966952002-10-31 22:12:35 +0000472}
473
474/* copy ulong */
475static inline void NetCopyLong(ulong *to, ulong *from)
476{
477 memcpy((void*)to, (void*)from, sizeof(ulong));
478}
479
Mike Rapoport50cca8b2007-08-12 08:48:27 +0300480/**
481 * is_zero_ether_addr - Determine if give Ethernet address is all zeros.
482 * @addr: Pointer to a six-byte array containing the Ethernet address
483 *
484 * Return true if the address is all zeroes.
485 */
486static inline int is_zero_ether_addr(const u8 *addr)
487{
488 return !(addr[0] | addr[1] | addr[2] | addr[3] | addr[4] | addr[5]);
489}
490
491/**
492 * is_multicast_ether_addr - Determine if the Ethernet address is a multicast.
493 * @addr: Pointer to a six-byte array containing the Ethernet address
494 *
495 * Return true if the address is a multicast address.
496 * By definition the broadcast address is also a multicast address.
497 */
498static inline int is_multicast_ether_addr(const u8 *addr)
499{
500 return (0x01 & addr[0]);
501}
502
Remy Bohmer23cd1382009-07-29 18:18:43 +0200503/*
504 * is_broadcast_ether_addr - Determine if the Ethernet address is broadcast
505 * @addr: Pointer to a six-byte array containing the Ethernet address
506 *
507 * Return true if the address is the broadcast address.
508 */
509static inline int is_broadcast_ether_addr(const u8 *addr)
510{
511 return (addr[0] & addr[1] & addr[2] & addr[3] & addr[4] & addr[5]) == 0xff;
512}
513
514/*
Mike Frysinger75edebe2009-01-27 16:53:39 -0500515 * is_valid_ether_addr - Determine if the given Ethernet address is valid
516 * @addr: Pointer to a six-byte array containing the Ethernet address
517 *
518 * Check that the Ethernet address (MAC) is not 00:00:00:00:00:00, is not
519 * a multicast address, and is not FF:FF:FF:FF:FF:FF.
520 *
521 * Return true if the address is valid.
522 */
Remy Bohmer23cd1382009-07-29 18:18:43 +0200523static inline int is_valid_ether_addr(const u8 *addr)
Mike Frysinger75edebe2009-01-27 16:53:39 -0500524{
525 /* FF:FF:FF:FF:FF:FF is a multicast address so we don't need to
526 * explicitly check for it here. */
527 return !is_multicast_ether_addr(addr) && !is_zero_ether_addr(addr);
528}
529
wdenk2d966952002-10-31 22:12:35 +0000530/* Convert an IP address to a string */
531extern void ip_to_string (IPaddr_t x, char *s);
532
wdenk73a8b272003-06-05 19:27:42 +0000533/* Convert a string to ip address */
Mike Frysinger908c6b62010-10-20 07:16:58 -0400534extern IPaddr_t string_to_ip(const char *s);
wdenk73a8b272003-06-05 19:27:42 +0000535
wdenka3d991b2004-04-15 21:48:45 +0000536/* Convert a VLAN id to a string */
537extern void VLAN_to_string (ushort x, char *s);
538
539/* Convert a string to a vlan id */
Mike Frysinger2e3ef6e2010-10-20 07:16:48 -0400540extern ushort string_to_VLAN(const char *s);
wdenka3d991b2004-04-15 21:48:45 +0000541
wdenka3d991b2004-04-15 21:48:45 +0000542/* read a VLAN id from an environment variable */
543extern ushort getenv_VLAN(char *);
544
wdenk2d966952002-10-31 22:12:35 +0000545/* copy a filename (allow for "..." notation, limit length) */
Mike Frysingerb920ee92010-10-20 07:16:40 -0400546extern void copy_filename (char *dst, const char *src, int size);
wdenk2d966952002-10-31 22:12:35 +0000547
Mike Frysinger91b469c2009-09-02 04:18:55 -0400548/* get a random source port */
549extern unsigned int random_port(void);
550
wdenk2d966952002-10-31 22:12:35 +0000551/**********************************************************************/
552
553#endif /* __NET_H__ */