enetphy.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 ENETPHY_H_
#define ENETPHY_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <stdint.h>
#include <stdbool.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                                 Macros                                     */
/* ========================================================================== */
 
#define ENETPHY_IS_ADDR_VALID(addr)           ((addr) <= 31U)
 
#define ENETPHY_BIT(n)                        (1U << (n))
 
#define ENETPHY_IS_BIT_SET(val, n)            (((val) & ENETPHY_BIT(n)) != 0U)
 
#define ENETPHY_ARRAYSIZE(x)                  (sizeof(x) / sizeof(x[0]))
 
/* Ethernet PHY driver error codes are same as CSL's to maintain consistency */
 
#define ENETPHY_SOK                           (CSL_PASS)
 
#define ENETPHY_EFAIL                         (CSL_EFAIL)
 
#define ENETPHY_EBADARGS                      (CSL_EBADARGS)
 
#define ENETPHY_EINVALIDPARAMS                (CSL_EINVALID_PARAMS)
 
#define ENETPHY_ETIMEOUT                      (CSL_ETIMEOUT)
 
#define ENETPHY_EALLOC                        (CSL_EALLOC)
 
#define ENETPHY_EPERM                         (CSL_EALLOC - 4)
 
#define ENETPHY_ENOTSUPPORTED                 (CSL_EALLOC - 5)
 
#define ENETPHY_LINK_CAP_HD10                 ENETPHY_BIT(1)
 
#define ENETPHY_LINK_CAP_FD10                 ENETPHY_BIT(2)
 
#define ENETPHY_LINK_CAP_HD100                ENETPHY_BIT(3)
 
#define ENETPHY_LINK_CAP_FD100                ENETPHY_BIT(4)
 
#define ENETPHY_LINK_CAP_HD1000               ENETPHY_BIT(5)
 
#define ENETPHY_LINK_CAP_FD1000               ENETPHY_BIT(6)
 
#define ENETPHY_LINK_CAP_10                   (ENETPHY_LINK_CAP_HD10 | \
                                               ENETPHY_LINK_CAP_FD10)
 
#define ENETPHY_LINK_CAP_100                  (ENETPHY_LINK_CAP_HD100 | \
                                               ENETPHY_LINK_CAP_FD100)
 
#define ENETPHY_LINK_CAP_1000                 (ENETPHY_LINK_CAP_HD1000 | \
                                               ENETPHY_LINK_CAP_FD1000)
 
#define ENETPHY_LINK_CAP_ALL                  (ENETPHY_LINK_CAP_HD10 |   \
                                               ENETPHY_LINK_CAP_FD10 |   \
                                               ENETPHY_LINK_CAP_HD100 |  \
                                               ENETPHY_LINK_CAP_FD100 |  \
                                               ENETPHY_LINK_CAP_HD1000 | \
                                               ENETPHY_LINK_CAP_FD1000)
 
#define ENETPHY_EXTENDED_CFG_SIZE_MAX         (128U)
 
#define ENETPHY_FSM_TICK_PERIOD_MS            (100U)
 
#define ENETPHY_INVALID_PHYADDR               (~0U)
 
#define ENETPHY_TIMEOUT_WAIT_FOREVER          (0xFFFFFFFFU)
 
#define ENETPHY_TIMEOUT_NO_WAIT               (0U)
 
/* ========================================================================== */
/*                         Structures and Enums                               */
/* ========================================================================== */
 
typedef enum EnetPhy_Magic_e
{
    ENETPHY_MAGIC = 0xCADACADAU,
 
    ENETPHY_NO_MAGIC = 0x0U,
} EnetPhy_Magic;
 
typedef enum EnetPhy_Mii_e
{
    ENETPHY_MAC_MII_MII = 0U,
 
    ENETPHY_MAC_MII_RMII,
 
    ENETPHY_MAC_MII_GMII,
 
    ENETPHY_MAC_MII_RGMII,
 
    ENETPHY_MAC_MII_SGMII,
 
    ENETPHY_MAC_MII_QSGMII,
} EnetPhy_Mii;
 
typedef enum EnetPhy_Speed_e
{
    ENETPHY_SPEED_10MBIT = 0U,
 
    ENETPHY_SPEED_100MBIT,
 
    ENETPHY_SPEED_1GBIT,
 
    ENETPHY_SPEED_AUTO,
} EnetPhy_Speed;
 
