MCUSW
EthTrcv Configuration

Introduction

This files defines EthTrcv MCAL configuration structures

Variables

struct EthTrcv_ConfigType_s EthTrcvConfig_0_PC
 ETHTRCV Configuration struct declaration. More...
 

Macros

#define ETHTRCV_PRE_COMPILE_VARIANT   (STD_ON)
 ETHTRCV Build Variant. Build variant pre-compile (STD_ON/STD_OFF) More...
 
#define ETHTRCV_AUTONEG_STATUS_WAITCOUNT_TICKS   (0x7d0U)
 EthTrcv auto-negotiation wait count Transceiver delay after auto-negotiation started to auto-negotiation completed. Transceiver (PHY) sets auto-negotiation status bit in status register once it is complete. Depending on Transceiver type, MDIO frequency it will take different time. change count value if transceiver detection fails in auto-negotiation. More...
 
#define ETHTRCV_LINKSTATUS_WAITCOUNT_TICKS   (0x7d0U)
 Wait for link status to become up after configuration. More...
 
#define ETHTRCV_WAKEUPSUPPORT_API   (ETHTRCV_WAKEUP_NOT_SUPPORTED)
 Enable/disable Ethernet transceiver EthTrcvWakeUpSupport APIs. More...
 
#define ETHTRCV_SETTRANSCEIVERMODE_API   (STD_ON)
 Enable/disable Ethernet transceiver settransceivermode API. More...
 
#define ETHTRCV_GETTRANSCEIVERMODE_API   (STD_ON)
 Enable/disable Ethernet transceiver gettransceivermodeapi API. More...
 
#define ETHTRCV_STARTAUTONEGOTIATION_API   (STD_ON)
 Enable/disable Ethernet transceiver startautonegotiation API. More...
 
#define ETHTRCV_GETLINKSTATE_API   (STD_ON)
 Enable/disable Ethernet transceiver getlinkstate API. More...
 
#define ETHTRCV_GETBAUDRATE_API   (STD_ON)
 Enable/disable Ethernet transceiver getbaudrate API. More...
 
#define ETHTRCV_GETDUPLEXMODE_API   (STD_ON)
 Enable/disable Ethernet transceiver getduplexmode API. More...
 
#define ETHTRCV_OS_COUNTER_ID   ((CounterType)OsCounter_0)
 Counter ID for counter used to count wait ticks. More...
 
#define ETHTRCV_TIMEOUT_DURATION   (160000U)
 ETH timeout. More...
 
#define ETHTRCV_DRV_CONFIG_0   ((const EthTrcv_ConfigType *) &EthTrcvConfig_0_PC)
 

EthTrcv Driver Service Id

The Service Id is one of the argument to Det_ReportError function and is used to identify the source of the error

#define ETHTRCV_INIT_ID   ((uint8) 0x01U)
 EthTrcv_Init() API Service ID. More...
 
#define ETHTRCV_CONTROLLER_INIT_ID   ((uint8) 0x02U)
 EthTrcv_Init() API Service ID. More...
 
#define ETHTRCV_SETTRCVMODE_ID   ((uint8) 0x03U)
 EthTrcv_SetTransceiverMode() API Service ID. More...
 
#define ETHTRCV_GETTRCVMODE_ID   ((uint8) 0x04U)
 EthTrcv_GetTransceiverMode() API Service ID. More...
 
#define ETHTRCV_SRTAUTONEGOTIA_ID   ((uint8) 0x05U)
 EthTrcv_StartAutoNegotiation() API Service ID. More...
 
#define ETHTRCV_GETLNKSTATE_ID   ((uint8) 0x06U)
 EthTrcv_GetLinkState() API Service ID. More...
 
#define ETHTRCV_GETBAUD_ID   ((uint8) 0x07U)
 EthTrcv_GetBaudRate() API Service ID. More...
 
#define ETHTRCV_GETDPLXMODE_ID   ((uint8) 0x08U)
 EthTrcv_GetDuplexMode() API Service ID. More...
 
#define ETHTRCV_READMIIIND_ID   ((uint8) 0x09U)
 EthTrcv_ReadMiiIndication callback() API Service ID. More...
 
#define ETHTRCV_WRITEMIIIND_ID   ((uint8) 0x0AU)
 EthTrcv_WriteMiiIndication callback() API Service ID. More...
 
