Ethernet. More...

#include "core/net.h"

Data Structures
struct	MacFilterEntry
	MAC filter table entry. More...

Macros
#define	ETH_SUPPORT ENABLED

#define	ETH_VIRTUAL_IF_SUPPORT DISABLED

#define	ETH_VLAN_SUPPORT DISABLED

#define	ETH_VMAN_SUPPORT DISABLED

#define	ETH_LLC_SUPPORT DISABLED

#define	ETH_PORT_TAGGING_SUPPORT DISABLED

#define	ETH_PORT_TAG_SIZE 4

#define	ETH_TIMESTAMP_SUPPORT DISABLED

#define	MAC_ADDR_FILTER_SIZE 12

#define	ETH_FAST_CRC_SUPPORT DISABLED

#define	ETH_MIN_FRAME_SIZE 64

#define	ETH_MAX_FRAME_SIZE 1518

#define	ETH_HEADER_SIZE 14

#define	ETH_CRC_SIZE 4

#define	ETH_MTU 1500

#define	VLAN_PCP_POS 13

#define	VLAN_DEI_POS 12

#define	VLAN_VID_POS 0

#define	VLAN_PCP_MASK 0xE000

#define	VLAN_DEI_MASK 0x1000

#define	VLAN_VID_MASK 0x0FFF

#define	macCopyAddr(destMacAddr, srcMacAddr) osMemcpy(destMacAddr, srcMacAddr, sizeof(MacAddr))

#define	macCompAddr(macAddr1, macAddr2) (!osMemcmp(macAddr1, macAddr2, sizeof(MacAddr)))

#define	macIsMulticastAddr(macAddr) (((macAddr)->b[0] & 0x01) != 0)

#define	eui64CopyAddr(destEui64Addr, srcEui64Addr) osMemcpy(destEui64Addr, srcEui64Addr, sizeof(Eui64))

#define	eui64CompAddr(eui64Addr1, eui64Addr2) (!osMemcmp(eui64Addr1, eui64Addr2, sizeof(Eui64)))

Typedefs
typedef void(*	LlcRxCallback) (NetInterface interface, EthHeader header, const uint8_t data, size_t length, NetRxAncillary ancillary, void *param)
	LLC frame received callback. More...

Enumerations
enum	MacAddrFlags { MAC_ADDR_FLAG_MULTICAST = 0x01, MAC_ADDR_FLAG_LOCAL = 0x02 }
	MAC address flags. More...

enum	EthType { ETH_TYPE_IPV4 = 0x0800, ETH_TYPE_ARP = 0x0806, ETH_TYPE_RARP = 0x8035, ETH_TYPE_VLAN = 0x8100, ETH_TYPE_IPV6 = 0x86DD, ETH_TYPE_EAPOL = 0x888E, ETH_TYPE_VMAN = 0x88A8, ETH_TYPE_LLDP = 0x88CC, ETH_TYPE_PTP = 0x88F7 }
	Ethernet Type field. More...

Functions
error_t	ethInit (NetInterface *interface)
	Ethernet related initialization. More...

void	ethProcessFrame (NetInterface interface, uint8_t frame, size_t length, NetRxAncillary *ancillary)
	Process an incoming Ethernet frame. More...

error_t	ethSendFrame (NetInterface interface, const MacAddr destAddr, uint16_t type, NetBuffer buffer, size_t offset, NetTxAncillary ancillary)
	Send an Ethernet frame. More...

error_t	ethAcceptMacAddr (NetInterface interface, const MacAddr macAddr)
	Add a unicast/multicast address to the MAC filter table. More...

error_t	ethDropMacAddr (NetInterface interface, const MacAddr macAddr)
	Remove a unicast/multicast address from the MAC filter table. More...

error_t	ethAttachLlcRxCalback (NetInterface interface, LlcRxCallback callback, void param)
	Register LLC frame received callback. More...

error_t	ethDetachLlcRxCalback (NetInterface *interface)
	Unregister LLC frame received callback. More...

