[net][netdev]add network interface device components, SAL component adaptation netdev change

3 files changed, 364 insertions, 0 deletions

diff --git a/components/net/netdev/include/arpa/inet.h b/components/net/netdev/include/arpa/inet.h
new file mode 100644
index 0000000000..085e15dcbc
--- /dev/null
+++ b/components/net/netdev/include/arpa/inet.h
@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) 2006-2018, RT-Thread Development Team
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Change Logs:
+ * Date           Author       Notes
+ * 2015-02-17     Bernard      First version
+ */
+
+#ifndef __INET_H__
+#define __INET_H__
+
+#include <netdev_ipaddr.h>
+
+#endif
diff --git a/components/net/netdev/include/netdev.h b/components/net/netdev/include/netdev.h
new file mode 100644
index 0000000000..e194003653
--- /dev/null
+++ b/components/net/netdev/include/netdev.h
@@ -0,0 +1,179 @@
+/*
+ * Copyright (c) 2006-2019, RT-Thread Development Team
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Change Logs:
+ * Date           Author       Notes
+ * 2019-03-18     ChenYong     First version
+ */
+
+#ifndef __NETDEV_H__
+#define __NETDEV_H__
+
+#include <rtthread.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/* the maximum of all used hardware address lengths */
+#ifndef NETDEV_HWADDR_MAX_LEN
+#define NETDEV_HWADDR_MAX_LEN          8U
+#endif
+
+/* the maximum of dns server number supported */
+#ifndef NETDEV_DNS_SERVERS_NUM
+#define NETDEV_DNS_SERVERS_NUM         2U
+#endif
+
+/* whether the network interface device is 'up' (set by the network interface driver or application) */
+#define NETDEV_FLAG_UP                 0x01U
+/* if set, the network interface device has broadcast capability, only supported in the 'lwIP' stack */
+#define NETDEV_FLAG_BROADCAST          0x02U
+/* if set, the network interface device has an active link (set by the network interface driver) */
+#define NETDEV_FLAG_LINK_UP            0x04U
+/* if set, the network interface device is an ethernet device using ARP, only supported in the 'lwIP' stack */
+#define NETDEV_FLAG_ETHARP             0x08U
+/* if set, the network interface device is an ethernet device, only supported in the 'lwIP' stack */
+#define NETDEV_FLAG_ETHERNET           0x10U
+/* if set, the network interface device has IGMP capability, only supported in the 'lwIP' stack */
+#define NETDEV_FLAG_IGMP               0x20U
+/* if set, the network interface device has MLD6 capability, only supported in the 'lwIP' stack */
+#define NETDEV_FLAG_MLD6               0x40U
+/* if set, the network interface device connected to internet successfully (set by the network interface driver) */
+#define NETDEV_FLAG_INTERNET_UP        0x80U
+/* if set, the network interface device has DHCP capability (set by the network interface device driver or application) */
+#define NETDEV_FLAG_DHCP               0x100U
+
+enum netdev_cb_type
+{
+    NETDEV_CB_ADDR_IP,                 /* IP address */
+    NETDEV_CB_ADDR_NETMASK,            /* subnet mask */
+    NETDEV_CB_ADDR_GATEWAY,            /* netmask */
+    NETDEV_CB_ADDR_DNS_SERVER,         /* dns server */
+    NETDEV_CB_STATUS_UP,               /* changed to 'up' */
+    NETDEV_CB_STATUS_DOWN,             /* changed to 'down' */
+    NETDEV_CB_STATUS_LINK_UP,          /* changed to 'link up' */
+    NETDEV_CB_STATUS_LINK_DOWN,        /* changed to 'link down' */
+    NETDEV_CB_STATUS_INTERNET_UP,      /* changed to 'internet up' */
+    NETDEV_CB_STATUS_INTERNET_DOWN,    /* changed to 'internet down' */
+    NETDEV_CB_STATUS_DHCP_ENABLE,      /* enable DHCP capability */
+    NETDEV_CB_STATUS_DHCP_DISABLE,     /* disable DHCP capability */
+};
+
+struct netdev;
+
+/* function prototype for network interface device status or address change callback functions */
+typedef void (*netdev_callback_fn )(struct netdev *netdev, enum netdev_cb_type type);
+
+struct netdev_ops;
+
+/* network interface device object */
+struct netdev
+{
+    rt_slist_t list; 
+    
+    char name[RT_NAME_MAX];                            /* network interface device name */
+    ip_addr_t ip_addr;                                 /* IP address */
+    ip_addr_t netmask;                                 /* subnet mask */
+    ip_addr_t gw;                                      /* gateway */
+    ip_addr_t dns_servers[NETDEV_DNS_SERVERS_NUM];     /* DNS server */
+    uint8_t hwaddr_len;                                /* hardware address length */
+    uint8_t hwaddr[NETDEV_HWADDR_MAX_LEN];             /* hardware address */
+    
+    uint16_t flags;                                    /* network interface device status flag */
+    uint16_t mtu;                                      /* maximum transfer unit (in bytes) */
+    const struct netdev_ops *ops;                      /* network interface device operations */
+    
+    netdev_callback_fn status_callback;                /* network interface device flags change callback */
+    netdev_callback_fn addr_callback;                  /* network interface device address information change callback */
+
+#ifdef RT_USING_SAL
+    void *sal_user_data;                               /* user-specific data for SAL */
+#endif /* RT_USING_SAL */
+    void *user_data;                                   /* user-specific data */
+};
+
+/* The list of network interface device */
+extern struct netdev *netdev_list;
+/* The default network interface device */
+extern struct netdev *netdev_default;
+
+/* The network interface device ping response object */
+struct netdev_ping_resp
+{
+    ip_addr_t ip_addr;                           /* response IP address */
+    uint16_t data_len;                           /* response data length */
+    uint16_t ttl;                                /* time to live */
+    uint32_t ticks;                              /* response time, unit tick */
+    void *user_data;                             /* user-specific data */
+};
+
+/* The network interface device operations */
+struct netdev_ops
+{
+    /* set network interface device hardware status operations */
+    int (*set_up)(struct netdev *netdev);
+    int (*set_down)(struct netdev *netdev);
+
+    /* set network interface device address information operations */
+    int (*set_addr_info)(struct netdev *netdev, ip_addr_t *ip_addr, ip_addr_t *netmask, ip_addr_t *gw);
+    int (*set_dns_server)(struct netdev *netdev, ip_addr_t *dns_server);
+    int (*set_dhcp)(struct netdev *netdev, rt_bool_t is_enabled);
+
+    /* set network interface device common network interface device operations */
+    int (*ping)(struct netdev *netdev, const char *host, size_t data_len, uint32_t timeout, struct netdev_ping_resp *ping_resp);
+    void (*netstat)(struct netdev *netdev);
+
+};
+
+/* The network interface device registered and unregistered*/
+int netdev_register(struct netdev *netdev, const char *name, void *user_data);
+int netdev_unregister(struct netdev *netdev);
+
+/* Get network interface device object */
+struct netdev *netdev_get_first_link_up(void);
+struct netdev *netdev_get_by_ipaddr(ip_addr_t *ip_addr);
+struct netdev *netdev_get_by_name(const char *name);
+#ifdef RT_USING_SAL
+struct netdev *netdev_get_by_family(int family);
+#endif /* RT_USING_SAL */
+
+/* Set default network interface device in list */
+void netdev_set_default(struct netdev *netdev);
+
+/*  Set network interface device status */
+int netdev_set_up(struct netdev *netdev);
+int netdev_set_down(struct netdev *netdev);
+int netdev_dhcp_enabled(struct netdev *netdev, rt_bool_t is_enabled);
+
+/* Get network interface device status */
+#define netdev_is_up(netdev) (((netdev)->flags & NETDEV_FLAG_UP) ? (uint8_t)1 : (uint8_t)0)
+#define netdev_is_link_up(netdev) (((netdev)->flags & NETDEV_FLAG_LINK_UP) ? (uint8_t)1 : (uint8_t)0)
+#define netdev_is_internet_up(netdev) (((netdev)->flags & NETDEV_FLAG_INTERNET_UP) ? (uint8_t)1 : (uint8_t)0)
+#define netdev_is_dhcp_enabled(netdev) (((netdev)->flags & NETDEV_FLAG_DHCP) ? (uint8_t)1 : (uint8_t)0)
+
+/* Set network interface device address */
+int netdev_set_ipaddr(struct netdev *netdev, const ip_addr_t *ipaddr);
+int netdev_set_netmask(struct netdev *netdev, const ip_addr_t *netmask);
+int netdev_set_gw(struct netdev *netdev, const ip_addr_t *gw);
+int netdev_set_dns_server(struct netdev *netdev, uint8_t dns_num, const ip_addr_t *dns_server);
+
+/* Set network interface device callback, it can be called when the status or address changed */
+void netdev_set_status_callback(struct netdev *netdev, netdev_callback_fn status_callback);
+
+/* Set network interface device status and address, this function can only be called in the network interface device driver */
+void netdev_low_level_set_ipaddr(struct netdev *netdev, const ip_addr_t *ipaddr);
+void netdev_low_level_set_netmask(struct netdev *netdev, const ip_addr_t *netmask);
+void netdev_low_level_set_gw(struct netdev *netdev, const ip_addr_t *gw);
+void netdev_low_level_set_dns_server(struct netdev *netdev, uint8_t dns_num, const ip_addr_t *dns_server);
+void netdev_low_level_set_status(struct netdev *netdev, rt_bool_t is_up);
+void netdev_low_level_set_link_status(struct netdev *netdev, rt_bool_t is_up);
+void netdev_low_level_set_dhcp_status(struct netdev *netdev, rt_bool_t is_enable);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* __NETDEV_H__ */
diff --git a/components/net/netdev/include/netdev_ipaddr.h b/components/net/netdev/include/netdev_ipaddr.h
new file mode 100644
index 0000000000..c2e13cd118
--- /dev/null
+++ b/components/net/netdev/include/netdev_ipaddr.h
@@ -0,0 +1,169 @@
+/*
+ * Copyright (c) 2006-2018, RT-Thread Development Team
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Change Logs:
+ * Date           Author       Notes
+ * 2018-05-18     ChenYong     First version
+ */
+
+#ifndef __NETDEV_IPADDR_H__
+#define __NETDEV_IPADDR_H__
+
+#include <stdint.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/* Only supports the IPV4 protocol */
+#ifndef NETDEV_IPV4
+#define NETDEV_IPV4           1
+#endif
+
+#ifndef NETDEV_IPV6
+#define NETDEV_IPV6           0
+#endif
+
+#ifdef NETDEV_IPV4
+/** IPv4 only: set the IP address given as an u32_t */
+#define ip4_addr_set_u32(dest_ipaddr, src_u32) ((dest_ipaddr)->addr = (src_u32))
+/** IPv4 only: get the IP address as an u32_t */
+#define ip4_addr_get_u32(src_ipaddr) ((src_ipaddr)->addr)
+
+#define IP4ADDR_STRLEN_MAX  16
+#endif /* NETIF_IPV4 */
+
+/* These macros should be calculated by the preprocessor and are used
+   with compile-time constants only (so that there is no little-endian
+   overhead at runtime). */
+#define PP_HTONS(x) ((((x) & 0x00ffUL) << 8) | (((x) & 0xff00UL) >> 8))
+#define PP_NTOHS(x) PP_HTONS(x)
+#define PP_HTONL(x) ((((x) & 0x000000ffUL) << 24) | \
+                     (((x) & 0x0000ff00UL) <<  8) | \
+                     (((x) & 0x00ff0000UL) >>  8) | \
+                     (((x) & 0xff000000UL) >> 24))
+#define PP_NTOHL(x) PP_HTONL(x)
+
+#define htons(x) (uint16_t)PP_HTONS(x)
+#define ntohs(x) (uint16_t)PP_NTOHS(x)
+#define htonl(x) (uint32_t)PP_HTONL(x)
+#define ntohl(x) (uint32_t)PP_NTOHL(x)
+
+/* If your port already typedef's in_addr_t, define IN_ADDR_T_DEFINED
+   to prevent this code from redefining it. */
+#if !defined(in_addr_t) && !defined(IN_ADDR_T_DEFINED)
+typedef uint32_t in_addr_t;
+#endif
+
+#if NETDEV_IPV4
+struct in_addr
+{
+    in_addr_t s_addr;
+};
+
+typedef struct ip4_addr
+{
+    uint32_t addr;
+} ip4_addr_t;
+
+typedef ip4_addr_t ip_addr_t;
+#endif /* NETIF_IPV4 */
+
+#if NETDEV_IPV6
+struct in6_addr
+{
+    union
+    {
+        uint32_t u32_addr[4];
+        uint8_t u8_addr[16];
+    } un;
+#define s6_addr  un.u8_addr
+};
+
+typedef struct ip6_addr
+{
+    uint32_t addr[4];
+} ip6_addr_t;
+
+typedef ip6_addr ip_addr_t
+#endif /* NETIF_IPV6 */
+
+#if NETDEV_IPV4 && NETDEV_IPV6
+/* IP address types for use in ip_addr_t.type member */
+enum netdev_ip_addr_type
+{
+    /** IPv4 */
+    IPADDR_TYPE_V4 = 0U,
+    /** IPv6 */
+    IPADDR_TYPE_V6 = 6U,
+    /** IPv4+IPv6 ("dual-stack") */
+    IPADDR_TYPE_ANY = 46U
+};
+
+/* A union struct for both IP version's addresses */
+typedef struct _ip_addr
+{
+    union
+    {
+        ip6_addr_t ip6;
+        ip4_addr_t ip4;
+    } u_addr;
+    /** @ref netdev_ip_addr_type */
+    uint8_t type;
+} ip_addr_t;
+#endif /* NETIF_IPV4 && NETIF_IPV6 */
+
+/** 255.255.255.255 */
+#define IPADDR_NONE         ((uint32_t)0xffffffffUL)
+/** 127.0.0.1 */
+#define IPADDR_LOOPBACK     ((uint32_t)0x7f000001UL)
+/** 0.0.0.0 */
+#define IPADDR_ANY          ((uint32_t)0x00000000UL)
+/** 255.255.255.255 */
+#define IPADDR_BROADCAST    ((uint32_t)0xffffffffUL)
+
+/** 255.255.255.255 */
+#define INADDR_NONE         IPADDR_NONE
+/** 127.0.0.1 */
+#define INADDR_LOOPBACK     IPADDR_LOOPBACK
+/** 0.0.0.0 */
+#define INADDR_ANY          IPADDR_ANY
+/** 255.255.255.255 */
+#define INADDR_BROADCAST    IPADDR_BROADCAST
+
+#define IPADDR_BROADCAST_STRING "255.255.255.255"
+
+#ifdef NETDEV_IPV4
+
+/** Copy IP address - faster than ip4_addr_set: no NULL check */
+#define ip4_addr_copy(dest, src)            ((dest).addr = (src).addr)
+#define ip4_addr_cmp(addr1, addr2)          ((addr1)->addr == (addr2)->addr)
+/** Set complete address to zero */
+#define ip4_addr_set_zero(ipaddr)           ((ipaddr)->addr = 0)
+#define ip4_addr_isany_val(ipaddr)          ((ipaddr).addr == IPADDR_ANY)
+#define ip4_addr_isany(ipaddr)              ((ipaddr) == NULL || ip4_addr_isany_val(*(ipaddr)))
+
+#define ip_addr_copy(dest, src)             ip4_addr_copy(dest, src)
+#define ip_addr_cmp(addr1, addr2)           ip4_addr_cmp(addr1, addr2)
+#define ip_addr_set_zero(ipaddr)            ip4_addr_set_zero(ipaddr)
+#define ip_addr_isany(ipaddr)               ip4_addr_isany(ipaddr)
+
+in_addr_t netdev_ipaddr_addr(const char *cp);
+int netdev_ip4addr_aton(const char *cp, ip4_addr_t *addr);
+char *netdev_ip4addr_ntoa(const ip4_addr_t *addr);
+char *netdev_ip4addr_ntoa_r(const ip4_addr_t *addr, char *buf, int buflen);
+
+#define inet_addr(cp)                       netdev_ipaddr_addr(cp)
+#define inet_aton(cp, addr)                 netdev_ip4addr_aton(cp,(ip4_addr_t*)addr)
+#define inet_ntoa(addr)                     netdev_ip4addr_ntoa((const ip4_addr_t*)&(addr))
+#define inet_ntoa_r(addr, buf, buflen)      netdev_ip4addr_ntoa_r((const ip4_addr_t*)&(addr), buf, buflen)
+
+#endif /* NETDEV_IPV4 */
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* __NETDEV_IPADDR_H__ */