CC1101.h

Go to the documentation of this file.

 
#ifndef _CC1101_h
#define _CC1101_h
 
#include "CC1101Registers.h"
#include <stdint.h>
 
// CC1101 hardware defaults
#if !defined(CC1101_SPI)
#define CC1101_SPI hwSPI 
#endif
 
// default PIN assignments, can be overridden
#if defined(ARDUINO_ARCH_AVR)
#if defined(__AVR_ATmega32U4__)
#define DEFAULT_CC1101_GD0_PIN                  (3)                             
#else
#define DEFAULT_CC1101_GD0_PIN                  (2)                             
#endif
#elif defined(ARDUINO_ARCH_ESP8266)
#define DEFAULT_CC1101_GD0_PIN                  (5)                             
#elif defined(ARDUINO_ARCH_ESP32)
#define DEFAULT_CC1101_GD0_PIN                  (16)
#define DEFAULT_CC1101_GD0_NUM                  digitalPinToInterrupt(DEFAULT_CC1101_GD0_PIN)           
#elif defined(ARDUINO_ARCH_SAMD)
#define DEFAULT_CC1101_GD0_PIN                  (2)                             
#elif defined(LINUX_ARCH_RASPBERRYPI)
#define DEFAULT_CC1101_GD0_PIN                  (22)                    
#elif defined(ARDUINO_ARCH_STM32)
#define DEFAULT_CC1101_GD0_PIN                  (PA3)                   
#elif defined(TEENSYDUINO)
#define DEFAULT_CC1101_GD0_PIN                  (8)                             
#else
#define DEFAULT_CC1101_GD0_PIN                  (2)                             
#endif
 
#ifndef DEFAULT_CC1101_CS_PIN
#define DEFAULT_CC1101_CS_PIN (SS) 
#endif
 
#define CC1101_CRYSTAL_HZ 26000000LL
 
#define CC1101_315MHZ 315000000LL
#define CC1101_433MHZ 433100000LL
#define CC1101_868MHZ 868100000LL
#define CC1101_915MHZ 915100000LL
#define CC1101_FREQ_VAL (((MY_CC1101_FREQUENCY)*65536LL) / CC1101_CRYSTAL_HZ)
#define CC1101_FREQ_BYTE0 ((CC1101_FREQ_VAL >> 16) & 0xFF)
#define CC1101_FREQ_BYTE1 ((CC1101_FREQ_VAL >> 8) & 0xFF)
#define CC1101_FREQ_BYTE2 (CC1101_FREQ_VAL & 0xFF)
 
#if (MY_CC1101_FREQUENCY == CC1101_315MHZ)
#define CC1101_PA_TABLE PA_TABLE_315
#elif (MY_CC1101_FREQUENCY == CC1101_433MHZ)
#define CC1101_PA_TABLE PA_TABLE_433
#elif (MY_CC1101_FREQUENCY == CC1101_868MHZ)
#define CC1101_PA_TABLE PA_TABLE_868
#elif (MY_CC1101_FREQUENCY == CC1101_915MHZ)
#define CC1101_PA_TABLE PA_TABLE_868
#else
#error Unsupported value for MY_CC1101_FREQUENCY
#endif
 
// Power levels represent which entry in the PA_TABLE to use.
typedef enum cc1101PowerLevel_e {
    CC1101_POWER_0 = 0x0, 
    CC1101_POWER_1 = 0x1, 
    CC1101_POWER_2 = 0x2, 
    CC1101_POWER_3 = 0x3, 
    CC1101_POWER_4 = 0x4, 
    CC1101_POWER_5 = 0x5, 
    CC1101_POWER_6 = 0x6, 
    CC1101_POWER_7 = 0x7, 
    CC1101_POWER_AUTO = 0xff, 
} cc1101_powerLevel_t;
 
#ifndef MY_CC1101_POWER_LEVEL
#ifdef MY_GATEWAY_FEATURE
#define MY_CC1101_POWER_LEVEL CC1101_POWER_6
#else
#define MY_CC1101_POWER_LEVEL CC1101_POWER_AUTO
#endif
#endif
 
#ifndef MY_CC1101_MIN_POWER_LEVEL
#define MY_CC1101_MIN_POWER_LEVEL (0)
#endif
 
#ifndef MY_CC1101_MAX_POWER_LEVEL
#define MY_CC1101_MAX_POWER_LEVEL (7)
#endif
 
#define CC1101_ATC_TARGET_RANGE_DBM (15) 
#define CC1101_RSSI_OFFSET (74u)          
#define CC1101_TARGET_RSSI (-50)          
 
#define CC1101_MODEM_S_BR4_8_FD20 0 
#define CC1101_MODEM_M_BR38_4_FD20 1 
#define CC1101_MODEM_F_BR100_FD50 2 
#define CC1101_MODEM_XF_BR250_FD125 3 
 
