lr1110_modem_wifi_types.h

Go to the documentation of this file.

 
#ifndef LR1110_MODEM_WIFI_TYPES_H
#define LR1110_MODEM_WIFI_TYPES_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*
 * -----------------------------------------------------------------------------
 * --- DEPENDENCIES ------------------------------------------------------------
 */
 
#include <stdbool.h>
#include <stdint.h>
 
/*
 * -----------------------------------------------------------------------------
 * --- PUBLIC MACROS -----------------------------------------------------------
 */
 
/*
 * -----------------------------------------------------------------------------
 * --- PUBLIC CONSTANTS --------------------------------------------------------
 */
 
#define LR1110_MODEM_WIFI_RESULT_SSID_LENGTH ( 32 )
 
#define LR1110_MODEM_WIFI_MAX_RESULTS ( 32 )
 
#define LR1110_MODEM_WIFI_MAC_ADDRESS_LENGTH ( 6 )
 
#define LR1110_MODEM_WIFI_STR_COUNTRY_CODE_SIZE ( 2 )
 
#define LR1110_MODEM_WIFI_CHANNEL_1_POS ( 0U )  
#define LR1110_MODEM_WIFI_CHANNEL_1_MASK ( 0x01UL << LR1110_MODEM_WIFI_CHANNEL_1_POS )
#define LR1110_MODEM_WIFI_CHANNEL_2_POS ( 1U )  
#define LR1110_MODEM_WIFI_CHANNEL_2_MASK ( 0x01UL << LR1110_MODEM_WIFI_CHANNEL_2_POS )
#define LR1110_MODEM_WIFI_CHANNEL_3_POS ( 2U )  
#define LR1110_MODEM_WIFI_CHANNEL_3_MASK ( 0x01UL << LR1110_MODEM_WIFI_CHANNEL_3_POS )
#define LR1110_MODEM_WIFI_CHANNEL_4_POS ( 3U )  
#define LR1110_MODEM_WIFI_CHANNEL_4_MASK ( 0x01UL << LR1110_MODEM_WIFI_CHANNEL_4_POS )
#define LR1110_MODEM_WIFI_CHANNEL_5_POS ( 4U )  
#define LR1110_MODEM_WIFI_CHANNEL_5_MASK ( 0x01UL << LR1110_MODEM_WIFI_CHANNEL_5_POS )
#define LR1110_MODEM_WIFI_CHANNEL_6_POS ( 5U )  
#define LR1110_MODEM_WIFI_CHANNEL_6_MASK ( 0x01UL << LR1110_MODEM_WIFI_CHANNEL_6_POS )
#define LR1110_MODEM_WIFI_CHANNEL_7_POS ( 6U )  
#define LR1110_MODEM_WIFI_CHANNEL_7_MASK ( 0x01UL << LR1110_MODEM_WIFI_CHANNEL_7_POS )
#define LR1110_MODEM_WIFI_CHANNEL_8_POS ( 7U )  
#define LR1110_MODEM_WIFI_CHANNEL_8_MASK ( 0x01UL << LR1110_MODEM_WIFI_CHANNEL_8_POS )
#define LR1110_MODEM_WIFI_CHANNEL_9_POS ( 8U )  
#define LR1110_MODEM_WIFI_CHANNEL_9_MASK ( 0x01UL << LR1110_MODEM_WIFI_CHANNEL_9_POS )
#define LR1110_MODEM_WIFI_CHANNEL_10_POS ( 9U )  
#define LR1110_MODEM_WIFI_CHANNEL_10_MASK ( 0x01UL << LR1110_MODEM_WIFI_CHANNEL_10_POS )
#define LR1110_MODEM_WIFI_CHANNEL_11_POS ( 10U )  
#define LR1110_MODEM_WIFI_CHANNEL_11_MASK ( 0x01UL << LR1110_MODEM_WIFI_CHANNEL_11_POS )
#define LR1110_MODEM_WIFI_CHANNEL_12_POS ( 11U )  
#define LR1110_MODEM_WIFI_CHANNEL_12_MASK ( 0x01UL << LR1110_MODEM_WIFI_CHANNEL_12_POS )
#define LR1110_MODEM_WIFI_CHANNEL_13_POS ( 12U )  
#define LR1110_MODEM_WIFI_CHANNEL_13_MASK ( 0x01UL << LR1110_MODEM_WIFI_CHANNEL_13_POS )
#define LR1110_MODEM_WIFI_CHANNEL_14_POS ( 13U )  
#define LR1110_MODEM_WIFI_CHANNEL_14_MASK ( 0x01UL << LR1110_MODEM_WIFI_CHANNEL_14_POS )
 
/*
 * -----------------------------------------------------------------------------
 * --- PUBLIC TYPES ------------------------------------------------------------
 */
 
typedef enum
{
    LR1110_MODEM_WIFI_NO_CHANNEL   = 0x00,
    LR1110_MODEM_WIFI_CHANNEL_1    = 0x01,  
    LR1110_MODEM_WIFI_CHANNEL_2    = 0x02,  
    LR1110_MODEM_WIFI_CHANNEL_3    = 0x03,  
    LR1110_MODEM_WIFI_CHANNEL_4    = 0x04,  
    LR1110_MODEM_WIFI_CHANNEL_5    = 0x05,  
    LR1110_MODEM_WIFI_CHANNEL_6    = 0x06,  
    LR1110_MODEM_WIFI_CHANNEL_7    = 0x07,  
    LR1110_MODEM_WIFI_CHANNEL_8    = 0x08,  
    LR1110_MODEM_WIFI_CHANNEL_9    = 0x09,  
    LR1110_MODEM_WIFI_CHANNEL_10   = 0x0A,  
    LR1110_MODEM_WIFI_CHANNEL_11   = 0x0B,  
    LR1110_MODEM_WIFI_CHANNEL_12   = 0x0C,  
    LR1110_MODEM_WIFI_CHANNEL_13   = 0x0D,  
    LR1110_MODEM_WIFI_CHANNEL_14   = 0x0E,  
    LR1110_MODEM_WIFI_ALL_CHANNELS = 0x0F,
} lr1110_modem_wifi_channel_t;
 
