xref: /wlan-driver/qcacld-3.0/core/hdd/inc/wlan_hdd_spectralscan.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2017-2020 The Linux Foundation. All rights reserved.
3*5113495bSYour Name  * Copyright (c) 2022-2023 Qualcomm Innovation Center, Inc. All rights reserved.
4*5113495bSYour Name  *
5*5113495bSYour Name  * Permission to use, copy, modify, and/or distribute this software for
6*5113495bSYour Name  * any purpose with or without fee is hereby granted, provided that the
7*5113495bSYour Name  * above copyright notice and this permission notice appear in all
8*5113495bSYour Name  * copies.
9*5113495bSYour Name  *
10*5113495bSYour Name  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
11*5113495bSYour Name  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
12*5113495bSYour Name  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
13*5113495bSYour Name  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
14*5113495bSYour Name  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
15*5113495bSYour Name  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
16*5113495bSYour Name  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
17*5113495bSYour Name  * PERFORMANCE OF THIS SOFTWARE.
18*5113495bSYour Name  */
19*5113495bSYour Name 
20*5113495bSYour Name /**
21*5113495bSYour Name  * DOC: wlan_hdd_spectralscan.h
22*5113495bSYour Name  *
23*5113495bSYour Name  * WLAN Host Device Driver spectral scan implementation
24*5113495bSYour Name  *
25*5113495bSYour Name  */
26*5113495bSYour Name 
27*5113495bSYour Name #if !defined(WLAN_HDD_SPECTRALSCAN_H)
28*5113495bSYour Name #define WLAN_HDD_SPECTRALSCAN_H
29*5113495bSYour Name 
30*5113495bSYour Name #ifdef WLAN_CONV_SPECTRAL_ENABLE
31*5113495bSYour Name 
32*5113495bSYour Name /*
33*5113495bSYour Name  * enum spectral_scan_msg_type - spectral scan registration
34*5113495bSYour Name  * @SPECTRAL_SCAN_REGISTER_REQ: spectral scan app register request
35*5113495bSYour Name  * @SPECTRAL_SCAN_REGISTER_RSP: spectral scan app register response
36*5113495bSYour Name  */
37*5113495bSYour Name enum spectral_scan_msg_type {
38*5113495bSYour Name 	SPECTRAL_SCAN_REGISTER_REQ,
39*5113495bSYour Name 	SPECTRAL_SCAN_REGISTER_RSP,
40*5113495bSYour Name };
41*5113495bSYour Name 
42*5113495bSYour Name /*
43*5113495bSYour Name  * struct spectral_scan_msg - spectral scan request message
44*5113495bSYour Name  * @msg_type: message type
45*5113495bSYour Name  * @pid: process id
46*5113495bSYour Name  */
47*5113495bSYour Name struct spectral_scan_msg {
48*5113495bSYour Name 	uint32_t msg_type;
49*5113495bSYour Name 	uint32_t pid;
50*5113495bSYour Name };
51*5113495bSYour Name 
52*5113495bSYour Name /**
53*5113495bSYour Name  * struct spectral_scan_msg_v - spectral scan request message included version
54*5113495bSYour Name  * @msg_type: message type
55*5113495bSYour Name  * @pid: process id
56*5113495bSYour Name  * @version: version information
57*5113495bSYour Name  * @sub_version: sub version information
58*5113495bSYour Name  */
59*5113495bSYour Name struct spectral_scan_msg_v {
60*5113495bSYour Name 	uint32_t msg_type;
61*5113495bSYour Name 	uint32_t pid;
62*5113495bSYour Name 	uint32_t version;
63*5113495bSYour Name 	uint32_t sub_version;
64*5113495bSYour Name };
65*5113495bSYour Name 
66*5113495bSYour Name #define FEATURE_SPECTRAL_SCAN_VENDOR_COMMANDS                         \
67*5113495bSYour Name {                                                                     \
68*5113495bSYour Name 	.info.vendor_id = QCA_NL80211_VENDOR_ID,                      \
69*5113495bSYour Name 	.info.subcmd = QCA_NL80211_VENDOR_SUBCMD_SPECTRAL_SCAN_START, \
70*5113495bSYour Name 	.flags = WIPHY_VENDOR_CMD_NEED_WDEV | \
71*5113495bSYour Name 			WIPHY_VENDOR_CMD_NEED_NETDEV, \
72*5113495bSYour Name 	.doit = wlan_hdd_cfg80211_spectral_scan_start, \
73*5113495bSYour Name 	vendor_command_policy(spectral_scan_policy, \
74*5113495bSYour Name 			      QCA_WLAN_VENDOR_ATTR_SPECTRAL_SCAN_CONFIG_MAX) \
75*5113495bSYour Name }, \
76*5113495bSYour Name { \
77*5113495bSYour Name 	.info.vendor_id = QCA_NL80211_VENDOR_ID, \
78*5113495bSYour Name 	.info.subcmd = QCA_NL80211_VENDOR_SUBCMD_SPECTRAL_SCAN_STOP, \
79*5113495bSYour Name 	.flags = WIPHY_VENDOR_CMD_NEED_WDEV | \
80*5113495bSYour Name 		WIPHY_VENDOR_CMD_NEED_NETDEV, \
81*5113495bSYour Name 	.doit = wlan_hdd_cfg80211_spectral_scan_stop, \
82*5113495bSYour Name 	vendor_command_policy(spectral_scan_policy, \
83*5113495bSYour Name 			      QCA_WLAN_VENDOR_ATTR_SPECTRAL_SCAN_CONFIG_MAX) \
84*5113495bSYour Name }, \
85*5113495bSYour Name { \
86*5113495bSYour Name 	.info.vendor_id = QCA_NL80211_VENDOR_ID, \
87*5113495bSYour Name 	.info.subcmd = QCA_NL80211_VENDOR_SUBCMD_SPECTRAL_SCAN_GET_CONFIG, \
88*5113495bSYour Name 	.flags = WIPHY_VENDOR_CMD_NEED_WDEV | \
89*5113495bSYour Name 			WIPHY_VENDOR_CMD_NEED_NETDEV, \
90*5113495bSYour Name 	.doit = wlan_hdd_cfg80211_spectral_scan_get_config, \
91*5113495bSYour Name 	vendor_command_policy(spectral_scan_policy, \
92*5113495bSYour Name 			      QCA_WLAN_VENDOR_ATTR_SPECTRAL_SCAN_CONFIG_MAX) \
93*5113495bSYour Name }, \
94*5113495bSYour Name { \
95*5113495bSYour Name 	.info.vendor_id = QCA_NL80211_VENDOR_ID, \
96*5113495bSYour Name 	.info.subcmd = QCA_NL80211_VENDOR_SUBCMD_SPECTRAL_SCAN_GET_DIAG_STATS, \
97*5113495bSYour Name 	.flags = WIPHY_VENDOR_CMD_NEED_WDEV |                                  \
98*5113495bSYour Name 		WIPHY_VENDOR_CMD_NEED_NETDEV,                                  \
99*5113495bSYour Name 	.doit = wlan_hdd_cfg80211_spectral_scan_get_diag_stats,                \
100*5113495bSYour Name 	vendor_command_policy(VENDOR_CMD_RAW_DATA, 0)                          \
101*5113495bSYour Name },                                                                             \
102*5113495bSYour Name {                                                                            \
103*5113495bSYour Name 	.info.vendor_id = QCA_NL80211_VENDOR_ID,                             \
104*5113495bSYour Name 	.info.subcmd = QCA_NL80211_VENDOR_SUBCMD_SPECTRAL_SCAN_GET_CAP_INFO, \
105*5113495bSYour Name 	.flags = WIPHY_VENDOR_CMD_NEED_WDEV |                                \
106*5113495bSYour Name 			WIPHY_VENDOR_CMD_NEED_NETDEV,                        \
107*5113495bSYour Name 	.doit = wlan_hdd_cfg80211_spectral_scan_get_cap_info,                \
108*5113495bSYour Name 	vendor_command_policy(VENDOR_CMD_RAW_DATA, 0)                        \
109*5113495bSYour Name },                                                                           \
110*5113495bSYour Name {                                                                            \
111*5113495bSYour Name 	.info.vendor_id = QCA_NL80211_VENDOR_ID,                             \
112*5113495bSYour Name 	.info.subcmd = QCA_NL80211_VENDOR_SUBCMD_SPECTRAL_SCAN_GET_STATUS,   \
113*5113495bSYour Name 	.flags = WIPHY_VENDOR_CMD_NEED_WDEV |                                \
114*5113495bSYour Name 		WIPHY_VENDOR_CMD_NEED_NETDEV,                                \
115*5113495bSYour Name 	.doit = wlan_hdd_cfg80211_spectral_scan_get_status,                  \
116*5113495bSYour Name 	vendor_command_policy(VENDOR_CMD_RAW_DATA, 0)                        \
117*5113495bSYour Name },
118*5113495bSYour Name 
119*5113495bSYour Name /**
120*5113495bSYour Name  * wlan_hdd_cfg80211_spectral_scan_start() - start spectral scan
121*5113495bSYour Name  * @wiphy:    WIPHY structure pointer
122*5113495bSYour Name  * @wdev:     Wireless device structure pointer
123*5113495bSYour Name  * @data:     Pointer to the data received
124*5113495bSYour Name  * @data_len: Length of the data received
125*5113495bSYour Name  *
126*5113495bSYour Name  * This function starts spectral scan
127*5113495bSYour Name  *
128*5113495bSYour Name  * Return: 0 on success and errno on failure
129*5113495bSYour Name  */
130*5113495bSYour Name int wlan_hdd_cfg80211_spectral_scan_start(struct wiphy *wiphy,
131*5113495bSYour Name 						struct wireless_dev *wdev,
132*5113495bSYour Name 						const void *data,
133*5113495bSYour Name 						int data_len);
134*5113495bSYour Name 
135*5113495bSYour Name /**
136*5113495bSYour Name  * wlan_hdd_cfg80211_spectral_scan_stop() - stop spectral scan
137*5113495bSYour Name  * @wiphy:    WIPHY structure pointer
138*5113495bSYour Name  * @wdev:     Wireless device structure pointer
139*5113495bSYour Name  * @data:     Pointer to the data received
140*5113495bSYour Name  * @data_len: Length of the data received
141*5113495bSYour Name  *
142*5113495bSYour Name  * This function stops spectral scan
143*5113495bSYour Name  *
144*5113495bSYour Name  * Return: 0 on success and errno on failure
145*5113495bSYour Name  */
146*5113495bSYour Name int wlan_hdd_cfg80211_spectral_scan_stop(struct wiphy *wiphy,
147*5113495bSYour Name 						struct wireless_dev *wdev,
148*5113495bSYour Name 						const void *data,
149*5113495bSYour Name 						int data_len);
150*5113495bSYour Name 
151*5113495bSYour Name /**
152*5113495bSYour Name  * wlan_hdd_cfg80211_spectral_scan_get_config() - get spectral scan config
153*5113495bSYour Name  * @wiphy:    WIPHY structure pointer
154*5113495bSYour Name  * @wdev:     Wireless device structure pointer
155*5113495bSYour Name  * @data:     Pointer to the data received
156*5113495bSYour Name  * @data_len: Length of the data received
157*5113495bSYour Name  *
158*5113495bSYour Name  * This function gets the spectral scan configuration
159*5113495bSYour Name  *
160*5113495bSYour Name  * Return: 0 on success and errno on failure
161*5113495bSYour Name  */
162*5113495bSYour Name int wlan_hdd_cfg80211_spectral_scan_get_config(struct wiphy *wiphy,
163*5113495bSYour Name 					       struct wireless_dev *wdev,
164*5113495bSYour Name 					       const void *data,
165*5113495bSYour Name 					       int data_len);
166*5113495bSYour Name 
167*5113495bSYour Name /**
168*5113495bSYour Name  * wlan_hdd_cfg80211_spectral_scan_get_diag_stats() -
169*5113495bSYour Name  *                                               get spectral scan diag stats
170*5113495bSYour Name  * @wiphy:    WIPHY structure pointer
171*5113495bSYour Name  * @wdev:     Wireless device structure pointer
172*5113495bSYour Name  * @data:     Pointer to the data received
173*5113495bSYour Name  * @data_len: Length of the data received
174*5113495bSYour Name  *
175*5113495bSYour Name  * This function gets spectral scan diagnostic statistics
176*5113495bSYour Name  *
177*5113495bSYour Name  * Return: 0 on success and errno on failure
178*5113495bSYour Name  */
179*5113495bSYour Name int wlan_hdd_cfg80211_spectral_scan_get_diag_stats(struct wiphy *wiphy,
180*5113495bSYour Name 						struct wireless_dev *wdev,
181*5113495bSYour Name 						const void *data,
182*5113495bSYour Name 						int data_len);
183*5113495bSYour Name 
184*5113495bSYour Name /**
185*5113495bSYour Name  * wlan_hdd_cfg80211_spectral_scan_get_cap_info() - get spectral scan cpa
186*5113495bSYour Name  * @wiphy:    WIPHY structure pointer
187*5113495bSYour Name  * @wdev:     Wireless device structure pointer
188*5113495bSYour Name  * @data:     Pointer to the data received
189*5113495bSYour Name  * @data_len: Length of the data received
190*5113495bSYour Name  *
191*5113495bSYour Name  * This function gets the spectral scan capabilities
192*5113495bSYour Name  *
193*5113495bSYour Name  * Return: 0 on success and errno on failure
194*5113495bSYour Name  */
195*5113495bSYour Name int wlan_hdd_cfg80211_spectral_scan_get_cap_info(struct wiphy *wiphy,
196*5113495bSYour Name 						struct wireless_dev *wdev,
197*5113495bSYour Name 						const void *data,
198*5113495bSYour Name 						int data_len);
199*5113495bSYour Name 
200*5113495bSYour Name /**
201*5113495bSYour Name  * wlan_hdd_cfg80211_spectral_scan_get_status() - get spectral scan status
202*5113495bSYour Name  * @wiphy:    WIPHY structure pointer
203*5113495bSYour Name  * @wdev:     Wireless device structure pointer
204*5113495bSYour Name  * @data:     Pointer to the data received
205*5113495bSYour Name  * @data_len: Length of the data received
206*5113495bSYour Name  *
207*5113495bSYour Name  * This function gets the spectral scan status
208*5113495bSYour Name  *
209*5113495bSYour Name  * Return: 0 on success and errno on failure
210*5113495bSYour Name  */
211*5113495bSYour Name int wlan_hdd_cfg80211_spectral_scan_get_status(struct wiphy *wiphy,
212*5113495bSYour Name 						struct wireless_dev *wdev,
213*5113495bSYour Name 						const void *data,
214*5113495bSYour Name 						int data_len);
215*5113495bSYour Name 
216*5113495bSYour Name /**
217*5113495bSYour Name  * hdd_spectral_register_to_dbr() - Register spectral to DBR
218*5113495bSYour Name  * @hdd_ctx: pointer to hdd context
219*5113495bSYour Name  *
220*5113495bSYour Name  * This function registers spectral to Direct Buffer RX component.
221*5113495bSYour Name  *
222*5113495bSYour Name  * Return: None
223*5113495bSYour Name  */
224*5113495bSYour Name void hdd_spectral_register_to_dbr(struct hdd_context *hdd_ctx);
225*5113495bSYour Name #else
226*5113495bSYour Name #define FEATURE_SPECTRAL_SCAN_VENDOR_COMMANDS
227*5113495bSYour Name static inline void
hdd_spectral_register_to_dbr(struct hdd_context * hdd_ctx)228*5113495bSYour Name hdd_spectral_register_to_dbr(struct hdd_context *hdd_ctx)
229*5113495bSYour Name {
230*5113495bSYour Name }
231*5113495bSYour Name #endif
232*5113495bSYour Name 
233*5113495bSYour Name #if defined(CNSS_GENL) && defined(WLAN_CONV_SPECTRAL_ENABLE)
234*5113495bSYour Name /**
235*5113495bSYour Name  * spectral_scan_activate_service() - Activate spectral scan  message handler
236*5113495bSYour Name  * @hdd_ctx: callback context to use
237*5113495bSYour Name  *
238*5113495bSYour Name  * This function registers a handler to receive netlink message from
239*5113495bSYour Name  * the spectral scan application process.
240*5113495bSYour Name  *
241*5113495bSYour Name  * Return: None
242*5113495bSYour Name  */
243*5113495bSYour Name void spectral_scan_activate_service(struct hdd_context *hdd_ctx);
244*5113495bSYour Name 
245*5113495bSYour Name /**
246*5113495bSYour Name  * spectral_scan_deactivate_service() - Deactivate spectral scan message handler
247*5113495bSYour Name  *
248*5113495bSYour Name  * This function deregisters a handler to receive netlink message from
249*5113495bSYour Name  * the spectral scan application process.
250*5113495bSYour Name  *
251*5113495bSYour Name  * Return: None
252*5113495bSYour Name  */
253*5113495bSYour Name void spectral_scan_deactivate_service(void);
254*5113495bSYour Name 
255*5113495bSYour Name /**
256*5113495bSYour Name  * wlan_spectral_update_rx_chainmask() - API to update rx chainmask before
257*5113495bSYour Name  * start spectral gen3
258*5113495bSYour Name  * @link_info: Link info pointer in HDD adapter.
259*5113495bSYour Name  *
260*5113495bSYour Name  * API to update rx chainmask before start spectral gen3.
261*5113495bSYour Name  *
262*5113495bSYour Name  * Return: QDF_STATUS_SUCCESS or non-zero on failure
263*5113495bSYour Name  */
264*5113495bSYour Name QDF_STATUS
265*5113495bSYour Name wlan_spectral_update_rx_chainmask(struct wlan_hdd_link_info *link_info);
266*5113495bSYour Name #else
spectral_scan_activate_service(struct hdd_context * hdd_ctx)267*5113495bSYour Name static inline void spectral_scan_activate_service(struct hdd_context *hdd_ctx)
268*5113495bSYour Name {
269*5113495bSYour Name }
270*5113495bSYour Name 
spectral_scan_deactivate_service(void)271*5113495bSYour Name static inline void spectral_scan_deactivate_service(void)
272*5113495bSYour Name {
273*5113495bSYour Name }
274*5113495bSYour Name 
275*5113495bSYour Name #ifdef WLAN_CONV_SPECTRAL_ENABLE
276*5113495bSYour Name static inline QDF_STATUS
wlan_spectral_update_rx_chainmask(struct wlan_hdd_link_info * link_info)277*5113495bSYour Name wlan_spectral_update_rx_chainmask(struct wlan_hdd_link_info *link_info)
278*5113495bSYour Name {
279*5113495bSYour Name 	return QDF_STATUS_SUCCESS;
280*5113495bSYour Name }
281*5113495bSYour Name #endif /* WLAN_CONV_SPECTRAL_ENABLE */
282*5113495bSYour Name #endif
283*5113495bSYour Name #endif
284