LteNicBase¶

compound module LteNicBase

The LteNicBase module serves as the foundational building block for LTE networking in Simu5G. It integrates protocols for LTE communication, including PDCP, RLC, MAC, and PHY layers. This base module allows higher-level modules, such as User Equipment (UE) and eNodeB (evolved Node B), to configure and utilize these layers according to their specific requirements.

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¶

Inheritance diagram¶

Known subclasses¶

Name	Type	Description
LteNicEnb	compound module	The LteNicEnb module is a network interface that provides LTE connectivity within an eNodeB. It implements the data and signaling planes of the LTE stack, which includes the PDCP, RLC, MAC, and PHY layers. The parameters and submodules allow customization of the eNodeB’s behavior, including whether it supports D2D communication, CoMP (Coordinated MultiPoint), or dual connectivity.
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.

Extends¶

Name	Type	Description
NetworkInterface ↗	compound module	Serves as the base module for all network interfaces.

Parameters¶

Name	Type	Default value	Description
displayStringTextFormat	string	“%a (%i)\n%m”	Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
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”

Properties¶

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

Gates¶

Name	Direction	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 ↗.displayStringTextFormat	string	“rec: %n pks”	Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
pcapRecorder ↗.verbose	bool	true	Whether to log packets on the module output
pcapRecorder ↗.recordEmptyPackets	bool	true	Specifies if zero length packets are recorded or not
pcapRecorder ↗.enableConvertingPackets	bool	true	Specifies if converting packets to link type is allowed or not
pcapRecorder ↗.pcapFile	string	“”	The PCAP file to be written, suggested value: pcapFile = “${resultdir}/${configname}-#${runnumber}” + fullpath() + “.pcap”
pcapRecorder ↗.fileFormat	string	“pcapng”
pcapRecorder ↗.snaplen	int	65535	Maximum number of bytes to record per packet
pcapRecorder ↗.timePrecision	int	6	Time precision in recorded file. pcap supports only 6 (usec) or 9 (nanosec), pcapng supports more values (see ‘if_tsresol’ option in pcapng file format).
pcapRecorder ↗.dumpBadFrames	bool	true	Enable dump of frames with hasBitError
pcapRecorder ↗.sendingSignalNames	string	“transmissionEnded”	Space-separated list of outbound packet signals to subscribe to
pcapRecorder ↗.receivingSignalNames	string	“receptionEnded”	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
pcapRecorder ↗.alwaysFlush	bool	false	Flush the pcapFile after each write to ensure that all packets are captured in case of a crash
ip2nic.binderModule	string	“binder”
ip2nic.connectionControlModule	string	“^.rrc.connectionControl”	The node’s control-plane entry point, asked for a bearer on a lookup miss
ip2nic.isNr	bool	false	True for the NR leg (set by NrNicUe/NrNicEnb, or in the ini for a DC master eNB)
ip2nic.hasSdap	bool	false	When true, SDAP handles DRB/RLC assignment; Ip2Nic skips traffic classification
ip2nic.sessionType	string	“”	UE only: the type of the UE’s session (see LteUe), which the payload the NIC delivers up is of; set by the NIC
ip2nic.establishBearersOnDemand	bool	true	When false, a packet that finds no established bearer raises an error instead of establishing one (static bearers are established up front; see the staticDrbs parameter of BearerConfigurator)
rrc.registration.interfaceTableModule	string
rrc.registration.interfaceName	string	“cellular”
rrc.registration.routingTableModule	string
rrc.registration.binderModule	string	“binder”
rrc.registration.connectionControlModule	string	“^.connectionControl”	The node’s control-plane entry point (see Rrc), told about a multicast group join
rrc.registration.sessionType	string	“”	UE only: the type of the UE’s session (see LteUe): a UE created during the run gets an IPv4 default route through the NIC only on an IP session, and the NIC of an Ethernet session is an Ethernet port; set by the NIC
rrc.bearerManagement.binderModule	string	“binder”	To reach a peer’s BearerManagement on RLF
rrc.bearerManagement.connectionControlModule	string	“^.connectionControl”	The node’s control-plane entry point (see Rrc), which a torn-down bearer’s DRB identity goes back through
rrc.bearerManagement.t311	double	0s	RRC re-establishment cell-selection timer (0 => release-to-IDLE)
rrc.bearerManagement.t301	double	0.1s	RRC re-establishment (request -> complete) timer
rrc.bearerManagement.headerCompressedSize	int	-1B	Removed, an error if set: header compression is configured per bearer (the rohc field of BearerConfigurator’s bearer definitions)
rrc.bearerManagement.pdcpEntityModuleType	string	“simu5g.stack.pdcp.LtePdcpEntity”	PDCP entity types: the full PDCP entity is a compound (PdcpEntityBase, TX+RX sides plus the leg split/join stage of a multi-leg bearer); the instantiable types are its subclasses (LtePdcpEntity, NrPdcpEntity). At a DC secondary a bearer’s PDCP lives at the master, so the secondary installs an PdcpRelayEntity (tunnels PDUs to/from the master) in its place.
rrc.bearerManagement.pdcpRelayEntityModuleType	string	“simu5g.stack.pdcp.PdcpRelayEntity”
rrc.bearerManagement.dualConnectivityEnabled	bool	false	Set by the NIC; two-leg (split-capable) bearers
rrc.bearerManagement.rlcTmEntityModuleType	string	“simu5g.stack.rlc.RlcTmEntity”	RLC entity types (compound modules): lteRlc* = LTE-FI bearers (TS 36.322), nrRlc* = NR bearers (SI/SO wire format, TS 38.322)
rrc.bearerManagement.lteRlcUmEntityModuleType	string	“simu5g.stack.rlc.LteRlcUmEntity”
rrc.bearerManagement.lteRlcAmEntityModuleType	string	“simu5g.stack.rlc.LteRlcAmEntity”
rrc.bearerManagement.nrRlcUmEntityModuleType	string	“simu5g.stack.rlc.NrRlcUmEntity”
rrc.bearerManagement.nrRlcAmEntityModuleType	string	“simu5g.stack.rlc.NrRlcAmEntity”
rrc.bearerManagement.registrationModule	string	“^.registration”	Module references for accessing other stack layers
rrc.bearerManagement.drbTableModule	string	“^.drbTable”
rrc.bearerManagement.ip2nicModule	string	“^.^.ip2nic”
rrc.bearerManagement.handoverPacketHolderModule	string	“^.^.handoverPacketHolder”	Attachment-ledger push target (UE only)
rrc.bearerManagement.pdcpMuxModule	string	“^.^.pdcpMux”
rrc.bearerManagement.pdcpDcMuxModule	string	“^.^.pdcpDcMux”
rrc.bearerManagement.d2dModeControllerModule	string	“^.d2dModeController”
rrc.bearerManagement.rlcMuxModule	string	“^.^.rlcMux”
rrc.bearerManagement.nrRlcMuxModule	string	“^.^.nrRlcMux”
rrc.bearerManagement.macModule	string	“^.^.mac”
rrc.bearerManagement.nrMacModule	string	“^.^.nrMac”
rrc.bearerManagement.sdapModule	string	“^.^.sdap”	Configuration push target; unresolvable (no SDAP on the NIC) = no pushes
rrc.bearerManagement.qosFlowClassifierModule	string	“^.^.qosFlowClassifier”	Uplink QFI rule push target; unresolvable (not a UE stack with SDAP) = no pushes
rrc.connectionControl.binderModule	string	“binder”
rrc.connectionControl.bearerConfiguratorModule	string	“bearerConfigurator”
rrc.connectionControl.coreControlModule	string	“coreControl”
rrc.connectionControl.bearerManagementModule	string	“^.bearerManagement”
rrc.connectionControl.macModule	string	“^.^.mac”
rrc.connectionControl.handoverPacketHolderModule	string	“^.^.handoverPacketHolder”
rrc.connectionControl.gtpUserModule	string	“^.^.^.relay.gtpUser”
rrc.connectionControl.gtpUserX2Module	string	“^.^.^.gtpUserX2”
rrc.connectionControl.macNodeId	int		The base station’s node id; the NIC sets it from the node’s
rrc.connectionControl.gateway	string	“”	The node’s core network gateway, as its gateway parameter names it; ignored at a node not connected to a core network (a secondary node)
rrc.nrConnectionControl.dynamicCellAssociation	bool	false
rrc.nrConnectionControl.enableHandover	bool	false	Allows handovers in the UE
rrc.nrConnectionControl.isNr	bool		Whether this instance is associated with the NR or the LTE stack
rrc.nrConnectionControl.macNodeId	int		MacNodeId of the stack leg this controller belongs to (set by the NIC)
rrc.nrConnectionControl.sessionType	string		The type of the session the UE requests at connection setup (see LteUe), set by the NIC
rrc.nrConnectionControl.handoverLatency	double	50ms	Handover duration
rrc.nrConnectionControl.handoverDetachmentTime	double	handoverLatency > 0s ? handoverLatency/2 : 25ms
rrc.nrConnectionControl.handoverAttachmentTime	double	handoverLatency > 0s ? handoverLatency-handoverDetachmentTime : handoverDetachmentTime
rrc.nrConnectionControl.minRssiDefault	bool	true	Whether minRssi is taken from PhyPisaData instead of the minRssi parameter
rrc.nrConnectionControl.minRssi	double	-99.0dB	Configurable minimum threshold RSSI for attaching to an eNB (meaningful only if minRssiDefault==false)
rrc.nrConnectionControl.hysteresisFactor	double	10
rrc.nrConnectionControl.binderModule	string	“binder”
rrc.nrConnectionControl.macModule	string	“^.^.mac”
rrc.nrConnectionControl.bearerManagementModule	string	“^.bearerManagement”
rrc.nrConnectionControl.handoverPacketHolderModule	string	“^.^.handoverPacketHolder”
rrc.nrConnectionControl.feedbackGeneratorModule	string	“^.^.dlFbGen”	TODO or “^.^.nrDlFbGen”
rrc.nrConnectionControl.otherConnectionControlModule	string	“”
rrc.nrConnectionControl.hasCollector	bool	false	True when node has a collector module (ueCollector/nrUeCollector) for this PHY module
rlcMux.bearerManagementModule	string	“^.rrc.bearerManagement”
packetFlowObserver.macModule	string
packetFlowObserver.pdcpModule	string
packetFlowObserver.rlcModule	string
packetFlowObserver.isNrObserver	bool
packetFlowObserver.pfmType	string

