Network Management Interface (Nm)

Initializes the NM Interface.

This function calls the <Bus>Nm_PassiveStartUp function in case NmBusType is not set to NM_BUSNM_LOCALNM (e.g. CanNm_PassiveStartUp function is called for NM_BUSNM_ CANNM).

This function calls the <Bus>Nm_NetworkRequest (e.g. CanNm_NetworkRequest function is called if channel is configured as CAN) function in case NmBusType is not set to NM_BUSNM_ LOCALNM.

Disables the NM PDU transmission ability. For that purpose <Bus>Nm_DisableCommunication shall be called in case NmBusType is not set to NM_BUSNM_LOCALNM (e.g. CanNm_Disable Communication function is called if channel is configured as CAN).

Enables the NM PDU transmission ability. For that purpose <Bus>Nm_EnableCommunication shall be called in case NmBusType is not set to NM_BUSNM_LOCALNM. (e.g. CanNm_Enable Communication function is called if channel is configured as CAN).

Set user data for NM messages transmitted next on the bus. For that purpose <Bus>Nm_Set UserData shall be called in case NmBusType is not set to NM_BUSNM_LOCALNM. (e.g. Can Nm_SetUserData function is called if channel is configured as CAN).

Get user data out of the last successfully received NM message. For that purpose <Bus>Nm_ GetUserData shall be called in case NmBusType is not set to NM_BUSNM_LOCALNM. (e.g. CanNm_GetUserData function is called if channel is configured as CAN).

Get the whole PDU data out of the most recently received NM message. For that purpose <Bus Nm>_GetPduData shall be called in case NmBusType is not set to NM_BUSNM_LOCALNM. (e.g. CanNm_GetPduData function is called if channel is configured as CAN).

Set Repeat Message Request Bit for NM messages transmitted next on the bus. For that purpose <Bus>Nm_RepeatMessageRequest shall be called in case NmBusType is not set to NM_BUSNM_LOCALNM. (e.g. CanNm_RepeatMessageRequest function is called if channel is configured as CAN). This will force all nodes on the bus to transmit NM messages so that they can be identified.

Get node identifier out of the last successfully received NM-message. The function <Bus>Nm_ GetNodeIdentifier shall be called in case NmBusType is not set to NM_BUSNM_LOCALNM. (e.g. CanNm_GetNodeIdentifier function is called if channel is configured as CAN).

Get node identifier configured for the local node. For that purpose <Bus>Nm_GetLocalNode Identifier shall be called in case NmBusType is not set to NM_BUSNM_LOCALNM. (e.g. Can Nm_GetLocalNodeIdentifier function is called if channel is configured as CAN).

Check if remote sleep indication takes place or not. For that purpose <Bus>Nm_CheckRemote SleepIndication shall be called in case NmBusType is not set to NM_BUSNM_LOCALNM. (e.g. CanNm_CheckRemoteSleepIndication function is called if channel is configured as CAN).

Returns the state of the network management. The function <Bus>Nm_GetState shall be called in case NmBusType is not set to NM_BUSNM_LOCALNM. (e.g. CanNm_GetState function is called if channel is configured as CAN).

This service returns the version information of this module.

This function calls the <Bus>Nm_NetworkRelease bus specific function in case NmBusType is not set to NM_BUSNM_LOCALNM (e.g. CanNm_NetworkRelease function is called if channel is configured as CAN).

Notification that a NM message has been received.

Notification that the state of the lower layer <Bus>Nm has changed.

This function implements the processes of the NM Interface, which need a fix cyclic scheduling.

Notification that a NM-message has been received in the Bus-Sleep Mode, what indicates that some nodes in the network have already entered the Network Mode.

Notification that the network management has entered Network Mode.

Notification that the network management has entered Prepare Bus-Sleep Mode.

Notification that the network management has entered Bus-Sleep Mode.

Notification that the network management has detected that all other nodes on the network are ready to enter Bus-Sleep Mode.

Notification that the network management has detected that not all other nodes on the network are longer ready to enter Bus-Sleep Mode.

Notification to the NM Coordinator functionality that this is a suitable point in time to initiate the coordinated shutdown on.

Service to indicate that an NM message with set Repeat Message Re- quest Bit has been received. This is needed for node detection and the Dynamic PNC-to-channel-mapping feature.

Service to indicate that an attempt to send an NM message failed.

This function is called by a <Bus>Nm to indicate reception of a CWU request.

Sets an indication, when the NM Coordinator Sleep Ready bit in the Control Bit Vector is set

Cancels an indication, when the NM Coordinator Sleep Ready bit in the Control Bit Vector is set back to 0.

Callout function to be called by Nm_CarWakeUpIndication()

Notification that the network management has entered Synchronize Mode.

Set Repeat Message Request Bit and Partial Network Learning Bit for NM messages transmitted next on the bus. For that purpose <Bus>Nm_PnLearningRequest shall be called (e.g. CanNm_PnLearningRequest function if channel is configured as CAN). This will force all nodes to enter the PNC Learning Phase and re-enter Repeat Message Stat. This is needed for the optional Dynamic PNC-to-channel-mapping feature.

Notification that the network management has received a PN shutdown message on a particular NM-channel. This is used to grant a nearly synchronized PNC shutdown across the entire PN topology. Tags: atp.Status=draft

This function store the request for a synchronized PNC shutdown of a particular PNC given by PncId per given NM-Channel. The handling of the synchronized PNC shutdown process is mainly done in the context of the Nm_Mainfunction. The function call is only valid if NmStandardBusType is not set to NM_BUSNM_LOCALNM as a <Bus>Nm like CanNm is needed to transmit the PNC shutdown requests.

Indication that a bus specific network management has received a NM message on a particular NM-channel that contain a PNC bit vector. This is used to aggregate the external PNC requests. The function evaluate if a relevant PNC request (PNC bit set to '1') is available in the given PNC bit vector. If a relevant PNC request is available (PNC bit passes the PNC bit vector filter), then the RelevantPncRequestDetectedPtr refers to a boolean with value set to TRUE. Otherwise refer to booelan with value set to FALSE. RelevantPncRequestDetectedPtr is evaluated by the callee <Bus>Nm module to qualify the further processing of the received NM-PDU.

