/* 00comp_ipnet_ptp.cdf - IPNet PTP configuration file */

/*
 * Copyright (c) 2016 Wind River Systems, Inc.
 *
 * The right to copy, distribute or otherwise make use of this software
 * may be licensed only pursuant to the terms of an applicable Wind River
 * license agreement. No license to Wind River intellectual property rights
 * is granted herein. All rights not licensed by Wind River are reserved
 * by Wind River.
 */

/*
modification history
--------------------
16aug16,myt  add boundary clock GUI configuration(F6696)
26jan16,h_l  created.
*/

#ifdef _WRS_CONFIG_COMPONENT_IPPTP

Folder FOLDER_PTP {
    NAME        PTP Components
    SYNOPSIS    PTP Components
    _CHILDREN   FOLDER_NET_L5_APPLICATIONS
    CHILDREN    SELECT_IPPTP_PROFILE \
                SELECT_IPPTP_CLOCK_TYPE \
                FOLDER_IPPTP_BOUNDARY_CLOCK \
                INCLUDE_IPPTP_ORDINARY_CLOCK \
                INCLUDE_IPPTP
    DEFAULT     SELECT_IPPTP_CLOCK_TYPE
}


Component INCLUDE_IPPTP {
    NAME            Precision time protocol
    SYNOPSIS        PTP module
    _INIT_ORDER     usrNetAppInit
    CONFIGLETTES    ipptp_config_init.c    
    PROTOTYPE       STATUS usrPtpClockInit (void);
    INIT_RTN        usrPtpClockInit ();
    LINK_SYMS       ptpdStart
    REQUIRES        INCLUDE_IPNET_SOCKET
    CFG_PARAMS      PTP_CLK_TASK_PRIORITY
}

Selection SELECT_IPPTP_PROFILE {
    NAME            Select profile
    SYNOPSIS        PTP profile selection
    COUNT           1-1
    CHILDREN        IPPTP_DEFAULT_PROFILE \
                    IPPTP_802_1AS_PROFILE
    DEFAULT         IPPTP_DEFAULT_PROFILE
}

Component IPPTP_DEFAULT_PROFILE {
    NAME            Default profile
    SYNOPSIS        Precision time protocol default profile
    REQUIRES        INCLUDE_IPPTP
}

Component IPPTP_802_1AS_PROFILE {
    NAME            802.1AS profile
    SYNOPSIS        Precision time protocol 802.1 AS profile
    REQUIRES        INCLUDE_IPPTP
}


Selection SELECT_IPPTP_CLOCK_TYPE {
    NAME            Select clock type
    SYNOPSIS        Clock is ordinary clock or boundary clock
    COUNT           1-1
    CHILDREN        SELECT_IPPTP_ORDINARY_CLOCK \
                    SELECT_IPPTP_BOUNDARY_CLOCK
    DEFAULT         SELECT_IPPTP_ORDINARY_CLOCK
}

Component SELECT_IPPTP_BOUNDARY_CLOCK {
    NAME            Boundary clock
    SYNOPSIS        Select ptp clock type is boundary clock 
    REQUIRES        INCLUDE_IPPTP_BOUNDARY_CLOCK_1 \
                    INCLUDE_IPPTP
}

Component SELECT_IPPTP_ORDINARY_CLOCK {
    NAME            Ordinary clock
    SYNOPSIS        Select ptp clock type is ordinary clock 
    REQUIRES        INCLUDE_IPPTP_ORDINARY_CLOCK \
                    INCLUDE_IPPTP
}

Folder FOLDER_IPPTP_BOUNDARY_CLOCK {
    NAME            Boundary clock
    CHILDREN        INCLUDE_IPPTP_BOUNDARY_CLOCK_1 \
                    INCLUDE_IPPTP_BOUNDARY_CLOCK_2 \
                    INCLUDE_IPPTP_BOUNDARY_CLOCK_3 \
                    INCLUDE_IPPTP_BOUNDARY_CLOCK_4
}

