openbts/GSM/GSML3RRMessages.h

/**@file @brief L3 Radio Resource messages, GSM 04.08 9.1. */

/*
* Copyright 2008, 2010 Free Software Foundation, Inc.
* Copyright 2011 Kestrel Signal Processing, Inc.
* Copyright 2014 Range Networks, Inc.
*
* This software is distributed under multiple licenses; see the COPYING file in the main directory for licensing information for this specific distribution.
*
* This use of this software may be subject to additional restrictions.
* See the LEGAL file in the main directory for details.

    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.

*/




#ifndef GSML3RRMESSAGES_H
#define GSML3RRMESSAGES_H

#include "GSMCommon.h"
#include "GSML3Message.h"
#include "GSML3CommonElements.h"
#include "GSML3RRElements.h"
#include <ByteVector.h>

namespace GSM {


/**
	This a virtual class for L3 messages in the Radio Resource protocol.
	These messages are defined in GSM 04.08 9.1.
	(pat) The GSM 04.08 and 04.18 specs list all these messages together, but say
	nothing about their transport mechanisms, which are wildly different and described elsewhere.
	For example, GPRS Mobility Management messages are handled inside the SGSN,
	which wraps them in an LLC protocol and sends them to the RLC/MAC layer
	(via BSSG and NS protocols, in which these messages reside temporarily)
	which wraps them in an RLC Header, then wraps them with a MAC header,
	before delivering to the radio transmit, which munges them even further.
	And by the way, if the MS is in DTM (Dual Transfer Mode) the MAC layer
	may (or should?) unwrap the L3 Message from its LLC wrapper and send it on a
	dedicated RR message channel instead of sending it via GPRS PDCH.

	Note that the message numbers are reused several times in the tables
	for different purposes, for example, MessageTypes for Mobility Management reuse
	numbers in Message Types for Radio Rsource Management.
*/
class L3RRMessage : public L3Message {

	public:

	/** RR Message MTIs, GSM 04.08 Table 10.1/3. */
	enum MessageType {
		///@name System Information
		//@{
		SystemInformationType1=0x19,
		SystemInformationType2=0x1a,
		SystemInformationType2bis=0x02,
		SystemInformationType2ter=0x03,
		SystemInformationType3=0x1b,		// 27
		SystemInformationType4=0x1c,		// 28
		SystemInformationType5=0x1d,		// 29
		SystemInformationType5bis=0x05,
		SystemInformationType5ter=0x06,
		SystemInformationType6=0x1e,		// 30
		SystemInformationType7=0x1f,
		SystemInformationType8=0x18,
		SystemInformationType9=0x04,
		SystemInformationType13=0x00,	// (pat) yes, this is correct.
		SystemInformationType16=0x3d,
		SystemInformationType17=0x3e,
		//@}
		///@name Channel Management
		//@{
		AssignmentCommand=0x2e,			// 46
		AssignmentComplete=0x29,
		AssignmentFailure=0x2f,
		ChannelRelease=0x0d,			// 13
		ImmediateAssignment=0x3f,		// 63
		ImmediateAssignmentExtended=0x39,
		ImmediateAssignmentReject=0x3a,		// 58
		AdditionalAssignment=0x3b,
		//@}
		///@name Paging
		//@{
		PagingRequestType1=0x21,		// 33
		PagingRequestType2=0x22,
		PagingRequestType3=0x24,
		PagingResponse=0x27,
		//@}
		///@name Handover
		//@{
		HandoverCommand=0x2b,
		HandoverComplete=0x2c,
		HandoverFailure=0x28,
		PhysicalInformation=0x2d,
		//@}
		///@name ciphering
		//@{
		CipheringModeCommand=0x35,
		CipheringModeComplete=0x32,
		//@}
		///@name miscellaneous
		//@{
		ChannelModeModify=0x10,
		RRStatus=0x12,
		ChannelModeModifyAcknowledge=0x17,
		ClassmarkChange=0x16,
		ClassmarkEnquiry=0x13,
		MeasurementReport = 0x15,
		GPRSSuspensionRequest=0x34,
		//@}
		///@name special cases -- assigned >8-bit codes to avoid conflicts
		//@{
		SynchronizationChannelInformation=0x100,
		ChannelRequest=0x101,
		HandoverAccess=0x102,
		//@}
		///@name application information - used for RRLP
		//@{
		ApplicationInformation=0x38,
		//@}
	};
	static const char *name(MessageType mt);


	L3RRMessage():L3Message() { } 
	
	/** Return the L3 protocol discriptor. */
	L3PD PD() const { return L3RadioResourcePD; }

	void text(std::ostream&) const;
};

std::ostream& operator<<(std::ostream& os, L3RRMessage::MessageType);



/** Subclass for L3 RR Messages with no rest octets.  */
// (pat) L3RRMessagesRO subclass must define:
//  l2BodyLength - length of body only, and there are no rest octets.
// 	writeBody() - writes the body.
class L3RRMessageNRO : public L3RRMessage {

