Specification of Ethernet Interface

Specification of Ethernet Interface

AUTOSAR Release 4.2.2

[SWS_EthIf_00236]

⌈

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

ETHIF_E_INV_TRCV_IDX otherwise (if DET is disabled) return E_NOT_OK.

⌋()

[SWS_EthIf_00237]

⌈

The function shall be pre compile time configurable On/Off by the configuration parameter EthIfWakeUpSupport.

⌋(SRS_Eth_00106)

8.3.7 EthIf_ GetTransceiverWakeupMode

[SWS_EthIf_00238]

⌈

Service name:

Syntax:

EthIf_GetTransceiverWakeupMode

Std_ReturnType EthIf_GetTransceiverWakeupMode( uint8

EthTrcv_WakeupModeType*

TrcvIdx,

TrcvWakeupModePtr

)

Service ID[hex]:

0x2f

Sync/Async:

Reentrancy:

Synchronous

Non Reentrant

Parameters (in):

TrcvIdx Index of the transceiver within the context of the Ethernet

Interface

Parameters

(inout):

None

Parameters (out):

Return value:

TrcvWakeupModePtr ETHTRCV_WUM_DISABLE: transceiver wake up is disabled

ETHTRCV_WUM_ENABLE: transceiver wake up is enabled

Std_ReturnType E_NOT_OK: transceiver wake up mode could not be obtained

Description:

Returns the wake up mode of the indexed transceiver

⌋()

[SWS_EthIf_00239]

⌈

The function EthIf_GetTransceiverWakeupMode shall forward the call to function

EthTrcv_GetTransceiverWakeupMode of the respective Ethernet Transceiver Driver.

⌋()

[SWS_EthIf_00240]

⌈

If default error detection is enabled: the function shall check that the service EthIf_Init was previously called. If the check fails, the function shall raise the default error

ETHIF_E_NOT_INITIALIZED otherwise (if DET is disabled) return E_NOT_OK.

⌋()

[SWS_EthIf_00241]

⌈

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

ETHIF_E_INV_TRCV_IDX otherwise (if DET is disabled) return E_NOT_OK.

⌋()

[SWS_EthIf_00242]

⌈

If default error detection is enabled: the function shall check the parameter

TrcvWakeupModePtr for being valid. If the check fails, the function shall raise the default error ETHIF_E_INV_POINTER otherwise (if DET is disabled) return

E_NOT_OK.

⌋()

33 of 77 Document ID 417: AUTOSAR_SWS_EthernetInterface

- AUTOSAR confidential -



[SWS_EthIf_00243]

⌈

The function shall be pre compile time configurable On/Off by the configuration parameter EthIfGetTransceiverWakeupModeApi.

⌋()

8.3.8 EthIf_ CheckWakeup

[SWS_EthIf_00244]

⌈

Service name:

Syntax:

EthIf_CheckWakeup

Std_ReturnType

)

EcuM_WakeupSourceType

EthIf_CheckWakeup(

WakeupSource


0x30

Sync/Async:

Reentrancy:

Asynchronous

Reentrant


WakeupSource source (transceiver) which initiated the wake up event

Parameters

(inout):

None


None

Return value:

Std_ReturnType E_OK when function has been successfully executed

E_NOT_OK when function could not be successfully executed

Description:

Service is called by integration code to check a wakeup source.

⌋()

[SWS_EthIf_00245]

⌈

The function EthIf_CheckWakeup shall forward the call to function

EthTrcv_CheckWakeup of the respective Ethernet Transceiver Driver.

⌋(

SRS_Eth_00106)

[SWS_EthIf_00246]

⌈



⌋()

[SWS_EthIf_00247]

⌈


WakeupSource for being valid. If the check fails, the function shall raise the default error ETHIF_E_INV_PARAM otherwise (if DET is disabled) return E_NOT_OK.

⌋()

[SWS_EthIf_00248]

⌈

The function EthIf_CheckWakeup() shall be pre-compile time configurable On/Off by the configuration parameter EthIfWakeUpSupport.

⌋()

[SWS_EthIf_00249]

⌈

Caveat: The function EthIf_CheckWakeup() requires previous transceiver initialization (EthIf_Init).

⌋(SRS_Eth_00106)

8.3.9 EthIf_GetPhysAddr

[SWS_EthIf_00061]

⌈

Service name:

EthIf_GetPhysAddr





Syntax:

void

) uint8 uint8*

EthIf_GetPhysAddr(

CtrlIdx,

PhysAddrPtr


0x08

Sync/Async:

Reentrancy:

Synchronous

Non Reentrant


CtrlIdx Index of the Ethernet controller within the context of the Ethernet

Interface

Parameters

(inout):

None


PhysAddrPtr Physical source address (MAC address) in network byte order.

Return value:

None

Description:

Obtains the physical source address used by the indexed controller

⌋()

[SWS_EthIf_00062]

⌈

The function EthIf_GetPhysAddr shall forward the call to the respective Ethernet

Controller Driver.

⌋()

[SWS_EthIf_00063]

⌈


ETHIF_E_NOT_INITIALIZED.

⌋()

[SWS_EthIf_00064]

⌈

If default error detection is enabled: the function shall check the parameter CtrlIdx for being valid. If the check fails, the function shall raise the default error

ETHIF_E_INV_CTRL_IDX.

⌋()

[SWS_EthIf_00065]

⌈


PhysAddrPtr for being valid. If the check fails, the function shall raise the default error

ETHIF_E_PARAM_POINTER.

⌋()

[SWS_EthIf_00066]

⌈

Caveat: The function requires previous initialization (EthIf_Init).

⌋()

8.3.10 EthIf_SetPhysAddr

[SWS_EthIf_00132]

⌈

Service name:

Syntax:

EthIf_SetPhysAddr void

) const uint8 uint8*

EthIf_SetPhysAddr(

CtrlIdx,

PhysAddrPtr


0x0d

Sync/Async:

Reentrancy:

Synchronous

Non Reentrant for the same CtrlIdx, reentrant for different



Driver.

PhysAddrPtr Pointer to memory containing the physical source address (MAC address) in network byte order.





Parameters

(inout):

None


None

Return value:

None

Description:

Sets the physical source address used by the indexed controller.

⌋()

[SWS_EthIf_00134]

⌈

The function EthIf_SetPhysAddr shall forward the call to the respective Ethernet

Controller Driver.

⌋()

[SWS_EthIf_00135]

⌈



⌋()

[SWS_EthIf_00136]

⌈



⌋()

[SWS_EthIf_00137]

⌈




⌋()

[SWS_EthIf_00138]

⌈


⌋()

8.3.11 EthIf_UpdatePhysAddrFilter

[SWS_EthIf_00139]

⌈

Service name:

Syntax:

EthIf_UpdatePhysAddrFilter

Std_ReturnType const uint8

EthIf_UpdatePhysAddrFilter( uint8*

Eth_FilterActionType

CtrlIdx,

PhysAddrPtr,

Action

)


0x0c

Sync/Async:

Synchronous

Reentrancy:



Driver.


PhysAddrPtr Pointer to memory containing the physical destination address

(MAC address) in network byte order. This is the multicast destination address of the layer 2 Ethernet packet.

Add or remove the address from the Ethernet controllers filter.

Parameters

(inout):

Action

None


None

Return value:

Description:

Std_ReturnType E_OK: filter was successfully

E_NOT_OK: filter could not be changed changed

Update the physical source address to/from the indexed controller filter. If the





Ethernet Controller is not capable to do the filtering, the software has to do this.

⌋()

[SWS_EthIf_00140]

⌈

The function EthIf_SetPhysAddrFilter shall forward the call to the respective Ethernet

Controller Driver.

⌋()

[SWS_EthIf_00141]

⌈



⌋()

[SWS_EthIf_00142]

⌈



⌋()

[SWS_EthIf_00143]

⌈




⌋()

[SWS_EthIf_00144]

⌈


⌋()

8.3.12 EthIf_GetPortMacAddr

[SWS_EthIf_00190]

⌈

Service name:

Syntax:

EthIf_GetPortMacAddr

Std_ReturnType const

) uint8* uint8* uint8*

