Events generated by the Network - WiFi Interface functions. More...

Functions
__STATIC_INLINE void	EvrNetWiFi_InitInterface (uint8_t if_num)
	Event on WiFi interface initialize (Op)

__STATIC_INLINE void	EvrNetWiFi_DriverInitFailed (uint8_t if_num)
	Event on WiFi failed to initialize the driver (Error)

__STATIC_INLINE void	EvrNetWiFi_SetBypassModeFailed (uint8_t if_num)
	Event on WiFi failed to activate bypass mode (Error)

__STATIC_INLINE void	EvrNetWiFi_GetMacAddressFailed (uint8_t if_num)
	Event on WiFi driver get MAC address failed (Error)

__STATIC_INLINE void	EvrNetWiFi_DriverMacAddress (uint8_t if_num, const uint8_t *mac_addr)
	Event on WiFi driver provided MAC address (Op)

__STATIC_INLINE void	EvrNetWiFi_MacAddressConfigError (uint8_t if_num)
	Event on WiFi MAC address configuration error (Error)

__STATIC_INLINE void	EvrNetWiFi_SetMacAddressFailed (uint8_t if_num)
	Event on WiFi driver failed to set MAC address (Op)

__STATIC_INLINE void	EvrNetWiFi_Ip4ConfigError (uint8_t if_num)
	Event on WiFi IPv4 configuration error (Error)

__STATIC_INLINE void	EvrNetWiFi_Ip6ConfigError (uint8_t if_num)
	Event on WiFi IPv6 configuration error (Error)

__STATIC_INLINE void	EvrNetWiFi_ThreadCreateFailed (uint8_t if_num)
	Event on WiFi thread create failed (Error)

__STATIC_INLINE void	EvrNetWiFi_SemaphoreCreateFailed (uint8_t if_num)
	Event on WiFi semaphore create failed (Error)

__STATIC_INLINE void	EvrNetWiFi_GetOptionInvalidParameter (uint8_t if_num)
	Event on WiFi get_option invalid parameter (Error)

__STATIC_INLINE void	EvrNetWiFi_SetOptionInvalidParameter (uint8_t if_num)
	Event on WiFi set_option invalid parameter (Error)

__STATIC_INLINE void	EvrNetWiFi_SetMacAddress (uint8_t if_num, const uint8_t *mac_addr)
	Event on WiFi set interface MAC address (Op)

__STATIC_INLINE void	EvrNetWiFi_SetIp4Address (uint8_t if_num, const uint8_t *ip4_addr)
	Event on WiFi set interface IPv4 address (Op)

__STATIC_INLINE void	EvrNetWiFi_SetIp4SubnetMask (uint8_t if_num, const uint8_t *net_mask)
	Event on WiFi set interface IPv4 subnet mask (Op)

__STATIC_INLINE void	EvrNetWiFi_SetIp4DefaultGateway (uint8_t if_num, const uint8_t *ip4_addr)
	Event on WiFi set interface IPv4 default gateway (Op)

__STATIC_INLINE void	EvrNetWiFi_SetIp4PrimaryDNS (uint8_t if_num, const uint8_t *ip4_addr)
	Event on WiFi set interface primary DNS server (Op)

__STATIC_INLINE void	EvrNetWiFi_SetIp4SecondaryDNS (uint8_t if_num, const uint8_t *ip4_addr)
	Event on WiFi set interface secondary DNS server (Op)

__STATIC_INLINE void	EvrNetWiFi_SetIp4Mtu (uint8_t if_num, uint16_t mtu)
	Event on WiFi set interface MTU (Op)

__STATIC_INLINE void	EvrNetWiFi_SetIp6Address (uint8_t if_num, const uint8_t *ip6_addr)
	Event on WiFi set interface IPv6 static address (Op)

__STATIC_INLINE void	EvrNetWiFi_SetIp6DefaultGateway (uint8_t if_num, const uint8_t *ip6_addr)
	Event on WiFi set interface IPv6 default gateway (Op)

__STATIC_INLINE void	EvrNetWiFi_SetIp6PrimaryDNS (uint8_t if_num, const uint8_t *ip6_addr)
	Event on WiFi set interface primary DNS server (Op)

__STATIC_INLINE void	EvrNetWiFi_SetIp6SecondaryDNS (uint8_t if_num, const uint8_t *ip6_addr)
	Event on WiFi set interface secondary DNS server (Op)

__STATIC_INLINE void	EvrNetWiFi_SetIp6PrefixLength (uint8_t if_num, uint8_t pref_len)
	Event on WiFi set interface IPv6 subnet prefix length (Op)

__STATIC_INLINE void	EvrNetWiFi_SetIp6Mtu (uint8_t if_num, uint16_t mtu)
	Event on WiFi set interface MTU (Op)

__STATIC_INLINE void	EvrNetWiFi_Scan (uint8_t if_num, uint32_t max_num)
	Event on WiFi scan wireless networks (API)

__STATIC_INLINE void	EvrNetWiFi_ScanWrongMode (uint8_t if_num, uint32_t mode)
	Event on WiFi scan in wrong mode (Error)

__STATIC_INLINE void	EvrNetWiFi_ScanInvalidParameter (uint8_t if_num)
	Event on WiFi scan invalid parameter (Error)

__STATIC_INLINE void	EvrNetWiFi_ScanComplete (uint8_t if_num, uint32_t num)
	Event on WiFi scan wireless networks complete (Op)

__STATIC_INLINE void	EvrNetWiFi_GetOption (uint8_t if_num, uint32_t opt)
	Event on WiFi get driver option (API)

__STATIC_INLINE void	EvrNetWiFi_SetOption (uint8_t if_num, uint32_t opt)
	Event on WiFi set driver option (API)

__STATIC_INLINE void	EvrNetWiFi_Activate (uint8_t if_num, uint32_t mode)
	Event on WiFi interface activate (API)

