mac_indirect_queue.h

zigbee location examples

/*******************************************************************************************************
 *                                                                                                     *
 *        **********                                                                                   *
 *       ************                                                                                  *
 *      ***        ***                                                                                 *
 *      ***   +++   ***                                                                                *
 *      ***   + +   ***                                                                                *
 *      ***   +                         CHIPCON CC2430 INTEGRATED 802.15.4 MAC AND PHY                 *
 *      ***   + +   ***                        Indirect Packet Queue + Related                         *
 *      ***   +++   ***                                                                                *
 *      ***        ***                                                                                 *
 *       ************                                                                                  *
 *        **********                                                                                   *
 *                                                                                                     *
 *******************************************************************************************************
 * CONFIDENTIAL                                                                                        *
 * The use of this file is restricted by the signed MAC software license agreement.                    *
 *                                                                                                     *
 * Copyright Chipcon AS, 2005                                                                          *
 *******************************************************************************************************/
#ifndef MACINDIRECTQUEUE_H
#define MACINDIRECTQUEUE_H

/*******************************************************************************************************
 *******************************************************************************************************
 **************************               CONSTANTS AND MACROS                **************************
 *******************************************************************************************************
 *******************************************************************************************************/


//-------------------------------------------------------------------------------------------------------
// MAC_TX_PACKET.timeToLive is set to MIQ_PACKET_PURGED to indicate that a packet was purged (callbacks
#define MIQ_PACKET_PURGED 0

// Packet queue termination
#define NO_PACKET 0xFF
//-------------------------------------------------------------------------------------------------------




/*******************************************************************************************************
 *******************************************************************************************************
 **************************                  STATE MACHINES                   **************************
 *******************************************************************************************************
 *******************************************************************************************************/


//-------------------------------------------------------------------------------------------------------
// miqAddIndirectPacket
#define MIQ_STATE_FIND_FIRST_PACKET_FROM_NODE  0
#define MIQ_STATE_INSERT_INTO_QUEUE            1

// miqRemoveIndirectPacket
#define MIQ_STATE_REMOVE_PACKET                0
#define MIQ_STATE_MOVE_FIRST_PACKET_FLAG       1

// miqExpireIndirectPacketsTask
#define MIQ_STATE_FIND_EXPIRED_PACKET          0
#define MIQ_STATE_REMOVE_EXPIRED_PACKET        1
//-------------------------------------------------------------------------------------------------------




/*******************************************************************************************************
 *******************************************************************************************************
 **************************                   MODULE DATA                     **************************
 *******************************************************************************************************
 *******************************************************************************************************/

#if MAC_OPT_FFD
//-------------------------------------------------------------------------------------------------------
// Internal module data
typedef struct {

    // Indexes of the first and the last packet in the indirect queue
    UINT8 firstIndirectPacket;
    UINT8 lastIndirectPacket;

    // The number of requested indirect packets (to tell whether or not to continue looping the
    // miqTransmitRequestedPackets(...) task.
    UINT8 requestedCounter;
    
} MAC_INDIRECT_QUEUE_INFO;
extern MAC_INDIRECT_QUEUE_INFO   miqInfo;
//-------------------------------------------------------------------------------------------------------
#endif // MAC_OPT_FFD



/*******************************************************************************************************
 *******************************************************************************************************
 **************************               FUNCTION PROTOTYPES                 **************************
 *******************************************************************************************************
 *******************************************************************************************************/

#if MAC_OPT_FFD
//-------------------------------------------------------------------------------------------------------
// Queue initialization
ROOT void miqInit(void);

// Queue management
void miqAddIndirectPacket(MAC_TASK_INFO   *pTask);
void miqRemoveIndirectPacket(MAC_TASK_INFO   *pTask);

// Transmission of requested packets
ROOT BOOL miqFindAndRequestIndirectPacket(ADDRESS   *pDestAddr, BOOL isExtAddr);
ROOT MAC_TX_PACKET *miqFindIndirectPacket(ADDRESS   *pDestAddr, BOOL isExtAddr);
ROOT void miqSetRequested(MAC_TX_PACKET   *pPacket, BOOL requested);
ROOT void miqUnrequestAll(void);
void miqTransmitRequestedPackets(MAC_TASK_INFO   *pTask);

// Expiration of old or purged packets
void miqExpireIndirectPacketsTask(MAC_TASK_INFO   *pTask);
ROOT void miqDecrTimeToLive(void);

// Transmission of the empty data packet, which is sent when there is no data for a polling device
ROOT BOOL miqTransmitNoDataPacket(ADDRESS   *pDestAddr, BOOL isExtAddr);
//-------------------------------------------------------------------------------------------------------
#endif // MAC_OPT_FFD

#endif