TCP/IP stack core. More...

#include "os_port.h"
#include "net_config.h"
#include "core/net_legacy.h"
#include "core/net_mem.h"
#include "core/net_misc.h"
#include "core/nic.h"
#include "core/ethernet.h"
#include "ipv4/ipv4.h"
#include "ipv4/ipv4_frag.h"
#include "ipv4/auto_ip.h"
#include "ipv6/ipv6.h"
#include "ipv4/arp.h"
#include "igmp/igmp_host.h"
#include "igmp/igmp_router.h"
#include "igmp/igmp_snooping.h"
#include "dhcp/dhcp_client.h"
#include "dhcp/dhcp_server.h"
#include "nat/nat.h"
#include "ipv6/ndp.h"
#include "ipv6/ndp_router_adv.h"
#include "ipv6/slaac.h"
#include "mld/mld_node.h"
#include "dhcpv6/dhcpv6_client.h"
#include "dns/dns_client.h"
#include "mdns/mdns_responder.h"
#include "mdns/mdns_common.h"
#include "dns_sd/dns_sd_responder.h"
#include "ppp/ppp.h"
#include "cpu_endian.h"
#include "error.h"

Data Structures
struct	_NetInterface
	Structure describing a network interface. More...

struct	NetSettings
	TCP/IP stack settings. More...

struct	NetContext
	TCP/IP stack context. More...

Macros
#define	NetInterface struct _NetInterface

#define	CYCLONE_TCP_VERSION_STRING "2.5.4"

#define	CYCLONE_TCP_MAJOR_VERSION 2

#define	CYCLONE_TCP_MINOR_VERSION 5

#define	CYCLONE_TCP_REV_NUMBER 4

#define	NET_RTOS_SUPPORT ENABLED

#define	NET_INTERFACE_COUNT 1

#define	NET_LOOPBACK_IF_SUPPORT DISABLED

#define	NET_MAX_LINK_CHANGE_CALLBACKS (6 * NET_INTERFACE_COUNT)

#define	NET_MAX_TIMER_CALLBACKS (6 * NET_INTERFACE_COUNT)

#define	NET_MAX_IF_NAME_LEN 8

#define	NET_MAX_HOSTNAME_LEN 24

#define	NET_RAND_SEED_SIZE 16

#define	NET_TASK_STACK_SIZE 650

#define	NET_TASK_PRIORITY OS_TASK_PRIORITY_HIGH

#define	NET_TICK_INTERVAL 100

#define	netGetSystemTickCount() osGetSystemTime()

Functions
void	netGetDefaultSettings (NetSettings *settings)
	Initialize settings with default values. More...

error_t	netInit (void)
	Initialize TCP/IP stack (deprecated) More...

error_t	netInitEx (NetContext context, const NetSettings settings)
	Initialize TCP/IP stack. More...

error_t	netStart (NetContext *context)
	Start TCP/IP stack. More...

error_t	netSeedRand (const uint8_t *seed, size_t length)
	Seed the pseudo-random number generator. More...

uint32_t	netGetRand (void)
	Generate a random 32-bit value. More...

uint32_t	netGetRandRange (uint32_t min, uint32_t max)
	Generate a random value in the specified range. More...

void	netGetRandData (uint8_t *data, size_t length)
	Get a string of random data. More...

NetInterface *	netGetDefaultInterface (void)
	Get default network interface. More...

error_t	netSetMacAddr (NetInterface interface, const MacAddr macAddr)
	Set MAC address. More...

error_t	netGetMacAddr (NetInterface interface, MacAddr macAddr)
	Retrieve MAC address. More...

error_t	netSetEui64 (NetInterface interface, const Eui64 eui64)
	Set EUI-64 interface identifier. More...

error_t	netGetEui64 (NetInterface interface, Eui64 eui64)
	Retrieve EUI-64 interface identifier. More...

error_t	netSetInterfaceId (NetInterface *interface, uint32_t id)
	Set interface identifier. More...

error_t	netSetInterfaceName (NetInterface interface, const char_t name)
	Set interface name. More...

error_t	netSetHostname (NetInterface interface, const char_t name)
	Set host name. More...

error_t	netSetVlanId (NetInterface *interface, uint16_t vlanId)
	Specify VLAN identifier (802.1Q) More...

error_t	netSetVmanId (NetInterface *interface, uint16_t vmanId)
	Specify VMAN identifier (802.1ad) More...

error_t	netSetParentInterface (NetInterface interface, NetInterface physicalInterface)
	Attach a virtual interface to a given physical interface. More...

