Generic abstract interface for link-layer connection management. More...

#include "cfn_sal.h"

Data Structures
struct	cfn_sal_nwk_connection_info_t

struct	cfn_sal_nwk_connection_config_t

struct	cfn_sal_nwk_connection_api_s
	Connection Virtual Method Table (VMT). More...

Macros
#define	CFN_SAL_NWK_TYPE_CONNECTION CFN_SAL_TYPE('C', 'O', 'N')

Typedefs
typedef struct cfn_sal_nwk_connection_s	cfn_sal_nwk_connection_t

typedef struct cfn_sal_nwk_connection_api_s	cfn_sal_nwk_connection_api_t

typedef void(*	cfn_sal_nwk_connection_callback_t) (cfn_sal_nwk_connection_t driver, uint32_t event, uint32_t error, void user_arg)

Enumerations
enum	cfn_sal_nwk_connection_event_t { CFN_SAL_NWK_CONNECTION_EVENT_NONE = 0 , CFN_SAL_NWK_CONNECTION_EVENT_CONNECTED = CFN_HAL_BIT(0) , CFN_SAL_NWK_CONNECTION_EVENT_DISCONNECTED = CFN_HAL_BIT(1) , CFN_SAL_NWK_CONNECTION_EVENT_LINK_LOST = CFN_HAL_BIT(2) }

enum	cfn_sal_nwk_connection_status_t { CFN_SAL_NWK_CONNECTION_STATUS_DISCONNECTED = 0 , CFN_SAL_NWK_CONNECTION_STATUS_CONNECTING , CFN_SAL_NWK_CONNECTION_STATUS_CONNECTED , CFN_SAL_NWK_CONNECTION_STATUS_ERROR }

Functions
	CFN_HAL_VMT_CHECK (struct cfn_sal_nwk_connection_api_s)

	CFN_SAL_CREATE_DRIVER_TYPE (sal_nwk_connection, cfn_sal_nwk_connection_config_t, cfn_sal_nwk_connection_api_t, cfn_sal_phy_t, cfn_sal_nwk_connection_callback_t)

CFN_HAL_INLINE void	cfn_sal_nwk_connection_populate (cfn_sal_nwk_connection_t driver, uint32_t peripheral_id, void dependency, const cfn_sal_nwk_connection_api_t api, const cfn_sal_phy_t phy, const cfn_sal_nwk_connection_config_t config, cfn_sal_nwk_connection_callback_t callback, void user_arg)

cfn_hal_error_code_t	cfn_sal_nwk_connection_construct (cfn_sal_nwk_connection_t driver, const cfn_sal_nwk_connection_config_t config, const cfn_sal_phy_t phy, void dependency, cfn_sal_nwk_connection_callback_t callback, void *user_arg)

cfn_hal_error_code_t	cfn_sal_nwk_connection_destruct (cfn_sal_nwk_connection_t *driver)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_nwk_connection_init (cfn_sal_nwk_connection_t *driver)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_nwk_connection_deinit (cfn_sal_nwk_connection_t *driver)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_nwk_connection_config_set (cfn_sal_nwk_connection_t driver, const cfn_sal_nwk_connection_config_t config)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_nwk_connection_config_get (cfn_sal_nwk_connection_t driver, cfn_sal_nwk_connection_config_t config)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_nwk_connection_callback_register (cfn_sal_nwk_connection_t driver, cfn_sal_nwk_connection_callback_t callback, void user_arg)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_nwk_connection_power_state_set (cfn_sal_nwk_connection_t *driver, cfn_hal_power_state_t state)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_nwk_connection_event_enable (cfn_sal_nwk_connection_t *driver, uint32_t event_mask)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_nwk_connection_event_disable (cfn_sal_nwk_connection_t *driver, uint32_t event_mask)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_nwk_connection_event_get (cfn_sal_nwk_connection_t driver, uint32_t event_mask)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_nwk_connection_error_enable (cfn_sal_nwk_connection_t *driver, uint32_t error_mask)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_nwk_connection_error_disable (cfn_sal_nwk_connection_t *driver, uint32_t error_mask)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_nwk_connection_error_get (cfn_sal_nwk_connection_t driver, uint32_t error_mask)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_nwk_connection_connect (cfn_sal_nwk_connection_t *driver)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_nwk_connection_disconnect (cfn_sal_nwk_connection_t *driver)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_nwk_connection_get_status (cfn_sal_nwk_connection_t driver, cfn_sal_nwk_connection_status_t status_out)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_nwk_connection_get_info (cfn_sal_nwk_connection_t driver, cfn_sal_nwk_connection_info_t info_out)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_nwk_connection_scan_networks (cfn_sal_nwk_connection_t driver, void results_array, size_t max_count)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_nwk_connection_get_mac_address (cfn_sal_nwk_connection_t driver, uint8_t mac_buf)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_nwk_connection_get_ip_address (cfn_sal_nwk_connection_t driver, uint8_t ip_buf)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_nwk_connection_get_gateway (cfn_sal_nwk_connection_t driver, uint8_t ip_buf)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_nwk_connection_get_dns (cfn_sal_nwk_connection_t driver, uint8_t ip_buf)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_nwk_connection_set_static_ip (cfn_sal_nwk_connection_t driver, const uint8_t ip, const uint8_t mask, const uint8_t gateway)

