text: /*!
   * \file      sx1276.h
   *
   * \brief     SX1276 driver implementation
   *
   * \copyright Revised BSD License, see section \ref LICENSE.
   *
   * \code
   *                ______                              _
   *               / _____)             _              | |
   *              ( (____  _____ ____ _| |_ _____  ____| |__
   *               \____ \| ___ |    (_   _) ___ |/ ___)  _ \
   *               _____) ) ____| | | || |_| ____( (___| | | |
   *              (______/|_____)_|_|_| \__)_____)\____)_| |_|
   *              (C)2013-2017 Semtech
   *
   * \endcode
   *
   * \author    Miguel Luis ( Semtech )
   *
   * \author    Gregory Cristian ( Semtech )
   */
  /**
    ******************************************************************************
    * @file    sx1276.h
    * @author  MCD Application Team
    * @brief   Header for driver sx1276.c
    ******************************************************************************
    * @attention
    *
    * <h2><center>&copy; Copyright (c) 2018 STMicroelectronics.
    * All rights reserved.</center></h2>
    *
    * This software component is licensed by ST under BSD 3-Clause license,
    * the "License"; You may not use this file except in compliance with the
    * License. You may obtain a copy of the License at:
    *                        opensource.org/licenses/BSD-3-Clause
    *
    ******************************************************************************
    */
  
  #ifndef __SX1276_H__
  #define __SX1276_H__
  
  #include "sx1276Regs-Fsk.h"
  #include "sx1276Regs-LoRa.h"
  
  /*!
   * Radio wake-up time from sleep
   */
  #define RADIO_WAKEUP_TIME                           2 // [ms]
  
  #define RF_MID_BAND_THRESH                          525000000
  /*!
   * Sync word for Private LoRa networks
   */
  #define LORA_MAC_PRIVATE_SYNCWORD                   0x12
  
  /*!
   * Sync word for Public LoRa networks
   */
  #define LORA_MAC_PUBLIC_SYNCWORD                    0x34
  
  /*!
   * Radio FSK modem parameters
   */
  typedef struct
  {
      int8_t   Power;
      uint32_t Fdev;
      uint32_t Bandwidth;
      uint32_t BandwidthAfc;
      uint32_t Datarate;
      uint16_t PreambleLen;
      bool     FixLen;
      uint8_t  PayloadLen;
      bool     CrcOn;
      bool     IqInverted;
      bool     RxContinuous;
      uint32_t TxTimeout;
      uint32_t RxSingleTimeout;
  }RadioFskSettings_t;
  
  /*!
   * Radio FSK packet handler state
   */
  typedef struct
  {
      uint8_t  PreambleDetected;
      uint8_t  SyncWordDetected;
      int8_t   RssiValue;
      int32_t  AfcValue;
      uint8_t  RxGain;
      uint16_t Size;
      uint16_t NbBytes;
      uint8_t  FifoThresh;
      uint8_t  ChunkSize;
  }RadioFskPacketHandler_t;
  
  /*!
   * Radio LoRa modem parameters
   */
  typedef struct
  {
      int8_t   Power;
      uint32_t Bandwidth;
      uint32_t Datarate;
      bool     LowDatarateOptimize;
      uint8_t  Coderate;
      uint16_t PreambleLen;
      bool     FixLen;
      uint8_t  PayloadLen;
      bool     CrcOn;
      bool     FreqHopOn;
      uint8_t  HopPeriod;
      bool     IqInverted;
      bool     RxContinuous;
      uint32_t TxTimeout;
      bool     PublicNetwork;
  }RadioLoRaSettings_t;
  
  /*!
   * Radio LoRa packet handler state
   */
  typedef struct
  {
      int8_t SnrValue;
      int16_t RssiValue;
      uint8_t Size;
  }RadioLoRaPacketHandler_t;
  
  /*!
   * Radio Settings
   */
  typedef struct
  {
      RadioState_t             State;
      RadioModems_t            Modem;
      uint32_t                 Channel;
      RadioFskSettings_t       Fsk;
      RadioFskPacketHandler_t  FskPacketHandler;
      RadioLoRaSettings_t      LoRa;
      RadioLoRaPacketHandler_t LoRaPacketHandler;
  }RadioSettings_t;
  
  /*!
   * Radio hardware and global parameters
   */
  typedef struct SX1276_s
  {
      uint8_t       RxTx;
      RadioSettings_t Settings;
  }SX1276_t;
  
  extern SX1276_t SX1276;
  /*!
   * Hardware IO IRQ callback function definition
   */
  typedef void ( DioIrqHandler )( void* context );
  
  /*!
   * SX1276 definitions
   */
  #define XTAL_FREQ                                   32000000
  #define FREQ_STEP                                   61.03515625
  #define FREQ_STEP_8                                 15625 /* FREQ_STEP<<8 */
  
  /*!
   * \brief Radio hardware registers initialization definition
   *
   * \remark Can be automatically generated by the SX1276 GUI (not yet implemented)
   */
  #define RADIO_INIT_REGISTERS_VALUE                \
  {                                                 \
      { MODEM_FSK , REG_LNA                , 0x23 },\
      { MODEM_FSK , REG_RXCONFIG           , 0x1E },\
      { MODEM_FSK , REG_RSSICONFIG         , 0xD2 },\
      { MODEM_FSK , REG_AFCFEI             , 0x01 },\
      { MODEM_FSK , REG_PREAMBLEDETECT     , 0xAA },\
      { MODEM_FSK , REG_OSC                , 0x07 },\
      { MODEM_FSK , REG_SYNCCONFIG         , 0x12 },\
      { MODEM_FSK , REG_SYNCVALUE1         , 0xC1 },\
      { MODEM_FSK , REG_SYNCVALUE2         , 0x94 },\
      { MODEM_FSK , REG_SYNCVALUE3         , 0xC1 },\
      { MODEM_FSK , REG_PACKETCONFIG1      , 0xD8 },\
      { MODEM_FSK , REG_FIFOTHRESH         , 0x8F },\
      { MODEM_FSK , REG_IMAGECAL           , 0x02 },\
      { MODEM_FSK , REG_DIOMAPPING1        , 0x00 },\
      { MODEM_FSK , REG_DIOMAPPING2        , 0x30 },\
      { MODEM_LORA, REG_LR_PAYLOADMAXLENGTH, 0x40 },\
  }                                                 \
  
  /* Freq = channel * FREQ_STEP */
  #define SX_CHANNEL_TO_FREQ( channel, freq )                                                         \
      do                                                                                              \
      {                                                                                               \
          uint32_t initialChanInt, initialChanFrac;                                                   \
          initialChanInt = channel  >> 8;                                                             \
          initialChanFrac = channel - ( initialChanInt << 8 );                                        \
          freq = initialChanInt * FREQ_STEP_8 + ( ( initialChanFrac * FREQ_STEP_8 + ( 128 ) ) >> 8 ); \
      }while( 0 )
  
  /* channel = Freq / FREQ_STEP */
  #define SX_FREQ_TO_CHANNEL( channel, freq )                                                                       \
      do                                                                                                            \
      {                                                                                                             \
          uint32_t initialFreqInt, initialFreqFrac;                                                                 \
          initialFreqInt = freq / FREQ_STEP_8;                                                                      \
          initialFreqFrac = freq - ( initialFreqInt * FREQ_STEP_8 );                                                \
          channel = ( initialFreqInt << 8 ) + ( ( ( initialFreqFrac << 8 ) + ( FREQ_STEP_8 / 2 ) ) / FREQ_STEP_8 ); \
      }while( 0 )
  
  #define RX_BUFFER_SIZE                              256
  
  typedef struct sBoardCallback
  {
      /*!
       * \brief Set XO state on the board
       */
      void ( *SX1276BoardSetXO )( uint8_t state );
      /*!
       * \brief Get Board Wake Up time
       */
      uint32_t ( *SX1276BoardGetWakeTime )( void );
      /*!
       * \brief Initializes the radio I/Os Irq
       */
      void ( *SX1276BoardIoIrqInit )( DioIrqHandler **irqHandlers );
      /*!
       * \brief Sets the radio output power.
       *
       * \param [IN] power Sets the RF output power
       */
      void ( *SX1276BoardSetRfTxPower )( int8_t power );
      /*!
       * \brief Set the RF Switch I/Os pins in Low Power mode
       *
       * \param [IN] status enable or disable
       */
      void ( *SX1276BoardSetAntSwLowPower )( bool status );
      /*!
       * \brief Controls the antena switch if necessary.
       *
       * \remark see errata note
       *
       * \param [IN] opMode Current radio operating mode
       */
      void ( *SX1276BoardSetAntSw )( uint8_t opMode );
  }LoRaBoardCallback_t;
  
  /*!
   * ============================================================================
   * Public functions prototypes
   * ============================================================================
   */
  void SX1276BoardInit( LoRaBoardCallback_t *callbacks );
  
  /*!
   * \brief Resets the SX1276
   */
  void SX1276Reset( void );
  /*!
   * \brief Initializes the radio
   *
   * \param [IN] events Structure containing the driver callback functions
   * \param [OUT] returns the wake up time of the radio and associated board
   */
  uint32_t SX1276Init( RadioEvents_t *events );
  
  /*!
   * \brief Sets the SX1276 operating mode
   *
   * \param [IN] opMode New operating mode
   */
  void SX1276SetOpMode( uint8_t opMode );
  
  /*!
   * Return current radio status
   *
   * \param status Radio status.[RF_IDLE, RF_RX_RUNNING, RF_TX_RUNNING]
   */
  RadioState_t SX1276GetStatus( void );
  
  /*!
   * \brief Configures the radio with the given modem
   *
   * \param [IN] modem Modem to be used [0: FSK, 1: LoRa]
   */
  void SX1276SetModem( RadioModems_t modem );
  
  /*!
   * \brief Sets the channel configuration
   *
   * \param [IN] freq         Channel RF frequency
   */
  void SX1276SetChannel( uint32_t freq );
  
  /*!
   * \brief Checks if the channel is free for the given time
   *
   * \param [IN] modem      Radio modem to be used [0: FSK, 1: LoRa]
   * \param [IN] freq       Channel RF frequency
   * \param [IN] rssiThresh RSSI threshold
   * \param [IN] maxCarrierSenseTime Max time while the RSSI is measured
   *
   * \retval isFree         [true: Channel is free, false: Channel is not free]
   */
  bool SX1276IsChannelFree( RadioModems_t modem, uint32_t freq, int16_t rssiThresh, uint32_t maxCarrierSenseTime );
  
  /*!
   * \brief Generates a 32 bits random value based on the RSSI readings
   *
   * \remark This function sets the radio in LoRa modem mode and disables
   *         all interrupts.
   *         After calling this function either SX1276SetRxConfig or
   *         SX1276SetTxConfig functions must be called.
   *
   * \retval randomValue    32 bits random value
   */
  uint32_t SX1276Random( void );
  
  /*!
   * \brief Sets the reception parameters
   *
   * \remark When using LoRa modem only bandwidths 125, 250 and 500 kHz are supported
   *
   * \param [IN] modem        Radio modem to be used [0: FSK, 1: LoRa]
   * \param [IN] bandwidth    Sets the bandwidth
   *                          FSK : >= 2600 and <= 250000 Hz
   *                          LoRa: [0: 125 kHz, 1: 250 kHz,
   *                                 2: 500 kHz, 3: Reserved]
   * \param [IN] datarate     Sets the Datarate
   *                          FSK : 600..300000 bits/s
   *                          LoRa: [6: 64, 7: 128, 8: 256, 9: 512,
   *                                10: 1024, 11: 2048, 12: 4096  chips]
   * \param [IN] coderate     Sets the coding rate (LoRa only)
   *                          FSK : N/A ( set to 0 )
   *                          LoRa: [1: 4/5, 2: 4/6, 3: 4/7, 4: 4/8]
   * \param [IN] bandwidthAfc Sets the AFC Bandwidth (FSK only)
   *                          FSK : >= 2600 and <= 250000 Hz
   *                          LoRa: N/A ( set to 0 )
   * \param [IN] preambleLen  Sets the Preamble length
   *                          FSK : Number of bytes
   *                          LoRa: Length in symbols (the hardware adds 4 more symbols)
   * \param [IN] symbTimeout  Sets the RxSingle timeout value
   *                          FSK : timeout number of bytes
   *                          LoRa: timeout in symbols
   * \param [IN] fixLen       Fixed length packets [0: variable, 1: fixed]
   * \param [IN] payloadLen   Sets payload length when fixed length is used
   * \param [IN] crcOn        Enables/Disables the CRC [0: OFF, 1: ON]
   * \param [IN] freqHopOn    Enables disables the intra-packet frequency hopping
   *                          FSK : N/A ( set to 0 )
   *                          LoRa: [0: OFF, 1: ON]
   * \param [IN] hopPeriod    Number of symbols between each hop
   *                          FSK : N/A ( set to 0 )
   *                          LoRa: Number of symbols
   * \param [IN] iqInverted   Inverts IQ signals (LoRa only)
   *                          FSK : N/A ( set to 0 )
   *                          LoRa: [0: not inverted, 1: inverted]
   * \param [IN] rxContinuous Sets the reception in continuous mode
   *                          [false: single mode, true: continuous mode]
   */
  void SX1276SetRxConfig( RadioModems_t modem, uint32_t bandwidth,
                           uint32_t datarate, uint8_t coderate,
                           uint32_t bandwidthAfc, uint16_t preambleLen,
                           uint16_t symbTimeout, bool fixLen,
                           uint8_t payloadLen,
                           bool crcOn, bool freqHopOn, uint8_t hopPeriod,
                           bool iqInverted, bool rxContinuous );
  
  /*!
   * \brief Sets the transmission parameters
   *
   * \remark When using LoRa modem only bandwidths 125, 250 and 500 kHz are supported
   *
   * \param [IN] modem        Radio modem to be used [0: FSK, 1: LoRa]
   * \param [IN] power        Sets the output power [dBm]
   * \param [IN] fdev         Sets the frequency deviation (FSK only)
   *                          FSK : [Hz]
   *                          LoRa: 0
   * \param [IN] bandwidth    Sets the bandwidth (LoRa only)
   *                          FSK : 0
   *                          LoRa: [0: 125 kHz, 1: 250 kHz,
   *                                 2: 500 kHz, 3: Reserved]
   * \param [IN] datarate     Sets the Datarate
   *                          FSK : 600..300000 bits/s
   *                          LoRa: [6: 64, 7: 128, 8: 256, 9: 512,
   *                                10: 1024, 11: 2048, 12: 4096  chips]
   * \param [IN] coderate     Sets the coding rate (LoRa only)
   *                          FSK : N/A ( set to 0 )
   *                          LoRa: [1: 4/5, 2: 4/6, 3: 4/7, 4: 4/8]
   * \param [IN] preambleLen  Sets the preamble length
   *                          FSK : Number of bytes
   *                          LoRa: Length in symbols (the hardware adds 4 more symbols)
   * \param [IN] fixLen       Fixed length packets [0: variable, 1: fixed]
   * \param [IN] crcOn        Enables disables the CRC [0: OFF, 1: ON]
   * \param [IN] freqHopOn    Enables disables the intra-packet frequency hopping
   *                          FSK : N/A ( set to 0 )
   *                          LoRa: [0: OFF, 1: ON]
   * \param [IN] hopPeriod    Number of symbols between each hop
   *                          FSK : N/A ( set to 0 )
   *                          LoRa: Number of symbols
   * \param [IN] iqInverted   Inverts IQ signals (LoRa only)
   *                          FSK : N/A ( set to 0 )
   *                          LoRa: [0: not inverted, 1: inverted]
   * \param [IN] timeout      Transmission timeout [ms]
   */
  void SX1276SetTxConfig( RadioModems_t modem, int8_t power, uint32_t fdev,
                          uint32_t bandwidth, uint32_t datarate,
                          uint8_t coderate, uint16_t preambleLen,
                          bool fixLen, bool crcOn, bool freqHopOn,
                          uint8_t hopPeriod, bool iqInverted, uint32_t timeout );
  
  /*!
   * \brief Computes the packet time on air in ms for the given payload
   *
   * \Remark Can only be called once SetRxConfig or SetTxConfig have been called
   *
   * \param [IN] modem      Radio modem to be used [0: FSK, 1: LoRa]
   * \param [IN] pktLen     Packet payload length
   *
   * \retval airTime        Computed airTime (ms) for the given packet payload length
   */
  uint32_t SX1276GetTimeOnAir( RadioModems_t modem, uint8_t pktLen );
  
  /*!
   * \brief Sends the buffer of size. Prepares the packet to be sent and sets
   *        the radio in transmission
   *
   * \param [IN]: buffer     Buffer pointer
   * \param [IN]: size       Buffer size
   */
  void SX1276Send( uint8_t *buffer, uint8_t size );
  
  /*!
   * \brief Sets the radio in sleep mode
   */
  void SX1276SetSleep( void );
  
  /*!
   * \brief Sets the radio in standby mode
   */
  void SX1276SetStby( void );
  
  /*!
   * \brief Sets the radio in reception mode for the given time
   * \param [IN] timeout Reception timeout [ms] [0: continuous, others timeout]
   */
  void SX1276SetRx( uint32_t timeout );
  
  /*!
   * \brief Start a Channel Activity Detection
   */
  void SX1276StartCad( void );
  
  /*!
   * \brief Sets the radio in continuous wave transmission mode
   *
   * \param [IN]: freq       Channel RF frequency
   * \param [IN]: power      Sets the output power [dBm]
   * \param [IN]: time       Transmission mode timeout [s]
   */
  void SX1276SetTxContinuousWave( uint32_t freq, int8_t power, uint16_t time );
  
  /*!
   * \brief Reads the current RSSI value
   *
   * \retval rssiValue Current RSSI value in [dBm]
   */
  int16_t SX1276ReadRssi( RadioModems_t modem );
  
  /*!
   * Performs the Rx chain calibration for LF and HF bands
   * \remark Must be called just after the reset so all registers are at their
   *         default values
   */
  void RxChainCalibration( void );
  /*!
   * \brief Set a SyncSword in the radio
   *
   * \param [IN]: data SyncSword
   */
  
  void SX1276SetSyncWord( uint8_t data );
  
  /*!
   * \brief Writes the radio register at the specified address
   *
   * \param [IN]: addr Register address
   * \param [IN]: data New register value
   */
  void SX1276Write( uint16_t addr, uint8_t data );
  
  /*!
   * \brief Reads the radio register at the specified address
   *
   * \param [IN]: addr Register address
   * \retval data Register value
   */
  uint8_t SX1276Read( uint16_t addr );
  
  /*!
   * \brief Writes multiple radio registers starting at address
   *
   * \param [IN] addr   First Radio register address
   * \param [IN] buffer Buffer containing the new register's values
   * \param [IN] size   Number of registers to be written
   */
  void SX1276WriteBuffer( uint16_t addr, uint8_t *buffer, uint8_t size );
  
  /*!
   * \brief Reads multiple radio registers starting at address
   *
   * \param [IN] addr First Radio register address
   * \param [OUT] buffer Buffer where to copy the registers data
   * \param [IN] size Number of registers to be read
   */
  void SX1276ReadBuffer( uint16_t addr, uint8_t *buffer, uint8_t size );
  
  /*!
   * \brief Sets the maximum payload length.
   *
   * \param [IN] modem      Radio modem to be used [0: FSK, 1: LoRa]
   * \param [IN] max        Maximum payload length in bytes
   */
  void SX1276SetMaxPayloadLength( RadioModems_t modem, uint8_t max );
  
  /*!
   * \brief Sets the network to public or private. Updates the sync byte.
   *
   * \remark Applies to LoRa modem only
   *
   * \param [IN] enable if true, it enables a public network
   */
  void SX1276SetPublicNetwork( bool enable );
  
  /*!
   * \brief Gets the time required for the board plus radio to get out of sleep.[ms]
   *
   * \retval time Radio plus board wakeup time in ms.
   */
  uint32_t SX1276GetWakeupTime( void );
  
  #endif /* __SX1276_H__ */
  