lan9646_driver.c File Reference

LAN9646 6-port Gigabit Ethernet switch driver. More...

#include "core/net.h"
#include "core/ethernet_misc.h"
#include "drivers/switch/lan9646_driver.h"
#include "debug.h"

Go to the source code of this file.

Macros
#define	TRACE_LEVEL   NIC_TRACE_LEVEL

Functions
error_t	lan9646Init (NetInterface *interface)
	LAN9646 Ethernet switch initialization. More...
__weak_func void	lan9646InitHook (NetInterface *interface)
	LAN9646 custom configuration. More...
__weak_func void	lan9646Tick (NetInterface *interface)
	LAN9646 timer handler. More...
void	lan9646EnableIrq (NetInterface *interface)
	Enable interrupts. More...
void	lan9646DisableIrq (NetInterface *interface)
	Disable interrupts. More...
__weak_func void	lan9646EventHandler (NetInterface *interface)
	LAN9646 event handler. More...
error_t	lan9646TagFrame (NetInterface *interface, NetBuffer *buffer, size_t *offset, NetTxAncillary *ancillary)
	Add tail tag to Ethernet frame. More...
error_t	lan9646UntagFrame (NetInterface *interface, uint8_t **frame, size_t *length, NetRxAncillary *ancillary)
	Decode tail tag from incoming Ethernet frame. More...
bool_t	lan9646GetLinkState (NetInterface *interface, uint8_t port)
	Get link state. More...
uint32_t	lan9646GetLinkSpeed (NetInterface *interface, uint8_t port)
	Get link speed. More...
NicDuplexMode	lan9646GetDuplexMode (NetInterface *interface, uint8_t port)
	Get duplex mode. More...
void	lan9646SetPortState (NetInterface *interface, uint8_t port, SwitchPortState state)
	Set port state. More...
SwitchPortState	lan9646GetPortState (NetInterface *interface, uint8_t port)
	Get port state. More...
void	lan9646SetAgingTime (NetInterface *interface, uint32_t agingTime)
	Set aging time for dynamic filtering entries. More...
void	lan9646EnableIgmpSnooping (NetInterface *interface, bool_t enable)
	Enable IGMP snooping. More...
void	lan9646EnableMldSnooping (NetInterface *interface, bool_t enable)
	Enable MLD snooping. More...
void	lan9646EnableRsvdMcastTable (NetInterface *interface, bool_t enable)
	Enable reserved multicast table. More...
error_t	lan9646AddStaticFdbEntry (NetInterface *interface, const SwitchFdbEntry *entry)
	Add a new entry to the static MAC table. More...
error_t	lan9646DeleteStaticFdbEntry (NetInterface *interface, const SwitchFdbEntry *entry)
	Remove an entry from the static MAC table. More...
error_t	lan9646GetStaticFdbEntry (NetInterface *interface, uint_t index, SwitchFdbEntry *entry)
	Read an entry from the static MAC table. More...
void	lan9646FlushStaticFdbTable (NetInterface *interface)
	Flush static MAC table. More...
error_t	lan9646GetDynamicFdbEntry (NetInterface *interface, uint_t index, SwitchFdbEntry *entry)
	Read an entry from the dynamic MAC table. More...
void	lan9646FlushDynamicFdbTable (NetInterface *interface, uint8_t port)
	Flush dynamic MAC table. More...
void	lan9646SetUnknownMcastFwdPorts (NetInterface *interface, bool_t enable, uint32_t forwardPorts)
	Set forward ports for unknown multicast packets. More...
void	lan9646WritePhyReg (NetInterface *interface, uint8_t port, uint8_t address, uint16_t data)
	Write PHY register. More...
uint16_t	lan9646ReadPhyReg (NetInterface *interface, uint8_t port, uint8_t address)
	Read PHY register. More...
void	lan9646DumpPhyReg (NetInterface *interface, uint8_t port)
	Dump PHY registers for debugging purpose. More...
