CAN Network Management (CanNm)

Initialize the Can Nm module.

Passive startup of the AUTOSAR CAN NM. It triggers the transition from Bus - Sleep Mode or Prepare Bus Sleep Mode to the Network Mode in Repeat Message State. Caveats: Can Nm is initia lized correctly.

Request the network, since ECU needs to communicate on the bus.

Release the network, since ECU doesn't have to communicate on the bus.

Disable the NM PDU transmission ability due to a ISO14229 Communication Control (28hex) service

Enable the NM PDU transmission ability due to a ISO14229 Communication Control (28hex) service

Set user data for NM PDUs transmitted next on the bus.

Get user data out of the most recently received NM PDU.

Get node identifier out of the most recently received N M PDU.

Get node identifier configured for the local node.

Set Repeat Message Request Bit for NM PDUs transmitted next on the bus.

Get the whole PDU data out of the most recently received NM PDU.

Returns the state and the mode of the network management.

This service returns the version information of this module.

Request bus synchronization.

Check if remote sleep indication takes place or not.

The lower layer communication interface module confirms the transmission of a PDU, or the failure to transmit a PDU.

Indication of a receive d PDU from a lower layer communication interface module.

Main function of the Can Nm which processes the algorithm describes in that document.

Requests transmission of a PDU.

Set the NM Coordinator S leep Ready bit in the Control Bit Vector

Enables the PN filter functionality on the indicated NM channel. Availability: The API is only available if Can Nm Global Pn Support is TRUE.

Within this API, the upper layer module (called module) shall check whether the available data fits into the buffer size reported by Pdu Info Ptr - >Sdu Length. If it fits, it shall copy its data into the buffer provided by Pdu Info Ptr - >Sdu Data Ptr and update the length of the actual copied data in Pdu Info Ptr - >Sdu Length. If not, it returns E_ NOT_ OK without changing Pdu Info Ptr.

De - initializes the Can Nm module.

Requests transmission of a NM - PDU with PNSR bit set to 1 (PN shutdown message) Tags: atp.Status=draft

Set Repeat Message Request Bit and Partial Network Learning Bit for NM messages transmitted next on the bus. This will force all nodes to enter the PNC Learning Phase. This is needed for the optional Dynamic PNC - to - channel - mapping feature.

NM indicate to activate the transmission of PN shutdown messages on the given NM - Channel. This results in transmission of a NM - PD U with PNSR bit set to 1 (PN shutdown message).

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.

This type shall contain at least all parameters that are post - build able according to chapter 10.

If Normal Operation State is entered from Ready Sleep State the transmission of NM PDUs shall be started immediately.

The CanNm module shall set the S ource N ode I dentifier with the configuration parameter CanNmNodeId unless CanNmPduNidPosition is set to off.

The Control Bit Vector shall consist of Bit 0: Repeat Message Request Bit 0: Repeat Message State not requested 1: Repeat Message State requested Bit 1 : PN Shutdown Request Bit (PNSR) 0: NM message does not contain synchronized Partial Network shutdown re quest 1: NM message does contain synchronized Partial Network shutdown request for at least one PNC Bit 3: NM Coordinator Sleep Bit 0: Start of synchronized shutdown is not requested by main coordinator 1: Start of synchronized shutdown is requested by mai n coordinator Bit 4 Active Wakeup Bit 0: Node has not woken up the network (passive wakeup) 1: Node has woken up the network (active Wakeup) Bit 5 Partial Network Learning Bit (PNL) 0: PNC Learning is not requested 1: PNC Learning is requested Bit 6 Part ial Network Information Bit (PNI) 0: NM PDU contains no Partial Network request information 1: NM PDU contains Partial Network request information Bit 2 and 7 are reserved for future extensions 0: Disabled / Reserved for future usage

[SWS_CanNm_00061],

[SWS_CanNm_00064],

[SWS_CanNm_00065],

[SWS_CanNm_00066] and

[SWS_CanNm_00073] ⌈If CanNmPassiveModeEnabled is set to TRUE or CanNmImmediateTxconfEnabled is set to TRUE CanNm shall not perform transmission error handling and omit the requirements [SWS_CanNm_00061],

The location of the S ource N ode I dentifier shall be configurable by means of CanNmPduNidPosition to Byte 0, Byte 1, or off.

The location of the C ontrol Bit V ector shall be configurable by means of C anNmPduCbvPosition to Byte 0, By te 1, or off.

[SWS_CanNm_00130] Upstream requirements: RS_Nm_02516 ⌈The service call CanNm_RequestBusSynchronization shall trigger transmission of a single Network Management PDU if CanNmPassiveModeEnabled (configuration parameter) is not defined.⌋ Rationale: This service is typically used for supporting the NM gateway extensions.