	public:

	L3RRMessageNRO():L3RRMessage() { }

	size_t fullBodyLength() const { return l2BodyLength(); }

};

/** Subclass for L3 RR messages with rest octets */
// (pat) L3RRMessagesRO subclass must define:
//  l2BodyLength - length of body only, in bytes
//  restOctetsLength - length of rest octets only, in bytes.
// 	writeBody() - writes the body AND the rest octets.
class L3RRMessageRO : public L3RRMessage {

	public:

	L3RRMessageRO():L3RRMessage() { }

	virtual size_t restOctetsLength() const =0;

	size_t fullBodyLength() const { return l2BodyLength() + restOctetsLength(); }

};


/**
	A Factory function to return a L3RRMessage of the specified MTI.
	Returns NULL if the MTI is not supported.
*/
L3RRMessage* L3RRFactory(L3RRMessage::MessageType MTI);

/**
	Parse a complete L3 radio resource message into its object type.
	@param source The L3 bits.
	@return A pointer to a new message or NULL on failure.
*/
L3RRMessage* parseL3RR(const L3Frame& source);


/** Paging Request Type 1, GSM 04.08 9.1.22 */
class L3PagingRequestType1 : public L3RRMessageNRO {

	private:

	std::vector<L3MobileIdentity> mMobileIDs;
	ChannelType mChannelsNeeded[2];


	public:

	L3PagingRequestType1()
		:L3RRMessageNRO()
	{
		// The empty paging request is a single untyped mobile ID.
		mMobileIDs.push_back(L3MobileIdentity());
		mChannelsNeeded[0]=AnyDCCHType;
		mChannelsNeeded[1]=AnyDCCHType;
	}

	L3PagingRequestType1(const L3MobileIdentity& wId, ChannelType wType)
		:L3RRMessageNRO()
	{
		mMobileIDs.push_back(wId);
		mChannelsNeeded[0]=wType;
		mChannelsNeeded[1]=AnyDCCHType;
	}

	L3PagingRequestType1(const L3MobileIdentity& wId1, ChannelType wType1,
			const L3MobileIdentity& wId2, ChannelType wType2)
		:L3RRMessageNRO()
	{
		mMobileIDs.push_back(wId1);
		mChannelsNeeded[0]=wType1;
		mMobileIDs.push_back(wId2);
		mChannelsNeeded[1]=wType2;
	}

	unsigned chanCode(ChannelType) const;

	int MTI() const { return PagingRequestType1; }

	size_t l2BodyLength() const;
	void writeBody(L3Frame& dest, size_t& wp) const;
	void text(std::ostream&) const;
};




/** Paging Response, GSM 04.08 9.1.25 */
class L3PagingResponse : public L3RRMessageNRO {

	private:

	L3MobileStationClassmark2 mClassmark;
	L3MobileIdentity mMobileID;

	public:

	const L3MobileIdentity& mobileID() const { return mMobileID; }

	int MTI() const { return PagingResponse; }

	size_t l2BodyLength() const;
	void parseBody(const L3Frame& source, size_t &rp);
	void text(std::ostream&) const;

};





// (pat 4-2014) The RACH timing from some handsets does not match the spec values of S and T in 4.08 3.3,
// so I verified in wireshark that the L3RACHControlParameters are sent correctly in all SysInfo messages.
// My thought was that maybe it was wrong in one of the SysInfo messages which might cause intermittently incorrect RACH behavior.


/**
	System Information Message Type 1, GSM 04.08 9.1.31
	- Cell Channel Description 10.5.2.1b M V 16 
	- RACH Control Parameters 10.5.2.29 M V 3 
*/
class L3SystemInformationType1 : public L3RRMessageNRO {

	private:

	L3FrequencyList mCellChannelDescription;
	L3RACHControlParameters mRACHControlParameters;

	public:

	L3SystemInformationType1():L3RRMessageNRO() {}

	void RACHControlParameters(const L3RACHControlParameters& wRACHControlParameters)
		{ mRACHControlParameters = wRACHControlParameters; }

	void cellChannelDescription(const L3FrequencyList& wCellChannelDescription)
		{ mCellChannelDescription = wCellChannelDescription; }

	int MTI() const { return (int)SystemInformationType1; }

	size_t l2BodyLength() const { return 19; }
	void writeBody(L3Frame &dest, size_t &wp) const;
	void text(std::ostream&) const;
};






/**
	System Information Type 2, GSM 04.08 9.1.32.
	- BCCH Frequency List 10.5.2.22 M V 16 
	- NCC Permitted 10.5.2.27 M V 1 
	- RACH Control Parameter 10.5.2.29 M V 3 
*/
class L3SystemInformationType2 : public L3RRMessageNRO {

	private:

	L3NeighborCellsDescription mBCCHFrequencyList;
	L3NCCPermitted mNCCPermitted;
	L3RACHControlParameters	mRACHControlParameters;

	public:

	//L3SystemInformationType2():L3RRMessageNRO() {}

	L3SystemInformationType2(const std::vector<unsigned>& wARFCNs)
		:L3RRMessageNRO(),
		mBCCHFrequencyList(wARFCNs)
	{ }


	void BCCHFrequencyList(const L3NeighborCellsDescription& wBCCHFrequencyList)
		{ mBCCHFrequencyList = wBCCHFrequencyList; }

	void NCCPermitted(const L3NCCPermitted& wNCCPermitted)
		{ mNCCPermitted = wNCCPermitted; }

	void RACHControlParameters(const L3RACHControlParameters& wRACHControlParameters)
		{ mRACHControlParameters = wRACHControlParameters; }

	int MTI() const { return (int)SystemInformationType2; }

	size_t l2BodyLength() const { return 20; }
	void writeBody(L3Frame &dest, size_t &wp) const;
	void text(std::ostream&) const;
};





/**
	System Information Type 3, GSM 04.08 9.1.35
	- Cell Identity 10.5.1.1 M V 2 
	- Location Area Identification 10.5.1.3 M V 5 
	- Control Channel Description 10.5.2.11 M V 3 
	- Cell Options (BCCH) 10.5.2.3 M V 1 
	- Cell Selection Parameters 10.5.2.4 M V 2 
	- RACH Control Parameters 10.5.2.29 M V 3 
*/
class L3SystemInformationType3 : public L3RRMessageRO {

	private:

	L3CellIdentity mCI;
	L3LocationAreaIdentity mLAI;
	L3ControlChannelDescription mControlChannelDescription;
	L3CellOptionsBCCH mCellOptions;
	L3CellSelectionParameters mCellSelectionParameters;
	L3RACHControlParameters mRACHControlParameters;

	// (pat) GSM04.08 table 9.32 says RestOctets are mandatory, so why are they optional here?
	// I moved this control into the rest octets and changed the logic.
	//bool mHaveRestOctets;
	// (pat) The rest of the Type3 setup information is in L3SI3RestOctets:
	L3SI3RestOctets mRestOctets;

	public:

	L3SystemInformationType3()
		:L3RRMessageRO()
	{ }

	void CI(const L3CellIdentity& wCI) { mCI = wCI; }

	void LAI(const L3LocationAreaIdentity& wLAI) { mLAI = wLAI; }

	void controlChannelDescription(const L3ControlChannelDescription& wControlChannelDescription)
		{ mControlChannelDescription = wControlChannelDescription; }

	void cellOptions(const L3CellOptionsBCCH& wCellOptions)
		{ mCellOptions = wCellOptions; }

	void cellSelectionParameters (const L3CellSelectionParameters& wCellSelectionParameters)
		{ mCellSelectionParameters = wCellSelectionParameters; }

	void RACHControlParameters(const L3RACHControlParameters& wRACHControlParameters)
		{ mRACHControlParameters = wRACHControlParameters; }

	int MTI() const { return (int)SystemInformationType3; }

	size_t l2BodyLength() const { return 16; }
	size_t restOctetsLength() const { return mRestOctets.lengthV(); }
	void writeBody(L3Frame &dest, size_t &wp) const;
	void text(std::ostream&) const;
};




struct L3SIType4RestOctets
{
	unsigned mRA_COLOUR;
	L3SIType4RestOctets();
	void writeV(L3Frame &dest, size_t &wp) const;
	void writeText(std::ostream& os) const;
	size_t lengthBits() const;
	size_t lengthV() const { return (lengthBits()+7)/8; }
};


/**
	System Information Type 4, GSM 04.08 9.1.36
	- Location Area Identification 10.5.1.3 M V 5 
	- Cell Selection Parameters 10.5.2.4 M V 2 
	- RACH Control Parameters 10.5.2.29 M V 3 
	pats note: We included the GPRS Indicator in the rest octets for SI3, so I am assuming
	we do not also have to included it in SI4.
*/
class L3SystemInformationType4 : public L3RRMessageRO {

	private:

	L3LocationAreaIdentity mLAI;
	L3CellSelectionParameters mCellSelectionParameters;
	L3RACHControlParameters mRACHControlParameters;
	bool mHaveCBCH;
	L3ChannelDescription mCBCHChannelDescription;
	L3SIType4RestOctets mType4RestOctets;

	public:

	L3SystemInformationType4();

	//void LAI(const L3LocationAreaIdentity& wLAI) { mLAI = wLAI; }

	//void cellSelectionParameters (const L3CellSelectionParameters& wCellSelectionParameters)
//		{ mCellSelectionParameters = wCellSelectionParameters; }

//	void RACHControlParameters(const L3RACHControlParameters& wRACHControlParameters)
//		{ mRACHControlParameters = wRACHControlParameters; }