void	lan9646WriteMmdReg (NetInterface *interface, uint8_t port, uint8_t devAddr, uint16_t regAddr, uint16_t data)
	Write MMD register. More...
uint16_t	lan9646ReadMmdReg (NetInterface *interface, uint8_t port, uint8_t devAddr, uint16_t regAddr)
	Read MMD register. More...
void	lan9646WriteSwitchReg8 (NetInterface *interface, uint16_t address, uint8_t data)
	Write switch register (8 bits) More...
uint8_t	lan9646ReadSwitchReg8 (NetInterface *interface, uint16_t address)
	Read switch register (8 bits) More...
void	lan9646WriteSwitchReg16 (NetInterface *interface, uint16_t address, uint16_t data)
	Write switch register (16 bits) More...
uint16_t	lan9646ReadSwitchReg16 (NetInterface *interface, uint16_t address)
	Read switch register (16 bits) More...
void	lan9646WriteSwitchReg32 (NetInterface *interface, uint16_t address, uint32_t data)
	Write switch register (32 bits) More...
uint32_t	lan9646ReadSwitchReg32 (NetInterface *interface, uint16_t address)
	Read switch register (32 bits) More...

Variables
const SwitchDriver	lan9646SwitchDriver
	LAN9646 Ethernet switch driver. More...
const uint16_t	lan9646IngressTailTag [6]
	Tail tag rules (host to LAN9646) More...

Detailed Description

LAN9646 6-port Gigabit Ethernet switch driver.

License

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

Copyright (C) 2010-2025 Oryx Embedded SARL. All rights reserved.

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 lan9646_driver.c.

Macro Definition Documentation

TRACE_LEVEL

#define TRACE_LEVEL   NIC_TRACE_LEVEL

Definition at line 32 of file lan9646_driver.c.

Function Documentation

lan9646AddStaticFdbEntry()

error_t lan9646AddStaticFdbEntry	(	NetInterface *	interface,
		const SwitchFdbEntry *	entry
	)

Add a new entry to the static MAC table.

Parameters

[in]	interface	Underlying network interface
[in]	entry	Pointer to the forwarding database entry

Returns

Error code

Definition at line 1005 of file lan9646_driver.c.

lan9646DeleteStaticFdbEntry()

error_t lan9646DeleteStaticFdbEntry	(	NetInterface *	interface,
		const SwitchFdbEntry *	entry
	)

Remove an entry from the static MAC table.

Parameters

[in]	interface	Underlying network interface
[in]	entry	Forwarding database entry to remove from the table

Returns

Error code

Definition at line 1127 of file lan9646_driver.c.

lan9646DisableIrq()

void lan9646DisableIrq

(

NetInterface *

interface

)

Disable interrupts.

Parameters

[in]

interface

Underlying network interface

Definition at line 337 of file lan9646_driver.c.

lan9646DumpPhyReg()

void lan9646DumpPhyReg	(	NetInterface *	interface,
		uint8_t	port
	)

Dump PHY registers for debugging purpose.

Parameters

[in]	interface	Underlying network interface
[in]	port	Port number

Definition at line 1619 of file lan9646_driver.c.

lan9646EnableIgmpSnooping()

void lan9646EnableIgmpSnooping	(	NetInterface *	interface,
		bool_t	enable
	)

Enable IGMP snooping.

Parameters

[in]	interface	Underlying network interface
[in]	enable	Enable or disable IGMP snooping

Definition at line 916 of file lan9646_driver.c.

lan9646EnableIrq()

void lan9646EnableIrq

(

NetInterface *

interface

)

Enable interrupts.

Parameters

[in]

interface

Underlying network interface

Definition at line 327 of file lan9646_driver.c.

lan9646EnableMldSnooping()

void lan9646EnableMldSnooping	(	NetInterface *	interface,
		bool_t	enable
	)

Enable MLD snooping.

Parameters

[in]	interface	Underlying network interface
[in]	enable	Enable or disable MLD snooping

