blob: 7673470046f596263e170d0facbdffba74540299 [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
Joe Hershberger4ef8d532012-05-23 08:01:04 +000022#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 */
wdenk2d966952002-10-31 22:12:35 +000026
27/*
28 * The number of receive packet buffers, and the required packet buffer
29 * alignment in memory.
30 *
31 */
32
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +020033#ifdef CONFIG_SYS_RX_ETH_BUFFER
34# define PKTBUFSRX CONFIG_SYS_RX_ETH_BUFFER
wdenk1d0350e2002-11-11 21:14:20 +000035#else
stroesec6028832003-06-05 15:38:29 +000036# define PKTBUFSRX 4
wdenk1d0350e2002-11-11 21:14:20 +000037#endif
38
Eric Nelson2c4b3c12012-03-15 18:33:24 +000039#define PKTALIGN ARCH_DMA_MINALIGN
wdenk2d966952002-10-31 22:12:35 +000040
Matthias Weisserea45cb02011-12-03 03:29:44 +000041/* IPv4 addresses are always 32 bits in size */
Kim Phillips3d494122013-01-16 18:09:11 -060042typedef __be32 IPaddr_t;
wdenk2d966952002-10-31 22:12:35 +000043
44
Luca Ceresoli03eb1292011-04-18 06:19:50 +000045/**
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
wdenk2d966952002-10-31 22:12:35 +000052 */
Luca Ceresoli03eb1292011-04-18 06:19:50 +000053typedef void rxhand_f(uchar *pkt, unsigned dport,
54 IPaddr_t sip, unsigned sport,
55 unsigned len);
wdenk2d966952002-10-31 22:12:35 +000056
Simon Glass4793ee62011-10-24 18:00:01 +000057/**
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 */
67typedef void rxhand_icmp_f(unsigned type, unsigned code, unsigned dport,
68 IPaddr_t sip, unsigned sport, uchar *pkt, unsigned len);
69
wdenk2d966952002-10-31 22:12:35 +000070/*
71 * A timeout handler. Called after time interval has expired.
72 */
73typedef void thand_f(void);
74
wdenk2d966952002-10-31 22:12:35 +000075enum eth_state_t {
76 ETH_STATE_INIT,
77 ETH_STATE_PASSIVE,
78 ETH_STATE_ACTIVE
79};
80
81struct eth_device {
Mike Frysingerf6add132011-11-10 14:11:04 +000082 char name[16];
wdenk2d966952002-10-31 22:12:35 +000083 unsigned char enetaddr[6];
84 int iobase;
85 int state;
86
Joe Hershbergerb28e28b2012-05-15 08:59:05 +000087 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 *);
David Updegraff53a5c422007-06-11 10:41:07 -050091#ifdef CONFIG_MCAST_TFTP
Joe Hershbergerb28e28b2012-05-15 08:59:05 +000092 int (*mcast) (struct eth_device *, u32 ip, u8 set);
David Updegraff53a5c422007-06-11 10:41:07 -050093#endif
Joe Hershbergerb28e28b2012-05-15 08:59:05 +000094 int (*write_hwaddr) (struct eth_device *);
wdenk2d966952002-10-31 22:12:35 +000095 struct eth_device *next;
Michael Wallefea7dca2011-10-27 11:31:35 +000096 int index;
wdenk2d966952002-10-31 22:12:35 +000097 void *priv;
98};
99
Andy Fleming5dc0cf62009-02-11 15:10:31 -0600100extern int eth_initialize(bd_t *bis); /* Initialize network subsystem */
101extern int eth_register(struct eth_device* dev);/* Register network device */
Vincent Palatine7e982d2012-01-09 08:32:36 +0000102extern int eth_unregister(struct eth_device *dev);/* Remove network device */
Andy Fleming5dc0cf62009-02-11 15:10:31 -0600103extern void eth_try_another(int first_restart); /* Change the device */
Andy Fleming5dc0cf62009-02-11 15:10:31 -0600104extern void eth_set_current(void); /* set nterface to ethcur var */
Kim Phillips06370592012-10-29 13:34:33 +0000105
Joe Hershbergerf8be7d62012-08-03 10:59:08 +0000106/* get the current device MAC */
Kim Phillips06370592012-10-29 13:34:33 +0000107extern struct eth_device *eth_current;
108
Joe Hershbergerf8be7d62012-08-03 10:59:08 +0000109static inline __attribute__((always_inline))
110struct eth_device *eth_get_dev(void)
111{
Joe Hershbergerf8be7d62012-08-03 10:59:08 +0000112 return eth_current;
113}
Ben Warrend7fb9bc2010-07-29 12:56:11 -0700114extern struct eth_device *eth_get_dev_by_name(const char *devname);
Andy Fleming5dc0cf62009-02-11 15:10:31 -0600115extern struct eth_device *eth_get_dev_by_index(int index); /* get dev @ index */
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000116extern int eth_get_dev_index(void); /* get the device index */
Mike Frysinger3f6e6992009-01-29 19:43:44 -0500117extern void eth_parse_enetaddr(const char *addr, uchar *enetaddr);
118extern int eth_getenv_enetaddr(char *name, uchar *enetaddr);
119extern int eth_setenv_enetaddr(char *name, const uchar *enetaddr);
Simon Glass7616e782011-06-13 16:13:10 -0700120
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 */
130extern int eth_getenv_enetaddr_by_index(const char *base_name, int index,
131 uchar *enetaddr);
wdenk2d966952002-10-31 22:12:35 +0000132
Michael Walle03c1b042012-06-05 11:33:16 +0000133#ifdef CONFIG_RANDOM_MACADDR
134/*
135 * The u-boot policy does not allow hardcoded ethernet addresses. Under the
136 * following circumstances a random generated address is allowed:
137 * - in emergency cases, where you need a working network connection to set
138 * the ethernet address.
139 * Eg. you want a rescue boot and don't have a serial port to access the
140 * CLI to set environment variables.
141 *
142 * In these cases, we generate a random locally administered ethernet address.
143 *
144 * Args:
145 * enetaddr - returns 6 byte hardware address
146 */
147extern void eth_random_enetaddr(uchar *enetaddr);
148#endif
149
Remy Bohmer23cd1382009-07-29 18:18:43 +0200150extern int usb_eth_initialize(bd_t *bi);
Andy Fleming5dc0cf62009-02-11 15:10:31 -0600151extern int eth_init(bd_t *bis); /* Initialize the device */
Joe Hershbergerdb288a92012-05-15 08:59:04 +0000152extern int eth_send(void *packet, int length); /* Send a packet */
Remy Bohmer23cd1382009-07-29 18:18:43 +0200153
Rafal Jaworowskif85b6072007-12-27 18:19:02 +0100154#ifdef CONFIG_API
Joe Hershbergerdb288a92012-05-15 08:59:04 +0000155extern int eth_receive(void *packet, int length); /* Receive a packet*/
156extern void (*push_packet)(void *packet, int length);
Rafal Jaworowskif85b6072007-12-27 18:19:02 +0100157#endif
Andy Fleming5dc0cf62009-02-11 15:10:31 -0600158extern int eth_rx(void); /* Check for received packets */
159extern void eth_halt(void); /* stop SCC */
160extern char *eth_get_name(void); /* get name of current device */
wdenk2d966952002-10-31 22:12:35 +0000161
Joe Hershbergerf8be7d62012-08-03 10:59:08 +0000162/* Set active state */
163static inline __attribute__((always_inline)) int eth_init_state_only(bd_t *bis)
164{
165 eth_get_dev()->state = ETH_STATE_ACTIVE;
166
167 return 0;
168}
169/* Set passive state */
170static inline __attribute__((always_inline)) void eth_halt_state_only(void)
171{
172 eth_get_dev()->state = ETH_STATE_PASSIVE;
173}
174
Simon Glass7616e782011-06-13 16:13:10 -0700175/*
176 * Set the hardware address for an ethernet interface based on 'eth%daddr'
177 * environment variable (or just 'ethaddr' if eth_number is 0).
178 * Args:
179 * base_name - base name for device (normally "eth")
180 * eth_number - value of %d (0 for first device of this type)
181 * Returns:
182 * 0 is success, non-zero is error status from driver.
183 */
184int eth_write_hwaddr(struct eth_device *dev, const char *base_name,
185 int eth_number);
186
David Updegraff53a5c422007-06-11 10:41:07 -0500187#ifdef CONFIG_MCAST_TFTP
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000188int eth_mcast_join(IPaddr_t mcast_addr, u8 join);
189u32 ether_crc(size_t len, unsigned char const *p);
David Updegraff53a5c422007-06-11 10:41:07 -0500190#endif
191
wdenk2d966952002-10-31 22:12:35 +0000192
193/**********************************************************************/
194/*
195 * Protocol headers.
196 */
197
198/*
199 * Ethernet header
200 */
Joe Hershbergercb487f52012-05-23 07:58:06 +0000201
202struct ethernet_hdr {
203 uchar et_dest[6]; /* Destination node */
204 uchar et_src[6]; /* Source node */
205 ushort et_protlen; /* Protocol or length */
206};
207
208/* Ethernet header size */
209#define ETHER_HDR_SIZE (sizeof(struct ethernet_hdr))
210
211struct e802_hdr {
wdenk2d966952002-10-31 22:12:35 +0000212 uchar et_dest[6]; /* Destination node */
213 uchar et_src[6]; /* Source node */
214 ushort et_protlen; /* Protocol or length */
215 uchar et_dsap; /* 802 DSAP */
216 uchar et_ssap; /* 802 SSAP */
217 uchar et_ctl; /* 802 control */
218 uchar et_snap1; /* SNAP */
219 uchar et_snap2;
220 uchar et_snap3;
221 ushort et_prot; /* 802 protocol */
Joe Hershbergercb487f52012-05-23 07:58:06 +0000222};
wdenk2d966952002-10-31 22:12:35 +0000223
Joe Hershbergerda5ebe22012-05-23 07:58:11 +0000224/* 802 + SNAP + ethernet header size */
Joe Hershbergercb487f52012-05-23 07:58:06 +0000225#define E802_HDR_SIZE (sizeof(struct e802_hdr))
wdenka3d991b2004-04-15 21:48:45 +0000226
227/*
Joe Hershbergerda5ebe22012-05-23 07:58:11 +0000228 * Virtual LAN Ethernet header
wdenka3d991b2004-04-15 21:48:45 +0000229 */
Joe Hershbergerc68cca32012-05-23 07:58:07 +0000230struct vlan_ethernet_hdr {
wdenka3d991b2004-04-15 21:48:45 +0000231 uchar vet_dest[6]; /* Destination node */
232 uchar vet_src[6]; /* Source node */
233 ushort vet_vlan_type; /* PROT_VLAN */
234 ushort vet_tag; /* TAG of VLAN */
235 ushort vet_type; /* protocol type */
Joe Hershbergerc68cca32012-05-23 07:58:07 +0000236};
wdenka3d991b2004-04-15 21:48:45 +0000237
Joe Hershbergerc68cca32012-05-23 07:58:07 +0000238/* VLAN Ethernet header size */
239#define VLAN_ETHER_HDR_SIZE (sizeof(struct vlan_ethernet_hdr))
wdenka3d991b2004-04-15 21:48:45 +0000240
wdenk2d966952002-10-31 22:12:35 +0000241#define PROT_IP 0x0800 /* IP protocol */
242#define PROT_ARP 0x0806 /* IP ARP protocol */
243#define PROT_RARP 0x8035 /* IP ARP protocol */
wdenka3d991b2004-04-15 21:48:45 +0000244#define PROT_VLAN 0x8100 /* IEEE 802.1q protocol */
wdenk2d966952002-10-31 22:12:35 +0000245
246#define IPPROTO_ICMP 1 /* Internet Control Message Protocol */
247#define IPPROTO_UDP 17 /* User Datagram Protocol */
248
249/*
Joe Hershbergerc5c59df2012-05-23 07:58:05 +0000250 * Internet Protocol (IP) header.
251 */
252struct ip_hdr {
253 uchar ip_hl_v; /* header length and version */
254 uchar ip_tos; /* type of service */
255 ushort ip_len; /* total length */
256 ushort ip_id; /* identification */
257 ushort ip_off; /* fragment offset field */
258 uchar ip_ttl; /* time to live */
259 uchar ip_p; /* protocol */
260 ushort ip_sum; /* checksum */
261 IPaddr_t ip_src; /* Source IP address */
262 IPaddr_t ip_dst; /* Destination IP address */
263};
264
265#define IP_OFFS 0x1fff /* ip offset *= 8 */
266#define IP_FLAGS 0xe000 /* first 3 bits */
267#define IP_FLAGS_RES 0x8000 /* reserved */
268#define IP_FLAGS_DFRAG 0x4000 /* don't fragments */
269#define IP_FLAGS_MFRAG 0x2000 /* more fragments */
270
271#define IP_HDR_SIZE (sizeof(struct ip_hdr))
272
273/*
Joe Hershberger594c26f2012-05-23 07:58:04 +0000274 * Internet Protocol (IP) + UDP header.
wdenk2d966952002-10-31 22:12:35 +0000275 */
Joe Hershberger594c26f2012-05-23 07:58:04 +0000276struct ip_udp_hdr {
wdenk2d966952002-10-31 22:12:35 +0000277 uchar ip_hl_v; /* header length and version */
278 uchar ip_tos; /* type of service */
279 ushort ip_len; /* total length */
280 ushort ip_id; /* identification */
281 ushort ip_off; /* fragment offset field */
282 uchar ip_ttl; /* time to live */
283 uchar ip_p; /* protocol */
284 ushort ip_sum; /* checksum */
285 IPaddr_t ip_src; /* Source IP address */
286 IPaddr_t ip_dst; /* Destination IP address */
287 ushort udp_src; /* UDP source port */
288 ushort udp_dst; /* UDP destination port */
289 ushort udp_len; /* Length of UDP packet */
290 ushort udp_xsum; /* Checksum */
Joe Hershberger594c26f2012-05-23 07:58:04 +0000291};
wdenk2d966952002-10-31 22:12:35 +0000292
Joe Hershberger594c26f2012-05-23 07:58:04 +0000293#define IP_UDP_HDR_SIZE (sizeof(struct ip_udp_hdr))
Joe Hershbergerc5c59df2012-05-23 07:58:05 +0000294#define UDP_HDR_SIZE (IP_UDP_HDR_SIZE - IP_HDR_SIZE)
wdenk2d966952002-10-31 22:12:35 +0000295
296/*
297 * Address Resolution Protocol (ARP) header.
298 */
Joe Hershberger738853b2012-05-23 07:58:08 +0000299struct arp_hdr {
wdenk2d966952002-10-31 22:12:35 +0000300 ushort ar_hrd; /* Format of hardware address */
301# define ARP_ETHER 1 /* Ethernet hardware address */
302 ushort ar_pro; /* Format of protocol address */
303 uchar ar_hln; /* Length of hardware address */
Joe Hershberger674bb242012-05-23 07:58:17 +0000304# define ARP_HLEN 6
wdenk2d966952002-10-31 22:12:35 +0000305 uchar ar_pln; /* Length of protocol address */
Joe Hershberger674bb242012-05-23 07:58:17 +0000306# define ARP_PLEN 4
wdenk2d966952002-10-31 22:12:35 +0000307 ushort ar_op; /* Operation */
308# define ARPOP_REQUEST 1 /* Request to resolve address */
309# define ARPOP_REPLY 2 /* Response to previous request */
310
311# define RARPOP_REQUEST 3 /* Request to resolve address */
312# define RARPOP_REPLY 4 /* Response to previous request */
313
314 /*
wdenk8bde7f72003-06-27 21:31:46 +0000315 * The remaining fields are variable in size, according to
316 * the sizes above, and are defined as appropriate for
317 * specific hardware/protocol combinations.
wdenk2d966952002-10-31 22:12:35 +0000318 */
319 uchar ar_data[0];
Joe Hershberger674bb242012-05-23 07:58:17 +0000320#define ar_sha ar_data[0]
321#define ar_spa ar_data[ARP_HLEN]
322#define ar_tha ar_data[ARP_HLEN + ARP_PLEN]
323#define ar_tpa ar_data[ARP_HLEN + ARP_PLEN + ARP_HLEN]
wdenk2d966952002-10-31 22:12:35 +0000324#if 0
325 uchar ar_sha[]; /* Sender hardware address */
326 uchar ar_spa[]; /* Sender protocol address */
327 uchar ar_tha[]; /* Target hardware address */
328 uchar ar_tpa[]; /* Target protocol address */
329#endif /* 0 */
Joe Hershberger738853b2012-05-23 07:58:08 +0000330};
wdenk2d966952002-10-31 22:12:35 +0000331
332#define ARP_HDR_SIZE (8+20) /* Size assuming ethernet */
333
334/*
335 * ICMP stuff (just enough to handle (host) redirect messages)
336 */
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200337#define ICMP_ECHO_REPLY 0 /* Echo reply */
Simon Glass4793ee62011-10-24 18:00:01 +0000338#define ICMP_NOT_REACH 3 /* Detination unreachable */
wdenk2d966952002-10-31 22:12:35 +0000339#define ICMP_REDIRECT 5 /* Redirect (change route) */
wdenk73a8b272003-06-05 19:27:42 +0000340#define ICMP_ECHO_REQUEST 8 /* Echo request */
wdenk2d966952002-10-31 22:12:35 +0000341
342/* Codes for REDIRECT. */
343#define ICMP_REDIR_NET 0 /* Redirect Net */
344#define ICMP_REDIR_HOST 1 /* Redirect Host */
345
Simon Glass4793ee62011-10-24 18:00:01 +0000346/* Codes for NOT_REACH */
347#define ICMP_NOT_REACH_PORT 3 /* Port unreachable */
348
Joe Hershbergere0a63072012-05-23 07:58:09 +0000349struct icmp_hdr {
wdenk2d966952002-10-31 22:12:35 +0000350 uchar type;
351 uchar code;
352 ushort checksum;
353 union {
354 struct {
355 ushort id;
356 ushort sequence;
357 } echo;
358 ulong gateway;
359 struct {
360 ushort __unused;
361 ushort mtu;
362 } frag;
Simon Glass4793ee62011-10-24 18:00:01 +0000363 uchar data[0];
wdenk2d966952002-10-31 22:12:35 +0000364 } un;
Joe Hershbergere0a63072012-05-23 07:58:09 +0000365};
wdenk2d966952002-10-31 22:12:35 +0000366
Joe Hershbergere0a63072012-05-23 07:58:09 +0000367#define ICMP_HDR_SIZE (sizeof(struct icmp_hdr))
368#define IP_ICMP_HDR_SIZE (IP_HDR_SIZE + ICMP_HDR_SIZE)
wdenk2d966952002-10-31 22:12:35 +0000369
wdenk2d966952002-10-31 22:12:35 +0000370/*
371 * Maximum packet size; used to allocate packet storage.
372 * TFTP packets can be 524 bytes + IP header + ethernet header.
373 * Lets be conservative, and go for 38 * 16. (Must also be
374 * a multiple of 32 bytes).
375 */
376/*
377 * AS.HARNOIS : Better to set PKTSIZE to maximum size because
378 * traffic type is not always controlled
379 * maximum packet size = 1518
380 * maximum packet size and multiple of 32 bytes = 1536
381 */
382#define PKTSIZE 1518
383#define PKTSIZE_ALIGN 1536
384/*#define PKTSIZE 608*/
385
386/*
387 * Maximum receive ring size; that is, the number of packets
388 * we can buffer before overflow happens. Basically, this just
389 * needs to be enough to prevent a packet being discarded while
390 * we are processing the previous one.
391 */
392#define RINGSZ 4
393#define RINGSZ_LOG2 2
394
395/**********************************************************************/
396/*
397 * Globals.
398 *
399 * Note:
400 *
401 * All variables of type IPaddr_t are stored in NETWORK byte order
402 * (big endian).
403 */
404
405/* net.c */
406/** BOOTP EXTENTIONS **/
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000407extern IPaddr_t NetOurGatewayIP; /* Our gateway IP address */
408extern IPaddr_t NetOurSubnetMask; /* Our subnet mask (0 = unknown) */
409extern IPaddr_t NetOurDNSIP; /* Our Domain Name Server (0 = unknown) */
Jon Loeliger1fe80d72007-07-09 22:08:34 -0500410#if defined(CONFIG_BOOTP_DNS2)
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000411extern IPaddr_t NetOurDNS2IP; /* Our 2nd Domain Name Server (0 = unknown) */
stroesefe389a82003-08-28 14:17:32 +0000412#endif
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000413extern char NetOurNISDomain[32]; /* Our NIS domain */
414extern char NetOurHostName[32]; /* Our hostname */
415extern char NetOurRootPath[64]; /* Our root path */
416extern ushort NetBootFileSize; /* Our boot file size in blocks */
wdenk2d966952002-10-31 22:12:35 +0000417/** END OF BOOTP EXTENTIONS **/
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000418extern ulong NetBootFileXferSize; /* size of bootfile in bytes */
419extern uchar NetOurEther[6]; /* Our ethernet address */
420extern uchar NetServerEther[6]; /* Boot server enet address */
421extern IPaddr_t NetOurIP; /* Our IP addr (0 = unknown) */
422extern IPaddr_t NetServerIP; /* Server IP addr (0 = unknown) */
Joe Hershbergerdb288a92012-05-15 08:59:04 +0000423extern uchar *NetTxPacket; /* THE transmit packet */
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000424extern uchar *NetRxPackets[PKTBUFSRX]; /* Receive packets */
Joe Hershbergerdb288a92012-05-15 08:59:04 +0000425extern uchar *NetRxPacket; /* Current receive packet */
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000426extern int NetRxPacketLen; /* Current rx packet length */
427extern unsigned NetIPID; /* IP ID (counting) */
428extern uchar NetBcastAddr[6]; /* Ethernet boardcast address */
wdenk68ceb292004-08-02 21:11:11 +0000429extern uchar NetEtherNullAddr[6];
wdenk2d966952002-10-31 22:12:35 +0000430
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000431#define VLAN_NONE 4095 /* untagged */
432#define VLAN_IDMASK 0x0fff /* mask of valid vlan id */
433extern ushort NetOurVLAN; /* Our VLAN */
434extern ushort NetOurNativeVLAN; /* Our Native VLAN */
wdenka3d991b2004-04-15 21:48:45 +0000435
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000436extern int NetRestartWrap; /* Tried all network devices */
wdenk2d966952002-10-31 22:12:35 +0000437
Simon Glasse4bf0c52011-10-24 18:00:02 +0000438enum proto_t {
439 BOOTP, RARP, ARP, TFTPGET, DHCP, PING, DNS, NFS, CDP, NETCONS, SNTP,
Joe Hershbergerd22c3382012-05-23 08:00:12 +0000440 TFTPSRV, TFTPPUT, LINKLOCAL
Simon Glasse4bf0c52011-10-24 18:00:02 +0000441};
wdenk2d966952002-10-31 22:12:35 +0000442
443/* from net/net.c */
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000444extern char BootFile[128]; /* Boot File name */
wdenk2d966952002-10-31 22:12:35 +0000445
Robin Getz1a32bf42009-07-20 14:53:54 -0400446#if defined(CONFIG_CMD_DNS)
447extern char *NetDNSResolve; /* The host to resolve */
448extern char *NetDNSenvvar; /* the env var to put the ip into */
449#endif
450
Jon Loeliger639221c2007-07-09 17:15:49 -0500451#if defined(CONFIG_CMD_PING)
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000452extern IPaddr_t NetPingIP; /* the ip address to ping */
wdenk73a8b272003-06-05 19:27:42 +0000453#endif
454
Jon Loeliger639221c2007-07-09 17:15:49 -0500455#if defined(CONFIG_CMD_CDP)
wdenka3d991b2004-04-15 21:48:45 +0000456/* when CDP completes these hold the return values */
Joe Hershbergerf575ae12012-05-23 07:57:59 +0000457extern ushort CDPNativeVLAN; /* CDP returned native VLAN */
458extern ushort CDPApplianceVLAN; /* CDP returned appliance VLAN */
Joe Hershberger17351882012-05-23 07:58:00 +0000459
460/*
461 * Check for a CDP packet by examining the received MAC address field
462 */
463static inline int is_cdp_packet(const uchar *et_addr)
464{
465 extern const uchar NetCDPAddr[6];
466
467 return memcmp(et_addr, NetCDPAddr, 6) == 0;
468}
wdenka3d991b2004-04-15 21:48:45 +0000469#endif
470
Jon Loeliger639221c2007-07-09 17:15:49 -0500471#if defined(CONFIG_CMD_SNTP)
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000472extern IPaddr_t NetNtpServerIP; /* the ip address to NTP */
473extern int NetTimeOffset; /* offset time from UTC */
wdenkea287de2005-04-01 00:25:43 +0000474#endif
475
Joe Hershberger13dfe942012-05-15 08:59:12 +0000476#if defined(CONFIG_MCAST_TFTP)
477extern IPaddr_t Mcast_addr;
478#endif
479
wdenk2d966952002-10-31 22:12:35 +0000480/* Initialize the network adapter */
Joe Hershberger46c495d2012-05-23 07:59:22 +0000481extern void net_init(void);
Simon Glasse4bf0c52011-10-24 18:00:02 +0000482extern int NetLoop(enum proto_t);
wdenk2d966952002-10-31 22:12:35 +0000483
484/* Shutdown adapters and cleanup */
485extern void NetStop(void);
486
487/* Load failed. Start again. */
488extern void NetStartAgain(void);
489
wdenka3d991b2004-04-15 21:48:45 +0000490/* Get size of the ethernet header when we send */
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200491extern int NetEthHdrSize(void);
wdenka3d991b2004-04-15 21:48:45 +0000492
493/* Set ethernet header; returns the size of the header */
Joe Hershbergerdb288a92012-05-15 08:59:04 +0000494extern int NetSetEther(uchar *, uchar *, uint);
Joe Hershbergere7111012012-05-23 07:59:16 +0000495extern int net_update_ether(struct ethernet_hdr *et, uchar *addr, uint prot);
wdenk2d966952002-10-31 22:12:35 +0000496
497/* Set IP header */
Joe Hershberger4b11c912012-05-23 07:59:07 +0000498extern void net_set_ip_header(uchar *pkt, IPaddr_t dest, IPaddr_t source);
499extern void net_set_udp_header(uchar *pkt, IPaddr_t dest, int dport,
500 int sport, int len);
wdenk2d966952002-10-31 22:12:35 +0000501
502/* Checksum */
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000503extern int NetCksumOk(uchar *, int); /* Return true if cksum OK */
504extern uint NetCksum(uchar *, int); /* Calculate the checksum */
wdenk2d966952002-10-31 22:12:35 +0000505
Joe Hershbergerd280d3f2012-05-23 07:58:01 +0000506/* Callbacks */
Joe Hershbergerece223b2012-05-23 07:59:15 +0000507extern rxhand_f *net_get_udp_handler(void); /* Get UDP RX packet handler */
508extern void net_set_udp_handler(rxhand_f *); /* Set UDP RX packet handler */
509extern rxhand_f *net_get_arp_handler(void); /* Get ARP RX packet handler */
510extern void net_set_arp_handler(rxhand_f *); /* Set ARP RX packet handler */
Simon Glass4793ee62011-10-24 18:00:01 +0000511extern void net_set_icmp_handler(rxhand_icmp_f *f); /* Set ICMP RX handler */
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000512extern void NetSetTimeout(ulong, thand_f *);/* Set timeout handler */
wdenk2d966952002-10-31 22:12:35 +0000513
Joe Hershberger22f6e992012-05-23 07:59:14 +0000514/* Network loop state */
515enum net_loop_state {
516 NETLOOP_CONTINUE,
517 NETLOOP_RESTART,
518 NETLOOP_SUCCESS,
519 NETLOOP_FAIL
520};
Kim Phillips06370592012-10-29 13:34:33 +0000521extern enum net_loop_state net_state;
522
Joe Hershberger22f6e992012-05-23 07:59:14 +0000523static inline void net_set_state(enum net_loop_state state)
524{
Joe Hershberger4ef8d532012-05-23 08:01:04 +0000525 debug_cond(DEBUG_INT_STATE, "--- NetState set to %d\n", state);
Joe Hershberger22f6e992012-05-23 07:59:14 +0000526 net_state = state;
527}
528
Joe Hershbergere94070c2012-05-23 07:59:24 +0000529/* Transmit a packet */
Joe Hershbergeradf5d932012-05-23 07:59:13 +0000530static inline void NetSendPacket(uchar *pkt, int len)
531{
532 (void) eth_send(pkt, len);
533}
wdenk2d966952002-10-31 22:12:35 +0000534
Joe Hershberger206d07f2012-05-23 07:58:10 +0000535/*
Joe Hershbergere94070c2012-05-23 07:59:24 +0000536 * Transmit "NetTxPacket" as UDP packet, performing ARP request if needed
Joe Hershbergerece223b2012-05-23 07:59:15 +0000537 * (ether will be populated)
Joe Hershberger206d07f2012-05-23 07:58:10 +0000538 *
539 * @param ether Raw packet buffer
540 * @param dest IP address to send the datagram to
541 * @param dport Destination UDP port
542 * @param sport Source UDP port
543 * @param payload_len Length of data after the UDP header
544 */
Joe Hershbergere94070c2012-05-23 07:59:24 +0000545extern int NetSendUDPPacket(uchar *ether, IPaddr_t dest, int dport,
Joe Hershberger206d07f2012-05-23 07:58:10 +0000546 int sport, int payload_len);
wdenk73a8b272003-06-05 19:27:42 +0000547
wdenk2d966952002-10-31 22:12:35 +0000548/* Processes a received packet */
Joe Hershbergerdb288a92012-05-15 08:59:04 +0000549extern void NetReceive(uchar *, int);
wdenk2d966952002-10-31 22:12:35 +0000550
Joe Hershberger48522bb2012-05-15 08:59:08 +0000551#ifdef CONFIG_NETCONSOLE
552void NcStart(void);
Joe Hershberger8a0eccb2012-09-18 10:01:32 +0000553int nc_input_packet(uchar *pkt, IPaddr_t src_ip, unsigned dest_port,
554 unsigned src_port, unsigned len);
Joe Hershberger48522bb2012-05-15 08:59:08 +0000555#endif
556
Joe Hershbergerf8be7d62012-08-03 10:59:08 +0000557static inline __attribute__((always_inline)) int eth_is_on_demand_init(void)
558{
559#ifdef CONFIG_NETCONSOLE
560 extern enum proto_t net_loop_last_protocol;
561
562 return net_loop_last_protocol != NETCONS;
563#else
564 return 1;
565#endif
566}
567
568static inline void eth_set_last_protocol(int protocol)
569{
570#ifdef CONFIG_NETCONSOLE
571 extern enum proto_t net_loop_last_protocol;
572
573 net_loop_last_protocol = protocol;
574#endif
575}
576
wdenk2d966952002-10-31 22:12:35 +0000577/*
Simon Glasse4a3d572011-10-27 06:24:32 +0000578 * Check if autoload is enabled. If so, use either NFS or TFTP to download
579 * the boot file.
580 */
581void net_auto_load(void);
582
583/*
wdenk2d966952002-10-31 22:12:35 +0000584 * The following functions are a bit ugly, but necessary to deal with
585 * alignment restrictions on ARM.
586 *
587 * We're using inline functions, which had the smallest memory
588 * footprint in our tests.
589 */
590/* return IP *in network byteorder* */
Joe Hershbergerdb288a92012-05-15 08:59:04 +0000591static inline IPaddr_t NetReadIP(void *from)
wdenk2d966952002-10-31 22:12:35 +0000592{
593 IPaddr_t ip;
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000594
595 memcpy((void *)&ip, (void *)from, sizeof(ip));
wdenk2d966952002-10-31 22:12:35 +0000596 return ip;
597}
598
599/* return ulong *in network byteorder* */
600static inline ulong NetReadLong(ulong *from)
601{
602 ulong l;
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000603
604 memcpy((void *)&l, (void *)from, sizeof(l));
wdenk2d966952002-10-31 22:12:35 +0000605 return l;
606}
607
608/* write IP *in network byteorder* */
609static inline void NetWriteIP(void *to, IPaddr_t ip)
610{
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000611 memcpy(to, (void *)&ip, sizeof(ip));
wdenk2d966952002-10-31 22:12:35 +0000612}
613
614/* copy IP */
Joe Hershbergerdb288a92012-05-15 08:59:04 +0000615static inline void NetCopyIP(void *to, void *from)
wdenk2d966952002-10-31 22:12:35 +0000616{
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000617 memcpy((void *)to, from, sizeof(IPaddr_t));
wdenk2d966952002-10-31 22:12:35 +0000618}
619
620/* copy ulong */
621static inline void NetCopyLong(ulong *to, ulong *from)
622{
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000623 memcpy((void *)to, (void *)from, sizeof(ulong));
wdenk2d966952002-10-31 22:12:35 +0000624}
625
Mike Rapoport50cca8b2007-08-12 08:48:27 +0300626/**
627 * is_zero_ether_addr - Determine if give Ethernet address is all zeros.
628 * @addr: Pointer to a six-byte array containing the Ethernet address
629 *
630 * Return true if the address is all zeroes.
631 */
632static inline int is_zero_ether_addr(const u8 *addr)
633{
634 return !(addr[0] | addr[1] | addr[2] | addr[3] | addr[4] | addr[5]);
635}
636
637/**
638 * is_multicast_ether_addr - Determine if the Ethernet address is a multicast.
639 * @addr: Pointer to a six-byte array containing the Ethernet address
640 *
641 * Return true if the address is a multicast address.
642 * By definition the broadcast address is also a multicast address.
643 */
644static inline int is_multicast_ether_addr(const u8 *addr)
645{
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000646 return 0x01 & addr[0];
Mike Rapoport50cca8b2007-08-12 08:48:27 +0300647}
648
Remy Bohmer23cd1382009-07-29 18:18:43 +0200649/*
650 * is_broadcast_ether_addr - Determine if the Ethernet address is broadcast
651 * @addr: Pointer to a six-byte array containing the Ethernet address
652 *
653 * Return true if the address is the broadcast address.
654 */
655static inline int is_broadcast_ether_addr(const u8 *addr)
656{
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000657 return (addr[0] & addr[1] & addr[2] & addr[3] & addr[4] & addr[5]) ==
658 0xff;
Remy Bohmer23cd1382009-07-29 18:18:43 +0200659}
660
661/*
Mike Frysinger75edebe2009-01-27 16:53:39 -0500662 * is_valid_ether_addr - Determine if the given Ethernet address is valid
663 * @addr: Pointer to a six-byte array containing the Ethernet address
664 *
665 * Check that the Ethernet address (MAC) is not 00:00:00:00:00:00, is not
666 * a multicast address, and is not FF:FF:FF:FF:FF:FF.
667 *
668 * Return true if the address is valid.
669 */
Remy Bohmer23cd1382009-07-29 18:18:43 +0200670static inline int is_valid_ether_addr(const u8 *addr)
Mike Frysinger75edebe2009-01-27 16:53:39 -0500671{
672 /* FF:FF:FF:FF:FF:FF is a multicast address so we don't need to
673 * explicitly check for it here. */
674 return !is_multicast_ether_addr(addr) && !is_zero_ether_addr(addr);
675}
676
wdenk2d966952002-10-31 22:12:35 +0000677/* Convert an IP address to a string */
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000678extern void ip_to_string(IPaddr_t x, char *s);
wdenk2d966952002-10-31 22:12:35 +0000679
wdenk73a8b272003-06-05 19:27:42 +0000680/* Convert a string to ip address */
Mike Frysinger908c6b62010-10-20 07:16:58 -0400681extern IPaddr_t string_to_ip(const char *s);
wdenk73a8b272003-06-05 19:27:42 +0000682
wdenka3d991b2004-04-15 21:48:45 +0000683/* Convert a VLAN id to a string */
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000684extern void VLAN_to_string(ushort x, char *s);
wdenka3d991b2004-04-15 21:48:45 +0000685
686/* Convert a string to a vlan id */
Mike Frysinger2e3ef6e2010-10-20 07:16:48 -0400687extern ushort string_to_VLAN(const char *s);
wdenka3d991b2004-04-15 21:48:45 +0000688
wdenka3d991b2004-04-15 21:48:45 +0000689/* read a VLAN id from an environment variable */
690extern ushort getenv_VLAN(char *);
691
wdenk2d966952002-10-31 22:12:35 +0000692/* copy a filename (allow for "..." notation, limit length) */
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000693extern void copy_filename(char *dst, const char *src, int size);
wdenk2d966952002-10-31 22:12:35 +0000694
Mike Frysinger91b469c2009-09-02 04:18:55 -0400695/* get a random source port */
696extern unsigned int random_port(void);
697
Simon Glassea5427e2013-05-15 06:23:54 +0000698/* Update U-Boot over TFTP */
699extern int update_tftp(ulong addr);
700
wdenk2d966952002-10-31 22:12:35 +0000701/**********************************************************************/
702
703#endif /* __NET_H__ */