@@ -0,0 +1,25 @@ | |||||
--- Revised BSD License --- | |||||
Copyright (c) 2013, SEMTECH S.A. | |||||
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 the Semtech corporation 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 SEMTECH S.A. 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. |
@@ -0,0 +1,131 @@ | |||||
/* | |||||
/ _____) _ | | | |||||
( (____ _____ ____ _| |_ _____ ____| |__ | |||||
\____ \| ___ | (_ _) ___ |/ ___) _ \ | |||||
_____) ) ____| | | || |_| ____( (___| | | | | |||||
(______/|_____)_|_|_| \__)_____)\____)_| |_| | |||||
(C) 2014 Semtech | |||||
Description: - | |||||
License: Revised BSD License, see LICENSE.TXT file include in the project | |||||
Maintainers: Miguel Luis, Gregory Cristian and Nicolas Huguenin | |||||
*/ | |||||
#ifndef __ENUMS_H__ | |||||
#define __ENUMS_H__ | |||||
/*! | |||||
* Radio driver internal state machine states definition | |||||
*/ | |||||
typedef enum RadioState | |||||
{ | |||||
RF_IDLE = 0, | |||||
RF_RX_RUNNING, | |||||
RF_TX_RUNNING, | |||||
RF_CAD, | |||||
}RadioState_t; | |||||
/*! | |||||
* Type of the modem. [LORA / FSK] | |||||
*/ | |||||
typedef enum ModemType | |||||
{ | |||||
MODEM_FSK = 0, | |||||
MODEM_LORA | |||||
}RadioModems_t; | |||||
/*! | |||||
* Type of the supported board. [SX1276MB1MAS / SX1276MB1LAS] | |||||
*/ | |||||
typedef enum BoardType | |||||
{ | |||||
SX1276MB1MAS = 0, | |||||
SX1276MB1LAS, | |||||
UNKNOWN | |||||
}BoardType_t; | |||||
/*! | |||||
* 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; | |||||
int8_t RssiValue; | |||||
uint8_t Size; | |||||
}RadioLoRaPacketHandler_t; | |||||
/*! | |||||
* Radio Settings | |||||
*/ | |||||
typedef struct | |||||
{ | |||||
RadioState State; | |||||
ModemType Modem; | |||||
uint32_t Channel; | |||||
RadioFskSettings_t Fsk; | |||||
RadioFskPacketHandler_t FskPacketHandler; | |||||
RadioLoRaSettings_t LoRa; | |||||
RadioLoRaPacketHandler_t LoRaPacketHandler; | |||||
}RadioSettings_t; | |||||
#endif //__ENUMS_H__ |
@@ -0,0 +1,20 @@ | |||||
/* | |||||
/ _____) _ | | | |||||
( (____ _____ ____ _| |_ _____ ____| |__ | |||||
\____ \| ___ | (_ _) ___ |/ ___) _ \ | |||||
_____) ) ____| | | || |_| ____( (___| | | | | |||||
(______/|_____)_|_|_| \__)_____)\____)_| |_| | |||||
(C) 2014 Semtech | |||||
Description: Interface for the radios, contains the main functions that a radio needs, and 5 callback functions | |||||
License: Revised BSD License, see LICENSE.TXT file include in the project | |||||
Maintainers: Miguel Luis, Gregory Cristian and Nicolas Huguenin | |||||
*/ | |||||
#include "radio.h" | |||||
Radio::Radio( RadioEvents_t *events ) | |||||
{ | |||||
this->RadioEvents = events; | |||||
} |
@@ -0,0 +1,337 @@ | |||||
/* | |||||
/ _____) _ | | | |||||
( (____ _____ ____ _| |_ _____ ____| |__ | |||||
\____ \| ___ | (_ _) ___ |/ ___) _ \ | |||||
_____) ) ____| | | || |_| ____( (___| | | | | |||||
(______/|_____)_|_|_| \__)_____)\____)_| |_| | |||||
(C) 2014 Semtech | |||||
Description: Interface for the radios, contains the main functions that a radio needs, and 5 callback functions | |||||
License: Revised BSD License, see LICENSE.TXT file include in the project | |||||
Maintainers: Miguel Luis, Gregory Cristian and Nicolas Huguenin | |||||
*/ | |||||
#ifndef __RADIO_H__ | |||||
#define __RADIO_H__ | |||||
#include "mbed.h" | |||||
#include "./enums/enums.h" | |||||
/*! | |||||
* @brief Radio driver callback functions | |||||
*/ | |||||
typedef struct | |||||
{ | |||||
/*! | |||||
* @brief Tx Done callback prototype. | |||||
*/ | |||||
void ( *TxDone )( void ); | |||||
/*! | |||||
* @brief Tx Timeout callback prototype. | |||||
*/ | |||||
void ( *TxTimeout )( void ); | |||||
/*! | |||||
* @brief Rx Done callback prototype. | |||||
* | |||||
* @param [IN] payload Received buffer pointer | |||||
* @param [IN] size Received buffer size | |||||
* @param [IN] rssi RSSI value computed while receiving the frame [dBm] | |||||
* @param [IN] snr Raw SNR value given by the radio hardware | |||||
* FSK : N/A ( set to 0 ) | |||||
* LoRa: SNR value in dB | |||||
*/ | |||||
void ( *RxDone )( uint8_t *payload, uint16_t size, int16_t rssi, int8_t snr ); | |||||
/*! | |||||
* @brief Rx Timeout callback prototype. | |||||
*/ | |||||
void ( *RxTimeout )( void ); | |||||
/*! | |||||
* @brief Rx Error callback prototype. | |||||
*/ | |||||
void ( *RxError )( void ); | |||||
/*! | |||||
* \brief FHSS Change Channel callback prototype. | |||||
* | |||||
* \param [IN] currentChannel Index number of the current channel | |||||
*/ | |||||
void ( *FhssChangeChannel )( uint8_t currentChannel ); | |||||
/*! | |||||
* @brief CAD Done callback prototype. | |||||
* | |||||
* @param [IN] channelDetected Channel Activity detected during the CAD | |||||
*/ | |||||
void ( *CadDone ) ( bool channelActivityDetected ); | |||||
}RadioEvents_t; | |||||
/*! | |||||
* Interface for the radios, contains the main functions that a radio needs, and 5 callback functions | |||||
*/ | |||||
class Radio | |||||
{ | |||||
protected: | |||||
RadioEvents_t* RadioEvents; | |||||
public: | |||||
//------------------------------------------------------------------------- | |||||
// Constructor | |||||
//------------------------------------------------------------------------- | |||||
/*! | |||||
* @brief Constructor of the radio object, the parameters are the callback functions described in the header. | |||||
* | |||||
* @param [IN] events Structure containing the driver callback functions | |||||
*/ | |||||
Radio( RadioEvents_t *events ); | |||||
virtual ~Radio( ) {}; | |||||
//------------------------------------------------------------------------- | |||||
// Pure virtual functions | |||||
//------------------------------------------------------------------------- | |||||
/*! | |||||
* @brief Initializes the radio | |||||
* | |||||
* @param [IN] events Structure containing the driver callback functions | |||||
*/ | |||||
virtual void Init( RadioEvents_t *events ) = 0; | |||||
/*! | |||||
* @brief Return current radio status | |||||
* | |||||
* @param status Radio status.[RF_IDLE, RF_RX_RUNNING, RF_TX_RUNNING] | |||||
*/ | |||||
virtual RadioState GetStatus( void ) = 0; | |||||
/*! | |||||
* @brief Configures the radio with the given modem | |||||
* | |||||
* @param [IN] modem Modem to be used [0: FSK, 1: LoRa] | |||||
*/ | |||||
virtual void SetModem( RadioModems_t modem ) = 0; | |||||
/*! | |||||
* @brief Sets the channel frequency | |||||
* | |||||
* @param [IN] freq Channel RF frequency | |||||
*/ | |||||
virtual void SetChannel( uint32_t freq ) = 0; | |||||
/*! | |||||
* @brief Sets the channels configuration | |||||
* | |||||
* @param [IN] modem Radio modem to be used [0: FSK, 1: LoRa] | |||||
* @param [IN] freq Channel RF frequency | |||||
* @param [IN] rssiThresh RSSI threshold | |||||
* | |||||
* @retval isFree [true: Channel is free, false: Channel is not free] | |||||
*/ | |||||
virtual bool IsChannelFree( RadioModems_t modem, uint32_t freq, int16_t rssiThresh ) = 0; | |||||
/*! | |||||
* @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 Radio.SetRxConfig or | |||||
* Radio.SetTxConfig functions must be called. | |||||
* | |||||
* @retval randomValue 32 bits random value | |||||
*/ | |||||
virtual uint32_t Random( void )= 0; | |||||
/*! | |||||
* @brief Sets the reception parameters | |||||
* | |||||
* @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 ( LoRa only ) | |||||
* FSK : N/A ( set to 0 ) | |||||
* 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 lenght is used | |||||
* @param [IN] crcOn Enables/Disables the CRC [0: OFF, 1: ON] | |||||
* @param [IN] freqHopOn Enables disables the intra-packet frequency hopping [0: OFF, 1: ON] (LoRa only) | |||||
* @param [IN] hopPeriod Number of symbols bewteen each hop (LoRa only) | |||||
* @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] | |||||
*/ | |||||
virtual void SetRxConfig ( 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 ) = 0; | |||||
/*! | |||||
* @brief Sets the transmission parameters | |||||
* | |||||
* @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 | |||||
* @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 [0: OFF, 1: ON] (LoRa only) | |||||
* @param [IN] hopPeriod Number of symbols bewteen each hop (LoRa only) | |||||
* @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 [us] | |||||
*/ | |||||
virtual void SetTxConfig( 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 ) = 0; | |||||
/*! | |||||
* @brief Checks if the given RF frequency is supported by the hardware | |||||
* | |||||
* @param [IN] frequency RF frequency to be checked | |||||
* @retval isSupported [true: supported, false: unsupported] | |||||
*/ | |||||
virtual bool CheckRfFrequency( uint32_t frequency ) = 0; | |||||
/*! | |||||
* @brief Computes the packet time on air 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 for the given packet payload length | |||||
*/ | |||||
virtual uint32_t TimeOnAir ( RadioModems_t modem, uint8_t pktLen ) = 0; | |||||
/*! | |||||
* @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 | |||||
*/ | |||||
virtual void Send( uint8_t *buffer, uint8_t size ) = 0; | |||||
/*! | |||||
* @brief Sets the radio in sleep mode | |||||
*/ | |||||
virtual void Sleep( void ) = 0; | |||||
/*! | |||||
* @brief Sets the radio in standby mode | |||||
*/ | |||||
virtual void Standby( void ) = 0; | |||||
/*! | |||||
* @brief Sets the radio in CAD mode | |||||
*/ | |||||
virtual void StartCad( void ) = 0; | |||||
/*! | |||||
* @brief Sets the radio in reception mode for the given time | |||||
* @param [IN] timeout Reception timeout [us] | |||||
* [0: continuous, others timeout] | |||||
*/ | |||||
virtual void Rx( uint32_t timeout ) = 0; | |||||
/*! | |||||
* @brief Sets the radio in transmission mode for the given time | |||||
* @param [IN] timeout Transmission timeout [us] | |||||
* [0: continuous, others timeout] | |||||
*/ | |||||
virtual void Tx( uint32_t timeout ) = 0; | |||||
/*! | |||||
* @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] | |||||
*/ | |||||
virtual void SetTxContinuousWave( uint32_t freq, int8_t power, uint16_t time ) = 0; | |||||
/*! | |||||
* @brief Reads the current RSSI value | |||||
* | |||||
* @retval rssiValue Current RSSI value in [dBm] | |||||
*/ | |||||
virtual int16_t GetRssi ( RadioModems_t modem ) = 0; | |||||
/*! | |||||
* @brief Writes the radio register at the specified address | |||||
* | |||||
* @param [IN]: addr Register address | |||||
* @param [IN]: data New register value | |||||
*/ | |||||
virtual void Write ( uint8_t addr, uint8_t data ) = 0; | |||||
/*! | |||||
* @brief Reads the radio register at the specified address | |||||
* | |||||
* @param [IN]: addr Register address | |||||
* @retval data Register value | |||||
*/ | |||||
virtual uint8_t Read ( uint8_t addr ) = 0; | |||||
/*! | |||||
* @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 | |||||
*/ | |||||
virtual void Write( uint8_t addr, uint8_t *buffer, uint8_t size ) = 0; | |||||
/*! | |||||
* @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 | |||||
*/ | |||||
virtual void Read ( uint8_t addr, uint8_t *buffer, uint8_t size ) = 0; | |||||
/*! | |||||
* @brief Writes the buffer contents to the Radio FIFO | |||||
* | |||||
* @param [IN] buffer Buffer containing data to be put on the FIFO. | |||||
* @param [IN] size Number of bytes to be written to the FIFO | |||||
*/ | |||||
virtual void WriteFifo( uint8_t *buffer, uint8_t size ) = 0; | |||||
/*! | |||||
* @brief Reads the contents of the Radio FIFO | |||||
* | |||||
* @param [OUT] buffer Buffer where to copy the FIFO read data. | |||||
* @param [IN] size Number of bytes to be read from the FIFO | |||||
*/ | |||||
virtual void ReadFifo( uint8_t *buffer, uint8_t size ) = 0; | |||||
/*! | |||||
* @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 | |||||
*/ | |||||
virtual void SetMaxPayloadLength( RadioModems_t modem, uint8_t max ) = 0; | |||||
/*! | |||||
* @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 | |||||
*/ | |||||
virtual void SetPublicNetwork( bool enable ) = 0; | |||||
}; | |||||
#endif // __RADIO_H__ |
@@ -0,0 +1,565 @@ | |||||
/* | |||||
/ _____) _ | | | |||||
( (____ _____ ____ _| |_ _____ ____| |__ | |||||
\____ \| ___ | (_ _) ___ |/ ___) _ \ | |||||
_____) ) ____| | | || |_| ____( (___| | | | | |||||
(______/|_____)_|_|_| \__)_____)\____)_| |_| | |||||
(C) 2014 Semtech | |||||
Description: SX1276 LoRa modem registers and bits definitions | |||||
License: Revised BSD License, see LICENSE.TXT file include in the project | |||||
Maintainer: Miguel Luis and Gregory Cristian | |||||
*/ | |||||
#ifndef __SX1276_REGS_LORA_H__ | |||||
#define __SX1276_REGS_LORA_H__ | |||||
/*! | |||||
* ============================================================================ | |||||
* SX1276 Internal registers Address | |||||
* ============================================================================ | |||||
*/ | |||||
#define REG_LR_FIFO 0x00 | |||||
// Common settings | |||||
#define REG_LR_OPMODE 0x01 | |||||
#define REG_LR_FRFMSB 0x06 | |||||
#define REG_LR_FRFMID 0x07 | |||||
#define REG_LR_FRFLSB 0x08 | |||||
// Tx settings | |||||
#define REG_LR_PACONFIG 0x09 | |||||
#define REG_LR_PARAMP 0x0A | |||||
#define REG_LR_OCP 0x0B | |||||
// Rx settings | |||||
#define REG_LR_LNA 0x0C | |||||
// LoRa registers | |||||
#define REG_LR_FIFOADDRPTR 0x0D | |||||
#define REG_LR_FIFOTXBASEADDR 0x0E | |||||
#define REG_LR_FIFORXBASEADDR 0x0F | |||||
#define REG_LR_FIFORXCURRENTADDR 0x10 | |||||
#define REG_LR_IRQFLAGSMASK 0x11 | |||||
#define REG_LR_IRQFLAGS 0x12 | |||||
#define REG_LR_RXNBBYTES 0x13 | |||||
#define REG_LR_RXHEADERCNTVALUEMSB 0x14 | |||||
#define REG_LR_RXHEADERCNTVALUELSB 0x15 | |||||
#define REG_LR_RXPACKETCNTVALUEMSB 0x16 | |||||
#define REG_LR_RXPACKETCNTVALUELSB 0x17 | |||||
#define REG_LR_MODEMSTAT 0x18 | |||||
#define REG_LR_PKTSNRVALUE 0x19 | |||||
#define REG_LR_PKTRSSIVALUE 0x1A | |||||
#define REG_LR_RSSIVALUE 0x1B | |||||
#define REG_LR_HOPCHANNEL 0x1C | |||||
#define REG_LR_MODEMCONFIG1 0x1D | |||||
#define REG_LR_MODEMCONFIG2 0x1E | |||||
#define REG_LR_SYMBTIMEOUTLSB 0x1F | |||||
#define REG_LR_PREAMBLEMSB 0x20 | |||||
#define REG_LR_PREAMBLELSB 0x21 | |||||
#define REG_LR_PAYLOADLENGTH 0x22 | |||||
#define REG_LR_PAYLOADMAXLENGTH 0x23 | |||||
#define REG_LR_HOPPERIOD 0x24 | |||||
#define REG_LR_FIFORXBYTEADDR 0x25 | |||||
#define REG_LR_MODEMCONFIG3 0x26 | |||||
#define REG_LR_FEIMSB 0x28 | |||||
#define REG_LR_FEIMID 0x29 | |||||
#define REG_LR_FEILSB 0x2A | |||||
#define REG_LR_RSSIWIDEBAND 0x2C | |||||
#define REG_LR_TEST2F 0x2F | |||||
#define REG_LR_TEST30 0x30 | |||||
#define REG_LR_DETECTOPTIMIZE 0x31 | |||||
#define REG_LR_INVERTIQ 0x33 | |||||
#define REG_LR_TEST36 0x36 | |||||
#define REG_LR_DETECTIONTHRESHOLD 0x37 | |||||
#define REG_LR_SYNCWORD 0x39 | |||||
#define REG_LR_TEST3A 0x3A | |||||
#define REG_LR_INVERTIQ2 0x3B | |||||
// end of documented register in datasheet | |||||
// I/O settings | |||||
#define REG_LR_DIOMAPPING1 0x40 | |||||
#define REG_LR_DIOMAPPING2 0x41 | |||||
// Version | |||||
#define REG_LR_VERSION 0x42 | |||||
// Additional settings | |||||
#define REG_LR_PLLHOP 0x44 | |||||
#define REG_LR_TCXO 0x4B | |||||
#define REG_LR_PADAC 0x4D | |||||
#define REG_LR_FORMERTEMP 0x5B | |||||
#define REG_LR_BITRATEFRAC 0x5D | |||||
#define REG_LR_AGCREF 0x61 | |||||
#define REG_LR_AGCTHRESH1 0x62 | |||||
#define REG_LR_AGCTHRESH2 0x63 | |||||
#define REG_LR_AGCTHRESH3 0x64 | |||||
#define REG_LR_PLL 0x70 | |||||
/*! | |||||
* ============================================================================ | |||||
* SX1276 LoRa bits control definition | |||||
* ============================================================================ | |||||
*/ | |||||
/*! | |||||
* RegFifo | |||||
*/ | |||||
/*! | |||||
* RegOpMode | |||||
*/ | |||||
#define RFLR_OPMODE_LONGRANGEMODE_MASK 0x7F | |||||
#define RFLR_OPMODE_LONGRANGEMODE_OFF 0x00 // Default | |||||
#define RFLR_OPMODE_LONGRANGEMODE_ON 0x80 | |||||
#define RFLR_OPMODE_ACCESSSHAREDREG_MASK 0xBF | |||||
#define RFLR_OPMODE_ACCESSSHAREDREG_ENABLE 0x40 | |||||
#define RFLR_OPMODE_ACCESSSHAREDREG_DISABLE 0x00 // Default | |||||
#define RFLR_OPMODE_FREQMODE_ACCESS_MASK 0xF7 | |||||
#define RFLR_OPMODE_FREQMODE_ACCESS_LF 0x08 // Default | |||||
#define RFLR_OPMODE_FREQMODE_ACCESS_HF 0x00 | |||||
#define RFLR_OPMODE_MASK 0xF8 | |||||
#define RFLR_OPMODE_SLEEP 0x00 | |||||
#define RFLR_OPMODE_STANDBY 0x01 // Default | |||||
#define RFLR_OPMODE_SYNTHESIZER_TX 0x02 | |||||
#define RFLR_OPMODE_TRANSMITTER 0x03 | |||||
#define RFLR_OPMODE_SYNTHESIZER_RX 0x04 | |||||
#define RFLR_OPMODE_RECEIVER 0x05 | |||||
// LoRa specific modes | |||||
#define RFLR_OPMODE_RECEIVER_SINGLE 0x06 | |||||
#define RFLR_OPMODE_CAD 0x07 | |||||
/*! | |||||
* RegFrf (MHz) | |||||
*/ | |||||
#define RFLR_FRFMSB_434_MHZ 0x6C // Default | |||||
#define RFLR_FRFMID_434_MHZ 0x80 // Default | |||||
#define RFLR_FRFLSB_434_MHZ 0x00 // Default | |||||
/*! | |||||
* RegPaConfig | |||||
*/ | |||||
#define RFLR_PACONFIG_PASELECT_MASK 0x7F | |||||
#define RFLR_PACONFIG_PASELECT_PABOOST 0x80 | |||||
#define RFLR_PACONFIG_PASELECT_RFO 0x00 // Default | |||||
#define RFLR_PACONFIG_MAX_POWER_MASK 0x8F | |||||
#define RFLR_PACONFIG_OUTPUTPOWER_MASK 0xF0 | |||||
/*! | |||||
* RegPaRamp | |||||
*/ | |||||
#define RFLR_PARAMP_TXBANDFORCE_MASK 0xEF | |||||
#define RFLR_PARAMP_TXBANDFORCE_BAND_SEL 0x10 | |||||
#define RFLR_PARAMP_TXBANDFORCE_AUTO 0x00 // Default | |||||
#define RFLR_PARAMP_MASK 0xF0 | |||||
#define RFLR_PARAMP_3400_US 0x00 | |||||
#define RFLR_PARAMP_2000_US 0x01 | |||||
#define RFLR_PARAMP_1000_US 0x02 | |||||
#define RFLR_PARAMP_0500_US 0x03 | |||||
#define RFLR_PARAMP_0250_US 0x04 | |||||
#define RFLR_PARAMP_0125_US 0x05 | |||||
#define RFLR_PARAMP_0100_US 0x06 | |||||
#define RFLR_PARAMP_0062_US 0x07 | |||||
#define RFLR_PARAMP_0050_US 0x08 | |||||
#define RFLR_PARAMP_0040_US 0x09 // Default | |||||
#define RFLR_PARAMP_0031_US 0x0A | |||||
#define RFLR_PARAMP_0025_US 0x0B | |||||
#define RFLR_PARAMP_0020_US 0x0C | |||||
#define RFLR_PARAMP_0015_US 0x0D | |||||
#define RFLR_PARAMP_0012_US 0x0E | |||||
#define RFLR_PARAMP_0010_US 0x0F | |||||
/*! | |||||
* RegOcp | |||||
*/ | |||||
#define RFLR_OCP_MASK 0xDF | |||||
#define RFLR_OCP_ON 0x20 // Default | |||||
#define RFLR_OCP_OFF 0x00 | |||||
#define RFLR_OCP_TRIM_MASK 0xE0 | |||||
#define RFLR_OCP_TRIM_045_MA 0x00 | |||||
#define RFLR_OCP_TRIM_050_MA 0x01 | |||||
#define RFLR_OCP_TRIM_055_MA 0x02 | |||||
#define RFLR_OCP_TRIM_060_MA 0x03 | |||||
#define RFLR_OCP_TRIM_065_MA 0x04 | |||||
#define RFLR_OCP_TRIM_070_MA 0x05 | |||||
#define RFLR_OCP_TRIM_075_MA 0x06 | |||||
#define RFLR_OCP_TRIM_080_MA 0x07 | |||||
#define RFLR_OCP_TRIM_085_MA 0x08 | |||||
#define RFLR_OCP_TRIM_090_MA 0x09 | |||||
#define RFLR_OCP_TRIM_095_MA 0x0A | |||||
#define RFLR_OCP_TRIM_100_MA 0x0B // Default | |||||
#define RFLR_OCP_TRIM_105_MA 0x0C | |||||
#define RFLR_OCP_TRIM_110_MA 0x0D | |||||
#define RFLR_OCP_TRIM_115_MA 0x0E | |||||
#define RFLR_OCP_TRIM_120_MA 0x0F | |||||
#define RFLR_OCP_TRIM_130_MA 0x10 | |||||
#define RFLR_OCP_TRIM_140_MA 0x11 | |||||
#define RFLR_OCP_TRIM_150_MA 0x12 | |||||
#define RFLR_OCP_TRIM_160_MA 0x13 | |||||
#define RFLR_OCP_TRIM_170_MA 0x14 | |||||
#define RFLR_OCP_TRIM_180_MA 0x15 | |||||
#define RFLR_OCP_TRIM_190_MA 0x16 | |||||
#define RFLR_OCP_TRIM_200_MA 0x17 | |||||
#define RFLR_OCP_TRIM_210_MA 0x18 | |||||
#define RFLR_OCP_TRIM_220_MA 0x19 | |||||
#define RFLR_OCP_TRIM_230_MA 0x1A | |||||
#define RFLR_OCP_TRIM_240_MA 0x1B | |||||
/*! | |||||
* RegLna | |||||
*/ | |||||
#define RFLR_LNA_GAIN_MASK 0x1F | |||||
#define RFLR_LNA_GAIN_G1 0x20 // Default | |||||
#define RFLR_LNA_GAIN_G2 0x40 | |||||
#define RFLR_LNA_GAIN_G3 0x60 | |||||
#define RFLR_LNA_GAIN_G4 0x80 | |||||
#define RFLR_LNA_GAIN_G5 0xA0 | |||||
#define RFLR_LNA_GAIN_G6 0xC0 | |||||
#define RFLR_LNA_BOOST_LF_MASK 0xE7 | |||||
#define RFLR_LNA_BOOST_LF_DEFAULT 0x00 // Default | |||||
#define RFLR_LNA_BOOST_HF_MASK 0xFC | |||||
#define RFLR_LNA_BOOST_HF_OFF 0x00 // Default | |||||
#define RFLR_LNA_BOOST_HF_ON 0x03 | |||||
/*! | |||||
* RegFifoAddrPtr | |||||
*/ | |||||
#define RFLR_FIFOADDRPTR 0x00 // Default | |||||
/*! | |||||
* RegFifoTxBaseAddr | |||||
*/ | |||||
#define RFLR_FIFOTXBASEADDR 0x80 // Default | |||||
/*! | |||||
* RegFifoTxBaseAddr | |||||
*/ | |||||
#define RFLR_FIFORXBASEADDR 0x00 // Default | |||||
/*! | |||||
* RegFifoRxCurrentAddr (Read Only) | |||||
*/ | |||||
/*! | |||||
* RegIrqFlagsMask | |||||
*/ | |||||
#define RFLR_IRQFLAGS_RXTIMEOUT_MASK 0x80 | |||||
#define RFLR_IRQFLAGS_RXDONE_MASK 0x40 | |||||
#define RFLR_IRQFLAGS_PAYLOADCRCERROR_MASK 0x20 | |||||
#define RFLR_IRQFLAGS_VALIDHEADER_MASK 0x10 | |||||
#define RFLR_IRQFLAGS_TXDONE_MASK 0x08 | |||||
#define RFLR_IRQFLAGS_CADDONE_MASK 0x04 | |||||
#define RFLR_IRQFLAGS_FHSSCHANGEDCHANNEL_MASK 0x02 | |||||
#define RFLR_IRQFLAGS_CADDETECTED_MASK 0x01 | |||||
/*! | |||||
* RegIrqFlags | |||||
*/ | |||||
#define RFLR_IRQFLAGS_RXTIMEOUT 0x80 | |||||
#define RFLR_IRQFLAGS_RXDONE 0x40 | |||||
#define RFLR_IRQFLAGS_PAYLOADCRCERROR 0x20 | |||||
#define RFLR_IRQFLAGS_VALIDHEADER 0x10 | |||||
#define RFLR_IRQFLAGS_TXDONE 0x08 | |||||
#define RFLR_IRQFLAGS_CADDONE 0x04 | |||||
#define RFLR_IRQFLAGS_FHSSCHANGEDCHANNEL 0x02 | |||||
#define RFLR_IRQFLAGS_CADDETECTED 0x01 | |||||
/*! | |||||
* RegFifoRxNbBytes (Read Only) | |||||
*/ | |||||
/*! | |||||
* RegRxHeaderCntValueMsb (Read Only) | |||||
*/ | |||||
/*! | |||||
* RegRxHeaderCntValueLsb (Read Only) | |||||
*/ | |||||
/*! | |||||
* RegRxPacketCntValueMsb (Read Only) | |||||
*/ | |||||
/*! | |||||
* RegRxPacketCntValueLsb (Read Only) | |||||
*/ | |||||
/*! | |||||
* RegModemStat (Read Only) | |||||
*/ | |||||
#define RFLR_MODEMSTAT_RX_CR_MASK 0x1F | |||||
#define RFLR_MODEMSTAT_MODEM_STATUS_MASK 0xE0 | |||||
/*! | |||||
* RegPktSnrValue (Read Only) | |||||
*/ | |||||
/*! | |||||
* RegPktRssiValue (Read Only) | |||||
*/ | |||||
/*! | |||||
* RegRssiValue (Read Only) | |||||
*/ | |||||
/*! | |||||
* RegHopChannel (Read Only) | |||||
*/ | |||||
#define RFLR_HOPCHANNEL_PLL_LOCK_TIMEOUT_MASK 0x7F | |||||
#define RFLR_HOPCHANNEL_PLL_LOCK_FAIL 0x80 | |||||
#define RFLR_HOPCHANNEL_PLL_LOCK_SUCCEED 0x00 // Default | |||||
#define RFLR_HOPCHANNEL_CRCONPAYLOAD_MASK 0xBF | |||||
#define RFLR_HOPCHANNEL_CRCONPAYLOAD_ON 0x40 | |||||
#define RFLR_HOPCHANNEL_CRCONPAYLOAD_OFF 0x00 // Default | |||||
#define RFLR_HOPCHANNEL_CHANNEL_MASK 0x3F | |||||
/*! | |||||
* RegModemConfig1 | |||||
*/ | |||||
#define RFLR_MODEMCONFIG1_BW_MASK 0x0F | |||||
#define RFLR_MODEMCONFIG1_BW_7_81_KHZ 0x00 | |||||
#define RFLR_MODEMCONFIG1_BW_10_41_KHZ 0x10 | |||||
#define RFLR_MODEMCONFIG1_BW_15_62_KHZ 0x20 | |||||
#define RFLR_MODEMCONFIG1_BW_20_83_KHZ 0x30 | |||||
#define RFLR_MODEMCONFIG1_BW_31_25_KHZ 0x40 | |||||
#define RFLR_MODEMCONFIG1_BW_41_66_KHZ 0x50 | |||||
#define RFLR_MODEMCONFIG1_BW_62_50_KHZ 0x60 | |||||
#define RFLR_MODEMCONFIG1_BW_125_KHZ 0x70 // Default | |||||
#define RFLR_MODEMCONFIG1_BW_250_KHZ 0x80 | |||||
#define RFLR_MODEMCONFIG1_BW_500_KHZ 0x90 | |||||
#define RFLR_MODEMCONFIG1_CODINGRATE_MASK 0xF1 | |||||
#define RFLR_MODEMCONFIG1_CODINGRATE_4_5 0x02 | |||||
#define RFLR_MODEMCONFIG1_CODINGRATE_4_6 0x04 // Default | |||||
#define RFLR_MODEMCONFIG1_CODINGRATE_4_7 0x06 | |||||
#define RFLR_MODEMCONFIG1_CODINGRATE_4_8 0x08 | |||||
#define RFLR_MODEMCONFIG1_IMPLICITHEADER_MASK 0xFE | |||||
#define RFLR_MODEMCONFIG1_IMPLICITHEADER_ON 0x01 | |||||
#define RFLR_MODEMCONFIG1_IMPLICITHEADER_OFF 0x00 // Default | |||||
/*! | |||||
* RegModemConfig2 | |||||
*/ | |||||
#define RFLR_MODEMCONFIG2_SF_MASK 0x0F | |||||
#define RFLR_MODEMCONFIG2_SF_6 0x60 | |||||
#define RFLR_MODEMCONFIG2_SF_7 0x70 // Default | |||||
#define RFLR_MODEMCONFIG2_SF_8 0x80 | |||||
#define RFLR_MODEMCONFIG2_SF_9 0x90 | |||||
#define RFLR_MODEMCONFIG2_SF_10 0xA0 | |||||
#define RFLR_MODEMCONFIG2_SF_11 0xB0 | |||||
#define RFLR_MODEMCONFIG2_SF_12 0xC0 | |||||
#define RFLR_MODEMCONFIG2_TXCONTINUOUSMODE_MASK 0xF7 | |||||
#define RFLR_MODEMCONFIG2_TXCONTINUOUSMODE_ON 0x08 | |||||
#define RFLR_MODEMCONFIG2_TXCONTINUOUSMODE_OFF 0x00 | |||||
#define RFLR_MODEMCONFIG2_RXPAYLOADCRC_MASK 0xFB | |||||
#define RFLR_MODEMCONFIG2_RXPAYLOADCRC_ON 0x04 | |||||
#define RFLR_MODEMCONFIG2_RXPAYLOADCRC_OFF 0x00 // Default | |||||
#define RFLR_MODEMCONFIG2_SYMBTIMEOUTMSB_MASK 0xFC | |||||
#define RFLR_MODEMCONFIG2_SYMBTIMEOUTMSB 0x00 // Default | |||||
/*! | |||||
* RegSymbTimeoutLsb | |||||
*/ | |||||
#define RFLR_SYMBTIMEOUTLSB_SYMBTIMEOUT 0x64 // Default | |||||
/*! | |||||
* RegPreambleLengthMsb | |||||
*/ | |||||
#define RFLR_PREAMBLELENGTHMSB 0x00 // Default | |||||
/*! | |||||
* RegPreambleLengthLsb | |||||
*/ | |||||
#define RFLR_PREAMBLELENGTHLSB 0x08 // Default | |||||
/*! | |||||
* RegPayloadLength | |||||
*/ | |||||
#define RFLR_PAYLOADLENGTH 0x0E // Default | |||||
/*! | |||||
* RegPayloadMaxLength | |||||
*/ | |||||
#define RFLR_PAYLOADMAXLENGTH 0xFF // Default | |||||
/*! | |||||
* RegHopPeriod | |||||
*/ | |||||
#define RFLR_HOPPERIOD_FREQFOPPINGPERIOD 0x00 // Default | |||||
/*! | |||||
* RegFifoRxByteAddr (Read Only) | |||||
*/ | |||||
/*! | |||||
* RegModemConfig3 | |||||
*/ | |||||
#define RFLR_MODEMCONFIG3_LOWDATARATEOPTIMIZE_MASK 0xF7 | |||||
#define RFLR_MODEMCONFIG3_LOWDATARATEOPTIMIZE_ON 0x08 | |||||
#define RFLR_MODEMCONFIG3_LOWDATARATEOPTIMIZE_OFF 0x00 // Default | |||||
#define RFLR_MODEMCONFIG3_AGCAUTO_MASK 0xFB | |||||
#define RFLR_MODEMCONFIG3_AGCAUTO_ON 0x04 // Default | |||||
#define RFLR_MODEMCONFIG3_AGCAUTO_OFF 0x00 | |||||
/*! | |||||
* RegFeiMsb (Read Only) | |||||
*/ | |||||
/*! | |||||
* RegFeiMid (Read Only) | |||||
*/ | |||||
/*! | |||||
* RegFeiLsb (Read Only) | |||||
*/ | |||||
/*! | |||||
* RegRssiWideband (Read Only) | |||||
*/ | |||||
/*! | |||||
* RegDetectOptimize | |||||
*/ | |||||
#define RFLR_DETECTIONOPTIMIZE_MASK 0xF8 | |||||
#define RFLR_DETECTIONOPTIMIZE_SF7_TO_SF12 0x03 // Default | |||||
#define RFLR_DETECTIONOPTIMIZE_SF6 0x05 | |||||
/*! | |||||
* RegInvertIQ | |||||
*/ | |||||
#define RFLR_INVERTIQ_RX_MASK 0xBF | |||||
#define RFLR_INVERTIQ_RX_OFF 0x00 | |||||
#define RFLR_INVERTIQ_RX_ON 0x40 | |||||
#define RFLR_INVERTIQ_TX_MASK 0xFE | |||||
#define RFLR_INVERTIQ_TX_OFF 0x01 | |||||
#define RFLR_INVERTIQ_TX_ON 0x00 | |||||
/*! | |||||
* RegDetectionThreshold | |||||
*/ | |||||
#define RFLR_DETECTIONTHRESH_SF7_TO_SF12 0x0A // Default | |||||
#define RFLR_DETECTIONTHRESH_SF6 0x0C | |||||
/*! | |||||
* RegInvertIQ2 | |||||
*/ | |||||
#define RFLR_INVERTIQ2_ON 0x19 | |||||
#define RFLR_INVERTIQ2_OFF 0x1D | |||||
/*! | |||||
* RegDioMapping1 | |||||
*/ | |||||
#define RFLR_DIOMAPPING1_DIO0_MASK 0x3F | |||||
#define RFLR_DIOMAPPING1_DIO0_00 0x00 // Default | |||||
#define RFLR_DIOMAPPING1_DIO0_01 0x40 | |||||
#define RFLR_DIOMAPPING1_DIO0_10 0x80 | |||||
#define RFLR_DIOMAPPING1_DIO0_11 0xC0 | |||||
#define RFLR_DIOMAPPING1_DIO1_MASK 0xCF | |||||
#define RFLR_DIOMAPPING1_DIO1_00 0x00 // Default | |||||
#define RFLR_DIOMAPPING1_DIO1_01 0x10 | |||||
#define RFLR_DIOMAPPING1_DIO1_10 0x20 | |||||
#define RFLR_DIOMAPPING1_DIO1_11 0x30 | |||||
#define RFLR_DIOMAPPING1_DIO2_MASK 0xF3 | |||||
#define RFLR_DIOMAPPING1_DIO2_00 0x00 // Default | |||||
#define RFLR_DIOMAPPING1_DIO2_01 0x04 | |||||
#define RFLR_DIOMAPPING1_DIO2_10 0x08 | |||||
#define RFLR_DIOMAPPING1_DIO2_11 0x0C | |||||
#define RFLR_DIOMAPPING1_DIO3_MASK 0xFC | |||||
#define RFLR_DIOMAPPING1_DIO3_00 0x00 // Default | |||||
#define RFLR_DIOMAPPING1_DIO3_01 0x01 | |||||
#define RFLR_DIOMAPPING1_DIO3_10 0x02 | |||||
#define RFLR_DIOMAPPING1_DIO3_11 0x03 | |||||
/*! | |||||
* RegDioMapping2 | |||||
*/ | |||||
#define RFLR_DIOMAPPING2_DIO4_MASK 0x3F | |||||
#define RFLR_DIOMAPPING2_DIO4_00 0x00 // Default | |||||
#define RFLR_DIOMAPPING2_DIO4_01 0x40 | |||||
#define RFLR_DIOMAPPING2_DIO4_10 0x80 | |||||
#define RFLR_DIOMAPPING2_DIO4_11 0xC0 | |||||
#define RFLR_DIOMAPPING2_DIO5_MASK 0xCF | |||||
#define RFLR_DIOMAPPING2_DIO5_00 0x00 // Default | |||||
#define RFLR_DIOMAPPING2_DIO5_01 0x10 | |||||
#define RFLR_DIOMAPPING2_DIO5_10 0x20 | |||||
#define RFLR_DIOMAPPING2_DIO5_11 0x30 | |||||
#define RFLR_DIOMAPPING2_MAP_MASK 0xFE | |||||
#define RFLR_DIOMAPPING2_MAP_PREAMBLEDETECT 0x01 | |||||
#define RFLR_DIOMAPPING2_MAP_RSSI 0x00 // Default | |||||
/*! | |||||
* RegVersion (Read Only) | |||||
*/ | |||||
/*! | |||||
* RegPllHop | |||||
*/ | |||||
#define RFLR_PLLHOP_FASTHOP_MASK 0x7F | |||||
#define RFLR_PLLHOP_FASTHOP_ON 0x80 | |||||
#define RFLR_PLLHOP_FASTHOP_OFF 0x00 // Default | |||||
/*! | |||||
* RegTcxo | |||||
*/ | |||||
#define RFLR_TCXO_TCXOINPUT_MASK 0xEF | |||||
#define RFLR_TCXO_TCXOINPUT_ON 0x10 | |||||
#define RFLR_TCXO_TCXOINPUT_OFF 0x00 // Default | |||||
/*! | |||||
* RegPaDac | |||||
*/ | |||||
#define RFLR_PADAC_20DBM_MASK 0xF8 | |||||
#define RFLR_PADAC_20DBM_ON 0x07 | |||||
#define RFLR_PADAC_20DBM_OFF 0x04 // Default | |||||
/*! | |||||
* RegFormerTemp | |||||
*/ | |||||
/*! | |||||
* RegBitrateFrac | |||||
*/ | |||||
#define RF_BITRATEFRAC_MASK 0xF0 | |||||
/*! | |||||
* RegAgcRef | |||||
*/ | |||||
/*! | |||||
* RegAgcThresh1 | |||||
*/ | |||||
/*! | |||||
* RegAgcThresh2 | |||||
*/ | |||||
/*! | |||||
* RegAgcThresh3 | |||||
*/ | |||||
/*! | |||||
* RegPll | |||||
*/ | |||||
#define RF_PLL_BANDWIDTH_MASK 0x3F | |||||
#define RF_PLL_BANDWIDTH_75 0x00 | |||||
#define RF_PLL_BANDWIDTH_150 0x40 | |||||
#define RF_PLL_BANDWIDTH_225 0x80 | |||||
#define RF_PLL_BANDWIDTH_300 0xC0 // Default | |||||
#endif // __SX1276_REGS_LORA_H__ |
@@ -0,0 +1,349 @@ | |||||
/* | |||||
/ _____) _ | | | |||||
( (____ _____ ____ _| |_ _____ ____| |__ | |||||
\____ \| ___ | (_ _) ___ |/ ___) _ \ | |||||
_____) ) ____| | | || |_| ____( (___| | | | | |||||
(______/|_____)_|_|_| \__)_____)\____)_| |_| | |||||
(C) 2014 Semtech | |||||
Description: - | |||||
License: Revised BSD License, see LICENSE.TXT file include in the project | |||||
Maintainers: Miguel Luis, Gregory Cristian and Nicolas Huguenin | |||||
*/ | |||||
#include "sx1276-hal.h" | |||||
const RadioRegisters_t SX1276MB1xAS::RadioRegsInit[] = RADIO_INIT_REGISTERS_VALUE; | |||||
SX1276MB1xAS::SX1276MB1xAS( RadioEvents_t *events, | |||||
PinName mosi, PinName miso, PinName sclk, PinName nss, PinName reset, | |||||
PinName dio0, PinName dio1, PinName dio2, PinName dio3, PinName dio4, PinName dio5, | |||||
PinName antSwitch ) | |||||
: SX1276( events, mosi, miso, sclk, nss, reset, dio0, dio1, dio2, dio3, dio4, dio5 ), | |||||
AntSwitch( antSwitch ), | |||||
#if( defined ( TARGET_NUCLEO_L152RE ) ) | |||||
Fake( D8 ) | |||||
#else | |||||
Fake( A3 ) | |||||
#endif | |||||
{ | |||||
this->RadioEvents = events; | |||||
Reset( ); | |||||
RxChainCalibration( ); | |||||
IoInit( ); | |||||
SetOpMode( RF_OPMODE_SLEEP ); | |||||
IoIrqInit( dioIrq ); | |||||
RadioRegistersInit( ); | |||||
SetModem( MODEM_FSK ); | |||||
this->settings.State = RF_IDLE ; | |||||
} | |||||
SX1276MB1xAS::SX1276MB1xAS( RadioEvents_t *events ) | |||||
#if defined ( TARGET_NUCLEO_L152RE ) | |||||
: SX1276( events, D11, D12, D13, D10, A0, D2, D3, D4, D5, A3, D9 ), // For NUCLEO L152RE dio4 is on port A3 | |||||
AntSwitch( A4 ), | |||||
Fake( D8 ) | |||||
#elif defined( TARGET_LPC11U6X ) | |||||
: SX1276( events, D11, D12, D13, D10, A0, D2, D3, D4, D5, D8, D9 ), | |||||
AntSwitch( P0_23 ), | |||||
Fake( A3 ) | |||||
#else | |||||
: SX1276( events, D11, D12, D13, D10, A0, D2, D3, D4, D5, D8, D9 ), | |||||
AntSwitch( A4 ), | |||||
Fake( A3 ) | |||||
#endif | |||||
{ | |||||
this->RadioEvents = events; | |||||
Reset( ); | |||||
boardConnected = UNKNOWN; | |||||
DetectBoardType( ); | |||||
RxChainCalibration( ); | |||||
IoInit( ); | |||||
SetOpMode( RF_OPMODE_SLEEP ); | |||||
IoIrqInit( dioIrq ); | |||||
RadioRegistersInit( ); | |||||
SetModem( MODEM_FSK ); | |||||
this->settings.State = RF_IDLE ; | |||||
} | |||||
//------------------------------------------------------------------------- | |||||
// Board relative functions | |||||
//------------------------------------------------------------------------- | |||||
uint8_t SX1276MB1xAS::DetectBoardType( void ) | |||||
{ | |||||
if( boardConnected == UNKNOWN ) | |||||
{ | |||||
this->AntSwitch.input( ); | |||||
wait_ms( 1 ); | |||||
if( this->AntSwitch == 1 ) | |||||
{ | |||||
boardConnected = SX1276MB1LAS; | |||||
} | |||||
else | |||||
{ | |||||
boardConnected = SX1276MB1MAS; | |||||
} | |||||
this->AntSwitch.output( ); | |||||
wait_ms( 1 ); | |||||
} | |||||
return ( boardConnected ); | |||||
} | |||||
void SX1276MB1xAS::IoInit( void ) | |||||
{ | |||||
AntSwInit( ); | |||||
SpiInit( ); | |||||
} | |||||
void SX1276MB1xAS::RadioRegistersInit( ) | |||||
{ | |||||
uint8_t i = 0; | |||||
for( i = 0; i < sizeof( RadioRegsInit ) / sizeof( RadioRegisters_t ); i++ ) | |||||
{ | |||||
SetModem( RadioRegsInit[i].Modem ); | |||||
Write( RadioRegsInit[i].Addr, RadioRegsInit[i].Value ); | |||||
} | |||||
} | |||||
void SX1276MB1xAS::SpiInit( void ) | |||||
{ | |||||
nss = 1; | |||||
spi.format( 8,0 ); | |||||
uint32_t frequencyToSet = 8000000; | |||||
#if( defined ( TARGET_NUCLEO_L152RE ) || defined ( TARGET_LPC11U6X ) ) | |||||
spi.frequency( frequencyToSet ); | |||||
#elif( defined ( TARGET_KL25Z ) ) //busclock frequency is halved -> double the spi frequency to compensate | |||||
spi.frequency( frequencyToSet * 2 ); | |||||
#else | |||||
#warning "Check the board's SPI frequency" | |||||
#endif | |||||
wait(0.1); | |||||
} | |||||
void SX1276MB1xAS::IoIrqInit( DioIrqHandler *irqHandlers ) | |||||
{ | |||||
#if( defined ( TARGET_NUCLEO_L152RE ) || defined ( TARGET_LPC11U6X ) ) | |||||
dio0.mode( PullDown ); | |||||
dio1.mode( PullDown ); | |||||
dio2.mode( PullDown ); | |||||
dio3.mode( PullDown ); | |||||
dio4.mode( PullDown ); | |||||
#endif | |||||
dio0.rise( mbed::callback( this, static_cast< TriggerMB1xAS > ( irqHandlers[0] ) ) ); | |||||
dio1.rise( mbed::callback( this, static_cast< TriggerMB1xAS > ( irqHandlers[1] ) ) ); | |||||
dio2.rise( mbed::callback( this, static_cast< TriggerMB1xAS > ( irqHandlers[2] ) ) ); | |||||
dio3.rise( mbed::callback( this, static_cast< TriggerMB1xAS > ( irqHandlers[3] ) ) ); | |||||
dio4.rise( mbed::callback( this, static_cast< TriggerMB1xAS > ( irqHandlers[4] ) ) ); | |||||
} | |||||
void SX1276MB1xAS::IoDeInit( void ) | |||||
{ | |||||
//nothing | |||||
} | |||||
void SX1276MB1xAS::SetRfTxPower( int8_t power ) | |||||
{ | |||||
uint8_t paConfig = 0; | |||||
uint8_t paDac = 0; | |||||
paConfig = Read( REG_PACONFIG ); | |||||
paDac = Read( REG_PADAC ); | |||||
paConfig = ( paConfig & RF_PACONFIG_PASELECT_MASK ) | GetPaSelect( this->settings.Channel ); | |||||
paConfig = ( paConfig & RF_PACONFIG_MAX_POWER_MASK ) | 0x70; | |||||
if( ( paConfig & RF_PACONFIG_PASELECT_PABOOST ) == RF_PACONFIG_PASELECT_PABOOST ) | |||||
{ | |||||
if( power > 17 ) | |||||
{ | |||||
paDac = ( paDac & RF_PADAC_20DBM_MASK ) | RF_PADAC_20DBM_ON; | |||||
} | |||||
else | |||||
{ | |||||
paDac = ( paDac & RF_PADAC_20DBM_MASK ) | RF_PADAC_20DBM_OFF; | |||||
} | |||||
if( ( paDac & RF_PADAC_20DBM_ON ) == RF_PADAC_20DBM_ON ) | |||||
{ | |||||
if( power < 5 ) | |||||
{ | |||||
power = 5; | |||||
} | |||||
if( power > 20 ) | |||||
{ | |||||
power = 20; | |||||
} | |||||
paConfig = ( paConfig & RF_PACONFIG_OUTPUTPOWER_MASK ) | ( uint8_t )( ( uint16_t )( power - 5 ) & 0x0F ); | |||||
} | |||||
else | |||||
{ | |||||
if( power < 2 ) | |||||
{ | |||||
power = 2; | |||||
} | |||||
if( power > 17 ) | |||||
{ | |||||
power = 17; | |||||
} | |||||
paConfig = ( paConfig & RF_PACONFIG_OUTPUTPOWER_MASK ) | ( uint8_t )( ( uint16_t )( power - 2 ) & 0x0F ); | |||||
} | |||||
} | |||||
else | |||||
{ | |||||
if( power < -1 ) | |||||
{ | |||||
power = -1; | |||||
} | |||||
if( power > 14 ) | |||||
{ | |||||
power = 14; | |||||
} | |||||
paConfig = ( paConfig & RF_PACONFIG_OUTPUTPOWER_MASK ) | ( uint8_t )( ( uint16_t )( power + 1 ) & 0x0F ); | |||||
} | |||||
Write( REG_PACONFIG, paConfig ); | |||||
Write( REG_PADAC, paDac ); | |||||
} | |||||
uint8_t SX1276MB1xAS::GetPaSelect( uint32_t channel ) | |||||
{ | |||||
if( channel > RF_MID_BAND_THRESH ) | |||||
{ | |||||
if( boardConnected == SX1276MB1LAS ) | |||||
{ | |||||
return RF_PACONFIG_PASELECT_PABOOST; | |||||
} | |||||
else | |||||
{ | |||||
return RF_PACONFIG_PASELECT_RFO; | |||||
} | |||||
} | |||||
else | |||||
{ | |||||
return RF_PACONFIG_PASELECT_RFO; | |||||
} | |||||
} | |||||
void SX1276MB1xAS::SetAntSwLowPower( bool status ) | |||||
{ | |||||
if( isRadioActive != status ) | |||||
{ | |||||
isRadioActive = status; | |||||
if( status == false ) | |||||
{ | |||||
AntSwInit( ); | |||||
} | |||||
else | |||||
{ | |||||
AntSwDeInit( ); | |||||
} | |||||
} | |||||
} | |||||
void SX1276MB1xAS::AntSwInit( void ) | |||||
{ | |||||
this->AntSwitch = 0; | |||||
} | |||||
void SX1276MB1xAS::AntSwDeInit( void ) | |||||
{ | |||||
this->AntSwitch = 0; | |||||
} | |||||
void SX1276MB1xAS::SetAntSw( uint8_t opMode ) | |||||
{ | |||||
switch( opMode ) | |||||
{ | |||||
case RFLR_OPMODE_TRANSMITTER: | |||||
this->AntSwitch = 1; | |||||
break; | |||||
case RFLR_OPMODE_RECEIVER: | |||||
case RFLR_OPMODE_RECEIVER_SINGLE: | |||||
case RFLR_OPMODE_CAD: | |||||
this->AntSwitch = 0; | |||||
break; | |||||
default: | |||||
this->AntSwitch = 0; | |||||
break; | |||||
} | |||||
} | |||||
bool SX1276MB1xAS::CheckRfFrequency( uint32_t frequency ) | |||||
{ | |||||
// Implement check. Currently all frequencies are supported | |||||
return true; | |||||
} | |||||
void SX1276MB1xAS::Reset( void ) | |||||
{ | |||||
reset.output( ); | |||||
reset = 0; | |||||
wait_ms( 1 ); | |||||
reset.input( ); | |||||
wait_ms( 6 ); | |||||
} | |||||
void SX1276MB1xAS::Write( uint8_t addr, uint8_t data ) | |||||
{ | |||||
Write( addr, &data, 1 ); | |||||
} | |||||
uint8_t SX1276MB1xAS::Read( uint8_t addr ) | |||||
{ | |||||
uint8_t data; | |||||
Read( addr, &data, 1 ); | |||||
return data; | |||||
} | |||||
void SX1276MB1xAS::Write( uint8_t addr, uint8_t *buffer, uint8_t size ) | |||||
{ | |||||
uint8_t i; | |||||
nss = 0; | |||||
spi.write( addr | 0x80 ); | |||||
for( i = 0; i < size; i++ ) | |||||
{ | |||||
spi.write( buffer[i] ); | |||||
} | |||||
nss = 1; | |||||
} | |||||
void SX1276MB1xAS::Read( uint8_t addr, uint8_t *buffer, uint8_t size ) | |||||
{ | |||||
uint8_t i; | |||||
nss = 0; | |||||
spi.write( addr & 0x7F ); | |||||
for( i = 0; i < size; i++ ) | |||||
{ | |||||
buffer[i] = spi.write( 0 ); | |||||
} | |||||
nss = 1; | |||||
} | |||||
void SX1276MB1xAS::WriteFifo( uint8_t *buffer, uint8_t size ) | |||||
{ | |||||
Write( 0, buffer, size ); | |||||
} | |||||
void SX1276MB1xAS::ReadFifo( uint8_t *buffer, uint8_t size ) | |||||
{ | |||||
Read( 0, buffer, size ); | |||||
} |
@@ -0,0 +1,212 @@ | |||||
/* | |||||
/ _____) _ | | | |||||
( (____ _____ ____ _| |_ _____ ____| |__ | |||||
\____ \| ___ | (_ _) ___ |/ ___) _ \ | |||||
_____) ) ____| | | || |_| ____( (___| | | | | |||||
(______/|_____)_|_|_| \__)_____)\____)_| |_| | |||||
(C) 2014 Semtech | |||||
Description: - | |||||
License: Revised BSD License, see LICENSE.TXT file include in the project | |||||
Maintainers: Miguel Luis, Gregory Cristian and Nicolas Huguenin | |||||
*/ | |||||
#ifndef __SX1276_HAL_H__ | |||||
#define __SX1276_HAL_H__ | |||||
#include "sx1276.h" | |||||
/*! | |||||
* @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 },\ | |||||
} \ | |||||
/*! | |||||
* Actual implementation of a SX1276 radio, includes some modifications to make it compatible with the MB1 LAS board | |||||
*/ | |||||
class SX1276MB1xAS : public SX1276 | |||||
{ | |||||
protected: | |||||
/*! | |||||
* Antenna switch GPIO pins objects | |||||
*/ | |||||
DigitalInOut AntSwitch; | |||||
DigitalIn Fake; | |||||
private: | |||||
static const RadioRegisters_t RadioRegsInit[]; | |||||
public: | |||||
SX1276MB1xAS( RadioEvents_t *events, | |||||
PinName mosi, PinName miso, PinName sclk, PinName nss, PinName reset, | |||||
PinName dio0, PinName dio1, PinName dio2, PinName dio3, PinName dio4, PinName dio5, | |||||
PinName antSwitch ); | |||||
SX1276MB1xAS( RadioEvents_t *events ); | |||||
virtual ~SX1276MB1xAS( ) { }; | |||||
protected: | |||||
/*! | |||||
* @brief Initializes the radio I/Os pins interface | |||||
*/ | |||||
virtual void IoInit( void ); | |||||
/*! | |||||
* @brief Initializes the radio registers | |||||
*/ | |||||
virtual void RadioRegistersInit( ); | |||||
/*! | |||||
* @brief Initializes the radio SPI | |||||
*/ | |||||
virtual void SpiInit( void ); | |||||
/*! | |||||
* @brief Initializes DIO IRQ handlers | |||||
* | |||||
* @param [IN] irqHandlers Array containing the IRQ callback functions | |||||
*/ | |||||
virtual void IoIrqInit( DioIrqHandler *irqHandlers ); | |||||
/*! | |||||
* @brief De-initializes the radio I/Os pins interface. | |||||
* | |||||
* \remark Useful when going in MCU lowpower modes | |||||
*/ | |||||
virtual void IoDeInit( void ); | |||||
/*! | |||||
* \brief Sets the radio output power. | |||||
* | |||||
* @param [IN] power Sets the RF output power | |||||
*/ | |||||
virtual void SetRfTxPower( int8_t power ); | |||||
/*! | |||||
* @brief Gets the board PA selection configuration | |||||
* | |||||
* @param [IN] channel Channel frequency in Hz | |||||
* @retval PaSelect RegPaConfig PaSelect value | |||||
*/ | |||||
virtual uint8_t GetPaSelect( uint32_t channel ); | |||||
/*! | |||||
* @brief Set the RF Switch I/Os pins in Low Power mode | |||||
* | |||||
* @param [IN] status enable or disable | |||||
*/ | |||||
virtual void SetAntSwLowPower( bool status ); | |||||
/*! | |||||
* @brief Initializes the RF Switch I/Os pins interface | |||||
*/ | |||||
virtual void AntSwInit( void ); | |||||
/*! | |||||
* @brief De-initializes the RF Switch I/Os pins interface | |||||
* | |||||
* @remark Needed to decrease the power consumption in MCU lowpower modes | |||||
*/ | |||||
virtual void AntSwDeInit( void ); | |||||
/*! | |||||
* @brief Controls the antena switch if necessary. | |||||
* | |||||
* @remark see errata note | |||||
* | |||||
* @param [IN] opMode Current radio operating mode | |||||
*/ | |||||
virtual void SetAntSw( uint8_t opMode ); | |||||
public: | |||||
/*! | |||||
* @brief Detect the board connected by reading the value of the antenna switch pin | |||||
*/ | |||||
virtual uint8_t DetectBoardType( void ); | |||||
/*! | |||||
* @brief Checks if the given RF frequency is supported by the hardware | |||||
* | |||||
* @param [IN] frequency RF frequency to be checked | |||||
* @retval isSupported [true: supported, false: unsupported] | |||||
*/ | |||||
virtual bool CheckRfFrequency( uint32_t frequency ); | |||||
/*! | |||||
* @brief Writes the radio register at the specified address | |||||
* | |||||
* @param [IN]: addr Register address | |||||
* @param [IN]: data New register value | |||||
*/ | |||||
virtual void Write ( uint8_t addr, uint8_t data ) ; | |||||
/*! | |||||
* @brief Reads the radio register at the specified address | |||||
* | |||||
* @param [IN]: addr Register address | |||||
* @retval data Register value | |||||
*/ | |||||
virtual uint8_t Read ( uint8_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 | |||||
*/ | |||||
virtual void Write( uint8_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 | |||||
*/ | |||||
virtual void Read ( uint8_t addr, uint8_t *buffer, uint8_t size ) ; | |||||
/*! | |||||
* @brief Writes the buffer contents to the SX1276 FIFO | |||||
* | |||||
* @param [IN] buffer Buffer containing data to be put on the FIFO. | |||||
* @param [IN] size Number of bytes to be written to the FIFO | |||||
*/ | |||||
virtual void WriteFifo( uint8_t *buffer, uint8_t size ) ; | |||||
/*! | |||||
* @brief Reads the contents of the SX1276 FIFO | |||||
* | |||||
* @param [OUT] buffer Buffer where to copy the FIFO read data. | |||||
* @param [IN] size Number of bytes to be read from the FIFO | |||||
*/ | |||||
virtual void ReadFifo( uint8_t *buffer, uint8_t size ) ; | |||||
/*! | |||||
* @brief Reset the SX1276 | |||||
*/ | |||||
virtual void Reset( void ); | |||||
}; | |||||
#endif // __SX1276_HAL_H__ |
@@ -0,0 +1,506 @@ | |||||
/* | |||||
/ _____) _ | | | |||||
( (____ _____ ____ _| |_ _____ ____| |__ | |||||
\____ \| ___ | (_ _) ___ |/ ___) _ \ | |||||
_____) ) ____| | | || |_| ____( (___| | | | | |||||
(______/|_____)_|_|_| \__)_____)\____)_| |_| | |||||
(C) 2014 Semtech | |||||
Description: Actual implementation of a SX1276 radio, inherits Radio | |||||
License: Revised BSD License, see LICENSE.TXT file include in the project | |||||
Maintainers: Miguel Luis, Gregory Cristian and Nicolas Huguenin | |||||
*/ | |||||
#ifndef __SX1276_H__ | |||||
#define __SX1276_H__ | |||||
#include "radio.h" | |||||
#include "./registers/sx1276Regs-Fsk.h" | |||||
#include "./registers/sx1276Regs-LoRa.h" | |||||
#include "./typedefs/typedefs.h" | |||||
/*! | |||||
* Radio wake-up time from sleep | |||||
*/ | |||||
#define RADIO_WAKEUP_TIME 1 // [ms] | |||||
/*! | |||||
* Sync word for Private LoRa networks | |||||
*/ | |||||
#define LORA_MAC_PRIVATE_SYNCWORD 0x12 | |||||
/*! | |||||
* Sync word for Public LoRa networks | |||||
*/ | |||||
#define LORA_MAC_PUBLIC_SYNCWORD 0x34 | |||||
/*! | |||||
* SX1276 definitions | |||||
*/ | |||||
#define XTAL_FREQ 32000000 | |||||
#define FREQ_STEP 61.03515625 | |||||
#define RX_BUFFER_SIZE 256 | |||||
/*! | |||||
* Constant values need to compute the RSSI value | |||||
*/ | |||||
#define RSSI_OFFSET_LF -164.0 | |||||
#define RSSI_OFFSET_HF -157.0 | |||||
#define RF_MID_BAND_THRESH 525000000 | |||||
/*! | |||||
* Actual implementation of a SX1276 radio, inherits Radio | |||||
*/ | |||||
class SX1276 : public Radio | |||||
{ | |||||
protected: | |||||
/*! | |||||
* SPI Interface | |||||
*/ | |||||
SPI spi; // mosi, miso, sclk | |||||
DigitalOut nss; | |||||
/*! | |||||
* SX1276 Reset pin | |||||
*/ | |||||
DigitalInOut reset; | |||||
/*! | |||||
* SX1276 DIO pins | |||||
*/ | |||||
InterruptIn dio0; | |||||
InterruptIn dio1; | |||||
InterruptIn dio2; | |||||
InterruptIn dio3; | |||||
InterruptIn dio4; | |||||
DigitalIn dio5; | |||||
bool isRadioActive; | |||||
uint8_t boardConnected; //1 = SX1276MB1LAS; 0 = SX1276MB1MAS | |||||
uint8_t *rxtxBuffer; | |||||
/*! | |||||
* Hardware DIO IRQ functions | |||||
*/ | |||||
DioIrqHandler *dioIrq; | |||||
/*! | |||||
* Tx and Rx timers | |||||
*/ | |||||
Timeout txTimeoutTimer; | |||||
Timeout rxTimeoutTimer; | |||||
Timeout rxTimeoutSyncWord; | |||||
RadioSettings_t settings; | |||||
static const FskBandwidth_t FskBandwidths[]; | |||||
protected: | |||||
/*! | |||||
* 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 ); | |||||
public: | |||||
SX1276( RadioEvents_t *events, | |||||
PinName mosi, PinName miso, PinName sclk, PinName nss, PinName reset, | |||||
PinName dio0, PinName dio1, PinName dio2, PinName dio3, PinName dio4, PinName dio5 ); | |||||
SX1276( RadioEvents_t *events ); | |||||
virtual ~SX1276( ); | |||||
//------------------------------------------------------------------------- | |||||
// Redefined Radio functions | |||||
//------------------------------------------------------------------------- | |||||
/*! | |||||
* @brief Initializes the radio | |||||
* | |||||
* @param [IN] events Structure containing the driver callback functions | |||||
*/ | |||||
virtual void Init( RadioEvents_t *events ); | |||||
/*! | |||||
* Return current radio status | |||||
* | |||||
* @param status Radio status. [RF_IDLE, RX_RUNNING, TX_RUNNING] | |||||
*/ | |||||
virtual RadioState GetStatus( void ); | |||||
/*! | |||||
* @brief Configures the SX1276 with the given modem | |||||
* | |||||
* @param [IN] modem Modem to be used [0: FSK, 1: LoRa] | |||||
*/ | |||||
virtual void SetModem( RadioModems_t modem ); | |||||
/*! | |||||
* @brief Sets the channel frequency | |||||
* | |||||
* @param [IN] freq Channel RF frequency | |||||
*/ | |||||
virtual void SetChannel( uint32_t freq ); | |||||
/*! | |||||
* @brief Sets the channels configuration | |||||
* | |||||
* @param [IN] modem Radio modem to be used [0: FSK, 1: LoRa] | |||||
* @param [IN] freq Channel RF frequency | |||||
* @param [IN] rssiThresh RSSI threshold | |||||
* | |||||
* @retval isFree [true: Channel is free, false: Channel is not free] | |||||
*/ | |||||
virtual bool IsChannelFree( RadioModems_t modem, uint32_t freq, int16_t rssiThresh ); | |||||
/*! | |||||
* @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 Radio.SetRxConfig or | |||||
* Radio.SetTxConfig functions must be called. | |||||
* | |||||
* @retval randomValue 32 bits random value | |||||
*/ | |||||
virtual uint32_t Random( void ); | |||||
/*! | |||||
* @brief Sets the reception parameters | |||||
* | |||||
* @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 ( LoRa only ) | |||||
* FSK : N/A ( set to 0 ) | |||||
* 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 lenght is used | |||||
* @param [IN] crcOn Enables/Disables the CRC [0: OFF, 1: ON] | |||||
* @param [IN] freqHopOn Enables disables the intra-packet frequency hopping [0: OFF, 1: ON] (LoRa only) | |||||
* @param [IN] hopPeriod Number of symbols bewteen each hop (LoRa only) | |||||
* @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] | |||||
*/ | |||||
virtual void SetRxConfig ( 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 | |||||
* | |||||
* @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 | |||||
* @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 [0: OFF, 1: ON] (LoRa only) | |||||
* @param [IN] hopPeriod Number of symbols bewteen each hop (LoRa only) | |||||
* @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] | |||||
*/ | |||||
virtual void SetTxConfig( 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 Checks if the given RF frequency is supported by the hardware | |||||
* | |||||
* @param [IN] frequency RF frequency to be checked | |||||
* @retval isSupported [true: supported, false: unsupported] | |||||
*/ | |||||
virtual bool CheckRfFrequency( uint32_t frequency ) = 0; | |||||
/*! | |||||
* @brief Computes the packet time on air 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 for the given packet payload length | |||||
*/ | |||||
virtual uint32_t TimeOnAir ( 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 | |||||
*/ | |||||
virtual void Send( uint8_t *buffer, uint8_t size ); | |||||
/*! | |||||
* @brief Sets the radio in sleep mode | |||||
*/ | |||||
virtual void Sleep( void ); | |||||
/*! | |||||
* @brief Sets the radio in standby mode | |||||
*/ | |||||
virtual void Standby( void ); | |||||
/*! | |||||
* @brief Sets the radio in CAD mode | |||||
*/ | |||||
virtual void StartCad( void ); | |||||
/*! | |||||
* @brief Sets the radio in reception mode for the given time | |||||
* @param [IN] timeout Reception timeout [ms] | |||||
* [0: continuous, others timeout] | |||||
*/ | |||||
virtual void Rx( uint32_t timeout ); | |||||
/*! | |||||
* @brief Sets the radio in transmission mode for the given time | |||||
* @param [IN] timeout Transmission timeout [ms] | |||||
* [0: continuous, others timeout] | |||||
*/ | |||||
virtual void Tx( uint32_t timeout ); | |||||
/*! | |||||
* @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] | |||||
*/ | |||||
virtual void SetTxContinuousWave( uint32_t freq, int8_t power, uint16_t time ); | |||||
/*! | |||||
* @brief Reads the current RSSI value | |||||
* | |||||
* @retval rssiValue Current RSSI value in [dBm] | |||||
*/ | |||||
virtual int16_t GetRssi ( RadioModems_t modem ); | |||||
/*! | |||||
* @brief Writes the radio register at the specified address | |||||
* | |||||
* @param [IN]: addr Register address | |||||
* @param [IN]: data New register value | |||||
*/ | |||||
virtual void Write ( uint8_t addr, uint8_t data ) = 0; | |||||
/*! | |||||
* @brief Reads the radio register at the specified address | |||||
* | |||||
* @param [IN]: addr Register address | |||||
* @retval data Register value | |||||
*/ | |||||
virtual uint8_t Read ( uint8_t addr ) = 0; | |||||
/*! | |||||
* @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 | |||||
*/ | |||||
virtual void Write( uint8_t addr, uint8_t *buffer, uint8_t size ) = 0; | |||||
/*! | |||||
* @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 | |||||
*/ | |||||
virtual void Read ( uint8_t addr, uint8_t *buffer, uint8_t size ) = 0; | |||||
/*! | |||||
* @brief Writes the buffer contents to the SX1276 FIFO | |||||
* | |||||
* @param [IN] buffer Buffer containing data to be put on the FIFO. | |||||
* @param [IN] size Number of bytes to be written to the FIFO | |||||
*/ | |||||
virtual void WriteFifo( uint8_t *buffer, uint8_t size ) = 0; | |||||
/*! | |||||
* @brief Reads the contents of the SX1276 FIFO | |||||
* | |||||
* @param [OUT] buffer Buffer where to copy the FIFO read data. | |||||
* @param [IN] size Number of bytes to be read from the FIFO | |||||
*/ | |||||
virtual void ReadFifo( uint8_t *buffer, uint8_t size ) = 0; | |||||
/*! | |||||
* @brief Resets the SX1276 | |||||
*/ | |||||
virtual void Reset( void ) = 0; | |||||
/*! | |||||
* @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 | |||||
*/ | |||||
virtual void SetMaxPayloadLength( 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 | |||||
*/ | |||||
virtual void SetPublicNetwork( bool enable ); | |||||
//------------------------------------------------------------------------- | |||||
// Board relative functions | |||||
//------------------------------------------------------------------------- | |||||
protected: | |||||
/*! | |||||
* @brief Initializes the radio I/Os pins interface | |||||
*/ | |||||
virtual void IoInit( void ) = 0; | |||||
/*! | |||||
* @brief Initializes the radio registers | |||||
*/ | |||||
virtual void RadioRegistersInit( ) = 0; | |||||
/*! | |||||
* @brief Initializes the radio SPI | |||||
*/ | |||||
virtual void SpiInit( void ) = 0; | |||||
/*! | |||||
* @brief Initializes DIO IRQ handlers | |||||
* | |||||
* @param [IN] irqHandlers Array containing the IRQ callback functions | |||||
*/ | |||||
virtual void IoIrqInit( DioIrqHandler *irqHandlers ) = 0; | |||||
/*! | |||||
* @brief De-initializes the radio I/Os pins interface. | |||||
* | |||||
* \remark Useful when going in MCU lowpower modes | |||||
*/ | |||||
virtual void IoDeInit( void ) = 0; | |||||
/*! | |||||
* @brief Sets the radio output power. | |||||
* | |||||
* @param [IN] power Sets the RF output power | |||||
*/ | |||||
virtual void SetRfTxPower( int8_t power ) = 0; | |||||
/*! | |||||
* @brief Gets the board PA selection configuration | |||||
* | |||||
* @param [IN] channel Channel frequency in Hz | |||||
* @retval PaSelect RegPaConfig PaSelect value | |||||
*/ | |||||
virtual uint8_t GetPaSelect( uint32_t channel ) = 0; | |||||
/*! | |||||
* @brief Set the RF Switch I/Os pins in Low Power mode | |||||
* | |||||
* @param [IN] status enable or disable | |||||
*/ | |||||
virtual void SetAntSwLowPower( bool status ) = 0; | |||||
/*! | |||||
* @brief Initializes the RF Switch I/Os pins interface | |||||
*/ | |||||
virtual void AntSwInit( void ) = 0; | |||||
/*! | |||||
* @brief De-initializes the RF Switch I/Os pins interface | |||||
* | |||||
* \remark Needed to decrease the power consumption in MCU lowpower modes | |||||
*/ | |||||
virtual void AntSwDeInit( void ) = 0; | |||||
/*! | |||||
* @brief Controls the antenna switch if necessary. | |||||
* | |||||
* \remark see errata note | |||||
* | |||||
* @param [IN] opMode Current radio operating mode | |||||
*/ | |||||
virtual void SetAntSw( uint8_t opMode ) = 0; | |||||
protected: | |||||
/*! | |||||
* @brief Sets the SX1276 operating mode | |||||
* | |||||
* @param [IN] opMode New operating mode | |||||
*/ | |||||
virtual void SetOpMode( uint8_t opMode ); | |||||
/* | |||||
* SX1276 DIO IRQ callback functions prototype | |||||
*/ | |||||
/*! | |||||
* @brief DIO 0 IRQ callback | |||||
*/ | |||||
virtual void OnDio0Irq( void ); | |||||
/*! | |||||
* @brief DIO 1 IRQ callback | |||||
*/ | |||||
virtual void OnDio1Irq( void ); | |||||
/*! | |||||
* @brief DIO 2 IRQ callback | |||||
*/ | |||||
virtual void OnDio2Irq( void ); | |||||
/*! | |||||
* @brief DIO 3 IRQ callback | |||||
*/ | |||||
virtual void OnDio3Irq( void ); | |||||
/*! | |||||
* @brief DIO 4 IRQ callback | |||||
*/ | |||||
virtual void OnDio4Irq( void ); | |||||
/*! | |||||
* @brief DIO 5 IRQ callback | |||||
*/ | |||||
virtual void OnDio5Irq( void ); | |||||
/*! | |||||
* @brief Tx & Rx timeout timer callback | |||||
*/ | |||||
virtual void OnTimeoutIrq( void ); | |||||
/*! | |||||
* Returns the known FSK bandwidth registers value | |||||
* | |||||
* \param [IN] bandwidth Bandwidth value in Hz | |||||
* \retval regValue Bandwidth register value. | |||||
*/ | |||||
static uint8_t GetFskBandwidthRegValue( uint32_t bandwidth ); | |||||
}; | |||||
#endif // __SX1276_H__ |
@@ -0,0 +1,53 @@ | |||||
/* | |||||
/ _____) _ | | | |||||
( (____ _____ ____ _| |_ _____ ____| |__ | |||||
\____ \| ___ | (_ _) ___ |/ ___) _ \ | |||||
_____) ) ____| | | || |_| ____( (___| | | | | |||||
(______/|_____)_|_|_| \__)_____)\____)_| |_| | |||||
(C) 2014 Semtech | |||||
Description: - | |||||
License: Revised BSD License, see LICENSE.TXT file include in the project | |||||
Maintainers: Miguel Luis, Gregory Cristian and Nicolas Huguenin | |||||
*/ | |||||
#ifndef __TYPEDEFS_H__ | |||||
#define __TYPEDEFS_H__ | |||||
#include "mbed.h" | |||||
#include "./enums/enums.h" | |||||
class SX1276; | |||||
class SX1276MB1xAS; | |||||
/*! | |||||
* Hardware IO IRQ callback function definition | |||||
*/ | |||||
typedef void ( SX1276::*DioIrqHandler )( void ); | |||||
/*! | |||||
* triggers definition | |||||
*/ | |||||
typedef void ( SX1276::*Trigger )( void ); | |||||
typedef void ( SX1276MB1xAS::*TriggerMB1xAS )( void ); | |||||
/*! | |||||
* FSK bandwidth definition | |||||
*/ | |||||
typedef struct | |||||
{ | |||||
uint32_t bandwidth; | |||||
uint8_t RegValue; | |||||
}FskBandwidth_t; | |||||
/*! | |||||
* Radio registers definition | |||||
*/ | |||||
typedef struct | |||||
{ | |||||
ModemType Modem; | |||||
uint8_t Addr; | |||||
uint8_t Value; | |||||
}RadioRegisters_t; | |||||
#endif //__TYPEDEFS_H__ |