text: /*!
   * \file      RegionKR920.h
   *
   * \brief     Region definition for KR920
   *
   * \copyright Revised BSD License, see section \ref LICENSE.
   *
   * \code
   *                ______                              _
   *               / _____)             _              | |
   *              ( (____  _____ ____ _| |_ _____  ____| |__
   *               \____ \| ___ |    (_   _) ___ |/ ___)  _ \
   *               _____) ) ____| | | || |_| ____( (___| | | |
   *              (______/|_____)_|_|_| \__)_____)\____)_| |_|
   *              (C)2013 Semtech
   *
   *               ___ _____ _   ___ _  _____ ___  ___  ___ ___
   *              / __|_   _/_\ / __| |/ / __/ _ \| _ \/ __| __|
   *              \__ \ | |/ _ \ (__| ' <| _| (_) |   / (__| _|
   *              |___/ |_/_/ \_\___|_|\_\_| \___/|_|_\\___|___|
   *              embedded.connectivity.solutions===============
   *
   * \endcode
   *
   * \author    Miguel Luis ( Semtech )
   *
   * \author    Gregory Cristian ( Semtech )
   *
   * \author    Daniel Jaeckle ( STACKFORCE )
   *
   * \defgroup  REGIONKR920 Region KR920
   *            Implementation according to LoRaWAN Specification v1.0.2.
   * \{
   */
  #ifndef __REGION_KR920_H__
  #define __REGION_KR920_H__
  
  /*!
   * LoRaMac maximum number of channels
   */
  #define KR920_MAX_NB_CHANNELS                       16
  
  /*!
   * Number of default channels
   */
  #define KR920_NUMB_DEFAULT_CHANNELS                 3
  
  /*!
   * Number of channels to apply for the CF list
   */
  #define KR920_NUMB_CHANNELS_CF_LIST                 5
  
  /*!
   * Minimal datarate that can be used by the node
   */
  #define KR920_TX_MIN_DATARATE                       DR_0
  
  /*!
   * Maximal datarate that can be used by the node
   */
  #define KR920_TX_MAX_DATARATE                       DR_5
  
  /*!
   * Minimal datarate that can be used by the node
   */
  #define KR920_RX_MIN_DATARATE                       DR_0
  
  /*!
   * Maximal datarate that can be used by the node
   */
  #define KR920_RX_MAX_DATARATE                       DR_5
  
  /*!
   * Default datarate used by the node
   */
  #define KR920_DEFAULT_DATARATE                      DR_0
  
  /*!
   * Minimal Rx1 receive datarate offset
   */
  #define KR920_MIN_RX1_DR_OFFSET                     0
  
  /*!
   * Maximal Rx1 receive datarate offset
   */
  #define KR920_MAX_RX1_DR_OFFSET                     5
  
  /*!
   * Default Rx1 receive datarate offset
   */
  #define KR920_DEFAULT_RX1_DR_OFFSET                 0
  
  /*!
   * Minimal Tx output power that can be used by the node
   */
  #define KR920_MIN_TX_POWER                          TX_POWER_7
  
  /*!
   * Maximal Tx output power that can be used by the node
   */
  #define KR920_MAX_TX_POWER                          TX_POWER_0
  
  /*!
   * Default Tx output power used by the node
   */
  #define KR920_DEFAULT_TX_POWER                      TX_POWER_0
  
  /*!
   * Default Max EIRP for frequency 920.9 MHz - 921.9 MHz
   */
  #define KR920_DEFAULT_MAX_EIRP_LOW                  10.0f
  
  /*!
   * Default Max EIRP for frequency 922.1 MHz - 923.3 MHz
   */
  #define KR920_DEFAULT_MAX_EIRP_HIGH                 14.0f
  
  /*!
   * Default antenna gain
   */
  #define KR920_DEFAULT_ANTENNA_GAIN                  2.15f
  
  /*!
   * ADR Ack limit
   */
  #define KR920_ADR_ACK_LIMIT                         64
  
  /*!
   * ADR Ack delay
   */
  #define KR920_ADR_ACK_DELAY                         32
  
  /*!
   * Enabled or disabled the duty cycle
   */
  #define KR920_DUTY_CYCLE_ENABLED                    0
  
  /*!
   * Maximum RX window duration
   */
  #define KR920_MAX_RX_WINDOW                         4000
  
  /*!
   * Receive delay 1
   */
  #define KR920_RECEIVE_DELAY1                        1000
  
  /*!
   * Receive delay 2
   */
  #define KR920_RECEIVE_DELAY2                        2000
  
  /*!
   * Join accept delay 1
   */
  #define KR920_JOIN_ACCEPT_DELAY1                    5000
  
  /*!
   * Join accept delay 2
   */
  #define KR920_JOIN_ACCEPT_DELAY2                    6000
  
  /*!
   * Maximum frame counter gap
   */
  #define KR920_MAX_FCNT_GAP                          16384
  
  /*!
   * Ack timeout
   */
  #define KR920_ACKTIMEOUT                            2000
  
  /*!
   * Random ack timeout limits
   */
  #define KR920_ACK_TIMEOUT_RND                       1000
  
  #if ( KR920_DEFAULT_DATARATE > DR_5 )
  #error "A default DR higher than DR_5 may lead to connectivity loss."
  #endif
  
  /*!
   * Second reception window channel frequency definition.
   */
  #define KR920_RX_WND_2_FREQ                         921900000
  
  /*!
   * Second reception window channel datarate definition.
   */
  #define KR920_RX_WND_2_DR                           DR_0
  
  /*!
   * Maximum number of bands
   */
  #define KR920_MAX_NB_BANDS                          1
  
  /*!
   * Band 0 definition
   * { DutyCycle, TxMaxPower, LastJoinTxDoneTime, LastTxDoneTime, TimeOff }
   */
  #define KR920_BAND0                                 { 1 , KR920_MAX_TX_POWER, 0, 0, 0 } //  100.0 %
  
  /*!
   * LoRaMac default channel 1
   * Channel = { Frequency [Hz], RX1 Frequency [Hz], { ( ( DrMax << 4 ) | DrMin ) }, Band }
   */
  #define KR920_LC1                                   { 922100000, 0, { ( ( DR_5 << 4 ) | DR_0 ) }, 0 }
  
  /*!
   * LoRaMac default channel 2
   * Channel = { Frequency [Hz], RX1 Frequency [Hz], { ( ( DrMax << 4 ) | DrMin ) }, Band }
   */
  #define KR920_LC2                                   { 922300000, 0, { ( ( DR_5 << 4 ) | DR_0 ) }, 0 }
  
  /*!
   * LoRaMac default channel 3
   * Channel = { Frequency [Hz], RX1 Frequency [Hz], { ( ( DrMax << 4 ) | DrMin ) }, Band }
   */
  #define KR920_LC3                                   { 922500000, 0, { ( ( DR_5 << 4 ) | DR_0 ) }, 0 }
  
  /*!
   * LoRaMac channels which are allowed for the join procedure
   */
  #define KR920_JOIN_CHANNELS                         ( uint16_t )( LC( 1 ) | LC( 2 ) | LC( 3 ) )
  
  /*!
   * RSSI threshold for a free channel [dBm]
   */
  #define KR920_RSSI_FREE_TH                          -65
  
  /*!
   * Specifies the time the node performs a carrier sense
   */
  #define KR920_CARRIER_SENSE_TIME                    6
  
  /*!
   * Data rates table definition
   */
  static const uint8_t DataratesKR920[]  = { 12, 11, 10,  9,  8,  7 };
  
  /*!
   * Bandwidths table definition in Hz
   */
  static const uint32_t BandwidthsKR920[] = { 125000, 125000, 125000, 125000, 125000, 125000 };
  
  /*!
   * Maximum payload with respect to the datarate index. Can operate with and without a repeater.
   */
  static const uint8_t MaxPayloadOfDatarateKR920[] = { 51, 51, 51, 115, 242, 242 };
  
  /*!
   * Maximum payload with respect to the datarate index. Can operate with repeater.
   */
  static const uint8_t MaxPayloadOfDatarateRepeaterKR920[] = { 51, 51, 51, 115, 222, 222 };
  
  /*!
   * \brief The function gets a value of a specific phy attribute.
   *
   * \param [IN] getPhy Pointer to the function parameters.
   *
   * \retval Returns a structure containing the PHY parameter.
   */
  PhyParam_t RegionKR920GetPhyParam( GetPhyParams_t* getPhy );
  
  /*!
   * \brief Updates the last TX done parameters of the current channel.
   *
   * \param [IN] txDone Pointer to the function parameters.
   */
  void RegionKR920SetBandTxDone( SetBandTxDoneParams_t* txDone );
  
  /*!
   * \brief Initializes the channels masks and the channels.
   *
   * \param [IN] type Sets the initialization type.
   */
  void RegionKR920InitDefaults( InitType_t type );
  
  /*!
   * \brief Verifies a parameter.
   *
   * \param [IN] verify Pointer to the function parameters.
   *
   * \param [IN] type Sets the initialization type.
   *
   * \retval Returns true, if the parameter is valid.
   */
  bool RegionKR920Verify( VerifyParams_t* verify, PhyAttribute_t phyAttribute );
  
  /*!
   * \brief The function parses the input buffer and sets up the channels of the
   *        CF list.
   *
   * \param [IN] applyCFList Pointer to the function parameters.
   */
  void RegionKR920ApplyCFList( ApplyCFListParams_t* applyCFList );
  
  /*!
   * \brief Sets a channels mask.
   *
   * \param [IN] chanMaskSet Pointer to the function parameters.
   *
   * \retval Returns true, if the channels mask could be set.
   */
  bool RegionKR920ChanMaskSet( ChanMaskSetParams_t* chanMaskSet );
  
  /*!
   * \brief Calculates the next datarate to set, when ADR is on or off.
   *
   * \param [IN] adrNext Pointer to the function parameters.
   *
   * \param [OUT] drOut The calculated datarate for the next TX.
   *
   * \param [OUT] txPowOut The TX power for the next TX.
   *
   * \param [OUT] adrAckCounter The calculated ADR acknowledgement counter.
   *
   * \retval Returns true, if an ADR request should be performed.
   */
  bool RegionKR920AdrNext( AdrNextParams_t* adrNext, int8_t* drOut, int8_t* txPowOut, uint32_t* adrAckCounter );
  
  /*!
   * Computes the Rx window timeout and offset.
   *
   * \param [IN] datarate     Rx window datarate index to be used
   *
   * \param [IN] minRxSymbols Minimum required number of symbols to detect an Rx frame.
   *
   * \param [IN] rxError      System maximum timing error of the receiver. In milliseconds
   *                          The receiver will turn on in a [-rxError : +rxError] ms
   *                          interval around RxOffset
   *
   * \param [OUT]rxConfigParams Returns updated WindowTimeout and WindowOffset fields.
   */
  void RegionKR920ComputeRxWindowParameters( int8_t datarate, uint8_t minRxSymbols, uint32_t rxError, RxConfigParams_t *rxConfigParams );
  
  /*!
   * \brief Configuration of the RX windows.
   *
   * \param [IN] rxConfig Pointer to the function parameters.
   *
   * \param [OUT] datarate The datarate index which was set.
   *
   * \retval Returns true, if the configuration was applied successfully.
   */
  bool RegionKR920RxConfig( RxConfigParams_t* rxConfig, int8_t* datarate );
  
  /*!
   * \brief TX configuration.
   *
   * \param [IN] txConfig Pointer to the function parameters.
   *
   * \param [OUT] txPower The tx power index which was set.
   *
   * \param [OUT] txTimeOnAir The time-on-air of the frame.
   *
   * \retval Returns true, if the configuration was applied successfully.
   */
  bool RegionKR920TxConfig( TxConfigParams_t* txConfig, int8_t* txPower, TimerTime_t* txTimeOnAir );
  
  /*!
   * \brief The function processes a Link ADR Request.
   *
   * \param [IN] linkAdrReq Pointer to the function parameters.
   *
   * \retval Returns the status of the operation, according to the LoRaMAC specification.
   */
  uint8_t RegionKR920LinkAdrReq( LinkAdrReqParams_t* linkAdrReq, int8_t* drOut, int8_t* txPowOut, uint8_t* nbRepOut, uint8_t* nbBytesParsed );
  
  /*!
   * \brief The function processes a RX Parameter Setup Request.
   *
   * \param [IN] rxParamSetupReq Pointer to the function parameters.
   *
   * \retval Returns the status of the operation, according to the LoRaMAC specification.
   */
  uint8_t RegionKR920RxParamSetupReq( RxParamSetupReqParams_t* rxParamSetupReq );
  
  /*!
   * \brief The function processes a Channel Request.
   *
   * \param [IN] newChannelReq Pointer to the function parameters.
   *
   * \retval Returns the status of the operation, according to the LoRaMAC specification.
   */
  uint8_t RegionKR920NewChannelReq( NewChannelReqParams_t* newChannelReq );
  
  /*!
   * \brief The function processes a TX ParamSetup Request.
   *
   * \param [IN] txParamSetupReq Pointer to the function parameters.
   *
   * \retval Returns the status of the operation, according to the LoRaMAC specification.
   *         Returns -1, if the functionality is not implemented. In this case, the end node
   *         shall not process the command.
   */
  int8_t RegionKR920TxParamSetupReq( TxParamSetupReqParams_t* txParamSetupReq );
  
  /*!
   * \brief The function processes a DlChannel Request.
   *
   * \param [IN] dlChannelReq Pointer to the function parameters.
   *
   * \retval Returns the status of the operation, according to the LoRaMAC specification.
   */
  uint8_t RegionKR920DlChannelReq( DlChannelReqParams_t* dlChannelReq );
  
  /*!
   * \brief Alternates the datarate of the channel for the join request.
   *
   * \param [IN] alternateDr Pointer to the function parameters.
   *
   * \retval Datarate to apply.
   */
  int8_t RegionKR920AlternateDr( AlternateDrParams_t* alternateDr );
  
  /*!
   * \brief Calculates the back-off time.
   *
   * \param [IN] calcBackOff Pointer to the function parameters.
   */
  void RegionKR920CalcBackOff( CalcBackOffParams_t* calcBackOff );
  
  /*!
   * \brief Searches and set the next random available channel
   *
   * \param [OUT] channel Next channel to use for TX.
   *
   * \param [OUT] time Time to wait for the next transmission according to the duty
   *              cycle.
   *
   * \param [OUT] aggregatedTimeOff Updates the aggregated time off.
   *
   * \retval Function status [1: OK, 0: Unable to find a channel on the current datarate]
   */
  bool RegionKR920NextChannel( NextChanParams_t* nextChanParams, uint8_t* channel, TimerTime_t* time, TimerTime_t* aggregatedTimeOff );
  
  /*!
   * \brief Adds a channel.
   *
   * \param [IN] channelAdd Pointer to the function parameters.
   *
   * \retval Status of the operation.
   */
  LoRaMacStatus_t RegionKR920ChannelAdd( ChannelAddParams_t* channelAdd );
  
  /*!
   * \brief Removes a channel.
   *
   * \param [IN] channelRemove Pointer to the function parameters.
   *
   * \retval Returns true, if the channel was removed successfully.
   */
  bool RegionKR920ChannelsRemove( ChannelRemoveParams_t* channelRemove  );
  
  /*!
   * \brief Sets the radio into continuous wave mode.
   *
   * \param [IN] continuousWave Pointer to the function parameters.
   */
  void RegionKR920SetContinuousWave( ContinuousWaveParams_t* continuousWave );
  
  /*!
   * \brief Computes new datarate according to the given offset
   *
   * \param [IN] downlinkDwellTime Downlink dwell time configuration. 0: No limit, 1: 400ms
   *
   * \param [IN] dr Current datarate
   *
   * \param [IN] drOffset Offset to be applied
   *
   * \retval newDr Computed datarate.
   */
  uint8_t RegionKR920ApplyDrOffset( uint8_t downlinkDwellTime, int8_t dr, int8_t drOffset );
  
  /*! \} defgroup REGIONKR920 */
  
  //void RegionKR920RxBeaconSetup( RxBeaconSetup_t* rxBeaconSetup, uint8_t* outDr );
  
  #endif // __REGION_KR920_H__
  