67 lines
2.1 KiB
C
67 lines
2.1 KiB
C
|
// Copyright 2019 Espressif Systems (Shanghai) PTE LTD
|
||
|
|
//
|
||
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||
|
|
// you may not use this file except in compliance with the License.
|
||
|
|
// You may obtain a copy of the License at
|
||
|
|
//
|
||
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
||
|
|
//
|
||
|
|
// Unless required by applicable law or agreed to in writing, software
|
||
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
||
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||
|
|
// See the License for the specific language governing permissions and
|
||
|
|
// limitations under the License.
|
||
|
|
#pragma once
|
||
|
|
|
||
|
|
#ifdef __cplusplus
|
||
|
|
extern "C" {
|
||
|
|
#endif
|
||
|
|
|
||
|
|
#include "esp_eth.h"
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Create a netif glue for Ethernet driver
|
||
|
|
* @note netif glue is used to attach io driver to TCP/IP netif
|
||
|
|
*
|
||
|
|
* @param eth_hdl Ethernet driver handle
|
||
|
|
* @return glue object, which inherits esp_netif_driver_base_t
|
||
|
|
*/
|
||
|
|
void *esp_eth_new_netif_glue(esp_eth_handle_t eth_hdl);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Delete netif glue of Ethernet driver
|
||
|
|
*
|
||
|
|
* @param glue netif glue
|
||
|
|
* @return -ESP_OK: delete netif glue successfully
|
||
|
|
*/
|
||
|
|
esp_err_t esp_eth_del_netif_glue(void *glue);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Register default IP layer handlers for Ethernet
|
||
|
|
*
|
||
|
|
* @note: Ethernet handle might not yet properly initialized when setting up these default handlers
|
||
|
|
*
|
||
|
|
* @param[in] esp_netif esp network interface handle created for Ethernet driver
|
||
|
|
* @return
|
||
|
|
* - ESP_ERR_INVALID_ARG: invalid parameter (esp_netif is NULL)
|
||
|
|
* - ESP_OK: set default IP layer handlers successfully
|
||
|
|
* - others: other failure occurred during register esp_event handler
|
||
|
|
*/
|
||
|
|
|
||
|
|
esp_err_t esp_eth_set_default_handlers(void *esp_netif);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Unregister default IP layer handlers for Ethernet
|
||
|
|
*
|
||
|
|
* @param[in] esp_netif esp network interface handle created for Ethernet driver
|
||
|
|
* @return
|
||
|
|
* - ESP_ERR_INVALID_ARG: invalid parameter (esp_netif is NULL)
|
||
|
|
* - ESP_OK: clear default IP layer handlers successfully
|
||
|
|
* - others: other failure occurred during unregister esp_event handler
|
||
|
|
*/
|
||
|
|
esp_err_t esp_eth_clear_default_handlers(void *esp_netif);
|
||
|
|
|
||
|
|
#ifdef __cplusplus
|
||
|
|
}
|
||
|
|
#endif
|