NetBuffer *	ethAllocBuffer (size_t length, size_t *offset)
	Allocate a buffer to hold an Ethernet frame. More...

error_t	macStringToAddr (const char_t str, MacAddr macAddr)
	Convert a string representation of a MAC address to a binary MAC address. More...

char_t *	macAddrToString (const MacAddr macAddr, char_t str)
	Convert a MAC address to a dash delimited string. More...

void	macAddrToEui64 (const MacAddr macAddr, Eui64 interfaceId)
	Map a MAC address to the IPv6 modified EUI-64 identifier. More...

void	ethDumpHeader (const EthHeader *ethHeader)
	Dump Ethernet header for debugging purpose. More...

error_t	eui64StringToAddr (const char_t str, Eui64 eui64)
	Convert a string representation of an EUI-64 address to a binary EUI-64 address. More...

char_t *	eui64AddrToString (const Eui64 eui64, char_t str)
	Convert an EUI-64 address to a dash delimited string. More...

Variables
typedef	__packed_struct
	MAC address. More...

	MacAddr

	Eui64

MacAddr	srcAddr

uint16_t	type

uint8_t	data []

	EthHeader

uint8_t	ssap

uint8_t	control

	LlcHeader

	VlanTag

const MacAddr	MAC_UNSPECIFIED_ADDR

const MacAddr	MAC_BROADCAST_ADDR

const Eui64	EUI64_UNSPECIFIED_ADDR

Detailed Description

Ethernet.

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.3.0

Definition in file ethernet.h.

Macro Definition Documentation

◆ ETH_CRC_SIZE

#define ETH_CRC_SIZE 4

Definition at line 114 of file ethernet.h.

◆ ETH_FAST_CRC_SUPPORT

#define ETH_FAST_CRC_SUPPORT DISABLED

Definition at line 102 of file ethernet.h.

◆ ETH_HEADER_SIZE

#define ETH_HEADER_SIZE 14

Definition at line 112 of file ethernet.h.

◆ ETH_LLC_SUPPORT

#define ETH_LLC_SUPPORT DISABLED

Definition at line 67 of file ethernet.h.

◆ ETH_MAX_FRAME_SIZE

#define ETH_MAX_FRAME_SIZE 1518

Definition at line 110 of file ethernet.h.

◆ ETH_MIN_FRAME_SIZE

#define ETH_MIN_FRAME_SIZE 64

Definition at line 108 of file ethernet.h.

◆ ETH_MTU

#define ETH_MTU 1500

Definition at line 116 of file ethernet.h.

◆ ETH_PORT_TAG_SIZE

#define ETH_PORT_TAG_SIZE 4

Definition at line 81 of file ethernet.h.

◆ ETH_PORT_TAGGING_SUPPORT

#define ETH_PORT_TAGGING_SUPPORT DISABLED

Definition at line 74 of file ethernet.h.

◆ ETH_SUPPORT

#define ETH_SUPPORT ENABLED

Definition at line 39 of file ethernet.h.

◆ ETH_TIMESTAMP_SUPPORT

#define ETH_TIMESTAMP_SUPPORT DISABLED

Definition at line 88 of file ethernet.h.

◆ ETH_VIRTUAL_IF_SUPPORT

#define ETH_VIRTUAL_IF_SUPPORT DISABLED

Definition at line 46 of file ethernet.h.

◆ ETH_VLAN_SUPPORT

#define ETH_VLAN_SUPPORT DISABLED

Definition at line 53 of file ethernet.h.

◆ ETH_VMAN_SUPPORT

#define ETH_VMAN_SUPPORT DISABLED

Definition at line 60 of file ethernet.h.

◆ eui64CompAddr

#define eui64CompAddr	(	eui64Addr1,
		eui64Addr2
	)	(!osMemcmp(eui64Addr1, eui64Addr2, sizeof(Eui64)))

