Ethernet Switch Driver (EthSwt)

Initializes the Ethernet Switch Driver

Enables/disables the indexed switch port

Obtains the mode of the indexed switch port

Starts the auto-negotiation of the indexed switch port

Obtains the link state of the indexed switch port

Obtains the baud rate of the indexed switch port

Obtains the duplex mode of the indexed switch port

Returns the version information of this module.

Obtains the port over which this MAC-address at the indexed switch can be reached. The result might be used for a DHCP-server which will need the port/MAC-resolution. If for the PortIdxPtr the maximal possible value (255) is returned the given MAC address cannot be reached via a port of this switch. If multiple ports were found the API returns E_NOT_OK.

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

The function shall request to reset and store the configuration of the learned MAC/Port tables of a Ethernet switch in a persistent manner. This could be used by e.g. a CDD.

Obtains the address resolution table of a switch and copies the list into a user provided buffer. The function will copy all or numberOfElements into the output list. If input value of numberOf Elements is 0 the function will not copy any data but only return the number of valid entries in the cache. arlTableListPointer may be NULL_PTR in this case.

Service to support asynchronous behavior of API calls

Is called, if a link which is configured goes down.

Function will be called by the NVRAMManager after the switch configuration has been stored or resetted.

Enables or disables a pre-configured VLAN at a certain port of a switch.

Sets the MAC learning mode in one of the tree modes: 1.) HW learning enabled, 2.) Hardware learning disabled, 3.) Software learning enabled. Note: This feature is hardware dependent, i.e. the switch hardware needs to support the different learning modes.

Returns the MAC learning mode, i.e. 1.) HW learning enabled, 2.) Hardware learning disabled, 3.) Software learning enabled. Note: This feature is hardware dependent, i.e. the switch hardware needs to support the different learning modes

Job end notification of EthSwt_StoreConfiguration or EthSwt_ResetConfiguration

Returns a list of statistic counters defined with Eth_RxTatsType. The majority of these Counters are derived from the IETF RFC2819.

Is called, if a link which is configured goes up

Generic API for reading the content of a switch register

Generic API for writing the content of a switch register

Generic API for reading the content of a transceiver register

Generic API for writing the content of a transceiver register

Reads a list with drop counter values of the corresponding port of the switch. The meaning of these values is described at Eth_CounterType.

Returns the list of Transmission Error Counters out of IETF RFC1213 and RFC1643 defined with Eth_TxErrorCounterValuesType, where the maximal possible value shall denote an invalid value, e.g. this counter is not available.

Returns the list of Transmission Statistics out of IETF RFC1213 defined with Eth_TxStatsType, where the maximal possible value shall denote an invalid value, e.g. this counter is not available.

API is called by EthIf. The Ethernet switch driver request to check for a wake-up at all Ethernet switch ports which reference an EthTrcv. For those Ethernet switch ports the call is forwarded to the referenced EthTrcv. The function could be called in context of an interrupt service routine or on task level Note: Interrupt service routine consuming time has to be considered, since all EthSwtPorts of the maintained Ethernet switches has to be checked. Therefore the call is forwarded to the referred EthTrcv where the request to check for wake-up is stored. The check of the Ethernet hardware is done asynchronously in the context of the EthTrcv_MainFunction.

Function inspects the Ethernet frame passed by the data pointer for management information and stores it for later use in EthSwt_EthRxFinishedIndication().

Indication for a finished receive process for a specific Ethernet frame, which results in providing the management information retrieved during EthSwt_EthRxProcessFrame().

Prepares the Ethernet frame for common Ethernet communication (frame shall be handled by switch according to the common address resolution behavior) and stores the information for processing of EthSwt_EthTxFinishedIndication().

Modifies the buffer length to be able to insert management information.

Extends the Ethernet frame prepared previously by EthSwt_EthTxPrepareFrame() with the management information to achieve transmission only on specific ports.

Function inserts management information into the Ethernet frame.

Indication for a finished transmit process for a specific Ethernet frame.

Trigger the cable diagnostics of the given Ethernet Switch port (PortIdx) by calling EthTrcv_Run CableDiagnostic of the referenced Ethernet transceiver.

Verifies the Switch Configuration depending on the HW-Architecture, HW-capability and the intended accuracy of this verification.

Configures switch to start or stop forwarding for all ports. This API call may be used during switch configuration verification.

The function retrieves the signal quality of the link of the indexed Ethernet switch port. If no transceiver is referenced the signal quality shall be set to 0xFFFFFFFF.

This function retrieves the OUI (24 bit) of the indexed Ethernet switch port.

Obtain the Organizationally Unique Identifier that is given by the IEEE of the indexed Ethernet switch. This function shall provide the OUI of Ethernet switch. The OUI has a size of 24 bit. If a ethernet switch can provide the OUI the 8 most significant bits of the OUI shall be set to 0x00xxxxxx. If a Ethernet switch can not provide the OUI the 8 most significant bits of the OUI shall be set to 0xFFxxxxxx.

Store the given port mirror configuration in a shadow buffer in the Ethernet switch driver for the given MirroredSwitchIdx.

Obtain the port mirror configuration of the given Ethernet switch.

Obtain the current status of the port mirroring for the indexed Ethernet switch port

Request to set the given port mirroring state of the port mirror configuration for the given Ethernet switch.

Activates a given test loop-back mode of the indexed Ethernet switch port.

Activates a given transmission mode of the indexed Ethernet switch port.

Retrieves the cable diagnostics result of the indexed Ethernet switch port respectively the referenced Ethernet Transceiver Driver.

Activates egress time stamping on a dedicated message object on a dedicated port of a Switch if EthSwtPortTimeStampSupport is set to TRUE for this port. The selective activation of dedicated message objects for time stamping reduces the number of notification calls only to the required calls. Some HW does store once the egress time stamp marker and some HW needs it always before transmission. There will be no disabled functionality, due to the fact, that the message type is always "time stamped" by network design.

Activates a given test mode of the indexed Ethernet switch port.

Retrieves the data in memory of the indexed Ethernet switch in variable length

Retrieves the total size of data and the memory start address of the indexed Ethernet Switch.

The call of the function EthSwt_GetCfgDataRaw() triggers a asynchrony read of a certain memory section of the Ethernet switch driver. If the read is done, the configured callout function <GetCfgDataRawDone> shall be called]

Delete the stored port mirror configuration of the given MirroredSwitchIdx. If no port mirror configuration was found for the given MirroredSwitchIdx, the return value shall be E_OK.

Obtains the MgmtObject of the (in this context) unique DataPtr.

Obtains the MgmtObject of the (in this context) unique BufIdx.

This function obtains the wake up reasons of the the indexed Ethernet switch port by calling Eth Trcv_GetBusWuReason(...) of the referenced EthTrcv

This function is called by an upper layer application (e.g. diagnostic application) via the EthIf module to control the activity status of a configured stream (given with StreamHandleIdx) within an dedicated Ethernet switch (given with SwitchIdx). Tags: atp.Status=draft

Requests the bucket counter values from the switch Tags: atp.Status=draft

Extracts the StreamHandleIdx from the switch vendor specific part of the network packet header Tags: atp.Status=draft

The function retrieves the maximum amount of allocated FIFO buffer of the indexed Ethernet switch egress port. If the Ethernet switch hardware does not support Ethernet switch port based maximal FIFO buffer level, the content of SwitchPortEgressFifoBufferLevelPtr shall be set to 0xFFFFFFFF. This API may be called by e.g. a CDD.

Obtains an Ethernet switch port bit map, where the given MAC-address with respect to the given VLAN-ID is assigned to. The return argument PortBitMapPtr points to uint32 value which shall be handled as Ethernet switch port bit map. Each bit of the Ethernet switch port bit map represents an EthSwtPortIdx, where the least significant bit (bit 0) represents EthSwitchPortIdx 0 and most significant bit (bit 32) represents EthSwitchPortIdx 31 (e.g. 0x0001 == EthSwitch PortIdx 0 is set; 0x8005 == EthSwitchPortIdx 0, 2 and 31 are set).

Reads a transceiver register using Clause 45 access if supported by hardware or implements a Clause 45 access using Clause 22 operations.

Generic API for writing the content of a transceiver register

The background task should be scheduled as often as possible when no other task runs. It may be used for switch and port initialization in case the EthSwt_Init function needs too much time.

Request a link state by calling EthTrcv_TransceiverLinkStateRequest with the TrcvIdx of the Ethernet transceiver which is referenced by the Ethernet Switch port (PortIdx).

Requests the Ethernet Switch 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 Switch Driver to configure a Reception Secure Channel for the given Secure Channel Identifier. Tags: atp.Status=DRAFT

Requests the Ethernet Switch 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 Switch 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

Requests the Ethernet Switch 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

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

