AUTOSAR SWS CANNetworkManagement
AUTOSAR SWS CANNetworkManagement
AUTOSAR SWS CANNetworkManagement
Disclaimer
This specification 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 specification.
The material contained in this specification is protected by copyright and other types
of Intellectual Property Rights. The commercial exploitation of the material contained
in this specification requires a license to such Intellectual Property Rights.
This specification 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 specification may be utilized or reproduced, in any form or by any means, without
permission in writing from the publisher.
The AUTOSAR specifications have been developed for automotive applications only.
They have neither been developed, nor tested for non-automotive applications.
The word AUTOSAR and the AUTOSAR logo are registered trademarks.
Any such exemplary items are contained in the specifications for illustration purposes
only, and they themselves are not part of the AUTOSAR Standard. Neither their
presence in such specifications, nor any later documentation of AUTOSAR
conformance of products actually implementing such exemplary items, imply that
intellectual property rights covering such exemplary items are licensed under the
same rules as applicable to the AUTOSAR Standard.
Table of Contents
Acronym/abb Description:
reviation:
CanIf Abbreviation for the CAN Interface
CanNm Abbreviation for CAN Network Management
CBV Control Bit Vector
CWU Car Wakeup
ERA External Request Array
EIRA External and Internal Request Array
NM Network Management
PNC Partial Network Cluster
PNI Partial Network Information
Term Description:
“PDU This means that the Network Management PDU transmission has been disabled by
transmission the service CanNm_DisableCommunication.
ability is
disabled”
“Repeat CanNm_RxIndication finds the RptMsgRequest set in the Control Bit Vector of a
Message received Network Management PDU.
Request Bit
Indication”
“PN filter mask” Vector of filter mask bytes defined by configuration container(s)
CanNmPnFilterMaskByte
3 Related documentation
Thus, the specification SWS BSW General shall be considered as additional and
required specification for CAN Network Management.
4.1 Limitations
1. One channel of CanNm is associated with only one network management
cluster in one network. One network management cluster can have only one
channel of CanNm in one node.
2. One channel of CanNm is associated with only one network within the same
ECU.
3. CanNm is only applicable for CAN systems.
«module»
:Nm
«module»
:CanNm
«module»
:CanIf
«module»
CanNm::CanNm
«optional»
CanIf_Transmit
Please refer to the chapter 5.1.6 Code file structure in “SWS_BSWGeneral” [9].
Please refer to the chapter 5.1.7 Header file structure in “SWS_BSWGeneral” [9].
SchM_CanNm.h
CanNm_MemMap.h Det.h
6 Requirements traceability
- - SWS_CanNm_00097
- - SWS_CanNm_00098
- - SWS_CanNm_00099
- - SWS_CanNm_00100
- - SWS_CanNm_00101
- - SWS_CanNm_00102
- - SWS_CanNm_00103
- - SWS_CanNm_00104
- - SWS_CanNm_00105
- - SWS_CanNm_00106
- - SWS_CanNm_00107
- - SWS_CanNm_00108
- - SWS_CanNm_00109
- - SWS_CanNm_00110
- - SWS_CanNm_00111
- - SWS_CanNm_00112
- - SWS_CanNm_00113
- - SWS_CanNm_00114
- - SWS_CanNm_00115
- - SWS_CanNm_00116
- - SWS_CanNm_00117
- - SWS_CanNm_00118
- - SWS_CanNm_00119
- - SWS_CanNm_00120
- - SWS_CanNm_00121
- - SWS_CanNm_00122
- - SWS_CanNm_00123
- - SWS_CanNm_00124
- - SWS_CanNm_00126
- - SWS_CanNm_00127
- - SWS_CanNm_00128
- - SWS_CanNm_00129
- - SWS_CanNm_00132
- - SWS_CanNm_00133
- - SWS_CanNm_00135
- - SWS_CanNm_00137
- - SWS_CanNm_00138
- - SWS_CanNm_00141
- - SWS_CanNm_00143
- - SWS_CanNm_00144
- - SWS_CanNm_00145
- - SWS_CanNm_00146
- - SWS_CanNm_00147
- - SWS_CanNm_00149
- - SWS_CanNm_00150
- - SWS_CanNm_00151
- - SWS_CanNm_00152
- - SWS_CanNm_00153
- - SWS_CanNm_00154
- - SWS_CanNm_00156
- - SWS_CanNm_00157
- - SWS_CanNm_00158
- - SWS_CanNm_00159
- - SWS_CanNm_00160
- - SWS_CanNm_00161
- - SWS_CanNm_00166
- - SWS_CanNm_00170
- - SWS_CanNm_00172
- - SWS_CanNm_00173
- - SWS_CanNm_00174
- - SWS_CanNm_00175
- - SWS_CanNm_00176
- - SWS_CanNm_00177
- - SWS_CanNm_00178
- - SWS_CanNm_00179
- - SWS_CanNm_00180
- - SWS_CanNm_00181
- - SWS_CanNm_00185
- - SWS_CanNm_00187
- - SWS_CanNm_00189
- - SWS_CanNm_00190
- - SWS_CanNm_00191
- - SWS_CanNm_00192
- - SWS_CanNm_00193
- - SWS_CanNm_00194
- - SWS_CanNm_00195
- - SWS_CanNm_00197
- - SWS_CanNm_00198
- - SWS_CanNm_00199
- - SWS_CanNm_00202
- - SWS_CanNm_00203
- - SWS_CanNm_00206
- - SWS_CanNm_00208
- - SWS_CanNm_00211
- - SWS_CanNm_00214
- - SWS_CanNm_00215
- - SWS_CanNm_00216
- - SWS_CanNm_00217
- - SWS_CanNm_00219
- - SWS_CanNm_00220
- - SWS_CanNm_00221
- - SWS_CanNm_00222
- - SWS_CanNm_00223
- - SWS_CanNm_00224
- - SWS_CanNm_00227
- - SWS_CanNm_00228
- - SWS_CanNm_00231
- - SWS_CanNm_00234
- - SWS_CanNm_00237
- - SWS_CanNm_00238
- - SWS_CanNm_00245
- - SWS_CanNm_00246
- - SWS_CanNm_00247
- - SWS_CanNm_00248
- - SWS_CanNm_00249
- - SWS_CanNm_00250
- - SWS_CanNm_00251
- - SWS_CanNm_00252
- - SWS_CanNm_00253
- - SWS_CanNm_00254
- - SWS_CanNm_00255
- - SWS_CanNm_00256
- - SWS_CanNm_00257
- - SWS_CanNm_00259
- - SWS_CanNm_00260
- - SWS_CanNm_00261
- - SWS_CanNm_00262
- - SWS_CanNm_00263
- - SWS_CanNm_00264
- - SWS_CanNm_00265
- - SWS_CanNm_00266
- - SWS_CanNm_00267
- - SWS_CanNm_00268
- - SWS_CanNm_00269
- - SWS_CanNm_00270
- - SWS_CanNm_00271
- - SWS_CanNm_00272
- - SWS_CanNm_00273
- - SWS_CanNm_00274
- - SWS_CanNm_00275
- - SWS_CanNm_00276
- - SWS_CanNm_00277
- - SWS_CanNm_00279
- - SWS_CanNm_00281
- - SWS_CanNm_00282
- - SWS_CanNm_00283
- - SWS_CanNm_00284
- - SWS_CanNm_00285
- - SWS_CanNm_00295
- - SWS_CanNm_00297
- - SWS_CanNm_00298
- - SWS_CanNm_00314
- - SWS_CanNm_00315
- - SWS_CanNm_00316
- - SWS_CanNm_00324
- - SWS_CanNm_00325
- - SWS_CanNm_00327
- - SWS_CanNm_00328
- - SWS_CanNm_00329
- - SWS_CanNm_00330
- - SWS_CanNm_00331
- - SWS_CanNm_00332
- - SWS_CanNm_00333
- - SWS_CanNm_00334
- - SWS_CanNm_00335
- - SWS_CanNm_00336
- - SWS_CanNm_00338
- - SWS_CanNm_00339
- - SWS_CanNm_00340
- - SWS_CanNm_00341
- - SWS_CanNm_00342
- - SWS_CanNm_00344
- - SWS_CanNm_00345
- - SWS_CanNm_00346
- - SWS_CanNm_00348
- - SWS_CanNm_00401
- - SWS_CanNm_00402
- - SWS_CanNm_00403
- - SWS_CanNm_00404
- - SWS_CanNm_00405
- - SWS_CanNm_00406
- - SWS_CanNm_00407
- - SWS_CanNm_00408
- - SWS_CanNm_00409
- - SWS_CanNm_00410
- - SWS_CanNm_00411
- - SWS_CanNm_00412
- - SWS_CanNm_00413
- - SWS_CanNm_00414
- - SWS_CanNm_00415
- - SWS_CanNm_00416
- - SWS_CanNm_00417
- - SWS_CanNm_00419
- - SWS_CanNm_00420
- - SWS_CanNm_00421
- - SWS_CanNm_00424
- - SWS_CanNm_00426
- - SWS_CanNm_00427
- - SWS_CanNm_00428
- - SWS_CanNm_00429
- - SWS_CanNm_00431
- - SWS_CanNm_00432
- - SWS_CanNm_00435
- - SWS_CanNm_00437
- - SWS_CanNm_00438
- - SWS_CanNm_00439
- - SWS_CanNm_00442
- - SWS_CanNm_00443
- - SWS_CanNm_00444
- - SWS_CanNm_00445
- - SWS_CanNm_00446
- - SWS_CanNm_00447
- - SWS_CanNm_00450
- - SWS_CanNm_00454
SRS_BSW_00005 Modules of the µC Abstraction Layer SWS_CanNm_00999
(MCAL) may not have hard coded
horizontal interfaces
SRS_BSW_00006 The source code of software modules SWS_CanNm_00999
above the µC Abstraction Layer
(MCAL) shall not be processor and
compiler dependent.
SRS_BSW_00010 The memory consumption of all Basic SWS_CanNm_00999
SW Modules shall be documented for
a defined configuration for all
supported platforms.
SRS_BSW_00160 Configuration files of AUTOSAR Basic SWS_CanNm_00999
SW module shall be readable for
human beings
SRS_BSW_00161 The AUTOSAR Basic Software shall SWS_CanNm_00999
provide a microcontroller abstraction
layer which provides a standardized
interface to higher software layers
SRS_BSW_00162 The AUTOSAR Basic Software shall SWS_CanNm_00999
provide a hardware abstraction layer
SRS_BSW_00164 The Implementation of interrupt SWS_CanNm_00999
service routines shall be done by the
Operating System, complex drivers or
modules
SRS_BSW_00168 SW components shall be tested by a SWS_CanNm_00999
function defined in a common API in
the Basis-SW
SRS_BSW_00170 The AUTOSAR SW Components shall SWS_CanNm_00999
provide information about their
dependency from faults, signal
qualities, driver demands
SRS_BSW_00172 The scheduling strategy that is built SWS_CanNm_00999
inside the Basic Software Modules
shall be compatible with the strategy
used in the system
SRS_BSW_00301 All AUTOSAR Basic Software SWS_CanNm_00305,
Modules shall only import the SWS_CanNm_00307,
necessary information SWS_CanNm_00308,
SWS_CanNm_00309,
SWS_CanNm_00312,
SWS_CanNm_00326
20 of 98 Document ID 013: AUTOSAR_SWS_CANNetworkManagement
- AUTOSAR confidential -
Specification of CAN Network Management
AUTOSAR Release 4.2.2
7 Functional specification
The main concept of the AUTOSAR CanNm algorithm can be defined by the
following two key-requirements:
The overall state machine of the AUTOSAR CanNm algorithm can be defined as
follows:
Note: State transitions have to be performed latest within the next main function.
Note: An UML state chart of the AUTOSAR CanNm state machine from point of view
of one single node in the network management cluster can be found in detail in the
API specification chapter 8).
For nodes that are not in passive mode (refer to chapter 7.9.3) the Repeat Message
State ensures, that any transition from Bus-Sleep or Prepare Bus-Sleep to the
Network Mode becomes visible to the other nodes on the network. Additionally it
ensures that any node stays active for a minimum amount of time. It can be used for
detection of present nodes.
[SWS_CanNm_00103] ⌈ When Repeat Message State is left and if the network has
been requested (see SWS_CanNm_00104), the CanNm module shall enter the
Normal Operation State.⌋ ()
[SWS_CanNm_00106] ⌈ When Repeat Message State is left and if the network has
been released (see SWS_CanNm_00105), the CanNm module shall enter the Ready
Sleep State.⌋ ()
The Normal Operation State ensures that any node can keep the network
management cluster awake as long as the network is requested.
The Ready Sleep State ensures that any node in the network management cluster
waits with transition to the Prepare Bus-Sleep Mode as long as any other node keeps
the network management cluster awake.
[SWS_CanNm_00110] ⌈ When the network is requested and the current state is the
Ready Sleep State, the CanNm module shall enter Normal Operation State (refer to
SWS_CanNm_00104).⌋ ()
The purpose of the Prepare Bus-Sleep Mode is to ensure that all nodes have time to
stop their network activity before the Bus-Sleep Mode is entered. In Prepare Bus-
Sleep Mode the bus activity is calmed down (i.e. queued messages are transmitted
in order to make all Tx-buffers empty) and finally there is no activity on the bus in the
Prepare Bus-Sleep Mode.
[SWS_CanNm_00122] ⌈ When the network has been requested in the Prepare Bus-
Sleep Mode and the CanNm module has entered Network Mode and if
CANNM_IMMEDIATE_RESTART_ENABLED (configuration parameter) is set to TRUE, the
CanNm module shall transmit a Network Management PDU.⌋ ()
Rationale: Other nodes in the cluster are still in Prepare Bus-Sleep Mode; in the
exceptional situation described above transition into the Bus-Sleep Mode shall be
avoided and bus-communication shall be restored as fast as possible.
Caused by the transmission offset for Network Management PDUs in CanNm, the
transmission of the first Network Management PDU in Repeat Message State can be
The purpose of the Bus-Sleep Mode is to reduce power consumption in the node
when no messages are to be exchanged. The communication controller is switched
into the sleep mode, respective wakeup mechanisms are activated and finally power
consumption is reduced to the adequate level in the Bus-Sleep Mode.
In the best case only oscillator’s drift should be taken into account for a configurable
amount of time determined by the value CANNM_TIMEOUT_TIME +
CANNM_WAIT_BUS_SLEEP_TIME (both configuration parameters).
Rationale: To avoid race conditions and state inconsistencies between Network and
Mode Management, CanNm will not automatically perform the transition from Bus-
Sleep Mode to Network Mode. CanNm will only inform the upper layers which have
to make the wake-up decision. Network Management PDU reception in Bus-Sleep
29 of 98 Document ID 013: AUTOSAR_SWS_CANNetworkManagement
- AUTOSAR confidential -
Specification of CAN Network Management
AUTOSAR Release 4.2.2
Mode must be handled depending on the current state of the ECU shutdown/startup
process.
Note: In the Prepare Bus-Sleep Mode and Bus-Sleep Mode is assumed that the
network is released, unless bus communication is explicitly requested.
Network states (i.e. ‘requested’ and ‘released’) are two additional states of the
AUTOSAR CanNm state machine that exist in parallel to the state machine. Network
states denote, whether the software components need to communicate on the bus
(the network state is then ‘requested’); or whether the software components don’t
have to communicate on the bus (the bus network state is then ‘released’); note that
if the network is released an ECU may still communicate because some other ECU
still request the network.
7.4 Initialization
Note: The CanNm module should be initialized after CanIf is initialized and before
any other network management service is called.
30 of 98 Document ID 013: AUTOSAR_SWS_CANNetworkManagement
- AUTOSAR confidential -
Specification of CAN Network Management
AUTOSAR Release 4.2.2
[SWS_CanNm_00025] ⌈ During initialization the CanNm module shall set each byte
of the user data to 0xFF.⌋ ()
7.5 Execution
7.5.1 Processor architecture
Note: Setting the CanNmPduCbvPosition to off means that in the NM PDU no space is
occupied by the source node identifier. Hence one more byte is available for user
data.
Note: The length of the Network Management PDU is defined by the PduLength
parameter in the "global" ECUC module ([EcuC003_Conf], see Ecu Configuration
specification). The difference between number of enabled system bytes and length is
the amount of user data bytes.
The figure below describes the format of the Control Bit Vector:
Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0
Reserved
Partial NM Reserved
Active R3.2 NM Repeat
Reserv Network Reserv Coordinator R3.2 NM
CBV Wakeup Coordinat Message
ed Informat ed Sleep Coordinator
Bit or ID Request
ion Bit Ready Bit ID (Low Bit)
(High Bit)
Figure 7-2 Control Bit Vector
Note: The Control Bit Vector is initialized with 0x00 during initialization (also refer to
SWS_CanNm_00085).
[SWS_CanNm_00013] ⌈ The CanNm module shall set the source node identifier
with the configuration parameter CANNM_NODE_ID unless CANNM_PDU_NID_POSITION is
set to off.⌋ ()
Note: The transmission mechanisms described in this chapter are only relevant if the
Network Management PDU transmission ability is enabled.
Note: The transmission mechanisms described in this chapter are only relevant if
CANNM_PASSIVE_MODE_ENABLED is FALSE.
The periodic transmission mode is used in "Repeat Message State" and "Normal
Operation State". Periodic transmission mode with bus load reduction is only
available in "Normal Operation State"
Note: The periodic transmission mode is used in the "Repeat Message State" and
"Normal Operation State" if the bus load reduction mechanism is disabled.
The periodic transmission mode with bus load reduction is only used, in the "Normal
Operation State" if the bus load reduction mechanism is enabled.
Rationale: If the bus access is completely regulated through an offline system design
tool, the actual transmit confirmation by CanIf can be regarded as redundant. Since
the maximum arbitration time is assumed to be known it is acceptable to immediately
raise the confirmation at the transmission request time.
[SWS_CanNm_00334] ⌈ When entering the Repeat Message State from Bus Sleep
Mode or Prepare Bus Sleep Mode because of CanNm_NetworkRequest() (active
wakeup) and if CanNmImmediateNmTransmissions is greater zero, the NM PDUs shall
be transmitted using CanNmImmediateNmCycleTime as cycle time. The transmission of
the first NM PDU shall be triggered as soon as possible. After the transmission the
Message Cycle Timer shall be reloaded with CanNmImmediateNmCycleTime. The
CanNmMsgCycleOffset shall not be applied in this case.⌋ ()
Note: If the function call of CanIf_Transmit fails the Transmission Error handling
described in chapter 7.12 informs the CanNm module.
Note: If a Network Management PDU has been successfully transmitted the function
CanNm_TxConfirmation shall be called by CanIf if CANNM_IMMEDIATE_TXCONF_ENABLED
(configuration parameter) is disabled.
Note: This feature can be used in case of partial network wakeup filter to avoid a
blocking of all messages in case of passive start-up and first message request is not
accepted by CanIf due to CanSM could not enable transmission path fast enough
(e.g. in case of asynchronous transceiver handling).
7.7.2 Reception
If a NM PDU has been successfully received, the CanIf module will call the callback
function CanNm_RxIndication.
nodes which belong to a network management cluster. Without any action this would
lead to a bus load which depends on the amount of members of the network
management cluster. Even if bursts are prevented through a node specific timing
parameter called CANNM_MSG_CYCLE_OFFSET a mechanism is necessary which reduces
the bus load independently of the size of the network management cluster.
The algorithm ensures that the bus load is limited to a maximum two Network
Management PDUs per CANNM_MSG_CYCLE_TIME.
for this network, the CanNm module shall restart the CanNm Message Cycle Timer
with the node specific time CANNM_MSG_REDUCED_TIME.⌋ ()
Note: If user data is configured it will be sent for sure in Repeat Message State. In
Normal Operation State it depends on the configuration of busload reduction whether
user data is sent. In Ready Sleep State user data will not be sent.
Note: The transmission of outdated NM data can be avoided by not stopping the IPdu
in COM used for NmUserData transmission.
In the Passive Mode the node is only receiving Network Management PDUs but not
transmitting any Network Management PDUs.
Note: Passive Mode has to be either enabled or disabled for all NM networks within
one ECU.
Note: This behavior shall also be applied in Repeat Message State. Communication
Control feature does not influence the duration of the Repeat Message State.
When having more than one coordinator connected to the same bus a special bit in
the CBV, the NmCoordinatorSleepReady bit is used to indicate that the main
coordinator requests to start shutdown sequence. The main functionality of the
algorithm is described in the Nm module.
7.10.1 Rx Path
Note: This is required to enable the ECU to identify detail about the sender of the Car
Wakeup request.
Note: The Car Wakeup filter is necessary to realize sub gateways that only consider
the Car Wakeup of the central Gateway to avoid wrong wakeups.
7.10.2 Tx Path
The transmission of the Car Wakeup bit shall be handled by the application using the
NM user data mechanism provided by the CanNm module.
Note: This is required to enable the Gateway to stay awake on any kind of NM-PDU.
Note: The usage of the CBV is mandatory in case Partial Networking is used.
The intention of the NM-PDU filter algorithm is to drop all received NM-PDUs that are
not relevant for the ECU. If there is no NM-PDU on the network, that is relevant for
the receiving ECU, the NM Timeout Timer is no longer restarted and the CanNm
module changes to Prepare Bus Sleep Mode during active bus communication.
In order to distinguish between NM-PDUs that are relevant for the ECU and PDUs
that are not relevant, the CanNm evaluates the NM User Data that contains the PN
requests provided by requesting ECU. Every bit of the PN request information
represents one PN.
It is statically configured if the ECU (CanNm) is part of one specific partial network or
not. The NM-PDUs are ignored if the ECU is not part of the requested partial
networks.
Note: If the NM-PDU filter algorithm is not enabled (e.g. due to malfunctioning PN
transceiver) the CanNm restarts the NM-Timeout Timer when receiving a NM-PDU.
Therefore normal shutdown behavior is performed.
[SWS_CanNm_00415] ⌈ The NM-PDU filter algorithm shall evaluate the bytes of the
received NM-PDU defined by CanNmPnInfoOffset (in bytes) starting from byte 0 and
CanNmPnInfoLength (in bytes). This range is called PN Info Range.⌋ ()
Note: This is required to enable the Gateway to stay awake on any kind of NM-PDU.
Example:
- CanNmPnInfoOffset =4
- CanNmPnInfoLength =2
Only Byte 4 and Byte 5 of the NM PDU contain PN information:
Note: This feature is used by every ECU that has to switch I-PDU-Groups because of
the activity of partial networks. (e.g. to prevent false timeouts) I-PDU-Groups shall be
switched on if the corresponding PN is requested internally or externally. I-PDU-
Groups shall be switched off not until all internal and external requests for the
corresponding PN are released.
The logic for switching the IPDU-Groups is implemented by ComM. The CanNm only
provides the information if a PN is requested or not. The COM module is used to
transfer the data to the upper layers.
To switch the I-PDU-Groups synchronously on all direct connected ECUs, CanNm
shall provide the information of a request change to the upper layer at (almost) the
same time on every ECU. This is why the reset timer is restarted on every received
and every sent NM PDU (see below).
The aggregated state of the internal/external requested PNs is called External
Internal Request Array (EIRA).
[SWS_CanNm_00426] ⌈ If
CanNmPnEiraCalcEnabled is TRUE
and a NM-PDU is received
and PNs are requested within this message (bits set to 1)
and the requested PNs are set to 1 within the configured PN filter mask
then CanNm shall store the request information (value 1) for these PNs.⌋ ()
[SWS_CanNm_00427] ⌈ If
CanNmPnEiraCalcEnabled is TRUE
and NM-PDU is beeing requested to send by CanNm
and PNs are requested within this message (bits set to 1)
and the requested PNs are set to 1 within the configured PN filter mask
then CanNm shall store the request information (value 1) for these PNs.⌋ ()
Note: This means, only one timer is required to handle one PN 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 networks.
This is possible because the switch of PN PDU-Groups is done global for the ECU
and not dependent of the physical channel.
Note: This feature is used by the Gateways to collect only the external PN requests.
The external PN requests are mirrored back to the requesting bus and provided to
other (required) physical channels of a central gateway. In case of a sub gateway the
requests bit must not be mirrored back to the requesting physical channel in order to
avoid static waking between central- and sub gateways. This logic shall be
implemented by the ComM. The CanNm module provides the information if the PN is
externally requested or not. The COM module is used for data transmission to the
upper layer.
The aggregated state of the external requested PNs is called “External Request
Array” (ERA).
[SWS_CanNm_00437] ⌈ If
CanNmPnEraCalcEnabled is TRUE
and a NM-PDU is received
and PNs are requested within this message (bits set to 1)
and the requested PNs are set to 1 within the configured PN filter mask
then CanNm shall store the request information (value 1) for these PNs. ⌋ ()
Note: This means, a separate timer is required to handle one PN on multiple physical
channels.
For example: 48 ERA reset timers are required to handle the requests of a gateway
with 6 physical channels and 8 partial networks. It is not possible to combine the
reset timer like EIRA timers, because the external request mustn’t be mirrored back
to the requesting bus by a sub gateway. Thus it is required to detect the physical
channel that is the source of the request bit.
Depending on configuration the CanNm will evaluate the confirmation from the CanIf
that a Network Management PDU has been successfully transmitted. Transmission
Error Handling is a functionality that will monitor these confirmations and alarm the
upper layers if a transmission confirmation is not received within a specific amount of
time. The functionality works by restarting a timer after each request to transmit a
Network Management PDU and if a confirmation has not been received before the
timer expires, a callback of the Nm is invoked.
[SWS_CanNm_00316]⌈
Type or error Relevance Related error code Error Value
API service used without module Development CANNM_E_NO_INIT 0x01
initialization
API service called with wrong Development CANNM_E_INVALID_CHANNEL 0x02
channel handle
API service called with wrong PDU- Development CANNM_E_INVALID_PDUID 0x03
ID
Reception of NM PDUs in Bus- Development CANNM_E_NET_START_IND 0x04
Sleep Mode.
CanNm initialization has failed, e.g. Development CANNM_E_INIT_FAILED 0x05
selected configuration set doesn’t
exist.
NM-Timeout Timer has abnormally Development CANNM_E_NETWORK_TIMEOUT 0x11
expired outside of the Ready Sleep
State; it may happen:
(1) because of Bus-Off state, (2) if
some ECU requests bus
communication or node detection
shortly before the NM-Timeout
Timer expires so that a Network
Management PDU can not be
transmitted in time; this race
condition applies to event-triggered
systems
Null pointer has been passed as an Development CANNM_E_PARAM_POINTER 0x12
argument
⌋ ()
Note: Currently no production errors are specified for the CAN NM.
Note: The network handle is invalid if it is different from allowed configured values.
Note: Since the shutdown of CanNm can be done at any time, the call of the API
Nm_SynchronizationPoint is not supported.
For details refer to the chapter 7.1.17 “Debugging support” in SWS_BSWGeneral [9].
8 API specification
AUTOSAR CanNm API consists of services, which are CAN specific and can be
called whenever they are required; each service apart from CanNm_Init refers to one
NM channel only.
[SWS_CanNm_00245] ⌈
Module Imported Type
ComStack_Types NetworkHandleType
PduIdType
PduInfoType
Nm Nm_ModeType
Nm_StateType
Std_Types Std_ReturnType
Std_VersionInfoType
⌋ ()
For further details of these types refer to the according specifications [4], [6] and [8].
[SWS_CanNm_00208] ⌈
Service name: CanNm_Init
Syntax: void CanNm_Init(
const CanNm_ConfigType* cannmConfigPtr
)
Service ID[hex]: 0x00
Sync/Async: Synchronous
Reentrancy: Non Reentrant
Parameters (in): cannmConfigPtr Pointer to a selected configuration structure
Parameters None
(inout):
Parameters (out): None
Return value: None
Description: Initialize the CanNm module.
⌋ ()
8.3.2 CanNm_PassiveStartUp
[SWS_CanNm_00211] ⌈
8.3.3 CanNm_NetworkRequest
[SWS_CanNm_00213]
Service name: CanNm_NetworkRequest
Syntax: Std_ReturnType CanNm_NetworkRequest(
NetworkHandleType nmChannelHandle
)
Service ID[hex]: 0x02
Sync/Async: Asynchronous
Reentrancy: Reentrant (but not for the same NM-channel)
Parameters (in): nmChannelHandle Identification of the NM-channel
Parameters None
(inout):
Parameters (out): None
Std_ReturnType E_OK: No error
Return value:
E_NOT_OK: Requesting of network has failed
Description: Request the network, since ECU needs to communicate on the bus.
⌋ ()
8.3.4 CanNm_NetworkRelease
[SWS_CanNm_00214] ⌈
Service name: CanNm_NetworkRelease
Syntax: Std_ReturnType CanNm_NetworkRelease(
NetworkHandleType nmChannelHandle
)
Service ID[hex]: 0x03
Sync/Async: Asynchronous
Reentrancy: Reentrant (but not for the same NM-Channel)
Parameters (in): nmChannelHandle Identification of the NM-channel
Parameters None
(inout):
Parameters (out): None
Std_ReturnType E_OK: No error
Return value:
E_NOT_OK: Releasing of network has failed
Description: Release the network, since ECU doesn't have to communicate on the bus.
⌋ ()
[SWS_CanNm_00215] ⌈
Service name: CanNm_DisableCommunication
Syntax: Std_ReturnType CanNm_DisableCommunication(
NetworkHandleType nmChannelHandle
)
Service ID[hex]: 0x0c
Sync/Async: Asynchronous
Reentrancy: Reentrant (but not for the same NM-channel)
Parameters (in): nmChannelHandle Identification of the NM-channel
Parameters None
(inout):
Parameters (out): None
Std_ReturnType E_OK: No error
Return value: E_NOT_OK: Disabling of NM PDU transmission ability has
failed
Description: Disable the NM PDU transmission ability due to a ISO14229 Communication
Control (28hex) service
⌋ ()
8.3.6 CanNm_EnableCommunication
[SWS_CanNm_00216] ⌈
Service name: CanNm_EnableCommunication
Syntax: Std_ReturnType CanNm_EnableCommunication(
NetworkHandleType nmChannelHandle
)
Service ID[hex]: 0x0d
Sync/Async: Asynchronous
Reentrancy: Reentrant (but not for the same NM-channel)
Parameters (in): nmChannelHandle Identification of the NM-channel
Parameters None
(inout):
Parameters (out): None
Return value: Std_ReturnType E_OK: No error
56 of 98 Document ID 013: AUTOSAR_SWS_CANNetworkManagement
- AUTOSAR confidential -
Specification of CAN Network Management
AUTOSAR Release 4.2.2
8.3.7 CanNm_SetUserData
[SWS_CanNm_00217] ⌈
Service name: CanNm_SetUserData
Syntax: Std_ReturnType CanNm_SetUserData(
NetworkHandleType nmChannelHandle,
const uint8* nmUserDataPtr
)
Service ID[hex]: 0x04
Sync/Async: Synchronous
Reentrancy: Reentrant (but not for the same NM-channel)
nmChannelHandle Identification of the NM-channel
Parameters (in): nmUserDataPtr Pointer where the user data for the next transmitted NM PDU
shall be copied from
Parameters None
(inout):
Parameters (out): None
Std_ReturnType E_OK: No error
Return value:
E_NOT_OK: Setting of user data has failed
Description: Set user data for NM PDUs transmitted next on the bus.
⌋ ()
8.3.8 CanNm_GetUserData
[SWS_CanNm_00218]
Service name: CanNm_GetUserData
Syntax: Std_ReturnType CanNm_GetUserData(
NetworkHandleType nmChannelHandle,
uint8* nmUserDataPtr
)
Service ID[hex]: 0x05
Sync/Async: Synchronous
Reentrancy: Reentrant
Parameters (in): nmChannelHandle Identification of the NM-channel
Parameters None
(inout):
nmUserDataPtr Pointer where user data out of the most recently received NM
Parameters (out):
PDU shall be copied to
Std_ReturnType E_OK: No error
Return value:
E_NOT_OK: Getting of user data has failed
Description: Get user data out of the most recently received NM PDU.
⌋ ()
8.3.9 CanNm_Transmit
[SWS_CanNm_00331] ⌈
Service name: CanNm_Transmit
Syntax: Std_ReturnType CanNm_Transmit(
PduIdType CanNmTxPduId,
const PduInfoType* PduInfoPtr
)
Service ID[hex]: 0x14
Sync/Async: Synchronous
Reentrancy: Reentrant
CanNmTxPduId Handle of the CanNm user data PDU.
Parameters (in): PduInfoPtr Pointer to a structure containing the pointer to the NM user data
buffer and the related DLC.
Parameters None
(inout):
Parameters (out): None
Std_ReturnType E_OK: Transmit request has been accepted
Return value:
E_NOT_OK: Transmit request has not been accepted (CanNm is
8.3.10 CanNm_GetNodeIdentifier
[SWS_CanNm_00219] ⌈
Service name: CanNm_GetNodeIdentifier
Syntax: Std_ReturnType CanNm_GetNodeIdentifier(
NetworkHandleType nmChannelHandle,
uint8* nmNodeIdPtr
)
Service ID[hex]: 0x06
Sync/Async: Synchronous
Reentrancy: Reentrant
Parameters (in): nmChannelHandle Identification of the NM-channel
Parameters None
(inout):
nmNodeIdPtr Pointer where node identifier out of the most recently received
Parameters (out):
NM PDU shall be copied to
Std_ReturnType E_OK: No error
Return value: E_NOT_OK: Getting of the node identifier out of the most
recently received NM PDU has failed
Description: Get node identifier out of the most recently received NM PDU.
⌋ ()
8.3.11 CanNm_GetLocalNodeIdentifier
[SWS_CanNm_00220] ⌈
Service name: CanNm_GetLocalNodeIdentifier
Syntax: Std_ReturnType CanNm_GetLocalNodeIdentifier(
NetworkHandleType nmChannelHandle,
59 of 98 Document ID 013: AUTOSAR_SWS_CANNetworkManagement
- AUTOSAR confidential -
Specification of CAN Network Management
AUTOSAR Release 4.2.2
uint8* nmNodeIdPtr
)
Service ID[hex]: 0x07
Sync/Async: Synchronous
Reentrancy: Reentrant
Parameters (in): nmChannelHandle Identification of the NM-channel
Parameters None
(inout):
nmNodeIdPtr Pointer where node identifier of the local node shall be copied
Parameters (out):
to
Std_ReturnType E_OK: No error
Return value: E_NOT_OK: Getting of the node identifier of the local node has
failed
Description: Get node identifier configured for the local node.
⌋ ()
8.3.12 CanNm_RepeatMessageRequest
[SWS_CanNm_00221] ⌈
Service name: CanNm_RepeatMessageRequest
Syntax: Std_ReturnType CanNm_RepeatMessageRequest(
NetworkHandleType nmChannelHandle
)
Service ID[hex]: 0x08
Sync/Async: Asynchronous
Reentrancy: Reentrant (but not for the same NM-channel)
Parameters (in): nmChannelHandle Identification of the NM-channel
Parameters None
(inout):
Parameters (out): None
Std_ReturnType E_OK: No error
Return value:
E_NOT_OK: Setting of Repeat Message Request Bit has failed
Description: Set Repeat Message Request Bit for NM PDUs transmitted next on the bus.
⌋ ()
8.3.13 CanNm_GetPduData
[SWS_CanNm_00222] ⌈
Service name: CanNm_GetPduData
Syntax: Std_ReturnType CanNm_GetPduData(
NetworkHandleType nmChannelHandle,
uint8* nmPduDataPtr
)
Service ID[hex]: 0x0a
Sync/Async: Synchronous
Reentrancy: Reentrant
Parameters (in): nmChannelHandle Identification of the NM-channel
Parameters None
(inout):
Parameters (out): nmPduDataPtr Pointer where NM PDU shall be copied to
Std_ReturnType E_OK: No error
Return value:
E_NOT_OK:Getting of NM PDU data has failed
Description: Get the whole PDU data out of the most recently received NM PDU.
⌋ ()
8.3.14 CanNm_GetState
[SWS_CanNm_00223] ⌈
Service name: CanNm_GetState
Syntax: Std_ReturnType CanNm_GetState(
NetworkHandleType nmChannelHandle,
Nm_StateType* nmStatePtr,
Nm_ModeType* nmModePtr
)
Service ID[hex]: 0x0b
Sync/Async: Synchronous
Reentrancy: Reentrant
Parameters (in): nmChannelHandle Identification of the NM-channel
Parameters None
(inout):
nmStatePtr Pointer where state of the network management shall be
copied to
Parameters (out):
nmModePtr Pointer where the mode of the network management shall be
copied to
Std_ReturnType E_OK: No error
Return value:
E_NOT_OK: Getting of NM state has failed
Description: Returns the state and the mode of the network management.
⌋ ()
8.3.15 CanNm_GetVersionInfo
[SWS_CanNm_00224] ⌈
Service name: CanNm_GetVersionInfo
Syntax: void CanNm_GetVersionInfo(
Std_VersionInfoType* versioninfo
)
Service ID[hex]: 0xf1
Sync/Async: Synchronous
Reentrancy: Reentrant
Parameters (in): None
Parameters None
(inout):
Parameters (out): versioninfo Pointer to where to store the version information of this module
Return value: None
Description: This service returns the version information of this module.
⌋ ()
8.3.16 CanNm_RequestBusSynchronization
[SWS_CanNm_00226] ⌈
Service name: CanNm_RequestBusSynchronization
Syntax: Std_ReturnType CanNm_RequestBusSynchronization(
NetworkHandleType nmChannelHandle
)
Service ID[hex]: 0xc0
Sync/Async: Synchronous
Reentrancy: Non Reentrant
Parameters (in): nmChannelHandle Identification of the NM-channel
Parameters None
(inout):
Parameters (out): None
Std_ReturnType E_OK: No error
Return value:
E_NOT_OK: Requesting of bus synchronization has failed
Description: Request bus synchronization.
⌋ (SRS_Nm_02516)
Rationale: This service is typically used for supporting the NM gateway extensions.
8.3.17 CanNm_CheckRemoteSleepIndication
[SWS_CanNm_00227] ⌈
Service name: CanNm_CheckRemoteSleepIndication
Syntax: Std_ReturnType CanNm_CheckRemoteSleepIndication(
NetworkHandleType nmChannelHandle,
boolean* nmRemoteSleepIndPtr
)
Service ID[hex]: 0xd0
Sync/Async: Synchronous
Reentrancy: Reentrant
Parameters (in): nmChannelHandle Identification of the NM-channel
Parameters None
(inout):
nmRemoteSleepIndPtr Pointer where check result of remote sleep indication shall
Parameters (out):
be copied to
Std_ReturnType E_OK: No error
Return value: E_NOT_OK: Checking of remote sleep indication bits has
failed
Description: Check if remote sleep indication takes place or not.
⌋ ()
8.3.18 CanNm_SetSleepReadyBit
[SWS_CanNm_00338] ⌈
Service name: CanNm_SetSleepReadyBit
Syntax: Std_ReturnType CanNm_SetSleepReadyBit(
NetworkHandleType nmChannelHandle,
boolean nmSleepReadyBit
)
Service ID[hex]: 0x17
Sync/Async: Synchronous
Reentrancy: Reentrant (but not for the same NM-channel)
nmChannelHandle Identification of the NM-channel
Parameters (in):
nmSleepReadyBit Value written to ReadySleep Bit in CBV
Parameters None
(inout):
Parameters (out): None
Std_ReturnType E_OK: No error
Return value:
E_NOT_OK: Writing of remote sleep indication bit has failed
Description: Set the NM Coordinator Sleep Ready bit in the Control Bit Vector
⌋ ()
[SWS_CanNm_00228] ⌈
Service name: CanNm_TxConfirmation
Syntax: void CanNm_TxConfirmation(
PduIdType TxPduId
)
Service ID[hex]: 0x40
Sync/Async: Synchronous
Reentrancy: Reentrant for different PduIds. Non reentrant for the same PduId.
Parameters (in): TxPduId ID of the I-PDU that has been transmitted.
Parameters None
(inout):
Parameters (out): None
Return value: None
Description: The lower layer communication interface module confirms the transmission of an I-
PDU.
⌋ ()
64 of 98 Document ID 013: AUTOSAR_SWS_CANNetworkManagement
- AUTOSAR confidential -
Specification of CAN Network Management
AUTOSAR Release 4.2.2
8.4.2 CanNm_RxIndication
[SWS_CanNm_00231] ⌈
Service name: CanNm_RxIndication
Syntax: void CanNm_RxIndication(
PduIdType RxPduId,
const PduInfoType* PduInfoPtr
)
Service ID[hex]: 0x42
Sync/Async: Synchronous
Reentrancy: Reentrant for different PduIds. Non reentrant for the same PduId.
RxPduId ID of the received I-PDU.
Parameters (in): PduInfoPtr Contains the length (SduLength) of the received I-PDU and a pointer to
a buffer (SduDataPtr) containing the I-PDU.
Parameters None
(inout):
Parameters (out): None
Return value: None
Description: Indication of a received I-PDU from a lower layer communication interface module.
⌋ ()
Note: The callback function CanNm_RxIndication called by the CAN Interface and
implemented by the CanNm module. It is called in case of a receive indication event
of the CAN Driver.
[SWS_CanNm_00344] ⌈
65 of 98 Document ID 013: AUTOSAR_SWS_CANNetworkManagement
- AUTOSAR confidential -
Specification of CAN Network Management
AUTOSAR Release 4.2.2
[SWS_CanNm_00234] ⌈
Service name: CanNm_MainFunction
Syntax: void CanNm_MainFunction(
void
)
Service ID[hex]: 0x13
Description: Main function of the CanNm which processes the algorithm describes in that
document.
⌋ ()
This chapter defines all interfaces which are required to fulfill the core functionality of
the module.
[SWS_CanNm_00324] ⌈
API function Description
Nm_BusSleepMode Notification that the network management has entered Bus-Sleep Mode.
Nm_NetworkMode Notification that the network management has entered Network Mode.
Nm_NetworkStartIndication Notification that a NM-message has been received in the Bus-Sleep
Mode, what indicates that some nodes in the network have already
entered the Network Mode.
Nm_PrepareBusSleepMode Notification that the network management has entered Prepare Bus-
Sleep Mode.
⌋ ()
This chapter defines all interfaces which are required to fulfill an optional functionality
of the module.
[SWS_CanNm_00325] ⌈
API function Description
CanIf_Transmit This service initiates a request for transmission of the CAN L-
PDU specified by the CanTxSduId and CAN related data in the
L-SDU structure.
CanSM_TxTimeoutException This function shall notify the CanSM module, that the CanNm
has detected for the affected partial CAN network a tx timeout
exception, which shall be recovered within the respective
network state machine of the CanSM module.
Det_ReportError Service to report development errors.
Nm_CarWakeUpIndication This function is called by a <Bus>Nm to indicate reception of a
CWU request.
Nm_CoordReadyToSleepCancellation Cancels an indication, when the NM Coordinator Sleep Ready
bit in the Control Bit Vector is set back to 0.
Nm_CoordReadyToSleepIndication Sets an indication, when the NM Coordinator Sleep Ready bit in
the Control Bit Vector is set
Nm_PduRxIndication Notification that a NM message has been received.
Nm_RemoteSleepCancellation Notification that the network management has detected that not
all other nodes on the network are longer ready to enter Bus-
Sleep Mode.
Nm_RemoteSleepIndication Notification that the network management has detected that all
other nodes on the network are ready to enter Bus-Sleep Mode.
Nm_RepeatMessageIndication Service to indicate that an NM message with set Repeat
Message Request Bit has been received.
Nm_StateChangeNotification Notification that the state of the lower layer <BusNm> has
changed.
Nm_TxTimeoutException Service to indicate that an attempt to send an NM message
failed.
PduR_CanNmRxIndication Indication of a received I-PDU from a lower layer communication
interface module.
PduR_CanNmTriggerTransmit Within this API, the upper layer module (called module) shall
check whether the available data fits into the buffer size reported
by PduInfoPtr->SduLength.
If it fits, it shall copy its data into the buffer provided by
PduInfoPtr->SduDataPtr and update the length of the actual
copied data in PduInfoPtr->SduLength.
If not, it returns E_NOT_OK without changing PduInfoPtr.
PduR_CanNmTxConfirmation The lower layer communication interface module confirms the
67 of 98 Document ID 013: AUTOSAR_SWS_CANNetworkManagement
- AUTOSAR confidential -
Specification of CAN Network Management
AUTOSAR Release 4.2.2
transmission of an I-PDU.
⌋ ()
Not applicable
Not applicable
CanNm_Init()
PowerOn /Initialization PowerOff
of CanNm
PowerOff
Bus-Sleep Mode Wait Bus-Sleep Timer has Prepare Bus-Sleep Mode
expired
/ Nm_BusSleepMode();
CanNm_RxIndication();
CanNm_PassiveStartup();
CanNm_RxIndication(); CanNm_NetworkRequest();
CanNm_PassiveStartUp();
/Nm_NetworkStartIndication(); Network
Mode
CanNm_NetworkRequest();
/ Start NM-Timeout Timer;
Start Repeat Message Timer;
Nm_NetworkMode(); NM-Timeout Timer has
CanNm_RxIndication(); CanNm_TxConfirmation(); expired
/ Start NM-Timeout / Start NM-Timeout / Start NM-Timeout Timer; / Start Wait Bus-Sleep Timer;
Timer; Timer; Start Repeat Message Timer; Nm_PrepareBusSleepMode();
Nm_NetworkMode();
Repeat Message
Timer has
expired;
CanNm_NetworkRelease();
9 Sequence diagrams
TimerExpired()
CanIf_Transmit()
StartTimer(CANNM_MSG_CYCLE_TIME)
StartTimer(CANNM_MSG_TIMEOUT_TIME)
CanNm_TxConfirmation(PduIdType)
StopTimer()
CanNm_TxConfirmation()
CanNm_RxIndication(PduIdType, PduInfoType*)
opt CANNM_BUS_LOAD_REDUCTION_ENABLED = ON
StartTimer(CANNM_MSG_TIMEOUT_TIME)
StartTimer(CANNM_MSG_REDUCED_TIME)
CanNm_RxIndication()
9.3 Nm Coordination
«module» «module» «module» «module» «module» «module»
ComM Nm FrNm CanNm FrSm CanSM
Nm_NetworkRelease(Std_ReturnType,
NetworkHandleType)
Nm_RemoteSleepIndication(NetworkHandleType)
The NM Coordinator ECU
"ready to sleep" but cluster
Nm_RemoteSleepIndication(NetworkHandleType)
to be coordinated is not.
Thus NM must not "release
bus communication" yet.
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()
FrSM_RequestComMode(ComM_ModeType,
NetworkHandleType)
[CAN]
Shutdown timer
expires()
CanNm_RequestBusSynchronization(Std_ReturnType,
NetworkHandleType)
CanNm_NetworkRelease(Std_ReturnType,
NetworkHandleType)
Network Mode
Ready Sleep
Timer
expires()
Nm_PrepareBusSleepMode(NetworkHandleType)
Silent Communication
CanSM_RequestComMode(Std_ReturnType,
NetworkHandleType, ComM_ModeType)
Timer
expires()
Nm_BusSleepMode(NetworkHandleType)
ComM_Nm_BusSleepMode(NetworkHandleType)
Bus-Sleep Mode
No Communication
CanSM_RequestComMode(Std_ReturnType,
NetworkHandleType, ComM_ModeType)
10 Configuration specification
In general, this chapter defines configuration parameters and their clustering into
containers. In order to support the specification chapter 10.1 describes fundamentals.
It also specifies a template (table) you shall use for the parameter specification. We
intend to leave chapter 10.1 in the specification to guarantee comprehension.
Chapter 10.2 specifies the structure (containers) and the parameters of the module
CanNm.
The configuration parameters as defined in this chapter are used to create a data
model for an AUTOSAR tool chain. The realization in the code is implementation
specific.
The configuration parameters as defined in this chapter are used to create a data
model for an AUTOSAR tool chain. The realization in the code is implementation
specific.
The configuration parameters are divided in parameters which are used to enable
features, parameters which affect all channels of the CanNm and parameters which
affect the respective channels of the CanNm.
10.2.1 Variants
CanNmGlobalConfig : +parameter
EcucParamConfContainerDef CanNmDevErrorDetect :EcucBooleanParamDef
+parameter
CanNmVersionInfoApi :EcucBooleanParamDef
+parameter CanNmUserDataEnabled :
EcucBooleanParamDef
+parameter CanNmRemoteSleepIndEnabled :
EcucBooleanParamDef
+parameter CanNmBusSynchronizationEnabled :
EcucBooleanParamDef
+parameter CanNmNodeDetectionEnabled :
EcucBooleanParamDef
+parameter CanNmBusLoadReductionEnabled :
EcucBooleanParamDef
+parameter CanNmImmediateRestartEnabled :
EcucBooleanParamDef
+parameter CanNmPassiveModeEnabled :
EcucBooleanParamDef
+parameter CanNmPduRxIndicationEnabled :
EcucBooleanParamDef
+parameter CanNmStateChangeIndEnabled :
EcucBooleanParamDef
+parameter CanNmComControlEnabled :
EcucBooleanParamDef
+parameter CanNmImmediateTxconfEnabled :
EcucBooleanParamDef
+parameter CanNmRepeatMsgIndEnabled :
EcucBooleanParamDef
+parameter CanNmComUserDataSupport :
EcucBooleanParamDef
CanNmChannelConfig :
EcucParamConfContainerDef
+subContainer
upperMultiplicity = *
lowerMultiplicity = 1
CanNmMainFunctionPeriod :
+parameter EcucFloatParamDef
max = 0.255
min = 0.001
+parameter CanNmCoordinatorSyncSupport :
EcucBooleanParamDef
+parameter CanNmNodeIdEnabled :
EcucBooleanParamDef
10.3.2 CanNm
Module Name CanNm
Module Description Configuration Parameters for the Can Nm module.
Post-Build Variant Support true
Included Containers
Container Name Multiplicity Scope / Dependency
This container contains the global configuration parameter of
the CanNm. The parameters and the parameters of the sub
CanNmGlobalConfig 1 containers shall be mapped to the C data type
CanNm_ConfigType (for parameters where it is possible)
which is passed to the CanNm_Init function.
10.3.3 CanNmGlobalConfig
SWS Item ECUC_CanNm_00001 :
Container Name CanNmGlobalConfig
This container contains the global configuration parameter of the CanNm.
The parameters and the parameters of the sub containers shall be mapped
Description
to the C data type CanNm_ConfigType (for parameters where it is
possible) which is passed to the CanNm_Init function.
Configuration Parameters
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 --
76 of 98 Document ID 013: AUTOSAR_SWS_CANNetworkManagement
- AUTOSAR confidential -
Specification of CAN Network Management
AUTOSAR Release 4.2.2
Post-build time --
Value Configuration Class Pre-compile time X All Variants
Link time --
Post-build time --
Scope / Dependency scope: local
dependency: only available if CanNmPnEnabled == true for at least one
CanNm Channel
BUILD
Post-build time --
Value Configuration Class Pre-compile time X VARIANT-PRE-COMPILE
Link time X VARIANT-LINK-TIME, VARIANT-POST-
BUILD
Post-build time --
Scope / Dependency scope: local
dependency: only available if CanNmPnEiraCalcEnabled == true. only
valid if CanNmPnEnabled == true for at least one CanNm Channel
Included Containers
Container Name Multiplicity Scope / Dependency
This container contains the channel specific configuration
CanNmChannelConfig 1..*
parameter of the CanNm.
CanNmPnInfo 0..1 PN information configuration
CanNmTxPduRef :
CanNmChannelConfig : EcucReferenceDef
CanNmTxPdu : Pdu :
EcucParamConfContainerDef +reference +destination
EcucParamConfContainerDef EcucParamConfContainerDef
lowerMultiplicity = 1
upperMultiplicity = * upperMultiplicity = 1
+subContainer lowerMultiplicity = 0 lowerMultiplicity = 0
lowerMultiplicity = 1
upperMultiplicity = 1 upperMultiplicity = *
CanNmTxConfirmationPduId :
+parameter EcucIntegerParamDef
min = 0
max = 65535
symbolicNameValue = true
CanNmRxPdu : CanNmRxPduRef :
EcucParamConfContainerDef +reference EcucReferenceDef +destination
+parameter CanNmRxPduId :
EcucIntegerParamDef
min = 0
max = 65535
symbolicNameValue = true
CanNmUserDataTxPdu :
EcucParamConfContainerDef CanNmTxUserDataPduRef :
+reference EcucReferenceDef +destination
+subContainer lowerMultiplicity = 0
upperMultiplicity = 1 lowerMultiplicity = 1
upperMultiplicity = 1
(from EcucPdu)
+parameter CanNmTxUserDataPduId :
EcucIntegerParamDef
min = 0
max = 65535
symbolicNameValue = true
CanNmComMNetworkHandleRef : ComMChannel :
+reference +destination EcucParamConfContainerDef
EcucSymbolicNameReferenceDef
lowerMultiplicity = 1
upperMultiplicity = 256
(from ComM)
10.3.5 CanNmChannelConfig
SWS Item ECUC_CanNm_00017 :
Container Name CanNmChannelConfig
This container contains the channel specific configuration parameter of the
Description
CanNm.
Post-Build Variant
false
Multiplicity
Multiplicity Configuration Pre-compile time X VARIANT-PRE-COMPILE, VARIANT-
Class LINK-TIME, VARIANT-POST-BUILD
Link time --
Post-build time --
Configuration Parameters
BUILD
Post-build time --
Scope / Dependency scope: local
dependency: only available if CanNmCarWakeUpRxEnabled == TRUE
CanNmCarWakeupBytePosition ≥ number of enabled system bytes (CBV,
NID)
Description Time offset in the periodic transmission node. It determines the start delay
of the transmission. Specified in seconds.
Multiplicity 1
Type EcucFloatParamDef
Range 0 .. 65.535
Default value --
Post-Build Variant Value false
Value Configuration Class Pre-compile time X VARIANT-PRE-COMPILE
Link time X VARIANT-LINK-TIME, VARIANT-POST-
BUILD
Post-build time --
Scope / Dependency scope: local
dependency: Parameter value < CanMsgCycleTime
This parameter is only valid if CanNmPassiveModeEnabled is False.
It denotes the time in seconds how long the NM shall stay in the Ready
Sleep State before transition into the Prepare Bus-Sleep Mode is initiated.
Multiplicity 1
Type EcucFloatParamDef
Range 0.002 .. 65.535
Default value --
Post-Build Variant Value false
Value Configuration Class Pre-compile time X VARIANT-PRE-COMPILE
Link time X VARIANT-LINK-TIME, VARIANT-POST-
BUILD
Post-build time --
Scope / Dependency scope: local
dependency: CanNmTimeoutTime > CanNmMsgCycleTime
Included Containers
Container Name Multiplicity Scope / Dependency
This container is used to configure the Rx PDU properties that
CanNmRxPdu 1..*
are used for the CanNm Channel.
This container contains the CanNmTxConfirmationPduId and
CanNmTxPdu 0..1
the CanNmTxPduRef.
This optional container is used to configure the UserNm PDU.
CanNmUserDataTxPdu 0..1 This container is only available if
CanNmComUserDataSupport is enabled.
10.3.6 CanNmRxPdu
SWS Item ECUC_CanNm_00038 :
Container Name CanNmRxPdu
This container is used to configure the Rx PDU properties that are used for
Description
the CanNm Channel.
Configuration Parameters
No Included Containers
10.3.7 CanNmTxPdu
SWS Item ECUC_CanNm_00036 :
Container Name CanNmTxPdu
This container contains the CanNmTxConfirmationPduId and the
Description
CanNmTxPduRef.
Configuration Parameters
No Included Containers
10.3.8 CanNmUserDataTxPdu
SWS Item ECUC_CanNm_00045 :
Container Name CanNmUserDataTxPdu
This optional container is used to configure the UserNm PDU. This
Description
container is only available if CanNmComUserDataSupport is enabled.
Configuration Parameters
Post-build time --
Scope / Dependency scope: ECU
No Included Containers
10.3.9 CanNmPnInfo
SWS Item ECUC_CanNm_00071 :
Container Name CanNmPnInfo
Description PN information configuration
Configuration Parameters
Included Containers
94 of 98 Document ID 013: AUTOSAR_SWS_CANNetworkManagement
- AUTOSAR confidential -
Specification of CAN Network Management
AUTOSAR Release 4.2.2
10.3.10 CanNmPnFilterMaskByte
SWS Item ECUC_CanNm_00069 :
Container Name CanNmPnFilterMaskByte
Description PN information configuration
Configuration Parameters
No Included Containers
11 Examples