From 45da88b852c31cec1d837513536cd3dbad28d942 Mon Sep 17 00:00:00 2001
From: Nicola Baldo <nbaldo@cttc.es>
Date: Wed, 1 May 2013 22:58:07 -0400
Subject: [PATCH] updated CHANGES.html and RELEASE_NOTES for LTE module

---
 CHANGES.html          | 41 ++++++++++++++++++++++++++++------------
 RELEASE_NOTES         |  2 ++
 src/lte/RELEASE_NOTES | 44 +++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 75 insertions(+), 12 deletions(-)

diff --git a/CHANGES.html b/CHANGES.html
index 819c13020..b3cdfb6f2 100644
--- a/CHANGES.html
+++ b/CHANGES.html
@@ -64,15 +64,27 @@ us a note on ns-developers mailing list.</p>
   </li>  
 </ul>
 <ul>
-	<li>Additions in LTE
-		<ul>
-			<li>New LTE control message classes DlHarqFeedbackLteControlMessage, RachPreambleLteControlMessage, RarLteControlMessage, MibLteControlMessage</li>
-			<li>New class UeManager
-			<li>New LteRadioBearerInfo subclasses LteSignalingRadioBearerInfo, LteDataRadioBearerInfo</li>
-			<li>New LteSinrChunkProcessor subclasses LteRsReceivedPowerChunkProcessor, LteInterferencePowerChunkProcessor</li>
-		</ul>
-	</li>
-
+  <li>LTE module
+    <ul>
+      <li> New user-visible LTE API
+	   <ul>
+	     <li>Two new methods have been added to LteHelper to enable the X2-based handover functionality: AddX2Interface, which setups the X2 interface between two eNBs, and HandoverRequest, which is  a convenience method that schedules an explicit handover event to be executed at a given point in the simulation. </li>
+	     <li>the new LteHelper method EnablePhyTraces can now be used to enable the new PHY traces</li>
+	   </ul>
+      </li> 
+      <li> New internal LTE API 
+	   <ul>
+	     <li>New LTE control message classes DlHarqFeedbackLteControlMessage, 
+	       RachPreambleLteControlMessage, RarLteControlMessage, MibLteControlMessage</li>
+	     <li>New class UeManager
+	     <li>New LteRadioBearerInfo subclasses LteSignalingRadioBearerInfo, 
+	       LteDataRadioBearerInfo</li>
+	     <li>New LteSinrChunkProcessor subclasses LteRsReceivedPowerChunkProcessor, 
+	       LteInterferencePowerChunkProcessor</li>
+	   </ul>
+      </li>
+    </ul>
+  </li>
 <li>New Tag, PacketSocketTag, to carry the dest address of a packet and the packet type</li>
 <li>New Tag, DeviceNameTag, to carry the ns3 device name from where a packet is coming</li>
 <li>New Error Model, BurstError model, to determine which bursts of packets are errored corresponding to an underlying distribution, burst rate, and burst size</li>
@@ -107,9 +119,14 @@ us a note on ns-developers mailing list.</p>
 </li>
 <li>Changes in LTE API
 <ul>
+   <li> User-visible LTE API 
+     <ul>
+	<li>The previous LteHelper method ActivateEpsBearer has been now replaced by two alternative methods: ActivateDataRadioBearer (to be used when the EPC model is not used) and ActivateDedicatedEpsBearer (to be used when the EPC model is used). In the case where the EPC model is used, the default EPS bearer is not automatically activated without the need for a specific method to be called.</li>
+     </ul>
+   </li> 
+   <li> Internal LTE API 
+     <ul>
 	<li>EpcHelper added methods AddUe, AddX2Interface.  Method AddEnb now requires a cellId.  Signature of ActivateEpsBearer changed to void ActivateEpsBearer (Ptr<NetDevice> ueLteDevice, uint64_t imsi, Ptr<EpcTft> tft, EpsBearer bearer) </li>
