Eth.h File Reference

Introduction

This file contains the interface of the Ethernet driver.

Go to the source code of this file.

Macros
Eth Driver Module SW Version Info
Definitions for the Eth Driver version used for compatibility checks
#define	ETH_SW_MAJOR_VERSION   (0U)
	Driver Implementation Major Version. More...
#define	ETH_SW_MINOR_VERSION   (1U)
	Driver Implementation Minor Version. More...
#define	ETH_SW_PATCH_VERSION   (0U)
	Driver Implementation Patch Version. More...
Eth Driver Module AUTOSAR Version Info
Definitions for the Etj Driver AUTOSAR version used for compatibility checks
#define	ETH_AR_RELEASE_MAJOR_VERSION   (4U)
	AUTOSAR Major version specification implemented by Eth Driver. More...
#define	ETH_AR_RELEASE_MINOR_VERSION   (2U)
	AUTOSAR Minor version specification implemented by Eth Driver. More...
#define	ETH_AR_RELEASE_REVISION_VERSION   (1U)
	AUTOSAR Patch version specification implemented by Eth Driver. More...
Eth Driver ID Info
#define	ETH_VENDOR_ID   ((uint16) 44U)
	Texas Instruments Vendor ID. More...
#define	ETH_MODULE_ID   ((uint16) 88U)
	Eth Driver Module ID. More...
#define	ETH_INSTANCE_ID   ((uint8) 0U)
	Eth Driver Instance ID. More...
Eth Controller names
Symbolic names for the EthControllerId. Only one controller is supported.
#define	ETH_CONTROLLER_ID_0   (0U)
	Eth controller ID 0. More...
Eth Error Codes
Error codes returned by Eth functions
#define	ETH_E_INV_CTRL_IDX   ((uint8) 0x01U)
	Invalid controller index. More...
#define	ETH_E_NOT_INITIALIZED   ((uint8) 0x02U)
	Eth module or controller was not initialized. More...
#define	ETH_E_PARAM_POINTER   ((uint8) 0x03U)
	Invalid pointer in parameter list. More...
#define	ETH_E_INV_PARAM   ((uint8) 0x04U)
	Invalid parameter. More...
#define	ETH_E_INIT_FAILED   ((uint8) 0x05U)
	Initialization failure. More...
#define	ETH_E_INV_MODE   ((uint8) 0x06U)
	Invalid mode. More...
Eth Service Ids
The Service Id is used to identify the source of an error when reported through the Det_ReportError() function.
#define	ETH_SID_INIT   ((uint8) 0x01U)
	Eth_Init() API Service ID. More...
#define	ETH_SID_CONTROLLER_INIT   ((uint8) 0x02U)
	Eth_ControllerInit() API Service ID. More...
#define	ETH_SID_SET_CONTROLLER_MODE   ((uint8) 0x03U)
	Eth_SetControllerMode() API Service ID. More...
#define	ETH_SID_GET_CONTROLLER_MODE   ((uint8) 0x04U)
	Eth_GetControllerMode() API Service ID. More...
#define	ETH_SID_WRITE_MII   ((uint8) 0x05U)
	Eth_WriteMii() API Service ID. More...
#define	ETH_SID_READ_MII   ((uint8) 0x06U)
	Eth_ReadMii() API Service ID. More...
#define	ETH_SID_GET_PHYS_ADDR   ((uint8) 0x08U)
	Eth_GetPhysAddr() API Service ID. More...
#define	ETH_SID_PROVIDE_TX_BUFFER   ((uint8) 0x09U)
	Eth_ProvideTxBuffer() API Service ID. More...
#define	ETH_SID_MAIN_FUNCTION   ((uint8) 0x0AU)
	Eth_MainFunction() API Service ID. More...
#define	ETH_SID_TRANSMIT   ((uint8) 0x0AU)
	Eth_Transmit() API Service ID. More...
#define	ETH_SID_RECEIVE   ((uint8) 0x0BU)
	Eth_Receive() API Service ID. More...
#define	ETH_SID_TX_CONFIRMATION   ((uint8) 0x0CU)
	Eth_TxConfirmation() API Service ID. More...
#define	ETH_SID_GET_VERSION_INFO   ((uint8) 0x0DU)
	Eth_GetVersionInfo() API Service ID. More...
#define	ETH_SID_RX_IRQ_HDLR   ((uint8) 0x10U)
	Eth_RxIrqHdlr_<CtrlIdx>() API Service ID. More...
#define	ETH_SID_TX_IRQ_HDLR   ((uint8) 0x11U)
	Eth_TxIrqHdlr_<CtrlIdx>() API Service ID. More...
#define	ETH_SID_UPDATE_PHYS_ADDR_FILTER   ((uint8) 0x12U)
	Eth_UpdatePhysAddrFilter() API Service ID. More...
#define	ETH_SID_SET_PHYS_ADDR   ((uint8) 0x13U)
	Eth_SetPhysAddr() API Service ID. More...
#define	ETH_SID_GET_DROP_COUNT   ((uint8) 0x14U)
	Eth_GetDropCount() API Service ID. More...
#define	ETH_SID_GET_ETHER_STATS   ((uint8) 0x15U)
	Eth_GetEtherStats() API Service ID. More...
#define	ETH_SID_GET_CURRENT_TIME   ((uint8) 0x16U)
	Eth_GetCurrentTime() API Service ID. More...