__STATIC_INLINE void	EvrNetWiFi_ActivateInvalidParameter (uint8_t if_num)
	Event on WiFi activate invalid parameter (Error)

__STATIC_INLINE void	EvrNetWiFi_Deactivate (uint8_t if_num, uint32_t mode)
	Event on WiFi interface deactivate (API)

__STATIC_INLINE void	EvrNetWiFi_DeactivateInvalidParam (uint8_t if_num)
	Event on WiFi deactivate invalid parameter (Error)

__STATIC_INLINE void	EvrNetWiFi_GetNetInfo (uint8_t if_num)
	Event on WiFi get network information (API)

__STATIC_INLINE void	EvrNetWiFi_GetNetInfoWrongMode (uint8_t if_num, uint32_t mode)
	Event on WiFi get network information in wrong mode (Error)

__STATIC_INLINE void	EvrNetWiFi_GetNetInfoInvalidParam (uint8_t if_num)
	Event on WiFi get network information invalid parameter (Error)

__STATIC_INLINE void	EvrNetWiFi_SendFrame (uint8_t if_num, uint32_t length, uint8_t ip_version)
	Event on WiFi send frame (Op)

__STATIC_INLINE void	EvrNetWiFi_NotConnected (uint8_t if_num)
	Event on WiFi station not connected (Error)

__STATIC_INLINE void	EvrNetWiFi_SendDataTooLarge (uint8_t if_num, uint32_t length, uint32_t max_length)
	Event on WiFi send payload too large error (Error)

__STATIC_INLINE void	EvrNetWiFi_SendIp4Disabled (uint8_t if_num)
	Event on WiFi send IPv4 disabled error (Error)

__STATIC_INLINE void	EvrNetWiFi_Ip4LocalAddressUndefined (uint8_t if_num)
	Event on WiFi local IPv4 address undefined (Error)

__STATIC_INLINE void	EvrNetWiFi_Ip4MacAddressUnresolved (uint8_t if_num, const uint8_t *ip4_addr)
	Event on WiFi MAC address unresolved (Error)

__STATIC_INLINE void	EvrNetWiFi_EnqueueFrame (uint8_t if_num, uint32_t ca_entry, uint32_t length)
	Event on enqueued WiFi frame for unresolved MAC address (Op)

__STATIC_INLINE void	EvrNetWiFi_SendIp6Disabled (uint8_t if_num)
	Event on WiFi send IPv6 disabled error (Error)

__STATIC_INLINE void	EvrNetWiFi_Ip6LocalAddressUndefined (uint8_t if_num)
	Event on WiFi local IPv6 address undefined (Error)

__STATIC_INLINE void	EvrNetWiFi_Ip6MacAddressUnresolved (uint8_t if_num, const uint8_t *ip6_addr)
	Event on WiFi MAC address unresolved (Error)

__STATIC_INLINE void	EvrNetWiFi_InvalidIpVersion (uint8_t if_num, uint8_t ip_version)
	Event on WiFi invalid IP version (Error)

__STATIC_INLINE void	EvrNetWiFi_ShowFrameHeader (const void *eth_header)
	Event on WiFi display send/receive frame header (Detail)

__STATIC_INLINE void	EvrNetWiFi_LinkStateChange (uint8_t if_num, uint32_t state)
	Event on WiFi connection state change (Op)

__STATIC_INLINE void	EvrNetWiFi_ReceiveFrame (uint8_t if_num, uint32_t length)
	Event on WiFi receive frame (Op)

__STATIC_INLINE void	EvrNetWiFi_Ip4Disabled (uint8_t if_num)
	Event on WiFi receive IPv4 disabled (Op)

__STATIC_INLINE void	EvrNetWiFi_Ip6Disabled (uint8_t if_num)
	Event on WiFi receive IPv6 disabled (Op)

__STATIC_INLINE void	EvrNetWiFi_ProtocolUnknown (uint8_t if_num, uint16_t protocol)
	Event on WiFi receive protocol unknown (Op)

__STATIC_INLINE void	EvrNetWiFi_OutputLowLevel (uint8_t if_num, uint32_t length)
	Event on WiFi output frame (Op)

__STATIC_INLINE void	EvrNetWiFi_TxQueueOverflow (uint8_t if_num)
	Event on WiFi output queue overflow (Error)

__STATIC_INLINE void	EvrNetWiFi_OutputNoMemory (uint8_t if_num)
	Event on WIFI output out of memory (Error)

__STATIC_INLINE void	EvrNetWiFi_UninitInterface (uint8_t if_num)
	Event on WiFi interface de-initialize (Op)

Description

Events generated by the Network - WiFi Interface functions.

The Network WiFi Interface functions generate events that inform about events in the WiFi interface and help in troubleshooting.

WiFi Interface uses bypass or transparent mode. In this mode, the ethernet frames are exchanged.

Function Documentation

◆ EvrNetWiFi_Activate()

__STATIC_INLINE void EvrNetWiFi_Activate	(	uint8_t	if_num,
		uint32_t	mode
	)

Event on WiFi interface activate (API)

Parameters

if_num	interface number
mode	WiFi interface mode 0: Station 1: Access Point

The event Activate is created when the function netWiFi_Activate is executed.

Value in the Event Recorder shows:

if_num: WiFi interface number.
mode: WiFi interface operating mode (Station, AP).

◆ EvrNetWiFi_ActivateInvalidParameter()

__STATIC_INLINE void EvrNetWiFi_ActivateInvalidParameter ( uint8_t if_num )

Event on WiFi activate invalid parameter (Error)

Parameters

if_num interface number

The event ActivateInvalidParameter is created when invalid input parameter is provided for the netWiFi_Activate function.

Value in the Event Recorder shows:

if_num: WiFi interface number.

◆ EvrNetWiFi_Deactivate()

__STATIC_INLINE void EvrNetWiFi_Deactivate	(	uint8_t	if_num,
		uint32_t	mode
	)

