enet_mod_phy.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_PHY_H_
#define ENET_MOD_PHY_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <stdint.h>
#include <include/core/enet_types.h>
#include <include/core/enet_ioctl.h>
#include <include/phy/enetphy.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                                 Macros                                     */
/* ========================================================================== */
 
#define ENET_PHY_PUBLIC_IOCTL(x)              (ENET_IOCTL_TYPE_PUBLIC | \
                                               ENET_IOCTL_PHY_BASE |    \
                                               ENET_IOCTL_MIN(x))
 
/* ========================================================================== */
/*                         Structures and Enums                               */
/* ========================================================================== */
 
enum EnetPhy_Ioctl_e
{
    ENET_PHY_IOCTL_GET_ID = ENET_PHY_PUBLIC_IOCTL(0U),
 
    ENET_PHY_IOCTL_GET_SUPPORTED_MODES = ENET_PHY_PUBLIC_IOCTL(1U),
 
    ENET_PHY_IOCTL_GET_LOOPBACK_STATE = ENET_PHY_PUBLIC_IOCTL(2U),
 
    ENET_PHY_IOCTL_IS_ALIVE = ENET_PHY_PUBLIC_IOCTL(3U),
 
    ENET_PHY_IOCTL_IS_LINKED = ENET_PHY_PUBLIC_IOCTL(4U),
 
    ENET_PHY_IOCTL_GET_LINK_MODE = ENET_PHY_PUBLIC_IOCTL(5U),
 
    ENET_PHY_IOCTL_RESET = ENET_PHY_PUBLIC_IOCTL(6U),
 
    ENET_PHY_IOCTL_READ_REG = ENET_PHY_PUBLIC_IOCTL(7U),
 
    ENET_PHY_IOCTL_WRITE_REG = ENET_PHY_PUBLIC_IOCTL(8U),
 
    ENET_PHY_IOCTL_READ_EXT_REG = ENET_PHY_PUBLIC_IOCTL(9U),
 
    ENET_PHY_IOCTL_WRITE_EXT_REG = ENET_PHY_PUBLIC_IOCTL(10U),
 
    ENET_PHY_IOCTL_C45_READ_REG = ENET_PHY_PUBLIC_IOCTL(11U),
 
    ENET_PHY_IOCTL_C45_WRITE_REG = ENET_PHY_PUBLIC_IOCTL(12U),
 
    ENET_PHY_IOCTL_PRINT_REGS = ENET_PHY_PUBLIC_IOCTL(13U),
 
    ENET_PHY_IOCTL_ADJ_PTP_FREQ = ENET_PHY_PUBLIC_IOCTL(14U),
 
    ENET_PHY_IOCTL_ADJ_PTP_PHASE = ENET_PHY_PUBLIC_IOCTL(15U),
 
    ENET_PHY_IOCTL_GET_PTP_TIME = ENET_PHY_PUBLIC_IOCTL(16U),
 
    ENET_PHY_IOCTL_SET_PTP_TIME = ENET_PHY_PUBLIC_IOCTL(17U),
 
    ENET_PHY_IOCTL_GET_PTP_TXTS = ENET_PHY_PUBLIC_IOCTL(18U),
 
    ENET_PHY_IOCTL_GET_PTP_RXTS = ENET_PHY_PUBLIC_IOCTL(19U),
 
    ENET_PHY_IOCTL_WAIT_PTP_TXTS = ENET_PHY_PUBLIC_IOCTL(20U),
 
    ENET_PHY_IOCTL_PROC_STATUS_FRAME = ENET_PHY_PUBLIC_IOCTL(21U),
 
    ENET_PHY_IOCTL_GET_STATUS_FRAME_ETHDR = ENET_PHY_PUBLIC_IOCTL(22U),
 
    ENET_PHY_IOCTL_ENABLE_PTP = ENET_PHY_PUBLIC_IOCTL(23U),
 
    ENET_PHY_IOCTL_ENABLE_EVENT_CAPTURE = ENET_PHY_PUBLIC_IOCTL(24U),
 
    ENET_PHY_IOCTL_ENABLE_TRIGGER_OUTPUT = ENET_PHY_PUBLIC_IOCTL(25U),
 