Indication by ComM of internal PNC requests. This is used to aggregate the internal PNC requests.

Function called by <Bus>Nms to request the aggregated internal PNC requests for transmission within the Nm message.

Notification that the network management has received a PN shutdown message on a particular NM-channel. This is used to grant a nearly synchronized PNC shutdown across the entire PN topology.

Function called by <Bus>Nms to confirm the state of the transmission for the given PNC bit vector on the given NM-Channel.

Operational modes of the network management.

States of the network management state machine.

BusNm Type

Configuration data structure of the Nm module.

The coordination algorithm shall be able to handle a topology where several coordinated busses are connected to one NM Coordinator .

As long as the node implementing the NM Coordinator is not ready to go to sleep on at least one of the busses in a coordination cluster (i.e. that it has actively requested the network), the NM Coordinator shall ensure that the network is requested on all currently active busses in that coordination cluster.

As long as at least one bus in the coordination cluster is not ready to sleep (i.e. because another node than the NM Coordinator is requesting that bus), the NM Coordinator shall still ensure that the network is requested on all currently active busses in that coordination cluster even if the local ECU itself is ready to go to sleep on all busses of that coordination cluster.

The Nm shall convert generic function calls from the ComM to bus specific functions of the bus specific NM layer.

The Nm shall convert callback functions called by the bus specific NM layers to generic callbacks to the ComM.

A scheduled main function shall only contain logic related to the NM Coordinator functionality .

All callbacks of the Nm shall assume that they can run either in task or in interrupt context.

The NM Coordinator shall be able to coordinate busses run- ning the official AUTOSAR bus specific NMs as well as all other generic bus NM s im- plementing the required functionality, callbacks and interfaces.

The NM Interface configuration shall provide the parameter Nm- CoordinatorSupportEnabled to define if the support of the NM Coordinator func- tionality is present or not.

The Base functionality of Nm may be implemented completely or partly using macros.

Module Header File Imported Type Com Com.h Com_SignalIdType ComStack_Types.h NetworkHandleType ComStack_Types ComStack_Types.h PNCHandleType Std_Types.h Std_ReturnType Std Std_Types.h Std_VersionInfoType

<Bus>Nm_GetState – Returns the state and the mode of the network management. <Bus>Nm_NetworkRelease – Release the network, since ECU doesn't have to communicate on the bus. <Bus>Nm_NetworkRequest – Request the network, since ECU needs to communicate on the bus. <Bus>Nm_PassiveStartUp – Passive startup of the NM. It triggers the transition from Bus-Sleep Mode to the Network Mode without requesting the network. ComM_Nm_BusSleepMode ComM_Nm.h Notification that the network management has entered Bus-Sleep Mode. This callback function should perform a transition of the hardware and transceiver to bus-sleep mode. ComM_Nm_NetworkMode ComM_Nm.h Notification that the network management has entered Network Mode. ComM_Nm_NetworkStartIndication ComM_Nm.h Indication that a NM-message has been received in the Bus Sleep Mode, what indicates that some nodes in the network have already entered the Network Mode. API Function Header File Description ComM_Nm_PrepareBusSleepMode ComM_Nm.h Notification that the network management has entered Prepare Bus-Sleep Mode. Reentrancy: Reentrant (but not for the same NM-Channel) ComM_Nm_RestartIndication ComM_Nm.h If NmIf has started to shut down the coordinated busses, AND not all coordinated busses have indicated bus sleep state, AND on at least on one of the coordinated busses NM is restarted, THEN the NM Interface shall call the callback function ComM_ Nm_RestartIndication with the nmNetworkHandle of the channels which have already indicated bus sleep state.

In case the main function is called before the Nm has been ini- tialized, the main function shall immediately return without yielding an error.

The following header files shall be included by the Nm Interface module: • Std_Types.h (for AUTOSAR standard types ) Note: Platform_Types.h (for platform specific types) is indirectly included via AUTOSAR standard types. • ComM_Nm.h (for Communication Manager callback functions) • BswM_Nm.h (If the BswM is used for CarWakeup-functionalitiy)

Caveats of Nm_Init : This service function has to be called af- ter the initialization of the respective bus interface.

Caveats of Nm_PassiveStartUp : The <BusNm> and the Nm itself are initialized correctly.

Caveats of Nm_NetworkRequest : The <BusNm> and the Nm itself are initialized correctly.

If Nm_NetworkRequest is called with a network handle where NmPassiveModeEnabled is set to TRUE it shall not execute any functionality and return with E_NOT_OK . If NmDevErrorDetect is set to TRUE then it shall raise the error NM_E_INVALID_CHANNEL in this case.

Caveats of Nm_NetworkRelease : The <BusNm> and the Nm itself are initialized correctly.

If Nm_NetworkRelease is called with a network handle where NmPassiveModeEnabled is set to TRUE it shall not execute any functionality and return with E_NOT_OK . If NmDevErrorDetect is set to TRUE then it shall raise the error NM_E_INVALID_CHANNEL in this case.

Caveats of Nm_DisableCommunication : The <BusNm> and the Nm itself are initialized correctly.

Configuration of Nm_DisableCommunication : This function is only available if NmComControlEnabled is set to TRUE .

Caveats of Nm_EnableCommunication : The <BusNm> and the Nm itself are initialized correctly.

Configuration of Nm_EnableCommunication : This function is only available if NmComControlEnabled is set to TRUE .

Caveats of Nm_SetUserData : The <BusNm> and the Nm itself are initialized correctly.

Configuration of Nm_SetUserData : This function is only avail- able if NmUserDataEnabled is set to TRUE .

Caveats of Nm_GetUserData : The <BusNm> and the Nm itself are initialized correctly.

Configuration of Nm_GetUserData : This function is only avail- able if NmUserDataEnabled is set to TRUE .

