dp83869.h

Go to the documentation of this file.

/*
 *  Copyright (c) Texas Instruments Incorporated 2021
 *
 *  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 DP83869_H_
#define DP83869_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <stdint.h>
#include <stdbool.h>
 
#include "phy_common.h"
#include "port.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                                 Macros                                     */
/* ========================================================================== */
 
#define DP83869_LED_NUM                       (4U)
 
/* ========================================================================== */
/*                         Structures and Enums                               */
/* ========================================================================== */
 
typedef enum Dp83869_Gpio0Mode_e
{
    DP83869_GPIO0_RXERR     = 0x0U,
 
    DP83869_GPIO0_1588TXSFD = 0x1U,
 
    DP83869_GPIO0_1588RXSFD = 0x2U,
 
    DP83869_GPIO0_WOL       = 0x3U,
 
    DP83869_GPIO0_ENERGYDET = 0x4U,
 
    DP83869_GPIO0_LED3      = 0x6U,
 
    DP83869_GPIO0_PRBSERR   = 0x7U,
 
    DP83869_GPIO0_CONSTANT0 = 0x8U,
 
    DP83869_GPIO0_CONSTANT1 = 0x9U,
} Dp83869_Gpio0Mode;
 
typedef enum Dp83869_Gpio1Mode_e
{
    DP83869_GPIO1_COL       = 0x0U,
 
    DP83869_GPIO1_1588TXSFD = 0x1U,
 
    DP83869_GPIO1_1588RXSFD = 0x2U,
 
    DP83869_GPIO1_WOL       = 0x3U,
 
    DP83869_GPIO1_ENERGYDET = 0x4U,
 
    DP83869_GPIO1_LED3      = 0x6U,
 
    DP83869_GPIO1_PRBSERR   = 0x7U,
 
    DP83869_GPIO1_CONSTANT0 = 0x8U,
 
    DP83869_GPIO1_CONSTANT1 = 0x9U,
} Dp83869_Gpio1Mode;
 
typedef enum Dp83869_LedMode_e
{
    DP83869_LED_LINKED           = 0x0U,
 
    DP83869_LED_RXTXACT          = 0x1U,
 
    DP83869_LED_TXACT            = 0x2U,
 
    DP83869_LED_RXACT            = 0x3U,
 
    DP83869_LED_COLLDET          = 0x4U,
 
    DP83869_LED_LINKED_1000BT    = 0x5U,
 
    DP83869_LED_LINKED_100BTX    = 0x6U,
 
    DP83869_LED_LINKED_10BT      = 0x7U,
 
    DP83869_LED_LINKED_10100BT   = 0x8U,
 
    DP83869_LED_LINKED_1001000BT = 0x9U,
 
    DP83869_LED_FULLDUPLEX       = 0xAU,
 
    DP83869_LED_LINKED_BLINKACT  = 0xBU,
 
    DP83869_LED_RXTXERR          = 0xDU,
 
    DP83869_LED_RXERR            = 0xEU,
} Dp83869_LedMode;
 
typedef struct Dp83869_Cfg_s
{
    bool txClkShiftEn;
 
    bool rxClkShiftEn;
 
    uint32_t txDelayInPs;
 
    uint32_t rxDelayInPs;
 
    uint8_t txFifoDepth;
 
    uint32_t idleCntThresh;
 
    uint32_t impedanceInMilliOhms;
 
    Dp83869_Gpio0Mode gpio0Mode;
 
    Dp83869_Gpio1Mode gpio1Mode;
 
    Dp83869_LedMode ledMode[DP83869_LED_NUM];
} Dp83869_Cfg;
 
/* ========================================================================== */
/*                         Global Variables Declarations                      */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
void Dp83869_initCfg(Dp83869_Cfg *cfg);
 
void Dp83869_bind(EthPhyDrv_Handle* hPhy, 
                    uint8_t phyAddr, 
                    Phy_RegAccessCb_t* pRegAccessCb);
 
bool Dp83869_isPhyDevSupported(EthPhyDrv_Handle hPhy,
                                const void *pVersion);
 
bool Dp83869_isMacModeSupported(EthPhyDrv_Handle hPhy, 
                                Phy_Mii mii);
 
int32_t Dp83869_config(EthPhyDrv_Handle hPhy,
                        const void *pExtCfg,
                        const uint32_t extCfgSize,
                        Phy_Mii mii, 
                        bool loopbackEn);
 
void Dp83869_reset(EthPhyDrv_Handle hPhy);
 
bool Dp83869_isResetComplete(EthPhyDrv_Handle hPhy);
 
void Dp83869_printRegs(EthPhyDrv_Handle hPhy);
 
/* ========================================================================== */
/*                        Deprecated Function Declarations                    */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                       Static Function Definitions                          */
/* ========================================================================== */
 
/* None */
 
#ifdef __cplusplus
}
#endif
 
#endif /* DP83869_H_ */