/usr/include/ns3.17/ns3/lte-mac-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 | /* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2011 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>
*/
#ifndef LTE_MAC_SAP_H
#define LTE_MAC_SAP_H
#include <ns3/packet.h>
namespace ns3 {
/**
* Service Access Point (SAP) offered by the MAC to the RLC
* See Femto Forum MAC Scheduler Interface Specification v 1.11, Figure 1
*
* This is the MAC SAP Provider, i.e., the part of the SAP that contains the MAC methods called by the RLC
*/
class LteMacSapProvider
{
public:
virtual ~LteMacSapProvider ();
/**
* Parameters for LteMacSapProvider::TransmitPdu
*
*/
struct TransmitPduParameters
{
Ptr<Packet> pdu; /**< the RLC PDU */
uint16_t rnti; /**< the C-RNTI identifying the UE */
uint8_t lcid; /**< the logical channel id corresponding to the sending RLC instance */
uint8_t layer; /**< the layer value that was passed by the MAC in the call to NotifyTxOpportunity that generated this PDU */
uint8_t harqProcessId; /**< the HARQ process id that was passed by the MAC in the call to NotifyTxOpportunity that generated this PDU */
};
/**
* send an RLC PDU to the MAC for transmission. This method is to be
* called as a response to LteMacSapUser::NotifyTxOpportunity
*/
virtual void TransmitPdu (TransmitPduParameters params) = 0;
/**
* Parameters for LteMacSapProvider::ReportBufferStatus
*
* \param params
*/
struct ReportBufferStatusParameters
{
uint16_t rnti; /**< the C-RNTI identifying the UE */
uint8_t lcid; /**< the logical channel id corresponding to the sending RLC instance */
uint32_t txQueueSize; /**< the current size of the RLC transmission queue */
uint16_t txQueueHolDelay; /**< the Head Of Line delay of the transmission queue */
uint32_t retxQueueSize; /**< the current size of the RLC retransmission queue in bytes */
uint16_t retxQueueHolDelay; /**< the Head Of Line delay of the retransmission queue */
uint16_t statusPduSize; /**< the current size of the pending STATUS RLC PDU message in bytes */
};
/**
* Report the RLC buffer status to the MAC
*
* \param params
*/
virtual void ReportBufferStatus (ReportBufferStatusParameters params) = 0;
};
/**
* Service Access Point (SAP) offered by the MAC to the RLC
* See Femto Forum MAC Scheduler Interface Specification v 1.11, Figure 1
*
* This is the MAC SAP User, i.e., the part of the SAP that contains the RLC methods called by the MAC
*/
class LteMacSapUser
{
public:
virtual ~LteMacSapUser ();
/**
* Called by the MAC to notify the RLC that the scheduler granted a
* transmission opportunity to this RLC instance.
*
* \param bytes the number of bytes to transmit
* \param layer the layer of transmission (MIMO)
*/
virtual void NotifyTxOpportunity (uint32_t bytes, uint8_t layer, uint8_t harqId) = 0;
/**
* Called by the MAC to notify the RLC that an HARQ process related
* to this RLC instance has failed
*
* @todo eventual parameters to be defined
*/
virtual void NotifyHarqDeliveryFailure () = 0;
/**
* Called by the MAC to notify the RLC of the reception of a new PDU
*
* \param p
*/
virtual void ReceivePdu (Ptr<Packet> p) = 0;
};
///////////////////////////////////////
template <class C>
class EnbMacMemberLteMacSapProvider : public LteMacSapProvider
{
public:
EnbMacMemberLteMacSapProvider (C* mac);
// inherited from LteMacSapProvider
virtual void TransmitPdu (TransmitPduParameters params);
virtual void ReportBufferStatus (ReportBufferStatusParameters params);
private:
C* m_mac;
};
template <class C>
EnbMacMemberLteMacSapProvider<C>::EnbMacMemberLteMacSapProvider (C* mac)
: m_mac (mac)
{
}
template <class C>
void EnbMacMemberLteMacSapProvider<C>::TransmitPdu (TransmitPduParameters params)
{
m_mac->DoTransmitPdu (params);
}
template <class C>
void EnbMacMemberLteMacSapProvider<C>::ReportBufferStatus (ReportBufferStatusParameters params)
{
m_mac->DoReportBufferStatus (params);
}
} // namespace ns3
#endif // LTE_MAC_SAP_H
|