Ethernet Transceiver Driver (EthTrcv)

Initializes the Ethernet Transceiver Driver

Enables / disables the indexed transceiver

Obtains the state of the indexed transceiver

Restarts the negotiation of the transmission parameters used by the indexed transceiver

Obtains the link state of the indexed transceiver

Obtains the baud rate of the indexed transceiver

Obtains the duplex mode of the indexed transceiver

Returns the version information of this module

Used for polling state changes and wakeup reasons. Calls EthIf_TrcvModeIndication when the transceiver mode changed. Stores wakeup events if EthTrcvWakeUpSupport is set to ETHTRCV_WAKEUP_BY_POLLING.

Called when information has been read out via MII interface. Triggered by previous Eth_Read Mii call. Can directly be called within Eth_ReadMii.

Called when information has been written via MII interface. Triggered by previous Eth_WriteMii call. Can directly be called within Eth_WriteMii.

Enables / di sables the wake - up mode or clear the wake - up reason of the indexed transceiver Tags: atp.Status=obsolete

Returns the wake up mode of t he indexed transceiver Tags: atp.Status=obsolete

Service is called by EthIf in case a wake-up interrupt is detected.

Indicates an wake-up request for the specified Ethernet Transceiver. The given TrcvMode indicates if the request is based on a remote request from the network (ETH_MODE_ACTIVE) or if the request is based on active user request (ETH_MODE_ACTIVE_WITH_WAKEUP_ REQUEST). The callback function Ccan be used to trigger integrator code that initiates a remote wake-up .(e.g. trigger a wake-up line for an active user request).

Obtains the current signal quality of the link of the indexed transceiver

Activates a given test mode.

Activates a given loopback mode.

Activates a given transmission mode.

Retrieves the cable diagnostics result of a given transceiver.

Obtains the PHY identifier of the Ethernet Transceiver according to IEEE 802.3-2015 chapter 22.2.4.3.1 PHY Identifer.

Trigger the cable diagnostics for the given Ethernet transceiver.

This function returns the least recent wakeup reasons.

Obtains the media access mode of the transceiver when EthTrcvDuplexMode is configured as ETHTRCV_DUPLEX_MODE_HALF

Request the given link state for the given transceiver

Requests the Ethernet Transceiver to update the SecY/PAC of the PHY with the provided parameters. A Transmission Secure Channel with the provided SCI shall be configured during the first call. A pointer to a MACsec Basic Parameters Configuration file shall be provided to create the Secure Channel. Tags: atp.Status=DRAFT

Requests the Ethernet Transceiver Driver to configure a Reception Secure Channel for the given Secure Channel Identifier. Tags: atp.Status=DRAFT

Requests the Ethernet Transceiver Driver to reset to default the MACsec values of the Reception Secure Channel for the given Secure Channel Identifier. Tags: atp.Status=DRAFT

Requests the Ethernet Transceiver Driver to update the Transmission Secure Association with the given Packet Number. The Active parameter is included to change the specified AN status. Tags: atp.Status=DRAFT

Requests the Ethernet Transceiver Driver to create a Transmission Secure Association in the Transceiver. The Short Secure Channel Identifier is included to support XPN configurations. Tags: atp.Status=DRAFT

Request the Ethernet Transceiver Driver to remove the Transmission Secure Association identified by the provided Association Number. Tags: atp.Status=DRAFT

Request the Ethernet Transceiver Driver to create a Reception Secure Association in the Transceiver. The Short Secure Channel Identifier is included to support XPN configurations. Tags: atp.Status=DRAFT

Request the Ethernet Transceiver Driver to update the Reception Secure Association with the given Packet Number. The Active parameter is included to change the specified AN status. Tags: atp.Status=DRAFT

Request the Ethernet Transceiver Driver to remove the Reception Secure Association identified by the provided Association Number. Tags: atp.Status=DRAFT

Request the Ethernet Transceiver Driver to return the Packet Number that is used for the next packet in the given Transmission Secure Association. Tags: atp.Status=DRAFT

Request the Ethernet Transceiver Driver to provide MACsec statistics. Tags: atp.Status=DRAFT

Requests to set the Controlled Port enabled parameter of a PAE. Tags: atp.Status=DRAFT

Requests the Ethernet Transceiver to update the SecY/PAC of the PHY with the provided parameters. A Transmission Secure Channel with the provided SCI shall be configured during the first call. A pointer to a MACsec Basic Parameters Configuration file shall be provided to create the Secure Channel. Tags: atp.Status=DRAFT

Requests the Ethernet Transceiver Driver to create a Transmission Secure Association in the Transceiver. The Short Secure Channel Identifier is included to support XPN configurations. Tags: atp.Status=DRAFT

Request the Ethernet Transceiver Driver to create a Reception Secure Association in the Transceiver. The Short Secure Channel Identifier is included to support XPN configurations. Tags: atp.Status=DRAFT

Request the Ethernet Transceiver Driver to provide MACsec statistics. Tags: atp.Status=DRAFT

Implementation specific structure of the post build configuration

This type defines the Ethernet link state. The link state changes after an Ethernet cable gets plugged in and the transceivers on both ends negotiated the transmission parameters (i.e. baud rate and duplex mode)

