Defines a User Equipment (UE) network interface card that supports both LTE and NR (New Radio) technologies. It extends the LteNicUe module by adding additional submodules and parameters to support NR-specific functionalities. D2D support is added by the NrNicUeD2D subtype.

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

Usage diagram

The following diagram shows usage relationships between types. Unresolved types are missing from the diagram.

Inheritance diagram

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

Known subclasses

Name	Type	Description
NrNicUeD2D	compound module	Device-to-Device (D2D) capable NR User Equipment network interface. It extends NrNicUe by swapping in the D2D-capable NR MAC/PHY leaves and enabling the D2D mode controller, allowing direct UE-to-UE communication without routing traffic through the gNodeB. It is the NR counterpart of LteNicUeD2D.

Extends

Name	Type	Description
LteNicUe	compound module	The LteNicUe module is a network interface that provides LTE connectivity within a UE (User Equipment). It implements the data and signaling planes of the LTE stack, which includes PDCP, RLC, MAC, and PHY layers. The parameters and submodules allow customization of the UE's behavior.

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	"StochasticChannelModel"
dualConnectivityEnabled	bool	false
numCarriers	int	1
address	string	"auto"
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
useReflectiveQos	bool	false
nrChannelModelType	string	"Tr38901ChannelModel"
numNrCarriers	int	1

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
dlFbGen.isNr	bool	false	True for the NR leg (set by NrNicUe on the nrDlFbGen submodule)
dlFbGen.macNodeId	int		MacNodeId of the stack leg this generator belongs to (set by the NIC)
dlFbGen.feedbackType	string	"ALLBANDS"	Can be ALLBANDS, PREFERRED, WIDEBAND
dlFbGen.rbAllocationType	string	"localized"	Resource allocation type ("distributed" or "localized")
dlFbGen.fbPeriod	int	6tti	Period for Periodic feedback in TTI
dlFbGen.fbDelay	int	1tti	Time interval between sensing and transmission in TTI
dlFbGen.usePeriodic	bool	true	Whether periodic feedback is used in addition to aperiodic feedback
dlFbGen.initialTxMode	string	"SINGLE_ANTENNA_PORT0"	Initial txMode (see LteCommon.h)
dlFbGen.binderModule	string	"binder"
dlFbGen.phyModule	string	"^.phy"
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)
nrRlcMux.bearerManagementModule	string
nrDlFbGen.isNr	bool	false	True for the NR leg (set by NrNicUe on the nrDlFbGen submodule)
nrDlFbGen.macNodeId	int		MacNodeId of the stack leg this generator belongs to (set by the NIC)
nrDlFbGen.feedbackType	string	"ALLBANDS"	Can be ALLBANDS, PREFERRED, WIDEBAND
nrDlFbGen.rbAllocationType	string	"localized"	Resource allocation type ("distributed" or "localized")
nrDlFbGen.fbPeriod	int	6tti	Period for Periodic feedback in TTI
nrDlFbGen.fbDelay	int	1tti	Time interval between sensing and transmission in TTI
nrDlFbGen.usePeriodic	bool	true	Whether periodic feedback is used in addition to aperiodic feedback
nrDlFbGen.initialTxMode	string	"SINGLE_ANTENNA_PORT0"	Initial txMode (see LteCommon.h)
nrDlFbGen.binderModule	string	"binder"
nrPacketFlowObserver.pdcpModule	string
nrPacketFlowObserver.pfmType	string

Source code

