ieee.h

Go to the documentation of this file.

/*
 * Copyright (c) 2021-2025, 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_ieee_h__include
#define ti_drivers_RCL_commands_ieee_h__include

#include <ti/drivers/rcl/RCL_Command.h>
#include <ti/drivers/rcl/RCL_Buffer.h>

#include <ti/drivers/utils/List.h>

typedef struct RCL_CMD_IEEE_RX_TX_t            RCL_CmdIeeeRxTx;
typedef struct RCL_CMD_IEEE_TX_TEST_t          RCL_CmdIeeeTxTest;
typedef struct RCL_STATS_IEEE_t                RCL_StatsIeee;
typedef struct RCL_CmdIeee_RxAction_t          RCL_CmdIeee_RxAction;
typedef struct RCL_CmdIeee_TxAction_t          RCL_CmdIeee_TxAction;

/* Command IDs for generic commands */
#define RCL_CMDID_IEEE_RX_TX            0x2001U
#define RCL_CMDID_IEEE_TX_TEST          0x2002U

#define RCL_CMD_IEEE_CHANNEL_FREQUENCY(channel) ((((channel) - 11UL) * 5000000UL) + 2405000000UL)

typedef union {
    struct {
        uint8_t crcError    :1;     
        uint8_t ignored     :1;     
        uint8_t reserved    :6;
    };
    uint8_t value;
} RCL_CmdIeee_RxPktStatus;

struct RCL_CMD_IEEE_RX_TX_t {
    RCL_Command             common;
    uint32_t                rfFrequency; 
    RCL_Command_TxPower     txPower;     
    RCL_Command_CoexControl coexControl; 
    RCL_CmdIeee_RxAction    *rxAction;   
    RCL_CmdIeee_TxAction    *txAction;   
    RCL_StatsIeee           *stats;      
};
#define RCL_CmdIeeeRxTx_Default()                           \
{                                                           \
    .common = RCL_Command_Default(RCL_CMDID_IEEE_RX_TX,     \
                                  RCL_Handler_Ieee_RxTx),   \
    .rfFrequency = 2440000000U,                             \
    .txPower = {.dBm = 0, .fraction = 0},                   \
    .coexControl = {.value =  0},                           \
    .rxAction = NULL,                                       \
    .txAction = NULL,                                       \
    .stats = NULL,                                          \
}
#define RCL_CmdIeeeRxTx_DefaultRuntime() (RCL_CmdIeeeRxTx) RCL_CmdIeeeRxTx_Default()

typedef enum
{
    RCL_CmdIeee_AutoAck_Off,                    
    RCL_CmdIeee_AutoAck_ImmAckNoAutoPend,       
    RCL_CmdIeee_AutoAck_ImmAckAutoPendAll,      
    RCL_CmdIeee_AutoAck_ImmAckAutoPendDataReq,  
    RCL_CmdIeee_AutoAck_ImmAckProvidedFrame,    
} RCL_CmdIeee_AutoAckMode;

typedef union
{
    struct {
        uint16_t panId;                      
        uint16_t shortAddr;                  
    };
    uint32_t combined;
} RCL_CmdIeee_PanIdAddr;

#define RCL_CMD_IEEE_SOURCE_MATCH_TABLE_SHORT_MAX_LEN 64

#define RCL_CMD_IEEE_SOURCE_MATCH_TABLE_SHORT_WITH_EXT_MAX_LEN 32

#define RCL_CMD_IEEE_SOURCE_MATCH_TABLE_SHORT_NUM_WORDS \
(((RCL_CMD_IEEE_SOURCE_MATCH_TABLE_SHORT_MAX_LEN) + ((8 * sizeof(uint16_t)) - 1)) / (8 * sizeof(uint16_t)))

typedef struct
{
    uint32_t numEntries;                                                    
    uint16_t entryEnable[RCL_CMD_IEEE_SOURCE_MATCH_TABLE_SHORT_NUM_WORDS];  
    uint16_t framePending[RCL_CMD_IEEE_SOURCE_MATCH_TABLE_SHORT_NUM_WORDS]; 
    RCL_CmdIeee_PanIdAddr shortEntry[];                                     
} RCL_CmdIeee_SourceMatchingTableShort;