Component INCLUDE_IPPTP_BOUNDARY_CLOCK_1 {
    NAME            Clock 1
    SYNOPSIS        Include and start PTP boundary clock 1,\
                    this clock is slave clock
    _INIT_ORDER     usrNetAppInit
    CONFIGLETTES    ipptp_config_bclk1.c    
    PROTOTYPE       STATUS usrPtpBoundaryClock1Init (void);
    INIT_RTN        usrPtpBoundaryClock1Init ();
    REQUIRES        INCLUDE_IPPTP \
                    SELECT_IPPTP_BOUNDARY_CLOCK \
                    SELECT_IPPTP_PROFILE
    CFG_PARAMS      PTP_BOUNDARY_CLK1_IF_NAME \
                    PTP_BOUNDARY_CLK1_TRANSPORT_LAYER \
                    PTP_BOUNDARY_CLK1_DELAY_MECHANISM \
                    PTP_BOUNDARY_CLK1_ONE_STEP_MODE \
                    PTP_BOUNDARY_CLK1_PRIORITY \
                    PTP_BOUNDARY_CLK1_PDELAY_REQ_INTERVAL \
                    PTP_BOUNDARY_CLK1_DEBUG_LEVEL
}

Component INCLUDE_IPPTP_BOUNDARY_CLOCK_2 {
    NAME            Clock 2
    SYNOPSIS        Include and start PTP boundary clock 2,\
                    this clock is master clock
    _INIT_ORDER     usrNetAppInit
    CONFIGLETTES    ipptp_config_bclk2.c    
    PROTOTYPE       STATUS usrPtpBoundaryClock2Init (void);
    INIT_RTN        usrPtpBoundaryClock2Init ();
    REQUIRES        INCLUDE_IPPTP \
                    INCLUDE_IPPTP_BOUNDARY_CLOCK_1 \
                    SELECT_IPPTP_BOUNDARY_CLOCK \
                    SELECT_IPPTP_PROFILE
    CFG_PARAMS      PTP_BOUNDARY_CLK2_IF_NAME \
                    PTP_BOUNDARY_CLK2_TRANSPORT_LAYER \
                    PTP_BOUNDARY_CLK2_DELAY_MECHANISM \
                    PTP_BOUNDARY_CLK2_ONE_STEP_MODE \
                    PTP_BOUNDARY_CLK2_PRIORITY \
                    PTP_BOUNDARY_CLK2_PDELAY_REQ_INTERVAL \
                    PTP_BOUNDARY_CLK2_DEBUG_LEVEL
}

Component INCLUDE_IPPTP_BOUNDARY_CLOCK_3 {
    NAME            Clock 3
    SYNOPSIS        Include and start PTP boundary clock 3,\
                    this clock is master clock
    _INIT_ORDER     usrNetAppInit
    CONFIGLETTES    ipptp_config_bclk3.c    
    PROTOTYPE       STATUS usrPtpBoundaryClock3Init (void);
    INIT_RTN        usrPtpBoundaryClock3Init ();
    REQUIRES        INCLUDE_IPPTP \
                    INCLUDE_IPPTP_BOUNDARY_CLOCK_1 \
                    SELECT_IPPTP_BOUNDARY_CLOCK \
                    SELECT_IPPTP_PROFILE
    CFG_PARAMS      PTP_BOUNDARY_CLK3_IF_NAME \
                    PTP_BOUNDARY_CLK3_TRANSPORT_LAYER \
                    PTP_BOUNDARY_CLK3_DELAY_MECHANISM \
                    PTP_BOUNDARY_CLK3_ONE_STEP_MODE \
                    PTP_BOUNDARY_CLK3_PRIORITY \
                    PTP_BOUNDARY_CLK3_PDELAY_REQ_INTERVAL \
                    PTP_BOUNDARY_CLK3_DEBUG_LEVEL
}

