rf_ieee_cmd.h

Go to the documentation of this file.

/******************************************************************************
*  Filename:       rf_ieee_cmd.h
*
*  Description:    CC13x2/CC26x2 API for IEEE 802.15.4 commands
*
*  Copyright (c) 2015 - 2020, Texas Instruments Incorporated
*  All rights reserved.
*
*  Redistribution and use in source and binary forms, with or without
*  modification, are permitted provided that the following conditions are met:
*
*  1) Redistributions of source code must retain the above copyright notice,
*     this list of conditions and the following disclaimer.
*
*  2) Redistributions in binary form must reproduce the above copyright notice,
*     this list of conditions and the following disclaimer in the documentation
*     and/or other materials provided with the distribution.
*
*  3) Neither the name of the ORGANIZATION nor the names of its contributors may
*     be used to endorse or promote products derived from this software without
*     specific prior written permission.
*
*  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
*  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
*  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
*  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
*  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
*  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
*  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
*  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
*  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
*  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
*  POSSIBILITY OF SUCH DAMAGE.
*
******************************************************************************/

#ifndef __IEEE_CMD_H
#define __IEEE_CMD_H

#ifndef __RFC_STRUCT
#define __RFC_STRUCT
#endif

#ifndef __RFC_STRUCT_ATTR
#if defined(__GNUC__)
#define __RFC_STRUCT_ATTR __attribute__ ((aligned (4)))
#elif defined(__TI_ARM__)
#define __RFC_STRUCT_ATTR __attribute__ ((__packed__,aligned (4)))
#else
#define __RFC_STRUCT_ATTR
#endif
#endif



#include <stdint.h>
#include "rf_mailbox.h"
#include "rf_common_cmd.h"

typedef struct __RFC_STRUCT rfc_CMD_IEEE_RX_s rfc_CMD_IEEE_RX_t;
typedef struct __RFC_STRUCT rfc_CMD_IEEE_ED_SCAN_s rfc_CMD_IEEE_ED_SCAN_t;
typedef struct __RFC_STRUCT rfc_CMD_IEEE_TX_s rfc_CMD_IEEE_TX_t;
typedef struct __RFC_STRUCT rfc_CMD_IEEE_CSMA_s rfc_CMD_IEEE_CSMA_t;
typedef struct __RFC_STRUCT rfc_CMD_IEEE_RX_ACK_s rfc_CMD_IEEE_RX_ACK_t;
typedef struct __RFC_STRUCT rfc_CMD_IEEE_ABORT_BG_s rfc_CMD_IEEE_ABORT_BG_t;
typedef struct __RFC_STRUCT rfc_CMD_IEEE_MOD_CCA_s rfc_CMD_IEEE_MOD_CCA_t;
typedef struct __RFC_STRUCT rfc_CMD_IEEE_MOD_FILT_s rfc_CMD_IEEE_MOD_FILT_t;
typedef struct __RFC_STRUCT rfc_CMD_IEEE_MOD_SRC_MATCH_s rfc_CMD_IEEE_MOD_SRC_MATCH_t;
typedef struct __RFC_STRUCT rfc_CMD_IEEE_ABORT_FG_s rfc_CMD_IEEE_ABORT_FG_t;
typedef struct __RFC_STRUCT rfc_CMD_IEEE_STOP_FG_s rfc_CMD_IEEE_STOP_FG_t;
typedef struct __RFC_STRUCT rfc_CMD_IEEE_CCA_REQ_s rfc_CMD_IEEE_CCA_REQ_t;
typedef struct __RFC_STRUCT rfc_ieeeRxOutput_s rfc_ieeeRxOutput_t;
typedef struct __RFC_STRUCT rfc_shortAddrEntry_s rfc_shortAddrEntry_t;
typedef struct __RFC_STRUCT rfc_ieeeRxCorrCrc_s rfc_ieeeRxCorrCrc_t;

