AUTOSAR CP SWS NetworkManagementInterface
AUTOSAR CP SWS NetworkManagementInterface
AUTOSAR CP R23-11
Specification of Network
Document Title Management Interface
Document Owner AUTOSAR
Document Responsibility AUTOSAR
Document Identification No 228
• Editorial changes
• Support for synchronized PNC shutdown
functionality
• Introduction of Dynamic
PNC-to-channel-mapping and PNC
Learning algorithm
AUTOSAR
• Added limitation regarding Nm
2020-11-30 R20-11 Release
Coordinator functionality when using
Management
10BASE-T1S in combination with PLCA
media access
• Editorial changes
5
4
• Minor changes
• removed dependencies of
AUTOSAR
ComMChannels to each other in respect
2016-11-30 4.3.0 Release
to NMVariants
Management
• minor corrections / clarifications /
editorial changes; For details please
refer to the ChangeDocumentation
• "‘Coordination algorithm"’ and
"‘Coordinated shutdown"’ redefined
AUTOSAR
Release • Make the CarWakeup feature available
2015-07-31 4.2.2
Management • Debugging support marked as obsolete
• Editorial changes
• Corrections on the requirement tracing
AUTOSAR
• Clarification at use of callback versus
2014-10-31 4.2.1 Release
callout
Management
• Editorial changes
• Rework of wakeup and abortion of
AUTOSAR coordinated shutdown
2014-03-31 4.1.3 Release
Management • Rework of coordination of nested
sub-busses
5
4
• Remove DEM usage
• Corrections on RemoteSleepIndication
feature
AUTOSAR
2013-10-31 4.1.2 Release • Corrections on MainFunction and
Managment coordinated shutdown
• Editorial changes
• Moved Nm_Passive_Mode_Enabled
Parameter back to global container
• NmMultipleChannelsEnabled removed
• move NmPassiveMode
4
• Release check added
Disclaimer
This work (specification and/or software implementation) and the material contained in
it, as released by AUTOSAR, is for the purpose of information only. AUTOSAR and the
companies that have contributed to it shall not be liable for any use of the work.
The material contained in this work is protected by copyright and other types of intel-
lectual property rights. The commercial exploitation of the material contained in this
work requires a license to such intellectual property rights.
This work may be utilized or reproduced without any modification, in any form or by
any means, for informational purposes only. For any other purpose, no part of the work
may be utilized or reproduced, in any form or by any means, without permission in
writing from the publisher.
The work has been developed for automotive applications only. It has neither been
developed, nor tested for non-automotive applications.
The word AUTOSAR and the AUTOSAR logo are registered trademarks.
Contents
1 Introduction and functional overview 10
3 Related documentation 13
3.1 Input documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
3.2 Related specification . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
4 Constraints and assumptions 14
4.1 Limitations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
4.2 Specific limitations of the current release . . . . . . . . . . . . . . . . . 14
4.3 Applicability to automotive domains . . . . . . . . . . . . . . . . . . . . 15
5 Dependencies to other modules 16
5.1 Interfaces to modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
5.1.1 ComM, CanNm, J1939Nm, FrNm, UdpNm, generic bus spe-
cific NM layers and CDD . . . . . . . . . . . . . . . . . . . . 17
5.1.2 Error handling modules . . . . . . . . . . . . . . . . . . . . . 17
5.1.3 BSW Scheduler . . . . . . . . . . . . . . . . . . . . . . . . . 17
5.2 File structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
5.2.1 Code file structure . . . . . . . . . . . . . . . . . . . . . . . . 18
5.2.2 Header file structure . . . . . . . . . . . . . . . . . . . . . . . 18
6 Requirements traceability 19
7 Functional specification 24
7.1 Base functionality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
7.2 NM Coordinator functionality . . . . . . . . . . . . . . . . . . . . . . . . 25
7.2.1 Applicability of the NM Coordinator functionality . . . . . . . 25
7.2.2 Keeping coordinated busses alive . . . . . . . . . . . . . . . 26
7.2.3 Shutdown of coordinated busses . . . . . . . . . . . . . . . . 27
7.2.4 Coordination of nested sub-busses . . . . . . . . . . . . . . 29
7.2.5 Calculation of shutdown timers . . . . . . . . . . . . . . . . . 33
7.2.6 Synchronization Use Case 1 - Synchronous command . . . 33
7.2.7 Synchronization Use Case 2 - Synchronous initiation . . . . 34
7.2.8 Synchronization Use Case 3 - Synchronous network sleep . 34
7.2.8.1 Examples . . . . . . . . . . . . . . . . . . . . . . . . 35
7.3 Wakeup and abortion of the coordinated shutdown . . . . . . . . . . . 37
7.3.1 External network wakeup . . . . . . . . . . . . . . . . . . . . 37
7.3.2 Coordinated wakeup . . . . . . . . . . . . . . . . . . . . . . . 37
7.3.3 Abortion of the coordinated shutdown . . . . . . . . . . . . . 37
7.4 Partial Network functionality . . . . . . . . . . . . . . . . . . . . . . . . 39
7.4.1 PNC bit vector filter algorithm . . . . . . . . . . . . . . . . . . 39
7.4.2 Aggregation of PNC requests . . . . . . . . . . . . . . . . . . 41
8.3.4.2 Nm_GetUserData . . . . . . . . . . . . . . . . . . . 68
8.3.4.3 Nm_GetPduData . . . . . . . . . . . . . . . . . . . . 69
8.3.4.4 Nm_RepeatMessageRequest . . . . . . . . . . . . . 69
8.3.4.5 Nm_GetNodeIdentifier . . . . . . . . . . . . . . . . . 70
8.3.4.6 Nm_GetLocalNodeIdentifier . . . . . . . . . . . . . . 71
8.3.4.7 Nm_CheckRemoteSleepIndication . . . . . . . . . . 72
8.3.4.8 Nm_GetState . . . . . . . . . . . . . . . . . . . . . . 73
8.3.4.9 Nm_GetVersionInfo . . . . . . . . . . . . . . . . . . . 73
8.3.4.10 Nm_PnLearningRequest . . . . . . . . . . . . . . . . 74
8.4 Call-back notifications . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
8.4.1 Standard Call-back notifications . . . . . . . . . . . . . . . . 75
8.4.1.1 Nm_NetworkStartIndication . . . . . . . . . . . . . . 75
8.4.1.2 Nm_NetworkMode . . . . . . . . . . . . . . . . . . . 76
8.4.1.3 Nm_BusSleepMode . . . . . . . . . . . . . . . . . . 76
8.4.1.4 Nm_PrepareBusSleepMode . . . . . . . . . . . . . . 77
8.4.1.5 NM_SynchronizeMode . . . . . . . . . . . . . . . . . 77
8.4.1.6 Nm_RemoteSleepIndication . . . . . . . . . . . . . . 78
8.4.1.7 Nm_RemoteSleepCancellation . . . . . . . . . . . . 78
8.4.1.8 Nm_SynchronizationPoint . . . . . . . . . . . . . . . 79
8.4.1.9 Nm_CoordReadyToSleepIndication . . . . . . . . . . 79
8.4.1.10 Nm_CoordReadyToSleepCancellation . . . . . . . . 80
8.4.1.11 Nm_ForwardSynchronizedPncShutdown . . . . . . . 81
8.4.1.12 Nm_PncBitVectorRxIndication . . . . . . . . . . . . . 81
8.4.1.13 Nm_PncBitVectorTxIndication . . . . . . . . . . . . . 82
8.4.1.14 Nm_PncBitVectorTxConfirmation . . . . . . . . . . . 82
8.4.2 Extra Call-back notifications . . . . . . . . . . . . . . . . . . 83
8.4.2.1 Nm_PduRxIndication . . . . . . . . . . . . . . . . . . 83
8.4.2.2 Nm_StateChangeNotification . . . . . . . . . . . . . 84
8.4.2.3 Nm_RepeatMessageIndication . . . . . . . . . . . . 84
8.4.2.4 Nm_TxTimeoutException . . . . . . . . . . . . . . . 85
8.4.2.5 Nm_CarWakeUpIndication . . . . . . . . . . . . . . . 86
8.5 Scheduled functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
8.5.1 Nm_MainFunction . . . . . . . . . . . . . . . . . . . . . . . . 87
8.6 Expected interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
8.6.1 Mandatory Interfaces . . . . . . . . . . . . . . . . . . . . . . 87
8.6.2 Optional Interfaces . . . . . . . . . . . . . . . . . . . . . . . . 88
8.6.3 Configurable Interfaces . . . . . . . . . . . . . . . . . . . . . 89
8.6.3.1 NmCarWakeUpCallout . . . . . . . . . . . . . . . . . 89
8.7 Version Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
9 Sequence diagrams 91
9.1 Basic functionality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
9.2 Seq of NM Coordinator functionality . . . . . . . . . . . . . . . . . . . . 91
9.3 Sequence of Partial network functionality . . . . . . . . . . . . . . . . . 93
10 Configuration specification 98
10.1 How to read this chapter . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Terms: Definition:
Network mode where all interconnected communication con-
Bus-Sleep Mode
trollers are in the sleep mode.
NM-Channel Logical channel associated with the NM-cluster
NM-Cluster Set of NM nodes coordinated with the use of the NM algorithm.
A functionality of the Nm which allows coordination of network
NM-Coordinator
sleep for multiple NM Channels.
Packet of information exchanged for purposes of the NM algo-
NM-Message
rithm.
Timeout in the NM algorithm that initiates transition into Bus-
NM-Timeout
Sleep Mode.
Supplementary application specific piece of data that is attached
NM User Data
to every NM message sent on the bus.
Node address information exchanged for purposes of the NM al-
Node Identifier
gorithm.
Node Identifier List List of Node Identifiers recognized by the NM algorithm.
Physical communication medium to which a NM node/ecu is con-
Bus
nected to.
Entity of all NM nodes/ecus which are connected to the same
network
bus.
channel Logical bus to which the NM node/ecu is connected to.
Shutdown of two or more busses in a way that their shutdown is
Coordinated shutdown
finished coinciding.
Coordination algorithm Initiation of coordinated shutdown in case all conditions are met.
Terms: Definition:
PNC bit vector Represent the Partial Network information in a NM frame
PNC bit vector length Represent the length of a Partial Network information in bytes
One bit which represent a particular Partial Network in the Partial
PNC bit
Network Info Range
Vector of filter mask bytes defined by configuration container(s)
PN filter mask NmPnFilterMaskByte per channel to filter relevant PNC requests
for the PNC timer handling
An ECU acts as top-level PNC coordinator for those PNCs which
are actively coordinated on all assigned channels. This ECU
has the PNC gateway functionality enabled. The top-level PNC
coordinator triggers for those PNCs a synchronized PNC shut-
Top-level PNC coordinator
down, if no other ECU in the network requests them and if the
synchronized PNC shutdown is enabled. Note: For different
PNCs it is possible to have different top-level PNC coordinators.
But for the same PNC only one top-level coordinator is supported.
An ECU acts as intermediate PNC coordinator for those PNCs
which are passively coordinated on at least one channel. This
ECU has the PNC gateway functionality enabled. The interme-
Intermediate PNC coordinator
diate PNC coordinator forwards a synchronized PNC shutdown
to active coordinated channels for PNCs which are passively
coordinated, if the synchronized PNC shutdown is enabled
A PNC leaf node is an ECU that act neither as top-level PNC
coordinator nor as an intermediate PNC coordinator. It act as
PNC leaf node
an ECU without a PNC gateway in the network and process PN
shutdown message as usual NM messages.
A top-level PNC coordinator transmits PN shutdown messages to
indicate a synchronized PNC shutdown across the PN topology.
A PN shutdown message is a NM message which has PNSR
bit in the control bit vector and all PNCs which are indicated
for a synchronized shutdown set to ’1’. An intermediate PNC
coordinator which receive a PN shutdown message has to
PN shutdown message forward the PNC bit vector as PN shutdown message on the
affected channels.
3 Related documentation
[1] Glossary
AUTOSAR_FO_TR_Glossary
[2] General Specification of Basic Software Modules
AUTOSAR_CP_SWS_BSWGeneral
[3] Specification of CAN Network Management
AUTOSAR_CP_SWS_CANNetworkManagement
[4] Specification of FlexRay Network Management
AUTOSAR_CP_SWS_FlexRayNetworkManagement
[5] Specification of UDP Network Management
AUTOSAR_CP_SWS_UDPNetworkManagement
[6] Specification of Network Management for SAE J1939
AUTOSAR_CP_SWS_SAEJ1939NetworkManagement
[7] General Requirements on Basic Software Modules
AUTOSAR_CP_SRS_BSWGeneral
[8] Requirements on AUTOSAR Network Management
AUTOSAR_FO_RS_NetworkManagement
[9] Guide to Mode Management
AUTOSAR_CP_EXP_ModeManagementGuide
[10] Specification of Communication Manager
AUTOSAR_CP_SWS_COMManager
[11] Guide to BSW Distribution
AUTOSAR_CP_EXP_BSWDistributionGuide
4.1 Limitations
1. The Generic Network Management Interface can only be applied to communica-
tion systems that support broadcast communication and ’bus-sleep mode’.
2. There is only one instance of the Generic Network Management Interface layer
for all NM-Clusters. This instance manages all channels where a NM is used.
3. The Generic Network Management Interface shall only include the common
modes, definitions and return values of different bus specific NM layers.
4. The Generic Network Management Interface shall only include the common
modes, definitions and return values of different bus specific NM layers.
5. If 10BASE-T1S is used in combination with PLCA media access, then Nm
Coordinator functionality are not supported.
Note: Consequently, the configuration parameter NmCoordinatorSupport-
Enabled shall be set to false.
6. NM Coordination functionality in combination with Partial Network functionality
and vice versa is not supported.
Figure 4.1 shows a typical example of the AUTOSAR NM stack.
«module»
:ComM
«module»
:Nm
5.1.1 ComM, CanNm, J1939Nm, FrNm, UdpNm, generic bus specific NM layers
and CDD
The Generic Network Management Interface module (Nm) provides services to the
Communication Manager (ComM) and uses services of the bus specific Network Man-
agement modules:
• CAN Network Management ([3, CanNm])
• FlexRay Network Management ([4, FrNm])
• Ethernet Network Management ([5, UdpNm]).
• J1939 Network Management ([6, J1939Nm]).
For Buses which do not need to provide Network Management Information on the
bus like for example a LIN-bus the Bus-Type can be configured as "local Nm". With
respect to callbacks, the Nm provides notification callbacks to the bus specific Network
Management modules and calls the notification callbacks provided by the ComM.
In addition to the official AUTOSAR NM-modules above, Nm also support generic bus
specific NM layers (<Bus>Nm). Any component which implements the required pro-
vided interfaces and uses the provided callback functions of Nm can be used as a bus
specific NM. See section 7.5 for the prerequisites for a generic bus specific NM.
Rationale: Nm is specified to support generic bus specific NM layers by adding generic
lower layer modules as Complex Drivers. As such, Nm does not explicitly use the ser-
vices by the official AUTOSAR bus-NM modules (CanNm, FrNm and UdpNm), but
rather the services of the generic <Bus>Nm. The AUTOSAR bus-NMs are then explic-
itly supported since they implement the interfaces of <Bus>Nm.
The optional CarWakeUp-Functionality needs a Complex Driver which Coordinates Ba-
sic Software Mode Management.
[SWS_Nm_00247] dThe 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:
c(SRS_BSW_00159, SRS_BSW_00345, SRS_BSW_00419)
6 Requirements traceability
The following tables references the requirements specified in [7] as well as [8] and links
to the fulfillment of these.
Requirement Description Satisfied by
[RS_Nm_00044] The Nm shall be applicable to [SWS_Nm_00051] [SWS_Nm_00172]
different types of communication [SWS_Nm_00274] [SWS_Nm_00276]
systems which are in the scope of
AUTOSAR and support a bus sleep
mode.
[RS_Nm_00045] Nm shall provide services to [SWS_Nm_00167] [SWS_Nm_00168]
coordinate shutdown of Nm-clusters
independently of each other
[RS_Nm_00046] It shall be possible to trigger the [SWS_Nm_00031] [SWS_Nm_00032]
startup of all Nodes at any Point in
Time
[RS_Nm_00047] Nm shall provide a service to request [SWS_Nm_00002] [SWS_Nm_00003]
to keep the bus awake and a service [SWS_Nm_00032] [SWS_Nm_00046]
to cancel this request. [SWS_Nm_00171]
[RS_Nm_00048] Nm shall put the communication [SWS_Nm_00046]
controller into sleep mode if there is
no bus communication
[RS_Nm_00050] The Nm shall provide the current [SWS_Nm_00043] [SWS_Nm_00114]
state of Nm [SWS_Nm_00275]
[RS_Nm_00051] Nm shall inform application when Nm [SWS_Nm_00031] [SWS_Nm_00032]
state changes occur. [SWS_Nm_00046] [SWS_Nm_00114]
[SWS_Nm_00156] [SWS_Nm_00158]
[SWS_Nm_00159] [SWS_Nm_00161]
[SWS_Nm_00162] [SWS_Nm_00163]
[SWS_Nm_00230] [SWS_Nm_00249]
[SWS_Nm_00487] [SWS_Nm_00509]
[RS_Nm_00052] The Nm interface shall signal to the [SWS_Nm_00192]
application that all other ECUs are
ready to sleep.
[RS_Nm_00054] There shall be a deterministic time [SWS_Nm_00171]
from the point where all nodes agree
to go to bus sleep to the point where
bus is switched off.
[RS_Nm_00149] The timing of Nm shall be [SWS_Nm_00175] [SWS_Nm_00281]
configurable. [SWS_Nm_00284]
[RS_Nm_00150] Specific features of the Network [SWS_Nm_00055] [SWS_Nm_00134]
Management shall be configurable [SWS_Nm_00136] [SWS_Nm_00138]
[SWS_Nm_00140] [SWS_Nm_00150]
[SWS_Nm_00164] [SWS_Nm_00165]
[SWS_Nm_00166] [SWS_Nm_00241]
[SWS_Nm_00251] [SWS_Nm_00255]
[SWS_Nm_00273] [SWS_Nm_00277]
[SWS_Nm_00278] [SWS_Nm_00279]
[SWS_Nm_00290]
[RS_Nm_00151] The Network Management algorithm [SWS_Nm_00031] [SWS_Nm_00032]
shall allow any node to integrate into
an already running Nm cluster
[RS_Nm_00153] The Network Management shall [SWS_Nm_00038] [SWS_Nm_00230]
optionally provide a possibility to
detect present nodes
5
4
Requirement Description Satisfied by
[RS_Nm_00154] The Network Management API shall [SWS_Nm_00006] [SWS_Nm_00012]
be independent from the [SWS_Nm_00276]
communication bus
[RS_Nm_02503] The Nm API shall optionally give the [SWS_Nm_00035] [SWS_Nm_00250]
possibility to send user data [SWS_Nm_00252] [SWS_Nm_00285]
[RS_Nm_02504] The Nm API shall optionally give the [SWS_Nm_00036] [SWS_Nm_00291]
possibility to get user data
[RS_Nm_02506] The Nm API shall give the possibility [SWS_Nm_00039]
to read the source node identifier of
the sender
[RS_Nm_02508] Every node shall have a node [SWS_Nm_00040]
identifier associated with it that is
unique in the Nm-cluster.
[RS_Nm_02509] The Nm interface shall signal to the [SWS_Nm_00193]
application that at least one ECU is
not ready to sleep anymore.
[RS_Nm_02511] It shall be possible to configure the [SWS_Nm_00168] [SWS_Nm_00228]
Network Management of a node so
that it does not contribute to the
cluster shutdown decision.
[RS_Nm_02512] The Nm shall give the possibility to [SWS_Nm_00033] [SWS_Nm_00034]
enable or disable the network
management related communication
configured for an active Nm node
[RS_Nm_02513] Nm shall provide functionality which [SWS_Nm_00006] [SWS_Nm_00012]
enables upper layers to control the [SWS_Nm_00031] [SWS_Nm_00032]
sleep mode. [SWS_Nm_00033] [SWS_Nm_00042]
[SWS_Nm_00154] [SWS_Nm_00155]
[RS_Nm_02514] It shall be possible to group networks [SWS_Nm_00001] [SWS_Nm_00168]
into Nm Coordination Clusters
[RS_Nm_02515] Nm shall offer a generic possibility to [SWS_Nm_00051] [SWS_Nm_00119]
run other Nms than the [SWS_Nm_00166] [SWS_Nm_00276]
AUTOSAR-Nms
[RS_Nm_02516] All AUTOSAR Nm instances shall [SWS_Nm_00169] [SWS_Nm_00171]
support the Nm Coordinator [SWS_Nm_00173] [SWS_Nm_00174]
functionality including Bus [SWS_Nm_00175] [SWS_Nm_00176]
synchronization on demand [SWS_Nm_00177] [SWS_Nm_00194]
[SWS_Nm_00284]
[RS_Nm_02517] CanNm shall support Partial [SWS_Nm_00302] [SWS_Nm_00308]
Networking on CAN [SWS_Nm_00312] [SWS_Nm_00313]
[SWS_Nm_00317] [SWS_Nm_00318]
[SWS_Nm_00319] [SWS_Nm_00320]
[SWS_Nm_00321] [SWS_Nm_00322]
[SWS_Nm_00323] [SWS_Nm_00324]
[SWS_Nm_00325] [SWS_Nm_00326]
[SWS_Nm_00327] [SWS_Nm_00328]
[SWS_Nm_00329] [SWS_Nm_00330]
[SWS_Nm_00331] [SWS_Nm_00533]
[SWS_Nm_00534] [SWS_Nm_00535]
[SWS_Nm_00536] [SWS_Nm_00537]
[SWS_Nm_CONSTR_00001]
[RS_Nm_02527] Nm shall implement a filter algorithm [SWS_Nm_00308] [SWS_Nm_00312]
dropping all Nm messages that are [SWS_Nm_CONSTR_00001]
not relevant for the ECU
5
4
Requirement Description Satisfied by
[RS_Nm_02535] The Nm coordination shall support [SWS_Nm_00254] [SWS_Nm_00256]
the coordination of nested sub-buses [SWS_Nm_00257] [SWS_Nm_00259]
[SWS_Nm_00261] [SWS_Nm_00262]
[SWS_Nm_00267] [SWS_Nm_00271]
[SWS_Nm_00272] [SWS_Nm_00280]
[RS_Nm_02536] Nm shall provide functionality to [SWS_Nm_00031] [SWS_Nm_00119]
start-up without requesting the [SWS_Nm_00245] [SWS_Nm_00250]
network.
[RS_Nm_02537] The Nm Coordinator shall be able to [SWS_Nm_00181] [SWS_Nm_00182]
abort the coordinated shutdown [SWS_Nm_00183] [SWS_Nm_00185]
[SWS_Nm_00235] [SWS_Nm_00236]
[SWS_Nm_00267]
[RS_Nm_02544] Nm shall forward the indication of a [SWS_Nm_91006] [SWS_Nm_91007]
PN shutdown message [SWS_Nm_91008] [SWS_Nm_91009]
[RS_Nm_02548] <Bus>Nm shall be able to propagate [SWS_Nm_00305]
and evaluate the need for
synchronized PNC shutdown in the
role of a top-level PNC coordinator or
intermediate PNC coordinator
(optional)
[RS_Nm_02562] Nm shall support channel-specific [SWS_Nm_00330]
storage of IRA
[RS_Nm_02563] Nm shall calculate the combined [SWS_Nm_00302] [SWS_Nm_00313]
partial network request status EIRA [SWS_Nm_00317] [SWS_Nm_00318]
[SWS_Nm_00319] [SWS_Nm_00320]
[SWS_Nm_00534] [SWS_Nm_00535]
[SWS_Nm_00536] [SWS_Nm_00537]
[RS_Nm_02564] Nm shall calculate the status of the [SWS_Nm_00322] [SWS_Nm_00323]
external partial network requests [SWS_Nm_00324] [SWS_Nm_00325]
ERA [SWS_Nm_00326] [SWS_Nm_00328]
[SWS_Nm_00329]
[RS_Nm_02565] <Bus>Nm shall communicate EIRA [SWS_Nm_00321] [SWS_Nm_00327]
and ERA requests to the upper layers
using dedicated APIs
[RS_Nm_02571] Nm shall handle requests for [SWS_Nm_00521] [SWS_Nm_00523]
synchronized PNC shutdown [SWS_Nm_00524] [SWS_Nm_00525]
[SWS_Nm_00527] [SWS_Nm_00529]
[SWS_Nm_00530] [SWS_Nm_00532]
[SWS_Nm_00533] [SWS_Nm_91005]
[RS_Nm_02572] <Bus>Nm shall transmit requests for [SWS_Nm_91005]
synchronized PNC shutdown as
NM-PDU
[RS_Nm_02574] Nm shall provide a confirmation API [SWS_Nm_91010]
to indicate the transmission state
PNC bit vector
[SRS_BSW_00003] All software modules shall provide [SWS_Nm_00044]
version and identification information
[SRS_BSW_00101] The Basic Software Module shall be [SWS_Nm_00030]
able to initialize variables and
hardware in a separate initialization
function
[SRS_BSW_00159] All modules of the AUTOSAR Basic [SWS_Nm_00247]
Software shall support a tool based
configuration
5
4
Requirement Description Satisfied by
[SRS_BSW_00171] Optional functionality of a Basic-SW [SWS_Nm_00243]
component that is not required in the
ECU shall be configurable at
pre-compile-time
[SRS_BSW_00301] All AUTOSAR Basic Software [SWS_Nm_00117] [SWS_Nm_00243]
Modules shall only import the
necessary information
[SRS_BSW_00323] All AUTOSAR Basic Software [SWS_Nm_00488] [SWS_Nm_00489]
Modules shall check passed API [SWS_Nm_00490] [SWS_Nm_00491]
parameters for validity [SWS_Nm_00492] [SWS_Nm_00493]
[SWS_Nm_00494] [SWS_Nm_00495]
[SWS_Nm_00496] [SWS_Nm_00497]
[SWS_Nm_00498] [SWS_Nm_00499]
[SWS_Nm_00500] [SWS_Nm_00505]
[SWS_Nm_00508]
[SRS_BSW_00327] Error values naming convention [SWS_Nm_00232]
[SRS_BSW_00330] It shall be allowed to use macros [SWS_Nm_00091]
instead of functions where source
code is used and runtime is critical
[SRS_BSW_00333] For each callback function it shall be [SWS_Nm_00028]
specified if it is called from interrupt
context or not
[SRS_BSW_00337] Classification of development errors [SWS_Nm_00232]
[SRS_BSW_00344] BSW Modules shall support link-time [SWS_Nm_00030]
configuration
[SRS_BSW_00345] BSW Modules shall support [SWS_Nm_00247]
pre-compile configuration
[SRS_BSW_00348] All AUTOSAR standard types and [SWS_Nm_00124]
constants shall be placed and
organized in a standard type header
file
[SRS_BSW_00353] All integer type definitions of target [SWS_Nm_00124]
and compiler specific scope shall be
placed and organized in a single type
header
[SRS_BSW_00357] For success/failure of an API call a [SWS_Nm_00124]
standard return type shall be defined
[SRS_BSW_00358] The return type of init() functions [SWS_Nm_00030]
implemented by AUTOSAR Basic
Software Modules shall be void
[SRS_BSW_00359] All AUTOSAR Basic Software [SWS_Nm_00112] [SWS_Nm_00114]
Modules callback functions shall [SWS_Nm_00154] [SWS_Nm_00156]
avoid return types other than void if [SWS_Nm_00159] [SWS_Nm_00162]
possible [SWS_Nm_00192] [SWS_Nm_00193]
[SWS_Nm_00194] [SWS_Nm_00230]
[SWS_Nm_00234] [SWS_Nm_00250]
[SWS_Nm_00254] [SWS_Nm_00272]
[SRS_BSW_00369] All AUTOSAR Basic Software [SWS_Nm_00488] [SWS_Nm_00489]
Modules shall not return specific [SWS_Nm_00490] [SWS_Nm_00491]
development error codes via the API [SWS_Nm_00492] [SWS_Nm_00493]
[SWS_Nm_00494] [SWS_Nm_00495]
[SWS_Nm_00496] [SWS_Nm_00497]
[SWS_Nm_00498] [SWS_Nm_00499]
[SWS_Nm_00500] [SWS_Nm_00505]
[SWS_Nm_00508]
5
4
Requirement Description Satisfied by
[SRS_BSW_00373] The main processing function of each [SWS_Nm_00020]
AUTOSAR Basic Software Module
shall be named according the defined
convention
[SRS_BSW_00384] The Basic Software Module [SWS_Nm_00124] [SWS_Nm_00243]
specifications shall specify at least in
the description which other modules
they require
[SRS_BSW_00385] List possible error notifications [SWS_Nm_00232]
[SRS_BSW_00386] The BSW shall specify the [SWS_Nm_00232] [SWS_Nm_00488]
configuration and conditions for [SWS_Nm_00489] [SWS_Nm_00490]
detecting an error [SWS_Nm_00491] [SWS_Nm_00492]
[SWS_Nm_00493] [SWS_Nm_00494]
[SWS_Nm_00495] [SWS_Nm_00496]
[SWS_Nm_00497] [SWS_Nm_00498]
[SWS_Nm_00499] [SWS_Nm_00500]
[SWS_Nm_00505] [SWS_Nm_00508]
[SRS_BSW_00405] BSW Modules shall support multiple [SWS_Nm_00030]
configuration sets
[SRS_BSW_00407] Each BSW module shall provide a [SWS_Nm_00044]
function to read out the version
information of a dedicated module
implementation
[SRS_BSW_00414] Init functions shall have a pointer to a [SWS_Nm_00030] [SWS_Nm_00282]
configuration structure as single [SWS_Nm_00283]
parameter
[SRS_BSW_00419] If a pre-compile time configuration [SWS_Nm_00247]
parameter is implemented as const
it should be placed into a separate
c-file
[SRS_BSW_00424] BSW module main processing [SWS_Nm_00118]
functions shall not be allowed to enter
a wait state
[SRS_BSW_00425] The BSW module description [SWS_Nm_00118]
template shall provide means to
model the defined trigger conditions
of schedulable objects
[SRS_BSW_00450] A Main function of a un-initialized [SWS_Nm_00121]
module shall return immediately
[SRS_BSW_00459] It shall be possible to concurrently [SWS_Nm_00484] [SWS_Nm_00485]
execute a service offered by a BSW [SWS_Nm_00486]
module in different partitions
[SRS_BSW_00478] Timing limits of main functions [SWS_Nm_00292]
[SRS_BSW_00482] Get version information function shall [SWS_Nm_00044]
follow a naming rule
[SRS_ModeMgm_- PNC activation requests shall be [SWS_Nm_00317] [SWS_Nm_00321]
09250] exchanged with the Network [SWS_Nm_00327] [SWS_Nm_91006]
Management via a PNC bit vector [SWS_Nm_91008] [SWS_Nm_91010]
7 Functional specification
The NM Interface functionality consists of three parts:
• The Base functionality necessary to run, together with the bus specific NM mod-
ules, AUTOSAR NM on an ECU.
• The NM Coordinator functionality used by gateway ECUs to synchronously shut
down one ore more busses.
• The Partial Network functionality is devided in 2 sub parts:
– The handling of PNC requests (filtering, aggregation and monitoring) is used
by any ECU which is member of an Partial Network.
– The PNC timer handling is used by any ECU which is member of an Partial
Network.
– The synchronized PNC shutdown functionality used by PNC gateway ECUs
in the role of a top-level PNC coordinator or intermediate PNC coordinator
to synchronously shutdown particular PNCs across the PN topology.
NM Coordinator) keeps any of the busses in the coordination cluster awake, the NM
Coordinator shall keep all busses of that coordination cluster awake.
[SWS_Nm_00228] dIf 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.c(RS_Nm_02511)
Rationale: This property shall be set for all bus specific NMs where the sleep of the
bus can be absolutely decided by the local node only and that no other nodes of that
bus can oppose that decision. An example of such a network is LIN where the local
AUTOSAR ECU will always be the LIN bus master and can always solely decide when
the network shall go to sleep.
No
No
Start
Figure 7.1: Overview of the coordination algorithm with the coordinated shutdown as
part of it
Note: There is no limitation where the actions performed by the coordination al-
gorithm shall take place.
This can be done either by the Nm main function ( Nm_MainFunction ) or module
indication / callbacks.
[SWS_Nm_00171] dWhen 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.c(RS_Nm_00047,
RS_Nm_02516, RS_Nm_00054)
Rationale: Evaluation of shutdown conditions can be also done in other API calls then
the main function. The evaluation can be segmented then to check only the specific
conditions affected by the API calls there, hence it is not necessary to re-evaluate all
conditions in every main processing period and every API call.
[SWS_Nm_00172] dIf 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 coordi-
nation cluster invoked Nm_SynchronizationPoint.c(RS_Nm_00044)
[SWS_Nm_00293] dIf on a coordinated network the coordinator detects a mode
change to NM_MODE_SYNCHRONIZE,NM_MODE_PREPARE_BUS_SLEEP or NM_MODE_-
BUS_SLEEP AND the coordinated cluster this network belongs to has not started the
shutdown process AND if there is no internal network mode request for that chan-
nel 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 con-
figuration parameter NmSynchronizingNetwork is TRUE then the coordinator shall
not wait for Nm_SynchronizationPoint on this network.c()
Rationale: If one or more of the networks in the NM coordination clusters is cyclic
(such as FlexRay), a higher level of synchronized shutdown will be achieved if the
algorithm is synchronized with one of the included cyclic networks. If configured so, the
shutdown timers for all coordinated networks will not be started until the synchronizing
network has called the Nm_SynchronizationPoint.
Rationale: Although only one network per NM coordination cluster should be config-
ured to indicate synchronization points, this will allow the NM Coordinator functionality
to filter out all synchronization indications except those that is originate from the net-
work that is configured to be the synchronizing network of each coordination cluster.
[SWS_Nm_00173] dIf 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.c(RS_Nm_02516)
Rationale: In some cases, non-synchronizing networks can take longer time to go to
sleep. If this happens, the coordinated shutdown will be started based on one
synchronization indication, but as the synchronizing network will not be released di-
rectly it will continue to invoke (several) more synchronization indications which can
safely be ignored.
[SWS_Nm_00174] dIf 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]).c(RS_Nm_02516)
[SWS_Nm_00175] dWhen 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.c(RS_Nm_00149, RS_Nm_02516)
The exemplary topology shown in Figure 7.2 has the following coordination approach.
GW 1 have configured the channel onto Network 1 and Network 2 as actively coordi-
nating channels. Where GW 2 is configured with Network 2 connection as passively
coordinated channel, but with actively coordinated channel on Network 3. GW 3 than
needs to be configured on Network 3 as passively coordinated channel but as actively
coordinated channel for his connection to the Network 4.
[SWS_Nm_00280] dThe functionality of coordinating nested sub busses shall be avail-
able if the NmCoordinatorSyncSupport parameter is set to TRUE.c(RS_Nm_-
02535)
Note: All requirements within this chapter are valid “per Nm Coordination Clus-
ter” (see [SWS_Nm_00167]).
The NmActiveCoordinator parameter indicates, if an NM Coordinator behaves
on this channel in actively manner
( Actively coordinated channel ) [NmActiveCoordinator = TRUE]
or behave in a passively manner
( Passively coordinated channel ) [NmActiveCoordinator = FALSE].
This Use Case focuses on how to synchronize the point in time where the different
networks are released.
This results in the fastest possible total shutdown of all networks, but with the downside
that the networks will not enter ”bus-sleep mode“ at the same time.
Rationale: One example of this Use Case is when several CAN networks shall be kept
alive as long as any CAN-node is requesting one of the networks; but when all nodes
are ready to go to sleep it does not matter if ”bus-sleep mode“ is entered at the same
time for the different networks.
Since the Use Case does not consider any cyclic behavior of the networks, the syn-
chronization parameter NmSynchronizingNetwork shall be set to FALSE for all net-
works and no bus specific NM shall be configured to invoke the Nm_Synchroniza-
tionPoint callback.
To achieve the fastest possible shutdown, the shutdown timer parameter NmGlobal-
CoordinatorTime needs to be set to 0.0.
This Use Case is an extension of Use Case 1, but here consideration is taken to the
fact that for some networks the request to release the network will only be acted upon
at specific points in time. This Use Case will command a simultaneous shutdown like
in Use Case 1, but will wait until a point in time suitable for the synchronizing network.
Rationale: One example of this Use Case is when one FlexRay network and several
CAN networks where the time when all networks are active shall be maximized, but the
networks shall still be put to sleep as fast as possible.
Since this Use Case shall consider the cyclic behavior of a selected network, one of
the networks shall have its synchronization parameter NmSynchronizingNetwork
set to TRUE while the other networks shall have this parameter set to FALSE. The
synchronizing network’s bus specific NM shall also be configured to invoke the Nm_-
SynchronizationPoint callback at suitable points in time where the shutdown shall
be initiated.
To achieve the fastest possible shutdown, the shutdown timer parameter NmGlobal-
CoordinatorTime needs to be set to 0.0.
This Use Case will focus on synchronizing the point in time where the different net-
works enters ”bus-sleep mode“. It will wait for indication from a synchronizing network,
and then delay the network releases of all networks based on timing values so that the
transition from ”network mode“ (or ”prepare bus-sleep mode“) into ”bus-sleep mode“ is
as synchronized as possible.
Rationale: One example of this Use Case is when one FlexRay network and several
CAN networks shall stop communicating at the same time.
Since this Use Case shall consider the cyclic behavior of a selected network, of the
networks - preferably the cyclic one - shall have its synchronization parameter NmSyn-
chronizingNetwork set to TRUE while the other networks shall have this parameter
set to FALSE. The synchronizing network’s bus specific NM shall also be configured
to invoke the Nm_SynchronizationPoint callback at suitable points in time where
the shutdown shall be initiated.
To calculate the shutdown timer TSHUTDOWN_CHANNEL of each network, specific
knowledge of each networks timing behavior must be obtained.
For all networks, TSHUTDOWN_CHANNEL must be calculated, this is the minimum
time it will take the network to enter ”bus-sleep mode“. For non-cyclic networks (such
as CAN), the time shall be measured from the point in time when the network is re-
leased until it enters ”bus-sleep mode“. For cyclic networks (such as FlexRay) the time
shall also include the full range from the synchronization indication made just before
the network is released. For Generic BusNms the time is given by the configuration
parameter NmGenericBusNmShutdownTime.
For the synchronizing network, TSYNCHRONIZATION_INDICATION must be deter-
mined. This is the time between any two consecutive calls made by that bus specific
NM to Nm_SynchronizationPoint.
The NmGlobalCoordinatorTime shall be the total time that is needed for the co-
ordination algorithm. This includes the shutdown time of nested sub-busses.
Start with setting NmGlobalCoordinatorTime to the same value as TSHUT-
DOWN_CHANNEL for the synchronizing network. If the TSHUTDOWN_CHANNEL
for any other network is greater than NmGlobalCoordinatorTime, extend NmGlob-
alCoordinatorTime with TSYNCHRONIZATION_INDICATION repeatedly until Nm-
GlobalCoordinatorTime is equal to, or larger than any TSHUTDOWN_CHANNEL.
The shutdown delay timer for each network shall be calculated as NmGlobalCoordi-
natorTime - TSHUTDOWN_CHANNEL for that network.
For the cyclic networks this parameter must then be increased slightly in order to make
sure that the network release will occur between to synchronization indications, slightly
after Nm_SynchronizationPoint (would) have been called. The amount of time to
extend the timer depends on the implementation and configuration of the bus specific
NM but should be far smaller than TSYNCHRONIZATION_INDICATION.
7.2.8.1 Examples
In the first case ( Figure 7.4), the synchronizing network holds the largest TSHUT-
DOWN_CHANNEL, which will therefore equal the NmGlobalCoordinatorTime. For
the synchronizing network, the shutdown delay timer will be NmGlobalCoordina-
torTime - TSHUTDOWN_CHANNEL, which is zero, but then a small amount of time
is added to make sure that the Nm will wait to release the network between the two
synchronization points.
For the Non-cyclic network, the shutdown delay timer will simply be NmGlobalCoor-
dinatorTime - TSHUTDOWN_CHANNEL.
In the second case ( Figure 7.5), the non-cyclic network takes very long time
to shut down and therefore holds the largest TSHUTDOWN_CHANNEL. The
NmGlobalCoordinatorTime has now been obtained by taking the synchroniz-
ing network’s (slightly shorter) TSHUTDOWN_CHANNEL adding TSYNCHRONIZA-
TION_INDICATION once to this value.
For the synchronizing network, the shutdown timer will be NmGlobalCoordinator-
Time - TSHUTDOWN_CHANNEL, with a small amount of time added to make sure
that the Nm will wait to release the network between the two synchronization points.
For the Non-cyclic network, the shutdown timer will simply be NmGlobalCoordina-
torTime - TSHUTDOWN_CHANNEL.
Depending on the configuration, ComM can start multiple networks based on the indi-
cation from one network. It is recommended to configure the ComM to automatically
start all network of a NM Coordination Cluster if one of the networks indicates
network start, but this is not always necessary. Since the wakeup of network is outside
the scope of Nm, this is independent of if the NM Coordination functionality is used or
not.
the network before all networks are released, race conditions can occur in the coor-
dination algorithm. This can happen in four ways:
1. A node on a network that has not yet been released and is still in ’network mode’
starts requesting the network again. This will be detected by the bus specific NM
which will inform Nm by calling Nm_RemoteSleepCancellation.
2. A node on a network that has already been released and has indicated ”prepare
bus-sleep mode“ but not ”bus-sleep mode“ starts requesting the network again. This
will be detected by the bus specific NM that will automatically change state to
”network mode“ and inform Nm by calling Nm_NetworkMode.
3. The ComM requests the network on any of the networks in the NM Coordination
Cluster.
4. The coordinator which actively coordinates this network sends Nm message with
cleared Ready-Sleep Bit. This will be detected by the Bus spec NM (only on
passively coordinated channels) and forwarded to the NM by calling Nm_Coor-
dReadyToSleepCancellation.
The generic approach is to abort the shutdown and start requesting the networks again.
However, networks that have already gone into ”bus-sleep mode“ shall not be automat-
ically woken up; this must be requested explicitly by ComM.
[SWS_Nm_00181] dThe 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_NetworkRequestor Nm_-
PassiveStartUp.
c(RS_Nm_02537)
Note: Nm_NetworkStartIndication is not a trigger to abort the coordinated
shutdown, as this is handled by the upper layer.
[SWS_Nm_00182] dIf the coordinated shutdown is aborted, NM Coordinator
shall call ComM_Nm_RestartIndication for all networks that already indicated ”bus
sleep“.c(RS_Nm_02537)
Rationale: Since Nm cannot take decision to wake networks on its own, this must be
decided by ComM just as in the (external) wakeup case.
[SWS_Nm_00183] dIf 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.c(RS_Nm_02537)
[SWS_Nm_00185] dIf the coordination algorithm has been aborted, all con-
ditions that guard the initiation of the coordinated shutdown shall be evaluated
again.c(RS_Nm_02537)
Rationale: When a coordinated shutdown has been aborted, in most cases there
are now networks in that NM Coordination Cluster that do not longer indicate
that network sleep is possible, and thus the NM Coordinator must keep all presently
non-sleeping networks awake. There can be cases where none of the conditions have
been changed, which will only lead to a re-initiation of the coordinated shutdown.
[SWS_Nm_00235] dIf 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.c(RS_Nm_02537)
Rationale: Any <Bus>Nm that needs to be re-requested during an aborted
coordinated shutdown have previously been released, both by ComM and by Nm.
It is the responsibility of the <Bus>Nm to inform the ComM (through Nm) that the net-
work really has been released and therefore the ComM will have knowledge of the net-
work state even though the error response on Nm_NetworkRequest never reached
the ComM directly.
[SWS_Nm_00236] dIf a coordinated shutdown has been initiated and Nm re-
ceives E_NOT_OK on a <Bus>Nm_NetworkRelease, the shutdown shall be im-
mediately 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 initi-
ating coordinated shutdown can be evaluated again. This applies also to networks that
were not actively participating in the current coordinated shutdown.c(RS_Nm_02537)
Rationale: If a network cannot be released, it shall immediately be requested again to
synchronize the states between the NM Coordinator in the Nm and the <Bus>Nm.
The coordinated shutdown will eventually be initiated again as long as the problem
with the <Bus>Nm persists. It is up to the <Bus>Nm to report any problems directly to
the DEM and/or Default Error Tracer so the NM Coordinator shall only try to release
the networks until it is successful.
The intention of the PNC bit vector filter algorithm is to include all PNC requests
that are relevant for the ECU for the PNC handling and to exclude all received PNC
requests that are not relevant for the ECU. Additionally the filter algorithm is used to
qualify relevant PNC request for transmission. PNC requests which are qualified to be
relevant (re-)start the corresponding PNC timer.
In order to distinguish between PNC requests that are relevant for the ECU and PNC
requests that are not relevant, the Nm evaluates the PNC bit vector received by the
<Bus>Nm (passive PNC requests, initiated remotely by another ECU in the network)
and it evaluates the PNC bit vector transmitted by ComM (active request, initiated
by a local application). Every bit of the PNC bit vector represents one PNC.
PNCs are statically configured. One PNC denotes the participation of an ECU to a
specific partial network cluster (PNC).
[SWS_Nm_00308] dThe PNC bit vector filter algorithm shall evaluate the bytes of
the given PNC bit vector in the context of Nm_PncBitVectorRxIndication.c
(RS_Nm_02517, RS_Nm_02527)
Note: If <Bus>NmAllNmMessagesKeepAwake> is enabled, ECU might still be kept
alive, even if no relevant PNC request was received.
[SWS_Nm_00312] dIf Nm_PncBitVectorRxIndication is called, NmPnEiraCal-
cEnabled or NmPnEraCalcEnabled is set to TRUE and at least one PNC bit is
detected as relevant PNC request 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.c(RS_Nm_02517, RS_-
Nm_02527)
Note: The value of RelevantPncRequestDetectedPtr is used by the caller
<Bus>Nm to qualify if the received NMPDU shall be considered for further Rx Indi-
cation handling.
Example: The given PNC bit vector has a length of 2 bytes (NmPncBitVector-
Length):
Byte 0 Byte 1
PNC bit vector
0x12 0x8E
0x01 (Byte 0) 0x12 (NM PDU Byte 4) 0x00 (no relevant PNC re-
quest)
0x97 (Byte 1) 0x8E (NM PDU Byte 5) 0x86 (relevant PNC re-
quest)
As one byte contains relevant information, the value of the boolean parameter Rele-
vantPncRequestDetectedPtr is set to TRUE.
[SWS_Nm_CONSTR_00001] dThe length of all configured NmPnFilterMaskBytes
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 NmPnFilterMaskBytes differ from the config-
ured NmPncBitVectorLength of the corresponding NM-channel.c(RS_Nm_02517,
RS_Nm_02527)
• 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".c(RS_Nm_02517, RS_Nm_02563)
[SWS_Nm_00535] dIf 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.c(RS_Nm_02517, RS_Nm_02563)
[SWS_Nm_00536] dIf
• 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".c(RS_Nm_02517, RS_Nm_02563)
[SWS_Nm_00537] dIf 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
c(RS_Nm_02517, RS_Nm_02563)
Note: The Nm module has to aggregate all PNCs which were indicated for a syn-
chronized PNC shutdown and transfer the pncId’s to a byte array (PNC bit vector).
Each bit (PNC bit) of the PNC bit vector represent a particular PNC. The byteIn-
dex and bitindex within the PNC bit vector of PNC bit can be determined as
follows:
• byteIndex = (PncId div 8)
• bitIndex = (PncId mod 8)
[SWS_Nm_00330] dFor 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).c(RS_Nm_02517, RS_Nm_02562)
[SWS_Nm_00317] dIf 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.c(RS_Nm_02517, RS_Nm_02563, SRS_ModeMgm_09250)
Note: Nm stores unfilterred internal PNC requests in order to support the possibility of
requesting a PNC on a specific channel even if the PNC is not assigned to the channel.
[SWS_Nm_00318] dIf 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.c(RS_Nm_02517, RS_Nm_02563)
Note: This means, only one timer is required to handle one PNC on multiple connected
physical channels. For example: only 8 EIRA reset timers are required to handle the
requests of a Gateway with 6 physical channels and 8 partial network clusters. This is
possible because the switch of PNC related PDU-Groups is done global for the ECU
and independent of the physical channel.
[SWS_Nm_00319] dIf 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.c(RS_Nm_02517, RS_Nm_02563)
Note: NmPnResetTime has to be configured to a value greater than <Bus>NmMsgCy-
cleTime. If NmPnResetTime is configured to a value smaller than <Bus>NmMsgCy-
cleTime and only one ECU requests the PNC, the request state toggles in the EIRA,
because the request state reset before the requesting ECU is able to transmit the PNC
bit vector within the next NM message.
Note: NmPnResetTime has to be configured to a value smaller than <Bus>NmTime-
outTime to avoid that the timer elapses after <Bus>Nm already changed to a state
where it is expected that application communication is disabled (e.g. change to Prepare
Bus Sleep (UdpNm, CanNm) or Bus Sleep (FrNm)).
PNC reset timers for ERA and EIRA are handeled in the context of Nm_Mainfunction.
PNC reset timers are used for the monitoring of PNC requests. Based on the current
available PNC requests and the current state of the corresponding PNC reset timers,
particular actions have to be performed (e.g. re-start PNC timer, set requested PNC to
PNC released)
[SWS_Nm_00328] dIf NmPartialNetworkSupportEnabled is set to TRUE, then
all PNC reset timers shall be stopped at initialization.c(RS_Nm_02517, RS_Nm_-
02564)
[SWS_Nm_00329] dIf 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
EIRA / ERA PNC state) PNC reset timer state Evaluation result
PNC requested Stopped Start PNC reset timer,
set PNC reset timer state
to "running" and inform
ComM regarding the PNC
state change
PNC requested Elapsed Restart PNC reset timer,
set PNC reset timer state
to "running" and inform
ComM regarding the PNC
state change
PNC requested Running Restart PNC reset timer
PNC released Stopped Do nothing
PNC released Elapsed Set PNC reset timer to
"stopped" and inform
ComM regarding the PNC
state change
PNC released Running Do nothing (Please note:
time of the PNC reset
timer was already decre-
ment as very first action in
the main function)
Table 7.3: Example for EIRA / ERA PNC state handling in combination with PNC reset
timer state.
The Nm only acts as a forwarding layer between the ComM and the bus specific NM
for the basic functionality.
All API calls made from the upper layer shall be forwarded to the corresponding API
call of the lower layer. All callbacks of Nm invoked by the lower layer shall be forwarded
to the corresponding callback of the upper layer.
The Basic functionality provides the following API calls to the ComM:
• Nm_NetworkRequest - [SWS_Nm_00032]
• Nm_NetworkRelease - [SWS_Nm_00046]
• Nm_PassiveStartUp - [SWS_Nm_00031]
Note: This implies that the bus specific NM provides the correspond-
ing functions <Bus>Nm_NetworkRequest, <Bus>Nm_NetworkRelease and
<Bus>Nm_PassiveStartUp.
The Basic functionality forwards the following API callbacks to the ComM:
• Nm_NetworkStartIndication - [SWS_Nm_00154]
• Nm_NetworkMode - [SWS_Nm_00156]
• Nm_BusSleepMode - [SWS_Nm_00162]
• Nm_PrepareBusSleepMode - [SWS_Nm_00159]
Note: This implies that the ComM provides the corresponding callback
functions ComM_Nm_NetworkStartIndication, ComM_Nm_NetworkMode,
ComM_Nm_BusSleepMode and ComM_Nm_PrepareBusSleepMode.
The Nm provides a number of API calls to the upper layers that are not used by ComM.
These are provided for OEM specific extensions of the NM stack and are not required
by any AUTOSAR module. They shall be forwarded to the corresponding API calls
provided by the bus specific NMs.
The Basic functionality provides the following API calls to any OEM extension of an
upper layer:
• Nm_DisableCommunication - [SWS_Nm_00033]
• Nm_EnableCommunication - [SWS_Nm_00034]
• Nm_SetUserData - [SWS_Nm_00035]
• Nm_GetUserData - [SWS_Nm_00036]
• Nm_GetPduData - [SWS_Nm_00037]
• Nm_RepeatMessageRequest - [SWS_Nm_00038]
• Nm_GetNodeIdentifier - [SWS_Nm_00039]
• Nm_GetLocalNodeIdentifier - [SWS_Nm_00040]
• Nm_CheckRemoteSleepIndication - [SWS_Nm_00042]
• Nm_GetState - [SWS_Nm_00043]
Note: This implies that the bus specific NM optionally provides the corresponding
functions.
The coordination algorithm makes use of the following interfaces of the bus
specific NM:
• <Bus>Nm_NetworkRequest - [SWS_Nm_00119]
• <Bus>Nm_NetworkRelease - [SWS_Nm_00119]
• <Bus>Nm_RequestBusSynchronization - [SWS_Nm_00166]
• <Bus>Nm_CheckRemoteSleepIndication - [SWS_Nm_00166]
Note: All NM networks configured to be part of a coordinated cluster of the NM
coordinator functionality must have the corresponding Bus NM configured to be able to
actively send out NM messages (e.g. CANNM_PASSIVE_MODE_ENABLED = false).
As a result of this configuration restriction, all <Bus>Nm used by the coordinator func-
tionality of the Nm module must provide the API <Bus>Nm_NetworkRequest.
Note: Any configuration where a network is part of a coordinated cluster of networks
where the corresponding <Bus>Nm is configured as passive is invalid.
Note: The <Bus>Nm_RequestBusSynchronization is called by Nm immediately
before <Bus>Nm_NetworkRelease in order to allow non-synchronous networks to
synchronize before the network is released. For some networks, this call has no
meaning. The bus specific NM shall still provide this interface in order to support
the generality of the NM Coordinator functionality, but can choose to provide an empty
implementation.
Rationale: The <Bus>Nm_CheckRemoteSleepIndication is never explicitly men-
tioned in the coordination algorithm. Its use is dependent on the implementa-
tion.
The coordination algorithm requires that the following callbacks of the Nm can
be invoked by the bus specific NM:
• Nm_NetworkStartIndication - [SWS_Nm_00154]
• Nm_NetworkMode - [SWS_Nm_00156]
• Nm_BusSleepMode - [SWS_Nm_00162]
• Nm_PrepareBusSleepMode - [SWS_Nm_00159]
• Nm_SynchronizeMode - [SWS_Nm_91002]
• Nm_RemoteSleepIndication - [SWS_Nm_00192]
• Nm_RemoteSleepCancellation - [SWS_Nm_00193]
• Nm_SynchronizationPoint - [SWS_Nm_00194]
Note: The Nm_NetworkStartIndication, Nm_NetworkMode, Nm_BusSleep-
Mode and Nm_PrepareBusSleepMode are used by the coordination algo-
rithm to keep track of the status of the different networks and to handle aborted
shutdown (see Chapter 7.3.3).
Note: The Nm_RemoteSleepIndication and Nm_RemoteSleepCancellation
are used by the coordination algorithm to determine when all conditions for
initiating the coordinated shutdown are met. The indication will be called by the
bus specific NM when it detects that all other nodes on the network (except for itself)
is ready to go to ”bus-sleep mode“. Some implementations will also make use of the
API call <Bus>Nm_CheckRemoteSleepIndication.
Note: A bus specific NM which is included in a coordination cluster must monitor its
bus to identify when all other nodes on the network is ready to go to sleep. When this
occurs, the bus specific NM shall call the callback Nm_RemoteSleepIndication of
Nm. (See [SWS_Nm_00192]).
Note: After a bus specific NM which is included in a coordination cluster has
signaled to Nm that all other nodes on the network is ready to go to sleep (See
[SWS_Nm_00192]), it must continue monitoring its bus to identify if any node starts
requesting the network again, implying that the bus is no longer ready to go to sleep.
When this occurs, the bus specific NM shall call the callback Nm_RemoteSleepCan-
cellation of Nm. (See [SWS_Nm_00193]).
Note: The Remote Sleep Indication and Cancellation functionality is further specified
in the respective bus specific NM.
Rationale: The Nm_SynchronizationPoint shall be called by the bus specific
NM in order to inform the coordination algorithm of a suitable point in time to
initiate the coordinated shutdown. For cyclic networks this is typically at cycle
boundaries. For non-cyclic networks this must be defined by other means. Each NM
Coordination Cluster can be configured to make use of synchronization indications or
not (See [SWS_Nm_00172]), and if they are used, the coordination algorithm filters
indications and only acts on indications from networks that are configured as synchro-
nizing networks.
Note: Please note for implementation of <bus>Nm: Cyclic networks invoke the Nm_-
SynchronizationPoint repeatedly when no other nodes request the network. The
invocation is typically made at boundaries in the bus specific NM protocol when
changes in the NM voting will occur.
It is assumed that any call to <Bus>Nm_ReleaseNetwork made between two of these
Nm_SynchronizationPoint will be acted upon at the same point in time as the next
Nm_SynchronizationPoint would have been invoked.
Rationale: The synchronization indication shall start when Nm_RemoteSleepIndi-
cation has been notified and continue until either the network has been released
(<Bus>Nm_NetworkRelease) or the Nm_RemoteSleepCancellation is called.
Note:: For the use case of coordinating Flexray-channel A + B if there is no other
Network inside the NM Cluster, hence,if an NM Coordinator contains only one
NM Channel, the NmActiveCoordinator for this NmChannelConfig needs to be
set to TRUE and the NmChannelSleepMaster needs be set to FALSE to allow the
channel to coordinate itself . Note: The Value of "NmSynchronizingNetwork" is
only relevant if this network is in the same coordination cluster with other networks.
The aggregation of PNC requests, requires that the following callback function of the
Nm can be invoked by the bus specific NM:
• Nm_PncBitVectorRxIndication
• Nm_PncBitVectorTxIndication
The aggregation of PNC requests functionality provides the following API, to be called
by the ComM:
• Nm_UpdateIRA
The synchronized PNC shutdown functionality makes use of the following interface of
the bus specific NM:
• <Bus>Nm_RequestSynchronizedPncShutdown -
[SWS_Nm_00166][SWS_Nm_00521]
The synchronized PNC shutdown functionality requires that the following callback of
the Nm can be invoked by the bus specific NM:
• Nm_ForwardSynchronizedPncShutdown - [SWS_Nm_91007]
The synchronized PNC shutdown functionality provides the following API, to be called
by the ComM:
• Nm_RequestSynchronizedPncShutdown - [SWS_Nm_91005]
The Nm’s configuration contains parameters that regulate support of optional features
found in the bus specific NMs. Since Nm is only a pass-through interface layer re-
garding features that are not used by the NM Coordinator functionality, enabling these
in Nm’s configuration will in many cases only enable the pass-through of the controlling
API functions and the callback indications from the bus specific layers.
Many of the parameters defined for NM are used only as a source for global configu-
ration of all bus specific NM modules. Corresponding parameters of the bus specific
NMs are derived from these parameters.
7.6 NM_BUSNM_LOCALNM
[SWS_Nm_00483] dIf 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_BUSNM_LOCALNM 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.c()
7.8.1 Nm_CarWakeUpIndication
7.8.2 Nm_StateChangeNotification
c(RS_Nm_00051)
c()
8 API specification
c(SRS_BSW_00301)
8.2.1 Nm_ModeType
c(RS_Nm_00044)
8.2.2 Nm_StateType
4
NM_STATE_PREPARE_ 0x02 Prepare-Bus State
BUS_SLEEP
NM_STATE_READY_ 0x03 Ready Sleep State
SLEEP
NM_STATE_NORMAL_ 0x04 Normal Operation State
OPERATION
NM_STATE_REPEAT_ 0x05 Repeat Message State
MESSAGE
NM_STATE_ 0x06 Synchronize State
SYNCHRONIZE
NM_STATE_OFFLINE 0x07 Offline State
Description States of the network management state machine.
Available via NmStack_types.h
c(RS_Nm_00050)
8.2.3 Nm_BusNmType
8.2.4 Nm_ConfigType
c(SRS_BSW_00414)
8.3.1.1 Nm_Init
8.3.1.2 Nm_PassiveStartUp
4
Parameters (out) None
Return value Std_ReturnType E_OK: No error
E_NOT_OK: Passive start of network management has failed
NetworkHandle does not exist (development only)
Module not yet initialized (development only)
Description 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).
Available via Nm.h
8.3.1.3 Nm_NetworkRequest
return with E_NOT_OK. If NmDevErrorDetect is set to TRUE then it shall raise the
error NM_E_INVALID_CHANNEL in this case.c()
[SWS_Nm_00489] dIf 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.c(SRS_BSW_-
00323, SRS_BSW_00369, SRS_BSW_00386)
8.3.1.4 Nm_NetworkRelease
The following services are provided by NM Interface to allow the Diagnostic Communi-
cation Manager (DCM) to control the transmission of NM Messages.
Note: To run the coordination algorithm correctly, it has to be ensured
that NM PDU transmission ability is enabled before the ECU is shut down. If
<Bus>Nm_NetworkRelease is called while NM PDU transmission ability is disabled,
the ECU will shut down after NM PDU transmission ability has been re-enabled again.
Therefore the ECU can also shut down in case of race conditions (e.g. diagnostic ses-
sion left shortly before enabling communication) or a wrong usage of communication
control.
8.3.2.1 Nm_DisableCommunication
c(RS_Nm_02513, RS_Nm_02512)
Note: Caveats of Nm_DisableCommunication: The <Bus>Nm and the Nm itself
are initialized correctly.
[SWS_Nm_00134] dConfiguration of Nm_DisableCommunication: This function is
only available if NmComControlEnabled is set to TRUE.c(RS_Nm_00150)
[SWS_Nm_00286] dIf Nm_DisableCommunication is called with a network handle
whereNmPassiveModeEnabledis 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.c()
8.3.2.2 Nm_EnableCommunication
c(RS_Nm_02512)
Note: Caveats of Nm_EnableCommunication: The <Bus>Nm and the Nm itself are
initialized correctly.
[SWS_Nm_00136] dConfiguration of Nm_EnableCommunication: This function is
only available if NmComControlEnabled is set to TRUE.c(RS_Nm_00150)
[SWS_Nm_00287] dIf Nm_EnableCommunication is called with a network handle
whereNmPassiveModeEnabledis 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.c()
[SWS_Nm_00492] dIf 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.c
(SRS_BSW_00323, SRS_BSW_00369, SRS_BSW_00386)
8.3.3.1 Nm_RequestSynchronizedPncShutdown
c(RS_Nm_02572, RS_Nm_02571)
[SWS_Nm_00508] dIf 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.c(SRS_BSW_00323, SRS_BSW_00369, SRS_BSW_00386)
8.3.3.2 Nm_UpdateIRA
4
Reentrancy Non Reentrant for the same NetworkHandle, reentrant otherwise
Parameters (in) NetworkHandle Identification of the NM-channel
PncBitVectorPtr Pointer to the bit vector with all PNC bits set to "1" of internal
requested PNCs (IRA)
Parameters (inout) None
Parameters (out) None
Return value None
Description Indication by ComM of internal PNC requests. This is used to aggregate the internal PNC
requests.
Available via Nm.h
c(RS_Nm_02544)
The following services are provided by NM Interface for OEM specific extensions of the
NM stack and are not required by any AUTOSAR module.
8.3.4.1 Nm_SetUserData
c(RS_Nm_02503)
Note: Caveats of Nm_SetUserData: The <Bus>Nm and the Nm itself are initialized
correctly.
8.3.4.2 Nm_GetUserData
c(RS_Nm_02504)
Note: Caveats of Nm_GetUserData: The <Bus>Nm and the Nm itself are initialized
correctly.
[SWS_Nm_00140] dConfiguration of Nm_GetUserData: This function is only avail-
able if NmUserDataEnabled is set to TRUE.c(RS_Nm_00150)
[SWS_Nm_00494] dIf the pre-processor switch NmDevErrorDetect is set to TRUE,
the function Nm_GetUserData shall raise the error NM_E_INVALID_CHANNEL if the
8.3.4.3 Nm_GetPduData
c()
Note: Caveats of Nm_GetPduData: The <Bus>Nm and the Nm itself are initialized
correctly.
[SWS_Nm_00495] dIf 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.c(SRS_BSW_00323,
SRS_BSW_00369, SRS_BSW_00386)
8.3.4.4 Nm_RepeatMessageRequest
4
Reentrancy Non-reentrant for the same NetworkHandle, reentrant otherwise
Parameters (in) NetworkHandle Identification of the NM-channel
Parameters (inout) None
Parameters (out) None
Return value Std_ReturnType E_OK: No error
E_NOT_OK: Setting of Repeat Message Request Bit has failed
NetworkHandle does not exist (development only)
Module not yet initialized (development only)
Description 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.
Available via Nm.h
c(RS_Nm_00153)
Note: Caveats of Nm_RepeatMessageRequest: The <Bus>Nm and the Nm itself
are initialized correctly.
[SWS_Nm_00289] dIf Nm_RepeatMessageRequest is called with a network handle
whereNmPassiveModeEnabledis 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.c()
[SWS_Nm_00496] dIf 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.c
(SRS_BSW_00323, SRS_BSW_00369, SRS_BSW_00386)
8.3.4.5 Nm_GetNodeIdentifier
4
Return value Std_ReturnType E_OK: No error
E_NOT_OK: Getting of the node identifier out of the last received
NM-message has failed
NetworkHandle does not exist (development only)
Module not yet initialized (development only)
Description 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).
Available via Nm.h
c(RS_Nm_02506)
Note: Caveats of Nm_GetNodeIdentifier: The <Bus>Nm and the Nm itself are
initialized correctly.
[SWS_Nm_00497] dIf 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.c(SRS_-
BSW_00323, SRS_BSW_00369, SRS_BSW_00386)
8.3.4.6 Nm_GetLocalNodeIdentifier
c(RS_Nm_02508)
Note: Caveats of Nm_GetLocalNodeIdentifier: The <Bus>Nm and the Nm itself
are initialized correctly.
8.3.4.7 Nm_CheckRemoteSleepIndication
c(RS_Nm_02513)
Note: Caveats of Nm_CheckRemoteSleepIndication: The <Bus>Nm and the Nm
itself are initialized correctly.
[SWS_Nm_00290] dIf Nm_CheckRemoteSleepIndication is called with a network
handle whereNmPassiveModeEnabledis 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.c(RS_Nm_00150)
[SWS_Nm_00150] dConfiguration of Nm_CheckRemoteSleepIndication: This
function is only available if NmRemoteSleepIndEnabled is set to TRUE.c(RS_Nm_-
00150)
[SWS_Nm_00499] dIf 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.c(SRS_BSW_00323, SRS_BSW_00369, SRS_BSW_00386)
8.3.4.8 Nm_GetState
c(RS_Nm_00050)
Note: Caveats of Nm_GetState: The <Bus>Nm and the Nm itself are initialized cor-
rectly.
[SWS_Nm_00500] dIf 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.c(SRS_BSW_00323,
SRS_BSW_00369, SRS_BSW_00386)
8.3.4.9 Nm_GetVersionInfo
4
Parameters (inout) None
Parameters (out) nmVerInfoPtr Pointer to where to store the version information of this module.
Return value None
Description This service returns the version information of this module.
Available via Nm.h
8.3.4.10 Nm_PnLearningRequest
c()
Note: Caveats of Nm_PnLearningRequest: The <Bus>Nm and the Nm itself are
initialized correctly.
[SWS_Nm_00502] dNm_PnLearningRequest shall only be available if NmDynam-
icPncToChannelMappingSupport is set to TRUE.c()
[SWS_Nm_00503] dIf 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.c()
[SWS_Nm_00505] dIf 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.c(SRS_-
BSW_00323, SRS_BSW_00369, SRS_BSW_00386)
8.4.1.1 Nm_NetworkStartIndication
c(SRS_BSW_00359, RS_Nm_02513)
[SWS_Nm_00155] dThe indication through callback function Nm_Net-
workStartIndication: shall be forwarded to ComM by calling the
ComM_Nm_NetworkStartIndication.c(RS_Nm_02513)
8.4.1.2 Nm_NetworkMode
c(SRS_BSW_00359, RS_Nm_00051)
[SWS_Nm_00158] dThe indication through callback function Nm_NetworkMode: shall
be forwarded to ComM by calling the ComM_Nm_NetworkMode.c(RS_Nm_00051)
8.4.1.3 Nm_BusSleepMode
c(SRS_BSW_00359, RS_Nm_00051)
[SWS_Nm_00163] dThe indication through callback function Nm_BusSleepMode:
shall be forwarded to ComM by calling the ComM_Nm_BusSleepMode.c(RS_Nm_-
00051)
8.4.1.4 Nm_PrepareBusSleepMode
c(SRS_BSW_00359, RS_Nm_00051)
[SWS_Nm_00161] dThe indication through callback function Nm_-
PrepareBusSleepMode: shall be forwarded to ComM by calling
ComM_Nm_PrepareBusSleepMode.c(RS_Nm_00051)
8.4.1.5 NM_SynchronizeMode
c()
8.4.1.6 Nm_RemoteSleepIndication
c(SRS_BSW_00359, RS_Nm_00052)
[SWS_Nm_00277] dConfiguration of Nm_RemoteSleepIndication: This function is
only available if NmRemoteSleepIndEnabled is set to TRUE.c(RS_Nm_00150)
The notification that all other nodes on the network are ready to enter Bus-Sleep Mode
is only needed for internal purposes of the NM Coordinator.
Note: When NM Coordinator functionality is disabled Nm_RemoteSleepIndication
can be an empty function.
8.4.1.7 Nm_RemoteSleepCancellation
c(SRS_BSW_00359, RS_Nm_02509)
8.4.1.8 Nm_SynchronizationPoint
c(SRS_BSW_00359, RS_Nm_02516)
The notification that this is a suitable point in time to initiate the coordinated shut-
down is only needed for internal purposes of the NM Coordinator.
8.4.1.9 Nm_CoordReadyToSleepIndication
4
Parameters (inout) None
Parameters (out) None
Return value None
Description Sets an indication, when the NM Coordinator Sleep Ready bit in the Control Bit Vector is set
Available via Nm.h
c(SRS_BSW_00359, RS_Nm_02535)
[SWS_Nm_00255] dConfiguration of Nm_CoordReadyToSleepIndication: Op-
tional
If NmCoordinatorSyncSupport is set to TRUE , the Nm shall provide the API Nm_-
CoordReadyToSleepIndication.c(RS_Nm_00150)
8.4.1.10 Nm_CoordReadyToSleepCancellation
c(SRS_BSW_00359, RS_Nm_02535)
[SWS_Nm_00273] dConfiguration of Nm_CoordReadyToSleepCancellation: Op-
tional
If NmCoordinatorSyncSupport is set to TRUE , the Nm shall provide the API Nm_-
CoordReadyToSleepCancellation.c(RS_Nm_00150)
8.4.1.11 Nm_ForwardSynchronizedPncShutdown
c(RS_Nm_02544)
8.4.1.12 Nm_PncBitVectorRxIndication
4
Description 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.
Available via Nm.h
c(RS_Nm_02544, SRS_ModeMgm_09250)
8.4.1.13 Nm_PncBitVectorTxIndication
c(RS_Nm_02544, SRS_ModeMgm_09250)
8.4.1.14 Nm_PncBitVectorTxConfirmation
4
Reentrancy Non-reentrant for the same NetworkHandle, reentrant otherwise
Parameters (in) NetworkHandle Identification of the NM-channel
PncBitVectorPtr Pointer to the PNC bit vector which was considered for
transmission
result E_OK: The PNC bit vector has been transmitted
E_NOT_OK: The transmission of the PNC bit vector failed
Parameters (inout) None
Parameters (out) None
Return value None
Description Function called by <Bus>Nms to confirm the state of the transmission for the given PNC bit
vector on the given NM-Channel.
Available via Nm.h
c(RS_Nm_02574, SRS_ModeMgm_09250)
The following call-back notifications are provided by NM Interface for OEM specific
extensions of bus specific NM components and are not required by any AUTOSAR
module. In the context of the Basic functionality and NM Coordinator functionality they
have no specific usage.
8.4.2.1 Nm_PduRxIndication
c(SRS_BSW_00359)
The notification that an NM message has been received is only needed for OEM
specific extensions of the NM Coordinator.
8.4.2.2 Nm_StateChangeNotification
8.4.2.3 Nm_RepeatMessageIndication
4
Reentrancy Reentrant
Parameters (in) nmNetworkHandle Identification of the NM-channel
pnLearningBitSet TRUE if also the Partial Network Learning Bit was received,
FALSE otherwise
Parameters (inout) None
Parameters (out) None
Return value None
Description 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.
Available via Nm.h
8.4.2.4 Nm_TxTimeoutException
c(SRS_BSW_00359)
The notification that an attempt to send an NM message failed is only needed for OEM
specific extensions of the Nm.
8.4.2.5 Nm_CarWakeUpIndication
8.5.1 Nm_MainFunction
c(SRS_BSW_00424, SRS_BSW_00425)
[SWS_Nm_00279] dIf NmCoordinatorSupportEnabled is set to TRUE, the Nm_-
MainFunction API shall be available.c(RS_Nm_00150)
4
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.
c(RS_Nm_02515, RS_Nm_02536)
This chapter defines all interfaces that are required to fulfill an optional functionality of
the module.
[SWS_Nm_00166] Definition of optional interfaces in module Nm d
API Function Header File Description
<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 – Check if remote sleep indication takes place or not.
Indication
<Bus>Nm_DeactivateTxPnShutdown – NM indicate to deactive the transmission of PN
Msg 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 – Request bus synchronization.
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.
5
4
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 ComM_Nm.h If an ECU in role of an intermediate PNC coordinator
Shutdown 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 ComM_Nm.h Notification that the state of all <Bus>Nm has left
Indication 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.
c(RS_Nm_00150, RS_Nm_02515)
In this chapter all interfaces are listed where the target function could be configured.
The target function is usually a call-back function. The names of these kind of inter-
faces are not fixed because they are configurable.
8.6.3.1 NmCarWakeUpCallout
4
Parameters (in) nmNetworkHandle Identification of the NM-channel
Parameters (inout) None
Parameters (out) None
Return value None
Description Callout function to be called by Nm_CarWakeUpIndication()
Available via Nm_Externals.h
c(RS_Nm_02504)
9 Sequence diagrams
Nm_NetworkRelease(Std_ReturnType,
NetworkHandleType)
Nm_RemoteSleepIndication(NetworkHandleType)
Nm_RemoteSleepIndication(NetworkHandleType)
Repetition cycle
boundary()
Nm_SynchronizationPoint(NetworkHandleType)
Start shutdown
timers()
FrNm_RequestBusSynchronization(Std_ReturnType,
NetworkHandleType)
FrNm_NetworkRelease(Std_ReturnType,
NetworkHandleType)
Repetition cycle
boundary()
Network Mode
Ready Sleep
Last repetition
Nm_BusSleepMode(NetworkHandleType) cycle finished()
[CAN]
Shutdown timer expires()
CanNm_RequestBusSynchronization(Std_ReturnType,
NetworkHandleType)
CanNm_NetworkRelease(Std_ReturnType,
NetworkHandleType)
Network Mode
Ready Sleep
Timer expires
()
Nm_PrepareBusSleepMode(NetworkHandleType)
Nm_BusSleepMode(NetworkHandleType)
ComM_Nm_BusSleepMode
(NetworkHandleType) Bus-Sleep Mode
CanSM_RequestComMode(Std_ReturnType, NetworkHandleType,
ComM_ModeType)
10 Configuration specification
The following chapter contains tables of all configuration parameters and switches
used to determine the functional units of the Generic Network Management Interface.
The default values of configuration parameters are denoted as bold.
In general, this chapter defines configuration parameters and their clustering into con-
tainers. section 10.1 describes fundamentals. section 10.2, section 10.3 and section
10.4 specifies the structure (containers) and the parameters of the Nm. The section
10.5 specifies published information of the Nm.
AUTOSARParameterDefinition:
EcucDefinitionCollection
lowerMultiplicity = 0
upperMultiplicity = 1
FrNm: EcucModuleDef
+module
lowerMultiplicity = 0
upperMultiplicity = 1
UdpNm: EcucModuleDef
+module
lowerMultiplicity = 0
upperMultiplicity = 1
J1939Nm: EcucModuleDef
+module
lowerMultiplicity = 0
upperMultiplicity = 1
10.2.1 Nm
Included Containers
Container Name Multiplicity Scope / Dependency
NmChannelConfig 1..* This container contains the configuration (parameters) of the bus
channel(s). The channel parameter shall be harmonized within
the whole communication stack.
NmGlobalConfig 1 This container contains all global configuration parameters of the
Nm Interface.
+subContainer NmGlobalProperties:
EcucParamConfContainerDef
+container
+subContainer NmGlobalFeatures:
EcucParamConfContainerDef
NmEcucPartitionRef:
+reference EcucReferenceDef
lowerMultiplicity = 0
upperMultiplicity = 1
+destination
EcucPartition:
+container EcucParamConfContainerDef
NmChannelConfig:
EcucParamConfContainerDef lowerMultiplicity = 0
upperMultiplicity = *
upperMultiplicity = *
lowerMultiplicity = 1
10.3.1 NmGlobalConfig
Included Containers
Container Name Multiplicity Scope / Dependency
NmGlobalConstants 1 –
NmGlobalFeatures 1 –
NmGlobalProperties 1 –
NmNumberOfChannels:
NmGlobalConfig: +subContainer NmGlobalConstants: +parameter EcucIntegerParamDef
EcucParamConfContainerDef EcucParamConfContainerDef
min = 1
upperMultiplicity = 1 max = 255
lowerMultiplicity = 1
NmDevErrorDetect:
EcucBooleanParamDef
+subContainer +parameter
defaultValue = false
NmGlobalProperties:
EcucParamConfContainerDef +parameter NmVersionInfoApi:
EcucBooleanParamDef
NmCycletimeMainFunction:
defaultValue = false EcucFloatParamDef
+parameter
min = 0
max = INF
NmPnResetTime: lowerMultiplicity = 0
EcucFloatParamDef upperMultiplicity = 1
+parameter
min = 0.001
max = 65535
lowerMultiplicity = 0 NmPnEiraCalcEnabled:
upperMultiplicity = 1 EcucBooleanParamDef
+parameter
defaultValue = false
lowerMultiplicity = 0
upperMultiplicity = 1
NmPncBitVectorOffset:
EcucIntegerParamDef
+parameter min = 0 NmPnShutdownMessageRetransmissionDuration:
max = 63 EcucFloatParamDef
defaultValue = 0
lowerMultiplicity = 0 min = 0.001
upperMultiplicity = 1 max = 65.535
+parameter lowerMultiplicity = 0
upperMultiplicity = 1
10.3.2 NmGlobalConstants
No Included Containers
10.3.3 NmGlobalProperties
4
Description Parameter to configure the offset in bytes of the PNC bit vector that contains the PNC
requests, which is transmitted within NM PDU by the corresponding <Bus>Nm.
Multiplicity 0..1
Type EcucIntegerParamDef
Range 0 .. 63
Default value 0
Value Configuration Class Pre-compile time X VARIANT-PRE-COMPILE
Link time X VARIANT-LINK-TIME
Post-build time –
Scope / Dependency scope: ECU
dependency: This parameter is only valid if NmPartialNetworkSupportEnabled is set to
TRUE. NmPncBitVectorOffset == Number of <Bus>Nm Sytem Bytes OR NmPncBit
VectorOffset + NmPncBitVectorLength == NM PduLength.
4
Post-build time –
Value Configuration Class Pre-compile time X VARIANT-PRE-COMPILE
Link time X VARIANT-LINK-TIME
Post-build time –
Scope / Dependency scope: local
dependency: This parameter is only valid if NmPartialNetworkSupportEnabled is set to
TRUE. NmPnResetTime > <Can|Udp>NmMsgCycleTime NmPnResetTime > FrNm
DataCycle * FR Cycle Time
No Included Containers
10.3.4 NmGlobalFeatures
4
Description Enables or disables CWU detection. FALSE - CarWakeUp not supported TRUE - Car
WakeUp supported
Multiplicity 1
Type EcucBooleanParamDef
Default value false
Post-Build Variant Value false
Value Configuration Class Pre-compile time X VARIANT-PRE-COMPILE
Link time X VARIANT-LINK-TIME
Post-build time –
Scope / Dependency scope: local
4
Value Configuration Class Pre-compile time X VARIANT-PRE-COMPILE
Link time X VARIANT-LINK-TIME
Post-build time –
Scope / Dependency scope: local
dependency: NmCoordinatorSyncSupport shall only be valid if NmCoordinatorSupport
Enabled is TRUE.
4
Multiplicity 0..1
Type EcucBooleanParamDef
Default value false
Multiplicity Configuration Class Pre-compile time X VARIANT-PRE-COMPILE
Link time X VARIANT-LINK-TIME
Post-build time –
Value Configuration Class Pre-compile time X VARIANT-PRE-COMPILE
Link time X VARIANT-LINK-TIME
Post-build time –
Scope / Dependency scope: local
dependency: This parameter can only be set to TRUE if NmCoordinatorSupport
Enabled is set to FALSE.
4
Multiplicity 1
Type EcucBooleanParamDef
Default value –
Post-Build Variant Value false
Value Configuration Class Pre-compile time X All Variants
Link time –
Post-build time –
Scope / Dependency scope: local
dependency: NmStateChangeIndEnabled = TRUE if NmDynamicPncToChannel
MappingSupport == TRUE
No Included Containers
NmGlobalConfig:
EcucParamConfContainerDef
upperMultiplicity = 1
lowerMultiplicity = 1
+subContainer
NmCoordinatorSupportEnabled: +parameterNmStateChangeIndEnabled:
+parameter
EcucBooleanParamDef EcucBooleanParamDef
defaultValue = false
NmCoordinatorSyncSupport: +parameter
EcucBooleanParamDef NmPartialNetworkSupportEnabled:
+parameter EcucBooleanParamDef
defaultValue = false
NmPduRxIndicationEnabled: +parameter
lowerMultiplicity = 0
EcucBooleanParamDef upperMultiplicity = 1
NmCarWakeUpRxEnabled:
+parameter
EcucBooleanParamDef
defaultValue = false
10.4.1 NmChannelConfig
NmChannelConfig: ComMChannel:
EcucParamConfContainerDef +reference NmComMChannelRef: EcucReferenceDef +destination EcucParamConfContainerDef
requiresSymbolicNameValue = true
upperMultiplicity = * lowerMultiplicity = 1
lowerMultiplicity = 1 upperMultiplicity = 256
NmCoordClusterIndex: EcucIntegerParamDef
+parameter lowerMultiplicity = 0
upperMultiplicity = 1
min = 0
max = 255 NmPnEnabled: EcucBooleanParamDef
+parameter
defaultValue = false
NmActiveCoordinator: EcucBooleanParamDef lowerMultiplicity = 0
upperMultiplicity = 1
+parameter
lowerMultiplicity = 0
upperMultiplicity = 1
+parameter NmDynamicPncToChannelMappingEnabled:
EcucBooleanParamDef
+parameter NmSynchronizingNetwork: EcucBooleanParamDef defaultValue = false
lowerMultiplicity = 0
upperMultiplicity = 1
NmComUserDataSupport: EcucBooleanParamDef
+parameter
lowerMultiplicity = 0
upperMultiplicity = 1
defaultValue = false
+choice +choice
min = 0
max = INF
+parameter NmStateReportEnabled:
NmStateReportSignalRef:
EcucBooleanParamDef
EcucReferenceDef
lowerMultiplicity = 0
+reference upperMultiplicity = 1
requiresSymbolicNameValue = true
min = 0
max = 255
defaultValue = 0
NmPncBitVectorLength:
+parameter EcucIntegerParamDef
min = 0 NmPnEraCalcEnabled:
max = 63 EcucBooleanParamDef
defaultValue = 0 defaultValue = false
+parameter lowerMultiplicity = 0
upperMultiplicity = 1
4
Scope / Dependency scope: local
dependency: If the parameter NmCoordClusterIndex is not defined, this parameter is
not valid.
4
Description Channel-specific parameter to enable the dynamic PNC-to-channel-mapping feature.
False: Dynamic PNC-to-channel-mapping is disabled True: Dynamic
PNC-to-channel-mapping is enabled
Tags: atp.Status=draft
Multiplicity 0..1
Type EcucBooleanParamDef
Default value false
Post-Build Variant Value false
Value Configuration Class Pre-compile time X VARIANT-PRE-COMPILE
Link time X VARIANT-LINK-TIME
Post-build time –
Scope / Dependency scope: local
dependency: Shall only be TRUE if NmDynamicPncToChannelMappingSupport is
TRUE
4
Scope / Dependency scope: local
dependency: only available if NmStatChangeIndEnabled and NmComUserData
Support are configured to TRUE.
4
Link time –
Post-build time –
Scope / Dependency scope: local
dependency: Signal must be configured in COM. Only available if NmStateReport
Enabled == true
Included Containers
Container Name Multiplicity Scope / Dependency
NmBusType 1 –
NmPnFilterMaskByte 0..63 Information for the filter of the PNC bit vector.
10.4.2 NmPnFilterMaskByte
4
Default value 0
Value Configuration Class Pre-compile time X VARIANT-PRE-COMPILE
Link time X VARIANT-LINK-TIME
Post-build time –
Scope / Dependency scope: local
dependency: This parameter is only valid if NmPartialNetworkSupportEnabled is set to
TRUE.
No Included Containers
10.4.3 NmBusType
Container Choices
Container Name Multiplicity Scope / Dependency
NmGenericBusNmConfig 0..1 –
NmStandardBusNmConfig 0..1 –
NmBusType: NmGenericBusNmConfig:
EcucChoiceContainerDef EcucParamConfContainerDef NmGenericBusNmShutdownTime:
+parameter EcucFloatParamDef
lowerMultiplicity = 0
upperMultiplicity = 1 min = 0
+choice max = INF
+parameter NmGenericBusNmPrefix:
EcucStringParamDef
NmStandardBusNmConfig:
+choice EcucParamConfContainerDef
lowerMultiplicity = 0
upperMultiplicity = 1
+parameter
+literal NM_BUSNM_J1939NM:
NmStandardBusType: EcucEnumerationLiteralDef
EcucEnumerationParamDef
+literal NM_BUSNM_CANNM:
EcucEnumerationLiteralDef
+literal
NM_BUSNM_FRNM:
EcucEnumerationLiteralDef
+literal NM_BUSNM_LOCALNM:
EcucEnumerationLiteralDef
+literal
NM_BUSNM_UDPNM:
EcucEnumerationLiteralDef
10.4.4 NmGenericBusNmConfig
4
Value Configuration Class Pre-compile time X VARIANT-PRE-COMPILE
Link time X VARIANT-LINK-TIME
Post-build time –
Scope / Dependency scope: local
No Included Containers
10.4.5 NmStandardBusNmConfig
4
Link time X VARIANT-LINK-TIME
Post-build time –
Scope / Dependency scope: local
dependency: Configuring value to NM_BUSNM_LOCALNM is only allowed if NmCoord
ClusterIndex for the corresponding channel is defined (i.e channel is coordinated).
No Included Containers
Number Heading
[SWS_Nm_00521]
[SWS_Nm_00523]
[SWS_Nm_00524]
[SWS_Nm_00525]
[SWS_Nm_00527]
[SWS_Nm_00529]
[SWS_Nm_00530]
[SWS_Nm_00532]
[SWS_Nm_00533]
[SWS_Nm_00534]
[SWS_Nm_00535]
[SWS_Nm_00536]
[SWS_Nm_00537]
[SWS_Nm_91010]
[SWS_Nm_91011]
[SWS_Nm_NA_-
Not applicable requirements
00999]
Table B.1: Added Specification Items in R22-11
Number Heading
[SWS_Nm_00030]
[SWS_Nm_00031]
[SWS_Nm_00032]
5
4
Number Heading
[SWS_Nm_00033]
[SWS_Nm_00034]
[SWS_Nm_00035]
[SWS_Nm_00036]
[SWS_Nm_00037]
[SWS_Nm_00038]
[SWS_Nm_00039]
[SWS_Nm_00040]
[SWS_Nm_00042]
[SWS_Nm_00043]
[SWS_Nm_00044]
[SWS_Nm_00046]
[SWS_Nm_00112]
[SWS_Nm_00114]
[SWS_Nm_00117]
[SWS_Nm_00118]
[SWS_Nm_00119]
[SWS_Nm_00124]
[SWS_Nm_00154]
[SWS_Nm_00156]
[SWS_Nm_00159]
[SWS_Nm_00162]
[SWS_Nm_00166]
[SWS_Nm_00176]
[SWS_Nm_00183]
[SWS_Nm_00192]
[SWS_Nm_00193]
[SWS_Nm_00194]
[SWS_Nm_00230]
[SWS_Nm_00232]
[SWS_Nm_00234]
[SWS_Nm_00235]
[SWS_Nm_00236]
[SWS_Nm_00245]
[SWS_Nm_00250]
[SWS_Nm_00254]
[SWS_Nm_00259]
[SWS_Nm_00261]
[SWS_Nm_00267]
5
4
Number Heading
[SWS_Nm_00271]
[SWS_Nm_00272]
[SWS_Nm_00274]
[SWS_Nm_00275]
[SWS_Nm_00276]
[SWS_Nm_00282]
[SWS_Nm_00291]
[SWS_Nm_00293]
[SWS_Nm_00302]
[SWS_Nm_00305]
[SWS_Nm_00308]
[SWS_Nm_00310]
[SWS_Nm_00311]
[SWS_Nm_00312]
[SWS_Nm_00313]
[SWS_Nm_00317]
[SWS_Nm_00318]
[SWS_Nm_00319]
[SWS_Nm_00320]
[SWS_Nm_00321]
[SWS_Nm_00322]
[SWS_Nm_00323]
[SWS_Nm_00324]
[SWS_Nm_00325]
[SWS_Nm_00326]
[SWS_Nm_00327]
[SWS_Nm_00328]
[SWS_Nm_00329]
[SWS_Nm_00330]
[SWS_Nm_00331]
[SWS_Nm_00501]
[SWS_Nm_00502]
[SWS_Nm_00503]
[SWS_Nm_00504]
[SWS_Nm_00505]
[SWS_Nm_00508]
[SWS_Nm_91002]
[SWS_Nm_91003]
[SWS_Nm_91005]
5
4
Number Heading
[SWS_Nm_91006]
[SWS_Nm_91007]
[SWS_Nm_91008]
[SWS_Nm_91009]
[SWS_Nm_-
CONSTR_00001]
Table B.2: Changed Specification Items in R22-11
Number Heading
[SWS_Nm_00314]
[SWS_Nm_00332]
[SWS_Nm_00506]
[SWS_Nm_00507]
[SWS_Nm_00999] Not applicable requirements
Table B.3: Deleted Specification Items in R22-11
none
none
none
Number Heading
[SWS_Nm_00509] Definiton of network management states in Nm module
Table B.4: Added Specification Items in R23-11
Number Heading
[SWS_Nm_00312]
[SWS_Nm_91003] Definition of API function Nm_PnLearningRequest
[SWS_Nm_91005] Definition of API function Nm_RequestSynchronizedPncShutdown
Table B.5: Changed Specification Items in R23-11
Number Heading
[SWS_Nm_00310]
[SWS_Nm_00311]
Table B.6: Deleted Specification Items in R23-11
none
none
none