Definition at line 139 of file ethernet.h.

◆ eui64CopyAddr

#define eui64CopyAddr	(	destEui64Addr,
		srcEui64Addr
	)	osMemcpy(destEui64Addr, srcEui64Addr, sizeof(Eui64))

Definition at line 136 of file ethernet.h.

◆ MAC_ADDR_FILTER_SIZE

#define MAC_ADDR_FILTER_SIZE 12

Definition at line 95 of file ethernet.h.

◆ macCompAddr

#define macCompAddr	(	macAddr1,
		macAddr2
	)	(!osMemcmp(macAddr1, macAddr2, sizeof(MacAddr)))

Definition at line 130 of file ethernet.h.

◆ macCopyAddr

#define macCopyAddr	(	destMacAddr,
		srcMacAddr
	)	osMemcpy(destMacAddr, srcMacAddr, sizeof(MacAddr))

Definition at line 127 of file ethernet.h.

◆ macIsMulticastAddr

#define macIsMulticastAddr ( macAddr ) (((macAddr)->b[0] & 0x01) != 0)

Definition at line 133 of file ethernet.h.

◆ VLAN_DEI_MASK

#define VLAN_DEI_MASK 0x1000

Definition at line 123 of file ethernet.h.

◆ VLAN_DEI_POS

#define VLAN_DEI_POS 12

Definition at line 120 of file ethernet.h.

◆ VLAN_PCP_MASK

#define VLAN_PCP_MASK 0xE000

Definition at line 122 of file ethernet.h.

◆ VLAN_PCP_POS

#define VLAN_PCP_POS 13

Definition at line 119 of file ethernet.h.

◆ VLAN_VID_MASK

#define VLAN_VID_MASK 0x0FFF

Definition at line 124 of file ethernet.h.

◆ VLAN_VID_POS

#define VLAN_VID_POS 0

Definition at line 121 of file ethernet.h.

Typedef Documentation

◆ LlcRxCallback

typedef void(* LlcRxCallback) (NetInterface *interface, EthHeader *header, const uint8_t *data, size_t length, NetRxAncillary *ancillary, void *param)

LLC frame received callback.

Definition at line 270 of file ethernet.h.

Enumeration Type Documentation

◆ EthType

enum EthType

Ethernet Type field.

Enumerator
ETH_TYPE_IPV4
ETH_TYPE_ARP
ETH_TYPE_RARP
ETH_TYPE_VLAN
ETH_TYPE_IPV6
ETH_TYPE_EAPOL
ETH_TYPE_VMAN
ETH_TYPE_LLDP
ETH_TYPE_PTP

Definition at line 162 of file ethernet.h.

◆ MacAddrFlags

enum MacAddrFlags

MAC address flags.

Enumerator
MAC_ADDR_FLAG_MULTICAST
MAC_ADDR_FLAG_LOCAL

Definition at line 151 of file ethernet.h.

Function Documentation

◆ ethAcceptMacAddr()

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

Add a unicast/multicast address to the MAC filter table.

Parameters

[in]	interface	Underlying network interface
[in]	macAddr	MAC address to accept

Returns: Error code

Definition at line 594 of file ethernet.c.

◆ ethAllocBuffer()

NetBuffer* ethAllocBuffer	(	size_t	length,
		size_t *	offset
	)

Allocate a buffer to hold an Ethernet frame.

Parameters

[in]	length	Desired payload length
[out]	offset	Offset to the first byte of the payload

Returns: The function returns a pointer to the newly allocated buffer. If the system is out of resources, NULL is returned

Definition at line 775 of file ethernet.c.

◆ ethAttachLlcRxCalback()

error_t ethAttachLlcRxCalback	(	NetInterface *	interface,
		LlcRxCallback	callback,
		void *	param
	)

Register LLC frame received callback.

Parameters

[in]	interface	Underlying network interface
[in]	callback	Callback function to be called when a LLC frame is received
[in]	param	Callback function parameter (optional)

