Denislam Valeev / Mbed OS Nucleo_rtos_basic
Embed: (wiki syntax)

« Back to documentation index

lora_phy_ds.h File Reference

lora_phy_ds.h File Reference

Data structures relating to PHY layer. More...

Go to the source code of this file.

Data Structures

union  phy_param_u
struct  get_phy_params_t
 The parameter structure for the function RegionGetPhyParam. More...
struct  set_band_txdone_params_t
 The parameter structure for the function RegionSetBandTxDone. More...
union  verification_params_t
 The parameter verification structure. More...
struct  cflist_params_t
 The parameter structure for the function RegionApplyCFList. More...
struct  tx_config_params_t
 TX configuration parameters. More...
struct  adr_req_params_t
 This structure contains parameters for ADR request coming from network server. More...
struct  link_adr_params_s
 Structure containing data for local ADR settings. More...
struct  verify_adr_params_s
 Structure used to store ADR values received from network for verification (legality) purposes. More...
struct  rx_param_setup_req_s
 Contains rx parameter setup request coming from network server. More...
struct  tx_param_setup_req_s
 Contains tx parameter setup request coming from network server. More...
struct  new_channel_req_params_s
 A structure that holds new channel parameters coming from the network server. More...
struct  dl_channel_req_params_s
 The parameter structure for the function RegionDlChannelReq. More...
struct  backoff_params_s
struct  channel_selection_params_s
 The parameter structure for the function RegionNextChannel. More...
struct  continuous_wave_mode_params_s

Typedefs

typedef enum phy_attributes__e phy_attributes_t
typedef union phy_param_u phy_param_t
typedef struct link_adr_params_s link_adr_params_t
 Structure containing data for local ADR settings.
typedef struct verify_adr_params_s verify_adr_params_t
 Structure used to store ADR values received from network for verification (legality) purposes.
typedef struct rx_param_setup_req_s rx_param_setup_req_t
 Contains rx parameter setup request coming from network server.
typedef struct tx_param_setup_req_s tx_param_setup_req_t
 Contains tx parameter setup request coming from network server.
typedef struct
new_channel_req_params_s 
new_channel_req_params_t
 A structure that holds new channel parameters coming from the network server.
typedef struct
dl_channel_req_params_s 
dl_channel_req_params_t
 The parameter structure for the function RegionDlChannelReq.
typedef struct backoff_params_s backoff_params_t
typedef struct
channel_selection_params_s 
channel_selection_params_t
 The parameter structure for the function RegionNextChannel.
typedef struct
continuous_wave_mode_params_s 
cw_mode_params_t

Enumerations

enum  phy_attributes__e {
  PHY_MIN_RX_DR, PHY_MIN_TX_DR, PHY_MAX_RX_DR, PHY_MAX_TX_DR,
  PHY_TX_DR, PHY_DEF_TX_DR, PHY_RX_DR, PHY_TX_POWER,
  PHY_DEF_TX_POWER, PHY_MAX_PAYLOAD, PHY_MAX_PAYLOAD_REPEATER, PHY_DUTY_CYCLE,
  PHY_MAX_RX_WINDOW, PHY_RECEIVE_DELAY1, PHY_RECEIVE_DELAY2, PHY_JOIN_ACCEPT_DELAY1,
  PHY_JOIN_ACCEPT_DELAY2, PHY_MAX_FCNT_GAP, PHY_ACK_TIMEOUT, PHY_DEF_DR1_OFFSET,
  PHY_DEF_RX2_FREQUENCY, PHY_DEF_RX2_DR, PHY_CHANNEL_MASK, PHY_DEFAULT_CHANNEL_MASK,
  PHY_MAX_NB_CHANNELS, PHY_CHANNELS, PHY_CUSTOM_CHANNEL_PLAN_SUPPORT, PHY_DEF_UPLINK_DWELL_TIME,
  PHY_DEF_DOWNLINK_DWELL_TIME, PHY_DEF_MAX_EIRP, PHY_DEF_ANTENNA_GAIN, PHY_NB_JOIN_TRIALS,
  PHY_DEF_NB_JOIN_TRIALS, PHY_NEXT_LOWER_TX_DR
}

Detailed Description