Event on WiFi interface deactivate (API)

Parameters

if_num	interface number
mode	WiFi interface mode 0: Station 1: Access Point

The event Deactivate is created when the function netWiFi_Deactivate is executed.

Value in the Event Recorder shows:

if_num: WiFi interface number.
mode: WiFi interface operating mode (Station, AP).

◆ EvrNetWiFi_DeactivateInvalidParam()

__STATIC_INLINE void EvrNetWiFi_DeactivateInvalidParam ( uint8_t if_num )

Event on WiFi deactivate invalid parameter (Error)

Parameters

if_num interface number

The event DeactivateInvalidParam is created when invalid input parameter is provided for the netWiFi_Deactivate function.

Value in the Event Recorder shows:

if_num: WiFi interface number.

◆ EvrNetWiFi_DriverInitFailed()

__STATIC_INLINE void EvrNetWiFi_DriverInitFailed ( uint8_t if_num )

Event on WiFi failed to initialize the driver (Error)

Parameters

if_num interface number

The event DriverInitFailed is created when the WiFi interface fails to initialize and turn on the WiFi driver due to an internal error in the WiFi driver. The event is generated when the function netInitialize is executed and is a critical failure.

Value in the Event Recorder shows:

if_num: WiFi interface number.

◆ EvrNetWiFi_DriverMacAddress()

__STATIC_INLINE void EvrNetWiFi_DriverMacAddress	(	uint8_t	if_num,
		const uint8_t *	mac_addr
	)

Event on WiFi driver provided MAC address (Op)

Parameters

if_num	interface number
mac_addr	pointer to MAC address

The event DriverMacAddress is created when the MAC address for the WiFi interface is available in the driver. The MAC address is read-only and can not be changed from the user application. The event is generated when the function netInitialize is executed.

Value in the Event Recorder shows:

if_num: WiFi interface number.
mac: MAC address retrieved from the driver.

◆ EvrNetWiFi_EnqueueFrame()

__STATIC_INLINE void EvrNetWiFi_EnqueueFrame	(	uint8_t	if_num,
		uint32_t	ca_entry,
		uint32_t	length
	)

Event on enqueued WiFi frame for unresolved MAC address (Op)

Parameters

if_num	interface number
ca_entry	cache entry identifier
length	frame length in bytes

The event EnqueueFrame is created when the internal send_frame function wants to send the frame to the local network, but the destination MAC address is not resolved. The ARP or NDP address resolver starts and enqueues the frame. When the address resolver completes, enqueued frames are sent to resolved destination MAC address.

Value in the Event Recorder shows:

if_num: WiFi interface number.
ca_entry: ARP/NDP cache entry identifier.
len: length of the queued frame in bytes.

◆ EvrNetWiFi_GetMacAddressFailed()

__STATIC_INLINE void EvrNetWiFi_GetMacAddressFailed ( uint8_t if_num )

Event on WiFi driver get MAC address failed (Error)

Parameters

if_num interface number

The event GetMacAddressFailed is created when the the WiFi interface failed to retrieve the MAC address while the WiFi interface is initializing. The MAC address is available in the WiFi module, but can not be retrieved. The event is generated when the function netInitialize is executed and is a critical failure.

Value in the Event Recorder shows:

if_num: WiFi interface number.

◆ EvrNetWiFi_GetNetInfo()

__STATIC_INLINE void EvrNetWiFi_GetNetInfo ( uint8_t if_num )

Event on WiFi get network information (API)

Parameters

if_num interface number

The event GetNetInfo is created when the function netWiFi_GetNetInfo is executed.

Value in the Event Recorder shows:

if_num: WiFi interface number.

◆ EvrNetWiFi_GetNetInfoInvalidParam()

__STATIC_INLINE void EvrNetWiFi_GetNetInfoInvalidParam ( uint8_t if_num )

Event on WiFi get network information invalid parameter (Error)

Parameters

if_num interface number

The event GetNetInfoInvalidParam is created when invalid input parameter is provided for the netWiFi_GetNetInfo function.

Value in the Event Recorder shows:

if_num: WiFi interface number.

◆ EvrNetWiFi_GetNetInfoWrongMode()

__STATIC_INLINE void EvrNetWiFi_GetNetInfoWrongMode	(	uint8_t	if_num,
		uint32_t	mode
	)

Event on WiFi get network information in wrong mode (Error)

Parameters

if_num	interface number
mode	WiFi interface mode 0: Station 1: Access Point

The event GetNetInfoWrongMode is created when the function netWiFi_GetNetInfo is executed in WiFi Access Point mode.

Value in the Event Recorder shows:

if_num: WiFi interface number.
mode: WiFi interface operating mode (Station, AP).

◆ EvrNetWiFi_GetOption()

__STATIC_INLINE void EvrNetWiFi_GetOption	(	uint8_t	if_num,
		uint32_t	opt
	)

Event on WiFi get driver option (API)

Parameters

if_num	interface number
opt	WiFi driver option to get

The event GetOption is created when the function netWiFi_GetOption is executed.

Value in the Event Recorder shows:

if_num: WiFi interface number.
opt: option to retrieve from the WiFi driver.

◆ EvrNetWiFi_GetOptionInvalidParameter()

__STATIC_INLINE void EvrNetWiFi_GetOptionInvalidParameter ( uint8_t if_num )

Event on WiFi get_option invalid parameter (Error)

Parameters

if_num interface number

The event GetOptionInvalidParameter is created, when invalid input parameter is provided for the internal get_option function. This happens when the function netIF_GetOption for the WiFi interface or the control function of the driver netWiFi_GetOption is executed.

Value in the Event Recorder shows:

if_num: WiFi interface number.

◆ EvrNetWiFi_InitInterface()

__STATIC_INLINE void EvrNetWiFi_InitInterface ( uint8_t if_num )

Event on WiFi interface initialize (Op)

Parameters

if_num interface number

