xref: /wlan-driver/qca-wifi-host-cmn/umac/dcs/dispatcher/inc/wlan_dcs_init_deinit_api.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2020, The Linux Foundation. All rights reserved.
3*5113495bSYour Name  *
4*5113495bSYour Name  * Permission to use, copy, modify, and/or distribute this software for any
5*5113495bSYour Name  * purpose with or without fee is hereby granted, provided that the above
6*5113495bSYour Name  * copyright notice and this permission notice appear in all copies.
7*5113495bSYour Name  *
8*5113495bSYour Name  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9*5113495bSYour Name  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10*5113495bSYour Name  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11*5113495bSYour Name  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12*5113495bSYour Name  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13*5113495bSYour Name  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14*5113495bSYour Name  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15*5113495bSYour Name  */
16*5113495bSYour Name 
17*5113495bSYour Name /**
18*5113495bSYour Name  * DOC: wlan_dcs_init_deinit_api.h
19*5113495bSYour Name  *
20*5113495bSYour Name  * This header file provide declaration to public APIs exposed for other UMAC
21*5113495bSYour Name  * components to init/deinit, (de)register to required WMI events on
22*5113495bSYour Name  * soc enable/disable
23*5113495bSYour Name  */
24*5113495bSYour Name 
25*5113495bSYour Name #ifndef __WLAN_DCS_INIT_DEINIT_API_H__
26*5113495bSYour Name #define __WLAN_DCS_INIT_DEINIT_API_H__
27*5113495bSYour Name 
28*5113495bSYour Name #ifdef DCS_INTERFERENCE_DETECTION
29*5113495bSYour Name 
30*5113495bSYour Name #include <qdf_types.h>
31*5113495bSYour Name #include <qdf_status.h>
32*5113495bSYour Name #include <wlan_objmgr_cmn.h>
33*5113495bSYour Name 
34*5113495bSYour Name /**
35*5113495bSYour Name  * wlan_dcs_init(): API to init dcs component
36*5113495bSYour Name  *
37*5113495bSYour Name  * This API is invoked from dispatcher init during all component init.
38*5113495bSYour Name  * This API will register all required handlers for pdev object
39*5113495bSYour Name  * create/delete notification.
40*5113495bSYour Name  *
41*5113495bSYour Name  * Return: QDF_STATUS_SUCCESS on success, QDF_STATUS_E_** on error
42*5113495bSYour Name  */
43*5113495bSYour Name QDF_STATUS wlan_dcs_init(void);
44*5113495bSYour Name 
45*5113495bSYour Name /**
46*5113495bSYour Name  * wlan_dcs_deinit(): API to deinit dcs component
47*5113495bSYour Name  *
48*5113495bSYour Name  * This API is invoked from dispatcher deinit during all component deinit.
49*5113495bSYour Name  * This API will unregister all required handlers for pdev object
50*5113495bSYour Name  * create/delete notification.
51*5113495bSYour Name  *
52*5113495bSYour Name  * Return: QDF_STATUS_SUCCESS on success, QDF_STATUS_E_** on error
53*5113495bSYour Name  */
54*5113495bSYour Name QDF_STATUS wlan_dcs_deinit(void);
55*5113495bSYour Name 
56*5113495bSYour Name /**
57*5113495bSYour Name  * wlan_dcs_enable(): API to enable dcs component
58*5113495bSYour Name  * @psoc: pointer to psoc
59*5113495bSYour Name  *
60*5113495bSYour Name  * This API is invoked from dispatcher psoc enable.
61*5113495bSYour Name  * This API will register dcs WMI event handlers.
62*5113495bSYour Name  *
63*5113495bSYour Name  * Return: QDF_STATUS_SUCCESS on success, QDF_STATUS_E_** on error
64*5113495bSYour Name  */
65*5113495bSYour Name QDF_STATUS wlan_dcs_enable(struct wlan_objmgr_psoc *psoc);
66*5113495bSYour Name 
67*5113495bSYour Name /**
68*5113495bSYour Name  * wlan_dcs_disable(): API to disable dcs component
69*5113495bSYour Name  * @psoc: pointer to psoc
70*5113495bSYour Name  *
71*5113495bSYour Name  * This API is invoked from dispatcher psoc disable.
72*5113495bSYour Name  * This API will unregister dcs WMI event handlers.
73*5113495bSYour Name  *
74*5113495bSYour Name  * Return: QDF_STATUS_SUCCESS on success, QDF_STATUS_E_** on error
75*5113495bSYour Name  */
76*5113495bSYour Name QDF_STATUS wlan_dcs_disable(struct wlan_objmgr_psoc *psoc);
77*5113495bSYour Name 
78*5113495bSYour Name /**
79*5113495bSYour Name  * wlan_dcs_psoc_open() - Dcs psoc open handler
80*5113495bSYour Name  * @psoc:  pointer to psoc object
81*5113495bSYour Name  *
82*5113495bSYour Name  * API to execute operations on psoc open
83*5113495bSYour Name  *
84*5113495bSYour Name  * Return: QDF_STATUS_SUCCESS upon successful registration,
85*5113495bSYour Name  *         QDF_STATUS_E_FAILURE upon failure
86*5113495bSYour Name  */
87*5113495bSYour Name QDF_STATUS wlan_dcs_psoc_open(struct wlan_objmgr_psoc *psoc);
88*5113495bSYour Name 
89*5113495bSYour Name #endif /* DCS_INTERFERENCE_DETECTION */
90*5113495bSYour Name #endif /* __WLAN_DCS_INIT_DEINIT_API_H__ */
91*5113495bSYour Name 
92