Component INCLUDE_IPPTP_BOUNDARY_CLOCK_4 {
    NAME            Clock 4
    SYNOPSIS        Include and start PTP boundary clock 4,\
                    this clock is master clock
    _INIT_ORDER     usrNetAppInit
    CONFIGLETTES    ipptp_config_bclk4.c    
    PROTOTYPE       STATUS usrPtpBoundaryClock4Init (void);
    INIT_RTN        usrPtpBoundaryClock4Init ();
    REQUIRES        INCLUDE_IPPTP \
                    INCLUDE_IPPTP_BOUNDARY_CLOCK_1 \
                    SELECT_IPPTP_BOUNDARY_CLOCK \
                    SELECT_IPPTP_PROFILE
    CFG_PARAMS      PTP_BOUNDARY_CLK4_IF_NAME \
                    PTP_BOUNDARY_CLK4_TRANSPORT_LAYER \
                    PTP_BOUNDARY_CLK4_DELAY_MECHANISM \
                    PTP_BOUNDARY_CLK4_ONE_STEP_MODE \
                    PTP_BOUNDARY_CLK4_PRIORITY \
                    PTP_BOUNDARY_CLK4_PDELAY_REQ_INTERVAL \
                    PTP_BOUNDARY_CLK4_DEBUG_LEVEL
}

Component INCLUDE_IPPTP_ORDINARY_CLOCK {
    NAME            Ordinary clock
    SYNOPSIS        Include and start PTP ordinary clock
    _INIT_ORDER     usrNetAppInit
    CONFIGLETTES    ipptp_config.c    
    PROTOTYPE       STATUS usrPtpOrdinaryClockInit (void);
    INIT_RTN        usrPtpOrdinaryClockInit ();
    REQUIRES        INCLUDE_IPPTP \
                    SELECT_IPPTP_ORDINARY_CLOCK \
                    SELECT_IPPTP_PROFILE
    CFG_PARAMS      PTP_ORDINARY_IF_NAME \
                    PTP_ORDINARY_TRANSPORT_LAYER \
                    PTP_ORDINARY_MASTER_MODE \
                    PTP_ORDINARY_DELAY_MECHANISM \
                    PTP_ORDINARY_ONE_STEP_MODE \
                    PTP_ORDINARY_PRIORITY \
                    PTP_ORDINARY_PDELAY_REQ_INTERVAL \
                    PTP_ORDINARY_DEBUG_LEVEL
}

/******************** Configuration Parameters *****************************/
Parameter PTP_CLK_TASK_PRIORITY {
    NAME            Clock daemon task priority   
    SYNOPSIS        This parameter sets the task priority of the PTP clock \
                    service task. Change this value carefully. 
    TYPE            int
    DEFAULT         80
}
/******************** Ordinary Clock Parameters *****************************/
Parameter PTP_ORDINARY_IF_NAME {
    NAME        Interface name
    SYNOPSIS    Interface name as a quoted string: e.g. "gei0"
    TYPE        char *
    DEFAULT     "gei0"
}

Parameter PTP_ORDINARY_TRANSPORT_LAYER {
    NAME            Transport layer
    SYNOPSIS        Precision time protocol transport layer
    TYPE            int
    DEFAULT         2
}

Parameter PTP_ORDINARY_MASTER_MODE {
    NAME        Slave master or BCMA
    SYNOPSIS    Slave set to 0, master set to 1, others for BCMA.
    TYPE        int
    DEFAULT     0
}


Parameter PTP_ORDINARY_DELAY_MECHANISM {
    NAME        Delay mechanism
    SYNOPSIS    P2P mode set to TRUE, else for E2E mode set to FALSE.
    TYPE        BOOL
    DEFAULT     TRUE
}

Parameter PTP_ORDINARY_ONE_STEP_MODE {
    NAME        Step mode
    SYNOPSIS    One-Step mode set to TRUE, else for two-Step mode set to FALSE.
    TYPE        BOOL
    DEFAULT     FALSE
}

Parameter PTP_ORDINARY_PRIORITY {
    NAME            Priority   
    SYNOPSIS        Clock priority when configured as master Clock 
    TYPE            int
    DEFAULT         128
}


