Device-to-Device (D2D) capable NR gNodeB network interface. It extends NrNicEnb by swapping in the D2D-capable NR MAC leaf and the D2D-capable eNB PHY, and by enabling the D2D mode controller and mode selection. It is the NR counterpart of LteNicEnbD2D.

The PDCP and RLC entities are missing from the submodules on purpose: the RRC layer's BearerManagement creates them per bearer at run time.

Inheritance diagram

The following diagram shows inheritance relationships for this type. Unresolved types are missing from the diagram.

Extends

Name	Type	Description
NrNicEnb	compound module	The NrNicEnb module serves as a network interface that provides 5G connectivity within a gNodeB. It implements the data and signaling plane of the NR (New Radio) stack, which encompasses the PDCP, RLC, MAC, and PHY layers. The parameters and submodules facilitate the customization of the gNodeB's behavior, including its support for CoMP (Coordinated MultiPoint) or dual connectivity. D2D support is added by the NrNicEnbD2D subtype.

Parameters

Name	Type	Default value	Description
displayStringTextFormat	string	"%a (%i)\n%m"
recordPcap	bool	false
numPcapRecorders	int	recordPcap ? 1 : 0
isWireless	bool	true
interfaceTableModule	string
routingTableModule	string
hasRniSupport	bool	false
nodeType	string
processingDelayIn	double	0s	Additional processing delay for incoming ip packets
processingDelayOut	double	0s	Additional processing delay for outgoing ip packets
channelModelType	string	"D2dChannelModel"
dualConnectivityEnabled	bool	false
numCarriers	int	1
address	string	"auto"
compEnabled	bool	false
hasSdap	bool	false	Whether the stack has an SDAP layer: true on 5GC (Upf) networks, false on EPC/EN-DC ones; the network sets it per its core

Properties

Name	Value	Description
networkInterface
lifecycleSupport
class	NonlayoutingNetworkInterface
display	i=block/ifcard;bgb=800,650;bgl=3

Gates

Name	Direction	Size	Description
upperLayerIn	input
upperLayerOut	output
radioIn	input		To receive messages sent using sendDirect()
nrRadioIn	input		For NR support
x2 [ ]	inout		Optional X2 manager

Signals

Name	Type	Unit	Description
packetDropped	inet::Packet

Statistics

Name	Title	Source	Record	Unit	Interpolation Mode	Description
packetDropInterfaceDown	packet drops: interface down	packetDropReasonIsInterfaceDown(packetDropped)	count, sum(packetBytes), vector(packetBytes)		none
packetDropNoCarrier	packet drops: no carrier	packetDropReasonIsNoCarrier(packetDropped)	count, sum(packetBytes), vector(packetBytes)		none

Unassigned submodule parameters

Name	Type	Default value	Description
pcapRecorder.verbose	bool	true	whether to log packets on the module output
pcapRecorder.pcapFile	string	""	the PCAP file to be written
pcapRecorder.fileFormat	string	"pcapng"
pcapRecorder.snaplen	int	65535	maximum number of bytes to record per packet
pcapRecorder.dumpBadFrames	bool	true	enable dump of frames with hasBitError
pcapRecorder.sendingSignalNames	string	"packetSentToLower"	space-separated list of outbound packet signals to subscribe to
pcapRecorder.receivingSignalNames	string	"packetReceivedFromLower"	space-separated list of inbound packet signals to subscribe to
pcapRecorder.dumpProtocols	string	"ethernetmac ppp ieee80211mac"	space-separated list of protocol names as defined in the Protocol class
pcapRecorder.packetFilter	object	"*"	which packets are considered, matches all packets by default
pcapRecorder.helpers	string	""	usable PcapRecorder::IHelper helpers for accept packettype and store/convert packet as specified linktype currently available: "inet::AckingMacToEthernetPcapRecorderHelper"
pcapRecorder.alwaysFlush	bool	false	flush the pcapFile after each write to ensure that all packets are captured in case of a crash
pcapRecorder.displayStringTextFormat	string	"rec: %n pks"
ip2nic.isNr	bool
rlcMux.bearerManagementModule	string
packetFlowObserver.macModule	string
packetFlowObserver.pdcpModule	string
packetFlowObserver.rlcModule	string
packetFlowObserver.isNrObserver	bool
packetFlowObserver.pfmType	string
pdcpDcMux.binderModule	string	"binder"
pdcpDcMux.bearerManagementModule	string	"^.rrc.bearerManagement"
x2Manager.interfaceTableModule	string
x2Manager.binderModule	string	"binder"
handoverX2Forwarder.losslessHandover	bool	false
handoverX2Forwarder.handoverPacketHolderModule	string	"^.handoverPacketHolder"
sdap.nodeRole	string		Node role: "UE" or "gNB" - determines reflective QoS behavior
sdap.useReflectiveQos	bool		UE only
sdap.reflectiveQosTableModule	string		UE only: path to ReflectiveQosTable module (empty = disabled)

Source code

//
// Device-to-Device (D2D) capable NR gNodeB network interface. It extends
// ~NrNicEnb by swapping in the D2D-capable NR MAC leaf and the D2D-capable eNB
// PHY, and by enabling the D2D mode controller and mode selection. It is the NR
// counterpart of ~LteNicEnbD2D.
//
// The PDCP and RLC entities are missing from the submodules on purpose: the RRC
// layer's ~BearerManagement creates them per bearer at run time.
//
module NrNicEnbD2D extends NrNicEnb
{
    parameters:
        mac.typename = default("NrMacGnbD2D");
        phy.typename = default("PhyEnbD2D");
        ip2nic.typename = default("Ip2NicD2D");
        rlcMux.typename = default("RlcMuxD2D");
        rrc.bearerManagement.lteRlcUmEntityModuleType = default("simu5g.stack.d2d.rlc.LteRlcUmEntityD2D");
        rrc.bearerManagement.nrRlcUmEntityModuleType = default("simu5g.stack.d2d.rlc.NrRlcUmEntityD2D");

        // Use the D2D-capable channel model (matching the NrNicEnb default of
        // TR 38.901 on the gNodeB's channelModel slot)
        channelModelType = default("D2dChannelModel");
        channelModel[*].pathLossType = default("Tr38901");
        rrc.typename = default("RrcD2D");
        rrc.hasD2DModeSelection = true;
}

File: src/simu5g/stack/d2d/NrNicEnbD2D.ned

---

This documentation is released under the Creative Commons license