umac/scan/core/src/wlan_scan_manager_6ghz.h

/*
 * Copyright (c) 2017-2020 The Linux Foundation. All rights reserved.
 * Copyright (c) 2022 Qualcomm Innovation Center, Inc. All rights reserved.
 *
 * Permission to use, copy, modify, and/or distribute this software for
 * any purpose with or without fee is hereby granted, provided that the
 * above copyright notice and this permission notice appear in all
 * copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
 * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
 * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
 * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
 * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 * PERFORMANCE OF THIS SOFTWARE.
 */

/*
 * DOC: contains scan manager functionality
 */

#ifndef _WLAN_SCAN_MANAGER_6GHZ_API_H_
#define _WLAN_SCAN_MANAGER_6GHZ_API_H_

#include "wlan_scan_main.h"

#ifdef CONFIG_BAND_6GHZ

/*
 * Userspace/framework tracks last few days(e.g: 10 days) history of
 * connected APs and maintains best 10 channels out of that list by
 * considering multiple parameters like scoring, location etc.
 * It's likely to find an AP in one of these channels when a scan issued.
 * So, framework issues first scan request with a maximum of 10 channels
 * Any scan request which consist of more than 10 channels can be considered as
 * full scan
 */
#define FULL_SCAN_CH_COUNT_MIN_BY_USERSPACE 11

/*
 * This can used to set the RNR_ONLY flag to certain type(PSC/non-PSC) or
 * all channels.
 */
#define SET_RNR_FLAG_TO_PSC_CHANNEL 0x1
#define SET_RNR_FLAG_TO_NON_PSC_CHANNEL 0x2
#define SET_RNR_FLAG_TO_ALL_6G_CHANNELS 0x3

/**
 * scm_add_channel_flags() - Update 6ghz channel flags in active/pno scan req
 * @vdev: vdev
 * @pno_chan_list: channel list
 * @num_chan: number channels
 * @is_colocated_6ghz_scan_enabled: Colacated 6ghz flag
 * @is_pno_scan: is pno scan
 *
 * Add channel flags for 6ghz channels from active/pno scan request based on ini
 *
 * Return: None
 */
void
scm_add_channel_flags(struct wlan_objmgr_vdev *vdev,
		      struct chan_list *chan_list,
		      uint8_t *num_chan,
		      bool is_colocated_6ghz_scan_enabled,
		      bool is_pno_scan);

/**
 * scm_update_6ghz_channel_list() - Update 6ghz channel list in the scan req
 * @req: scan start request
 * @scan_obj: scan component object
 *
 * Filter out the unsupported 6ghz channels from scan request and add supported
 * 6ghz channels based on the ini.
 *
 * Return: None
 */
void
scm_update_6ghz_channel_list(struct scan_start_request *req,
			     struct wlan_scan_obj *scan_obj);

/**
 * scm_is_6ghz_scan_optimization_supported() - Check firmware capability
 * @psoc: psoc
 *
 * Check if firmware supports 6ghz scan optimization from fw_ext_caps of psoc.
 *
 * Return: None
 */
bool
scm_is_6ghz_scan_optimization_supported(struct wlan_objmgr_psoc *psoc);

/**
 * scm_add_all_valid_6g_channels() - Add all valid 6g channels to scan request
 * @vdev: vdev on which scan request is issued
 * @req: Scan start request
 * @num_scan_ch: Total number of scan channels
 *
 * If colocated 6ghz scan flag present in host scan request or at least one 6G
 * channel is present in the host scan request, then this API
 * fills all remaining (other than channel(s) resent in host scan req) valid
 * 6 GHz channel(s) to scan requests channel list and set the flag
 * FLAG_SCAN_ONLY_IF_RNR_FOUND for each of those added channels.
 * By this driver allows Firmware to scan 6G channels based on RNR IEs only.
 *
 * Return: None
 */
void scm_add_all_valid_6g_channels(struct wlan_objmgr_pdev *pdev,
				   struct chan_list *chan_list,
				   uint8_t *num_scan_ch,
				   bool is_colocated_6ghz);

#else
static inline void
scm_add_channel_flags(struct wlan_objmgr_vdev *vdev,
		      struct chan_list *pno_chan_list,
		      uint8_t *num_chan,
		      bool is_colocated_6ghz,
		      bool is_pno_scan)
{
}

static inline void
scm_update_6ghz_channel_list(struct scan_start_request *req,
			     struct wlan_scan_obj *scan_obj)
{
}

static inline bool
scm_is_6ghz_scan_optimization_supported(struct wlan_objmgr_psoc *psoc)
{
	return false;
}

static inline void scm_add_all_valid_6g_channels(struct wlan_objmgr_pdev *pdev,
						 struct chan_list *chan_list,
						 uint8_t *num_scan_ch,
						 bool is_colocated_6ghz)
{
}
#endif

#endif