A Discrete-Event Network Simulator
API
lte-enb-cmac-sap.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2011 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License version 2 as
6 * published by the Free Software Foundation;
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this program; if not, write to the Free Software
15 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16 *
17 * Author: Nicola Baldo <nbaldo@cttc.es>
18 * Marco Miozzo <mmiozzo@cttc.es>
19 */
20
21#ifndef LTE_ENB_CMAC_SAP_H
22#define LTE_ENB_CMAC_SAP_H
23
24#include <ns3/eps-bearer.h>
25#include <ns3/ff-mac-common.h>
26#include <ns3/lte-common.h>
27#include <ns3/packet.h>
28
29namespace ns3
30{
31
32class LteMacSapUser;
33
42{
43 public:
44 virtual ~LteEnbCmacSapProvider();
51 virtual void ConfigureMac(uint16_t ulBandwidth, uint16_t dlBandwidth) = 0;
52
58 virtual void AddUe(uint16_t rnti) = 0;
59
65 virtual void RemoveUe(uint16_t rnti) = 0;
66
71 struct LcInfo
72 {
73 uint16_t rnti;
74 uint8_t lcId;
75 uint8_t lcGroup;
76 uint8_t qci;
77 bool isGbr;
78 uint64_t mbrUl;
79 uint64_t mbrDl;
80 uint64_t gbrUl;
81 uint64_t gbrDl;
82 };
83
90 virtual void AddLc(LcInfo lcinfo, LteMacSapUser* msu) = 0;
91
97 virtual void ReconfigureLc(LcInfo lcinfo) = 0;
98
105 virtual void ReleaseLc(uint16_t rnti, uint8_t lcid) = 0;
106
110 struct UeConfig
111 {
115 uint16_t m_rnti;
120 };
121
127 virtual void UeUpdateConfigurationReq(UeConfig params) = 0;
128
134 {
139 };
140
146
152 {
153 bool valid;
154 uint8_t raPreambleId;
156 };
157
167};
168
177{
178 public:
179 virtual ~LteEnbCmacSapUser();
180
186 virtual uint16_t AllocateTemporaryCellRnti() = 0;
187
195 virtual void NotifyLcConfigResult(uint16_t rnti, uint8_t lcid, bool success) = 0;
196
200 struct UeConfig
201 {
205 uint16_t m_rnti;
210 };
211
217 virtual void RrcConfigurationUpdateInd(UeConfig params) = 0;
218
231 virtual bool IsRandomAccessCompleted(uint16_t rnti) = 0;
232};
233
234} // namespace ns3
235
236#endif // MAC_SAP_H
Service Access Point (SAP) offered by the eNB MAC to the eNB RRC See Femto Forum MAC Scheduler Interf...
virtual RachConfig GetRachConfig()=0
virtual void ReleaseLc(uint16_t rnti, uint8_t lcid)=0
release an existing logical channel
virtual void AddLc(LcInfo lcinfo, LteMacSapUser *msu)=0
Add a new logical channel.
virtual void UeUpdateConfigurationReq(UeConfig params)=0
update the configuration of the UE
virtual void AddUe(uint16_t rnti)=0
Add UE function.
virtual AllocateNcRaPreambleReturnValue AllocateNcRaPreamble(uint16_t rnti)=0
Allocate a random access preamble for non-contention based random access (e.g., for handover).
virtual void RemoveUe(uint16_t rnti)=0
remove the UE, e.g., after handover or termination of the RRC connection
virtual void ReconfigureLc(LcInfo lcinfo)=0
Reconfigure an existing logical channel.
virtual void ConfigureMac(uint16_t ulBandwidth, uint16_t dlBandwidth)=0
Service Access Point (SAP) offered by the MAC to the RRC See Femto Forum MAC Scheduler Interface Spec...
virtual bool IsRandomAccessCompleted(uint16_t rnti)=0
Is random access completed function.
virtual void RrcConfigurationUpdateInd(UeConfig params)=0
Notify the RRC of a UE config updated requested by the MAC (normally, by the scheduler)
virtual void NotifyLcConfigResult(uint16_t rnti, uint8_t lcid, bool success)=0
notify the result of the last LC config operation
virtual uint16_t AllocateTemporaryCellRnti()=0
request the allocation of a Temporary C-RNTI
Service Access Point (SAP) offered by the MAC to the RLC See Femto Forum MAC Scheduler Interface Spec...
Definition: lte-mac-sap.h:96
Every class exported by the ns3 library is enclosed in the ns3 namespace.
AllocateNcRaPreambleReturnValue structure.
bool valid
true if a valid RA config was allocated, false otherwise
Logical Channel information to be passed to CmacSapProvider::ConfigureLc.
uint64_t gbrUl
guaranteed bitrate in uplink
uint8_t qci
QoS Class Identifier.
uint64_t mbrDl
maximum bitrate in downlink
uint64_t mbrUl
maximum bitrate in uplink
uint8_t lcGroup
logical channel group
uint64_t gbrDl
guaranteed bitrate in downlink
uint8_t lcId
logical channel identifier
bool isGbr
true if the bearer is GBR, false if the bearer is NON-GBR
uint16_t rnti
C-RNTI identifying the UE.
struct defining the RACH configuration of the MAC
uint8_t preambleTransMax
preamble transmit maximum
uint8_t raResponseWindowSize
RA response window size.
uint8_t connEstFailCount
the counter value for T300 timer expiration
uint8_t numberOfRaPreambles
number of RA preambles
Parameters for [re]configuring the UE.
uint16_t m_rnti
UE id within this cell.
uint8_t m_transmissionMode
Transmission mode [1..7] (i.e., SISO, MIMO, etc.)
Parameters for [re]configuring the UE.
uint16_t m_rnti
UE id within this cell.
uint8_t m_transmissionMode
Transmission mode [1..7] (i.e., SISO, MIMO, etc.)