	int MTI() const { return (int)SystemInformationType4; }

	size_t l2BodyLength() const;
	size_t restOctetsLength() const;
	void writeBody(L3Frame &dest, size_t &wp) const;
	void text(std::ostream&) const;
};




/**
	System Information Type 5, GSM 04.08 9.1.37
	- BCCH Frequency List 10.5.2.22 M V 16 
*/
class L3SystemInformationType5 : public L3RRMessageNRO {

	private:

	L3NeighborCellsDescription mBCCHFrequencyList;

	public:

	//L3SystemInformationType5():L3RRMessageNRO() { }

	L3SystemInformationType5(const std::vector<unsigned>& wARFCNs)
		:L3RRMessageNRO(),
		mBCCHFrequencyList(wARFCNs)
	{ }

	void BCCHFrequencyList(const L3NeighborCellsDescription& wBCCHFrequencyList)
		{ mBCCHFrequencyList = wBCCHFrequencyList; }

	int MTI() const { return (int)SystemInformationType5; }

	size_t l2BodyLength() const { return 16; }
	void writeBody(L3Frame &dest, size_t &wp) const;
	void text(std::ostream&) const;
};





/**
	System Information Type 6, GSM 04.08 9.1.40
	- Cell Identity 10.5.1.11 M V 2 
	- Location Area Identification 10.5.1.3 M V 5 
	- Cell Options (SACCH) 10.5.2.3 M V 1 
	- NCC Permitted 10.5.2.27 M V 1 
*/
class L3SystemInformationType6 : public L3RRMessageNRO {

	private:

	L3CellIdentity mCI;
	L3LocationAreaIdentity mLAI;
	L3CellOptionsSACCH mCellOptions;
	L3NCCPermitted mNCCPermitted;

	public:

	L3SystemInformationType6():L3RRMessageNRO() {}

	void CI(const L3CellIdentity& wCI) { mCI = wCI; }

	void LAI(const L3LocationAreaIdentity& wLAI) { mLAI = wLAI; }

	void cellOptions(const L3CellOptionsSACCH& wCellOptions)
		{ mCellOptions = wCellOptions; }

	void NCCPermitted(const L3NCCPermitted& wNCCPermitted)
		{ mNCCPermitted = wNCCPermitted; }

	int MTI() const { return (int)SystemInformationType6; }

	size_t l2BodyLength() const { return 9; }
	void writeBody(L3Frame &dest, size_t &wp) const;
	void text(std::ostream&) const;
};


// GSM 04.08 10.5.2.16
struct L3IARestOctets : public GenericMessageElement
{
	// Someday this may include frequence parameters, but now all it can be is Packet Assignment.
	struct L3IAPacketAssignment mPacketAssignment;

	size_t lengthBits() const {
		return mPacketAssignment.lengthBits();
	}
	void writeBits(L3Frame &dest, size_t &wp) const {
		mPacketAssignment.writeBits(dest, wp);
		while (wp & 7) { dest.writeL(wp); }	// fill out to byte boundary.
	}
	void text(std::ostream& os) const {
		mPacketAssignment.text(os);
	}
};



/** Immediate Assignment, GSM 04.08 9.1.18 */
// (pat) The elements below correspond directly to the parts of the Immediate Assignment
// message content as defined in 9.1.18, table 9.18.
// (pat) some deobfuscation.
//	// Example from Control::AccessGrantResponder()
//	L3ImmediateAssignment assign(	// Initialization of assign message
//		L3RequestReference(
//			unsigned RA,	// => L3RequestReference::mRA
//			GSM::Time &when // => L3RequestReference::mT1p,mT2,mT3
//		),	// {/*empty body*/}
//		LogicalChannel *LCH->channelDescription(),
//			// returns L3ChannelDescription(
//			//	LCH->mL1.typeAndOffset(), // => L3ChannelDescription::mTypeAndOffset;
//			//	LCH->mL1.TN(),		// => L3ChannelDescription::mTN
//			//	LCH->mL1.TSC(), 	// => L3ChannelDescription::mTSC
//			//	LCH->mL1.ARFCN())	// => L3ChannelDescription::mARFCN;
//			//	{ L3ChannelDescription::mHFlag = 0, ::mMAIO = 0, ::mHSN = 0 }
//		L3TimingAdvance(
//			int initialTA	// => L3TimingAdvance::mTimingAdvance
//			// L3TimingAdvance : L3ProtocolElement() [virtual class, no constructor]
//		)
//	);


class L3ImmediateAssignment : public L3RRMessageRO
{

private:

	L3PageMode mPageMode;
	L3DedicatedModeOrTBF mDedicatedModeOrTBF;
	L3RequestReference mRequestReference;
	// (pat) Note that either "Channel Description" or "Packet Channel Description"
	// appears in the message.  They are identical except for some new options
	// added to Packet Channel Description.
	L3ChannelDescription mChannelDescription;  
	L3TimingAdvance mTimingAdvance;
	// Used for Packet uplink/downlink assignment messages, which, when transmitted
	// on CCCH, appear in the rest octets of the Immediate Assignment message.
	struct L3IARestOctets mIARestOctets;
	Bool_z mStartTimePresent;
	uint32_t mStartTimeFrame;


public:
	size_t restOctetsLength() const { return (mIARestOctets.lengthBits()+7)/8; }
	void setStartFrame(uint32_t wStartFrame) { mStartTimePresent = true; mStartTimeFrame = wStartFrame; }


	L3ImmediateAssignment(
				const L3RequestReference& wRequestReference,
				const L3ChannelDescription& wChannelDescription,
				const L3TimingAdvance& wTimingAdvance = L3TimingAdvance(0),
				const bool forTBF = false, bool wDownlink = false)
		:L3RRMessageRO(),
		mPageMode(0),
		mDedicatedModeOrTBF(forTBF,wDownlink),
		mRequestReference(wRequestReference),
		mChannelDescription(wChannelDescription),
		mTimingAdvance(wTimingAdvance)
	{}


	int MTI() const { return (int)ImmediateAssignment; }
	size_t l2BodyLength() const {
		// 1/2: page mode
		// 1/2: Dedicated mode or TBF
		// 3: channel description or packet channel description 
		// 3: request reference
		// 1: timing advance
		// 1-9: Mobile Allocation (not implemented, so just 1 byte)
		// 0-3: starting time if present.
		// = 9 total bytes.
		return 9 + (mStartTimePresent ? 3 : 0);
	}

	// (pat) Return the PacketAssignment part of the message for the client to fill in.
	// I did it this way to cause the least change to the preexisting L3ImmediateAssignment class.
	struct L3IAPacketAssignment *packetAssign() { return &mIARestOctets.mPacketAssignment; }


	// (pat) writeBody called via:
	// CCCHLogicalChannel:send(L3RRMessage msg)
	// calls L3FrameFIFO mq.L3FrameFIFO::write(new L3Frame(L3Message msg,UNIT_DATA));
	// L3Frame::L3Frame(L3Message&,Primitive) : BitVector2(msg.bitsNeeded)
	//                      mPrimitive(wPrimitive),
	//                      mL2Length(wPrimitive) { L3Message msg.write(); }
	// L3Message::write() calls writeBody()

	void writeStartTime(L3Frame& dest, size_t &wp) const;
	void writeBody(L3Frame &dest, size_t &wp) const;
	void text(std::ostream&) const;
};



/** Immediate Assignment Reject, GSM 04.08 9.1.20 */
class L3ImmediateAssignmentReject : public L3RRMessageNRO {

private:

	L3PageMode mPageMode;
	std::vector<L3RequestReference> mRequestReference;
	L3WaitIndication mWaitIndication;			///< All entries get the same wait indication.

public:


	L3ImmediateAssignmentReject(const L3RequestReference& wRequestReference, unsigned seconds)
		:L3RRMessageNRO(),
		mWaitIndication(seconds)
	{ mRequestReference.push_back(wRequestReference); }

	void addReject(const L3RequestReference& wRequestReference) { mRequestReference.push_back(wRequestReference); }
	void setWaitTime(unsigned seconds) { mWaitIndication.mValue = seconds; }

	int MTI() const { return (int)ImmediateAssignmentReject; }

	size_t l2BodyLength() const { return 17; }
	void writeBody(L3Frame &dest, size_t &wp) const;
	void text(std::ostream&) const;

};






/** GSM 04.08 9.1.7 */
class L3ChannelRelease : public L3RRMessageNRO {

private:

	L3RRCauseElement mRRCause;
	// 3GPP 44.018 10.5.2.14c GPRS Resumption.
	// It is one bit to specify to the MS whether GPRS services should resume.
	// Kinda important.
	bool mGprsResumptionPresent;
	bool mGprsResumptionBit;

public:
	
	/** The default cause is 0x0, "normal event". */
	L3ChannelRelease(const RRCause cause = L3RRCause::Normal_Event)
		:L3RRMessageNRO(),mRRCause(cause),mGprsResumptionPresent(0)
	{}

	int MTI() const { return (int) ChannelRelease; }

	size_t l2BodyLength() const { return mRRCause.lengthV(); }
	void writeBody( L3Frame &dest, size_t &wp ) const; 
	void text(std::ostream&) const;
};




/**
	GSM 04.08 9.1.8
	The channel request message is special because the timestamp
	is implied by the receive time but not actually present in
	the message.
	This messages has no parse or write methods, but is used to
	transfer information from L1 to the control layer.
*/
class L3ChannelRequest : public L3RRMessageNRO {

	private:

	unsigned mRA;		///< request reference
	GSM::Time mTime;		///< receive timestamp

	public:

	L3ChannelRequest(unsigned wRA, const GSM::Time& wTime)
		:L3RRMessageNRO(),
		mRA(wRA), mTime(wTime)
	{}

	/**@name Accessors. */
	//@{
	unsigned RA() const { return mRA; }
	const GSM::Time& time() const { return mTime; }
	//@}

	int MTI() const { return (int)ChannelRequest; }

	size_t l2BodyLength() const { return 0; }
	void writeBody( L3Frame &dest, size_t &wp ) const; 
	void parseBody(const L3Frame&, size_t&);
	void text(std::ostream&) const;
};





/** GSM 04.08 9.1.2 */
class L3AssignmentCommand : public L3RRMessageNRO {

private:

	L3ChannelDescription mChannelDescription;
	L3PowerCommand	mPowerCommand;
	
	bool mHaveMode1;
	L3ChannelMode mMode1;	
	L3MultiRateConfiguration mMultiRate;	// For AMR codecs, defaults to AMR-FR.

public:

	L3AssignmentCommand(const L3ChannelDescription& wChannelDescription,
			const L3ChannelMode& wMode1 )
		:L3RRMessageNRO(),
		mChannelDescription(wChannelDescription),
		mHaveMode1(true),mMode1(wMode1)
	{}

	L3AssignmentCommand(const L3ChannelDescription& wChannelDescription)
		:L3RRMessageNRO(),
		mChannelDescription(wChannelDescription),
		mHaveMode1(false)
	{}


	bool isAMR() const { return mHaveMode1 && mMode1.isAMR(); }

	int MTI() const { return (int) AssignmentCommand; }

	size_t l2BodyLength() const;
	void writeBody( L3Frame &dest, size_t &wp ) const; 
	void text(std::ostream&) const;
};


/** GSM 04.08 9.1.3 */
class L3AssignmentComplete : public L3RRMessageNRO {

	private:

	L3RRCauseElement mCause;

	public:

	///@name Accessors.
	//@{
	const L3RRCauseElement& cause() const { return mCause; }
	//@}

	int MTI() const { return (int) AssignmentComplete; }

	size_t l2BodyLength() const { return 1; }
	void parseBody( const L3Frame &src, size_t &rp );
	void text(std::ostream&) const;

};


/** GSM 04.08 9.1.3 */
class L3AssignmentFailure : public L3RRMessageNRO {

	private:

	L3RRCauseElement mCause;

	public:

	///@name Accessors.
	//@{
	const L3RRCauseElement& cause() const { return mCause; }
	//@}

	int MTI() const { return (int) AssignmentFailure; }

	size_t l2BodyLength() const { return 1; }
	void parseBody( const L3Frame &src, size_t &rp );
	void text(std::ostream&) const;

};


/** GSM 04.08 9.1.29 */
class L3RRStatus : public L3RRMessageNRO {

	private:

	L3RRCauseElement mCause;

	public:

	///@name Accessors.
	//@{
	const L3RRCauseElement& cause() const { return mCause; }
	//@}

	int MTI() const { return (int) RRStatus; }

	size_t l2BodyLength() const { return 1; }
	void parseBody( const L3Frame &src, size_t &rp );
	void text(std::ostream&) const;

};



/** GSM 04.08 9.1.5 */
class L3ChannelModeModify : public L3RRMessageNRO {

	private:

	L3ChannelDescription mDescription;
	L3ChannelMode mMode;
	L3MultiRateConfiguration mMultiRate;	// For AMR codecs, defaults to AMR-FR.

	public:

	L3ChannelModeModify(const L3ChannelDescription& wDescription,
						const L3ChannelMode& wMode)
		:L3RRMessageNRO(),
		mDescription(wDescription),
		mMode(wMode)
	{}

	int MTI() const { return (int) ChannelModeModify; }
	bool isAMR() const { return mMode.isAMR(); }

	size_t l2BodyLength() const
		{ return mDescription.lengthV() + mMode.lengthV() +
			(isAMR() ? mMultiRate.lengthTLV() : 0); }

	void writeBody(L3Frame&, size_t&) const;
	void text(std::ostream&) const;
};


/** GSM 04.08 9.1.6 */
class L3ChannelModeModifyAcknowledge : public L3RRMessageNRO {

	private:

	L3ChannelDescription mDescription;
	L3ChannelMode mMode;

	public:

	const L3ChannelDescription& description() const { return mDescription; }
	const L3ChannelMode& mode() const { return mMode; }

	int MTI() const { return (int) ChannelModeModifyAcknowledge; }

	size_t l2BodyLength() const
		{ return mDescription.lengthV() + mMode.lengthV(); }

	void parseBody(const L3Frame&, size_t&);
	void text(std::ostream&) const;
};


/** GSM 04.08 9.1.21 */
class L3MeasurementReport : public L3RRMessageNRO {