Definition at line 946 of file lan9646_driver.c.

lan9646EnableRsvdMcastTable()

void lan9646EnableRsvdMcastTable	(	NetInterface *	interface,
		bool_t	enable
	)

Enable reserved multicast table.

Parameters

[in]	interface	Underlying network interface
[in]	enable	Enable or disable reserved group addresses

Definition at line 976 of file lan9646_driver.c.

lan9646EventHandler()

__weak_func void lan9646EventHandler

(

NetInterface *

interface

)

LAN9646 event handler.

Parameters

[in]

interface

Underlying network interface

Definition at line 347 of file lan9646_driver.c.

lan9646FlushDynamicFdbTable()

void lan9646FlushDynamicFdbTable	(	NetInterface *	interface,
		uint8_t	port
	)

Flush dynamic MAC table.

Parameters

[in]	interface	Underlying network interface
[in]	port	Port number

Definition at line 1457 of file lan9646_driver.c.

lan9646FlushStaticFdbTable()

void lan9646FlushStaticFdbTable

(

NetInterface *

interface

)

Flush static MAC table.

Parameters

[in]

interface

Underlying network interface

Definition at line 1304 of file lan9646_driver.c.

lan9646GetDuplexMode()

NicDuplexMode lan9646GetDuplexMode	(	NetInterface *	interface,
		uint8_t	port
	)

Get duplex mode.

Parameters

[in]	interface	Underlying network interface
[in]	port	Port number

Returns

Duplex mode

Definition at line 712 of file lan9646_driver.c.

lan9646GetDynamicFdbEntry()

error_t lan9646GetDynamicFdbEntry	(	NetInterface *	interface,
		uint_t	index,
		SwitchFdbEntry *	entry
	)

Read an entry from the dynamic MAC table.

Parameters

[in]	interface	Underlying network interface
[in]	index	Zero-based index of the entry to read
[out]	entry	Pointer to the forwarding database entry

Returns

Error code

Definition at line 1353 of file lan9646_driver.c.

lan9646GetLinkSpeed()

uint32_t lan9646GetLinkSpeed	(	NetInterface *	interface,
		uint8_t	port
	)

Get link speed.

Parameters

[in]	interface	Underlying network interface
[in]	port	Port number

Returns

Link speed

Definition at line 617 of file lan9646_driver.c.

lan9646GetLinkState()

bool_t lan9646GetLinkState	(	NetInterface *	interface,
		uint8_t	port
	)

Get link state.

Parameters

[in]	interface	Underlying network interface
[in]	port	Port number

Returns

Link state

Definition at line 583 of file lan9646_driver.c.

lan9646GetPortState()

SwitchPortState lan9646GetPortState	(	NetInterface *	interface,
		uint8_t	port
	)

Get port state.

Parameters

[in]	interface	Underlying network interface
[in]	port	Port number

Returns

Port state

Definition at line 832 of file lan9646_driver.c.

lan9646GetStaticFdbEntry()

error_t lan9646GetStaticFdbEntry	(	NetInterface *	interface,
		uint_t	index,
		SwitchFdbEntry *	entry
	)

Read an entry from the static MAC table.

Parameters

[in]	interface	Underlying network interface
[in]	index	Zero-based index of the entry to read
[out]	entry	Pointer to the forwarding database entry

Returns

Error code

Definition at line 1207 of file lan9646_driver.c.

lan9646Init()

error_t lan9646Init

(

NetInterface *

interface

)

LAN9646 Ethernet switch initialization.

Parameters

[in]

interface

Underlying network interface

Returns

Error code

Definition at line 93 of file lan9646_driver.c.

lan9646InitHook()

__weak_func void lan9646InitHook

(

NetInterface *

interface

)

LAN9646 custom configuration.

Parameters

[in]

interface

Underlying network interface

Definition at line 247 of file lan9646_driver.c.

lan9646ReadMmdReg()