Status supervision used for Development Error Detection. The state shall be available for debugging.

This type defines the Ethernet baud rate. The baud rate gets either negotiated between the connected transceivers or has to be configured.

This type defines the Ethernet duplex mode. The duplex mode gets either negotiated between the connected transceivers or has to be configured.

This type controls the transceiver wake up modes and/ or clears the wake - up reason. Tags: atp.Status=obsolete

This type defines the transceiver wake up reasons.

Describes the possible PHY test modes

Describes the possible PHY loopback modes

Describes the possible PHY transmit modes

Describes the results of the cable diagnostics.

This type defines the media access control type in half duplex. If ETHTRCV_MAC_TYPE_PLCA is configured, PLCA is supported and the parameters listed in ECUC_EthTrcv_00055 have to be configured. Tags: atp.Status=draft

The Ethernet Transceiver Driver is using a zero-based in- dex to abstract the access for upper software layers. The parameter EthTrcvCtrlIdx [ECUC_EthTrcv_00014] within configuration corresponds to parameter TrcvIdx used in the APIs.

The Ethernet Transceiver Driver module shall support pre- compile time, link time and post-build time configuration.

The header file EthTrcv.h shall include a software and speci- fication version number.

The Ethernet Transceiver Driver module shall perform a con- sistency check between code files and header files based on pre-process-checking the version numbers of related code files and header files.

In case development error detection is enabled for the Eth- ernet Transceiver Driver module: The Ethernet Transceiver Driver module shall check API parameters for validity and report detected errors to the DET.

The Ethernet Transceiver Driver module shall implement the API functions specified by the Ethernet Transceiver Driver SWS as real C-code func- tions and shall not implement the API as macros for object code deliveries.

None of the Ethernet Transceiver Driver module header files shall define global variables.

The Ethernet Transceiver Driver module shall provide an XML file that contains the data, which is required for the SW identification (it shall contain the vendor identification, module ID and software version information), configuration and integration process. This file should describe vendor specific configuration parameters as well as it should contain recommended configuration parameter values.

of the Ethernet Driver module(s). Ethernet Driver related configuration data is contained in the Ethernet Driver module configuration description.

The MCG shall ensure the consistency of the generated con- figuration data.

The configuration of the Ethernet Transceiver Driver module shall be calculated at ECU configuration time. None of the communication parameters shall be calculated at runtime.

The start address of post-build time configuration data shall be passed during module initialization.

Type of error Related error code Error value Invalid transceiver index ETHTRCV_E_INV_TRCV_IDX 0x01 EthTrcv module was not initialized ETHTRCV_E_UNINIT 0x02 Invalid pointer in parameter list ETHTRCV_E_PARAM_POINTER 0x03

Module Header File Imported Type Rte_Dem_Type.h Dem_EventIdType Dem Rte_Dem_Type.h Dem_EventStatusType EcuM EcuM.h EcuM_WakeupSourceType Eth Eth_GeneralTypes.h Eth_ModeType Icu Icu.h Icu_ChannelType Mka.h Mka_ConfidentialityOffsetType (DRAFT) Mka.h Mka_MacSecConfigType (DRAFT) Mka.h Mka_SakKeyPtrType (DRAFT) Mka.h Mka_Stats_Rx_ScType (DRAFT) Mka.h Mka_Stats_Rx_SecYType (DRAFT) Mka.h Mka_Stats_SecYType (DRAFT) Mka.h Mka_Stats_Tx_ScType (DRAFT) Mka.h Mka_Stats_Tx_SecYType (DRAFT) Mka Mka.h Mka_ValidateFramesType (DRAFT) Std_Types.h Std_ReturnType Std Std_Types.h Std_VersionInfoType

{DRAFT} The function shall store the access to the configura- tion structure for subsequent API calls.

The function shall change the state of the component from ETHTRCV_STATE_UNINIT to ETHTRCV_STATE_INIT.

EthTrcv_Init() shall be called during initialization.

The function shall initialize the Ethernet hardware (PHY) with all available configuration parameters: • EthTrcvConnNeg (see [ECUC_EthTrcv_00025]) • EthTrcvDuplexMode (see [ECUC_EthTrcv_00023]) • EthTrcvMacLayerSpeed (see [ECUC_EthTrcv_00044]) • EthTrcvMacLayerSubType (see [ECUC_EthTrcv_00043]) • EthTrcvMacLayerType (see [ECUC_EthTrcv_00035]) • EthTrcvPhysLayerType (see [ECUC_EthTrcv_00024]) • EthTrcvSpeed (see [ECUC_EthTrcv_00022]).

The function shall check the access to the Ethernet transceiver. If the check fails, the function shall raise the production error ETHTRCV_ E_ACCESS otherwise pass the production error ETHTRCV_E_ACCESS.

The function shall put the indexed transceiver in the specified mode according to the following specified requirements. Each time a new mode is en- tered which was previously requested by EthTrcv_SetTransceiverMode, EthTrcv shall call EthIf_TrcvModeIndication latest during the next EthTrcv_MainFunction.

