lr1110_system_types.h

Go to the documentation of this file.

 
#ifndef LR1110_SYSTEM_TYPES_H
#define LR1110_SYSTEM_TYPES_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*
 * -----------------------------------------------------------------------------
 * --- DEPENDENCIES ------------------------------------------------------------
 */
 
#include <stdint.h>
#include <stdbool.h>
 
/*
 * -----------------------------------------------------------------------------
 * --- PUBLIC MACROS -----------------------------------------------------------
 */
 
/*
 * -----------------------------------------------------------------------------
 * --- PUBLIC CONSTANTS --------------------------------------------------------
 */
 
#define LR1110_SYSTEM_VERSION_LENGTH ( 4 )
 
#define LR1110_SYSTEM_UID_LENGTH ( 8 )
#define LR1110_SYSTEM_JOIN_EUI_LENGTH ( 8 )
#define LR1110_SYSTEM_PIN_LENGTH ( 4 )
 
/*
 * -----------------------------------------------------------------------------
 * --- PUBLIC TYPES ------------------------------------------------------------
 */
 
typedef uint8_t lr1110_system_uid_t[LR1110_SYSTEM_UID_LENGTH];
 
typedef uint8_t lr1110_system_join_eui_t[LR1110_SYSTEM_JOIN_EUI_LENGTH];
 
typedef uint8_t lr1110_system_pin_t[LR1110_SYSTEM_PIN_LENGTH];
 
typedef uint32_t lr1110_system_irq_mask_t;
 
#define LR1110_SYSTEM_IRQ_NONE                   ( 0 << 0 )
#define LR1110_SYSTEM_IRQ_TX_DONE                ( 1 << 2 )
#define LR1110_SYSTEM_IRQ_RX_DONE                ( 1 << 3 )
#define LR1110_SYSTEM_IRQ_PREAMBLE_DETECTED      ( 1 << 4 )
#define LR1110_SYSTEM_IRQ_SYNC_WORD_HEADER_VALID ( 1 << 5 )
#define LR1110_SYSTEM_IRQ_HEADER_ERROR           ( 1 << 6 )
#define LR1110_SYSTEM_IRQ_CRC_ERROR              ( 1 << 7 )
#define LR1110_SYSTEM_IRQ_CAD_DONE               ( 1 << 8 )
#define LR1110_SYSTEM_IRQ_CAD_DETECTED           ( 1 << 9 )
#define LR1110_SYSTEM_IRQ_TIMEOUT                ( 1 << 10 )
#define LR1110_SYSTEM_IRQ_LR_FHSS_INTRA_PKT_HOP  ( 1 << 11 )
#define LR1110_SYSTEM_IRQ_GNSS_SCAN_DONE         ( 1ul << 19 )
#define LR1110_SYSTEM_IRQ_WIFI_SCAN_DONE         ( 1ul << 20 )
#define LR1110_SYSTEM_IRQ_EOL                    ( 1ul << 21 )
#define LR1110_SYSTEM_IRQ_CMD_ERROR              ( 1ul << 22 )
#define LR1110_SYSTEM_IRQ_ERROR                  ( 1ul << 23 )
#define LR1110_SYSTEM_IRQ_FSK_LEN_ERROR          ( 1ul << 24 )
#define LR1110_SYSTEM_IRQ_FSK_ADDR_ERROR         ( 1ul << 25 )
#define LR1110_SYSTEM_IRQ_ALL_MASK \
        LR1110_SYSTEM_IRQ_TX_DONE | LR1110_SYSTEM_IRQ_RX_DONE | LR1110_SYSTEM_IRQ_PREAMBLE_DETECTED | \
        LR1110_SYSTEM_IRQ_SYNC_WORD_HEADER_VALID | LR1110_SYSTEM_IRQ_HEADER_ERROR | LR1110_SYSTEM_IRQ_CRC_ERROR | \
        LR1110_SYSTEM_IRQ_CAD_DONE | LR1110_SYSTEM_IRQ_CAD_DETECTED | LR1110_SYSTEM_IRQ_TIMEOUT | \
        LR1110_SYSTEM_IRQ_GNSS_SCAN_DONE | LR1110_SYSTEM_IRQ_WIFI_SCAN_DONE | LR1110_SYSTEM_IRQ_EOL | \
        LR1110_SYSTEM_IRQ_CMD_ERROR | LR1110_SYSTEM_IRQ_ERROR | LR1110_SYSTEM_IRQ_FSK_LEN_ERROR | \
        LR1110_SYSTEM_IRQ_FSK_ADDR_ERROR
 
