A Discrete-Event Network Simulator
API
lte-phy.cc
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2010 TELEMATICS LAB, DEE - Politecnico di Bari
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation;
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * Author: Giuseppe Piro <g.piro@poliba.it>
19  * Marco Miozzo <mmiozzo@cttc.es>
20  */
21 
22 #include <ns3/waveform-generator.h>
23 #include <ns3/object-factory.h>
24 #include <ns3/log.h>
25 #include <cmath>
26 #include <ns3/simulator.h>
27 #include "ns3/spectrum-error-model.h"
28 #include "lte-phy.h"
29 #include "lte-net-device.h"
30 
31 namespace ns3 {
32 
33 NS_LOG_COMPONENT_DEFINE ("LtePhy");
34 
36 
37 
39 {
40  NS_LOG_FUNCTION (this);
41  NS_FATAL_ERROR ("This constructor should not be called");
42 }
43 
45  : m_downlinkSpectrumPhy (dlPhy),
46  m_uplinkSpectrumPhy (ulPhy),
47  m_tti (0.001),
48  m_ulBandwidth (0),
49  m_dlBandwidth (0),
50  m_rbgSize (0),
51  m_macChTtiDelay (0),
52  m_cellId (0),
53  m_componentCarrierId(0)
54 {
55  NS_LOG_FUNCTION (this);
56 }
57 
58 
59 TypeId
61 {
62  static TypeId tid = TypeId ("ns3::LtePhy")
63  .SetParent<Object> ()
64  .SetGroupName("Lte")
65  ;
66  return tid;
67 }
68 
69 
71 {
72  NS_LOG_FUNCTION (this);
73 }
74 
75 void
77 {
78  NS_LOG_FUNCTION (this);
79  m_packetBurstQueue.clear ();
80  m_controlMessagesQueue.clear ();
81  m_downlinkSpectrumPhy->Dispose ();
83  m_uplinkSpectrumPhy->Dispose ();
85  m_netDevice = 0;
87 }
88 
89 void
91 {
92  NS_LOG_FUNCTION (this << d);
93  m_netDevice = d;
94 }
95 
96 
99 {
100  NS_LOG_FUNCTION (this);
101  return m_netDevice;
102 }
103 
106 {
107  return m_downlinkSpectrumPhy;
108 }
109 
112 {
113  return m_uplinkSpectrumPhy;
114 }
115 
116 
117 void
119 {
120  NS_LOG_FUNCTION (this << c);
121  m_downlinkSpectrumPhy->SetChannel (c);
122 }
123 
124 void
126 {
127  NS_LOG_FUNCTION (this << c);
128  m_uplinkSpectrumPhy->SetChannel (c);
129 }
130 
131 void
132 LtePhy::SetTti (double tti)
133 {
134  NS_LOG_FUNCTION (this << tti);
135  m_tti = tti;
136 }
137 
138 
139 double
140 LtePhy::GetTti (void) const
141 {
142  NS_LOG_FUNCTION (this << m_tti);
143  return m_tti;
144 }
145 
146 
147 uint16_t
148 LtePhy::GetSrsPeriodicity (uint16_t srcCi) const
149 {
150  // from 3GPP TS 36.213 table 8.2-1 UE Specific SRS Periodicity
151  uint16_t SrsPeriodicity[9] = {0, 2, 5, 10, 20, 40, 80, 160, 320};
152  uint16_t SrsCiLow[9] = {0, 0, 2, 7, 17, 37, 77, 157, 317};
153  uint16_t SrsCiHigh[9] = {0, 1, 6, 16, 36, 76, 156, 316, 636};
154  uint8_t i;
155  for (i = 8; i > 0; i --)
156  {
157  if ((srcCi>=SrsCiLow[i])&&(srcCi<=SrsCiHigh[i]))
158  {
159  break;
160  }
161  }
162  return SrsPeriodicity[i];
163 }
164 
165 uint16_t
166 LtePhy::GetSrsSubframeOffset (uint16_t srcCi) const
167 {
168  // from 3GPP TS 36.213 table 8.2-1 UE Specific SRS Periodicity
169  uint16_t SrsSubframeOffset[9] = {0, 0, 2, 7, 17, 37, 77, 157, 317};
170  uint16_t SrsCiLow[9] = {0, 0, 2, 7, 17, 37, 77, 157, 317};
171  uint16_t SrsCiHigh[9] = {0, 1, 6, 16, 36, 76, 156, 316, 636};
172  uint8_t i;
173  for (i = 8; i > 0; i --)
174  {
175  if ((srcCi>=SrsCiLow[i])&&(srcCi<=SrsCiHigh[i]))
176  {
177  break;
178  }
179  }
180  return (srcCi - SrsSubframeOffset[i]);
181 }
182 
183 uint8_t
184 LtePhy::GetRbgSize (void) const
185 {
186  return m_rbgSize;
187 }
188 
189 void
191 {
192  m_packetBurstQueue.at (m_packetBurstQueue.size () - 1)->AddPacket (p);
193 }
194 
197 {
198  if (m_packetBurstQueue.at (0)->GetSize () > 0)
199  {
200  Ptr<PacketBurst> ret = m_packetBurstQueue.at (0)->Copy ();
201  m_packetBurstQueue.erase (m_packetBurstQueue.begin ());
202  m_packetBurstQueue.push_back (CreateObject <PacketBurst> ());
203  return (ret);
204  }
205  else
206  {
207  m_packetBurstQueue.erase (m_packetBurstQueue.begin ());
208  m_packetBurstQueue.push_back (CreateObject <PacketBurst> ());
209  return (0);
210  }
211 }
212 
213 
214 void
216 {
217  // In uplink the queue of control messages and packet are of different sizes
218  // for avoiding TTI cancellation due to synchronization of subframe triggers
219  m_controlMessagesQueue.at (m_controlMessagesQueue.size () - 1).push_back (m);
220 }
221 
222 std::list<Ptr<LteControlMessage> >
224 {
225  NS_LOG_FUNCTION (this);
226  if (m_controlMessagesQueue.at (0).size () > 0)
227  {
228  std::list<Ptr<LteControlMessage> > ret = m_controlMessagesQueue.at (0);
230  std::list<Ptr<LteControlMessage> > newlist;
231  m_controlMessagesQueue.push_back (newlist);
232  return (ret);
233  }
234  else
235  {
237  std::list<Ptr<LteControlMessage> > newlist;
238  m_controlMessagesQueue.push_back (newlist);
239  std::list<Ptr<LteControlMessage> > emptylist;
240  return (emptylist);
241  }
242 }
243 
244 
245 void
246 LtePhy::DoSetCellId (uint16_t cellId)
247 {
248  m_cellId = cellId;
249  m_downlinkSpectrumPhy->SetCellId (cellId);
250  m_uplinkSpectrumPhy->SetCellId (cellId);
251 }
252 
253 void
255 {
256  m_componentCarrierId = index;
257  m_downlinkSpectrumPhy->SetComponentCarrierId (index);
258  m_uplinkSpectrumPhy->SetComponentCarrierId (index);
259 }
260 
261 uint8_t
263 {
264  return m_componentCarrierId;
265 }
266 
267 } // namespace ns3
void SetDevice(Ptr< LteNetDevice > d)
Set the device where the phy layer is attached.
Definition: lte-phy.cc:90
static TypeId GetTypeId(void)
Get the type ID.
Definition: lte-phy.cc:60
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:73
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by "...
void DoSetCellId(uint16_t cellId)
Definition: lte-phy.cc:246
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
Definition: object-base.h:45
uint8_t m_componentCarrierId
component carrier Id used to address sap
Definition: lte-phy.h:311
std::vector< Ptr< PacketBurst > > m_packetBurstQueue
A queue of packet bursts to be sent.
Definition: lte-phy.h:289
void SetComponentCarrierId(uint8_t index)
Set the component carrier ID.
Definition: lte-phy.cc:254
double m_tti
Transmission time interval.
Definition: lte-phy.h:264
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:202
Ptr< LteSpectrumPhy > m_downlinkSpectrumPhy
The downlink LteSpectrumPhy associated to this LtePhy.
Definition: lte-phy.h:238
void SetUplinkChannel(Ptr< SpectrumChannel > c)
Set the uplink channel.
Definition: lte-phy.cc:125
Ptr< LteSpectrumPhy > GetUplinkSpectrumPhy()
Definition: lte-phy.cc:111
#define NS_FATAL_ERROR(msg)
Report a fatal error with a message and terminate.
Definition: fatal-error.h:162
virtual void DoDispose(void)
Destructor implementation.
Definition: object.cc:346
uint16_t GetSrsPeriodicity(uint16_t srcCi) const
Definition: lte-phy.cc:148
double GetTti(void) const
Definition: lte-phy.cc:140
uint8_t GetRbgSize(void) const
Definition: lte-phy.cc:184
void DoDispose()
Destructor implementation.
Definition: lte-phy.cc:76
virtual ~LtePhy()
Definition: lte-phy.cc:70
void SetDownlinkChannel(Ptr< SpectrumChannel > c)
Set the downlink channel.
Definition: lte-phy.cc:118
uint16_t GetSrsSubframeOffset(uint16_t srcCi) const
Definition: lte-phy.cc:166
Ptr< LteSpectrumPhy > GetDownlinkSpectrumPhy()
Definition: lte-phy.cc:105
Every class exported by the ns3 library is enclosed in the ns3 namespace.
void SetControlMessages(Ptr< LteControlMessage > m)
Definition: lte-phy.cc:215
Ptr< LteNetDevice > GetDevice() const
Get the device where the phy layer is attached.
Definition: lte-phy.cc:98
uint16_t m_cellId
Cell identifier.
Definition: lte-phy.h:308
uint8_t GetComponentCarrierId()
Get the component carrier ID.
Definition: lte-phy.cc:262
Ptr< LteNetDevice > m_netDevice
Pointer to the NetDevice where this PHY layer is attached.
Definition: lte-phy.h:232
std::list< Ptr< LteControlMessage > > GetControlMessages(void)
Definition: lte-phy.cc:223
Ptr< PacketBurst > GetPacketBurst(void)
Definition: lte-phy.cc:196
uint8_t m_rbgSize
The RB group size according to the bandwidth.
Definition: lte-phy.h:276
std::vector< std::list< Ptr< LteControlMessage > > > m_controlMessagesQueue
A queue of control messages to be sent.
Definition: lte-phy.h:291
A base class which provides memory management and object aggregation.
Definition: object.h:87
Ptr< LteSpectrumPhy > m_uplinkSpectrumPhy
The uplink LteSpectrumPhy associated to this LtePhy.
Definition: lte-phy.h:243
void SetMacPdu(Ptr< Packet > p)
Definition: lte-phy.cc:190
a unique identifier for an interface.
Definition: type-id.h:58
void SetTti(double tti)
Definition: lte-phy.cc:132
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition: type-id.cc:915