/usr/include/ns3.17/ns3/lte-ue-cphy-sap.h is in libns3-dev 3.17+dfsg-1build1.
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 | /* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2011, 2012 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
*
* 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: Nicola Baldo <nbaldo@cttc.es>,
* Marco Miozzo <mmiozzo@cttc.es>
*/
#ifndef LTE_UE_CPHY_SAP_H
#define LTE_UE_CPHY_SAP_H
#include <stdint.h>
#include <ns3/ptr.h>
#include <ns3/lte-rrc-sap.h>
namespace ns3 {
class LteEnbNetDevice;
/**
* Service Access Point (SAP) offered by the UE PHY to the UE RRC for control purposes
*
* This is the PHY SAP Provider, i.e., the part of the SAP that contains
* the PHY methods called by the MAC
*/
class LteUeCphySapProvider
{
public:
/**
* destructor
*/
virtual ~LteUeCphySapProvider ();
/**
* reset the PHY
*
*/
virtual void Reset () = 0;
/**
* tell the PHY to synchronize with a given eNB for communication purposes
*
* \param cellId the ID of the eNB
* \param dlEarfcn the carrier frequency (EARFCN) in downlink
*/
virtual void SyncronizeWithEnb (uint16_t cellId, uint16_t dlEarfcn) = 0;
/**
* \param dlBandwidth the DL bandwidth in PRBs
*/
virtual void SetDlBandwidth (uint8_t dlBandwidth) = 0;
/**
* Configure uplink (normally done after reception of SIB2)
*
* \param ulEarfcn the carrier frequency (EARFCN) in uplink
* \param ulBandwidth the UL bandwidth in PRBs
*/
virtual void ConfigureUplink (uint16_t ulEarfcn, uint8_t ulBandwidth) = 0;
/**
*
* \param rnti the cell-specific UE identifier
*/
virtual void SetRnti (uint16_t rnti) = 0;
/**
* \param txMode the transmissionMode of the user
*/
virtual void SetTransmissionMode (uint8_t txMode) = 0;
/**
* \param txMode the transmissionMode of the user
*/
virtual void SetSrsConfigurationIndex (uint16_t srcCi) = 0;
};
/**
* Service Access Point (SAP) offered by the UE PHY to the UE RRC for control purposes
*
* This is the CPHY SAP User, i.e., the part of the SAP that contains the RRC
* methods called by the PHY
*/
class LteUeCphySapUser
{
public:
/**
* destructor
*/
virtual ~LteUeCphySapUser ();
/**
*
* \param mib the Master Information Block received on the BCH
*/
virtual void RecvMasterInformationBlock (LteRrcSap::MasterInformationBlock mib) = 0;
};
/**
* Template for the implementation of the LteUeCphySapProvider as a member
* of an owner class of type C to which all methods are forwarded
*
*/
template <class C>
class MemberLteUeCphySapProvider : public LteUeCphySapProvider
{
public:
MemberLteUeCphySapProvider (C* owner);
// inherited from LteUeCphySapProvider
virtual void Reset ();
virtual void SyncronizeWithEnb (uint16_t cellId, uint16_t dlEarfcn);
virtual void SetDlBandwidth (uint8_t ulBandwidth);
virtual void ConfigureUplink (uint16_t ulEarfcn, uint8_t ulBandwidth);
virtual void SetRnti (uint16_t rnti);
virtual void SetTransmissionMode (uint8_t txMode);
virtual void SetSrsConfigurationIndex (uint16_t srcCi);
private:
MemberLteUeCphySapProvider ();
C* m_owner;
};
template <class C>
MemberLteUeCphySapProvider<C>::MemberLteUeCphySapProvider (C* owner)
: m_owner (owner)
{
}
template <class C>
MemberLteUeCphySapProvider<C>::MemberLteUeCphySapProvider ()
{
}
template <class C>
void
MemberLteUeCphySapProvider<C>::Reset ()
{
m_owner->DoReset ();
}
template <class C>
void
MemberLteUeCphySapProvider<C>::SyncronizeWithEnb (uint16_t cellId, uint16_t dlEarfcn)
{
m_owner->DoSyncronizeWithEnb (cellId, dlEarfcn);
}
template <class C>
void
MemberLteUeCphySapProvider<C>::SetDlBandwidth (uint8_t dlBandwidth)
{
m_owner->DoSetDlBandwidth (dlBandwidth);
}
template <class C>
void
MemberLteUeCphySapProvider<C>::ConfigureUplink (uint16_t ulEarfcn, uint8_t ulBandwidth)
{
m_owner->DoConfigureUplink (ulEarfcn, ulBandwidth);
}
template <class C>
void
MemberLteUeCphySapProvider<C>::SetRnti (uint16_t rnti)
{
m_owner->DoSetRnti (rnti);
}
template <class C>
void
MemberLteUeCphySapProvider<C>::SetTransmissionMode (uint8_t txMode)
{
m_owner->DoSetTransmissionMode (txMode);
}
template <class C>
void
MemberLteUeCphySapProvider<C>::SetSrsConfigurationIndex (uint16_t srcCi)
{
m_owner->DoSetSrsConfigurationIndex (srcCi);
}
/**
* Template for the implementation of the LteUeCphySapUser as a member
* of an owner class of type C to which all methods are forwarded
*
*/
template <class C>
class MemberLteUeCphySapUser : public LteUeCphySapUser
{
public:
MemberLteUeCphySapUser (C* owner);
// methods inherited from LteUeCphySapUser go here
virtual void RecvMasterInformationBlock (LteRrcSap::MasterInformationBlock mib);
private:
MemberLteUeCphySapUser ();
C* m_owner;
};
template <class C>
MemberLteUeCphySapUser<C>::MemberLteUeCphySapUser (C* owner)
: m_owner (owner)
{
}
template <class C>
MemberLteUeCphySapUser<C>::MemberLteUeCphySapUser ()
{
}
template <class C>
void
MemberLteUeCphySapUser<C>::RecvMasterInformationBlock (LteRrcSap::MasterInformationBlock mib)
{
m_owner->DoRecvMasterInformationBlock (mib);
}
} // namespace ns3
#endif // LTE_UE_CPHY_SAP_H
|