enum lr1110_system_calibration_e
{
    LR1110_SYSTEM_CALIB_LF_RC_MASK  = ( 1 << 0 ),
    LR1110_SYSTEM_CALIB_HF_RC_MASK  = ( 1 << 1 ),
    LR1110_SYSTEM_CALIB_PLL_MASK    = ( 1 << 2 ),
    LR1110_SYSTEM_CALIB_ADC_MASK    = ( 1 << 3 ),
    LR1110_SYSTEM_CALIB_IMG_MASK    = ( 1 << 4 ),
    LR1110_SYSTEM_CALIB_PLL_TX_MASK = ( 1 << 5 )
};
 
typedef uint8_t lr1110_system_cal_mask_t;
 
enum lr1110_system_errors_e
{
    LR1110_SYSTEM_ERRORS_LF_RC_CALIB_MASK   = ( 1 << 0 ),
    LR1110_SYSTEM_ERRORS_HF_RC_CALIB_MASK   = ( 1 << 1 ),
    LR1110_SYSTEM_ERRORS_ADC_CALIB_MASK     = ( 1 << 2 ),
    LR1110_SYSTEM_ERRORS_PLL_CALIB_MASK     = ( 1 << 3 ),
    LR1110_SYSTEM_ERRORS_IMG_CALIB_MASK     = ( 1 << 4 ),
    LR1110_SYSTEM_ERRORS_HF_XOSC_START_MASK = ( 1 << 5 ),
    LR1110_SYSTEM_ERRORS_LF_XOSC_START_MASK = ( 1 << 6 ),
    LR1110_SYSTEM_ERRORS_PLL_LOCK_MASK      = ( 1 << 7 )
};
 
typedef uint16_t lr1110_system_errors_t;
 
typedef enum
{
    LR1110_SYSTEM_CHIP_MODE_SLEEP     = 0x00,
    LR1110_SYSTEM_CHIP_MODE_STBY_RC   = 0x01,
    LR1110_SYSTEM_CHIP_MODE_STBY_XOSC = 0x02,
    LR1110_SYSTEM_CHIP_MODE_FS        = 0x03,
    LR1110_SYSTEM_CHIP_MODE_RX        = 0x04,
    LR1110_SYSTEM_CHIP_MODE_TX        = 0x05,
    LR1110_SYSTEM_CHIP_MODE_LOC       = 0x06
} lr1110_system_chip_modes_t;
 
typedef enum
{
    LR1110_SYSTEM_RESET_STATUS_CLEARED      = 0x00,
    LR1110_SYSTEM_RESET_STATUS_ANALOG       = 0x01,
    LR1110_SYSTEM_RESET_STATUS_EXTERNAL     = 0x02,
    LR1110_SYSTEM_RESET_STATUS_SYSTEM       = 0x03,
    LR1110_SYSTEM_RESET_STATUS_WATCHDOG     = 0x04,
    LR1110_SYSTEM_RESET_STATUS_IOCD_RESTART = 0x05,
    LR1110_SYSTEM_RESET_STATUS_RTC_RESTART  = 0x06
} lr1110_system_reset_status_t;
 
