rf_common_cmd.h

Go to the documentation of this file.

/******************************************************************************
*  Filename:       rf_common_cmd.h
*  Revised:        $ $
*  Revision:       $ $
*
*  Description:    CC13xx API for common/generic commands
*
*  Copyright (c) 2015 - 2016, 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 __COMMON_CMD_H
#define __COMMON_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>

typedef struct __RFC_STRUCT rfc_command_s rfc_command_t;
typedef struct __RFC_STRUCT rfc_radioOp_s rfc_radioOp_t;
typedef struct __RFC_STRUCT rfc_CMD_NOP_s rfc_CMD_NOP_t;
typedef struct __RFC_STRUCT rfc_CMD_RADIO_SETUP_s rfc_CMD_RADIO_SETUP_t;
typedef struct __RFC_STRUCT rfc_CMD_FS_s rfc_CMD_FS_t;
typedef struct __RFC_STRUCT rfc_CMD_FS_OFF_s rfc_CMD_FS_OFF_t;
typedef struct __RFC_STRUCT rfc_CMD_RX_TEST_s rfc_CMD_RX_TEST_t;
typedef struct __RFC_STRUCT rfc_CMD_TX_TEST_s rfc_CMD_TX_TEST_t;
typedef struct __RFC_STRUCT rfc_CMD_SYNC_STOP_RAT_s rfc_CMD_SYNC_STOP_RAT_t;
typedef struct __RFC_STRUCT rfc_CMD_SYNC_START_RAT_s rfc_CMD_SYNC_START_RAT_t;
typedef struct __RFC_STRUCT rfc_CMD_COUNT_s rfc_CMD_COUNT_t;
typedef struct __RFC_STRUCT rfc_CMD_FS_POWERUP_s rfc_CMD_FS_POWERUP_t;
typedef struct __RFC_STRUCT rfc_CMD_FS_POWERDOWN_s rfc_CMD_FS_POWERDOWN_t;
typedef struct __RFC_STRUCT rfc_CMD_SCH_IMM_s rfc_CMD_SCH_IMM_t;
typedef struct __RFC_STRUCT rfc_CMD_COUNT_BRANCH_s rfc_CMD_COUNT_BRANCH_t;
typedef struct __RFC_STRUCT rfc_CMD_PATTERN_CHECK_s rfc_CMD_PATTERN_CHECK_t;
typedef struct __RFC_STRUCT rfc_CMD_ABORT_s rfc_CMD_ABORT_t;
typedef struct __RFC_STRUCT rfc_CMD_STOP_s rfc_CMD_STOP_t;
typedef struct __RFC_STRUCT rfc_CMD_GET_RSSI_s rfc_CMD_GET_RSSI_t;
typedef struct __RFC_STRUCT rfc_CMD_UPDATE_RADIO_SETUP_s rfc_CMD_UPDATE_RADIO_SETUP_t;
typedef struct __RFC_STRUCT rfc_CMD_TRIGGER_s rfc_CMD_TRIGGER_t;
typedef struct __RFC_STRUCT rfc_CMD_GET_FW_INFO_s rfc_CMD_GET_FW_INFO_t;
typedef struct __RFC_STRUCT rfc_CMD_START_RAT_s rfc_CMD_START_RAT_t;
typedef struct __RFC_STRUCT rfc_CMD_PING_s rfc_CMD_PING_t;
typedef struct __RFC_STRUCT rfc_CMD_READ_RFREG_s rfc_CMD_READ_RFREG_t;
typedef struct __RFC_STRUCT rfc_CMD_ADD_DATA_ENTRY_s rfc_CMD_ADD_DATA_ENTRY_t;
typedef struct __RFC_STRUCT rfc_CMD_REMOVE_DATA_ENTRY_s rfc_CMD_REMOVE_DATA_ENTRY_t;
typedef struct __RFC_STRUCT rfc_CMD_FLUSH_QUEUE_s rfc_CMD_FLUSH_QUEUE_t;
typedef struct __RFC_STRUCT rfc_CMD_CLEAR_RX_s rfc_CMD_CLEAR_RX_t;
typedef struct __RFC_STRUCT rfc_CMD_REMOVE_PENDING_ENTRIES_s rfc_CMD_REMOVE_PENDING_ENTRIES_t;
typedef struct __RFC_STRUCT rfc_CMD_SET_RAT_CMP_s rfc_CMD_SET_RAT_CMP_t;
typedef struct __RFC_STRUCT rfc_CMD_SET_RAT_CPT_s rfc_CMD_SET_RAT_CPT_t;
typedef struct __RFC_STRUCT rfc_CMD_DISABLE_RAT_CH_s rfc_CMD_DISABLE_RAT_CH_t;
typedef struct __RFC_STRUCT rfc_CMD_SET_RAT_OUTPUT_s rfc_CMD_SET_RAT_OUTPUT_t;
typedef struct __RFC_STRUCT rfc_CMD_ARM_RAT_CH_s rfc_CMD_ARM_RAT_CH_t;
typedef struct __RFC_STRUCT rfc_CMD_DISARM_RAT_CH_s rfc_CMD_DISARM_RAT_CH_t;
typedef struct __RFC_STRUCT rfc_CMD_SET_TX_POWER_s rfc_CMD_SET_TX_POWER_t;
typedef struct __RFC_STRUCT rfc_CMD_UPDATE_FS_s rfc_CMD_UPDATE_FS_t;
typedef struct __RFC_STRUCT rfc_CMD_BUS_REQUEST_s rfc_CMD_BUS_REQUEST_t;

struct __RFC_STRUCT rfc_command_s {
   uint16_t commandNo;                  
};



struct __RFC_STRUCT rfc_radioOp_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;
};


#define CMD_NOP                                                 0x0801
struct __RFC_STRUCT rfc_CMD_NOP_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;
};


#define CMD_RADIO_SETUP                                         0x0802
struct __RFC_STRUCT rfc_CMD_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;
   uint8_t mode;                        
   uint8_t loDivider;                   
   struct {
      uint16_t frontEndMode:3;          
      uint16_t biasMode:1;              
      uint16_t analogCfgMode:6;         
      uint16_t bNoFsPowerUp:1;          
   } config;                            
   uint16_t txPower;                    
   uint32_t* pRegOverride;              
};


#define CMD_FS                                                  0x0803
struct __RFC_STRUCT rfc_CMD_FS_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 frequency;                  
   uint16_t fractFreq;                  
   struct {
      uint8_t bTxMode:1;                
      uint8_t refFreq:6;                
   } synthConf;
   uint8_t __dummy0;                    
   uint8_t __dummy1;                    
   uint8_t __dummy2;                    
   uint16_t __dummy3;                   
};


#define CMD_FS_OFF                                              0x0804
struct __RFC_STRUCT rfc_CMD_FS_OFF_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;
};


#define CMD_RX_TEST                                             0x0807
struct __RFC_STRUCT rfc_CMD_RX_TEST_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 bEnaFifo:1;               
      uint8_t bFsOff:1;                 
      uint8_t bNoSync:1;                
   } config;
   struct {
      uint8_t triggerType:4;            
      uint8_t bEnaCmd:1;                
      uint8_t triggerNo:2;              
      uint8_t pastTrig:1;               
   } endTrigger;                        
   uint32_t syncWord;                   
   ratmr_t endTime;                     
};


#define CMD_TX_TEST                                             0x0808
struct __RFC_STRUCT rfc_CMD_TX_TEST_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 bUseCw:1;                 
      uint8_t bFsOff:1;                 
      uint8_t whitenMode:2;             
   } config;
   uint8_t __dummy0;
   uint16_t txWord;                     
   uint8_t __dummy1;
   struct {
      uint8_t triggerType:4;            
      uint8_t bEnaCmd:1;                
      uint8_t triggerNo:2;              
      uint8_t pastTrig:1;               
   } endTrigger;                        
   uint32_t syncWord;                   
   ratmr_t endTime;                     
};


#define CMD_SYNC_STOP_RAT                                       0x0809
struct __RFC_STRUCT rfc_CMD_SYNC_STOP_RAT_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 __dummy0;
   ratmr_t rat0;                        
};


#define CMD_SYNC_START_RAT                                      0x080A
struct __RFC_STRUCT rfc_CMD_SYNC_START_RAT_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 __dummy0;
   ratmr_t rat0;                        
};


#define CMD_COUNT                                               0x080B
struct __RFC_STRUCT rfc_CMD_COUNT_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 counter;                    
};


#define CMD_FS_POWERUP                                          0x080C
struct __RFC_STRUCT rfc_CMD_FS_POWERUP_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 __dummy0;
   uint32_t* pRegOverride;              
};


#define CMD_FS_POWERDOWN                                        0x080D
struct __RFC_STRUCT rfc_CMD_FS_POWERDOWN_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;
};


#define CMD_SCH_IMM                                             0x0810
struct __RFC_STRUCT rfc_CMD_SCH_IMM_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 __dummy0;
   uint32_t cmdrVal;                    
   uint32_t cmdstaVal;                  
};


#define CMD_COUNT_BRANCH                                        0x0812
struct __RFC_STRUCT rfc_CMD_COUNT_BRANCH_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 counter;                    
   rfc_radioOp_t *pNextOpIfOk;          
};


#define CMD_PATTERN_CHECK                                       0x0813
struct __RFC_STRUCT rfc_CMD_PATTERN_CHECK_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 operation:2;             
      uint16_t bByteRev:1;              
      uint16_t bBitRev:1;               
      uint16_t signExtend:5;            
      uint16_t bRxVal:1;                
   } patternOpt;                        
   rfc_radioOp_t *pNextOpIfOk;          
   uint8_t* pValue;                     
   uint32_t mask;                       
   uint32_t compareVal;                 
};


#define CMD_ABORT                                               0x0401
struct __RFC_STRUCT rfc_CMD_ABORT_s {
   uint16_t commandNo;                  
};


#define CMD_STOP                                                0x0402
struct __RFC_STRUCT rfc_CMD_STOP_s {
   uint16_t commandNo;                  
};


#define CMD_GET_RSSI                                            0x0403
struct __RFC_STRUCT rfc_CMD_GET_RSSI_s {
   uint16_t commandNo;                  
};


#define CMD_UPDATE_RADIO_SETUP                                  0x0001
struct __RFC_STRUCT rfc_CMD_UPDATE_RADIO_SETUP_s {
   uint16_t commandNo;                  
   uint16_t __dummy0;
   uint32_t* pRegOverride;              
};


#define CMD_TRIGGER                                             0x0404
struct __RFC_STRUCT rfc_CMD_TRIGGER_s {
   uint16_t commandNo;                  
   uint8_t triggerNo;                   
};


#define CMD_GET_FW_INFO                                         0x0002
struct __RFC_STRUCT rfc_CMD_GET_FW_INFO_s {
   uint16_t commandNo;                  
   uint16_t versionNo;                  
   uint16_t startOffset;                
   uint16_t freeRamSz;                  
   uint16_t availRatCh;                 
};


#define CMD_START_RAT                                           0x0405
struct __RFC_STRUCT rfc_CMD_START_RAT_s {
   uint16_t commandNo;                  
};


#define CMD_PING                                                0x0406
struct __RFC_STRUCT rfc_CMD_PING_s {
   uint16_t commandNo;                  
};


#define CMD_READ_RFREG                                          0x0601
struct __RFC_STRUCT rfc_CMD_READ_RFREG_s {
   uint16_t commandNo;                  
   uint16_t address;                    
   uint32_t value;                      
};


#define CMD_ADD_DATA_ENTRY                                      0x0005
struct __RFC_STRUCT rfc_CMD_ADD_DATA_ENTRY_s {
   uint16_t commandNo;                  
   uint16_t __dummy0;
   dataQueue_t* pQueue;                 
   uint8_t* pEntry;                     
};


#define CMD_REMOVE_DATA_ENTRY                                   0x0006
struct __RFC_STRUCT rfc_CMD_REMOVE_DATA_ENTRY_s {
   uint16_t commandNo;                  
   uint16_t __dummy0;
   dataQueue_t* pQueue;                 
   uint8_t* pEntry;                     
};


#define CMD_FLUSH_QUEUE                                         0x0007
struct __RFC_STRUCT rfc_CMD_FLUSH_QUEUE_s {
   uint16_t commandNo;                  
   uint16_t __dummy0;
   dataQueue_t* pQueue;                 
   uint8_t* pFirstEntry;                
};


#define CMD_CLEAR_RX                                            0x0008
struct __RFC_STRUCT rfc_CMD_CLEAR_RX_s {
   uint16_t commandNo;                  
   uint16_t __dummy0;
   dataQueue_t* pQueue;                 
};


#define CMD_REMOVE_PENDING_ENTRIES                              0x0009
struct __RFC_STRUCT rfc_CMD_REMOVE_PENDING_ENTRIES_s {
   uint16_t commandNo;                  
   uint16_t __dummy0;
   dataQueue_t* pQueue;                 
   uint8_t* pFirstEntry;                
};


#define CMD_SET_RAT_CMP                                         0x000A
struct __RFC_STRUCT rfc_CMD_SET_RAT_CMP_s {
   uint16_t commandNo;                  
   uint8_t ratCh;                       
   uint8_t __dummy0;
   ratmr_t compareTime;                 
};


#define CMD_SET_RAT_CPT                                         0x0603
struct __RFC_STRUCT rfc_CMD_SET_RAT_CPT_s {
   uint16_t commandNo;                  
   struct {
      uint16_t :3;
      uint16_t inputSrc:5;              
      uint16_t ratCh:4;                 
      uint16_t bRepeated:1;             
      uint16_t inputMode:2;             
   } config;
};


#define CMD_DISABLE_RAT_CH                                      0x0408
struct __RFC_STRUCT rfc_CMD_DISABLE_RAT_CH_s {
   uint16_t commandNo;                  
   uint8_t ratCh;                       
};


#define CMD_SET_RAT_OUTPUT                                      0x0604
struct __RFC_STRUCT rfc_CMD_SET_RAT_OUTPUT_s {
   uint16_t commandNo;                  
   struct {
      uint16_t :2;
      uint16_t outputSel:3;             
      uint16_t outputMode:3;            
      uint16_t ratCh:4;                 
   } config;
};


#define CMD_ARM_RAT_CH                                          0x0409
struct __RFC_STRUCT rfc_CMD_ARM_RAT_CH_s {
   uint16_t commandNo;                  
   uint8_t ratCh;                       
};


#define CMD_DISARM_RAT_CH                                       0x040A
struct __RFC_STRUCT rfc_CMD_DISARM_RAT_CH_s {
   uint16_t commandNo;                  
   uint8_t ratCh;                       
};


#define CMD_SET_TX_POWER                                        0x0010
struct __RFC_STRUCT rfc_CMD_SET_TX_POWER_s {
   uint16_t commandNo;                  
   uint16_t txPower;                    
};


#define CMD_UPDATE_FS                                           0x0011
struct __RFC_STRUCT rfc_CMD_UPDATE_FS_s {
   uint16_t commandNo;                  
   uint16_t __dummy0;
   uint32_t __dummy1;
   uint32_t __dummy2;
   uint16_t __dummy3;
   uint16_t frequency;                  
   uint16_t fractFreq;                  
};


#define CMD_BUS_REQUEST                                         0x040E
struct __RFC_STRUCT rfc_CMD_BUS_REQUEST_s {
   uint16_t commandNo;                  
   uint8_t bSysBusNeeded;               
};


#endif