csma_802_15_4.h

第一个是csma的c文件

// Copyright (c) 2001-2008, Scalable Network Technologies, Inc.  All Rights Reserved.
//                          6701 Center Drive West
//                          Suite 520
//                          Los Angeles, CA 90045
//                          [e-mail]
//
// This source code is licensed, not sold, and is subject to a written
// license agreement.  Among other things, no portion of this source
// code may be copied, transmitted, disclosed, displayed, distributed,
// translated, used as the basis for a derivative work, or used, in
// whole or in part, for any program or purpose other than its intended
// use in compliance with the license agreement as part of the QualNet
// software.  This source code and certain of the algorithms contained
// within it are confidential trade secrets of Scalable Network
// Technologies, Inc. and may not be used as the basis for any other
// software, hardware, product or service.

#ifndef CSMA_802_15_4_H
#define CSMA_802_15_4_H

#include "api.h"
#include "mac_802_15_4.h"
#include "phy_802_15_4.h"
//--------------------------------------------------------------------------
// #define's
//--------------------------------------------------------------------------


//--------------------------------------------------------------------------
// typedef's enums
//--------------------------------------------------------------------------

// /**
// ENUM        :: C802_15_4TimerType
// DESCRIPTION :: Timers used by CSMA-CA
// **/
typedef enum
{
    C802_15_4BACKOFFTIMER,
    C802_15_4BEACONOTHERTIMER,
    C802_15_4DEFERCCATIMER
}C802_15_4TimerType;

//--------------------------------------------------------------------------
// typedef's struct
//--------------------------------------------------------------------------

// /**
// STRUCT      :: C802_15_4Timer
// DESCRIPTION :: Timer type for CSMACA 802.15.4
// **/
typedef struct csma_802_15_4_timer_str
{
    C802_15_4TimerType timerType;
}C802_15_4Timer;

// /**
// STRUCT      :: CsmaData_802_15_4
// DESCRIPTION :: Layer structure of CSMA
// **/
typedef struct csma_802_15_4_str
{
    UInt8 NB;
    UInt8 CW;
    UInt8 BE;

    BOOL ackReq;
    BOOL beaconEnabled;
    BOOL beaconOther;
    BOOL waitNextBeacon;
    clocktype bcnTxTime;
    clocktype bcnRxTime;
    clocktype bPeriod;             //backoff periods
    int bPeriodsLeft;           //backoff periods left for next superframe
    Message* txPkt;

    //Timers
    Message* backoffT;
    Message* bcnOtherT;
    Message* deferCCAT;

    RandomSeed seed;
}CsmaData802_15_4;

//--------------------------------------------------------------------------
// FUNCTION DECLARATIONS
//--------------------------------------------------------------------------

// /**
// FUNCTION   :: Csma802_15_4Reset
// LAYER      :: Mac
// PURPOSE    :: Resets running CSMA algo.
// PARAMETERS ::
// + node       : Node*             : Pointer to node
// RETURN  :: None
// **/
void Csma802_15_4Reset(Node* node, int interfaceIndex);

// /**
// FUNCTION   :: Csma802_15_4AdjustTime
// LAYER      :: Mac
// PURPOSE    :: find the beginning point of CAP and adjust the scheduled
//               time, if it comes before CAP
// PARAMETERS ::
// + node       : Node*             : Pointer to node
// +  wtime     : clocktype         : Time to be adjusted
// RETURN  :: clocktype
// **/
clocktype Csma802_15_4AdjustTime(Node* node, int interfaceIndex, clocktype wtime);

// /**
// FUNCTION   :: Csma802_15_4CanProceed
// LAYER      :: Mac
// PURPOSE    :: Check if can proceed within the current superframe
// PARAMETERS ::
// + node       : Node*             : Pointer to node
// +  wtime     : clocktype         : Time to be adjusted
// + afterCCA   : BOOL              :
// RETURN  :: BOOL  : TRUE or FALSE
// **/
BOOL Csma802_15_4CanProceed(
        Node* node,
        int interfaceIndex,
        clocktype wtime,
        BOOL afterCCA = FALSE);