[SWS_CanNm_00132] Upstream requirements: RS_Nm_02506, SRS_BSW_00483 ⌈The service call CanNm_GetNodeIdentifier shall provide the node identifier out of the most recently received Network Management PDU if CanNmNodeIdEnabled is set to TRUE.⌋

[SWS_CanNm_00133] Upstream requirements: RS_Nm_02508, SRS_BSW_00483 ⌈The service call CanNm_GetLocalNodeIdentifier shall provide the node identi- fier configured for the local host node if CanNmNodeIdEnabled is set to TRUE.⌋

The service call CanNm_GetPduData shall provide whole PDU data (Node ID, Control Bit Vector and User Data) of the most recently received Network Management PDU if CanNmNodeDetectionEnabled or Can nNmUserDataEnabled or CanNmNodeIdEnabled is set to TRUE.

If CanNm_PassiveStartUp is called in the Network Mode, the CanNm module shall not execute this service and shall return E_NOT_OK .

[SWS_CanNm_00153] Upstream requirements: RS_Nm_00052, RS_Nm_02509, SRS_BSW_00483 ⌈Service call CanNm_CheckRemoteSleepIndication shall provide the information about current status of Remote Sleep Indication (i.e. already detected or not).⌋

[SWS_CanNm_00172] ⌈The service CanNm_DisableCommunication shall return E_NOT_OK, if the current mode is not Network Mode.⌋

[SWS_CanNm_00176] Upstream requirements: RS_Nm_02512 ⌈The service CanNm_EnableCommunication shall enable the Network Management PDU transmission ability if the Network Management PDU transmission ability is dis- abled.⌋

[SWS_CanNm_00177] ⌈The service CanNm_EnableCommunication shall return E_NOT_OK if the Network Management PDU transmission ability is enabled.⌋

[SWS_CanNm_00187] Upstream requirements: RS_Nm_02516 ⌈If CanNm_RequestBusSynchronization is called in Bus-Sleep Mode and Prepare Bus-Sleep Mode the CanNm module shall not execute the service and shall return E_- NOT_OK.⌋

The CanNm module shall not return development errors by API functions; in case of a development error, the execution of the respective API function shall be aborted and E_NOT_OK shall be returned, if applicable.

The CanNm module sha ll not return production errors by API functions; in case of a production error, the execution of the respective API function shall be aborted and E_NOT_OK shall be returned, if applicable.

When a CanNm service with an invalid networ k handle is called, the called function shall not be executed and it shall return E_NOT_OK to the calling function if applicable. If development error detection is enabled ( CanNmDevErrorDetect is set to TRUE ) the corresponding error CANNM_E_ INVALID_CHANNEL shall be reported to DET.

When the NM - Timeout Timer expires in the Repeat Message State the CanNm module shall report CANNM_E_NETWORK_TIMEOUT to the DET.

When the NM - Timeout Timer expires in the Normal Operation State the CanNm module shall report CANNM_E_NETWORK_TIMEOUT to the DET.

When a CanNm service with an inva lid PDU ID is called, the called function shall not be executed and it shall return E_NOT_OK to the calling function if applicable. If development error detection is enabled ( CanNmDevErrorDetect is set to TRUE ) the corresponding error CANNM_E_ INVALID_PDUID shall be reported to DET.

Module Header File Imported Type Com Stack_ Types Com Stack_ Types.h Network Handle Type Com Stack_ Types.h Pdu Id Type Com Stack_ Types.h Pdu Info Type Com Stack_ Types.h Pdu Length Type Nm Nm Stack_ types.h Nm _ Mode Type Nm Stack_ types.h Nm _ State Type Std Std_ Types.h Std _ Return Type Std_ Types.h Std _ Version Info Type

[SWS_CanNm_00254] ⌈Caveats of CanNm_PassiveStartUp: The CanNm module is initialized correctly.⌋

[SWS_CanNm_00255] ⌈The function CanNm_NetworkRequest shall change the Network state to ‘requested’.⌋

[SWS_CanNm_00256] ⌈Caveats of CanNm_NetworkRequest: The CanNm module is initialized correctly.⌋

[SWS_CanNm_00257] ⌈Configuration of CanNm_NetworkRequest: Optional (Only available if CanNmPassiveModeEnabled is not defined).⌋

[SWS_CanNm_00259] ⌈Caveats of CanNm_NetworkRelease: The CanNm module is initialized correctly.⌋

[SWS_CanNm_00260] ⌈Configuration of CanNm_NetworkRelease: Optional (Only available if CanNmPassiveModeEnabled is not defined)⌋

[SWS_CanNm_00261] ⌈Caveats of CanNm_DisableCommunication: The CanNm module is initialized correctly.⌋

[SWS_CanNm_00262] ⌈Configuration of CanNm_DisableCommunication: Op- tional (Only available if CanNmComControlEnabled is set to TRUE)⌋

