blob: ad9afbf417d64a1b239a967c30d75e94049dc59a [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
36typedef ulong IPaddr_t;
37
38
Luca Ceresoli03eb1292011-04-18 06:19:50 +000039/**
40 * An incoming packet handler.
41 * @param pkt pointer to the application packet
42 * @param dport destination UDP port
43 * @param sip source IP address
44 * @param sport source UDP port
45 * @param len packet length
wdenk2d966952002-10-31 22:12:35 +000046 */
Luca Ceresoli03eb1292011-04-18 06:19:50 +000047typedef void rxhand_f(uchar *pkt, unsigned dport,
48 IPaddr_t sip, unsigned sport,
49 unsigned len);
wdenk2d966952002-10-31 22:12:35 +000050
Simon Glass4793ee62011-10-24 18:00:01 +000051/**
52 * An incoming ICMP packet handler.
53 * @param type ICMP type
54 * @param code ICMP code
55 * @param dport destination UDP port
56 * @param sip source IP address
57 * @param sport source UDP port
58 * @param pkt pointer to the ICMP packet data
59 * @param len packet length
60 */
61typedef void rxhand_icmp_f(unsigned type, unsigned code, unsigned dport,
62 IPaddr_t sip, unsigned sport, uchar *pkt, unsigned len);
63
wdenk2d966952002-10-31 22:12:35 +000064/*
65 * A timeout handler. Called after time interval has expired.
66 */
67typedef void thand_f(void);
68
wdenk2d966952002-10-31 22:12:35 +000069#define NAMESIZE 16
70
71enum eth_state_t {
72 ETH_STATE_INIT,
73 ETH_STATE_PASSIVE,
74 ETH_STATE_ACTIVE
75};
76
77struct eth_device {
78 char name[NAMESIZE];
79 unsigned char enetaddr[6];
80 int iobase;
81 int state;
82
83 int (*init) (struct eth_device*, bd_t*);
David Updegraff53a5c422007-06-11 10:41:07 -050084 int (*send) (struct eth_device*, volatile void* packet, int length);
wdenk2d966952002-10-31 22:12:35 +000085 int (*recv) (struct eth_device*);
86 void (*halt) (struct eth_device*);
David Updegraff53a5c422007-06-11 10:41:07 -050087#ifdef CONFIG_MCAST_TFTP
88 int (*mcast) (struct eth_device*, u32 ip, u8 set);
89#endif
Ben Warrenecee9322010-04-26 11:11:46 -070090 int (*write_hwaddr) (struct eth_device*);
wdenk2d966952002-10-31 22:12:35 +000091 struct eth_device *next;
92 void *priv;
93};
94
Andy Fleming5dc0cf62009-02-11 15:10:31 -060095extern int eth_initialize(bd_t *bis); /* Initialize network subsystem */
96extern int eth_register(struct eth_device* dev);/* Register network device */
97extern void eth_try_another(int first_restart); /* Change the device */
Andy Fleming5dc0cf62009-02-11 15:10:31 -060098extern void eth_set_current(void); /* set nterface to ethcur var */
Andy Fleming5dc0cf62009-02-11 15:10:31 -060099extern struct eth_device *eth_get_dev(void); /* get the current device MAC */
Ben Warrend7fb9bc2010-07-29 12:56:11 -0700100extern struct eth_device *eth_get_dev_by_name(const char *devname);
Andy Fleming5dc0cf62009-02-11 15:10:31 -0600101extern struct eth_device *eth_get_dev_by_index(int index); /* get dev @ index */
102extern int eth_get_dev_index (void); /* get the device index */
Mike Frysinger3f6e6992009-01-29 19:43:44 -0500103extern void eth_parse_enetaddr(const char *addr, uchar *enetaddr);
104extern int eth_getenv_enetaddr(char *name, uchar *enetaddr);
105extern int eth_setenv_enetaddr(char *name, const uchar *enetaddr);
Simon Glass7616e782011-06-13 16:13:10 -0700106
107/*
108 * Get the hardware address for an ethernet interface .
109 * Args:
110 * base_name - base name for device (normally "eth")
111 * index - device index number (0 for first)
112 * enetaddr - returns 6 byte hardware address
113 * Returns:
114 * Return true if the address is valid.
115 */
116extern int eth_getenv_enetaddr_by_index(const char *base_name, int index,
117 uchar *enetaddr);
wdenk2d966952002-10-31 22:12:35 +0000118
Remy Bohmer23cd1382009-07-29 18:18:43 +0200119extern int usb_eth_initialize(bd_t *bi);
Andy Fleming5dc0cf62009-02-11 15:10:31 -0600120extern int eth_init(bd_t *bis); /* Initialize the device */
121extern int eth_send(volatile void *packet, int length); /* Send a packet */
Remy Bohmer23cd1382009-07-29 18:18:43 +0200122
Rafal Jaworowskif85b6072007-12-27 18:19:02 +0100123#ifdef CONFIG_API
Andy Fleming5dc0cf62009-02-11 15:10:31 -0600124extern int eth_receive(volatile void *packet, int length); /* Receive a packet*/
Rafal Jaworowskif85b6072007-12-27 18:19:02 +0100125#endif
Andy Fleming5dc0cf62009-02-11 15:10:31 -0600126extern int eth_rx(void); /* Check for received packets */
127extern void eth_halt(void); /* stop SCC */
128extern char *eth_get_name(void); /* get name of current device */
wdenk2d966952002-10-31 22:12:35 +0000129
Simon Glass7616e782011-06-13 16:13:10 -0700130/*
131 * Set the hardware address for an ethernet interface based on 'eth%daddr'
132 * environment variable (or just 'ethaddr' if eth_number is 0).
133 * Args:
134 * base_name - base name for device (normally "eth")
135 * eth_number - value of %d (0 for first device of this type)
136 * Returns:
137 * 0 is success, non-zero is error status from driver.
138 */
139int eth_write_hwaddr(struct eth_device *dev, const char *base_name,
140 int eth_number);
141
David Updegraff53a5c422007-06-11 10:41:07 -0500142#ifdef CONFIG_MCAST_TFTP
143int eth_mcast_join( IPaddr_t mcast_addr, u8 join);
144u32 ether_crc (size_t len, unsigned char const *p);
145#endif
146
wdenk2d966952002-10-31 22:12:35 +0000147
148/**********************************************************************/
149/*
150 * Protocol headers.
151 */
152
153/*
154 * Ethernet header
155 */
156typedef struct {
157 uchar et_dest[6]; /* Destination node */
158 uchar et_src[6]; /* Source node */
159 ushort et_protlen; /* Protocol or length */
160 uchar et_dsap; /* 802 DSAP */
161 uchar et_ssap; /* 802 SSAP */
162 uchar et_ctl; /* 802 control */
163 uchar et_snap1; /* SNAP */
164 uchar et_snap2;
165 uchar et_snap3;
166 ushort et_prot; /* 802 protocol */
167} Ethernet_t;
168
169#define ETHER_HDR_SIZE 14 /* Ethernet header size */
170#define E802_HDR_SIZE 22 /* 802 ethernet header size */
wdenka3d991b2004-04-15 21:48:45 +0000171
172/*
173 * Ethernet header
174 */
175typedef struct {
176 uchar vet_dest[6]; /* Destination node */
177 uchar vet_src[6]; /* Source node */
178 ushort vet_vlan_type; /* PROT_VLAN */
179 ushort vet_tag; /* TAG of VLAN */
180 ushort vet_type; /* protocol type */
181} VLAN_Ethernet_t;
182
183#define VLAN_ETHER_HDR_SIZE 18 /* VLAN Ethernet header size */
184
wdenk2d966952002-10-31 22:12:35 +0000185#define PROT_IP 0x0800 /* IP protocol */
186#define PROT_ARP 0x0806 /* IP ARP protocol */
187#define PROT_RARP 0x8035 /* IP ARP protocol */
wdenka3d991b2004-04-15 21:48:45 +0000188#define PROT_VLAN 0x8100 /* IEEE 802.1q protocol */
wdenk2d966952002-10-31 22:12:35 +0000189
190#define IPPROTO_ICMP 1 /* Internet Control Message Protocol */
191#define IPPROTO_UDP 17 /* User Datagram Protocol */
192
193/*
194 * Internet Protocol (IP) header.
195 */
196typedef struct {
197 uchar ip_hl_v; /* header length and version */
198 uchar ip_tos; /* type of service */
199 ushort ip_len; /* total length */
200 ushort ip_id; /* identification */
201 ushort ip_off; /* fragment offset field */
202 uchar ip_ttl; /* time to live */
203 uchar ip_p; /* protocol */
204 ushort ip_sum; /* checksum */
205 IPaddr_t ip_src; /* Source IP address */
206 IPaddr_t ip_dst; /* Destination IP address */
207 ushort udp_src; /* UDP source port */
208 ushort udp_dst; /* UDP destination port */
209 ushort udp_len; /* Length of UDP packet */
210 ushort udp_xsum; /* Checksum */
211} IP_t;
212
Peter Tysere0c07b82008-12-01 16:26:20 -0600213#define IP_OFFS 0x1fff /* ip offset *= 8 */
214#define IP_FLAGS 0xe000 /* first 3 bits */
215#define IP_FLAGS_RES 0x8000 /* reserved */
216#define IP_FLAGS_DFRAG 0x4000 /* don't fragments */
217#define IP_FLAGS_MFRAG 0x2000 /* more fragments */
218
wdenk2d966952002-10-31 22:12:35 +0000219#define IP_HDR_SIZE_NO_UDP (sizeof (IP_t) - 8)
220#define IP_HDR_SIZE (sizeof (IP_t))
221
222
223/*
224 * Address Resolution Protocol (ARP) header.
225 */
226typedef struct
227{
228 ushort ar_hrd; /* Format of hardware address */
229# define ARP_ETHER 1 /* Ethernet hardware address */
230 ushort ar_pro; /* Format of protocol address */
231 uchar ar_hln; /* Length of hardware address */
232 uchar ar_pln; /* Length of protocol address */
233 ushort ar_op; /* Operation */
234# define ARPOP_REQUEST 1 /* Request to resolve address */
235# define ARPOP_REPLY 2 /* Response to previous request */
236
237# define RARPOP_REQUEST 3 /* Request to resolve address */
238# define RARPOP_REPLY 4 /* Response to previous request */
239
240 /*
wdenk8bde7f72003-06-27 21:31:46 +0000241 * The remaining fields are variable in size, according to
242 * the sizes above, and are defined as appropriate for
243 * specific hardware/protocol combinations.
wdenk2d966952002-10-31 22:12:35 +0000244 */
245 uchar ar_data[0];
246#if 0
247 uchar ar_sha[]; /* Sender hardware address */
248 uchar ar_spa[]; /* Sender protocol address */
249 uchar ar_tha[]; /* Target hardware address */
250 uchar ar_tpa[]; /* Target protocol address */
251#endif /* 0 */
252} ARP_t;
253
254#define ARP_HDR_SIZE (8+20) /* Size assuming ethernet */
255
256/*
257 * ICMP stuff (just enough to handle (host) redirect messages)
258 */
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200259#define ICMP_ECHO_REPLY 0 /* Echo reply */
Simon Glass4793ee62011-10-24 18:00:01 +0000260#define ICMP_NOT_REACH 3 /* Detination unreachable */
wdenk2d966952002-10-31 22:12:35 +0000261#define ICMP_REDIRECT 5 /* Redirect (change route) */
wdenk73a8b272003-06-05 19:27:42 +0000262#define ICMP_ECHO_REQUEST 8 /* Echo request */
wdenk2d966952002-10-31 22:12:35 +0000263
264/* Codes for REDIRECT. */
265#define ICMP_REDIR_NET 0 /* Redirect Net */
266#define ICMP_REDIR_HOST 1 /* Redirect Host */
267
Simon Glass4793ee62011-10-24 18:00:01 +0000268/* Codes for NOT_REACH */
269#define ICMP_NOT_REACH_PORT 3 /* Port unreachable */
270
wdenk2d966952002-10-31 22:12:35 +0000271typedef struct icmphdr {
272 uchar type;
273 uchar code;
274 ushort checksum;
275 union {
276 struct {
277 ushort id;
278 ushort sequence;
279 } echo;
280 ulong gateway;
281 struct {
282 ushort __unused;
283 ushort mtu;
284 } frag;
Simon Glass4793ee62011-10-24 18:00:01 +0000285 uchar data[0];
wdenk2d966952002-10-31 22:12:35 +0000286 } un;
287} ICMP_t;
288
289
wdenk2d966952002-10-31 22:12:35 +0000290/*
291 * Maximum packet size; used to allocate packet storage.
292 * TFTP packets can be 524 bytes + IP header + ethernet header.
293 * Lets be conservative, and go for 38 * 16. (Must also be
294 * a multiple of 32 bytes).
295 */
296/*
297 * AS.HARNOIS : Better to set PKTSIZE to maximum size because
298 * traffic type is not always controlled
299 * maximum packet size = 1518
300 * maximum packet size and multiple of 32 bytes = 1536
301 */
302#define PKTSIZE 1518
303#define PKTSIZE_ALIGN 1536
304/*#define PKTSIZE 608*/
305
306/*
307 * Maximum receive ring size; that is, the number of packets
308 * we can buffer before overflow happens. Basically, this just
309 * needs to be enough to prevent a packet being discarded while
310 * we are processing the previous one.
311 */
312#define RINGSZ 4
313#define RINGSZ_LOG2 2
314
315/**********************************************************************/
316/*
317 * Globals.
318 *
319 * Note:
320 *
321 * All variables of type IPaddr_t are stored in NETWORK byte order
322 * (big endian).
323 */
324
325/* net.c */
326/** BOOTP EXTENTIONS **/
327extern IPaddr_t NetOurGatewayIP; /* Our gateway IP addresse */
328extern IPaddr_t NetOurSubnetMask; /* Our subnet mask (0 = unknown)*/
329extern IPaddr_t NetOurDNSIP; /* Our Domain Name Server (0 = unknown)*/
Jon Loeliger1fe80d72007-07-09 22:08:34 -0500330#if defined(CONFIG_BOOTP_DNS2)
stroesefe389a82003-08-28 14:17:32 +0000331extern IPaddr_t NetOurDNS2IP; /* Our 2nd Domain Name Server (0 = unknown)*/
332#endif
wdenk2d966952002-10-31 22:12:35 +0000333extern char NetOurNISDomain[32]; /* Our NIS domain */
334extern char NetOurHostName[32]; /* Our hostname */
335extern char NetOurRootPath[64]; /* Our root path */
336extern ushort NetBootFileSize; /* Our boot file size in blocks */
337/** END OF BOOTP EXTENTIONS **/
338extern ulong NetBootFileXferSize; /* size of bootfile in bytes */
339extern uchar NetOurEther[6]; /* Our ethernet address */
340extern uchar NetServerEther[6]; /* Boot server enet address */
341extern IPaddr_t NetOurIP; /* Our IP addr (0 = unknown) */
342extern IPaddr_t NetServerIP; /* Server IP addr (0 = unknown) */
343extern volatile uchar * NetTxPacket; /* THE transmit packet */
344extern volatile uchar * NetRxPackets[PKTBUFSRX];/* Receive packets */
Mike Frysingerd9bec9f2009-07-18 21:04:08 -0400345extern volatile uchar * NetRxPacket; /* Current receive packet */
346extern int NetRxPacketLen; /* Current rx packet length */
wdenk2d966952002-10-31 22:12:35 +0000347extern unsigned NetIPID; /* IP ID (counting) */
348extern uchar NetBcastAddr[6]; /* Ethernet boardcast address */
wdenk68ceb292004-08-02 21:11:11 +0000349extern uchar NetEtherNullAddr[6];
wdenk2d966952002-10-31 22:12:35 +0000350
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200351#define VLAN_NONE 4095 /* untagged */
352#define VLAN_IDMASK 0x0fff /* mask of valid vlan id */
353extern ushort NetOurVLAN; /* Our VLAN */
354extern ushort NetOurNativeVLAN; /* Our Native VLAN */
wdenka3d991b2004-04-15 21:48:45 +0000355
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200356extern uchar NetCDPAddr[6]; /* Ethernet CDP address */
wdenka3d991b2004-04-15 21:48:45 +0000357extern ushort CDPNativeVLAN; /* CDP returned native VLAN */
358extern ushort CDPApplianceVLAN; /* CDP returned appliance VLAN */
359
wdenk2d966952002-10-31 22:12:35 +0000360extern int NetState; /* Network loop state */
361#define NETLOOP_CONTINUE 1
362#define NETLOOP_RESTART 2
363#define NETLOOP_SUCCESS 3
364#define NETLOOP_FAIL 4
365
wdenk2d966952002-10-31 22:12:35 +0000366extern int NetRestartWrap; /* Tried all network devices */
wdenk2d966952002-10-31 22:12:35 +0000367
Simon Glasse4bf0c52011-10-24 18:00:02 +0000368enum proto_t {
369 BOOTP, RARP, ARP, TFTPGET, DHCP, PING, DNS, NFS, CDP, NETCONS, SNTP,
Simon Glass58f317d2011-10-24 18:00:05 +0000370 TFTPSRV, TFTPPUT
Simon Glasse4bf0c52011-10-24 18:00:02 +0000371};
wdenk2d966952002-10-31 22:12:35 +0000372
373/* from net/net.c */
374extern char BootFile[128]; /* Boot File name */
375
Robin Getz1a32bf42009-07-20 14:53:54 -0400376#if defined(CONFIG_CMD_DNS)
377extern char *NetDNSResolve; /* The host to resolve */
378extern char *NetDNSenvvar; /* the env var to put the ip into */
379#endif
380
Jon Loeliger639221c2007-07-09 17:15:49 -0500381#if defined(CONFIG_CMD_PING)
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200382extern IPaddr_t NetPingIP; /* the ip address to ping */
wdenk73a8b272003-06-05 19:27:42 +0000383#endif
384
Jon Loeliger639221c2007-07-09 17:15:49 -0500385#if defined(CONFIG_CMD_CDP)
wdenka3d991b2004-04-15 21:48:45 +0000386/* when CDP completes these hold the return values */
387extern ushort CDPNativeVLAN;
388extern ushort CDPApplianceVLAN;
389#endif
390
Jon Loeliger639221c2007-07-09 17:15:49 -0500391#if defined(CONFIG_CMD_SNTP)
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200392extern IPaddr_t NetNtpServerIP; /* the ip address to NTP */
wdenkea287de2005-04-01 00:25:43 +0000393extern int NetTimeOffset; /* offset time from UTC */
394#endif
395
wdenk2d966952002-10-31 22:12:35 +0000396/* Initialize the network adapter */
Simon Glasse4bf0c52011-10-24 18:00:02 +0000397extern int NetLoop(enum proto_t);
wdenk2d966952002-10-31 22:12:35 +0000398
399/* Shutdown adapters and cleanup */
400extern void NetStop(void);
401
402/* Load failed. Start again. */
403extern void NetStartAgain(void);
404
wdenka3d991b2004-04-15 21:48:45 +0000405/* Get size of the ethernet header when we send */
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200406extern int NetEthHdrSize(void);
wdenka3d991b2004-04-15 21:48:45 +0000407
408/* Set ethernet header; returns the size of the header */
409extern int NetSetEther(volatile uchar *, uchar *, uint);
wdenk2d966952002-10-31 22:12:35 +0000410
411/* Set IP header */
412extern void NetSetIP(volatile uchar *, IPaddr_t, int, int, int);
413
414/* Checksum */
415extern int NetCksumOk(uchar *, int); /* Return true if cksum OK */
416extern uint NetCksum(uchar *, int); /* Calculate the checksum */
417
418/* Set callbacks */
419extern void NetSetHandler(rxhand_f *); /* Set RX packet handler */
Simon Glass4793ee62011-10-24 18:00:01 +0000420extern void net_set_icmp_handler(rxhand_icmp_f *f); /* Set ICMP RX handler */
wdenk3e01d752004-10-09 21:56:21 +0000421extern void NetSetTimeout(ulong, thand_f *);/* Set timeout handler */
wdenk2d966952002-10-31 22:12:35 +0000422
423/* Transmit "NetTxPacket" */
424extern void NetSendPacket(volatile uchar *, int);
425
wdenk73a8b272003-06-05 19:27:42 +0000426/* Transmit UDP packet, performing ARP request if needed */
427extern int NetSendUDPPacket(uchar *ether, IPaddr_t dest, int dport, int sport, int len);
428
wdenk2d966952002-10-31 22:12:35 +0000429/* Processes a received packet */
430extern void NetReceive(volatile uchar *, int);
431
wdenk2d966952002-10-31 22:12:35 +0000432/*
Simon Glasse4a3d572011-10-27 06:24:32 +0000433 * Check if autoload is enabled. If so, use either NFS or TFTP to download
434 * the boot file.
435 */
436void net_auto_load(void);
437
438/*
wdenk2d966952002-10-31 22:12:35 +0000439 * The following functions are a bit ugly, but necessary to deal with
440 * alignment restrictions on ARM.
441 *
442 * We're using inline functions, which had the smallest memory
443 * footprint in our tests.
444 */
445/* return IP *in network byteorder* */
Anatolij Gustschin33a4a702008-04-30 13:34:40 +0200446static inline IPaddr_t NetReadIP(volatile void *from)
wdenk2d966952002-10-31 22:12:35 +0000447{
448 IPaddr_t ip;
Anatolij Gustschin33a4a702008-04-30 13:34:40 +0200449 memcpy((void*)&ip, (void*)from, sizeof(ip));
wdenk2d966952002-10-31 22:12:35 +0000450 return ip;
451}
452
453/* return ulong *in network byteorder* */
454static inline ulong NetReadLong(ulong *from)
455{
456 ulong l;
457 memcpy((void*)&l, (void*)from, sizeof(l));
458 return l;
459}
460
461/* write IP *in network byteorder* */
462static inline void NetWriteIP(void *to, IPaddr_t ip)
463{
464 memcpy(to, (void*)&ip, sizeof(ip));
465}
466
467/* copy IP */
Anatolij Gustschin33a4a702008-04-30 13:34:40 +0200468static inline void NetCopyIP(volatile void *to, void *from)
wdenk2d966952002-10-31 22:12:35 +0000469{
Anatolij Gustschin33a4a702008-04-30 13:34:40 +0200470 memcpy((void*)to, from, sizeof(IPaddr_t));
wdenk2d966952002-10-31 22:12:35 +0000471}
472
473/* copy ulong */
474static inline void NetCopyLong(ulong *to, ulong *from)
475{
476 memcpy((void*)to, (void*)from, sizeof(ulong));
477}
478
Mike Rapoport50cca8b2007-08-12 08:48:27 +0300479/**
480 * is_zero_ether_addr - Determine if give Ethernet address is all zeros.
481 * @addr: Pointer to a six-byte array containing the Ethernet address
482 *
483 * Return true if the address is all zeroes.
484 */
485static inline int is_zero_ether_addr(const u8 *addr)
486{
487 return !(addr[0] | addr[1] | addr[2] | addr[3] | addr[4] | addr[5]);
488}
489
490/**
491 * is_multicast_ether_addr - Determine if the Ethernet address is a multicast.
492 * @addr: Pointer to a six-byte array containing the Ethernet address
493 *
494 * Return true if the address is a multicast address.
495 * By definition the broadcast address is also a multicast address.
496 */
497static inline int is_multicast_ether_addr(const u8 *addr)
498{
499 return (0x01 & addr[0]);
500}
501
Remy Bohmer23cd1382009-07-29 18:18:43 +0200502/*
503 * is_broadcast_ether_addr - Determine if the Ethernet address is broadcast
504 * @addr: Pointer to a six-byte array containing the Ethernet address
505 *
506 * Return true if the address is the broadcast address.
507 */
508static inline int is_broadcast_ether_addr(const u8 *addr)
509{
510 return (addr[0] & addr[1] & addr[2] & addr[3] & addr[4] & addr[5]) == 0xff;
511}
512
513/*
Mike Frysinger75edebe2009-01-27 16:53:39 -0500514 * is_valid_ether_addr - Determine if the given Ethernet address is valid
515 * @addr: Pointer to a six-byte array containing the Ethernet address
516 *
517 * Check that the Ethernet address (MAC) is not 00:00:00:00:00:00, is not
518 * a multicast address, and is not FF:FF:FF:FF:FF:FF.
519 *
520 * Return true if the address is valid.
521 */
Remy Bohmer23cd1382009-07-29 18:18:43 +0200522static inline int is_valid_ether_addr(const u8 *addr)
Mike Frysinger75edebe2009-01-27 16:53:39 -0500523{
524 /* FF:FF:FF:FF:FF:FF is a multicast address so we don't need to
525 * explicitly check for it here. */
526 return !is_multicast_ether_addr(addr) && !is_zero_ether_addr(addr);
527}
528
wdenk2d966952002-10-31 22:12:35 +0000529/* Convert an IP address to a string */
530extern void ip_to_string (IPaddr_t x, char *s);
531
wdenk73a8b272003-06-05 19:27:42 +0000532/* Convert a string to ip address */
Mike Frysinger908c6b62010-10-20 07:16:58 -0400533extern IPaddr_t string_to_ip(const char *s);
wdenk73a8b272003-06-05 19:27:42 +0000534
wdenka3d991b2004-04-15 21:48:45 +0000535/* Convert a VLAN id to a string */
536extern void VLAN_to_string (ushort x, char *s);
537
538/* Convert a string to a vlan id */
Mike Frysinger2e3ef6e2010-10-20 07:16:48 -0400539extern ushort string_to_VLAN(const char *s);
wdenka3d991b2004-04-15 21:48:45 +0000540
wdenka3d991b2004-04-15 21:48:45 +0000541/* read a VLAN id from an environment variable */
542extern ushort getenv_VLAN(char *);
543
wdenk2d966952002-10-31 22:12:35 +0000544/* copy a filename (allow for "..." notation, limit length) */
Mike Frysingerb920ee92010-10-20 07:16:40 -0400545extern void copy_filename (char *dst, const char *src, int size);
wdenk2d966952002-10-31 22:12:35 +0000546
Mike Frysinger91b469c2009-09-02 04:18:55 -0400547/* get a random source port */
548extern unsigned int random_port(void);
549
wdenk2d966952002-10-31 22:12:35 +0000550/**********************************************************************/
551
552#endif /* __NET_H__ */