Caveats of Nm_GetPduData : The <BusNm> and the Nm itself are initialized correctly.

Caveats of Nm_RepeatMessageRequest : The <BusNm> and the Nm itself are initialized correctly.

Caveats of Nm_GetNodeIdentifier : The <BusNm> and the Nm itself are initialized correctly.

Caveats of Nm_GetLocalNodeIdentifier : The <BusNm> and the Nm itself are initialized correctly.

Caveats of Nm_CheckRemoteSleepIndication : The <BusNm> and the Nm itself are initialized correctly.

Configuration of Nm_CheckRemoteSleepIndication : This function is only available if NmRemoteSleepIndEnabled is set to TRUE .

Caveats of Nm_GetState : The <BusNm> and the Nm itself are initialized correctly.

The indication through callback function Nm_Network- StartIndication : shall be forwarded to ComM by calling the ComM_Nm_- NetworkStartIndication .

The indication through callback function Nm_NetworkMode : shall be forwarded to ComM by calling the ComM_Nm_NetworkMode .

The indication through callback function Nm_PrepareBus- SleepMode : shall be forwarded to ComM by calling ComM_Nm_PrepareBusSleep- Mode .

The indication through callback function Nm_BusSleepMode : shall be forwarded to ComM by calling the ComM_Nm_BusSleepMode .

Configuration of Nm_PduRxIndication : This function is only available if NmPduRxIndicationEnabled is set to TRUE.

Configuration of Nm_StateChangeNotification : This func- tion is only available if NmStateChangeIndEnabled is set to TRUE.

<Bus>Nm_ActivateTxPnShutdownMsg – NM indicate to activate the transmission of PN shutdown messages on the given NM-Channel. This results in transmission of a NM-PDU with PNSR bit set to 1 (PN shutdown message). <Bus>Nm_CheckRemoteSleep Indication – Check if remote sleep indication takes place or not. <Bus>Nm_DeactivateTxPnShutdown Msg – NM indicate to deactive the transmission of PN shutdown messages on the given NM-Channel. This result in transmission of a usual NM-PDUs with PNSR bit set to 0. <Bus>Nm_DisableCommunication – Disable the NM PDU transmission ability. <Bus>Nm_EnableCommunication – Enable the NM PDU transmission ability. <Bus>Nm_GetLocalNodeIdentifier – Get node identifier configured for the local node. <Bus>Nm_GetNodeIdentifier – Get node identifier out of the last successfully received NM-message. <Bus>Nm_GetPduData – Pointer where NM PDU shall be copied to. <Bus>Nm_GetUserData – Get user data out of the last successfully received NM message. <Bus>Nm_PnLearningRequest – – <Bus>Nm_RepeatMessageRequest – Request a Repeat Message Request to be transmitted next on the bus. <Bus>Nm_RequestBus Synchronization – Request bus synchronization. <Bus>Nm_RequestSynchronizedPnc Shutdown – – <Bus>Nm_SetSleepReadyBit – Set the NM Coordinator Sleep Ready bit in the Control Bit Vector <Bus>Nm_SetUserData – Set user data for NM messages transmitted next on the bus. API Function Header File Description BswM_Nm_CarWakeUpIndication BswM_Nm.h Function called by Nm to indicate a CarWakeup. Com_SendSignal Com.h The service Com_SendSignal updates the signal object identified by SignalId with the signal referenced by the SignalDataPtr parameter. ComM_Nm_ForwardSynchronizedPnc Shutdown ComM_Nm.h If an ECU in role of an intermediate PNC coordinator receives a PN shutdown message via a <Bus>Nm, then ComM is immediately indicated via ComM_ Nm_ForwardSynchronizedPncShutdown to forward the request for a synchronized PNC shutdown of the affected PNCs given by PncBitVectorPtr. Therefore, ComM will immediately release the affected PNC state machines and forward the PNC bit vector to the affected ComM Channels and the corresponding NM channels, respectively. Note: This supports a nearly synchronized PNC shutdown across the PN topology from the top-level PNC coordinator down to the subordinated PNC node. ComM_Nm_PncLearningBitIndication ComM_Nm.h Service to indicate that an NM message with set PNC Learning Bit has been received. ComM_Nm_RepeatMessageLeft Indication ComM_Nm.h Notification that the state of all <Bus>Nm has left RepeatMessage. This interface is used to indicate by the optional Dynamic PNC-to-channel-mapping feature to indicate that learning phase ends. ComM_Nm_UpdateEIRA ComM_Nm.h Function to indicate the current aggregated external / internal PNC request called by Nm. ComM_Nm_UpdateERA ComM_Nm.h Function to indicate the current external PNC request per channel called by Nm. Det_ReportError Det.h Service to report development errors.

It shall be possible to configure multiple NM coordination clusters that shall be coordinated independently.

Each bus shall belong to zero or one NM coordination cluster.

Shutdown shall only be coordinated on the presently awake net- works of a coordination cluster. Networks that are already in ”bus-sleep mode“ shall still be monitored but not coordinated.

When all networks of a coordination cluster are either ready to go to sleep or already in ”bus-sleep mode“ the NM Coordinator shall start the coordinated shutdown on all awake networks. The NM Coordinator shall eval- uate continuously if the coordinated shutdown can be started.

If the configuration parameter NmSynchronizingNetwork is TRUE for any of the busses in a coordination cluster, the coordination shutdown shall be delayed until a network that is configured as synchronizing network for this coordination cluster invoked Nm_SynchronizationPoint .

If not all conditions to start the coordinated shutdown have been met, or if the coordinated shutdown has already been started (but not aborted), calls to Nm_SynchronizationPoint shall be ignored.

If the configuration parameter NmSynchronizingNetwork is FALSE for all of the presently awake busses in a coordination cluster, the timers shall be started after all shutdown conditions have been met, without waiting for a call to Nm_SynchronizationPoint (). (see also [SWS_Nm_00172]).

