diff options
Diffstat (limited to 'libloragw/inc/loragw_reg.h')
| -rw-r--r-- | libloragw/inc/loragw_reg.h | 26 |
1 files changed, 14 insertions, 12 deletions
diff --git a/libloragw/inc/loragw_reg.h b/libloragw/inc/loragw_reg.h index 3b74bc3..1c6e9e7 100644 --- a/libloragw/inc/loragw_reg.h +++ b/libloragw/inc/loragw_reg.h @@ -4,10 +4,10 @@ \____ \| ___ | (_ _) ___ |/ ___) _ \ _____) ) ____| | | || |_| ____( (___| | | | (______/|_____)_|_|_| \__)_____)\____)_| |_| - ©2013 Semtech-Cycleo + (C)2013 Semtech-Cycleo Description: - Functions used to handle a single Lora gateway. + Functions used to handle a single LoRa concentrator. Registers are addressed by name. Multi-bytes registers are handled automatically. Read-modify-write is handled automatically. @@ -26,6 +26,8 @@ Maintainer: Sylvain Miermont #include <stdint.h> /* C99 types */ #include <stdbool.h> /* bool type */ +#include "config.h" /* library configuration options (dynamically generated) */ + /* -------------------------------------------------------------------------- */ /* --- PUBLIC CONSTANTS ----------------------------------------------------- */ @@ -34,7 +36,7 @@ Maintainer: Sylvain Miermont /* auto generated register mapping for C code : 11-Jul-2013 13:20:40 -this file contains autogenerated C struct used to access the LORA register from the Primer firmware +this file contains autogenerated C struct used to access the LORA registers this file is autogenerated from registers description 293 registers are defined */ @@ -371,19 +373,19 @@ this file is autogenerated from registers description /* --- PUBLIC FUNCTIONS PROTOTYPES ------------------------------------------ */ /** -@brief Connect Lora gateway by opening SPI link +@brief Connect LoRa concentrator by opening SPI link @return status of register operation (LGW_REG_SUCCESS/LGW_REG_ERROR) */ int lgw_connect(void); /** -@brief Disconnect Lora gateway by closing SPI link +@brief Disconnect LoRa concentrator by closing SPI link @return status of register operation (LGW_REG_SUCCESS/LGW_REG_ERROR) */ int lgw_disconnect(void); /** -@brief Use the soft-reset register to put the gateway in initial state +@brief Use the soft-reset register to put the concentrator in initial state @return status of register operation (LGW_REG_SUCCESS/LGW_REG_ERROR) */ int lgw_soft_reset(void); @@ -396,7 +398,7 @@ int lgw_soft_reset(void); int lgw_reg_check(FILE *f); /** -@brief Lora gateway register write +@brief LoRa concentrator register write @param register_id register number in the data structure describing registers @param reg_value signed value to write to the register (for u32, use cast) @return status of register operation (LGW_REG_SUCCESS/LGW_REG_ERROR) @@ -404,7 +406,7 @@ int lgw_reg_check(FILE *f); int lgw_reg_w(uint16_t register_id, int32_t reg_value); /** -@brief Lora gateway register read +@brief LoRa concentrator register read @param register_id register number in the data structure describing registers @param reg_value pointer to a variable where to write register read value @return status of register operation (LGW_REG_SUCCESS/LGW_REG_ERROR) @@ -412,18 +414,18 @@ int lgw_reg_w(uint16_t register_id, int32_t reg_value); int lgw_reg_r(uint16_t register_id, int32_t *reg_value); /** -@brief Lora gateway register burst write +@brief LoRa concentrator register burst write @param register_id register number in the data structure describing registers -@param data pointer to byte array that will be sent to the Lora gateway +@param data pointer to byte array that will be sent to the LoRa concentrator @param size size of the transfer, in byte(s) @return status of register operation (LGW_REG_SUCCESS/LGW_REG_ERROR) */ int lgw_reg_wb(uint16_t register_id, uint8_t *data, uint16_t size); /** -@brief Lora gateway register burst read +@brief LoRa concentrator register burst read @param register_id register number in the data structure describing registers -@param data pointer to byte array that will be written from the Lora gateway +@param data pointer to byte array that will be written from the LoRa concentrator @param size size of the transfer, in byte(s) @return status of register operation (LGW_REG_SUCCESS/LGW_REG_ERROR) */ |