#define CMD_IEEE_RX                                             0x2801
struct __RFC_STRUCT rfc_CMD_IEEE_RX_s {
   uint16_t commandNo;                  
   uint16_t status;                     
   rfc_radioOp_t *pNextOp;              
   ratmr_t startTime;                   
   struct {
      uint8_t triggerType:4;            
      uint8_t bEnaCmd:1;                
      uint8_t triggerNo:2;              
      uint8_t pastTrig:1;               
   } startTrigger;                      
   struct {
      uint8_t rule:4;                   
      uint8_t nSkip:4;                  
   } condition;
   uint8_t channel;                     
   struct {
      uint8_t bAutoFlushCrc:1;          
      uint8_t bAutoFlushIgn:1;          
      uint8_t bIncludePhyHdr:1;         
      uint8_t bIncludeCrc:1;            
      uint8_t bAppendRssi:1;            
      uint8_t bAppendCorrCrc:1;         
      uint8_t bAppendSrcInd:1;          
      uint8_t bAppendTimestamp:1;       
   } rxConfig;
   dataQueue_t* pRxQ;                   
   rfc_ieeeRxOutput_t *pOutput;         
   struct {
      uint16_t frameFiltEn:1;           
      uint16_t frameFiltStop:1;         
      uint16_t autoAckEn:1;             
      uint16_t slottedAckEn:1;          
      uint16_t autoPendEn:1;            
      uint16_t defaultPend:1;           
      uint16_t bPendDataReqOnly:1;      
      uint16_t bPanCoord:1;             
      uint16_t maxFrameVersion:2;       
      uint16_t fcfReservedMask:3;       
      uint16_t modifyFtFilter:2;        
      uint16_t bStrictLenFilter:1;      
   } frameFiltOpt;                      
   struct {
      uint8_t bAcceptFt0Beacon:1;       
      uint8_t bAcceptFt1Data:1;         
      uint8_t bAcceptFt2Ack:1;          
      uint8_t bAcceptFt3MacCmd:1;       
      uint8_t bAcceptFt4Reserved:1;     
      uint8_t bAcceptFt5Reserved:1;     
      uint8_t bAcceptFt6Reserved:1;     
      uint8_t bAcceptFt7Reserved:1;     
   } frameTypes;                        
   struct {
      uint8_t ccaEnEnergy:1;            
      uint8_t ccaEnCorr:1;              
      uint8_t ccaEnSync:1;              
      uint8_t ccaCorrOp:1;              
      uint8_t ccaSyncOp:1;              
      uint8_t ccaCorrThr:2;             
   } ccaOpt;                            
   int8_t ccaRssiThr;                   
   uint8_t __dummy0;
   uint8_t numExtEntries;               
   uint8_t numShortEntries;             
   uint32_t* pExtEntryList;             
   uint32_t* pShortEntryList;           
   uint64_t localExtAddr;               
   uint16_t localShortAddr;             
   uint16_t localPanID;                 
   uint16_t __dummy1;
   uint8_t __dummy2;
   struct {
      uint8_t triggerType:4;            
      uint8_t bEnaCmd:1;                
      uint8_t triggerNo:2;              
      uint8_t pastTrig:1;               
   } endTrigger;                        
   ratmr_t endTime;                     
} __RFC_STRUCT_ATTR;


#define CMD_IEEE_ED_SCAN                                        0x2802
struct __RFC_STRUCT rfc_CMD_IEEE_ED_SCAN_s {
   uint16_t commandNo;                  
   uint16_t status;                     
   rfc_radioOp_t *pNextOp;              
   ratmr_t startTime;                   
   struct {
      uint8_t triggerType:4;            
      uint8_t bEnaCmd:1;                
      uint8_t triggerNo:2;              
      uint8_t pastTrig:1;               
   } startTrigger;                      
   struct {
      uint8_t rule:4;                   
      uint8_t nSkip:4;                  
   } condition;
   uint8_t channel;                     
   struct {
      uint8_t ccaEnEnergy:1;            
      uint8_t ccaEnCorr:1;              
      uint8_t ccaEnSync:1;              
      uint8_t ccaCorrOp:1;              
      uint8_t ccaSyncOp:1;              
      uint8_t ccaCorrThr:2;             
   } ccaOpt;                            
   int8_t ccaRssiThr;                   
   uint8_t __dummy0;
   int8_t maxRssi;                      
   struct {
      uint8_t triggerType:4;            
      uint8_t bEnaCmd:1;                
      uint8_t triggerNo:2;              
      uint8_t pastTrig:1;               
   } endTrigger;                        
   ratmr_t endTime;                     
} __RFC_STRUCT_ATTR;