If development error detection is enabled: the function shall check that the service EthTrcv_Init was previously called. If the check fails, the function shall raise the development error ETHTRCV_E_UNINIT.

If development error detection is enabled: the function shall check the parameter TrcvIdx for being valid. If the check fails, the function shall raise the development error ETHTRCV_E_INV_TRCV_IDX.

{OBSOLETE} The function shall be pre compile time configurable On/Off by the configuration parameter: EthTrcvSetTransceiverModeApi.

EthTrcv_Init() shall be called before EthTrcv_SetTransceiverMode() .

The function shall read the current transceiver mode of the Ethernet hardware (PHY), whereby ETH_MODE_ACTIVE_WITH_WAKEUP_RE- QUEST shall always be returned as ETH_MODE_ACTIVE.

If development error detection is enabled: the function shall check that the service EthTrcv_Init was previously called. If the check fails, the function shall raise the development error ETHTRCV_E_UNINIT.

If development error detection is enabled: the function shall check the parameter TrcvIdx for being valid. If the check fails, the function shall raise the development error ETHTRCV_E_INV_TRCV_IDX.

If development error detection is enabled: the function shall check the parameter TrcvModePtr for being valid. If the check fails, the function shall raise the development error ETHTRCV_E_PARAM_POINTER.

{OBSOLETE} The function shall be pre compile time configurable On/Off by the configuration parameter: EthTrcvGetTransceiverModeApi.

EthTrcv_Init() shall be called before EthTrcv_GetTransceiverMode() .

The function shall restart the automatic negotiation of the transmission parameters used by the indexed transceiver if the internal cable diag- nostic state is different from ETHTRCV_CABLEDIAG_PENDING. Otherwise, the API shall return with E_NOT_OK.

If development error detection is enabled: the function shall check that the service EthTrcv_Init was previously called. If the check fails, the function shall raise the development error ETHTRCV_E_UNINIT.

If development error detection is enabled: the function shall check the parameter TrcvIdx for being valid. If the check fails, the function shall raise the development error ETHTRCV_E_INV_TRCV_IDX.

The function shall be pre compile time configurable On/Off by the configuration parameter: EthTrcvStartAutoNegotiationApi [ECUC_EthTrcv_00008] and EthTrcvEnablePLCA [ECUC_EthTrcv_00055].

EthTrcv_Init() shall be called before EthTrcv_StartAutoNego- tiation() .

The function shall read the current transceiver link state, ex- pect for the following condition: If EthTrcvWakeupSleepOnDatalineEnabled set to TRUE and the Ethernet Transceiver Driver detect that a sleep process is performed for the given TrcvIdx, then ETHTRCV_ LINK_STATE_DOWN shall be returned.

If development error detection is enabled: the function shall check that the service EthTrcv_Init() was previously called. If the check fails, the func- tion shall raise the development error ETHTRCV_E_UNINIT.

If development error detection is enabled: the function shall check the parameter TrcvIdx for being valid. If the check fails, the function shall raise the development error ETHTRCV_E_INV_TRCV_IDX.

If development error detection is enabled: the function shall check the parameter LinkStatePtr for being valid. If the check fails, the function shall raise the development error ETHTRCV_E_PARAM_POINTER.

The function shall be pre compile time configurable On/Off by the configuration parameter: EthTrcvGetLinkStateApi [ECUC_EthTrcv_00009].

EthTrcv_Init() shall be called before EthTrcv_GetLinkState() .

The function shall read the current transceiver baud rate.

If development error detection is enabled: the function shall check that the service EthTrcv_Init was previously called. If the check fails, the function shall raise the development error ETHTRCV_E_UNINIT.

If development error detection is enabled: the function shall check the parameter TrcvIdx for being valid. If the check fails, the function shall raise the development error ETHTRCV_E_INV_TRCV_IDX.

If development error detection is enabled: the function shall check the parameter BaudRatePtr for being valid. If the check fails, the function shall raise the development error ETHTRCV_E_PARAM_POINTER.

The function shall be pre compile time configurable On/Off by the configuration parameter: EthTrcvGetBaudRateApi [ECUC_EthTrcv_00010].

EthTrcv_Init() shall be called before EthTrcv_GetBaudRate() .

The function shall read the current transceiver duplex mode.

If development error detection is enabled: the function shall check that the service EthTrcv_Init was previously called. If the check fails, the function shall raise the development error ETHTRCV_E_UNINIT.

If development error detection is enabled: the function shall check the parameter TrcvIdx for being valid. If the check fails, the function shall raise the development error ETHTRCV_E_INV_TRCV_IDX.

If development error detection is enabled: the function shall check the parameter DuplexModePtr for being valid. If the check fails, the function shall raise the development error ETHTRCV_E_PARAM_POINTER.

The function shall be pre compile time configurable On/Off by the configuration parameter: EthTrcvGetDuplexModeApi [ECUC_EthTrcv_00011].

EthTrcv_Init() shall be called before EthTrcv_GetDuplexMode() .

