rf_prop_cmd.h

Go to the documentation of this file.

/******************************************************************************
*  Filename:       rf_prop_cmd.h
*  Revised:        2016-02-18 12:46:56 +0100 (Thu, 18 Feb 2016)
*  Revision:       45712
*
*  Description:    CC13xx API for Proprietary mode commands
*
*  Copyright (c) 2015, 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 __PROP_CMD_H
#define __PROP_CMD_H

#ifndef __RFC_STRUCT
#ifdef __GNUC__
#define __RFC_STRUCT __attribute__ ((aligned (4)))
#else
#define __RFC_STRUCT
#endif
#endif



#include <stdint.h>
#include <driverlib/rf_mailbox.h>
#include <driverlib/rf_common_cmd.h>

typedef struct __RFC_STRUCT rfc_carrierSense_s rfc_carrierSense_t;
typedef struct __RFC_STRUCT rfc_CMD_PROP_TX_s rfc_CMD_PROP_TX_t;
typedef struct __RFC_STRUCT rfc_CMD_PROP_RX_s rfc_CMD_PROP_RX_t;
typedef struct __RFC_STRUCT rfc_CMD_PROP_TX_ADV_s rfc_CMD_PROP_TX_ADV_t;
typedef struct __RFC_STRUCT rfc_CMD_PROP_RX_ADV_s rfc_CMD_PROP_RX_ADV_t;
typedef struct __RFC_STRUCT rfc_CMD_PROP_CS_s rfc_CMD_PROP_CS_t;
typedef struct __RFC_STRUCT rfc_CMD_PROP_RADIO_SETUP_s rfc_CMD_PROP_RADIO_SETUP_t;
typedef struct __RFC_STRUCT rfc_CMD_PROP_RADIO_DIV_SETUP_s rfc_CMD_PROP_RADIO_DIV_SETUP_t;
typedef struct __RFC_STRUCT rfc_CMD_PROP_RX_SNIFF_s rfc_CMD_PROP_RX_SNIFF_t;
typedef struct __RFC_STRUCT rfc_CMD_PROP_RX_ADV_SNIFF_s rfc_CMD_PROP_RX_ADV_SNIFF_t;
typedef struct __RFC_STRUCT rfc_CMD_PROP_SET_LEN_s rfc_CMD_PROP_SET_LEN_t;
typedef struct __RFC_STRUCT rfc_CMD_PROP_RESTART_RX_s rfc_CMD_PROP_RESTART_RX_t;
typedef struct __RFC_STRUCT rfc_propRxOutput_s rfc_propRxOutput_t;
typedef struct __RFC_STRUCT rfc_propRxStatus_s rfc_propRxStatus_t;

struct __RFC_STRUCT rfc_carrierSense_s {
   struct {
      uint8_t bEnaRssi:1;               
      uint8_t bEnaCorr:1;               
      uint8_t operation:1;              
      uint8_t busyOp:1;                 
      uint8_t idleOp:1;                 
      uint8_t timeoutRes:1;             
   } csConf;
   int8_t rssiThr;                      
   uint8_t numRssiIdle;                 
   uint8_t numRssiBusy;                 
   uint16_t corrPeriod;                 
   struct {
      uint8_t numCorrInv:4;             
      uint8_t numCorrBusy:4;            
   } corrConfig;
   struct {
      uint8_t triggerType:4;            
      uint8_t bEnaCmd:1;                
      uint8_t triggerNo:2;              
      uint8_t pastTrig:1;               
   } csEndTrigger;                      
   ratmr_t csEndTime;                   
};


#define CMD_PROP_TX                                             0x3801
struct __RFC_STRUCT rfc_CMD_PROP_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 bFsOff:1;                 
      uint8_t :2;
      uint8_t bUseCrc:1;                
      uint8_t bVarLen:1;                
   } pktConf;
   uint8_t pktLen;                      
   uint32_t syncWord;                   
   uint8_t* pPkt;                       
};


#define CMD_PROP_RX                                             0x3802
struct __RFC_STRUCT rfc_CMD_PROP_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;
   struct {
      uint8_t bFsOff:1;                 
      uint8_t bRepeatOk:1;              
      uint8_t bRepeatNok:1;             
      uint8_t bUseCrc:1;                
      uint8_t bVarLen:1;                
      uint8_t bChkAddress:1;            
      uint8_t endType:1;                
      uint8_t filterOp:1;               
   } pktConf;
   struct {
      uint8_t bAutoFlushIgnored:1;      
      uint8_t bAutoFlushCrcErr:1;       
      uint8_t :1;
      uint8_t bIncludeHdr:1;            
      uint8_t bIncludeCrc:1;            
      uint8_t bAppendRssi:1;            
      uint8_t bAppendTimestamp:1;       
      uint8_t bAppendStatus:1;          
   } rxConf;                            
   uint32_t syncWord;                   
   uint8_t maxPktLen;                   
   uint8_t address0;                    
   uint8_t address1;                    
   struct {
      uint8_t triggerType:4;            
      uint8_t bEnaCmd:1;                
      uint8_t triggerNo:2;              
      uint8_t pastTrig:1;               
   } endTrigger;                        
   ratmr_t endTime;                     
   dataQueue_t* pQueue;                 
   uint8_t* pOutput;                    
};


#define CMD_PROP_TX_ADV                                         0x3803
struct __RFC_STRUCT rfc_CMD_PROP_TX_ADV_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 bFsOff:1;                 
      uint8_t :2;
      uint8_t bUseCrc:1;                
      uint8_t bCrcIncSw:1;              
      uint8_t bCrcIncHdr:1;             
   } pktConf;
   uint8_t numHdrBits;                  
   uint16_t pktLen;                     
   struct {
      uint8_t bExtTxTrig:1;             
      uint8_t inputMode:2;              
      uint8_t source:5;                 
   } startConf;
   struct {
      uint8_t triggerType:4;            
      uint8_t bEnaCmd:1;                
      uint8_t triggerNo:2;              
      uint8_t pastTrig:1;               
   } preTrigger;                        
   ratmr_t preTime;                     
   uint32_t syncWord;                   
   uint8_t* pPkt;                       
};


#define CMD_PROP_RX_ADV                                         0x3804
struct __RFC_STRUCT rfc_CMD_PROP_RX_ADV_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 bFsOff:1;                 
      uint8_t bRepeatOk:1;              
      uint8_t bRepeatNok:1;             
      uint8_t bUseCrc:1;                
      uint8_t bCrcIncSw:1;              
      uint8_t bCrcIncHdr:1;             
      uint8_t endType:1;                
      uint8_t filterOp:1;               
   } pktConf;
   struct {
      uint8_t bAutoFlushIgnored:1;      
      uint8_t bAutoFlushCrcErr:1;       
      uint8_t :1;
      uint8_t bIncludeHdr:1;            
      uint8_t bIncludeCrc:1;            
      uint8_t bAppendRssi:1;            
      uint8_t bAppendTimestamp:1;       
      uint8_t bAppendStatus:1;          
   } rxConf;                            
   uint32_t syncWord0;                  
   uint32_t syncWord1;                  
   uint16_t maxPktLen;                  
   struct {
      uint16_t numHdrBits:6;            
      uint16_t lenPos:5;                
      uint16_t numLenBits:5;            
   } hdrConf;
   struct {
      uint16_t addrType:1;              
      uint16_t addrSize:5;              
      uint16_t addrPos:5;               
      uint16_t numAddr:5;               
   } addrConf;
   int8_t lenOffset;                    
   struct {
      uint8_t triggerType:4;            
      uint8_t bEnaCmd:1;                
      uint8_t triggerNo:2;              
      uint8_t pastTrig:1;               
   } endTrigger;                        
   ratmr_t endTime;                     
   uint8_t* pAddr;                      
   dataQueue_t* pQueue;                 
   uint8_t* pOutput;                    
};


#define CMD_PROP_CS                                             0x3805
struct __RFC_STRUCT rfc_CMD_PROP_CS_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 bFsOffIdle:1;             
      uint8_t bFsOffBusy:1;             
   } csFsConf;
   uint8_t __dummy0;
   struct {
      uint8_t bEnaRssi:1;               
      uint8_t bEnaCorr:1;               
      uint8_t operation:1;              
      uint8_t busyOp:1;                 
      uint8_t idleOp:1;                 
      uint8_t timeoutRes:1;             
   } csConf;
   int8_t rssiThr;                      
   uint8_t numRssiIdle;                 
   uint8_t numRssiBusy;                 
   uint16_t corrPeriod;                 
   struct {
      uint8_t numCorrInv:4;             
      uint8_t numCorrBusy:4;            
   } corrConfig;
   struct {
      uint8_t triggerType:4;            
      uint8_t bEnaCmd:1;                
      uint8_t triggerNo:2;              
      uint8_t pastTrig:1;               
   } csEndTrigger;                      
   ratmr_t csEndTime;                   
};


#define CMD_PROP_RADIO_SETUP                                    0x3806
struct __RFC_STRUCT rfc_CMD_PROP_RADIO_SETUP_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 {
      uint16_t modType:3;               
      uint16_t deviation:13;            
   } modulation;
   struct {
      uint32_t preScale:4;              
      uint32_t :4;
      uint32_t rateWord:21;             
   } symbolRate;
   uint8_t rxBw;                        
   struct {
      uint8_t nPreamBytes:6;            
      uint8_t preamMode:2;              
   } preamConf;
   struct {
      uint16_t nSwBits:6;               
      uint16_t bBitReversal:1;          
      uint16_t bMsbFirst:1;             
      uint16_t fecMode:4;               
      uint16_t :1;
      uint16_t whitenMode:3;            
   } formatConf;
   struct {
      uint16_t frontEndMode:3;          
      uint16_t biasMode:1;              
      uint16_t :6;
      uint16_t bNoFsPowerUp:1;          
   } config;                            
   uint16_t txPower;                    
   uint32_t* pRegOverride;              
};


#define CMD_PROP_RADIO_DIV_SETUP                                0x3807
struct __RFC_STRUCT rfc_CMD_PROP_RADIO_DIV_SETUP_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 {
      uint16_t modType:3;               
      uint16_t deviation:13;            
   } modulation;
   struct {
      uint32_t preScale:4;              
      uint32_t :4;
      uint32_t rateWord:21;             
   } symbolRate;
   uint8_t rxBw;                        
   struct {
      uint8_t nPreamBytes:6;            
      uint8_t preamMode:2;              
   } preamConf;
   struct {
      uint16_t nSwBits:6;               
      uint16_t bBitReversal:1;          
      uint16_t bMsbFirst:1;             
      uint16_t fecMode:4;               
      uint16_t :1;
      uint16_t whitenMode:3;            
   } formatConf;
   struct {
      uint16_t frontEndMode:3;          
      uint16_t biasMode:1;              
      uint16_t :6;
      uint16_t bNoFsPowerUp:1;          
   } config;                            
   uint16_t txPower;                    
   uint32_t* pRegOverride;              
   uint16_t centerFreq;                 
   int16_t intFreq;                     
   uint8_t loDivider;                   
};


#define CMD_PROP_RX_SNIFF                                       0x3808
struct __RFC_STRUCT rfc_CMD_PROP_RX_SNIFF_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 bFsOff:1;                 
      uint8_t bRepeatOk:1;              
      uint8_t bRepeatNok:1;             
      uint8_t bUseCrc:1;                
      uint8_t bVarLen:1;                
      uint8_t bChkAddress:1;            
      uint8_t endType:1;                
      uint8_t filterOp:1;               
   } pktConf;
   struct {
      uint8_t bAutoFlushIgnored:1;      
      uint8_t bAutoFlushCrcErr:1;       
      uint8_t :1;
      uint8_t bIncludeHdr:1;            
      uint8_t bIncludeCrc:1;            
      uint8_t bAppendRssi:1;            
      uint8_t bAppendTimestamp:1;       
      uint8_t bAppendStatus:1;          
   } rxConf;                            
   uint32_t syncWord;                   
   uint8_t maxPktLen;                   
   uint8_t address0;                    
   uint8_t address1;                    
   struct {
      uint8_t triggerType:4;            
      uint8_t bEnaCmd:1;                
      uint8_t triggerNo:2;              
      uint8_t pastTrig:1;               
   } endTrigger;                        
   ratmr_t endTime;                     
   dataQueue_t* pQueue;                 
   uint8_t* pOutput;                    
   struct {
      uint8_t bEnaRssi:1;               
      uint8_t bEnaCorr:1;               
      uint8_t operation:1;              
      uint8_t busyOp:1;                 
      uint8_t idleOp:1;                 
      uint8_t timeoutRes:1;             
   } csConf;
   int8_t rssiThr;                      
   uint8_t numRssiIdle;                 
   uint8_t numRssiBusy;                 
   uint16_t corrPeriod;                 
   struct {
      uint8_t numCorrInv:4;             
      uint8_t numCorrBusy:4;            
   } corrConfig;
   struct {
      uint8_t triggerType:4;            
      uint8_t bEnaCmd:1;                
      uint8_t triggerNo:2;              
      uint8_t pastTrig:1;               
   } csEndTrigger;                      
   ratmr_t csEndTime;                   
};


#define CMD_PROP_RX_ADV_SNIFF                                   0x3809
struct __RFC_STRUCT rfc_CMD_PROP_RX_ADV_SNIFF_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 bFsOff:1;                 
      uint8_t bRepeatOk:1;              
      uint8_t bRepeatNok:1;             
      uint8_t bUseCrc:1;                
      uint8_t bCrcIncSw:1;              
      uint8_t bCrcIncHdr:1;             
      uint8_t endType:1;                
      uint8_t filterOp:1;               
   } pktConf;
   struct {
      uint8_t bAutoFlushIgnored:1;      
      uint8_t bAutoFlushCrcErr:1;       
      uint8_t :1;
      uint8_t bIncludeHdr:1;            
      uint8_t bIncludeCrc:1;            
      uint8_t bAppendRssi:1;            
      uint8_t bAppendTimestamp:1;       
      uint8_t bAppendStatus:1;          
   } rxConf;                            
   uint32_t syncWord0;                  
   uint32_t syncWord1;                  
   uint16_t maxPktLen;                  
   struct {
      uint16_t numHdrBits:6;            
      uint16_t lenPos:5;                
      uint16_t numLenBits:5;            
   } hdrConf;
   struct {
      uint16_t addrType:1;              
      uint16_t addrSize:5;              
      uint16_t addrPos:5;               
      uint16_t numAddr:5;               
   } addrConf;
   int8_t lenOffset;                    
   struct {
      uint8_t triggerType:4;            
      uint8_t bEnaCmd:1;                
      uint8_t triggerNo:2;              
      uint8_t pastTrig:1;               
   } endTrigger;                        
   ratmr_t endTime;                     
   uint8_t* pAddr;                      
   dataQueue_t* pQueue;                 
   uint8_t* pOutput;                    
   struct {
      uint8_t bEnaRssi:1;               
      uint8_t bEnaCorr:1;               
      uint8_t operation:1;              
      uint8_t busyOp:1;                 
      uint8_t idleOp:1;                 
      uint8_t timeoutRes:1;             
   } csConf;
   int8_t rssiThr;                      
   uint8_t numRssiIdle;                 
   uint8_t numRssiBusy;                 
   uint16_t corrPeriod;                 
   struct {
      uint8_t numCorrInv:4;             
      uint8_t numCorrBusy:4;            
   } corrConfig;
   struct {
      uint8_t triggerType:4;            
      uint8_t bEnaCmd:1;                
      uint8_t triggerNo:2;              
      uint8_t pastTrig:1;               
   } csEndTrigger;                      
   ratmr_t csEndTime;                   
};


#define CMD_PROP_SET_LEN                                        0x3401
struct __RFC_STRUCT rfc_CMD_PROP_SET_LEN_s {
   uint16_t commandNo;                  
   uint16_t rxLen;                      
};


#define CMD_PROP_RESTART_RX                                     0x3402
struct __RFC_STRUCT rfc_CMD_PROP_RESTART_RX_s {
   uint16_t commandNo;                  
};



struct __RFC_STRUCT rfc_propRxOutput_s {
   uint16_t nRxOk;                      
   uint16_t nRxNok;                     
   uint8_t nRxIgnored;                  
   uint8_t nRxStopped;                  
   uint8_t nRxBufFull;                  
   int8_t lastRssi;                     
   ratmr_t timeStamp;                   
};



struct __RFC_STRUCT rfc_propRxStatus_s {
   struct {
      uint8_t addressInd:5;             
      uint8_t syncWordId:1;             
      uint8_t result:2;                 
   } status;
};


#endif