LteMacEnb

simple module

This module extends the LteMacBase(1,2) module by providing specific MAC functions on the eNodeB side. Specifically, it initializes and manages the scheduling classes responsible for resource allocation operations in both uplink and downlink directions, while also supporting Carrier Aggregation (CA). It manages the Random Access procedure (RAC) and the reception of Buffer Status Reports (BSRs) from UEs, as well as the transmission of scheduling grants to UEs allocated within the uplink bandwidth. For downlink connections, it notifies the Radio Link Control (RLC) layer when it is ready to receive MAC Service Data Units (SDUs) to build MAC Protocol Data Units (PDUs) and transmit them to the physical layer.

Inheritance diagram

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

Known subclasses

Name	Type	Description
LteMacEnbD2D	simple module	This module extends LTE MAC functionalities at the eNodeB side to support device-to-device (D2D) communications. Specifically, it enhances resource allocation procedures to enable direct communication between User Equipments (UEs), i.e., it allocates resources for D2D transmissions. Network-assisted D2D is only implemented (out-of-coverage D2D is not supported).

Extends

Name	Type	Description
LteMacBase	simple module	Base module for the Medium Access Control (MAC) layer of the LTE protocol stack.

Parameters

Name	Type	Default value	Description
binderModule	string	"binder"
packetFlowManagerModule	string	"^.packetFlowManager"	TODO or nrPacketFlowManager
queueSize	int	2MiB
muMimo	bool	true
harqProcesses	int	8
maxHarqRtx	int	3
harqFbEvaluationTimer	int	4	number of slots for sending back HARQ FB
statDisplay	bool	false
amcType	string	"LteAmc"	AMC Type: "LteAmc", "NRAmc"
amcMode	string	"AUTO"	AMC Mode: "auto", "piloted", "multi", "das", "D2D"
rbAllocationType	string	"localized"	resource allocation type ("distributed" or "localized")
summaryLowerBound	double	5ms	summary feedback confidence function lower bound
summaryUpperBound	double	20ms	summary feedback confidence function upper bound
fbhbCapacityDl	int	5	FeedBack Historical Base capacity in DL (number of stored feedback samples per UE)
fbhbCapacityUl	int	5	FeedBack Historical Base capacity in UL (number of stored feedback samples per UE)
fbhbCapacityD2D	int	5	FeedBack Historical Base capacity in D2D (number of stored feedback samples per UE)
pmiWeight	double	0.0	wideband PMI generation parameter (0.0 means "use the mean value" )
cqiWeight	double	0.0	wideband CQI generation parameter (0.0 means "use the mean value" )
eNodeBCount	int	0	number of eNodeBs - set to 0 if unknown
schedulingDisciplineDl	string	"MAXCI"	Scheduling discipline. See LteCommon.h for discipline meaning.
schedulingDisciplineUl	string	"MAXCI"
pfAlpha	double	0.95	Proportional Fair parameters
pilotMode	string	"ROBUST_CQI"
cellInfoModule	string
rlcUmModule	string	"^.rlc.um"
pdcpRrcModule	string	"^.pdcpRrc"

Properties

Name	Value	Description
display	i=block/mac
class	LteMacEnb

Gates

Name	Direction	Description
RLC_to_MAC	input	RLC to MAC
MAC_to_RLC	output	MAC to RLC
PHY_to_MAC	input	PHY to MAC
MAC_to_PHY	output	MAC to PHY

Signals

Name	Type	Unit	Description
avgServedBlocksUl
avgServedBlocksDl

Statistics

Name	Title	Source	Record	Unit	Interpolation Mode	Description
avgServedBlocksUl	Average number of allocated Resource Blocks in the Dl	avgServedBlocksUl	mean, vector	blocks
avgServedBlocksDl	Average number of allocated Resource Blocks in the Dl	avgServedBlocksDl	mean, vector	blocks

Source code

//
// This module extends the ~LteMacBase module by providing specific MAC functions
// on the eNodeB side. Specifically, it initializes and manages the scheduling classes
// responsible for resource allocation operations in both uplink and downlink directions,
// while also supporting Carrier Aggregation (CA).
// It manages the Random Access procedure (RAC) and the reception of Buffer Status
// Reports (BSRs) from UEs, as well as the transmission of scheduling grants to UEs allocated
// within the uplink bandwidth. For downlink connections, it notifies the Radio Link Control (RLC)
// layer when it is ready to receive MAC Service Data Units (SDUs) to build MAC
// Protocol Data Units (PDUs) and transmit them to the physical layer.
//
simple LteMacEnb extends LteMacBase
{
    parameters:
        @class("LteMacEnb");

        //# volatile xml optSolution = default(xmldoc("solution.sol"));

        //#
        //# AMC Parameters
        //#

        // AMC Type:  "LteAmc", "NRAmc"
        string amcType @enum(LteAmc,NRAmc) = default("LteAmc");

        // AMC Mode:  "auto", "piloted", "multi", "das", "D2D"
        string amcMode @enum(AUTO,D2D) = default("AUTO");

        // resource allocation type ("distributed" or "localized")
        string rbAllocationType @enum(distributed,localized) = default("localized");

        // summary feedback confidence function lower bound
        double summaryLowerBound @unit(s) = default(5ms);

        // summary feedback confidence function upper bound
        double summaryUpperBound @unit(s) = default(20ms);

        // FeedBack Historical Base capacity in DL (number of stored feedback samples per UE)
        int fbhbCapacityDl = default(5);

        // FeedBack Historical Base capacity in UL (number of stored feedback samples per UE)
        int fbhbCapacityUl = default(5);

        // FeedBack Historical Base capacity in D2D (number of stored feedback samples per UE)
        int fbhbCapacityD2D = default(5);

        // wideband PMI generation parameter (0.0 means "use the mean value" )
        double pmiWeight = default(0.0);

        // wideband CQI generation parameter (0.0 means "use the mean value" )
        double cqiWeight = default(0.0);

        // number of eNodeBs - set to 0 if unknown
        int eNodeBCount = default(0);

        //#
        //# eNb Scheduler Parameters
        //#
        // Scheduling discipline. See LteCommon.h for discipline meaning.
        string schedulingDisciplineDl @enum(DRR,PF,MAXCI,MAXCI_MB,MAXCI_OPT_MB,MAXCI_COMP,ALLOCATOR_BESTFIT) = default("MAXCI");
        string schedulingDisciplineUl @enum(DRR,PF,MAXCI,MAXCI_MB,MAXCI_OPT_MB,MAXCI_COMP,ALLOCATOR_BESTFIT) = default("MAXCI");

        // Proportional Fair parameters
        double pfAlpha = default(0.95);

        string pilotMode @enum(IN_CQI,MAX_CQI,AVG_CQI,MEDIAN_CQI,ROBUST_CQI) = default("ROBUST_CQI");

        string cellInfoModule;
        string rlcUmModule = default("^.rlc.um");
        string pdcpRrcModule = default("^.pdcpRrc");

        //#
        //# Statistics related to resource blocks occupancy
        @signal[avgServedBlocksDl];
        @statistic[avgServedBlocksDl](title="Average number of allocated Resource Blocks in the Dl"; unit="blocks"; source="avgServedBlocksDl"; record=mean,vector);
        @signal[avgServedBlocksUl];
        @statistic[avgServedBlocksUl](title="Average number of allocated Resource Blocks in the Dl"; unit="blocks"; source="avgServedBlocksUl"; record=mean,vector);
}

File: src/stack/mac/LteMacEnb.ned