NrRlcUmEntity

Package: simu5g.stack.rlc

compound module NrRlcUmEntity

RLC UM entity of an NR data radio bearer: the RlcUmEntityBase compound with its TX/RX sides bound to the NR (SI/SO wire format, TS 38.322) entity profiles. Selected by BearerManagement for NR bearers via its nrRlcUmEntityModuleType parameter.

Inheritance diagram

Known subclasses

Name

Type

Description

NrRlcUmEntityD2D

compound module

RLC UM entity of a D2D-capable NR data radio bearer: NrRlcUmEntity with both sides bound to the D2D entity profiles. Selected by BearerManagement on the D2D-capable NICs via its nrRlcUmEntityModuleType parameter.

Extends

Name

Type

Description

RlcUmEntityBase

compound module

Base type of the RLC UM entity of one data radio bearer: packages the transmitting and the receiving side (TS 36.322 / 38.322 model an entity per bearer). Created dynamically by BearerManagement, one per (peer, DRB) pair; a bearer with traffic in one direction only simply leaves the other side idle.

Parameters

Name

Type

Default value

Description

macModule

string

“^.mac”

This bearer leg’s MAC; set per leg by BearerManagement

rlcMuxModule

string

“^.rlcMux”

This bearer leg’s RLC mux

Properties

Name

Value

Description

display

i=block/wheelbarrow

dynamic

true

Gates

Name

Direction

Size

Description

upperIn

input

SDUs from PDCP

upperOut

output

Reassembled SDUs to PDCP

lowerIn

input

PDUs from RlcMux

lowerOut

output

PDUs and new-data notifications to RlcMux/MAC

macIn

input

MAC SDU requests via RlcMux

Unassigned submodule parameters

Name

Type

Default value

Description

tx.macModule

string

“^.^.mac”

Set by the enclosing RlcUmEntityBase compound (per leg)

tx.sn_FieldLength

int

12

UM SN field length in bits: 6 or 12

rx.macModule

string

“^.^.mac”

Set by the enclosing RlcUmEntityBase compound (per leg)

rx.rlcMuxModule

string

“^.^.rlcMux”

This bearer’s leg mux; set by the RlcUmEntityBase compound

rx.UM_Window_Size

int

2048

SDU reassembly window: 2048 (12-bit SN) or 32 (6-bit SN)

rx.t_Reassembly

double

80ms

Source code

//
// RLC UM entity of an NR data radio bearer: the ~RlcUmEntityBase compound with
// its TX/RX sides bound to the NR (SI/SO wire format, TS 38.322) entity
// profiles. Selected by BearerManagement for NR bearers via its
// nrRlcUmEntityModuleType parameter.
//
module NrRlcUmEntity extends RlcUmEntityBase
{
    parameters:
        tx.typename = default("simu5g.stack.rlc.um.NrRlcUmTxEntity");
        rx.typename = default("simu5g.stack.rlc.um.NrRlcUmRxEntity");
}

File: src/simu5g/stack/rlc/NrRlcUmEntity.ned