api_mac.h

Go to the documentation of this file.

/******************************************************************************

 @file api_mac.h

 @brief TI-15.4 Stack API

 Group: WCS LPC
 $Target Device: DEVICES $

 ******************************************************************************
 $License: BSD3 2016 $
 ******************************************************************************
 $Release Name: PACKAGE NAME $
 $Release Date: PACKAGE RELEASE DATE $
 *****************************************************************************/
#ifndef API_MAC_H
#define API_MAC_H

/******************************************************************************
 Includes
 *****************************************************************************/

#include <stdbool.h>
#include <stdint.h>

#ifdef __cplusplus
extern "C"
{
#endif

/******************************************************************************
 Constants and definitions
 *****************************************************************************/

#define APIMAC_KEY_MAX_LEN  16

#define APIMAC_SADDR_EXT_LEN 8

 /* Security Implementation specific defines. The values depend on memory resources.
  */
 #ifndef MAX_KEY_TABLE_ENTRIES
#ifdef FEATURE_SECURE_COMMISSIONING
/* Key entry numbers = max device number + network key */
#define MAX_KEY_TABLE_ENTRIES             MAX_DEVICE_TABLE_ENTRIES+1
#else
#define MAX_KEY_TABLE_ENTRIES             2
#endif
 #endif

 #ifndef MAX_SECURITY_LEVEL_TABLE_ENTRIES
   #define MAX_SECURITY_LEVEL_TABLE_ENTRIES  2
 #endif

 /* MAC key table related constants */
 #ifndef MAX_KEY_ID_LOOKUP_ENTRIES
   #define MAX_KEY_ID_LOOKUP_ENTRIES         1
 #endif

 #ifndef MAX_KEY_DEVICE_TABLE_ENTRIES
#ifdef FEATURE_SECURE_COMMISSIONING
#define MAX_KEY_DEVICE_TABLE_ENTRIES        1
#else
     #define MAX_KEY_DEVICE_TABLE_ENTRIES        MAX_DEVICE_TABLE_ENTRIES
#endif
 #endif

 /*Max keys/node */
 #ifndef MAX_NODE_KEY_ENTRIES
     #define MAX_NODE_KEY_ENTRIES                1
 #endif

 #ifndef MAX_KEY_USAGE_TABLE_ENTRIES
   #define MAX_KEY_USAGE_TABLE_ENTRIES       2
 #endif

#define APIMAC_MAX_KEY_TABLE_ENTRIES MAX_KEY_TABLE_ENTRIES

#define API_MAX_NODE_KEY_ENTRIES   MAX_NODE_KEY_ENTRIES

#define APIMAC_KEYID_IMPLICIT_LEN 0

#define APIMAC_KEYID_MODE1_LEN 1

#define APIMAC_KEYID_MODE4_LEN 5

#define APIMAC_KEYID_MODE8_LEN 9

#define APIMAC_KEY_SOURCE_MAX_LEN 8

#define APIMAC_KEY_INDEX_LEN 1

#define APIMAC_FRAME_COUNTER_LEN 4

#define APIMAC_KEY_LOOKUP_SHORT_LEN 5

#define APIMAC_KEY_LOOKUP_LONG_LEN 9

#define APIMAC_MAX_KEY_LOOKUP_LEN APIMAC_KEY_LOOKUP_LONG_LEN

#define APIMAC_DATA_OFFSET 24

#define APIMAC_MAX_BEACON_PAYLOAD 16

#define APIMAC_MIC_32_LEN 4

#define APIMAC_MIC_64_LEN 8

#define APIMAC_MIC_128_LEN 16

#define APIMAC_MHR_LEN 37

#define APIMAC_CHANNEL_PAGE_9 9

#define APIMAC_CHANNEL_PAGE_10 10

#define APIMAC_CHANNEL_PAGE_NONE 0

#define APIMAC_STANDARD_PHY_DESCRIPTOR_ENTRIES  5

#define APIMAC_GENERIC_PHY_DESCRIPTOR_ENTRIES   10

 #define APIMAC_50KBPS_915MHZ_PHY_1                 1

 #define APIMAC_50KBPS_868MHZ_PHY_3               3

 #define APIMAC_50KBPS_433MHZ_PHY_128        128

 #define APIMAC_5KBPS_915MHZ_PHY_129       129

 #define APIMAC_5KBPS_433MHZ_PHY_130    130

 #define APIMAC_5KBPS_868MHZ_PHY_131     131

#define APIMAC_200KBPS_915MHZ_PHY_132            132

#define APIMAC_200KBPS_868MHZ_PHY_133          133

#define APIMAC_250KBPS_IEEE_PHY_0                      0

#define APIMAC_MRFSK_STD_PHY_ID_BEGIN APIMAC_50KBPS_915MHZ_PHY_1

#define APIMAC_MRFSK_STD_PHY_ID_END ( APIMAC_MRFSK_STD_PHY_ID_BEGIN + APIMAC_STANDARD_PHY_DESCRIPTOR_ENTRIES - 1 )

 #define APIMAC_MRFSK_GENERIC_PHY_ID_BEGIN APIMAC_50KBPS_433MHZ_PHY_128

 #define APIMAC_MRFSK_GENERIC_PHY_ID_END ( APIMAC_MRFSK_GENERIC_PHY_ID_BEGIN + APIMAC_GENERIC_PHY_DESCRIPTOR_ENTRIES - 1 )


#define APIMAC_PHY_DESCRIPTOR 0x01

#define APIMAC_NO_EXTENDER      0x00

#define APIMAC_HIGH_GAIN_MODE   0x01

#define APIMAC_DEFAULT_PA       0x00

#define APIMAC_HIGH_PA          0x01

#define APIMAC_ADDR_USE_EXT 0xFFFE

#define APIMAC_SHORT_ADDR_BROADCAST 0xFFFF

#define APIMAC_SHORT_ADDR_NONE 0xFFFF

#define APIMAC_RANDOM_SEED_LEN 32

#define APIMAC_FH_UTT_IE 0x00000002

#define APIMAC_FH_BT_IE 0x00000008

#define APIMAC_FH_US_IE 0x00010000

#define APIMAC_FH_BS_IE 0x00020000

#define APIMAC_FH_HEADER_IE_MASK 0x000000FF

#define APIMAC_FH_PROTO_DISPATCH_NONE 0x00

#define APIMAC_FH_PROTO_DISPATCH_MHD_PDU 0x01

#define APIMAC_FH_PROTO_DISPATCH_6LOWPAN 0x02

#define APIMAC_154G_MAX_NUM_CHANNEL    129

#define APIMAC_154G_CHANNEL_BITMAP_SIZ \
        ((APIMAC_154G_MAX_NUM_CHANNEL + 7) / 8)

#define APIMAC_HEADER_IE_MAX 2

#define APIMAC_PAYLOAD_IE_MAX 2

#define APIMAC_PAYLOAD_SUB_IE_MAX 4

#define APIMAC_SFS_BEACON_ORDER(s) ((s) & 0x0F)

#define APIMAC_SFS_SUPERFRAME_ORDER(s) (((s) >> 4) & 0x0F)

#define APIMAC_SFS_FINAL_CAP_SLOT(s) (((s) >> 8) & 0x0F)

#define APIMAC_SFS_BLE(s) (((s) >> 12) & 0x01)

#define APIMAC_SFS_PAN_COORDINATOR(s) (((s) >> 14) & 0x01)

#define APIMAC_SFS_ASSOCIATION_PERMIT(s) (((s) >> 15) & 0x01)

#define APIMAC_FH_MAX_BIT_MAP_SIZE 32

#define APIMAC_FH_NET_NAME_SIZE_MAX 32

#define APIMAC_FH_GTK_HASH_SIZE 8

typedef enum
{
    ApiMac_assocStatus_success = 0,
    ApiMac_assocStatus_panAtCapacity = 1,
    ApiMac_assocStatus_panAccessDenied = 2
} ApiMac_assocStatus_t;

typedef enum
{
    ApiMac_addrType_none = 0,
    ApiMac_addrType_short = 2,
    ApiMac_addrType_extended = 3
} ApiMac_addrType_t;

typedef enum
{
    ApiMac_beaconType_normal = 0,
    ApiMac_beaconType_enhanced = 1,
} ApiMac_beaconType_t;

typedef enum
{
    ApiMac_disassocateReason_coord = 1,
    ApiMac_disassocateReason_device = 2
} ApiMac_disassocateReason_t;

typedef enum
{
    ApiMac_commStatusReason_assocRsp = 0,
    ApiMac_commStatusReason_orphanRsp = 1,
    ApiMac_commStatusReason_rxSecure = 2
} ApiMac_commStatusReason_t;

typedef enum
{
    ApiMac_status_success = 0,
    ApiMac_status_subSystemError = 0x25,
    ApiMac_status_commandIDError = 0x26,
    ApiMac_status_lengthError = 0x27,
    ApiMac_status_unsupportedType = 0x28,
    ApiMac_status_autoAckPendingAllOn = 0xFE,
    ApiMac_status_autoAckPendingAllOff = 0xFF,
    ApiMac_status_beaconLoss = 0xE0,
    ApiMac_status_channelAccessFailure = 0xE1,
    ApiMac_status_counterError = 0xDB,
    ApiMac_status_denied = 0xE2,
    ApiMac_status_disabledTrxFailure = 0xE3,
    ApiMac_status_frameTooLong = 0xE5,
    ApiMac_status_improperKeyType = 0xDC,
    ApiMac_status_improperSecurityLevel = 0xDD,
    ApiMac_status_invalidAddress = 0xF5,
    ApiMac_status_invalidGts = 0xE6,
    ApiMac_status_invalidHandle = 0xE7,
    ApiMac_status_invalidIndex = 0xF9,
    ApiMac_status_invalidParameter = 0xE8,
    ApiMac_status_limitReached = 0xFA,
    ApiMac_status_noAck = 0xE9,
    ApiMac_status_noBeacon = 0xEA,
    ApiMac_status_noData = 0xEB,
    ApiMac_status_noShortAddress = 0xEC,
    ApiMac_status_onTimeTooLong = 0xF6,
    ApiMac_status_outOfCap = 0xED,
    ApiMac_status_panIdConflict = 0xEE,
    ApiMac_status_pastTime = 0xF7,
    ApiMac_status_readOnly = 0xFB,
    ApiMac_status_realignment = 0xEF,
    ApiMac_status_scanInProgress = 0xFC,
    ApiMac_status_securityError = 0xE4,
    ApiMac_status_superframeOverlap = 0xFD,
    ApiMac_status_trackingOff = 0xF8,
    ApiMac_status_transactionExpired = 0xF0,
    ApiMac_status_transactionOverflow = 0xF1,
    ApiMac_status_txActive = 0xF2,
    ApiMac_status_unavailableKey = 0xF3,
    ApiMac_status_unsupportedAttribute = 0xF4,
    ApiMac_status_unsupportedLegacy = 0xDE,
    ApiMac_status_unsupportedSecurity = 0xDF,
    ApiMac_status_unsupported = 0x18,
    ApiMac_status_badState = 0x19,
    ApiMac_status_noResources = 0x1A,
    ApiMac_status_ackPending = 0x1B,
    ApiMac_status_noTime = 0x1C,
    ApiMac_status_txAborted = 0x1D,
    ApiMac_status_duplicateEntry = 0x1E,
    ApiMac_status_fhError = 0x61,
    ApiMac_status_fhIeNotSupported = 0x62,
    ApiMac_status_fhNotInAsync = 0x63,
    ApiMac_status_fhNotInNeighborTable = 0x64,
    ApiMac_status_fhOutSlot = 0x65,
    ApiMac_status_fhInvalidAddress = 0x66,
    ApiMac_status_fhIeFormatInvalid = 0x67,
    ApiMac_status_fhPibNotSupported = 0x68,
    ApiMac_status_fhPibReadOnly = 0x69,
    ApiMac_status_fhPibInvalidParameter = 0x6A,
    ApiMac_status_fhInvalidFrameType = 0x6B,
    ApiMac_status_fhExpiredNode = 0x6C,
    ApiMac_status_fhNoPatch = 0x6D
} ApiMac_status_t;

typedef enum
{
    ApiMac_secLevel_none = 0,
    ApiMac_secLevel_mic32 = 1,
    ApiMac_secLevel_mic64 = 2,
    ApiMac_secLevel_mic128 = 3,
    ApiMac_secLevel_enc = 4,
    ApiMac_secLevel_encMic32 = 5,
    ApiMac_secLevel_encMic64 = 6,
    ApiMac_secLevel_encMic128 = 7
} ApiMac_secLevel_t;

typedef enum
{
    ApiMac_keyIdMode_implicit = 0,
    ApiMac_keyIdMode_1 = 1,
    ApiMac_keyIdMode_4 = 2,
    ApiMac_keyIdMode_8 = 3,
} ApiMac_keyIdMode_t;

typedef enum
{
    ApiMac_attribute_associatePermit = 0x41,
    ApiMac_attribute_autoRequest = 0x42,
    ApiMac_attribute_battLifeExt = 0x43,
    ApiMac_attribute_gtsPermit = 0x4D,
    ApiMac_attribute_promiscuousMode = 0x51,
    ApiMac_attribute_RxOnWhenIdle = 0x52,
    ApiMac_attribute_associatedPanCoord = 0x56,
    ApiMac_attribute_timestampSupported = 0x5C,
    ApiMac_attribute_securityEnabled = 0x5D,
    ApiMac_attribute_includeMPMIE = 0x62,
    ApiMac_attribute_fcsType = 0xE9,
} ApiMac_attribute_bool_t;

typedef enum
{
    ApiMac_attribute_ackWaitDuration = 0x40,
    ApiMac_attribute_battLifeExtPeriods = 0x44,
    ApiMac_attribute_beaconPayloadLength = 0x46,
    ApiMac_attribute_beaconOrder = 0x47,
    ApiMac_attribute_bsn = 0x49,
    ApiMac_attribute_dsn = 0x4C,
    ApiMac_attribute_maxCsmaBackoffs = 0x4E,
    ApiMac_attribute_backoffExponent = 0x4F,
    ApiMac_attribute_superframeOrder = 0x54,
    ApiMac_attribute_maxBackoffExponent = 0x57,
    ApiMac_attribute_maxFrameRetries = 0x59,
    ApiMac_attribute_responseWaitTime = 0x5A,
    ApiMac_attribute_syncSymbolOffset = 0x5B,
    ApiMac_attribute_eBeaconSequenceNumber = 0x5E,
    ApiMac_attribute_eBeaconOrder = 0x5F,
    ApiMac_attribute_offsetTimeslot = 0x61,
    ApiMac_attribute_phyTransmitPowerSigned = 0xE0,
    ApiMac_attribute_logicalChannel = 0xE1,
    ApiMac_attribute_altBackoffExponent = 0xE3,
    ApiMac_attribute_deviceBeaconOrder = 0xE4,
    ApiMac_attribute_rf4cePowerSavings = 0xE5,
    ApiMac_attribute_frameVersionSupport = 0xE6,
    ApiMac_attribute_channelPage = 0xE7,
    ApiMac_attribute_phyCurrentDescriptorId = 0xE8,
    ApiMac_attribute_rssiThreshold = 0xF4,
    ApiMac_attribute_rangeExtender = 0xF5,
    ApiMac_attribute_enDataAckPending = 0xF6,
    ApiMac_attribute_rfFreq = 0xF7,
    ApiMac_attribute_paType = 0xF8,
} ApiMac_attribute_uint8_t;

typedef enum
{
    ApiMac_attribute_coordShortAddress = 0x4B,
    ApiMac_attribute_panId = 0x50,
    ApiMac_attribute_shortAddress = 0x53,
    ApiMac_attribute_transactionPersistenceTime = 0x55,
    ApiMac_attribute_maxFrameTotalWaitTime = 0x58,
    ApiMac_attribute_eBeaconOrderNBPAN = 0x60,
} ApiMac_attribute_uint16_t;


typedef enum
{
    ApiMac_attribute_beaconTxTime = 0x48,
    ApiMac_attribute_diagRxCrcPass = 0xEA,
    ApiMac_attribute_diagRxCrcFail = 0xEB,
    ApiMac_attribute_diagRxBroadcast = 0xEC,
    ApiMac_attribute_diagTxBroadcast = 0xED,
    ApiMac_attribute_diagRxUnicast = 0xEE,
    ApiMac_attribute_diagTxUnicast = 0xEF,
    ApiMac_attribute_diagTxUnicastRetry = 0xF0,
    ApiMac_attribute_diagTxUnicastFail = 0xF1,
    ApiMac_attribute_diagRxSecureFail = 0xF2,
    ApiMac_attribute_diagTxSecureFail = 0xF3
} ApiMac_attribute_uint32_t;

typedef enum
{
    ApiMac_attribute_beaconPayload = 0x45,
    ApiMac_attribute_coordExtendedAddress = 0x4A,
    ApiMac_attribute_extendedAddress = 0xE2,
} ApiMac_attribute_array_t;

typedef enum
{
    ApiMac_securityAttribute_securityLevelTableEntries = 0x83,
    ApiMac_securityAttribute_autoRequestSecurityLevel = 0x85,
    ApiMac_securityAttribute_autoRequestKeyIdMode = 0x86,
    ApiMac_securityAttribute_autoRequestKeyIndex = 0x88,
} ApiMac_securityAttribute_uint8_t;

typedef enum
{
    ApiMac_securityAttribute_keyTableEntries = 0x81,

    ApiMac_securityAttribute_deviceTableEntries = 0x82,

    ApiMac_securityAttribute_panCoordShortAddress = 0x8B,

} ApiMac_securityAttribute_uint16_t;

typedef enum
{
    ApiMac_securityAttribute_autoRequestKeySource = 0x87,
    ApiMac_securityAttribute_defaultKeySource = 0x89,
    ApiMac_securityAttribute_panCoordExtendedAddress = 0x8A,
} ApiMac_securityAttribute_array_t;

typedef enum
{
    ApiMac_securityAttribute_keyTable = 0x71,
    ApiMac_securityAttribute_keyIdLookupEntry = 0xD0,
    ApiMac_securityAttribute_keyDeviceEntry = 0xD1,
    ApiMac_securityAttribute_keyUsageEntry = 0xD2,
    ApiMac_securityAttribute_keyEntry = 0xD3,
    ApiMac_securityAttribute_deviceEntry = 0xD4,
    ApiMac_securityAttribute_securityLevelEntry = 0xD5
} ApiMac_securityAttribute_struct_t;

typedef enum
{
    ApiMac_FHAttribute_unicastDwellInterval = 0x2004,
    ApiMac_FHAttribute_broadcastDwellInterval = 0x2005,
    ApiMac_FHAttribute_clockDrift = 0x2006,
    ApiMac_FHAttribute_timingAccuracy = 0x2007,
    ApiMac_FHAttribute_unicastChannelFunction = 0x2008,
    ApiMac_FHAttribute_broadcastChannelFunction = 0x2009,
    ApiMac_FHAttribute_useParentBSIE = 0x200A,
    ApiMac_FHAttribute_routingCost = 0x200F,
    ApiMac_FHAttribute_routingMethod = 0x2010,
    ApiMac_FHAttribute_eapolReady = 0x2011,
    ApiMac_FHAttribute_fanTPSVersion = 0x2012,
    ApiMac_FHAttribute_CsmaBaseBacoff = 0x201A,

} ApiMac_FHAttribute_uint8_t;

typedef enum
{
    ApiMac_FHAttribute_broadcastSchedId = 0x200B,
    ApiMac_FHAttribute_unicastFixedChannel = 0x200C,
    ApiMac_FHAttribute_broadcastFixedChannel = 0x200D,
    ApiMac_FHAttribute_panSize = 0x200E,
    ApiMac_FHAttribute_panVersion = 0x2014,
    ApiMac_FHAttribute_neighborValidTime = 0x2019,
    ApiMac_FHAttribute_numNonSleepDevice = 0x201b,
    ApiMac_FHAttribute_numSleepDevice = 0x201c,
    ApiMac_FHAttribute_numTempTableNode = 0x201d,

} ApiMac_FHAttribute_uint16_t;

typedef enum
{
    ApiMac_FHAttribute_BCInterval = 0x2001,
} ApiMac_FHAttribute_uint32_t;

typedef enum
{
    ApiMac_FHAttribute_trackParentEUI = 0x2000,
    ApiMac_FHAttribute_unicastExcludedChannels = 0x2002,
    ApiMac_FHAttribute_broadcastExcludedChannels = 0x2003,
    ApiMac_FHAttribute_netName = 0x2013,
    ApiMac_FHAttribute_gtk0Hash = 0x2015,
    ApiMac_FHAttribute_gtk1Hash = 0x2016,
    ApiMac_FHAttribute_gtk2Hash = 0x2017,
    ApiMac_FHAttribute_gtk3Hash = 0x2018,
} ApiMac_FHAttribute_array_t;

typedef enum
{
    ApiMac_fhFrameType_panAdvert = 0x00,
    ApiMac_fhFrameType_panAdvertSolicit = 0x01,
    ApiMac_fhFrameType_config = 0x02,
    ApiMac_fhFrameType_configSolicit = 0x03,
    ApiMac_fhFrameType_data = 0x04,
    ApiMac_fhFrameType_ack = 0x05,
    ApiMac_fhFrameType_eapol = 0x06,
    ApiMac_fhFrameType_invalid = 0xFF
} ApiMac_fhFrameType_t;

typedef enum
{
    ApiMac_payloadIEGroup_ESDU = 0x00,
    ApiMac_payloadIEGroup_MLME = 0x01,
    ApiMac_payloadIEGroup_WiSUN = 0x04,
    ApiMac_payloadIEGroup_term = 0x0F
} ApiMac_payloadIEGroup_t;

typedef enum
{
    ApiMac_MLMESubIE_coexist = 0x21,
    ApiMac_MLMESubIE_sunDevCap = 0x22,
    ApiMac_MLMESubIE_sunFSKGenPhy = 0x23,
} ApiMac_MLMESubIE_t;

typedef enum
{
    ApiMac_wisunSubIE_USIE = 1,
    ApiMac_wisunSubIE_BSIE = 2,
    ApiMac_wisunSubIE_PANIE = 4,
    ApiMac_wisunSubIE_netNameIE = 5,
    ApiMac_wisunSubIE_PANVersionIE = 6,
    ApiMac_wisunSubIE_GTKHashIE = 7
} ApiMac_wisunSubIE_t;

typedef enum
{
    ApiMac_scantype_energyDetect = 0,
    ApiMac_scantype_active = 1,
    ApiMac_scantype_passive = 2,
    ApiMac_scantype_orphan = 3,
    ApiMac_scantype_activeEnhanced = 5
} ApiMac_scantype_t;

typedef enum
{
    ApiMac_wisunAsycnOperation_start = 0,
    ApiMac_wisunAsycnOperation_stop = 1
} ApiMac_wisunAsycnOperation_t;

typedef enum
{
    ApiMac_wisunAsyncFrame_advertisement = 0,
    ApiMac_wisunAsyncFrame_advertisementSolicit = 1,
    ApiMac_wisunAsyncFrame_config = 2,
    ApiMac_wisunAsyncFrame_configSolicit = 3
} ApiMac_wisunAsyncFrame_t;

typedef enum
{
    ApiMac_fhDispatchType_none = 0,
    ApiMac_fhDispatchType_MHD_PDU = 1,
    ApiMac_fhDispatchType_6LowPAN = 2
} ApiMac_fhDispatchType_t;

/******************************************************************************
 Structures - Building blocks for the API for the MAC Module
 *****************************************************************************/

typedef uint8_t ApiMac_sAddrExt_t[APIMAC_SADDR_EXT_LEN];

typedef struct
{
    union
    {
        uint16_t shortAddr;
        ApiMac_sAddrExt_t extAddr;
    } addr;

    ApiMac_addrType_t addrMode;
} ApiMac_sAddr_t;

typedef struct _apimac_sdata
{
    uint8_t *p;
    uint16_t len;
} ApiMac_sData_t;

typedef struct _apimac_mrfskphydesc
{
    uint32_t firstChCentrFreq;
    uint16_t numChannels;
    uint32_t channelSpacing;
    uint8_t fskModScheme;
    uint16_t symbolRate;
    uint8_t fskModIndex;
    uint8_t ccaType;
} ApiMac_MRFSKPHYDesc_t;

typedef struct _apimac_sec
{
    uint8_t keySource[APIMAC_KEY_SOURCE_MAX_LEN];
    uint8_t securityLevel;
    uint8_t keyIdMode;
    uint8_t keyIndex;
} ApiMac_sec_t;

typedef struct _apimac_keyidlookupdescriptor
{
    uint8_t lookupData[APIMAC_MAX_KEY_LOOKUP_LEN];
    uint8_t lookupDataSize;
} ApiMac_keyIdLookupDescriptor_t;

typedef struct _apimac_keydevicedescriptor
{
    uint16_t deviceDescriptorHandle;
    bool uniqueDevice;
    bool blackListed;
} ApiMac_keyDeviceDescriptor_t;

typedef struct _apimac_keyusagedescriptor
{
    uint8_t frameType;
    uint8_t cmdFrameId;
} ApiMac_keyUsageDescriptor_t;

typedef struct _apimac_keydescriptor
{
    ApiMac_keyIdLookupDescriptor_t *keyIdLookupList;
    uint8_t keyIdLookupEntries;
    ApiMac_keyDeviceDescriptor_t *keyDeviceList;

    uint16_t keyDeviceListEntries;

    ApiMac_keyUsageDescriptor_t *keyUsageList;
    uint8_t keyUsageListEntries;
    uint8_t key[APIMAC_KEY_MAX_LEN];
    uint32_t frameCounter;
} ApiMac_keyDescriptor_t;

typedef struct _apimac_devicedescriptor
{
    uint16_t panID;
    uint16_t shortAddress;
    ApiMac_sAddrExt_t extAddress;
} ApiMac_deviceDescriptor_t;

typedef struct _apimac_securityleveldescriptor
{
    uint8_t frameType;
    uint8_t commandFrameIdentifier;
    uint8_t securityMinimum;
    bool securityOverrideSecurityMinimum;
} ApiMac_securityLevelDescriptor_t;

typedef struct
{
    uint32_t             frameCounter;
    uint16_t             keyIdx;
} ApiMac_frameCntr_t;

typedef struct _apimac_secdevicedescriptor
{
    ApiMac_deviceDescriptor_t devInfo;
    ApiMac_frameCntr_t *frameCntr;
    bool exempt;
} ApiMac_securityDeviceDescriptor_t;

typedef struct _apimac_securitykeyentry
{
    uint8_t keyEntry[APIMAC_KEY_MAX_LEN];
    uint8_t keyIndex;
    uint32_t frameCounter;
} ApiMac_securityKeyEntry_t;

typedef struct _apimac_securitypibkeyidlookupentry
{
    uint16_t keyIndex;
    uint8_t  keyIdLookupIndex;
    ApiMac_keyIdLookupDescriptor_t lookupEntry;
} ApiMac_securityPibKeyIdLookupEntry_t;

typedef struct _apimac_securitypibkeydeviceentry
{
    uint16_t keyIndex;
    uint16_t keyDeviceIndex;
    ApiMac_keyDeviceDescriptor_t deviceEntry;
} ApiMac_securityPibKeyDeviceEntry_t;

typedef struct _apimac_securitypibkeyusageentry
{
    uint16_t keyIndex;
    uint8_t keyUsageIndex;
    ApiMac_keyUsageDescriptor_t usageEntry;
} ApiMac_securityPibKeyUsageEntry_t;

typedef struct _apimac_securitypibkeyentry
{
    uint16_t keyIndex;
    uint8_t keyEntry[APIMAC_KEY_MAX_LEN];
    uint32_t frameCounter;
} ApiMac_securityPibKeyEntry_t;

typedef struct _apimac_securitypibdeviceentry
{
    uint16_t deviceIndex;
    ApiMac_securityDeviceDescriptor_t deviceEntry;
} ApiMac_securityPibDeviceEntry_t;


typedef struct _apimac_securitypiblevelentry
{
    uint8_t levelIndex;
    ApiMac_securityLevelDescriptor_t levelEntry;
} ApiMac_securityPibSecurityLevelEntry_t;

typedef struct _apimac_capabilityinfo
{
    bool panCoord;
    bool ffd;
    bool mainsPower;
    bool rxOnWhenIdle;
    bool security;
    bool allocAddr;
} ApiMac_capabilityInfo_t;

typedef struct _apimac_txoptions
{
    bool ack;
    bool indirect;
    bool pendingBit;
    bool noRetransmits;
    bool noConfirm;
    bool useAltBE;
    bool usePowerAndChannel;
    bool useGreenPower;
} ApiMac_txOptions_t;

typedef struct _apimac_mcpsdatareq
{
    ApiMac_sAddr_t dstAddr;
    uint16_t dstPanId;
    ApiMac_addrType_t srcAddrMode;
    uint8_t msduHandle;
    ApiMac_txOptions_t txOptions;
    uint8_t channel;
    uint8_t power;
    uint8_t *pIEList;
    uint16_t payloadIELen;
    ApiMac_fhDispatchType_t fhProtoDispatch;
    uint32_t includeFhIEs;
    ApiMac_sData_t msdu;
    ApiMac_sec_t sec;
    uint8_t  gpOffset;
    uint8_t  gpDuration;
} ApiMac_mcpsDataReq_t;

typedef struct _apimac_payloadieitem
{
    bool ieTypeLong;
    uint8_t ieId;
    uint16_t ieContentLen;
    uint8_t *pIEContent;
} ApiMac_payloadIeItem_t;

typedef struct _apimac_payloadierec
{
    void *pNext;
    ApiMac_payloadIeItem_t item;
} ApiMac_payloadIeRec_t;

typedef struct _apimac_mcpsdataind
{
    ApiMac_sAddr_t srcAddr;
    ApiMac_sAddr_t dstAddr;
    uint32_t timestamp;
    uint16_t timestamp2;
    uint16_t srcPanId;
    uint16_t dstPanId;
    uint8_t mpduLinkQuality;
    uint8_t correlation;
    int8_t rssi;
    uint8_t dsn;
    uint16_t payloadIeLen;
    uint8_t *pPayloadIE;
    ApiMac_fhFrameType_t fhFrameType;
    ApiMac_fhDispatchType_t fhProtoDispatch;
    uint32_t frameCntr;
    ApiMac_sec_t sec;
    ApiMac_sData_t msdu;
} ApiMac_mcpsDataInd_t;

typedef struct _apimac_mcpsdatacnf
{
    ApiMac_status_t status;
    uint8_t msduHandle;
    uint32_t timestamp;
    uint16_t timestamp2;
    uint8_t retries;
    uint8_t mpduLinkQuality;
    uint8_t correlation;
    int8_t rssi;
    uint32_t frameCntr;
} ApiMac_mcpsDataCnf_t;

typedef struct _apimac_mcpspurgecnf
{
    ApiMac_status_t status;
    uint8_t msduHandle;
} ApiMac_mcpsPurgeCnf_t;

typedef struct _apimac_pandesc
{
    ApiMac_sAddr_t coordAddress;
    uint16_t coordPanId;
    uint16_t superframeSpec;
    uint8_t logicalChannel;
    uint8_t channelPage;
    bool gtsPermit;
    uint8_t linkQuality;
    uint32_t timestamp;
    bool securityFailure;
    ApiMac_sec_t sec;
} ApiMac_panDesc_t;

typedef struct _apimac_macmlmeassociatereq
{
    ApiMac_sec_t sec;
    uint8_t logicalChannel;
    uint8_t channelPage;
    uint8_t phyID;
    ApiMac_sAddr_t coordAddress;
    uint16_t coordPanId;
    ApiMac_capabilityInfo_t capabilityInformation;
} ApiMac_mlmeAssociateReq_t;

typedef struct _apimac_mlmeassociatersp
{
    ApiMac_sec_t sec;
    ApiMac_sAddrExt_t deviceAddress;
    uint16_t assocShortAddress;
    ApiMac_assocStatus_t status;
} ApiMac_mlmeAssociateRsp_t;

typedef struct _apimac_mlmedisassociatereq
{
    ApiMac_sec_t sec;
    ApiMac_sAddr_t deviceAddress;
    uint16_t devicePanId;
    ApiMac_disassocateReason_t disassociateReason;
    bool txIndirect;
} ApiMac_mlmeDisassociateReq_t;

typedef struct _apimac_mlmeorphanrsp
{
    ApiMac_sec_t sec;
    ApiMac_sAddrExt_t orphanAddress;
    uint16_t shortAddress;
    bool associatedMember;
} ApiMac_mlmeOrphanRsp_t;

typedef struct _apimac_mlmepollreq
{
    ApiMac_sAddr_t coordAddress;
    uint16_t coordPanId;
    ApiMac_sec_t sec;
} ApiMac_mlmePollReq_t;

typedef struct _apimac_mlmescanreq
{
    uint8_t scanChannels[APIMAC_154G_CHANNEL_BITMAP_SIZ];
    ApiMac_scantype_t scanType;
    uint8_t scanDuration;
    uint8_t channelPage;
    uint8_t phyID;
    uint8_t maxResults;
    bool permitJoining;
    uint8_t linkQuality;
    uint8_t percentFilter;
    ApiMac_sec_t sec;
    bool MPMScan;
    uint8_t MPMScanType;
    uint16_t MPMScanDuration;
} ApiMac_mlmeScanReq_t;

typedef struct _apimac_mpmParams
{
    uint8_t eBeaconOrder;
    uint8_t offsetTimeSlot;
    uint16_t NBPANEBeaconOrder;
    uint8_t *pIEIDs;
    uint8_t numIEs;
} ApiMac_mpmParams_t;

typedef struct _apimac_mlmestartreq
{
    uint32_t startTime;
    uint16_t panId;
    uint8_t logicalChannel;
    uint8_t channelPage;
    uint8_t phyID;
    uint8_t beaconOrder;
    uint8_t superframeOrder;
    bool panCoordinator;
    bool batteryLifeExt;
    bool coordRealignment;
    ApiMac_sec_t realignSec;
    ApiMac_sec_t beaconSec;
    ApiMac_mpmParams_t mpmParams;
    bool startFH;
} ApiMac_mlmeStartReq_t;

typedef struct _apimac_mlmesyncreq
{
    uint8_t logicalChannel;
    uint8_t channelPage;
    uint8_t phyID;
    uint8_t trackBeacon;
} ApiMac_mlmeSyncReq_t;

typedef struct _apimac_mlmewsasyncreq
{
    ApiMac_sec_t sec;
    ApiMac_wisunAsycnOperation_t operation;
    ApiMac_wisunAsyncFrame_t frameType;
    uint8_t channels[APIMAC_154G_CHANNEL_BITMAP_SIZ];
} ApiMac_mlmeWSAsyncReq_t;

typedef struct _apimac_secadddevice
{
    uint16_t panID;
    uint16_t shortAddr;
    ApiMac_sAddrExt_t  extAddr;
    bool exempt;
    uint32_t frameCounter;
#ifndef FEATURE_SECURE_COMMISSIONING

    uint8_t keyIdLookupDataSize;
    uint8_t keyIdLookupData[APIMAC_MAX_KEY_LOOKUP_LEN];
    bool uniqueDevice;
    bool  duplicateDevFlag;
#endif
} ApiMac_secAddDevice_t;

typedef struct _apimac_secaddkeyinitframecounter
{
    uint8_t key[APIMAC_KEY_MAX_LEN];
    uint32_t frameCounter;
    uint16_t replaceKeyIndex;

    bool newKeyFlag;
    uint8_t lookupDataSize;
    uint8_t lookupData[APIMAC_MAX_KEY_LOOKUP_LEN];
#ifdef FEATURE_SECURE_COMMISSIONING
    /* device key or network key */
    bool networkKey;
    /* ext. Address*/
    ApiMac_sAddrExt_t ApiMac_extAddr;
#endif
} ApiMac_secAddKeyInitFrameCounter_t;

typedef struct _apimac_mlmeassociateind
{
    ApiMac_sAddrExt_t deviceAddress;
    ApiMac_capabilityInfo_t capabilityInformation;
    ApiMac_sec_t sec;
} ApiMac_mlmeAssociateInd_t;

typedef struct _apimac_mlmeassociatecnf
{
    ApiMac_assocStatus_t status;
    uint16_t assocShortAddress;
    ApiMac_sec_t sec;
} ApiMac_mlmeAssociateCnf_t;

typedef struct _apimac_mlmedisassociateind
{
    ApiMac_sAddrExt_t deviceAddress;
    ApiMac_disassocateReason_t disassociateReason;
    ApiMac_sec_t sec;
} ApiMac_mlmeDisassociateInd_t;

typedef struct _apimac_mlmediassociatecnf
{
    ApiMac_status_t status;
    ApiMac_sAddr_t deviceAddress;
    uint16_t panId;
} ApiMac_mlmeDisassociateCnf_t;

typedef struct _apimac_beacondata
{
    uint8_t numPendShortAddr;
    uint16_t *pShortAddrList;
    uint8_t numPendExtAddr;
    uint8_t *pExtAddrList;
    uint8_t sduLength;
    uint8_t *pSdu;
} ApiMac_beaconData_t;

typedef struct _apimac_coexist
{
    uint8_t beaconOrder;
    uint8_t superFrameOrder;
    uint8_t finalCapSlot;
    uint8_t eBeaconOrder;
    uint8_t offsetTimeSlot;
    uint8_t capBackOff;
    uint16_t eBeaconOrderNBPAN;
} ApiMac_coexist_t;

typedef struct _apimac_ebeacondata
{
    ApiMac_coexist_t coexist;
} ApiMac_eBeaconData_t;

typedef struct
{
    ApiMac_beaconType_t beaconType;
    uint8_t bsn;
    ApiMac_panDesc_t panDesc;
    union
    {
        ApiMac_beaconData_t beacon;
        ApiMac_eBeaconData_t eBeacon;
    } beaconData;
} ApiMac_mlmeBeaconNotifyInd_t;

typedef struct _apimac_mlmeorphanind
{
    ApiMac_sAddrExt_t orphanAddress;
    ApiMac_sec_t sec;
} ApiMac_mlmeOrphanInd_t;

typedef struct _apimac_mlmescancnf
{
    ApiMac_status_t status;
    ApiMac_scantype_t scanType;
    uint8_t channelPage;
    uint8_t phyId;
    uint8_t unscannedChannels[APIMAC_154G_CHANNEL_BITMAP_SIZ];
    uint8_t resultListSize;
    union
    {
        uint8_t *pEnergyDetect;
        ApiMac_panDesc_t *pPanDescriptor;
    } result;
} ApiMac_mlmeScanCnf_t;

typedef struct _apimac_mlmestartcnf
{
    ApiMac_status_t status;
} ApiMac_mlmeStartCnf_t;

typedef struct _apimac_mlmesynclossind
{
    ApiMac_status_t reason;
    uint16_t panId;
    uint8_t logicalChannel;
    uint8_t channelPage;
    uint8_t phyID;
    ApiMac_sec_t sec;
} ApiMac_mlmeSyncLossInd_t;

typedef struct _apimac_mlmepollcnf
{
    ApiMac_status_t status;
    uint8_t framePending;
} ApiMac_mlmePollCnf_t;

typedef struct _apimac_mlmecommstatusind
{
    ApiMac_status_t status;
    ApiMac_sAddr_t srcAddr;
    ApiMac_sAddr_t dstAddr;
    uint16_t panId;
    ApiMac_commStatusReason_t reason;
    ApiMac_sec_t sec;
} ApiMac_mlmeCommStatusInd_t;

typedef struct _apimac_mlmepollind
{
    ApiMac_sAddr_t srcAddr;
    uint16_t srcPanId;
    bool noRsp;
} ApiMac_mlmePollInd_t;

typedef ApiMac_mcpsDataInd_t ApiMac_mlmeWsAsyncInd_t;

typedef struct _apimac_mlmewsasynccnf
{
    ApiMac_status_t status;
} ApiMac_mlmeWsAsyncCnf_t;

typedef void (*ApiMac_associateIndFp_t)(ApiMac_mlmeAssociateInd_t *pAssocInd);

typedef void (*ApiMac_associateCnfFp_t)(ApiMac_mlmeAssociateCnf_t *pAssocCnf);

typedef void (*ApiMac_disassociateIndFp_t)(
                ApiMac_mlmeDisassociateInd_t *pDisassociateInd);

typedef void (*ApiMac_disassociateCnfFp_t)(
                ApiMac_mlmeDisassociateCnf_t *pDisassociateCnf);

typedef void (*ApiMac_beaconNotifyIndFp_t)(
                ApiMac_mlmeBeaconNotifyInd_t *pBeaconNotifyInd);

typedef void (*ApiMac_orphanIndFp_t)(ApiMac_mlmeOrphanInd_t *pOrphanInd);

typedef void (*ApiMac_scanCnfFp_t)(ApiMac_mlmeScanCnf_t *pScanCnf);

typedef void (*ApiMac_startCnfFp_t)(ApiMac_mlmeStartCnf_t *pStartCnf);

typedef void (*ApiMac_syncLossIndFp_t)(ApiMac_mlmeSyncLossInd_t *pSyncLossInd);

typedef void (*ApiMac_pollCnfFp_t)(ApiMac_mlmePollCnf_t *pPollCnf);

typedef void (*ApiMac_commStatusIndFp_t)(
                ApiMac_mlmeCommStatusInd_t *pCommStatus);

typedef void (*ApiMac_pollIndFp_t)(ApiMac_mlmePollInd_t *pPollInd);

typedef void (*ApiMac_dataCnfFp_t)(ApiMac_mcpsDataCnf_t *pDataCnf);

typedef void (*ApiMac_dataIndFp_t)(ApiMac_mcpsDataInd_t *pDataInd);

typedef void (*ApiMac_purgeCnfFp_t)(ApiMac_mcpsPurgeCnf_t *pPurgeCnf);

typedef void (*ApiMac_wsAsyncIndFp_t)(ApiMac_mlmeWsAsyncInd_t *pWsAsyncInd);

typedef void (*ApiMac_wsAsyncCnfFp_t)(ApiMac_mlmeWsAsyncCnf_t *pWsAsyncCnf);

typedef void (*ApiMac_unprocessedFp_t)(uint16_t param1, uint16_t param2,
                                       void *pMsg);

typedef struct _apimac_callbacks
{
    ApiMac_associateIndFp_t pAssocIndCb;
    ApiMac_associateCnfFp_t pAssocCnfCb;
    ApiMac_disassociateIndFp_t pDisassociateIndCb;
    ApiMac_disassociateCnfFp_t pDisassociateCnfCb;
    ApiMac_beaconNotifyIndFp_t pBeaconNotifyIndCb;
    ApiMac_orphanIndFp_t pOrphanIndCb;
    ApiMac_scanCnfFp_t pScanCnfCb;
    ApiMac_startCnfFp_t pStartCnfCb;
    ApiMac_syncLossIndFp_t pSyncLossIndCb;
    ApiMac_pollCnfFp_t pPollCnfCb;
    ApiMac_commStatusIndFp_t pCommStatusCb;
    ApiMac_pollIndFp_t pPollIndCb;
    ApiMac_dataCnfFp_t pDataCnfCb;
    ApiMac_dataIndFp_t pDataIndCb;
    ApiMac_purgeCnfFp_t pPurgeCnfCb;
    ApiMac_wsAsyncIndFp_t pWsAsyncIndCb;
    ApiMac_wsAsyncCnfFp_t pWsAsyncCnfCb;
    ApiMac_unprocessedFp_t pUnprocessedCb;
} ApiMac_callbacks_t;

/******************************************************************************
 Function Prototypes
 *****************************************************************************/

extern void *ApiMac_init(bool enableFH);

extern void ApiMac_registerCallbacks(ApiMac_callbacks_t *pCallbacks);

extern void ApiMac_processIncoming(void);

extern ApiMac_status_t ApiMac_mcpsDataReq(ApiMac_mcpsDataReq_t *pData);

extern ApiMac_status_t ApiMac_mcpsPurgeReq(uint8_t msduHandle);

extern ApiMac_status_t ApiMac_mlmeAssociateReq(
                ApiMac_mlmeAssociateReq_t *pData);

extern ApiMac_status_t ApiMac_mlmeAssociateRsp(
                ApiMac_mlmeAssociateRsp_t *pData);

extern ApiMac_status_t ApiMac_mlmeDisassociateReq(
                ApiMac_mlmeDisassociateReq_t *pData);

extern ApiMac_status_t ApiMac_mlmeGetReqBool(
                ApiMac_attribute_bool_t pibAttribute,
                bool *pValue);

extern ApiMac_status_t ApiMac_mlmeGetReqUint8(
                ApiMac_attribute_uint8_t pibAttribute,
                uint8_t *pValue);

extern ApiMac_status_t ApiMac_mlmeGetReqUint16(
                ApiMac_attribute_uint16_t pibAttribute,
                uint16_t *pValue);

extern ApiMac_status_t ApiMac_mlmeGetReqUint32(
                ApiMac_attribute_uint32_t pibAttribute,
                uint32_t *pValue);

extern ApiMac_status_t ApiMac_mlmeGetReqArray(
                ApiMac_attribute_array_t pibAttribute,
                uint8_t *pValue);

extern ApiMac_status_t ApiMac_mlmeGetFhReqUint8(
                ApiMac_FHAttribute_uint8_t pibAttribute, uint8_t *pValue);

extern ApiMac_status_t ApiMac_mlmeGetFhReqUint16(
                ApiMac_FHAttribute_uint16_t pibAttribute, uint16_t *pValue);

extern ApiMac_status_t ApiMac_mlmeGetFhReqUint32(
                ApiMac_FHAttribute_uint32_t pibAttribute, uint32_t *pValue);

extern ApiMac_status_t ApiMac_mlmeGetFhReqArray(
                ApiMac_FHAttribute_array_t pibAttribute, uint8_t *pValue);

extern ApiMac_status_t ApiMac_mlmeGetSecurityReqUint8(
                ApiMac_securityAttribute_uint8_t pibAttribute, uint8_t *pValue);

extern ApiMac_status_t ApiMac_mlmeGetSecurityReqUint16(
             ApiMac_securityAttribute_uint16_t pibAttribute, uint16_t *pValue);

extern ApiMac_status_t ApiMac_mlmeGetSecurityReqArray(
             ApiMac_securityAttribute_array_t pibAttribute, uint8_t *pValue);

extern ApiMac_status_t ApiMac_mlmeGetSecurityReqStruct(
             ApiMac_securityAttribute_struct_t pibAttribute, void *pValue);

extern ApiMac_status_t ApiMac_mlmeOrphanRsp(ApiMac_mlmeOrphanRsp_t *pData);

extern ApiMac_status_t ApiMac_mlmePollReq(ApiMac_mlmePollReq_t *pData);

extern ApiMac_status_t ApiMac_mlmeResetReq(bool setDefaultPib);

extern ApiMac_status_t ApiMac_mlmeScanReq(ApiMac_mlmeScanReq_t *pData);

extern ApiMac_status_t ApiMac_mlmeSetReqBool(
                ApiMac_attribute_bool_t pibAttribute,
                bool value);

extern ApiMac_status_t ApiMac_mlmeSetReqUint8(
                ApiMac_attribute_uint8_t pibAttribute,
                uint8_t value);

extern ApiMac_status_t ApiMac_mlmeSetReqUint16(
                ApiMac_attribute_uint16_t pibAttribute,
                uint16_t value);

extern ApiMac_status_t ApiMac_mlmeSetReqUint32(
                ApiMac_attribute_uint32_t pibAttribute,
                uint32_t value);

extern ApiMac_status_t ApiMac_mlmeSetReqArray(
                ApiMac_attribute_array_t pibAttribute,
                uint8_t *pValue);

extern ApiMac_status_t ApiMac_mlmeSetFhReqUint8(
                ApiMac_FHAttribute_uint8_t pibAttribute, uint8_t value);

extern ApiMac_status_t ApiMac_mlmeSetFhReqUint16(
                ApiMac_FHAttribute_uint16_t pibAttribute, uint16_t value);

extern ApiMac_status_t ApiMac_mlmeSetFhReqUint32(
                ApiMac_FHAttribute_uint32_t pibAttribute, uint32_t value);

extern ApiMac_status_t ApiMac_mlmeSetFhReqArray(
                ApiMac_FHAttribute_array_t pibAttribute, uint8_t *pValue);

extern ApiMac_status_t ApiMac_mlmeSetSecurityReqUint8(
                ApiMac_securityAttribute_uint8_t pibAttribute, uint8_t value);

extern ApiMac_status_t ApiMac_mlmeSetSecurityReqUint16(
                ApiMac_securityAttribute_uint16_t pibAttribute, uint16_t value);

extern ApiMac_status_t ApiMac_mlmeSetSecurityReqArray(
                ApiMac_securityAttribute_array_t pibAttribute, uint8_t *pValue);

extern ApiMac_status_t ApiMac_mlmeSetSecurityReqStruct(
                ApiMac_securityAttribute_struct_t pibAttribute, void *pValue);

extern ApiMac_status_t ApiMac_mlmeStartReq(ApiMac_mlmeStartReq_t *pData);

extern ApiMac_status_t ApiMac_mlmeSyncReq(ApiMac_mlmeSyncReq_t *pData);

extern uint8_t ApiMac_randomByte(void);

extern ApiMac_status_t ApiMac_updatePanId(uint16_t panId);

#if defined(COMBO_MAC) || defined(FREQ_2_4G)

extern ApiMac_status_t ApiMac_srcMatchEnable(void);
#endif

extern ApiMac_status_t ApiMac_mlmeWSAsyncReq(ApiMac_mlmeWSAsyncReq_t* pData);

extern ApiMac_status_t ApiMac_startFH(void);

extern ApiMac_status_t ApiMac_parsePayloadGroupIEs(
                uint8_t *pPayload, uint16_t payloadLen,
                ApiMac_payloadIeRec_t **pList);

extern ApiMac_status_t ApiMac_parsePayloadSubIEs(uint8_t *pContent,
                                                 uint16_t contentLen,
                                                 ApiMac_payloadIeRec_t **pList);

extern void ApiMac_freeIEList(ApiMac_payloadIeRec_t *pList);

extern ApiMac_status_t ApiMac_enableFH(void);

extern uint8_t ApiMac_convertCapabilityInfo(
                ApiMac_capabilityInfo_t *pMsgcapInfo);

extern void ApiMac_buildMsgCapInfo(uint8_t cInfo,
                                   ApiMac_capabilityInfo_t *pPBcapInfo);

extern ApiMac_status_t ApiMac_secAddDevice(ApiMac_secAddDevice_t *pAddDevice);

extern ApiMac_status_t ApiMac_secDeleteDevice(ApiMac_sAddrExt_t *pExtAddr);

extern ApiMac_status_t ApiMac_secDeleteKeyAndAssocDevices(uint8_t keyIndex);

extern ApiMac_status_t ApiMac_secDeleteAllDevices(void);

extern ApiMac_status_t ApiMac_secGetDefaultSourceKey(uint8_t keyId,
                                                     uint32_t *pFrameCounter);

extern ApiMac_status_t ApiMac_secAddKeyInitFrameCounter(
                ApiMac_secAddKeyInitFrameCounter_t *pInfo);

#ifdef __cplusplus
}
#endif

#endif /* API_MAC_H */