#ifndef MY_CC1101_MODEM_CONFIGURATION
#define MY_CC1101_MODEM_CONFIGURATION CC1101_MODEM_M_BR38_4_FD20
#endif
 
#if (MY_CC1101_MODEM_CONFIGURATION) == (CC1101_MODEM_S_BR4_8_FD20)
#define MY_CC1101_REG_MDMCFG4_VALUE 0x67 // 135KHz bw, 4800b
#define MY_CC1101_REG_MDMCFG3_VALUE 0x83 // 4800b
#define MY_CC1101_REG_MDMCFG2_VALUE 0x12
#define MY_CC1101_REG_DEVIATN_VALUE 0x34 // 19khz dev.
#elif (MY_CC1101_MODEM_CONFIGURATION) == (CC1101_MODEM_M_BR38_4_FD20)
#define MY_CC1101_REG_MDMCFG4_VALUE 0x8a // 200KHz bw, 38.4kb
#define MY_CC1101_REG_MDMCFG3_VALUE 0x82 // 38.4kb
#define MY_CC1101_REG_MDMCFG2_VALUE 0x12
#define MY_CC1101_REG_DEVIATN_VALUE 0x47 // 47khz dev.
#elif (MY_CC1101_MODEM_CONFIGURATION) == (CC1101_MODEM_F_BR100_FD50)
#define MY_CC1101_REG_MDMCFG4_VALUE 0x8B // 200KHz bw, 100kb
#define MY_CC1101_REG_MDMCFG3_VALUE 0xF8 // 100kb
#define MY_CC1101_REG_MDMCFG2_VALUE 0x12
#define MY_CC1101_REG_DEVIATN_VALUE 0x47 // 47khz dev.
#elif (MY_CC1101_MODEM_CONFIGURATION) == (CC1101_MODEM_XF_BR250_FD125)
#define MY_CC1101_REG_MDMCFG4_VALUE 0x5D // 320KHz bw, 250kb
#define MY_CC1101_REG_MDMCFG3_VALUE 0x3B // 250kb
#define MY_CC1101_REG_MDMCFG2_VALUE 0x12
#define MY_CC1101_REG_DEVIATN_VALUE 0x62 // 125khz dev.
#else
#error Invalid setting for MY_CC1101_MODEM_CONFIGURATION.
#endif
 
#define CC1101_MAX_PACKET_LEN (0x40u) 
#define CC1101_PREAMBLE_LENGTH (8u) 
#define CC1101_BROADCAST_ADDRESS 0xFF
 
#ifndef MY_CC1101_SYNC_WORD
#define MY_CC1101_SYNC_WORD 0xF543 
#endif
 
#define CC1101_TX_RETRIES (5u) 
 
#if !defined(MY_CC1101_TX_TIMEOUT_MS)
#define MY_CC1101_TX_TIMEOUT_MS                                                \
    (50ul) 
#endif
 
#if !defined(MY_CC1101_TX_RETRY_DELAY_MS)
#define MY_CC1101_TX_RETRY_DELAY_MS                                            \
    (50l) 
#endif
 
#define CC1101_SEND_RETRIES (4u) 
 
#if !defined(MY_CC1101_SEND_TIMEOUT_MS)
#define MY_CC1101_SEND_TIMEOUT_MS (500ul) 
#endif
 
#if !defined(MY_CC1101_ACK_SEND_DELAY_MS)
#define MY_CC1101_ACK_SEND_DELAY_MS                                            \
    5 
#endif
 
#if !defined(MY_CC1101_CSN_TIMEOUT_MS)
#define MY_CC1101_CSN_TIMEOUT_MS (2ul) 
#endif
 
#if (MY_CC1101_MAX_POWER_LEVEL) <= (MY_CC1101_MIN_POWER_LEVEL)
#error MY_CC1101_MAX_POWER_LEVEL has to be bigger than MY_CC1101_MIN_POWER_LEVEL
#endif
 
#if !defined(CC1101_RETRY_TIMEOUT_MS)
// air-time approximation for timeout, 1 hop ~15 bytes payload - adjust if
// needed <fill in>
#define CC1101_RETRY_TIMEOUT_MS                                                \
    (1000ul) 
#endif
 
#define CC1101_WRITE_SINGLE 0x00
#define CC1101_WRITE_BURST 0x40
#define CC1101_READ_SINGLE 0x80
#define CC1101_READ_BURST 0xC0
 
typedef uint16_t
cc1101_sequenceNumber_t; // will eventually change to uint8_t in 3.0
typedef int8_t cc1101_RSSI_t;
typedef uint8_t cc1101_LQI_t;
typedef union {
    struct {
        uint8_t : 5;            
        bool ackRssiReport : 1; 
        bool ackReceived : 1;   
        bool ackRequested : 1;  
    } fields;                 
    uint8_t values;           
} cc1101_controlFlags_t;
 
typedef uint8_t cc1101_status_t;
 