[SWS_CanNm_00263] ⌈Caveats of CanNm_EnableCommunication: The CanNm module is initialized correctly.⌋

[SWS_CanNm_00264] ⌈Configuration of CanNm_EnableCommunication: Optional (Only available if CanNmComControlEnabled is set to TRUE).⌋

[SWS_CanNm_00265] ⌈Caveats of CanNm_SetUserData: The CanNm module is initialized correctly.⌋

[SWS_CanNm_00266] ⌈Configuration of CanNm_SetUserData: Optional (Only avail- able if CanNmUserDataEnabled is set to TRUE and CanNmPassiveModeEnabled is not defined)⌋

[SWS_CanNm_00267] ⌈Caveats of CanNm_GetUserData: The CanNm module is initialized correctly.⌋

[SWS_CanNm_00268] ⌈Configuration of CanNm_GetUserData: Optional (Only avail- able if CanNmUserDataEnabled is set to TRUE).⌋

[SWS_CanNm_00269] ⌈Caveats of CanNm_GetNodeIdentifier: The CanNm module is initialized correctly.⌋

[SWS_CanNm_00271] ⌈Caveats of CanNm_GetLocalNodeIdentifier: The CanNm module is initialized correctly.⌋

[SWS_CanNm_00273] ⌈Caveats of CanNm_RepeatMessageRequest: The CanNm module is initialized correctly.⌋

[SWS_CanNm_00275] ⌈Caveats of CanNm_GetPduData: The CanNm module is ini- tialized correctly.⌋

[SWS_CanNm_00277] ⌈Caveats of CanNm_GetState: The CanNm module is initial- ized correctly.⌋

[SWS_CanNm_00279] ⌈Caveats of CanNm_RequestBusSynchronization: The CanNm module is initialized correctly.⌋

[SWS_CanNm_00280] Upstream requirements: RS_Nm_02516 ⌈Configuration of CanNm_RequestBusSynchronization: Optional (Only available if CanNmBusSynchronizationEnabled is set to TRUE) and CanNmPassiveMod- eEnabled is not defined.⌋

[SWS_CanNm_00281] ⌈Caveats of CanNm_CheckRemoteSleepIndication: The CanNm module is initialized correctly.⌋

[SWS_CanNm_00282] ⌈Configuration of CanNm_CheckRemoteSleepIndication: Optional (Only available if CanNmRemoteSleepIndEnabled is set to TRUE).⌋

[SWS_CanNm_00283] ⌈Caveats of CanNm_TxConfirmation: • The call context is either on interrupt level (interrupt mode) or on task level (polling mode). This callback service is re-entrant for multiple CAN controller usage. • The CanNm module is initialized correctly. ⌋

[SWS_CanNm_00285] ⌈Caveats of CanNm_RxIndication: • Until this service returns the CAN Interface will not access canSduPtr. The can SduPtr is only valid and can be used by upper layers until the indication returns. CAN Interface guarantees that the number of configured bytes for this CanNm- RxPduId is valid. The call context is either on interrupt level (interrupt mode) or on task level (polling mode). This callback service is re-entrant for multiple CAN controller usage. • The CanNm module is initialized correctly. ⌋

[SWS_CanNm_00295] ⌈The service CanNm_EnableCommunication shall return E_NOT_OK, if the current mode is not Network Mode.⌋

Type of error Related error code Error value API service used without module initialization CANNM_ E_ UNINIT 0x01 API service called with wrong channel handle CANNM_ E_ INVALID_ CHANNEL 0x02 API service called with wrong PDU - ID CANNM_ E_ INVALID_ PDUID 0x03 Can Nm initialization has failed, e.g. selected configuration set doesn't exist. CANNM_ E_ INIT_ FAILED 0x05 Null pointer has been passed as an argument CANNM_ E_ PARAM_ POINTER 0x12 De Init API service called when not all CAN networks are in Bus Sleep mode CANNM_ E_ NOT_ IN_ BUS_ SLEEP 0x13

Type of error Related error code Error value Reception of NM PDUs in Bus - Sleep Mode. CANNM_ E_ NET_ START _ IND 0x04 NM - Timeout Timer has abnormally expired outside of the Ready Sleep State; it may happen: (1) because of Bus - Off state,(2)if some ECU requests bus communication or node detection shortly before the NM - Timeout Timer expires so that a Network Management PDU c an not be transmitted in time; this race condition applies to event - triggered systems CANNM_ E_ NETWORK_ TIMEOUT 0x11 A NM message with PN Shutdown Request Bit was received on a CANNM_ E_ 0x20 channel that is actively coordinated by the Com M PNC Gateway. INVA LID_ PN_ SYNC_ SHUTDOWN_ REQUEST