uint16_t lan9646ReadMmdReg	(	NetInterface *	interface,
		uint8_t	port,
		uint8_t	devAddr,
		uint16_t	regAddr
	)

Read MMD register.

Parameters

[in]	interface	Underlying network interface
[in]	port	Port number
[in]	devAddr	Device address
[in]	regAddr	Register address

Returns

Register value

Definition at line 1673 of file lan9646_driver.c.

lan9646ReadPhyReg()

uint16_t lan9646ReadPhyReg	(	NetInterface *	interface,
		uint8_t	port,
		uint8_t	address
	)

Read PHY register.

Parameters

[in]	interface	Underlying network interface
[in]	port	Port number
[in]	address	PHY register address

Returns

Register value

Definition at line 1583 of file lan9646_driver.c.

lan9646ReadSwitchReg16()

uint16_t lan9646ReadSwitchReg16	(	NetInterface *	interface,
		uint16_t	address
	)

Read switch register (16 bits)

Parameters

[in]	interface	Underlying network interface
[in]	address	Switch register address

Returns

Register value

Definition at line 1833 of file lan9646_driver.c.

lan9646ReadSwitchReg32()

uint32_t lan9646ReadSwitchReg32	(	NetInterface *	interface,
		uint16_t	address
	)

Read switch register (32 bits)

Parameters

[in]	interface	Underlying network interface
[in]	address	Switch register address

Returns

Register value

Definition at line 1927 of file lan9646_driver.c.

lan9646ReadSwitchReg8()

uint8_t lan9646ReadSwitchReg8	(	NetInterface *	interface,
		uint16_t	address
	)

Read switch register (8 bits)

Parameters

[in]	interface	Underlying network interface
[in]	address	Switch register address

Returns

Register value

Definition at line 1742 of file lan9646_driver.c.

lan9646SetAgingTime()

void lan9646SetAgingTime	(	NetInterface *	interface,
		uint32_t	agingTime
	)

Set aging time for dynamic filtering entries.

Parameters

[in]	interface	Underlying network interface
[in]	agingTime	Aging time, in seconds

Definition at line 895 of file lan9646_driver.c.

lan9646SetPortState()

void lan9646SetPortState	(	NetInterface *	interface,
		uint8_t	port,
		SwitchPortState	state
	)

Set port state.

Parameters

[in]	interface	Underlying network interface
[in]	port	Port number
[in]	state	Port state

Definition at line 776 of file lan9646_driver.c.

lan9646SetUnknownMcastFwdPorts()

void lan9646SetUnknownMcastFwdPorts	(	NetInterface *	interface,
		bool_t	enable,
		uint32_t	forwardPorts
	)

Set forward ports for unknown multicast packets.

Parameters

[in]	interface	Underlying network interface
[in]	enable	Enable or disable forwarding of unknown multicast packets
[in]	forwardPorts	Port map

Definition at line 1504 of file lan9646_driver.c.

lan9646TagFrame()

error_t lan9646TagFrame	(	NetInterface *	interface,
		NetBuffer *	buffer,
		size_t *	offset,
		NetTxAncillary *	ancillary
	)

Add tail tag to Ethernet frame.

Parameters

[in]	interface	Underlying network interface
[in]	buffer	Multi-part buffer containing the payload
[in,out]	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 472 of file lan9646_driver.c.

lan9646Tick()

__weak_func void lan9646Tick

(

NetInterface *

interface

)

LAN9646 timer handler.

Parameters

[in]

interface

Underlying network interface

Definition at line 257 of file lan9646_driver.c.

lan9646UntagFrame()

error_t lan9646UntagFrame	(	NetInterface *	interface,
		uint8_t **	frame,
		size_t *	length,
		NetRxAncillary *	ancillary
	)

Decode tail tag from incoming Ethernet frame.

Parameters

[in]	interface	Underlying network interface
[in,out]	frame	Pointer to the received Ethernet frame
[in,out]	length	Length of the frame, in bytes
[in,out]	ancillary	Additional options passed to the stack along with the packet