typedef struct {
    // First two bytes must be length/address per the CC1101 packet format.
    uint8_t length;                     
    uint8_t recipient;                  
    uint8_t version;                    
    uint8_t sender;                     
    cc1101_controlFlags_t controlFlags; 
    cc1101_sequenceNumber_t
    sequenceNumber; 
} __attribute__((packed)) cc1101_header_t;
 
typedef struct {
    cc1101_sequenceNumber_t sequenceNumber; 
    cc1101_RSSI_t RSSI;                     
    cc1101_LQI_t LQI;                       
} __attribute__((packed)) cc1101_ack_t;
 
#define CC1101_HEADER_LEN                                                      \
    sizeof(cc1101_header_t) 
#define CC1101_MAX_PAYLOAD_LEN                                                 \
    (CC1101_MAX_PACKET_LEN - CC1101_HEADER_LEN) 
 
#define CC1101_PACKET_HEADER_VERSION (1u) 
#define CC1101_MIN_PACKET_HEADER_VERSION                                       \
    (1u) 
 
 
typedef struct {
    union {
        struct {
            cc1101_header_t header; 
            union {
                uint8_t payload[CC1101_MAX_PAYLOAD_LEN]; 
                cc1101_ack_t ACK;                        
            };
        };
        uint8_t data[CC1101_MAX_PACKET_LEN]; 
    };
    uint8_t payloadLen; 
    cc1101_RSSI_t RSSI; 
    cc1101_LQI_t LQI;   
} __attribute__((packed)) cc1101_packet_t;
 
typedef enum {
    CC1101_MODE_SLEEP = 0x00, 
    CC1101_MODE_IDLE,         
    CC1101_MODE_FS,           
    CC1101_MODE_TX,           
    CC1101_MODE_RX,           
    CC1101_MODE_CCA           
} cc1101_radioModes_t;
 
typedef struct {
    uint8_t address;                          
    cc1101_packet_t currentPacket;            
    cc1101_packet_t lastAck;                  
    cc1101_sequenceNumber_t txSequenceNumber; 
    cc1101_powerLevel_t powerLevel;           
    cc1101_radioModes_t radioMode;            
    cc1101_RSSI_t targetRSSI;                 
    cc1101_status_t chipStatus;               //<! CC1101 status byte.
    bool ATCenabled;                          
    volatile bool ackReceived : 1;            
    volatile bool dataReceived : 1;           
    volatile bool txComplete : 1;             
    volatile bool irqFired : 1;               
} cc1101_internal_t;
 
static void CC1101_sendCommand(cc1101_commands_t command);
 
static uint8_t CC1101_readRegister(cc1101_registers_t reg);
 
static void CC1101_readRegisterBurst(cc1101_registers_t reg, uint8_t *buffer,
                                     uint8_t size);
 
static void CC1101_sendRegisterBurst(cc1101_registers_t reg,
                                     const uint8_t *buffer, uint8_t size);
 
static void CC1101_sendRegister(cc1101_registers_t address, uint8_t value);
 
static bool CC1101_initialise();
 
static void CC1101_configure();
 
static bool CC1101_csnLow();
 
static void CC1101_csnHigh();
 
static void CC1101_wakeUp();
 
static void CC1101_idle();
 
static void CC1101_sleep();
 
static void CC1101_interruptHandler();
 
static void CC1101_handle();
 
static void CC1101_txPower(cc1101_powerLevel_t power);
 
static void CC1101_setFrequency();
 
static bool CC1101_sanityCheck();
 
static void CC1101_setAddress(uint8_t address);
 
static uint8_t CC1101_getAddress(void);
 
static bool CC1101_sendWithRetry(const uint8_t recipient, const void *buffer,
                                 const uint8_t bufferSize, const bool noACK);
 
static bool CC1101_send(const uint8_t recipient, uint8_t *data,
                        const uint8_t len, const cc1101_controlFlags_t flags);
static bool CC1101_sendPacket(cc1101_packet_t *packet);
 
static void CC1101_sendFifo(const uint8_t *buffer, const uint8_t size);
 
static void CC1101_readFifo(uint8_t *buffer, const uint8_t size);
 
static void CC1101_tx();
 
static void CC1101_rx();
 
static bool CC1101_packetAvailable();
 
static uint8_t CC1101_getData(uint8_t *buffer, const uint8_t bufferSize);
 
static void CC1101_sendAck(const uint8_t recipient,
                           const cc1101_sequenceNumber_t sequenceNumber,
                           const cc1101_RSSI_t RSSI, const cc1101_LQI_t LQI);
 
static void CC1101_ATC();
 
static void CC1101_setATC(bool onOff, int8_t targetRSSI);
 
static int16_t CC1101_getSendingRSSI();
 
static int16_t CC1101_getReceivingRSSI();
 
static int8_t CC1101_getTxPowerLevel();
 
static uint8_t CC1101_getTxPowerPercent();
 
static bool CC1101_setTxPowerPercent(const uint8_t newPowerPercent);
 
#endif