When the coordinated shutdown is started, a shutdown de- lay timer shall be activated for each currently awake channel in the coordination clus- ter. Each timer shall be set to NmGlobalCoordinatorTime . In case NmBusType is not set to NM_BUSNM_LOCALNM additionally the shutdown time of the specific channel TSHUTDOWN_CHANNEL shall be subtracted.

When a shutdown timer expires for a network, Nm shall in case BusNmType is not set to NM_BUSNM_LOCALNM release the network by calling the <Bus>Nm_RequestBusSynchronization followed by <Bus>Nm_NetworkRe- lease . In case BusNmType is set to NM_BUSNM_LOCALNM Nm shall inform ComM about shutdown by calling ComM_Nm_BusSleepMode() .

Nm shall keep track of all networks that have been released but have not yet reported ”bus-sleep mode“. If the shutdown is aborted, these networks shall still be considered active networks.

The coordinated shutdown shall be aborted if any network in that NM Coordination Cluster , • indicates Nm_RemoteSleepCancellation or • indicates Nm_NetworkMode or • indicates Nm_CoordReadyToSleepCancellation • or the ComM request one of the networks with Nm_NetworkRequest or Nm_- PassiveStartUp .

If the coordinated shutdown is aborted, NM Coordinator shall call ComM_Nm_RestartIndication for all networks that already indicated ”bus sleep“.

If the coordinated shutdown is aborted, NM Coordinator shall in case BusNmType is not set NM_BUSNM_LOCALNM request the network from the <Bus>Nm 's for the networks that have not indicated ”bus sleep“. In case BusNmType is set to NM_BUSNM_LOCALNM Nm shall inform ComM about network startup by calling ComM_Nm_NetworkMode() .

If the coordination algorithm has been aborted, all con- ditions that guard the initiation of the coordinated shutdown shall be evaluated again.

If a bus of a coordination cluster has the parameter NmChannel- SleepMaster set to TRUE , the NM Coordinator shall consider that bus ready to sleep at all times and shall not await an invocation of Nm_RemoteSleepIndication from that bus before starting shutdown of that network.

Type of error Related error code Error value API service used without Nm interface initialization NM_E_UNINIT 0x00 API Service called with wrong parameter but not with NULL-pointer NM_E_INVALID_CHANNEL 0x01 API service called with a NULL pointer NM_E_PARAM_POINTER 0x02

If the pre-processor switch NmDevErrorDetect is set to TRUE , all function calls containing a NetworkHandleType parameter shall raise the error NM_- E_INVALID_CHANNEL if the network parameter is not a configured network handle.

If a coordinated shutdown has been aborted and Nm re- ceives E_NOT_OK on a <Bus>Nm_NetworkRequest , that network shall not be con- sidered awake when the conditions for initiating a coordinated shutdown are evaluated again.

If a coordinated shutdown has been initiated and Nm re- ceives E_NOT_OK on a <Bus>Nm_NetworkRelease , the shutdown shall be imme- diately aborted. For all networks that have not entered ”bus-sleep mode“, Nm shall request the networks. This includes the network that indicated an error for <Bus> Nm_NetworkRelease . As soon as this has been done, the conditions for initiating coordinated shutdown can be evaluated again. This applies also to networks that were not actively participating in the current coordinated shutdown.

Configuration of Nm_SetUserData : If NmComUserDataSup- port is TRUE the API Nm_SetUserData shall not be available.

The Nm Interface shall optionally include the header file of De- fault Error Tracer (depending on the pre-processor switch NmDevErrorDetect, see ECUC_Nm_00203). • Det.h for service of the Default Error Tracer.

If the ComM calls Nm_PassiveStartUp () for a network that is part of a coordinated cluster of networks, the Nm coordinator functionality shall treat this call as if the ComM had called Nm_NetworkRequest (). In case BusNmType is not set to NM_BUSNM_LOCALNM the Nm shall forward a call of <Bus>Nm_NetworkRe- quest to the lower layer and accordingly, the network shall be counted as requested by the NM coordinator.

The code file structure shall not be defined within this specification completely. At this point it shall be pointed out that the code-file structure shall include the following files named:

If NmStateReportEnabled is set to TRUE and NmStateRe- portSignalRef is configured, when one of the state transitions mentioned in Table 7.4 occur, Nm_StateChangeNotification shall call Com_SendSignal(uint8, Com_SignalIdType, const void * ) for the signal referenced by NmStateRe- portSignalRef with the value according to Table 7.4

Configuration of Nm_CarWakeUpIndication : Optional If NmCarWakeUpRxEnabled is TRUE , The Nm shall provide the API Nm_CarWake- UpIndication .

If the <bus>Nm calls Nm_CarWakeUpIndication and NmCar- WakeUpCallout is defined, the NM Interface shall call the callout function defined by NmCarWakeUpCallout with nmNetworkHandle as parameter.

Configuration of Nm_CoordReadyToSleepIndication : Op- tional If NmCoordinatorSyncSupport is set to TRUE , the Nm shall provide the API Nm_- CoordReadyToSleepIndication .

The NM-Coordinator shall support two or more NM- Coordinators connected to the same NM Cluster .

On its passively coordinated channels a NM-Coordinator shall send Nm messages only if the node has a network management request pending or a connected network which is coordinated actively by that NM Coordinator is not ready to sleep.

The NM Coordinator shall set the NMcoordinatorSleepReady bit in the NM message via <Bus>Nm_SetSleepReadyBit to the value 1 at his actively coordinated channels, IF all nodes of the NM Coordination cluster are ready to sleep (RemoteSleepIndi- cation) AND IF NmSynchronizingNetwork is enabled a Nm_SynchronizationPoint () call has been received on the corresponding channel AND If all channels of this NM Coordination cluster are configured as NmActiveCo- ordinator == TRUE . AND If the NmBusType is not configured to NM_BUSNM_LOCALNM .

If Nm_CoordReadyToSleepIndication is received on a passively coordinated channel the NmCoordinator shall set the NMCoordinatorSleep- Ready bit to SET (1) via API call to <Bus>Nm_SetSleepReadyBit on all actively coordinated channels.