Returns

Error code

Definition at line 531 of file lan9646_driver.c.

lan9646WriteMmdReg()

void lan9646WriteMmdReg	(	NetInterface *	interface,
		uint8_t	port,
		uint8_t	devAddr,
		uint16_t	regAddr,
		uint16_t	data
	)

Write MMD register.

Parameters

[in]	interface	Underlying network interface
[in]	port	Port number
[in]	devAddr	Device address
[in]	regAddr	Register address
[in]	data	Register value

Definition at line 1645 of file lan9646_driver.c.

lan9646WritePhyReg()

void lan9646WritePhyReg	(	NetInterface *	interface,
		uint8_t	port,
		uint8_t	address,
		uint16_t	data
	)

Write PHY register.

Parameters

[in]	interface	Underlying network interface
[in]	port	Port number
[in]	address	PHY register address
[in]	data	Register value

Definition at line 1549 of file lan9646_driver.c.

lan9646WriteSwitchReg16()

void lan9646WriteSwitchReg16	(	NetInterface *	interface,
		uint16_t	address,
		uint16_t	data
	)

Write switch register (16 bits)

Parameters

[in]	interface	Underlying network interface
[in]	address	Switch register address
[in]	data	Register value

Definition at line 1789 of file lan9646_driver.c.

lan9646WriteSwitchReg32()

void lan9646WriteSwitchReg32	(	NetInterface *	interface,
		uint16_t	address,
		uint32_t	data
	)

Write switch register (32 bits)

Parameters

[in]	interface	Underlying network interface
[in]	address	Switch register address
[in]	data	Register value

Definition at line 1881 of file lan9646_driver.c.

lan9646WriteSwitchReg8()

void lan9646WriteSwitchReg8	(	NetInterface *	interface,
		uint16_t	address,
		uint8_t	data
	)

Write switch register (8 bits)

Parameters

[in]	interface	Underlying network interface
[in]	address	Switch register address
[in]	data	Register value

Definition at line 1699 of file lan9646_driver.c.

Variable Documentation

lan9646IngressTailTag

const uint16_t lan9646IngressTailTag[6]

Initial value:

=
{
   HTONS(LAN9646_TAIL_TAG_NORMAL_ADDR_LOOKUP),
   HTONS(LAN9646_TAIL_TAG_PORT_BLOCKING_OVERRIDE | LAN9646_TAIL_TAG_DEST_PORT1),
   HTONS(LAN9646_TAIL_TAG_PORT_BLOCKING_OVERRIDE | LAN9646_TAIL_TAG_DEST_PORT2),
   HTONS(LAN9646_TAIL_TAG_PORT_BLOCKING_OVERRIDE | LAN9646_TAIL_TAG_DEST_PORT3),
 
}

Tail tag rules (host to LAN9646)

Definition at line 77 of file lan9646_driver.c.

lan9646SwitchDriver

const SwitchDriver lan9646SwitchDriver

Initial value:

=
{
   lan9646Init,
   lan9646Tick,
   lan9646EnableIrq,
   lan9646DisableIrq,
   lan9646EventHandler,
   lan9646TagFrame,
   lan9646UntagFrame,
   lan9646GetLinkState,
   lan9646GetLinkSpeed,
   lan9646GetDuplexMode,
   lan9646SetPortState,
   lan9646GetPortState,
   lan9646SetAgingTime,
   lan9646EnableIgmpSnooping,
   lan9646EnableMldSnooping,
   lan9646EnableRsvdMcastTable,
   lan9646AddStaticFdbEntry,
   lan9646DeleteStaticFdbEntry,
   lan9646GetStaticFdbEntry,
   lan9646FlushStaticFdbTable,
   lan9646GetDynamicFdbEntry,
   lan9646FlushDynamicFdbTable,
   lan9646SetUnknownMcastFwdPorts
}

LAN9646 Ethernet switch driver.

Definition at line 45 of file lan9646_driver.c.