#define ETHTRCV_VERSION_ID   ((uint8) 0x0BU)
 EthTrcv_GetVersionInfo() API Service ID. More...
 
#define ETHTRCV_MAINFCT_WRITE_ID   ((uint8) 0x0CU)
 EthTrcv_MainFunction() API Service ID. More...
 
#define ETHTRCV_GETTRCVWKUPMODE_ID   ((uint8) 0x0DU)
 EthTrcv_GetTransceiverWakeupMode() API Service ID. More...
 
#define ETHTRCV_SETTRCVWKUPMODE_ID   ((uint8) 0x0EU)
 EthTrcv_SetTransceiverWakeupMode() API Service ID. More...
 
#define ETHTRCV_CHKWKUP_ID   ((uint8) 0x0FU)
 EthTrcv_CheckWakeup() API Service ID. More...
 
#define ETHTRCV_SETPHYTESTMODE_ID   ((uint8) 0x10U)
 EthTrcv_SetPhyTestMode() API Service ID. More...
 
#define ETHTRCV_SETPHYLOOPBACKMODE_ID   ((uint8) 0x11U)
 EthTrcv_SetPhyLoopbackMode() API Service ID. More...
 
#define ETHTRCV_GETPHYSIGNALQUALITY_ID   ((uint8) 0x12U)
 EthTrcv_GetPhySignalQuality() API Service ID. More...
 
#define ETHTRCV_SETPHYTXMODE_ID   ((uint8) 0x13U)
 EthTrcv_SetPhyTxMode() API Service ID. More...
 
#define ETHTRCV_GETCABLEDIAGNOSTICSRESULT_ID   ((uint8) 0x014U)
 EthTrcv_GetCableDiagnosticsResult() API Service ID. More...
 
#define ETHTRCV_GETPHYIDENTIFIER_ID   ((uint8) 0x015U)
 EthTrcv_GetPhyIdentifier() API Service ID. More...
 

EthTrcv Driver Configuration SW Version Info

Pre-compile switches for enabling/disabling ETHTRCV MCAL APIs

#define ETHTRCV_VERSION_INFO_API   (STD_ON)/** \brief Enable/Disable DEV error detection */
 Enable/Disable EthTrcv_GetVersionInfo() More...
 
#define ETHTRCV_DEV_ERROR_DETECT   (STD_ON)/* @} */
 
#define ETHTRCV_MAX_CONTROLLER   (2U)
 EthTrcv max number of controllers. More...
 
#define ETHTRCV_MAX_CONTROLLER_CFGS   (2U)
 EthTrcv max number of configurations. More...
 

EthTrcv Controller names

Symbolic names for the EthTrcvControllerId.

#define ETHTRCV_CONTROLLER_ID_0   (0U)
 

EthTrcv Transceiver names

Symbolic names for the EthTrcv.

#define ETHTRCV_CONTROLLER_ID_0_TRCV_ID_0   (0U)
 

ETHTRCV DEM Error codes to report

Pre-compile switches for enabling/disabling DEM events

#define DemConf_DemEventParameter_ETHTRCV_DEM_NO_EVENT   (0xFFFFU)
 
#define ETHTRCV_DEM_NO_EVENT   DemConf_DemEventParameter_ETHTRCV_DEM_NO_EVENT
 
#define ETHTRCV_E_HARDWARE_ERROR   (ETHTRCV_DEM_NO_EVENT)
 Hardware failed. More...
 
#define ETHTRCV_E_ACCESS   (ETHTRCV_DEM_NO_EVENT)
 Hardware failed. More...
 

Macro Definition Documentation

◆ ETHTRCV_INIT_ID

#define ETHTRCV_INIT_ID   ((uint8) 0x01U)

EthTrcv_Init() API Service ID.

◆ ETHTRCV_CONTROLLER_INIT_ID

#define ETHTRCV_CONTROLLER_INIT_ID   ((uint8) 0x02U)

EthTrcv_Init() API Service ID.

◆ ETHTRCV_SETTRCVMODE_ID

#define ETHTRCV_SETTRCVMODE_ID   ((uint8) 0x03U)

◆ ETHTRCV_GETTRCVMODE_ID

#define ETHTRCV_GETTRCVMODE_ID   ((uint8) 0x04U)