The NM Coordinator shall start coordinated shutdown af- ter the Sleep Ready Bit with SET status has been requested.

NM Coordinator shall set the NMCoordinatorSleepReady bit to UNSET (0) via API call to <Bus>Nm_SetSleepReadyBit on all actively coordinated channels if the coordinated shutdown has been aborted for any reason.

If Nm_CoordReadyToSleepCancellation is received on a passively coordinated channel the NmCoordinator shall set the NMCoordinatorSleep- Ready bit to UNSET (0) via API call to <Bus>Nm_SetSleepReadyBit on all actively coordinated channels.

Configuration of Nm_CoordReadyToSleepCancellation : Op- tional If NmCoordinatorSyncSupport is set to TRUE , the Nm shall provide the API Nm_- CoordReadyToSleepCancellation .

Configuration of Nm_RemoteSleepIndication : This function is only available if NmRemoteSleepIndEnabled is set to TRUE .

Configuration of Nm_RemoteSleepCancellation : This func- tion is only available if NmRemoteSleepIndEnabled is set to TRUE .

If NmCoordinatorSupportEnabled is set to TRUE, the Nm_- MainFunction API shall be available.

The functionality of coordinating nested sub busses shall be avail- able if the NmCoordinatorSyncSupport parameter is set to TRUE .

NmGlobalCoordinatorTime shall be set at least to the maxi- mum time needed to shut down all Networks coordinated.

The Configuration pointer ConfigPtr shall always have a NULL_PTR value.

If the NmGlobalCoordinatorTime is zero the shutdown delay timer of all channels shall also be zero.

If the <bus>Nm calls Nm_CarWakeUpIndication and Nm- CarWakeUpCallout is not defined, the NM Interface shall call the function BswM_Nm_CarWakeUpIndication with nmNetworkHandle as parameter.

If Nm_DisableCommunication is called with a network handle where NmPassiveModeEnabled is set to TRUE it shall not execute any functionality and return with E_NOT_OK . If NmDevErrorDetect is set to TRUE then it shall raise the error NM_E_INVALID_CHANNEL in this case.

If Nm_EnableCommunication is called with a network handle where NmPassiveModeEnabled is set to TRUE it shall not execute any functionality and return with E_NOT_OK . If NmDevErrorDetect is set to TRUE then it shall raise the error NM_E_INVALID_CHANNEL in this case.

If Nm_SetUserData is called with a network handle where Nm- PassiveModeEnabled is set to TRUE it shall not execute any functionality and return with E_NOT_OK . If NmDevErrorDetect is set to TRUE then it shall raise the error NM_E_INVALID_CHANNEL in this case.

If Nm_RepeatMessageRequest is called with a network handle where NmPassiveModeEnabled is set to TRUE it shall not execute any functionality and return with E_NOT_OK . If NmDevErrorDetect is set to TRUE then it shall raise the error NM_E_INVALID_CHANNEL in this case.

If Nm_CheckRemoteSleepIndication is called with a network handle where NmPassiveModeEnabled is set to TRUE it shall not execute any func- tionality and return with E_NOT_OK . If NmDevErrorDetect is set to TRUE then it shall raise the error NM_E_INVALID_CHANNEL in this case.

If the NM Coordinator functionality is configured, the con- figuration parameter NmCycletimeMainFunction shall be configured (see [SWS_Nm_00118]).

If on a coordinated network the coordinator detects a mode change to NM_MODE_SYNCHRONIZE , NM_MODE_PREPARE_BUS_SLEEP or NM_BUS_- SLEEP AND the coordinated cluster this network belongs to has not started the shut- down process AND if there is no internal network mode request for that channel by ComM, the coordinator shall treat this network as remote sleep and shall call <Bus> Nm_NetworkRelease for this network. If additionally for this network the configuration parameter NmSynchronizingNetwork is TRUE then the coordinator shall not wait for Nm_SynchronizationPoint on this network.

If NmPnEiraCalcEnabled is set to TRUE, then Nm shall provide the possibility to store external and internal requested PNCs combined over all NM- channels where NmPnEnabled is set to TRUE. At initialization the values of all PNCs within EIRA shall be set to 0 (PNC released).

If the reception of PN shutdown message via callback function Nm_ForwardSynchronizedPncShutdown is indicated, then Nm shall stop the ERA related monitoring of external PNC requests of the PNCs (see [SWS_Nm_00324])) which are indicated for an PNC shutdown (PNC bit set to '1') in the given PNC bit vector , set the corresponding ERA bits to '0' in the ERA of the indicated NM-channel and forward the indication to ComM with the corresponding ComMChan- nel by calling ComM_Nm_ForwardSynchronizedPncShutdown(<ComMChannel>, <PncBitVector>) .

The PNC bit vector filter algorithm shall evaluate the bytes of the given PNC bit vector in the context of Nm_PncBitVectorRxIndication .

Every bit (PNC bit) of the PNC bit vector represents one Par- tial Network Cluster (PNC). If the PNC bit is set to 1 the Partial Network Cluster is requested. If the bit is set to 0 there is no request for this PNC.

The PNC bit vector filter algorithm shall compare (bitwise AND) the received PNC bit vector with the PN filter mask to detect if a relevant PNC is requested or not. Each PNC bit of the PN filter mask shall have the following meaning: • 0: The PNC request is irrelevant for the ECU. The communication stack of the ECU is not kept awake if this bit is set in a received PNC bit vector . • 1: The PNC request is relevant for the ECU. The communication stack of the ECU is kept awake if this bit is set in a received PNC bit vector .

If Nm_PncBitVectorRxIndication is called, NmPnEiraCal- cEnabled or NmPnEraCalcEnabled is set to TRUE and at least one PNC bit is de- tected as relevant PNC request according to [SWS_Nm_00311] in the given PNC bit vector , the OUT parameter RelevantPncRequestDetectedPtr shall be set to TRUE. Otherwise the value of RelevantPncRequestDetectedPtr shall be set to FALSE.

