LteMacUe

simple module

This module extends the LteMacBase(1,2) module by providing specific MAC functions at the User Equipment (UE) side. For uplink connections, this module manages the initiation of the Random Access procedure (RAC) and the sending of Buffer Status Reports (BSRs) to the eNodeBs. Once it receives an uplink scheduling grant from the eNodeB, it is responsible for managing the local connections' scheduler and constructing MAC Protocol Data Units (PDUs) to be transmitted 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
LteMacUeD2D	simple module	This module extends LTE MAC functionalities at the User Equipment side to support device-to-device (D2D) communications. Specifically, it customizes LteMacUe functionalities to support the transmission and reception of MAC Protocol Data Units (PDUs), Channel Status Information (CSI), and Buffer Status Reports (BSRs) over a D2D link. It supports D2D multicast transmission to nearby UEs belonging to a given multicast group.

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

Properties

Name	Value	Description
display	i=block/mac
class	LteMacUe

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
macCellThroughputUl
macCellPacketLossUl
macDelayUl
harqErrorRateUl
macPacketLossUl
harqErrorRate_1st_Ul
macThroughputUl
harqTxAttemptsDl
macBufferOverFlowDl
harqErrorRate_3rd_Ul
macCellThroughputDl
macCellPacketLossDl
macThroughputDl
harqTxAttemptsUl
macPacketLossDl
harqErrorRate_1st_Dl
sentPacketToLowerLayer
receivedPacketFromUpperLayer
sentPacketToUpperLayer
harqErrorRate_2nd_Dl
harqErrorRate_4th_Dl
macBufferOverFlowD2D
macDelayDl
receivedPacketFromLowerLayer
macBufferOverFlowUl
harqErrorRateDl
harqErrorRate_3rd_Dl
harqErrorRate_2nd_Ul
harqErrorRate_4th_Ul

Statistics

Name	Title	Source	Record	Unit	Interpolation Mode
macCellThroughputUl	Cell Throughput at the MAC layer UL	macCellThroughputUl	mean	Bps
macCellPacketLossUl	Mac Cell Packet Loss Ul	macCellPacketLossUl	mean
macDelayUl	Delay at the MAC layer UL	macDelayUl	mean, vector	s
harqErrorRateUl	Harq Error Rate Ul	harqErrorRateUl	mean, vector
macPacketLossUl	Mac Packet Loss Ul	macPacketLossUl	mean
harqErrorRate_1st_Ul	Harq Error Rate Ul (1st tx)	harqErrorRate_1st_Ul	mean, vector
macThroughputUl	Throughput at the MAC layer UL	macThroughputUl	mean	Bps
harqTxAttemptsDl	Harq Tx Attempts Dl	harqTxAttemptsDl	mean, vector
macBufferOverFlowDl	Mac buffer overflow as function of time	macBufferOverFlowDl	mean	Byte/s
harqErrorRate_3rd_Ul	Harq Error Rate Ul (3rd tx)	harqErrorRate_3rd_Ul	mean, vector
macCellThroughputDl	Cell Throughput at the MAC layer DL	macCellThroughputDl	mean	Bps
macCellPacketLossDl	Mac Cell Packet Loss Dl	macCellPacketLossDl	mean
macThroughputDl	Throughput at the MAC layer DL	macThroughputDl	mean	Bps
harqTxAttemptsUl	Harq Tx Attempts Ul	harqTxAttemptsUl	mean, vector
macPacketLossDl	Mac Packet Loss Dl	macPacketLossDl	mean
harqErrorRate_1st_Dl	Harq Error Rate Dl (1st tx)	harqErrorRate_1st_Dl	mean, vector
sentPacketToLowerLayer		sentPacketToLowerLayer	count, sum(packetBytes), vector(packetBytes)		none
receivedPacketFromUpperLayer		receivedPacketFromUpperLayer	count, sum(packetBytes), vector(packetBytes)		none
sentPacketToUpperLayer		sentPacketToUpperLayer	count, sum(packetBytes), vector(packetBytes)		none
harqErrorRate_2nd_Dl	Harq Error Rate Dl (2nd tx)	harqErrorRate_2nd_Dl	mean, vector
harqErrorRate_4th_Dl	Harq Error Rate Dl (4th tx)	harqErrorRate_4th_Dl	mean, vector
macBufferOverFlowD2D	Mac buffer overflow as function of time	macBufferOverFlowD2D	mean	Byte/s
macDelayDl	Delay at the MAC layer UL	macDelayDl	mean, vector	s
receivedPacketFromLowerLayer		receivedPacketFromLowerLayer	count, sum(packetBytes), vector(packetBytes)		none
macBufferOverFlowUl	Mac buffer overflow as function of time	macBufferOverFlowUl	mean	Byte/s
harqErrorRateDl	Harq Error Rate Dl	harqErrorRateDl	mean, vector
harqErrorRate_3rd_Dl	Harq Error Rate Dl (3rd tx)	harqErrorRate_3rd_Dl	mean, vector
harqErrorRate_2nd_Ul	Harq Error Rate Ul (2nd tx)	harqErrorRate_2nd_Ul	mean, vector
harqErrorRate_4th_Ul	Harq Error Rate Ul (4th tx)	harqErrorRate_4th_Ul	mean, vector

Source code

//
// This module extends the ~LteMacBase module by providing specific MAC functions
// at the User Equipment (UE) side.
// For uplink connections, this module manages the initiation of the Random Access procedure (RAC)
// and the sending of Buffer Status Reports (BSRs) to the eNodeBs. Once it receives an uplink scheduling
// grant from the eNodeB, it is responsible for managing the local connections' scheduler and
// constructing MAC Protocol Data Units (PDUs) to be transmitted to the physical layer.
//
simple LteMacUe extends LteMacBase
{
    parameters:
        @class("LteMacUe");
        string collectorModule = default("");
}

File: src/stack/mac/LteMacUe.ned