-	<li>LteHelper method ActivateEpsBearer renamed to ActivateDedicatedEpsBearer</li>
-	<li>LteHelper added methods AddX2Interface, HandoverRequest, ActivateDataRadioBearer</li>
 	<li>LteHelper added methods EnableDlPhyTraces, EnableUlPhyTraces, EnableDlTxPhyTraces, EnableUlTxPhyTraces, EnableDlRxPhyTraces, EnableUlRxPhyTraces</li>
 	<li>LteHelper removed methods EnableDlRlcTraces, EnableUlRlcTraces, EnableDlPdcpTraces, EnableUlPdcpTraces</li>
 	<li>RadioBearerStatsCalculator added methods (Set/Get)StartTime, (Set/Get)Epoch, RescheduleEndEpoch, EndEpoch</li>
@@ -145,7 +162,7 @@ us a note on ns-developers mailing list.</p>
 	<li>LteUePhy DoSendMacPdu, DoSendLteControlMessage, DoSetTransmissionMode, DoSetSrsConfigurationIndex made private</li>
 	<li>LteUePhySapProvider removed methods	SetBandwidth, SetTransmissionMode, SetSrsConfigurationIndex</li>
 	<li>LteUePhySapProvider added method SendRachPreamble</li>  
- 	
+   </li>   	
 </ul>
 <li>AnimationInterface method EnableIpv4RouteTracking returns reference to calling AnimationInterface object</li>
 
diff --git a/RELEASE_NOTES b/RELEASE_NOTES
index 51b919977..005773343 100644
--- a/RELEASE_NOTES
+++ b/RELEASE_NOTES
@@ -30,6 +30,8 @@ New user-visible features
   pkg-config generator has been replaced by Waf's builtin tool.
 - create-module.py script has been updated to work with waf 1.7 and support
   for creating modules with names containing dashes has been added.
+- the M5 release of the LTE module by the LENA project has been
+  merged; please see src/lte/RELEASE_NOTES for more detailed info 
 
 Bugs fixed
 ----------
diff --git a/src/lte/RELEASE_NOTES b/src/lte/RELEASE_NOTES
index 3eb50dc97..1c9f4aa7e 100644
--- a/src/lte/RELEASE_NOTES
+++ b/src/lte/RELEASE_NOTES
@@ -7,6 +7,50 @@ This file documents the user-visible features that have been added
 within each release of the ns-3 LTE module.
 
 
+Milestone 5 (M5) release of the LENA project (January 23, 2013)
+================================================================
+
+ - MIMO model
+ - HARQ model integrated with error model
+ - Control Channel and Reference Signals models
+ - MAC Random Access model with protocol interference model
+   for preamble collisions
+ - RRC implementation with new UE and ENB state machines and
+   ASN.1-encoded RRC PDUs sent over Signaling Radio Bearers
+ - RLC TM model
+ - MME, S1-AP and S11 logical models
+ - X2 implementation supporting handover and SON primitives
+ - additional KPIs: RSRP & SINR traces, PHY tx/rx traces,
+   SRB stats
+ - several bug fixes
+
+
+GSoC 2012 release (merged into ns-3-dev on December 2012)
+=========================================================
+
+ - Maximum Throughput (MT) Scheduler
+ - Throughput to Average (TTA) Scheduler
+ - Blind Equal Throughput (BET) Scheduler
+ - Token Bank Fair Queue (TBFQ) Scheduler
+ - Priority Set Scheduler (PSS)
+
+
+Milestone 4 (M4) release of the LENA project (December 15, 2011)
+================================================================
+
++ LTE Radio Protocols:
+  - RLC/UM
+  - RLC/AM
+  - PDCP
++ EPC data plane:
+  - S1-U interface with GTP-U tunneling
+  - SGW/PGW node
+  - TFT classifiers
+  - mapping of EPS bearers to Radio Bearers
+  - integration with ns-3 Ipv4 and ns-3 applications
++ Propagation Models:
+  - revised trace-based fading model with new traces
+  - new buildings pathloss model 
 
 
 Milestone 1 (M1) release of the LENA project (June 17, 2011)