If • NmPnEiraCalcEnabled is TRUE • and a PNC bit vector is received via Nm_PncBitVectorRxIndica- tion (<Nm-channel>, < PNC bit vector of external PNC requests>) or Nm_ForwardSynchronizedPncShutdown (<NM-channel>, < PNC bit vec- tor PNCs indicated for a synchronized shutdown>) • and PNCs are requested within this message (bits set to 1) • and the requested PNCs are set to 1 within the configured PN filter mask then Nm shall store the request information (value 1) for these PNCs as "PNC re- quested".

⌊ DRAFT g If • NmPnEiraCalcEnabled is TRUE • and a transmission of a PNC bit vector is indicated via Nm_PncBitVec- torTxIndication (<NM-channel>, <buffer to provide the unfiltered PNC bit vector of aggregated internal PNC requests >) • and PNCs are requested within the stored unfiltered PNC bit vector (bits set to 1) • and the requested PNCs of the stored unfiltered PNC bit vector for internal PNC requests are set to 1 within the configured PN filter mask then Nm shall store the request information (value 1) for these PNCs as "PNC re- quested".

If Nm_UpdateIRA (<NM-channel>, <PncBitVector of aggregated internal PNC requests>) is called, the Nm shall store the received unfilterred PncBitVec- tor per given NM-channel. Therefore, the Nm module shall copy the amount of bytes with respect of the configured length (see NmPncBitVectorLength ) of the given NM- Channel.

If NmPnEiraCalcEnabled is TRUE, then Nm shall provide a pos- sibility to monitor each relevant PNC in the context of Nm_Mainfunction . The moni- toring shall consider the PNC state, if the PNC is still externally or internally requested on at least one of the relevant NM-channels.

If NmPnEiraCalcEnabled is TRUE and every time a PNC is stored as "PNC requested" (see [SWS_Nm_00313]), then the monitoring for this PNC shall be restarted with respect to NmPnResetTime in the context of Nm_Mainfunc- tion .

If NmPnEiraCalcEnabled is TRUE and a PNC is not requested again within NmPnResetTime the corresponding stored value for this PNC shall be set to PNC released (value 0) in the context of Nm_Mainfunction .

If NmPnEiraCalcEnabled is TRUE and the stored value for a PNC is set to PNC requested or back to PNC released (see [SWS_Nm_00313] and [SWS_Nm_00320]), then Nm shall forward the changed state of EIRA to ComM by calling ComM_Nm_UpdateEIRA(<PncBitVector of EIRA>)) .

If NmPnEraCalcEnabled is TRUE, then Nm shall provide the pos- sibility to store relevant external PNCs request per channel. At initialization the values of all PNCs shall be set to 0 (PNC released).

If • NmPnEraCalcEnabled is TRUE • and a PNC bit vector is received via Nm_PncBitVectorRxIndication(<NM- channel>, <PncBitVector of external PNC requests>) • and PNCs are requested within this message (bits set to 1) • and the requested PNCs are set to 1 within the configured PN filter mask then Nm shall store the PNC request information (value 1) for these PNCs as "PNC requested" per given channel.

If NmPnEraCalcEnabled is TRUE, then Nm shall provide a pos- sibility to monitor each relevant PNC per channel in the context of Nm_Mainfunction . The monitoring shall consider the PNC state, if the PNC is still externally requested on the corresponding NM-channels.

If NmPnEraCalcEnabled is TRUE, then every time a PNC is stored as "PNC requested" (see [SWS_Nm_00323]), the monitoring for this PNC shall be restarted with respect to NmPnResetTime in the context of Nm_Mainfunction .

If NmPnEraCalcEnabled is TRUE and a PNC is not requested again within NmPnResetTime the corresponding stored value for this PN shall be set to PNC released (value 0).

If NmPnEraCalcEnabled is TRUE and the stored value for a PNC is set to PNC requested or back to PNC released (see [SWS_Nm_00323] and [SWS_Nm_00326]), then Nm shall forward the changed state of ERA of the affected NM-channel to ComM by calling ComM_Nm_UpdateERA(<ComMChannel>, <PncBitVector of ERA>) .

If NmPartialNetworkSupportEnabled is set to TRUE, then all PNC reset timers shall be stopped at initialization.

If NmPartialNetworkSupportEnabled is set to TRUE, then the evaluation of the PNC states in combination with PNC reset timers shall consider at least the following order: • Update PNC reset timers • Evaluate the PNC states • Perform actions based on the current state of PNC reset timer and PNC requests

For all configured NM-channel where NmPartialNetworkSup- portEnabled is set TRUE, Nm shall provide the possibility to store external and in- ternal requested PNCs combined over all NM-channels where NmPnEnabled is set to TRUE. At initialization the values of all PNCs within EIRA shall be set to 0 (PNC released).

If NmPnEiraCalcEnabled is TRUE and NmPnEraCalcEn- abled is TRUE , the PNC status information has to be stored separately for both, the EIRA and ERA information (compare [SWS_Nm_00302] and [SWS_Nm_00322]).

⌊ DRAFT g If NmPnEiraCalcEnabled is set to TRUE and Nm_- PncBitVectorTxIndication (NetworkHandle, PncBitVectorPtr) is called, then Nm shall copy the unfiltered PNC bit vector for internal PNC requests of the given NM- channel to the buffer indicated by PncBitVectorPtr.

If BusNmType is NM_BUSNM_LOCALNM and ComM requests Nm_- PassiveStartUp() or Nm_NetworkRequest() then Nm shall inform ComM about start of network by calling ComM_Nm_NetworkMode() . Rationale : Buses of type NM_LOCAL_NM which are coordinated do not have a network management message but are synchronized e.g. by a master - slave concept like LIN). These Bus-Types are always directly started on request by ComM but the shutdown will be done by coordinator algorithm.

The Nm module shall apply appropriate mechanisms to allow calls of its APIs from other partitions than its main function, e.g. by providing a Nm satellite.