error_t	netSetDriver (NetInterface interface, const NicDriver driver)
	Set Ethernet MAC driver. More...

error_t	netSetPhyDriver (NetInterface interface, const PhyDriver driver)
	Set Ethernet PHY driver. More...

error_t	netSetPhyAddr (NetInterface *interface, uint8_t phyAddr)
	Specify Ethernet PHY address. More...

error_t	netSetSwitchDriver (NetInterface interface, const SwitchDriver driver)
	Set Ethernet switch driver. More...

error_t	netSetSwitchPort (NetInterface *interface, uint8_t port)
	Specify switch port. More...

error_t	netSetSmiDriver (NetInterface interface, const SmiDriver driver)
	Set SMI driver. More...

error_t	netSetSpiDriver (NetInterface interface, const SpiDriver driver)
	Set SPI driver. More...

error_t	netSetUartDriver (NetInterface interface, const UartDriver driver)
	Set UART driver. More...

error_t	netSetExtIntDriver (NetInterface interface, const ExtIntDriver driver)
	Set external interrupt line driver. More...

error_t	netSetLinkState (NetInterface *interface, bool_t linkState)
	Set administrative link state. More...

bool_t	netGetLinkState (NetInterface *interface)
	Get link state. More...

uint_t	netGetLinkSpeed (NetInterface *interface)
	Get link speed. More...

NicDuplexMode	netGetDuplexMode (NetInterface *interface)
	Get duplex mode. More...

error_t	netEnablePromiscuousMode (NetInterface *interface, bool_t enable)
	Enable promiscuous mode. More...

error_t	netConfigInterface (NetInterface *interface)
	Configure network interface. More...

error_t	netStartInterface (NetInterface *interface)
	Start network interface. More...

error_t	netStopInterface (NetInterface *interface)
	Stop network interface. More...

void	netTask (void)
	TCP/IP events handling (deprecated) More...

void	netTaskEx (NetContext *context)
	TCP/IP events handling. More...

Variables
NetContext	netContext

Detailed Description

TCP/IP stack core.

License

SPDX-License-Identifier: GPL-2.0-or-later

This file is part of CycloneTCP Open.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Author: Oryx Embedded SARL (www.oryx-embedded.com)

Version: 2.5.4

Definition in file net.h.

Macro Definition Documentation

◆ CYCLONE_TCP_MAJOR_VERSION

#define CYCLONE_TCP_MAJOR_VERSION 2

Definition at line 100 of file net.h.

◆ CYCLONE_TCP_MINOR_VERSION

#define CYCLONE_TCP_MINOR_VERSION 5

Definition at line 102 of file net.h.

◆ CYCLONE_TCP_REV_NUMBER

#define CYCLONE_TCP_REV_NUMBER 4

Definition at line 104 of file net.h.

◆ CYCLONE_TCP_VERSION_STRING

#define CYCLONE_TCP_VERSION_STRING "2.5.4"

Definition at line 98 of file net.h.

◆ NET_INTERFACE_COUNT

#define NET_INTERFACE_COUNT 1

Definition at line 115 of file net.h.

◆ NET_LOOPBACK_IF_SUPPORT

#define NET_LOOPBACK_IF_SUPPORT DISABLED

Definition at line 122 of file net.h.

◆ NET_MAX_HOSTNAME_LEN

#define NET_MAX_HOSTNAME_LEN 24

Definition at line 150 of file net.h.

◆ NET_MAX_IF_NAME_LEN

#define NET_MAX_IF_NAME_LEN 8

Definition at line 143 of file net.h.

◆ NET_MAX_LINK_CHANGE_CALLBACKS

#define NET_MAX_LINK_CHANGE_CALLBACKS (6 * NET_INTERFACE_COUNT)

Definition at line 129 of file net.h.

◆ NET_MAX_TIMER_CALLBACKS

#define NET_MAX_TIMER_CALLBACKS (6 * NET_INTERFACE_COUNT)

Definition at line 136 of file net.h.

◆ NET_RAND_SEED_SIZE

#define NET_RAND_SEED_SIZE 16

Definition at line 157 of file net.h.

◆ NET_RTOS_SUPPORT

#define NET_RTOS_SUPPORT ENABLED

Definition at line 108 of file net.h.

◆ NET_TASK_PRIORITY

#define NET_TASK_PRIORITY OS_TASK_PRIORITY_HIGH

Definition at line 171 of file net.h.

◆ NET_TASK_STACK_SIZE

