Detailed Description

ClearCore Ethernet configuration manager.

This class manages setup and access to the Ethernet PHY chip and Ethernet Media Access Controller (GMAC) peripheral.

For more detailed information on the ClearCore Ethernet system, check out the ClearCore Ethernet informational page.

ClearCore Ethernet configuration manager. More...

#include <EthernetManager.h>

Public Member Functions
volatile const bool &	PhyLinkActive ()
	Check the link status from the PHY.

volatile const bool &	PhyRemoteFault ()
	Check the remote fault status from the PHY.

uint8_t *	MacAddress ()
	Get the MAC address.

IpAddress	LocalIp ()
	Get the local IP address.

void	LocalIp (IpAddress ipaddr)
	Set the local IP address.

IpAddress	NetmaskIp ()
	Get the netmask IP.

void	NetmaskIp (IpAddress address)
	Set the netmask IP.

IpAddress	GatewayIp ()
	Get the gateway IP address.

void	GatewayIp (IpAddress address)
	Set the gateway IP address.

IpAddress	DnsIp ()
	Get the DNS IP address used for address resolution.

void	DnsIp (IpAddress dns)
	Set the DNS IP address used for address resolution.

volatile const uint16_t &	RetransmissionTimeout ()
	Get the retransmission timeout.

void	RetransmissionTimeout (uint8_t timeout)
	Set the retransmission timeout.

volatile const uint8_t &	RetransmissionCount ()
	Get the retransmission count.

void	RetransmissionCount (uint8_t count)
	Set the retransmission count.

bool	DhcpBegin ()
	Set up DHCP connection to retrieve local IP.

void	Setup ()
	Setup LwIP with the local network interface.

void	Refresh ()
	Perform any necessary periodic Ethernet and LwIP updates.

volatile const bool &	EthernetActive ()
	A flag to indicate whether Ethernet setup has been invoked.

Member Function Documentation

◆ DhcpBegin()

bool ClearCore::EthernetManager::DhcpBegin ( )

Set up DHCP connection to retrieve local IP.

Attempts to perform DHCP negotiation to be supplied an IP address.

Returns: Returns true if DHCP supplied an IP address.

Examples: EthernetExamples/EthernetTcpClientHelloWorld/EthernetTcpClientHelloWorld.cpp, EthernetExamples/EthernetTcpServerHelloWorld_automatic/EthernetTcpServerHelloWorld_automatic.cpp, EthernetExamples/EthernetTcpServerHelloWorld_manual/EthernetTcpServerHelloWorld_manual.cpp, EthernetExamples/EthernetUdpHelloWorld/EthernetUdpHelloWorld.cpp, EthernetTcpClientHelloWorld.cpp, EthernetTcpServerHelloWorld_automatic.cpp, EthernetTcpServerHelloWorld_manual.cpp, and EthernetUdpHelloWorld.cpp.

◆ DnsIp() [1/2]

IpAddress ClearCore::EthernetManager::DnsIp ( )

Get the DNS IP address used for address resolution.

Returns: Returns the current default DNS IP address.

◆ DnsIp() [2/2]

void ClearCore::EthernetManager::DnsIp ( IpAddress dns )

Set the DNS IP address used for address resolution.

Parameters

[in] dns The DNS IP address.

Note: Doesn't have any effect when called prior to calling Setup().

◆ EthernetActive()

volatile const bool & ClearCore::EthernetManager::EthernetActive ( )

inline

A flag to indicate whether Ethernet setup has been invoked.

Returns: true if Ethernet has been set up, false otherwise.

◆ GatewayIp() [1/2]

IpAddress ClearCore::EthernetManager::GatewayIp ( )

Get the gateway IP address.

Returns: Returns the gateway IP address.

◆ GatewayIp() [2/2]

void ClearCore::EthernetManager::GatewayIp ( IpAddress address )

Set the gateway IP address.

Note: The gateway IP must be provided when using a static local IP.; Doesn't have any effect when using DHCP.

◆ LocalIp() [1/2]

IpAddress ClearCore::EthernetManager::LocalIp ( )

Get the local IP address.

Returns: Returns the local IP address.

Examples: EthernetExamples/EthernetTcpClientHelloWorld/EthernetTcpClientHelloWorld.cpp, EthernetExamples/EthernetTcpServerHelloWorld_automatic/EthernetTcpServerHelloWorld_automatic.cpp, EthernetExamples/EthernetTcpServerHelloWorld_manual/EthernetTcpServerHelloWorld_manual.cpp, EthernetExamples/EthernetUdpHelloWorld/EthernetUdpHelloWorld.cpp, EthernetTcpClientHelloWorld.cpp, EthernetTcpServerHelloWorld_automatic.cpp, EthernetTcpServerHelloWorld_manual.cpp, and EthernetUdpHelloWorld.cpp.

◆ LocalIp() [2/2]

void ClearCore::EthernetManager::LocalIp ( IpAddress ipaddr )

Set the local IP address.

Note: The local IP must be provided when using a static local IP. In this case, be sure to specify a valid IP address on the same network as your router/switch. This is probably an address of the form "192.168.x.y". For example, if your router's address is 192.168.0.1, you should use an address of the form 192.168.0.y as long as there isn't a device on the network already that was assigned the same IP address.; Doesn't have any effect when using DHCP.

◆ MacAddress()

uint8_t * ClearCore::EthernetManager::MacAddress ( )

