1.2.5.2.24 TCPIP_MAC_LinkCheck Function

C

bool TCPIP_MAC_LinkCheck(
    DRV_HANDLE hMac
);

Description

This is a function that returns the current status of the link.

Precondtions

The TCPIP_MAC_Initialize() function should have been called. TCPIP_MAC_Open() should have been called to obtain a valid handle.

Parameters

ParametersDescription
hMacHandle identifying the MAC driver client.

Returns

  • True - If the link is up.

  • False - If the link is down.

Remarks

The stack will call this function periodically. Therefore this function is not required to initiate a new PHY transaction and to wait for the result. It can just initiate a new PHY transaction and return immediately the result of the previous transaction.