EthIf_GetPortMacAddr(

MacAddrPtr,

SwitchIdxPtr,

PortIdxPtr


0x28

Sync/Async:

Synchronous

Reentrancy:


Non Reentrant

MacAddrPtr MAC-address for which a switch port is searched over which the node with this MAC-address can be reached.

Parameters

(inout):

None


Return value:

SwitchIdxPtr Pointer to the switch index

PortIdxPtr Pointer to the port index

Std_ReturnType E_OK:

E_NOT_OK: switch port could not be initialized success

Description:

Obtains the port over which this MAC-address can be reached

⌋()

[SWS_EthIf_00191]

⌈

The function EthIf_GetPortMacAddr shall return the switch and port index over which the given MAC-address is reachable. If multiple or no ports are possible, this API call will return an error value. The API call will be forwarded to the Ethernet Switch Driver which shall have a corresponding API call.

⌋()





[SWS_EthIf_00192]

⌈

The function EthIf_GetPortMacAddr shall be pre compile time configurable On/Off by the configuration parameter: EthIfGetPortMacAddrApi.

⌋()

[SWS_EthIf_00193]

⌈



⌋()

[SWS_EthIf_00194]

⌈


MacAddrPtr, SwitchIdxPtr and PortIdxPtr for being valid. If the check fails, the function shall raise the default error ETHIF_E_PARAM_POINTER.

⌋()

[SWS_EthIf_00195]

⌈


⌋()

8.3.13 EthIf_GetArlTable

[SWS_EthIf_00196]

⌈

Service name:

Syntax:

EthIf_GetArlTable

Std_ReturnType

) uint8

EthSwt_MacVlanType[]*

EthIf_GetArlTable(

SwitchIdx,

ArlTable


0x29

Sync/Async:

Synchronous /Asynchronous

Reentrancy:


Non Reentrant

SwitchIdx Index of the switch within the context of the Ethernet Switch

Driver

Parameters

(inout):

None


ArlTable Returns the ARL table of the switch consisting of a list of structs with MAC-address, VLAN-ID and port.

Return value:



Description:

Obtains the address resolution table of a switch

⌋()

[SWS_EthIf_00197]

⌈

The function EthIf_GetArlTable shall return a list of structs with MAC-address, VLAN-

ID and port for the indexed switch.

⌋()

[SWS_EthIf_00198]

⌈

The function EthIf_GetArlTable shall be pre compile time configurable On/Off by the configuration parameter: EthIfGetArlTable.

⌋()

[SWS_EthIf_00199]

⌈



⌋()





[SWS_EthIf_00200]

⌈

If default error detection is enabled: the function shall check the parameter ArlTable for being valid. If the check fails, the function shall raise the default error


⌋()

[SWS_EthIf_00201]

⌈


⌋()

8.3.14 EthIf_GetBufferLevel

[SWS_EthIf_00202]

⌈

Service name:

Syntax:

EthIf_GetBufferLevel

Std_ReturnType

) uint8 uint32*

EthIf_GetBufferLevel(

SwitchIdx,

SwitchBufferLevelPtr


0x2a

Sync/Async:

Reentrancy:


Non Reentrant


SwitchIdx Index of the switch within the context of the Ethernet

Switch Driver

Parameters

(inout):

None


SwitchBufferLevelPtr

Return value:

Std_ReturnType

The interpretation of this value is switch dependent

E_OK: success

E_NOT_OK: switch port could not be initialized

Description:

Reads the buffer level of the corresponding switch. Whether this buffer level is one value for the entire switch (shared memory) or one value for each port at a switch is technology dependent.

⌋()

[SWS_EthIf_00203]

⌈

The function EthIf_GetBufferLevel shall read the buffer level of the currently used buffer of the switch.

⌋()

[SWS_EthIf_00204]

⌈

The function EthIf_GetBufferLevel shall be pre compile time configurable On/Off by the configuration parameter: EthIfGetBufferLevelApi.

⌋()

[SWS_EthIf_00205]

⌈



⌋()

[SWS_EthIf_00206]

⌈


SwitchBufferLevelPtr for being valid. If the check fails, the function shall raise the default error ETHIF_E_PARAM_POINTER.

⌋()

[SWS_EthIf_00207]

⌈


⌋()





8.3.15 EthIf_GetDropCount

[SWS_EthIf_00208]

⌈

Service name:

Syntax:

EthIf_GetDropCount

Std_ReturnType

) uint8 uint32[]*

EthIf_GetDropCount(

SwitchIdx,

DropCount


0x2b

Sync/Async:


Reentrancy:


Non Reentrant

SwitchIdx Index of the switch within the context of the Ethernet

Switch Driver

Parameters

(inout):

None


DropCount

Return value:

Std_ReturnType

The interpretation of this list of values is switch dependent

E_OK:


Description:

Reads a list with drop counter values of the corresponding switch. The meaning of these values is switch dependent and can include values like 1.) dropped packets due to buffer overrun, 2.) dropped packets due to CRC errors, etc.

⌋()

[SWS_EthIf_00209]

⌈

The function EthIf_GetDropCount shall read a list of values of the switch.

⌋()

[SWS_EthIf_00210]

⌈

The function EthIf_GetDropCount shall be pre compile time configurable On/Off by the configuration parameter: EthIfGetDropCount.

⌋()

[SWS_EthIf_00211]

⌈



⌋()

[SWS_EthIf_00212]

⌈


DropCount for being valid. If the check fails, the function shall raise the default error


⌋()

[SWS_EthIf_00213]

⌈


⌋()

8.3.16 EthIf_StoreConfiguration

[SWS_EthIf_00214]

⌈

Service name:

Syntax:

EthIf_StoreConfiguration

Std_ReturnType

)


0x2c

Sync/Async:

Reentrancy:


Non Reentrant

40 of 77 uint8

EthIf_StoreConfiguration(

SwitchIdx

Document ID 417: AUTOSAR_SWS_EthernetInterface






Driver

Parameters

(inout):

None


None

Std_ReturnType

Return value:

E_OK: success

E_NOT_OK: switch port could not be initialized or unknown index

Description:

Stores the configuration of the learned MAC/Port tables of a switch in a persistent manner and will be used by e.g. CDD.

⌋()

[SWS_EthIf_00215]

⌈

The function EthIf_StoreConfiguration shall read a list of values of the switch.

⌋()

[SWS_EthIf_00216]

⌈

The function EthIf_StoreConfiguration shall be pre compile time configurable On/Off by the configuration parameter: EthIfStoreConfigurationApi.

⌋()

[SWS_EthIf_00217]

⌈



⌋()

[SWS_EthIf_00218]

⌈


⌋()

8.3.17 EthIf_ResetConfiguration

[SWS_EthIf_00219]

⌈

Service name:

Syntax:

EthIf_ResetConfiguration

Std_ReturnType

) uint8

EthIf_ResetConfiguration(

SwitchIdx


0x2d

Sync/Async:

Reentrancy:


Non Reentrant



Driver

Parameters

(inout):

None


None

Return value:



Description:

Resets the configuration of the learned MAC/Port tables of a switch in a persistent manner and will be used by e.g. CDD. The statically configured entries shall still remain.

⌋()

[SWS_EthIf_00220]

⌈

The function EthIf_ResetConfiguration shall read a list of values of the switch.

⌋()

[SWS_EthIf_00221]

⌈





The function EthIf_ResetConfiguration shall be pre compile time configurable On/Off by the configuration parameter: EthIfResetConfigurationApi.

⌋()

[SWS_EthIf_00222]

⌈



⌋()

[SWS_EthIf_00223]

⌈


⌋()

8.3.18 EthIf_GetCurrentTime

[SWS_EthIf_00154]

⌈

Service name:

Syntax:

EthIf_GetCurrentTime

Std_ReturnType uint8

Eth_TimeStampQualType*

Eth_TimeStampType*

)