Det _ Report - Runtime Error Det.h Service to report runtime errors. If a callout has been configured then this callout shall be called. Nm _ Bus Sleep - Mode Nm.h Notification that the network management has entered Bus - Sleep Mode. Nm _ Network - Mode Nm.h Notification that the network manag ement has entered Network Mode. Nm _ Network - Start Indication Nm.h 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. Nm _ Prepare - Bus Sleep Mode Nm .h Notification that the network management has entered Prepare Bus - Sleep Mode.

Can If _ Transmit Can If.h Requests transmission of a PDU. Can S M _ Tx - Timeout Exception Can SM_ Can If.h This function shall notify the Can SM module, that the Can Nm has detected for the affected partial CAN network a tx timeout exception, which shall be recovered within the respective network state machine of the Can SM module. Det _ Report Error Det.h Service to report development errors. Nm _ Car Wake Up - Indication Nm.h This function is called by a <Bus>Nm to indicate reception of a CWU request. Nm _ Coord Ready - To Sleep - Cancellation Nm.h Cancels an indication, when the NM Coordinator Sleep Ready bit in the Control Bit Vector is set back to 0. Nm _ Coord Ready - To Sleep Indication Nm.h Sets an indication, when the NM Coordinator Sleep Ready bit in the Control Bit Vector is set Nm _ Forward - Synchronized Pnc - Shutdown Nm.h 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. Nm _ Pdu Rx - Indication Nm.h Not ification that a NM message has been received. Nm _ Pnc Bit Vector - Nm.h Indication that a bus specific network management has received a Rx Indication NM message on a particular NM - channel that contain a PNC bit vector. This is used to aggregate the exter nal 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 Relevant Pnc Request Detected Ptr r efers to a boolean with value set to TRUE. Otherwise refer to booelan with value set to FALSE. Relevant Pnc Request Detected Ptr is evaluated by the callee <Bus>Nm module to qualify the further processing of the received NM - PDU. Nm _ Pnc Bit Vector - Tx Con firmation Nm.h Function called by <Bus>Nms to confirm the state of the transmission for the given PNC bit vector on the given NM - Channel. Nm _ Pnc Bit Vector - Tx Indication Nm.h Function called by <Bus> Nms to request the aggregated internal PNC requests for transmission within the Nm message. Nm _ Remote - Sleep Cancellation Nm.h Notification that the network management has detected that not all other nodes on the network are longer ready to enter Bus - Sle ep Mode. Nm _ Remote - Sleep Indication Nm.h Notification that the network management has detected that all other nodes on the network are ready to enter Bus - Sleep Mode. Nm _ Repeat - Message - Indication Nm.h Service to indicate that an NM message with set Re peat Message Re - quest Bit has been received. This is needed for node detection and the Dynamic PNC - to - channel - mapping feature. Nm _ State - Change - Notification Nm.h Notification that the state of the lower layer <Bus>Nm has changed. Nm _ Tx Timeout - Except ion Nm.h Service to indicate that an attempt to send an NM message failed. Pdu R _ Can Nm Rx - Indication Pdu R_ Can Nm.h Indication of a received PDU from a lower layer communication interface module. Pdu R _ Can Nm - Trigger Transmit Pdu R_ Can Nm.h Within this API, the upper layer module (called module) shall check whether the available data fits into the buffer size reported by Pdu Info Ptr - >Sdu Length. If it fits, it shall copy its data into the buffer provided by Pdu Info Ptr - >Sdu Data Ptr and upd ate the length of the actual copied data in Pdu Info Ptr - >Sdu Length. If not, it returns E_ NOT_ OK without changing Pdu Info Ptr. Pdu R _ Can Nm Tx - Confirmation Pdu R_ Can Nm.h The lower layer communication interface module confirms the transmission of a PDU, or the failure to transmit a PDU.

[SWS_CanNm_00330] ⌈If CanNmComUserDataSupport or CanNmGlobalPnSup- port is enabled the CanNm implementation shall provide an API CanNm_Transmit.⌋

[SWS_CanNm_00333] Upstream requirements: RS_Nm_02527, SRS_BSW_00483 ⌈If CanNmComUserDataSupport is enabled and if CanNm is in RepeatMessage state or NormalOperation state and if CanNm_Transmit() is called CanNm shall request an additional transmission of the NM PDU with the current data.⌋ Note: The call of CanNm_Transmit request to transmit a NM PDU between the pe- riodic transmissions with the current data (e.g., system bytes, user data and PNC bit vector).

[SWS_CanNm_00339] ⌈Caveats of CanNm_SetSleepReadyBit: The CanNm mod- ule is initialized correctly.⌋

[SWS_CanNm_00340] ⌈Configuration of CanNm_SetSleepReadyBit: Optional (Only available if CanNmCoordinatorSyncSupport is set to TRUE).⌋

