ST-DEVKIT-LRWAN
Dependents: DISCO-L072CZ-LRWAN1-base
Fork of SX1276GenericLib by
radio/radio.h
- Committer:
- Helmut Tschemernjak
- Date:
- 2017-05-17
- Revision:
- 51:aef3234bcb71
- Parent:
- 50:43f7160e869c
- Child:
- 53:6d3adad59633
File content as of revision 51:aef3234bcb71:
/* / _____) _ | | ( (____ _____ ____ _| |_ _____ ____| |__ \____ \| ___ | (_ _) ___ |/ ___) _ \ _____) ) ____| | | || |_| ____( (___| | | | (______/|_____)_|_|_| \__)_____)\____)_| |_| (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" /* ! * 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; /*! * 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 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 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; /*! * @brief Radio driver callback functions */ typedef struct { /*! * @brief Tx Done callback prototype. */ void ( *TxDone )(void *radio); /*! * @brief Tx Timeout callback prototype. */ void ( *TxTimeout )(void *radio); /*! * @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 )(void *radio, uint8_t *payload, uint16_t size, int16_t rssi, int8_t snr ); /*! * @brief Rx Timeout callback prototype. */ void ( *RxTimeout )(void *radio); /*! * @brief Rx Error callback prototype. */ void ( *RxError )(void *radio); /*! * \brief FHSS Change Channel callback prototype. * * \param [IN] currentChannel Index number of the current channel */ void ( *FhssChangeChannel )(void *radio, uint8_t currentChannel ); /*! * @brief CAD Done callback prototype. * * @param [IN] channelDetected Channel Activity detected during the CAD */ void ( *CadDone ) (void *radio, 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, RX_RUNNING, TX_RUNNING, CAD_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 * @param [IN]: buffer Header pointer * @param [IN]: size Header size */ virtual void Send( void *buffer, int16_t size, void *header = NULL, int16_t hsize = 0) = 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 Returns the maximal transfer unit for a given modem * * @retval MTU size in bytes */ virtual int16_t MaxMTUSize( RadioModems_t modem ) = 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, void *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, void *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( void *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( void *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__