mirror of
https://github.com/espressif/esp-idf.git
synced 2026-10-01 18:50:34 +03:00
Sarvesh Bodakhe
08e98f6f30
- Add esp_wifi_netif_set_static_neighbor() that to add/remove IPv6 static entry using netif API to skip Neighbor Discovery Protocol - Move the fe80::/64 + EUI-64 derivation to esp_wifi_netif.c
123 lines
3.8 KiB
C
123 lines
3.8 KiB
C
/*
|
|
* SPDX-FileCopyrightText: 2019-2023 Espressif Systems (Shanghai) CO LTD
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <stdint.h>
|
|
#include <stdbool.h>
|
|
#include "esp_err.h"
|
|
#include "esp_wifi_types.h"
|
|
#include "esp_netif_types.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* @brief Number of WiFi interfaces used by wifi-netif abstraction
|
|
*/
|
|
#define MAX_WIFI_IFS WIFI_IF_MAX
|
|
|
|
/**
|
|
* @brief Forward declaration of WiFi interface handle
|
|
*/
|
|
typedef struct wifi_netif_driver* wifi_netif_driver_t;
|
|
|
|
/**
|
|
* @brief Creates wifi driver instance to be used with esp-netif
|
|
*
|
|
* @param wifi_if wifi interface type (station, softAP)
|
|
*
|
|
* @return
|
|
* - pointer to wifi interface handle on success
|
|
* - NULL otherwise
|
|
*/
|
|
wifi_netif_driver_t esp_wifi_create_if_driver(wifi_interface_t wifi_if);
|
|
|
|
/**
|
|
* @brief Destroys wifi driver instance
|
|
*
|
|
* @param h pointer to wifi interface handle
|
|
*
|
|
*/
|
|
void esp_wifi_destroy_if_driver(wifi_netif_driver_t h);
|
|
|
|
/**
|
|
* @brief Return mac of specified wifi driver instance
|
|
*
|
|
* @param[in] ifx pointer to wifi interface handle
|
|
* @param[out] mac output mac address
|
|
*
|
|
* @return ESP_OK on success
|
|
*
|
|
*/
|
|
esp_err_t esp_wifi_get_if_mac(wifi_netif_driver_t ifx, uint8_t mac[6]);
|
|
|
|
/**
|
|
* @brief Return true if the supplied interface instance is ready after start.
|
|
* Typically used when registering on receive callback, which ought to be
|
|
* installed as soon as AP started, but once STA gets connected.
|
|
*
|
|
* @param[in] ifx pointer to wifi interface handle
|
|
*
|
|
* @return
|
|
* - true if ready after interface started (typically Access Point type)
|
|
* - false if ready once interface connected (typically for Station type)
|
|
*/
|
|
bool esp_wifi_is_if_ready_when_started(wifi_netif_driver_t ifx);
|
|
|
|
/**
|
|
* @brief Register interface receive callback function with argument
|
|
*
|
|
* @param[in] ifx pointer to wifi interface handle
|
|
* @param[in] fn function to be registered (typically esp_netif_receive)
|
|
* @param[in] arg argument to be supplied to registered function (typically esp_netif ptr)
|
|
*
|
|
* @return ESP_OK on success
|
|
*
|
|
*/
|
|
esp_err_t esp_wifi_register_if_rxcb(wifi_netif_driver_t ifx, esp_netif_receive_t fn, void * arg);
|
|
|
|
/**
|
|
* @brief Derive an IPv6 link-local address from a link-layer (MAC) address
|
|
*
|
|
* Computes fe80::/64 combined with the EUI-64 form of the given MAC (the 802
|
|
* group bit complemented) into an esp_ip6_addr_t (zone 0). Interface-agnostic.
|
|
*
|
|
* @param[out] ip6 destination, set to the derived IPv6 link-local address
|
|
* @param[in] mac source link-layer (MAC) address (6 bytes)
|
|
*/
|
|
void esp_wifi_netif_get_ip6_linklocal_from_mac(esp_ip6_addr_t *ip6, const uint8_t mac[6]);
|
|
|
|
#if CONFIG_LWIP_ND6_SUPPORT_STATIC_ENTRIES
|
|
/**
|
|
* @brief Pin (or remove) a static IPv6 link-local neighbor mapping on a wifi netif
|
|
*
|
|
* Installs a fixed link-local IPv6 -> MAC mapping for a peer reachable on the
|
|
* given wifi interface so that traffic to the peer bypasses Neighbor Discovery
|
|
* (no NS/NA exchanged), or removes a previously installed one. This layer owns
|
|
* both the netif lookup (from the interface type) and the derivation of the
|
|
* peer's link-local address from its MAC, so the caller only supplies the
|
|
* interface and the peer MAC. Only available when lwIP static ND6 entries are
|
|
* enabled.
|
|
*
|
|
* @param[in] wifi_if wifi interface the peer is reachable on
|
|
* @param[in] mac peer's link-layer (MAC) address
|
|
* @param[in] add true to add the mapping, false to remove it
|
|
*
|
|
* @return
|
|
* - ESP_OK on success
|
|
* - ESP_ERR_INVALID_ARG if mac is NULL or wifi_if is out of range
|
|
* - ESP_ERR_INVALID_STATE if the interface's netif is not up
|
|
* - error code from the underlying esp_netif call otherwise
|
|
*/
|
|
esp_err_t esp_wifi_netif_set_static_neighbor(wifi_interface_t wifi_if, const uint8_t mac[6], bool add);
|
|
#endif /* CONFIG_LWIP_ND6_SUPPORT_STATIC_ENTRIES */
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|