The event InitInterface is created when the WiFi interface is initialized, that is, when the function netInitialize is executed.

Value in the Event Recorder shows:

if_num: WiFi interface number.

◆ EvrNetWiFi_InvalidIpVersion()

__STATIC_INLINE void EvrNetWiFi_InvalidIpVersion	(	uint8_t	if_num,
		uint8_t	ip_version
	)

Event on WiFi invalid IP version (Error)

Parameters

if_num	interface number
ip_version	invalid IP protocol version value 0: IPv4 1: IPv6

The event InvalidIpVersion is created when the internal send_frame function wants to send the frame, but the requested Internet Protocol version is not recognized. This might happen when the requested IP protocol version is IPv6, but the Network Component library that is used supports IPv4 only.

Value in the Event Recorder shows:

if_num: WiFi interface number.
ver: requested IP protocol version.

◆ EvrNetWiFi_Ip4ConfigError()

__STATIC_INLINE void EvrNetWiFi_Ip4ConfigError ( uint8_t if_num )

Event on WiFi IPv4 configuration error (Error)

Parameters

if_num interface number

The event Ip4ConfigError is created when an error is found in IPv4 configuration for the WiFi interface.

The error is in one of the following configurations:

IP Address
Subnet mask
Default Gateway
Primary DNS Server
Secondary DNS Server

The event is created when the function netInitialize is executed and is a critical failure.

Value in the Event Recorder shows:

if_num: WiFi interface number.

◆ EvrNetWiFi_Ip4Disabled()

__STATIC_INLINE void EvrNetWiFi_Ip4Disabled ( uint8_t if_num )

Event on WiFi receive IPv4 disabled (Op)

Parameters

if_num interface number

The event Ip4Disabled is created when the network library receives the WiFi frame with protocol type ARP or IPv4, but IPv4 protocol is disabled in the WiFi interface configuration.

Value in the Event Recorder shows:

if_num: WiFi interface number.

◆ EvrNetWiFi_Ip4LocalAddressUndefined()

__STATIC_INLINE void EvrNetWiFi_Ip4LocalAddressUndefined ( uint8_t if_num )

Event on WiFi local IPv4 address undefined (Error)

Parameters

if_num interface number

The event Ip4LocalAddressUndefined is created when the internal send_frame function wants to send the unicast frame, but the local IP address is not valid. This usually happens when the DHCP client does not yet assign the IP address.

Value in the Event Recorder shows:

if_num: WiFi interface number.
addr: 0.0.0.0 (undefined address).

◆ EvrNetWiFi_Ip4MacAddressUnresolved()

__STATIC_INLINE void EvrNetWiFi_Ip4MacAddressUnresolved	(	uint8_t	if_num,
		const uint8_t *	ip4_addr
	)

Event on WiFi MAC address unresolved (Error)

Parameters

if_num	interface number
ip4_addr	pointer to IPv4 destination address

The event Ip4MacAddressUnresolved is created when the internal send_frame function wants to send the frame, but the destination MAC address is not resolved. This usually happens when the destination IP address is external and the gateway is not reachable.

Value in the Event Recorder shows:

if_num: WiFi interface number.
dst_addr: destination IPv4 address to send to.

◆ EvrNetWiFi_Ip6ConfigError()

__STATIC_INLINE void EvrNetWiFi_Ip6ConfigError ( uint8_t if_num )

Event on WiFi IPv6 configuration error (Error)

Parameters

if_num interface number

The event Ip6ConfigError is created when an error is found in IPv6 configuration for the WiFi interface.

The error is in one of the following configurations:

IPv6 Address
Default Gateway
Primary DNS Server
Secondary DNS Server

The event is created when the function netInitialize is executed and is a critical failure.

Value in the Event Recorder shows:

if_num: WiFi interface number.

◆ EvrNetWiFi_Ip6Disabled()

__STATIC_INLINE void EvrNetWiFi_Ip6Disabled ( uint8_t if_num )

Event on WiFi receive IPv6 disabled (Op)

Parameters

if_num interface number

The event Ip6Disabled is created when the network library receives the WiFi frame with protocol type IPv6, but IPv6 protocol is disabled in the WiFi interface configuration.

Value in the Event Recorder shows:

if_num: WiFi interface number.

◆ EvrNetWiFi_Ip6LocalAddressUndefined()

__STATIC_INLINE void EvrNetWiFi_Ip6LocalAddressUndefined ( uint8_t if_num )

Event on WiFi local IPv6 address undefined (Error)

Parameters

if_num interface number

The event Ip6LocalAddressUndefined is created when the internal send_frame function wants to send the unicast frame, but the local IPv6 address is not valid. This usually happens when the DHCPv6 client does not yet assign the IPv6 address.

Value in the Event Recorder shows:

if_num: WiFi interface number.
addr: 0:0:0:0:0:0:0:0 (undefined address).

◆ EvrNetWiFi_Ip6MacAddressUnresolved()

__STATIC_INLINE void EvrNetWiFi_Ip6MacAddressUnresolved	(	uint8_t	if_num,
		const uint8_t *	ip6_addr
	)

Event on WiFi MAC address unresolved (Error)

Parameters

if_num	interface number
ip6_addr	pointer to IPv6 destination address

The event Ip6MacAddressUnresolved is created when the internal send_frame function wants to send the frame, but the destination MAC address is not resolved. This happens when the Neighbor Discovery is in progress for the on-link destination IPv6 address or when the gateway is not reachable for external IPv6 address.

Value in the Event Recorder shows:

if_num: WiFi interface number.
dst_addr: destination IPv6 address to send to.

◆ EvrNetWiFi_LinkStateChange()

__STATIC_INLINE void EvrNetWiFi_LinkStateChange	(	uint8_t	if_num,
		uint32_t	state
	)

Event on WiFi connection state change (Op)

Parameters

if_num	interface number
state	wireless station connection state 0: disconnected 1: connected to Access Point