Dem_SetEventStatus Dem.h Called by SW-Cs or BSW modules to report monitor status information to the Dem. BSW modules calling Dem_SetEventStatus can safely ignore the return value. This API will be available only if ({Dem/Dem ConfigSet/DemEventParameter/DemEvent ReportingType} == STANDARD_REPORTING) API Function Header File Description EthIf_TrcvModeIndication EthIf.h Called asynchronously when a mode change has been read out. If the function is triggered by previous call of EthTrcv_SetTransceiverMode it can directly be called within the trigger function. SchM_Enter_EthTrcv SchM_<Mip>.h Invokes the SchM_Enter function to enter a module local exclusive area. SchM_Exit_EthTrcv SchM_<Mip>.h Invokes the SchM_Exit function to exit an exclusive area.

Det_ReportError Det.h Service to report development errors. EcuM_SetWakeupEvent EcuM.h Sets the wakeup event. Eth_ReadMii Eth.h Reads a transceiver register Eth_WriteMii Eth.h Configures a transceiver register or triggers a function offered by the receiver EthIf_SleepIndication (draft) EthIf.h This API is called by the corresponding EthTrcv, if a sleep indication was detected on the network. This could be used e.g. for Ethernet hardware which is compliant to the OA TC10. In this case the Ethernet hardware (PHY) detect an Sleep.Indication which was triggered by a Sleep.Request of the connected link partner. Tags: atp.Status=draft EthSwt_ReadTrcvRegister EthSwt.h Generic API for reading the content of a transceiver register EthSwt_WriteTrcvRegister EthSwt.h Generic API for writing the content of a transceiver register Icu_DisableNotification Icu.h This function disables the notification of a channel. Icu_EnableNotification Icu.h This function enables the notification on the given channel.

EthTrcv_StartAutoNegotiation() shall not be called or required by an upper layer BSW software component.

EthTrcv_GetBaudRate() shall not be called or required by an upper layer BSW software component.

EthTrcv_GetDuplexMode() shall not be called or required by an upper layer BSW software component.

If development error detection is enabled: the function shall check the parameter VersionInfoPtr for being valid. If the check fails, the function shall raise the development error ETHTRCV_E_PARAM_POINTER.

If the transceiver is already in the requested mode E_OK shall be returned and no development error shall be raised.

EthTrcv_SetTransceiverMode() shall check the access to the Ethernet transceiver. If the check fails, the function shall raise the production error ETHTRCV_E_ACCESS and return E_NOT_OK, otherwise pass the production error ETHTRCV_E_ACCESS and return E_OK.

Error Name: ETHTRCV_E_ACCESS Short Description: Ethernet Transceiver Access Failure. Long Description: Monitors the access to the Ethernet Transceiver. Fail When access to the Ethernet Transceiver fails the module shall report the extended production error with event status DEM_EVENT_ STATUS_PREFAILED to DEM. Detection Criteria: Pass When access to the Ethernet Transceiver succeds the module shall report the extended production error with event status DEM_EVENT_ STATUS_PREPASSED to DEM. Secondary Parameters: None. Time Required: None. Monitor Frequency None.

Used for polling state changes. Calls EthIf_TrcvModeIndica- tion when the transceiver mode changed.

The Ethernet Transceiver driver shall support wake up de- tection depending on the configuration parameter EthTrcvWakeUpSupport either not at all (ETHTRCV_WAKEUP_NOT_SUPPORTED) or by interrupt (ETHTRCV_ WAKEUP_BY_INTERRUPT) or by asynchronous check (ETHTRCV_WAKEUP_BY_ ASYNCHRONOUS_CHECK) or by polling (ETHTRCV_WAKEUP_BY_POLLING).

If the EthTrcv is requested with ETH_MODE_DOWN (e.g. low power mode), the Ethernet Transceiver driver shall enable the corresponding ICU chan- nel (see EthTrcvIcuChannelRef) by calling Icu_EnableNotification if configured.

If the EthTrcv is requested with ETH_MODE_ACTIVE (e.g. normal mode), the Ethernet Transceiver driver shall disable the corresponding ICU channel (see EthTrcvIcuChannelRef) by calling Icu_DisableNotification if configured.

The function shall check for wake-up reasons and propagate the corresponding wake-up source (see EthTrcvWakeupMap configuration [ECUC_- EthTrcv_00027]) to the EcuM by calling EcuM_SetWakeupEvent.

If the function is called with ETH_MODE_DOWN and EthTrcv WakeupSleepOnDatalineEnabled is not configured, it shall set the corresponding Eth- ernet Hardware (PHY) into a mode (e.g. sleep mode) where wakeups can be de- tected.

If EthTrcv_SetTransceiverMode() is called with parameter ETH_MODE_ACTIVE or ETH_MODE_ACTIVE_WITH_WAKEUP_REQUEST, EthTrcv WakeupSleepOnDatalineEnabled is not configured and the internal cable diagnostic state is different from ETHTRCV_CABLEDIAG_PENDING, the Ethernet Transceiver driver shall: • Check for wake-up reasons when entering the transceiver's active mode; • If no wake-up reason has been detected, the Ethernet transceiver shall send a wake-up symbol on the bus if configured; • Invoke the call-out <EthTrcvWakeUpCallout> function if configured.