EthIf_GetCurrentTime(

CtrlIdx, timeQualPtr, timeStampPtr


0x22

Sync/Async:

Reentrancy:

Synchronous

Non Reentrant


CtrlIdx

Parameters

(inout):

None


Return value:

timeQualPtr timeStampPtr

Std_ReturnType

Index of the addresses ETH controller. quality of HW time stamp, e.g. based on current drift current time stamp

E_OK:

E_NOT_OK: failed successful

Description:

Returns a time value out of the HW registers according to the capability of the HW.

Is the HW resolution is lower than the Eth_TimeStampType resolution resp. range, than an the remaining bits will be filled with 0.

⌋()

[SWS_EthIf_00155]

⌈



⌋()

[SWS_EthIf_00156]

⌈



⌋()

[SWS_EthIf_00157]

⌈

If default error detection is enabled: the function shall check the parameter timeQualPtr and timeStampPtr for being valid. If the check fails, the function shall raise the default error ETHIF_E_PARAM_POINTER.

⌋()

[SWS_EthIf_00158]

⌈





The function shall be pre compile time configurable On/Off by the configuration parameter: EthIfGlobalTimeSupport.

⌋()

[SWS_EthIf_00159]

⌈


⌋()

8.3.19 EthIf_EnableEgressTimeStamp

[SWS_EthIf_00160]

⌈

Service name:

Syntax:

EthIf_EnableEgressTimeStamp void

) uint8 uint8

EthIf_EnableEgressTimeStamp(

CtrlIdx,

BufIdx


0x23

Sync/Async:

Reentrancy:

Synchronous

Non Reentrant


CtrlIdx Index of the addresses ETH controller.

BufIdx Index of the message buffer, where Application expects egress time stamping

None

Parameters

(inout):


None

Return value:

None

Description:

Activates egress time stamping on a dedicated message object.

Some HW does store once the egress time stamp marker and some HW needs it always before transmission. There will be no â€œdisableâ€• functionality, due to the fact, that the message type is always "time stamped" by network design.

⌋()

[SWS_EthIf_00161]

⌈



⌋()

[SWS_EthIf_00162]

⌈



⌋()

[SWS_EthIf_00164]

⌈


⌋()

[SWS_EthIf_00165]

⌈


⌋()

8.3.20 EthIf_GetEgressTimeStamp

[SWS_EthIf_00166]

⌈

Service name:

Syntax:

EthIf_GetEgressTimeStamp void

43 of 77

EthIf_GetEgressTimeStamp(





) uint8 uint8


Eth_TimeStampType*

CtrlIdx,

BufIdx, timeQualPtr, timeStampPtr


0x24

Sync/Async:

Reentrancy:

Synchronous

Non Reentrant


CtrlIdx

BufIdx

Index of the addresses ETH controller.

Index of the message buffer, where Application expects egress time stamping

Parameters

(inout):

None


timeQualPtr quality of HW time stamp, e.g. based on current drift timeStampPtr current time stamp

Return value:

None

Description:

Reads back the egress time stamp on a dedicated message object.

It must be called within the TxConfirmation() function.

⌋()

[SWS_EthIf_00167]

⌈



⌋()

[SWS_EthIf_00168]

⌈



⌋()

[SWS_EthIf_00169]

⌈

If default error detection is enabled: the function shall check the parameter timeQualPtr and timeStampPtr for being valid. If the check fails, the function shall raise the default error ETHIF_E_PARAM_POINTER.

⌋()

[SWS_EthIf_00170]

⌈


⌋()

[SWS_EthIf_00171]

⌈


⌋()

8.3.21 EthIf_GetIngressTimeStamp

[SWS_EthIf_00172]

⌈

Service name:

Syntax:

EthIf_GetIngressTimeStamp void uint8

Eth_DataType*

EthIf_GetIngressTimeStamp(

CtrlIdx,

DataPtr,

)


Eth_TimeStampType* timeQualPtr, timeStampPtr


0x25





Sync/Async:

Reentrancy:


Synchronous

Non Reentrant


DataPtr Pointer to the message buffer, where Application expects ingress time stamping

None

Parameters

(inout):


timeQualPtr quality of HW time stamp, e.g. based on current drift timeStampPtr current time stamp

None

Return value:

Description:

Reads back the ingress time stamp on a dedicated message object.

It must be called within the RxIndication() function.

⌋()

[SWS_EthIf_00173]

⌈



⌋()

[SWS_EthIf_00174]

⌈



⌋()

[SWS_EthIf_00175]

⌈

If default error detection is enabled: the function shall check the parameter DataPtr, timeQualPtr and timeStampPtr for being valid. If the check fails, the function shall raise the default error ETHIF_E_PARAM_POINTER.

⌋()

[SWS_EthIf_00176]

⌈


⌋()

[SWS_EthIf_00177]

⌈


⌋()

8.3.22 EthIf_SetCorrectionTime

[SWS_EthIf_00178]

⌈

Service name:

Syntax:

EthIf_SetCorrectionTime void

) const const

EthIf_SetCorrectionTime( uint8

Eth_TimeIntDiffType*

CtrlIdx, timeOffsetPtr,

Eth_RateRatioType* rateRatioPtr


0x26

Sync/Async:

Synchronous

Reentrancy:

Non Reentrant



timeOffsetPtr offset between time stamp grandmaster and time stamp by local clock:

(OriginTimeStampSync[FUP]

– IngressTimeStampSync) + Pdelay rateRatioPtr time elements to calculate and to modify the ratio of the frequency of





the grandmaster in relation to the frequency of the Local Clock with: ratio = OriginTimeStampDelta / IngressTimeStampDelta

Parameters

(inout):

None


None

Return value:

None

Description:

Allows the Time Slave to adjust the local ETH Reference clock in HW.

⌋()

[SWS_EthIf_00179]

⌈



⌋()

[SWS_EthIf_00180]

⌈



⌋()

[SWS_EthIf_00181]

⌈

If default error detection is enabled: the function shall check the parameter timeOffsetPtr and timeRatioPtr for being valid. If the check fails, the function shall raise the default error ETHIF_E_PARAM_POINTER.

⌋()

[SWS_EthIf_00182]

⌈


⌋()

[SWS_EthIf_00183]

⌈


⌋()

8.3.23 EthIf_SetGlobalTime

[SWS_EthIf_00184]

⌈

Service name:

Syntax:

EthIf_SetGlobalTime

Std_ReturnType

) const

EthIf_SetGlobalTime( uint8

Eth_TimeStampType*

CtrlIdx, timeStampPtr


0x27

Sync/Async:

Reentrancy:

Synchronous

Non Reentrant


Parameters

(inout):

CtrlIdx timeStampPtr

None

Index of the addresses ETH controller. new time stamp


None

Return value:

Description:


E_NOT_OK: failed successful

Allows the Time Master to adjust the global ETH Reference clock in HW.

We can use this method to set a global time base on ETH in general or to synchronize the global ETH time base with another time base, e.g. FlexRay.

⌋()





[SWS_EthIf_00185]

⌈



⌋()

[SWS_EthIf_00186]

⌈



⌋()

[SWS_EthIf_00187]

⌈

If default error detection is enabled: the function shall check the parameter timeStampPtr for being valid. If the check fails, the function shall raise the default error ETHIF_E_PARAM_POINTER.

⌋()

[SWS_EthIf_00188]

⌈


⌋()

[SWS_EthIf_00189]

⌈


⌋()

8.3.24 EthIf_ProvideTxBuffer

[SWS_EthIf_00067]

⌈

Service name:

Syntax:

EthIf_ProvideTxBuffer

BufReq_ReturnType

)


0x09

Sync/Async:

Synchronous

Reentrancy:

Non Reentrant

CtrlIdx


Parameters

(inout):

FrameType

Priority

LenBytePtr uint8

Eth_FrameType uint8

Eth_BufIdxType* uint8** uint16*

