blob: 735b0b9d26f57cd45afc111a00a5bc96a96d53b0 [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
Claudiu Manoil9c4cffa2013-09-30 12:44:39 +030092 int (*mcast) (struct eth_device *, const u8 *enetaddr, 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
Remy Bohmer23cd1382009-07-29 18:18:43 +0200133extern int usb_eth_initialize(bd_t *bi);
Andy Fleming5dc0cf62009-02-11 15:10:31 -0600134extern int eth_init(bd_t *bis); /* Initialize the device */
Joe Hershbergerdb288a92012-05-15 08:59:04 +0000135extern int eth_send(void *packet, int length); /* Send a packet */
Remy Bohmer23cd1382009-07-29 18:18:43 +0200136
Rafal Jaworowskif85b6072007-12-27 18:19:02 +0100137#ifdef CONFIG_API
Joe Hershbergerdb288a92012-05-15 08:59:04 +0000138extern int eth_receive(void *packet, int length); /* Receive a packet*/
139extern void (*push_packet)(void *packet, int length);
Rafal Jaworowskif85b6072007-12-27 18:19:02 +0100140#endif
Andy Fleming5dc0cf62009-02-11 15:10:31 -0600141extern int eth_rx(void); /* Check for received packets */
142extern void eth_halt(void); /* stop SCC */
143extern char *eth_get_name(void); /* get name of current device */
wdenk2d966952002-10-31 22:12:35 +0000144
Joe Hershbergerf8be7d62012-08-03 10:59:08 +0000145/* Set active state */
146static 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 */
153static inline __attribute__((always_inline)) void eth_halt_state_only(void)
154{
155 eth_get_dev()->state = ETH_STATE_PASSIVE;
156}
157
Simon Glass7616e782011-06-13 16:13:10 -0700158/*
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 */
167int eth_write_hwaddr(struct eth_device *dev, const char *base_name,
168 int eth_number);
169
David Updegraff53a5c422007-06-11 10:41:07 -0500170#ifdef CONFIG_MCAST_TFTP
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000171int eth_mcast_join(IPaddr_t mcast_addr, u8 join);
172u32 ether_crc(size_t len, unsigned char const *p);
David Updegraff53a5c422007-06-11 10:41:07 -0500173#endif
174
wdenk2d966952002-10-31 22:12:35 +0000175
176/**********************************************************************/
177/*
178 * Protocol headers.
179 */
180
181/*
182 * Ethernet header
183 */
Joe Hershbergercb487f52012-05-23 07:58:06 +0000184
185struct 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
194struct e802_hdr {
wdenk2d966952002-10-31 22:12:35 +0000195 uchar et_dest[6]; /* Destination node */
196 uchar et_src[6]; /* Source node */
197 ushort et_protlen; /* Protocol or length */
198 uchar et_dsap; /* 802 DSAP */
199 uchar et_ssap; /* 802 SSAP */
200 uchar et_ctl; /* 802 control */
201 uchar et_snap1; /* SNAP */
202 uchar et_snap2;
203 uchar et_snap3;
204 ushort et_prot; /* 802 protocol */
Joe Hershbergercb487f52012-05-23 07:58:06 +0000205};
wdenk2d966952002-10-31 22:12:35 +0000206
Joe Hershbergerda5ebe22012-05-23 07:58:11 +0000207/* 802 + SNAP + ethernet header size */
Joe Hershbergercb487f52012-05-23 07:58:06 +0000208#define E802_HDR_SIZE (sizeof(struct e802_hdr))
wdenka3d991b2004-04-15 21:48:45 +0000209
210/*
Joe Hershbergerda5ebe22012-05-23 07:58:11 +0000211 * Virtual LAN Ethernet header
wdenka3d991b2004-04-15 21:48:45 +0000212 */
Joe Hershbergerc68cca32012-05-23 07:58:07 +0000213struct vlan_ethernet_hdr {
wdenka3d991b2004-04-15 21:48:45 +0000214 uchar vet_dest[6]; /* Destination node */
215 uchar vet_src[6]; /* Source node */
216 ushort vet_vlan_type; /* PROT_VLAN */
217 ushort vet_tag; /* TAG of VLAN */
218 ushort vet_type; /* protocol type */
Joe Hershbergerc68cca32012-05-23 07:58:07 +0000219};
wdenka3d991b2004-04-15 21:48:45 +0000220
Joe Hershbergerc68cca32012-05-23 07:58:07 +0000221/* VLAN Ethernet header size */
222#define VLAN_ETHER_HDR_SIZE (sizeof(struct vlan_ethernet_hdr))
wdenka3d991b2004-04-15 21:48:45 +0000223
wdenk2d966952002-10-31 22:12:35 +0000224#define PROT_IP 0x0800 /* IP protocol */
225#define PROT_ARP 0x0806 /* IP ARP protocol */
226#define PROT_RARP 0x8035 /* IP ARP protocol */
wdenka3d991b2004-04-15 21:48:45 +0000227#define PROT_VLAN 0x8100 /* IEEE 802.1q protocol */
wdenk2d966952002-10-31 22:12:35 +0000228
229#define IPPROTO_ICMP 1 /* Internet Control Message Protocol */
230#define IPPROTO_UDP 17 /* User Datagram Protocol */
231
232/*
Joe Hershbergerc5c59df2012-05-23 07:58:05 +0000233 * Internet Protocol (IP) header.
234 */
235struct ip_hdr {
236 uchar ip_hl_v; /* header length and version */
237 uchar ip_tos; /* type of service */
238 ushort ip_len; /* total length */
239 ushort ip_id; /* identification */
240 ushort ip_off; /* fragment offset field */
241 uchar ip_ttl; /* time to live */
242 uchar ip_p; /* protocol */
243 ushort ip_sum; /* checksum */
244 IPaddr_t ip_src; /* Source IP address */
245 IPaddr_t ip_dst; /* Destination IP address */
246};
247
248#define IP_OFFS 0x1fff /* ip offset *= 8 */
249#define IP_FLAGS 0xe000 /* first 3 bits */
250#define IP_FLAGS_RES 0x8000 /* reserved */
251#define IP_FLAGS_DFRAG 0x4000 /* don't fragments */
252#define IP_FLAGS_MFRAG 0x2000 /* more fragments */
253
254#define IP_HDR_SIZE (sizeof(struct ip_hdr))
255
256/*
Joe Hershberger594c26f2012-05-23 07:58:04 +0000257 * Internet Protocol (IP) + UDP header.
wdenk2d966952002-10-31 22:12:35 +0000258 */
Joe Hershberger594c26f2012-05-23 07:58:04 +0000259struct ip_udp_hdr {
wdenk2d966952002-10-31 22:12:35 +0000260 uchar ip_hl_v; /* header length and version */
261 uchar ip_tos; /* type of service */
262 ushort ip_len; /* total length */
263 ushort ip_id; /* identification */
264 ushort ip_off; /* fragment offset field */
265 uchar ip_ttl; /* time to live */
266 uchar ip_p; /* protocol */
267 ushort ip_sum; /* checksum */
268 IPaddr_t ip_src; /* Source IP address */
269 IPaddr_t ip_dst; /* Destination IP address */
270 ushort udp_src; /* UDP source port */
271 ushort udp_dst; /* UDP destination port */
272 ushort udp_len; /* Length of UDP packet */
273 ushort udp_xsum; /* Checksum */
Joe Hershberger594c26f2012-05-23 07:58:04 +0000274};
wdenk2d966952002-10-31 22:12:35 +0000275
Joe Hershberger594c26f2012-05-23 07:58:04 +0000276#define IP_UDP_HDR_SIZE (sizeof(struct ip_udp_hdr))
Joe Hershbergerc5c59df2012-05-23 07:58:05 +0000277#define UDP_HDR_SIZE (IP_UDP_HDR_SIZE - IP_HDR_SIZE)
wdenk2d966952002-10-31 22:12:35 +0000278
279/*
280 * Address Resolution Protocol (ARP) header.
281 */
Joe Hershberger738853b2012-05-23 07:58:08 +0000282struct arp_hdr {
wdenk2d966952002-10-31 22:12:35 +0000283 ushort ar_hrd; /* Format of hardware address */
284# define ARP_ETHER 1 /* Ethernet hardware address */
285 ushort ar_pro; /* Format of protocol address */
286 uchar ar_hln; /* Length of hardware address */
Joe Hershberger674bb242012-05-23 07:58:17 +0000287# define ARP_HLEN 6
wdenk2d966952002-10-31 22:12:35 +0000288 uchar ar_pln; /* Length of protocol address */
Joe Hershberger674bb242012-05-23 07:58:17 +0000289# define ARP_PLEN 4
wdenk2d966952002-10-31 22:12:35 +0000290 ushort ar_op; /* Operation */
291# define ARPOP_REQUEST 1 /* Request to resolve address */
292# define ARPOP_REPLY 2 /* Response to previous request */
293
294# define RARPOP_REQUEST 3 /* Request to resolve address */
295# define RARPOP_REPLY 4 /* Response to previous request */
296
297 /*
wdenk8bde7f72003-06-27 21:31:46 +0000298 * The remaining fields are variable in size, according to
299 * the sizes above, and are defined as appropriate for
300 * specific hardware/protocol combinations.
wdenk2d966952002-10-31 22:12:35 +0000301 */
302 uchar ar_data[0];
Joe Hershberger674bb242012-05-23 07:58:17 +0000303#define ar_sha ar_data[0]
304#define ar_spa ar_data[ARP_HLEN]
305#define ar_tha ar_data[ARP_HLEN + ARP_PLEN]
306#define ar_tpa ar_data[ARP_HLEN + ARP_PLEN + ARP_HLEN]
wdenk2d966952002-10-31 22:12:35 +0000307#if 0
308 uchar ar_sha[]; /* Sender hardware address */
309 uchar ar_spa[]; /* Sender protocol address */
310 uchar ar_tha[]; /* Target hardware address */
311 uchar ar_tpa[]; /* Target protocol address */
312#endif /* 0 */
Joe Hershberger738853b2012-05-23 07:58:08 +0000313};
wdenk2d966952002-10-31 22:12:35 +0000314
315#define ARP_HDR_SIZE (8+20) /* Size assuming ethernet */
316
317/*
318 * ICMP stuff (just enough to handle (host) redirect messages)
319 */
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200320#define ICMP_ECHO_REPLY 0 /* Echo reply */
Simon Glass4793ee62011-10-24 18:00:01 +0000321#define ICMP_NOT_REACH 3 /* Detination unreachable */
wdenk2d966952002-10-31 22:12:35 +0000322#define ICMP_REDIRECT 5 /* Redirect (change route) */
wdenk73a8b272003-06-05 19:27:42 +0000323#define ICMP_ECHO_REQUEST 8 /* Echo request */
wdenk2d966952002-10-31 22:12:35 +0000324
325/* Codes for REDIRECT. */
326#define ICMP_REDIR_NET 0 /* Redirect Net */
327#define ICMP_REDIR_HOST 1 /* Redirect Host */
328
Simon Glass4793ee62011-10-24 18:00:01 +0000329/* Codes for NOT_REACH */
330#define ICMP_NOT_REACH_PORT 3 /* Port unreachable */
331
Joe Hershbergere0a63072012-05-23 07:58:09 +0000332struct icmp_hdr {
wdenk2d966952002-10-31 22:12:35 +0000333 uchar type;
334 uchar code;
335 ushort checksum;
336 union {
337 struct {
338 ushort id;
339 ushort sequence;
340 } echo;
341 ulong gateway;
342 struct {
Jeroen Hofstee6e840eb2013-08-10 16:52:47 +0200343 ushort unused;
wdenk2d966952002-10-31 22:12:35 +0000344 ushort mtu;
345 } frag;
Simon Glass4793ee62011-10-24 18:00:01 +0000346 uchar data[0];
wdenk2d966952002-10-31 22:12:35 +0000347 } un;
Joe Hershbergere0a63072012-05-23 07:58:09 +0000348};
wdenk2d966952002-10-31 22:12:35 +0000349
Joe Hershbergere0a63072012-05-23 07:58:09 +0000350#define ICMP_HDR_SIZE (sizeof(struct icmp_hdr))
351#define IP_ICMP_HDR_SIZE (IP_HDR_SIZE + ICMP_HDR_SIZE)
wdenk2d966952002-10-31 22:12:35 +0000352
wdenk2d966952002-10-31 22:12:35 +0000353/*
354 * Maximum packet size; used to allocate packet storage.
355 * TFTP packets can be 524 bytes + IP header + ethernet header.
356 * Lets be conservative, and go for 38 * 16. (Must also be
357 * a multiple of 32 bytes).
358 */
359/*
360 * AS.HARNOIS : Better to set PKTSIZE to maximum size because
361 * traffic type is not always controlled
362 * maximum packet size = 1518
363 * maximum packet size and multiple of 32 bytes = 1536
364 */
365#define PKTSIZE 1518
366#define PKTSIZE_ALIGN 1536
367/*#define PKTSIZE 608*/
368
369/*
370 * Maximum receive ring size; that is, the number of packets
371 * we can buffer before overflow happens. Basically, this just
372 * needs to be enough to prevent a packet being discarded while
373 * we are processing the previous one.
374 */
375#define RINGSZ 4
376#define RINGSZ_LOG2 2
377
378/**********************************************************************/
379/*
380 * Globals.
381 *
382 * Note:
383 *
384 * All variables of type IPaddr_t are stored in NETWORK byte order
385 * (big endian).
386 */
387
388/* net.c */
389/** BOOTP EXTENTIONS **/
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000390extern IPaddr_t NetOurGatewayIP; /* Our gateway IP address */
391extern IPaddr_t NetOurSubnetMask; /* Our subnet mask (0 = unknown) */
392extern IPaddr_t NetOurDNSIP; /* Our Domain Name Server (0 = unknown) */
Jon Loeliger1fe80d72007-07-09 22:08:34 -0500393#if defined(CONFIG_BOOTP_DNS2)
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000394extern IPaddr_t NetOurDNS2IP; /* Our 2nd Domain Name Server (0 = unknown) */
stroesefe389a82003-08-28 14:17:32 +0000395#endif
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000396extern char NetOurNISDomain[32]; /* Our NIS domain */
397extern char NetOurHostName[32]; /* Our hostname */
398extern char NetOurRootPath[64]; /* Our root path */
399extern ushort NetBootFileSize; /* Our boot file size in blocks */
wdenk2d966952002-10-31 22:12:35 +0000400/** END OF BOOTP EXTENTIONS **/
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000401extern ulong NetBootFileXferSize; /* size of bootfile in bytes */
402extern uchar NetOurEther[6]; /* Our ethernet address */
403extern uchar NetServerEther[6]; /* Boot server enet address */
404extern IPaddr_t NetOurIP; /* Our IP addr (0 = unknown) */
405extern IPaddr_t NetServerIP; /* Server IP addr (0 = unknown) */
Joe Hershbergerdb288a92012-05-15 08:59:04 +0000406extern uchar *NetTxPacket; /* THE transmit packet */
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000407extern uchar *NetRxPackets[PKTBUFSRX]; /* Receive packets */
Joe Hershbergerdb288a92012-05-15 08:59:04 +0000408extern uchar *NetRxPacket; /* Current receive packet */
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000409extern int NetRxPacketLen; /* Current rx packet length */
410extern unsigned NetIPID; /* IP ID (counting) */
411extern uchar NetBcastAddr[6]; /* Ethernet boardcast address */
wdenk68ceb292004-08-02 21:11:11 +0000412extern uchar NetEtherNullAddr[6];
wdenk2d966952002-10-31 22:12:35 +0000413
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000414#define VLAN_NONE 4095 /* untagged */
415#define VLAN_IDMASK 0x0fff /* mask of valid vlan id */
416extern ushort NetOurVLAN; /* Our VLAN */
417extern ushort NetOurNativeVLAN; /* Our Native VLAN */
wdenka3d991b2004-04-15 21:48:45 +0000418
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000419extern int NetRestartWrap; /* Tried all network devices */
wdenk2d966952002-10-31 22:12:35 +0000420
Simon Glasse4bf0c52011-10-24 18:00:02 +0000421enum proto_t {
422 BOOTP, RARP, ARP, TFTPGET, DHCP, PING, DNS, NFS, CDP, NETCONS, SNTP,
Joe Hershbergerd22c3382012-05-23 08:00:12 +0000423 TFTPSRV, TFTPPUT, LINKLOCAL
Simon Glasse4bf0c52011-10-24 18:00:02 +0000424};
wdenk2d966952002-10-31 22:12:35 +0000425
426/* from net/net.c */
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000427extern char BootFile[128]; /* Boot File name */
wdenk2d966952002-10-31 22:12:35 +0000428
Robin Getz1a32bf42009-07-20 14:53:54 -0400429#if defined(CONFIG_CMD_DNS)
430extern char *NetDNSResolve; /* The host to resolve */
431extern char *NetDNSenvvar; /* the env var to put the ip into */
432#endif
433
Jon Loeliger639221c2007-07-09 17:15:49 -0500434#if defined(CONFIG_CMD_PING)
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000435extern IPaddr_t NetPingIP; /* the ip address to ping */
wdenk73a8b272003-06-05 19:27:42 +0000436#endif
437
Jon Loeliger639221c2007-07-09 17:15:49 -0500438#if defined(CONFIG_CMD_CDP)
wdenka3d991b2004-04-15 21:48:45 +0000439/* when CDP completes these hold the return values */
Joe Hershbergerf575ae12012-05-23 07:57:59 +0000440extern ushort CDPNativeVLAN; /* CDP returned native VLAN */
441extern ushort CDPApplianceVLAN; /* CDP returned appliance VLAN */
Joe Hershberger17351882012-05-23 07:58:00 +0000442
443/*
444 * Check for a CDP packet by examining the received MAC address field
445 */
446static inline int is_cdp_packet(const uchar *et_addr)
447{
448 extern const uchar NetCDPAddr[6];
449
450 return memcmp(et_addr, NetCDPAddr, 6) == 0;
451}
wdenka3d991b2004-04-15 21:48:45 +0000452#endif
453
Jon Loeliger639221c2007-07-09 17:15:49 -0500454#if defined(CONFIG_CMD_SNTP)
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000455extern IPaddr_t NetNtpServerIP; /* the ip address to NTP */
456extern int NetTimeOffset; /* offset time from UTC */
wdenkea287de2005-04-01 00:25:43 +0000457#endif
458
Joe Hershberger13dfe942012-05-15 08:59:12 +0000459#if defined(CONFIG_MCAST_TFTP)
460extern IPaddr_t Mcast_addr;
461#endif
462
wdenk2d966952002-10-31 22:12:35 +0000463/* Initialize the network adapter */
Joe Hershberger46c495d2012-05-23 07:59:22 +0000464extern void net_init(void);
Simon Glasse4bf0c52011-10-24 18:00:02 +0000465extern int NetLoop(enum proto_t);
wdenk2d966952002-10-31 22:12:35 +0000466
467/* Shutdown adapters and cleanup */
468extern void NetStop(void);
469
470/* Load failed. Start again. */
471extern void NetStartAgain(void);
472
wdenka3d991b2004-04-15 21:48:45 +0000473/* Get size of the ethernet header when we send */
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200474extern int NetEthHdrSize(void);
wdenka3d991b2004-04-15 21:48:45 +0000475
476/* Set ethernet header; returns the size of the header */
Joe Hershbergerdb288a92012-05-15 08:59:04 +0000477extern int NetSetEther(uchar *, uchar *, uint);
Joe Hershbergere7111012012-05-23 07:59:16 +0000478extern int net_update_ether(struct ethernet_hdr *et, uchar *addr, uint prot);
wdenk2d966952002-10-31 22:12:35 +0000479
480/* Set IP header */
Joe Hershberger4b11c912012-05-23 07:59:07 +0000481extern void net_set_ip_header(uchar *pkt, IPaddr_t dest, IPaddr_t source);
482extern void net_set_udp_header(uchar *pkt, IPaddr_t dest, int dport,
483 int sport, int len);
wdenk2d966952002-10-31 22:12:35 +0000484
485/* Checksum */
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000486extern int NetCksumOk(uchar *, int); /* Return true if cksum OK */
487extern uint NetCksum(uchar *, int); /* Calculate the checksum */
wdenk2d966952002-10-31 22:12:35 +0000488
Joe Hershbergerd280d3f2012-05-23 07:58:01 +0000489/* Callbacks */
Joe Hershbergerece223b2012-05-23 07:59:15 +0000490extern rxhand_f *net_get_udp_handler(void); /* Get UDP RX packet handler */
491extern void net_set_udp_handler(rxhand_f *); /* Set UDP RX packet handler */
492extern rxhand_f *net_get_arp_handler(void); /* Get ARP RX packet handler */
493extern void net_set_arp_handler(rxhand_f *); /* Set ARP RX packet handler */
Simon Glass4793ee62011-10-24 18:00:01 +0000494extern void net_set_icmp_handler(rxhand_icmp_f *f); /* Set ICMP RX handler */
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000495extern void NetSetTimeout(ulong, thand_f *);/* Set timeout handler */
wdenk2d966952002-10-31 22:12:35 +0000496
Joe Hershberger22f6e992012-05-23 07:59:14 +0000497/* Network loop state */
498enum net_loop_state {
499 NETLOOP_CONTINUE,
500 NETLOOP_RESTART,
501 NETLOOP_SUCCESS,
502 NETLOOP_FAIL
503};
Kim Phillips06370592012-10-29 13:34:33 +0000504extern enum net_loop_state net_state;
505
Joe Hershberger22f6e992012-05-23 07:59:14 +0000506static inline void net_set_state(enum net_loop_state state)
507{
Joe Hershberger4ef8d532012-05-23 08:01:04 +0000508 debug_cond(DEBUG_INT_STATE, "--- NetState set to %d\n", state);
Joe Hershberger22f6e992012-05-23 07:59:14 +0000509 net_state = state;
510}
511
Joe Hershbergere94070c2012-05-23 07:59:24 +0000512/* Transmit a packet */
Joe Hershbergeradf5d932012-05-23 07:59:13 +0000513static inline void NetSendPacket(uchar *pkt, int len)
514{
515 (void) eth_send(pkt, len);
516}
wdenk2d966952002-10-31 22:12:35 +0000517
Joe Hershberger206d07f2012-05-23 07:58:10 +0000518/*
Joe Hershbergere94070c2012-05-23 07:59:24 +0000519 * Transmit "NetTxPacket" as UDP packet, performing ARP request if needed
Joe Hershbergerece223b2012-05-23 07:59:15 +0000520 * (ether will be populated)
Joe Hershberger206d07f2012-05-23 07:58:10 +0000521 *
522 * @param ether Raw packet buffer
523 * @param dest IP address to send the datagram to
524 * @param dport Destination UDP port
525 * @param sport Source UDP port
526 * @param payload_len Length of data after the UDP header
527 */
Joe Hershbergere94070c2012-05-23 07:59:24 +0000528extern int NetSendUDPPacket(uchar *ether, IPaddr_t dest, int dport,
Joe Hershberger206d07f2012-05-23 07:58:10 +0000529 int sport, int payload_len);
wdenk73a8b272003-06-05 19:27:42 +0000530
wdenk2d966952002-10-31 22:12:35 +0000531/* Processes a received packet */
Joe Hershbergerdb288a92012-05-15 08:59:04 +0000532extern void NetReceive(uchar *, int);
wdenk2d966952002-10-31 22:12:35 +0000533
Joe Hershberger48522bb2012-05-15 08:59:08 +0000534#ifdef CONFIG_NETCONSOLE
535void NcStart(void);
Joe Hershberger8a0eccb2012-09-18 10:01:32 +0000536int nc_input_packet(uchar *pkt, IPaddr_t src_ip, unsigned dest_port,
537 unsigned src_port, unsigned len);
Joe Hershberger48522bb2012-05-15 08:59:08 +0000538#endif
539
Joe Hershbergerf8be7d62012-08-03 10:59:08 +0000540static inline __attribute__((always_inline)) int eth_is_on_demand_init(void)
541{
542#ifdef CONFIG_NETCONSOLE
543 extern enum proto_t net_loop_last_protocol;
544
545 return net_loop_last_protocol != NETCONS;
546#else
547 return 1;
548#endif
549}
550
551static inline void eth_set_last_protocol(int protocol)
552{
553#ifdef CONFIG_NETCONSOLE
554 extern enum proto_t net_loop_last_protocol;
555
556 net_loop_last_protocol = protocol;
557#endif
558}
559
wdenk2d966952002-10-31 22:12:35 +0000560/*
Simon Glasse4a3d572011-10-27 06:24:32 +0000561 * Check if autoload is enabled. If so, use either NFS or TFTP to download
562 * the boot file.
563 */
564void net_auto_load(void);
565
566/*
wdenk2d966952002-10-31 22:12:35 +0000567 * The following functions are a bit ugly, but necessary to deal with
568 * alignment restrictions on ARM.
569 *
570 * We're using inline functions, which had the smallest memory
571 * footprint in our tests.
572 */
573/* return IP *in network byteorder* */
Joe Hershbergerdb288a92012-05-15 08:59:04 +0000574static inline IPaddr_t NetReadIP(void *from)
wdenk2d966952002-10-31 22:12:35 +0000575{
576 IPaddr_t ip;
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000577
578 memcpy((void *)&ip, (void *)from, sizeof(ip));
wdenk2d966952002-10-31 22:12:35 +0000579 return ip;
580}
581
582/* return ulong *in network byteorder* */
583static inline ulong NetReadLong(ulong *from)
584{
585 ulong l;
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000586
587 memcpy((void *)&l, (void *)from, sizeof(l));
wdenk2d966952002-10-31 22:12:35 +0000588 return l;
589}
590
591/* write IP *in network byteorder* */
592static inline void NetWriteIP(void *to, IPaddr_t ip)
593{
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000594 memcpy(to, (void *)&ip, sizeof(ip));
wdenk2d966952002-10-31 22:12:35 +0000595}
596
597/* copy IP */
Joe Hershbergerdb288a92012-05-15 08:59:04 +0000598static inline void NetCopyIP(void *to, void *from)
wdenk2d966952002-10-31 22:12:35 +0000599{
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000600 memcpy((void *)to, from, sizeof(IPaddr_t));
wdenk2d966952002-10-31 22:12:35 +0000601}
602
603/* copy ulong */
604static inline void NetCopyLong(ulong *to, ulong *from)
605{
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000606 memcpy((void *)to, (void *)from, sizeof(ulong));
wdenk2d966952002-10-31 22:12:35 +0000607}
608
Mike Rapoport50cca8b2007-08-12 08:48:27 +0300609/**
610 * is_zero_ether_addr - Determine if give Ethernet address is all zeros.
611 * @addr: Pointer to a six-byte array containing the Ethernet address
612 *
613 * Return true if the address is all zeroes.
614 */
615static inline int is_zero_ether_addr(const u8 *addr)
616{
617 return !(addr[0] | addr[1] | addr[2] | addr[3] | addr[4] | addr[5]);
618}
619
620/**
621 * is_multicast_ether_addr - Determine if the Ethernet address is a multicast.
622 * @addr: Pointer to a six-byte array containing the Ethernet address
623 *
624 * Return true if the address is a multicast address.
625 * By definition the broadcast address is also a multicast address.
626 */
627static inline int is_multicast_ether_addr(const u8 *addr)
628{
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000629 return 0x01 & addr[0];
Mike Rapoport50cca8b2007-08-12 08:48:27 +0300630}
631
Remy Bohmer23cd1382009-07-29 18:18:43 +0200632/*
633 * is_broadcast_ether_addr - Determine if the Ethernet address is broadcast
634 * @addr: Pointer to a six-byte array containing the Ethernet address
635 *
636 * Return true if the address is the broadcast address.
637 */
638static inline int is_broadcast_ether_addr(const u8 *addr)
639{
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000640 return (addr[0] & addr[1] & addr[2] & addr[3] & addr[4] & addr[5]) ==
641 0xff;
Remy Bohmer23cd1382009-07-29 18:18:43 +0200642}
643
644/*
Mike Frysinger75edebe2009-01-27 16:53:39 -0500645 * is_valid_ether_addr - Determine if the given Ethernet address is valid
646 * @addr: Pointer to a six-byte array containing the Ethernet address
647 *
648 * Check that the Ethernet address (MAC) is not 00:00:00:00:00:00, is not
649 * a multicast address, and is not FF:FF:FF:FF:FF:FF.
650 *
651 * Return true if the address is valid.
652 */
Remy Bohmer23cd1382009-07-29 18:18:43 +0200653static inline int is_valid_ether_addr(const u8 *addr)
Mike Frysinger75edebe2009-01-27 16:53:39 -0500654{
655 /* FF:FF:FF:FF:FF:FF is a multicast address so we don't need to
656 * explicitly check for it here. */
657 return !is_multicast_ether_addr(addr) && !is_zero_ether_addr(addr);
658}
659
Masahiro Yamadada384a92014-04-18 19:09:48 +0900660/**
661 * eth_random_addr - Generate software assigned random Ethernet address
662 * @addr: Pointer to a six-byte array containing the Ethernet address
663 *
664 * Generate a random Ethernet address (MAC) that is not multicast
665 * and has the local assigned bit set.
666 */
667static inline void eth_random_addr(uchar *addr)
668{
669 int i;
670 unsigned int seed = get_timer(0);
671
672 for (i = 0; i < 6; i++)
673 addr[i] = rand_r(&seed);
674
675 addr[0] &= 0xfe; /* clear multicast bit */
676 addr[0] |= 0x02; /* set local assignment bit (IEEE802) */
677}
678
wdenk2d966952002-10-31 22:12:35 +0000679/* Convert an IP address to a string */
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000680extern void ip_to_string(IPaddr_t x, char *s);
wdenk2d966952002-10-31 22:12:35 +0000681
wdenk73a8b272003-06-05 19:27:42 +0000682/* Convert a string to ip address */
Mike Frysinger908c6b62010-10-20 07:16:58 -0400683extern IPaddr_t string_to_ip(const char *s);
wdenk73a8b272003-06-05 19:27:42 +0000684
wdenka3d991b2004-04-15 21:48:45 +0000685/* Convert a VLAN id to a string */
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000686extern void VLAN_to_string(ushort x, char *s);
wdenka3d991b2004-04-15 21:48:45 +0000687
688/* Convert a string to a vlan id */
Mike Frysinger2e3ef6e2010-10-20 07:16:48 -0400689extern ushort string_to_VLAN(const char *s);
wdenka3d991b2004-04-15 21:48:45 +0000690
wdenka3d991b2004-04-15 21:48:45 +0000691/* read a VLAN id from an environment variable */
692extern ushort getenv_VLAN(char *);
693
wdenk2d966952002-10-31 22:12:35 +0000694/* copy a filename (allow for "..." notation, limit length) */
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000695extern void copy_filename(char *dst, const char *src, int size);
wdenk2d966952002-10-31 22:12:35 +0000696
Mike Frysinger91b469c2009-09-02 04:18:55 -0400697/* get a random source port */
698extern unsigned int random_port(void);
699
Simon Glassea5427e2013-05-15 06:23:54 +0000700/* Update U-Boot over TFTP */
701extern int update_tftp(ulong addr);
702
wdenk2d966952002-10-31 22:12:35 +0000703/**********************************************************************/
704
705#endif /* __NET_H__ */