	private:
	// This is a placeholder. We don't really parse anything yet.
	L3MeasurementResults mResults;

	public:

	int MTI() const { return (int) MeasurementReport; }
	size_t l2BodyLength() const { return mResults.lengthV(); }

	void parseBody(const L3Frame&, size_t&);
	void text(std::ostream&) const;

	const L3MeasurementResults results() const { return mResults; }

};


/** GSM 04.08 9.1.53 */
class L3ApplicationInformation : public L3RRMessageNRO {

	private:

	L3APDUID mID;
	L3APDUFlags mFlags;
	L3APDUData mData;

	public:

	~L3ApplicationInformation();

	L3ApplicationInformation();
	// data is the first argument to allow the rest to default, since that is the common case,
	// sending a single (cr=0, first=0, last=0) RRLP (id=0) APDU wrapped in a ApplicationInformation L3 packet.
	L3ApplicationInformation(BitVector2& data, unsigned protocolIdentifier=0,
	                         unsigned cr=0, unsigned firstSegment=0, unsigned lastSegment=0);

	///@name Accessors.
	//@{
	const L3APDUID& id() const { return mID; }
	const L3APDUFlags& flags() const { return mFlags; }
	const L3APDUData& data() const { return mData; }
	//@}

	int MTI() const { return (int) ApplicationInformation; }

	size_t l2BodyLength() const;
	void writeBody( L3Frame&, size_t&) const;
	void parseBody( const L3Frame &src, size_t &rp );
	void text(std::ostream&) const;

};


/** GSM 04.08 (or 04.18) 9.1.13b */
// 44.018 3.4.25 GPRS Suspension procedure.
// 44.018 3.4.13 RR Connection releasee procedure - GPRS resumption if includes:
// 10.5.2.14c GPRS Resumption IEI
class L3GPRSSuspensionRequest : public L3RRMessageNRO
{	public:
	// The TLLI is what we most need out of this message to identify the MS.
	// Note that TLLI is not just a simple number; encoding defined in 23.003.
	// We dont worry about it here; the SGSN handles that.
	uint32_t mTLLI;
	// 3GPP 24.008 10.5.5.15 Routing Area Identification.
	// Similar to L3LocationAreaIdentity but includes RAC too.
	// We dont really care about it now, and when we do, all we will care
	// is if it matches our own or not, so just squirrel away the 6 bytes as a ByteVector.
	// This is an immediate object whose memory will be deleted automatically.
	ByteVector mRaId;
	// Suspension cause 44.018 10.5.2.47.
	// Can be 0: mobile originated call, 1: Location area update, 2: SMS, or others
	uint8_t mSuspensionCause;
	// Optional service support, IEI=0x01.
	// It is for MBMS and we dont really care about it, but get it anyway.
	uint8_t mServiceSupport;

	// Must init only the optional elements:
	L3GPRSSuspensionRequest() : mServiceSupport(0) {}

	int MTI() const { return (int) GPRSSuspensionRequest; }

	size_t l2BodyLength() const { return 11; }	// This is uplink only so not relevant.
	void parseBody(const L3Frame&, size_t&);
	void text(std::ostream&) const;
};


/** GSM 04.08 9.1.12 */
class L3ClassmarkEnquiry : public L3RRMessageNRO {

	public:

	int MTI() const { return (int) ClassmarkEnquiry; }

	size_t l2BodyLength() const { return 0; }
	void writeBody(L3Frame&, size_t&) const {}
};


/** GSM 04.08 9.1.11 */
class L3ClassmarkChange : public L3RRMessageNRO {

	protected:

	L3MobileStationClassmark2 mClassmark;
	bool mHaveAdditionalClassmark;
	L3MobileStationClassmark3 mAdditionalClassmark;

	public:

	int MTI() const { return (int) ClassmarkChange; }

	size_t l2BodyLength() const;
	void parseBody(const L3Frame&, size_t&);
	void text(std::ostream&) const;

	const L3MobileStationClassmark2& classmark() const { return mClassmark; }
};


/** GSM 04.08 9.1.43a */
// (pat) Someone kindly added this before I got here...
// SI13 includes GPRS Cell Options in its rest octets,
// so we broadcast it on BCCH if GPRS is supported.
class L3SystemInformationType13 : public L3RRMessageRO {

	protected:

	L3SI13RestOctets mRestOctets;

	public:

	L3SystemInformationType13()
		:L3RRMessageRO()
	{ }

	int MTI() const { return (int)SystemInformationType13; }

	size_t l2BodyLength() const { return 0; }

	size_t restOctetsLength() const { return mRestOctets.lengthV(); }

	void writeBody(L3Frame &dest, size_t &wp) const
	{
		size_t wpstart = wp;
		mRestOctets.writeV(dest,wp);
		assert(wp-wpstart == fullBodyLength() * 8);
	}

