dp83tc812.h

Go to the documentation of this file.

/*
 *  Copyright (c) Texas Instruments Incorporated 2020
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *
 *    Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 *    Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the
 *    distribution.
 *
 *    Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef DP83TC812_H_
#define DP83TC812_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <stdint.h>
 
#include "phy_common.h"
#include "port.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                                 Macros                                     */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                         Structures and Enums                               */
/* ========================================================================== */
 
typedef enum Dp83tc812_MasterSlaveMode_e
{
    DP83TC812_MASTER_SLAVE_STRAP   = 0x0U,
 
    DP83TC812_MASTER_MODE          = 0x1U,
 
    DP83TC812_SLAVE_MODE           = 0x2U,
} Dp83tc812_MasterSlaveMode;
 
typedef struct Dp83tc812_Cfg_s
{
    bool txClkShiftEn;
 
    bool rxClkShiftEn;
 
    bool interruptEn;
 
    bool sgmiiAutoNegEn;
 
    Dp83tc812_MasterSlaveMode MasterSlaveMode;
} Dp83tc812_Cfg;
 
/* ========================================================================== */
/*                         Global Variables Declarations                      */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
void Dp83tc812_initCfg(Dp83tc812_Cfg *cfg);
 
void Dp83tc812_bind(EthPhyDrv_Handle* hPhy, 
                    uint8_t phyAddr, 
                    Phy_RegAccessCb_t* pRegAccessCb);
 
bool Dp83tc812_isPhyDevSupported(EthPhyDrv_Handle hPhy,
                                const void *pversion);
 
bool Dp83tc812_isMacModeSupported(EthPhyDrv_Handle hPhy, 
                                    Phy_Mii mii);
 
int32_t Dp83tc812_config(EthPhyDrv_Handle hPhy,
                        const void *pExtCfg,
                        const uint32_t extCfgSize,
                        Phy_Mii mii, 
                        bool loopbackEn);
 
void Dp83tc812_reset(EthPhyDrv_Handle hPhy);
 
bool Dp83tc812_isResetComplete(EthPhyDrv_Handle hPhy);
 
void Dp83tc812_printRegs(EthPhyDrv_Handle hPhy);
/* ========================================================================== */
/*                        Deprecated Function Declarations                    */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                       Static Function Definitions                          */
/* ========================================================================== */
 
/* None */
 
#ifdef __cplusplus
}
#endif
 
#endif /* DP83TC812_H_ */