cpsw_cpts.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 CPSW_CPTS_H_
#define CPSW_CPTS_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <include/core/enet_mod_timesync.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                                 Macros                                     */
/* ========================================================================== */
 
#define CPSW_CPTS_PUBLIC_IOCTL(x)             (ENET_IOCTL_TYPE_PUBLIC |   \
                                               ENET_IOCTL_TIMESYNC_BASE | \
                                               ENET_IOCTL_PER_CPSW |      \
                                               ENET_IOCTL_MIN(x))
 
#define CPSW_CPTS_NUDGE_MIN_VAL           (-128)
 
#define CPSW_CPTS_NUDGE_MAX_VAL           (127)
 
/* ========================================================================== */
/*                         Structures and Enums                               */
/* ========================================================================== */
 
typedef enum CpswCpts_Ioctl_s
{
    CPSW_CPTS_IOCTL_REGISTER_STACK = CPSW_CPTS_PUBLIC_IOCTL(0U),
 
    CPSW_CPTS_IOCTL_UNREGISTER_STACK = CPSW_CPTS_PUBLIC_IOCTL(1U),
 
    CPSW_CPTS_IOCTL_REGISTER_HWPUSH_CALLBACK = CPSW_CPTS_PUBLIC_IOCTL(2U),
 
    CPSW_CPTS_IOCTL_UNREGISTER_HWPUSH_CALLBACK = CPSW_CPTS_PUBLIC_IOCTL(3U),
 
    CPSW_CPTS_IOCTL_SET_TS_NUDGE = CPSW_CPTS_PUBLIC_IOCTL(4U),
 
    CPSW_CPTS_IOCTL_SET_COMP = CPSW_CPTS_PUBLIC_IOCTL(5U),
 
    CPSW_CPTS_IOCTL_SET_COMP_NUDGE = CPSW_CPTS_PUBLIC_IOCTL(6U),
 
    CPSW_CPTS_IOCTL_SET_GENF = CPSW_CPTS_PUBLIC_IOCTL(7U),
 
    CPSW_CPTS_IOCTL_SET_GENF_NUDGE = CPSW_CPTS_PUBLIC_IOCTL(8U),
 
    CPSW_CPTS_IOCTL_SET_ESTF = CPSW_CPTS_PUBLIC_IOCTL(9U),
 
    CPSW_CPTS_IOCTL_SET_ESTF_NUDGE = CPSW_CPTS_PUBLIC_IOCTL(10U),
 
    CPSW_CPTS_IOCTL_SELECT_TS_OUTPUT_BIT = CPSW_CPTS_PUBLIC_IOCTL(11U),
 
    CPSW_CPTS_IOCTL_LOOKUP_EVENT = CPSW_CPTS_PUBLIC_IOCTL(12U),
} CpswCpts_Ioctl;
 
typedef enum CpswCpts_RftClkFreq_e
{
    CPSW_CPTS_RFTCLK_FREQ_1000MHZ    = 0U,
 
    CPSW_CPTS_RFTCLK_FREQ_500MHZ     = 1U,
 
    CPSW_CPTS_RFTCLK_FREQ_333_33MHZ  = 2U,
 
    CPSW_CPTS_RFTCLK_FREQ_250MHZ     = 3U,
 
    CPSW_CPTS_RFTCLK_FREQ_200MHZ     = 4U,
 
    CPSW_CPTS_RFTCLK_FREQ_166_66MHZ  = 5U,
 
    CPSW_CPTS_RFTCLK_FREQ_142_85MHZ  = 6U,
 
    CPSW_CPTS_RFTCLK_FREQ_125MHZ     = 7U,
} CpswCpts_RftClkFreq;
 
typedef enum CpswCpts_EventType_e
{
    CPSW_CPTS_EVENTTYPE_TS_PUSH = 0U,
 
    CPSW_CPTS_EVENTTYPE_TS_ROLLOVER,
 
    CPSW_CPTS_EVENTTYPE_TS_HALFROLLOVER,
 
    CPSW_CPTS_EVENTTYPE_HW_TS_PUSH,
 
    CPSW_CPTS_EVENTTYPE_ETH_RECEIVE,
 
    CPSW_CPTS_EVENTTYPE_ETH_TRANSMIT,
 
    CPSW_CPTS_EVENTTYPE_TS_COMP,
 
    CPSW_CPTS_EVENTTYPE_TS_HOST_TX,
 
    CPSW_CPTS_EVENTTYPE_INVALID = -1,
} CpswCpts_EventType;
 
