]> git.kernelconcepts.de Git - karo-tx-uboot.git/blobdiff - include/net.h
gpio: remove gpiolib.c and define remaining functions as static inline in asm/gpio.h
[karo-tx-uboot.git] / include / net.h
index 64700d915f18f0b9461231d61790261003a4c5d7..0b338ff4e63c9cff6b266a4fd9617d4fbf523efd 100644 (file)
@@ -3,7 +3,7 @@
  *
  *     Copyright 1994 - 2000 Neil Russell.
  *     (See License)
- *
+ *     SPDX-License-Identifier:        GPL-2.0
  *
  * History
  *     9/16/00   bor  adapted to TQM823L/STK8xxL board, RARP/TFTP boot added
 #include <asm/cache.h>
 #include <asm/byteorder.h>     /* for nton* / ntoh* stuff */
 
+#define DEBUG_LL_STATE 0       /* Link local state machine changes */
+#define DEBUG_DEV_PKT 0                /* Packets or info directed to the device */
+#define DEBUG_NET_PKT 0                /* Packets on info on the network at large */
+#define DEBUG_INT_STATE 0      /* Internal network state changes */
 
 /*
  *     The number of receive packet buffers, and the required packet buffer
@@ -35,7 +39,7 @@
 #define PKTALIGN       ARCH_DMA_MINALIGN
 
 /* IPv4 addresses are always 32 bits in size */
-typedef u32            IPaddr_t;
+typedef __be32         IPaddr_t;
 
 
 /**
@@ -77,7 +81,7 @@ enum eth_state_t {
 struct eth_device {
        char name[16];
        unsigned char enetaddr[6];
-       int iobase;
+       phys_addr_t iobase;
        int state;
 
        int  (*init) (struct eth_device *, bd_t *);
@@ -85,7 +89,7 @@ struct eth_device {
        int  (*recv) (struct eth_device *);
        void (*halt) (struct eth_device *);
 #ifdef CONFIG_MCAST_TFTP
-       int (*mcast) (struct eth_device *, u32 ip, u8 set);
+       int (*mcast) (struct eth_device *, const u8 *enetaddr, u8 set);
 #endif
        int  (*write_hwaddr) (struct eth_device *);
        struct eth_device *next;
@@ -98,7 +102,15 @@ extern int eth_register(struct eth_device* dev);/* Register network device */
 extern int eth_unregister(struct eth_device *dev);/* Remove network device */
 extern void eth_try_another(int first_restart);        /* Change the device */
 extern void eth_set_current(void);             /* set nterface to ethcur var */
-extern struct eth_device *eth_get_dev(void);   /* get the current device MAC */
+
+/* get the current device MAC */
+extern struct eth_device *eth_current;
+
+static inline __attribute__((always_inline))
+struct eth_device *eth_get_dev(void)
+{
+       return eth_current;
+}
 extern struct eth_device *eth_get_dev_by_name(const char *devname);
 extern struct eth_device *eth_get_dev_by_index(int index); /* get dev @ index */
 extern int eth_get_dev_index(void);            /* get the device index */
@@ -130,6 +142,19 @@ extern int eth_rx(void);                   /* Check for received packets */
 extern void eth_halt(void);                    /* stop SCC */
 extern char *eth_get_name(void);               /* get name of current device */
 
+/* Set active state */
+static inline __attribute__((always_inline)) int eth_init_state_only(bd_t *bis)
+{
+       eth_get_dev()->state = ETH_STATE_ACTIVE;
+
+       return 0;
+}
+/* Set passive state */
+static inline __attribute__((always_inline)) void eth_halt_state_only(void)
+{
+       eth_get_dev()->state = ETH_STATE_PASSIVE;
+}
+
 /*
  * Set the hardware address for an ethernet interface based on 'eth%daddr'
  * environment variable (or just 'ethaddr' if eth_number is 0).
@@ -156,7 +181,17 @@ u32 ether_crc(size_t len, unsigned char const *p);
 /*
  *     Ethernet header
  */