#define NET_TASK_STACK_SIZE 650

Definition at line 164 of file net.h.

◆ NET_TICK_INTERVAL

#define NET_TICK_INTERVAL 100

Definition at line 176 of file net.h.

◆ netGetSystemTickCount

#define netGetSystemTickCount ( ) osGetSystemTime()

Definition at line 183 of file net.h.

◆ NetInterface

#define NetInterface struct _NetInterface

Definition at line 36 of file net.h.

Function Documentation

◆ netConfigInterface()

error_t netConfigInterface ( NetInterface * interface )

Configure network interface.

Parameters

[in] interface Network interface to configure

Returns: Error code

Definition at line 1204 of file net.c.

◆ netEnablePromiscuousMode()

error_t netEnablePromiscuousMode	(	NetInterface *	interface,
		bool_t	enable
	)

Enable promiscuous mode.

Parameters

[in]	interface	Pointer to the desired network interface
[in]	enable	Enable or disable promiscuous mode

Returns: Error code

Definition at line 1178 of file net.c.

◆ netGetDefaultInterface()

NetInterface* netGetDefaultInterface ( void )

Get default network interface.

Returns: Pointer to the default network interface to be used

Definition at line 471 of file net.c.

◆ netGetDefaultSettings()

void netGetDefaultSettings ( NetSettings * settings )

Initialize settings with default values.

Parameters

[out] settings Structure that contains TCP/IP stack settings

Definition at line 83 of file net.c.

◆ netGetDuplexMode()

NicDuplexMode netGetDuplexMode ( NetInterface * interface )

Get duplex mode.

Parameters

[in] interface Pointer to the desired network interface

Returns: Duplex mode

Definition at line 1146 of file net.c.

◆ netGetEui64()

error_t netGetEui64	(	NetInterface *	interface,
		Eui64 *	eui64
	)

Retrieve EUI-64 interface identifier.

Parameters

[in]	interface	Pointer to the desired network interface
[out]	eui64	Interface identifier

Returns: Error code

Definition at line 582 of file net.c.

◆ netGetLinkSpeed()

uint_t netGetLinkSpeed ( NetInterface * interface )

Get link speed.

Parameters

[in] interface Pointer to the desired network interface

Returns: Link speed

Definition at line 1115 of file net.c.

◆ netGetLinkState()

bool_t netGetLinkState ( NetInterface * interface )

Get link state.

Parameters

[in] interface Pointer to the desired network interface

Returns: Link state

Definition at line 1084 of file net.c.

◆ netGetMacAddr()

error_t netGetMacAddr	(	NetInterface *	interface,
		MacAddr *	macAddr
	)

Retrieve MAC address.

Parameters

[in]	interface	Pointer to the desired network interface
[out]	macAddr	MAC address

Returns: Error code

Definition at line 520 of file net.c.

◆ netGetRand()

uint32_t netGetRand ( void )

Generate a random 32-bit value.

Returns: Random value

Definition at line 386 of file net.c.

◆ netGetRandData()

void netGetRandData	(	uint8_t *	data,
		size_t	length
	)

Get a string of random data.

Parameters

[out]	data	Buffer where to store random data
[in]	length	Number of random bytes to generate

Definition at line 447 of file net.c.

◆ netGetRandRange()

uint32_t netGetRandRange	(	uint32_t	min,
		uint32_t	max
	)

Generate a random value in the specified range.

Parameters

[in]	min	Lower bound
[in]	max	Upper bound

Returns: Random value in the specified range

Definition at line 417 of file net.c.

◆ netInit()

error_t netInit ( void )

Initialize TCP/IP stack (deprecated)

Returns: Error code

Definition at line 97 of file net.c.

◆ netInitEx()

error_t netInitEx	(	NetContext *	context,
		const NetSettings *	settings
	)

Initialize TCP/IP stack.

Parameters

[in]	context	Pointer to the TCP/IP stack context
[in]	settings	TCP/IP stack specific settings

Returns: Error code

Definition at line 127 of file net.c.

◆ netSeedRand()

error_t netSeedRand	(	const uint8_t *	seed,
		size_t	length
	)

Seed the pseudo-random number generator.

Parameters

[in]	seed	Pointer to the random seed
[in]	length	Length of the random seed, in bytes

Returns: Error code

Definition at line 339 of file net.c.

◆ netSetDriver()

error_t netSetDriver	(	NetInterface *	interface,
		const NicDriver *	driver
	)

Set Ethernet MAC driver.

Parameters