#define RCL_CMD_IEEE_SOURCE_MATCH_TABLE_EXT_MAX_LEN 16

#define RCL_CMD_IEEE_SOURCE_MATCH_TABLE_EXT_NUM_WORDS \
(((RCL_CMD_IEEE_SOURCE_MATCH_TABLE_EXT_MAX_LEN) + ((8 * sizeof(uint16_t)) - 1)) / (8 * sizeof(uint16_t)))

typedef struct
{
    uint32_t numEntries;                                                    
    uint16_t entryEnable[RCL_CMD_IEEE_SOURCE_MATCH_TABLE_EXT_NUM_WORDS];    
    uint16_t framePending[RCL_CMD_IEEE_SOURCE_MATCH_TABLE_EXT_NUM_WORDS];   
    uint64_t extEntry[];                                                    
} RCL_CmdIeee_SourceMatchingTableExt;

typedef struct
{
    uint8_t entryEnable: 1;     
    uint8_t framePending: 1;    
    uint8_t reserved: 6;
} RCL_CmdIeee_SourceMatchingEntryControl;

typedef struct RCL_CmdIeee_PanConfig_t
{
    uint64_t localExtAddr;                      
    uint16_t localPanId;                        
    uint16_t localShortAddr;                    
    RCL_CmdIeee_AutoAckMode autoAckMode : 3;    
    uint8_t defaultPend : 1;                    
    uint8_t panCoord : 1;                       
    uint8_t maxFrameVersion : 2;                
    RCL_CmdIeee_SourceMatchingTableShort *sourceMatchingTableShort; 
    RCL_CmdIeee_SourceMatchingTableExt *sourceMatchingTableExt;     
} RCL_CmdIeee_PanConfig;

#define RCL_CmdIeee_PanConfig_Default()                     \
{                                                           \
    .localExtAddr = 0,                                      \
    .localPanId = 0,                                        \
    .localShortAddr = 0,                                    \
    .autoAckMode = RCL_CmdIeee_AutoAck_Off,                 \
    .defaultPend = 0,                                       \
    .panCoord = 0,                                          \
    .maxFrameVersion = 1,                                   \
    .sourceMatchingTableShort = NULL,                       \
    .sourceMatchingTableExt = NULL,                         \
}
#define RCL_CmdIeee_PanConfig_DefaultRuntime() (RCL_CmdIeee_PanConfig) RCL_CmdIeee_PanConfig_Default()

/* Do include after typedefs, as the types are needed in ti/drivers/rcl/handlers/ieee.h */
#include <ti/drivers/rcl/handlers/ieee.h>

#define RCL_CMD_IEEE_MAX_NUM_PAN    1   /* Maximum number of PANs; will be updated to 2 when dual PAN support is added */

struct RCL_CmdIeee_RxAction_t
{
    List_List rxBuffers;                
    uint8_t numPan;                     
    bool frameFiltStop;                 
    bool disableSync;                   
    bool alwaysStoreAck;                
    RCL_CmdIeee_PanConfig panConfig[RCL_CMD_IEEE_MAX_NUM_PAN];  
};

#define RCL_CmdIeee_RxAction_Default()                      \
{                                                           \
    .rxBuffers = { 0 },                                     \
    .numPan = 0,                                            \
    .frameFiltStop = false,                                 \
    .disableSync = false,                                   \
    .alwaysStoreAck = false,                                \
    .panConfig = {RCL_CmdIeee_PanConfig_Default()}          \
}
#define RCL_CmdIeee_RxAction_DefaultRuntime() (RCL_CmdIeee_RxAction) RCL_CmdIeee_RxAction_Default()

typedef enum
{
    RCL_CmdIeee_NoCca = 0,                   
    RCL_CmdIeee_CcaMode1Energy = 1,          
    RCL_CmdIeee_CcaMode2Signal = 2,          
    RCL_CmdIeee_CcaMode3EnergyOrSignal = 3,  
    RCL_CmdIeee_CcaMode4Aloha = 4,           
    RCL_CmdIeee_CcaMode3EnergyAndSignal = 7, 
} RCL_CmdIeee_CcaMode;

