blob: c6c83b238d752d6c34cbf85c036dd65406cea45c [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)
Wolfgang Denk2ea91032014-09-30 10:44:01 +02006 * SPDX-License-Identifier: GPL-2.0
wdenk2d966952002-10-31 22:12:35 +00007 *
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];
Michal Simek16ae7822015-01-14 16:00:39 +010084 phys_addr_t iobase;
wdenk2d966952002-10-31 22:12:35 +000085 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
Joe Hershbergerff997432015-03-22 17:09:02 -0500100int eth_initialize(bd_t *bis); /* Initialize network subsystem */
101int eth_register(struct eth_device *dev);/* Register network device */
102int eth_unregister(struct eth_device *dev);/* Remove network device */
103void eth_try_another(int first_restart); /* Change the device */
104void 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}
Joe Hershberger8b2c9a72015-03-22 17:09:00 -0500114
115static inline unsigned char *eth_get_ethaddr(void)
116{
117 if (eth_current)
118 return eth_current->enetaddr;
119 return NULL;
120}
121
Joe Hershbergerff997432015-03-22 17:09:02 -0500122struct eth_device *eth_get_dev_by_name(const char *devname);
123struct eth_device *eth_get_dev_by_index(int index); /* get dev @ index */
124int eth_get_dev_index(void); /* get the device index */
125void eth_parse_enetaddr(const char *addr, uchar *enetaddr);
126int eth_getenv_enetaddr(char *name, uchar *enetaddr);
127int eth_setenv_enetaddr(char *name, const uchar *enetaddr);
Simon Glass7616e782011-06-13 16:13:10 -0700128
129/*
130 * Get the hardware address for an ethernet interface .
131 * Args:
132 * base_name - base name for device (normally "eth")
133 * index - device index number (0 for first)
134 * enetaddr - returns 6 byte hardware address
135 * Returns:
136 * Return true if the address is valid.
137 */
Joe Hershbergerff997432015-03-22 17:09:02 -0500138int eth_getenv_enetaddr_by_index(const char *base_name, int index,
139 uchar *enetaddr);
wdenk2d966952002-10-31 22:12:35 +0000140
Joe Hershbergerff997432015-03-22 17:09:02 -0500141int usb_eth_initialize(bd_t *bi);
142int eth_init(bd_t *bis); /* Initialize the device */
143int eth_send(void *packet, int length); /* Send a packet */
Remy Bohmer23cd1382009-07-29 18:18:43 +0200144
Rafal Jaworowskif85b6072007-12-27 18:19:02 +0100145#ifdef CONFIG_API
Joe Hershbergerff997432015-03-22 17:09:02 -0500146int eth_receive(void *packet, int length); /* Receive a packet*/
Joe Hershbergerdb288a92012-05-15 08:59:04 +0000147extern void (*push_packet)(void *packet, int length);
Rafal Jaworowskif85b6072007-12-27 18:19:02 +0100148#endif
Joe Hershbergerff997432015-03-22 17:09:02 -0500149int eth_rx(void); /* Check for received packets */
150void eth_halt(void); /* stop SCC */
151char *eth_get_name(void); /* get name of current device */
wdenk2d966952002-10-31 22:12:35 +0000152
Joe Hershbergerf8be7d62012-08-03 10:59:08 +0000153/* Set active state */
154static inline __attribute__((always_inline)) int eth_init_state_only(bd_t *bis)
155{
156 eth_get_dev()->state = ETH_STATE_ACTIVE;
157
158 return 0;
159}
160/* Set passive state */
161static inline __attribute__((always_inline)) void eth_halt_state_only(void)
162{
163 eth_get_dev()->state = ETH_STATE_PASSIVE;
164}
165
Simon Glass7616e782011-06-13 16:13:10 -0700166/*
167 * Set the hardware address for an ethernet interface based on 'eth%daddr'
168 * environment variable (or just 'ethaddr' if eth_number is 0).
169 * Args:
170 * base_name - base name for device (normally "eth")
171 * eth_number - value of %d (0 for first device of this type)
172 * Returns:
173 * 0 is success, non-zero is error status from driver.
174 */
175int eth_write_hwaddr(struct eth_device *dev, const char *base_name,
176 int eth_number);
177
David Updegraff53a5c422007-06-11 10:41:07 -0500178#ifdef CONFIG_MCAST_TFTP
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000179int eth_mcast_join(IPaddr_t mcast_addr, u8 join);
180u32 ether_crc(size_t len, unsigned char const *p);
David Updegraff53a5c422007-06-11 10:41:07 -0500181#endif
182
wdenk2d966952002-10-31 22:12:35 +0000183
184/**********************************************************************/
185/*
186 * Protocol headers.
187 */
188
189/*
190 * Ethernet header
191 */
Joe Hershbergercb487f52012-05-23 07:58:06 +0000192
193struct ethernet_hdr {
194 uchar et_dest[6]; /* Destination node */
195 uchar et_src[6]; /* Source node */
196 ushort et_protlen; /* Protocol or length */
197};
198
199/* Ethernet header size */
200#define ETHER_HDR_SIZE (sizeof(struct ethernet_hdr))
201
Bin Menga7c3d5e2015-03-20 17:12:18 +0800202#define ETH_FCS_LEN 4 /* Octets in the FCS */
203
Joe Hershbergercb487f52012-05-23 07:58:06 +0000204struct e802_hdr {
wdenk2d966952002-10-31 22:12:35 +0000205 uchar et_dest[6]; /* Destination node */
206 uchar et_src[6]; /* Source node */
207 ushort et_protlen; /* Protocol or length */
208 uchar et_dsap; /* 802 DSAP */
209 uchar et_ssap; /* 802 SSAP */
210 uchar et_ctl; /* 802 control */
211 uchar et_snap1; /* SNAP */
212 uchar et_snap2;
213 uchar et_snap3;
214 ushort et_prot; /* 802 protocol */
Joe Hershbergercb487f52012-05-23 07:58:06 +0000215};
wdenk2d966952002-10-31 22:12:35 +0000216
Joe Hershbergerda5ebe22012-05-23 07:58:11 +0000217/* 802 + SNAP + ethernet header size */
Joe Hershbergercb487f52012-05-23 07:58:06 +0000218#define E802_HDR_SIZE (sizeof(struct e802_hdr))
wdenka3d991b2004-04-15 21:48:45 +0000219
220/*
Joe Hershbergerda5ebe22012-05-23 07:58:11 +0000221 * Virtual LAN Ethernet header
wdenka3d991b2004-04-15 21:48:45 +0000222 */
Joe Hershbergerc68cca32012-05-23 07:58:07 +0000223struct vlan_ethernet_hdr {
wdenka3d991b2004-04-15 21:48:45 +0000224 uchar vet_dest[6]; /* Destination node */
225 uchar vet_src[6]; /* Source node */
226 ushort vet_vlan_type; /* PROT_VLAN */
227 ushort vet_tag; /* TAG of VLAN */
228 ushort vet_type; /* protocol type */
Joe Hershbergerc68cca32012-05-23 07:58:07 +0000229};
wdenka3d991b2004-04-15 21:48:45 +0000230
Joe Hershbergerc68cca32012-05-23 07:58:07 +0000231/* VLAN Ethernet header size */
232#define VLAN_ETHER_HDR_SIZE (sizeof(struct vlan_ethernet_hdr))
wdenka3d991b2004-04-15 21:48:45 +0000233
wdenk2d966952002-10-31 22:12:35 +0000234#define PROT_IP 0x0800 /* IP protocol */
235#define PROT_ARP 0x0806 /* IP ARP protocol */
236#define PROT_RARP 0x8035 /* IP ARP protocol */
wdenka3d991b2004-04-15 21:48:45 +0000237#define PROT_VLAN 0x8100 /* IEEE 802.1q protocol */
wdenk2d966952002-10-31 22:12:35 +0000238
239#define IPPROTO_ICMP 1 /* Internet Control Message Protocol */
240#define IPPROTO_UDP 17 /* User Datagram Protocol */
241
242/*
Joe Hershbergerc5c59df2012-05-23 07:58:05 +0000243 * Internet Protocol (IP) header.
244 */
245struct ip_hdr {
246 uchar ip_hl_v; /* header length and version */
247 uchar ip_tos; /* type of service */
248 ushort ip_len; /* total length */
249 ushort ip_id; /* identification */
250 ushort ip_off; /* fragment offset field */
251 uchar ip_ttl; /* time to live */
252 uchar ip_p; /* protocol */
253 ushort ip_sum; /* checksum */
254 IPaddr_t ip_src; /* Source IP address */
255 IPaddr_t ip_dst; /* Destination IP address */
256};
257
258#define IP_OFFS 0x1fff /* ip offset *= 8 */
259#define IP_FLAGS 0xe000 /* first 3 bits */
260#define IP_FLAGS_RES 0x8000 /* reserved */
261#define IP_FLAGS_DFRAG 0x4000 /* don't fragments */
262#define IP_FLAGS_MFRAG 0x2000 /* more fragments */
263
264#define IP_HDR_SIZE (sizeof(struct ip_hdr))
265
266/*
Joe Hershberger594c26f2012-05-23 07:58:04 +0000267 * Internet Protocol (IP) + UDP header.
wdenk2d966952002-10-31 22:12:35 +0000268 */
Joe Hershberger594c26f2012-05-23 07:58:04 +0000269struct ip_udp_hdr {
wdenk2d966952002-10-31 22:12:35 +0000270 uchar ip_hl_v; /* header length and version */
271 uchar ip_tos; /* type of service */
272 ushort ip_len; /* total length */
273 ushort ip_id; /* identification */
274 ushort ip_off; /* fragment offset field */
275 uchar ip_ttl; /* time to live */
276 uchar ip_p; /* protocol */
277 ushort ip_sum; /* checksum */
278 IPaddr_t ip_src; /* Source IP address */
279 IPaddr_t ip_dst; /* Destination IP address */
280 ushort udp_src; /* UDP source port */
281 ushort udp_dst; /* UDP destination port */
282 ushort udp_len; /* Length of UDP packet */
283 ushort udp_xsum; /* Checksum */
Joe Hershberger594c26f2012-05-23 07:58:04 +0000284};
wdenk2d966952002-10-31 22:12:35 +0000285
Joe Hershberger594c26f2012-05-23 07:58:04 +0000286#define IP_UDP_HDR_SIZE (sizeof(struct ip_udp_hdr))
Joe Hershbergerc5c59df2012-05-23 07:58:05 +0000287#define UDP_HDR_SIZE (IP_UDP_HDR_SIZE - IP_HDR_SIZE)
wdenk2d966952002-10-31 22:12:35 +0000288
289/*
290 * Address Resolution Protocol (ARP) header.
291 */
Joe Hershberger738853b2012-05-23 07:58:08 +0000292struct arp_hdr {
wdenk2d966952002-10-31 22:12:35 +0000293 ushort ar_hrd; /* Format of hardware address */
294# define ARP_ETHER 1 /* Ethernet hardware address */
295 ushort ar_pro; /* Format of protocol address */
296 uchar ar_hln; /* Length of hardware address */
Joe Hershberger674bb242012-05-23 07:58:17 +0000297# define ARP_HLEN 6
wdenk2d966952002-10-31 22:12:35 +0000298 uchar ar_pln; /* Length of protocol address */
Joe Hershberger674bb242012-05-23 07:58:17 +0000299# define ARP_PLEN 4
wdenk2d966952002-10-31 22:12:35 +0000300 ushort ar_op; /* Operation */
301# define ARPOP_REQUEST 1 /* Request to resolve address */
302# define ARPOP_REPLY 2 /* Response to previous request */
303
304# define RARPOP_REQUEST 3 /* Request to resolve address */
305# define RARPOP_REPLY 4 /* Response to previous request */
306
307 /*
wdenk8bde7f72003-06-27 21:31:46 +0000308 * The remaining fields are variable in size, according to
309 * the sizes above, and are defined as appropriate for
310 * specific hardware/protocol combinations.
wdenk2d966952002-10-31 22:12:35 +0000311 */
312 uchar ar_data[0];
Joe Hershberger674bb242012-05-23 07:58:17 +0000313#define ar_sha ar_data[0]
314#define ar_spa ar_data[ARP_HLEN]
315#define ar_tha ar_data[ARP_HLEN + ARP_PLEN]
316#define ar_tpa ar_data[ARP_HLEN + ARP_PLEN + ARP_HLEN]
wdenk2d966952002-10-31 22:12:35 +0000317#if 0
318 uchar ar_sha[]; /* Sender hardware address */
319 uchar ar_spa[]; /* Sender protocol address */
320 uchar ar_tha[]; /* Target hardware address */
321 uchar ar_tpa[]; /* Target protocol address */
322#endif /* 0 */
Joe Hershberger738853b2012-05-23 07:58:08 +0000323};
wdenk2d966952002-10-31 22:12:35 +0000324
325#define ARP_HDR_SIZE (8+20) /* Size assuming ethernet */
326
327/*
328 * ICMP stuff (just enough to handle (host) redirect messages)
329 */
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200330#define ICMP_ECHO_REPLY 0 /* Echo reply */
Simon Glass4793ee62011-10-24 18:00:01 +0000331#define ICMP_NOT_REACH 3 /* Detination unreachable */
wdenk2d966952002-10-31 22:12:35 +0000332#define ICMP_REDIRECT 5 /* Redirect (change route) */
wdenk73a8b272003-06-05 19:27:42 +0000333#define ICMP_ECHO_REQUEST 8 /* Echo request */
wdenk2d966952002-10-31 22:12:35 +0000334
335/* Codes for REDIRECT. */
336#define ICMP_REDIR_NET 0 /* Redirect Net */
337#define ICMP_REDIR_HOST 1 /* Redirect Host */
338
Simon Glass4793ee62011-10-24 18:00:01 +0000339/* Codes for NOT_REACH */
340#define ICMP_NOT_REACH_PORT 3 /* Port unreachable */
341
Joe Hershbergere0a63072012-05-23 07:58:09 +0000342struct icmp_hdr {
wdenk2d966952002-10-31 22:12:35 +0000343 uchar type;
344 uchar code;
345 ushort checksum;
346 union {
347 struct {
348 ushort id;
349 ushort sequence;
350 } echo;
351 ulong gateway;
352 struct {
Jeroen Hofstee6e840eb2013-08-10 16:52:47 +0200353 ushort unused;
wdenk2d966952002-10-31 22:12:35 +0000354 ushort mtu;
355 } frag;
Simon Glass4793ee62011-10-24 18:00:01 +0000356 uchar data[0];
wdenk2d966952002-10-31 22:12:35 +0000357 } un;
Joe Hershbergere0a63072012-05-23 07:58:09 +0000358};
wdenk2d966952002-10-31 22:12:35 +0000359
Joe Hershbergere0a63072012-05-23 07:58:09 +0000360#define ICMP_HDR_SIZE (sizeof(struct icmp_hdr))
361#define IP_ICMP_HDR_SIZE (IP_HDR_SIZE + ICMP_HDR_SIZE)
wdenk2d966952002-10-31 22:12:35 +0000362
wdenk2d966952002-10-31 22:12:35 +0000363/*
364 * Maximum packet size; used to allocate packet storage.
365 * TFTP packets can be 524 bytes + IP header + ethernet header.
366 * Lets be conservative, and go for 38 * 16. (Must also be
367 * a multiple of 32 bytes).
368 */
369/*
370 * AS.HARNOIS : Better to set PKTSIZE to maximum size because
371 * traffic type is not always controlled
372 * maximum packet size = 1518
373 * maximum packet size and multiple of 32 bytes = 1536
374 */
375#define PKTSIZE 1518
376#define PKTSIZE_ALIGN 1536
377/*#define PKTSIZE 608*/
378
379/*
380 * Maximum receive ring size; that is, the number of packets
381 * we can buffer before overflow happens. Basically, this just
382 * needs to be enough to prevent a packet being discarded while
383 * we are processing the previous one.
384 */
385#define RINGSZ 4
386#define RINGSZ_LOG2 2
387
388/**********************************************************************/
389/*
390 * Globals.
391 *
392 * Note:
393 *
394 * All variables of type IPaddr_t are stored in NETWORK byte order
395 * (big endian).
396 */
397
398/* net.c */
399/** BOOTP EXTENTIONS **/
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000400extern IPaddr_t NetOurGatewayIP; /* Our gateway IP address */
401extern IPaddr_t NetOurSubnetMask; /* Our subnet mask (0 = unknown) */
402extern IPaddr_t NetOurDNSIP; /* Our Domain Name Server (0 = unknown) */
Jon Loeliger1fe80d72007-07-09 22:08:34 -0500403#if defined(CONFIG_BOOTP_DNS2)
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000404extern IPaddr_t NetOurDNS2IP; /* Our 2nd Domain Name Server (0 = unknown) */
stroesefe389a82003-08-28 14:17:32 +0000405#endif
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000406extern char NetOurNISDomain[32]; /* Our NIS domain */
407extern char NetOurHostName[32]; /* Our hostname */
408extern char NetOurRootPath[64]; /* Our root path */
409extern ushort NetBootFileSize; /* Our boot file size in blocks */
wdenk2d966952002-10-31 22:12:35 +0000410/** END OF BOOTP EXTENTIONS **/
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000411extern ulong NetBootFileXferSize; /* size of bootfile in bytes */
412extern uchar NetOurEther[6]; /* Our ethernet address */
413extern uchar NetServerEther[6]; /* Boot server enet address */
414extern IPaddr_t NetOurIP; /* Our IP addr (0 = unknown) */
415extern IPaddr_t NetServerIP; /* Server IP addr (0 = unknown) */
Joe Hershbergerdb288a92012-05-15 08:59:04 +0000416extern uchar *NetTxPacket; /* THE transmit packet */
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000417extern uchar *NetRxPackets[PKTBUFSRX]; /* Receive packets */
Joe Hershbergerdb288a92012-05-15 08:59:04 +0000418extern uchar *NetRxPacket; /* Current receive packet */
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000419extern int NetRxPacketLen; /* Current rx packet length */
420extern unsigned NetIPID; /* IP ID (counting) */
421extern uchar NetBcastAddr[6]; /* Ethernet boardcast address */
wdenk68ceb292004-08-02 21:11:11 +0000422extern uchar NetEtherNullAddr[6];
wdenk2d966952002-10-31 22:12:35 +0000423
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000424#define VLAN_NONE 4095 /* untagged */
425#define VLAN_IDMASK 0x0fff /* mask of valid vlan id */
426extern ushort NetOurVLAN; /* Our VLAN */
427extern ushort NetOurNativeVLAN; /* Our Native VLAN */
wdenka3d991b2004-04-15 21:48:45 +0000428
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000429extern int NetRestartWrap; /* Tried all network devices */
wdenk2d966952002-10-31 22:12:35 +0000430
Simon Glasse4bf0c52011-10-24 18:00:02 +0000431enum proto_t {
432 BOOTP, RARP, ARP, TFTPGET, DHCP, PING, DNS, NFS, CDP, NETCONS, SNTP,
Joe Hershbergerd22c3382012-05-23 08:00:12 +0000433 TFTPSRV, TFTPPUT, LINKLOCAL
Simon Glasse4bf0c52011-10-24 18:00:02 +0000434};
wdenk2d966952002-10-31 22:12:35 +0000435
436/* from net/net.c */
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000437extern char BootFile[128]; /* Boot File name */
wdenk2d966952002-10-31 22:12:35 +0000438
Robin Getz1a32bf42009-07-20 14:53:54 -0400439#if defined(CONFIG_CMD_DNS)
440extern char *NetDNSResolve; /* The host to resolve */
441extern char *NetDNSenvvar; /* the env var to put the ip into */
442#endif
443
Jon Loeliger639221c2007-07-09 17:15:49 -0500444#if defined(CONFIG_CMD_PING)
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000445extern IPaddr_t NetPingIP; /* the ip address to ping */
wdenk73a8b272003-06-05 19:27:42 +0000446#endif
447
Jon Loeliger639221c2007-07-09 17:15:49 -0500448#if defined(CONFIG_CMD_CDP)
wdenka3d991b2004-04-15 21:48:45 +0000449/* when CDP completes these hold the return values */
Joe Hershbergerf575ae12012-05-23 07:57:59 +0000450extern ushort CDPNativeVLAN; /* CDP returned native VLAN */
451extern ushort CDPApplianceVLAN; /* CDP returned appliance VLAN */
Joe Hershberger17351882012-05-23 07:58:00 +0000452
453/*
454 * Check for a CDP packet by examining the received MAC address field
455 */
456static inline int is_cdp_packet(const uchar *et_addr)
457{
458 extern const uchar NetCDPAddr[6];
459
460 return memcmp(et_addr, NetCDPAddr, 6) == 0;
461}
wdenka3d991b2004-04-15 21:48:45 +0000462#endif
463
Jon Loeliger639221c2007-07-09 17:15:49 -0500464#if defined(CONFIG_CMD_SNTP)
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000465extern IPaddr_t NetNtpServerIP; /* the ip address to NTP */
466extern int NetTimeOffset; /* offset time from UTC */
wdenkea287de2005-04-01 00:25:43 +0000467#endif
468
Joe Hershberger13dfe942012-05-15 08:59:12 +0000469#if defined(CONFIG_MCAST_TFTP)
470extern IPaddr_t Mcast_addr;
471#endif
472
wdenk2d966952002-10-31 22:12:35 +0000473/* Initialize the network adapter */
Joe Hershbergerff997432015-03-22 17:09:02 -0500474void net_init(void);
475int NetLoop(enum proto_t);
wdenk2d966952002-10-31 22:12:35 +0000476
477/* Shutdown adapters and cleanup */
Joe Hershbergerff997432015-03-22 17:09:02 -0500478void NetStop(void);
wdenk2d966952002-10-31 22:12:35 +0000479
480/* Load failed. Start again. */
Joe Hershbergerff997432015-03-22 17:09:02 -0500481void NetStartAgain(void);
wdenk2d966952002-10-31 22:12:35 +0000482
wdenka3d991b2004-04-15 21:48:45 +0000483/* Get size of the ethernet header when we send */
Joe Hershbergerff997432015-03-22 17:09:02 -0500484int NetEthHdrSize(void);
wdenka3d991b2004-04-15 21:48:45 +0000485
486/* Set ethernet header; returns the size of the header */
Joe Hershbergerff997432015-03-22 17:09:02 -0500487int NetSetEther(uchar *, uchar *, uint);
488int net_update_ether(struct ethernet_hdr *et, uchar *addr, uint prot);
wdenk2d966952002-10-31 22:12:35 +0000489
490/* Set IP header */
Joe Hershbergerff997432015-03-22 17:09:02 -0500491void net_set_ip_header(uchar *pkt, IPaddr_t dest, IPaddr_t source);
492void net_set_udp_header(uchar *pkt, IPaddr_t dest, int dport,
Joe Hershberger4b11c912012-05-23 07:59:07 +0000493 int sport, int len);
wdenk2d966952002-10-31 22:12:35 +0000494
Simon Glass9b0e35c2015-01-19 22:16:07 -0700495/**
496 * compute_ip_checksum() - Compute IP checksum
497 *
498 * @addr: Address to check (must be 16-bit aligned)
499 * @nbytes: Number of bytes to check (normally a multiple of 2)
500 * @return 16-bit IP checksum
501 */
502unsigned compute_ip_checksum(const void *addr, unsigned nbytes);
503
504/**
505 * add_ip_checksums() - add two IP checksums
506 *
507 * @offset: Offset of first sum (if odd we do a byte-swap)
508 * @sum: First checksum
509 * @new_sum: New checksum to add
510 * @return updated 16-bit IP checksum
511 */
512unsigned add_ip_checksums(unsigned offset, unsigned sum, unsigned new_sum);
513
514/**
515 * ip_checksum_ok() - check if a checksum is correct
516 *
517 * This works by making sure the checksum sums to 0
518 *
519 * @addr: Address to check (must be 16-bit aligned)
520 * @nbytes: Number of bytes to check (normally a multiple of 2)
521 * @return true if the checksum matches, false if not
522 */
523int ip_checksum_ok(const void *addr, unsigned nbytes);
524
Joe Hershbergerd280d3f2012-05-23 07:58:01 +0000525/* Callbacks */
Joe Hershbergerff997432015-03-22 17:09:02 -0500526rxhand_f *net_get_udp_handler(void); /* Get UDP RX packet handler */
527void net_set_udp_handler(rxhand_f *); /* Set UDP RX packet handler */
528rxhand_f *net_get_arp_handler(void); /* Get ARP RX packet handler */
529void net_set_arp_handler(rxhand_f *); /* Set ARP RX packet handler */
530void net_set_icmp_handler(rxhand_icmp_f *f); /* Set ICMP RX handler */
531void NetSetTimeout(ulong, thand_f *);/* Set timeout handler */
wdenk2d966952002-10-31 22:12:35 +0000532
Joe Hershberger22f6e992012-05-23 07:59:14 +0000533/* Network loop state */
534enum net_loop_state {
535 NETLOOP_CONTINUE,
536 NETLOOP_RESTART,
537 NETLOOP_SUCCESS,
538 NETLOOP_FAIL
539};
Kim Phillips06370592012-10-29 13:34:33 +0000540extern enum net_loop_state net_state;
541
Joe Hershberger22f6e992012-05-23 07:59:14 +0000542static inline void net_set_state(enum net_loop_state state)
543{
Joe Hershberger4ef8d532012-05-23 08:01:04 +0000544 debug_cond(DEBUG_INT_STATE, "--- NetState set to %d\n", state);
Joe Hershberger22f6e992012-05-23 07:59:14 +0000545 net_state = state;
546}
547
Joe Hershbergere94070c2012-05-23 07:59:24 +0000548/* Transmit a packet */
Joe Hershbergeradf5d932012-05-23 07:59:13 +0000549static inline void NetSendPacket(uchar *pkt, int len)
550{
551 (void) eth_send(pkt, len);
552}
wdenk2d966952002-10-31 22:12:35 +0000553
Joe Hershberger206d07f2012-05-23 07:58:10 +0000554/*
Joe Hershbergere94070c2012-05-23 07:59:24 +0000555 * Transmit "NetTxPacket" as UDP packet, performing ARP request if needed
Joe Hershbergerece223b2012-05-23 07:59:15 +0000556 * (ether will be populated)
Joe Hershberger206d07f2012-05-23 07:58:10 +0000557 *
558 * @param ether Raw packet buffer
559 * @param dest IP address to send the datagram to
560 * @param dport Destination UDP port
561 * @param sport Source UDP port
562 * @param payload_len Length of data after the UDP header
563 */
Joe Hershbergerff997432015-03-22 17:09:02 -0500564int NetSendUDPPacket(uchar *ether, IPaddr_t dest, int dport,
Joe Hershberger206d07f2012-05-23 07:58:10 +0000565 int sport, int payload_len);
wdenk73a8b272003-06-05 19:27:42 +0000566
wdenk2d966952002-10-31 22:12:35 +0000567/* Processes a received packet */
Joe Hershbergerff997432015-03-22 17:09:02 -0500568void NetReceive(uchar *, int);
wdenk2d966952002-10-31 22:12:35 +0000569
Joe Hershberger48522bb2012-05-15 08:59:08 +0000570#ifdef CONFIG_NETCONSOLE
571void NcStart(void);
Joe Hershberger8a0eccb2012-09-18 10:01:32 +0000572int nc_input_packet(uchar *pkt, IPaddr_t src_ip, unsigned dest_port,
573 unsigned src_port, unsigned len);
Joe Hershberger48522bb2012-05-15 08:59:08 +0000574#endif
575
Joe Hershbergerf8be7d62012-08-03 10:59:08 +0000576static inline __attribute__((always_inline)) int eth_is_on_demand_init(void)
577{
578#ifdef CONFIG_NETCONSOLE
579 extern enum proto_t net_loop_last_protocol;
580
581 return net_loop_last_protocol != NETCONS;
582#else
583 return 1;
584#endif
585}
586
587static inline void eth_set_last_protocol(int protocol)
588{
589#ifdef CONFIG_NETCONSOLE
590 extern enum proto_t net_loop_last_protocol;
591
592 net_loop_last_protocol = protocol;
593#endif
594}
595
wdenk2d966952002-10-31 22:12:35 +0000596/*
Simon Glasse4a3d572011-10-27 06:24:32 +0000597 * Check if autoload is enabled. If so, use either NFS or TFTP to download
598 * the boot file.
599 */
600void net_auto_load(void);
601
602/*
wdenk2d966952002-10-31 22:12:35 +0000603 * The following functions are a bit ugly, but necessary to deal with
604 * alignment restrictions on ARM.
605 *
606 * We're using inline functions, which had the smallest memory
607 * footprint in our tests.
608 */
609/* return IP *in network byteorder* */
Joe Hershbergerdb288a92012-05-15 08:59:04 +0000610static inline IPaddr_t NetReadIP(void *from)
wdenk2d966952002-10-31 22:12:35 +0000611{
612 IPaddr_t ip;
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000613
614 memcpy((void *)&ip, (void *)from, sizeof(ip));
wdenk2d966952002-10-31 22:12:35 +0000615 return ip;
616}
617
618/* return ulong *in network byteorder* */
619static inline ulong NetReadLong(ulong *from)
620{
621 ulong l;
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000622
623 memcpy((void *)&l, (void *)from, sizeof(l));
wdenk2d966952002-10-31 22:12:35 +0000624 return l;
625}
626
627/* write IP *in network byteorder* */
628static inline void NetWriteIP(void *to, IPaddr_t ip)
629{
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000630 memcpy(to, (void *)&ip, sizeof(ip));
wdenk2d966952002-10-31 22:12:35 +0000631}
632
633/* copy IP */
Joe Hershbergerdb288a92012-05-15 08:59:04 +0000634static inline void NetCopyIP(void *to, void *from)
wdenk2d966952002-10-31 22:12:35 +0000635{
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000636 memcpy((void *)to, from, sizeof(IPaddr_t));
wdenk2d966952002-10-31 22:12:35 +0000637}
638
639/* copy ulong */
640static inline void NetCopyLong(ulong *to, ulong *from)
641{
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000642 memcpy((void *)to, (void *)from, sizeof(ulong));
wdenk2d966952002-10-31 22:12:35 +0000643}
644
Mike Rapoport50cca8b2007-08-12 08:48:27 +0300645/**
646 * is_zero_ether_addr - Determine if give Ethernet address is all zeros.
647 * @addr: Pointer to a six-byte array containing the Ethernet address
648 *
649 * Return true if the address is all zeroes.
650 */
651static inline int is_zero_ether_addr(const u8 *addr)
652{
653 return !(addr[0] | addr[1] | addr[2] | addr[3] | addr[4] | addr[5]);
654}
655
656/**
657 * is_multicast_ether_addr - Determine if the Ethernet address is a multicast.
658 * @addr: Pointer to a six-byte array containing the Ethernet address
659 *
660 * Return true if the address is a multicast address.
661 * By definition the broadcast address is also a multicast address.
662 */
663static inline int is_multicast_ether_addr(const u8 *addr)
664{
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000665 return 0x01 & addr[0];
Mike Rapoport50cca8b2007-08-12 08:48:27 +0300666}
667
Remy Bohmer23cd1382009-07-29 18:18:43 +0200668/*
669 * is_broadcast_ether_addr - Determine if the Ethernet address is broadcast
670 * @addr: Pointer to a six-byte array containing the Ethernet address
671 *
672 * Return true if the address is the broadcast address.
673 */
674static inline int is_broadcast_ether_addr(const u8 *addr)
675{
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000676 return (addr[0] & addr[1] & addr[2] & addr[3] & addr[4] & addr[5]) ==
677 0xff;
Remy Bohmer23cd1382009-07-29 18:18:43 +0200678}
679
680/*
Mike Frysinger75edebe2009-01-27 16:53:39 -0500681 * is_valid_ether_addr - Determine if the given Ethernet address is valid
682 * @addr: Pointer to a six-byte array containing the Ethernet address
683 *
684 * Check that the Ethernet address (MAC) is not 00:00:00:00:00:00, is not
685 * a multicast address, and is not FF:FF:FF:FF:FF:FF.
686 *
687 * Return true if the address is valid.
688 */
Remy Bohmer23cd1382009-07-29 18:18:43 +0200689static inline int is_valid_ether_addr(const u8 *addr)
Mike Frysinger75edebe2009-01-27 16:53:39 -0500690{
691 /* FF:FF:FF:FF:FF:FF is a multicast address so we don't need to
692 * explicitly check for it here. */
693 return !is_multicast_ether_addr(addr) && !is_zero_ether_addr(addr);
694}
695
Masahiro Yamadada384a92014-04-18 19:09:48 +0900696/**
697 * eth_random_addr - Generate software assigned random Ethernet address
698 * @addr: Pointer to a six-byte array containing the Ethernet address
699 *
700 * Generate a random Ethernet address (MAC) that is not multicast
701 * and has the local assigned bit set.
702 */
703static inline void eth_random_addr(uchar *addr)
704{
705 int i;
706 unsigned int seed = get_timer(0);
707
708 for (i = 0; i < 6; i++)
709 addr[i] = rand_r(&seed);
710
711 addr[0] &= 0xfe; /* clear multicast bit */
712 addr[0] |= 0x02; /* set local assignment bit (IEEE802) */
713}
714
wdenk2d966952002-10-31 22:12:35 +0000715/* Convert an IP address to a string */
Joe Hershbergerff997432015-03-22 17:09:02 -0500716void ip_to_string(IPaddr_t x, char *s);
wdenk2d966952002-10-31 22:12:35 +0000717
wdenk73a8b272003-06-05 19:27:42 +0000718/* Convert a string to ip address */
Joe Hershbergerff997432015-03-22 17:09:02 -0500719IPaddr_t string_to_ip(const char *s);
wdenk73a8b272003-06-05 19:27:42 +0000720
wdenka3d991b2004-04-15 21:48:45 +0000721/* Convert a VLAN id to a string */
Joe Hershbergerff997432015-03-22 17:09:02 -0500722void VLAN_to_string(ushort x, char *s);
wdenka3d991b2004-04-15 21:48:45 +0000723
724/* Convert a string to a vlan id */
Joe Hershbergerff997432015-03-22 17:09:02 -0500725ushort string_to_VLAN(const char *s);
wdenka3d991b2004-04-15 21:48:45 +0000726
wdenka3d991b2004-04-15 21:48:45 +0000727/* read a VLAN id from an environment variable */
Joe Hershbergerff997432015-03-22 17:09:02 -0500728ushort getenv_VLAN(char *);
wdenka3d991b2004-04-15 21:48:45 +0000729
wdenk2d966952002-10-31 22:12:35 +0000730/* copy a filename (allow for "..." notation, limit length) */
Joe Hershbergerff997432015-03-22 17:09:02 -0500731void copy_filename(char *dst, const char *src, int size);
wdenk2d966952002-10-31 22:12:35 +0000732
Mike Frysinger91b469c2009-09-02 04:18:55 -0400733/* get a random source port */
Joe Hershbergerff997432015-03-22 17:09:02 -0500734unsigned int random_port(void);
Mike Frysinger91b469c2009-09-02 04:18:55 -0400735
Simon Glassea5427e2013-05-15 06:23:54 +0000736/* Update U-Boot over TFTP */
Joe Hershbergerff997432015-03-22 17:09:02 -0500737int update_tftp(ulong addr);
Simon Glassea5427e2013-05-15 06:23:54 +0000738
wdenk2d966952002-10-31 22:12:35 +0000739/**********************************************************************/
740
741#endif /* __NET_H__ */