/*
 * mac-simple.h
 * Copyright (C) 2003 by the University of Southern California
 * $Id: mac-simple.h,v 1.6 2005/08/25 18:58:07 johnh Exp $
 *
 * 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.
 *
 *
 * The copyright of this module includes the following
 * linking-with-specific-other-licenses addition:
 *
 * In addition, as a special exception, the copyright holders of
 * this module give you permission to combine (via static or
 * dynamic linking) this module with free software programs or
 * libraries that are released under the GNU LGPL and with code
 * included in the standard release of ns-2 under the Apache 2.0
 * license or under otherwise-compatible licenses with advertising
 * requirements (or modified versions of such code, with unchanged
 * license).  You may copy and distribute such a system following the
 * terms of the GNU GPL for this module and the licenses of the
 * other code concerned, provided that you include the source code of
 * that other code when and as the GNU GPL requires distribution of
 * source code.
 *
 * Note that people who make modified versions of this module
 * are not obligated to grant this special exception for their
 * modified versions; it is their choice whether to do so.  The GNU
 * General Public License gives permission to release a modified
 * version without this exception; this exception also makes it
 * possible to release a modified version which carries forward this
 * exception.
 *
 */

#ifndef ns_mac_simple_h
#define ns_mac_simple_h

// Added by Sushmita to support event tracing (singal@nunki.usc.edu)
#include "address.h"
#include "ip.h"
#include "timer-handler.h"

class MacngenhancedWaitTimer;
class MacngenhancedSendTimer;
class MacngenhancedRecvTimer;
//C.A.R.MEN
class MacngenhancedBroadCastTimer;
class PrimaryUser_Timer;

// Added by Sushmita to support event tracing (singal@nunki.usc.edu)
class EventTrace;
struct frame_control {
	u_char		fc_subtype		: 4;
	u_char		fc_type			: 2;
	u_char		fc_protocol_version	: 2;

	u_char		fc_order		: 1;
	u_char		fc_wep			: 1;
	u_char		fc_more_data		: 1;
	u_char		fc_pwr_mgt		: 1;
	u_char		fc_retry		: 1;
	u_char		fc_more_frag		: 1;
	u_char		fc_from_ds		: 1;
	u_char		fc_to_ds		: 1;
};
struct hdr_strategy {
	int			nodeID;
	double                  x;
        double                  y;
        int                     channel;
	
	u_int16_t hdr_type_;     // mac_hdr type

	double txtime_;		// transmission time
	double sstime_;		// slot start time

	int padding_;

	/*
	inline void set(MacFrameType ft, int sa, int da=-1) {
		ftype_ = ft;
		macSA_ = sa;
		if (da != -1)  macDA_ = da;
	}
	inline MacFrameType& ftype() { return ftype_; }
	inline int& macSA() { return macSA_; }
	inline int& macDA() { return macDA_; }
	inline u_int16_t& hdr_type() {return hdr_type_; }

	inline double& txtime() { return txtime_; }
	inline double& sstime() { return sstime_; }
	*/
	// Header access methods
     //  inline int	hdr_dst(char* hdr, int dst = -2);
      // inline int	hdr_src(char* hdr, int src = -2);
      //inline int	hdr_type(char* hdr, u_int16_t type = 0);
	static int offset_;
	inline static int& offset() { return offset_; }
	inline static hdr_strategy* access(const Packet* p) {
		return (hdr_strategy*) p->access(offset_);
	}
};

/*

   negotiate based
*/

class Macngenhanced : public Mac {
	//Added by Sushmita to support backoff
	friend class BackoffTimer;
public:
	Macngenhanced();
	void recv(Packet *p, Handler *h);
	void send(Packet *p, Handler *h);
        void sendStrategy();

	void waitHandler(void);
	void sendHandler(void);
	void recvHandler(void);
	double txtime(Packet *p);
        void sendPrimaryUserPacket();

	// Added by Sushmita to support event tracing (singal@nunki.usc.edu)
	void trace_event(char *, Packet *);
	int command(int, const char*const*);
	EventTrace *et_;
	double ChannelUsage[100];
        int recvchan;  //preferred channel for reception.
        double txpower; //preferred power for transmission
        PrimaryUser_Timer *PrimaryUser_Timer_;

private:
	Packet *	pktRx_;
	Packet *	pktTx_;
        MacState        rx_state_;      // incoming state (MAC_RECV or MAC_IDLE)
	MacState        tx_state_;      // outgoing state
        int             tx_active_;
	int             fullduplex_mode_;
	Handler * 	txHandler_;
	MacngenhancedWaitTimer *waitTimer;
	MacngenhancedSendTimer *sendTimer;
	MacngenhancedRecvTimer *recvTimer;
        MacngenhancedBroadCastTimer *broadcastTimer;

	int busy_ ;


};

class MacngenhancedTimer: public Handler {
public:
	MacngenhancedTimer(Macngenhanced* m) : mac(m) {
	  busy_ = 0;
	}
	virtual void handle(Event *e) = 0;
	virtual void restart(double time);
	virtual void start(double time);
	virtual void stop(void);
	inline int busy(void) { return busy_; }
	inline double expire(void) {
		return ((stime + rtime) - Scheduler::instance().clock());
	}

protected:
	Macngenhanced	*mac;
	int		busy_;
	Event		intr;
	double		stime;
	double		rtime;
	double		slottime;
};

// Timer to use for delaying the sending of packets
class MacngenhancedWaitTimer: public MacngenhancedTimer {
public: MacngenhancedWaitTimer(Macngenhanced *m) : MacngenhancedTimer(m) {}
	void handle(Event *e);
};

//  Timer to use for finishing sending of packets
class MacngenhancedSendTimer: public MacngenhancedTimer {
public:
	MacngenhancedSendTimer(Macngenhanced *m) : MacngenhancedTimer(m) {}
	void handle(Event *e);
};

// Timer to use for finishing reception of packets
class MacngenhancedRecvTimer: public MacngenhancedTimer {
public:
	MacngenhancedRecvTimer(Macngenhanced *m) : MacngenhancedTimer(m) {}
	void handle(Event *e);
};

// Timer to use for broadcasting packets
//C.A.R.MEN
class MacngenhancedBroadCastTimer: public MacngenhancedTimer {
public:
	MacngenhancedBroadCastTimer(Macngenhanced *m) : MacngenhancedTimer(m) {}
	void handle(Event *e);
        void expire(Event *e);
};

//Timer for the primary user packet based detection
class PrimaryUser_Timer : public  MacngenhancedTimer {
public:
  PrimaryUser_Timer(Macngenhanced *m) : MacngenhancedTimer(m) {}
  void handle(Event *e);
  void expire(Event *e);

};


#endif