    ENET_PHY_IOCTL_GET_EVENT_TIMESTAMP = ENET_PHY_PUBLIC_IOCTL(26U),
};
 
typedef struct EnetPhy_GenericInArgs_s
{
    Enet_MacPort macPort;
} EnetPhy_GenericInArgs;
 
typedef struct EnetPhy_ReadRegInArgs_s
{
    Enet_MacPort macPort;
 
    uint16_t reg;
} EnetPhy_ReadRegInArgs;
 
typedef struct EnetPhy_WriteRegInArgs_s
{
    Enet_MacPort macPort;
 
    uint16_t reg;
 
    uint16_t val;
} EnetPhy_WriteRegInArgs;
 
typedef struct EnetPhy_C45ReadRegInArgs_s
{
    Enet_MacPort macPort;
 
    uint8_t mmd;
 
    uint16_t reg;
} EnetPhy_C45ReadRegInArgs;
 
typedef struct EnetPhy_C45WriteRegInArgs_s
{
    Enet_MacPort macPort;
 
    uint8_t mmd;
 
    uint16_t reg;
 
    uint16_t val;
} EnetPhy_C45WriteRegInArgs;
 
typedef struct EnetPhy_PtpPktTimestampInArgs_s
{
    Enet_MacPort macPort;
    uint32_t domain;
    uint32_t msgType;
    uint32_t seqId;
} EnetPhy_PtpPktTimestampInArgs;
 
typedef struct EnetPhy_AdjPtpFreqInArgs_s
{
    Enet_MacPort macPort;
    int64_t ppb;
} EnetPhy_AdjPtpFreqInArgs;
 
typedef struct EnetPhy_AdjPtpPhaseInArgs_s
{
    Enet_MacPort macPort;
    int64_t offset;
} EnetPhy_AdjPtpPhaseInArgs;
 
typedef struct EnetPhy_SetPtpTimeInArgs_s
{
    Enet_MacPort macPort;
    uint64_t ts64;
} EnetPhy_SetPtpTimeInArgs;
 
typedef struct EnetPhy_ProcStatusFrameInArgs_s
{
    Enet_MacPort macPort;
    uint8_t *frame;
    uint32_t size;
} EnetPhy_ProcStatusFrameInArgs;
 
typedef struct EnetPhy_ProcStatusFrameOutArgs_s
{
    /* combination of any #ENETPHY_STATUS_FRAME_TYPE_x */
    uint32_t types;
} EnetPhy_ProcStatusFrameOutArgs;
 
typedef struct EnetPhy_GetStatusFrameEthdrOutArgs_s
{
    uint8_t *ethhdr;
    uint32_t size;
} EnetPhy_GetStatusFrameEthdrOutArgs;
 
typedef struct EnetPhy_EnablePtpInArgs_s
{
    Enet_MacPort macPort;
    bool on;
    /* This PHY-specific parameter is used to distinguish status frames
     * among multiple PHYs connected to the same SoC.
     * Please check the PHY datasheet for supported value. */
    uint32_t srcMacStatusFrameType;
} EnetPhy_EnablePtpInArgs;
 
typedef struct EnetPhy_EnableEventCaptureInArgs_s
{
    Enet_MacPort macPort;
    uint32_t eventIdx;
    bool falling;
    bool on;
} EnetPhy_EnableEventCaptureInArgs;
 
typedef struct EnetPhy_EnableTriggerOutputInArgs_s
{
    Enet_MacPort macPort;
    uint32_t triggerIdx;
    uint64_t startNsec;
    uint64_t periodNsec;
    bool repeat;
} EnetPhy_EnableTriggerOutputInArgs;
 
typedef struct EnetPhy_GetEventTimestampOutArgs_s
{
    uint32_t eventIdx;
    uint32_t seqId;
    uint64_t ts64;
} EnetPhy_GetEventTimestampOutArgs;
 
/* ========================================================================== */
/*                         Global Variables Declarations                      */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                        Deprecated Function Declarations                    */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                       Static Function Definitions                          */
/* ========================================================================== */
 
/* None */
 
#ifdef __cplusplus
}
#endif
 
#endif /* ENET_MOD_PHY_H_ */