ble_cs.h

Go to the documentation of this file.

/*
 * Copyright (c) 2022-2023, 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:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  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.
 *
 * *  Neither the name of Texas Instruments Incorporated 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 OWNER 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 ti_drivers_RCL_commands_ble_cs_h__include
#define ti_drivers_RCL_commands_ble_cs_h__include
 
#include <ti/drivers/rcl/RCL_Command.h>
#include <ti/drivers/rcl/RCL_Buffer.h>
#include <ti/drivers/rcl/handlers/ble_cs.h>
 
#include <ti/drivers/utils/List.h>
 
/* Forward declaration of types */
typedef struct RCL_CMD_BLE_CS_t                 RCL_CmdBleCs;
typedef struct RCL_CMD_BLE_CS_STEP_t            RCL_CmdBleCs_Step;
typedef struct RCL_CMD_BLE_CS_STEP_RESULT_t     RCL_CmdBleCs_StepResult;
typedef struct RCL_CMD_BLE_CS_S2R_t             RCL_CmdBleCs_S2r;
typedef struct RCL_CMD_BLE_CS_OUTPUT_t          RCL_CmdBleCs_Output;
 
typedef enum   RCL_CMD_BLE_CS_Phy_e             RCL_CmdBleCs_Phy;
typedef enum   RCL_CMD_BLE_CS_Role_e            RCL_CmdBleCs_Role;
typedef enum   RCL_CMD_BLE_CS_StepMode_e        RCL_CmdBleCs_StepMode;
typedef enum   RCL_CMD_BLE_CS_PacketResult_e    RCL_CmdBleCs_PacketResult;
typedef enum   RCL_CMD_BLE_CS_Tfcs_e            RCL_CmdBleCs_Tfcs;
typedef enum   RCL_CMD_BLE_CS_Tpm_e             RCL_CmdBleCs_Tpm;
typedef enum   RCL_CMD_BLE_CS_Tip_e             RCL_CmdBleCs_Tip;
typedef enum   RCL_CMD_BLE_CS_Tsw_e             RCL_CmdBleCs_Tsw;
typedef enum   RCL_CMD_BLE_CS_AntennaConfig_e   RCL_CmdBleCs_AntennaConfig;
typedef enum   RCL_CMD_BLE_CS_Payload_e         RCL_CmdBleCs_Payload;
 
/* Command IDs for generic commands */
#define RCL_CMDID_BLE_CS               0x1001U
 
/* Helper macros to convert between time units */
#define RCL_BLE_CS_US_TO_MCE_TIMER(x)        ((x)*48)
#define RCL_BLE_CS_US_TO_PBE_TIMER(x)        ((x)*4)
#define RCL_BLE_CS_MCE_TIMER_TO_US(x)        ((x)/48)
#define RCL_BLE_CS_PBE_TIMER_TO_US(x)        ((x)/4)
#define RCL_BLE_CS_MCE_TIMER_TO_PBE_TIMER(x) ((x)/12)
 
/* Helper macros for constants */
#define RCL_BLE_CS_MAX_NUM_ANT        4
#define RCL_BLE_CS_MAX_NUM_ANT_PATH   5
#define RCL_BLE_CS_MAX_PAYLOAD_SIZE   4
#define RCL_BLE_CS_NUM_CORR           3
#define RCL_BLE_CS_NUM_STIM           2
#define RCL_BLE_CS_LEN_S2R            512
 
struct RCL_CMD_BLE_CS_t {
    RCL_Command common;
    struct {
      uint16_t role:1;                         
      uint16_t phy:1;                          
      uint16_t repeatSteps:1;                  
      uint16_t chFilterEnable:1;               
      uint16_t nS2R:4;                         
      uint16_t nSteps:8;                       
    } mode;
 
    struct {
      uint8_t select;                          
      uint8_t gpoMask;                         
      uint8_t gpoVal[RCL_BLE_CS_MAX_NUM_ANT];  
    } antennaConfig;
 
    struct {
      uint16_t tFcs;                           
      uint16_t tFm;                            
      uint16_t tPm;                            
      uint16_t tIp1;                           
      uint16_t tIp2;                           
      uint16_t reserved;
      uint16_t tSw;                            
      uint16_t tSwAdjustA;                     
      uint16_t tSwAdjustB;                     
    } timing;
 
    struct {
      uint8_t txPower;                         
      uint8_t rxGain;                          
      uint8_t foffOverride;                    
      uint8_t foffOverrideEnable:1;            
      uint8_t reserved:7;
    } frontend;
 
    uint16_t reserved1;
 
    RCL_CmdBleCs_Step       *steps;            
    RCL_CmdBleCs_StepResult *results;          
    RCL_CmdBleCs_S2r        *s2rResults;       
    RCL_CmdBleCs_Output     *output;           
};
 
/* Default configuration of command */
#define RCL_CmdBleCs_Default()                          \
{                                                       \
    .common = RCL_Command_Default(RCL_CMDID_BLE_CS,     \
                                  RCL_Handler_BLE_CS),  \
}
#define RCL_CmdBleCs_DefaultRuntime() (RCL_CmdBleCs) RCL_CmdBleCs_Default()
 
struct RCL_CMD_BLE_CS_STEP_t {
    uint16_t channelIdx;                             
    uint16_t mode;                                   
    struct {
        uint16_t toneExtension : 2;                  
        uint16_t reserved : 13;
        uint16_t infiniteRx : 1;                     
    } options;
    uint16_t foffErr;                                
    uint16_t tAdjustA;                               
    uint16_t tAdjustB;                               
    uint16_t reserved0;
    uint16_t payloadLen;                             
    uint32_t payloadTx[RCL_BLE_CS_MAX_PAYLOAD_SIZE]; 
    uint32_t payloadRx[RCL_BLE_CS_MAX_PAYLOAD_SIZE]; 
    uint32_t aaTx;                                   
    uint32_t aaRx;                                   
    uint16_t antennaPermIdx;                         
    uint16_t antennaSequence;                        
    uint16_t tStep;                                  
    uint16_t tAntenna;                               
};
 
