Service Access Point (SAP) offered by the UE PHY to the UE RRC for control purposes. More...

#include "lte-ue-cphy-sap.h"

Inheritance diagram for ns3::LteUeCphySapProvider:

Public Member Functions
virtual	~LteUeCphySapProvider ()
	Destructor.

virtual void	ConfigureReferenceSignalPower (int8_t referenceSignalPower)=0
	Configure referenceSignalPower.

virtual void	ConfigureUplink (uint32_t ulEarfcn, uint16_t ulBandwidth)=0
	Configure uplink (normally done after reception of SIB2)

virtual uint16_t	GetCellId ()=0
	Get PHY cell ID.

virtual uint32_t	GetDlEarfcn ()=0
	Get PHY DL EARFCN.

virtual void	Reset ()=0
	Reset the PHY.

virtual void	ResetPhyAfterRlf ()=0
	Reset the PHY after radio link failure function It resets the physical layer parameters of the UE after RLF.

virtual void	ResetRlfParams ()=0
	Reset radio link failure parameters.

virtual void	SetDlBandwidth (uint16_t dlBandwidth)=0

virtual void	SetImsi (uint64_t imsi)=0
	A method call by UE RRC to communicate the IMSI to the UE PHY.

virtual void	SetPa (double pa)=0
	Set P_A value for UE power control.

virtual void	SetRnti (uint16_t rnti)=0
	Set Rnti function.

virtual void	SetRsrpFilterCoefficient (uint8_t rsrpFilterCoefficient)=0
	Set RSRP filter coefficient.

virtual void	SetSrsConfigurationIndex (uint16_t srcCi)=0
	Set SRS configuration index.

virtual void	SetTransmissionMode (uint8_t txMode)=0
	Set transmission mode.

virtual void	StartCellSearch (uint32_t dlEarfcn)=0
	Tell the PHY entity to listen to PSS from surrounding cells and measure the RSRP.

virtual void	StartInSyncDetection ()=0
	Start in-sync detection function When T310 timer is started, it indicates that physical layer problems are detected at the UE and the recovery process is started by checking if the radio frames are in-sync for N311 consecutive times.

virtual void	SynchronizeWithEnb (uint16_t cellId)=0
	Tell the PHY entity to synchronize with a given eNodeB over the currently active EARFCN for communication purposes.

virtual void	SynchronizeWithEnb (uint16_t cellId, uint32_t dlEarfcn)=0
	Tell the PHY entity to align to the given EARFCN and synchronize with a given eNodeB for communication purposes.

Detailed Description

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

Definition at line 30 of file lte-ue-cphy-sap.h.

Constructor & Destructor Documentation

◆ ~LteUeCphySapProvider()

ns3::LteUeCphySapProvider::~LteUeCphySapProvider ( )

virtual

Destructor.

Definition at line 14 of file lte-ue-cphy-sap.cc.

Member Function Documentation

◆ ConfigureReferenceSignalPower()

virtual void ns3::LteUeCphySapProvider::ConfigureReferenceSignalPower ( int8_t referenceSignalPower )

pure virtual

Configure referenceSignalPower.

Parameters

referenceSignalPower received from eNB in SIB2

Implemented in ns3::MemberLteUeCphySapProvider< C >.

◆ ConfigureUplink()

virtual void ns3::LteUeCphySapProvider::ConfigureUplink	(	uint32_t	ulEarfcn,
		uint16_t	ulBandwidth )

pure virtual

Configure uplink (normally done after reception of SIB2)

Parameters

ulEarfcn	the uplink carrier frequency (EARFCN)
ulBandwidth	the UL bandwidth in number of PRBs

Implemented in ns3::MemberLteUeCphySapProvider< C >.

◆ GetCellId()

virtual uint16_t ns3::LteUeCphySapProvider::GetCellId ( )

pure virtual

Get PHY cell ID.

Returns: cell ID this PHY is synchronized to

Implemented in ns3::MemberLteUeCphySapProvider< C >.

◆ GetDlEarfcn()

virtual uint32_t ns3::LteUeCphySapProvider::GetDlEarfcn ( )

pure virtual

Get PHY DL EARFCN.

Returns: DL EARFCN this PHY is synchronized to

Implemented in ns3::MemberLteUeCphySapProvider< C >.

◆ Reset()

virtual void ns3::LteUeCphySapProvider::Reset ( )

pure virtual

Reset the PHY.

Implemented in ns3::MemberLteUeCphySapProvider< C >.

◆ ResetPhyAfterRlf()

virtual void ns3::LteUeCphySapProvider::ResetPhyAfterRlf ( )

pure virtual

Reset the PHY after radio link failure function It resets the physical layer parameters of the UE after RLF.

Implemented in ns3::MemberLteUeCphySapProvider< C >.

◆ ResetRlfParams()

virtual void ns3::LteUeCphySapProvider::ResetRlfParams ( )

pure virtual

Reset radio link failure parameters.

Upon receiving N311 in-sync indications from the UE PHY the UE RRC instructs the UE PHY to reset the RLF parameters so, it can start RLF detection again.

Implemented in ns3::MemberLteUeCphySapProvider< C >.

◆ SetDlBandwidth()

virtual void ns3::LteUeCphySapProvider::SetDlBandwidth ( uint16_t dlBandwidth )

pure virtual

Parameters

dlBandwidth the DL bandwidth in number of PRBs

Implemented in ns3::MemberLteUeCphySapProvider< C >.

◆ SetImsi()

virtual void ns3::LteUeCphySapProvider::SetImsi ( uint64_t imsi )