Nm shall interact with <Bus>Nm (i.e. call <Bus>Nm APIs) only in the partition, where the respective <Bus>Nm module is assigned to.

The Nm kernel shall be assigned to the same partition as ComM kernel in order to keep the interaction between these two modules on an intra-partition basis.

When Nm_StateChangeNotification is called to report a change of the Nm state, Nm shall call BswM_Nm_StateChangeNotification() with the reported current state.

If the pre-processor switch NmDevErrorDetect is set to TRUE , the function Nm_PassiveStartUp shall raise the error NM_E_INVALID_CHANNEL if the parameter NetworkHandle is not a configured network handle.

If the pre-processor switch NmDevErrorDetect is set to TRUE , the function Nm_NetworkRequest shall raise the error NM_E_INVALID_CHANNEL if the parameter NetworkHandle is not a configured network handle.

If the pre-processor switch NmDevErrorDetect is set to TRUE , the function Nm_NetworkRelease shall raise the error NM_E_INVALID_CHANNEL if the parameter NetworkHandle is not a configured network handle.

If the pre-processor switch NmDevErrorDetect is set to TRUE , the function Nm_DisableCommunication shall raise the error NM_E_INVALID_- CHANNEL if the parameter NetworkHandle is not a configured network handle.

If the pre-processor switch NmDevErrorDetect is set to TRUE , the function Nm_EnableCommunication shall raise the error NM_E_INVALID_- CHANNEL if the parameter NetworkHandle is not a configured network handle.

If the pre-processor switch NmDevErrorDetect is set to TRUE , the function Nm_SetUserData shall raise the error NM_E_INVALID_CHANNEL if the parameter NetworkHandle is not a configured network handle.

If the pre-processor switch NmDevErrorDetect is set to TRUE , the function Nm_GetUserData shall raise the error NM_E_INVALID_CHANNEL if the parameter NetworkHandle is not a configured network handle.

If the pre-processor switch NmDevErrorDetect is set to TRUE , the function Nm_GetPduData shall raise the error NM_E_INVALID_CHANNEL if the parameter NetworkHandle is not a configured network handle.

If the pre-processor switch NmDevErrorDetect is set to TRUE , the function Nm_RepeatMessageRequest shall raise the error NM_E_INVALID_- CHANNEL if the parameter NetworkHandle is not a configured network handle.

If the pre-processor switch NmDevErrorDetect is set to TRUE , the function Nm_GetNodeIdentifier shall raise the error NM_E_INVALID_CHAN- NEL if the parameter NetworkHandle is not a configured network handle.

If the pre-processor switch NmDevErrorDetect is set to TRUE , the function Nm_GetLocalNodeIdentifier shall raise the error NM_E_INVALID_- CHANNEL if the parameter NetworkHandle is not a configured network handle.

If the pre-processor switch NmDevErrorDetect is set to TRUE , the function Nm_CheckRemoteSleepIndication shall raise the error NM_E_IN- VALID_CHANNEL if the parameter nmNetworkHandle is not a configured network handle.

If the pre-processor switch NmDevErrorDetect is set to TRUE , the function Nm_GetState shall raise the error NM_E_INVALID_CHANNEL if the pa- rameter nmNetworkHandle is not a configured network handle.

If NmDynamicPncToChannelMappingEnabled is set to TRUE and Nm_StateChangeNotification is called, then ComM_Nm_RepeatMessageLeftIndication() shall be called when nmPre- viousState is set to NM_STATE_REPEAT_MESSAGE and nmCurrentState is different from NM_STATE_REPEAT_MESSAGE .

Nm_PnLearningRequest shall only be available if NmDynam- icPncToChannelMappingSupport is set to TRUE .

If Nm_PnLearningRequest is called with a network handle for a bus system where NmDynamicPncToChannelMappingEnabled is set to FALSE Nm shall not execute any functionality and return with E_NOT_OK . If NmDevErrorDetect is set to TRUE then it shall raise the error NM_E_INVALID_CHANNEL in this case.

If Nm_RepeatMessageIndication is called with pn- LearningBitSet set to TRUE and NmDynamicPncToChannelMappingEn- abled is set to TRUE for the provided nmNetworkHandle Nm shall call ComM_Nm_PncLearningBitIndication with the corresponding network handle.

If the pre-processor switch NmDevErrorDetect is set to TRUE , the function Nm_PnLearningRequest shall raise the error NM_E_INVALID_CHAN- NEL if the parameter NetworkHandle is not a configured network handle.

⌊ DRAFT g If function Nm_RequestSynchronizedPncShutdown is called, NmSynchronizedPncShutdownEnabled is set to TRUE and NmStan- dardBusType is set to a type other than NM_BUSNM_LOCALNM , the function shall immediately forward the call to the affected <Bus>Nm by calling <Bus> Nm_RequestSynchronizedPncShutdown . Otherwise the function shall return with E_NOT_OK .

⌊ OBSOLETE g The indication of a received PN shutdown message via callback function Nm_ForwardSynchronizedPncShutdown shall be forwarded to ComM with the corresponding ComMChannel by calling ComM_Nm_ForwardSynchronizedPncShutdown(<ComMChannel>) .

If the pre-processor switch NmDevErrorDetect is set to TRUE , the function Nm_RequestSynchronizedPncShutdown shall raise the error NM_E_- INVALID_CHANNEL if the parameter NetworkHandle is not a configured network handle.

[SWS_Nm_00509] occur, Nm_StateChangeNotification shall call Com_SendSignal(uint8, Com_SignalIdType, const void*) for the signal referenced by NmStateRe- portSignalRef with the value according to [SWS_Nm_00509].⌋ Note: The transmitted signal has to be at least a 6 bit signal in Com that should be part of the NM message.

If function Nm_RequestSynchronizedPncShutdown is called, NmSynchronizedPncShutdownEnabled is set to TRUE and NmStandardBusType of the given NM-channel is set to a type other than NM_BUSNM_LOCALNM , the Nm module shall store the given PNC (PncId) per given NM-channel ( NetworkHandle ) as a pending request for a synchronized PNC shutdown.

