]> git.kernelconcepts.de Git - karo-tx-uboot.git/blobdiff - include/net.h
net: Use packed structures for networking
[karo-tx-uboot.git] / include / net.h
index 20cf65d7984822778788967eb20fcb0bab5774ef..9a34360fc5ed92bad58bf16f36d2ceec7d0bfe06 100644 (file)
@@ -85,10 +85,20 @@ enum eth_state_t {
  *
  * @iobase: The base address of the hardware registers
  * @enetaddr: The Ethernet MAC address that is loaded from EEPROM or env
+ * @phy_interface: PHY interface to use - see PHY_INTERFACE_MODE_...
  */
 struct eth_pdata {
        phys_addr_t iobase;
        unsigned char enetaddr[6];
+       int phy_interface;
+};
+
+enum eth_recv_flags {
+       /*
+        * Check hardware device for new packets (otherwise only return those
+        * which are already in the memory buffer ready to process)
+        */
+       ETH_RECV_CHECK_DEVICE           = 1 << 0,
 };
 
 /**
@@ -109,7 +119,9 @@ struct eth_pdata {
  * mcast: Join or leave a multicast group (for TFTP) - optional
  * write_hwaddr: Write a MAC address to the hardware (used to pass it to Linux
  *              on some platforms like ARM). This function expects the
- *              eth_pdata::enetaddr field to be populated - optional
+ *              eth_pdata::enetaddr field to be populated. The method can
+ *              return -ENOSYS to indicate that this is not implemented for
+                this hardware - optional.
  * read_rom_hwaddr: Some devices have a backup of the MAC address stored in a
  *                 ROM on the board. This is how the driver should expose it
  *                 to the network stack. This function should fill in the
@@ -118,7 +130,7 @@ struct eth_pdata {
 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 (*recv)(struct udevice *dev, int flags, uchar **packetp);
        int (*free_pkt)(struct udevice *dev, uchar *packet, int length);
        void (*stop)(struct udevice *dev);
 #ifdef CONFIG_MCAST_TFTP
@@ -149,14 +161,14 @@ struct eth_device {
        phys_addr_t iobase;
        int state;
 
-       int  (*init) (struct eth_device *, bd_t *);
-       int  (*send) (struct eth_device *, void *packet, int length);
-       int  (*recv) (struct eth_device *);
-       void (*halt) (struct eth_device *);
+       int (*init)(struct eth_device *, bd_t *);
+       int (*send)(struct eth_device *, void *packet, int length);
+       int (*recv)(struct eth_device *);
+       void (*halt)(struct eth_device *);
 #ifdef CONFIG_MCAST_TFTP
-       int (*mcast) (struct eth_device *, const u8 *enetaddr, u8 set);
+       int (*mcast)(struct eth_device *, const u8 *enetaddr, u8 set);
 #endif
-       int  (*write_hwaddr) (struct eth_device *);
+       int (*write_hwaddr)(struct eth_device *);
        struct eth_device *next;
        int index;
        void *priv;
@@ -259,10 +271,10 @@ u32 ether_crc(size_t len, unsigned char const *p);
  */
 
 struct ethernet_hdr {
-       uchar           et_dest[6];     /* Destination node             */
-       uchar           et_src[6];      /* Source node                  */
-       ushort          et_protlen;     /* Protocol or length           */
-};
+       u8              et_dest[6];     /* Destination node     */
+       u8              et_src[6];      /* Source node          */
+       u16             et_protlen;             /* Protocol or length   */
+} __attribute__((packed));
 
 /* Ethernet header size */
 #define ETHER_HDR_SIZE (sizeof(struct ethernet_hdr))
@@ -270,17 +282,17 @@ struct ethernet_hdr {
 #define ETH_FCS_LEN    4               /* Octets in the FCS            */
 
 struct e802_hdr {
-       uchar           et_dest[6];     /* Destination node             */
-       uchar           et_src[6];      /* Source node                  */
-       ushort          et_protlen;     /* Protocol or length           */
-       uchar           et_dsap;        /* 802 DSAP                     */
-       uchar           et_ssap;        /* 802 SSAP                     */
-       uchar           et_ctl;         /* 802 control                  */
-       uchar           et_snap1;       /* SNAP                         */
-       uchar           et_snap2;
-       uchar           et_snap3;
-       ushort          et_prot;        /* 802 protocol                 */
-};
+       u8              et_dest[6];     /* Destination node             */
+       u8              et_src[6];      /* Source node                  */
+       u16             et_protlen;     /* Protocol or length           */
+       u8              et_dsap;        /* 802 DSAP                     */
+       u8              et_ssap;        /* 802 SSAP                     */
+       u8              et_ctl;         /* 802 control                  */
+       u8              et_snap1;       /* SNAP                         */
+       u8              et_snap2;
+       u8              et_snap3;
+       u16             et_prot;                /* 802 protocol         */
+} __attribute__((packed));
 
 /* 802 + SNAP + ethernet header size */
 #define E802_HDR_SIZE  (sizeof(struct e802_hdr))