EthIf_ProvideTxBuffer(

CtrlIdx,

FrameType,

Priority,

BufIdxPtr,

BufPtr,

LenBytePtr

Index of the Ethernet controller within the context of the

Ethernet Interface

Ethernet Frame Type (EtherType)

Priority value which shall be used for the 3-bit PCP field of the VLAN tag in: desired length in bytes, out: granted length in bytes


Return value:

Description:

⌋()

BufIdxPtr Index to the granted buffer resource. To be used for subsequent requests

Pointer to the granted buffer BufPtr

BufReq_ReturnType BUFREQ_OK: success

BUFREQ_E_NOT_OK: development error detected

BUFREQ_E_BUSY: all buffers in use

Provides access to a transmit buffer of the specified Ethernet controller.





[SWS_EthIf_00146]

⌈

If CtrlIdx refers to an EthIfCtrl where no EthIfVlanID is configured, the parameters FrameType and Priority are not used.

⌋()

[SWS_EthIf_00147]

⌈

If VLAN is used

- EthIf shall increment the input desired length by 4 bytes before calling the

Ethernet Driver module

- EthIf shall store the PCP (Priority parameter), CFI (always 0), VID (configured

VLAN ID) and value of the FrameType parameter at the beginning of the buffer received from Eth_ProvideTxBuffer).

- EthIf shall increment the BufPtr by 4 bytes when returning the granted buffer

- EthIf shall decrement the output granted length by 4 bytes

⌋()

[SWS_EthIf_00068]

⌈

The function EthIf_ProvideTxBuffer shall forward the call to the respective Ethernet

Controller Driver.

⌋()

[SWS_EthIf_00069]

⌈


ETHIF_E_NOT_INITIALIZED and return BUFREQ_E_NOT_OK.

⌋()

[SWS_EthIf_00070]

⌈


ETHIF_E_INV_CTRL_IDX and return BUFREQ_E_NOT_OK.

⌋()

[SWS_EthIf_00071]

⌈

If default error detection is enabled: the function shall check the parameter BufIdxPtr for being valid. If the check fails, the function shall raise the default error

ETHIF_E_PARAM_POINTER and return BUFREQ_E_NOT_OK.

⌋()

[SWS_EthIf_00072]

⌈

If default error detection is enabled: the function shall check the parameter BufPtr for being valid. If the check fails, the function shall raise the default error


⌋()

[SWS_EthIf_00073]

⌈


LenBytePtr for being valid. If the check fails, the function shall raise the default error


⌋()

[SWS_EthIf_00074]

⌈


⌋()





8.3.25 EthIf_Transmit

[SWS_EthIf_00075]

⌈

Service name:

Syntax:

EthIf_Transmit

Std_ReturnType uint8 const

Eth_BufIdxType

Eth_FrameType boolean uint16 uint8*

)

EthIf_Transmit(

CtrlIdx,

BufIdx,

FrameType,

TxConfirmation,

LenByte,

PhysAddrPtr


0x0a

Sync/Async:

Synchronous

Reentrancy:

Non Reentrant


Parameters

(inout):


Interface

FrameType Ethernet frame type

TxConfirmation Activates transmission confirmation

PhysAddrPtr Physical target address (MAC address) in network byte order

LenByte Data length in byte


BufIdx

Return value:

Index of the buffer resource


E_NOT_OK: transmission failed success

Description:

Triggers transmission of a previously filled transmit buffer

⌋()

[SWS_EthIf_00250]

⌈

If CtrlIdx refers to an EthIfCtrl where an EthIfVlanID is configured, the parameters

FrameType is not used, and 0x8100 is provided to Eth_Transmit instead.

⌋()

[SWS_EthIf_00076]

⌈

The function EthIf_Transmit shall forward the call to the respective Ethernet

Controller Driver.

⌋()

[SWS_EthIf_00077]

⌈



⌋()

[SWS_EthIf_00078]

⌈


ETHIF_E_INV_CTRL_IDX otherwise (if DET is disabled) return E_NOT_OK.

⌋()

[SWS_EthIf_00079]

⌈

If default error detection is enabled: the function shall check the parameter BufIdx for being valid. If the check fails, the function shall raise the default error

ETHIF_E_INV_PARAM otherwise (if DET is disabled) return E_NOT_OK.

⌋()





[SWS_EthIf_00080]

⌈



ETHIF_E_PARAM_POINTER otherwise (if DET is disabled) return E_NOT_OK.

⌋()

[SWS_EthIf_00081]

⌈

Caveat: The function requires previous buffer request (EthIf_ProvideTxBuffer).

⌋()

8.3.26 EthIf_GetVersionInfo

[SWS_EthIf_00082]

⌈

Service name:

Syntax:

EthIf_GetVersionInfo void

)

Std_VersionInfoType*

EthIf_GetVersionInfo(

VersionInfoPtr


0x0b

Sync/Async:

Synchronous

Reentrancy:

Reentrant


None

Parameters

(inout):

None


VersionInfoPtr Version information of this module

Return value:

None

Description:

Returns the version information of this module

⌋()

[SWS_EthIf_00127]

⌈


VersionInfoPtr for being valid. If the check fails, the function shall raise the default error ETHIF_E_PARAM_POINTER.

⌋()

8.4 Callback notifications

This is a list of functions provided for other modules. File EthIf_Cbk.h shall provide the function prototypes of the callback functions.

8.4.1 EthIf_RxIndication

[SWS_EthIf_00085]

⌈

Service name:

Syntax:

EthIf_RxIndication void

) const uint8

Eth_FrameType boolean uint8*

Eth_DataType* uint16

EthIf_RxIndication(

CtrlIdx,

FrameType,

IsBroadcast,

PhysAddrPtr,

DataPtr,

LenByte


0x10

Sync/Async:

Synchronous

Reentrancy:

Non Reentrant







Parameters

(inout):

LenByte

None


None

Interface

FrameType Frame type of received Ethernet frame

IsBroadcast parameter to indicate a broadcast frame

PhysAddrPtr Pointer to Physical source address (MAC address in network byte order) of received Ethernet frame

DataPtr Pointer to payload of received Ethernet frame.

Length of the received frame bytes

Return value:

None

Description:

⌋()

Handles a received frame received by the indexed controller

[SWS_EthIf_00086]

⌈



⌋()

[SWS_EthIf_00087]

⌈



⌋()

[SWS_EthIf_00088]

⌈

If default error detection is enabled: the function shall check the parameter DataPtr for being valid. If the check fails, the function shall raise the default error


⌋()

[SWS_EthIf_00151]

⌈

The Ethernet Driver shall indicate broadcast message with the parameter

‘IsBroadcast’ to the Ethernet Interface.

⌋()

[SWS_EthIf_00145]

⌈

If the VLAN is not active the Ethernet Interface shall filter the message.

⌋()

[SWS_EthIf_00089]

⌈


⌋()

[SWS_EthIf_00090]

⌈

Caveat: The function shall be callable on interrupt level.

⌋()

8.4.2 EthIf_TxConfirmation

[SWS_EthIf_00091]

⌈

Service name:

Syntax:

EthIf_TxConfirmation void

)


0x11

Sync/Async:

Synchronous

51 of 77 uint8

Eth_BufIdxType

EthIf_TxConfirmation(

CtrlIdx,

BufIdx





Reentrancy:

Non Reentrant


CtrlIdx Index of the Ethernet controller within the context of the Ethernet Interface

BufIdx Index of the transmitted buffer

Parameters

(inout):

None


None

Return value:

None

Description:

Confirms frame transmission by the indexed controller

⌋()

[SWS_EthIf_00092]

⌈



⌋()

[SWS_EthIf_00093]

⌈



⌋()

[SWS_EthIf_00094]

⌈

If default error detection is enabled: the function shall check the parameter BufIdx for being valid. If the check fails, the function shall raise the default error

ETHIF_E_INV_PARAM.

⌋()

[SWS_EthIf_00095]

⌈


⌋()

[SWS_EthIf_00096]

⌈

Caveat: The function shall be callable on interrupt level.

⌋()

8.4.3 EthIf_CtrlModeIndication

[SWS_EthIf_00231]

⌈

Service name:

Syntax:

EthIf_CtrlModeIndication void

) uint8