Get the MAC address.

Returns: Returns the MAC address as uint8_t pointer type.

◆ NetmaskIp() [1/2]

IpAddress ClearCore::EthernetManager::NetmaskIp ( )

Get the netmask IP.

Returns: Returns the netmask IP as uint32_t type.

◆ NetmaskIp() [2/2]

void ClearCore::EthernetManager::NetmaskIp ( IpAddress address )

Set the netmask IP.

Note: Doesn't have any effect when using DHCP.; The netmask IP must be provided when using a static local IP.

◆ PhyLinkActive()

volatile const bool & ClearCore::EthernetManager::PhyLinkActive ( )

inline

Check the link status from the PHY.

Returns: Returns true if the PHY has indicated link up. Returns false if the PHY has indicated link down.

Note: The PHY link should be confirmed before activating transmit and receive of frames through the GMAC.

Examples: EthernetExamples/EthernetTcpClientHelloWorld/EthernetTcpClientHelloWorld.cpp, EthernetExamples/EthernetTcpServerHelloWorld_automatic/EthernetTcpServerHelloWorld_automatic.cpp, EthernetExamples/EthernetTcpServerHelloWorld_manual/EthernetTcpServerHelloWorld_manual.cpp, EthernetExamples/EthernetUdpHelloWorld/EthernetUdpHelloWorld.cpp, EthernetTcpClientHelloWorld.cpp, EthernetTcpServerHelloWorld_automatic.cpp, EthernetTcpServerHelloWorld_manual.cpp, and EthernetUdpHelloWorld.cpp.

◆ PhyRemoteFault()

volatile const bool & ClearCore::EthernetManager::PhyRemoteFault ( )

inline

Check the remote fault status from the PHY.

Returns: Returns true if the PHY indicates a remote fault.

◆ Refresh()

void ClearCore::EthernetManager::Refresh ( )

Perform any necessary periodic Ethernet and LwIP updates.

Sends all incoming, buffered packets to the LwIP interface. Calls sys_check_timeouts() to perform any necessary LwIP related tasks.

Note: Must be called regularly when actively using Ethernet.; Must NOT be called from an interrupt context.

Examples: EthernetExamples/EthernetTcpClientHelloWorld/EthernetTcpClientHelloWorld.cpp, EthernetExamples/EthernetTcpServerHelloWorld_automatic/EthernetTcpServerHelloWorld_automatic.cpp, EthernetExamples/EthernetTcpServerHelloWorld_manual/EthernetTcpServerHelloWorld_manual.cpp, EthernetTcpClientHelloWorld.cpp, EthernetTcpServerHelloWorld_automatic.cpp, and EthernetTcpServerHelloWorld_manual.cpp.

◆ RetransmissionCount() [1/2]

volatile const uint8_t & ClearCore::EthernetManager::RetransmissionCount ( )

inline

Get the retransmission count.

Returns: The number of times to attempt transmitting before giving up.

◆ RetransmissionCount() [2/2]

void ClearCore::EthernetManager::RetransmissionCount ( uint8_t count )

inline

Set the retransmission count.

Parameters

[in] count The retransmission count to be set.

Note: This is really the total transmission count, so you should never set this to a value less than 1.

◆ RetransmissionTimeout() [1/2]

volatile const uint16_t & ClearCore::EthernetManager::RetransmissionTimeout ( )

inline

Get the retransmission timeout.

Returns: Returns the retransmission timeout in milliseconds.

◆ RetransmissionTimeout() [2/2]

void ClearCore::EthernetManager::RetransmissionTimeout ( uint8_t timeout )

inline

Set the retransmission timeout.

Parameters

[in] timeout The retransmission timeout interval to be set, in milliseconds.

◆ Setup()

void ClearCore::EthernetManager::Setup ( )

Setup LwIP with the local network interface.

Note: Should only be called once.

Examples: EthernetExamples/EthernetTcpClientHelloWorld/EthernetTcpClientHelloWorld.cpp, EthernetExamples/EthernetTcpServerHelloWorld_automatic/EthernetTcpServerHelloWorld_automatic.cpp, EthernetExamples/EthernetTcpServerHelloWorld_manual/EthernetTcpServerHelloWorld_manual.cpp, EthernetExamples/EthernetUdpHelloWorld/EthernetUdpHelloWorld.cpp, EthernetTcpClientHelloWorld.cpp, EthernetTcpServerHelloWorld_automatic.cpp, EthernetTcpServerHelloWorld_manual.cpp, and EthernetUdpHelloWorld.cpp.

The documentation for this class was generated from the following file:

EthernetManager.h

Detailed Description

Public Member Functions

Member Function Documentation

◆ DhcpBegin()

◆ DnsIp() [1/2]

◆ DnsIp() [2/2]

◆ EthernetActive()

◆ GatewayIp() [1/2]

◆ GatewayIp() [2/2]

◆ LocalIp() [1/2]

◆ LocalIp() [2/2]

◆ MacAddress()

◆ NetmaskIp() [1/2]

◆ NetmaskIp() [2/2]

◆ PhyLinkActive()

◆ PhyRemoteFault()

◆ Refresh()

◆ RetransmissionCount() [1/2]

◆ RetransmissionCount() [2/2]

◆ RetransmissionTimeout() [1/2]

◆ RetransmissionTimeout() [2/2]

◆ Setup()