pure virtual

A method call by UE RRC to communicate the IMSI to the UE PHY.

Parameters

imsi	the IMSI of the UE

Implemented in ns3::MemberLteUeCphySapProvider< C >.

◆ SetPa()

virtual void ns3::LteUeCphySapProvider::SetPa ( double pa )

pure virtual

Set P_A value for UE power control.

Parameters

pa	the P_A value

Implemented in ns3::MemberLteUeCphySapProvider< C >.

◆ SetRnti()

virtual void ns3::LteUeCphySapProvider::SetRnti ( uint16_t rnti )

pure virtual

Set Rnti function.

Parameters

rnti	the cell-specific UE identifier

Implemented in ns3::MemberLteUeCphySapProvider< C >.

◆ SetRsrpFilterCoefficient()

virtual void ns3::LteUeCphySapProvider::SetRsrpFilterCoefficient ( uint8_t rsrpFilterCoefficient )

pure virtual

Set RSRP filter coefficient.

Determines the strength of smoothing effect induced by layer 3 filtering of RSRP used for uplink power control in all attached UE. If equals to 0, no layer 3 filtering is applicable.

Parameters

rsrpFilterCoefficient value.

Implemented in ns3::MemberLteUeCphySapProvider< C >.

◆ SetSrsConfigurationIndex()

virtual void ns3::LteUeCphySapProvider::SetSrsConfigurationIndex ( uint16_t srcCi )

pure virtual

Set SRS configuration index.

Parameters

srcCi the SRS configuration index

Implemented in ns3::MemberLteUeCphySapProvider< C >.

◆ SetTransmissionMode()

virtual void ns3::LteUeCphySapProvider::SetTransmissionMode ( uint8_t txMode )

pure virtual

Set transmission mode.

Parameters

txMode the transmissionMode of the user

Implemented in ns3::MemberLteUeCphySapProvider< C >.

◆ StartCellSearch()

virtual void ns3::LteUeCphySapProvider::StartCellSearch ( uint32_t dlEarfcn )

pure virtual

Tell the PHY entity to listen to PSS from surrounding cells and measure the RSRP.

Parameters

dlEarfcn the downlink carrier frequency (EARFCN) to listen to

This function will instruct this PHY instance to listen to the DL channel over the bandwidth of 6 RB at the frequency associated with the given EARFCN.

After this, it will start receiving Primary Synchronization Signal (PSS) and periodically returning measurement reports to RRC via LteUeCphySapUser::ReportUeMeasurements function.

Implemented in ns3::MemberLteUeCphySapProvider< C >.

◆ StartInSyncDetection()

virtual void ns3::LteUeCphySapProvider::StartInSyncDetection ( )

pure virtual

Start in-sync detection function When T310 timer is started, it indicates that physical layer problems are detected at the UE and the recovery process is started by checking if the radio frames are in-sync for N311 consecutive times.

Implemented in ns3::MemberLteUeCphySapProvider< C >.

◆ SynchronizeWithEnb() [1/2]

virtual void ns3::LteUeCphySapProvider::SynchronizeWithEnb ( uint16_t cellId )

pure virtual

Tell the PHY entity to synchronize with a given eNodeB over the currently active EARFCN for communication purposes.

Parameters

cellId the ID of the eNodeB to synchronize with

By synchronizing, the PHY will start receiving various information transmitted by the eNodeB. For instance, when receiving system information, the message will be relayed to RRC via LteUeCphySapUser::RecvMasterInformationBlock and LteUeCphySapUser::RecvSystemInformationBlockType1 functions.

Initially, the PHY will be configured to listen to 6 RBs of BCH. LteUeCphySapProvider::SetDlBandwidth can be called afterwards to increase the bandwidth.

Implemented in ns3::MemberLteUeCphySapProvider< C >.

◆ SynchronizeWithEnb() [2/2]

virtual void ns3::LteUeCphySapProvider::SynchronizeWithEnb	(	uint16_t	cellId,
		uint32_t	dlEarfcn )

pure virtual

Tell the PHY entity to align to the given EARFCN and synchronize with a given eNodeB for communication purposes.

Parameters

cellId	the ID of the eNodeB to synchronize with
dlEarfcn	the downlink carrier frequency (EARFCN)

By synchronizing, the PHY will start receiving various information transmitted by the eNodeB. For instance, when receiving system information, the message will be relayed to RRC via LteUeCphySapUser::RecvMasterInformationBlock and LteUeCphySapUser::RecvSystemInformationBlockType1 functions.

Initially, the PHY will be configured to listen to 6 RBs of BCH. LteUeCphySapProvider::SetDlBandwidth can be called afterwards to increase the bandwidth.

Implemented in ns3::MemberLteUeCphySapProvider< C >.

The documentation for this class was generated from the following files:

src/lte/model/lte-ue-cphy-sap.h
src/lte/model/lte-ue-cphy-sap.cc

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~LteUeCphySapProvider()

Member Function Documentation

◆ ConfigureReferenceSignalPower()

◆ ConfigureUplink()

◆ GetCellId()

◆ GetDlEarfcn()

◆ Reset()

◆ ResetPhyAfterRlf()

◆ ResetRlfParams()

◆ SetDlBandwidth()

◆ SetImsi()

◆ SetPa()

◆ SetRnti()

◆ SetRsrpFilterCoefficient()

◆ SetSrsConfigurationIndex()

◆ SetTransmissionMode()

◆ StartCellSearch()

◆ StartInSyncDetection()

◆ SynchronizeWithEnb() [1/2]

◆ SynchronizeWithEnb() [2/2]