{OBSOLETE} If function EthTrcv_SetTra nsceiverWakeupMode() is called with ETHTRCV_WUM_DISABLE or ETHTRCV_WUM_ENABLE and the internal cable diagnostic state is different from ETHTRCV_CABLEDIAG_PENDING, the Ethernet Transceiver shall put the indexed transceiver in the specified wake up mode.

{OBSOLETE} If function EthTrcv_SetTransceiverWakeupMode() is called with ETHTRCV_WUM_CLEAR and the internal cable diagnostic state is different from ETHTRCV_CABLEDIAG_PENDING, the Ethernet Transceiver driver shall clear stored wakeup events on the indexed transceiver.

{OBSOLETE} If development er ror detection is enabled: The function EthTrcv_SetTransceiverWakeupMode() shall check that the service EthTrcv_Init was previously called. If the check fails, the function shall raise the development error ETHTRCV_E_UNINIT otherwise (if DET is disabled) re turn E_NOT_OK.

{OBSOLETE} If development error detection is enabled: The function EthTrcv_SetTransceiverWakeupMode() shall check the parameter TrcvIdx for being valid. If the check fails, the function shall raise the development error ETHTRCV_E _INV_TRCV_IDX otherwise (if DET is disabled) return E_NOT_OK.

{OBSOLETE} The function EthTrcv_SetTransceiverWakeupMode() shall be only available if EthTrcvWakeUpSupport is not disabled (set to ETHTRCV_WAKEUP_NOT_SUPPORTED).

{OBSOLETE} If the transceiver is already in the requested wake - up mode, E_OK shall be returned and no development error shall be raised.

{OBSOLETE} Caveat: The function EthTrcv_SetTransceiverWakeup Mode() requires previous transceiver initialization (EthTrcv_Init).

{OBSOLETE} The function EthTrcv_GetTransceiverWakeupMode() shall read the current transceiver wake up mode and provide it into TrcvWakeupModePtr.

{OBSOLETE} If development error detection is enabled: The function EthTrcv_GetTransceiverWakeupMode() shall check that the service EthTrcv_Init was previously called. If the check fails, the function shall raise the development error ETHTRCV_E_UNINIT otherwise (if DET is disabled) return E_NOT_OK.

{OBSOLETE} If development error detection is enabled: The function EthTrcv_GetTransceiverWakeupMode() shall check the parameter TrcvIdx for being valid. If the check fails, the function shall raise the development error ETHTRCV_E_IN V_TRCV_IDX otherwise (if DET is disabled) return E_NOT_OK.

{OBSOLETE} If development error detection is enabled: The function EthTrcv_GetTransceiverWakeupMode() shall check the parameter TrcvWakeupModePtr for being valid. If the c heck fails, the function shall raise the development error ETHTRCV_E_PARAM_POINTER otherwise (if DET is disabled) return E_NOT_OK.

{OBSOLETE} The function EthTrcv_GetTransceiverWakeupMode() shall be only available if EthTrcvGetTra nsceiverWakeupModeApi is set to TRUE.

{OBSOLETE} Caveat: The function EthTrcv_GetTransceiverWakeupMode() requires previous transceiver initialization (EthTrcv_Init).

If EthTrcvWakeUpSupport is set to ETHTRCV_WAKEUP_ BY_INTERRUPT or ETHTRCV_WAKEUP_BY_POLLING, the function EthTrcv_Check Wakeup() shall check if a wake up has been detected and if yes propagate the cor- responding wake up source (see EthTrcvWakeupMap configuration [ECUC_EthTrcv_- 00027]) to the EcuM by calling EcuM_SetWakeupEvent.

{OBSOLETE} I f the wake - up mode of the corresponding transceiver is not ETHTRCV_WUM_ENABLE, the function EthTrcv_CheckWakeup() shall return E_OK.

If development error detection is enabled: The function Eth Trcv_CheckWakeup() shall check that the service EthTrcv_Init was previously called. If the check fails, the function shall raise the development error ETHTRCV_E_UNINIT.

If development error detection is enabled: The function Eth Trcv_CheckWakeup() shall check the parameter TrcvIdx for being valid. If the check fails, the function shall raise the development error ETHTRCV_E_INV_TRCV_IDX.

⌊ OBSOLETE g The function EthTrcv_CheckWakeup() shall be only available if EthTrcvWakeUpSupport is something else than ETHTRCV_WAKEUP_ NOT_SUPPORTED.

EthTrcv_Init() shall be called before EthTrcv_Check Wakeup() .

If EthTrcvWakeUpSupport is set to ETHTRCV_WAKEUP_POLLING, the function EthTrcv_MainFunction() shall check for wake up reasons. If wake-up reasons were detected, the wake-up events shall be stored and EcuM_CheckWakeup shall be called with the corresponding wake-up source (see EthTrcvWakeupMap configuration [ECUC_EthTrcv_00027]).

The callback function shall be configurable by the configura- tion parameter: EthTrcvWakeUpCallout.

The wake up interrupt handler (if present) shall clear the in- terrupt and identify the wake up reason and store it.

If development error detection is enabled: the function Eth Trcv_SetPhyTestMode() shall check the parameter Mode for being supported by the hardware. If the check fails, the function shall raise the development error ETHTRCV_ E_NOT_SUPPORTED.

