blob: ee11f82ccc87acf426b95f78337bb2de52d77abd [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
Eric Nelson2c4b3c12012-03-15 18:33:24 +000019#include <asm/cache.h>
wdenk2d966952002-10-31 22:12:35 +000020#include <asm/byteorder.h> /* for nton* / ntoh* stuff */
21
22
23/*
24 * The number of receive packet buffers, and the required packet buffer
25 * alignment in memory.
26 *
27 */
28
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +020029#ifdef CONFIG_SYS_RX_ETH_BUFFER
30# define PKTBUFSRX CONFIG_SYS_RX_ETH_BUFFER
wdenk1d0350e2002-11-11 21:14:20 +000031#else
stroesec6028832003-06-05 15:38:29 +000032# define PKTBUFSRX 4
wdenk1d0350e2002-11-11 21:14:20 +000033#endif
34
Eric Nelson2c4b3c12012-03-15 18:33:24 +000035#define PKTALIGN ARCH_DMA_MINALIGN
wdenk2d966952002-10-31 22:12:35 +000036
Matthias Weisserea45cb02011-12-03 03:29:44 +000037/* IPv4 addresses are always 32 bits in size */
38typedef u32 IPaddr_t;
wdenk2d966952002-10-31 22:12:35 +000039
40
Luca Ceresoli03eb1292011-04-18 06:19:50 +000041/**
42 * An incoming packet handler.
43 * @param pkt pointer to the application packet
44 * @param dport destination UDP port
45 * @param sip source IP address
46 * @param sport source UDP port
47 * @param len packet length
wdenk2d966952002-10-31 22:12:35 +000048 */
Luca Ceresoli03eb1292011-04-18 06:19:50 +000049typedef void rxhand_f(uchar *pkt, unsigned dport,
50 IPaddr_t sip, unsigned sport,
51 unsigned len);
wdenk2d966952002-10-31 22:12:35 +000052
Simon Glass4793ee62011-10-24 18:00:01 +000053/**
54 * An incoming ICMP packet handler.
55 * @param type ICMP type
56 * @param code ICMP code
57 * @param dport destination UDP port
58 * @param sip source IP address
59 * @param sport source UDP port
60 * @param pkt pointer to the ICMP packet data
61 * @param len packet length
62 */
63typedef void rxhand_icmp_f(unsigned type, unsigned code, unsigned dport,
64 IPaddr_t sip, unsigned sport, uchar *pkt, unsigned len);
65
wdenk2d966952002-10-31 22:12:35 +000066/*
67 * A timeout handler. Called after time interval has expired.
68 */
69typedef void thand_f(void);
70
wdenk2d966952002-10-31 22:12:35 +000071enum eth_state_t {
72 ETH_STATE_INIT,
73 ETH_STATE_PASSIVE,
74 ETH_STATE_ACTIVE
75};
76
77struct eth_device {
Mike Frysingerf6add132011-11-10 14:11:04 +000078 char name[16];
wdenk2d966952002-10-31 22:12:35 +000079 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;
Michael Wallefea7dca2011-10-27 11:31:35 +000092 int index;
wdenk2d966952002-10-31 22:12:35 +000093 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 */
Vincent Palatine7e982d2012-01-09 08:32:36 +000098extern int eth_unregister(struct eth_device *dev);/* Remove network device */
Andy Fleming5dc0cf62009-02-11 15:10:31 -060099extern void eth_try_another(int first_restart); /* Change the device */
Andy Fleming5dc0cf62009-02-11 15:10:31 -0600100extern void eth_set_current(void); /* set nterface to ethcur var */
Andy Fleming5dc0cf62009-02-11 15:10:31 -0600101extern struct eth_device *eth_get_dev(void); /* get the current device MAC */
Ben Warrend7fb9bc2010-07-29 12:56:11 -0700102extern struct eth_device *eth_get_dev_by_name(const char *devname);
Andy Fleming5dc0cf62009-02-11 15:10:31 -0600103extern struct eth_device *eth_get_dev_by_index(int index); /* get dev @ index */
104extern int eth_get_dev_index (void); /* get the device index */
Mike Frysinger3f6e6992009-01-29 19:43:44 -0500105extern void eth_parse_enetaddr(const char *addr, uchar *enetaddr);
106extern int eth_getenv_enetaddr(char *name, uchar *enetaddr);
107extern int eth_setenv_enetaddr(char *name, const uchar *enetaddr);
Simon Glass7616e782011-06-13 16:13:10 -0700108
109/*
110 * Get the hardware address for an ethernet interface .
111 * Args:
112 * base_name - base name for device (normally "eth")
113 * index - device index number (0 for first)
114 * enetaddr - returns 6 byte hardware address
115 * Returns:
116 * Return true if the address is valid.
117 */
118extern int eth_getenv_enetaddr_by_index(const char *base_name, int index,
119 uchar *enetaddr);
wdenk2d966952002-10-31 22:12:35 +0000120
Remy Bohmer23cd1382009-07-29 18:18:43 +0200121extern int usb_eth_initialize(bd_t *bi);
Andy Fleming5dc0cf62009-02-11 15:10:31 -0600122extern int eth_init(bd_t *bis); /* Initialize the device */
123extern int eth_send(volatile void *packet, int length); /* Send a packet */
Remy Bohmer23cd1382009-07-29 18:18:43 +0200124
Rafal Jaworowskif85b6072007-12-27 18:19:02 +0100125#ifdef CONFIG_API
Andy Fleming5dc0cf62009-02-11 15:10:31 -0600126extern int eth_receive(volatile void *packet, int length); /* Receive a packet*/
Rafal Jaworowskif85b6072007-12-27 18:19:02 +0100127#endif
Andy Fleming5dc0cf62009-02-11 15:10:31 -0600128extern int eth_rx(void); /* Check for received packets */
129extern void eth_halt(void); /* stop SCC */
130extern char *eth_get_name(void); /* get name of current device */
wdenk2d966952002-10-31 22:12:35 +0000131
Simon Glass7616e782011-06-13 16:13:10 -0700132/*
133 * Set the hardware address for an ethernet interface based on 'eth%daddr'
134 * environment variable (or just 'ethaddr' if eth_number is 0).
135 * Args:
136 * base_name - base name for device (normally "eth")
137 * eth_number - value of %d (0 for first device of this type)
138 * Returns:
139 * 0 is success, non-zero is error status from driver.
140 */
141int eth_write_hwaddr(struct eth_device *dev, const char *base_name,
142 int eth_number);
143
David Updegraff53a5c422007-06-11 10:41:07 -0500144#ifdef CONFIG_MCAST_TFTP
145int eth_mcast_join( IPaddr_t mcast_addr, u8 join);
146u32 ether_crc (size_t len, unsigned char const *p);
147#endif
148
wdenk2d966952002-10-31 22:12:35 +0000149
150/**********************************************************************/
151/*
152 * Protocol headers.
153 */
154
155/*
156 * Ethernet header
157 */
158typedef struct {
159 uchar et_dest[6]; /* Destination node */
160 uchar et_src[6]; /* Source node */
161 ushort et_protlen; /* Protocol or length */
162 uchar et_dsap; /* 802 DSAP */
163 uchar et_ssap; /* 802 SSAP */
164 uchar et_ctl; /* 802 control */
165 uchar et_snap1; /* SNAP */
166 uchar et_snap2;
167 uchar et_snap3;
168 ushort et_prot; /* 802 protocol */
169} Ethernet_t;
170
171#define ETHER_HDR_SIZE 14 /* Ethernet header size */
172#define E802_HDR_SIZE 22 /* 802 ethernet header size */
wdenka3d991b2004-04-15 21:48:45 +0000173
174/*
175 * Ethernet header
176 */
177typedef struct {
178 uchar vet_dest[6]; /* Destination node */
179 uchar vet_src[6]; /* Source node */
180 ushort vet_vlan_type; /* PROT_VLAN */
181 ushort vet_tag; /* TAG of VLAN */
182 ushort vet_type; /* protocol type */
183} VLAN_Ethernet_t;
184
185#define VLAN_ETHER_HDR_SIZE 18 /* VLAN Ethernet header size */
186
wdenk2d966952002-10-31 22:12:35 +0000187#define PROT_IP 0x0800 /* IP protocol */
188#define PROT_ARP 0x0806 /* IP ARP protocol */
189#define PROT_RARP 0x8035 /* IP ARP protocol */
wdenka3d991b2004-04-15 21:48:45 +0000190#define PROT_VLAN 0x8100 /* IEEE 802.1q protocol */
wdenk2d966952002-10-31 22:12:35 +0000191
192#define IPPROTO_ICMP 1 /* Internet Control Message Protocol */
193#define IPPROTO_UDP 17 /* User Datagram Protocol */
194
195/*
196 * Internet Protocol (IP) header.
197 */
198typedef struct {
199 uchar ip_hl_v; /* header length and version */
200 uchar ip_tos; /* type of service */
201 ushort ip_len; /* total length */
202 ushort ip_id; /* identification */
203 ushort ip_off; /* fragment offset field */
204 uchar ip_ttl; /* time to live */
205 uchar ip_p; /* protocol */
206 ushort ip_sum; /* checksum */
207 IPaddr_t ip_src; /* Source IP address */
208 IPaddr_t ip_dst; /* Destination IP address */
209 ushort udp_src; /* UDP source port */
210 ushort udp_dst; /* UDP destination port */
211 ushort udp_len; /* Length of UDP packet */
212 ushort udp_xsum; /* Checksum */
213} IP_t;
214
Peter Tysere0c07b82008-12-01 16:26:20 -0600215#define IP_OFFS 0x1fff /* ip offset *= 8 */
216#define IP_FLAGS 0xe000 /* first 3 bits */
217#define IP_FLAGS_RES 0x8000 /* reserved */
218#define IP_FLAGS_DFRAG 0x4000 /* don't fragments */
219#define IP_FLAGS_MFRAG 0x2000 /* more fragments */
220
wdenk2d966952002-10-31 22:12:35 +0000221#define IP_HDR_SIZE_NO_UDP (sizeof (IP_t) - 8)
222#define IP_HDR_SIZE (sizeof (IP_t))
223
224
225/*
226 * Address Resolution Protocol (ARP) header.
227 */
228typedef struct
229{
230 ushort ar_hrd; /* Format of hardware address */
231# define ARP_ETHER 1 /* Ethernet hardware address */
232 ushort ar_pro; /* Format of protocol address */
233 uchar ar_hln; /* Length of hardware address */
234 uchar ar_pln; /* Length of protocol address */
235 ushort ar_op; /* Operation */
236# define ARPOP_REQUEST 1 /* Request to resolve address */
237# define ARPOP_REPLY 2 /* Response to previous request */
238
239# define RARPOP_REQUEST 3 /* Request to resolve address */
240# define RARPOP_REPLY 4 /* Response to previous request */
241
242 /*
wdenk8bde7f72003-06-27 21:31:46 +0000243 * The remaining fields are variable in size, according to
244 * the sizes above, and are defined as appropriate for
245 * specific hardware/protocol combinations.
wdenk2d966952002-10-31 22:12:35 +0000246 */
247 uchar ar_data[0];
248#if 0
249 uchar ar_sha[]; /* Sender hardware address */
250 uchar ar_spa[]; /* Sender protocol address */
251 uchar ar_tha[]; /* Target hardware address */
252 uchar ar_tpa[]; /* Target protocol address */
253#endif /* 0 */
254} ARP_t;
255
256#define ARP_HDR_SIZE (8+20) /* Size assuming ethernet */
257
258/*
259 * ICMP stuff (just enough to handle (host) redirect messages)
260 */
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200261#define ICMP_ECHO_REPLY 0 /* Echo reply */
Simon Glass4793ee62011-10-24 18:00:01 +0000262#define ICMP_NOT_REACH 3 /* Detination unreachable */
wdenk2d966952002-10-31 22:12:35 +0000263#define ICMP_REDIRECT 5 /* Redirect (change route) */
wdenk73a8b272003-06-05 19:27:42 +0000264#define ICMP_ECHO_REQUEST 8 /* Echo request */
wdenk2d966952002-10-31 22:12:35 +0000265
266/* Codes for REDIRECT. */
267#define ICMP_REDIR_NET 0 /* Redirect Net */
268#define ICMP_REDIR_HOST 1 /* Redirect Host */
269
Simon Glass4793ee62011-10-24 18:00:01 +0000270/* Codes for NOT_REACH */
271#define ICMP_NOT_REACH_PORT 3 /* Port unreachable */
272
wdenk2d966952002-10-31 22:12:35 +0000273typedef struct icmphdr {
274 uchar type;
275 uchar code;
276 ushort checksum;
277 union {
278 struct {
279 ushort id;
280 ushort sequence;
281 } echo;
282 ulong gateway;
283 struct {
284 ushort __unused;
285 ushort mtu;
286 } frag;
Simon Glass4793ee62011-10-24 18:00:01 +0000287 uchar data[0];
wdenk2d966952002-10-31 22:12:35 +0000288 } un;
289} ICMP_t;
290
291
wdenk2d966952002-10-31 22:12:35 +0000292/*
293 * Maximum packet size; used to allocate packet storage.
294 * TFTP packets can be 524 bytes + IP header + ethernet header.
295 * Lets be conservative, and go for 38 * 16. (Must also be
296 * a multiple of 32 bytes).
297 */
298/*
299 * AS.HARNOIS : Better to set PKTSIZE to maximum size because
300 * traffic type is not always controlled
301 * maximum packet size = 1518
302 * maximum packet size and multiple of 32 bytes = 1536
303 */
304#define PKTSIZE 1518
305#define PKTSIZE_ALIGN 1536
306/*#define PKTSIZE 608*/
307
308/*
309 * Maximum receive ring size; that is, the number of packets
310 * we can buffer before overflow happens. Basically, this just
311 * needs to be enough to prevent a packet being discarded while
312 * we are processing the previous one.
313 */
314#define RINGSZ 4
315#define RINGSZ_LOG2 2
316
317/**********************************************************************/
318/*
319 * Globals.
320 *
321 * Note:
322 *
323 * All variables of type IPaddr_t are stored in NETWORK byte order
324 * (big endian).
325 */
326
327/* net.c */
328/** BOOTP EXTENTIONS **/
329extern IPaddr_t NetOurGatewayIP; /* Our gateway IP addresse */
330extern IPaddr_t NetOurSubnetMask; /* Our subnet mask (0 = unknown)*/
331extern IPaddr_t NetOurDNSIP; /* Our Domain Name Server (0 = unknown)*/
Jon Loeliger1fe80d72007-07-09 22:08:34 -0500332#if defined(CONFIG_BOOTP_DNS2)
stroesefe389a82003-08-28 14:17:32 +0000333extern IPaddr_t NetOurDNS2IP; /* Our 2nd Domain Name Server (0 = unknown)*/
334#endif
wdenk2d966952002-10-31 22:12:35 +0000335extern char NetOurNISDomain[32]; /* Our NIS domain */
336extern char NetOurHostName[32]; /* Our hostname */
337extern char NetOurRootPath[64]; /* Our root path */
338extern ushort NetBootFileSize; /* Our boot file size in blocks */
339/** END OF BOOTP EXTENTIONS **/
340extern ulong NetBootFileXferSize; /* size of bootfile in bytes */
341extern uchar NetOurEther[6]; /* Our ethernet address */
342extern uchar NetServerEther[6]; /* Boot server enet address */
343extern IPaddr_t NetOurIP; /* Our IP addr (0 = unknown) */
344extern IPaddr_t NetServerIP; /* Server IP addr (0 = unknown) */
345extern volatile uchar * NetTxPacket; /* THE transmit packet */
346extern volatile uchar * NetRxPackets[PKTBUFSRX];/* Receive packets */
Mike Frysingerd9bec9f2009-07-18 21:04:08 -0400347extern volatile uchar * NetRxPacket; /* Current receive packet */
348extern int NetRxPacketLen; /* Current rx packet length */
wdenk2d966952002-10-31 22:12:35 +0000349extern unsigned NetIPID; /* IP ID (counting) */
350extern uchar NetBcastAddr[6]; /* Ethernet boardcast address */
wdenk68ceb292004-08-02 21:11:11 +0000351extern uchar NetEtherNullAddr[6];
wdenk2d966952002-10-31 22:12:35 +0000352
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200353#define VLAN_NONE 4095 /* untagged */
354#define VLAN_IDMASK 0x0fff /* mask of valid vlan id */
355extern ushort NetOurVLAN; /* Our VLAN */
356extern ushort NetOurNativeVLAN; /* Our Native VLAN */
wdenka3d991b2004-04-15 21:48:45 +0000357
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200358extern uchar NetCDPAddr[6]; /* Ethernet CDP address */
wdenka3d991b2004-04-15 21:48:45 +0000359extern ushort CDPNativeVLAN; /* CDP returned native VLAN */
360extern ushort CDPApplianceVLAN; /* CDP returned appliance VLAN */
361
wdenk2d966952002-10-31 22:12:35 +0000362extern int NetState; /* Network loop state */
363#define NETLOOP_CONTINUE 1
364#define NETLOOP_RESTART 2
365#define NETLOOP_SUCCESS 3
366#define NETLOOP_FAIL 4
367
wdenk2d966952002-10-31 22:12:35 +0000368extern int NetRestartWrap; /* Tried all network devices */
wdenk2d966952002-10-31 22:12:35 +0000369
Simon Glasse4bf0c52011-10-24 18:00:02 +0000370enum proto_t {
371 BOOTP, RARP, ARP, TFTPGET, DHCP, PING, DNS, NFS, CDP, NETCONS, SNTP,
Simon Glass58f317d2011-10-24 18:00:05 +0000372 TFTPSRV, TFTPPUT
Simon Glasse4bf0c52011-10-24 18:00:02 +0000373};
wdenk2d966952002-10-31 22:12:35 +0000374
375/* from net/net.c */
376extern char BootFile[128]; /* Boot File name */
377
Robin Getz1a32bf42009-07-20 14:53:54 -0400378#if defined(CONFIG_CMD_DNS)
379extern char *NetDNSResolve; /* The host to resolve */
380extern char *NetDNSenvvar; /* the env var to put the ip into */
381#endif
382
Jon Loeliger639221c2007-07-09 17:15:49 -0500383#if defined(CONFIG_CMD_PING)
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200384extern IPaddr_t NetPingIP; /* the ip address to ping */
wdenk73a8b272003-06-05 19:27:42 +0000385#endif
386
Jon Loeliger639221c2007-07-09 17:15:49 -0500387#if defined(CONFIG_CMD_CDP)
wdenka3d991b2004-04-15 21:48:45 +0000388/* when CDP completes these hold the return values */
389extern ushort CDPNativeVLAN;
390extern ushort CDPApplianceVLAN;
391#endif
392
Jon Loeliger639221c2007-07-09 17:15:49 -0500393#if defined(CONFIG_CMD_SNTP)
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200394extern IPaddr_t NetNtpServerIP; /* the ip address to NTP */
wdenkea287de2005-04-01 00:25:43 +0000395extern int NetTimeOffset; /* offset time from UTC */
396#endif
397
wdenk2d966952002-10-31 22:12:35 +0000398/* Initialize the network adapter */
Simon Glasse4bf0c52011-10-24 18:00:02 +0000399extern int NetLoop(enum proto_t);
wdenk2d966952002-10-31 22:12:35 +0000400
401/* Shutdown adapters and cleanup */
402extern void NetStop(void);
403
404/* Load failed. Start again. */
405extern void NetStartAgain(void);
406
wdenka3d991b2004-04-15 21:48:45 +0000407/* Get size of the ethernet header when we send */
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200408extern int NetEthHdrSize(void);
wdenka3d991b2004-04-15 21:48:45 +0000409
410/* Set ethernet header; returns the size of the header */
411extern int NetSetEther(volatile uchar *, uchar *, uint);
wdenk2d966952002-10-31 22:12:35 +0000412
413/* Set IP header */
414extern void NetSetIP(volatile uchar *, IPaddr_t, int, int, int);
415
416/* Checksum */
417extern int NetCksumOk(uchar *, int); /* Return true if cksum OK */
418extern uint NetCksum(uchar *, int); /* Calculate the checksum */
419
420/* Set callbacks */
421extern void NetSetHandler(rxhand_f *); /* Set RX packet handler */
Simon Glass4793ee62011-10-24 18:00:01 +0000422extern void net_set_icmp_handler(rxhand_icmp_f *f); /* Set ICMP RX handler */
wdenk3e01d752004-10-09 21:56:21 +0000423extern void NetSetTimeout(ulong, thand_f *);/* Set timeout handler */
wdenk2d966952002-10-31 22:12:35 +0000424
425/* Transmit "NetTxPacket" */
426extern void NetSendPacket(volatile uchar *, int);
427
wdenk73a8b272003-06-05 19:27:42 +0000428/* Transmit UDP packet, performing ARP request if needed */
429extern int NetSendUDPPacket(uchar *ether, IPaddr_t dest, int dport, int sport, int len);
430
wdenk2d966952002-10-31 22:12:35 +0000431/* Processes a received packet */
432extern void NetReceive(volatile uchar *, int);
433
wdenk2d966952002-10-31 22:12:35 +0000434/*
Simon Glasse4a3d572011-10-27 06:24:32 +0000435 * Check if autoload is enabled. If so, use either NFS or TFTP to download
436 * the boot file.
437 */
438void net_auto_load(void);
439
440/*
wdenk2d966952002-10-31 22:12:35 +0000441 * The following functions are a bit ugly, but necessary to deal with
442 * alignment restrictions on ARM.
443 *
444 * We're using inline functions, which had the smallest memory
445 * footprint in our tests.
446 */
447/* return IP *in network byteorder* */
Anatolij Gustschin33a4a702008-04-30 13:34:40 +0200448static inline IPaddr_t NetReadIP(volatile void *from)
wdenk2d966952002-10-31 22:12:35 +0000449{
450 IPaddr_t ip;
Anatolij Gustschin33a4a702008-04-30 13:34:40 +0200451 memcpy((void*)&ip, (void*)from, sizeof(ip));
wdenk2d966952002-10-31 22:12:35 +0000452 return ip;
453}
454
455/* return ulong *in network byteorder* */
456static inline ulong NetReadLong(ulong *from)
457{
458 ulong l;
459 memcpy((void*)&l, (void*)from, sizeof(l));
460 return l;
461}
462
463/* write IP *in network byteorder* */
464static inline void NetWriteIP(void *to, IPaddr_t ip)
465{
466 memcpy(to, (void*)&ip, sizeof(ip));
467}
468
469/* copy IP */
Anatolij Gustschin33a4a702008-04-30 13:34:40 +0200470static inline void NetCopyIP(volatile void *to, void *from)
wdenk2d966952002-10-31 22:12:35 +0000471{
Anatolij Gustschin33a4a702008-04-30 13:34:40 +0200472 memcpy((void*)to, from, sizeof(IPaddr_t));
wdenk2d966952002-10-31 22:12:35 +0000473}
474
475/* copy ulong */
476static inline void NetCopyLong(ulong *to, ulong *from)
477{
478 memcpy((void*)to, (void*)from, sizeof(ulong));
479}
480
Mike Rapoport50cca8b2007-08-12 08:48:27 +0300481/**
482 * is_zero_ether_addr - Determine if give Ethernet address is all zeros.
483 * @addr: Pointer to a six-byte array containing the Ethernet address
484 *
485 * Return true if the address is all zeroes.
486 */
487static inline int is_zero_ether_addr(const u8 *addr)
488{
489 return !(addr[0] | addr[1] | addr[2] | addr[3] | addr[4] | addr[5]);
490}
491
492/**
493 * is_multicast_ether_addr - Determine if the Ethernet address is a multicast.
494 * @addr: Pointer to a six-byte array containing the Ethernet address
495 *
496 * Return true if the address is a multicast address.
497 * By definition the broadcast address is also a multicast address.
498 */
499static inline int is_multicast_ether_addr(const u8 *addr)
500{
501 return (0x01 & addr[0]);
502}
503
Remy Bohmer23cd1382009-07-29 18:18:43 +0200504/*
505 * is_broadcast_ether_addr - Determine if the Ethernet address is broadcast
506 * @addr: Pointer to a six-byte array containing the Ethernet address
507 *
508 * Return true if the address is the broadcast address.
509 */
510static inline int is_broadcast_ether_addr(const u8 *addr)
511{
512 return (addr[0] & addr[1] & addr[2] & addr[3] & addr[4] & addr[5]) == 0xff;
513}
514
515/*
Mike Frysinger75edebe2009-01-27 16:53:39 -0500516 * is_valid_ether_addr - Determine if the given Ethernet address is valid
517 * @addr: Pointer to a six-byte array containing the Ethernet address
518 *
519 * Check that the Ethernet address (MAC) is not 00:00:00:00:00:00, is not
520 * a multicast address, and is not FF:FF:FF:FF:FF:FF.
521 *
522 * Return true if the address is valid.
523 */
Remy Bohmer23cd1382009-07-29 18:18:43 +0200524static inline int is_valid_ether_addr(const u8 *addr)
Mike Frysinger75edebe2009-01-27 16:53:39 -0500525{
526 /* FF:FF:FF:FF:FF:FF is a multicast address so we don't need to
527 * explicitly check for it here. */
528 return !is_multicast_ether_addr(addr) && !is_zero_ether_addr(addr);
529}
530
wdenk2d966952002-10-31 22:12:35 +0000531/* Convert an IP address to a string */
532extern void ip_to_string (IPaddr_t x, char *s);
533
wdenk73a8b272003-06-05 19:27:42 +0000534/* Convert a string to ip address */
Mike Frysinger908c6b62010-10-20 07:16:58 -0400535extern IPaddr_t string_to_ip(const char *s);
wdenk73a8b272003-06-05 19:27:42 +0000536
wdenka3d991b2004-04-15 21:48:45 +0000537/* Convert a VLAN id to a string */
538extern void VLAN_to_string (ushort x, char *s);
539
540/* Convert a string to a vlan id */
Mike Frysinger2e3ef6e2010-10-20 07:16:48 -0400541extern ushort string_to_VLAN(const char *s);
wdenka3d991b2004-04-15 21:48:45 +0000542
wdenka3d991b2004-04-15 21:48:45 +0000543/* read a VLAN id from an environment variable */
544extern ushort getenv_VLAN(char *);
545
wdenk2d966952002-10-31 22:12:35 +0000546/* copy a filename (allow for "..." notation, limit length) */
Mike Frysingerb920ee92010-10-20 07:16:40 -0400547extern void copy_filename (char *dst, const char *src, int size);
wdenk2d966952002-10-31 22:12:35 +0000548
Mike Frysinger91b469c2009-09-02 04:18:55 -0400549/* get a random source port */
550extern unsigned int random_port(void);
551
wdenk2d966952002-10-31 22:12:35 +0000552/**********************************************************************/
553
554#endif /* __NET_H__ */