-typedef struct {
+
+struct ethernet_hdr {
+       uchar           et_dest[6];     /* Destination node             */
+       uchar           et_src[6];      /* Source node                  */
+       ushort          et_protlen;     /* Protocol or length           */
+};
+
+/* Ethernet header size */
+#define ETHER_HDR_SIZE (sizeof(struct ethernet_hdr))
+
+struct e802_hdr {
        uchar           et_dest[6];     /* Destination node             */
        uchar           et_src[6];      /* Source node                  */
        ushort          et_protlen;     /* Protocol or length           */
@@ -167,23 +202,24 @@ typedef struct {
        uchar           et_snap2;
        uchar           et_snap3;
        ushort          et_prot;        /* 802 protocol                 */
-} Ethernet_t;
+};
 
-#define ETHER_HDR_SIZE 14              /* Ethernet header size         */
-#define E802_HDR_SIZE  22              /* 802 ethernet header size     */
+/* 802 + SNAP + ethernet header size */
+#define E802_HDR_SIZE  (sizeof(struct e802_hdr))
 
 /*
- *     Ethernet header
+ *     Virtual LAN Ethernet header
  */
-typedef struct {
+struct vlan_ethernet_hdr {
        uchar           vet_dest[6];    /* Destination node             */
        uchar           vet_src[6];     /* Source node                  */
        ushort          vet_vlan_type;  /* PROT_VLAN                    */
        ushort          vet_tag;        /* TAG of VLAN                  */
        ushort          vet_type;       /* protocol type                */
-} VLAN_Ethernet_t;
+};
 
-#define VLAN_ETHER_HDR_SIZE    18      /* VLAN Ethernet header size    */
+/* VLAN Ethernet header size */
+#define VLAN_ETHER_HDR_SIZE    (sizeof(struct vlan_ethernet_hdr))
 
 #define PROT_IP                0x0800          /* IP protocol                  */
 #define PROT_ARP       0x0806          /* IP ARP protocol              */
@@ -196,7 +232,7 @@ typedef struct {
 /*
  *     Internet Protocol (IP) header.
  */
-typedef struct {
+struct ip_hdr {
        uchar           ip_hl_v;        /* header length and version    */
        uchar           ip_tos;         /* type of service              */
        ushort          ip_len;         /* total length                 */
@@ -207,11 +243,7 @@ typedef struct {
        ushort          ip_sum;         /* checksum                     */
        IPaddr_t        ip_src;         /* Source IP address            */
        IPaddr_t        ip_dst;         /* Destination IP address       */
-       ushort          udp_src;        /* UDP source port              */
-       ushort          udp_dst;        /* UDP destination port         */
-       ushort          udp_len;        /* Length of UDP packet         */
-       ushort          udp_xsum;       /* Checksum                     */
-} IP_t;
+};
 
 #define IP_OFFS                0x1fff /* ip offset *= 8 */
 #define IP_FLAGS       0xe000 /* first 3 bits */
@@ -219,20 +251,42 @@ typedef struct {
 #define IP_FLAGS_DFRAG 0x4000 /* don't fragments */
 #define IP_FLAGS_MFRAG 0x2000 /* more fragments */
 
-#define IP_HDR_SIZE_NO_UDP     (sizeof(IP_t) - 8)
-#define IP_HDR_SIZE            (sizeof(IP_t))
+#define IP_HDR_SIZE            (sizeof(struct ip_hdr))
+
+/*
+ *     Internet Protocol (IP) + UDP header.
+ */
+struct ip_udp_hdr {
+       uchar           ip_hl_v;        /* header length and version    */
+       uchar           ip_tos;         /* type of service              */
+       ushort          ip_len;         /* total length                 */
+       ushort          ip_id;          /* identification               */
+       ushort          ip_off;         /* fragment offset field        */
+       uchar           ip_ttl;         /* time to live                 */
+       uchar           ip_p;           /* protocol                     */
+       ushort          ip_sum;         /* checksum                     */
+       IPaddr_t        ip_src;         /* Source IP address            */
+       IPaddr_t        ip_dst;         /* Destination IP address       */
+       ushort          udp_src;        /* UDP source port              */
+       ushort          udp_dst;        /* UDP destination port         */
+       ushort          udp_len;        /* Length of UDP packet         */
+       ushort          udp_xsum;       /* Checksum                     */
+};
 
+#define IP_UDP_HDR_SIZE                (sizeof(struct ip_udp_hdr))
+#define UDP_HDR_SIZE           (IP_UDP_HDR_SIZE - IP_HDR_SIZE)
 
 /*
  *     Address Resolution Protocol (ARP) header.
  */
-typedef struct
-{
+struct arp_hdr {
        ushort          ar_hrd;         /* Format of hardware address   */
 #   define ARP_ETHER       1           /* Ethernet  hardware address   */
        ushort          ar_pro;         /* Format of protocol address   */
        uchar           ar_hln;         /* Length of hardware address   */
+#   define ARP_HLEN    6
        uchar           ar_pln;         /* Length of protocol address   */
+#   define ARP_PLEN    4
        ushort          ar_op;          /* Operation                    */
 #   define ARPOP_REQUEST    1          /* Request  to resolve  address */
 #   define ARPOP_REPLY     2           /* Response to previous request */
@@ -246,13 +300,17 @@ typedef struct
         * specific hardware/protocol combinations.
         */
        uchar           ar_data[0];
+#define ar_sha         ar_data[0]
+#define ar_spa         ar_data[ARP_HLEN]
+#define ar_tha         ar_data[ARP_HLEN + ARP_PLEN]
+#define ar_tpa         ar_data[ARP_HLEN + ARP_PLEN + ARP_HLEN]
 #if 0
        uchar           ar_sha[];       /* Sender hardware address      */
        uchar           ar_spa[];       /* Sender protocol address      */
        uchar           ar_tha[];       /* Target hardware address      */
        uchar           ar_tpa[];       /* Target protocol address      */
 #endif /* 0 */
-} ARP_t;
+};
 
 #define ARP_HDR_SIZE   (8+20)          /* Size assuming ethernet       */
 
@@ -271,7 +329,7 @@ typedef struct
 /* Codes for NOT_REACH */
 #define ICMP_NOT_REACH_PORT    3       /* Port unreachable             */
 
-typedef struct icmphdr {
+struct icmp_hdr {
        uchar           type;
        uchar           code;
        ushort          checksum;
@@ -282,13 +340,15 @@ typedef struct icmphdr {
                } echo;
                ulong   gateway;
                struct {
-                       ushort  __unused;
+                       ushort  unused;
                        ushort  mtu;
                } frag;
                uchar data[0];
        } un;
-} ICMP_t;
+};
 
+#define ICMP_HDR_SIZE          (sizeof(struct icmp_hdr))
+#define IP_ICMP_HDR_SIZE       (IP_HDR_SIZE + ICMP_HDR_SIZE)
 
 /*
  * Maximum packet size; used to allocate packet storage.
@@ -356,17 +416,11 @@ extern uchar              NetEtherNullAddr[6];
 extern ushort          NetOurVLAN;             /* Our VLAN */
 extern ushort          NetOurNativeVLAN;       /* Our Native VLAN */
 
-extern int             NetState;               /* Network loop state */
-#define NETLOOP_CONTINUE       1
-#define NETLOOP_RESTART                2
-#define NETLOOP_SUCCESS                3
-#define NETLOOP_FAIL           4
-
 extern int             NetRestartWrap;         /* Tried all network devices */
 
 enum proto_t {
        BOOTP, RARP, ARP, TFTPGET, DHCP, PING, DNS, NFS, CDP, NETCONS, SNTP,
-       TFTPSRV, TFTPPUT
+       TFTPSRV, TFTPPUT, LINKLOCAL, BOOTME
 };
 
 /* from net/net.c */
@@ -407,6 +461,7 @@ extern IPaddr_t Mcast_addr;
 #endif
 
 /* Initialize the network adapter */
+extern void net_init(void);
 extern int NetLoop(enum proto_t);
 
 /* Shutdown adapters and cleanup */
@@ -420,33 +475,119 @@ extern int       NetEthHdrSize(void);
 
 /* Set ethernet header; returns the size of the header */
 extern int NetSetEther(uchar *, uchar *, uint);
+extern int net_update_ether(struct ethernet_hdr *et, uchar *addr, uint prot);
 
 /* Set IP header */
-extern void NetSetIP(uchar *, IPaddr_t, int, int, int);
+extern void net_set_ip_header(uchar *pkt, IPaddr_t dest, IPaddr_t source);
+extern void net_set_udp_header(uchar *pkt, IPaddr_t dest, int dport,
+                               int sport, int len);
+
+/**
+ * compute_ip_checksum() - Compute IP checksum
+ *
+ * @addr:      Address to check (must be 16-bit aligned)
+ * @nbytes:    Number of bytes to check (normally a multiple of 2)
+ * @return 16-bit IP checksum
+ */
+unsigned compute_ip_checksum(const void *addr, unsigned nbytes);
+
+/**
+ * add_ip_checksums() - add two IP checksums
+ *
+ * @offset:    Offset of first sum (if odd we do a byte-swap)
+ * @sum:       First checksum
+ * @new_sum:   New checksum to add
+ * @return updated 16-bit IP checksum
+ */
+unsigned add_ip_checksums(unsigned offset, unsigned sum, unsigned new_sum);
+
+/**
+ * ip_checksum_ok() - check if a checksum is correct
+ *
+ * This works by making sure the checksum sums to 0
+ *
+ * @addr:      Address to check (must be 16-bit aligned)
+ * @nbytes:    Number of bytes to check (normally a multiple of 2)
+ * @return true if the checksum matches, false if not
+ */
+int ip_checksum_ok(const void *addr, unsigned nbytes);
 
 /* Checksum */
 extern int     NetCksumOk(uchar *, int);       /* Return true if cksum OK */
 extern uint    NetCksum(uchar *, int);         /* Calculate the checksum */
 
 /* Callbacks */
-extern rxhand_f *NetGetHandler(void);          /* Get RX packet handler */
-extern void    NetSetHandler(rxhand_f *);      /* Set RX packet handler */
+extern rxhand_f *net_get_udp_handler(void);    /* Get UDP RX packet handler */
+extern void net_set_udp_handler(rxhand_f *);   /* Set UDP RX packet handler */
+extern rxhand_f *net_get_arp_handler(void);    /* Get ARP RX packet handler */
+extern void net_set_arp_handler(rxhand_f *);   /* Set ARP RX packet handler */
 extern void net_set_icmp_handler(rxhand_icmp_f *f); /* Set ICMP RX handler */
 extern void    NetSetTimeout(ulong, thand_f *);/* Set timeout handler */
 
-/* Transmit "NetTxPacket" */
-extern void NetSendPacket(uchar *, int);
+/* Network loop state */
+enum net_loop_state {
+       NETLOOP_CONTINUE,
+       NETLOOP_RESTART,
+       NETLOOP_SUCCESS,
+       NETLOOP_FAIL
+};
+extern enum net_loop_state net_state;
+
+static inline void net_set_state(enum net_loop_state state)
+{
+       debug_cond(DEBUG_INT_STATE, "--- NetState set to %d\n", state);
+       net_state = state;
+}
+
+/* Transmit a packet */
+static inline void NetSendPacket(uchar *pkt, int len)
+{
+       (void) eth_send(pkt, len);
+}
 
-/* Transmit UDP packet, performing ARP request if needed */
-extern int     NetSendUDPPacket(uchar *ether, IPaddr_t dest, int dport,
-                       int sport, int len);
+/*
+ * Transmit "NetTxPacket" as UDP packet, performing ARP request if needed
+ *  (ether will be populated)
+ *
+ * @param ether Raw packet buffer
+ * @param dest IP address to send the datagram to
+ * @param dport Destination UDP port
+ * @param sport Source UDP port
+ * @param payload_len Length of data after the UDP header
+ */
+extern int NetSendUDPPacket(uchar *ether, IPaddr_t dest, int dport,
+                       int sport, int payload_len);
 
 /* Processes a received packet */
 extern void NetReceive(uchar *, int);
 
 #ifdef CONFIG_NETCONSOLE
 void NcStart(void);
-int nc_input_packet(uchar *pkt, unsigned dest, unsigned src, unsigned len);
+int nc_input_packet(uchar *pkt, IPaddr_t src_ip, unsigned dest_port,
+       unsigned src_port, unsigned len);
+#endif
+
+static inline __attribute__((always_inline)) int eth_is_on_demand_init(void)
+{
+#ifdef CONFIG_NETCONSOLE
+       extern enum proto_t net_loop_last_protocol;
+
+       return net_loop_last_protocol != NETCONS;
+#else
+       return 1;
+#endif
+}
+
+static inline void eth_set_last_protocol(int protocol)
+{
+#ifdef CONFIG_NETCONSOLE
+       extern enum proto_t net_loop_last_protocol;
+
+       net_loop_last_protocol = protocol;
+#endif
+}
+#ifdef CONFIG_CMD_BOOTCE
+void BootmeStart(void);
 #endif
 
 /*
@@ -549,6 +690,25 @@ static inline int is_valid_ether_addr(const u8 *addr)
        return !is_multicast_ether_addr(addr) && !is_zero_ether_addr(addr);
 }
 
+/**
+ * eth_random_addr - Generate software assigned random Ethernet address
+ * @addr: Pointer to a six-byte array containing the Ethernet address
+ *
+ * Generate a random Ethernet address (MAC) that is not multicast
+ * and has the local assigned bit set.
+ */
+static inline void eth_random_addr(uchar *addr)
+{
+       int i;
+       unsigned int seed = get_timer(0);
+
+       for (i = 0; i < 6; i++)
+               addr[i] = rand_r(&seed);
+
+       addr[0] &= 0xfe;        /* clear multicast bit */
+       addr[0] |= 0x02;        /* set local assignment bit (IEEE802) */
+}
+
 /* Convert an IP address to a string */
 extern void ip_to_string(IPaddr_t x, char *s);
 
@@ -570,6 +730,9 @@ extern void copy_filename(char *dst, const char *src, int size);
 /* get a random source port */
 extern unsigned int random_port(void);
 
+/* Update U-Boot over TFTP */
+extern int update_tftp(ulong addr);
+
 /**********************************************************************/
 
 #endif /* __NET_H__ */