IDF release/v4.0 08219f3cf

tools/sdk/include/tcpip_adapter/tcpip_adapter.h

@@ -16,7 +16,7 @@
 #define _TCPIP_ADAPTER_H_
 
 #include <stdint.h>
-#include "rom/queue.h"
+#include "sys/queue.h"
 #include "esp_wifi_types.h"
 #include "sdkconfig.h"
 
@@ -96,6 +96,7 @@ typedef enum {
     TCPIP_ADAPTER_IF_STA = 0,     /**< Wi-Fi STA (station) interface */
     TCPIP_ADAPTER_IF_AP,          /**< Wi-Fi soft-AP interface */
     TCPIP_ADAPTER_IF_ETH,         /**< Ethernet interface */
+    TCPIP_ADAPTER_IF_TEST,        /**< tcpip stack test interface */
     TCPIP_ADAPTER_IF_MAX
 } tcpip_adapter_if_t;
 
@@ -143,6 +144,37 @@ typedef enum{
 /* Deprecated name for tcpip_adapter_dhcp_option_id_t, to remove after ESP-IDF V4.0 */
 typedef tcpip_adapter_dhcp_option_id_t tcpip_adapter_option_id_t;
 
+/** IP event declarations */
+typedef enum {
+    IP_EVENT_STA_GOT_IP,               /*!< ESP32 station got IP from connected AP */
+    IP_EVENT_STA_LOST_IP,              /*!< ESP32 station lost IP and the IP is reset to 0 */
+    IP_EVENT_AP_STAIPASSIGNED,         /*!< ESP32 soft-AP assign an IP to a connected station */
+    IP_EVENT_GOT_IP6,                  /*!< ESP32 station or ap or ethernet interface v6IP addr is preferred */
+    IP_EVENT_ETH_GOT_IP,               /*!< ESP32 ethernet got IP from connected AP */
+} ip_event_t;
+
+/** @brief IP event base declaration */
+ESP_EVENT_DECLARE_BASE(IP_EVENT);
+
+/** Event structure for IP_EVENT_STA_GOT_IP, IP_EVENT_ETH_GOT_IP events  */
+typedef struct {
+    tcpip_adapter_if_t if_index;        /*!< Interface for which the event is received */
+    tcpip_adapter_ip_info_t ip_info;    /*!< IP address, netmask, gatway IP address */
+    bool ip_changed;                    /*!< Whether the assigned IP has changed or not */
+} ip_event_got_ip_t;
+
+/** Event structure for IP_EVENT_GOT_IP6 event */
+typedef struct {
+    tcpip_adapter_if_t if_index;        /*!< Interface for which the event is received */
+    tcpip_adapter_ip6_info_t ip6_info;  /*!< IPv6 address of the interface */
+} ip_event_got_ip6_t;
+
+/** Event structure for IP_EVENT_AP_STAIPASSIGNED event */
+typedef struct {
+    ip4_addr_t ip; /*!< IP address which was assigned to the station */
+} ip_event_ap_staipassigned_t;
+
+
 /**
  * @brief  Initialize the underlying TCP/IP stack
  *
@@ -157,13 +189,14 @@ void tcpip_adapter_init(void);
  *
  * @param[in]  mac Set MAC address of this interface
  * @param[in]  ip_info Set IP address of this interface
+ * @param[in]  args extra args passed to tcpip_adapter
  *
  * @return
  *         - ESP_OK
  *         - ESP_ERR_TCPIP_ADAPTER_INVALID_PARAMS
  *         - ESP_ERR_NO_MEM
  */
-esp_err_t tcpip_adapter_eth_start(uint8_t *mac, tcpip_adapter_ip_info_t *ip_info);
+esp_err_t tcpip_adapter_eth_start(uint8_t *mac, tcpip_adapter_ip_info_t *ip_info, void *args);
 
 /**
  * @brief  Cause the TCP/IP stack to start the Wi-Fi station interface with specified MAC and IP
@@ -661,6 +694,61 @@ esp_err_t tcpip_adapter_get_netif(tcpip_adapter_if_t tcpip_if, void ** netif);
  */
 bool tcpip_adapter_is_netif_up(tcpip_adapter_if_t tcpip_if);
 
+/**
+ * @brief  Cause the TCP/IP stack to start the test interface with specified MAC and IP.
+ * Test interface is used to exercise network stack with injected packets from SW.
+ *
+ * @param[in]  mac Set MAC address of this interface
+ * @param[in]  ip_info Set IP address of this interface
+ *
+ * @return
+ *         - ESP_OK
+ *         - ESP_ERR_TCPIP_ADAPTER_INVALID_PARAMS
+ *         - ESP_ERR_NO_MEM
+ */
+esp_err_t tcpip_adapter_test_start(uint8_t *mac, tcpip_adapter_ip_info_t *ip_info);
+
+/**
+ * @brief  Install default event handlers for Ethernet interface
+ * @return
+ *      - ESP_OK on success
+ *      - one of the errors from esp_event on failure
+ */
+esp_err_t tcpip_adapter_set_default_eth_handlers();
+
+/**
+ * @brief Uninstall default event handlers for Ethernet interface
+ * @return
+ *      - ESP_OK on success
+ *      - one of the errors from esp_event on failure
+ */
+esp_err_t tcpip_adapter_clear_default_eth_handlers();
+
+/**
+ * @brief  Install default event handlers for Wi-Fi interfaces (station and AP)
+ * @return
+ *      - ESP_OK on success
+ *      - one of the errors from esp_event on failure
+ */
+esp_err_t tcpip_adapter_set_default_wifi_handlers();
+
+/**
+ * @brief  Uninstall default event handlers for Wi-Fi interfaces (station and AP)
+ * @return
+ *      - ESP_OK on success
+ *      - one of the errors from esp_event on failure
+ */
+esp_err_t tcpip_adapter_clear_default_wifi_handlers();
+
+/**
+ * @brief  Search nefit index through netif interface
+ * @param[in]   tcpip_if Interface to search for netif index
+ * @return
+ *      - netif_index on success 
+ *      - -1 if an invalid parameter is supplied
+ */
+int tcpip_adapter_get_netif_index(tcpip_adapter_if_t tcpip_if);
+
 #ifdef __cplusplus
 }
 #endif

tools/sdk/include/tcpip_adapter/tcpip_adapter_internal.h

@@ -15,7 +15,7 @@
 #pragma once
 
 #include "tcpip_adapter.h"
-#include "rom/queue.h"
+#include "sys/queue.h"
 
 struct tcpip_adapter_api_msg_s;