Detailed Description

Generic abstract interface for link-layer connection management.

Macro Definition Documentation

◆ CFN_SAL_NWK_TYPE_CONNECTION

#define CFN_SAL_NWK_TYPE_CONNECTION CFN_SAL_TYPE('C', 'O', 'N')

Typedef Documentation

◆ cfn_sal_nwk_connection_api_t

typedef struct cfn_sal_nwk_connection_api_s cfn_sal_nwk_connection_api_t

◆ cfn_sal_nwk_connection_callback_t

typedef void(* cfn_sal_nwk_connection_callback_t) (cfn_sal_nwk_connection_t *driver, uint32_t event, uint32_t error, void *user_arg)

◆ cfn_sal_nwk_connection_t

typedef struct cfn_sal_nwk_connection_s cfn_sal_nwk_connection_t

Enumeration Type Documentation

◆ cfn_sal_nwk_connection_event_t

enum cfn_sal_nwk_connection_event_t

Enumerator
CFN_SAL_NWK_CONNECTION_EVENT_NONE
CFN_SAL_NWK_CONNECTION_EVENT_CONNECTED
CFN_SAL_NWK_CONNECTION_EVENT_DISCONNECTED
CFN_SAL_NWK_CONNECTION_EVENT_LINK_LOST

◆ cfn_sal_nwk_connection_status_t

enum cfn_sal_nwk_connection_status_t

Enumerator
CFN_SAL_NWK_CONNECTION_STATUS_DISCONNECTED
CFN_SAL_NWK_CONNECTION_STATUS_CONNECTING
CFN_SAL_NWK_CONNECTION_STATUS_CONNECTED
CFN_SAL_NWK_CONNECTION_STATUS_ERROR

Function Documentation

◆ CFN_HAL_VMT_CHECK()

CFN_HAL_VMT_CHECK ( struct cfn_sal_nwk_connection_api_s )

◆ CFN_SAL_CREATE_DRIVER_TYPE()

CFN_SAL_CREATE_DRIVER_TYPE	(	sal_nwk_connection	,
		cfn_sal_nwk_connection_config_t	,
		cfn_sal_nwk_connection_api_t	,
		cfn_sal_phy_t	,
		cfn_sal_nwk_connection_callback_t
	)

◆ cfn_sal_nwk_connection_callback_register()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_nwk_connection_callback_register	(	cfn_sal_nwk_connection_t *	driver,
		cfn_sal_nwk_connection_callback_t	callback,
		void *	user_arg
	)

◆ cfn_sal_nwk_connection_config_get()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_nwk_connection_config_get	(	cfn_sal_nwk_connection_t *	driver,
		cfn_sal_nwk_connection_config_t *	config
	)

◆ cfn_sal_nwk_connection_config_set()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_nwk_connection_config_set	(	cfn_sal_nwk_connection_t *	driver,
		const cfn_sal_nwk_connection_config_t *	config
	)

◆ cfn_sal_nwk_connection_connect()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_nwk_connection_connect ( cfn_sal_nwk_connection_t * driver )

◆ cfn_sal_nwk_connection_construct()

cfn_hal_error_code_t cfn_sal_nwk_connection_construct	(	cfn_sal_nwk_connection_t *	driver,
		const cfn_sal_nwk_connection_config_t *	config,
		const cfn_sal_phy_t *	phy,
		void *	dependency,
		cfn_sal_nwk_connection_callback_t	callback,
		void *	user_arg
	)

