dp83826.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 dp83826_H_
#define dp83826_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 Dp83826_LedMode_e
{
    DP83826_LED_LINK_OK          = 0x0U,
 
    DP83826_LED_RXTXACT          = 0x1U,
 
    DP83826_LED_TXACT            = 0x2U,
 
    DP83826_LED_RXACT            = 0x3U,
 
    DP83826_LED_COLLISION        = 0x4U,
 
    DP83826_LED_SPEED_100BTX     = 0x5U,
 
    DP83826_LED_SPEED_10BTX      = 0x6U,
 
    DP83826_LED_FULL_DUPLEX      = 0x7U,
 
    DP83826_LED_BLINK_ACT        = 0x8U,
 
    DP83826_LED_STRETCH_ACT      = 0x9U,
 
    DP83826_LED_100BTFD           = 0xAU,
 
    DP83826_LED_LPI_MODE         = 0xBU,
 
    DP83826_LED_RXTXERR          = 0xCU,
 
    DP83826_LED_LINK_LOSS        = 0xDU,
 
    DP83826_LED_PRBS_ERROR       = 0xEU,
} Dp83826_LedMode;
 
typedef struct Dp83826_Cfg_s
{
    /* No extended config parameters at the moment */
} Dp83826_Cfg;
 
/* ========================================================================== */
/*                         Global Variables Declarations                      */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
void Dp83826_initCfg(Dp83826_Cfg *cfg);
 
void Dp83826_bind(EthPhyDrv_Handle* hPhy,
                    uint8_t phyAddr,
                    Phy_RegAccessCb_t* pRegAccessCb);
 
bool Dp83826_isPhyDevSupported(EthPhyDrv_Handle hPhy,
                                const void *pVersion);
 
bool Dp83826_isMacModeSupported(EthPhyDrv_Handle hPhy,
                                Phy_Mii mii);
 
int32_t Dp83826_config(EthPhyDrv_Handle hPhy,
                        const void *pExtCfg,
                        const uint32_t extCfgSize,
                        Phy_Mii mii,
                        bool loopbackEn);
 
void Dp83826_printRegs(EthPhyDrv_Handle hPhy);
 
/* ========================================================================== */
/*                        Deprecated Function Declarations                    */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                       Static Function Definitions                          */
/* ========================================================================== */
 
/* None */
 
#ifdef __cplusplus
}
#endif
 
#endif /* dp83826_H_ */