@@ -289,12 +301,12 @@ struct e802_hdr {
  *     Virtual LAN Ethernet header
  */
 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                */
-};
+       u8              vet_dest[6];    /* Destination node     */
+       u8              vet_src[6];     /* Source node          */
+       u16             vet_vlan_type;          /* PROT_VLAN            */
+       u16             vet_tag;                /* TAG of VLAN          */
+       u16             vet_type;               /* protocol type        */
+} __attribute__((packed));
 
 /* VLAN Ethernet header size */
 #define VLAN_ETHER_HDR_SIZE    (sizeof(struct vlan_ethernet_hdr))
@@ -311,17 +323,17 @@ struct vlan_ethernet_hdr {
  *     Internet Protocol (IP) header.
  */
 struct ip_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                     */
+       u8              ip_hl_v;        /* header length and version    */
+       u8              ip_tos;         /* type of service              */
+       u16             ip_len;         /* total length                 */
+       u16             ip_id;          /* identification               */
+       u16             ip_off;         /* fragment offset field        */
+       u8              ip_ttl;         /* time to live                 */
+       u8              ip_p;           /* protocol                     */
+       u16             ip_sum;         /* checksum                     */
        struct in_addr  ip_src;         /* Source IP address            */
        struct in_addr  ip_dst;         /* Destination IP address       */
-};
+} __attribute__((packed));
 
 #define IP_OFFS                0x1fff /* ip offset *= 8 */
 #define IP_FLAGS       0xe000 /* first 3 bits */
@@ -335,21 +347,21 @@ 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                     */
+       u8              ip_hl_v;        /* header length and version    */
+       u8              ip_tos;         /* type of service              */
+       u16             ip_len;         /* total length                 */
+       u16             ip_id;          /* identification               */
+       u16             ip_off;         /* fragment offset field        */
+       u8              ip_ttl;         /* time to live                 */
+       u8              ip_p;           /* protocol                     */
+       u16             ip_sum;         /* checksum                     */
        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         */
-       ushort          udp_xsum;       /* Checksum                     */
-};
+       u16             udp_src;        /* UDP source port              */
+       u16             udp_dst;        /* UDP destination port         */
+       u16             udp_len;        /* Length of UDP packet         */
+       u16             udp_xsum;       /* Checksum                     */
+} __attribute__((packed));
 
 #define IP_UDP_HDR_SIZE                (sizeof(struct ip_udp_hdr))
 #define UDP_HDR_SIZE           (IP_UDP_HDR_SIZE - IP_HDR_SIZE)