Returns: Error code

Definition at line 719 of file ethernet.c.

◆ ethDetachLlcRxCalback()

error_t ethDetachLlcRxCalback ( NetInterface * interface )

Unregister LLC frame received callback.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 747 of file ethernet.c.

◆ ethDropMacAddr()

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

Remove a unicast/multicast address from the MAC filter table.

Parameters

[in]	interface	Underlying network interface
[in]	macAddr	MAC address to drop

Returns: Error code

Definition at line 664 of file ethernet.c.

◆ ethDumpHeader()

void ethDumpHeader ( const EthHeader * ethHeader )

Dump Ethernet header for debugging purpose.

Parameters

[in] ethHeader Pointer to the Ethernet header

Definition at line 971 of file ethernet.c.

◆ ethInit()

error_t ethInit ( NetInterface * interface )

Ethernet related initialization.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 64 of file ethernet.c.

◆ ethProcessFrame()

void ethProcessFrame	(	NetInterface *	interface,
		uint8_t *	frame,
		size_t	length,
		NetRxAncillary *	ancillary
	)

Process an incoming Ethernet frame.

Parameters

[in]	interface	Underlying network interface
[in]	frame	Incoming Ethernet frame to process
[in]	length	Total frame length
[in]	ancillary	Additional options passed to the stack along with the packet

Definition at line 84 of file ethernet.c.

◆ ethSendFrame()

error_t ethSendFrame	(	NetInterface *	interface,
		const MacAddr *	destAddr,
		uint16_t	type,
		NetBuffer *	buffer,
		size_t	offset,
		NetTxAncillary *	ancillary
	)

Send an Ethernet frame.

Parameters

[in]	interface	Underlying network interface
[in]	destAddr	MAC address of the destination host
[in]	type	Ethernet type
[in]	buffer	Multi-part buffer containing the payload
[in]	offset	Offset to the first payload byte
[in]	ancillary	Additional options passed to the stack along with the packet

Returns: Error code

Definition at line 399 of file ethernet.c.

◆ eui64AddrToString()

char_t* eui64AddrToString	(	const Eui64 *	eui64,
		char_t *	str
	)

Convert an EUI-64 address to a dash delimited string.

Parameters

[in]	eui64	Pointer to the EUI-64 address
[out]	str	NULL-terminated string representing the EUI-64 address

Returns: Pointer to the formatted string

Definition at line 1093 of file ethernet.c.

◆ eui64StringToAddr()

error_t eui64StringToAddr	(	const char_t *	str,
		Eui64 *	eui64
	)

Convert a string representation of an EUI-64 address to a binary EUI-64 address.

Parameters

[in]	str	NULL-terminated string representing the EUI-64 address
[out]	eui64	Binary representation of the EUI-64 address

Returns: Error code

Definition at line 993 of file ethernet.c.

◆ macAddrToEui64()

void macAddrToEui64	(	const MacAddr *	macAddr,
		Eui64 *	interfaceId
	)

Map a MAC address to the IPv6 modified EUI-64 identifier.

Parameters

[in]	macAddr	Host MAC address
[out]	interfaceId	IPv6 modified EUI-64 identifier

Definition at line 944 of file ethernet.c.

◆ macAddrToString()

char_t* macAddrToString	(	const MacAddr *	macAddr,
		char_t *	str
	)

Convert a MAC address to a dash delimited string.

Parameters

[in]	macAddr	Pointer to the MAC address
[out]	str	NULL-terminated string representing the MAC address

Returns: Pointer to the formatted string

Definition at line 917 of file ethernet.c.

◆ macStringToAddr()

error_t macStringToAddr	(	const char_t *	str,
		MacAddr *	macAddr
	)

Convert a string representation of a MAC address to a binary MAC address.

Parameters

[in]	str	NULL-terminated string representing the MAC address
[out]	macAddr	Binary representation of the MAC address

Returns: Error code

Definition at line 819 of file ethernet.c.