Source code¶

//
// The LteNicBase module serves as the foundational building block for LTE networking
// in Simu5G. It integrates protocols for LTE communication, including PDCP, RLC, MAC,
// and PHY layers. This base module allows higher-level modules, such as User Equipment (UE)
// and eNodeB (evolved Node B), to configure and utilize these layers according to their
// specific requirements.
//
// 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 LteNicBase extends NetworkInterface like ICellularNic
{
    parameters:
        @class(NonlayoutingNetworkInterface);
        @display("i=block/ifcard;bgb=800,810;bgl=3");
        bool isWireless = true;
        string interfaceTableModule;
        string routingTableModule;

        bool hasRniSupport = default(false);

        string nodeType;
        double processingDelayIn @unit(s) = default(0s);   // Additional processing delay for incoming ip packets
        double processingDelayOut @unit(s) = default(0s);   // Additional processing delay for outgoing ip packets

        string channelModelType = default("StochasticChannelModel");

        bool dualConnectivityEnabled = default(false);
        int numCarriers = default(1);

        string address @mutable = default("auto");
        // The LTE leg's modules take their MacNodeId from the node
        phy.macNodeId = parent.macNodeId;
        mac.macNodeId = parent.macNodeId;
        *.interfaceTableModule = default(absPath(this.interfaceTableModule));
        *.routingTableModule = default(absPath(this.routingTableModule));
        **.dualConnectivityEnabled = default(this.dualConnectivityEnabled);

    gates:
        //# Gates connecting UE/eNB and LTE Stack
        //# Control Ports
        input upperLayerIn;
        output upperLayerOut;
        input radioIn @loose;  // To receive messages sent using sendDirect()
        input nrRadioIn @loose;// For NR support
        inout x2[] @loose;     // Optional X2 manager

    submodules:
        // handover helper, performs packet holding / forwarding
        handoverPacketHolder: <> like IHandoverPacketHolder {
            @display("p=440,100;is=s");
        }
        // bridge between radio nic and network layer
        ip2nic: <default("Ip2Nic")> like INetworkLayer2CellularNic {
            nodeType = parent.nodeType;
            @display("p=310,200;is=s");
        }
        // RRC Layer
        rrc: <default("Rrc")> like IRrc {
            @display("p=80,60,col;g=left");
        }
        // PDCP submodules (flattened from former PdcpLayer compound)
        pdcpMux: <default("PdcpMux")> like IPdcpMux {
            @display("p=310,340;is=s");
        }
        // RLC submodules (flattened from former LteRlc compound)
        rlcMux: <default("RlcMux")> like IRlcMux {
            @display("p=310,580;is=s");
        }
        // MAC Layer
        mac: <> like ILteMac {
            @display("p=310,660");
        }
        // PHY submodule
        phy: <> like IPhy {
            @display("p=310,750");
        }

        channelModel[numCarriers]: <channelModelType> like IChannelModel {
            @display("p=80,60,col;g=left");
        }

        //# Modules used to take trace of PDCP pkt flow
        packetFlowObserver: <default("")> like IPacketFlowObserver if hasRniSupport {
            @display("p=80,60,col;g=left");
        }

    connections allowunconnected:
        handoverPacketHolder.stackOut --> ip2nic.upperLayerIn;
        ip2nic.stackOut --> pdcpMux.upperLayerIn;
        ip2nic.stackIn <-- pdcpMux.upperLayerOut;

        //# Internal LTE Stack Connections

        //# RLC <-> MAC
        rlcMux.macOut --> mac.upperLayerIn;
        rlcMux.macIn <-- mac.upperLayerOut;

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

        //# external: lower connection
        radioIn --> phy.radioIn;
        ip2nic.upperLayerOut --> {  delay = parent.processingDelayOut; } --> upperLayerOut;
        upperLayerIn --> {  delay = parent.processingDelayIn; } --> handoverPacketHolder.upperLayerIn;
}

File: src/simu5g/stack/LteNicBase.ned