lr1110_wifi.h

Go to the documentation of this file.

 
#ifndef LR1110_WIFI_H
#define LR1110_WIFI_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*
 * -----------------------------------------------------------------------------
 * --- DEPENDENCIES ------------------------------------------------------------
 */
 
#include "transceiver/lr1110_regmem.h"
#include "transceiver/lr1110_wifi_types.h"
#include "common/lr1110_types.h"
#include "common/lr1110_hal.h"
 
/*
 * -----------------------------------------------------------------------------
 * --- PUBLIC MACROS -----------------------------------------------------------
 */
 
/*
 * -----------------------------------------------------------------------------
 * --- PUBLIC CONSTANTS --------------------------------------------------------
 */
 
#ifndef LR1110_WIFI_N_RESULTS_MAX_PER_CHUNK
#define LR1110_WIFI_N_RESULTS_MAX_PER_CHUNK LR1110_WIFI_MAX_RESULTS
#endif  // LR1110_WIFI_N_RESULTS_MAX_PER_CHUNK
 
/*
 * -----------------------------------------------------------------------------
 * --- PUBLIC TYPES ------------------------------------------------------------
 */
 
/*
 * -----------------------------------------------------------------------------
 * --- PUBLIC FUNCTIONS PROTOTYPES ---------------------------------------------
 */
 
err_t lr1110_wifi_scan( lriot_t *ctx, lr1110_wifi_signal_type_scan_t signal_type,
                        lr1110_wifi_channel_mask_t channels, lr1110_wifi_mode_t scan_mode,
                        uint8_t max_results, uint8_t nb_scan_per_channel, uint16_t timeout_in_ms, bool abort_on_timeout );
 
err_t lr1110_wifi_search_country_code( lriot_t *ctx, lr1110_wifi_channel_mask_t channels_mask,
                                       uint8_t nb_max_results, uint8_t nb_scan_per_channel,
                                       uint16_t timeout_in_ms, bool abort_on_timeout );
 
err_t lr1110_wifi_scan_time_limit( lriot_t *ctx, lr1110_wifi_signal_type_scan_t signal_type,
                                   lr1110_wifi_channel_mask_t channels, lr1110_wifi_mode_t scan_mode, uint8_t max_results,
                                   uint16_t timeout_per_channel_ms, uint16_t timeout_per_scan_ms );
 
err_t lr1110_wifi_search_country_code_time_limit( lriot_t *ctx, lr1110_wifi_channel_mask_t channels_mask,
                                                  uint8_t nb_max_results, uint16_t timeout_per_channel_ms,
                                                  uint16_t timeout_per_scan_ms );
 
err_t lr1110_wifi_get_nb_results( lriot_t *ctx, uint8_t* nb_results );
 
err_t lr1110_wifi_read_basic_complete_results( lriot_t *ctx, uint8_t start_result_index, uint8_t nb_results,
                                               lr1110_wifi_basic_complete_result_t* results );
 
err_t lr1110_wifi_read_basic_mac_type_channel_results( lriot_t *ctx, uint8_t start_result_index, uint8_t nb_results,
                                                       lr1110_wifi_basic_mac_type_channel_result_t* results );
 
err_t lr1110_wifi_read_extended_full_results( lriot_t *ctx, uint8_t start_result_index, uint8_t nb_results,
                                              lr1110_wifi_extended_full_result_t* results );
 
err_t lr1110_wifi_reset_cumulative_timing( lriot_t *ctx );
 
err_t lr1110_wifi_read_cumulative_timing( lriot_t *ctx, lr1110_wifi_cumulative_timings_t* timing );
 
err_t lr1110_wifi_get_nb_country_code_results( lriot_t *ctx, uint8_t* nb_country_code_results );
 
err_t lr1110_wifi_read_country_code_results( lriot_t *ctx, uint8_t start_result_index, uint8_t nb_country_results,
                                             lr1110_wifi_country_code_t* country_code_results );
 
err_t lr1110_wifi_cfg_timestamp_ap_phone( lriot_t *ctx, uint32_t timestamp_in_s );
 
err_t lr1110_wifi_read_version( lriot_t *ctx, lr1110_wifi_version_t* wifi_version );
 
void lr1110_wifi_parse_channel_info( lr1110_wifi_channel_info_byte_t channel_info, uint8_t* channel,
                                     bool* rssi_validity, uint8_t* mac_origin_estimation );
 
uint8_t lr1110_wifi_extract_channel_from_info_byte( lr1110_wifi_channel_info_byte_t channel_info );
 
void lr1110_wifi_parse_frame_type_info( lr1110_wifi_frame_type_info_byte_t frame_type_info, uint8_t* frame_type,
                                        lr1110_wifi_frame_sub_type_t* frame_sub_type, bool* to_ds, bool* from_ds );
 
void lr1110_wifi_parse_data_rate_info( lr1110_wifi_datarate_info_byte_t data_rate_info, uint8_t* wifi_signal_type,
                                       uint8_t* wifi_data_rate );
 
uint8_t lr1110_wifi_get_nb_results_max_per_chunk( void );
 
uint8_t lr1110_wifi_extract_signal_type_from_data_rate_info( lr1110_wifi_datarate_info_byte_t data_rate_info );
 
bool lr1110_wifi_is_well_formed_utf8_byte_sequence( uint8_t* buffer, uint8_t length );
 
#ifdef __cplusplus
}
#endif
 
#endif  // LR1110_WIFI_H
 
/* --- EOF ------------------------------------------------------------------ */