oc_eth_phy.c

Go to the documentation of this file.

#include <oc_eth.h>
#include <oc_eth_phy.h>
#include <oc_module.h>
#include <oc_ktime.h>

#ifdef oC_ETH_LLD_AVAILABLE

#define _________________________________________LOCAL_PROT_SECTION_________________________________________________________________________

static inline oC_ErrorCode_t WriteRegister ( oC_ETH_PhyAddress_t PhyAddress , oC_ETH_PhyRegister_t Register , uint32_t      Value );
static inline oC_ErrorCode_t ReadRegister  ( oC_ETH_PhyAddress_t PhyAddress , oC_ETH_PhyRegister_t Register , uint32_t * outValue );

#undef  _________________________________________LOCAL_PROT_SECTION_________________________________________________________________________


#define _________________________________________FUNCTIONS_SECTION__________________________________________________________________________

//==========================================================================================================================================
//==========================================================================================================================================
oC_ErrorCode_t oC_ETH_WritePhyRegister( oC_ETH_PhyAddress_t PhyAddress , oC_ETH_PhyRegister_t Register , uint32_t      Value )
{
    oC_ErrorCode_t errorCode = oC_ErrorCode_ImplementError;

    if(oC_Module_TurnOnVerification(&errorCode , oC_Module_ETH))
    {
        errorCode = WriteRegister(PhyAddress,Register,Value);
    }

    return errorCode;
}

//==========================================================================================================================================
//==========================================================================================================================================
oC_ErrorCode_t oC_ETH_ReadPhyRegister( oC_ETH_PhyAddress_t PhyAddress , oC_ETH_PhyRegister_t Register , uint32_t * outValue )
{
    oC_ErrorCode_t errorCode = oC_ErrorCode_ImplementError;

    if(oC_Module_TurnOnVerification(&errorCode , oC_Module_ETH))
    {
        errorCode = ReadRegister(PhyAddress,Register,outValue);
    }

    return errorCode;
}

//==========================================================================================================================================
//==========================================================================================================================================
oC_ErrorCode_t oC_ETH_PhyReset( oC_ETH_PhyAddress_t PhyAddress )
{
    oC_ErrorCode_t errorCode = oC_ErrorCode_ImplementError;

    if(oC_Module_TurnOnVerification(&errorCode , oC_Module_ETH))
    {
        oC_ETH_PhyRegister_BCR_t BCR = { .Value = 0 };

        BCR.SoftReset   = 1;

        if(ErrorCode( WriteRegister( PhyAddress , oC_ETH_PhyRegister_BCR , BCR.Value  ) ))
        {
            /* The reset process takes 0.5 s */
            sleep(ms(500));

            errorCode = oC_ErrorCode_None;
        }
    }

    return errorCode;
}

//==========================================================================================================================================
//==========================================================================================================================================
oC_ErrorCode_t oC_ETH_ReadLinkStatus( oC_ETH_PhyAddress_t PhyAddress , oC_Net_LinkStatus_t * outLinkStatus )
{
    oC_ErrorCode_t errorCode = oC_ErrorCode_ImplementError;

    if(oC_Module_TurnOnVerification(&errorCode , oC_Module_ETH))
    {
        oC_ETH_PhyRegister_BSR_t BSR = { .Value = 0 };

        if(
            ErrorCondition( isram(outLinkStatus) , oC_ErrorCode_OutputAddressNotInRAM            )
         && ErrorCode     ( ReadRegister( PhyAddress , oC_ETH_PhyRegister_BSR , &BSR.Value  )    )
         )
        {
            *outLinkStatus  = BSR.LinkStatus == 1 ? oC_Net_LinkStatus_Up : oC_Net_LinkStatus_Down;
            errorCode       = oC_ErrorCode_None;
        }
    }

    return errorCode;
}

//==========================================================================================================================================
//==========================================================================================================================================
oC_ErrorCode_t oC_ETH_SetAutoNegotiation( oC_ETH_PhyAddress_t PhyAddress , bool Enabled , oC_Time_t Timeout )
{
    oC_ErrorCode_t errorCode = oC_ErrorCode_ImplementError;

    if(oC_Module_TurnOnVerification(&errorCode , oC_Module_ETH))
    {
        oC_Timestamp_t           endTimestamp   = oC_KTime_GetTimestamp() + Timeout;
        oC_ETH_PhyRegister_BCR_t BCR            = { .Value = 0 };
        oC_ETH_PhyRegister_BSR_t BSR            = { .Value = 0 };


        if(
            ErrorCode( ReadRegister ( PhyAddress , oC_ETH_PhyRegister_BCR , &BCR.Value  )    )
           )
        {
            BCR.AutoNegotiation = 1;

            if(
                ErrorCode( WriteRegister( PhyAddress , oC_ETH_PhyRegister_BCR ,  BCR.Value  )    )
                )
            {
                errorCode = oC_ErrorCode_None;

                while(
                        Timeout > 0
                     && ErrorCode       ( ReadRegister(PhyAddress,oC_ETH_PhyRegister_BSR,&BSR.Value         ))
                     && BSR.AutoNegotiateComplete == 0
                     && ErrorCondition  ( oC_KTime_GetTimestamp() < endTimestamp , oC_ErrorCode_Timeout      )
                     );
            }
        }
    }

    return errorCode;
}

//==========================================================================================================================================
//==========================================================================================================================================
oC_ErrorCode_t oC_ETH_SetPhyLoopback( oC_ETH_PhyAddress_t PhyAddress , bool Enabled )
{
    oC_ErrorCode_t errorCode = oC_ErrorCode_ImplementError;

    if(oC_Module_TurnOnVerification(&errorCode , oC_Module_ETH))
    {
        oC_ETH_PhyRegister_BCR_t BCR = { .Value = 0 };

        if( ErrorCode( ReadRegister ( PhyAddress , oC_ETH_PhyRegister_BCR , &BCR.Value  )) )
        {
            if(Enabled)
            {
                BCR.Loopback        = 1;
                BCR.AutoNegotiation = 0;
                BCR.SpeedSelect     = 1;
                BCR.DuplexMode      = 1;
            }
            else
            {
                BCR.Loopback        = 0;
                BCR.AutoNegotiation = 1;
                BCR.SpeedSelect     = 0;
                BCR.DuplexMode      = 0;
            }

            if( ErrorCode( WriteRegister( PhyAddress , oC_ETH_PhyRegister_BCR ,  BCR.Value  )) )
            {
                errorCode = oC_ErrorCode_None;
            }
        }
    }

    return errorCode;
}

#undef  _________________________________________FUNCTIONS_SECTION__________________________________________________________________________

#define _________________________________________LOCAL_FUNCTIONS_SECTION____________________________________________________________________

//==========================================================================================================================================
//==========================================================================================================================================
static inline oC_ErrorCode_t WriteRegister( oC_ETH_PhyAddress_t PhyAddress , oC_ETH_PhyRegister_t Register , uint32_t Value )
{
    return oC_ETH_LLD_WritePhyRegister(PhyAddress,(oC_ETH_LLD_PHY_RegisterAddress_t)Register,Value);
}

//==========================================================================================================================================
//==========================================================================================================================================
static inline oC_ErrorCode_t ReadRegister( oC_ETH_PhyAddress_t PhyAddress , oC_ETH_PhyRegister_t Register , uint32_t * outValue )
{
    return oC_ETH_LLD_ReadPhyRegister(PhyAddress,(oC_ETH_LLD_PHY_RegisterAddress_t)Register,outValue);
}

#undef  _________________________________________LOCAL_FUNCTIONS_SECTION____________________________________________________________________

#endif