cpsw_phy.h

Go to the documentation of this file.

/*
 *  Copyright (c) Texas Instruments Incorporated 2018
 *
 *  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 CPSW_PHY_H_
#define CPSW_PHY_H_

/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */

#include <ti/csl/csl_types.h>

#include "cpsw_mdio.h"
#include "cpsw_types.h"
#include "cpsw_macport.h"

#ifdef __cplusplus
extern "C" {
#endif

/* ========================================================================== */
/*                                 Macros                                     */
/* ========================================================================== */

#define CPSW_PHY_EXTENDED_CFG_SIZE_MAX        (128U)

#define CPSW_PHY_FSM_TICK_PERIOD_MS           (100U)

#define CPSW_PHY_INVALID_PHYADDR              (~0U)

/* TODO: Currently, always assume auto-detect */
#define CPSW_PHY_DEVID_AUTODETECT             (~0U)

#define CPSW_PHY_USE_DEFAULT                  (~0U)

#define CPSW_PHY_NWAY_AUTOMDIX_ENABLE         (1U << 15)

#define CPSW_PHY_MIIMDIO_MDIXFLIP             (1U << 28)

/* These events are returned as result param by CpswPhy_tick() to allow the upper
 * layer to track PHY status */

#define CPSW_PHY_EVENT_NOCHANGE               (0U)

#define CPSW_PHY_EVENT_LINKDOWN               (1U)

#define CPSW_PHY_EVENT_LINKUP                 (2U)

#define CPSW_PHY_EVENT_PHYERROR               (3U)

#define CPSW_PHY_EVENT_LPBK                   (4U)

#define CPSW_PHY_IS_ADDR_VALID(addr)          ((addr) <= 31U)

#define CPSW_PHY_PUBLIC_IOCTL(x)              (CPSW_IOCTL_PHY_BASE | CPSW_IOCTL_MIN(x))

/* ========================================================================== */
/*                         Structures and Enums                               */
/* ========================================================================== */

enum CpswPhy_Ioctl_e
{
    CPSW_PHY_IOCTL_PHY_TICK                = CPSW_PHY_PUBLIC_IOCTL(0U),

    CPSW_PHY_IOCTL_PHY_GET_ID              = CPSW_PHY_PUBLIC_IOCTL(1U),

    CPSW_PHY_IOCTL_PHY_GET_SUPPORTED_MODES = CPSW_PHY_PUBLIC_IOCTL(2U),

    CPSW_PHY_IOCTL_PHY_GET_LOOPBACK_STATE  = CPSW_PHY_PUBLIC_IOCTL(3U),

    CPSW_PHY_IOCTL_PHY_GET_LINK_STATE      = CPSW_PHY_PUBLIC_IOCTL(4U),

    CPSW_PHY_IOCTL_PHY_GET_LINK_MODE       = CPSW_PHY_PUBLIC_IOCTL(5U),

    CPSW_PHY_IOCTL_PHY_SET_MODE            = CPSW_PHY_PUBLIC_IOCTL(6U),

    CPSW_PHY_IOCTL_PHY_RESET               = CPSW_PHY_PUBLIC_IOCTL(7U),

    CPSW_PHY_IOCTL_RUN_COMPLIANCE_TEST     = CPSW_PHY_PUBLIC_IOCTL(8U),

    CPSW_PHY_IOCTL_PHY_IS_ALIVE            = CPSW_PHY_PUBLIC_IOCTL(9U),

    CPSW_PHY_IOCTL_PHY_IS_LINKED           = CPSW_PHY_PUBLIC_IOCTL(10U),

    CPSW_PHY_IOCTL_READ_REG                = CPSW_PHY_PUBLIC_IOCTL(11U),

    CPSW_PHY_IOCTL_WRITE_REG               = CPSW_PHY_PUBLIC_IOCTL(12U),

    CPSW_PHY_IOCTL_READ_REG_EXT            = CPSW_PHY_PUBLIC_IOCTL(13U),

    CPSW_PHY_IOCTL_WRITE_REG_EXT           = CPSW_PHY_PUBLIC_IOCTL(14U),

    CPSW_PHY_IOCTL_READ_CLAUSE45_REG       = CPSW_PHY_PUBLIC_IOCTL(15U),

    CPSW_PHY_IOCTL_WRITE_CLAUSE45_REG      = CPSW_PHY_PUBLIC_IOCTL(16U),

    CPSW_PHY_IOCTL_PRINT_REGS              = CPSW_PHY_PUBLIC_IOCTL(17U),
};

typedef struct CpswPhy_GenericInArgs_s
{
    Cpsw_MacPort portNum;
} CpswPhy_GenericInArgs;

/* TODO: Remove - it's unused */
typedef struct CpswPhy_GetModeOutArgs_s
{
    Cpsw_Speed speed;

    Cpsw_Duplexity duplexity;

    bool loopback;
} CpswPhy_GetModeOutArgs;

typedef struct CpswPhy_SetModeInArgs
{
    Cpsw_MacPort portNum;

    uint32_t mode;

    bool loopbackEn;
} CpswPhy_SetModeInArgs;

typedef struct CpswPhy_ComplianceTestInArgs_s
{
    Cpsw_MacPort portNum;

    uint32_t testMode;
} CpswPhy_ComplianceTestInArgs;

typedef struct CpswPhy_ReadRegInArgs_s
{
    Cpsw_MacPort portNum;

    uint16_t reg;
} CpswPhy_ReadRegInArgs;

typedef struct CpswPhy_WriteRegInArgs_s
{
    Cpsw_MacPort portNum;

    uint16_t reg;

    uint16_t val;
} CpswPhy_WriteRegInArgs;

typedef struct CpswPhy_Clause45ReadRegInArgs_s
{
    Cpsw_MacPort portNum;

    CpswMdio_Clause45Mmd mmd;

    uint16_t reg;
} CpswPhy_Clause45ReadRegInArgs;

typedef struct CpswPhy_Clause45WriteRegInArgs_s
{
    Cpsw_MacPort portNum;

    CpswMdio_Clause45Mmd mmd;

    uint16_t reg;

    uint16_t val;
} CpswPhy_Clause45WriteRegInArgs;

typedef struct CpswPhy_Version_s
{
    uint32_t oui;

    uint32_t model;

    uint32_t revision;
} CpswPhy_Version;

typedef struct CpswPhy_FsmTimeoutConfig_s
{
    uint32_t findingStateTicks;

    uint32_t resetWaitStateTicks;

    uint32_t resetWaitStateResidenceTicks;

    uint32_t nwayStartStateTicks;

    uint32_t nwayWaitStateTicks;

    uint32_t linkWaitStateTicks;

    uint32_t mdixTicks;
} CpswPhy_FsmTimeoutConfig;

typedef struct CpswPhy_Config_s
{
    uint32_t phyAddr;

    uint32_t nwayCaps;

    bool mdixEnable;

    bool isStrapped;

    bool enableLoopback;

    bool masterMode;

    bool extClkSource;

    bool skipExtendedConfig;

    CpswPhy_FsmTimeoutConfig timeoutConfig;

    uint8_t extendedConfig[CPSW_PHY_EXTENDED_CFG_SIZE_MAX];

    uint32_t extendedConfigSize;
} CpswPhy_Config;

typedef struct CpswPhy_Obj_s *CpswPhy_Handle;

/* ========================================================================== */
/*                         Global Variables Declarations                      */
/* ========================================================================== */

/* None */

/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */

/* None */

/* ========================================================================== */
/*                        Deprecated Function Declarations                    */
/* ========================================================================== */

/* None */

#ifdef __cplusplus
}
#endif

#endif /* #ifndef CPSW_PHY_H_ */