]> git.kernelconcepts.de Git - karo-tx-uboot.git/blobdiff - include/net.h
net: cosmetic: Name ethaddr variables consistently
[karo-tx-uboot.git] / include / net.h
index 746a877ec62cb11d6706009b0cfb3cefffcc13c5..19718c5bf4d7017b916c28c415efdeb48ed63ca5 100644 (file)
@@ -39,8 +39,9 @@
 #define PKTALIGN       ARCH_DMA_MINALIGN
 
 /* IPv4 addresses are always 32 bits in size */
-typedef __be32         IPaddr_t;
-
+struct in_addr {
+       __be32 s_addr;
+};
 
 /**
  * An incoming packet handler.
@@ -51,7 +52,7 @@ typedef __be32                IPaddr_t;
  * @param len    packet length
  */
 typedef void rxhand_f(uchar *pkt, unsigned dport,
-                     IPaddr_t sip, unsigned sport,
+                     struct in_addr sip, unsigned sport,
                      unsigned len);
 
 /**
@@ -65,7 +66,7 @@ typedef void rxhand_f(uchar *pkt, unsigned dport,
  * @param len  packet length
  */
 typedef void rxhand_icmp_f(unsigned type, unsigned code, unsigned dport,
-               IPaddr_t sip, unsigned sport, uchar *pkt, unsigned len);
+               struct in_addr sip, unsigned sport, uchar *pkt, unsigned len);
 
 /*
  *     A timeout handler.  Called after time interval has expired.
@@ -97,7 +98,12 @@ struct eth_pdata {
  * send: Send the bytes passed in "packet" as a packet on the wire
  * recv: Check if the hardware received a packet. If so, set the pointer to the
  *      packet buffer in the packetp parameter. If not, return an error or 0 to
- *      indicate that the hardware receive FIFO is empty
+ *      indicate that the hardware receive FIFO is empty. If 0 is returned, the
+ *      network stack will not process the empty packet, but free_pkt() will be
+ *      called if supplied
+ * free_pkt: Give the driver an opportunity to manage its packet buffer memory
+ *          when the network stack is finished processing it. This will only be
+ *          called when no error was returned from recv - optional
  * stop: Stop the hardware from looking for packets - may be called even if
  *      state == PASSIVE
  * mcast: Join or leave a multicast group (for TFTP) - optional
@@ -113,6 +119,7 @@ struct eth_ops {
        int (*start)(struct udevice *dev);
        int (*send)(struct udevice *dev, void *packet, int length);
        int (*recv)(struct udevice *dev, uchar **packetp);
+       int (*free_pkt)(struct udevice *dev, uchar *packet, int length);
        void (*stop)(struct udevice *dev);
 #ifdef CONFIG_MCAST_TFTP
        int (*mcast)(struct udevice *dev, const u8 *enetaddr, int join);
@@ -124,6 +131,11 @@ struct eth_ops {
 #define eth_get_ops(dev) ((struct eth_ops *)(dev)->driver->ops)
 
 struct udevice *eth_get_dev(void); /* get the current device */
+/*
+ * The devname can be either an exact name given by the driver or device tree
+ * or it can be an alias of the form "eth%d"
+ */
+struct udevice *eth_get_dev_by_name(const char *devname);
 unsigned char *eth_get_ethaddr(void); /* get the current device MAC */
 /* Used only when NetConsole is enabled */
 int eth_init_state_only(void); /* Set active state */
@@ -232,7 +244,7 @@ void eth_halt(void);                        /* stop SCC */
 const char *eth_get_name(void);                /* get name of current device */
 
 #ifdef CONFIG_MCAST_TFTP
-int eth_mcast_join(IPaddr_t mcast_addr, int join);
+int eth_mcast_join(struct in_addr mcast_addr, int join);
 u32 ether_crc(size_t len, unsigned char const *p);
 #endif
 
@@ -307,8 +319,8 @@ struct ip_hdr {
        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       */
+       struct in_addr  ip_src;         /* Source IP address            */
+       struct in_addr  ip_dst;         /* Destination IP address       */
 };
 
 #define IP_OFFS                0x1fff /* ip offset *= 8 */