struct RCL_CmdIeee_TxAction_t
{
    RCL_CommandStatus txStatus;                 
    int8_t rssiLimit;                           
    RCL_ScheduleType ccaScheduling : 1;         
    uint16_t allowDelay : 1;                    
    RCL_CmdIeee_CcaMode ccaMode : 3;            
    uint16_t ccaCorrThresh : 3;                 
    uint16_t ccaContentionWindow : 2;           
    uint16_t expectImmAck : 1;                  
    uint16_t expectEnhAck : 1;                  
    uint16_t allowTxDelay : 1;                  
    uint16_t endCmdWhenDone : 1;                
    RCL_Command_CoexPriority coexPriority : 1;  
    uint32_t absCcaStartTime;                   
    uint16_t relativeTxStartTime;               
    uint16_t ackTimeout;                        
    RCL_Buffer_DataEntry *txEntry;              
    uint32_t txTimeStamp;                       
};
#define RCL_CmdIeee_TxAction_Default()                      \
{                                                           \
    .txStatus = RCL_CommandStatus_Idle,                     \
    .rssiLimit = -70,                                       \
    .ccaScheduling = RCL_Schedule_Now,                      \
    .allowDelay = 1,                                        \
    .ccaMode = RCL_CmdIeee_NoCca,                           \
    .ccaCorrThresh = 3,                                     \
    .ccaContentionWindow = 1,                               \
    .expectImmAck = 0,                                      \
    .expectEnhAck = 0,                                      \
    .allowTxDelay = 1,                                      \
    .endCmdWhenDone = 0,                                    \
    .absCcaStartTime = 0,                                   \
    .relativeTxStartTime = 0,                               \
    .ackTimeout = RCL_SCHEDULER_SYSTIM_US(300),             \
    .txEntry = NULL,                                        \
    .txTimeStamp = 0,                                       \
}
#define RCL_CmdIeee_TxAction_DefaultRuntime() (RCL_CmdIeee_TxAction) RCL_CmdIeee_TxAction_Default()


struct RCL_CMD_IEEE_TX_TEST_t {
    RCL_Command     common;
    uint32_t        rfFrequency;    
    RCL_Command_TxPower txPower;    
    uint16_t     txWord;            
    struct {
        uint8_t  whitenMode: 2;     
        uint8_t  sendCw: 1;         
        uint8_t  reserved: 5;       
    } config;
};
#define RCL_CmdIeeeTxTest_Default()                             \
{                                                               \
    .common = RCL_Command_Default(RCL_CMDID_IEEE_TX_TEST,    \
                                  RCL_Handler_Ieee_TxTest),  \
    .rfFrequency = 2440000000U,                                 \
    .txPower = {.dBm = 0, .fraction = 0},                       \
    .txWord = 0,                                                \
    .config = {                                                 \
        .whitenMode = 2,                                        \
        .sendCw = 0,                                            \
        .reserved = 0,                                          \
    },                                                          \
}
#define RCL_CmdIeeeTxTest_DefaultRuntime() (RCL_CmdIeeeTxTest) RCL_CmdIeeeTxTest_Default()

#define RCL_CMD_IEEE_WH_MODE_OFF         0 
#define RCL_CMD_IEEE_WH_MODE_PRBS9       1 
#define RCL_CMD_IEEE_WH_MODE_PRBS15      2 
#define RCL_CMD_IEEE_WH_MODE_PRBS32      3 
struct RCL_STATS_IEEE_t {
    struct
    {
        uint8_t accumulate : 1;      
        uint8_t activeUpdate : 1;    
        uint8_t reserved : 6;        
    } config;                        
    uint8_t   timestampValid;        
    int8_t    lastRssi;              
    int8_t    maxRssi;               
    uint32_t  lastTimestamp;         
    uint16_t  nRxNok;                
    uint16_t  nRxFifoFull;           
    uint16_t  nRxOk;                 
    uint16_t  nRxIgnored;            
    uint16_t  nTxImmAck;             
    uint16_t  nTxEnhAck;             
    uint16_t  nTx;                   
};

#define RCL_StatsIeee_Default()  \
{                                   \
    .config = { 0 },                \
    .timestampValid = 0,            \
    .lastRssi = LRF_RSSI_INVALID,   \
    .maxRssi = LRF_RSSI_INVALID,    \
}
#define RCL_StatsIeee_DefaultRuntime() (RCL_StatsIeee) RCL_StatsIeee_Default()



#endif