//
// Defines a User Equipment (UE) network interface card that
// supports both LTE and NR (New Radio) technologies. It extends the
// LteNicUe module by adding additional submodules and parameters to
// support NR-specific functionalities. D2D support is added by the
// ~NrNicUeD2D subtype.
//
// 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 NrNicUe extends LteNicUe
{
    parameters:
        bool hasSdap = default(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
        bool useReflectiveQos = default(false);
        ip2nic.hasSdap = default(this.hasSdap);
        sdap.nodeRole = default("UE");
        sdap.useReflectiveQos = default(this.useReflectiveQos);
        sdap.reflectiveQosTableModule = default(this.useReflectiveQos ? "^.reflectiveQosTable" : "");
        string nrChannelModelType = default("Tr38901ChannelModel");

        packetFlowObserver.typename = default("PacketFlowObserverUe");

        int numNrCarriers = default(1);

        ip2nic.isNr = default(true);
        rrc.bearerManagement.pdcpEntityModuleType = default("simu5g.stack.pdcp.NrPdcpEntity");

        rrc.hasNrHandoverController = true;
        rrc.nrHandoverController.isNr = true;
        nrMac.isNr = true;
        nrPhy.isNr = true;
        nrDlFbGen.isNr = true;
        // The NR leg's modules take their MacNodeId from the node's NR id
        rrc.nrHandoverController.macNodeId = parent.nrMacNodeId;
        nrMac.macNodeId = parent.nrMacNodeId;
        nrPhy.macNodeId = parent.nrMacNodeId;
        nrDlFbGen.macNodeId = parent.nrMacNodeId;
        rrc.nrHandoverController.otherHandoverControllerModule = "^.handoverController";
        nrPhy.channelModelModule = "^.nrChannelModel[0]";
        nrPhy.feedbackGeneratorModule = "^.nrDlFbGen";
        nrPhy.handoverControllerModule = "^.rrc.nrHandoverController";
        rrc.nrHandoverController.macModule = "^.^.nrMac";
        rrc.nrHandoverController.feedbackGeneratorModule = "^.^.nrDlFbGen";
        rrc.handoverController.otherHandoverControllerModule = "^.nrHandoverController";

    submodules:
        // uplink QoS-flow classification (the TrafficFlowFilter's uplink counterpart),
        // where uplink traffic enters the stack
        qosFlowClassifier: <default("QosFlowClassifier")> like IQosFlowClassifier if hasSdap {
            @display("p=440,120;is=s");
        }
        sdap: <default("NrSdap")> like INrSdap if hasSdap {
            @display("p=230,155");
        }
        reflectiveQosTable: <default("ReflectiveQosTable")> like IReflectiveQosTable if useReflectiveQos && hasSdap {
            @display("p=80,60,col;g=left");
        }
        // NR RLC submodules (flattened from former LteRlc compound)
        nrRlcMux: <default("RlcMux")> like IRlcMux {
            @display("p=570,430;is=s");
        }
        // MAC Layer
        nrMac: <default("NrMacUe")> like ILteMac {
            @display("p=570,510");
        }
        // PHY Layer
        nrPhy: <default("PhyUe")> like IPhy {
            @display("p=570,600");
        }
        // NR Channel Model
        nrChannelModel[numNrCarriers]: <nrChannelModelType> like IChannelModel {
            @display("p=80,60,col;g=left");
        }

        // Feedback generator submodule
        nrDlFbGen: LteDlFeedbackGenerator {
            @display("p=80,60,col;g=left");
            phyModule = "^.nrPhy";
        }

        nrPacketFlowObserver: <default("NrPacketFlowObserverUe")> like IPacketFlowObserver if hasRniSupport {
            @display("p=80,60,col;g=left");
            macModule = "^.nrMac";
            rlcModule = "^";
            isNrObserver = true;
        }

    connections:

        //# NR RLC <-> MAC
        nrRlcMux.macOut --> nrMac.upperLayerIn;
        nrRlcMux.macIn <-- nrMac.upperLayerOut;

        //#
        //# Connections from LTE Stack to radio interface
        //#
        nrMac.phyOut --> nrPhy.upperGateIn;
        nrMac.phyIn <-- nrPhy.upperGateOut;

        //# external: lower connection
        nrRadioIn --> nrPhy.radioIn;

        //# uplink QoS-flow classifier (optional, spliced above ip2nic)
        handoverPacketHolder.stackOut --> { @reconnect; } --> qosFlowClassifier.upperLayerIn if hasSdap;
        qosFlowClassifier.lowerLayerOut --> ip2nic.upperLayerIn if hasSdap;

        //# SDAP layer (optional, spliced between ip2nic and pdcpMux)
        ip2nic.stackOut --> { @reconnect; } --> sdap.upperLayerIn if hasSdap;
        sdap.pdcpOut --> pdcpMux.upperLayerIn if hasSdap;
        pdcpMux.upperLayerOut --> { @reconnect; } --> sdap.pdcpIn if hasSdap;
        sdap.upperLayerOut --> ip2nic.stackIn if hasSdap;
}

File: src/simu5g/stack/NrNicUe.ned

---

This documentation is released under the Creative Commons license