Variable Documentation

◆ __packed_struct

typedef __packed_struct

Initial value:

{
   __packed_union
   {
      uint8_t b[6];
      uint16_t w[3];
   }

MAC address.

VLAN tag.

LLC header.

Ethernet frame header.

EUI-64 identifier.

Definition at line 186 of file ethernet.h.

◆ control

uint8_t control

Definition at line 232 of file ethernet.h.

◆ data

uint8_t data

Definition at line 220 of file ethernet.h.

◆ EthHeader

EthHeader

Definition at line 221 of file ethernet.h.

◆ Eui64

Eui64

Definition at line 208 of file ethernet.h.

◆ EUI64_UNSPECIFIED_ADDR

const Eui64 EUI64_UNSPECIFIED_ADDR

extern

Definition at line 983 of file ethernet.c.

◆ LlcHeader

LlcHeader

Definition at line 233 of file ethernet.h.

◆ MAC_BROADCAST_ADDR

const MacAddr MAC_BROADCAST_ADDR

extern

Definition at line 55 of file ethernet.c.

◆ MAC_UNSPECIFIED_ADDR

const MacAddr MAC_UNSPECIFIED_ADDR

extern

Definition at line 53 of file ethernet.c.

◆ MacAddr

MacAddr

Definition at line 193 of file ethernet.h.

◆ srcAddr

MacAddr srcAddr

Definition at line 218 of file ethernet.h.

◆ ssap

uint8_t ssap

Definition at line 231 of file ethernet.h.

◆ type

uint16_t type

Definition at line 219 of file ethernet.h.

◆ VlanTag

VlanTag

Definition at line 244 of file ethernet.h.

Data Structures

Macros

Typedefs

Enumerations

Functions

Variables

Detailed Description

License

Macro Definition Documentation

◆ ETH_CRC_SIZE

◆ ETH_FAST_CRC_SUPPORT

◆ ETH_HEADER_SIZE

◆ ETH_LLC_SUPPORT

◆ ETH_MAX_FRAME_SIZE

◆ ETH_MIN_FRAME_SIZE

◆ ETH_MTU

◆ ETH_PORT_TAG_SIZE

◆ ETH_PORT_TAGGING_SUPPORT

◆ ETH_SUPPORT

◆ ETH_TIMESTAMP_SUPPORT

◆ ETH_VIRTUAL_IF_SUPPORT

◆ ETH_VLAN_SUPPORT

◆ ETH_VMAN_SUPPORT

◆ eui64CompAddr

◆ eui64CopyAddr

◆ MAC_ADDR_FILTER_SIZE

◆ macCompAddr

◆ macCopyAddr

◆ macIsMulticastAddr

◆ VLAN_DEI_MASK

◆ VLAN_DEI_POS

◆ VLAN_PCP_MASK

◆ VLAN_PCP_POS

◆ VLAN_VID_MASK

◆ VLAN_VID_POS

Typedef Documentation

◆ LlcRxCallback

Enumeration Type Documentation

◆ EthType

◆ MacAddrFlags

Function Documentation

◆ ethAcceptMacAddr()

◆ ethAllocBuffer()

◆ ethAttachLlcRxCalback()

◆ ethDetachLlcRxCalback()

◆ ethDropMacAddr()

◆ ethDumpHeader()

◆ ethInit()

◆ ethProcessFrame()

◆ ethSendFrame()

◆ eui64AddrToString()

◆ eui64StringToAddr()

◆ macAddrToEui64()

◆ macAddrToString()

◆ macStringToAddr()

Variable Documentation

◆ __packed_struct

◆ control

◆ data

◆ EthHeader

◆ Eui64

◆ EUI64_UNSPECIFIED_ADDR

◆ LlcHeader

◆ MAC_BROADCAST_ADDR

◆ MAC_UNSPECIFIED_ADDR

◆ MacAddr

◆ srcAddr

◆ ssap

◆ type

◆ VlanTag