The event LinkStateChange is created when the network library detects a change in the state of the WiFi connection that is connected or disconnected.

Value in the Event Recorder shows:

if_num: WiFi interface number.
state: connection state (Connected, Disconnected).

◆ EvrNetWiFi_MacAddressConfigError()

__STATIC_INLINE void EvrNetWiFi_MacAddressConfigError ( uint8_t if_num )

Event on WiFi MAC address configuration error (Error)

Parameters

if_num interface number

The event MacAddressConfigError is created when an error is found in the WiFi MAC configuration while the WiFi interface is initializing. The event is generated when the function netInitialize is executed and is a critical failure.

Value in the Event Recorder shows:

if_num: WiFi interface number.

◆ EvrNetWiFi_NotConnected()

__STATIC_INLINE void EvrNetWiFi_NotConnected ( uint8_t if_num )

Event on WiFi station not connected (Error)

Parameters

if_num interface number

The event NotConnected is created when the network library wants to send the frame on the WiFi interface, but the wireless station is not connected.

Value in the Event Recorder shows:

if_num: WiFi interface number.

◆ EvrNetWiFi_OutputLowLevel()

__STATIC_INLINE void EvrNetWiFi_OutputLowLevel	(	uint8_t	if_num,
		uint32_t	length
	)

Event on WiFi output frame (Op)

Parameters

if_num	interface number
length	frame length in bytes

The event OutputLowLevel is created when the WiFi interface wants to pass a frame to the WiFi driver.

Value in the Event Recorder shows:

if_num: WiFi interface number.
len: length of the frame in bytes.

◆ EvrNetWiFi_OutputNoMemory()

__STATIC_INLINE void EvrNetWiFi_OutputNoMemory ( uint8_t if_num )

Event on WIFI output out of memory (Error)

Parameters

if_num interface number

The event OutputNoMemory is created when the network library wants to pass the frame to the WiFi interface, but the available memory is exhausted. Therefore, the frame is not sent.

Value in the Event Recorder shows:

if_num: WiFi interface number.

◆ EvrNetWiFi_ProtocolUnknown()

__STATIC_INLINE void EvrNetWiFi_ProtocolUnknown	(	uint8_t	if_num,
		uint16_t	protocol
	)

Event on WiFi receive protocol unknown (Op)

Parameters

if_num	interface number
protocol	unknown ethernet protocol type

The event ProtocolUnknown is created when the network library receives a WiFi frame, but the received ethernet protocol type is not recognized.

Value in the Event Recorder shows:

if_num: WiFi interface number.
proto: received ethernet protocol type.

◆ EvrNetWiFi_ReceiveFrame()

__STATIC_INLINE void EvrNetWiFi_ReceiveFrame	(	uint8_t	if_num,
		uint32_t	length
	)

Event on WiFi receive frame (Op)

Parameters

if_num	interface number
length	frame length in bytes

The event ReceiveFrame is created when the network library receives the WiFi frame.

Value in the Event Recorder shows:

if_num: WiFi interface number.
len: length of the received WiFi frame in bytes.

◆ EvrNetWiFi_Scan()

__STATIC_INLINE void EvrNetWiFi_Scan	(	uint8_t	if_num,
		uint32_t	max_num
	)

Event on WiFi scan wireless networks (API)

Parameters

if_num	interface number
max_num	maximum number of networks to scan

The event Scan is created when the function netWiFi_Scan is executed.

Value in the Event Recorder shows:

if_num: WiFi interface number.
max: maximum number of wireless networks to scan.

◆ EvrNetWiFi_ScanComplete()

__STATIC_INLINE void EvrNetWiFi_ScanComplete	(	uint8_t	if_num,
		uint32_t	num
	)

Event on WiFi scan wireless networks complete (Op)

Parameters

if_num	interface number
num	number of wireless networks found

The event ScanComplete is created when execution the function netWiFi_Scan is complete.

Value in the Event Recorder shows:

if_num: WiFi interface number.
num: number of available wireless networks found.

◆ EvrNetWiFi_ScanInvalidParameter()

__STATIC_INLINE void EvrNetWiFi_ScanInvalidParameter ( uint8_t if_num )

Event on WiFi scan invalid parameter (Error)

Parameters

if_num interface number

The event ScanInvalidParameter is created when invalid input parameter is provided for the netWiFi_Scan function.

Value in the Event Recorder shows:

if_num: WiFi interface number.

◆ EvrNetWiFi_ScanWrongMode()

__STATIC_INLINE void EvrNetWiFi_ScanWrongMode	(	uint8_t	if_num,
		uint32_t	mode
	)

Event on WiFi scan in wrong mode (Error)

Parameters

if_num	interface number
mode	WiFi interface mode 0: Station 1: Access Point

The event ScanWrongMode is created when the function netWiFi_Scan is executed in WiFi Access Point mode.

Value in the Event Recorder shows:

if_num: WiFi interface number.
mode: WiFi interface operating mode (Station, AP).

◆ EvrNetWiFi_SemaphoreCreateFailed()

__STATIC_INLINE void EvrNetWiFi_SemaphoreCreateFailed ( uint8_t if_num )

Event on WiFi semaphore create failed (Error)

Parameters

if_num interface number

The event SemaphoreCreateFailed is generated, if the function netInitialize could not create the semaphore for the WiFi interface.

Value in the Event Recorder shows:

if_num: WiFi interface number.

◆ EvrNetWiFi_SendDataTooLarge()

__STATIC_INLINE void EvrNetWiFi_SendDataTooLarge	(	uint8_t	if_num,
		uint32_t	length,
		uint32_t	max_length
	)

Event on WiFi send payload too large error (Error)

Parameters

if_num	interface number
length	data length in bytes
max_length	maximum length of data in bytes

The event SendDataTooLarge is created when the length of the data to send is larger than the WiFi MTU (1500 bytes).

Value in the Event Recorder shows:

if_num: WiFi interface number.
len: length of the data to send in bytes.
max: maximum allowed data length in bytes.

◆ EvrNetWiFi_SendFrame()

__STATIC_INLINE void EvrNetWiFi_SendFrame	(	uint8_t	if_num,
		uint32_t	length,
		uint8_t	ip_version
	)

Event on WiFi send frame (Op)

Parameters

if_num	interface number
length	frame length in bytes
ip_version	internet protocol version 0: IPv4 1: IPv6

The event SendFrame is created when the ethernet frame header is constructed for the frame and the data is sent to the WiFi driver.

Value in the Event Recorder shows:

if_num: WiFi interface number.
len: length of the ethernet frame payload.
ver: IP protocol version (IPv4, IPv6).

◆ EvrNetWiFi_SendIp4Disabled()

__STATIC_INLINE void EvrNetWiFi_SendIp4Disabled ( uint8_t if_num )

Event on WiFi send IPv4 disabled error (Error)

Parameters

if_num interface number

The event SendIp4Disabled is created when the internal send_frame function does not send the IPv4 frame, because IPv4 is disabled in the interface configuration.

Value in the Event Recorder shows:

if_num: WiFi interface number.

◆ EvrNetWiFi_SendIp6Disabled()

__STATIC_INLINE void EvrNetWiFi_SendIp6Disabled ( uint8_t if_num )

Event on WiFi send IPv6 disabled error (Error)

Parameters

if_num interface number

The event SendIp6Disabled is created when the internal send_frame function does not send the IPv6 frame, because IPv6 is disabled in the interface configuration.

Value in the Event Recorder shows:

if_num: WiFi interface number.

◆ EvrNetWiFi_SetBypassModeFailed()

__STATIC_INLINE void EvrNetWiFi_SetBypassModeFailed ( uint8_t if_num )

Event on WiFi failed to activate bypass mode (Error)

Parameters

if_num interface number

The event SetBypassModeFailed is created when the WiFi interface failed to initialize the WiFi driver in bypass mode, because the requested features are not supported in the driver. The event is generated when the function netInitialize is executed and is a critical failure.

Value in the Event Recorder shows:

if_num: WiFi interface number.

◆ EvrNetWiFi_SetIp4Address()

__STATIC_INLINE void EvrNetWiFi_SetIp4Address	(	uint8_t	if_num,
		const uint8_t *	ip4_addr
	)

Event on WiFi set interface IPv4 address (Op)

Parameters

if_num	interface number
ip4_addr	pointer to IPv4 address

The event SetIp4Address is created when the static IPv4 address is set for the WiFi interface. This happens when the function netIF_SetOption for the WiFi interface is executed.

Value in the Event Recorder shows:

if_num: WiFi interface number.
ip: static IPv4 address to be set.

◆ EvrNetWiFi_SetIp4DefaultGateway()

__STATIC_INLINE void EvrNetWiFi_SetIp4DefaultGateway	(	uint8_t	if_num,
		const uint8_t *	ip4_addr
	)

Event on WiFi set interface IPv4 default gateway (Op)

Parameters

if_num	interface number
ip4_addr	pointer to IPv4 address of a gateway

The event SetIp4DefaultGateway is created when IPv4 default gateway address is set for the WiFi interface. This happens when the function netIF_SetOption for the WiFi interface is executed.

Value in the Event Recorder shows:

if_num: WiFi interface number.
gw: IPv4 address of default gateway.

◆ EvrNetWiFi_SetIp4Mtu()

__STATIC_INLINE void EvrNetWiFi_SetIp4Mtu	(	uint8_t	if_num,
		uint16_t	mtu
	)

Event on WiFi set interface MTU (Op)

Parameters

if_num	interface number
mtu	maximum transmission unit 0: fragmentation disabled

Remarks: MTU is limited in the range from 576 to 1500 bytes.

The event SetIp4Mtu is created when the Maximum Transmission Unit is set for the WiFi interface. This happens when the function netIF_SetOption for the WiFi interface is executed.

Value in the Event Recorder shows:

if_num: WiFi interface number.
mtu: IPv4 MTU to be set.

◆ EvrNetWiFi_SetIp4PrimaryDNS()

__STATIC_INLINE void EvrNetWiFi_SetIp4PrimaryDNS	(	uint8_t	if_num,
		const uint8_t *	ip4_addr
	)

Event on WiFi set interface primary DNS server (Op)

Parameters

if_num	interface number
ip4_addr	pointer to IPv4 address of a DNS server

The event SetIp4PrimaryDNS is created when IPv4 primary DNS server address is set for the WiFi interface. This happens when the function netIF_SetOption for the WiFi interface is executed.

Value in the Event Recorder shows:

if_num: WiFi interface number.
pri_dns: IPv4 address of the primary DNS server.

◆ EvrNetWiFi_SetIp4SecondaryDNS()

__STATIC_INLINE void EvrNetWiFi_SetIp4SecondaryDNS	(	uint8_t	if_num,
		const uint8_t *	ip4_addr
	)

Event on WiFi set interface secondary DNS server (Op)

Parameters

if_num	interface number
ip4_addr	pointer to IPv4 address of a DNS server

The event SetIp4SecondaryDNS is created when IPv4 secondary DNS server address is set for the WiFi interface. This happens when the function netIF_SetOption for the WiFi interface is executed.

Value in the Event Recorder shows:

if_num: WiFi interface number.
sec_dns: IPv4 address of the secondary DNS server.

◆ EvrNetWiFi_SetIp4SubnetMask()

__STATIC_INLINE void EvrNetWiFi_SetIp4SubnetMask	(	uint8_t	if_num,
		const uint8_t *	net_mask
	)

Event on WiFi set interface IPv4 subnet mask (Op)

Parameters

if_num	interface number
net_mask	pointer to IPv4 subnet mask

