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