TI-15.4 Stack API

The following is the application programming interface (API) for the Texas Instruments 802.15.4 MAC software. This API provides an interface to the management and data services of the 802.15.4 stack.

Callback Functions

These functions must be implemented by the application and are used to pass events and data from the MAC to the application. Data accessed through callback function parameters (such as a pointer to data) are only valid for the execution of the function and should not be considered valid when the function returns. These functions execute in the context of the MAC. The callback function implementation should avoid using critical sections and CPU intensive operations. The callback table structure should be setup application then call ApiMac_registerCallbacks() to register the table.

Common Constants and Structures

• Address Type - the common address type used by the MAC is the ApiMac_sAddr_t.
• Status Values - the common MAC status type is ApiMac_status_t.
• MAC Security Level - The security level (ApiMac_secLevel_t) defines the encryption and/or authentication methods used on the message frame.
• Key Identifier Modes - The key identifier mode (ApiMac_keyIdMode_t) defines how the key is determined from the key index
• Security Type- MAC security structure (ApiMac_sec_t).

Initialization and Task Interfaces

• ApiMac_init()
• ApiMac_registerCallbacks()
• ApiMac_processIncoming()

Data Interfaces

• ApiMac_mcpsDataReq()
• ApiMac_mcpsPurgeReq()

Management Interfaces

• ApiMac_mlmeAssociateReq()
• ApiMac_mlmeAssociateRsp()
• ApiMac_mlmeDisassociateReq()
• ApiMac_mlmeOrphanRsp()
• ApiMac_mlmePollReq()
• ApiMac_mlmeResetReq()
• ApiMac_mlmeScanReq()
• ApiMac_mlmeStartReq()
• ApiMac_mlmeSyncReq()
• ApiMac_mlmeWSAsyncReq()

Management Attribute Interfaces

The MAC attributes can be read and written to by use of the following Get and Set functions, which are organized by the attributes data type:

• ApiMac_mlmeGetReqBool()
• ApiMac_mlmeGetReqUint8()
• ApiMac_mlmeGetReqUint16()
• ApiMac_mlmeGetReqUint32()
• ApiMac_mlmeGetReqArray()
• ApiMac_mlmeGetFhReqUint8()
• ApiMac_mlmeGetFhReqUint16()
• ApiMac_mlmeGetFhReqUint32()
• ApiMac_mlmeGetFhReqArray()
• ApiMac_mlmeGetSecurityReqUint8()
• ApiMac_mlmeGetSecurityReqUint16()
• ApiMac_mlmeGetSecurityReqArray()
• ApiMac_mlmeGetSecurityReqStruct()
• ApiMac_mlmeSetReqBool()
• ApiMac_mlmeSetReqUint8()
• ApiMac_mlmeSetReqUint16()
• ApiMac_mlmeSetReqUint32()
• ApiMac_mlmeSetReqArray()
• ApiMac_mlmeSetFhReqUint8()
• ApiMac_mlmeSetFhReqUint16()
• ApiMac_mlmeSetFhReqUint32()
• ApiMac_mlmeSetFhReqArray()
• ApiMac_mlmeSetSecurityReqUint8()
• ApiMac_mlmeSetSecurityReqUint16()
• ApiMac_mlmeSetSecurityReqArray()
• ApiMac_mlmeSetSecurityReqStruct()

Simplified Security Interfaces

• ApiMac_secAddDevice()
• ApiMac_secDeleteDevice()
• ApiMac_secDeleteKeyAndAssocDevices()
• ApiMac_secDeleteAllDevices()
• ApiMac_secGetDefaultSourceKey()
• ApiMac_secAddKeyInitFrameCounter()

Extension Interfaces

• ApiMac_randomByte()
• ApiMac_updatePanId()
• ApiMac_startFH()
• ApiMac_enableFH()
• ApiMac_parsePayloadGroupIEs()
• ApiMac_parsePayloadSubIEs()
• ApiMac_freeIEList()
• ApiMac_convertCapabilityInfo()
• ApiMac_buildMsgCapInfo()