[SWS_CanNm_00345] ⌈Caveats of CanNm_ConfirmPnAvailability: The CanNm module is initialized correctly.⌋

[SWS_CanNm_00346] ⌈Configuration of CanNm_ConfirmPnAvailability: Op- tional (Only available if CanNmGlobalPnSupport is set to TRUE).⌋

If CanNmCoordinatorSyncSupport is set to TRUE and CanNm called Nm_CoordReadyToSleepIndication and is still in Network Mode it shall notify the Nm by calling Nm_CoordReadyToSleep Cancellation on the f irst reception of a NM PDU with the NmCoordinatorSleepReady bit (see CBV) set to 0.

{OBSOLETE, replaced by SWS_CanNm_05 10 } If CanNm ComUserDataSupport is enabled CanNm shall collect the NM User Data from the referenced NM I - PDU by calling PduR_CanNmTriggerTransmit and combine the user data with the further NM bytes within the call of CanNm_TriggerTransmit.

The function CanNm_TriggerTransmit shall copy the NM PDU data of the according NM PDU requested by TxPduId

If development error detection for the CanNm module is enabled: Th e function CanNm_DeInit shall raise the error CANNM_E_NOT_IN_BUS_SLEEP if not all CAN networks are in Bus Sleep mode.

If fun ction CanNm_PnLearningRequest is called on a channel where CanNmDynamicPncToChannelMappingEnabled is set to TRUE and CanNm is in the Network Mode the CanNm module shall set the Repeat Message Bit and the Partial Network Learning Bit in the CBV to 1 on thi s channel and change to or restart the Repeat Message State.

If the bits Partial Network Learning and Repeat Message Request both are received with value 1 on a channel where CanNmDynamicPncToChannelMappingEnabled is set to TRUE and CanNm is in the Network Mode, then CanNm shall set the Parti al Network Learning Bit in the CBV to 1 on this channel and change to or restart the Repeat Message State.

If CanNmDynamicPncToChannelMapping Enabled is set to T RUE CanNm shall clear the Partial Network Learning Bit when leaving the Repeat Message State.

If the function CanNm_PnLearningRequest is called in Prepare Bus - Sleep Mode or Bus Sleep Mode no functionality shall be executed and E_NOT_OK shall be returned.

The function CanNm_PnLearningRequest shall only be available if CanNmDynamicPncToChannelMappingSupport is set to TRUE .

If the CanNm performs a state change from Bus Sleep Mode or Prepare Bus Sleep Mode to Network Mode due to a call to Can Nm_NetworkRequest ( i.e. due to an active wakeup) and CanNmActiveWakeupBitEnabled is TRUE , the CanNm shall set the ActiveWakeupBit in the CBV.

If the CanNm module leaves the Network Mode and CanNmActiveWakeupBitEnabled is TRUE , the CanNm module shall cl ear th e ActiveWakeupBit in the CBV.

{OBSOLETE} If CanNmPnE i raCalcEnabled is TRUE and CanNmPnEraCalcEnabled is TRUE , the PN status information has to be stored separately for both, the EIRA and ERA information (compare SWS_CanNm_00 4 35 and SWS_CanNm_00424 ).

If CanNmGlobalPnSupport is set to TR UE and NM Message Tx Timeout Timer has expired then CanNm shall call the function CanSM_TxTimeoutException .

If CanNmPnHandleMultipleNetworkRequests is set to TRUE CanNm_NetworkRequest shall trigger a state transition from Network Mode to Repeat Message state . If PDU transmission ability is enabled the NM PDUs shall be transmitted using CanNmImmediateNmCycleTime as cycle time. The transmission of the first NM PDU shall be triggered as soon as possible . After the transmission the Message Cycle Timer shall be reloaded with CanNmImmediateNmCycleTime . The CanNmMsgCycleOffset shall not be applied in this case.

{ DRAFT } If transmission of NM PDUs has been started, the CanNm Message Cycle Timer expires and when CanNmSynchronizedPncShutdownEnabled is set to TRUE and requests for synchronized PNC shutdown are pending, the transmission of the NM PDU shall be postponed to the next CanNm_Mainfunction call .

If CanNmSynchronizedPncShutdownEnabled is set to TRUE , when a NM PDU is received where PNI bit and PNSR bit ar e 1 and the corresponding ComMChannel configured via CanNmComMNetworkHandleRef is actively coordinated ( ComMPncGatewayType set to COMM_GATEWAY_TYPE_ACTIVE ), CanNm module shall report the runtime error CANNM_E_INVALID_PN_SYNC_SHUTDOWN_REQUEST to DET , ignore the PNSR bit and handle the PDU as usual NM PDU.