If development error detection is enabled: the function Eth Trcv_SetPhyTxMode shall check the parameter Mode for being supported by the hard- ware. If the check fails, the function shall raise the development error ETHTRCV_E_ NOT_SUPPORTED.

If development error detection is enabled: the function Eth Trcv_SetPhyLoopbackMode shall check the parameter Mode for being supported by the hardware. If the check fails, the function shall raise the development error ETHTRCV_E_NOT_SUPPORTED.

The function shall start link training of the indexed transceiver if: • the requested link state is ETHTRCV_LINK_STATE_ACTIVE and • the internal cable diagnostic state is different from ETHTRCV_CABLEDIAG_ PENDING and • EthTrcvConnNeg is set to TRCV_CONN_NEG_MASTER or TRCV_CONN_ NEG_AUTO. If EthTrcvConnNeg is set to TRCV_CONN_NEG_SLAVE, the indexed transceiver shall be put in a state to wait for the link training of the link partner.

The function shall stop link training of the indexed transceiver, if the requested link state is ETHTRCV_LINK_STATE_DOWN and EthTrcvConnNeg is set to TRCV_CONN_NEG_MASTER or TRCV_CONN_NEG_AUTO.

The function shall put the link down of the indexed transceiver, if the requested link state is ETHTRCV_LINK_STATE_DOWN.

If the Ethernet transceiver is already in the requested link state, E_OK shall be returned and no development error shall be raised.

The Ethernet Transceiver Driver module shall reject configu- rations with partition mappings which are not supported by the implementation.

The module will operate as an independent instance in each of the partitions, means the called API will only target the partition it is called in.

The ECUC partitions referenced by EthTrcvConfigEcucParti- tionRef shall be a subset of the ECUC partitions referenced by EthTrcvEcucPartition Ref.

EthTrcvConfig, EthCtrlConfig and EthSwtConfig (if existent in configuration) of one communication channel shall all reference the same ECUC partition.

If EthTrcv_RunPortCableDiagnostic is called, EthTrcv has to ensure that the Ethernet hardware (PHY) is in a state to run the cable diagnostic by considering at least the following points: • the corresponding Ethernet transceiver is in state ETH_MODE_ACTIVE • the corresponding Ethernet transceiver is in state ETHTRCV_LINK_STATE_ DOWN If all pre conditions are fullfilled to run the cable diagnostic measurement, EthTrcv shall trigger the cable diagnostic measurement and set the state internally to ETHTRCV_ CABLEDIAG_PENDING of the affected Ethernet transceiver.

If EthTrcv_GetCableDiagnosticsResult is called, the current state of the cable diagnostic measurement of the affected Ethernet transceiver shall be returned and stored per Ethernet transceiver as internal cable diagnostic state.

As long as the cable diagnostic measurement is running (in- ternal cable diagnostic state is ETHTRCV_CABLEDIAG_PENDING), a mode request (indicated by EthTrcv_SetTransceiverMode) and link request (indicated by EthTrcv_ TransceiverLinkStateRequest), respectively, shall be stored and not executed.

As soon as the cable diagnostic meassurement has finished (internal cable diagnostic state is different from ETHTRCV_CABLEDIAG_PENDING), EthTrcv shall execute the last mode request and link request, respectively, of the af- fected Ethernet transceiver.

If EthTrcv_SetTransceiverMode() is called and the internal cable diagnostic state is equal to ETHTRCV_CABLEDIAG_PENDING, the Ethernet Transceiver driver shall store the mode request per EthTrcv (TrcvIdx).

{OBSOLETE} If the internal cable diagnostic state is ETHTRCV_CABLEDIAG_PENDING, the EthTrcv_SetTransceiverWakeupMode shall return E_NOT_OK .

If EthTrcv_TransceiverLinkStateRequest() is called and the internal cable diagnostic state is ETHTRCV_CABLEDIAG_PENDING, the Ethernet Transceiver driver shall store the link state request per Ethernet transceiver and pro- ceed as specified in [SWS_EthTrcv_00162].

If the internal cable diagnostic state is ETHTRCV_CABLE- DIAG_PENDING, EthTrcv_SetPhyTestMode() shall return E_NOT_OK.

If the internal cable diagnostic state is ETHTRCV_CABLE- DIAG_PENDING, the EthTrcv_SetPhyLoopbackMode() shall return E_NOT_OK.

If the internal cable diagnostic state is ETHTRCV_CABLE- DIAG_PENDING, the EthTrcv_SetPhyTxMode shall return E_NOT_OK.

The function shall be pre compile time configurable On/Off by the configuration parameter EthTrcvSetPhyTestModeApi [ECUC_EthTrcv_00047].

The function shall be pre compile time configurable On/Off by the configuration parameter EthTrcvEnableCableDiagnosticApi [ECUC_EthTrcv_- 00054].

The function shall be pre compile time configurable On/Off by the configuration parameter EthTrcvEnableCableDiagnosticApi [ECUC_EthTrcv_- 00054].

The function shall be pre compile time configurable On/Off by the configuration parameter EthTrcvGetPhyIdentifierApi [ECUC_EthTrcv_00046].

