5.11.0.0R3
Software Development Kit
 
Loading...
Searching...
No Matches
Wi-Fi MESH Networking Functions

Functions

wwd_result_t wwd_join_mesh (const wiced_ssid_t *ssid, wiced_security_t auth_type, const uint8_t *security_key, uint8_t key_length, wwd_interface_t interface)
 
wwd_result_t wwd_mesh_filter (wiced_mac_t *mac, wwd_interface_t interface)
 
wwd_result_t wwd_mesh_status (char *result_buf, uint16_t result_buf_sz)
 
wwd_result_t wwd_set_mesh_auth_proto (uint32_t auth_proto, wwd_interface_t interface)
 
wwd_result_t wwd_set_mesh_auto_peer (uint32_t auto_peer, wwd_interface_t interface)
 
wwd_result_t wwd_set_mesh_channel (uint32_t channel, wwd_interface_t interface)
 
wwd_result_t wwd_set_mesh_mcast_rebroadcast (uint32_t mcast_rebro, wwd_interface_t interface)
 
wwd_result_t wwd_set_mesh_security (wiced_security_t auth_type, wwd_interface_t interface)
 
wwd_result_t wwd_wifi_get_flags (uint32_t *wifi_flags, wwd_interface_t interface)
 
wiced_bool_t wwd_wifi_is_mesh_enabled (void)
 
wiced_bool_t wwd_wifi_is_mesh_mcast_rebroadcast_enabled (void)
 
wwd_result_t wwd_wifi_set_flags (uint32_t *wifi_flags, wwd_interface_t interface)
 

Detailed Description

Wiced Wi-Fi Driver (WWD) functions for WLAN MESH

Function Documentation

◆ wwd_join_mesh()

wwd_result_t wwd_join_mesh ( const wiced_ssid_t * ssid,
wiced_security_t auth_type,
const uint8_t * security_key,
uint8_t key_length,
wwd_interface_t interface )
extern

join specified mesh network

Parameters
[in]ssid: Name of Mesh network to join
[in]auth_type: Authentication type:
  • WICED_SECURITY_OPEN - Open Security
  • WICED_SECURITY_WPA2_AES_PSK - WPA2 Security using AES cipher
[in]security_key: A byte array containing either the cleartext security key for WPA/WPA2 secured networks, or a pointer to an array of wiced_wep_key_t structures for WEP secured networks
[in]key_length: The length of the security_key in bytes.
[in]interface: WICED_STA_INTERFACE should be used.
Returns
WWD_SUCCESS or Error code

◆ wwd_mesh_filter()

wwd_result_t wwd_mesh_filter ( wiced_mac_t * mac,
wwd_interface_t interface )
extern

set mesh filter for specified MAC address to skip peering

Parameters
[in]mac: MAC address of node to be filtered/blocked.
[in]interface: WICED_STA_INTERFACE should be used.
Returns
WWD_SUCCESS or Error code

◆ wwd_mesh_status()

wwd_result_t wwd_mesh_status ( char * result_buf,
uint16_t result_buf_sz )
extern

Get mesh status

Parameters
[in]result_buf: pointer to buffer to store status info.
[in]result_buf_sz: size of buffer
Returns
WWD_SUCCESS or Error code

◆ wwd_set_mesh_auth_proto()

wwd_result_t wwd_set_mesh_auth_proto ( uint32_t auth_proto,
wwd_interface_t interface )
extern

enable/disable mesh auth proto

Parameters
[in]auth_proto: Mesh security mode to operate.
[in]interface: Which interface to use. Use WICED_STA_INTERFACE for mesh network, WICED_AP_INTERFACE for Gateway interface.

◆ wwd_set_mesh_auto_peer()

wwd_result_t wwd_set_mesh_auto_peer ( uint32_t auto_peer,
wwd_interface_t interface )
extern

enable/disable mesh auto peering

Parameters
[in]auto_peer: 0 (disable) or 1 (enable) mesh auto peering.
[in]interface: WICED_STA_INTERFACE for mesh network.
Returns
WWD_SUCCESS or Error code

◆ wwd_set_mesh_channel()

wwd_result_t wwd_set_mesh_channel ( uint32_t channel,
wwd_interface_t interface )
extern

set channel for mesh network operation

Parameters
[in]channel: Channel to operate on.
[in]interface: Which interface to use. Use WICED_STA_INTERFACE for mesh network, WICED_AP_INTERFACE for Gateway interface.
Returns
WWD_SUCCESS or Error code

◆ wwd_set_mesh_mcast_rebroadcast()

wwd_result_t wwd_set_mesh_mcast_rebroadcast ( uint32_t mcast_rebro,
wwd_interface_t interface )
extern

enable/disable mesh mcast rebroadcast

Parameters
[in]mcast_rebro: 0 (disable) or 1 (enable) mesh multicast rebroadcasting.
[in]interface: WICED_STA_INTERFACE for mesh network.
Returns
WWD_SUCCESS or Error code

◆ wwd_set_mesh_security()

wwd_result_t wwd_set_mesh_security ( wiced_security_t auth_type,
wwd_interface_t interface )
extern

enable/disable mesh security

Parameters
[in]auth_type: Authentication type:
  • WICED_SECURITY_OPEN - Open Security
  • WICED_SECURITY_WPA2_AES_PSK - WPA2 Security using AES cipher
[in]interface: Which interface to use. Use WICED_STA_INTERFACE for mesh network, WICED_AP_INTERFACE for Gateway interface.

◆ wwd_wifi_get_flags()

wwd_result_t wwd_wifi_get_flags ( uint32_t * wifi_flags,
wwd_interface_t interface )
extern

Retrieve various mesh related flags on an interface

Parameters
[in/out]wifi_flags : Retrieve various flags
[in]interface: WICED_STA_INTERFACE for mesh network.
Returns
WWD_SUCCESS or Error code

◆ wwd_wifi_is_mesh_enabled()

wiced_bool_t wwd_wifi_is_mesh_enabled ( void )
extern

Query whether mesh networking is currently enabled.

Returns
wiced_bool_t

◆ wwd_wifi_is_mesh_mcast_rebroadcast_enabled()

wiced_bool_t wwd_wifi_is_mesh_mcast_rebroadcast_enabled ( void )
extern

Query whether mesh multicast rebroadcast is currently enabled.

Returns
wiced_bool_t

◆ wwd_wifi_set_flags()

wwd_result_t wwd_wifi_set_flags ( uint32_t * wifi_flags,
wwd_interface_t interface )
extern

Set various mesh related flags on an interface

Parameters
[in]wifi_flags: Set various flags
[in]interface: WICED_STA_INTERFACE for mesh network.
Returns
WWD_SUCCESS or Error code