#define CMD_IEEE_TX                                             0x2C01
struct __RFC_STRUCT rfc_CMD_IEEE_TX_s {
   uint16_t commandNo;                  
   uint16_t status;                     
   rfc_radioOp_t *pNextOp;              
   ratmr_t startTime;                   
   struct {
      uint8_t triggerType:4;            
      uint8_t bEnaCmd:1;                
      uint8_t triggerNo:2;              
      uint8_t pastTrig:1;               
   } startTrigger;                      
   struct {
      uint8_t rule:4;                   
      uint8_t nSkip:4;                  
   } condition;
   struct {
      uint8_t bIncludePhyHdr:1;         
      uint8_t bIncludeCrc:1;            
      uint8_t :1;
      uint8_t payloadLenMsb:5;          
   } txOpt;
   uint8_t payloadLen;                  
   uint8_t* pPayload;                   
   ratmr_t timeStamp;                   
} __RFC_STRUCT_ATTR;


#define CMD_IEEE_CSMA                                           0x2C02
struct __RFC_STRUCT rfc_CMD_IEEE_CSMA_s {
   uint16_t commandNo;                  
   uint16_t status;                     
   rfc_radioOp_t *pNextOp;              
   ratmr_t startTime;                   
   struct {
      uint8_t triggerType:4;            
      uint8_t bEnaCmd:1;                
      uint8_t triggerNo:2;              
      uint8_t pastTrig:1;               
   } startTrigger;                      
   struct {
      uint8_t rule:4;                   
      uint8_t nSkip:4;                  
   } condition;
   uint16_t randomState;                
   uint8_t macMaxBE;                    
   uint8_t macMaxCSMABackoffs;          
   struct {
      uint8_t initCW:5;                 
      uint8_t bSlotted:1;               
      uint8_t rxOffMode:2;              
   } csmaConfig;
   uint8_t NB;                          
   uint8_t BE;                          
   uint8_t remainingPeriods;            
   int8_t lastRssi;                     
   struct {
      uint8_t triggerType:4;            
      uint8_t bEnaCmd:1;                
      uint8_t triggerNo:2;              
      uint8_t pastTrig:1;               
   } endTrigger;                        
   ratmr_t lastTimeStamp;               
   ratmr_t endTime;                     
} __RFC_STRUCT_ATTR;


#define CMD_IEEE_RX_ACK                                         0x2C03
struct __RFC_STRUCT rfc_CMD_IEEE_RX_ACK_s {
   uint16_t commandNo;                  
   uint16_t status;                     
   rfc_radioOp_t *pNextOp;              
   ratmr_t startTime;                   
   struct {
      uint8_t triggerType:4;            
      uint8_t bEnaCmd:1;                
      uint8_t triggerNo:2;              
      uint8_t pastTrig:1;               
   } startTrigger;                      
   struct {
      uint8_t rule:4;                   
      uint8_t nSkip:4;                  
   } condition;
   uint8_t seqNo;                       
   struct {
      uint8_t triggerType:4;            
      uint8_t bEnaCmd:1;                
      uint8_t triggerNo:2;              
      uint8_t pastTrig:1;               
   } endTrigger;                        
   ratmr_t endTime;                     
} __RFC_STRUCT_ATTR;


#define CMD_IEEE_ABORT_BG                                       0x2C04
struct __RFC_STRUCT rfc_CMD_IEEE_ABORT_BG_s {
   uint16_t commandNo;                  
   uint16_t status;                     
   rfc_radioOp_t *pNextOp;              
   ratmr_t startTime;                   
   struct {
      uint8_t triggerType:4;            
      uint8_t bEnaCmd:1;                
      uint8_t triggerNo:2;              
      uint8_t pastTrig:1;               
   } startTrigger;                      
   struct {
      uint8_t rule:4;                   
      uint8_t nSkip:4;                  
   } condition;
} __RFC_STRUCT_ATTR;