	void text(std::ostream& os) const
		{ L3RRMessage::text(os); os << mRestOctets; }
};




class L3HandoverCommand : public L3RRMessageNRO {

	protected:

	L3CellDescription mCellDescription;
	L3ChannelDescription2 mChannelDescriptionAfter;
	L3HandoverReference mHandoverReference;
	L3PowerCommandAndAccessType mPowerCommandAccessType;
	L3SynchronizationIndication mSynchronizationIndication;

	public:

	L3HandoverCommand(const L3CellDescription& wCellDescription,
		const L3ChannelDescription2 wChannelDescriptionAfter,
		const L3HandoverReference& wHandoverReference,
		const L3PowerCommandAndAccessType& wPowerCommandAccessType,
		const L3SynchronizationIndication& wSynchronizationIndication)
		:L3RRMessageNRO(),
		mCellDescription(wCellDescription),
		mChannelDescriptionAfter(wChannelDescriptionAfter),
		mHandoverReference(wHandoverReference),
		mPowerCommandAccessType(wPowerCommandAccessType),
		mSynchronizationIndication(wSynchronizationIndication)
		{ }

	L3HandoverCommand() {}	// This is to manufacture one.

	int MTI() const { return (int) HandoverCommand; }

	size_t l2BodyLength() const;
	// (pat) This is never an incoming message from a handset, but we pass it between BTS base-stations,
	// so add a parser so we can print its content in debug messages.
	void parseBody(const L3Frame&, size_t&);
	void writeBody(L3Frame&, size_t&) const;
	void text(std::ostream&) const;
};



/** GSM 04.08 9.1.16 */
class L3HandoverComplete : public L3RRMessageNRO {

	protected:

	L3RRCauseElement mCause;

	public:

	int MTI() const { return (int) HandoverComplete; }

	size_t l2BodyLength() const { return mCause.lengthV(); }
	void parseBody(const L3Frame&, size_t&);
	void text(std::ostream&) const;

	const L3RRCauseElement& cause() const { return mCause; }
};



/** GSM 04.08 9.1.17 */
class L3HandoverFailure : public L3RRMessageNRO {

	protected:

	L3RRCauseElement mCause;

	public:

	int MTI() const { return (int) HandoverFailure; }

	size_t l2BodyLength() const { return mCause.lengthV(); }
	void parseBody(const L3Frame&, size_t&);
	void text(std::ostream&) const;

	const L3RRCauseElement& cause() const { return mCause; }
};


/** GSM 04.08 9.1.9 */
class L3CipheringModeCommand : public L3RRMessageNRO {

	protected:

	L3CipheringModeSetting mCipheringModeSetting;
	L3CipheringModeResponse mCipheringResponse;

	public:

	L3CipheringModeCommand(L3CipheringModeSetting wCipheringModeSetting, L3CipheringModeResponse wCipheringResponse)
		: mCipheringModeSetting(wCipheringModeSetting),
		mCipheringResponse(wCipheringResponse)
	{ }

	int MTI() const;

	size_t l2BodyLength() const { return 1; }
	void writeBody(L3Frame&, size_t&) const;
	void text(std::ostream&) const;
};

/** GSM 04.08 9.1.10 */
class L3CipheringModeComplete : public L3RRMessageNRO {

	protected:

	public:

	int MTI() const;

	size_t l2BodyLength() const { return 0; }
	void parseBody(const L3Frame&, size_t&);
	void text(std::ostream&) const;
};


/** GSM 04.08 9.1.28 */
class L3PhysicalInformation : public L3RRMessageNRO {

	protected:

	L3TimingAdvance mTA;

	public:

	L3PhysicalInformation(const L3TimingAdvance& wTA)
		:L3RRMessageNRO(),
		mTA(wTA)
	{ }


	int MTI() const { return (int) PhysicalInformation; }

	size_t l2BodyLength() const { return mTA.lengthV(); }
	void writeBody(L3Frame&, size_t&) const;
	void text(std::ostream&) const;
};



#if 0
/**
	GSM 04.08 9.1.14
	This messages has no parse or write methods, but is used to
	transfer information from L1 to the control layer.
*/
class L3HandoverAccess : public L3RRMessageNRO {

	protected:

	unsigned mReference;
	float mTimingError;
	float mRSSI;

	public:

	L3HandoverAccess(unsigned wReference, unsigned wTimingError, float wRSSI)
		:L3RRMessageNRO(),
		mReference(wReference),mTimingError(wTimingError),mRSSI(wRSSI)
	{ }

	int MTI() const { return (int) HandoverAccess; }

	size_t l2BodyLength() const { return 1; }

	unsigned reference() const { return mReference; }
	float timingError() const { return mTimingError; }
	float RSSI() const { return mRSSI; }
};
#endif


} // GSM

#endif
// vim: ts=4 sw=4