Eth_ModeType

EthIf_CtrlModeIndication(

CtrlIdx,

CtrlMode


0x0e

Sync/Async:

Synchronous

Reentrancy:



Interface


Parameters

(inout):

CtrlMode Notified Ethernet controller mode

None


None

Return value:

None

Description:

Called asynchronously when mode has been read out. Triggered by previous

Eth_SetControllerMode call. Can directly be called within the trigger functions.

⌋()





[SWS_EthIf_00252]

⌈

The function shall call EthSM_CtrlModeIndication.

⌋()

8.4.4 EthIf_TrcvModeIndication

[SWS_EthIf_00232]

⌈

Service name:

Syntax:

EthIf_TrcvModeIndication void

) uint8

EthTrcv_ModeType

EthIf_TrcvModeIndication(

CtrlIdx,

TrcvMode


0x0f

Sync/Async:

Synchronous

Reentrancy:




Interface

TrcvMode Notified Ethernet transceiver mode

Parameters

(inout):

None


None

Return value:

None

Description:

Called asynchronously when mode has been read out. Triggered by previous

Eth_SetTransceiverMode call. Can directly be called within the trigger functions.

⌋()

[SWS_EthIf_00253]

⌈

The function shall call EthSM_TrcvModeIndication.

⌋()

8.5 Scheduled functions

8.5.1 EthIf_MainFunctionRx

[SWS_EthIf_00097]

⌈

Service name:

Syntax:

EthIf_MainFunctionRx void

)

EthIf_MainFunctionRx( void


0x20

Description:

The function checks for new received frames and issues transmission confirmations in polling mode. It checks also for transceiver state changes.

⌋()

[SWS_EthIf_00098]

⌈



⌋()

[SWS_EthIf_00099]

⌈

The receive frame check shall be pre compile time configurable On/Off by the configuration parameter: ETHIF_ENABLE_RX_INTERRUPT.

⌋()





8.5.2 EthIf_MainFunctionTx

[SWS_EthIf_00113]

⌈

Service name:

Syntax:

EthIf_MainFunctionTx void

)

EthIf_MainFunctionTx( void


0x21

Description:

The function issues transmission confirmations in polling mode. It checks also for transceiver state changes.

⌋()

[SWS_EthIf_00124]

⌈



⌋()

[SWS_EthIf_00100]

⌈

The transmission confirmation check shall be pre compile time configurable On/Off by the configuration parameter: ETHIF_ENABLE_TX_INTERRUPT.

⌋()

[SWS_EthIf_00101]

⌈

The frequency of polling the transceiver state change shall be configurable by the configuration parameter: EthIfTrcvLinkStateChgMainReload.

⌋()

8.6 Expected Interfaces

This chapter lists all interfaces required from other modules.

8.6.1 Mandatory Interfaces

This chapter defines all interfaces required to fulfill the core functionality of the module.

[SWS_EthIf_00102]

⌈

API function

Dem_ReportErrorStatus

Eth_GetControllerMode

Eth_GetPhysAddr

Eth_ProvideTxBuffer

Eth_ReadMii

Description

Queues the reported events from the BSW modules (API is only used by BSW modules). The interface has an asynchronous behavior, because the processing of the event is done within the Dem main function.

OBD Events Suppression shall be ignored for this computation.

Obtains the state of the indexed controller

Obtains the physical source address used by the indexed controller

Provides access to a transmit buffer of the specified controller

Reads a transceiver register

Eth_Receive

Eth_SetControllerMode

Triggers frame reception

Enables / disables the indexed controller

Eth_Transmit

Eth_TxConfirmation

Triggers transmission of a previously filled transmit buffer

Triggers frame transmission confirmation

Eth_WriteMii Configures a transceiver register or triggers a function offered by the receiver

EthSM_CtrlModeIndication Called when mode has been read out. Either triggered by previous





EthIf_GetControllerMode or by EthIf_SetControllerMode call. Can directly be called within the trigger functions.

EthSM_TrcvModeIndication Called when mode has been read out. Either triggered by previous

EthIf_GetTransceiverMode or by EthIf_SetTransceiverMode call. Can directly be called within the trigger functions.

EthTrcv_GetDuplexMode

EthTrcv_GetLinkState

Obtains the duplex mode of the indexed transceiver

Obtains the link state of the indexed transceiver

EthTrcv_GetTransceiverMode Obtains the state of the indexed transceiver

EthTrcv_SetTransceiverMode Enables / disables the indexed transceiver

⌋()

8.6.2 Optional Interfaces

This chapter defines all interfaces required to fulfill an optional functionality of the module.

[SWS_EthIf_00103]

⌈

API function Description

Det_ReportError

Eth_GetCounterState

EthTrcv_GetBaudRate Obtains the baud rate of the indexed transceiver

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

SchM_Enter_EthIf

Service to report development errors.

Reads the value of a counter specified with its memory offset

SchM_Exit_EthIf

⌋()

Invokes the SchM_Enter function to enter a module local exclusive area.

Invokes the SchM_Exit function to exit an exclusive area.

8.6.3 Configurable interfaces

This chapter lists all interfaces with configurable target functions. The target function is usually a callback function. The function names are configurable.

[SWS_EthIf_00104]

⌈

Service name:

Syntax:

<User>_RxIndication void

) const uint8

Eth_FrameType boolean uint8* uint8* uint16

<User>_RxIndication(

CtrlIdx,

FrameType,

IsBroadcast,

PhysAddrPtr,

DataPtr,

LenByte


--

Sync/Async:

Reentrancy:

--

Dont care


Interface

FrameType frame type of received Ethernet frame


IsBroadcast parameter to indicate a broadcast frame

PhysAddrPtr pointer to Physical source address (MAC address in network byte order) of received Ethernet frame





DataPtr Pointer to payload of the received Ethernet frame (i.e. Ethernet header is not provided).

Length of received data.

Parameters

(inout):

LenByte

None


None

Return value:

None

Description:

Indicates the reception of an Ethernet frame

⌋()

[SWS_EthIf_00105]

⌈

The callback function shall be configurable by the configuration parameter:

EthIfRxIndicationFunction.

⌋()

[SWS_EthIf_00106]

⌈

Service name:

Syntax:

<User>_TxConfirmation void

) uint8

Eth_BufIdxType

<User>_TxConfirmation(

CtrlIdx,

BufIdx


--

Sync/Async:

Reentrancy:

--

Dont care


CtrlIdx Index of the Ethernet controller within the context of the Ethernet Interface

BufIdx Index of the buffer resource

Parameters

(inout):

None


None

Return value:

void --

Description:

Confirms the transmission of an Ethernet frame

⌋()

[SWS_EthIf_00107]

⌈


EthIfTxConfirmationFunction.

⌋()

[SWS_EthIf_00108]

⌈

Service name:

Syntax:

<User>_TrcvLinkStateChg void

) uint8

EthTrcv_LinkStateType

