1*5113495bSYour Name /*
2*5113495bSYour Name * Copyright (c) 2017-2019 The Linux Foundation. All rights reserved.
3*5113495bSYour Name * Copyright (c) 2023 Qualcomm Innovation Center, Inc. All rights reserved.
4*5113495bSYour Name *
5*5113495bSYour Name *
6*5113495bSYour Name * Permission to use, copy, modify, and/or distribute this software for
7*5113495bSYour Name * any purpose with or without fee is hereby granted, provided that the
8*5113495bSYour Name * above copyright notice and this permission notice appear in all
9*5113495bSYour Name * copies.
10*5113495bSYour Name *
11*5113495bSYour Name * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
12*5113495bSYour Name * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
13*5113495bSYour Name * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
14*5113495bSYour Name * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
15*5113495bSYour Name * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
16*5113495bSYour Name * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
17*5113495bSYour Name * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
18*5113495bSYour Name * PERFORMANCE OF THIS SOFTWARE.
19*5113495bSYour Name */
20*5113495bSYour Name
21*5113495bSYour Name #ifndef _SPECTRAL_CMN_API_I_H_
22*5113495bSYour Name #define _SPECTRAL_CMN_API_I_H_
23*5113495bSYour Name
24*5113495bSYour Name #include "spectral_defs_i.h"
25*5113495bSYour Name
26*5113495bSYour Name /**
27*5113495bSYour Name * wlan_spectral_psoc_obj_create_handler() - handler for psoc object create
28*5113495bSYour Name * @psoc: reference to global psoc object
29*5113495bSYour Name * @arg: reference to argument provided during registration of handler
30*5113495bSYour Name *
31*5113495bSYour Name * This is a handler to indicate psoc object created. Hence spectral_context
32*5113495bSYour Name * object can be created and attached to psoc component list.
33*5113495bSYour Name *
34*5113495bSYour Name * Return: QDF_STATUS_SUCCESS on success
35*5113495bSYour Name * QDF_STATUS_E_FAILURE if psoc is null
36*5113495bSYour Name * QDF_STATUS_E_NOMEM on failure of spectral object allocation
37*5113495bSYour Name */
38*5113495bSYour Name QDF_STATUS wlan_spectral_psoc_obj_create_handler(struct wlan_objmgr_psoc *psoc,
39*5113495bSYour Name void *arg);
40*5113495bSYour Name
41*5113495bSYour Name /**
42*5113495bSYour Name * wlan_spectral_psoc_obj_destroy_handler() - handler for psoc object delete
43*5113495bSYour Name * @psoc: reference to global psoc object
44*5113495bSYour Name * @arg: reference to argument provided during registration of handler
45*5113495bSYour Name *
46*5113495bSYour Name * This is a handler to indicate psoc object going to be deleted.
47*5113495bSYour Name * Hence spectral_context object can be detached from psoc component list.
48*5113495bSYour Name * Then spectral_context object can be deleted.
49*5113495bSYour Name *
50*5113495bSYour Name * Return: QDF_STATUS_SUCCESS on success
51*5113495bSYour Name * QDF_STATUS_E_FAILURE on failure
52*5113495bSYour Name */
53*5113495bSYour Name QDF_STATUS wlan_spectral_psoc_obj_destroy_handler(struct wlan_objmgr_psoc *psoc,
54*5113495bSYour Name void *arg);
55*5113495bSYour Name
56*5113495bSYour Name /**
57*5113495bSYour Name * wlan_spectral_pdev_obj_create_handler() - handler for pdev object create
58*5113495bSYour Name * @pdev: reference to global pdev object
59*5113495bSYour Name * @arg: reference to argument provided during registration of handler
60*5113495bSYour Name *
61*5113495bSYour Name * This is a handler to indicate pdev object created. Hence pdev specific
62*5113495bSYour Name * spectral object can be created and attached to pdev component list.
63*5113495bSYour Name *
64*5113495bSYour Name * Return: QDF_STATUS_SUCCESS on success
65*5113495bSYour Name * QDF_STATUS_E_FAILURE if pdev is null
66*5113495bSYour Name * QDF_STATUS_E_NOMEM on failure of spectral object allocation
67*5113495bSYour Name */
68*5113495bSYour Name QDF_STATUS wlan_spectral_pdev_obj_create_handler(struct wlan_objmgr_pdev *pdev,
69*5113495bSYour Name void *arg);
70*5113495bSYour Name
71*5113495bSYour Name /**
72*5113495bSYour Name * wlan_spectral_pdev_obj_destroy_handler() - handler for pdev object delete
73*5113495bSYour Name * @pdev: reference to global pdev object
74*5113495bSYour Name * @arg: reference to argument provided during registration of handler
75*5113495bSYour Name *
76*5113495bSYour Name * This is a handler to indicate pdev object going to be deleted.
77*5113495bSYour Name * Hence pdev specific spectral object can be detached from pdev component list.
78*5113495bSYour Name * Then pdev_spectral object can be deleted.
79*5113495bSYour Name *
80*5113495bSYour Name * Return: QDF_STATUS_SUCCESS on success
81*5113495bSYour Name * QDF_STATUS_E_FAILURE on failure
82*5113495bSYour Name */
83*5113495bSYour Name QDF_STATUS wlan_spectral_pdev_obj_destroy_handler(struct wlan_objmgr_pdev *pdev,
84*5113495bSYour Name void *arg);
85*5113495bSYour Name
86*5113495bSYour Name /**
87*5113495bSYour Name * spectral_control_cmn()- common handler for demultiplexing requests from
88*5113495bSYour Name * higher layer
89*5113495bSYour Name * @pdev: reference to global pdev object
90*5113495bSYour Name * @sscan_req: pointer to Spectral scan request
91*5113495bSYour Name *
92*5113495bSYour Name * This function processes the spectral config command
93*5113495bSYour Name * and appropriate handlers are invoked.
94*5113495bSYour Name *
95*5113495bSYour Name * Return: QDF_STATUS_SUCCESS/QDF_STATUS_E_FAILURE
96*5113495bSYour Name */
97*5113495bSYour Name QDF_STATUS spectral_control_cmn(struct wlan_objmgr_pdev *pdev,
98*5113495bSYour Name struct spectral_cp_request *sscan_req);
99*5113495bSYour Name
100*5113495bSYour Name /**
101*5113495bSYour Name * spectral_control_ol(): Offload handler for demultiplexing requests from
102*5113495bSYour Name * higher layer
103*5113495bSYour Name * @pdev: reference to global pdev object
104*5113495bSYour Name * @id: spectral config command id
105*5113495bSYour Name * @indata: reference to input data
106*5113495bSYour Name * @insize: input data size
107*5113495bSYour Name * @outdata: reference to output data
108*5113495bSYour Name * @outsize: reference to output data size
109*5113495bSYour Name *
110*5113495bSYour Name * This function processes the spectral config command
111*5113495bSYour Name * and appropriate handlers are invoked.
112*5113495bSYour Name *
113*5113495bSYour Name * Return: 0 success else failure
114*5113495bSYour Name */
115*5113495bSYour Name int spectral_control_ol(
116*5113495bSYour Name struct wlan_objmgr_pdev *pdev, u_int id,
117*5113495bSYour Name void *indata, uint32_t insize, void *outdata, uint32_t *outsize);
118*5113495bSYour Name
119*5113495bSYour Name /**
120*5113495bSYour Name * spectral_get_spectral_ctx_from_pdev() - API to get spectral context object
121*5113495bSYour Name * from pdev
122*5113495bSYour Name * @pdev: Reference to pdev global object
123*5113495bSYour Name *
124*5113495bSYour Name * This API used to get spectral context object from global pdev reference.
125*5113495bSYour Name * Null check should be done before invoking this inline function.
126*5113495bSYour Name *
127*5113495bSYour Name * Return: Reference to spectral_context object
128*5113495bSYour Name */
129*5113495bSYour Name static inline struct spectral_context *
spectral_get_spectral_ctx_from_pdev(struct wlan_objmgr_pdev * pdev)130*5113495bSYour Name spectral_get_spectral_ctx_from_pdev(struct wlan_objmgr_pdev *pdev)
131*5113495bSYour Name {
132*5113495bSYour Name struct wlan_objmgr_psoc *psoc = NULL;
133*5113495bSYour Name struct spectral_context *sc = NULL;
134*5113495bSYour Name
135*5113495bSYour Name psoc = wlan_pdev_get_psoc(pdev);
136*5113495bSYour Name if (psoc) {
137*5113495bSYour Name sc = wlan_objmgr_psoc_get_comp_private_obj(
138*5113495bSYour Name psoc,
139*5113495bSYour Name WLAN_UMAC_COMP_SPECTRAL);
140*5113495bSYour Name }
141*5113495bSYour Name
142*5113495bSYour Name return sc;
143*5113495bSYour Name }
144*5113495bSYour Name
145*5113495bSYour Name /**
146*5113495bSYour Name * spectral_get_spectral_ctx_from_psoc() - API to get spectral context object
147*5113495bSYour Name * from psoc
148*5113495bSYour Name * @psoc: Reference to psoc global object
149*5113495bSYour Name *
150*5113495bSYour Name * This API used to get spectral context object from global psoc reference.
151*5113495bSYour Name * Null check should be done before invoking this inline function.
152*5113495bSYour Name *
153*5113495bSYour Name * Return: Reference to spectral_context object
154*5113495bSYour Name */
155*5113495bSYour Name static inline struct spectral_context *
spectral_get_spectral_ctx_from_psoc(struct wlan_objmgr_psoc * psoc)156*5113495bSYour Name spectral_get_spectral_ctx_from_psoc(struct wlan_objmgr_psoc *psoc)
157*5113495bSYour Name {
158*5113495bSYour Name struct spectral_context *sc = NULL;
159*5113495bSYour Name
160*5113495bSYour Name if (psoc) {
161*5113495bSYour Name sc = wlan_objmgr_psoc_get_comp_private_obj(
162*5113495bSYour Name psoc,
163*5113495bSYour Name WLAN_UMAC_COMP_SPECTRAL);
164*5113495bSYour Name }
165*5113495bSYour Name
166*5113495bSYour Name return sc;
167*5113495bSYour Name }
168*5113495bSYour Name
169*5113495bSYour Name /**
170*5113495bSYour Name * spectral_get_spectral_ctx_from_vdev() - API to get spectral context object
171*5113495bSYour Name * from vdev
172*5113495bSYour Name * @vdev: Reference to vdev global object
173*5113495bSYour Name *
174*5113495bSYour Name * This API used to get spectral context object from global vdev reference.
175*5113495bSYour Name * Null check should be done before invoking this inline function.
176*5113495bSYour Name *
177*5113495bSYour Name * Return: Reference to spectral_context object
178*5113495bSYour Name */
179*5113495bSYour Name static inline struct spectral_context *
spectral_get_spectral_ctx_from_vdev(struct wlan_objmgr_vdev * vdev)180*5113495bSYour Name spectral_get_spectral_ctx_from_vdev(struct wlan_objmgr_vdev *vdev)
181*5113495bSYour Name {
182*5113495bSYour Name struct wlan_objmgr_psoc *psoc = NULL;
183*5113495bSYour Name struct spectral_context *sc = NULL;
184*5113495bSYour Name
185*5113495bSYour Name psoc = wlan_vdev_get_psoc(vdev);
186*5113495bSYour Name if (psoc) {
187*5113495bSYour Name sc = wlan_objmgr_psoc_get_comp_private_obj(
188*5113495bSYour Name psoc,
189*5113495bSYour Name WLAN_UMAC_COMP_SPECTRAL);
190*5113495bSYour Name }
191*5113495bSYour Name
192*5113495bSYour Name return sc;
193*5113495bSYour Name }
194*5113495bSYour Name #endif /* _SPECTRAL_CMN_API_I_H_ */
195