{ DRAFT } If CanNmSynchronizedPncShutdownEnabled is set to TRUE and the service CanNm_RequestSynchronizedPncShutdown is called the CanNm module shall store the given PNC ( pncId ) per given NM - Channel ( nmChannelH andle ) as a pending request for a synchronized PNC shutdown.

{ OBSOLETE, replaced by SWS_CanNm_00506 } If CanNmSynchronizedPncShutdownEnabled is set to TRUE , requests for synchronized PNC shutdown are pending and no transmission confirmation (indicated via CanNm_TxConfirmation ) of a previous call is pending, then the CanNm module shall request in the next main function call a transmission of a NM message by calling CanIf_Transmit . In case the NM - PDU is not configured for triggered transmission in CanIf ( CanIfTxPduTriggerTransmit set to FALSE ), CanNm shall set for this message additionally the following data beneath the normal data:  Set the PNSR bit in the CBV to 1  Overwrite the PN information in the user data (after NM User Data has been fetched, if CanN mComUserDataSupport is enabled ) by setting bits that corresponds to PNC IDs stored as pending request for a synchronized PNC shutdown to 1 and all other bits to 0.

{ DRAFT } If CanNmSynchronizedPncShutdownEnabled is set to TRUE , the CanNm module has requested a transmission due to synchronized PNC shutdown (see [SWS_CanNm_00463] ) and CanNm_TxConfirmation is called with result E_OK , the CanNm shall consider those PNC IDs stored as pending request for a synchronized PNC shutdown of the corresponding NM - channel as completed and remove them from storage. Additionally, if CanNmPnShutdownMessageRetransmissionDur ation is configured, then CanNm shall cancel the retransmission timer for PN shutdown messages of the affected NM - channel.

{ DRAFT } If CanNmSyn chronizedPncShutdownEnabled is set to TRUE , CanNmPnShutdownMessageRetransmissionDuration is configured, the CanNm module has requested a transmission due to synchronized PNC sh utdown ( see [SWS_CanNm_00463] ), CanNm_TxConfirmation is called with result E_NOT_OK or the transmission request for this PN shutdown message was not accepted ( CanIf_Transmit returned E_NOT_OK) , the n the CanNm shall keep those PNC IDs stored as pending request for a synchronized PNC shutdown and perform a re transmission in the next main function .

DRAFT If CanNmSynchronizedPncShutdownEnabled is TRUE and the PNSR bit is set to 1 of the received NM PDU, the CanNm module shall set the bits in the ERA PDU to 0 of the corresponding bits which are set to 1 in the r eceived PN info range, stop the according monitoring for these externally requested PNs (see [ SWS_CanNm_ 00439 ] ) and inform the upper layers in the given order:  call PduR_CanNmRxIndication() for the configured ERA PDU  call Nm_For wardSynchronizedPncShutdown() with the configured NetworkHandle ( CanNmComMNetworkHandleRef )

{ DRAFT } If CanNm SynchronizedPncShutdownEnabled is set to TRUE the CanNm implementation shall provide the API CanNm _ RequestSynchronizedPncShutdown .

{ DRAFT } If CanNmPnShutdownMessageRetransmissionDuration is configured and transmission of a P N shutdown message is requested (refer to [SWS_CanNm_00506] ) for the first time, then the corresponding retransmission timer for PN shutdown messages shall be started with CanNmPnShutdownMessageRetransmissionDuration on all affe cted NM - channels.

{ OBSOLETE, replaced by SWS_CanNm_00509 } If CanNmSynchronizedPncShutdownEnabled is set to TRUE and requests for synchronized PNC shutdown are pending, then the CanNm module shall set for this message additionally the following data beneath the normal data within the call of CanNm_TriggerTransmit: - Set the PNSR bit in the CBV to 1 - Overwrit e the PN information in the user data (after NM User Data has been fetched, if CanNmComUserDataSupport is enabled ) by setting bits that correspond to PNC IDs stored as pending request for a synchronized PNC shutdown to 1 and all other bits to 0."

{ DRAFT } If CanNmSynchronizedPncShutdownEnabled is set to TRUE and the CanNm module has stored PNC IDs as pending request for a synchronized PNC shutdown, then the CanNm shall remove those PNC IDs from storage which are either externally or internally requested a gain:  CanNm shall check on reception of an NM - message, if externally requested PNCs are received  CanNm shall check up front to each transmission of an PN shutdown message if internal PNC requests are available by deriving the internal PNC requests from the corresponding ComPdu (see ECUC_CanNm_00046 : )