The event SetIp4SubnetMask is created when IPv4 subnet mask is set for the WiFi interface. This happens when the function netIF_SetOption for the WiFi interface is executed.

Value in the Event Recorder shows:

if_num: WiFi interface number.
mask: IPv4 subnet mask to be set.

◆ EvrNetWiFi_SetIp6Address()

__STATIC_INLINE void EvrNetWiFi_SetIp6Address	(	uint8_t	if_num,
		const uint8_t *	ip6_addr
	)

Event on WiFi set interface IPv6 static address (Op)

Parameters

if_num	interface number
ip6_addr	pointer to IPv6 address

The event SetIp6Address is created when the static IPv6 address is set for the WiFi interface. This happens when the function netIF_SetOption for the WiFi interface is executed.

Value in the Event Recorder shows:

if_num: WiFi interface number.
ip: static IPv6 address to be set.

◆ EvrNetWiFi_SetIp6DefaultGateway()

__STATIC_INLINE void EvrNetWiFi_SetIp6DefaultGateway	(	uint8_t	if_num,
		const uint8_t *	ip6_addr
	)

Event on WiFi set interface IPv6 default gateway (Op)

Parameters

if_num	interface number
ip6_addr	pointer to IPv6 address of a gateway

The event SetIp6DefaultGateway is created when IPv6 default gateway address is set for the WiFi interface. This happens when the function netIF_SetOption for the WiFi interface is executed.

Value in the Event Recorder shows:

if_num: WiFi interface number.
gw: IPv6 address of default gateway.

◆ EvrNetWiFi_SetIp6Mtu()

__STATIC_INLINE void EvrNetWiFi_SetIp6Mtu	(	uint8_t	if_num,
		uint16_t	mtu
	)

Event on WiFi set interface MTU (Op)

Parameters

if_num	interface number
mtu	maximum transmission unit 0: fragmentation disabled

Remarks: MTU is limited in the range from 1280 to 1500 bytes.

The event SetIp6Mtu is created when the Maximum Transmission Unit is set for the WiFi interface. This happens when the function netIF_SetOption for the WiFi interface is executed.

Value in the Event Recorder shows:

if_num: WiFi interface number.
mtu: IPv6 MTU to be set.

◆ EvrNetWiFi_SetIp6PrefixLength()

__STATIC_INLINE void EvrNetWiFi_SetIp6PrefixLength	(	uint8_t	if_num,
		uint8_t	pref_len
	)

Event on WiFi set interface IPv6 subnet prefix length (Op)

Parameters

if_num	interface number
pref_len	subnet prefix length

The event SetIp6PrefixLength is created when the IPv6 subnet prefix length is set for the WiFi interface. This happens when the function netIF_SetOption for the WiFi interface is executed.

Value in the Event Recorder shows:

if_num: WiFi interface number.
pref_len: IPv6 prefix length to be set.

◆ EvrNetWiFi_SetIp6PrimaryDNS()

__STATIC_INLINE void EvrNetWiFi_SetIp6PrimaryDNS	(	uint8_t	if_num,
		const uint8_t *	ip6_addr
	)

Event on WiFi set interface primary DNS server (Op)

Parameters

if_num	interface number
ip6_addr	pointer to IPv6 address of a DNS server

The event SetIp6PrimaryDNS is created when IPv6 primary DNS server address is set for the WiFi interface. This happens when the function netIF_SetOption for the WiFi interface is executed.

Value in the Event Recorder shows:

if_num: WiFi interface number.
pri_dns: IPv6 address of the primary DNS server.

◆ EvrNetWiFi_SetIp6SecondaryDNS()

__STATIC_INLINE void EvrNetWiFi_SetIp6SecondaryDNS	(	uint8_t	if_num,
		const uint8_t *	ip6_addr
	)

Event on WiFi set interface secondary DNS server (Op)

Parameters

if_num	interface number
ip6_addr	pointer to IPv6 address of a DNS server

The event SetIp6SecondaryDNS is created when IPv6 secondary DNS server address is set for the WiFi interface. This happens when the function netIF_SetOption for the WiFi interface is executed.

Value in the Event Recorder shows:

if_num: WiFi interface number.
sec_dns: IPv6 address of the secondary DNS server.

◆ EvrNetWiFi_SetMacAddress()

__STATIC_INLINE void EvrNetWiFi_SetMacAddress	(	uint8_t	if_num,
		const uint8_t *	mac_addr
	)

Event on WiFi set interface MAC address (Op)

Parameters

if_num	interface number
mac_addr	pointer to MAC address

The event SetMacAddress is created when the MAC address for the WiFi interface is set in the driver. This happens when the WiFi interface is initialized or when the function netIF_SetOption for the WiFi interface is executed.

Value in the Event Recorder shows:

if_num: WiFi interface number.
mac: MAC address to be set.

◆ EvrNetWiFi_SetMacAddressFailed()

__STATIC_INLINE void EvrNetWiFi_SetMacAddressFailed ( uint8_t if_num )

Event on WiFi driver failed to set MAC address (Op)

Parameters

if_num interface number

The event SetMacAddressFailed is created when the WiFi interface failed to set the MAC address while the WiFi interface is initializing. The MAC address that is configured in the WiFi configuration can not be set up in the WiFi module. The event is generated when the function netInitialize is executed and is a critical failure.

Value in the Event Recorder shows:

if_num: WiFi interface number.

◆ EvrNetWiFi_SetOption()

__STATIC_INLINE void EvrNetWiFi_SetOption	(	uint8_t	if_num,
		uint32_t	opt
	)

Event on WiFi set driver option (API)

Parameters

if_num	interface number
opt	WiFi driver option to set

The event SetOption is created when the function netWiFi_SetOption is executed.

Value in the Event Recorder shows:

if_num: WiFi interface number.
opt: option to set in the WiFi driver.

◆ EvrNetWiFi_SetOptionInvalidParameter()

__STATIC_INLINE void EvrNetWiFi_SetOptionInvalidParameter ( uint8_t if_num )

