enet_mod_mdio.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 ENET_MOD_MDIO_H_
#define ENET_MOD_MDIO_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <stdint.h>
#include <include/core/enet_types.h>
#include <include/core/enet_ioctl.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                                 Macros                                     */
/* ========================================================================== */
 
#define ENET_MDIO_FEAT_CLAUSE45               (ENET_BIT(0U))
 
#define ENET_MDIO_FEAT_PHY_MONITOR            (ENET_BIT(1U))
 
#define ENET_MDIO_PUBLIC_IOCTL(x)             (ENET_IOCTL_TYPE_PUBLIC | \
                                               ENET_IOCTL_MDIO_BASE |   \
                                               ENET_IOCTL_MIN(x))
 
#define ENET_MDIO_PRIVATE_IOCTL(x)             (ENET_IOCTL_TYPE_PRIVATE | \
                                               ENET_IOCTL_MDIO_BASE |   \
                                               ENET_IOCTL_MIN(x))
 
#define ENET_MDIO_PHY_ADDR_MASK(addr)         (ENET_BIT(addr))
 
#define ENET_MDIO_IS_PHY_ADDR_SET(mask, addr) (((mask) & ENET_BIT(addr)) != 0U)
 
#define ENET_MDIO_PHY_ADDR_MASK_NONE          (0x00000000U)
 
#define ENET_MDIO_PHY_ADDR_MASK_ALL           (0xFFFFFFFFU)
 
#define ENET_MDIO_PHY_CNT_MAX                 (31U)
 
/* ========================================================================== */
/*                         Structures and Enums                               */
/* ========================================================================== */
 
typedef enum EnetMdio_Ioctl_e
{
    ENET_MDIO_IOCTL_GET_VERSION = ENET_MDIO_PUBLIC_IOCTL(0U),
 
    ENET_MDIO_IOCTL_PRINT_REGS = ENET_MDIO_PUBLIC_IOCTL(1U),
 
    ENET_MDIO_IOCTL_IS_ALIVE = ENET_MDIO_PUBLIC_IOCTL(2U),
 
    ENET_MDIO_IOCTL_IS_LINKED = ENET_MDIO_PUBLIC_IOCTL(3U),
 
    ENET_MDIO_IOCTL_IS_POLL_ENABLED = ENET_MDIO_PUBLIC_IOCTL(4U),
 
    ENET_MDIO_IOCTL_C22_READ = ENET_MDIO_PUBLIC_IOCTL(5U),
 
    ENET_MDIO_IOCTL_C22_WRITE = ENET_MDIO_PUBLIC_IOCTL(6U),
 
    ENET_MDIO_IOCTL_C45_READ = ENET_MDIO_PUBLIC_IOCTL(7U),
 
    ENET_MDIO_IOCTL_C45_WRITE = ENET_MDIO_PUBLIC_IOCTL(8U),
 
    ENET_MDIO_IOCTL_C22_ASYNC_READ_TRIGGER = ENET_MDIO_PUBLIC_IOCTL(9U),
 
    ENET_MDIO_IOCTL_C22_ASYNC_READ_COMPLETE = ENET_MDIO_PUBLIC_IOCTL(10U),
 
    ENET_MDIO_IOCTL_C22_ASYNC_WRITE_TRIGGER = ENET_MDIO_PUBLIC_IOCTL(11U),
 
    ENET_MDIO_IOCTL_C22_ASYNC_WRITE_COMPLETE = ENET_MDIO_PUBLIC_IOCTL(12U),
 
    ENET_MDIO_IOCTL_C45_ASYNC_READ_TRIGGER = ENET_MDIO_PUBLIC_IOCTL(13U),
 
    ENET_MDIO_IOCTL_C45_ASYNC_READ_COMPLETE = ENET_MDIO_PUBLIC_IOCTL(14U),
 
    ENET_MDIO_IOCTL_C45_ASYNC_WRITE_TRIGGER = ENET_MDIO_PUBLIC_IOCTL(15U),
 
    ENET_MDIO_IOCTL_C45_ASYNC_WRITE_COMPLETE = ENET_MDIO_PUBLIC_IOCTL(16U),
 
    ENET_MDIO_IOCTL_ENABLE_STATE_MACHINE = ENET_MDIO_PUBLIC_IOCTL(17U),
 
} EnetMdio_Ioctl;
 
typedef enum EnetMdio_Group_e
{
    ENET_MDIO_GROUP_0 = 0U,
 
    ENET_MDIO_GROUP_1,
 
    ENET_MDIO_GROUP_NUM,
} EnetMdio_Group;
 
typedef enum EnetMdio_FrameFmt_s
{
    ENET_MDIO_FRAME_FMT_C22 = 0U,
 
    ENET_MDIO_FRAME_FMT_C45,
} EnetMdio_FrameFmt;
 
typedef enum EnetMdio_C45Mmd_e
{
    ENET_MDIO_MMD_PMA_PMD  = 1U,
 
    ENET_MDIO_MMD_WIS      = 2U,
 
    ENET_MDIO_MMD_PCS      = 3U,
 
    ENET_MDIO_MMD_PHY_XS   = 4U,
 
    ENET_MDIO_MMD_DTE_XS   = 5U,
 
    ENET_MDIO_MMD_VENDOR_1 = 30U,
 
    ENET_MDIO_MMD_VENDOR_2 = 31U,
} EnetMdio_C45Mmd;
 
typedef struct EnetMdio_C22ReadInArgs_s
{
    EnetMdio_Group group;
 
    uint32_t phyAddr;
 
    uint16_t reg;
} EnetMdio_C22ReadInArgs;
 
typedef struct EnetMdio_C45ReadInArgs_s
{
    EnetMdio_Group group;
 
    uint32_t phyAddr;
 
    EnetMdio_C45Mmd mmd;
 
    uint16_t reg;
} EnetMdio_C45ReadInArgs;
 
typedef struct EnetMdio_C22WriteInArgs_s
{
    EnetMdio_Group group;
 
    uint32_t phyAddr;
 
    uint16_t reg;
 
    uint16_t val;
} EnetMdio_C22WriteInArgs;
 
typedef struct EnetMdio_C45WriteInArgs_s
{
    EnetMdio_Group group;
 
    uint32_t phyAddr;
 
    EnetMdio_C45Mmd mmd;
 
    uint16_t reg;
 
    uint16_t val;
} EnetMdio_C45WriteInArgs;
 
/* ========================================================================== */
/*                         Global Variables Declarations                      */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                        Deprecated Function Declarations                    */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                       Static Function Definitions                          */
/* ========================================================================== */
 
/* None */
 
#ifdef __cplusplus
}
#endif
 
#endif /* ENET_MOD_MDIO_H_ */