LteNicEnb

Package: simu5g.stack

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.

pcapRecorder[numPcapRecorders] : PcapRecorder 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: This module interface is implemented by clock models. Source: clock: <default("")> like IClock if typename != "" { parameters: @display("p=100,200;is=s"); } ip2nic : like INetworkLayer2CellularNic IP2Nic: The IP2Nic module acts as a bridge between the IP network layer and the cellular (LTE/NR) protocol... INetworkLayer2CellularNic: The INetworkLayer2CellularNic module interface serves as an intermediary between the network layer... Source: ip2nic: <default("IP2Nic")> like INetworkLayer2CellularNic { nodeType = parent.nodeType; @display("p=412,67"); } pdcpRrc : like ILtePdcpRrc ILtePdcpRrc: Interface for the PDCP/RRC layer of the LTE Stack. Source: pdcpRrc: <> like ILtePdcpRrc { @display("p=362,141"); } rlc : LteRlc The LteRlc module implements the functionalities of the Radio Link Control (RLC) layer. Source: rlc: LteRlc { @display("p=362,226"); d2dCapable = parent.d2dCapable; *.macModule = "^.^.mac"; *.packetFlowManagerModule = parent.hasRNISupport ? "^.^.packetFlowManager" : ""; um.nodeType = parent.nodeType; } mac : like ILteMac ILteMac: Interface for the Medium Access Control (MAC) layer of the LTE Stack. Source: mac: <> like ILteMac { @display("p=363,314"); } phy : like ILtePhy ILtePhy: Interface for the Physical (PHY) layer of the LTE stack. Source: phy: <> like ILtePhy { @display("p=363,389"); } channelModel[numCarriers] : like ILteChannelModel ILteChannelModel: This module provides the interface for modules implementing the model of the radio channel. Source: channelModel[numCarriers]: <LteChannelModelType> like ILteChannelModel { @display("p=100,389"); } //# packetFlowManager : like IPacketFlowManager Source: packetFlowManager: <default("")> like IPacketFlowManager if hasRNISupport { @display("p=70,300"); } x2Manager : LteX2Manager This module serves as a pluggable interface for submodules of the e/gNodeB's LTE/NR protocol stack... Source: x2Manager: LteX2Manager { @display("p=623,226,row"); } compManager : like ILteCompManager LteCompManagerProportional: This module implements a simple CoMP (Coordinated Multi-Point) coordinated scheduling algorithm. ILteCompManager: The LteCompManager interface defines the structure for the CoMP Manager. Source: compManager: <default("LteCompManagerProportional")> like ILteCompManager if compEnabled { @display("p=493,314,row"); } handoverManager : LteHandoverManager This module is responsible for managing the exchange of messages during the handover process. Source: handoverManager: LteHandoverManager { @display("p=493,226,row"); } dualConnectivityManager : DualConnectivityManager This module is responsible for bridging data-plane packets between PDCP entities of two eNodeBs or... Source: dualConnectivityManager: DualConnectivityManager if dualConnectivityEnabled { @display("p=493,141,row"); } bgTrafficGenerator[numCarriers] : BackgroundTrafficGenerator This module is part of a ~BackgroundCell module and is responsible for instantiating a configurable... Source: bgTrafficGenerator[numCarriers]: BackgroundTrafficGenerator { @display("p=100,307,row"); }

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

The LteNicEnbD2D module represents an LTE eNodeB network interface with support for D2D (Device-to-Device) communications. It extends the basic LteNicEnb module to manage D2D-capable UEs (User Equipments). A D2D mode selection algorithm can be specified using the 'd2dModeSelectionType' parameter.

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"
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
LteChannelModelType string "LteRealisticChannelModel"
d2dCapable bool false

inherit the value from the parent module
dualConnectivityEnabled bool false
numCarriers int 1
address string "auto"
compEnabled bool false

Properties

Name Value Description
networkInterface
lifecycleSupport
class ::inet::NetworkInterface
display i=block/ifcard;bgb=704,443;bgl=3

Gates

Name Direction Size Description
EUTRAN_RRC_Sap inout
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.interfaceTableModule string
ip2nic.routingTableModule string
pdcpRrc.headerCompressedSize int
rlc.tm.queueSize int 2MiB

RLC SDU queue size (0: unlimited)
rlc.um.queueSize int
rlc.um.mapAllLcidsToSingleBearer bool
packetFlowManager.macModule string
packetFlowManager.pfmType string
x2Manager.interfaceTableModule string
x2Manager.binderModule string "binder"
handoverManager.losslessHandover bool false
handoverManager.ip2nicModule string "^.ip2nic"
dualConnectivityManager.pdcpRrcModule string "^.pdcpRrc"

Source code

//
// 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.
//
module LteNicEnb extends LteNicBase
{
    parameters:
        pdcpRrc.typename = default("LtePdcpRrcEnb");
        mac.typename = default("LteMacEnb");
        phy.typename = default("LtePhyEnb");
        packetFlowManager.typename = default("PacketFlowManagerEnb");
        d2dCapable = default(false);          // DO NOT CHANGE
        bool compEnabled = default(false);
        *.handoverManagerModule = "^.handoverManager";

    submodules:
        //#
        //# X2 manager
        //#
        x2Manager: LteX2Manager {
            @display("p=623,226,row");
        }

        //#
        //# Modules exploiting X2 interface
        //#
        compManager: <default("LteCompManagerProportional")> like ILteCompManager if compEnabled {
            @display("p=493,314,row");
        }
        handoverManager: LteHandoverManager {
            @display("p=493,226,row");
        }
        dualConnectivityManager: DualConnectivityManager if dualConnectivityEnabled {
            @display("p=493,141,row");
        }
        bgTrafficGenerator[numCarriers]: BackgroundTrafficGenerator {
            @display("p=100,307,row");
        }

    connections:
        //# connections between X2 Manager and its users
        compManager.x2ManagerIn <-- x2Manager.dataPort$o++ if compEnabled;
        compManager.x2ManagerOut --> x2Manager.dataPort$i++ if compEnabled;
        handoverManager.x2ManagerIn <-- x2Manager.dataPort$o++;
        handoverManager.x2ManagerOut --> x2Manager.dataPort$i++;
        dualConnectivityManager.x2ManagerIn <-- x2Manager.dataPort$o++ if dualConnectivityEnabled;
        dualConnectivityManager.x2ManagerOut --> x2Manager.dataPort$i++ if dualConnectivityEnabled;

        if ( sizeof(x2) > 0 ) {
            //# connections between X2 Manager and GTP (for handover)
            x2$i[0] --> x2Manager.x2Gtp$i;
            x2$o[0] <-- x2Manager.x2Gtp$o;
        }
        //# connections between X2 Manager and the outer world
        for i=1..sizeof(x2)-1 {
            x2$i[i] --> x2Manager.x2$i++;
            x2$o[i] <-- x2Manager.x2$o++;
        }
}
File: src/stack/LteNicEnb.ned

This documentation is released under the Creative Commons license