Parameter PTP_ORDINARY_PDELAY_REQ_INTERVAL {
    NAME            Pdelay request interval
    SYNOPSIS        PTP ordinary clock Pdelay request interval,reciprocal of \
                    N times of power of 2,(1 ~ -4) means (0.5PPS ~ 16PPS)
    TYPE            int
    DEFAULT         0
}

Parameter PTP_ORDINARY_DEBUG_LEVEL {
    NAME            Debug level
    SYNOPSIS        Default debug level config: e.g. 0~6 
    TYPE            int
    DEFAULT         0
}

/******************** Boundary Clock1 Parameters *****************************/
Parameter PTP_BOUNDARY_CLK1_IF_NAME {
    NAME        Interface name
    SYNOPSIS    Interface name as a quoted string: e.g. "gei0"
    TYPE        char *
    DEFAULT     "gei0"
}

Parameter PTP_BOUNDARY_CLK1_TRANSPORT_LAYER {
    NAME            Transport layer
    SYNOPSIS        Precision time protocol transport layer
    TYPE            int
    DEFAULT         2
}


Parameter PTP_BOUNDARY_CLK1_DELAY_MECHANISM {
    NAME        Delay mechanism
    SYNOPSIS    P2P mode set to TRUE, else for E2E mode set to FALSE.
    TYPE        BOOL
    DEFAULT     TRUE
}

Parameter PTP_BOUNDARY_CLK1_ONE_STEP_MODE {
    NAME        Step mode
    SYNOPSIS    One-Step mode set to TRUE, else for two-Step mode set to FALSE.
    TYPE        BOOL
    DEFAULT     FALSE
}


Parameter PTP_BOUNDARY_CLK1_PRIORITY {
    NAME            Priority   
    SYNOPSIS        Clock priority when configured as master Clock 
    TYPE            int
    DEFAULT         128
}


Parameter PTP_BOUNDARY_CLK1_PDELAY_REQ_INTERVAL {
    NAME            Pdelay request interval
    SYNOPSIS        PTP ordinary clock Pdelay request interval,reciprocal of \
                    N times of power of 2,(1 ~ -4) means (0.5PPS ~ 16PPS)
    TYPE            int
    DEFAULT         0
}


Parameter PTP_BOUNDARY_CLK1_DEBUG_LEVEL {
    NAME            Debug level
    SYNOPSIS        Default debug level config: e.g. 0~6 
    TYPE            int
    DEFAULT         0
}

/******************** Boundary Clock2 Parameters *****************************/
Parameter PTP_BOUNDARY_CLK2_IF_NAME {
    NAME        Interface name
    SYNOPSIS    Interface name as a quoted string: e.g. "gei1"
    TYPE        char *
    DEFAULT     "gei1"
}

Parameter PTP_BOUNDARY_CLK2_TRANSPORT_LAYER {
    NAME            Transport layer
    SYNOPSIS        Precision time protocol transport layer
    TYPE            int
    DEFAULT         2
}


Parameter PTP_BOUNDARY_CLK2_DELAY_MECHANISM {
    NAME        Delay mechanism
    SYNOPSIS    P2P mode set to TRUE, else for E2E mode set to FALSE.
    TYPE        BOOL
    DEFAULT     TRUE
}

Parameter PTP_BOUNDARY_CLK2_ONE_STEP_MODE {
    NAME        Step mode
    SYNOPSIS    One-Step mode set to TRUE, else for two-Step mode set to FALSE.
    TYPE        BOOL
    DEFAULT     FALSE
}
Parameter PTP_BOUNDARY_CLK2_PRIORITY {
    NAME            Priority   
    SYNOPSIS        Clock priority when configured as master Clock 
    TYPE            int
    DEFAULT         128
}


Parameter PTP_BOUNDARY_CLK2_PDELAY_REQ_INTERVAL {
    NAME            Pdelay request interval
    SYNOPSIS        PTP ordinary clock Pdelay request interval,reciprocal of \
                    N times of power of 2,(1 ~ -4) means (0.5PPS ~ 16PPS)
    TYPE            int
    DEFAULT         0
}