typedef enum EnetPhy_Duplexity_e
{
    ENETPHY_DUPLEX_HALF = 0U,
 
    ENETPHY_DUPLEX_FULL,
 
    ENETPHY_DUPLEX_AUTO,
} EnetPhy_Duplexity;
 
typedef struct EnetPhy_Version_s
{
    uint32_t oui;
 
    uint32_t model;
 
    uint32_t revision;
} EnetPhy_Version;
 
typedef enum EnetPhy_LinkStatus_e
{
    ENETPHY_GOT_LINK = 0U,
 
    ENETPHY_LINK_UP,
 
    ENETPHY_LOST_LINK,
 
    ENETPHY_LINK_DOWN,
} EnetPhy_LinkStatus;
 
typedef struct EnetPhy_LinkCfg_s
{
    EnetPhy_Speed speed;
 
    EnetPhy_Duplexity duplexity;
} EnetPhy_LinkCfg;
 
typedef struct EnetPhy_FsmTimeoutCfg_s
{
    uint32_t findingStateTicks;
 
    uint32_t resetWaitStateTicks;
 
    uint32_t resetWaitStateResidenceTicks;
 
    uint32_t nwayStartStateTicks;
 
    uint32_t nwayWaitStateTicks;
 
    uint32_t linkWaitStateTicks;
 
    uint32_t mdixTicks;
} EnetPhy_FsmTimeoutCfg;
 
typedef struct EnetPhy_Cfg_s
{
    uint32_t phyGroup;
 
    uint32_t phyAddr;
 
    uint32_t nwayCaps;
 
    bool mdixEn;
 
    bool isStrapped;
 
    bool isIsolateStateReq;
 
    bool loopbackEn;
 
    bool masterMode;
 
    bool extClkSource;
 
    bool skipExtendedCfg;
 
    EnetPhy_FsmTimeoutCfg timeoutCfg;
 
    uint8_t extendedCfg[ENETPHY_EXTENDED_CFG_SIZE_MAX];
 
    uint32_t extendedCfgSize;
 
} EnetPhy_Cfg;
 
typedef struct EnetPhy_Mdio_s
{
    int32_t (*isAlive)(uint32_t phyAddr,
                       bool *isAlive,
                       void *arg);
 
    int32_t (*isLinked)(uint32_t phyAddr,
                        bool *isLinked,
                        void *arg);
 
    int32_t (*readC22)(uint32_t group,
                       uint32_t phyAddr,
                       uint32_t reg,
                       uint16_t *val,
                       void *arg);
 
    int32_t (*writeC22)(uint32_t group,
                        uint32_t phyAddr,
                        uint32_t reg,
                        uint16_t val,
                        void *arg);
 
    int32_t (*readC45)(uint32_t group,
                       uint32_t phyAddr,
                       uint8_t mmd,
                       uint16_t reg,
                       uint16_t *val,
                       void *arg);
 
    int32_t (*writeC45)(uint32_t group,
                        uint32_t phyAddr,
                        uint8_t mmd,
                        uint16_t reg,
                        uint16_t val,
                        void *arg);
} EnetPhy_Mdio;
 
typedef EnetPhy_Mdio *EnetPhy_MdioHandle;
 
typedef struct EnetPhy_Drv_s *EnetPhyDrv_Handle;
 
typedef enum EnetPhy_FsmState_e
{
    ENETPHY_FSM_STATE_INIT = 0U,
 
    ENETPHY_FSM_STATE_FINDING,
 
    ENETPHY_FSM_STATE_RESET_WAIT,
 
    ENETPHY_FSM_STATE_ENABLE,
 
    ENETPHY_FSM_STATE_FOUND,
 
    ENETPHY_FSM_STATE_NWAY_START,
 
    ENETPHY_FSM_STATE_NWAY_WAIT,
 
    ENETPHY_FSM_STATE_LINK_WAIT,
 
    ENETPHY_FSM_STATE_LINKED,
 
    ENETPHY_FSM_STATE_LOOPBACK,
 
    ENETPHY_FSM_STATE_ISOLATE
} EnetPhy_FsmState;
 