◆ ETHTRCV_SRTAUTONEGOTIA_ID

#define ETHTRCV_SRTAUTONEGOTIA_ID   ((uint8) 0x05U)

◆ ETHTRCV_GETLNKSTATE_ID

#define ETHTRCV_GETLNKSTATE_ID   ((uint8) 0x06U)

EthTrcv_GetLinkState() API Service ID.

◆ ETHTRCV_GETBAUD_ID

#define ETHTRCV_GETBAUD_ID   ((uint8) 0x07U)

EthTrcv_GetBaudRate() API Service ID.

◆ ETHTRCV_GETDPLXMODE_ID

#define ETHTRCV_GETDPLXMODE_ID   ((uint8) 0x08U)

EthTrcv_GetDuplexMode() API Service ID.

◆ ETHTRCV_READMIIIND_ID

#define ETHTRCV_READMIIIND_ID   ((uint8) 0x09U)

EthTrcv_ReadMiiIndication callback() API Service ID.

◆ ETHTRCV_WRITEMIIIND_ID

#define ETHTRCV_WRITEMIIIND_ID   ((uint8) 0x0AU)

EthTrcv_WriteMiiIndication callback() API Service ID.

◆ ETHTRCV_VERSION_ID

#define ETHTRCV_VERSION_ID   ((uint8) 0x0BU)

EthTrcv_GetVersionInfo() API Service ID.

◆ ETHTRCV_MAINFCT_WRITE_ID

#define ETHTRCV_MAINFCT_WRITE_ID   ((uint8) 0x0CU)

EthTrcv_MainFunction() API Service ID.

◆ ETHTRCV_GETTRCVWKUPMODE_ID

#define ETHTRCV_GETTRCVWKUPMODE_ID   ((uint8) 0x0DU)

EthTrcv_GetTransceiverWakeupMode() API Service ID.

◆ ETHTRCV_SETTRCVWKUPMODE_ID

#define ETHTRCV_SETTRCVWKUPMODE_ID   ((uint8) 0x0EU)

EthTrcv_SetTransceiverWakeupMode() API Service ID.

◆ ETHTRCV_CHKWKUP_ID

#define ETHTRCV_CHKWKUP_ID   ((uint8) 0x0FU)

EthTrcv_CheckWakeup() API Service ID.

◆ ETHTRCV_SETPHYTESTMODE_ID

#define ETHTRCV_SETPHYTESTMODE_ID   ((uint8) 0x10U)

EthTrcv_SetPhyTestMode() API Service ID.

◆ ETHTRCV_SETPHYLOOPBACKMODE_ID

#define ETHTRCV_SETPHYLOOPBACKMODE_ID   ((uint8) 0x11U)

◆ ETHTRCV_GETPHYSIGNALQUALITY_ID

#define ETHTRCV_GETPHYSIGNALQUALITY_ID   ((uint8) 0x12U)

◆ ETHTRCV_SETPHYTXMODE_ID

#define ETHTRCV_SETPHYTXMODE_ID   ((uint8) 0x13U)

EthTrcv_SetPhyTxMode() API Service ID.

◆ ETHTRCV_GETCABLEDIAGNOSTICSRESULT_ID

#define ETHTRCV_GETCABLEDIAGNOSTICSRESULT_ID   ((uint8) 0x014U)

◆ ETHTRCV_GETPHYIDENTIFIER_ID

#define ETHTRCV_GETPHYIDENTIFIER_ID   ((uint8) 0x015U)

EthTrcv_GetPhyIdentifier() API Service ID.

◆ ETHTRCV_PRE_COMPILE_VARIANT

#define ETHTRCV_PRE_COMPILE_VARIANT   (STD_ON)

ETHTRCV Build Variant. Build variant pre-compile (STD_ON/STD_OFF)

◆ ETHTRCV_VERSION_INFO_API

#define ETHTRCV_VERSION_INFO_API   (STD_ON)/** \brief Enable/Disable DEV error detection */

Enable/Disable EthTrcv_GetVersionInfo()

◆ ETHTRCV_DEV_ERROR_DETECT

#define ETHTRCV_DEV_ERROR_DETECT   (STD_ON)/* @} */

◆ ETHTRCV_MAX_CONTROLLER

#define ETHTRCV_MAX_CONTROLLER   (2U)

EthTrcv max number of controllers.

