enet_mod_tas.h

Go to the documentation of this file.

/*
 *  Copyright (c) Texas Instruments Incorporated 2021
 *
 *  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_TAS_H_
#define ENET_MOD_TAS_H_

/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */

#include <stdint.h>
#include <ti/drv/enet/include/core/enet_mod.h>

#ifdef __cplusplus
extern "C" {
#endif

/* ========================================================================== */
/*                                 Macros                                     */
/* ========================================================================== */

#define ENET_TAS_PUBLIC_IOCTL(x)             (ENET_IOCTL_TYPE_PUBLIC |   \
                                                   ENET_IOCTL_TAS_BASE | \
                                                   ENET_IOCTL_MIN(x))

#define ENET_TAS_GATE_MASK(tc7, tc6, tc5, tc4, tc3, tc2, tc1, tc0)               \
                                            (((((tc7) != 0U) ? 1U : 0U) << 7U) | \
                                             ((((tc6) != 0U) ? 1U : 0U) << 6U) | \
                                             ((((tc5) != 0U) ? 1U : 0U) << 5U) | \
                                             ((((tc4) != 0U) ? 1U : 0U) << 4U) | \
                                             ((((tc3) != 0U) ? 1U : 0U) << 3U) | \
                                             ((((tc2) != 0U) ? 1U : 0U) << 2U) | \
                                             ((((tc1) != 0U) ? 1U : 0U) << 1U) | \
                                             ((((tc0) != 0U) ? 1U : 0U) << 0U))

#define ENET_TAS_MAX_CMD_LISTS               (16)

#define ENET_TAS_MAX_NUM_QUEUES              (8)

#define ENET_TAS_MIN_CYCLE_TIME_NS           (1000000)

#define ENET_TAS_MIN_WINDOW_DURATION_NS      (10000)

/* ========================================================================== */
/*                         Structures and Enums                               */
/* ========================================================================== */

typedef enum EnetTas_Ioctl_e
{
    ENET_TAS_IOCTL_GET_VERSION = ENET_TAS_PUBLIC_IOCTL(0U),

    ENET_TAS_IOCTL_SET_ADMIN_LIST = ENET_TAS_PUBLIC_IOCTL(1U),

    ENET_TAS_IOCTL_GET_OPER_LIST_STATUS = ENET_TAS_PUBLIC_IOCTL(2U),

    ENET_TAS_IOCTL_SET_STATE = ENET_TAS_PUBLIC_IOCTL(3U),

    ENET_TAS_IOCTL_GET_STATE = ENET_TAS_PUBLIC_IOCTL(4U),

    ENET_TAS_IOCTL_GET_ADMIN_LIST = ENET_TAS_PUBLIC_IOCTL(5U),

    ENET_TAS_IOCTL_GET_OPER_LIST = ENET_TAS_PUBLIC_IOCTL(6U),

    ENET_TAS_IOCTL_CONFIG_CHANGE_STATUS_PARAMS = ENET_TAS_PUBLIC_IOCTL(7U),
} EnetTas_Ioctl;

typedef struct EnetTas_GenericInArgs_s
{
    Enet_MacPort macPort;
} EnetTas_GenericInArgs;

typedef enum EnetTas_OperStatus_s
{
    ENET_TAS_OPER_LIST_NOT_YET_UPDATED = 0,

    ENET_TAS_OPER_LIST_UPDATED = 1,
} EnetTas_OperStatus;

typedef enum EnetTas_TasState_s
{
    ENET_TAS_DISABLE = 0,

    ENET_TAS_ENABLE = 1,

    ENET_TAS_RESET = 2,
} EnetTas_TasState;

typedef struct EnetTas_GateCmdEntry_s
{
    uint32_t timeInterval;

    uint8_t gateStateMask;
} EnetTas_GateCmdEntry;

typedef struct EnetTas_MaxSDUTable_s
{
    uint16_t maxSDU[ENET_TAS_MAX_NUM_QUEUES];
} EnetTas_MaxSDUTable;

typedef struct EnetTas_ControlList_s
{
    uint64_t baseTime;

    EnetTas_GateCmdEntry gateCmdList[ENET_TAS_MAX_CMD_LISTS];

    uint64_t cycleTime;

    uint8_t listLength;

    EnetTas_MaxSDUTable sduTable;
} EnetTas_ControlList;

typedef struct EnetTas_ConfigStatus_s
{
    uint64_t configChangeTime;

    uint32_t configChangeErrorCounter;

    uint8_t configPending;

    uint8_t configChange;
} EnetTas_ConfigStatus;

typedef struct EnetTas_SetAdminListInArgs_s
{
    Enet_MacPort macPort;

    EnetTas_ControlList adminList;
} EnetTas_SetAdminListInArgs;

typedef struct EnetTas_SetStateInArgs_s
{
    Enet_MacPort macPort;

    EnetTas_TasState state;
} EnetTas_SetStateInArgs;

/* ========================================================================== */
/*                         Global Variables Declarations                      */
/* ========================================================================== */

/* None */

/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */

/* None */

/* ========================================================================== */
/*                        Deprecated Function Declarations                    */
/* ========================================================================== */

/* None */

/* ========================================================================== */
/*                       Static Function Definitions                          */
/* ========================================================================== */

/* None */

#ifdef __cplusplus
}
#endif

#endif /* ENET_MOD_TAS_H_ */

/* @} */