typedef enum CpswCpts_OutputBitSel_e
{
    CPSW_CPTS_TS_OUTPUT_BIT_DISABLED = 0U,
 
    CPSW_CPTS_TS_OUTPUT_BIT_17,
 
    CPSW_CPTS_TS_OUTPUT_BIT_18,
 
    CPSW_CPTS_TS_OUTPUT_BIT_19,
 
    CPSW_CPTS_TS_OUTPUT_BIT_20,
 
    CPSW_CPTS_TS_OUTPUT_BIT_21,
 
    CPSW_CPTS_TS_OUTPUT_BIT_22,
 
    CPSW_CPTS_TS_OUTPUT_BIT_23,
 
    CPSW_CPTS_TS_OUTPUT_BIT_24,
 
    CPSW_CPTS_TS_OUTPUT_BIT_25,
 
    CPSW_CPTS_TS_OUTPUT_BIT_26,
 
    CPSW_CPTS_TS_OUTPUT_BIT_27,
 
    CPSW_CPTS_TS_OUTPUT_BIT_28,
 
    CPSW_CPTS_TS_OUTPUT_BIT_29,
 
    CPSW_CPTS_TS_OUTPUT_BIT_30,
 
    CPSW_CPTS_TS_OUTPUT_BIT_31,
} CpswCpts_OutputBitSel;
 
typedef enum CpswCpts_HwPush_e
{
    CPSW_CPTS_HWPUSH_FIRST = 1U,
 
    CPSW_CPTS_HWPUSH_1 = CPSW_CPTS_HWPUSH_FIRST,
 
    CPSW_CPTS_HWPUSH_2,
 
    CPSW_CPTS_HWPUSH_3,
 
    CPSW_CPTS_HWPUSH_4,
 
    CPSW_CPTS_HWPUSH_5,
 
    CPSW_CPTS_HWPUSH_6,
 
    CPSW_CPTS_HWPUSH_7,
 
    CPSW_CPTS_HWPUSH_8,
 
    CPSW_CPTS_HWPUSH_LAST = CPSW_CPTS_HWPUSH_8,
 
    CPSW_CPTS_HWPUSH_INVALID  = -1,
} CpswCpts_HwPush;
 
#define CPSW_CPTS_HWPUSH_COUNT_MAX            ((uint32_t)CPSW_CPTS_HWPUSH_LAST)
 
#define CPSW_CPTS_HWPUSH_NORM(x)              ((uint32_t)((x) - CPSW_CPTS_HWPUSH_FIRST))
 
typedef struct CpswCpts_Event_s
{
    uint64_t tsVal;
 
    CpswCpts_EventType eventType;
 
    EnetTimeSync_MsgType msgType;
 
    uint32_t seqId;
 
    uint32_t portNum;
 
    uint32_t domain;
 
    CpswCpts_HwPush hwPushNum;
} CpswCpts_Event;
 
typedef void (*CpswCpts_EventNotifyCb)(void *eventNotifyCbArg,
                                       CpswCpts_Event *eventInfo);
 
typedef void (*CpswCpts_HwPushNotifyCb)(void *hwPushNotifyCbArg,
                                        CpswCpts_HwPush hwPushNum);
 
typedef struct CpswCpts_StackConfig_s
{
    CpswCpts_EventNotifyCb eventNotifyCb;
 
    void *eventNotifyCbArg;
} CpswCpts_RegisterStackInArgs;
 
typedef struct CpswCpts_RegisterHwPushCbInArgs_s
{
    CpswCpts_HwPush hwPushNum;
 
    CpswCpts_HwPushNotifyCb hwPushNotifyCb;
 
    void *hwPushNotifyCbArg;
} CpswCpts_RegisterHwPushCbInArgs;
 
typedef struct CpswCpts_SetCompValInArgs_s
{
    uint64_t tsCompVal;
 
    uint32_t tsCompLen;
 
    bool tsCompToggle;
} CpswCpts_SetCompValInArgs;
 
typedef struct CpswCpts_SetFxnGenInArgs_s
{
    uint32_t index;
 
    uint32_t length;
 
    uint64_t compare;
 
    bool polarityInv;
 
    uint64_t ppmVal;
 
    EnetTimeSync_AdjDir ppmDir;
 
    EnetTimeSync_AdjMode ppmMode;
} CpswCpts_SetFxnGenInArgs;
 
typedef struct CpswCpts_SetFxnGenNudgeInArgs_s
{
    uint32_t index;
 
    int32_t tsNudge;
} CpswCpts_SetFxnGenNudgeInArgs;
 
typedef struct CpswCpts_Cfg_s
{
    bool hostRxTsEn;
 
    bool tsCompPolarity;
 
    bool tsRxEventsDis;
 
    bool tsGenfClrEn;
 
    CpswCpts_RftClkFreq cptsRftClkFreq;
} CpswCpts_Cfg;
 
/* ========================================================================== */
/*                         Global Variables Declarations                      */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
void CpswCpts_initCfg(CpswCpts_Cfg *cptsCfg);
 
/* ========================================================================== */
/*                        Deprecated Function Declarations                    */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                       Static Function Definitions                          */
/* ========================================================================== */
 
/* None */
 
#ifdef __cplusplus
}
#endif
 
#endif /* CPSW_CPTS_H_ */