◆ cfn_sal_nwk_connection_deinit()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_nwk_connection_deinit ( cfn_sal_nwk_connection_t * driver )

◆ cfn_sal_nwk_connection_destruct()

cfn_hal_error_code_t cfn_sal_nwk_connection_destruct ( cfn_sal_nwk_connection_t * driver )

◆ cfn_sal_nwk_connection_disconnect()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_nwk_connection_disconnect ( cfn_sal_nwk_connection_t * driver )

◆ cfn_sal_nwk_connection_error_disable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_nwk_connection_error_disable	(	cfn_sal_nwk_connection_t *	driver,
		uint32_t	error_mask
	)

◆ cfn_sal_nwk_connection_error_enable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_nwk_connection_error_enable	(	cfn_sal_nwk_connection_t *	driver,
		uint32_t	error_mask
	)

◆ cfn_sal_nwk_connection_error_get()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_nwk_connection_error_get	(	cfn_sal_nwk_connection_t *	driver,
		uint32_t *	error_mask
	)

◆ cfn_sal_nwk_connection_event_disable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_nwk_connection_event_disable	(	cfn_sal_nwk_connection_t *	driver,
		uint32_t	event_mask
	)

◆ cfn_sal_nwk_connection_event_enable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_nwk_connection_event_enable	(	cfn_sal_nwk_connection_t *	driver,
		uint32_t	event_mask
	)

◆ cfn_sal_nwk_connection_event_get()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_nwk_connection_event_get	(	cfn_sal_nwk_connection_t *	driver,
		uint32_t *	event_mask
	)

◆ cfn_sal_nwk_connection_get_dns()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_nwk_connection_get_dns	(	cfn_sal_nwk_connection_t *	driver,
		uint8_t *	ip_buf
	)

◆ cfn_sal_nwk_connection_get_gateway()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_nwk_connection_get_gateway	(	cfn_sal_nwk_connection_t *	driver,
		uint8_t *	ip_buf
	)

◆ cfn_sal_nwk_connection_get_info()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_nwk_connection_get_info	(	cfn_sal_nwk_connection_t *	driver,
		cfn_sal_nwk_connection_info_t *	info_out
	)

◆ cfn_sal_nwk_connection_get_ip_address()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_nwk_connection_get_ip_address	(	cfn_sal_nwk_connection_t *	driver,
		uint8_t *	ip_buf
	)

◆ cfn_sal_nwk_connection_get_mac_address()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_nwk_connection_get_mac_address	(	cfn_sal_nwk_connection_t *	driver,
		uint8_t *	mac_buf
	)

◆ cfn_sal_nwk_connection_get_status()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_nwk_connection_get_status	(	cfn_sal_nwk_connection_t *	driver,
		cfn_sal_nwk_connection_status_t *	status_out
	)

◆ cfn_sal_nwk_connection_init()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_nwk_connection_init ( cfn_sal_nwk_connection_t * driver )

◆ cfn_sal_nwk_connection_populate()

CFN_HAL_INLINE void cfn_sal_nwk_connection_populate	(	cfn_sal_nwk_connection_t *	driver,
		uint32_t	peripheral_id,
		void *	dependency,
		const cfn_sal_nwk_connection_api_t *	api,
		const cfn_sal_phy_t *	phy,
		const cfn_sal_nwk_connection_config_t *	config,
		cfn_sal_nwk_connection_callback_t	callback,
		void *	user_arg
	)

◆ cfn_sal_nwk_connection_power_state_set()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_nwk_connection_power_state_set	(	cfn_sal_nwk_connection_t *	driver,
		cfn_hal_power_state_t	state
	)

◆ cfn_sal_nwk_connection_scan_networks()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_nwk_connection_scan_networks	(	cfn_sal_nwk_connection_t *	driver,
		void *	results_array,
		size_t	max_count
	)

◆ cfn_sal_nwk_connection_set_static_ip()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_nwk_connection_set_static_ip	(	cfn_sal_nwk_connection_t *	driver,
		const uint8_t *	ip,
		const uint8_t *	mask,
		const uint8_t *	gateway
	)

Data Structures

Macros

Typedefs

Enumerations

Functions