[in]	interface	Pointer to the desired network interface
[in]	driver	Ethernet MAC driver

Returns: Error code

Definition at line 798 of file net.c.

◆ netSetEui64()

error_t netSetEui64	(	NetInterface *	interface,
		const Eui64 *	eui64
	)

Set EUI-64 interface identifier.

Parameters

[in]	interface	Pointer to the desired network interface
[in]	eui64	Interface identifier

Returns: Error code

Definition at line 557 of file net.c.

◆ netSetExtIntDriver()

error_t netSetExtIntDriver	(	NetInterface *	interface,
		const ExtIntDriver *	driver
	)

Set external interrupt line driver.

Parameters

[in]	interface	Pointer to the desired network interface
[in]	driver	Underlying SPI driver

Returns: Error code

Definition at line 1027 of file net.c.

◆ netSetHostname()

error_t netSetHostname	(	NetInterface *	interface,
		const char_t *	name
	)

Set host name.

Parameters

[in]	interface	Pointer to the desired network interface
[in]	name	NULL-terminated string that contains the host name

Returns: Error code

Definition at line 668 of file net.c.

◆ netSetInterfaceId()

error_t netSetInterfaceId	(	NetInterface *	interface,
		uint32_t	id
	)

Set interface identifier.

Parameters

[in]	interface	Pointer to the desired network interface
[in]	id	Unique number identifying the interface

Returns: Error code

Definition at line 614 of file net.c.

◆ netSetInterfaceName()

error_t netSetInterfaceName	(	NetInterface *	interface,
		const char_t *	name
	)

Set interface name.

Parameters

[in]	interface	Pointer to the desired network interface
[in]	name	NULL-terminated string that contains the interface name

Returns: Error code

Definition at line 639 of file net.c.

◆ netSetLinkState()

error_t netSetLinkState	(	NetInterface *	interface,
		bool_t	linkState
	)

Set administrative link state.

Parameters

[in]	interface	Pointer to the desired network interface
[in]	linkState	Administrative link state (up or down)

Returns: Error code

Definition at line 1052 of file net.c.

◆ netSetMacAddr()

error_t netSetMacAddr	(	NetInterface *	interface,
		const MacAddr *	macAddr
	)

Set MAC address.

Parameters

[in]	interface	Pointer to the desired network interface
[in]	macAddr	MAC address

Returns: Error code

Definition at line 485 of file net.c.

◆ netSetParentInterface()

error_t netSetParentInterface	(	NetInterface *	interface,
		NetInterface *	physicalInterface
	)

Attach a virtual interface to a given physical interface.

Parameters

[in]	interface	Pointer to the virtual interface
[in]	physicalInterface	physical interface on top of which the virtual interface will run

Returns: Error code

Definition at line 766 of file net.c.

◆ netSetPhyAddr()

error_t netSetPhyAddr	(	NetInterface *	interface,
		uint8_t	phyAddr
	)

Specify Ethernet PHY address.

Parameters

[in]	interface	Pointer to the desired network interface
[in]	phyAddr	PHY address

Returns: Error code

Definition at line 853 of file net.c.

◆ netSetPhyDriver()

error_t netSetPhyDriver	(	NetInterface *	interface,
		const PhyDriver *	driver
	)

Set Ethernet PHY driver.

Parameters

[in]	interface	Pointer to the desired network interface
[in]	driver	Ethernet PHY driver (can be NULL for MAC + PHY controller)

Returns: Error code

Definition at line 823 of file net.c.

◆ netSetSmiDriver()

error_t netSetSmiDriver	(	NetInterface *	interface,
		const SmiDriver *	driver
	)

Set SMI driver.

Parameters

[in]	interface	Pointer to the desired network interface
[in]	driver	Underlying SMI driver

Returns: Error code

Definition at line 947 of file net.c.

◆ netSetSpiDriver()

error_t netSetSpiDriver	(	NetInterface *	interface,
		const SpiDriver *	driver
	)

Set SPI driver.

Parameters

[in]	interface	Pointer to the desired network interface
[in]	driver	Underlying SPI driver

Returns: Error code

Definition at line 977 of file net.c.

◆ netSetSwitchDriver()

error_t netSetSwitchDriver	(	NetInterface *	interface,
		const SwitchDriver *	driver
	)

Set Ethernet switch driver.

Parameters

[in]	interface	Pointer to the desired network interface
[in]	driver	Ethernet switch driver

Returns: Error code

Definition at line 887 of file net.c.

◆ netSetSwitchPort()

