mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
966b8620c2
If LCP keepalive mechanism is enabled in menuconfig, it's statically configured on creation of an interface and cannot be changed runtime. In some cases it's useful to relax LCP criteria during runtime operation, for example before initiating OTA. This config option allows for disabling already enabled LCP echo (this setting becomes effective after reconnecting, i.e. initializing a new session) Closes https://github.com/espressif/esp-protocols/issues/287
127 lines
5.1 KiB
C
127 lines
5.1 KiB
C
/*
|
|
* SPDX-FileCopyrightText: 2019-2023 Espressif Systems (Shanghai) CO LTD
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
//
|
|
|
|
#ifndef _ESP_NETIF_PPP_H_
|
|
#define _ESP_NETIF_PPP_H_
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/** @brief PPP event base */
|
|
ESP_EVENT_DECLARE_BASE(NETIF_PPP_STATUS);
|
|
|
|
/** @brief Configuration structure for PPP network interface
|
|
*
|
|
*/
|
|
typedef struct esp_netif_ppp_config {
|
|
bool ppp_phase_event_enabled; /**< Enables events coming from PPP PHASE change */
|
|
bool ppp_error_event_enabled; /**< Enables events from main PPP state machine producing errors */
|
|
#ifdef CONFIG_LWIP_ENABLE_LCP_ECHO
|
|
bool ppp_lcp_echo_disabled; /**< Allows to temporarily disable LCP keepalive (runtime, if enabled compile time)
|
|
* When LCP echo is enabled in menuconfig, this option can be used to override the setting,
|
|
* if we have to relax LCP keepalive criteria during runtime operation, for example before OTA update.
|
|
* The current session must be closed, settings will be applied upon connecting.
|
|
* */
|
|
#endif // CONFIG_LWIP_ENABLE_LCP_ECHO
|
|
} esp_netif_ppp_config_t;
|
|
|
|
/** @brief event id offset for PHASE related events
|
|
*
|
|
* All PPP related events are produced from esp-netif under `NETIF_PPP_STATUS`, this offset defines
|
|
* helps distinguish between error and phase events
|
|
*/
|
|
#define NETIF_PP_PHASE_OFFSET (0x100)
|
|
|
|
/** @brief event id offset for internal errors
|
|
*
|
|
*/
|
|
#define NETIF_PPP_INTERNAL_ERR_OFFSET (0x200)
|
|
|
|
/** @brief event ids for different PPP related events
|
|
*
|
|
*/
|
|
typedef enum {
|
|
NETIF_PPP_ERRORNONE = 0, /* No error. */
|
|
NETIF_PPP_ERRORPARAM = 1, /* Invalid parameter. */
|
|
NETIF_PPP_ERROROPEN = 2, /* Unable to open PPP session. */
|
|
NETIF_PPP_ERRORDEVICE = 3, /* Invalid I/O device for PPP. */
|
|
NETIF_PPP_ERRORALLOC = 4, /* Unable to allocate resources. */
|
|
NETIF_PPP_ERRORUSER = 5, /* User interrupt. */
|
|
NETIF_PPP_ERRORCONNECT = 6, /* Connection lost. */
|
|
NETIF_PPP_ERRORAUTHFAIL = 7, /* Failed authentication challenge. */
|
|
NETIF_PPP_ERRORPROTOCOL = 8, /* Failed to meet protocol. */
|
|
NETIF_PPP_ERRORPEERDEAD = 9, /* Connection timeout */
|
|
NETIF_PPP_ERRORIDLETIMEOUT = 10, /* Idle Timeout */
|
|
NETIF_PPP_ERRORCONNECTTIME = 11, /* Max connect time reached */
|
|
NETIF_PPP_ERRORLOOPBACK = 12, /* Loopback detected */
|
|
NETIF_PPP_PHASE_DEAD = NETIF_PP_PHASE_OFFSET + 0,
|
|
NETIF_PPP_PHASE_MASTER = NETIF_PP_PHASE_OFFSET + 1,
|
|
NETIF_PPP_PHASE_HOLDOFF = NETIF_PP_PHASE_OFFSET + 2,
|
|
NETIF_PPP_PHASE_INITIALIZE = NETIF_PP_PHASE_OFFSET + 3,
|
|
NETIF_PPP_PHASE_SERIALCONN = NETIF_PP_PHASE_OFFSET + 4,
|
|
NETIF_PPP_PHASE_DORMANT = NETIF_PP_PHASE_OFFSET + 5,
|
|
NETIF_PPP_PHASE_ESTABLISH = NETIF_PP_PHASE_OFFSET + 6,
|
|
NETIF_PPP_PHASE_AUTHENTICATE = NETIF_PP_PHASE_OFFSET + 7,
|
|
NETIF_PPP_PHASE_CALLBACK = NETIF_PP_PHASE_OFFSET + 8,
|
|
NETIF_PPP_PHASE_NETWORK = NETIF_PP_PHASE_OFFSET + 9,
|
|
NETIF_PPP_PHASE_RUNNING = NETIF_PP_PHASE_OFFSET + 10,
|
|
NETIF_PPP_PHASE_TERMINATE = NETIF_PP_PHASE_OFFSET + 11,
|
|
NETIF_PPP_PHASE_DISCONNECT = NETIF_PP_PHASE_OFFSET + 12,
|
|
NETIF_PPP_CONNECT_FAILED = NETIF_PPP_INTERNAL_ERR_OFFSET + 0,
|
|
} esp_netif_ppp_status_event_t;
|
|
|
|
/** @brief definitions of different authorisation types
|
|
*
|
|
*/
|
|
typedef enum {
|
|
NETIF_PPP_AUTHTYPE_NONE = 0x00,
|
|
NETIF_PPP_AUTHTYPE_PAP = 0x01,
|
|
NETIF_PPP_AUTHTYPE_CHAP = 0x02,
|
|
NETIF_PPP_AUTHTYPE_MSCHAP = 0x04,
|
|
NETIF_PPP_AUTHTYPE_MSCHAP_V2 = 0x08,
|
|
NETIF_PPP_AUTHTYPE_EAP = 0x10,
|
|
} esp_netif_auth_type_t;
|
|
|
|
/** @brief Sets the auth parameters for the supplied esp-netif.
|
|
*
|
|
* @param[in] esp_netif Handle to esp-netif instance
|
|
* @param[in] authtype Authorisation type
|
|
* @param[in] user User name
|
|
* @param[in] passwd Password
|
|
*
|
|
* @return ESP_OK on success,
|
|
* ESP_ERR_ESP_NETIF_INVALID_PARAMS if the supplied netif is not of PPP type, or netif is null
|
|
*/
|
|
esp_err_t esp_netif_ppp_set_auth(esp_netif_t *netif, esp_netif_auth_type_t authtype, const char *user, const char *passwd);
|
|
|
|
/** @brief Sets common parameters for the supplied esp-netif.
|
|
*
|
|
* @param[in] esp_netif Handle to esp-netif instance
|
|
* @param[in] config Pointer to PPP netif configuration structure
|
|
*
|
|
* @return ESP_OK on success,
|
|
* ESP_ERR_ESP_NETIF_INVALID_PARAMS if the supplied netif is not of PPP type, or netif is null
|
|
*/
|
|
esp_err_t esp_netif_ppp_set_params(esp_netif_t *netif, const esp_netif_ppp_config_t *config);
|
|
|
|
/** @brief Gets parameters configured in the supplied esp-netif.
|
|
*
|
|
* @param[in] esp_netif Handle to esp-netif instance
|
|
* @param[out] config Pointer to PPP netif configuration structure
|
|
*
|
|
* @return ESP_OK on success,
|
|
* ESP_ERR_ESP_NETIF_INVALID_PARAMS if the supplied netif is not of PPP type, or netif is null
|
|
*/
|
|
esp_err_t esp_netif_ppp_get_params(esp_netif_t *netif, esp_netif_ppp_config_t *config);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif //_ESP_NETIF_PPP_H_
|