/usr/include/ns3.27/ns3/lte-ue-phy.h is in libns3-dev 3.27+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2010 TELEMATICS LAB, DEE - Politecnico di Bari
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation;
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* Author: Giuseppe Piro <g.piro@poliba.it>
* Author: Marco Miozzo <mmiozzo@cttc.es>
*/
#ifndef LTE_UE_PHY_H
#define LTE_UE_PHY_H
#include <ns3/lte-phy.h>
#include <ns3/ff-mac-common.h>
#include <ns3/lte-control-messages.h>
#include <ns3/lte-amc.h>
#include <ns3/lte-ue-phy-sap.h>
#include <ns3/lte-ue-cphy-sap.h>
#include <ns3/ptr.h>
#include <ns3/lte-amc.h>
#include <set>
#include <ns3/lte-ue-power-control.h>
namespace ns3 {
class PacketBurst;
class LteEnbPhy;
class LteHarqPhy;
/**
* \ingroup lte
*
* The LteSpectrumPhy models the physical layer of LTE
*/
class LteUePhy : public LtePhy
{
/// allow UeMemberLteUePhySapProvider class friend access
friend class UeMemberLteUePhySapProvider;
/// allow MemberLteUeCphySapProvider<LteUePhy> class friend access
friend class MemberLteUeCphySapProvider<LteUePhy>;
public:
/**
* \brief The states of the UE PHY entity
*/
enum State
{
CELL_SEARCH = 0,
SYNCHRONIZED,
NUM_STATES
};
/**
* @warning the default constructor should not be used
*/
LteUePhy ();
/**
*
* \param dlPhy the downlink LteSpectrumPhy instance
* \param ulPhy the uplink LteSpectrumPhy instance
*/
LteUePhy (Ptr<LteSpectrumPhy> dlPhy, Ptr<LteSpectrumPhy> ulPhy);
virtual ~LteUePhy ();
/**
* \brief Get the type ID.
* \return the object TypeId
*/
static TypeId GetTypeId (void);
// inherited from Object
virtual void DoInitialize (void);
virtual void DoDispose (void);
/**
* \brief Get the PHY SAP provider
* \return a pointer to the SAP Provider
*/
LteUePhySapProvider* GetLteUePhySapProvider ();
/**
* \brief Set the PHY SAP User
* \param s a pointer to the SAP user
*/
void SetLteUePhySapUser (LteUePhySapUser* s);
/**
* \brief Get the CPHY SAP provider
* \return a pointer to the SAP Provider
*/
LteUeCphySapProvider* GetLteUeCphySapProvider ();
/**
* \brief Set the CPHY SAP User
* \param s a pointer to the SAP user
*/
void SetLteUeCphySapUser (LteUeCphySapUser* s);
/**
* \param pow the transmission power in dBm
*/
void SetTxPower (double pow);
/**
* \return the transmission power in dBm
*/
double GetTxPower () const;
/**
* \return ptr to UE Uplink Power Control entity
*/
Ptr<LteUePowerControl> GetUplinkPowerControl () const;
/**
* \param nf the noise figure in dB
*/
void SetNoiseFigure (double nf);
/**
* \return the noise figure in dB
*/
double GetNoiseFigure () const;
/**
* \returns the TTI delay between MAC and channel
*/
uint8_t GetMacChDelay (void) const;
/**
* \return a pointer to the LteSpectrumPhy instance relative to the downlink
*/
Ptr<LteSpectrumPhy> GetDlSpectrumPhy () const;
/**
* \return a pointer to the LteSpectrumPhy instance relative to the uplink
*/
Ptr<LteSpectrumPhy> GetUlSpectrumPhy () const;
/**
* \brief Create the PSD for the TX
* \return the pointer to the PSD
*/
virtual Ptr<SpectrumValue> CreateTxPowerSpectralDensity ();
/**
* \brief Set a list of sub channels to use in TX
* \param mask a list of sub channels
*/
void SetSubChannelsForTransmission (std::vector <int> mask);
/**
* \brief Get a list of sub channels to use in RX
* \return a list of sub channels
*/
std::vector <int> GetSubChannelsForTransmission (void);
/**
* \brief Get a list of sub channels to use in RX
* \param mask list of sub channels
*/
void SetSubChannelsForReception (std::vector <int> mask);
/**
* \brief Get a list of sub channels to use in RX
* \return a list of sub channels
*/
std::vector <int> GetSubChannelsForReception (void);
/**
* \brief Create the DL CQI feedback from SINR values perceived at
* the physical layer with the signal received from eNB
* \param sinr SINR values vector
* \return a DL CQI control message containing the CQI feedback
*/
Ptr<DlCqiLteControlMessage> CreateDlCqiFeedbackMessage (const SpectrumValue& sinr);
// inherited from LtePhy
virtual void GenerateCtrlCqiReport (const SpectrumValue& sinr);
virtual void GenerateDataCqiReport (const SpectrumValue& sinr);
/**
* \brief Create the mixed CQI report
*
* \param sinr SINR values vector
*/
virtual void GenerateMixedCqiReport (const SpectrumValue& sinr);
virtual void ReportInterference (const SpectrumValue& interf);
/**
* \brief Create the mixed CQI report
*
* \param interf interference values vector
*/
virtual void ReportDataInterference (const SpectrumValue& interf);
virtual void ReportRsReceivedPower (const SpectrumValue& power);
// callbacks for LteSpectrumPhy
/**
* \brief Receive LTE control message list function
*
* \param msgList LTE control message list
*/
virtual void ReceiveLteControlMessageList (std::list<Ptr<LteControlMessage> > msgList);
/**
* \brief Receive PSS function
*
* \param cellId the cell ID
* \param p PSS list
*/
virtual void ReceivePss (uint16_t cellId, Ptr<SpectrumValue> p);
/**
* \brief PhySpectrum received a new PHY-PDU
* \param p the packet received
*/
void PhyPduReceived (Ptr<Packet> p);
/**
* \brief trigger from eNB the start from a new frame
*
* \param frameNo frame number
* \param subframeNo subframe number
*/
void SubframeIndication (uint32_t frameNo, uint32_t subframeNo);
/**
* \brief Send the SRS signal in the last symbols of the frame
*/
void SendSrs ();
/**
* \brief PhySpectrum generated a new DL HARQ feedback
* \param mes the DlInfoListElement_s
*/
virtual void ReceiveLteDlHarqFeedback (DlInfoListElement_s mes);
/**
* \brief Set the HARQ PHY module
* \param harq the HARQ PHY module
*/
void SetHarqPhyModule (Ptr<LteHarqPhy> harq);
/**
* \return The current state
*/
State GetState () const;
/**
* TracedCallback signature for state transition events.
*
* \param [in] cellId
* \param [in] rnti
* \param [in] oldState
* \param [in] newState
*/
typedef void (* StateTracedCallback)
(uint16_t cellId, uint16_t rnti, State oldState, State newState);
/**
* TracedCallback signature for cell RSRP and SINR report.
*
* \param [in] cellId
* \param [in] rnti
* \param [in] rsrp
* \param [in] sinr
* \param [in] componentCarrierId
*/
typedef void (* RsrpSinrTracedCallback)
(uint16_t cellId, uint16_t rnti,
double rsrp, double sinr, uint8_t componentCarrierId);
/**
* TracedCallback signature for cell RSRP and RSRQ.
*
* \param [in] rnti
* \param [in] cellId
* \param [in] rsrp
* \param [in] rsrq
* \param [in] isServingCell
* \param [in] componentCarrierId
*/
typedef void (* RsrpRsrqTracedCallback)
(uint16_t rnti, uint16_t cellId, double rsrp, double rsrq,
bool isServingCell, uint8_t componentCarrierId);
private:
/**
* Set transmit mode 1 gain function
*
* \param [in] gain
*/
void SetTxMode1Gain (double gain);
/**
* Set transmit mode 2 gain function
*
* \param [in] gain
*/
void SetTxMode2Gain (double gain);
/**
* Set transmit mode 3 gain function
*
* \param [in] gain
*/
void SetTxMode3Gain (double gain);
/**
* Set transmit mode 4 gain function
*
* \param [in] gain
*/
void SetTxMode4Gain (double gain);
/**
* Set transmit mode 5 gain function
*
* \param [in] gain
*/
void SetTxMode5Gain (double gain);
/**
* Set transmit mode 6 gain function
*
* \param [in] gain
*/
void SetTxMode6Gain (double gain);
/**
* Set transmit mode 7 gain function
*
* \param [in] gain
*/
void SetTxMode7Gain (double gain);
/**
* Set transmit mode gain function
*
* \param [in] txMode
* \param [in] gain
*/
void SetTxModeGain (uint8_t txMode, double gain);
/**
* queue subchannels for transmission function
*
* \param [in] rbMap
*/
void QueueSubChannelsForTransmission (std::vector <int> rbMap);
/**
* internal method that takes care of generating CQI reports,
* calculating the RSRP and RSRQ metrics, and generating RSRP+SINR traces
*
* \param sinr
*/
void GenerateCqiRsrpRsrq (const SpectrumValue& sinr);
/**
* \brief Layer-1 filtering of RSRP and RSRQ measurements and reporting to
* the RRC entity.
*
* Initially executed at +0.200s, and then repeatedly executed with
* periodicity as indicated by the *UeMeasurementsFilterPeriod* attribute.
*/
void ReportUeMeasurements ();
/**
* Switch the UE PHY to the given state.
* \param s the destination state
*/
void SwitchToState (State s);
// UE CPHY SAP methods
/// Reset function
void DoReset ();
/**
* Start the cell search function
* \param dlEarfcn the DL EARFCN
*/
void DoStartCellSearch (uint32_t dlEarfcn);
/**
* Synchronize with ENB function
* \param cellId the cell ID
*/
void DoSynchronizeWithEnb (uint16_t cellId);
/**
* Synchronize with ENB function
* \param cellId the cell ID
* \param dlEarfcn the DL EARFCN
*/
void DoSynchronizeWithEnb (uint16_t cellId, uint32_t dlEarfcn);
/**
* Set DL bandwidth function
* \param dlBandwidth the DL bandwidth
*/
void DoSetDlBandwidth (uint8_t dlBandwidth);
/**
* Configure UL uplink function
* \param ulEarfcn UL EARFCN
* \param ulBandwidth the UL bandwidth
*/
void DoConfigureUplink (uint32_t ulEarfcn, uint8_t ulBandwidth);
/**
* Configure reference signal power function
* \param referenceSignalPower reference signal power
*/
void DoConfigureReferenceSignalPower (int8_t referenceSignalPower);
/**
* Set RNTI function
* \param rnti the RNTI
*/
void DoSetRnti (uint16_t rnti);
/**
* Set transmission mode function
* \param txMode the transmission mode
*/
void DoSetTransmissionMode (uint8_t txMode);
/**
* Set SRS configuration index function
* \param srcCi the SRS configuration index
*/
void DoSetSrsConfigurationIndex (uint16_t srcCi);
/**
* Set PA function
* \param pa the PA value
*/
void DoSetPa (double pa);
// UE PHY SAP methods
virtual void DoSendMacPdu (Ptr<Packet> p);
/**
* Send LTE conrol message function
* \param msg the LTE control message
*/
virtual void DoSendLteControlMessage (Ptr<LteControlMessage> msg);
/**
* Send RACH preamble function
* \param prachId the RACH preamble ID
* \param raRnti the rnti
*/
virtual void DoSendRachPreamble (uint32_t prachId, uint32_t raRnti);
/// A list of sub channels to use in TX.
std::vector <int> m_subChannelsForTransmission;
/// A list of sub channels to use in RX.
std::vector <int> m_subChannelsForReception;
std::vector< std::vector <int> > m_subChannelsForTransmissionQueue; ///< subchannels for transmission queue
Ptr<LteAmc> m_amc; ///< AMC
/**
* The `EnableUplinkPowerControl` attribute. If true, Uplink Power Control
* will be enabled.
*/
bool m_enableUplinkPowerControl;
/// Pointer to UE Uplink Power Control entity.
Ptr<LteUePowerControl> m_powerControl;
/// Wideband Periodic CQI. 2, 5, 10, 16, 20, 32, 40, 64, 80 or 160 ms.
Time m_p10CqiPeriodicity;
Time m_p10CqiLast; ///< last periodic CQI
/**
* SubBand Aperiodic CQI. Activated by DCI format 0 or Random Access Response
* Grant.
* \note Defines a periodicity for academic studies.
*/
Time m_a30CqiPeriodicity;
Time m_a30CqiLast; ///< last aperiodic CQI
LteUePhySapProvider* m_uePhySapProvider; ///< UE Phy SAP provider
LteUePhySapUser* m_uePhySapUser; ///< UE Phy SAP user
LteUeCphySapProvider* m_ueCphySapProvider; ///< UE CPhy SAP provider
LteUeCphySapUser* m_ueCphySapUser; ///< UE CPhy SAP user
uint16_t m_rnti; ///< the RNTI
uint8_t m_transmissionMode; ///< the transmission mode
std::vector <double> m_txModeGain; ///< the transmit mode gain
uint16_t m_srsPeriodicity; ///< SRS periodicity
uint16_t m_srsSubframeOffset; ///< SRS subframe offset
uint16_t m_srsConfigured; ///< SRS configured
Time m_srsStartTime; ///< SRS start time
double m_paLinear; ///< PA linear
bool m_dlConfigured; ///< DL configured?
bool m_ulConfigured; ///< UL configured?
/// The current UE PHY state.
State m_state;
/**
* The `StateTransition` trace source. Fired upon every UE PHY state
* transition. Exporting the serving cell ID, RNTI, old state, and new state.
*/
TracedCallback<uint16_t, uint16_t, State, State> m_stateTransitionTrace;
/// \todo Can be removed.
uint8_t m_subframeNo;
bool m_rsReceivedPowerUpdated; ///< RS receive power updated?
SpectrumValue m_rsReceivedPower; ///< RS receive power
bool m_rsInterferencePowerUpdated; ///< RS interference power updated?
SpectrumValue m_rsInterferencePower; ///< RS interference power
bool m_dataInterferencePowerUpdated; ///< data interference power updated?
SpectrumValue m_dataInterferencePower; ///< data interference power
bool m_pssReceived; ///< PSS received?
/// PssElement structure
struct PssElement
{
uint16_t cellId; ///< cell ID
double pssPsdSum; ///< PSS PSD sum
uint16_t nRB; ///< number of RB
};
std::list <PssElement> m_pssList; ///< PSS list
/**
* The `RsrqUeMeasThreshold` attribute. Receive threshold for PSS on RSRQ
* in dB.
*/
double m_pssReceptionThreshold;
/// Summary results of measuring a specific cell. Used for layer-1 filtering.
struct UeMeasurementsElement
{
double rsrpSum; ///< Sum of RSRP sample values in linear unit.
uint8_t rsrpNum; ///< Number of RSRP samples.
double rsrqSum; ///< Sum of RSRQ sample values in linear unit.
uint8_t rsrqNum; ///< Number of RSRQ samples.
};
/**
* Store measurement results during the last layer-1 filtering period.
* Indexed by the cell ID where the measurements come from.
*/
std::map <uint16_t, UeMeasurementsElement> m_ueMeasurementsMap;
/**
* The `UeMeasurementsFilterPeriod` attribute. Time period for reporting UE
* measurements, i.e., the length of layer-1 filtering (default 200 ms).
*/
Time m_ueMeasurementsFilterPeriod;
/// \todo Can be removed.
Time m_ueMeasurementsFilterLast;
Ptr<LteHarqPhy> m_harqPhyModule; ///< HARQ phy module
uint32_t m_raPreambleId; ///< RA preamble ID
uint32_t m_raRnti; ///< RA rnti
/**
* The `ReportCurrentCellRsrpSinr` trace source. Trace information regarding
* RSRP and average SINR (see TS 36.214). Exporting cell ID, RNTI, RSRP, and
* SINR. Moreover it reports the m_componentCarrierId.
*/
TracedCallback<uint16_t, uint16_t, double, double, uint8_t> m_reportCurrentCellRsrpSinrTrace;
/**
* The `RsrpSinrSamplePeriod` attribute. The sampling period for reporting
* RSRP-SINR stats.
*/
uint16_t m_rsrpSinrSamplePeriod;
/**
* The `RsrpSinrSampleCounter` attribute. The sampling counter for reporting
* RSRP-SINR stats.
*/
uint16_t m_rsrpSinrSampleCounter;
/**
* The `ReportUeMeasurements` trace source. Contains trace information
* regarding RSRP and RSRQ measured from a specific cell (see TS 36.214).
* Exporting RNTI, the ID of the measured cell, RSRP (in dBm), RSRQ (in dB),
* and whether the cell is the serving cell. Moreover it report the m_componentCarrierId.
*/
TracedCallback<uint16_t, uint16_t, double, double, bool, uint8_t> m_reportUeMeasurements;
EventId m_sendSrsEvent; ///< send SRS event
/**
* The `UlPhyTransmission` trace source. Contains trace information regarding
* PHY stats from UL Tx perspective. Exporting a structure with type
* PhyTransmissionStatParameters.
*/
TracedCallback<PhyTransmissionStatParameters> m_ulPhyTransmission;
Ptr<SpectrumValue> m_noisePsd; ///< Noise power spectral density for
///the configured bandwidth
}; // end of `class LteUePhy`
}
#endif /* LTE_UE_PHY_H */
|