mac_rx_pool.h

zigbee location examples

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




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


//-------------------------------------------------------------------------------------------------------
// The flags used in the MAC_RX_PACKET packet structured

// Set when the packet is reserved, and cleared when released
#define MRXP_FLAG_PACKET_OCCUPIED_BM    0x01

// Used by the RX engine to indicate that the packet was acknowledged with the pending bit set (used by
// the processing tasks)
#define MRXP_FLAG_SACKPEND_ISSUED_BM    0x02

// When a beacon is received with "RX on when idle" enabled, the processing task will be responsible for
// turning RX off
#define MRXP_FLAG_RX_NOT_TURNED_OFF_BM  0x04
//-------------------------------------------------------------------------------------------------------




/*******************************************************************************************************
 *******************************************************************************************************
 **************************                   MODULE DATA                     **************************
 *******************************************************************************************************
 *******************************************************************************************************/
typedef enum {
   SECURITY_STATUS_OK,
   SECURITY_STATUS_NOK
} SECURITY_STATUS;


//-------------------------------------------------------------------------------------------------------
// Internal module data
// DO NOT CHANGE THE ORDER INSIDE THIS STRUCTURE!!!
typedef struct {
    BYTE					flags;
    BYTE 					sequenceNumber;
    SECURITY_STATUS			securityStatus;
    UINT32 					dummy;
    MCPS_DATA_INDICATION 	mdi;
    BOOL 					packetStatus;
    BOOL 					framePending;
    TIMESTAMP               timestamp;
} MAC_RX_PACKET;
extern MAC_RX_PACKET pMrxPacketPool[MAC_OPT_RX_POOL_SIZE];
//-------------------------------------------------------------------------------------------------------




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


//-------------------------------------------------------------------------------------------------------
// Initializes the packet pool
ROOT void mrxpInit(void);

// Reserve/release
ROOT MAC_RX_PACKET  * mrxpReservePacket(void);
ROOT void mrxpReleasePacket(MAC_RX_PACKET   *pPacket);
//-------------------------------------------------------------------------------------------------------


#endif