<User>_TrcvLinkStateChg(

CtrlIdx,

TrcvLinkState


--

Sync/Async:

Reentrancy:

--

Don’t care



Interface

TrcvLinkState ETHTRCV_LINK_STATE_DOWN transceiver link is down

ETHTRCV_LINK_STATE_ACTIVE transceiver link is up

Parameters

(inout):

Description:

⌋()

None


None

Return value:

None

Indicates the change of a transceiver state





[SWS_EthIf_00109]

⌈


EthIfTrcvLinkStateChgFunction.

⌋()

[SWS_EthIf_00229]

⌈

EthIfControllers not referring to an Ethernet Transceiver, i.e. no valid EthIfEthTrcvRef is configured, shall act as if the transceiver was present and the transceiver status was ETHTRCV_LINK_STATE_ACTIVE.

⌋()

[SWS_EthIf_00230]

⌈

Upon change of link state <User>_TrcvLinkStateChg shall be invoked for every affected EthIfController.

⌋()

Terms and definitions:

Reentrant: interface is reentrant

Don’t care: reentrancy of interface not relevant for this module (in general it is in this case not reentrant).





9 Sequence diagrams

The sequence diagrams show the basic operations carried out during operation.

They show the interaction of the Ethernet Interface with upper layer BSW module and the underlying Ethernet Controller Driver.

Please note that the sequence diagrams are an extension for illustrational purposes to ease understanding of the specification.

9.1 Initialization

Name:

Package:

Version:

Author:

EthIf_Initalization

EthIf

1.0

fix0ec2

«module»

:EcuM

«module»

:EthIf

EthIf_Init(const

EthIf_ConfigType*)

Eth_Init(const

Eth_ConfigType*)

EthTrcv_Init(const

EthTrcv_ConfigType*)

«module»

:Eth

«module»

:EthTrcv

Eth_WriteMii(Std_ReturnType, uint8, uint8, uint8, uint16)

Figure 5: Initialization





9.2 Communication Initialization

Name:

Package:

Version:

Author:

EthIf_CommunicationInitialization

EthIf

1.0

fix0ec2

«module»

:EthSM

«module»

:EthIf

EthIf_SetControllerMode(CtrlIdx,

ETH_MODE_ACTIVE)

Eth_SetControllerMode(CtrlIdx,

ETH_MODE_ACTIVE)

«module»

:Eth

«module»

:EthTrcv

EthIf_CtrlModeIndication(CtrlIdx,

ETH_MODE_ACTIVE)

EthSM_CtrlModeIndication(CtrlIdx,

ETH_MODE_ACTIVE)

EthIf_SetTransceiverMode(CtrlIdx,

ETHTRCV_MODE_ACTIVE)

EthTrcv_SetTransceiverMode(TrcvIdx,


EthSM_TrcvModeIndication(CtrlIdx,


Figure 6: Communication Initialization

EthIf_TrcvModeIndication(CtrlIdx,






9.3 Data Transmission

Name:

Package:

Version:

Author:

EthIf_DataTransmission

EthIf

1.0

fix0ec2

UL

EthIf_ProvideTxBuffer(BufReq_ReturnType, uint8, Eth_FrameType, uint8,

Eth_BufIdxType*, uint8**, uint16*)

«module»

:EthIf

Eth_ProvideTxBuffer(BufReq_ReturnType, uint8, Eth_BufIdxType*, uint8**, uint16*)

«module»

:Eth

EthIf_Transmit(Std_ReturnType, uint8,

Eth_BufIdxType, Eth_FrameType, boolean, uint16, const uint8*)

Eth_Transmit(Std_ReturnType, uint8,

Eth_BufIdxType, Eth_FrameType , boolean, uint16, const uint8*)

EthIf_MainFunctionTx()

Eth_TxConfirmation(void, uint8)

EthIf_TxConfirmation(uint8,

Eth_BufIdxType)

UL_TxConfirmation(CtrlIdx,

Bufidx)

Figure 7: Frame Transmission in Polling Mode

[SWS_EthIf_00115]

In each call of EthIf_MainFunctionTx the component shall call Eth_TxConfirmation for all Ethernet Controller Drivers.

Note: The Ethernet Interface expects that each Ethernet Controller Driver issues confirmations for all transmitted frames using the call-back function

EthIf_Cbk_TxConfirmation.

[SWS_EthIf_00125]

EthIf_Cbk_TxConfirmation shall forward the confirmation to the registered call-back functions <User>_TxConfirmation.





Name:

Package:

Version:

Author:

EthIf_TransmissionInterrupt

EthIf

1.0

fix0ec2

UL

EthIf_ProvideTxBuffer(BufReq_ReturnType, uint8, Eth_FrameType, uint8,

Eth_BufIdxType*, uint8**, uint16*)

«module»

:EthIf

Eth_ProvideTxBuffer(BufReq_ReturnType, uint8, Eth_BufIdxType*, uint8**, uint16*)

«module»

:Eth

Eth_TxIrqHdlr_<CtrlIdx>(void)

EthIf_TxConfirmation(uint8,

Eth_BufIdxType)

UL_TxConfirmation(CtrlIdx,

BufIdx)

Figure 8: Frame Transmission in Interrupt Mode

9.4 Data Reception

Name:

Package:

Version:

Author:

EthIf_DataReception

EthIf

1.0

fix0ec2

UL

«module»

:EthIf

EthIf_MainFunctionRx()

Eth_Receive(uint8,

Eth_RxStatusType*)

EthIf_RxIndication(uint8, Eth_FrameType, boolean, const uint8*, Eth_DataType*, uint16)

UL_RxIndication(CtrlIdx, DataPtr,

LenByte)

«module»

:Eth





Figure 9: Frame Reception in Polling Mode

Name:

Package:

Version:

Author:

EthIf_ReceptionInterrupt

EthIf

1.0

fix0ec2

UL

«module»

:EthIf

UL_RxIndication(CtrlIdx, DataPtr,

LenByte)

EthIf_RxIndication(uint8, Eth_FrameType, boolean, const uint8*, Eth_DataType*, uint16)

«module»

:Eth

Eth_RxIrqHdlr_<CtrlIdx>(void)

Figure 10: Frame Reception in Interrupt Mode

9.5 Link State Change

Name:

Package:

Version:

Author:

EthIf_LinkStateChange

EthIf

1.0

fix0ec2

UL

«module»

:EthIf

EthIf_MainFunctionRx()

EthTrcv_GetLinkState(Std_ReturnType, uint8, EthTrcv_LinkStateType*)

«module»

:EthTrcv

UL_LinkStateChange(CtrlIdx, LinkState)

Figure 11: Link State Change





10 Configuration specification

In general, this chapter defines configuration parameters and their clustering into containers. In order to support the specification Chapter 10.1 describes fundamentals. It also specifies a template (table) you shall use for the parameter specification. We intend to leave Chapter 10.1 in the specification to guarantee comprehension.

Chapter 10.2 specifies the structure (containers) and the parameters of the module

Ethernet Interface.

Chapter 10.3 specifies published information of the module Ethernet Interface.

10.1 Containers and configuration parameters

The following chapters summarize all configuration parameters. The detailed

meanings of the parameters describe Chapters 7 and Chapter 8.





EthIf :EcucModuleDef lowerMultiplicity = 0 upperMultiplicity = 1

+container

EthIfGeneral :

EcucParamConfContainerDef

+parameter EthIfDevErrorDetect :

EcucBooleanParamDef

+parameter

EthIfMaxT rcvsT otal :

EcucIntegerParamDef min = 1 max = 255

+parameter EthIfEnableRxInterrupt :

EcucBooleanParamDef

+parameter EthIfEnableT xInterrupt :

EcucBooleanParamDef

+parameter EthIfVersionInfoApi :

EcucBooleanParamDef

+parameter EthIfVersionInfoApiMacro :

EcucBooleanParamDef

+parameter

EthIfT rcvLinkStateChgMainReload :


+parameter

EthIfMainFunctionPeriod :

EcucFloatParamDef

+parameter min = 0 max = INF EthIfPublicCddHeaderFile :

EcucStringParamDef

+parameter lowerMultiplicity = 0 upperMultiplicity = * minLength = 1 maxLength = 32

EthIfRxIndicationIterations :


+parameter

EthIfMainFunctionRxT imeout :

EcucFloatParamDef min = 0 max = INF

+parameter EthIfStartAutoNegotiation :

EcucBooleanParamDef

+parameter EthIfGetBaudRate :

EcucBooleanParamDef

+parameter EthIfGetCounterState :

EcucBooleanParamDef

Figure 10.1: Ethernet Interface general configuration structure





EthIf :EcucModuleDef lowerMultiplicity = 0 upperMultiplicity = 1

+container

EthIfConfigSet :

EcucParamConfContainerDef

+subContainer

EthIfFrameOwnerConfig :

EcucParamConfContainerDef lowerMultiplicity = 1 upperMultiplicity = *

+parameter

EthIfFrameType :


+parameter

EthIfOwner :


+subContainer

EthIfRxIndicationConfig :


+parameter EthIfRxIndicationFunction :

EcucFunctionNameDef

+subContainer

EthIfTxConfirmationConfig :


+parameter EthIfTxConfirmationFunction :

EcucFunctionNameDef

+subContainer

EthIfTrcvLinkStateChgConfig :


EthIfController :


+parameter EthIfTrcvLinkStateChgFunction :

EcucFunctionNameDef

EthCtrlIdx :EcucIntegerParamDef min = 0 max = 255 symbolicNameValue = true

EthIfCtrlIdx :

EcucIntegerParamDef

+parameter min = 0 max = 255 symbolicNameValue = true

+reference

EthIfEthCtrlRef :

EcucSymbolicNameReferenceDef

+destination

EthCtrlConfig :EcucParamConfContainerDef lowerMultiplicity = 1 upperMultiplicity = *

+subContainer

+reference

EthIfEthTrcvRef :

EcucSymbolicNameReferenceDef lowerMultiplicity = 0 upperMultiplicity = 1

+destination

(from Eth)

EthTrcvConfig :EcucParamConfContainerDef lowerMultiplicity = 1 upperMultiplicity = *

(from EthTrcv)

EthIfVlanId :

EcucIntegerParamDef

+parameter min = 0 max = 4095 lowerMultiplicity = 0 upperMultiplicity = 1

+parameter

EthTrcvIdx :

EcucIntegerParamDef

+parameter

EthIfCtrlMtu :

EcucIntegerParamDef min = 64 max = 9000 min = 0 max = 255 symbolicNameValue = true

(from EthTrcv)

+subContainer

EthIfSwitch :


+parameter

EthIfMaxTxBufsTotal :


+parameter

EthIfSwitchIdx :EcucIntegerParamDef min = 0 max = 255 symbolicNameValue = true

EthSwtIdx :

EcucIntegerParamDef min = 0 max = 255 symbolicNameValue = true

+parameter

(from EthSwt)

+reference EthIfSwitchRef :

EcucSymbolicNameReferenceDef

+destination

EthSwtConfig :


(from EthSwt)

Figure 10.2: Ethernet Interface Interface configuration structure





10.1.1 Variants

VARIANT-POST-

BUILD: All configuration parameters in container ‘EthGeneral’ shall be configurable at pre-compile time.

Use case: Object code delivery, selectable configuration

VARIANT-LINK-TIME

: All configuration parameters in container ‘EthGeneral’ shall be configurable at pre-compile time.

Use case: Object code delivery, single configuration

VARIANT-PRE-COMPILE: All configuration parameters shall be configurable at precompile time.

Use case: Execution time optimizations, fix configuration

10.1.2 EthIf

Module Name

Module Description

EthIf

Configuration of the EthIf (Ethernet Interface) module.

Post-Build Variant Support

true

Included Containers

Container Name

EthIfConfigSet

EthIfGeneral

Multiplicity Scope / Dependency

1

Collecting container for all parameters with post-build configuration classes.

1

This container contains the general configuration parameters of the Ethernet Interface.

10.1.3 EthIfGeneral

SWS Item


Description

ECUC_EthIf_00001 :

EthIfGeneral

This container contains the general configuration parameters of the

Ethernet Interface.

Configuration Parameters

SWS Item

Name

Description


EthIfDevErrorDetect

Switches the Default Error Tracer (Det) detection and notification ON or

OFF.

 true: enabled (ON).

 false: disabled (OFF).

Multiplicity

Type

Default value

1

EcucBooleanParamDef

--

Post-Build Variant Value

false





Value Configuration Class Pre-compile time

Link time

Post-build time

scope: local

Scope / Dependency

SWS Item

Name

Description

X All Variants

--

--


EthIfEnableRxInterrupt

Enables / Disables receive interrupt.

Multiplicity

Type


1

EcucBooleanParamDef

Default value

--


false


Link time


scope: local

X All Variants

--

--

SWS Item

Name

Description

Multiplicity

Type


EthIfEnableTxInterrupt

Enables / Disables the transmit interrupt.

1

EcucBooleanParamDef

Default value

--


false


Link time


scope: local


SWS Item

Name

Description

Multiplicity


EthIfGetBaudRate

X All Variants

--

--

Enables / Disables GetBaudRate API.

1

Type

Default value

EcucBooleanParamDef

--


false


Link time


scope: local


SWS Item

Name

Description

Multiplicity


EthIfGetCounterState

X All Variants

--

--

Enables / Disables GetCounterState API.

1

Type

Default value

EcucBooleanParamDef

--


false


Link time


scope: local


SWS Item

Name


X All Variants

--

--

EthIfGetTransceiverWakeupModeApi





Description

Multiplicity

Enables / Disables EthIf_GetTransceiverWakeupMode API

0..1

Type

EcucBooleanParamDef

Default value

Post-Build

false

Variant

false

Multiplicity


false

Multiplicity Configuration Pre-compile time

Class

Link time




Link time

X All Variants

--

--

X All Variants

--


-- scope: dependency: Only valid if EthIfWakeUpSupport is TRUE local

SWS Item

Name

Description


EthIfGlobalTimeSupport

Multiplicity

Type


Enables/Disables the Global Time APIs used amongst others by Global

Time Synchronization over Ethernet.

1

EcucBooleanParamDef

Default value

--


false


Link time


scope: local

X All Variants

--

--

SWS Item

Name

Description


EthIfMainFunctionPeriod

Multiplicity

Type

Specifies the period of main function EthIf_MainFunctionRx and

EthIf_MainFunctionTx in seconds. Ethernet Interface does not require this information but the BSW scheduler.

1

Range

Default value

EcucFloatParamDef

0 .. INF

--


false



Link time


scope: local

SWS Item

Name

Description

Multiplicity

Type

Range

Default value

X All Variants

--

--

ECUC_EthIf_00031 : (Obsolete)

EthIfMainFunctionRxTimeout

This parameter is deprecated and will be removed in future.

Old description: Timeout in seconds after which the EthIf stops to receive frames in an EthIfMainFunctionRx period.

Tags:

atp.Status=obsolete atp.StatusRevisionBegin=4.2.2

0..1

EcucFloatParamDef

0 .. INF

--






false


Link time


scope: local


SWS Item

Name

Description

Multiplicity


EthIfMaxTrcvsTotal

X All Variants

--

--

Limits the total number of transceivers.

1

Type

Range

Default value

EcucIntegerParamDef

1 .. 255

--


false


Link time


scope: local


SWS Item

Name

Description


EthIfPublicCddHeaderFile

X All Variants

--

--

Defines header files for callback functions which shall be included in case of CDDs. Range of characters is 1.. 32.

Multiplicity

Type

Default value maxLength minLength

0..*

EcucStringParamDef

--

32

1

regularExpression

Post-Build

--

Variant

false

Multiplicity


false


Class

Link time


X All Variants

--


Link time


scope: ECU


SWS Item

Name

Description


EthIfRxIndicationIterations

--

X All Variants

--

--

Maximum number of Ethernet frames per Ethernet controller polled from the Ethernet driver within EthIf_MainFunctionRx.

0..1

Multiplicity

Type

Range

EcucIntegerParamDef

0 .. 65535

Default value

--


false


Link time


scope: local

X All Variants

--

--


SWS Item

Name


EthIfStartAutoNegotiation





Description

Multiplicity

Enables / Disables StartAutoNegotiation API.

1

Type

EcucBooleanParamDef

Default value

--


false



Link time


scope: local

X All Variants

--

--

SWS Item

Name

Description


EthIfTrcvLinkStateChgMainReload

Specifies the frequency of transceiver link state change checks in each period of main function EthIf_MainFunctionTx.

1

Multiplicity

Type

Range

Default value

EcucIntegerParamDef

1 .. 255

--


false



Link time


scope: local

X All Variants

--

--

SWS Item

Name

Description

Multiplicity


EthIfVersionInfoApi

Enables / Disables version info API

1

Type

Default value

EcucBooleanParamDef

--


false


Link time


scope: local

X All Variants

--

--


SWS Item

Name

Description

Multiplicity


EthIfVersionInfoApiMacro

Enables / Disables version info API macro implementation.

1

Type

Default value

EcucBooleanParamDef

--


false


Link time


scope: local

X All Variants

--

--


SWS Item

Name

Description

Multiplicity


EthIfWakeUpSupport

Configures if wakeup is supported or not.

1

Type

Default value

EcucBooleanParamDef false


false




Link time


scope: local


No Included Containers



X All Variants

--

--

10.1.4 EthIfConfigSet

SWS Item


Description


EthIfConfigSet

Collecting container for all parameters with post-build configuration classes.


Included Containers


EthIfController

EthIfFrameOwnerConfig

EthIfRxIndicationConfig

Multiplicity Scope / Dependency

1..* This container contains the configuration of EthIfController.

1..* Configuration of Ethernet frame owner

1..* Configuration of receive callback functions.

EthIfSwitch 0..* This container contains the configuration of EthIfSwitches.

EthIfTrcvLinkStateChgConfig 1..* Specifies link state change callback function

0..* Configuration of transmit indication callback functions. EthIfTxConfirmationConfig

10.1.5 EthIfController

SWS Item


Description


SWS Item

Name

Description

Multiplicity

Type

Range

Default value


EthIfController

This container contains the configuration of EthIfController.


EthIfCtrlIdx

This parameter provides a zero-based consecutive index of the Ethernet

Communication Controllers. Upper layer BSW modules and the EthIf itself use this index to identify a Ethernet CC.

1

EcucIntegerParamDef (Symbolic Name generated for this parameter)

0 .. 255

--


false



Link time


scope: ECU

SWS Item

Name

Description

X All Variants

--

--


EthIfCtrlMtu

Specifies the maximum transmission unit (MTU) of the EthIfCtrl in [bytes].

Note: in case a VLAN tag is used for the EthIfCtrl, the MTU is 4 bytes





smaller than the maximum payload size of an Ethernet frame which can be transmitted on the network.

1

Multiplicity

Type

Range

EcucIntegerParamDef

64 .. 9000

Default value

--


true


X VARIANT-PRE-COMPILE


Link time


scope: dependency: EthIfVlanId

X VARIANT-LINK-TIME

X VARIANT-POST-BUILD

ECU

SWS Item

Name

Description

Multiplicity

Type



EthIfMaxTxBufsTotal

Limits the total number of transmit buffers.

1

EcucIntegerParamDef

Range

Default value

1 .. 255

--


false


Link time


scope: local

X All Variants

--

--

SWS Item

Name

Description

Multiplicity


EthIfVlanId

A virtual-LAN is identified by this attribute according to IEEE 802.1Q.

0..1

Type

Range

EcucIntegerParamDef

0 .. 4095

Default value

Post-Build

Multiplicity

Variant

-- true


true


Class

Link time



Link time



scope: ECU


X VARIANT-LINK-TIME



X VARIANT-LINK-TIME


SWS Item



Name

Description

EthIfEthCtrlRef

Reference to a Controller, which is handled by a specific Driver. This reference is unique for the ECU.

1

Multiplicity

Type

Symbolic name reference to [ EthCtrlConfig ]


true


Link time


scope: ECU


X VARIANT-LINK-TIME






SWS Item

Name

Description

Multiplicity

Type


EthIfEthTrcvRef

Reference to a Ethernet Transceiver.

0..1

Symbolic name reference to [ EthTrcvConfig ]

Post-Build

Multiplicity

Variant

true


true


Class

Link time



Link time


scope: ECU




X VARIANT-LINK-TIME



X VARIANT-LINK-TIME


10.1.6 EthIfFrameOwnerConfig

SWS Item


Description


SWS Item

Name

Description

Multiplicity

Type


EthIfFrameOwnerConfig

Configuration of Ethernet frame owner


EthIfFrameType

Selects the Ethernet frame type.

1

EcucIntegerParamDef

Range

Default value

0 .. 65535

--


true


Link time


scope: local


X VARIANT-LINK-TIME



SWS Item

Name

Description


EthIfOwner

Multiplicity

Type

Range

Default value

Selects the owner of an Ethernet frame type. The owner is a zero based index into the callback function configuration 'EthIfRxIndicationConfig'. I.e. an Ethernet frame of type IPv4 (0x800) at index 0 will call the first callback function configured in 'EthIfRxIndicationConfig'.

1

EcucIntegerParamDef

0 .. 255

--


true


Link time



X VARIANT-LINK-TIME



scope: local






10.1.7 EthIfRxIndicationConfig

SWS Item


Description


SWS Item

Name

Description

Multiplicity

Type

Default value maxLength minLength


EthIfRxIndicationConfig

Configuration of receive callback functions.


EthIfRxIndicationFunction

Specifies receive indication callback function.

1

EcucFunctionNameDef

--

--

--


--


true


Link time



scope: local



X VARIANT-LINK-TIME


10.1.8 EthIfSwitch

SWS Item


Description


EthIfSwitch

This container contains the configuration of EthIfSwitches.


SWS Item

Name

Description


EthIfSwitchIdx

This parameter provides a zero-based consecutive index of the Ethernet

Interface Switches. Upper layer BSW modules and the EthIf itself use this index to identify a Ethernet Switch.

1

Multiplicity

Type

Range

EcucIntegerParamDef (Symbolic Name generated for this parameter)

0 .. 255

Default value

--


false



SWS Item

Link time


scope: ECU


X All Variants

--

--





Name

Description

Multiplicity

Type

EthIfSwitchRef

Reference to a Ethernet Switch, which is handled by a specific Ethernet

Switch driver.


true


Link time



1

Symbolic name reference to [ EthSwtConfig ]


scope: ECU


X VARIANT-LINK-TIME


10.1.9 EthIfTrcvLinkStateChgConfig

SWS Item


Description


SWS Item

Name


EthIfTrcvLinkStateChgConfig

Specifies link state change callback function

Description

Multiplicity

Type

Default value


EthIfTrcvLinkStateChgFunction

Specifies link state change callback function

1

EcucFunctionNameDef

--

maxLength minLength

--

--


--


true




Link time


scope: local


X VARIANT-LINK-TIME


10.1.10 EthIfTxConfirmationConfig

SWS Item


Description


SWS Item

Name

Description

Multiplicity

Type


EthIfTxConfirmationConfig

Configuration of transmit indication callback functions.


EthIfTxConfirmationFunction

Specifies transmit indication callback function

1

EcucFunctionNameDef





Default value maxLength

--

--

minLength

--


--


true


Link time


scope: local




X VARIANT-LINK-TIME






11 Not applicable requirements

[SWS_EthIf_00999]

These requirements are not applicable to this specification (BSW00170).



Specification of Ethernet Interface

8.4 Callback notifications

8.5 Scheduled functions

8.6 Expected Interfaces

9 Sequence diagrams

9.1 Initialization

9.2 Communication Initialization

9.3 Data Transmission

9.4 Data Reception

9.5 Link State Change

10 Configuration specification

10.1 Containers and configuration parameters

11 Not applicable requirements

Related manuals

Table of contents

Specification of Ethernet Interface

8.4 Callback notifications

8.5 Scheduled functions

8.6 Expected Interfaces

9 Sequence diagrams

9.1 Initialization

9.2 Communication Initialization

9.3 Data Transmission

9.4 Data Reception

9.5 Link State Change

10 Configuration specification

10.1 Containers and configuration parameters

11 Not applicable requirements

Related manuals

ETAS

RTA-FBL

ETAS

RTA-BSW

ETAS

INTECRIO

ETAS

ASCET-SE

ETAS

RTA-RTE

ETAS

INTECRIO

ETAS

RTA-RTE

ETAS

AUTOSAR

Table of contents