LteNicUe

Package: simu5g.stack

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.

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

pcapRecorder[numPcapRecorders] : PcapRecorder [from inet] ↗ Records PCAP traces of frames sent/received by other modules within the same host. Source: pcapRecorder[numPcapRecorders]: PcapRecorder { parameters: moduleNamePatterns = ".^"; @display("p=100,100;is=s"); } clock : like IClock IClock [from inet] ↗: Interface for clock models. Source: clock: <default("")> like IClock if typename != "" { parameters: @display("p=100,200;is=s"); } handoverPacketHolder : like IHandoverPacketHolder IHandoverPacketHolder: Manages packet buffering/tunnelling during handover Source: handoverPacketHolder: <> like IHandoverPacketHolder { @display("p=440,100;is=s"); } ip2nic : like INetworkLayer2CellularNic Ip2Nic: Bridges the IP network layer and the cellular protocol stack, handling bidirectional packet flow. INetworkLayer2CellularNic: The INetworkLayer2CellularNic module interface serves as an intermediary between the network layer... Source: ip2nic: <default("Ip2Nic")> like INetworkLayer2CellularNic { nodeType = parent.nodeType; @display("p=310,200;is=s"); } rrc : like IRrc Rrc: RRC (Radio Resource Control) layer for LTE/NR networks. IRrc: Interface for the RRC (Radio Resource Control) layer of the LTE/NR Stack. Source: rrc: <default("Rrc")> like IRrc { @display("p=80,60,col;g=left"); } pdcpMux : like IPdcpMux PdcpMux: Upper-layer PDCP packet dispatcher. IPdcpMux: Module interface for the upper-layer PDCP packet dispatcher of a cellular NIC (see ~PdcpMux for the... Source: pdcpMux: <default("PdcpMux")> like IPdcpMux { @display("p=310,340;is=s"); } rlcMux : like IRlcMux RlcMux: Lower-layer RLC packet dispatcher. IRlcMux: Module interface for the lower-layer RLC packet dispatcher of a cellular NIC (see ~RlcMux for the... Source: rlcMux: <default("RlcMux")> like IRlcMux { @display("p=310,580;is=s"); } mac : like ILteMac ILteMac: Interface for the Medium Access Control (MAC) layer of the LTE Stack. Source: mac: <> like ILteMac { @display("p=310,660"); } phy : like IPhy IPhy: Interface for the Physical (PHY) layer of the LTE/NR protocol stack. Source: phy: <> like IPhy { @display("p=310,750"); } channelModel[numCarriers] : like IChannelModel IChannelModel: Provides the interface for modules implementing the model of the radio channel. Source: channelModel[numCarriers]: <channelModelType> like IChannelModel { @display("p=80,60,col;g=left"); } packetFlowObserver : like IPacketFlowObserver Source: packetFlowObserver: <default("")> like IPacketFlowObserver if hasRniSupport { @display("p=80,60,col;g=left"); } dlFbGen : LteDlFeedbackGenerator This is the Lte Downlink Feedback Generator. Source: dlFbGen: LteDlFeedbackGenerator { @display("p=80,60,col;g=left"); } ethernetPortal : EthernetPortal The top of a UE's cellular NIC when its session is an Ethernet PDU session (the sessionType... Source: ethernetPortal: EthernetPortal if sessionType == "Ethernet" { @display("p=310,50;is=s"); }

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
LteNicUeD2D compound module

Represents a Device-to-Device (D2D) capable User Equipment (UE) network interface. It extends the basic LTE UE functionality by adding D2D communication capabilities, allowing direct communication between UEs without the need to route traffic through the base station.
NrNicUe compound module

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.

Extends

Name Type Description
LteNicBase compound module

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.

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"
sessionType string

The type of the UE's session (see LteUe), set by the node

Properties

Name Value Description
class NonlayoutingNetworkInterface
networkInterface
lifecycleSupport
display i=block/ifcard;bgb=800,810;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.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 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
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"

Source code

//
// 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.
//
// 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 LteNicUe extends LteNicBase like IUeCellularNic
{
    parameters:
        mac.typename = default("LteMacUe");
        phy.typename = default("PhyUe");
        handoverPacketHolder.typename = default("HandoverPacketHolderUe");
        packetFlowObserver.typename = default("PacketFlowObserverUe");

        string sessionType;  // The type of the UE's session (see ~LteUe), set by the node

        rrc.hasConnectionControl = true;
        rrc.connectionControl.typename = default("ConnectionControlUe");
        rrc.connectionControl.isNr = false;
        rrc.connectionControl.macNodeId = parent.macNodeId;
        rrc.connectionControl.sessionType = this.sessionType;
        rrc.registration.sessionType = this.sessionType;
        handoverPacketHolder.sessionType = this.sessionType;
        ip2nic.sessionType = this.sessionType;
        dlFbGen.macNodeId = parent.macNodeId;

    submodules:
        // Feedback generator submodule
        dlFbGen: LteDlFeedbackGenerator {
            @display("p=80,60,col;g=left");
        }
        // the NIC's top in Ethernet mode, an Ethernet port of the UE's link layer
        ethernetPortal: EthernetPortal if sessionType == "Ethernet" {
            @display("p=310,50;is=s");
        }

    connections allowunconnected:
        upperLayerIn --> { @reconnect; delay = parent.processingDelayIn; } --> ethernetPortal.upperLayerIn if sessionType == "Ethernet";
        ethernetPortal.lowerLayerOut --> handoverPacketHolder.upperLayerIn if sessionType == "Ethernet";
        ip2nic.upperLayerOut --> { @reconnect; } --> ethernetPortal.lowerLayerIn if sessionType == "Ethernet";
        ethernetPortal.upperLayerOut --> {  delay = parent.processingDelayOut; } --> upperLayerOut if sessionType == "Ethernet";
}
File: src/simu5g/stack/LteNicUe.ned

This documentation is released under the Creative Commons license