Request the Ethernet Switch 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 Switch 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 Switch Driver to remove the Reception Secure Association identified by the provided Association Number. Tags: atp.Status=DRAFT

Request the Ethernet Switch 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 Switch Driver to provide MACsec statistics. Tags: atp.Status=DRAFT

Callback to notify that EthSwt_MacSecUpdateSecY finished. Tags: atp.Status=DRAFT

Callback to notify that EthSwt_MacSecAddTxSa finished. Tags: atp.Status=DRAFT

Callback to notify that EthSwt_MacSecAddRxSa finished. Tags: atp.Status=DRAFT

Callback to notify that EthSwt_MacSecGetMacSecStats finished and provide the requested statistics. Tags: atp.Status=DRAFT

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

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

Implementation specific structure of the post build configuration.

The interpretation of this value

Type for holding the management information received/transmitted on Switches (ports).

The EthSwt_PortMirrorCfgType specify the port mirror configuration which is set up per Ethernet switch. The configuration is written to the Ethernet switch driver by calling EthSwt_WritePortMirror Configuration. One port mirror configuration is maintained per Ethernet Switch.

Type to request or obtain the port mirroring state (enable/disable) for a particular port mirror configuration per Ethernet switch.

Holds information if upper layer or EthSwt is owner of mgmt_obj.

Will be set from EthSwt and marks EthSwt_MgmtObject as valid or not. So the upper layer will be able to detect inconsistencies.

Provides information about all struct member elements. The ownership gives information whether EthSwt has finished its activities in providing all struct member elements.

Type of error Related error code Error value Invalid switch index ETHSWT_E_INV_SWITCH_IDX 0x01 EthSwt module was not initialized ETHSWT_E_UNINIT 0x02 Invalid pointer in parameter list ETHSWT_E_PARAM_POINTER 0x03 Invalid API which is not available by another module ETHSWT_E_INV_API 0x05 Invalid switch port index ETHSWT_E_INV_SWITCHPORT_IDX 0x06 Invalid Controller Index ETHSWT_E_INV_CTRL_IDX 0x07 Invalid input parameter ETHSWT_E_INV_PARAM 0x08 Invalid configuration ETHSWT_E_INIT_FAILED 0x09

Module Header File Imported Type Rte_Dem_Type.h Dem_EventIdType Dem Rte_Dem_Type.h Dem_EventStatusType Eth_GeneralTypes.h Eth_BufIdxType Eth_GeneralTypes.h Eth_CounterType Eth_GeneralTypes.h Eth_DataType Eth_GeneralTypes.h Eth_MacVlanType Eth_GeneralTypes.h Eth_ModeType Eth_GeneralTypes.h Eth_RxStatsType Eth_GeneralTypes.h Eth_TimeStampType Eth_GeneralTypes.h Eth_TxErrorCounterValuesType Eth Eth_GeneralTypes.h Eth_TxStatsType Eth_GeneralTypes.h EthTrcv_BaudRateType Eth_GeneralTypes.h EthTrcv_CableDiagResultType Eth_GeneralTypes.h EthTrcv_DuplexModeType Eth_GeneralTypes.h EthTrcv_LinkStateType Eth_GeneralTypes.h EthTrcv_PhyLoopbackModeType Eth_GeneralTypes.h EthTrcv_PhyTestModeType Eth_GeneralTypes.h EthTrcv_PhyTxModeType EthTrcv Eth_GeneralTypes.h EthTrcv_WakeupReasonType 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) Rte_NvM_Type.h NvM_BlockIdType Rte_NvM_Type.h NvM_BlockRequestType NvM Rte_NvM_Type.h NvM_RequestResultType Spi.h Spi_AsyncModeType Spi.h Spi_ChannelType Spi.h Spi_DataBufferType Spi Spi.h Spi_NumberOfDataType Module Header File Imported Type Spi.h Spi_SequenceType Std_Types.h Std_ReturnType Std Std_Types.h Std_VersionInfoType

The function EthSwt_Init shall store the access to the con- figuration structure for subsequent API calls.

The function EthSwt_Init shall change the state of all switches controlled by this Switch Driver from ETHSWT_STATE_UNINIT to ETHSWT_- STATE_INIT .

If development error detection is enabled, the function Eth- Swt_Init shall check the parameter CfgPtr for being valid. If the check fails, EthSwt_Init shall raise the development error ETHSWT_E_INIT_FAILED.

After initialization of the Ethernet switch within the EthSwt_- BackgroundTask , the Ethernet switch shall enter an inactive or low power mode if EthSwtLowPowerModeSupport is set to TRUE. If EthSwtLowPowerModeSupport is not defined or set to FALSE the Ethernet switch shall enter an active state.

The function EthSwt_SwitchInit shall check the access to the Ethernet Switch hardware, i.e. by trying to read or write registers during the configuration of the switch. If the access to the registers fails, the function shall raise the extended production error ETHSWT_E_ACCESS and return E_NOT_OK .

The function EthSwt_SetSwitchPortMode shall put the in- dexed port of the switch into the specified mode. If EthSwtPort references an EthTrcv then the function EthTrcv_SetTransceiverMode of the Ethernet Transceiver Driver shall additionally be called with the corresponding transceiver mode.

The function EthSwt_SetSwitchPortMode shall be pre compile time configurable On/Off by the configuration parameter: EthSwt- SetSwitchPortModeApi .

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

The function EthSwt_GetSwitchPortMode shall read the mode of the indexed port of the switch. If EthSwtPort references an EthTrcv then the function shall additionally call the corresponding function EthTrcv_Get- TransceiverMode of the Ethernet Transceiver Driver.

The function EthSwt_GetSwitchPortMode shall be pre compile time configurable On/Off by the configuration parameter: EthSwt- GetSwitchPortModeApi .

The function EthSwt_StartSwitchPortAutoNegotia- tion shall restart the automatic negotiation of the used transmission parameters of the referenced Ethernet transceiver driver by calling the function EthTrcv_StartAu- toNegotiation .

The function EthSwt_StartSwitchPortAutoNegotia- tion shall be pre compile time configurable On/Off by the configuration parameter: EthSwtStartSwitchPortAutoNegotiationApi .

The function EthSwt_GetLinkState shall read the current (link) state of the indexed switch port. If the indexed Ethernet port references an Eth- ernet transceiver, the link state shall be obtained by calling the function EthTrcv_- GetLinkState of the Ethernet Transceiver Driver. If the indexed Ethernet Switch port does not reference an Ethernet transceiver, the state shall be obtained from the MAC interface of the Switch port. If the MAC interface is not able to provide a link state (e.g. Ethernet hardware does not support a link state of the MAC interface), the API shall return the following state which is derived from the current mode: • If the current mode of the indexed switch port is ETH_MODE_ACTIVE , then ETHTRCV_LINK_STATE_ACTIVE shall be returned • If the current mode of the indexed switch port is ETH_MODE_DOWN , then ETHTRCV_LINK_STATE_DOWN shall be returned

The function EthSwt_GetLinkState shall be pre compile time configurable On/Off by the configuration parameter: EthSwt- GetLinkStateApi .

The function EthSwt_GetBaudRate shall read the current baud rate of the indexed switch port. If the indexed Ethernet port reference an Ethernet transceiver, the baud rate shall be obtained by the function EthTrcv_GetBaudRate of the Ethernet Transceiver Driver. If the indexed Ethernet Switch port does not reference an Ethernet transceiver, the baud rate shall be obtained from the MAC interface of the Switch port.

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

The function EthSwt_GetDuplexMode shall read the cur- rent duplex mode of the indexed switch port. If the indexed Ethernet port reference an Ethernet transceiver, the duplex mode shall be obtained by calling the function EthTrcv_ GetDuplexMode of the Ethernet Transceiver Driver. If the indexed Ether- net Switch port does not reference an Ethernet transceiver, the duplex mode shall be obtained from the MAC interface of the Switch port.

The function EthSwt_GetDuplexMode shall be pre compile time configurable On/Off by the configuration parameter: EthSwtGetDuplexMod- eApi .

The function EthSwt_GetPortMacAddr shall return the port index over which the given MAC-address is reachable within the indexed switch. If for the PortIdxPtr the maximal possible value (255) is returned the given MAC address cannot be reached via a port of this switch. If multiple ports were found the API returns E_NOT_OK .

The function EthSwt_StoreConfiguration shall request to store the configuration of the learned MAC/Port tables of a switch in a persistent manner. This can be done in two ways: 1.) Reading out the parameters and storing them in the NV-RAM of the host CPU using the NV-RAM manager. 2.) Advising the switch to store the configuration data in its local NV-RAM. In both alternatives <EthSwtPersistentConfigurationResultCallback> shall be invoked if EthSwtPersistentConfigurationResultCallback is configured. In case of storage to switch local NV-RAM, JobResult shall be set to NVM_REQ_OK to indi- cate success or to NVM_REQ_NOT_OK to indicate failure.