@@ -358,14 +370,14 @@ struct ip_udp_hdr {
  *     Address Resolution Protocol (ARP) header.
  */
 struct arp_hdr {
-       ushort          ar_hrd;         /* Format of hardware address   */
+       u16             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   */
+       u16             ar_pro;         /* Format of protocol address   */
+       u8              ar_hln;         /* Length of hardware address   */
 #   define ARP_HLEN    6
-       uchar           ar_pln;         /* Length of protocol address   */
+       u8              ar_pln;         /* Length of protocol address   */
 #   define ARP_PLEN    4
-       ushort          ar_op;          /* Operation                    */
+       u16             ar_op;          /* Operation                    */
 #   define ARPOP_REQUEST    1          /* Request  to resolve  address */
 #   define ARPOP_REPLY     2           /* Response to previous request */
 
@@ -377,18 +389,18 @@ struct arp_hdr {
         * the sizes above, and are defined as appropriate for
         * specific hardware/protocol combinations.
         */
-       uchar           ar_data[0];
+       u8              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      */
+       u8              ar_sha[];       /* Sender hardware address      */
+       u8              ar_spa[];       /* Sender protocol address      */
+       u8              ar_tha[];       /* Target hardware address      */
+       u8              ar_tpa[];       /* Target protocol address      */
 #endif /* 0 */
-};
+} __attribute__((packed));
 
 #define ARP_HDR_SIZE   (8+20)          /* Size assuming ethernet       */
 
@@ -408,22 +420,22 @@ struct arp_hdr {
 #define ICMP_NOT_REACH_PORT    3       /* Port unreachable             */
 
 struct icmp_hdr {
-       uchar           type;
-       uchar           code;
-       ushort          checksum;
+       u8              type;
+       u8              code;
+       u16             checksum;
        union {
                struct {
-                       ushort  id;
-                       ushort  sequence;
+                       u16     id;
+                       u16     sequence;
                } echo;
-               ulong   gateway;
+               u32     gateway;
                struct {
-                       ushort  unused;
-                       ushort  mtu;
+                       u16     unused;
+                       u16     mtu;
                } frag;
-               uchar data[0];
+               u8 data[0];
        } un;
-};
+} __attribute__((packed));
 
 #define ICMP_HDR_SIZE          (sizeof(struct icmp_hdr))
 #define IP_ICMP_HDR_SIZE       (IP_HDR_SIZE + ICMP_HDR_SIZE)
@@ -485,16 +497,15 @@ extern uchar              *net_tx_packet;         /* THE transmit packet */
 extern uchar           *net_rx_packets[PKTBUFSRX]; /* Receive packets */
 extern uchar           *net_rx_packet;         /* Current receive packet */
 extern int             net_rx_packet_len;      /* Current rx packet length */
-extern unsigned                NetIPID;                /* IP ID (counting) */
 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 */
-extern ushort          NetOurVLAN;             /* Our VLAN */
-extern ushort          NetOurNativeVLAN;       /* Our Native VLAN */
+extern ushort          net_our_vlan;           /* Our VLAN */
+extern ushort          net_native_vlan;        /* Our Native VLAN */
 
-extern int             NetRestartWrap;         /* Tried all network devices */
+extern int             net_restart_wrap;       /* Tried all network devices */
 
 enum proto_t {
        BOOTP, RARP, ARP, TFTPGET, DHCP, PING, DNS, NFS, CDP, NETCONS, SNTP,
@@ -534,7 +545,7 @@ static inline int is_cdp_packet(const uchar *ethaddr)
 
 #if defined(CONFIG_CMD_SNTP)
 extern struct in_addr  net_ntp_server;         /* the ip address to NTP */
-extern int NetTimeOffset;                      /* offset time from UTC */
+extern int net_ntp_time_offset;                        /* offset time from UTC */
 #endif
 
 #if defined(CONFIG_MCAST_TFTP)
@@ -543,13 +554,10 @@ extern struct in_addr net_mcast_addr;
 
 /* Initialize the network adapter */
 void net_init(void);
-int NetLoop(enum proto_t);
-
-/* Shutdown adapters and cleanup */
-void   NetStop(void);
+int net_loop(enum proto_t);
 
 /* Load failed.         Start again. */
-int    NetStartAgain(void);
+int net_start_again(void);
 
 /* Get size of the ethernet header when we send */
 int net_eth_hdr_size(void);
@@ -599,7 +607,7 @@ void net_set_udp_handler(rxhand_f *);       /* Set UDP RX packet handler */
 rxhand_f *net_get_arp_handler(void);   /* Get ARP RX packet handler */
 void net_set_arp_handler(rxhand_f *);  /* Set ARP RX packet handler */
 void net_set_icmp_handler(rxhand_icmp_f *f); /* Set ICMP RX handler */
-void   NetSetTimeout(ulong, thand_f *);/* Set timeout handler */
+void net_set_timeout_handler(ulong, thand_f *);/* Set timeout handler */
 
 /* Network loop state */
 enum net_loop_state {
@@ -640,7 +648,7 @@ int net_send_udp_packet(uchar *ether, struct in_addr dest, int dport,
 void net_process_received_packet(uchar *in_packet, int len);
 
 #ifdef CONFIG_NETCONSOLE
-void NcStart(void);
+void nc_start(void);
 int nc_input_packet(uchar *pkt, struct in_addr src_ip, unsigned dest_port,
        unsigned src_port, unsigned len);
 #endif
@@ -691,9 +699,9 @@ static inline struct in_addr net_read_ip(void *from)
 }
 
 /* return ulong *in network byteorder* */
-static inline ulong NetReadLong(ulong *from)
+static inline u32 net_read_u32(u32 *from)
 {
-       ulong l;
+       u32 l;
 
        memcpy((void *)&l, (void *)from, sizeof(l));
        return l;
@@ -712,9 +720,9 @@ static inline void net_copy_ip(void *to, void *from)
 }
 
 /* copy ulong */
-static inline void NetCopyLong(ulong *to, ulong *from)
+static inline void net_copy_u32(u32 *to, u32 *from)
 {
-       memcpy((void *)to, (void *)from, sizeof(ulong));
+       memcpy((void *)to, (void *)from, sizeof(u32));
 }
 
 /**
@@ -794,13 +802,13 @@ void ip_to_string(struct in_addr x, 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);
+void vlan_to_string(ushort x, char *s);
 
 /* Convert a string to a vlan id */
-ushort string_to_VLAN(const char *s);
+ushort string_to_vlan(const char *s);
 
 /* read a VLAN id from an environment variable */
-ushort getenv_VLAN(char *);
+ushort getenv_vlan(char *);
 
 /* copy a filename (allow for "..." notation, limit length) */
 void copy_filename(char *dst, const char *src, int size);