typedef enum
{
    LR1110_MODEM_WIFI_TYPE_SCAN_B     = 0x01,  
    LR1110_MODEM_WIFI_TYPE_SCAN_G     = 0x02,  
    LR1110_MODEM_WIFI_TYPE_SCAN_N     = 0x03,  
    LR1110_MODEM_WIFI_TYPE_SCAN_B_G_N = 0x04,  
} lr1110_modem_wifi_signal_type_scan_t;
 
typedef enum
{
    LR1110_MODEM_WIFI_TYPE_RESULT_B = 0x01,  
    LR1110_MODEM_WIFI_TYPE_RESULT_G = 0x02,  
    LR1110_MODEM_WIFI_TYPE_RESULT_N = 0x03,  
} lr1110_modem_wifi_signal_type_result_t;
 
typedef enum
{
    LR1110_MODEM_WIFI_SCAN_MODE_BEACON =
        1,  
    LR1110_MODEM_WIFI_SCAN_MODE_BEACON_AND_PKT =
        2,  
    LR1110_MODEM_WIFI_SCAN_MODE_FULL_BEACON =
        4,  
} lr1110_modem_wifi_mode_t;
 
typedef enum
{
    LR1110_MODEM_WIFI_RESULT_FORMAT_BASIC_COMPLETE         = 0x01,
    LR1110_MODEM_WIFI_RESULT_FORMAT_BASIC_MAC_TYPE_CHANNEL = 0x04,
} lr1110_modem_wifi_result_format_t;
 
typedef uint8_t lr1110_modem_wifi_mac_address_t[LR1110_MODEM_WIFI_MAC_ADDRESS_LENGTH];
 
typedef uint8_t lr1110_modem_wifi_datarate_info_byte_t;
 
typedef uint8_t lr1110_modem_wifi_channel_info_byte_t;
 
typedef uint8_t lr1110_modem_wifi_frame_type_info_byte_t;
 
typedef uint16_t lr1110_modem_wifi_channel_mask_t;
 
typedef struct
{
    uint32_t rx_detection_us;    
    uint32_t rx_correlation_us;  
    uint32_t rx_capture_us;      
    uint32_t demodulation_us;    
} lr1110_modem_wifi_cumulative_timings_t;
 
typedef struct lr1110_modem_wifi_fcs_info_byte_s
{
    bool is_fcs_ok;       
    bool is_fcs_checked;  
} lr1110_modem_wifi_fcs_info_byte_t;
 
typedef struct
{
    lr1110_modem_wifi_datarate_info_byte_t   data_rate_info_byte;   
    lr1110_modem_wifi_channel_info_byte_t    channel_info_byte;     
    int8_t                                   rssi;                  
    lr1110_modem_wifi_frame_type_info_byte_t frame_type_info_byte;  
    lr1110_modem_wifi_mac_address_t          mac_address;           
    int16_t                                  phi_offset;            
    uint32_t timestamp_us_high;  
    uint32_t timestamp_us_low;  
    uint16_t beacon_period_tu;  
} lr1110_modem_wifi_basic_complete_result_t;
 
typedef struct
{
    lr1110_modem_wifi_datarate_info_byte_t data_rate_info_byte;  
    lr1110_modem_wifi_channel_info_byte_t  channel_info_byte;    
    int8_t                                 rssi;                 
    lr1110_modem_wifi_mac_address_t        mac_address;          
} lr1110_modem_wifi_basic_mac_type_channel_result_t;
 
typedef struct
{
    lr1110_modem_wifi_datarate_info_byte_t data_rate_info_byte;  
    lr1110_modem_wifi_channel_info_byte_t  channel_info_byte;    
    int8_t                                 rssi;                 
    uint8_t                                rate;                 
    uint16_t                               service;              
    uint16_t                               length;  
    uint16_t                               frame_control;  
    lr1110_modem_wifi_mac_address_t        mac_address_1;  
    lr1110_modem_wifi_mac_address_t        mac_address_2;  
    lr1110_modem_wifi_mac_address_t        mac_address_3;  
    uint32_t timestamp_us_high;  
    uint32_t timestamp_us_low;  
    uint16_t beacon_period_tu;
    uint16_t seq_control;                                       
    uint8_t  ssid_bytes[LR1110_MODEM_WIFI_RESULT_SSID_LENGTH];  
    uint8_t                           current_channel;          
    uint16_t                          country_code;             
    uint8_t                           io_regulation;            
    lr1110_modem_wifi_fcs_info_byte_t fcs_check_byte;           //<! Frame Check Sequence info
    int16_t                           phi_offset;               
} lr1110_modem_wifi_extended_full_result_t;
 
typedef struct
{
    uint8_t major;  
    uint8_t minor;  
} lr1110_modem_wifi_version_t;
 
#ifdef __cplusplus
}
#endif
 
#endif  // LR1110_MODEM_WIFI_TYPES_H
 
/* --- EOF ------------------------------------------------------------------ */