// /**
// FUNCTION   :: Csma802_15_4NewBeacon
// LAYER      :: Mac
// PURPOSE    :: Called by MAC each time a new beacon received or sent within
//               the current PAN
// PARAMETERS ::
// + node       : Node*             : Pointer to node
// + trx        : char              :
// RETURN  :: None
// **/
void Csma802_15_4NewBeacon(Node* node, int interfaceIndex, char trx);

// /**
// FUNCTION   :: Csma802_15_4Start
// LAYER      :: Mac
// PURPOSE    :: Called by MAC to start CSMA algo to send pkt
// PARAMETERS ::
// + node       : Node*             : Pointer to node
// + firsttime  : BOOL              : Whether sending for the first time
// + pkt        : Message*          : Packet to be sent
// + ackreq     : BOOL              : Whether Ack requested
// RETURN  :: None
// **/
void Csma802_15_4Start(
        Node* node,
        int interfaceIndex,
        BOOL firsttime,
        Message* pkt = 0,
        BOOL ackreq = 0);

// /**
// FUNCTION   :: Csma802_15_4Cancel
// LAYER      :: Mac
// PURPOSE    :: To cancel CSMA algo
// PARAMETERS ::
// + node       : Node*             : Pointer to node
// RETURN  :: None
// **/
void Csma802_15_4Cancel(Node* node, int interfaceIndex);

// /**
// FUNCTION   :: Csma802_15_4RX_ON_confirm
// LAYER      :: Mac
// PURPOSE    :: Retruns receive ON status
// PARAMETERS ::
// + node       : Node*             : Pointer to node
// + status     : PLMEsetTrxState           : RxON status
// RETURN  :: None
// **/
void Csma802_15_4RX_ON_confirm(
        Node* node,
        int interfaceIndex,
        PLMEsetTrxState status);

// /**
// FUNCTION   :: Csma802_15_4BcnOtherHandler
// LAYER      :: Mac
// PURPOSE    :: Fn to handle Beacon Other timer
// PARAMETERS ::
// + node       : Node*             : Pointer to node
// RETURN  :: None
// **/
void Csma802_15_4BcnOtherHandler(Node* node, int interfaceIndex);

// /**
// FUNCTION   :: Csma802_15_4DeferCCAHandler
// LAYER      :: Mac
// PURPOSE    :: Fn to handle Defer CCA timer
// PARAMETERS ::
// + node       : Node*             : Pointer to node
// RETURN  :: None
// **/
void Csma802_15_4DeferCCAHandler(Node* node, int interfaceIndex);

// /**
// FUNCTION   :: Csma802_15_4CCA_confirm
// LAYER      :: Mac
// PURPOSE    :: Returns channel clear access status
// PARAMETERS ::
// + node       : Node*             : Pointer to node
// + status     : PhyStatusType           : CCA status
// RETURN  :: None
// **/
void Csma802_15_4CCA_confirm(
        Node* node,
        int interfaceIndex,
        PhyStatusType status);

// /**
// FUNCTION     Csma802_15_4Init
// PURPOSE      Initialization function for CSMA-CA
// PARAMETERS   Node* node
//                  Node being initialized.
//              NodeInput* nodeInput
//                  Structure containing contents of input file.
//              int interfaceIndex
//                  Interface index.
// RETURN       None
// NOTES        None
// **/
void Csma802_15_4Init(
        Node* node,
        const NodeInput* nodeInput,
        int interfaceIndex);

// /**
// FUNCTION     Csma802_15_4Layer
// PURPOSE      To handle timer events at CSMA level
// PARAMETERS   Node *node
//                  Node which received the message.
//              int interfaceIndex
//                  Interface index.
//              Message* msg
//                  Message received by the layer.
// RETURN       None
// NOTES        None
// **/
void Csma802_15_4Layer(Node* node, int interfaceIndex, Message* msg);


// /**
// FUNCTION     Csma802_15_4Finalize
// PURPOSE      Called at the end of simulation to clean CSMA
// PARAMETERS   Node* node
//                  Node which received the message.
//              int interfaceIndex
//                  Interface index.
// RETURN       None
// NOTES        None
// **/
void Csma802_15_4Finalize(Node* node, int interfaceIndex);

//--------------------------------------------------------------------------
// STATIC FUNCTIONS
//--------------------------------------------------------------------------

#endif  /*CSMA_802_15_4*/