@@ -331,8 +343,8 @@ struct ip_udp_hdr {
        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       */
+       struct in_addr  ip_src;         /* Source IP address            */
+       struct in_addr  ip_dst;         /* Destination IP address       */
        ushort          udp_src;        /* UDP source port              */
        ushort          udp_dst;        /* UDP destination port         */
        ushort          udp_len;        /* Length of UDP packet         */
@@ -447,28 +459,28 @@ struct icmp_hdr {
  *
  * Note:
  *
- * All variables of type IPaddr_t are stored in NETWORK byte order
+ * All variables of type struct in_addr are stored in NETWORK byte order
  * (big endian).
  */
 
 /* net.c */
 /** BOOTP EXTENTIONS **/
-extern IPaddr_t NetOurGatewayIP;       /* Our gateway IP address */
-extern IPaddr_t NetOurSubnetMask;      /* Our subnet mask (0 = unknown) */
-extern IPaddr_t NetOurDNSIP;   /* Our Domain Name Server (0 = unknown) */
+extern struct in_addr net_gateway;     /* Our gateway IP address */
+extern struct in_addr net_netmask;     /* Our subnet mask (0 = unknown) */
+/* Our Domain Name Server (0 = unknown) */
+extern struct in_addr net_dns_server;
 #if defined(CONFIG_BOOTP_DNS2)
-extern IPaddr_t NetOurDNS2IP;  /* Our 2nd Domain Name Server (0 = unknown) */
+/* Our 2nd Domain Name Server (0 = unknown) */
+extern struct in_addr net_dns_server2;
 #endif
-extern char    NetOurNISDomain[32];    /* Our NIS domain */
-extern char    NetOurHostName[32];     /* Our hostname */
-extern char    NetOurRootPath[64];     /* Our root path */
-extern ushort  NetBootFileSize;        /* Our boot file size in blocks */
+extern char    net_nis_domain[32];     /* Our IS domain */
+extern char    net_hostname[32];       /* Our hostname */
+extern char    net_root_path[64];      /* Our root path */
 /** END OF BOOTP EXTENTIONS **/
-extern ulong           NetBootFileXferSize;    /* size of bootfile in bytes */
-extern uchar           NetOurEther[6];         /* Our ethernet address */
-extern uchar           NetServerEther[6];      /* Boot server enet address */
-extern IPaddr_t                NetOurIP;       /* Our    IP addr (0 = unknown) */
-extern IPaddr_t                NetServerIP;    /* Server IP addr (0 = unknown) */
+extern u8              net_ethaddr[6];         /* Our ethernet address */
+extern u8              net_server_ethaddr[6];  /* Boot server enet address */
+extern struct in_addr  net_ip;         /* Our    IP addr (0 = unknown) */
+extern struct in_addr  net_server_ip;  /* Server IP addr (0 = unknown) */
 extern uchar           *NetTxPacket;           /* THE transmit packet */
 #ifdef CONFIG_DM_ETH
 extern uchar           *net_rx_packets[PKTBUFSRX]; /* Receive packets */
@@ -478,8 +490,8 @@ extern uchar                *NetRxPackets[PKTBUFSRX]; /* Receive packets */
 extern uchar           *NetRxPacket;           /* Current receive packet */
 extern int             NetRxPacketLen;         /* Current rx packet length */
 extern unsigned                NetIPID;                /* IP ID (counting) */
-extern uchar           NetBcastAddr[6];        /* Ethernet boardcast address */
-extern uchar           NetEtherNullAddr[6];
+extern const u8                net_bcast_ethaddr[6];   /* Ethernet broadcast address */
+extern const u8                net_null_ethaddr[6];
 
 #define VLAN_NONE      4095                    /* untagged */
 #define VLAN_IDMASK    0x0fff                  /* mask of valid vlan id */
@@ -493,8 +505,11 @@ enum proto_t {
        TFTPSRV, TFTPPUT, LINKLOCAL, BOOTME
 };
 
-/* from net/net.c */
-extern char    BootFile[128];                  /* Boot File name */
+extern char    net_boot_file_name[128];/* Boot File name */
+/* The actual transferred size of the bootfile (in bytes) */
+extern u32     net_boot_file_size;
+/* Boot file size in blocks as reported by the DHCP server */
+extern u32     net_boot_file_expected_size_in_blocks;
 
 #if defined(CONFIG_CMD_DNS)
 extern char *NetDNSResolve;            /* The host to resolve  */
@@ -502,7 +517,7 @@ extern char *NetDNSenvvar;          /* the env var to put the ip into */
 #endif
 
 #if defined(CONFIG_CMD_PING)
-extern IPaddr_t        NetPingIP;                      /* the ip address to ping */
+extern struct in_addr net_ping_ip;     /* the ip address to ping */
 #endif
 
 #if defined(CONFIG_CMD_CDP)
@@ -513,21 +528,21 @@ extern ushort CDPApplianceVLAN;           /* CDP returned appliance VLAN */
 /*
  * Check for a CDP packet by examining the received MAC address field
  */
-static inline int is_cdp_packet(const uchar *et_addr)
+static inline int is_cdp_packet(const uchar *ethaddr)
 {
-       extern const uchar NetCDPAddr[6];
+       extern const u8 net_cdp_ethaddr[6];
 
-       return memcmp(et_addr, NetCDPAddr, 6) == 0;
+       return memcmp(ethaddr, net_cdp_ethaddr, 6) == 0;
 }
 #endif
 
 #if defined(CONFIG_CMD_SNTP)
-extern IPaddr_t        NetNtpServerIP;                 /* the ip address to NTP */
+extern struct in_addr  net_ntp_server;         /* the ip address to NTP */
 extern int NetTimeOffset;                      /* offset time from UTC */
 #endif
 
 #if defined(CONFIG_MCAST_TFTP)
-extern IPaddr_t Mcast_addr;
+extern struct in_addr net_mcast_addr;
 #endif
 
 /* Initialize the network adapter */
@@ -538,18 +553,18 @@ int NetLoop(enum proto_t);
 void   NetStop(void);
 
 /* Load failed.         Start again. */
-void   NetStartAgain(void);
+int    NetStartAgain(void);
 
 /* Get size of the ethernet header when we send */
 int    NetEthHdrSize(void);
 
 /* Set ethernet header; returns the size of the header */
-int NetSetEther(uchar *, uchar *, uint);
+int NetSetEther(uchar *xet, const uchar *dest_ethaddr, uint prot);
 int net_update_ether(struct ethernet_hdr *et, uchar *addr, uint prot);
 
 /* Set IP header */
-void net_set_ip_header(uchar *pkt, IPaddr_t dest, IPaddr_t source);
-void net_set_udp_header(uchar *pkt, IPaddr_t dest, int dport,
+void net_set_ip_header(uchar *pkt, struct in_addr dest, struct in_addr source);
+void net_set_udp_header(uchar *pkt, struct in_addr dest, int dport,
                                int sport, int len);
 
 /**
@@ -608,6 +623,7 @@ static inline void net_set_state(enum net_loop_state state)
 /* Transmit a packet */
 static inline void NetSendPacket(uchar *pkt, int len)
 {
+       /* Currently no way to return errors from eth_send() */
        (void) eth_send(pkt, len);
 }
 
@@ -621,7 +637,7 @@ static inline void NetSendPacket(uchar *pkt, int len)
  * @param sport Source UDP port
  * @param payload_len Length of data after the UDP header
  */
-int NetSendUDPPacket(uchar *ether, IPaddr_t dest, int dport,
+int NetSendUDPPacket(uchar *ether, struct in_addr dest, int dport,
                        int sport, int payload_len);
 
 #ifndef CONFIG_DM_ETH
@@ -632,7 +648,7 @@ void net_process_received_packet(uchar *in_packet, int len);
 
 #ifdef CONFIG_NETCONSOLE
 void NcStart(void);
-int nc_input_packet(uchar *pkt, IPaddr_t src_ip, unsigned dest_port,
+int nc_input_packet(uchar *pkt, struct in_addr src_ip, unsigned dest_port,
        unsigned src_port, unsigned len);
 #endif
 
@@ -673,9 +689,9 @@ void net_auto_load(void);
  * footprint in our tests.
  */
 /* return IP *in network byteorder* */
-static inline IPaddr_t NetReadIP(void *from)
+static inline struct in_addr net_read_ip(void *from)
 {
-       IPaddr_t ip;
+       struct in_addr ip;
 
        memcpy((void *)&ip, (void *)from, sizeof(ip));
        return ip;
@@ -691,15 +707,15 @@ static inline ulong NetReadLong(ulong *from)
 }
 
 /* write IP *in network byteorder* */
-static inline void NetWriteIP(void *to, IPaddr_t ip)
+static inline void net_write_ip(void *to, struct in_addr ip)
 {
        memcpy(to, (void *)&ip, sizeof(ip));
 }
 
 /* copy IP */
-static inline void NetCopyIP(void *to, void *from)
+static inline void net_copy_ip(void *to, void *from)
 {
-       memcpy((void *)to, from, sizeof(IPaddr_t));
+       memcpy((void *)to, from, sizeof(struct in_addr));
 }
 
 /* copy ulong */
@@ -709,42 +725,42 @@ static inline void NetCopyLong(ulong *to, ulong *from)
 }
 
 /**
- * is_zero_ether_addr - Determine if give Ethernet address is all zeros.
+ * is_zero_ethaddr - Determine if give Ethernet address is all zeros.
  * @addr: Pointer to a six-byte array containing the Ethernet address
  *
  * Return true if the address is all zeroes.
  */
-static inline int is_zero_ether_addr(const u8 *addr)
+static inline int is_zero_ethaddr(const u8 *addr)
 {
        return !(addr[0] | addr[1] | addr[2] | addr[3] | addr[4] | addr[5]);
 }
 
 /**
- * is_multicast_ether_addr - Determine if the Ethernet address is a multicast.
+ * is_multicast_ethaddr - Determine if the Ethernet address is a multicast.
  * @addr: Pointer to a six-byte array containing the Ethernet address
  *
  * Return true if the address is a multicast address.
  * By definition the broadcast address is also a multicast address.
  */
-static inline int is_multicast_ether_addr(const u8 *addr)
+static inline int is_multicast_ethaddr(const u8 *addr)
 {
        return 0x01 & addr[0];
 }
 
 /*
- * is_broadcast_ether_addr - Determine if the Ethernet address is broadcast
+ * is_broadcast_ethaddr - Determine if the Ethernet address is broadcast
  * @addr: Pointer to a six-byte array containing the Ethernet address
  *
  * Return true if the address is the broadcast address.
  */
-static inline int is_broadcast_ether_addr(const u8 *addr)
+static inline int is_broadcast_ethaddr(const u8 *addr)
 {
        return (addr[0] & addr[1] & addr[2] & addr[3] & addr[4] & addr[5]) ==
                0xff;
 }
 
 /*
- * is_valid_ether_addr - Determine if the given Ethernet address is valid
+ * is_valid_ethaddr - Determine if the given Ethernet address is valid
  * @addr: Pointer to a six-byte array containing the Ethernet address
  *
  * Check that the Ethernet address (MAC) is not 00:00:00:00:00:00, is not
@@ -752,21 +768,21 @@ static inline int is_broadcast_ether_addr(const u8 *addr)
  *
  * Return true if the address is valid.
  */
-static inline int is_valid_ether_addr(const u8 *addr)
+static inline int is_valid_ethaddr(const u8 *addr)
 {
        /* FF:FF:FF:FF:FF:FF is a multicast address so we don't need to
         * explicitly check for it here. */
-       return !is_multicast_ether_addr(addr) && !is_zero_ether_addr(addr);
+       return !is_multicast_ethaddr(addr) && !is_zero_ethaddr(addr);
 }
 
 /**
- * eth_random_addr - Generate software assigned random Ethernet address
+ * net_random_ethaddr - 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)
+static inline void net_random_ethaddr(uchar *addr)
 {
        int i;
        unsigned int seed = get_timer(0);
@@ -779,10 +795,10 @@ static inline void eth_random_addr(uchar *addr)
 }
 
 /* Convert an IP address to a string */
-void ip_to_string(IPaddr_t x, char *s);
+void ip_to_string(struct in_addr x, char *s);
 
 /* Convert a string to ip address */
-IPaddr_t string_to_ip(const char *s);
+struct in_addr string_to_ip(const char *s);
 
 /* Convert a VLAN id to a string */
 void VLAN_to_string(ushort x, char *s);