{ DRAFT } If CanNmSynchronizedPncShutdownEnabled is set to TRUE , CanNmPnShutdownMessageRetransmissionDuration is not configured, the CanNm module has requested a transmission due to synchronized PNC shutdown (see [SWS_CanNm_00463] ), CanNm_TxConfirmation is called with result E_NOT_OK or the transmissions request for this PN shutdown message was not accepted ( CanIf_Transmit returned E_NOT_OK), then the CanNm shall remove the PNC IDs stored as pend ing request for a synchronized PNC shutdown of the corresponding NM - channel and report the runtime error CANNM_E_TRANSMISSION_OF_PN_SHUTDOWN_MESSAGE_FAILED to DET.

{ DRAFT } If CanNmSynchronizedPncShutdownEnabled is set to TRUE and a retransmission timer for a PN shutdown message (see ECUC_CanNm_00098 : ) expires, then CanNm shall remove the pending reque st for a synchronized PNC shutdown of the corresponding NM - channel from the storage and report the runtime error CANNM_E_TRANSMISSION_OF_PN_SHUTDOWN_MESSAGE_FAILED to DET .

During initialization and if CanNmPnEnabled is TRUE , the CanNm module shall set each byte of the PNC bit vector to 0x00 .

{DRAFT} The re maining bytes not assigned to Nm System Bytes or PNC bit v ector shall be available for User Data.

If CanNmPnEnabled is set to TRUE , the PNI bit in the received NM - PDU is set to 1 and one of the following pre - conditions is valid:  CanNmSynchronizedPncShutdownEnabled is set to FALSE  CanNmSynchronizedPncShutdownEnabled is set to TRUE and the PNSR bit is se t to 0 then the CanNm module shall extract the PNC bit v ector from the received NM - PDU according to the partial network configuration (NmPncBitVectorOffset and NmPncBitVectorLength of the corresponding NM - channel) and forward the PNC bit v ector by calling Nm_PncBitVectorRxIndication .

If CanNmPnEnabled is set to TRUE and Nm_PncBitVectorRxIndication was called, a received NM PDU shall only be considered for further processing under the following conditions:  CanNmAllNmMessagesKeepAwake is set to TRUE OR  CanNm_ConfirmPnAvailability has not been called yet OR  the output value of RelevantPncRequestDetectedPt r is set to TRUE

If CanNmSynchronizedPncShutdownEnabled is TRUE , the PNI bit in the received NM - P DU is set to 1 and the PNSR bit is set to 1 , CanNm module shall extract the PNC bit v ector from the received NM - PDU according to the partial network configuration ( NmPncBitVectorOffset and NmPncBitVectorLength of the corresponding NM - channel) and forward t he PNC bit vector by calling Nm_ForwardSynchronizedPncShutdown .

{DRAFT} If Can NmPnEnabled is TRUE , the NM - PDU is not configured for triggered transmission in CanIf ( CanIfTxPduTriggerTransmit set to FA LSE ), no requests for synchronized PNC shutdown are pending and a NM - PDU has to be transmitted, t he CanNm module shall perform the following actions in the given order: - Call Nm_PncBitVectorTxIndication(<NM - channel>, <buffer to store the unfiltered PNC bit vector of aggregated internal PNC requests>) to indicate the transmission request and to retrieve internal PNC requests . - Copy the received PNC bit vector for internal PNC requests to the NM - PDU by considering NmPncBitVectorOffset and NmPncBitVectorLength o f the corresponding NM - channel - If user data is enabled, fetch the available data (either from Com if CanNmComUserDataSupport is enabled or from internal storage) and copy the data in the user data range of the NM - PDU. - Trigger transmission of the NM - PDU by calling CanIf_Transmit

{DRAFT} If CanNmSynchronizedPn cShutdownEnabled is set to TRUE , requests for synchronized PNC shutdown are pending and no transmission confirmation (indicated via CanNm_TxConfirmation ) of a previous call is pending, then the CanNm module shall request in the next main function call a tr ansmission of a NM - PDU as PN shutdown message by calling CanIf_Transmit . In case the NM - PDU is not configured for triggered transmission in CanIf ( CanIfTxPduTriggerTransmit set to FALSE ), CanNm shall set for this message additionally the following data ben eath the normal data:  Set the PNSR bit in the CBV to 1  If user data is enabled, fetch the available data (either from Com if CanNmComUserDataSupport is enabled or from internal storage) and copy the data in the user data range of the NM - PDU  Write the PNC b it vector with respect to NmPncBitVectorOffset and NmPncBitVectorLength of the corresponding NM - channel by setting bits that corresponds to PNC IDs stored as pending request for a synchronized PNC shutdown to 1 and all other bits to 0

When a Null pointer has been passed to a CanNm service, the called function shall not be executed and it shall return E_NOT_OK to the calling function if applicable. If development error detection is enabled ( CanNmDevErrorDetect is set to TRUE ) the corresponding error CANNM_E_PARAM_POINTER shall be reported to DET.