#define	ETH_SID_ENABLE_EGRESS_TIMESTAMP   ((uint8) 0x17U)
	Eth_EnableEgressTimeStamp() API Service ID. More...
#define	ETH_SID_GET_EGRESS_TIMESTAMP   ((uint8) 0x18U)
	Eth_GetEgressTimeStamp() API Service ID. More...
#define	ETH_SID_GET_INGRESS_TIMESTAMP   ((uint8) 0x19U)
	Eth_GetIngressTimeStamp() API Service ID. More...
#define	ETH_SID_SET_CORRECTION_TIME   ((uint8) 0x1AU)
	Eth_SetCorrectionTime() API Service ID. More...
#define	ETH_SID_SET_GLOBAL_TIME   ((uint8) 0x1BU)
	Eth_SetGlobalTime() API Service ID. More...

Functions
void	Eth_Init (const Eth_ConfigType *CfgPtr)
	This function initializes the driver. More...
Std_ReturnType	Eth_ControllerInit (uint8 CtrlIdx, uint8 CfgIdx)
	This function initializes the indexed controller. More...
Std_ReturnType	Eth_SetControllerMode (uint8 CtrlIdx, Eth_ModeType CtrlMode)
	This function enables / disables the indexed controller. More...
Std_ReturnType	Eth_GetControllerMode (uint8 CtrlIdx, Eth_ModeType *CtrlModePtr)
	This function obtains the state of the indexed controller. More...
void	Eth_GetPhysAddr (uint8 CtrlIdx, uint8 *PhysAddrPtr)
	This function obtains the physical source address used by the indexed controller. More...
void	Eth_SetPhysAddr (uint8 CtrlIdx, const uint8 *PhysAddrPtr)
	This function sets the physical source address used by the indexed controller. More...
Std_ReturnType	Eth_UpdatePhysAddrFilter (uint8 CtrlIdx, uint8 *PhysAddrPtr, Eth_FilterActionType Action)
	This function updates the physical source address to / from the indexed controller filter. More...
Std_ReturnType	Eth_WriteMii (uint8 CtrlIdx, uint8 TrcvIdx, uint8 RegIdx, uint16 RegVal)
	This function configures a transceiver register or triggers a function offered by the receiver Service. More...
Std_ReturnType	Eth_ReadMii (uint8 CtrlIdx, uint8 TrcvIdx, uint8 RegIdx, uint16 *RegValPtr)
	This function reads a transceiver register. More...
Std_ReturnType	Eth_GetDropCount (uint8 CtrlIdx, uint8 CountValues, uint32 *DropCount)
	This function reads a list with drop counter values of the corresponding controller. More...
Std_ReturnType	Eth_GetEtherStats (uint8 CtrlIdx, uint32 *etherStats)
	This function reads a list with statistics values of the corresponding controller. More...
Std_ReturnType	Eth_GetCurrentTime (uint8 CtrlIdx, Eth_TimeStampQualType *timeQualPtr, Eth_TimeStampType *timeStampPtr)
	This function returns a time value out of the HW registers. More...
void	Eth_EnableEgressTimeStamp (uint8 CtrlIdx, uint8 BufIdx)
	This function activates egress time stamping on a dedicated message object. More...
void	Eth_GetEgressTimeStamp (uint8 CtrlIdx, uint8 BufIdx, Eth_TimeStampQualType *timeQualPtr, Eth_TimeStampType *timeStampPtr)
	This function reads back the egress time stamp on a dedicated message object. More...
void	Eth_GetIngressTimeStamp (uint8 CtrlIdx, Eth_DataType *DataPtr, Eth_TimeStampQualType *timeQualPtr, Eth_TimeStampType *timeStampPtr)
	This function reads back the ingress time stamp on a dedicated message object. More...
void	Eth_SetCorrectionTime (uint8 CtrlIdx, Eth_TimeIntDiffType *timeOffsetPtr, Eth_RateRatioType *rateRatioPtr)
	This function allows the Time Slave to adjust the local ETH Reference clock in HW. More...
Std_ReturnType	Eth_SetGlobalTime (uint8 CtrlIdx, Eth_TimeStampType *timeStampPtr)
	This function allows the Time Master to adjust the global ETH Reference clock in HW. More...
BufReq_ReturnType	Eth_ProvideTxBuffer (uint8 CtrlIdx, Eth_BufIdxType *BufIdxPtr, uint8 **BufPtr, uint16 *LenBytePtr)
	This function provides access to a transmit buffer of the specified controller. More...
Std_ReturnType	Eth_Transmit (uint8 CtrlIdx, Eth_BufIdxType BufIdx, Eth_FrameType FrameType, boolean TxConfirmation, uint16 LenByte, uint8 *PhysAddrPtr)
	This function triggers transmission of a previously filled transmit buffer. More...
void	Eth_Receive (uint8 CtrlIdx, Eth_RxStatusType *RxStatusPtr)
	This function triggers frame reception. More...
void	Eth_TxConfirmation (uint8 CtrlIdx)
	This function triggers frame transmission confirmation. More...
void	Eth_GetVersionInfo (Std_VersionInfoType *VersionInfo)
	Function returns the version information of this module. More...
void	Eth_MainFunction (void)
	The function checks for controller errors and lost frames. Used for polling state changes. Calls EthIf_CtrlModeIndication when the controller mode changed. More...