blob: 9564051c56e6f49e14a17bef92ffd55e3c515531 [file] [log] [blame]
wdenk2d966952002-10-31 22:12:35 +00001/*
2 * LiMon Monitor (LiMon) - Network.
3 *
4 * Copyright 1994 - 2000 Neil Russell.
5 * (See License)
6 *
7 *
8 * History
9 * 9/16/00 bor adapted to TQM823L/STK8xxL board, RARP/TFTP boot added
10 */
11
12#ifndef __NET_H__
13#define __NET_H__
14
wdenk71f95112003-06-15 22:40:42 +000015#if defined(CONFIG_8xx)
wdenk2d966952002-10-31 22:12:35 +000016#include <commproc.h>
wdenk71f95112003-06-15 22:40:42 +000017#endif /* CONFIG_8xx */
wdenkaacf9a42003-01-17 16:27:01 +000018
Eric Nelson2c4b3c12012-03-15 18:33:24 +000019#include <asm/cache.h>
wdenk2d966952002-10-31 22:12:35 +000020#include <asm/byteorder.h> /* for nton* / ntoh* stuff */
21
22
23/*
24 * The number of receive packet buffers, and the required packet buffer
25 * alignment in memory.
26 *
27 */
28
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +020029#ifdef CONFIG_SYS_RX_ETH_BUFFER
30# define PKTBUFSRX CONFIG_SYS_RX_ETH_BUFFER
wdenk1d0350e2002-11-11 21:14:20 +000031#else
stroesec6028832003-06-05 15:38:29 +000032# define PKTBUFSRX 4
wdenk1d0350e2002-11-11 21:14:20 +000033#endif
34
Eric Nelson2c4b3c12012-03-15 18:33:24 +000035#define PKTALIGN ARCH_DMA_MINALIGN
wdenk2d966952002-10-31 22:12:35 +000036
Matthias Weisserea45cb02011-12-03 03:29:44 +000037/* IPv4 addresses are always 32 bits in size */
38typedef u32 IPaddr_t;
wdenk2d966952002-10-31 22:12:35 +000039
40
Luca Ceresoli03eb1292011-04-18 06:19:50 +000041/**
42 * An incoming packet handler.
43 * @param pkt pointer to the application packet
44 * @param dport destination UDP port
45 * @param sip source IP address
46 * @param sport source UDP port
47 * @param len packet length
wdenk2d966952002-10-31 22:12:35 +000048 */
Luca Ceresoli03eb1292011-04-18 06:19:50 +000049typedef void rxhand_f(uchar *pkt, unsigned dport,
50 IPaddr_t sip, unsigned sport,
51 unsigned len);
wdenk2d966952002-10-31 22:12:35 +000052
Simon Glass4793ee62011-10-24 18:00:01 +000053/**
54 * An incoming ICMP packet handler.
55 * @param type ICMP type
56 * @param code ICMP code
57 * @param dport destination UDP port
58 * @param sip source IP address
59 * @param sport source UDP port
60 * @param pkt pointer to the ICMP packet data
61 * @param len packet length
62 */
63typedef void rxhand_icmp_f(unsigned type, unsigned code, unsigned dport,
64 IPaddr_t sip, unsigned sport, uchar *pkt, unsigned len);
65
wdenk2d966952002-10-31 22:12:35 +000066/*
67 * A timeout handler. Called after time interval has expired.
68 */
69typedef void thand_f(void);
70
wdenk2d966952002-10-31 22:12:35 +000071enum eth_state_t {
72 ETH_STATE_INIT,
73 ETH_STATE_PASSIVE,
74 ETH_STATE_ACTIVE
75};
76
77struct eth_device {
Mike Frysingerf6add132011-11-10 14:11:04 +000078 char name[16];
wdenk2d966952002-10-31 22:12:35 +000079 unsigned char enetaddr[6];
80 int iobase;
81 int state;
82
Joe Hershbergerb28e28b2012-05-15 08:59:05 +000083 int (*init) (struct eth_device *, bd_t *);
84 int (*send) (struct eth_device *, void *packet, int length);
85 int (*recv) (struct eth_device *);
86 void (*halt) (struct eth_device *);
David Updegraff53a5c422007-06-11 10:41:07 -050087#ifdef CONFIG_MCAST_TFTP
Joe Hershbergerb28e28b2012-05-15 08:59:05 +000088 int (*mcast) (struct eth_device *, u32 ip, u8 set);
David Updegraff53a5c422007-06-11 10:41:07 -050089#endif
Joe Hershbergerb28e28b2012-05-15 08:59:05 +000090 int (*write_hwaddr) (struct eth_device *);
wdenk2d966952002-10-31 22:12:35 +000091 struct eth_device *next;
Michael Wallefea7dca2011-10-27 11:31:35 +000092 int index;
wdenk2d966952002-10-31 22:12:35 +000093 void *priv;
94};
95
Andy Fleming5dc0cf62009-02-11 15:10:31 -060096extern int eth_initialize(bd_t *bis); /* Initialize network subsystem */
97extern int eth_register(struct eth_device* dev);/* Register network device */
Vincent Palatine7e982d2012-01-09 08:32:36 +000098extern int eth_unregister(struct eth_device *dev);/* Remove network device */
Andy Fleming5dc0cf62009-02-11 15:10:31 -060099extern void eth_try_another(int first_restart); /* Change the device */
Andy Fleming5dc0cf62009-02-11 15:10:31 -0600100extern void eth_set_current(void); /* set nterface to ethcur var */
Andy Fleming5dc0cf62009-02-11 15:10:31 -0600101extern struct eth_device *eth_get_dev(void); /* get the current device MAC */
Ben Warrend7fb9bc2010-07-29 12:56:11 -0700102extern struct eth_device *eth_get_dev_by_name(const char *devname);
Andy Fleming5dc0cf62009-02-11 15:10:31 -0600103extern struct eth_device *eth_get_dev_by_index(int index); /* get dev @ index */
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000104extern int eth_get_dev_index(void); /* get the device index */
Mike Frysinger3f6e6992009-01-29 19:43:44 -0500105extern void eth_parse_enetaddr(const char *addr, uchar *enetaddr);
106extern int eth_getenv_enetaddr(char *name, uchar *enetaddr);
107extern int eth_setenv_enetaddr(char *name, const uchar *enetaddr);
Simon Glass7616e782011-06-13 16:13:10 -0700108
109/*
110 * Get the hardware address for an ethernet interface .
111 * Args:
112 * base_name - base name for device (normally "eth")
113 * index - device index number (0 for first)
114 * enetaddr - returns 6 byte hardware address
115 * Returns:
116 * Return true if the address is valid.
117 */
118extern int eth_getenv_enetaddr_by_index(const char *base_name, int index,
119 uchar *enetaddr);
wdenk2d966952002-10-31 22:12:35 +0000120
Remy Bohmer23cd1382009-07-29 18:18:43 +0200121extern int usb_eth_initialize(bd_t *bi);
Andy Fleming5dc0cf62009-02-11 15:10:31 -0600122extern int eth_init(bd_t *bis); /* Initialize the device */
Joe Hershbergerdb288a92012-05-15 08:59:04 +0000123extern int eth_send(void *packet, int length); /* Send a packet */
Remy Bohmer23cd1382009-07-29 18:18:43 +0200124
Rafal Jaworowskif85b6072007-12-27 18:19:02 +0100125#ifdef CONFIG_API
Joe Hershbergerdb288a92012-05-15 08:59:04 +0000126extern int eth_receive(void *packet, int length); /* Receive a packet*/
127extern void (*push_packet)(void *packet, int length);
Rafal Jaworowskif85b6072007-12-27 18:19:02 +0100128#endif
Andy Fleming5dc0cf62009-02-11 15:10:31 -0600129extern int eth_rx(void); /* Check for received packets */
130extern void eth_halt(void); /* stop SCC */
131extern char *eth_get_name(void); /* get name of current device */
wdenk2d966952002-10-31 22:12:35 +0000132
Simon Glass7616e782011-06-13 16:13:10 -0700133/*
134 * Set the hardware address for an ethernet interface based on 'eth%daddr'
135 * environment variable (or just 'ethaddr' if eth_number is 0).
136 * Args:
137 * base_name - base name for device (normally "eth")
138 * eth_number - value of %d (0 for first device of this type)
139 * Returns:
140 * 0 is success, non-zero is error status from driver.
141 */
142int eth_write_hwaddr(struct eth_device *dev, const char *base_name,
143 int eth_number);
144
David Updegraff53a5c422007-06-11 10:41:07 -0500145#ifdef CONFIG_MCAST_TFTP
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000146int eth_mcast_join(IPaddr_t mcast_addr, u8 join);
147u32 ether_crc(size_t len, unsigned char const *p);
David Updegraff53a5c422007-06-11 10:41:07 -0500148#endif
149
wdenk2d966952002-10-31 22:12:35 +0000150
151/**********************************************************************/
152/*
153 * Protocol headers.
154 */
155
156/*
157 * Ethernet header
158 */
Joe Hershbergercb487f52012-05-23 07:58:06 +0000159
160struct ethernet_hdr {
161 uchar et_dest[6]; /* Destination node */
162 uchar et_src[6]; /* Source node */
163 ushort et_protlen; /* Protocol or length */
164};
165
166/* Ethernet header size */
167#define ETHER_HDR_SIZE (sizeof(struct ethernet_hdr))
168
169struct e802_hdr {
wdenk2d966952002-10-31 22:12:35 +0000170 uchar et_dest[6]; /* Destination node */
171 uchar et_src[6]; /* Source node */
172 ushort et_protlen; /* Protocol or length */
173 uchar et_dsap; /* 802 DSAP */
174 uchar et_ssap; /* 802 SSAP */
175 uchar et_ctl; /* 802 control */
176 uchar et_snap1; /* SNAP */
177 uchar et_snap2;
178 uchar et_snap3;
179 ushort et_prot; /* 802 protocol */
Joe Hershbergercb487f52012-05-23 07:58:06 +0000180};
wdenk2d966952002-10-31 22:12:35 +0000181
Joe Hershbergerda5ebe22012-05-23 07:58:11 +0000182/* 802 + SNAP + ethernet header size */
Joe Hershbergercb487f52012-05-23 07:58:06 +0000183#define E802_HDR_SIZE (sizeof(struct e802_hdr))
wdenka3d991b2004-04-15 21:48:45 +0000184
185/*
Joe Hershbergerda5ebe22012-05-23 07:58:11 +0000186 * Virtual LAN Ethernet header
wdenka3d991b2004-04-15 21:48:45 +0000187 */
Joe Hershbergerc68cca32012-05-23 07:58:07 +0000188struct vlan_ethernet_hdr {
wdenka3d991b2004-04-15 21:48:45 +0000189 uchar vet_dest[6]; /* Destination node */
190 uchar vet_src[6]; /* Source node */
191 ushort vet_vlan_type; /* PROT_VLAN */
192 ushort vet_tag; /* TAG of VLAN */
193 ushort vet_type; /* protocol type */
Joe Hershbergerc68cca32012-05-23 07:58:07 +0000194};
wdenka3d991b2004-04-15 21:48:45 +0000195
Joe Hershbergerc68cca32012-05-23 07:58:07 +0000196/* VLAN Ethernet header size */
197#define VLAN_ETHER_HDR_SIZE (sizeof(struct vlan_ethernet_hdr))
wdenka3d991b2004-04-15 21:48:45 +0000198
wdenk2d966952002-10-31 22:12:35 +0000199#define PROT_IP 0x0800 /* IP protocol */
200#define PROT_ARP 0x0806 /* IP ARP protocol */
201#define PROT_RARP 0x8035 /* IP ARP protocol */
wdenka3d991b2004-04-15 21:48:45 +0000202#define PROT_VLAN 0x8100 /* IEEE 802.1q protocol */
wdenk2d966952002-10-31 22:12:35 +0000203
204#define IPPROTO_ICMP 1 /* Internet Control Message Protocol */
205#define IPPROTO_UDP 17 /* User Datagram Protocol */
206
207/*
Joe Hershbergerc5c59df2012-05-23 07:58:05 +0000208 * Internet Protocol (IP) header.
209 */
210struct ip_hdr {
211 uchar ip_hl_v; /* header length and version */
212 uchar ip_tos; /* type of service */
213 ushort ip_len; /* total length */
214 ushort ip_id; /* identification */
215 ushort ip_off; /* fragment offset field */
216 uchar ip_ttl; /* time to live */
217 uchar ip_p; /* protocol */
218 ushort ip_sum; /* checksum */
219 IPaddr_t ip_src; /* Source IP address */
220 IPaddr_t ip_dst; /* Destination IP address */
221};
222
223#define IP_OFFS 0x1fff /* ip offset *= 8 */
224#define IP_FLAGS 0xe000 /* first 3 bits */
225#define IP_FLAGS_RES 0x8000 /* reserved */
226#define IP_FLAGS_DFRAG 0x4000 /* don't fragments */
227#define IP_FLAGS_MFRAG 0x2000 /* more fragments */
228
229#define IP_HDR_SIZE (sizeof(struct ip_hdr))
230
231/*
Joe Hershberger594c26f2012-05-23 07:58:04 +0000232 * Internet Protocol (IP) + UDP header.
wdenk2d966952002-10-31 22:12:35 +0000233 */
Joe Hershberger594c26f2012-05-23 07:58:04 +0000234struct ip_udp_hdr {
wdenk2d966952002-10-31 22:12:35 +0000235 uchar ip_hl_v; /* header length and version */
236 uchar ip_tos; /* type of service */
237 ushort ip_len; /* total length */
238 ushort ip_id; /* identification */
239 ushort ip_off; /* fragment offset field */
240 uchar ip_ttl; /* time to live */
241 uchar ip_p; /* protocol */
242 ushort ip_sum; /* checksum */
243 IPaddr_t ip_src; /* Source IP address */
244 IPaddr_t ip_dst; /* Destination IP address */
245 ushort udp_src; /* UDP source port */
246 ushort udp_dst; /* UDP destination port */
247 ushort udp_len; /* Length of UDP packet */
248 ushort udp_xsum; /* Checksum */
Joe Hershberger594c26f2012-05-23 07:58:04 +0000249};
wdenk2d966952002-10-31 22:12:35 +0000250
Joe Hershberger594c26f2012-05-23 07:58:04 +0000251#define IP_UDP_HDR_SIZE (sizeof(struct ip_udp_hdr))
Joe Hershbergerc5c59df2012-05-23 07:58:05 +0000252#define UDP_HDR_SIZE (IP_UDP_HDR_SIZE - IP_HDR_SIZE)
wdenk2d966952002-10-31 22:12:35 +0000253
254/*
255 * Address Resolution Protocol (ARP) header.
256 */
Joe Hershberger738853b2012-05-23 07:58:08 +0000257struct arp_hdr {
wdenk2d966952002-10-31 22:12:35 +0000258 ushort ar_hrd; /* Format of hardware address */
259# define ARP_ETHER 1 /* Ethernet hardware address */
260 ushort ar_pro; /* Format of protocol address */
261 uchar ar_hln; /* Length of hardware address */
Joe Hershberger674bb242012-05-23 07:58:17 +0000262# define ARP_HLEN 6
wdenk2d966952002-10-31 22:12:35 +0000263 uchar ar_pln; /* Length of protocol address */
Joe Hershberger674bb242012-05-23 07:58:17 +0000264# define ARP_PLEN 4
wdenk2d966952002-10-31 22:12:35 +0000265 ushort ar_op; /* Operation */
266# define ARPOP_REQUEST 1 /* Request to resolve address */
267# define ARPOP_REPLY 2 /* Response to previous request */
268
269# define RARPOP_REQUEST 3 /* Request to resolve address */
270# define RARPOP_REPLY 4 /* Response to previous request */
271
272 /*
wdenk8bde7f72003-06-27 21:31:46 +0000273 * The remaining fields are variable in size, according to
274 * the sizes above, and are defined as appropriate for
275 * specific hardware/protocol combinations.
wdenk2d966952002-10-31 22:12:35 +0000276 */
277 uchar ar_data[0];
Joe Hershberger674bb242012-05-23 07:58:17 +0000278#define ar_sha ar_data[0]
279#define ar_spa ar_data[ARP_HLEN]
280#define ar_tha ar_data[ARP_HLEN + ARP_PLEN]
281#define ar_tpa ar_data[ARP_HLEN + ARP_PLEN + ARP_HLEN]
wdenk2d966952002-10-31 22:12:35 +0000282#if 0
283 uchar ar_sha[]; /* Sender hardware address */
284 uchar ar_spa[]; /* Sender protocol address */
285 uchar ar_tha[]; /* Target hardware address */
286 uchar ar_tpa[]; /* Target protocol address */
287#endif /* 0 */
Joe Hershberger738853b2012-05-23 07:58:08 +0000288};
wdenk2d966952002-10-31 22:12:35 +0000289
290#define ARP_HDR_SIZE (8+20) /* Size assuming ethernet */
291
292/*
293 * ICMP stuff (just enough to handle (host) redirect messages)
294 */
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200295#define ICMP_ECHO_REPLY 0 /* Echo reply */
Simon Glass4793ee62011-10-24 18:00:01 +0000296#define ICMP_NOT_REACH 3 /* Detination unreachable */
wdenk2d966952002-10-31 22:12:35 +0000297#define ICMP_REDIRECT 5 /* Redirect (change route) */
wdenk73a8b272003-06-05 19:27:42 +0000298#define ICMP_ECHO_REQUEST 8 /* Echo request */
wdenk2d966952002-10-31 22:12:35 +0000299
300/* Codes for REDIRECT. */
301#define ICMP_REDIR_NET 0 /* Redirect Net */
302#define ICMP_REDIR_HOST 1 /* Redirect Host */
303
Simon Glass4793ee62011-10-24 18:00:01 +0000304/* Codes for NOT_REACH */
305#define ICMP_NOT_REACH_PORT 3 /* Port unreachable */
306
Joe Hershbergere0a63072012-05-23 07:58:09 +0000307struct icmp_hdr {
wdenk2d966952002-10-31 22:12:35 +0000308 uchar type;
309 uchar code;
310 ushort checksum;
311 union {
312 struct {
313 ushort id;
314 ushort sequence;
315 } echo;
316 ulong gateway;
317 struct {
318 ushort __unused;
319 ushort mtu;
320 } frag;
Simon Glass4793ee62011-10-24 18:00:01 +0000321 uchar data[0];
wdenk2d966952002-10-31 22:12:35 +0000322 } un;
Joe Hershbergere0a63072012-05-23 07:58:09 +0000323};
wdenk2d966952002-10-31 22:12:35 +0000324
Joe Hershbergere0a63072012-05-23 07:58:09 +0000325#define ICMP_HDR_SIZE (sizeof(struct icmp_hdr))
326#define IP_ICMP_HDR_SIZE (IP_HDR_SIZE + ICMP_HDR_SIZE)
wdenk2d966952002-10-31 22:12:35 +0000327
wdenk2d966952002-10-31 22:12:35 +0000328/*
329 * Maximum packet size; used to allocate packet storage.
330 * TFTP packets can be 524 bytes + IP header + ethernet header.
331 * Lets be conservative, and go for 38 * 16. (Must also be
332 * a multiple of 32 bytes).
333 */
334/*
335 * AS.HARNOIS : Better to set PKTSIZE to maximum size because
336 * traffic type is not always controlled
337 * maximum packet size = 1518
338 * maximum packet size and multiple of 32 bytes = 1536
339 */
340#define PKTSIZE 1518
341#define PKTSIZE_ALIGN 1536
342/*#define PKTSIZE 608*/
343
344/*
345 * Maximum receive ring size; that is, the number of packets
346 * we can buffer before overflow happens. Basically, this just
347 * needs to be enough to prevent a packet being discarded while
348 * we are processing the previous one.
349 */
350#define RINGSZ 4
351#define RINGSZ_LOG2 2
352
353/**********************************************************************/
354/*
355 * Globals.
356 *
357 * Note:
358 *
359 * All variables of type IPaddr_t are stored in NETWORK byte order
360 * (big endian).
361 */
362
363/* net.c */
364/** BOOTP EXTENTIONS **/
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000365extern IPaddr_t NetOurGatewayIP; /* Our gateway IP address */
366extern IPaddr_t NetOurSubnetMask; /* Our subnet mask (0 = unknown) */
367extern IPaddr_t NetOurDNSIP; /* Our Domain Name Server (0 = unknown) */
Jon Loeliger1fe80d72007-07-09 22:08:34 -0500368#if defined(CONFIG_BOOTP_DNS2)
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000369extern IPaddr_t NetOurDNS2IP; /* Our 2nd Domain Name Server (0 = unknown) */
stroesefe389a82003-08-28 14:17:32 +0000370#endif
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000371extern char NetOurNISDomain[32]; /* Our NIS domain */
372extern char NetOurHostName[32]; /* Our hostname */
373extern char NetOurRootPath[64]; /* Our root path */
374extern ushort NetBootFileSize; /* Our boot file size in blocks */
wdenk2d966952002-10-31 22:12:35 +0000375/** END OF BOOTP EXTENTIONS **/
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000376extern ulong NetBootFileXferSize; /* size of bootfile in bytes */
377extern uchar NetOurEther[6]; /* Our ethernet address */
378extern uchar NetServerEther[6]; /* Boot server enet address */
379extern IPaddr_t NetOurIP; /* Our IP addr (0 = unknown) */
380extern IPaddr_t NetServerIP; /* Server IP addr (0 = unknown) */
Joe Hershbergerdb288a92012-05-15 08:59:04 +0000381extern uchar *NetTxPacket; /* THE transmit packet */
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000382extern uchar *NetRxPackets[PKTBUFSRX]; /* Receive packets */
Joe Hershbergerdb288a92012-05-15 08:59:04 +0000383extern uchar *NetRxPacket; /* Current receive packet */
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000384extern int NetRxPacketLen; /* Current rx packet length */
385extern unsigned NetIPID; /* IP ID (counting) */
386extern uchar NetBcastAddr[6]; /* Ethernet boardcast address */
wdenk68ceb292004-08-02 21:11:11 +0000387extern uchar NetEtherNullAddr[6];
wdenk2d966952002-10-31 22:12:35 +0000388
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000389#define VLAN_NONE 4095 /* untagged */
390#define VLAN_IDMASK 0x0fff /* mask of valid vlan id */
391extern ushort NetOurVLAN; /* Our VLAN */
392extern ushort NetOurNativeVLAN; /* Our Native VLAN */
wdenka3d991b2004-04-15 21:48:45 +0000393
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000394extern int NetRestartWrap; /* Tried all network devices */
wdenk2d966952002-10-31 22:12:35 +0000395
Simon Glasse4bf0c52011-10-24 18:00:02 +0000396enum proto_t {
397 BOOTP, RARP, ARP, TFTPGET, DHCP, PING, DNS, NFS, CDP, NETCONS, SNTP,
Simon Glass58f317d2011-10-24 18:00:05 +0000398 TFTPSRV, TFTPPUT
Simon Glasse4bf0c52011-10-24 18:00:02 +0000399};
wdenk2d966952002-10-31 22:12:35 +0000400
401/* from net/net.c */
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000402extern char BootFile[128]; /* Boot File name */
wdenk2d966952002-10-31 22:12:35 +0000403
Robin Getz1a32bf42009-07-20 14:53:54 -0400404#if defined(CONFIG_CMD_DNS)
405extern char *NetDNSResolve; /* The host to resolve */
406extern char *NetDNSenvvar; /* the env var to put the ip into */
407#endif
408
Jon Loeliger639221c2007-07-09 17:15:49 -0500409#if defined(CONFIG_CMD_PING)
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000410extern IPaddr_t NetPingIP; /* the ip address to ping */
wdenk73a8b272003-06-05 19:27:42 +0000411#endif
412
Jon Loeliger639221c2007-07-09 17:15:49 -0500413#if defined(CONFIG_CMD_CDP)
wdenka3d991b2004-04-15 21:48:45 +0000414/* when CDP completes these hold the return values */
Joe Hershbergerf575ae12012-05-23 07:57:59 +0000415extern ushort CDPNativeVLAN; /* CDP returned native VLAN */
416extern ushort CDPApplianceVLAN; /* CDP returned appliance VLAN */
Joe Hershberger17351882012-05-23 07:58:00 +0000417
418/*
419 * Check for a CDP packet by examining the received MAC address field
420 */
421static inline int is_cdp_packet(const uchar *et_addr)
422{
423 extern const uchar NetCDPAddr[6];
424
425 return memcmp(et_addr, NetCDPAddr, 6) == 0;
426}
wdenka3d991b2004-04-15 21:48:45 +0000427#endif
428
Jon Loeliger639221c2007-07-09 17:15:49 -0500429#if defined(CONFIG_CMD_SNTP)
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000430extern IPaddr_t NetNtpServerIP; /* the ip address to NTP */
431extern int NetTimeOffset; /* offset time from UTC */
wdenkea287de2005-04-01 00:25:43 +0000432#endif
433
Joe Hershberger13dfe942012-05-15 08:59:12 +0000434#if defined(CONFIG_MCAST_TFTP)
435extern IPaddr_t Mcast_addr;
436#endif
437
wdenk2d966952002-10-31 22:12:35 +0000438/* Initialize the network adapter */
Simon Glasse4bf0c52011-10-24 18:00:02 +0000439extern int NetLoop(enum proto_t);
wdenk2d966952002-10-31 22:12:35 +0000440
441/* Shutdown adapters and cleanup */
442extern void NetStop(void);
443
444/* Load failed. Start again. */
445extern void NetStartAgain(void);
446
wdenka3d991b2004-04-15 21:48:45 +0000447/* Get size of the ethernet header when we send */
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200448extern int NetEthHdrSize(void);
wdenka3d991b2004-04-15 21:48:45 +0000449
450/* Set ethernet header; returns the size of the header */
Joe Hershbergerdb288a92012-05-15 08:59:04 +0000451extern int NetSetEther(uchar *, uchar *, uint);
Joe Hershbergere7111012012-05-23 07:59:16 +0000452extern int net_update_ether(struct ethernet_hdr *et, uchar *addr, uint prot);
wdenk2d966952002-10-31 22:12:35 +0000453
454/* Set IP header */
Joe Hershberger4b11c912012-05-23 07:59:07 +0000455extern void net_set_ip_header(uchar *pkt, IPaddr_t dest, IPaddr_t source);
456extern void net_set_udp_header(uchar *pkt, IPaddr_t dest, int dport,
457 int sport, int len);
wdenk2d966952002-10-31 22:12:35 +0000458
459/* Checksum */
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000460extern int NetCksumOk(uchar *, int); /* Return true if cksum OK */
461extern uint NetCksum(uchar *, int); /* Calculate the checksum */
wdenk2d966952002-10-31 22:12:35 +0000462
Joe Hershbergerd280d3f2012-05-23 07:58:01 +0000463/* Callbacks */
Joe Hershbergerece223b2012-05-23 07:59:15 +0000464extern rxhand_f *net_get_udp_handler(void); /* Get UDP RX packet handler */
465extern void net_set_udp_handler(rxhand_f *); /* Set UDP RX packet handler */
466extern rxhand_f *net_get_arp_handler(void); /* Get ARP RX packet handler */
467extern void net_set_arp_handler(rxhand_f *); /* Set ARP RX packet handler */
Simon Glass4793ee62011-10-24 18:00:01 +0000468extern void net_set_icmp_handler(rxhand_icmp_f *f); /* Set ICMP RX handler */
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000469extern void NetSetTimeout(ulong, thand_f *);/* Set timeout handler */
wdenk2d966952002-10-31 22:12:35 +0000470
Joe Hershberger22f6e992012-05-23 07:59:14 +0000471/* Network loop state */
472enum net_loop_state {
473 NETLOOP_CONTINUE,
474 NETLOOP_RESTART,
475 NETLOOP_SUCCESS,
476 NETLOOP_FAIL
477};
478static inline void net_set_state(enum net_loop_state state)
479{
480 extern enum net_loop_state net_state;
481
482 net_state = state;
483}
484
wdenk2d966952002-10-31 22:12:35 +0000485/* Transmit "NetTxPacket" */
Joe Hershbergeradf5d932012-05-23 07:59:13 +0000486static inline void NetSendPacket(uchar *pkt, int len)
487{
488 (void) eth_send(pkt, len);
489}
wdenk2d966952002-10-31 22:12:35 +0000490
Joe Hershberger206d07f2012-05-23 07:58:10 +0000491/*
492 * Transmit UDP packet, performing ARP request if needed
Joe Hershbergerece223b2012-05-23 07:59:15 +0000493 * (ether will be populated)
Joe Hershberger206d07f2012-05-23 07:58:10 +0000494 *
495 * @param ether Raw packet buffer
496 * @param dest IP address to send the datagram to
497 * @param dport Destination UDP port
498 * @param sport Source UDP port
499 * @param payload_len Length of data after the UDP header
500 */
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000501extern int NetSendUDPPacket(uchar *ether, IPaddr_t dest, int dport,
Joe Hershberger206d07f2012-05-23 07:58:10 +0000502 int sport, int payload_len);
wdenk73a8b272003-06-05 19:27:42 +0000503
wdenk2d966952002-10-31 22:12:35 +0000504/* Processes a received packet */
Joe Hershbergerdb288a92012-05-15 08:59:04 +0000505extern void NetReceive(uchar *, int);
wdenk2d966952002-10-31 22:12:35 +0000506
Joe Hershberger48522bb2012-05-15 08:59:08 +0000507#ifdef CONFIG_NETCONSOLE
508void NcStart(void);
509int nc_input_packet(uchar *pkt, unsigned dest, unsigned src, unsigned len);
510#endif
511
wdenk2d966952002-10-31 22:12:35 +0000512/*
Simon Glasse4a3d572011-10-27 06:24:32 +0000513 * Check if autoload is enabled. If so, use either NFS or TFTP to download
514 * the boot file.
515 */
516void net_auto_load(void);
517
518/*
wdenk2d966952002-10-31 22:12:35 +0000519 * The following functions are a bit ugly, but necessary to deal with
520 * alignment restrictions on ARM.
521 *
522 * We're using inline functions, which had the smallest memory
523 * footprint in our tests.
524 */
525/* return IP *in network byteorder* */
Joe Hershbergerdb288a92012-05-15 08:59:04 +0000526static inline IPaddr_t NetReadIP(void *from)
wdenk2d966952002-10-31 22:12:35 +0000527{
528 IPaddr_t ip;
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000529
530 memcpy((void *)&ip, (void *)from, sizeof(ip));
wdenk2d966952002-10-31 22:12:35 +0000531 return ip;
532}
533
534/* return ulong *in network byteorder* */
535static inline ulong NetReadLong(ulong *from)
536{
537 ulong l;
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000538
539 memcpy((void *)&l, (void *)from, sizeof(l));
wdenk2d966952002-10-31 22:12:35 +0000540 return l;
541}
542
543/* write IP *in network byteorder* */
544static inline void NetWriteIP(void *to, IPaddr_t ip)
545{
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000546 memcpy(to, (void *)&ip, sizeof(ip));
wdenk2d966952002-10-31 22:12:35 +0000547}
548
549/* copy IP */
Joe Hershbergerdb288a92012-05-15 08:59:04 +0000550static inline void NetCopyIP(void *to, void *from)
wdenk2d966952002-10-31 22:12:35 +0000551{
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000552 memcpy((void *)to, from, sizeof(IPaddr_t));
wdenk2d966952002-10-31 22:12:35 +0000553}
554
555/* copy ulong */
556static inline void NetCopyLong(ulong *to, ulong *from)
557{
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000558 memcpy((void *)to, (void *)from, sizeof(ulong));
wdenk2d966952002-10-31 22:12:35 +0000559}
560
Mike Rapoport50cca8b2007-08-12 08:48:27 +0300561/**
562 * is_zero_ether_addr - Determine if give Ethernet address is all zeros.
563 * @addr: Pointer to a six-byte array containing the Ethernet address
564 *
565 * Return true if the address is all zeroes.
566 */
567static inline int is_zero_ether_addr(const u8 *addr)
568{
569 return !(addr[0] | addr[1] | addr[2] | addr[3] | addr[4] | addr[5]);
570}
571
572/**
573 * is_multicast_ether_addr - Determine if the Ethernet address is a multicast.
574 * @addr: Pointer to a six-byte array containing the Ethernet address
575 *
576 * Return true if the address is a multicast address.
577 * By definition the broadcast address is also a multicast address.
578 */
579static inline int is_multicast_ether_addr(const u8 *addr)
580{
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000581 return 0x01 & addr[0];
Mike Rapoport50cca8b2007-08-12 08:48:27 +0300582}
583
Remy Bohmer23cd1382009-07-29 18:18:43 +0200584/*
585 * is_broadcast_ether_addr - Determine if the Ethernet address is broadcast
586 * @addr: Pointer to a six-byte array containing the Ethernet address
587 *
588 * Return true if the address is the broadcast address.
589 */
590static inline int is_broadcast_ether_addr(const u8 *addr)
591{
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000592 return (addr[0] & addr[1] & addr[2] & addr[3] & addr[4] & addr[5]) ==
593 0xff;
Remy Bohmer23cd1382009-07-29 18:18:43 +0200594}
595
596/*
Mike Frysinger75edebe2009-01-27 16:53:39 -0500597 * is_valid_ether_addr - Determine if the given Ethernet address is valid
598 * @addr: Pointer to a six-byte array containing the Ethernet address
599 *
600 * Check that the Ethernet address (MAC) is not 00:00:00:00:00:00, is not
601 * a multicast address, and is not FF:FF:FF:FF:FF:FF.
602 *
603 * Return true if the address is valid.
604 */
Remy Bohmer23cd1382009-07-29 18:18:43 +0200605static inline int is_valid_ether_addr(const u8 *addr)
Mike Frysinger75edebe2009-01-27 16:53:39 -0500606{
607 /* FF:FF:FF:FF:FF:FF is a multicast address so we don't need to
608 * explicitly check for it here. */
609 return !is_multicast_ether_addr(addr) && !is_zero_ether_addr(addr);
610}
611
wdenk2d966952002-10-31 22:12:35 +0000612/* Convert an IP address to a string */
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000613extern void ip_to_string(IPaddr_t x, char *s);
wdenk2d966952002-10-31 22:12:35 +0000614
wdenk73a8b272003-06-05 19:27:42 +0000615/* Convert a string to ip address */
Mike Frysinger908c6b62010-10-20 07:16:58 -0400616extern IPaddr_t string_to_ip(const char *s);
wdenk73a8b272003-06-05 19:27:42 +0000617
wdenka3d991b2004-04-15 21:48:45 +0000618/* Convert a VLAN id to a string */
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000619extern void VLAN_to_string(ushort x, char *s);
wdenka3d991b2004-04-15 21:48:45 +0000620
621/* Convert a string to a vlan id */
Mike Frysinger2e3ef6e2010-10-20 07:16:48 -0400622extern ushort string_to_VLAN(const char *s);
wdenka3d991b2004-04-15 21:48:45 +0000623
wdenka3d991b2004-04-15 21:48:45 +0000624/* read a VLAN id from an environment variable */
625extern ushort getenv_VLAN(char *);
626
wdenk2d966952002-10-31 22:12:35 +0000627/* copy a filename (allow for "..." notation, limit length) */
Joe Hershbergerb28e28b2012-05-15 08:59:05 +0000628extern void copy_filename(char *dst, const char *src, int size);
wdenk2d966952002-10-31 22:12:35 +0000629
Mike Frysinger91b469c2009-09-02 04:18:55 -0400630/* get a random source port */
631extern unsigned int random_port(void);
632
wdenk2d966952002-10-31 22:12:35 +0000633/**********************************************************************/
634
635#endif /* __NET_H__ */