#define CMD_IEEE_MOD_CCA                                        0x2001
struct __RFC_STRUCT rfc_CMD_IEEE_MOD_CCA_s {
   uint16_t commandNo;                  
   struct {
      uint8_t ccaEnEnergy:1;            
      uint8_t ccaEnCorr:1;              
      uint8_t ccaEnSync:1;              
      uint8_t ccaCorrOp:1;              
      uint8_t ccaSyncOp:1;              
      uint8_t ccaCorrThr:2;             
   } newCcaOpt;                         
   int8_t newCcaRssiThr;                
} __RFC_STRUCT_ATTR;


#define CMD_IEEE_MOD_FILT                                       0x2002
struct __RFC_STRUCT rfc_CMD_IEEE_MOD_FILT_s {
   uint16_t commandNo;                  
   struct {
      uint16_t frameFiltEn:1;           
      uint16_t frameFiltStop:1;         
      uint16_t autoAckEn:1;             
      uint16_t slottedAckEn:1;          
      uint16_t autoPendEn:1;            
      uint16_t defaultPend:1;           
      uint16_t bPendDataReqOnly:1;      
      uint16_t bPanCoord:1;             
      uint16_t maxFrameVersion:2;       
      uint16_t fcfReservedMask:3;       
      uint16_t modifyFtFilter:2;        
      uint16_t bStrictLenFilter:1;      
   } newFrameFiltOpt;                   
   struct {
      uint8_t bAcceptFt0Beacon:1;       
      uint8_t bAcceptFt1Data:1;         
      uint8_t bAcceptFt2Ack:1;          
      uint8_t bAcceptFt3MacCmd:1;       
      uint8_t bAcceptFt4Reserved:1;     
      uint8_t bAcceptFt5Reserved:1;     
      uint8_t bAcceptFt6Reserved:1;     
      uint8_t bAcceptFt7Reserved:1;     
   } newFrameTypes;                     
} __RFC_STRUCT_ATTR;


#define CMD_IEEE_MOD_SRC_MATCH                                  0x2003
struct __RFC_STRUCT rfc_CMD_IEEE_MOD_SRC_MATCH_s {
   uint16_t commandNo;                  
   struct {
      uint8_t bEnable:1;                
      uint8_t srcPend:1;                
      uint8_t entryType:1;              
   } options;
   uint8_t entryNo;                     
} __RFC_STRUCT_ATTR;


#define CMD_IEEE_ABORT_FG                                       0x2401
struct __RFC_STRUCT rfc_CMD_IEEE_ABORT_FG_s {
   uint16_t commandNo;                  
} __RFC_STRUCT_ATTR;


#define CMD_IEEE_STOP_FG                                        0x2402
struct __RFC_STRUCT rfc_CMD_IEEE_STOP_FG_s {
   uint16_t commandNo;                  
} __RFC_STRUCT_ATTR;


#define CMD_IEEE_CCA_REQ                                        0x2403
struct __RFC_STRUCT rfc_CMD_IEEE_CCA_REQ_s {
   uint16_t commandNo;                  
   int8_t currentRssi;                  
   int8_t maxRssi;                      
   struct {
      uint8_t ccaState:2;               
      uint8_t ccaEnergy:2;              
      uint8_t ccaCorr:2;                
      uint8_t ccaSync:1;                
   } ccaInfo;
} __RFC_STRUCT_ATTR;



struct __RFC_STRUCT rfc_ieeeRxOutput_s {
   uint8_t nTxAck;                      
   uint8_t nRxBeacon;                   
   uint8_t nRxData;                     
   uint8_t nRxAck;                      
   uint8_t nRxMacCmd;                   
   uint8_t nRxReserved;                 
   uint8_t nRxNok;                      
   uint8_t nRxIgnored;                  
   uint8_t nRxBufFull;                  
   int8_t lastRssi;                     
   int8_t maxRssi;                      
   uint8_t __dummy0;
   ratmr_t beaconTimeStamp;             
} __RFC_STRUCT_ATTR;



struct __RFC_STRUCT rfc_shortAddrEntry_s {
   uint16_t shortAddr;                  
   uint16_t panId;                      
} __RFC_STRUCT_ATTR;



struct __RFC_STRUCT rfc_ieeeRxCorrCrc_s {
   struct {
      uint8_t corr:6;                   
      uint8_t bIgnore:1;                
      uint8_t bCrcErr:1;                
   } status;
} __RFC_STRUCT_ATTR;


#endif