The function EthSwt_StoreConfiguration shall be pre compile time configurable On/Off by the configuration parameter: EthSwtStoreCon- figurationApi .

The function EthSwt_ResetConfiguration shall request to reset the configuration of the learned MAC/Port tables of a switch in a persistent manner. This can be done in two ways: 1.) Overwriting the learned parameters in the NV-RAM of the host CPU with preconfigured default values. 2.) Advising the switch to reset the learned configuration data in its local NV-RAM. In both alternatives <EthSwtPersistentConfigurationResultCallback> shall be invoked if EthSwtPersistentConfigurationResultCallback is configured. In case of storage to switch local NV-RAM, JobResult shall be set to NVM_REQ_OK to indi- cate success or to NVM_REQ_NOT_OK to indicate failure.

The function EthSwt_ResetConfiguration shall be pre compile time configurable On/Off by the configuration parameter: EthSwtResetCon- figurationApi .

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) Det_ReportError Det.h Service to report development errors. Eth_ReadMii Eth.h Reads a transceiver register Eth_WriteMii Eth.h Configures a transceiver register or triggers a function offered by the receiver EthTrcv_GetBaudRate EthTrcv.h Obtains the baud rate of the indexed transceiver EthTrcv_GetDuplexMode EthTrcv.h Obtains the duplex mode of the indexed transceiver EthTrcv_GetLinkState EthTrcv.h Obtains the link state of the indexed transceiver EthTrcv_GetTransceiverMode EthTrcv.h Obtains the state of the indexed transceiver EthTrcv_SetTransceiverMode EthTrcv.h Enables / disables the indexed transceiver EthTrcv_StartAutoNegotiation EthTrcv.h Restarts the negotiation of the transmission parameters used by the indexed transceiver NvM_GetErrorStatus NvM.h Service to read the block dependent error/status information. NvM_ReadBlock NvM.h Service to copy the data of the NV block to its corresponding RAM block. NvM_WriteBlock NvM.h Service to copy the data of the RAM block to its corresponding NV block. Spi_AsyncTransmit Spi.h Service to transmit data on the SPI bus. Spi_Cancel Spi.h Service cancels the specified on-going sequence transmission. Spi_ReadIB Spi.h Service for reading synchronously one or more data from an IB SPI Handler/Driver Channel specified by parameter. Spi_SetAsyncMode Spi.h Service to set the asynchronous mechanism mode for SPI busses handled asynchronously. Spi_SetupEB Spi.h Service to setup the buffers and the length of data for the EB SPI Handler/Driver Channel specified. Spi_SyncTransmit Spi.h Service to transmit data on the SPI bus Spi_WriteIB Spi.h Service for writing one or more data to an IB SPI Handler/Driver Channel specified by parameter.

The Ethernet Switch Driver shall use a zero-based index to abstract the access for upper software layers.

EthSwt_GetCounterValues shall read a list with drop counter values of the corresponding port of the switch. The meaning of these values is described at Eth_CounterType .

The function EthSwt_GetCounterValues shall be pre compile time configurable On/Off by the configuration parameter: EthSwtGetCoun- terValuesApi .

Error Name: ETHSWT_E_ACCESS Short Description: Ethernet Switch Access Failure Long Description: This production error shall be issued when the switch is not accessible. Recommended DTC: N/A Fail When access to the Ethernet Switch 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 Switch succeeds the module shall report the extended production error with event status DEM_EVENT_STATUS_ PREPASSED to DEM. Secondary Parameters: N/A Time Required: N/A Monitor Frequency N/A MIL illumination: N/A Table 7.5: ETHSWT_E_ACCESS

The EthSwt_MainFunction support asynchronous behav- ior of API calls. This function is directly called by Basic Software Scheduler.

The function <EthSwtLinkDownCallout> shall be called if a link, which is configured, goes down (link loss). The function provides the Switch index and the Port index, such that the port which went down can be identified.

The parameter EthSwtIdx within the configuration shall cor- respond to the argument used in the API.

The function EthSwt_GetVersionInfo shall be pre com- pile time configurable On/Off by the configuration parameter: EthSwtVersionIn- foApi .

The function EthSwt_NvmSingleBlockCallback shall be called by the NVRAMManager [13] after the switch configuration has been stored or reset in the the NV RAM.

The function EthSwt_NvmSingleBlockCallback shall al- ways return E_OK according to SWS_NvM_00368 .

The function EthSwt_NvmSingleBlockCallback shall raise a development error if the JobResult equals NVM_REQ_NOT_OK , i.e. the write request has been finished unsuccessfully.

The function EthSwt_NvmSingleBlockCallback shall be pre compile time configurable On/Off by the existence of the container EthSwtNvm .

The SwitchPortIdx is an index for a port at the switch.

In case different Switch devices are used in one ECU, the function names of the different Ethernet Switch drivers must be modified such that no two functions with the same names are generated. It is the responsibility of the user to take care that no two functions with the same names are configured. The names may be extended with a vendor ID or a type ID.

{OBSOLETE} Replaced by [SWS_EthSwt_CONSTR_00496]. The configuration of the Ethernet switch driver shall support different egress port struc- tures by the configuration EthSwtPortEgressScheduler .

{OBSOLETE} Replaced by [SWS_EthSwt_CONSTR_00495]. The Ethernet switch configuration shall support to configure the linkage between the priority of an received Ethernet frame and the according queue of an egress port via the traffic class assignment. Therefore the priority to traffic class assignment at an ingress port (exclusively either via EthSwtPortTrafficClassAssignment or Eth- SwtPriorityTrafficClassAssignment ) and the traffic class to a queue assign- ment at the egress port ( via EthSwtPortQueueTrafficClassAssignment ) shall be configured.

{OBSOLETE} Replaced by [SWS_EthSwt_CONSTR_00450]. The switch configuration shall support the configuration how packets will be forwarded with respect to configured VLANs by using the configuration parameters of the subcon- tainer EthSwtVlanMembership .

{OBSOLETE} Replaced by [SWS_EthSwt_CONSTR_00451]. The switch configuration shall support the configuration how VLANs will be inserted into Ethernet frames or existing VLANs will be modified by the configuration EthSwt- PortIngressVlanModification .

The Ethernet Switch driver shall support an API which allows to store learned parameters like address resolution tables in a persistent manner by using the API EthSwt_StoreConfiguration . This persistent storage can be done in an NVRAM of the host CPU which runs the Ethernet Switch driver. Alternatively, this can be done in a memory of the switch itself. The trigger for storing the learned configuration or resetting the stored configuration can be done e.g. by a DCM.

If development error detection is activated by EthSwt- DevErrorDetect , the function EthSwt_GetLinkState shall check whether the EthTrcv_GetLinkState API of the indexed transceiver driver is available by check- ing whether for this SwitchPortIdx the corresponding EthTrcv API is available. If this is not the case, the function shall raise the development error ETHSWT_E_INV_- API.

The function EthSwt_SetSwitchPortMode shall check whether the EthTrcv_SetTransceiverMode API of the indexed transceiver driver is available by checking whether for this SwitchPortIdx the corresponding EthTrcv API is available. If this is not the case, the function shall raise the development error ETHSWT_E_INV_API.

The function EthSwt_GetSwitchPortMode shall check whether the EthTrcv_GetTransceiverMode API of the indexed transceiver driver is available by checking whether for this SwitchPortIdx the corresponding EthTrcv API is available. If this is not the case, the function shall raise the development error ETHSWT_E_INV_API.

The switch driver shall provide APIs to read the MAC-address to switch port mapping from the switch device to support the IP-address assignment by using the API EthSwt_GetPortMacAddr .

The switch driver shall check whether the lower layer driver, i.e. the EthTrcv provides the APIs which can be called by an upper layer module (Eth If) of the switch driver and will be forwarded to the lower layer. In case of missing APIs, the switch driver shall raise the development error ETHSWT_E_INV_API if APIs are missing in the lower layer module.

The function EthSwt_EnableVlan shall enable or disable a pre-configured VLAN at a certain port of a switch.

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

