Introduction

Data Structures
struct	EnetTas_GenericInArgs
	Generic input args. More...

struct	EnetTas_GateCmdEntry
	Gate control list. See IEEE Std 802.1Q-2018 8.6.8.4. More...

struct	EnetTas_MaxSDUTable
	Max SDU table. See IEEE Std 802.1Q-2018 12.29.1.1. More...

struct	EnetTas_ControlList
	Gate control list. See IEEE Std 802.1Q-2018 8.6.9.4 D3-1. More...

struct	EnetTas_ConfigStatus
	Config state machine variables. See IEEE Std 802.1Q-2018 8.6.8.4. More...

struct	EnetTas_SetAdminListInArgs
	Input args for ENET_TAS_IOCTL_SET_ADMIN_LIST commands. More...

struct	EnetTas_SetStateInArgs
	Input args for ENET_TAS_IOCTL_SET_STATE commands. More...

Enumerations
enum	EnetTas_Ioctl { 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) }
	TAS module IOCTL commands. More...

enum	EnetTas_OperStatus { TAS_OPER_LIST_NOT_YET_UPDATED = 0, TAS_OPER_LIST_UPDATED = 1 }
	ICSSG TAS state types. More...

enum	EnetTas_TasState { TAS_DISABLE = 0, TAS_ENABLE = 1, TAS_RESET = 2 }
	TAS state types. More...

Macros
#define	ENET_TAS_PUBLIC_IOCTL(x)
	Helper macro to create IOCTL commands for TAS module. More...

#define	ENET_TAS_MAX_CMD_LISTS (16)
	Maximum number of gate command entries in each list. More...

#define	ENET_TAS_MAX_NUM_QUEUES (8)
	Maximum number of transmit queues supported by implementation. More...

#define	ENET_TAS_MIN_CYCLE_TIME_NS (1000000)
	Minimum cycle time supported by implementation (in ns). More...

#define	ENET_TAS_MIN_WINDOW_DURATION_NS (10000)
	Minimum TAS window duration supported by implementation (in ns). More...

Macro Definition Documentation

◆ ENET_TAS_PUBLIC_IOCTL

#define ENET_TAS_PUBLIC_IOCTL ( x )

Value:

                                                   (ENET_IOCTL_TYPE_PUBLIC |   \
                                                   ENET_IOCTL_TAS_BASE | \
                                                   ENET_IOCTL_MIN(x))

Helper macro to create IOCTL commands for TAS module.

◆ ENET_TAS_MAX_CMD_LISTS

#define ENET_TAS_MAX_CMD_LISTS (16)

Maximum number of gate command entries in each list.

◆ ENET_TAS_MAX_NUM_QUEUES

#define ENET_TAS_MAX_NUM_QUEUES (8)

Maximum number of transmit queues supported by implementation.

◆ ENET_TAS_MIN_CYCLE_TIME_NS

#define ENET_TAS_MIN_CYCLE_TIME_NS (1000000)

Minimum cycle time supported by implementation (in ns).

◆ ENET_TAS_MIN_WINDOW_DURATION_NS

#define ENET_TAS_MIN_WINDOW_DURATION_NS (10000)

Minimum TAS window duration supported by implementation (in ns).

Enumeration Type Documentation

◆ EnetTas_Ioctl

enum EnetTas_Ioctl

TAS module IOCTL commands.

Enumerator
ENET_TAS_IOCTL_GET_VERSION	Get the hardware version of the TAS module. IOCTL parameters: inArgs: None outArgs: Enet_Version Type: Synchronous.
ENET_TAS_IOCTL_SET_ADMIN_LIST	Set the admin list parameters of the TAS module. IOCTL parameters: inArgs: EnetTas_SetAdminListInArgs outArgs: None Type: Asynchronous.
ENET_TAS_IOCTL_GET_OPER_LIST_STATUS	Get the status of the operational list update. This IOCTL should be called after ENET_TAS_IOCTL_SET_ADMIN_LIST to verify Admin list to operational list copy at specified time. This IOCTL should be called until TAS_OPER_LIST_UPDATED received as output IOCTL parameters: inArgs: EnetTas_GenericInArgs outArgs: EnetTas_OperStatus Type: Synchronous.
ENET_TAS_IOCTL_SET_STATE	Set the State of the TAS module. IOCTL parameters: inArgs: EnetTas_SetStateInArgs outArgs: None Type: Asynchronous.
ENET_TAS_IOCTL_GET_STATE	Get the State of the TAS module. IOCTL parameters: inArgs: EnetTas_GenericInArgs outArgs: EnetTas_TasState Type: Synchronous.
ENET_TAS_IOCTL_GET_ADMIN_LIST	Get the admin list parameters of the TAS module. IOCTL parameters: inArgs: EnetTas_GenericInArgs outArgs: EnetTas_ControlList Type: Synchronous.
ENET_TAS_IOCTL_GET_OPER_LIST	Get the operational list parameters of the TAS module. IOCTL parameters: inArgs: EnetTas_GenericInArgs outArgs: EnetTas_ControlList Type: Synchronous.
ENET_TAS_IOCTL_CONFIG_CHANGE_STATUS_PARAMS	Get the TAS config change status parameters. IOCTL parameters: inArgs: EnetTas_GenericInArgs outArgs: EnetTas_ConfigStatus Type: Synchronous.

◆ EnetTas_OperStatus

enum EnetTas_OperStatus

ICSSG TAS state types.

Enumerator
TAS_OPER_LIST_NOT_YET_UPDATED	Operational list is not yet updated.
TAS_OPER_LIST_UPDATED	Operational list is updated.

◆ EnetTas_TasState

enum EnetTas_TasState

TAS state types.

Enumerator
TAS_DISABLE	Idle.
TAS_ENABLE	Enable TAS.
TAS_RESET	Reset the state machine.