error_t netSetSwitchPort	(	NetInterface *	interface,
		uint8_t	port
	)

Specify switch port.

Parameters

[in]	interface	Pointer to the desired network interface
[in]	port	Switch port identifier

Returns: Error code

Definition at line 917 of file net.c.

◆ netSetUartDriver()

error_t netSetUartDriver	(	NetInterface *	interface,
		const UartDriver *	driver
	)

Set UART driver.

Parameters

[in]	interface	Pointer to the desired network interface
[in]	driver	Underlying UART driver

Returns: Error code

Definition at line 1002 of file net.c.

◆ netSetVlanId()

error_t netSetVlanId	(	NetInterface *	interface,
		uint16_t	vlanId
	)

Specify VLAN identifier (802.1Q)

Parameters

[in]	interface	Pointer to the desired network interface
[in]	vlanId	VLAN identifier

Returns: Error code

Definition at line 697 of file net.c.

◆ netSetVmanId()

error_t netSetVmanId	(	NetInterface *	interface,
		uint16_t	vmanId
	)

Specify VMAN identifier (802.1ad)

Parameters

[in]	interface	Pointer to the desired network interface
[in]	vmanId	VMAN identifier

Returns: Error code

Definition at line 731 of file net.c.

◆ netStart()

error_t netStart ( NetContext * context )

Start TCP/IP stack.

Parameters

[in] context Pointer to the TCP/IP stack context

Returns: Error code

Definition at line 312 of file net.c.

◆ netStartInterface()

error_t netStartInterface ( NetInterface * interface )

Start network interface.

Parameters

[in] interface Network interface to start

Returns: Error code

Definition at line 1386 of file net.c.

◆ netStopInterface()

error_t netStopInterface ( NetInterface * interface )

Stop network interface.

Parameters

[in] interface Network interface to stop

Returns: Error code

Definition at line 1466 of file net.c.

◆ netTask()

void netTask ( void )

TCP/IP events handling (deprecated)

Definition at line 1522 of file net.c.

◆ netTaskEx()

void netTaskEx ( NetContext * context )

TCP/IP events handling.

Parameters

[in] context Pointer to the TCP/IP stack context

Definition at line 1533 of file net.c.

Variable Documentation

◆ netContext

NetContext netContext

extern

Definition at line 75 of file net.c.

Data Structures

Macros

Functions

Variables

Detailed Description

License

Macro Definition Documentation

◆ CYCLONE_TCP_MAJOR_VERSION

◆ CYCLONE_TCP_MINOR_VERSION

◆ CYCLONE_TCP_REV_NUMBER

◆ CYCLONE_TCP_VERSION_STRING

◆ NET_INTERFACE_COUNT

◆ NET_LOOPBACK_IF_SUPPORT

◆ NET_MAX_HOSTNAME_LEN

◆ NET_MAX_IF_NAME_LEN

◆ NET_MAX_LINK_CHANGE_CALLBACKS

◆ NET_MAX_TIMER_CALLBACKS

◆ NET_RAND_SEED_SIZE

◆ NET_RTOS_SUPPORT

◆ NET_TASK_PRIORITY

◆ NET_TASK_STACK_SIZE

◆ NET_TICK_INTERVAL

◆ netGetSystemTickCount

◆ NetInterface

Function Documentation

◆ netConfigInterface()

◆ netEnablePromiscuousMode()

◆ netGetDefaultInterface()

◆ netGetDefaultSettings()

◆ netGetDuplexMode()

◆ netGetEui64()

◆ netGetLinkSpeed()

◆ netGetLinkState()

◆ netGetMacAddr()

◆ netGetRand()

◆ netGetRandData()

◆ netGetRandRange()

◆ netInit()

◆ netInitEx()

◆ netSeedRand()

◆ netSetDriver()

◆ netSetEui64()

◆ netSetExtIntDriver()

◆ netSetHostname()

◆ netSetInterfaceId()

◆ netSetInterfaceName()

◆ netSetLinkState()

◆ netSetMacAddr()

◆ netSetParentInterface()

◆ netSetPhyAddr()

◆ netSetPhyDriver()

◆ netSetSmiDriver()

◆ netSetSpiDriver()

◆ netSetSwitchDriver()

◆ netSetSwitchPort()

◆ netSetUartDriver()

◆ netSetVlanId()

◆ netSetVmanId()

◆ netStart()

◆ netStartInterface()

◆ netStopInterface()

◆ netTask()

◆ netTaskEx()

Variable Documentation

◆ netContext