{DRAFT} If CanNmSynchronizedPncShutdownEnabled is set to TRUE and requests for synchronized PNC shutdown are pending, then the CanNm module shall set for this message additionally the following data beneath the normal data within the call of CanNm_TriggerTransmit : - Set the PNSR bit in the CBV to 1 - If user data is enabled, fetch the available data (either from Com if CanNmComUserDataSupport is enabled or from internal storage) and copy the data in the user data range of the NM - PDU - W rite the PNC bit vector with respect to NmPncBitVectorOffset and NmPncBitVectorLength of the corresponding NM - channel by setting bits that corresponds to PNC IDs stored as pending request for a synchronized PNC shutdown to 1 and all other bits to 0

{DRAFT} If CanNm_TriggerTransmit is called and CanNmComUserDataSupport is enabled, CanNm shall collect the NM Us er Data from the referenced NM I - PDU by calling PduR_CanNmTriggerTransmit and copy the data to the user data range of the NM - PDU .

I f CanNmSynchronizedPncShutdownEnabled is set to TRUE , the CanNm module shall consider transmission of PN shutdown message as inactive after initialization .

If transmission of Network Management PDUs has been started, the CanNm Message Cycle Timer expires and when CanNmSynchronizedPncShutdownEnabled is set to TRUE and the transmission of PN shutdown messages is active , the transmission of this NM PDU shall be postponed to the next CanNm_Mainfunction call .

If the CanNm module has requested a transmission of a NM - PDU, CanNmS ynchronizedPncShutdownEnabled is set to TRUE , the transmission of PN shutdown messages is active , CanNm_TxConfirmation is called with result E_NOT_OK or the transmission request for this NM - PDU was not accepted ( CanIf_Transmit returned E_NOT_OK ) , the n the CanNm module shall perform a retransmission of a NM - PDU for this NM - Channel in the next main function call.

If CanNmGlobalPnSupport is set to TRUE , the CanNm module shall store the latest PNC bit vector per NM - channel everytime the PNC bit vector has been fetched from the Nm modul via call of Nm_PncBitVectorTxIndication .

If CanNmGlobalPnSupport is set to TRUE , a NM - PDU has been transmitted on a NM - Channel and CanNm_TxConfirmation is called with result E_OK for this NM - PDU, then the CanNm shall forward the confirmation to Nm by calling Nm_PncBitVectorTxConfirmation with the stored PNC bit vector (see [SWS_CanNm_00515] ) for this NM - channel with result set to E_OK .

If CanNmGlobalPnSupport is set to TRUE , a NM - PDU has been transmitted on a NM - Channel and CanNm_TxConfirmation is called with result E_NOT_OK or the transmission request for this NM - PDU was not accepted ( CanIf_Transmit returned E_NOT_OK ) for this NM - PDU , then the CanNm module shall forward the confirmation to Nm by calling Nm_ PncBitVectorTxConfirmation with the stored PNC bit vector (see [SWS_CanNm_00515] ) for this NM - Channel with result set to E_NOT_OK

If Can NmPnEnabled is TRUE and a NM - PDU has to be transmitted (either as cylic NM - PDU transmitted with CanNmMsgCycleTime (see [SWS_CanNm_00512 ) or as PN shutdown message), the CanNm module shall additionally fetch the PNC bit vector by calling Nm_PncBitVectorTxIndication and copy the PNC bit vector with respect to NmPncBitVectorOffset and NmPncBitVectorLength of the corresponding NM - channel to the NM - PDU before requesting the transmission of the NM - PDU .

If CanNmSynchronizedPncShutdown Enabled is set to TRUE , the transmission of PN shutdown messages is active for this NM - Channel and no transmission confirmation of a previous call to transmit a NM - PDU as PN shutdown message on this NM - Channel is pending, then the CanNm module shall reque st in the next main function call a transmission of a NM - PDU as PN shutdown message by calling CanIf_Transmit .

If CanNmSynchronizedPncShutdownEnabled is set to TRUE the CanNm implementation shall provide the API CanNm_ActivateTxPnShutdownMsg .

If CanNmSynchronizedPncShutdownEnabled is set to TRUE and CanNm_ActivateTxPnShutdownMs g is called with a valid NM - Channel ( nmChannelHandle ), then the Can Nm module shall consider the PN shutdown message transmission as active on the given NM - channel, set PNSR bit in the CBV to 1 and return with E_OK .

If Can NmSynchronizedPncShutdownEnabled is set to TRUE the CanNm implementation shall provide the API CanNm_DeactivateTxPnShutdownMsg .

If CanNmSynchronizedPncShutdownEnabled is set to TRUE and CanNm_DeactivateTxPnShutdownMsg is c alled with a valid NM - Channel ( nmChannelHandle ), then the CanNm module shall consider the PN shutdown message transmission as inactive on the given NM - channel, set PNSR bit in the CBV to 0 and return with E_OK.