enet_mod_timesync.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_TIMESYNC_H_
#define ENET_MOD_TIMESYNC_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_TIMESYNC_PUBLIC_IOCTL(x)             (ENET_IOCTL_TYPE_PUBLIC |   \
                                                   ENET_IOCTL_TIMESYNC_BASE | \
                                                   ENET_IOCTL_MIN(x))
 
/* ========================================================================== */
/*                         Structures and Enums                               */
/* ========================================================================== */
 
typedef enum EnetTimeSync_Ioctl_e
{
    ENET_TIMESYNC_IOCTL_GET_VERSION = ENET_TIMESYNC_PUBLIC_IOCTL(0U),
 
    ENET_TIMESYNC_IOCTL_PRINT_REGS = ENET_TIMESYNC_PUBLIC_IOCTL(1U),
 
    ENET_TIMESYNC_IOCTL_PRINT_STATS = ENET_TIMESYNC_PUBLIC_IOCTL(2U),
 
    ENET_TIMESYNC_IOCTL_GET_CURRENT_TIMESTAMP = ENET_TIMESYNC_PUBLIC_IOCTL(3U),
 
    ENET_TIMESYNC_IOCTL_SET_TIMESTAMP = ENET_TIMESYNC_PUBLIC_IOCTL(4U),
 
    ENET_TIMESYNC_IOCTL_ADJUST_TIMESTAMP = ENET_TIMESYNC_PUBLIC_IOCTL(5U),
 
    ENET_TIMESYNC_IOCTL_GET_ETH_RX_TIMESTAMP = ENET_TIMESYNC_PUBLIC_IOCTL(6U),
 
    ENET_TIMESYNC_IOCTL_GET_ETH_TX_TIMESTAMP = ENET_TIMESYNC_PUBLIC_IOCTL(7U),
 
    ENET_TIMESYNC_IOCTL_RESET = ENET_TIMESYNC_PUBLIC_IOCTL(8U),
 
    ENET_TIMESYNC_IOCTL_SET_TIMESTAMP_COMPLETE = ENET_TIMESYNC_PUBLIC_IOCTL(9U),
} EnetTimeSync_Ioctl;
 
typedef enum EnetTimeSync_MsgType_e
{
    ENET_TIMESYNC_MESSAGE_SYNC                  = 0x00U,
 
    ENET_TIMESYNC_MESSAGE_DELAY_REQ             = 0x01U,
 
    ENET_TIMESYNC_MESSAGE_PDELAY_REQ            = 0x02U,
 
    ENET_TIMESYNC_MESSAGE_PDELAY_RESP           = 0x03U,
 
    ENET_TIMESYNC_MESSAGE_FOLLOW_UP             = 0x08U,
 
    ENET_TIMESYNC_MESSAGE_DELAY_RESP            = 0x09U,
 
    ENET_TIMESYNC_MESSAGE_PDELAY_RESP_FOLLOW_UP = 0x0AU,
 
    ENET_TIMESYNC_MESSAGE_ANNOUNCE              = 0x0BU,
 
    ENET_TIMESYNC_MESSAGE_SIGNALING             = 0x0CU,
 
    ENET_TIMESYNC_MESSAGE_MANAGEMENT            = 0x0DU,
 
    ENET_TIMESYNC_MESSAGE_INVALID               = -1,
} EnetTimeSync_MsgType;
 
typedef enum EnetTimeSync_AdjMode_e
{
    ENET_TIMESYNC_ADJMODE_DISABLE = 0U,
 
    ENET_TIMESYNC_ADJMODE_PPM,
 
    ENET_TIMESYNC_ADJMODE_PPH,
} EnetTimeSync_AdjMode;
 
typedef enum EnetTimeSync_AdjDir_e
{
    ENET_TIMESYNC_ADJDIR_INCREASE = 0U,
 
    ENET_TIMESYNC_ADJDIR_DECREASE,
} EnetTimeSync_AdjDir;
 
typedef struct EnetTimeSync_setTimestamp_s
{
    uint64_t tsLoadVal;
 
    uint8_t clkMode;
 
    /*Sign of the clock. Applicable only to ICSSG peripheral. */
    uint8_t clkSign;
} EnetTimeSync_setTimestamp;
 
typedef struct EnetTimeSync_TimestampAdj_s
{
    int32_t adjValInNsecs;
 
    uint32_t intervalInNsecs;
} EnetTimeSync_TimestampAdj;
 
typedef struct EnetTimeSync_GetEthTimestampInArgs_s
{
    EnetTimeSync_MsgType msgType;
 
    uint32_t seqId;
 
    uint32_t portNum;
 
    uint32_t domain;
} EnetTimeSync_GetEthTimestampInArgs;
 
/* ========================================================================== */
/*                         Global Variables Declarations                      */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                        Deprecated Function Declarations                    */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                       Static Function Definitions                          */
/* ========================================================================== */
 
/* None */
 
#ifdef __cplusplus
}
#endif
 
#endif /* ENET_MOD_TIMESYNC_H_ */