Event on WiFi set_option invalid parameter (Error)

Parameters

if_num interface number

The event SetOptionInvalidParameter is created, when invalid input parameter is provided for the internal set_option function. This happens when the function netIF_SetOption for the WiFi interface or the control function of the driver netWiFi_SetOption is executed.

Value in the Event Recorder shows:

if_num: WiFi interface number.

◆ EvrNetWiFi_ShowFrameHeader()

__STATIC_INLINE void EvrNetWiFi_ShowFrameHeader ( const void * eth_header )

Event on WiFi display send/receive frame header (Detail)

Parameters

eth_header

pointer to ethernet frame header of 14 bytes

DstAddr (6 bytes)
SrcAddr (6 bytes)
Protocol (2 bytes)

The event ShowFrameHeader is created when the network library wants to display detailed information about the ethernet header.

Value in the Event Recorder shows:

dst: destination MAC address.
src: source MAC address.
proto: protocol type (ARP, IPv4, IPv6).

◆ EvrNetWiFi_ThreadCreateFailed()

__STATIC_INLINE void EvrNetWiFi_ThreadCreateFailed ( uint8_t if_num )

Event on WiFi thread create failed (Error)

Parameters

if_num interface number

The event ThreadCreateFailed is generated, if the function netInitialize failed to create the WiFi interface thread.

Value in the Event Recorder shows:

if_num: WiFi interface number.

◆ EvrNetWiFi_TxQueueOverflow()

__STATIC_INLINE void EvrNetWiFi_TxQueueOverflow ( uint8_t if_num )

Event on WiFi output queue overflow (Error)

Parameters

if_num interface number

The event TxQueueOverflow is created when the network library wants to pass the frame to the WiFi interface, but the interface transmit queue is filled. Therefore, the frame is not sent.

Value in the Event Recorder shows:

if_num: WiFi interface number.

◆ EvrNetWiFi_UninitInterface()

__STATIC_INLINE void EvrNetWiFi_UninitInterface ( uint8_t if_num )

Event on WiFi interface de-initialize (Op)

Parameters

if_num interface number

The event UninitInterface is created when the function netUninitialize is executed.

Value in the Event Recorder shows:

wifi: WiFi interface name.

Functions

Description

Function Documentation

◆ EvrNetWiFi_Activate()

◆ EvrNetWiFi_ActivateInvalidParameter()

◆ EvrNetWiFi_Deactivate()

◆ EvrNetWiFi_DeactivateInvalidParam()

◆ EvrNetWiFi_DriverInitFailed()

◆ EvrNetWiFi_DriverMacAddress()

◆ EvrNetWiFi_EnqueueFrame()

◆ EvrNetWiFi_GetMacAddressFailed()

◆ EvrNetWiFi_GetNetInfo()

◆ EvrNetWiFi_GetNetInfoInvalidParam()

◆ EvrNetWiFi_GetNetInfoWrongMode()

◆ EvrNetWiFi_GetOption()

◆ EvrNetWiFi_GetOptionInvalidParameter()

◆ EvrNetWiFi_InitInterface()

◆ EvrNetWiFi_InvalidIpVersion()

◆ EvrNetWiFi_Ip4ConfigError()

◆ EvrNetWiFi_Ip4Disabled()

◆ EvrNetWiFi_Ip4LocalAddressUndefined()

◆ EvrNetWiFi_Ip4MacAddressUnresolved()

◆ EvrNetWiFi_Ip6ConfigError()

◆ EvrNetWiFi_Ip6Disabled()

◆ EvrNetWiFi_Ip6LocalAddressUndefined()

◆ EvrNetWiFi_Ip6MacAddressUnresolved()

◆ EvrNetWiFi_LinkStateChange()

◆ EvrNetWiFi_MacAddressConfigError()

◆ EvrNetWiFi_NotConnected()

◆ EvrNetWiFi_OutputLowLevel()

◆ EvrNetWiFi_OutputNoMemory()

◆ EvrNetWiFi_ProtocolUnknown()

◆ EvrNetWiFi_ReceiveFrame()

◆ EvrNetWiFi_Scan()

◆ EvrNetWiFi_ScanComplete()

◆ EvrNetWiFi_ScanInvalidParameter()

◆ EvrNetWiFi_ScanWrongMode()

◆ EvrNetWiFi_SemaphoreCreateFailed()

◆ EvrNetWiFi_SendDataTooLarge()

◆ EvrNetWiFi_SendFrame()

◆ EvrNetWiFi_SendIp4Disabled()

◆ EvrNetWiFi_SendIp6Disabled()

◆ EvrNetWiFi_SetBypassModeFailed()

◆ EvrNetWiFi_SetIp4Address()

◆ EvrNetWiFi_SetIp4DefaultGateway()

◆ EvrNetWiFi_SetIp4Mtu()

◆ EvrNetWiFi_SetIp4PrimaryDNS()

◆ EvrNetWiFi_SetIp4SecondaryDNS()

◆ EvrNetWiFi_SetIp4SubnetMask()

◆ EvrNetWiFi_SetIp6Address()

◆ EvrNetWiFi_SetIp6DefaultGateway()

◆ EvrNetWiFi_SetIp6Mtu()

◆ EvrNetWiFi_SetIp6PrefixLength()

◆ EvrNetWiFi_SetIp6PrimaryDNS()

◆ EvrNetWiFi_SetIp6SecondaryDNS()

◆ EvrNetWiFi_SetMacAddress()

◆ EvrNetWiFi_SetMacAddressFailed()

◆ EvrNetWiFi_SetOption()

◆ EvrNetWiFi_SetOptionInvalidParameter()

◆ EvrNetWiFi_ShowFrameHeader()

◆ EvrNetWiFi_ThreadCreateFailed()

◆ EvrNetWiFi_TxQueueOverflow()

◆ EvrNetWiFi_UninitInterface()