Data structures relating to PHY layer.

   ______                              _
  / _____)             _              | |
 ( (____  _____ ____ _| |_ _____  ____| |__
  \____ \| ___ |    (_   _) ___ |/ ___)  _ \
  _____) ) ____| | | || |_| ____( (___| | | |
 (______/|_____)_|_|_| \__)_____)\____)_| |_|
   (C)2013 Semtech
  ___ _____ _   ___ _  _____ ___  ___  ___ ___
 / __|_   _/_\ / __| |/ / __/ _ \| _ \/ __| __|
 \__ \ | |/ _ \ (__| ' <| _| (_) |   / (__| _|
 |___/ |_/_/ \_\___|_|\_\_| \___/|_|_\\___|___|
 embedded.connectivity.solutions===============

License: Revised BSD License, see LICENSE.TXT file include in the project

Maintainer: Miguel Luis ( Semtech ), Gregory Cristian ( Semtech ) and Daniel Jaeckle ( STACKFORCE )

Copyright (c) 2017, Arm Limited and affiliates. SPDX-License-Identifier: BSD-3-Clause

Definition in file lora_phy_ds.h.


Typedef Documentation

The parameter structure for the function RegionCalcBackOff.

The parameter structure for the function RegionNextChannel.

The parameter structure for the function RegionContinuousWave.

The parameter structure for the function RegionDlChannelReq.

Structure containing data for local ADR settings.

A structure that holds new channel parameters coming from the network server.

Enumeration of PHY attributes.

typedef union phy_param_u phy_param_t

Keeps value in response to a call to get_phy_params() API.

Contains rx parameter setup request coming from network server.

Contains tx parameter setup request coming from network server.

Structure used to store ADR values received from network for verification (legality) purposes.


Enumeration Type Documentation

Enumeration of PHY attributes.

Enumerator:
PHY_MIN_RX_DR 

The minimum RX datarate.

PHY_MIN_TX_DR 

The minimum TX datarate.

PHY_MAX_RX_DR 

The maximum RX datarate.

PHY_MAX_TX_DR 

The maximum TX datarate.

PHY_TX_DR 

The TX datarate.

PHY_DEF_TX_DR 

The default TX datarate.

PHY_RX_DR 

The RX datarate.

PHY_TX_POWER 

The TX power.

PHY_DEF_TX_POWER 

The default TX power.

PHY_MAX_PAYLOAD 

Maximum payload possible.

PHY_MAX_PAYLOAD_REPEATER 

Maximum payload possible when the repeater support is enabled.

PHY_DUTY_CYCLE 

The duty cycle.

PHY_MAX_RX_WINDOW 

The maximum receive window duration.

PHY_RECEIVE_DELAY1 

The receive delay for window 1.

PHY_RECEIVE_DELAY2 

The receive delay for window 2.

PHY_JOIN_ACCEPT_DELAY1 

The join accept delay for window 1.

PHY_JOIN_ACCEPT_DELAY2 

The join accept delay for window 2.

PHY_MAX_FCNT_GAP 

The maximum frame counter gap.

PHY_ACK_TIMEOUT 

The acknowledgement time out.

PHY_DEF_DR1_OFFSET 

The default datarate offset for window 1.

PHY_DEF_RX2_FREQUENCY 

The default receive window 2 frequency.

PHY_DEF_RX2_DR 

The default receive window 2 datarate.

PHY_CHANNEL_MASK 

The channels mask.

PHY_DEFAULT_CHANNEL_MASK 

The default channel mask.

PHY_MAX_NB_CHANNELS 

The maximum number of supported channels.

PHY_CHANNELS 

The channels.

PHY_CUSTOM_CHANNEL_PLAN_SUPPORT 

The PHYs that support dynamic channel plan (non-custom) support do not let the user add/remove to the channel plan. The network guides the device for the plan. So only EU like regions support custom channel planning.

PHY_DEF_UPLINK_DWELL_TIME 

The default value of the uplink dwell time.

PHY_DEF_DOWNLINK_DWELL_TIME 

The default value of the downlink dwell time.

PHY_DEF_MAX_EIRP 

The default value of the MaxEIRP.

PHY_DEF_ANTENNA_GAIN 

The default value of the antenna gain.

PHY_NB_JOIN_TRIALS 

The value for the number of join trials.

PHY_DEF_NB_JOIN_TRIALS 

The default value for the number of join trials.

PHY_NEXT_LOWER_TX_DR 

The next lower datarate.

Definition at line 530 of file lora_phy_ds.h.