If NmSynchronizedPncShutdownEnabled is set to TRUE, re- quests for synchronized PNC shutdown are pending and PNC shutdown handling has been deactived, then Nm shall activate the PNC shutdown handling by calling <Bus> Nm_ActivateTxPnShutdownMsg .

If NmSynchronizedPncShutdownEnabled is set to TRUE, no requests for synchronized PNC shutdown are pending, PNC shutdown handling has been activated, then Nm shall deactivate the PNC shutdown handling by calling <Bus> Nm_DeactivateTxPnShutdownMsg .

If NmPnShutdownMessageRetransmissionDuration is configured and Nm_RequestSynchronizedPncShutdown is called (refer to [SWS_Nm_00523]), then the corresponding retransmission timer for PN shutdown messages shall be started with NmPnShutdownMessageRetransmissionDura- tion on all affected NM-channels.

If NmSynchronizedPncShutdownEnabled is set to TRUE, PNC shutdown handling has been activated (refer to [SWS_Nm_00523]) and Nm_- PncBitVectorTxConfirmation is called with E_OK, then the Nm module shall consider those PNC IDs, stored as pending request for a synchronized PNC shut- down of the given NM-channel, as completed which were indicated by the given PNC bit vector (PNC bit set '1') and remove them from storage. Additionally, if NmPn- ShutdownMessageRetransmissionDuration is configured, then the Nm module shall cancel the retransmission timer for PN shutdown messages of the affected NM- channel.

If NmSynchronizedPncShutdownEnabled is set to TRUE and the Nm module has stored PNC IDs as pending request for a synchronized PNC shut- down, then Nm shall remove those PNC IDs from storage which are either externally or internally requested again: • Nm shall check on reception of an PNC bit vector via call of Nm_- PncBitVectorRxIndication , if externally requested PNCs are received. • Nm shall check on update of an PNC bit vector via call of Nm_UpdateIRA , if internal PNC requests are available .

If NmSynchronizedPncShutdownEnabled is set to TRUE, NmPnShutdownMessageRetransmissionDuration is not configured, the corre- sponding <Bus>Nm module of this NM-channel has indicated transmission request via call of Nm_PncBitVectorTxIndication and Nm_PncBitVectorTxConfir- mation is called with result E_NOT_OK (transmission of the given PNC bit vector failed), then the Nm shall remove the PNC IDs stored as pending request for a syn- chronized PNC shutdown of the corresponding NM-channel and report the runtime error NM_E_TRANSMISSION_OF_PN_SHUTDOWN_MESSAGE_FAILED to DET .

If NmSynchronizedPncShutdownEnabled is set to TRUE and a retransmission timer for a PN shutdown message (see NmP- nShutdownMessageRetransmissionDuration ) expires, then Nm shall remove the pending request for a synchronized PNC shutdown of the cor- responding NM-channel from the storage and report the runtime error NM_E_TRANSMISSION_OF_PN_SHUTDOWN_MESSAGE_FAILED to DET .

If NmPartialNetworkSupportEnabled is set to TRUE, then PNC shutdown handling shall be considered as deactivated at initialization.

If • NmPnEiraCalcEnabled is set to TRUE • and a transmission of a PNC bit vector is indicated via Nm_PncBitVec- torTxIndication (<NM-channel>, <buffer to provide the unfiltered PNC bit vector of aggregated internal PNC requests >) • and no requests for a synchronized PNC shutdown are pending on the given NM-channel • and PNCs are requested within the stored unfiltered PNC bit vector (bits set to 1) • and the requested PNCs of the stored unfiltered PNC bit vector for internal PNC requests are set to 1 within the configured PN filter mask then Nm shall store the request information (value 1) for these PNCs as "PNC re- quested".

If NmPnEiraCalcEnabled is TRUE, Nm_PncBitVec- torTxIndication (<NM-channel>, PncBitVectorPtr <buffer to provide the unfiltered PNC bit vector>) is called and no requests for synchronized PNC shutdown are pending on the given NM-channel, then Nm shall copy the unfiltered PNC bit vector for internal PNC requests of the given NM-channel to the buffer indicated by PncBitVectorPtr .

If • NmPnEiraCalcEnabled is set to TRUE • and requests for a synchronized PNC shutdown are pending on the given NM- channel • and a transmission of a PNC bit vector is indicated via Nm_PncBitVec- torTxIndication (<NM-channel>, <buffer to provide the PNC bit vector of the aggregated synchronized PNC requests >), • and PNCs are requested for a synchronized PNC shutdown within the PNC bit vector (bits set to 1) • and the aggregated synchronized PNC requests of the PNC bit vector are set to 1 within the configured PN filter mask, then Nm shall store the request information (value 1) for these PNCs as "PNC re- quested".

If NmPnEiraCalcEnabled is set to TRUE, Nm_PncBitVec- torTxIndication (NetworkHandle <NM-channel>, PncBitVectorPtr <buffer to pro- vide the aggregated synchronized PNC requests as bit vector>) is called and requests for synchronized PNC shutdown are pending on the given NM-channel, then Nm shall set the buffer indicated by PncBitVectorPtr as follows : • set all according bits to 1 that relate to a PNC requested for synchronized PNC shutdown of the given NM-channel • set all other bits to 0

Not applicable requirements These requirements are not ap- plicable to this specification.

Type of error Related error code Error value Retransmission timer for a PN shutdown message has expired, because a PN shutdown message could not be transmitted on the network within the configured duration of re-transmission. NM_E_TRANSMISSION_OF_PN_SHUTDOWN_ MESSAGE_FAILED 0x10

The length of all configured NmPnFilterMaskByte s shall have the same length (in bytes) as the NmPncBitVectorLength of the cor- responding NM-channel. A configuration tool shall reject a configuration as invalid (error), if the length of the configured NmPnFilterMaskByte s differ from the config- ured NmPncBitVectorLength of the corresponding NM-channel.

Not applicable requirements These requirements are not applicable to this specification.