The function shall be pre compile time configurable On/Off by the configuration parameter EthTrcvVersionInfoApi [ECUC_EthTrcv_00004].

If the parameter EthTrcvDuplexMode is set to ETHTRCV_ DUPLEX_MODE_HALF the function shall return the current transceiver media access mode. Otherwise, it shall return E_NOT_OK.

If development error detection is enabled: the function shall check that the service EthTrcv_Init was previously called. If the check fails, the function shall raise the development error ETHTRCV_E_UNINIT.

If development error detection is enabled: the function shall check the parameter TrcvIdx for being valid. If the check fails, the function shall raise the development error ETHTRCV_E_INV_TRCV_IDX.

If development error detection is enabled: the function shall check the parameter MacModePtr for being valid. If the check fails, the function shall raise the development error ETHTRCV_E_PARAM_POINTER.

EthTrcv_Init() shall be called before EthTrcv_GetMacMethod() .

A new requested EthTrcv mode shall overwrite the last re- quested EthTrcv mode, except in case the last mode is ETH_MODE_ACTIVE_WITH_ WAKEUP_REQUEST and the new mode is ETH_MODE_ACTIVE.

If the function is called with ETH_MODE_DOWN, EthTrcv WakeupSleepOnDatalineEnabled is set to TRUE, the Ethernet Transceiver driver has detected a pending wake-up and a corresponding delay timer with EthTrcvSleepMode ExecutionDelay is not running, the Ethernet Transceiver driver shall start a delay timer with EthTrcvSleepModeExecutionDelay and return with E_OK.

If the function is called with ETH_MODE_DOWN, EthTrcv WakeupSleepOnDatalineEnabled is set to TRUE and the corresponding delay timer with EthTrcvSleepModeExecutionDelay is running, then the Ethernet Transceiver driver shall return with E_OK.

Spezifikationsanforderung SWS_EthTrcv_00182.

If the function is called with ETH_MODE_ACTIVE, EthTrcvWakeupSleepOnDatalineEnabled is TRUE and the internal cable diagnostic state is different from ETHTRCV_CABLEDIAG_PENDING, the Ethernet Transceiver driver shall: • Put the Ethernet hardware (PHY) to normal mode, if not already switched auto- matically by the statemachine of the Ethernet hardware (PHY), • Invoke the call-out <EthTrcvWakeUpCallout> function if configured.

Spezifikationsanforderung SWS_EthTrcv_00184.

If the function EthTrcv_CheckWakeup() is called and EthTrcv WakeUpSupport is set to ETHTRCV_WAKEUP_BY_ASYNCHRONOUS_CHECK, the Ethernet Transceiver Driver shall store the request to asynchronously check for a wake- up of used Ethernet hardware (e.g. the OA TC10 compliant PHY) in the context of the EthTrcv_MainFunction.

The function EthTrcv_GetBusWuReason shall read the stored wake-up reason and provide the information in WakeupReasonPtr.

If development error detection is enabled: the function shall check that the service EthTrcv_Init was previously called. If the check fails, the function shall raise the development error ETHTRCV_E_UNINIT.

If development error detection is enabled: the function shall check the parameter TrcvIdx for being valid. If the check fails, the function shall raise the development error ETHTRCV_E_INV_TRCV_IDX.

If development error detection is enabled: the function shall check the parameter TrcvModePtr for being valid. If the check fails, the function shall raise the development error ETHTRCV_E_PARAM_POINTER.

The function shall be pre compile time configurable On/Off by the configuration parameter: EthTrcvGetBusWuReasonApi [ECUC_EthTrcv_00061].

If EthTrcvWakeUpSupport is set to ETHTRCV_WAKEUP_ BY_ASYNCHRONOUS_CHECK, the EthTrcv_MainFunction shall check the main- tained Ethernet hardware (PHY) for a signaled wake-up (e.g. Wakeup.Indication if using OA TC10 [3] compliant PHYs) of those EthTrcvs where the check for wake- up was requested by EthTrcv_CheckWakeup. If a wake-up is detected, the Ethernet Transceiver Driver shall inform the EcuM by calling EcuM_SetWakeupEvent with the corresponding WakeupSource.

{DRAFT} If EthTrcvWakeupSleepOnDatalineEnabled is set to TRUE and EthTrcvActAsSlavePassiveEnabled is set to TRUE, the EthTrcv_Main Function shall evaluate the maintained Ethernet hardware (PHY) for a signaled Sleep.Indication (see [3]). If a Sleep.Indication is detected, the Ethernet Transceiver Driver shall inform the EthIf by calling EthIf_SleepIndication.

Spezifikationsanforderung SWS_EthTrcv_00193.

Spezifikationsanforderung SWS_EthTrcv_00194.

If EthTrcvWakeupSleepOnDatalineEnabled is set to TRUE, the requested transceiver mode is still ETH_MODE_DOWN and Sleep Fail.Indication was reported EthTrcvSleepRequestNumberOfRepetitions times, the Ethernet Transceiver driver shall call EthIf_TrcvModeIndication(ETH_MODE_DOWN). If EthTrcvForceSleepEnabled is set to true the Ethernet Transceiver driver shall additionally force the Ehternet hardware (PHY) to go to sleep.

