test: Allow showing basic information about tests
[platform/kernel/u-boot.git] / include / net.h
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  *      LiMon Monitor (LiMon) - Network.
4  *
5  *      Copyright 1994 - 2000 Neil Russell.
6  *      (See License)
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
15 #include <linux/types.h>
16 #include <asm/cache.h>
17 #include <asm/byteorder.h>      /* for nton* / ntoh* stuff */
18 #include <env.h>
19 #include <log.h>
20 #include <time.h>
21 #include <linux/if_ether.h>
22 #include <rand.h>
23
24 struct bd_info;
25 struct cmd_tbl;
26 struct udevice;
27
28 #define DEBUG_LL_STATE 0        /* Link local state machine changes */
29 #define DEBUG_DEV_PKT 0         /* Packets or info directed to the device */
30 #define DEBUG_NET_PKT 0         /* Packets on info on the network at large */
31 #define DEBUG_INT_STATE 0       /* Internal network state changes */
32
33 /*
34  *      The number of receive packet buffers, and the required packet buffer
35  *      alignment in memory.
36  *
37  */
38 #define PKTBUFSRX       CONFIG_SYS_RX_ETH_BUFFER
39 #define PKTALIGN        ARCH_DMA_MINALIGN
40
41 /* Number of packets processed together */
42 #define ETH_PACKETS_BATCH_RECV  32
43
44 /* ARP hardware address length */
45 #define ARP_HLEN 6
46 /*
47  * The size of a MAC address in string form, each digit requires two chars
48  * and five separator characters to form '00:00:00:00:00:00'.
49  */
50 #define ARP_HLEN_ASCII (ARP_HLEN * 2) + (ARP_HLEN - 1)
51
52 /* IPv4 addresses are always 32 bits in size */
53 struct in_addr {
54         __be32 s_addr;
55 };
56
57 /**
58  * do_tftpb - Run the tftpboot command
59  *
60  * @cmdtp: Command information for tftpboot
61  * @flag: Command flags (CMD_FLAG_...)
62  * @argc: Number of arguments
63  * @argv: List of arguments
64  * Return: result (see enum command_ret_t)
65  */
66 int do_tftpb(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]);
67
68 /**
69  * An incoming packet handler.
70  * @param pkt    pointer to the application packet
71  * @param dport  destination UDP port
72  * @param sip    source IP address
73  * @param sport  source UDP port
74  * @param len    packet length
75  */
76 typedef void rxhand_f(uchar *pkt, unsigned dport,
77                       struct in_addr sip, unsigned sport,
78                       unsigned len);
79
80 /**
81  * An incoming ICMP packet handler.
82  * @param type  ICMP type
83  * @param code  ICMP code
84  * @param dport destination UDP port
85  * @param sip   source IP address
86  * @param sport source UDP port
87  * @param pkt   pointer to the ICMP packet data
88  * @param len   packet length
89  */
90 typedef void rxhand_icmp_f(unsigned type, unsigned code, unsigned dport,
91                 struct in_addr sip, unsigned sport, uchar *pkt, unsigned len);
92
93 /*
94  *      A timeout handler.  Called after time interval has expired.
95  */
96 typedef void    thand_f(void);
97
98 enum eth_state_t {
99         ETH_STATE_INIT,
100         ETH_STATE_PASSIVE,
101         ETH_STATE_ACTIVE
102 };
103
104 #ifdef CONFIG_DM_ETH
105 /**
106  * struct eth_pdata - Platform data for Ethernet MAC controllers
107  *
108  * @iobase: The base address of the hardware registers
109  * @enetaddr: The Ethernet MAC address that is loaded from EEPROM or env
110  * @phy_interface: PHY interface to use - see PHY_INTERFACE_MODE_...
111  * @max_speed: Maximum speed of Ethernet connection supported by MAC
112  * @priv_pdata: device specific plat
113  */
114 struct eth_pdata {
115         phys_addr_t iobase;
116         unsigned char enetaddr[ARP_HLEN];
117         int phy_interface;
118         int max_speed;
119         void *priv_pdata;
120 };
121
122 enum eth_recv_flags {
123         /*
124          * Check hardware device for new packets (otherwise only return those
125          * which are already in the memory buffer ready to process)
126          */
127         ETH_RECV_CHECK_DEVICE           = 1 << 0,
128 };
129
130 /**
131  * struct eth_ops - functions of Ethernet MAC controllers
132  *
133  * start: Prepare the hardware to send and receive packets
134  * send: Send the bytes passed in "packet" as a packet on the wire
135  * recv: Check if the hardware received a packet. If so, set the pointer to the
136  *       packet buffer in the packetp parameter. If not, return an error or 0 to
137  *       indicate that the hardware receive FIFO is empty. If 0 is returned, the
138  *       network stack will not process the empty packet, but free_pkt() will be
139  *       called if supplied
140  * free_pkt: Give the driver an opportunity to manage its packet buffer memory
141  *           when the network stack is finished processing it. This will only be
142  *           called when no error was returned from recv - optional
143  * stop: Stop the hardware from looking for packets - may be called even if
144  *       state == PASSIVE
145  * mcast: Join or leave a multicast group (for TFTP) - optional
146  * write_hwaddr: Write a MAC address to the hardware (used to pass it to Linux
147  *               on some platforms like ARM). This function expects the
148  *               eth_pdata::enetaddr field to be populated. The method can
149  *               return -ENOSYS to indicate that this is not implemented for
150                  this hardware - optional.
151  * read_rom_hwaddr: Some devices have a backup of the MAC address stored in a
152  *                  ROM on the board. This is how the driver should expose it
153  *                  to the network stack. This function should fill in the
154  *                  eth_pdata::enetaddr field - optional
155  * set_promisc: Enable or Disable promiscuous mode
156  */
157 struct eth_ops {
158         int (*start)(struct udevice *dev);
159         int (*send)(struct udevice *dev, void *packet, int length);
160         int (*recv)(struct udevice *dev, int flags, uchar **packetp);
161         int (*free_pkt)(struct udevice *dev, uchar *packet, int length);
162         void (*stop)(struct udevice *dev);
163         int (*mcast)(struct udevice *dev, const u8 *enetaddr, int join);
164         int (*write_hwaddr)(struct udevice *dev);
165         int (*read_rom_hwaddr)(struct udevice *dev);
166         int (*set_promisc)(struct udevice *dev, bool enable);
167 };
168
169 #define eth_get_ops(dev) ((struct eth_ops *)(dev)->driver->ops)
170
171 struct udevice *eth_get_dev(void); /* get the current device */
172 /*
173  * The devname can be either an exact name given by the driver or device tree
174  * or it can be an alias of the form "eth%d"
175  */
176 struct udevice *eth_get_dev_by_name(const char *devname);
177 unsigned char *eth_get_ethaddr(void); /* get the current device MAC */
178
179 /* Used only when NetConsole is enabled */
180 int eth_is_active(struct udevice *dev); /* Test device for active state */
181 int eth_init_state_only(void); /* Set active state */
182 void eth_halt_state_only(void); /* Set passive state */
183 #endif
184
185 #ifndef CONFIG_DM_ETH
186 struct eth_device {
187 #define ETH_NAME_LEN 20
188         char name[ETH_NAME_LEN];
189         unsigned char enetaddr[ARP_HLEN];
190         phys_addr_t iobase;
191         int state;
192
193         int (*init)(struct eth_device *eth, struct bd_info *bd);
194         int (*send)(struct eth_device *, void *packet, int length);
195         int (*recv)(struct eth_device *);
196         void (*halt)(struct eth_device *);
197         int (*mcast)(struct eth_device *, const u8 *enetaddr, int join);
198         int (*write_hwaddr)(struct eth_device *eth);
199         struct eth_device *next;
200         int index;
201         void *priv;
202 };
203
204 int eth_register(struct eth_device *dev);/* Register network device */
205 int eth_unregister(struct eth_device *dev);/* Remove network device */
206
207 extern struct eth_device *eth_current;
208
209 static __always_inline struct eth_device *eth_get_dev(void)
210 {
211         return eth_current;
212 }
213 struct eth_device *eth_get_dev_by_name(const char *devname);
214 struct eth_device *eth_get_dev_by_index(int index); /* get dev @ index */
215
216 /* get the current device MAC */
217 static inline unsigned char *eth_get_ethaddr(void)
218 {
219         if (eth_current)
220                 return eth_current->enetaddr;
221         return NULL;
222 }
223
224 /* Used only when NetConsole is enabled */
225 int eth_is_active(struct eth_device *dev); /* Test device for active state */
226 /* Set active state */
227 static __always_inline int eth_init_state_only(void)
228 {
229         eth_get_dev()->state = ETH_STATE_ACTIVE;
230
231         return 0;
232 }
233 /* Set passive state */
234 static __always_inline void eth_halt_state_only(void)
235 {
236         eth_get_dev()->state = ETH_STATE_PASSIVE;
237 }
238
239 /*
240  * Set the hardware address for an ethernet interface based on 'eth%daddr'
241  * environment variable (or just 'ethaddr' if eth_number is 0).
242  * Args:
243  *      base_name - base name for device (normally "eth")
244  *      eth_number - value of %d (0 for first device of this type)
245  * Returns:
246  *      0 is success, non-zero is error status from driver.
247  */
248 int eth_write_hwaddr(struct eth_device *dev, const char *base_name,
249                      int eth_number);
250
251 int usb_eth_initialize(struct bd_info *bi);
252 #endif
253
254 int eth_initialize(void);               /* Initialize network subsystem */
255 void eth_try_another(int first_restart);        /* Change the device */
256 void eth_set_current(void);             /* set nterface to ethcur var */
257
258 int eth_get_dev_index(void);            /* get the device index */
259
260 /**
261  * eth_env_set_enetaddr_by_index() - set the MAC address environment variable
262  *
263  * This sets up an environment variable with the given MAC address (@enetaddr).
264  * The environment variable to be set is defined by <@base_name><@index>addr.
265  * If @index is 0 it is omitted. For common Ethernet this means ethaddr,
266  * eth1addr, etc.
267  *
268  * @base_name:  Base name for variable, typically "eth"
269  * @index:      Index of interface being updated (>=0)
270  * @enetaddr:   Pointer to MAC address to put into the variable
271  * Return: 0 if OK, other value on error
272  */
273 int eth_env_set_enetaddr_by_index(const char *base_name, int index,
274                                  uchar *enetaddr);
275
276
277 /*
278  * Initialize USB ethernet device with CONFIG_DM_ETH
279  * Returns:
280  *      0 is success, non-zero is error status.
281  */
282 int usb_ether_init(void);
283
284 /*
285  * Get the hardware address for an ethernet interface .
286  * Args:
287  *      base_name - base name for device (normally "eth")
288  *      index - device index number (0 for first)
289  *      enetaddr - returns 6 byte hardware address
290  * Returns:
291  *      Return true if the address is valid.
292  */
293 int eth_env_get_enetaddr_by_index(const char *base_name, int index,
294                                  uchar *enetaddr);
295
296 int eth_init(void);                     /* Initialize the device */
297 int eth_send(void *packet, int length);    /* Send a packet */
298
299 #if defined(CONFIG_API) || defined(CONFIG_EFI_LOADER)
300 int eth_receive(void *packet, int length); /* Receive a packet*/
301 extern void (*push_packet)(void *packet, int length);
302 #endif
303 int eth_rx(void);                       /* Check for received packets */
304 void eth_halt(void);                    /* stop SCC */
305 const char *eth_get_name(void);         /* get name of current device */
306 int eth_mcast_join(struct in_addr mcast_addr, int join);
307
308 /**********************************************************************/
309 /*
310  *      Protocol headers.
311  */
312
313 /*
314  *      Ethernet header
315  */
316
317 struct ethernet_hdr {
318         u8              et_dest[ARP_HLEN];      /* Destination node     */
319         u8              et_src[ARP_HLEN];       /* Source node          */
320         u16             et_protlen;             /* Protocol or length   */
321 } __attribute__((packed));
322
323 /* Ethernet header size */
324 #define ETHER_HDR_SIZE  (sizeof(struct ethernet_hdr))
325
326 #define ETH_FCS_LEN     4               /* Octets in the FCS            */
327
328 struct e802_hdr {
329         u8              et_dest[ARP_HLEN];      /* Destination node     */
330         u8              et_src[ARP_HLEN];       /* Source node          */
331         u16             et_protlen;             /* Protocol or length   */
332         u8              et_dsap;                /* 802 DSAP             */
333         u8              et_ssap;                /* 802 SSAP             */
334         u8              et_ctl;                 /* 802 control          */
335         u8              et_snap1;               /* SNAP                 */
336         u8              et_snap2;
337         u8              et_snap3;
338         u16             et_prot;                /* 802 protocol         */
339 } __attribute__((packed));
340
341 /* 802 + SNAP + ethernet header size */
342 #define E802_HDR_SIZE   (sizeof(struct e802_hdr))
343
344 /*
345  *      Virtual LAN Ethernet header
346  */
347 struct vlan_ethernet_hdr {
348         u8              vet_dest[ARP_HLEN];     /* Destination node     */
349         u8              vet_src[ARP_HLEN];      /* Source node          */
350         u16             vet_vlan_type;          /* PROT_VLAN            */
351         u16             vet_tag;                /* TAG of VLAN          */
352         u16             vet_type;               /* protocol type        */
353 } __attribute__((packed));
354
355 /* VLAN Ethernet header size */
356 #define VLAN_ETHER_HDR_SIZE     (sizeof(struct vlan_ethernet_hdr))
357
358 #define PROT_IP         0x0800          /* IP protocol                  */
359 #define PROT_ARP        0x0806          /* IP ARP protocol              */
360 #define PROT_WOL        0x0842          /* ether-wake WoL protocol      */
361 #define PROT_RARP       0x8035          /* IP ARP protocol              */
362 #define PROT_VLAN       0x8100          /* IEEE 802.1q protocol         */
363 #define PROT_IPV6       0x86dd          /* IPv6 over bluebook           */
364 #define PROT_PPP_SES    0x8864          /* PPPoE session messages       */
365 #define PROT_NCSI       0x88f8          /* NC-SI control packets        */
366
367 #define IPPROTO_ICMP     1      /* Internet Control Message Protocol    */
368 #define IPPROTO_UDP     17      /* User Datagram Protocol               */
369
370 /*
371  *      Internet Protocol (IP) header.
372  */
373 struct ip_hdr {
374         u8              ip_hl_v;        /* header length and version    */
375         u8              ip_tos;         /* type of service              */
376         u16             ip_len;         /* total length                 */
377         u16             ip_id;          /* identification               */
378         u16             ip_off;         /* fragment offset field        */
379         u8              ip_ttl;         /* time to live                 */
380         u8              ip_p;           /* protocol                     */
381         u16             ip_sum;         /* checksum                     */
382         struct in_addr  ip_src;         /* Source IP address            */
383         struct in_addr  ip_dst;         /* Destination IP address       */
384 } __attribute__((packed));
385
386 #define IP_OFFS         0x1fff /* ip offset *= 8 */
387 #define IP_FLAGS        0xe000 /* first 3 bits */
388 #define IP_FLAGS_RES    0x8000 /* reserved */
389 #define IP_FLAGS_DFRAG  0x4000 /* don't fragments */
390 #define IP_FLAGS_MFRAG  0x2000 /* more fragments */
391
392 #define IP_HDR_SIZE             (sizeof(struct ip_hdr))
393
394 #define IP_MIN_FRAG_DATAGRAM_SIZE       (IP_HDR_SIZE + 8)
395
396 /*
397  *      Internet Protocol (IP) + UDP header.
398  */
399 struct ip_udp_hdr {
400         u8              ip_hl_v;        /* header length and version    */
401         u8              ip_tos;         /* type of service              */
402         u16             ip_len;         /* total length                 */
403         u16             ip_id;          /* identification               */
404         u16             ip_off;         /* fragment offset field        */
405         u8              ip_ttl;         /* time to live                 */
406         u8              ip_p;           /* protocol                     */
407         u16             ip_sum;         /* checksum                     */
408         struct in_addr  ip_src;         /* Source IP address            */
409         struct in_addr  ip_dst;         /* Destination IP address       */
410         u16             udp_src;        /* UDP source port              */
411         u16             udp_dst;        /* UDP destination port         */
412         u16             udp_len;        /* Length of UDP packet         */
413         u16             udp_xsum;       /* Checksum                     */
414 } __attribute__((packed));
415
416 #define IP_UDP_HDR_SIZE         (sizeof(struct ip_udp_hdr))
417 #define UDP_HDR_SIZE            (IP_UDP_HDR_SIZE - IP_HDR_SIZE)
418
419 /*
420  *      Address Resolution Protocol (ARP) header.
421  */
422 struct arp_hdr {
423         u16             ar_hrd;         /* Format of hardware address   */
424 #   define ARP_ETHER        1           /* Ethernet  hardware address   */
425         u16             ar_pro;         /* Format of protocol address   */
426         u8              ar_hln;         /* Length of hardware address   */
427         u8              ar_pln;         /* Length of protocol address   */
428 #   define ARP_PLEN     4
429         u16             ar_op;          /* Operation                    */
430 #   define ARPOP_REQUEST    1           /* Request  to resolve  address */
431 #   define ARPOP_REPLY      2           /* Response to previous request */
432
433 #   define RARPOP_REQUEST   3           /* Request  to resolve  address */
434 #   define RARPOP_REPLY     4           /* Response to previous request */
435
436         /*
437          * The remaining fields are variable in size, according to
438          * the sizes above, and are defined as appropriate for
439          * specific hardware/protocol combinations.
440          */
441         u8              ar_data[0];
442 #define ar_sha          ar_data[0]
443 #define ar_spa          ar_data[ARP_HLEN]
444 #define ar_tha          ar_data[ARP_HLEN + ARP_PLEN]
445 #define ar_tpa          ar_data[ARP_HLEN + ARP_PLEN + ARP_HLEN]
446 #if 0
447         u8              ar_sha[];       /* Sender hardware address      */
448         u8              ar_spa[];       /* Sender protocol address      */
449         u8              ar_tha[];       /* Target hardware address      */
450         u8              ar_tpa[];       /* Target protocol address      */
451 #endif /* 0 */
452 } __attribute__((packed));
453
454 #define ARP_HDR_SIZE    (8+20)          /* Size assuming ethernet       */
455
456 /*
457  * ICMP stuff (just enough to handle (host) redirect messages)
458  */
459 #define ICMP_ECHO_REPLY         0       /* Echo reply                   */
460 #define ICMP_NOT_REACH          3       /* Detination unreachable       */
461 #define ICMP_REDIRECT           5       /* Redirect (change route)      */
462 #define ICMP_ECHO_REQUEST       8       /* Echo request                 */
463
464 /* Codes for REDIRECT. */
465 #define ICMP_REDIR_NET          0       /* Redirect Net                 */
466 #define ICMP_REDIR_HOST         1       /* Redirect Host                */
467
468 /* Codes for NOT_REACH */
469 #define ICMP_NOT_REACH_PORT     3       /* Port unreachable             */
470
471 struct icmp_hdr {
472         u8              type;
473         u8              code;
474         u16             checksum;
475         union {
476                 struct {
477                         u16     id;
478                         u16     sequence;
479                 } echo;
480                 u32     gateway;
481                 struct {
482                         u16     unused;
483                         u16     mtu;
484                 } frag;
485                 u8 data[0];
486         } un;
487 } __attribute__((packed));
488
489 #define ICMP_HDR_SIZE           (sizeof(struct icmp_hdr))
490 #define IP_ICMP_HDR_SIZE        (IP_HDR_SIZE + ICMP_HDR_SIZE)
491
492 /*
493  * Maximum packet size; used to allocate packet storage. Use
494  * the maxium Ethernet frame size as specified by the Ethernet
495  * standard including the 802.1Q tag (VLAN tagging).
496  * maximum packet size =  1522
497  * maximum packet size and multiple of 32 bytes =  1536
498  */
499 #define PKTSIZE                 1522
500 #ifndef CONFIG_DM_DSA
501 #define PKTSIZE_ALIGN           1536
502 #else
503 /* Maximum DSA tagging overhead (headroom and/or tailroom) */
504 #define DSA_MAX_OVR             256
505 #define PKTSIZE_ALIGN           (1536 + DSA_MAX_OVR)
506 #endif
507
508 /*
509  * Maximum receive ring size; that is, the number of packets
510  * we can buffer before overflow happens. Basically, this just
511  * needs to be enough to prevent a packet being discarded while
512  * we are processing the previous one.
513  */
514 #define RINGSZ          4
515 #define RINGSZ_LOG2     2
516
517 /**********************************************************************/
518 /*
519  *      Globals.
520  *
521  * Note:
522  *
523  * All variables of type struct in_addr are stored in NETWORK byte order
524  * (big endian).
525  */
526
527 /* net.c */
528 /** BOOTP EXTENTIONS **/
529 extern struct in_addr net_gateway;      /* Our gateway IP address */
530 extern struct in_addr net_netmask;      /* Our subnet mask (0 = unknown) */
531 /* Our Domain Name Server (0 = unknown) */
532 extern struct in_addr net_dns_server;
533 #if defined(CONFIG_BOOTP_DNS2)
534 /* Our 2nd Domain Name Server (0 = unknown) */
535 extern struct in_addr net_dns_server2;
536 #endif
537 extern char     net_nis_domain[32];     /* Our IS domain */
538 extern char     net_hostname[32];       /* Our hostname */
539 #ifdef CONFIG_NET
540 extern char     net_root_path[CONFIG_BOOTP_MAX_ROOT_PATH_LEN];  /* Our root path */
541 #endif
542 /** END OF BOOTP EXTENTIONS **/
543 extern u8               net_ethaddr[ARP_HLEN];          /* Our ethernet address */
544 extern u8               net_server_ethaddr[ARP_HLEN];   /* Boot server enet address */
545 extern struct in_addr   net_ip;         /* Our    IP addr (0 = unknown) */
546 extern struct in_addr   net_server_ip;  /* Server IP addr (0 = unknown) */
547 extern uchar            *net_tx_packet;         /* THE transmit packet */
548 extern uchar            *net_rx_packets[PKTBUFSRX]; /* Receive packets */
549 extern uchar            *net_rx_packet;         /* Current receive packet */
550 extern int              net_rx_packet_len;      /* Current rx packet length */
551 extern const u8         net_bcast_ethaddr[ARP_HLEN];    /* Ethernet broadcast address */
552 extern const u8         net_null_ethaddr[ARP_HLEN];
553
554 #define VLAN_NONE       4095                    /* untagged */
555 #define VLAN_IDMASK     0x0fff                  /* mask of valid vlan id */
556 extern ushort           net_our_vlan;           /* Our VLAN */
557 extern ushort           net_native_vlan;        /* Our Native VLAN */
558
559 extern int              net_restart_wrap;       /* Tried all network devices */
560
561 enum proto_t {
562         BOOTP, RARP, ARP, TFTPGET, DHCP, PING, DNS, NFS, CDP, NETCONS, SNTP,
563         TFTPSRV, TFTPPUT, LINKLOCAL, FASTBOOT, WOL, UDP, NCSI
564 };
565
566 extern char     net_boot_file_name[1024];/* Boot File name */
567 /* Indicates whether the file name was specified on the command line */
568 extern bool     net_boot_file_name_explicit;
569 /* The actual transferred size of the bootfile (in bytes) */
570 extern u32      net_boot_file_size;
571 /* Boot file size in blocks as reported by the DHCP server */
572 extern u32      net_boot_file_expected_size_in_blocks;
573
574 #if defined(CONFIG_CMD_DNS)
575 extern char *net_dns_resolve;           /* The host to resolve  */
576 extern char *net_dns_env_var;           /* the env var to put the ip into */
577 #endif
578
579 #if defined(CONFIG_CMD_PING)
580 extern struct in_addr net_ping_ip;      /* the ip address to ping */
581 #endif
582
583 #if defined(CONFIG_CMD_CDP)
584 /* when CDP completes these hold the return values */
585 extern ushort cdp_native_vlan;          /* CDP returned native VLAN */
586 extern ushort cdp_appliance_vlan;       /* CDP returned appliance VLAN */
587
588 /*
589  * Check for a CDP packet by examining the received MAC address field
590  */
591 static inline int is_cdp_packet(const uchar *ethaddr)
592 {
593         extern const u8 net_cdp_ethaddr[ARP_HLEN];
594
595         return memcmp(ethaddr, net_cdp_ethaddr, ARP_HLEN) == 0;
596 }
597 #endif
598
599 #if defined(CONFIG_CMD_SNTP)
600 extern struct in_addr   net_ntp_server;         /* the ip address to NTP */
601 extern int net_ntp_time_offset;                 /* offset time from UTC */
602 #endif
603
604 /* Initialize the network adapter */
605 int net_init(void);
606 int net_loop(enum proto_t);
607
608 /* Load failed.  Start again. */
609 int net_start_again(void);
610
611 /* Get size of the ethernet header when we send */
612 int net_eth_hdr_size(void);
613
614 /* Set ethernet header; returns the size of the header */
615 int net_set_ether(uchar *xet, const uchar *dest_ethaddr, uint prot);
616 int net_update_ether(struct ethernet_hdr *et, uchar *addr, uint prot);
617
618 /* Set IP header */
619 void net_set_ip_header(uchar *pkt, struct in_addr dest, struct in_addr source,
620                        u16 pkt_len, u8 proto);
621 void net_set_udp_header(uchar *pkt, struct in_addr dest, int dport,
622                                 int sport, int len);
623
624 /**
625  * compute_ip_checksum() - Compute IP checksum
626  *
627  * @addr:       Address to check (must be 16-bit aligned)
628  * @nbytes:     Number of bytes to check (normally a multiple of 2)
629  * Return: 16-bit IP checksum
630  */
631 unsigned compute_ip_checksum(const void *addr, unsigned nbytes);
632
633 /**
634  * add_ip_checksums() - add two IP checksums
635  *
636  * @offset:     Offset of first sum (if odd we do a byte-swap)
637  * @sum:        First checksum
638  * @new_sum:    New checksum to add
639  * Return: updated 16-bit IP checksum
640  */
641 unsigned add_ip_checksums(unsigned offset, unsigned sum, unsigned new_sum);
642
643 /**
644  * ip_checksum_ok() - check if a checksum is correct
645  *
646  * This works by making sure the checksum sums to 0
647  *
648  * @addr:       Address to check (must be 16-bit aligned)
649  * @nbytes:     Number of bytes to check (normally a multiple of 2)
650  * Return: true if the checksum matches, false if not
651  */
652 int ip_checksum_ok(const void *addr, unsigned nbytes);
653
654 /* Callbacks */
655 rxhand_f *net_get_udp_handler(void);    /* Get UDP RX packet handler */
656 void net_set_udp_handler(rxhand_f *);   /* Set UDP RX packet handler */
657 rxhand_f *net_get_arp_handler(void);    /* Get ARP RX packet handler */
658 void net_set_arp_handler(rxhand_f *);   /* Set ARP RX packet handler */
659 bool arp_is_waiting(void);              /* Waiting for ARP reply? */
660 void net_set_icmp_handler(rxhand_icmp_f *f); /* Set ICMP RX handler */
661 void net_set_timeout_handler(ulong, thand_f *);/* Set timeout handler */
662
663 /* Network loop state */
664 enum net_loop_state {
665         NETLOOP_CONTINUE,
666         NETLOOP_RESTART,
667         NETLOOP_SUCCESS,
668         NETLOOP_FAIL
669 };
670 extern enum net_loop_state net_state;
671
672 static inline void net_set_state(enum net_loop_state state)
673 {
674         debug_cond(DEBUG_INT_STATE, "--- NetState set to %d\n", state);
675         net_state = state;
676 }
677
678 /*
679  * net_get_async_tx_pkt_buf - Get a packet buffer that is not in use for
680  *                            sending an asynchronous reply
681  *
682  * returns - ptr to packet buffer
683  */
684 uchar * net_get_async_tx_pkt_buf(void);
685
686 /* Transmit a packet */
687 static inline void net_send_packet(uchar *pkt, int len)
688 {
689         /* Currently no way to return errors from eth_send() */
690         (void) eth_send(pkt, len);
691 }
692
693 /*
694  * Transmit "net_tx_packet" as UDP packet, performing ARP request if needed
695  *  (ether will be populated)
696  *
697  * @param ether Raw packet buffer
698  * @param dest IP address to send the datagram to
699  * @param dport Destination UDP port
700  * @param sport Source UDP port
701  * @param payload_len Length of data after the UDP header
702  */
703 int net_send_ip_packet(uchar *ether, struct in_addr dest, int dport, int sport,
704                        int payload_len, int proto, u8 action, u32 tcp_seq_num,
705                        u32 tcp_ack_num);
706 int net_send_udp_packet(uchar *ether, struct in_addr dest, int dport,
707                         int sport, int payload_len);
708
709 /* Processes a received packet */
710 void net_process_received_packet(uchar *in_packet, int len);
711
712 #if defined(CONFIG_NETCONSOLE) && !defined(CONFIG_SPL_BUILD)
713 void nc_start(void);
714 int nc_input_packet(uchar *pkt, struct in_addr src_ip, unsigned dest_port,
715         unsigned src_port, unsigned len);
716 #endif
717
718 static __always_inline int eth_is_on_demand_init(void)
719 {
720 #if defined(CONFIG_NETCONSOLE) && !defined(CONFIG_SPL_BUILD)
721         extern enum proto_t net_loop_last_protocol;
722
723         return net_loop_last_protocol != NETCONS;
724 #else
725         return 1;
726 #endif
727 }
728
729 static inline void eth_set_last_protocol(int protocol)
730 {
731 #if defined(CONFIG_NETCONSOLE) && !defined(CONFIG_SPL_BUILD)
732         extern enum proto_t net_loop_last_protocol;
733
734         net_loop_last_protocol = protocol;
735 #endif
736 }
737
738 /*
739  * Check if autoload is enabled. If so, use either NFS or TFTP to download
740  * the boot file.
741  */
742 void net_auto_load(void);
743
744 /*
745  * The following functions are a bit ugly, but necessary to deal with
746  * alignment restrictions on ARM.
747  *
748  * We're using inline functions, which had the smallest memory
749  * footprint in our tests.
750  */
751 /* return IP *in network byteorder* */
752 static inline struct in_addr net_read_ip(void *from)
753 {
754         struct in_addr ip;
755
756         memcpy((void *)&ip, (void *)from, sizeof(ip));
757         return ip;
758 }
759
760 /* return ulong *in network byteorder* */
761 static inline u32 net_read_u32(void *from)
762 {
763         u32 l;
764
765         memcpy((void *)&l, (void *)from, sizeof(l));
766         return l;
767 }
768
769 /* write IP *in network byteorder* */
770 static inline void net_write_ip(void *to, struct in_addr ip)
771 {
772         memcpy(to, (void *)&ip, sizeof(ip));
773 }
774
775 /* copy IP */
776 static inline void net_copy_ip(void *to, void *from)
777 {
778         memcpy((void *)to, from, sizeof(struct in_addr));
779 }
780
781 /* copy ulong */
782 static inline void net_copy_u32(void *to, void *from)
783 {
784         memcpy((void *)to, (void *)from, sizeof(u32));
785 }
786
787 /**
788  * is_zero_ethaddr - Determine if give Ethernet address is all zeros.
789  * @addr: Pointer to a six-byte array containing the Ethernet address
790  *
791  * Return true if the address is all zeroes.
792  */
793 static inline int is_zero_ethaddr(const u8 *addr)
794 {
795         return !(addr[0] | addr[1] | addr[2] | addr[3] | addr[4] | addr[5]);
796 }
797
798 /**
799  * is_multicast_ethaddr - Determine if the Ethernet address is a multicast.
800  * @addr: Pointer to a six-byte array containing the Ethernet address
801  *
802  * Return true if the address is a multicast address.
803  * By definition the broadcast address is also a multicast address.
804  */
805 static inline int is_multicast_ethaddr(const u8 *addr)
806 {
807         return 0x01 & addr[0];
808 }
809
810 /*
811  * is_broadcast_ethaddr - Determine if the Ethernet address is broadcast
812  * @addr: Pointer to a six-byte array containing the Ethernet address
813  *
814  * Return true if the address is the broadcast address.
815  */
816 static inline int is_broadcast_ethaddr(const u8 *addr)
817 {
818         return (addr[0] & addr[1] & addr[2] & addr[3] & addr[4] & addr[5]) ==
819                 0xff;
820 }
821
822 /*
823  * is_valid_ethaddr - Determine if the given Ethernet address is valid
824  * @addr: Pointer to a six-byte array containing the Ethernet address
825  *
826  * Check that the Ethernet address (MAC) is not 00:00:00:00:00:00, is not
827  * a multicast address, and is not FF:FF:FF:FF:FF:FF.
828  *
829  * Return true if the address is valid.
830  */
831 static inline int is_valid_ethaddr(const u8 *addr)
832 {
833         /* FF:FF:FF:FF:FF:FF is a multicast address so we don't need to
834          * explicitly check for it here. */
835         return !is_multicast_ethaddr(addr) && !is_zero_ethaddr(addr);
836 }
837
838 /**
839  * net_random_ethaddr - Generate software assigned random Ethernet address
840  * @addr: Pointer to a six-byte array containing the Ethernet address
841  *
842  * Generate a random Ethernet address (MAC) that is not multicast
843  * and has the local assigned bit set.
844  */
845 static inline void net_random_ethaddr(uchar *addr)
846 {
847         int i;
848         unsigned int seed = get_ticks();
849
850         for (i = 0; i < 6; i++)
851                 addr[i] = rand_r(&seed);
852
853         addr[0] &= 0xfe;        /* clear multicast bit */
854         addr[0] |= 0x02;        /* set local assignment bit (IEEE802) */
855 }
856
857 /**
858  * string_to_enetaddr() - Parse a MAC address
859  *
860  * Convert a string MAC address
861  *
862  * Implemented in lib/net_utils.c (built unconditionally)
863  *
864  * @addr: MAC address in aa:bb:cc:dd:ee:ff format, where each part is a 2-digit
865  *      hex value
866  * @enetaddr: Place to put MAC address (6 bytes)
867  */
868 void string_to_enetaddr(const char *addr, uint8_t *enetaddr);
869
870 /* Convert an IP address to a string */
871 void ip_to_string(struct in_addr x, char *s);
872
873 /**
874  * string_to_ip() - Convert a string to ip address
875  *
876  * Implemented in lib/net_utils.c (built unconditionally)
877  *
878  * @s: Input string to parse
879  * @return: in_addr struct containing the parsed IP address
880  */
881 struct in_addr string_to_ip(const char *s);
882
883 /* Convert a VLAN id to a string */
884 void vlan_to_string(ushort x, char *s);
885
886 /* Convert a string to a vlan id */
887 ushort string_to_vlan(const char *s);
888
889 /* read a VLAN id from an environment variable */
890 ushort env_get_vlan(char *);
891
892 /* copy a filename (allow for "..." notation, limit length) */
893 void copy_filename(char *dst, const char *src, int size);
894
895 /* check if serverip is specified in filename from the command line */
896 int is_serverip_in_cmd(void);
897
898 /**
899  * net_parse_bootfile - Parse the bootfile env var / cmd line param
900  *
901  * @param ipaddr - a pointer to the ipaddr to populate if included in bootfile
902  * @param filename - a pointer to the string to save the filename part
903  * @param max_len - The longest - 1 that the filename part can be
904  *
905  * return 1 if parsed, 0 if bootfile is empty
906  */
907 int net_parse_bootfile(struct in_addr *ipaddr, char *filename, int max_len);
908
909 /**
910  * update_tftp - Update firmware over TFTP (via DFU)
911  *
912  * This function updates board's firmware via TFTP
913  *
914  * @param addr - memory address where data is stored
915  * @param interface - the DFU medium name - e.g. "mmc"
916  * @param devstring - the DFU medium number - e.g. "1"
917  *
918  * Return: - 0 on success, other value on failure
919  */
920 int update_tftp(ulong addr, char *interface, char *devstring);
921
922 /**
923  * env_get_ip() - Convert an environment value to to an ip address
924  *
925  * @var: Environment variable to convert. The value of this variable must be
926  *      in the format format a.b.c.d, where each value is a decimal number from
927  *      0 to 255
928  * Return: IP address, or 0 if invalid
929  */
930 static inline struct in_addr env_get_ip(char *var)
931 {
932         return string_to_ip(env_get(var));
933 }
934
935 /**
936  * reset_phy() - Reset the Ethernet PHY
937  *
938  * This should be implemented by boards if CONFIG_RESET_PHY_R is enabled
939  */
940 void reset_phy(void);
941
942 #endif /* __NET_H__ */