typedef struct EnetPhy_State_s
{
    EnetPhy_FsmState fsmState;
 
    bool fsmStateChanged;
 
    EnetPhy_Speed speed;
 
    EnetPhy_Duplexity duplexity;
 
    uint32_t timeout;
 
    uint32_t residenceTime;
 
    bool isNwayCapable;
 
    bool enableNway;
 
    bool needsManualCfg;
 
    bool needsNwayCfg;
 
    uint32_t linkCaps;
 
    uint32_t phyLinkCaps;
 
    bool loopbackEn;
 
    bool needsMdixSwitch;
 
    bool enableMdix;
} EnetPhy_State;
 
typedef struct EnetPhy_Obj_s
{
    EnetPhy_MdioHandle hMdio;
 
    EnetPhy_Cfg phyCfg;
 
    EnetPhy_Mii mii;
 
    uint32_t macCaps;
 
    EnetPhy_LinkCfg linkCfg;
 
    EnetPhy_FsmTimeoutCfg timeoutCfg;
 
    EnetPhy_State state;
 
    uint32_t group;
 
    uint32_t addr;
 
    uint32_t reqLinkCaps;
 
    EnetPhyDrv_Handle hDrv;
 
    EnetPhy_Magic magic;
 
    void *mdioArgs;
} EnetPhy_Obj;
 
typedef struct EnetPhy_Obj_s *EnetPhy_Handle;
 
/* ========================================================================== */
/*                         Global Variables Declarations                      */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
void EnetPhy_initCfg(EnetPhy_Cfg *phyCfg);
 
void EnetPhy_setExtendedCfg(EnetPhy_Cfg *phyCfg,
                            const void *extendedCfg,
                            uint32_t extendedCfgSize);
 
EnetPhy_Handle EnetPhy_open(const EnetPhy_Cfg *phyCfg,
                            EnetPhy_Mii mii,
                            const EnetPhy_LinkCfg *linkCfg,
                            uint32_t macPortCaps,
                            EnetPhy_MdioHandle hMdio,
                            void *mdioArgs);
 
void EnetPhy_close(EnetPhy_Handle hPhy);
 
EnetPhy_LinkStatus EnetPhy_tick(EnetPhy_Handle hPhy);
 
int32_t EnetPhy_getId(EnetPhy_Handle hPhy,
                      EnetPhy_Version *version);
 
bool EnetPhy_isAlive(EnetPhy_Handle hPhy);
 
bool EnetPhy_isLinked(EnetPhy_Handle hPhy);
 
int32_t EnetPhy_getLinkCfg(EnetPhy_Handle hPhy,
                           EnetPhy_LinkCfg *linkCfg);
 
int32_t EnetPhy_readReg(EnetPhy_Handle hPhy,
                        uint32_t reg,
                        uint16_t *val);
 
int32_t EnetPhy_writeReg(EnetPhy_Handle hPhy,
                         uint32_t reg,
                         uint16_t val);
 
int32_t EnetPhy_rmwReg(EnetPhy_Handle hPhy,
                       uint32_t reg,
                       uint16_t mask,
                       uint16_t val);
 
int32_t EnetPhy_readExtReg(EnetPhy_Handle hPhy,
                           uint32_t reg,
                           uint16_t *val);
 
int32_t EnetPhy_writeExtReg(EnetPhy_Handle hPhy,
                            uint32_t reg,
                            uint16_t val);
 
int32_t EnetPhy_rmwExtReg(EnetPhy_Handle hPhy,
                          uint32_t reg,
                          uint16_t mask,
                          uint16_t val);
 
int32_t EnetPhy_readC45Reg(EnetPhy_Handle hPhy,
                           uint8_t mmd,
                           uint32_t reg,
                           uint16_t *val);
 
int32_t EnetPhy_writeC45Reg(EnetPhy_Handle hPhy,
                            uint8_t mmd,
                            uint32_t reg,
                            uint16_t val);
 
int32_t EnetPhy_rmwC45Reg(EnetPhy_Handle hPhy,
                          uint8_t mmd,
                          uint32_t reg,
                          uint16_t mask,
                          uint16_t val);
 
void EnetPhy_printRegs(EnetPhy_Handle hPhy);
 
/* ========================================================================== */
/*                        Deprecated Function Declarations                    */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                       Static Function Definitions                          */
/* ========================================================================== */
 
/* None */
 
#ifdef __cplusplus
}
#endif
 
#endif /* ENETPHY_H_ */