esp-idf/components/esp_netif/lwip/esp_netif_lwip_ppp.h

/*
 * SPDX-FileCopyrightText: 2019-2023 Espressif Systems (Shanghai) CO LTD
 *
 * SPDX-License-Identifier: Apache-2.0
 */

#ifndef _ESP_NETIF_LWIP_PPP_H_
#define _ESP_NETIF_LWIP_PPP_H_

/**
 * @brief  Creates new PPP related structure
 * This needs to be called withing lwIP context
 *
 * @param[in]     esp_netif pointer esp-netif instance
 * @param[in]     stack_config TCP/IP stack configuration structure
 *
 * @return
 *         - pointer to ppp-netif object on success
 *         - NULL otherwise
 */
netif_related_data_t * esp_netif_new_ppp(esp_netif_t *esp_netif, const esp_netif_netstack_config_t *esp_netif_stack_config);

/**
 * @brief  Creates new PPP related structure
 * This needs to be called withing lwIP context
 *
 * @param[in]     esp_netif pointer esp-netif instance
 *
 * @return
 *         - ESP_OK on success
 */
esp_err_t esp_netif_start_ppp(esp_netif_t *esp_netif);

/**
 * @brief  Data path API to input incoming packets to PPP
 *
 * @param[in]    ppp pointer to internal ppp context instance
 * @param[in]    buffer pointer to the incoming data
 * @param[in]    len length of the data
 * @param[in]    eb external buffer ptr not used here (to be inline with input function prototypes)
 *
 * @return
 *         - ESP_OK on success
 */
esp_netif_recv_ret_t esp_netif_lwip_ppp_input(void *ppp, void *buffer, size_t len, void *eb);

/**
 * @brief   Destroys the ppp netif object
 * This needs to be called withing lwIP context
 *
 * @param[in]    netif_related pointer to internal ppp context instance
 */
void esp_netif_destroy_ppp(netif_related_data_t *netif_related);

/**
 * @brief  Stops the PPP interface
 * This needs to be called withing lwIP context
 *
 * @param[in]    netif_related pointer to internal ppp context instance
 *
 * @return
 *         - ESP_OK on success
 */
esp_err_t esp_netif_stop_ppp(netif_related_data_t *netif_related);

/**
 * @brief  Sets default netif for routing priority config
 * This needs to be called withing lwIP context
 *
 * @note: This function must be called from lwip thread
 *
 */
void esp_netif_ppp_set_default_netif(netif_related_data_t *netif_related);

/**
 * @brief Set PPP auth internal version (TCPIP context must be locked)
 * This needs to be called withing lwIP context
 *
 * For params/return value description, please @refitem esp_netif_ppp_set_auth()
 */
esp_err_t esp_netif_ppp_set_auth_internal(esp_netif_t *netif, esp_netif_auth_type_t authtype, const char *user, const char *passwd);

#endif // _ESP_NETIF_LWIP_PPP_H_