After each call of EthTrcv_SetTransceiverMode with ETH_ MODE_ACTIVE_WITH_WAKEUP_REQUEST for a particular EthTrcv the EthTrcv_ MainFunction shall repeat a wake-up request EthTrcvWakeupRequestNumberOfRep- etitions times with a delay of EthTrcvWakeUpRequestRepetitionPeriod in between as long as no EthTrcv_SetTransceiverMode with ETH_MODE_DOWN occurs for the same EthTrcv.

{DRAFT} If EthTrcvPhysLayerType is set to TRCV_PHYS_LAYER_TYPE_10BASE_T1S, the function shall internally store the requested link state and return E_OK.

{DRAFT} The function shall check the access to the Eth- ernet PHY to read the link register. If the check fails, the function shall raise the production error ETHTRCV_E_ACCESS return E_NOT_OK and state ETHTRCV_LINK_STATE_DOWN.

{DRAFT} The function shall return the stored requested state given by a previous call of EthTrcv_TransceiverLinkStateRequest() (see [SWS_EthTrcv_00197]) and return E_OK. If EthTrcv_TransceiverLinkStateRequest() was not called before, ETHTRCV_LINK_STATE_DOWN shall be returned with E_OK.

{DRAFT} If the PHY register indicates a link up, the func- tion shall additionally read the PLCA Status register of the PHY. If the PLCA mode is not active, the Ethernet transceiver driver shall report a runtime error ETHTRCV_E_MDI_COMMUNICATION and return E_NOT_OK.

If EthTrcvWakeupSleepOnDatalineEnabled is set to TRUE and a wake-up reason was detected which relates to OA TC10 [3] compatible Eth- ernet hardware (PHY), then the Ethernet hardware state (e.g. normal mode) shall be kept, since a wake-up arrived and the corresponding delay timer with EthTrcvSleep- ModeExecutionDelay shall be started.

If the function EthTrcv_CheckWakeup() is called, EthTrcvWakeupSleepOnDatalineEnabled is set to TRUE, a wake-up reason which relates to OA TC10 [3] compliant Ether- net hardware (PHY) was detected (ETHTRCV_WUR_WODL_WUP, ETHTRCV_WUR_WODL_WUR or ETHTRCV_WUR_TRANSFER) and EthTr- cvWakeUpSupport is to ETHTRCV_WAKEUP_BY_ASYNCHRONOUS_CHECK, ETHTRCV_WAKEUP_BY_INTERRUPT or ETHTRCV_WAKEUP_BY_POLLING, then the Ethernet Transceiver driver shall start a delay timer with EthTrcvSleepModeExecu- tionDelay.

The function shall consider at least the following initialization sequence for the Ethernet hardware (PHY): • check for wake-up reasons according to [SWS_EthTrcv_00115] • initialize the PHY according to [SWS_EthTrcv_00035] • ensure that the PHY resides in a defined hardware state according to [SWS_EthTrcv_00204] and [SWS_EthTrcv_00205].

If EthTrcvWakeupSleepOnDatalineEnabled is not configured, then the Ethernet Transceiver driver shall ensure within the function call of EthTrcv_Init that the Ethernet hardware (PHY) resides in a sleep mode.

If EthTrcvWakeupSleepOnDatalineEnabled is configured and no wake-up reason was detected, then the Ethernet Transceiver driver shall ensure within the call of EthTrcv_Init that the Ethernet hardware (PHY) resides in the OA TC10 [3] specified sleep mode

If the function is called with ETH_MODE_DOWN and EthTrcv WakeupSleepOnDatalineEnabled is set to FALSE, the Ethernet Transceiver shall set the corresponding Ethernet Hardware (PHY) into a sleep mode without performing the sleep process according to OA TC10 [3].

If EthTrcv_SetTransceiverMode() is called with parameter ETH_MODE_ACTIVE or ETH_MODE_ACTIVE_WITH_WAKEUP_REQUEST, EthTrcv WakeupSleepOnDatalineEnabled set to FALSE and the internal cable diagnostic state is different from ETHTRCV_CABLEDIAG_PENDING, the Ethernet Transceiver driver shall: • Put the Ethernet hardware (PHY) to normal mode, • Invoke the call-out <EthTrcvWakeUpCallout> function if configured.

{DRAFT} The EthTrcv shall collect the information of the Eth Swt Ports referring to the each EthTrcv instance (e.g. TrcvIdx) during configuration in order to call the EthSwt callbacks of MKA (e.g. EthSwt_MacSecUpdateSecYIndication, EthSwt_MacSecAddTxSaNotification, EthSwt_MacSecAddRxSaNotification and Eth Swt_MacSecGetMacSecStatsNotification). The EthSwtPort.EthSwtPortTrcvRef links an EthSwtPort to an EthTrcvIdx in the EthSwt configuration.

If EthTrcvEcucPartitionRef references one or more ECUC partitions, EthTrcvConfigEcucPartitionRef shall have a multiplicity of one and reference one of these ECUC partitions as well.