typedef enum
{
    LR1110_SYSTEM_CMD_STATUS_FAIL = 0x00,
    LR1110_SYSTEM_CMD_STATUS_PERR = 0x01,
    LR1110_SYSTEM_CMD_STATUS_OK   = 0x02,
    LR1110_SYSTEM_CMD_STATUS_DATA = 0x03
} lr1110_system_command_status_t;
 
typedef enum
{
    LR1110_SYSTEM_LFCLK_RC   = 0x00,  
    LR1110_SYSTEM_LFCLK_XTAL = 0x01,
    LR1110_SYSTEM_LFCLK_EXT  = 0x02
} lr1110_system_lfclk_cfg_t;
 
typedef enum
{
    LR1110_SYSTEM_REG_MODE_LDO  = 0x00,  
    LR1110_SYSTEM_REG_MODE_DCDC = 0x01
} lr1110_system_reg_mode_t;
 
typedef enum
{
    LR1110_SYSTEM_INFOPAGE_0 = 0x00,  
    LR1110_SYSTEM_INFOPAGE_1 = 0x01  
} lr1110_system_infopage_id_t;
 
enum lr1110_system_rfswitch_cfg_pin_e
{
    LR1110_SYSTEM_RFSW0_HIGH = ( 1 << 0 ),
    LR1110_SYSTEM_RFSW1_HIGH = ( 1 << 1 ),
    LR1110_SYSTEM_RFSW2_HIGH = ( 1 << 2 ),
    LR1110_SYSTEM_RFSW3_HIGH = ( 1 << 3 ),
    LR1110_SYSTEM_RFSW4_HIGH = ( 1 << 4 )
};
 
typedef struct lr1110_system_rfswitch_cfg_s
{
    uint8_t enable;
    uint8_t standby;
    uint8_t rx_mode;
    uint8_t tx_mode;
    uint8_t tx_hp;
    uint8_t tx_hf;
    uint8_t gnss;
    uint8_t wifi;
} lr1110_system_rfswitch_cfg_t;
 
typedef enum
{
    LR1110_SYSTEM_STANDBY_CFG_RC   = 0x00,
    LR1110_SYSTEM_STANDBY_CFG_XOSC = 0x01
} lr1110_system_standby_cfg_t;
 
typedef enum
{
    LR1110_SYSTEM_TCXO_CTRL_1_6V = 0x00,  
    LR1110_SYSTEM_TCXO_CTRL_1_7V = 0x01,  
    LR1110_SYSTEM_TCXO_CTRL_1_8V = 0x02,  
    LR1110_SYSTEM_TCXO_CTRL_2_2V = 0x03,  
    LR1110_SYSTEM_TCXO_CTRL_2_4V = 0x04,  
    LR1110_SYSTEM_TCXO_CTRL_2_7V = 0x05,  
    LR1110_SYSTEM_TCXO_CTRL_3_0V = 0x06,  
    LR1110_SYSTEM_TCXO_CTRL_3_3V = 0x07  
} lr1110_system_tcxo_supply_voltage_t;
 
typedef struct lr1110_system_stat1_s
{
    uint8_t  command_status;
    bool     is_interrupt_active;
} lr1110_system_stat1_t;
 
typedef struct lr1110_system_stat2_s
{
    uint8_t reset_status;
    uint8_t chip_mode;
    bool    is_running_from_flash;
} lr1110_system_stat2_t;
 
typedef struct lr1110_system_version_s
{
    uint8_t  hw;
    uint8_t  type;
    uint16_t fw;
} lr1110_system_version_t;
 
typedef struct lr1110_system_sleep_cfg_s
{
    bool is_warm_start;
    bool is_rtc_timeout;
} lr1110_system_sleep_cfg_t;
 
/*
 * -----------------------------------------------------------------------------
 * --- PUBLIC FUNCTIONS PROTOTYPES ---------------------------------------------
 */
 
#ifdef __cplusplus
}
#endif
 
#endif  // LR1110_SYSTEM_TYPES_H
 
/* --- EOF ------------------------------------------------------------------ */