Parameter PTP_BOUNDARY_CLK2_DEBUG_LEVEL {
    NAME            Debug level
    SYNOPSIS        Default debug level config: e.g. 0~6 
    TYPE            int
    DEFAULT         0
}

/******************** Boundary Clock3 Parameters *****************************/
Parameter PTP_BOUNDARY_CLK3_IF_NAME {
    NAME        Interface name
    SYNOPSIS    Interface name as a quoted string: e.g. "gei2"
    TYPE        char *
    DEFAULT     "gei2"
}

Parameter PTP_BOUNDARY_CLK3_TRANSPORT_LAYER {
    NAME            Transport layer
    SYNOPSIS        Precision time protocol transport layer
    TYPE            int
    DEFAULT         2
}


Parameter PTP_BOUNDARY_CLK3_DELAY_MECHANISM {
    NAME        Delay mechanism
    SYNOPSIS    P2P mode set to TRUE, else for E2E mode set to FALSE.
    TYPE        BOOL
    DEFAULT     TRUE
}

Parameter PTP_BOUNDARY_CLK3_ONE_STEP_MODE {
    NAME        Step mode
    SYNOPSIS    One-Step mode set to TRUE, else for two-Step mode set to FALSE.
    TYPE        BOOL
    DEFAULT     FALSE
}
Parameter PTP_BOUNDARY_CLK3_PRIORITY {
    NAME            Priority   
    SYNOPSIS        Clock priority when configured as master Clock 
    TYPE            int
    DEFAULT         128
}


Parameter PTP_BOUNDARY_CLK3_PDELAY_REQ_INTERVAL {
    NAME            Pdelay request interval
    SYNOPSIS        PTP ordinary clock Pdelay request interval,reciprocal of \
                    N times of power of 2,(1 ~ -4) means (0.5PPS ~ 16PPS)
    TYPE            int
    DEFAULT         0
}

Parameter PTP_BOUNDARY_CLK3_DEBUG_LEVEL {
    NAME            Debug level
    SYNOPSIS        Default debug level config: e.g. 0~6 
    TYPE            int
    DEFAULT         0
}

/******************** Boundary Clock4 Parameters *****************************/
Parameter PTP_BOUNDARY_CLK4_IF_NAME {
    NAME        Interface name
    SYNOPSIS    Interface name as a quoted string: e.g. "gei3"
    TYPE        char *
    DEFAULT     "gei3"
}

Parameter PTP_BOUNDARY_CLK4_TRANSPORT_LAYER {
    NAME            Transport layer
    SYNOPSIS        Precision time protocol transport layer
    TYPE            int
    DEFAULT         2
}


Parameter PTP_BOUNDARY_CLK4_DELAY_MECHANISM {
    NAME        Delay mechanism
    SYNOPSIS    P2P mode set to TRUE, else for E2E mode set to FALSE.
    TYPE        BOOL
    DEFAULT     TRUE
}

Parameter PTP_BOUNDARY_CLK4_ONE_STEP_MODE {
    NAME        Step mode
    SYNOPSIS    One-Step mode set to TRUE, else for two-Step mode set to FALSE.
    TYPE        BOOL
    DEFAULT     FALSE
}
Parameter PTP_BOUNDARY_CLK4_PRIORITY {
    NAME            Priority   
    SYNOPSIS        Clock priority when configured as master Clock 
    TYPE            int
    DEFAULT         128
}


Parameter PTP_BOUNDARY_CLK4_PDELAY_REQ_INTERVAL {
    NAME            Pdelay request interval
    SYNOPSIS        PTP ordinary clock Pdelay request interval,reciprocal of \
                    N times of power of 2,(1 ~ -4) means (0.5PPS ~ 16PPS)
    TYPE            int
    DEFAULT         0
}

Parameter PTP_BOUNDARY_CLK4_DEBUG_LEVEL {
    NAME            Debug level
    SYNOPSIS        Default debug level config: e.g. 0~6 
    TYPE            int
    DEFAULT         0
}

#endif