Merge branch 'master' of git://www.denx.de/git/u-boot-imx
[platform/kernel/u-boot.git] / include / net.h
1 /*
2  *      LiMon Monitor (LiMon) - Network.
3  *
4  *      Copyright 1994 - 2000 Neil Russell.
5  *      (See License)
6  *      SPDX-License-Identifier:        GPL-2.0
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
15 #if defined(CONFIG_8xx)
16 #include <commproc.h>
17 #endif  /* CONFIG_8xx */
18
19 #include <asm/cache.h>
20 #include <asm/byteorder.h>      /* for nton* / ntoh* stuff */
21
22 #define DEBUG_LL_STATE 0        /* Link local state machine changes */
23 #define DEBUG_DEV_PKT 0         /* Packets or info directed to the device */
24 #define DEBUG_NET_PKT 0         /* Packets on info on the network at large */
25 #define DEBUG_INT_STATE 0       /* Internal network state changes */
26
27 /*
28  *      The number of receive packet buffers, and the required packet buffer
29  *      alignment in memory.
30  *
31  */
32
33 #ifdef CONFIG_SYS_RX_ETH_BUFFER
34 # define PKTBUFSRX      CONFIG_SYS_RX_ETH_BUFFER
35 #else
36 # define PKTBUFSRX      4
37 #endif
38
39 #define PKTALIGN        ARCH_DMA_MINALIGN
40
41 /* IPv4 addresses are always 32 bits in size */
42 typedef __be32          IPaddr_t;
43
44
45 /**
46  * An incoming packet handler.
47  * @param pkt    pointer to the application packet
48  * @param dport  destination UDP port
49  * @param sip    source IP address
50  * @param sport  source UDP port
51  * @param len    packet length
52  */
53 typedef void rxhand_f(uchar *pkt, unsigned dport,
54                       IPaddr_t sip, unsigned sport,
55                       unsigned len);
56
57 /**
58  * An incoming ICMP packet handler.
59  * @param type  ICMP type
60  * @param code  ICMP code
61  * @param dport destination UDP port
62  * @param sip   source IP address
63  * @param sport source UDP port
64  * @param pkt   pointer to the ICMP packet data
65  * @param len   packet length
66  */
67 typedef void rxhand_icmp_f(unsigned type, unsigned code, unsigned dport,
68                 IPaddr_t sip, unsigned sport, uchar *pkt, unsigned len);
69
70 /*
71  *      A timeout handler.  Called after time interval has expired.
72  */
73 typedef void    thand_f(void);
74
75 enum eth_state_t {
76         ETH_STATE_INIT,
77         ETH_STATE_PASSIVE,
78         ETH_STATE_ACTIVE
79 };
80
81 struct eth_device {
82         char name[16];
83         unsigned char enetaddr[6];
84         phys_addr_t iobase;
85         int state;
86
87         int  (*init) (struct eth_device *, bd_t *);
88         int  (*send) (struct eth_device *, void *packet, int length);
89         int  (*recv) (struct eth_device *);
90         void (*halt) (struct eth_device *);
91 #ifdef CONFIG_MCAST_TFTP
92         int (*mcast) (struct eth_device *, const u8 *enetaddr, u8 set);
93 #endif
94         int  (*write_hwaddr) (struct eth_device *);
95         struct eth_device *next;
96         int index;
97         void *priv;
98 };
99
100 extern int eth_initialize(bd_t *bis);   /* Initialize network subsystem */
101 extern int eth_register(struct eth_device* dev);/* Register network device */
102 extern int eth_unregister(struct eth_device *dev);/* Remove network device */
103 extern void eth_try_another(int first_restart); /* Change the device */
104 extern void eth_set_current(void);              /* set nterface to ethcur var */
105
106 /* get the current device MAC */
107 extern struct eth_device *eth_current;
108
109 static inline __attribute__((always_inline))
110 struct eth_device *eth_get_dev(void)
111 {
112         return eth_current;
113 }
114 extern struct eth_device *eth_get_dev_by_name(const char *devname);
115 extern struct eth_device *eth_get_dev_by_index(int index); /* get dev @ index */
116 extern int eth_get_dev_index(void);             /* get the device index */
117 extern void eth_parse_enetaddr(const char *addr, uchar *enetaddr);
118 extern int eth_getenv_enetaddr(char *name, uchar *enetaddr);
119 extern int eth_setenv_enetaddr(char *name, const uchar *enetaddr);
120
121 /*
122  * Get the hardware address for an ethernet interface .
123  * Args:
124  *      base_name - base name for device (normally "eth")
125  *      index - device index number (0 for first)
126  *      enetaddr - returns 6 byte hardware address
127  * Returns:
128  *      Return true if the address is valid.
129  */
130 extern int eth_getenv_enetaddr_by_index(const char *base_name, int index,
131                                         uchar *enetaddr);
132
133 extern int usb_eth_initialize(bd_t *bi);
134 extern int eth_init(bd_t *bis);                 /* Initialize the device */
135 extern int eth_send(void *packet, int length);     /* Send a packet */
136
137 #ifdef CONFIG_API
138 extern int eth_receive(void *packet, int length); /* Receive a packet*/
139 extern void (*push_packet)(void *packet, int length);
140 #endif
141 extern int eth_rx(void);                        /* Check for received packets */
142 extern void eth_halt(void);                     /* stop SCC */
143 extern char *eth_get_name(void);                /* get name of current device */
144
145 /* Set active state */
146 static inline __attribute__((always_inline)) int eth_init_state_only(bd_t *bis)
147 {
148         eth_get_dev()->state = ETH_STATE_ACTIVE;
149
150         return 0;
151 }
152 /* Set passive state */
153 static inline __attribute__((always_inline)) void eth_halt_state_only(void)
154 {
155         eth_get_dev()->state = ETH_STATE_PASSIVE;
156 }
157
158 /*
159  * Set the hardware address for an ethernet interface based on 'eth%daddr'
160  * environment variable (or just 'ethaddr' if eth_number is 0).
161  * Args:
162  *      base_name - base name for device (normally "eth")
163  *      eth_number - value of %d (0 for first device of this type)
164  * Returns:
165  *      0 is success, non-zero is error status from driver.
166  */
167 int eth_write_hwaddr(struct eth_device *dev, const char *base_name,
168                      int eth_number);
169
170 #ifdef CONFIG_MCAST_TFTP
171 int eth_mcast_join(IPaddr_t mcast_addr, u8 join);
172 u32 ether_crc(size_t len, unsigned char const *p);
173 #endif
174
175
176 /**********************************************************************/
177 /*
178  *      Protocol headers.
179  */
180
181 /*
182  *      Ethernet header
183  */
184
185 struct ethernet_hdr {
186         uchar           et_dest[6];     /* Destination node             */
187         uchar           et_src[6];      /* Source node                  */
188         ushort          et_protlen;     /* Protocol or length           */
189 };
190
191 /* Ethernet header size */
192 #define ETHER_HDR_SIZE  (sizeof(struct ethernet_hdr))
193
194 #define ETH_FCS_LEN     4               /* Octets in the FCS            */
195
196 struct e802_hdr {
197         uchar           et_dest[6];     /* Destination node             */
198         uchar           et_src[6];      /* Source node                  */
199         ushort          et_protlen;     /* Protocol or length           */
200         uchar           et_dsap;        /* 802 DSAP                     */
201         uchar           et_ssap;        /* 802 SSAP                     */
202         uchar           et_ctl;         /* 802 control                  */
203         uchar           et_snap1;       /* SNAP                         */
204         uchar           et_snap2;
205         uchar           et_snap3;
206         ushort          et_prot;        /* 802 protocol                 */
207 };
208
209 /* 802 + SNAP + ethernet header size */
210 #define E802_HDR_SIZE   (sizeof(struct e802_hdr))
211
212 /*
213  *      Virtual LAN Ethernet header
214  */
215 struct vlan_ethernet_hdr {
216         uchar           vet_dest[6];    /* Destination node             */
217         uchar           vet_src[6];     /* Source node                  */
218         ushort          vet_vlan_type;  /* PROT_VLAN                    */
219         ushort          vet_tag;        /* TAG of VLAN                  */
220         ushort          vet_type;       /* protocol type                */
221 };
222
223 /* VLAN Ethernet header size */
224 #define VLAN_ETHER_HDR_SIZE     (sizeof(struct vlan_ethernet_hdr))
225
226 #define PROT_IP         0x0800          /* IP protocol                  */
227 #define PROT_ARP        0x0806          /* IP ARP protocol              */
228 #define PROT_RARP       0x8035          /* IP ARP protocol              */
229 #define PROT_VLAN       0x8100          /* IEEE 802.1q protocol         */
230
231 #define IPPROTO_ICMP     1      /* Internet Control Message Protocol    */
232 #define IPPROTO_UDP     17      /* User Datagram Protocol               */
233
234 /*
235  *      Internet Protocol (IP) header.
236  */
237 struct ip_hdr {
238         uchar           ip_hl_v;        /* header length and version    */
239         uchar           ip_tos;         /* type of service              */
240         ushort          ip_len;         /* total length                 */
241         ushort          ip_id;          /* identification               */
242         ushort          ip_off;         /* fragment offset field        */
243         uchar           ip_ttl;         /* time to live                 */
244         uchar           ip_p;           /* protocol                     */
245         ushort          ip_sum;         /* checksum                     */
246         IPaddr_t        ip_src;         /* Source IP address            */
247         IPaddr_t        ip_dst;         /* Destination IP address       */
248 };
249
250 #define IP_OFFS         0x1fff /* ip offset *= 8 */
251 #define IP_FLAGS        0xe000 /* first 3 bits */
252 #define IP_FLAGS_RES    0x8000 /* reserved */
253 #define IP_FLAGS_DFRAG  0x4000 /* don't fragments */
254 #define IP_FLAGS_MFRAG  0x2000 /* more fragments */
255
256 #define IP_HDR_SIZE             (sizeof(struct ip_hdr))
257
258 /*
259  *      Internet Protocol (IP) + UDP header.
260  */
261 struct ip_udp_hdr {
262         uchar           ip_hl_v;        /* header length and version    */
263         uchar           ip_tos;         /* type of service              */
264         ushort          ip_len;         /* total length                 */
265         ushort          ip_id;          /* identification               */
266         ushort          ip_off;         /* fragment offset field        */
267         uchar           ip_ttl;         /* time to live                 */
268         uchar           ip_p;           /* protocol                     */
269         ushort          ip_sum;         /* checksum                     */
270         IPaddr_t        ip_src;         /* Source IP address            */
271         IPaddr_t        ip_dst;         /* Destination IP address       */
272         ushort          udp_src;        /* UDP source port              */
273         ushort          udp_dst;        /* UDP destination port         */
274         ushort          udp_len;        /* Length of UDP packet         */
275         ushort          udp_xsum;       /* Checksum                     */
276 };
277
278 #define IP_UDP_HDR_SIZE         (sizeof(struct ip_udp_hdr))
279 #define UDP_HDR_SIZE            (IP_UDP_HDR_SIZE - IP_HDR_SIZE)
280
281 /*
282  *      Address Resolution Protocol (ARP) header.
283  */
284 struct arp_hdr {
285         ushort          ar_hrd;         /* Format of hardware address   */
286 #   define ARP_ETHER        1           /* Ethernet  hardware address   */
287         ushort          ar_pro;         /* Format of protocol address   */
288         uchar           ar_hln;         /* Length of hardware address   */
289 #   define ARP_HLEN     6
290         uchar           ar_pln;         /* Length of protocol address   */
291 #   define ARP_PLEN     4
292         ushort          ar_op;          /* Operation                    */
293 #   define ARPOP_REQUEST    1           /* Request  to resolve  address */
294 #   define ARPOP_REPLY      2           /* Response to previous request */
295
296 #   define RARPOP_REQUEST   3           /* Request  to resolve  address */
297 #   define RARPOP_REPLY     4           /* Response to previous request */
298
299         /*
300          * The remaining fields are variable in size, according to
301          * the sizes above, and are defined as appropriate for
302          * specific hardware/protocol combinations.
303          */
304         uchar           ar_data[0];
305 #define ar_sha          ar_data[0]
306 #define ar_spa          ar_data[ARP_HLEN]
307 #define ar_tha          ar_data[ARP_HLEN + ARP_PLEN]
308 #define ar_tpa          ar_data[ARP_HLEN + ARP_PLEN + ARP_HLEN]
309 #if 0
310         uchar           ar_sha[];       /* Sender hardware address      */
311         uchar           ar_spa[];       /* Sender protocol address      */
312         uchar           ar_tha[];       /* Target hardware address      */
313         uchar           ar_tpa[];       /* Target protocol address      */
314 #endif /* 0 */
315 };
316
317 #define ARP_HDR_SIZE    (8+20)          /* Size assuming ethernet       */
318
319 /*
320  * ICMP stuff (just enough to handle (host) redirect messages)
321  */
322 #define ICMP_ECHO_REPLY         0       /* Echo reply                   */
323 #define ICMP_NOT_REACH          3       /* Detination unreachable       */
324 #define ICMP_REDIRECT           5       /* Redirect (change route)      */
325 #define ICMP_ECHO_REQUEST       8       /* Echo request                 */
326
327 /* Codes for REDIRECT. */
328 #define ICMP_REDIR_NET          0       /* Redirect Net                 */
329 #define ICMP_REDIR_HOST         1       /* Redirect Host                */
330
331 /* Codes for NOT_REACH */
332 #define ICMP_NOT_REACH_PORT     3       /* Port unreachable             */
333
334 struct icmp_hdr {
335         uchar           type;
336         uchar           code;
337         ushort          checksum;
338         union {
339                 struct {
340                         ushort  id;
341                         ushort  sequence;
342                 } echo;
343                 ulong   gateway;
344                 struct {
345                         ushort  unused;
346                         ushort  mtu;
347                 } frag;
348                 uchar data[0];
349         } un;
350 };
351
352 #define ICMP_HDR_SIZE           (sizeof(struct icmp_hdr))
353 #define IP_ICMP_HDR_SIZE        (IP_HDR_SIZE + ICMP_HDR_SIZE)
354
355 /*
356  * Maximum packet size; used to allocate packet storage.
357  * TFTP packets can be 524 bytes + IP header + ethernet header.
358  * Lets be conservative, and go for 38 * 16.  (Must also be
359  * a multiple of 32 bytes).
360  */
361 /*
362  * AS.HARNOIS : Better to set PKTSIZE to maximum size because
363  * traffic type is not always controlled
364  * maximum packet size =  1518
365  * maximum packet size and multiple of 32 bytes =  1536
366  */
367 #define PKTSIZE                 1518
368 #define PKTSIZE_ALIGN           1536
369 /*#define PKTSIZE               608*/
370
371 /*
372  * Maximum receive ring size; that is, the number of packets
373  * we can buffer before overflow happens. Basically, this just
374  * needs to be enough to prevent a packet being discarded while
375  * we are processing the previous one.
376  */
377 #define RINGSZ          4
378 #define RINGSZ_LOG2     2
379
380 /**********************************************************************/
381 /*
382  *      Globals.
383  *
384  * Note:
385  *
386  * All variables of type IPaddr_t are stored in NETWORK byte order
387  * (big endian).
388  */
389
390 /* net.c */
391 /** BOOTP EXTENTIONS **/
392 extern IPaddr_t NetOurGatewayIP;        /* Our gateway IP address */
393 extern IPaddr_t NetOurSubnetMask;       /* Our subnet mask (0 = unknown) */
394 extern IPaddr_t NetOurDNSIP;    /* Our Domain Name Server (0 = unknown) */
395 #if defined(CONFIG_BOOTP_DNS2)
396 extern IPaddr_t NetOurDNS2IP;   /* Our 2nd Domain Name Server (0 = unknown) */
397 #endif
398 extern char     NetOurNISDomain[32];    /* Our NIS domain */
399 extern char     NetOurHostName[32];     /* Our hostname */
400 extern char     NetOurRootPath[64];     /* Our root path */
401 extern ushort   NetBootFileSize;        /* Our boot file size in blocks */
402 /** END OF BOOTP EXTENTIONS **/
403 extern ulong            NetBootFileXferSize;    /* size of bootfile in bytes */
404 extern uchar            NetOurEther[6];         /* Our ethernet address */
405 extern uchar            NetServerEther[6];      /* Boot server enet address */
406 extern IPaddr_t         NetOurIP;       /* Our    IP addr (0 = unknown) */
407 extern IPaddr_t         NetServerIP;    /* Server IP addr (0 = unknown) */
408 extern uchar            *NetTxPacket;           /* THE transmit packet */
409 extern uchar            *NetRxPackets[PKTBUFSRX]; /* Receive packets */
410 extern uchar            *NetRxPacket;           /* Current receive packet */
411 extern int              NetRxPacketLen;         /* Current rx packet length */
412 extern unsigned         NetIPID;                /* IP ID (counting) */
413 extern uchar            NetBcastAddr[6];        /* Ethernet boardcast address */
414 extern uchar            NetEtherNullAddr[6];
415
416 #define VLAN_NONE       4095                    /* untagged */
417 #define VLAN_IDMASK     0x0fff                  /* mask of valid vlan id */
418 extern ushort           NetOurVLAN;             /* Our VLAN */
419 extern ushort           NetOurNativeVLAN;       /* Our Native VLAN */
420
421 extern int              NetRestartWrap;         /* Tried all network devices */
422
423 enum proto_t {
424         BOOTP, RARP, ARP, TFTPGET, DHCP, PING, DNS, NFS, CDP, NETCONS, SNTP,
425         TFTPSRV, TFTPPUT, LINKLOCAL
426 };
427
428 /* from net/net.c */
429 extern char     BootFile[128];                  /* Boot File name */
430
431 #if defined(CONFIG_CMD_DNS)
432 extern char *NetDNSResolve;             /* The host to resolve  */
433 extern char *NetDNSenvvar;              /* the env var to put the ip into */
434 #endif
435
436 #if defined(CONFIG_CMD_PING)
437 extern IPaddr_t NetPingIP;                      /* the ip address to ping */
438 #endif
439
440 #if defined(CONFIG_CMD_CDP)
441 /* when CDP completes these hold the return values */
442 extern ushort CDPNativeVLAN;            /* CDP returned native VLAN */
443 extern ushort CDPApplianceVLAN;         /* CDP returned appliance VLAN */
444
445 /*
446  * Check for a CDP packet by examining the received MAC address field
447  */
448 static inline int is_cdp_packet(const uchar *et_addr)
449 {
450         extern const uchar NetCDPAddr[6];
451
452         return memcmp(et_addr, NetCDPAddr, 6) == 0;
453 }
454 #endif
455
456 #if defined(CONFIG_CMD_SNTP)
457 extern IPaddr_t NetNtpServerIP;                 /* the ip address to NTP */
458 extern int NetTimeOffset;                       /* offset time from UTC */
459 #endif
460
461 #if defined(CONFIG_MCAST_TFTP)
462 extern IPaddr_t Mcast_addr;
463 #endif
464
465 /* Initialize the network adapter */
466 extern void net_init(void);
467 extern int NetLoop(enum proto_t);
468
469 /* Shutdown adapters and cleanup */
470 extern void     NetStop(void);
471
472 /* Load failed.  Start again. */
473 extern void     NetStartAgain(void);
474
475 /* Get size of the ethernet header when we send */
476 extern int      NetEthHdrSize(void);
477
478 /* Set ethernet header; returns the size of the header */
479 extern int NetSetEther(uchar *, uchar *, uint);
480 extern int net_update_ether(struct ethernet_hdr *et, uchar *addr, uint prot);
481
482 /* Set IP header */
483 extern void net_set_ip_header(uchar *pkt, IPaddr_t dest, IPaddr_t source);
484 extern void net_set_udp_header(uchar *pkt, IPaddr_t dest, int dport,
485                                 int sport, int len);
486
487 /**
488  * compute_ip_checksum() - Compute IP checksum
489  *
490  * @addr:       Address to check (must be 16-bit aligned)
491  * @nbytes:     Number of bytes to check (normally a multiple of 2)
492  * @return 16-bit IP checksum
493  */
494 unsigned compute_ip_checksum(const void *addr, unsigned nbytes);
495
496 /**
497  * add_ip_checksums() - add two IP checksums
498  *
499  * @offset:     Offset of first sum (if odd we do a byte-swap)
500  * @sum:        First checksum
501  * @new_sum:    New checksum to add
502  * @return updated 16-bit IP checksum
503  */
504 unsigned add_ip_checksums(unsigned offset, unsigned sum, unsigned new_sum);
505
506 /**
507  * ip_checksum_ok() - check if a checksum is correct
508  *
509  * This works by making sure the checksum sums to 0
510  *
511  * @addr:       Address to check (must be 16-bit aligned)
512  * @nbytes:     Number of bytes to check (normally a multiple of 2)
513  * @return true if the checksum matches, false if not
514  */
515 int ip_checksum_ok(const void *addr, unsigned nbytes);
516
517 /* Callbacks */
518 extern rxhand_f *net_get_udp_handler(void);     /* Get UDP RX packet handler */
519 extern void net_set_udp_handler(rxhand_f *);    /* Set UDP RX packet handler */
520 extern rxhand_f *net_get_arp_handler(void);     /* Get ARP RX packet handler */
521 extern void net_set_arp_handler(rxhand_f *);    /* Set ARP RX packet handler */
522 extern void net_set_icmp_handler(rxhand_icmp_f *f); /* Set ICMP RX handler */
523 extern void     NetSetTimeout(ulong, thand_f *);/* Set timeout handler */
524
525 /* Network loop state */
526 enum net_loop_state {
527         NETLOOP_CONTINUE,
528         NETLOOP_RESTART,
529         NETLOOP_SUCCESS,
530         NETLOOP_FAIL
531 };
532 extern enum net_loop_state net_state;
533
534 static inline void net_set_state(enum net_loop_state state)
535 {
536         debug_cond(DEBUG_INT_STATE, "--- NetState set to %d\n", state);
537         net_state = state;
538 }
539
540 /* Transmit a packet */
541 static inline void NetSendPacket(uchar *pkt, int len)
542 {
543         (void) eth_send(pkt, len);
544 }
545
546 /*
547  * Transmit "NetTxPacket" as UDP packet, performing ARP request if needed
548  *  (ether will be populated)
549  *
550  * @param ether Raw packet buffer
551  * @param dest IP address to send the datagram to
552  * @param dport Destination UDP port
553  * @param sport Source UDP port
554  * @param payload_len Length of data after the UDP header
555  */
556 extern int NetSendUDPPacket(uchar *ether, IPaddr_t dest, int dport,
557                         int sport, int payload_len);
558
559 /* Processes a received packet */
560 extern void NetReceive(uchar *, int);
561
562 #ifdef CONFIG_NETCONSOLE
563 void NcStart(void);
564 int nc_input_packet(uchar *pkt, IPaddr_t src_ip, unsigned dest_port,
565         unsigned src_port, unsigned len);
566 #endif
567
568 static inline __attribute__((always_inline)) int eth_is_on_demand_init(void)
569 {
570 #ifdef CONFIG_NETCONSOLE
571         extern enum proto_t net_loop_last_protocol;
572
573         return net_loop_last_protocol != NETCONS;
574 #else
575         return 1;
576 #endif
577 }
578
579 static inline void eth_set_last_protocol(int protocol)
580 {
581 #ifdef CONFIG_NETCONSOLE
582         extern enum proto_t net_loop_last_protocol;
583
584         net_loop_last_protocol = protocol;
585 #endif
586 }
587
588 /*
589  * Check if autoload is enabled. If so, use either NFS or TFTP to download
590  * the boot file.
591  */
592 void net_auto_load(void);
593
594 /*
595  * The following functions are a bit ugly, but necessary to deal with
596  * alignment restrictions on ARM.
597  *
598  * We're using inline functions, which had the smallest memory
599  * footprint in our tests.
600  */
601 /* return IP *in network byteorder* */
602 static inline IPaddr_t NetReadIP(void *from)
603 {
604         IPaddr_t ip;
605
606         memcpy((void *)&ip, (void *)from, sizeof(ip));
607         return ip;
608 }
609
610 /* return ulong *in network byteorder* */
611 static inline ulong NetReadLong(ulong *from)
612 {
613         ulong l;
614
615         memcpy((void *)&l, (void *)from, sizeof(l));
616         return l;
617 }
618
619 /* write IP *in network byteorder* */
620 static inline void NetWriteIP(void *to, IPaddr_t ip)
621 {
622         memcpy(to, (void *)&ip, sizeof(ip));
623 }
624
625 /* copy IP */
626 static inline void NetCopyIP(void *to, void *from)
627 {
628         memcpy((void *)to, from, sizeof(IPaddr_t));
629 }
630
631 /* copy ulong */
632 static inline void NetCopyLong(ulong *to, ulong *from)
633 {
634         memcpy((void *)to, (void *)from, sizeof(ulong));
635 }
636
637 /**
638  * is_zero_ether_addr - Determine if give Ethernet address is all zeros.
639  * @addr: Pointer to a six-byte array containing the Ethernet address
640  *
641  * Return true if the address is all zeroes.
642  */
643 static inline int is_zero_ether_addr(const u8 *addr)
644 {
645         return !(addr[0] | addr[1] | addr[2] | addr[3] | addr[4] | addr[5]);
646 }
647
648 /**
649  * is_multicast_ether_addr - Determine if the Ethernet address is a multicast.
650  * @addr: Pointer to a six-byte array containing the Ethernet address
651  *
652  * Return true if the address is a multicast address.
653  * By definition the broadcast address is also a multicast address.
654  */
655 static inline int is_multicast_ether_addr(const u8 *addr)
656 {
657         return 0x01 & addr[0];
658 }
659
660 /*
661  * is_broadcast_ether_addr - Determine if the Ethernet address is broadcast
662  * @addr: Pointer to a six-byte array containing the Ethernet address
663  *
664  * Return true if the address is the broadcast address.
665  */
666 static inline int is_broadcast_ether_addr(const u8 *addr)
667 {
668         return (addr[0] & addr[1] & addr[2] & addr[3] & addr[4] & addr[5]) ==
669                 0xff;
670 }
671
672 /*
673  * is_valid_ether_addr - Determine if the given Ethernet address is valid
674  * @addr: Pointer to a six-byte array containing the Ethernet address
675  *
676  * Check that the Ethernet address (MAC) is not 00:00:00:00:00:00, is not
677  * a multicast address, and is not FF:FF:FF:FF:FF:FF.
678  *
679  * Return true if the address is valid.
680  */
681 static inline int is_valid_ether_addr(const u8 *addr)
682 {
683         /* FF:FF:FF:FF:FF:FF is a multicast address so we don't need to
684          * explicitly check for it here. */
685         return !is_multicast_ether_addr(addr) && !is_zero_ether_addr(addr);
686 }
687
688 /**
689  * eth_random_addr - Generate software assigned random Ethernet address
690  * @addr: Pointer to a six-byte array containing the Ethernet address
691  *
692  * Generate a random Ethernet address (MAC) that is not multicast
693  * and has the local assigned bit set.
694  */
695 static inline void eth_random_addr(uchar *addr)
696 {
697         int i;
698         unsigned int seed = get_timer(0);
699
700         for (i = 0; i < 6; i++)
701                 addr[i] = rand_r(&seed);
702
703         addr[0] &= 0xfe;        /* clear multicast bit */
704         addr[0] |= 0x02;        /* set local assignment bit (IEEE802) */
705 }
706
707 /* Convert an IP address to a string */
708 extern void ip_to_string(IPaddr_t x, char *s);
709
710 /* Convert a string to ip address */
711 extern IPaddr_t string_to_ip(const char *s);
712
713 /* Convert a VLAN id to a string */
714 extern void VLAN_to_string(ushort x, char *s);
715
716 /* Convert a string to a vlan id */
717 extern ushort string_to_VLAN(const char *s);
718
719 /* read a VLAN id from an environment variable */
720 extern ushort getenv_VLAN(char *);
721
722 /* copy a filename (allow for "..." notation, limit length) */
723 extern void copy_filename(char *dst, const char *src, int size);
724
725 /* get a random source port */
726 extern unsigned int random_port(void);
727
728 /* Update U-Boot over TFTP */
729 extern int update_tftp(ulong addr);
730
731 /**********************************************************************/
732
733 #endif /* __NET_H__ */