Data Structures
struct	net
	Defines the system's network interfaces. More...

Macros
#define	NET_DEFAULT {{},{},{},{},{},NET_LINK_DOWN,NET_UNBOUND,NET_MODE_ETHERNET};

#define	ETHERNETIF_LINKTHR_ATTR {.stack_size = 128,.priority = (osPriority_t) osPriorityNormal}

Typedefs
typedef struct net	net_s
	Defines the system's network interfaces. More...

Enumerations
enum	net_bound_state_e { NET_BOUND = 1 , NET_UNBOUND = 0 }
	conveys information regarding the network's DHCP state More...

enum	net_link_state_e { NET_LINK_UP = 1 , NET_LINK_DOWN = 0 }
	conveys information relative the network's link state More...

enum	net_mode_e { NET_MODE_ETHERNET , NET_MODE_WIRELESS }
	used to set net's prefferred/current network interface More...

Functions
void	net_init (net_mode_e mode, void *net_ready_callback)
	Initialises network. More...

ip4_addr_t	net_get_ip_addr (void)
	Returns the active network interface IP address. More...

ip4_addr_t	net_get_gateway (void)
	Returns the active network interface gateway address. More...

void	net_set_mode (net_mode_e mode)
	Sets the network mode to either ethernet or wireless. More...

Detailed Description

High level multi-interfaces network controller

Macro Definition Documentation

◆ ETHERNETIF_LINKTHR_ATTR

#define ETHERNETIF_LINKTHR_ATTR {.stack_size = 128,.priority = (osPriority_t) osPriorityNormal}

Definition at line 21 of file net.h.

◆ NET_DEFAULT

#define NET_DEFAULT {{},{},{},{},{},NET_LINK_DOWN,NET_UNBOUND,NET_MODE_ETHERNET};

Definition at line 20 of file net.h.

Typedef Documentation

◆ net_s

typedef struct net net_s

Defines the system's network interfaces.

The system is able to switch between wirelless and wired ethernet configuration. Network configuration address may be set static or provided through DHCP.

See also: cueosCONFIG.h for further information relative to network configuration

Enumeration Type Documentation

◆ net_bound_state_e

enum net_bound_state_e

conveys information regarding the network's DHCP state

Enumerator
NET_BOUND	DHCP state is bound (IP found)
NET_UNBOUND	DHCP state is bound (No IP found)

Definition at line 27 of file net.h.

◆ net_link_state_e

enum net_link_state_e

conveys information relative the network's link state

Enumerator
NET_LINK_UP	The network is up
NET_LINK_DOWN	The network is down

Definition at line 35 of file net.h.

◆ net_mode_e

enum net_mode_e

used to set net's prefferred/current network interface

Enumerator
NET_MODE_ETHERNET	Use ethernet
NET_MODE_WIRELESS	Use wifi

Definition at line 43 of file net.h.

Function Documentation

◆ net_get_gateway()

ip4_addr_t net_get_gateway ( void )

Returns the active network interface gateway address.

Returns: ip4_addr_t the interface's gateway address

Definition at line 177 of file net.c.

◆ net_get_ip_addr()

ip4_addr_t net_get_ip_addr ( void )

Returns the active network interface IP address.

Returns: ip4_addr_t the interface's IP address

Definition at line 168 of file net.c.

◆ net_init()

void net_init	(	net_mode_e	mode,
		void *	net_ready_callback
	)

Initialises network.

Parameters

mode	the network mode (either ethernet or wireless)
*net_ready_callback	callback function to be called on initialisation success

Definition at line 138 of file net.c.

◆ net_set_mode()

void net_set_mode ( net_mode_e mode )

Sets the network mode to either ethernet or wireless.