nrf_modem_wifi_scan.h

Go to the documentation of this file.

/*
 * Copyright (c) 2025 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef NRF_MODEM_WIFI_SCAN_H__
#define NRF_MODEM_WIFI_SCAN_H__
 
#include <stdint.h>
#include <stddef.h>
#include <nrf_modem_toolchain.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define NRF_MODEM_WIFI_SCAN_MAC_ADDRESS_LEN 6
#define NRF_MODEM_WIFI_SCAN_SSID_BUF_LEN 33
#define NRF_MODEM_WIFI_SCAN_RSSI_NOT_MEASURED 0
#define NRF_MODEM_WIFI_SCAN_WIFI_ALL_CHANNELS 0xFFFF
#define NRF_MODEM_WIFI_SCAN_TIME_MS_MIN 100
#define NRF_MODEM_WIFI_SCAN_TIME_DESIRED_MS_DEFAULT 1000
 
enum nrf_modem_wifi_scan_status {
        NRF_MODEM_WIFI_SCAN_STATUS_SUCCESS = 0,
        NRF_MODEM_WIFI_SCAN_STATUS_INVALID_PARAMS = 1,
        NRF_MODEM_WIFI_SCAN_STATUS_ABORTED = 2,
        NRF_MODEM_WIFI_SCAN_STATUS_TIMEOUT = 3,
        NRF_MODEM_WIFI_SCAN_STATUS_FAILURE = 4,
        NRF_MODEM_WIFI_SCAN_STATUS_NOT_ACTIVE = 5,
        NRF_MODEM_WIFI_SCAN_STATUS_NO_MEMORY = 6,
        NRF_MODEM_WIFI_SCAN_STATUS_NOT_ALLOWED = 7,
};
 
enum nrf_modem_wifi_scan_event_id {
        NRF_MODEM_WIFI_SCAN_EVT_RESULT = 1,
};
 
struct nrf_modem_wifi_scan_result {
        bool finished;
 
        int16_t rssi;
 
        uint8_t channel;
 
        uint8_t mac_address[NRF_MODEM_WIFI_SCAN_MAC_ADDRESS_LEN];
 
        char ssid[NRF_MODEM_WIFI_SCAN_SSID_BUF_LEN];
};
 
struct nrf_modem_wifi_scan_event {
        enum nrf_modem_wifi_scan_event_id id;
        enum nrf_modem_wifi_scan_status status;
        union {
                struct nrf_modem_wifi_scan_result result;
        };
};
 
#define NRF_MODEM_WIFI_SCAN_ACTIONS_IGNORE_PROBES 0x01
#define NRF_MODEM_WIFI_SCAN_ACTIONS_IGNORE_LOCAL_ADDR 0x02
#define NRF_MODEM_WIFI_SCAN_ACTIONS_INCREASE_MAX_GAIN 0x04
#define NRF_MODEM_WIFI_SCAN_ACTIONS_ENABLE_OFFLINE_PROCESSING 0x08
struct nrf_modem_wifi_scan_start_params {
        uint32_t actions;
 
        uint16_t channels_bitmap;
 
        uint16_t scan_time_desired_ms;
 
        uint8_t ap_max_count;
};
 
typedef void (*nrf_modem_wifi_scan_event_handler_t)(const struct nrf_modem_wifi_scan_event *evt);
 
int nrf_modem_wifi_scan_event_handler_set(nrf_modem_wifi_scan_event_handler_t handler);
 
int nrf_modem_wifi_scan_start(struct nrf_modem_wifi_scan_start_params const *params);
 
int nrf_modem_wifi_scan_cancel(void);
 
#ifdef __cplusplus
}
#endif
 
#endif /* NRF_MODEM_WIFI_SCAN_H__ */