typedef struct {
    int16_t q;   
    int16_t i;   
} IQSample;
 
typedef struct {
    int16_t magnMin;     
    int16_t magnMax;     
    int16_t magnAvg;     
    int16_t magnAvgdB;   
} MagnData;
 
struct RCL_CMD_BLE_CS_STEP_RESULT_t {
    uint16_t pktResult;                            
    int16_t  foffMeasured;                         
    uint16_t rtt;                                  
    uint16_t corr[RCL_BLE_CS_NUM_CORR];            
    uint16_t stim[RCL_BLE_CS_NUM_STIM];            
    IQSample dc;                                   
    IQSample pct[RCL_BLE_CS_MAX_NUM_ANT_PATH];     
    uint32_t payload[RCL_BLE_CS_MAX_PAYLOAD_SIZE]; 
    MagnData magn[RCL_BLE_CS_MAX_NUM_ANT_PATH];    
};
 
typedef union {
    uint32_t word;                 
    uint8_t  byte[4];              
    IQSample iq;                   
} S2RSample;
 
struct RCL_CMD_BLE_CS_S2R_t {
  uint16_t  idx;                       
  uint16_t  length;                    
  S2RSample data[RCL_BLE_CS_LEN_S2R];  
};
 
struct RCL_CMD_BLE_CS_OUTPUT_t {
  uint16_t nStepsWritten;      
  uint16_t nResultsRead;       
  uint16_t nStepsDone;         
  uint16_t nRxOk;              
  uint16_t nRxNok;             
  uint8_t  nS2RDone;           
  int8_t   lastRssi;           
  int16_t  lastFoff;           
};
 
enum RCL_CMD_BLE_CS_Phy_e {
    RCL_CmdBleCs_Phy_1M,
    RCL_CmdBleCs_Phy_2M,
    RCL_CmdBleCs_Phy_Length
};
 
enum RCL_CMD_BLE_CS_Role_e {
    RCL_CmdBleCs_Role_Initiator,
    RCL_CmdBleCs_Role_Reflector,
    RCL_CmdBleCs_Role_Length
};
 
enum RCL_CMD_BLE_CS_StepMode_e {
    RCL_CmdBleCs_StepMode_0,       
    RCL_CmdBleCs_StepMode_1,       
    RCL_CmdBleCs_StepMode_2,       
    RCL_CmdBleCs_StepMode_3,       
    RCL_CmdBleCs_StepMode_Length
};
 
enum RCL_CMD_BLE_CS_PacketResult_e {
    RCL_CmdBleCs_PacketResult_Error,    
    RCL_CmdBleCs_PacketResult_Ok,       
    RCL_CmdBleCs_PacketResult_BitError, 
    RCL_CmdBleCs_PacketResult_Lost,     
    RCL_CmdBleCs_PacketResult_Length
};
 
enum RCL_CMD_BLE_CS_Tfcs_e {
    RCL_CmdBleCs_Tfcs_80us,     
    RCL_CmdBleCs_Tfcs_100us,
    RCL_CmdBleCs_Tfcs_120us,
    RCL_CmdBleCs_Tfcs_150us,    
    RCL_CmdBleCs_Tfcs_Length,
};
 
enum RCL_CMD_BLE_CS_Tpm_e {
    RCL_CmdBleCs_Tpm_10us,
    RCL_CmdBleCs_Tpm_20us,
    RCL_CmdBleCs_Tpm_40us,      
    RCL_CmdBleCs_Tpm_Length,
};
 
enum RCL_CMD_BLE_CS_Tip_e {
    RCL_CmdBleCs_Tip_40us,      
    RCL_CmdBleCs_Tip_50us,
    RCL_CmdBleCs_Tip_60us,
    RCL_CmdBleCs_Tip_80us,      
    RCL_CmdBleCs_Tip_145us,     
    RCL_CmdBleCs_Tip_Length,
};
 
enum RCL_CMD_BLE_CS_Tsw_e {
    RCL_CmdBleCs_Tsw_0us,       
    RCL_CmdBleCs_Tsw_1us,
    RCL_CmdBleCs_Tsw_2us,
    RCL_CmdBleCs_Tsw_4us,
    RCL_CmdBleCs_Tsw_10us,      
    RCL_CmdBleCs_Tsw_Length
};
 
enum RCL_CMD_BLE_CS_AntennaConfig_e {
    RCL_CmdBleCs_AntennaConfig_1x1,     
    RCL_CmdBleCs_AntennaConfig_1x2,
    RCL_CmdBleCs_AntennaConfig_1x3,
    RCL_CmdBleCs_AntennaConfig_1x4,
    RCL_CmdBleCs_AntennaConfig_2x1,
    RCL_CmdBleCs_AntennaConfig_3x1,
    RCL_CmdBleCs_AntennaConfig_4x1,
    RCL_CmdBleCs_AntennaConfig_2x2,
    RCL_CmdBleCs_AntennaConfig_Length,
};
 
enum RCL_CMD_BLE_CS_Payload_e {
    RCL_CmdBleCs_Payload_None,
    RCL_CmdBleCs_Payload_32bit,
    RCL_CmdBleCs_Payload_64bit,
    RCL_CmdBleCs_Payload_96bit,
    RCL_CmdBleCs_Payload_128bit,
    RCL_CmdBleCs_Payload_Length
};
#endif