◆ ETHTRCV_MAX_CONTROLLER_CFGS

#define ETHTRCV_MAX_CONTROLLER_CFGS   (2U)

EthTrcv max number of configurations.

◆ ETHTRCV_CONTROLLER_ID_0

#define ETHTRCV_CONTROLLER_ID_0   (0U)

◆ ETHTRCV_CONTROLLER_ID_0_TRCV_ID_0

#define ETHTRCV_CONTROLLER_ID_0_TRCV_ID_0   (0U)

◆ ETHTRCV_AUTONEG_STATUS_WAITCOUNT_TICKS

#define ETHTRCV_AUTONEG_STATUS_WAITCOUNT_TICKS   (0x7d0U)

EthTrcv auto-negotiation wait count Transceiver delay after auto-negotiation started to auto-negotiation completed. Transceiver (PHY) sets auto-negotiation status bit in status register once it is complete. Depending on Transceiver type, MDIO frequency it will take different time. change count value if transceiver detection fails in auto-negotiation.

◆ ETHTRCV_LINKSTATUS_WAITCOUNT_TICKS

#define ETHTRCV_LINKSTATUS_WAITCOUNT_TICKS   (0x7d0U)

Wait for link status to become up after configuration.

◆ ETHTRCV_WAKEUPSUPPORT_API

#define ETHTRCV_WAKEUPSUPPORT_API   (ETHTRCV_WAKEUP_NOT_SUPPORTED)

Enable/disable Ethernet transceiver EthTrcvWakeUpSupport APIs.

◆ ETHTRCV_SETTRANSCEIVERMODE_API

#define ETHTRCV_SETTRANSCEIVERMODE_API   (STD_ON)

Enable/disable Ethernet transceiver settransceivermode API.

◆ ETHTRCV_GETTRANSCEIVERMODE_API

#define ETHTRCV_GETTRANSCEIVERMODE_API   (STD_ON)

Enable/disable Ethernet transceiver gettransceivermodeapi API.

◆ ETHTRCV_STARTAUTONEGOTIATION_API

#define ETHTRCV_STARTAUTONEGOTIATION_API   (STD_ON)

Enable/disable Ethernet transceiver startautonegotiation API.

◆ ETHTRCV_GETLINKSTATE_API

#define ETHTRCV_GETLINKSTATE_API   (STD_ON)

Enable/disable Ethernet transceiver getlinkstate API.

◆ ETHTRCV_GETBAUDRATE_API

#define ETHTRCV_GETBAUDRATE_API   (STD_ON)

Enable/disable Ethernet transceiver getbaudrate API.

◆ ETHTRCV_GETDUPLEXMODE_API

#define ETHTRCV_GETDUPLEXMODE_API   (STD_ON)

Enable/disable Ethernet transceiver getduplexmode API.

◆ ETHTRCV_OS_COUNTER_ID

#define ETHTRCV_OS_COUNTER_ID   ((CounterType)OsCounter_0)

Counter ID for counter used to count wait ticks.

◆ ETHTRCV_TIMEOUT_DURATION

#define ETHTRCV_TIMEOUT_DURATION   (160000U)

ETH timeout.

◆ DemConf_DemEventParameter_ETHTRCV_DEM_NO_EVENT

#define DemConf_DemEventParameter_ETHTRCV_DEM_NO_EVENT   (0xFFFFU)

◆ ETHTRCV_DEM_NO_EVENT

#define ETHTRCV_DEM_NO_EVENT   DemConf_DemEventParameter_ETHTRCV_DEM_NO_EVENT

◆ ETHTRCV_E_HARDWARE_ERROR

#define ETHTRCV_E_HARDWARE_ERROR   (ETHTRCV_DEM_NO_EVENT)

Hardware failed.

◆ ETHTRCV_E_ACCESS

#define ETHTRCV_E_ACCESS   (ETHTRCV_DEM_NO_EVENT)

Hardware failed.

◆ ETHTRCV_DRV_CONFIG_0

#define ETHTRCV_DRV_CONFIG_0   ((const EthTrcv_ConfigType *) &EthTrcvConfig_0_PC)

Variable Documentation

◆ EthTrcvConfig_0_PC

struct EthTrcv_ConfigType_s EthTrcvConfig_0_PC

ETHTRCV Configuration struct declaration.

Configuration of the driver