wharsnew++

Author: avarga

WHATSNEW.md

@@ -3,12 +3,12 @@
 ## v1.6.0 (2026-07-31)
 
 This release adds a standards-compliant NR RLC to Simu5G. RLC Unacknowledged
-Mode and Acknowledged Mode per TS 38.322 -- contributed by Esteban Egea Lopez
--- have been integrated into the mainline and are now the default on NR
-bearers; the RLC entity modules were restructured into shared bases with LTE
-and NR concrete implementations; the LTE RLC AM -- which never worked properly
--- was reimplemented per TS 36.322 on the same architecture; and radio link
-failure detection with RRC re-establishment was added.
+Mode and Acknowledged Mode per TS 38.322 contributed by Esteban Egea Lopez have
+been integrated into the mainline and are now the default on NR bearers. The RLC
+entity modules were restructured into shared bases with LTE and NR concrete
+implementations. The previously incomplete LTE RLC AM was reimplemented per TS
+36.322 on the same architecture. Radio link failure detection with RRC
+re-establishment was added.
 
 Tested with INET-4.5.4 and OMNeT++ 6.3, compatible with INET-4.6.0 and OMNeT++
 6.1 through 6.4.
@@ -79,14 +79,13 @@ concrete entities with `tx.typename`/`rx.typename`.
 
 ### LTE RLC AM reimplemented per TS 36.322
 
-Simu5G's original LTE RLC AM was derived from UMTS RLC (TS 25.322) and never
-worked properly; no simulation configuration selected it. What it implemented
-was not TS 36.322 in any dimension: the wire format was per-SDU fragmentation
-with a sequence number per fragment (no concatenation, no FI/LI, no poll bit),
-retransmission was driven by per-PDU timeouts that resent without any NACK, a
-PDU exhausting its retransmissions was silently discarded -- data loss on an
-acknowledged-mode bearer, with no radio link failure -- and status reporting
-was periodic rather than event-driven.
+Simu5G's original LTE RLC AM was derived from UMTS RLC (TS 25.322), it was
+incomplete, and no simulation configuration used it. What it implemented was not
+TS 36.322 compliant: the wire format was per-SDU fragmentation with a sequence
+number per fragment (no concatenation, no FI/LI, no poll bit), retransmission
+was driven by per-PDU timeouts that resent without any NACK, a PDU exhausting
+its retransmissions was silently discarded with no radio link failure
+indication, and status reporting was periodic rather than event-driven.
 
 It has been reimplemented from scratch on the architecture of the NR AM
 entity, whose TS 38.322 ARQ skeleton TS 36.322 shares; only the framing is
@@ -110,26 +109,22 @@ simulation results.
 
 ### Selecting RLC AM
 
-Acknowledged Mode is now usable on both RATs -- previously there was no NR AM
-implementation at all, and an NR bearer asking for AM got the LTE one, which did
-not work -- but nothing selects it by default: every bearer stays in the mode it
-had before, so existing simulations are unaffected. Two mechanisms choose the
-mode of a bearer, depending on whether SDAP is in the stack.
+Acknowledged Mode is now usable on both RATs, but nothing selects it by default:
+every bearer stays in the mode it had before, so existing simulations are
+unaffected. Two mechanisms choose the mode of a bearer, depending on whether
+SDAP is in the stack.
 
 Without SDAP, `Ip2Nic` classifies each packet into a traffic class by packet name
 (`VoIP*` -> conversational, `gaming*` -> interactive, `VoDPacket*` -> streaming,
 anything else -> background) and maps the class to an RLC mode with its
 `conversationalRlc`, `streamingRlc`, `interactiveRlc` and `backgroundRlc`
 parameters. They accept `"TM"`, `"UM"` and `"AM"`, and all four default to
-`"UM"` -- which is the pre-v1.6.0 behavior, kept for backward compatibility:
+`"UM"` (which is the pre-v1.6.0 behavior, kept for backward compatibility).
 
-      **.cellularNic.ip2nic.conversationalRlc = "AM"
-
-With SDAP in the stack (`hasSdap = true` on the NR NIC, which propagates into
-`ip2nic.hasSdap`), `Ip2Nic` skips traffic classification entirely and the mode
-becomes a property of the DRB: every entry of `NrSdap.drbConfig` takes an
-optional `rlcType` field, again one of `"AM"`, `"UM"` and `"TM"`, and again
-defaulting to `"UM"`:
+With SDAP in the stack (`hasSdap = true` on the NR NIC), `Ip2Nic` skips traffic
+classification entirely and the mode becomes a property of the DRB: every entry
+of `NrSdap.drbConfig` takes an optional `rlcType` field, again one of `"AM"`,
+`"UM"` and `"TM"`, and again defaulting to `"UM"`. For example:
 
       *.gnb.cellularNic.hasSdap = true
       *.gnb.cellularNic.sdap.drbConfig = [
@@ -138,8 +133,8 @@ defaulting to `"UM"`:
 
 Either way, both ends of a bearer must be configured with the same mode: each
 node builds its own RLC entity from its own configuration, so a mismatch leaves
-an AM entity facing a UM one. The `**.` wildcard above takes care of that for
-`Ip2Nic`; with SDAP, the UE's `drbConfig` entry for a DRB and the gNB's entry
+an AM entity facing a UM one. With `Ip2Nic`, this can be ensured by using `**.`
+wildcards; with SDAP, the UE's `drbConfig` entry for a DRB and the gNB's entry
 for the same DRB have to agree on `rlcType`.
 
 Which entity type then implements the mode follows from the RAT, as described
@@ -179,7 +174,6 @@ entities left behind at the old cell.
 Defects found in the NR AM implementation found using these scenarios
 were fixed.
 
-
 ### Radio link failure and RRC re-establishment
 
 The RLC AM transmitters declare a radio link failure when a PDU exceeds
@@ -313,6 +307,7 @@ bearer individually measurable.
   and `IRlcAmRxEntity.ned`, one interface per file. The interfaces themselves,
   and all type names, are unchanged.
 
+
 ## v1.5.2 (2026-07-30)
 
 This release corrects the names of the per-bearer PDCP and RLC entity modules