{OBSOLETE} Replaced by [SWS_EthSwt_CONSTR_00458]. The switch configuration shall support the configuration how the PCP field of incom- ing Ethernet frames will be modified before they are forwarded to the egress port, i.e. a priority regeneration table can be configured (Please refer to EthSwtPriori- tyRegeneration , EthSwtPriorityRegenerationIngressPriority and Eth- SwtPriorityRegenerationRegeneratedPriority .

The switch configuration shall support the configuration of a default traffic class for incoming untagged Ethernet frames (Please also refer to Eth- SwtPortTrafficClassAssignment ).

The parameter EthSwtIndex shall be used to distinguish different instances of a switch driver module in case the API Det_ReportError (uint16 ModuleId, uint8 InstanceId, uint8 ApiId, uint8 ErrorId) is called.

The Ethernet Switch driver shall support an API which allows to reset learned parameters like address resolution tables by using the API EthSwt_- ResetConfiguration .

The function EthSwt_SetMacLearningMode shall set the MAC learning mode according to EthSwt_MacLearningType .

The function EthSwt_SetMacLearningMode shall be pre compile time configurable On/Off by the configuration parameter: EthSwtSet- MacLearningModeApi .

The function EthSwt_GetMacLearningMode shall return the MAC learning mode according to EthSwt_MacLearningType .

The function EthSwt_GetMacLearningMode shall be pre compile time configurable On/Off by the configuration parameter: EthSwtGet- MacLearningModeApi .

The NvM APIs will only be used if the respective block is not configured for NvM_ReadAll and NvM_WriteAll .

The callback function <EthSwtPersistentConfigurationResult- Callback> shall be called by the EthSwt_NvmSingleBlockCallback to inform the caller of EthSwt_StoreConfiguration or EthSwt_ResetConfiguration about the state of the past calls.

The function EthSwt_NvmSingleBlockCallback shall call the function <user>_PersistentConfigurationResult to provide the JobResult to the caller of EthSwt_StoreConfiguration or EthSwt_ResetConfiguration .

If the numberOfElements is greater 0x00, the arlTableList- Pointer shall be filled with up to numberOfElements elements. numberOfElements shall return the number of copied elements.

EthSwt_GetRxStats shall return a list of statistic counters defined with Eth_RxStatsType . The majority of these Counters are derived from the IETF RFC2819.

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

The function <EthSwtLinkUpCallout> shall be called if a link, which is configured, goes up. The function provides the Switch index and the Port index, such that the port which went up can be identified.

The function EthSwt_GetSwitchReg shall read the content of a switch register.

The function EthSwt_GetSwitchReg shall be pre compile time configurable On/Off by the configuration parameter: EthSwtGetSwitchRe- gApi .

The function EthSwt_SetSwitchReg shall write the content to the switch register.

The function EthSwt_SetSwitchReg shall be pre compile time configurable On/Off by the configuration parameter: EthSwtSetSwitchRe- gApi .

The function EthSwt_ReadTrcvRegister shall read the specified transceiver register through the MII or SPI of the indexed switch port.

The function EthSwt_ReadTrcvRegister shall be pre compile time configurable On/Off by the configuration parameter: EthSwtReadTr- cvRegisterApi .

The function EthSwt_WriteTrcvRegister shall write the specified transceiver register through the MII or SPI of the indexed switch port.

The function EthSwt_WriteTrcvRegister shall be pre compile time configurable On/Off by the configuration parameter: EthSwtWriteTr- cvRegisterApi .

The switch driver shall support a learning phase which can be divided into several sequential steps.

The function EthSwt_GetArlTable shall provide a list of structs with MAC-address, VLAN-ID and port for the indexed switch.

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

The function EthSwt_GetPortMacAddr shall be pre com- pile time configurable On/Off by the configuration parameter: EthSwtGetPort- MacAddrApi .

If the parameter EthSwtDropDoubleTagged is set to TRUE , the double tagged frames shall be dropped independent on which Ethernet switch port this Ethernet frame has been received.

The Parameter EthSwtPortQueueMinimumLength shall define the minimum length for one queue of an dedicated egress port.

The EthSwt_GetArlTable API shall return only the num- berOfElements if the numberOfElements is set to 0x00. In this case no data will be copied and a NULLPTR can be used for the arlTableListPointer.

The Switch driver shall offer Switch management APIs • EthSwt_EthRxProcessFrame • EthSwt_EthRxFinishedIndication • EthSwt_EthTxAdaptBufferLength • EthSwt_EthTxPrepareFrame • EthSwt_SetMgmtInfo • EthSwt_EthTxProcessFrame and • EthSwt_EthTxFinishedIndication if EthSwtManagementSupportApi is set to TRUE .

The Switch Driver management APIs • EthSwt_EthRxProcessFrame • EthSwt_EthRxFinishedIndication • EthSwt_EthTxAdaptBufferLength • EthSwt_EthTxPrepareFrame • EthSwt_SetMgmtInfo • EthSwt_EthTxProcessFrame and • EthSwt_EthTxFinishedIndication shall support the Ethernet Driver to gather the Switch specific management information out of an Ethernet frame for reception or to prepare an Ethernet frame for management mode conformant frame transmission, e.g. the egress route of a frame.

The Switch Driver management APIs EthSwt_EthTxPro- cessFrame and EthSwt_EthTxFinishedIndication shall return immediately, if EthSwt_SetMgmtInfo has not been called before a call of EthSwt_EthTxPro- cessFrame .

The Switch driver shall access the port specific hardware time stamps if EthSwtPortTimeStampSupport of the port is set to TRUE .

The Switch driver shall inform the EthIf about the availability of port specific ingress and egress timestamps us- ing the APIs EthIf_SwitchIngressTimeStampIndication and EthIf_SwitchEgressTimeStampIndication , if EthSwtGlobalTimeSup- portApi is set to TRUE .

The function EthSwt_EthRxProcessFrame shall be pre compile time configurable ON/OFF by the configuration parameter: EthSwtManage- mentSupportApi .

The function EthSwt_EthRxFinishedIndication shall be pre compile time configurable ON/OFF by the configuration parameter: EthSwt- ManagementSupportApi .

The function EthSwt_EthTxPrepareFrame shall be pre compile time configurable ON/OFF by the configuration parameter: EthSwtManage- mentSupportApi .

The function EthSwt_EthTxAdaptBufferLength shall be pre compile time configurable ON/OFF by the configuration parameter: EthSwtMan- agementSupportApi .

The function EthSwt_SetMgmtInfo shall be pre compile time configurable ON/OFF by the configuration parameter: EthSwtManagementSup- portApi .

The function EthSwt_EthTxProcessFrame shall be pre compile time configurable ON/OFF by the configuration parameter: EthSwtManage- mentSupportApi .

The function EthSwt_EthTxFinishedIndication shall be pre compile time configurable ON/OFF by the configuration parameter: EthSwt- ManagementSupportApi .

If the management information for reception will not be avail- able within the time specified in the configuration parameter EthSwtMgmtInfoIndi- cationTimeout , the pointer MgmtInfoPtr shall be set to NULL before calling the function EthIf_SwitchMgmtInfoIndication .

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

The function EthSwt_SetForwardingMode shall be com- pile time configurable On/Off by the configuration parameter: EthSwtSetForward- ingModeApi .

If the parameter EthSwtVerifyConfigApi is set to TRUE the function EthSwt_VerifyConfig shall be used to verify switch configuration.

The function EthSwt_GetPortSignalQuality shall obtain the signal quality by calling the function EthTrcv_GetPhySignalQuality of the referenced Ethernet Transceiver Driver. If the current signal quality is not available, the signal quality shall be set to 0xFFFFFFFF .

The function EthSwt_GetPortSignalQuality shall be pre compile time configurable On/Off by the configuration parameter: EthSwtGet- PortSignalQualityApi .

The function EthSwt_GetPortIdentifier shall return the value of the organizationally unique identifier (OUI 24 bit) of the indexed Ethernet switch port that is connected to the indexed Ethernet switch. It shall set the 8 most significant bits of the OUI to 0xFFxxxxxx. If the Ethernet switch port references an Ethernet transceiver, the function shall obtain the OUI by calling the function EthTrcv_Get- PhyIdentifier and set the 8 most significant bits of the OUI to 0x00xxxxxx.

The function EthSwt_GetPortIdentifier shall be pre compile time configurable On/Off by the configuration parameter: EthSwtGetPor- tIdentifierApi .

The function EthSwt_GetSwitchIdentifier shall return the value of the organizationally unique identifier of the indexed Ethernet switch.

The function EthSwt_GetSwitchIdentifier shall be pre compile time configurable On/Off by the configuration parameter: EthSwt- GetSwitchIdentifierApi .

The function EthSwt_WritePortMirrorConfiguration shall store the port mirror configuration of the given MirroredSwitchIdx in a shadow buffer. The MirroredSwitchIdx shall be used to identify the port mirror configura- tion within the Ethernet switch driver.

The function EthSwt_WritePortMirrorConfiguration shall be pre compile time configurable On/Off by the configuration parameter: Eth- SwtWritePortMirrorConfigurationApi .

The function EthSwt_ReadPortMirrorConfiguration shall return the port mirror configuration identified by the given MirroredSwitchIdx. If no port mirror configuration is found for the MirroredSwitchIdx, the function shall return E_NOT_OK .

The function EthSwt_ReadPortMirrorConfiguration shall be pre compile time configurable On/Off by the configuration parameter: Eth- SwtReadPortMirrorConfigurationApi .

The function EthSwt_GetPortMirrorState shall return the port mirroring state of the indexed ethernet switch port.

The function EthSwt_GetPortMirrorState shall be pre compile time configurable On/Off by the configuration parameter: EthSwtGetPort- MirrorStateApi .

The function EthSwt_SetPortMirrorState shall request the given port mirroring state for the port mirroring configuration of the indexed Ethernet switch, and store the requested port mirror state in a shadow buffer.

The function EthSwt_SetPortMirrorState shall be pre compile time configurable On/Off by the configuration parameter: EthSwtSetPort- MirrorStateApi .

The function EthSwt_SetPortTestMode shall forward the call with the given test mode by calling the function EthTrcv_SetPhyTestMode of the referenced Ethernet Transceiver Driver.

The function EthSwt_SetPortTestMode shall be pre com- pile time configurable On/Off by the configuration parameter: EthSwtSetPortTest- ModeApi .

The function EthSwt_SetPortLoopbackMode shall forward the call with the given loop-back mode by calling the function EthTrcv_SetPhyLoop- backMode of the referenced Ethernet Transceiver Driver.

The function EthSwt_SetPortLoopbackMode shall be pre compile time configurable On/Off by the configuration parameter: EthSwtSetPort- LoopbackModeApi .

The function EthSwt_SetPortTxMode shall forward the call with the given transmission mode by calling the function EthTrcv_SetPhyTxMode of the referenced Ethernet Transceiver Driver.

The function EthSwt_SetPortTxMode shall be pre compile time configurable On/Off by the configuration parameter: EthSwtSetPortTxMod- eApi .

The function EthSwt_GetPortCableDiagnosticsRe- sult shall obtain the cable diagnostics result by calling the function EthTrcv_Get- CableDiagnosticsResult of the referenced Ethernet Transceiver Driver.

The function EthSwt_GetPortCableDiagnosticsRe- sult shall be pre compile time configurable On/Off by the configuration parameter: EthSwtGetPortCableDiagnosticsResultApi .

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

The function EthSwt_GetTxErrorCounterValues shall be pre compile time configurable On/Off by the configuration parameter: EthSwt- GetTxErrorCounterValuesApi .

EthSwt_GetTxStats shall return the list of Transmission Statistics out of IETF RFC1213 defined with Eth_TxStatsType , where the maxi- mal possible value shall denote an invalid value, e.g. this counter is not available.

EthSwt_GetTxErrorCounterValues returns the list of Transmission Error Counters out of IETF RFC1213 and RFC1643 defined with Eth_- TxErrorCounterValuesType , where the maximal possible value shall denote an invalid value, e.g. this counter is not available.

All Ethernet switch HW ports which are not configured as a EthSwtPort shall be switched off during initialization. This Ethernet switch HW ports shall never be switched on during runtime

All EthSwtPorts shall be set to ETH_MODE_DOWN during ini- tialization.

If EthSwtLowPowerModeSupport is set to TRUE and at least one EthSwtPort of a Ethernet switch is enabled and the corresponding Ether- net switch HW is in an inactive or low power mode the Ethernet switch HW shall be set to an active mode in which forwarding of Ethernet frames is possible.

If EthSwtLowPowerModeSupport is set to TRUE and no Eth SwtPort for a certain Ethernet switch is enabled, the corresponding Ethernet switch HW shall be set to an inactive or low power mode.

If EthSwt_PortEnableTimeStamp is called for a PortIdx , the switch driver shall enable the time-stamping for this port if EthSwtPortTimeS- tampSupport is set to TRUE for this port.

The function EthSwt_PortEnableTimeStamp shall be pre compile time configurable ON/OFF by the configuration parameter: EthSwtGlobal- TimeSupportApi .

If development error detection is activated by EthSwtDev- ErrorDetect , all functions except EthSwt_Init shall check that the service Eth- Swt_Init was previously called. If the check fails, the function shall raise the devel- opment error ETHSWT_E_UNINIT.

If development error detection is activated by EthSwtDev- ErrorDetect , all functions with input parameter SwitchIdx shall check the parameter for being valid. If the check fails, the functions shall raise the development error ETH- SWT_E_INV_SWITCH_IDX.

If development error detection is enabled, all functions with input parameter SwitchPortIdx or PortIdx shall check the parameter for being valid. If the check fails, the functions shall raise the development error ETHSWT_E_- INV_SWITCH_IDX.

If development error detection is enabled, all functions with input parameter CtrlIdx shall check the parameter for being valid. If the check fails, the functions shall raise the development error ETHSWT_E_INV_CTRL_IDX.

If development error detection is enabled, all functions with input parameter BufIdx shall check the parameter for being valid. If the check fails, the functions shall raise the development error ETHSWT_E_INV_PARAM.

If development error detection is enabled, all functions with inout or output pointer parameter shall check the parameter for being valid. If the check fails, the functions shall raise the development error ETHSWT_E_PARAM_POINTER.

If development error tracing is activated by EthSwtDevEr- rorDetect , the functions which call an Ethernet Transceiver API and do not obtain the functionality directly from the switch port interface shall check whether the API of the indexed transceiver driver is available. If this is not the case, the functions shall raise the development error ETHSWT_E_INV_API.

If neither the Ethernet switch port nor the Ethernet Transceiver Driver can provide an OUI the function EthSwt_GetPortIdentifier shall return E_NOT_OK .

Error Name: ETHSWT_E_SYNCPORT2PHY Short Description: Ethernet switch port and the referenced Ethernet transceiver are in contradicting modes. Long Description: While getting the Ethernet switch port mode, the Ethernet switch driver detected an inconsistent state between Ethernet switch port and the referenced Ethernet transceiver Mode. Recommended DTC: N/A Fail When getting the Ethernet switch port mode together with the Ethernet transceiver mode and the mode of the two referenced modules was found inconsistent the module shall report the extended production error with event status DEM_EVENT_STATUS_ PREFAILED to DEM. Detection Criteria: Pass When getting the Ethernet switch port mode together with the Ethernet transceiver mode and the mode of the two referenced modules was found consistent the module shall report the extended production error with event status DEM_EVENT_STATUS_ PREPASSED to DEM. Secondary Parameters: N/A Time Required: N/A Monitor Frequency N/A MIL illumination: N/A Table 7.6: ETHSWT_E_SYNCPORT2PHY

When calling the function EthSwt_SetSwitchPortMode with mode ETH_MODE_DOWN , the EthSwt shall disable the Ethernet switch port directly for reduction of power consumption, if it is possible.

When calling the function EthSwt_SetSwitchPortMode , the function shall check the access to the Ethernet switch driver. If the check fails, the function shall raise the extended production error ETHSWT_E_ACCESS and return E_NOT_OK , otherwise pass the extended production error ETHSWT_E_ACCESS and re- turn E_OK .

If EthSwtPort does not references an EthTrcv, EthSwt shall indicate a mode of the port by the API EthIf_SwitchPortModeIndication latest during the next EthSwt_MainFunction .

If the obtained modes of the EthSwtPort and the EthTrcv are not aligned, the function EthSwt_GetSwitchPortMode shall raise the extended pro- duction error ETHSWT_E_SYNCPORT2PHY and return E_NOT_OK . If EthTrcv_GetTransceiverMode returns E_NOT_OK , the EthSwt_GetSwitch- PortMode shall also return E_NOT_OK without raising an error.

If the function EthSwt_GetSwitchPortMode is called, the function shall check the access to the Ethernet Switch Driver. If the check fails, the function shall raise the extended production error ETHSWT_E_ACCESS and re- turn E_NOT_OK , otherwise pass the production error ETHSWT_E_ACCESS and return E_OK .

The function EthSwt_GetCfgDataRaw shall only be avail- able if parameter EthSwtGetCfgRaw is set to TRUE.

When calling the function EthSwt_GetCfgDataRaw , the function shall check the access to the Ethernet switch driver. If the check fails, the function shall raise the extended production error ETHSWT_E_ACCESS and return E_NOT_OK , otherwise pass the extended production error ETHSWT_E_ACCESS and re- turn E_OK .

The function EthSwt_GetCfgDataInfo shall only be avail- able if parameter EthSwtGetCfgRaw is set to TRUE.

When calling the function EthSwt_GetCfgDataInfo , the function shall check the access to the Ethernet switch driver. If the check fails, the function shall raise the extended production error ETHSWT_E_ACCESS and return E_NOT_OK , otherwise pass the extended production error ETHSWT_E_ACCESS and re- turn E_OK .

Unused ARL table entries shall be removed from the ARL ta- ble after the timeout configured via EthSwtArlTableEntryTimeout , if this parame- ters is present in the configuration.

The Switch driver shall enable clock synchronization with an- other Ethernet switch to which it is connected via uplink port, if EthSwtClockSyn- chronizationSupport is set to TRUE .

The Ethernet Switch Driver module shall reject configurations with partition mappings which are not supported by the implementation.

The function EthSwt_PortLinkStateRequest shall re- quest the given link state for the indexed Ethernet switch port of the switch by call- ing the EthTrcv_TransceiverLinkStateRequest with the given EthTrcv_- LinkStateType . If the EthSwtPort does not reference an EthTrcv, then the function shall return E_NOT_OK .

The port mirror configuration (see [SWS_EthSwt_91017] ) shall be written to a shadow buffer of the Ethernet switch driver per Ethernet Switch by calling EthSwt_WritePortMirrorConfiguration .

The port mirror configuration shall be enabled and disabled, respectively, per Ethernet Switch by calling EthSwt_SetPortMirrorState . The current state of the stored port mirror configuration shall be stored persistently, to out- last an ECU reset and to restore the port mirroring activities after an ECU reset.

The stored port mirror configuration shall be marked as "to be deleted" by calling EthSwt_DeletePortMirrorConfiguration , if the port mirror- ing of the given Ethernet switch index is disabled (see [SWS_EthSwt_91022]. Other- wise the request to delete the port mirror configuration shall be rejected.

The current port mirroring state shall be returned by calling EthSwt_GetPortMirrorState .

The port mirror configuration per Ethernet switch shall be re- turned by calling EthSwt_ReadPortMirrorConfiguration .

The EthSwt shall check for enabled port mirror configuration. The enabled port mirror configuration shall be activated by reconfiguring the Ethernet switch hardware according to the port mirror configuration, before frame forwarding is being enabled.

If the PortMirrorState is set to 0x01 (port mirroring enabled), then the stored port mirror configuration for the given Ethernet switch shall be written to hardware registers of the given Ethernet switch and enable port mirroring.

If the PortMirrorState is set to 0x00 (port mirroring disabled) the corresponding hardware registers of the given Ethernet switch shall be reset (to the HW's default values) and the port mirroring shall be disabled.

The function shall return with ETH- SWT_PORT_MIRRORING_CONFIGURATION_NOT_SUPPORTED , if the port mirroring configuration is not supported by the Ethernet switch driver or by the Ethernet switch hardware, e.g.: • the configured mirrored traffic direction (see [SWS_EthSwt_91017] "TrafficDirec- tionIngressBitMask" and "TrafficDirectionEgressBitMask") for ingress and egress traffic of the same port is not supported • mirrored ports and capture ports, respectively, are not available within the Ether- net switch driver

The function EthSwt_DeletePortMirrorConfigura- tion shall mark the stored port mirror configuration in the shadow buffer of the given MirroredSwitchIdx as "to be deleted".

If a port mirroring for the given MirroredSwitchIdx is enabled, the request to delete the configuration shall be rejected by returning E_NOT_OK . Only those port configurations are allowed to be deleted, where the port mirroring of the given MirroredSwitchIdx is disabled.

The function EthSwt_DeletePortMirrorConfigura- tion shall be pre compile time configurable On/Off by the configuration parameter: EthSwtDeletePortMirrorConfigurationApi .

The cable diagnostic APIs ( EthSwt_RunPortCableDiag- nostic , EthSwt_GetPortCableDiagnosticsResult ) shall only be called for Eth- ernet switch ports of a Ethernet switch, where the Ethernet switch ports reference an Ethernet transceiver.

The function EthSwt_RunPortCableDiagnostic shall for- ward the call by calling EthTrcv_RunCableDiagnostic of the referenced Ethernet Transceiver Driver.

The function EthSwt_GetMaxFIFOBufferFillLevel shall read out the maximum amount of allocated FIFO buffer since the last read out.

When the maximum amount of allocated FIFO buffer is read out, the value shall be reset to 0x00000000 explicitly, if it is not done by the hardware.

The function EthSwt_GetMaxFIFOBufferFillLevel shall be pre compile time configurable On/Off by the configuration parameter: Eth- SwtGetMaxFIFOBufferFillLevelApi .

A MgmtObject is just allowed to be owned between EthSwt and only one <UPPER_LAYER>. The structure element can be identified unambigu- ously using the DataPtr in Rx- and BufIdx in Tx-context, because both elements are definitively unique within the RxIndication() / TxConfirmation() context.

Type of error Related error code Error value Initialization of ports is not finished ETHSWT_INIT_NOT_COMPLETED 0x01

All functions apart from EthSwt_SetSwitchPortMode , EthSwt_GetSwitchPortMode , EthSwt_StartSwitchPortAutoNegotiation , EthSwt_GetLinkState , EthSwt_GetBaudRate , EthSwt_GetDuplexMode , EthSwt_ReadTrcvRegister , EthSwt_WriteTrcvRegister , EthSwt_Init , EthSwt_MainFunction and EthSwt_BackgroundTask may only be called in state ETHSWT_STATE_ACTIVE . If a function which can only run (succeed with E_OK ) in the states ETHSWT_STATE_- PORTINIT_COMPLETED and ETHSWT_STATE_ACTIVE is called before state ETH- SWT_STATE_PORTINIT_COMPLETED is reached, the Ethernet switch driver shall raise the runtime error ETHSWT_INIT_NOT_COMPLETED .

ETHSWT_STATE_PORTINIT_COMPLETED shall be reached as soon as the port initialization has finished.

ETHSWT_STATE_ACTIVE shall be reached, when the Ether- net switch initialization has finished.

The function shall report the active mode always as ETH_MODE_ACTIVE , even though the previous requested (via EthSwt_SetSwitch- PortMode ) mode was ETH_MODE_ACTIVE_WITH_WAKEUP_REQUEST .

The function EthSwt_CheckWakeup shall iterate over the Ethernet switch ports of the indexed Ethernet switch and forward the call to EthTrcv_- CheckWakeup for those Ethernet switch ports, which reference an EthTrcv.

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

The function EthSwt_GetSwitchPortWakeupReason shall read the current wake-up reason of the indexed Ethernet switch port by forwarding the call to EthTrcv_GetBusWuReason of the referenced EthTrcv. If the indexed Eth- ernet switch port has no reference to an EthTrcv, the function shall return E_NOT_OK .

The function EthSwt_GetSwitchPortWakeupReason shall be pre compile time configurable On/Off by the configuration parameter: Eth- SwtGetSwitchPortWakeupReasonApi

[SWS_EthSwt_00448] Behaviour if EthSwtMacAddressLearningMode is set to IVL Upstream requirements: SRS_Eth_00087 ⌈if EthSwtMacAddressLearningMode is set to IVL then the EthSwt driver shall return with E_NOT_OK.⌋ Note: If EthSwtMacAddressLearningMode is set to IVL, then the MAC-address to Ethernet switch port assignment is learned with respect to the according VLAN. With IVL the presence of an VLAN-ID is needed.

[SWS_EthSwt_00449] Behaviour if given MAC-address is available at exactly one Ethernet port Upstream requirements: SRS_Eth_00087 ⌈If the given MAC-address is available at exact one Ethernet switch port, then the EthSwt driver shall return the port index via PortIdxPtr and report E_OK.⌋

{DRAFT} If an Ethernet switch has to elect an priority value for an received Ethernet frame, then the priority election process shall be performed according the following order: • If the Ethernet switch detect that the received Ethernet frame is handled by an per-stream filtering and policing (see EthSwtPSFP ) and the corresponding stream gate (see EthSwtStreamGate ) has an IPV configured, then this value shall be used as priority to map this Ethernet frame to a traffic class. Otherwise the Ethernet switch shall proceed as discribed within the next point. • Else if the Ethernet switch detect that a regenerated priority value (see EthSwt- PriorityRegeneration ) is available, then this value shall be used as priority to map this Ethernet frame to a traffic class. Otherwise the Ethernet switch shall proceed as discribed within the next point. • Else if neither a IPV nor a regenerated priority value is available, then the PCP of the received Ethernet frame shall be used as priority to map this Ethernet frame to a traffic class.

{DRAFT} If an Ethernet frame has to be transmitted on a par- ticular egress port, this Ethernet frame is transmitted with an VLAN tag and a outbound VLAN priority is assgined to this Ethernet frame, then this Ethernet frame shall be transmitted with the VLAN priority set to the assigned outbound VLAN priority

{DRAFT} If the destination MAC address of a received Ether- net frame is qualified as a MAC unicast/multicast address and this MAC address is available in the ARL table, then this Ethernet frame shall be forwarded for further pro- cessing. Otherwise this Ethernet frame shall be dropped and the forwarding process shall be aborted.

{DRAFT} If the VLAN membership of a egress port match to the VLAN-ID of a received Ethernet frame and this Ethernet frame has been assigned to this egress port, then the assignment of this Ethernet frame to this egress port shall be kept. Otherwise the assignment of this Ethernet frame to the affected egress port shall be removed.

{DRAFT} After the egress filtering has been finalized for an received Ethernet frame and the Ethernet frame is still assigned to a least one egress port, then this Ethernet frame shall be forwarded for further processing. Otherwise this Ethernet frame shall be dropped and the forwarding process shall be aborted.

{DRAFT} If an instance of an EthSwtStreamIdentifica- tion references one or multiple ingress ports, then the stream identification shall be processed for streams received via any of the referencing ingress ports.

{DRAFT} If an instance of an EthSwtStreamIdentifica- tion references one or multiple egress ports, then the stream identification shall be processed for streams which are forwarded to all referenced egress ports.

{DRAFT} If an instance of an EthSwtStreamIdentifica- tion neither reference ingress ports nor egress ports, then the stream identification shall be processed for all streams received via any ingress port regardless to which egress port the stream is forwarded.

{DRAFT} If an Ethernet frame (i.e stream) has been received, then the stream identification shall be processed by instances of configured EthSwt- StreamIdentification where the internal stream route match.

{DRAFT} If a Ethernet frame (i.e stream) has been received, then the Ethernet switch shall check for a matching instance of EthSwtStreamI- dentification in ascending order according the EthSwtStreamIdentifica- tionPosition , starting with EthSwtStreamIdentificationPosition config- ured with value 0.

{DRAFT} If a received Ethernet frame (i.e stream) does not match any instances of EthSwtStreamIdentification s, the Ethernet frame shall be forwarded to the next frame processing level without applying any further stream identification handling.

{DRAFT} If a Ethernet frame (i.e. stream) has been received and the internal stream route match to an instance of a configured EthSwtStreamI- dentification , then this stream identification shall be processed in the following order: • Perform the EthSwtStreamFilterRule • Perform the EthSwtStreamFilterAction , if configured • Perform the EthSwtPSFP , if configured and if the Ethernet frame has passed the EthSwtStreamFilterRule and EthSwtStreamFilterAction • Perform the EthSwtPortATSScheduler , if configured and if the Ethernet frame has passed the EthSwtStreamFilterRule and EthSwtStreamFilterAc- tion

{DRAFT} A configured instance of an EthSwtStreamIden- tification where no optional elements are configured, shall be considered as empty stream identification, where incoming Ethernet frames always pass.

{DRAFT} If an EthSwtStreamFilterRule have multiple fil- ter rule primitives configured (e.g. EthSwtStreamFilterMACSrcAddress and EthSwtStreamFilterVlanId ), then the filter rule primitives shall be considered as AND-linked filter rules.

{DRAFT} If a Ethernet frame (i.e. stream) has been received, the internal stream route for this Ethernet frame matches to an instance of a configured EthSwtStreamIdentification , the EthSwtStreamFilterRule of this instance has filter rule primitives configured (e.g. EthSwtStreamFilterMACSrcAddress and EthSwtStreamFilterVlanId ) and the Ethernet frame matches all configured filter rule primitives, then this Ethernet frame shall be qualified as matching stream.

{DRAFT} If an Ethernet frame (i.e. stream) has been received, the internal stream route for this Ethernet frame matches to an instance of a configured EthSwtStreamIdentification and a particular filter rule primitive in the EthSwt- StreamFilterRule of this instance is not configured, then this filter rule primitive shall be considered a matching filter rule primitive.

{DRAFT} If a Ethernet frame (i.e. stream) has been qualified as matching stream and an EthSwtStreamFilterAction is configured, then this filter action shall be applied on this Ethernet frame.

{DRAFT} If a filter action is applied on a Ethernet frame (i.e. stream) and the corresponding EthSwtStreamFilterAction has EthSwtStream- FilterActionDropFrame set to TRUE , then this Ethernet frame shall be dropped.

{DRAFT} If a filter action is applied on a Ethernet frame (i.e. stream) and the corresponding EthSwtStreamFilterAction EthSwtStreamFil- terActionBlockSource set to TRUE, then this Ethernet frame and all sub se- quential receptions of Ethernet frames with the same source MAC address shall be blocked.

{DRAFT} If a filter action is applied on a Ethernet frame (i.e. stream) and the corresponding EthSwtStreamFilterAction has an EthSwt- StreamFilterActionVlanModification configured, then the VLAN-ID of this Ethernet frame shall be modified with the configured VLAN-ID given by EthSwt- StreamFilterActionVlanModificationVlanId .

{DRAFT} If a filter action EthSwtStreamFilterAction- DestinationPortModification is configured, then the egress destination which is used for the modification shall be determined according the configured references to egress ports via EthSwtStreamFilterActionDestinationPortModifica- tionEgressPortRef .

{DRAFT} If a filter action is applied on a Ethernet frame (i.e. stream), the corresponding EthSwtStreamFilterAction has an Eth- SwtStreamFilterActionDestinationPortModification configured and the EthSwtStreamFilterActionDestinationPortModificationType is set to ETHSWT_STREAM_EGRESS_DESTINATION_OVERWRITE , then the egress destina- tion of this Ethernet frame shall be overwritten with the configured egress des- tination (see EthSwtStreamFilterActionDestinationPortModificationE- gressPortRef ).

{DRAFT} If a filter action is applied on a Ethernet frame (i.e. stream), the corresponding EthSwtStreamFilterAction has an EthSwtStream- FilterActionDestinationPortModification configured and the EthSwtStreamFil- terActionDestinationPortModificationType is set to ETHSWT_STREAM_- EGRESS_DESTINATION_EXTEND , then the egress destination of this Ethernet frame shall be extended with the configured egress destination (see EthSwtStreamFil- terActionDestinationPortModificationEgressPortRef ).

{DRAFT} If a EthSwtPSFP is available, the corresponding EthSwtStreamGate has an EthSwtStreamGateIPV (internal priority value) config- ured and an Ethernet frame pass through the gate, then the internal priority value shall be assigned to this Ethernet frame.

{DRAFT} If an Ethernet frame match to EthSwtStreamIden- tification , this Ethernet frame pass the filtering and a EthSwtFlowMetering is available, then this Ethernet frame shall be handled by this EthSwtFlowMetering .

{DRAFT} A configured EthSwtFlowMetering shall per- form the metering according to the configuration: EthSwtFlowMeteringColor- Mode , EthSwtFlowMeteringCIR , EthSwtFlowMeteringCBS , EthSwtFlowMe- teringEIR , EthSwtFlowMeteringEBS and EthSwtFlowMeterCF

{DRAFT} If an Ethernet frame match to EthSwtStreamIden- tification , this Ethernet frame pass the filtering and a EthSwtPortATSSched- uler is available, then a elegibility time shall be assigned to this Ethernet frame and scheduled by this EthSwtPortATSScheduler .

{DRAFT} A configured EthSwtPortATSScheduler shall perform the scheduling according to the following configuration: EthSwtPor- tATSCommitedBurstSize , EthSwtPortATSCommitedInformationRate and EthSwtATSGroupMaximumResidenceTime .

[SWS_EthSwt_00511] Behaviour if given MAC-address is available at multiple Ethernet ports Upstream requirements: SRS_Eth_00087 ⌈If the given MAC-address is available at multiple Ethernet switch ports, then the Eth- Swt driver shall return with E_NOT_OK.⌋ Note: If EthSwtMacAddressLearningMode is set to SVL and the MAC-address given with MacAddrPtr is a MAC multicast address, then the given MAC-address could be available at serveral Ethernet switch ports of the Ethernet switch addressed with SwitchIdx.

[SWS_EthSwt_00512] Behaviour if EthSwtMacAddressLearningMode is set to SVL Upstream requirements: SRS_Eth_00087 ⌈If EthSwtMacAddressLearningMode is set to SVL, then the EthSwt driver shall consider the given the MAC-address and ignore the given VLAN-ID to determine the MAC-address to Ethernet port assignment.⌋ Note: If EthSwtMacAddressLearningMode is set to SVL, the MAC-address to port assignment is shared across all VLANs and therefore the given VLAN is ignored.

[SWS_EthSwt_00513] Behaviour if EthSwtMacAddressLearningMode is set to IVL and VLAN-ID is set to value in a range from 1 to 4095 Upstream requirements: SRS_Eth_00087 ⌈If EthSwtMacAddressLearningMode is set to IVL and given VLAN-ID is set to a value in a range from 1 to 4095, then the EthSwt driver shall consider the given the MAC-address and the given VLAN-ID to determine the MAC-address to Ethernet port assignment.⌋

[SWS_EthSwt_00514] Behaviour if EthSwtMacAddressLearningMode is set to IVL and VLAN-ID is set to 0 Upstream requirements: SRS_Eth_00087 ⌈If EthSwtMacAddressLearningMode is set to IVL and given VLAN-ID is set to 0, then the EthSwt driver shall consider the given the MAC-address to determine the MAC-address to Ethernet port assignment irrespective of the VLAN.⌋

[SWS_EthSwt_00515] Behaviour if EthSwtMacAddressLearningMode is set to IVL and VLAN-ID is set to a value greater than 4095 Upstream requirements: SRS_Eth_00087 ⌈If EthSwtMacAddressLearningMode is set to IVL and given VLAN-ID is set to a value greater that 4095, then the EthSwt driver shall return with E_NOT_OK.⌋

[SWS_EthSwt_00516] Creation of Ethernet switch port bit map Upstream requirements: SRS_Eth_00087 ⌈The function shall create a Ethernet switch port bit map addressed by PortBitMapPtr with respect to [SWS_EthSwt_00512], [SWS_EthSwt_00513] and

[SWS_EthSwt_00517] Behaviour for creation of Ethernet switch port bit map Upstream requirements: SRS_Eth_00087 ⌈If the creation of the Ethernet switch port bit map was successful finalized and trans- fered to the location addressed with PortBitMapPtr, then the EthSwt driver shall return with E_OK.⌋

[SWS_EthSwt_00518] Behaviour if Ethernet switch port bit map exceeds uint32 data type Upstream requirements: SRS_Eth_00087 ⌈If the resulting Ethernet switch port bit map exceeds the unit32 data type, then the EthSwt driver shall return with E_NOT_OK.⌋

[SWS_EthSwt_00519] compile configuration for API Upstream requirements: SRS_BSW_00171 ⌈The function EthSwt_GetPortMacAddrVlan shall be pre compile time configurable On/Off by the configuration parameter: EthSwtGetPortMacAddrVlanApi.⌋

[SWS_EthSwt_00560] EthSwt_ReadMmd functionality ⌈The function EthSwt_- ReadMmd shall read the specified transceiver register through the MII or SPI of the indexed switch port.⌋

[SWS_EthSwt_00561] Configuring EthSwt_ReadMmd availability ⌈The function EthSwt_ReadMmd shall be precompile time configurable On/Off by the configuration parameter: EthSwtReadMmdApi.⌋

[SWS_EthSwt_00562] EthSwt_WriteMmd functionality ⌈The function EthSwt_- WriteMmd shall write a value to the specified transceiver register through the MII of the indexed switch port.⌋

[SWS_EthSwt_00563] Configuring EthSwt_WriteMmd availability ⌈The function EthSwt_WriteMmd shall be precompile time configurable On/Off by the configuration parameter: EthSwtWriteMmdApi.⌋

Overlayed return value of Std_ReturnType for Ethernet switch driver API EthSwt_WritePortMirror Configuration, if the port mirroring configuration is not supported by Ethernet switch driver or by the Ethernet switch hardware (e.g. the configured mirrored traffic direction (see SWS_EthSwt_91017 "TrafficDirectionIngressBitMask" and "TrafficDirectionEgressBitMask") for ingress and egress traffic of the same port is not supported, or the addressed Ethernet switch ports within the port mirror configuration are not accessible by the Ethernet switch driver)

The port specific timestamping (EthSwtPortTime StampSupport) can be set to TRUE , if clock synchronization for connected Ethernet switches is deactivated ( EthSwtClockSynchronizationSupport set to FALSE ).

The port specific timestamping ( EthSwtPort- TimeStampSupport ) can be set to TRUE , if EthSwtClockSynchronization- Support is activated and EthSwtPortRole is not ETHSWT_UP_LINK_PORT . Eth SwtPorts with EthSwtPortRole ETHSWT_UP_LINK_PORT are connected to another Ethernet switch and not considered for the time delay compensation, if EthSwt- ClockSynchronizationSupport is activated.

The ECUC partitions referenced by EthSwtCon- figEcucPartitionRef shall be a subset of the ECUC partitions referenced by Eth- SwtEcucPartitionRef .

EthSwtConfig , EthCtrlConfig and EthTr- cvConfig of one communication channel shall all reference the same ECUC parti- tion.

The module will operate as an independent in- stance in each of the partitions (see EthSwtEcucPartitionRef ), means the called API will only target the partition it is called in.

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

{DRAFT} The switch configuration shall support the configuration how packets will be forwarded with respect to configured VLANs by using the configuration parameters of the subcontainer EthSwtVlanMembership .

{DRAFT} The switch configuration shall support the configuration how VLANs will be inserted into Ethernet frames or existing VLANs will be modified by the configuration EthSwtPortIngressVlanModification .

{DRAFT} If EthSwtPortIngressDefaultVlan and EthSwtPortIngressDefaultPriority for a particular Ethernet port is avail- able, then the default VLAN and the default priority of this hardware Ethernet switch port shall be configured with the available values.

{DRAFT} If Ethernet frames without a VLAN tag (untagged Ethernet frame) which are received on a particular Ethernet port shall be dropped, then the parameter EthSwtPortIngressDropUntagged of this Ethernet port shall be set to TRUE and the parameters EthSwtPortIngressDefaultVlan and EthSwtPortIngressDefaultPriority of this Ethernet port shall not be con- figured (multiplicity of both parameters are 0 )

{DRAFT} If Ethernet frames without a VLAN tag (untagged Ethernet frame) which are received on a particular Ethernet port shall be handled for further processing with a dedicated VLAN-ID and VLAN priority, then the parameter EthSwtPortIngressDropUntagged of this Ethernet port shall be set to FALSE and the parameters EthSwtPortIngressDefaultVlan and EthSwtPort- IngressDefaultPriority of this Ethernet port shall be configured.

{DRAFT} The switch configuration shall support the configuration of priority to traffic class mapping per ingress port, i.e. a priority to traf- fic class table can be configured (see EthSwtPortTrafficClassAssignment ).

{DRAFT} If the same EthSwtPortIngress need to configure a priority to traffic class assignment, then exclusively either EthSwt- PortTrafficClassAssignment or EthSwtPriorityTrafficClassAssign- ment shall be configured.

{DRAFT} The switch configuration shall support the configuration how the PCP field of incoming Ethernet frames will be modified be- fore they are forwarded to the egress port, i.e. a priority regeneration table can be configured (Please refer to EthSwtPriorityRegeneration , EthSwtPriorityRe- generationIngressPriority and EthSwtPriorityRegenerationRegener- atedPriority .

{DRAFT} The Ethernet switch configuration shall support a port based configuration at ingress side to assign an outbound VLAN pri- ority to incoming Ethernet frames according to their regenerated VLAN priority (a.k.a. PCP field, see [SWS_EthSwt_00178]), i.e. an outbound VLAN priority assignment can be configured (see EthSwtPortOutboundVlanPriorityAssignment , Eth- SwtPriorityRegeneratedIngressVlanPriority , and EthSwtPriorityOut- boundVlanPriority ).

{DRAFT} If an instance of an EthSwtStreamI- dentification is configured, then it shall be possible that this EthSwtStreamI- dentification could reference none, one or multiple ingress and egress ports via EthSwtPortIngressStreamIndentificationRef and EthSwtPortEgressStreamIdentifi- cationRef respectively.

{DRAFT} If an instance of a configured Eth- SwtStreamIdentification references an EthSwtPortIngress or EthSwt- PortEgress , then this instance of stream identification definition shall reference the same EthSwtPortIngress or EthSwtPortEgress exclusively one time.

{DRAFT} Every instance of EthSwtStreamIden- tification shall have a unique position value configured via EthSwtStreamIden- tificationPosition . The value shall start with 0 and continue in ascending order with no gaps for each subsequential instance of EthSwtStreamIdentification .

{DRAFT} The configuration shall allow to have exlu- sively either EthSwtFlowMetering or EthSwtPortATSScheduler in the same EthSwtStreamIdentification configured.

{DRAFT} If an EthSwtPortATSScheduler is configured, then additionally a EthSwtPSFP shall be available in the same EthSwt- StreamIdentification .

{DRAFT} If a filter action EthSwtStreamFilter- ActionDestinationPortModification is configured, then this EthSwtStream- FilterActionDestinationPortModification shall reference the same Eth- SwtPortEgress via EthSwtStreamFilterActionDestinationPortModifi- cationEgressPortRef exclusively one time.

{DRAFT} If a EthSwtStreamIdentification has a EthSwtPSFP configured, then a EthSwtStreamGate shall be configured.

{DRAFT} If a EthSwtPSFP is configured, then the corresponding Ethernet switch hardware shall be configured such that Ethernet frames (i.e. streams) could always pass through (open gate).

{DRAFT} The Ethernet switch configuration shall support to configure the linkage between the priority of an received Ethernet frame and the according queue of an egress port via the traffic class assignment. There- fore the priority to traffic class assignment at an ingress port (exclusively either via EthSwtPortTrafficClassAssignment or EthSwtPriorityTrafficClassAs- signment ) and the traffic class to a queue assignment at the egress port ( via EthSwtPortQueueTrafficClassAssignment ) shall be configured.

{DRAFT} The configuration of the Ethernet switch driver shall support different egress port structures by the configuration EthSwt- PortEgressScheduler .