xref: /wlan-driver/qcacld-3.0/components/coex/dispatcher/inc/wlan_coex_utils_api.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2020, The Linux Foundation. All rights reserved.
3*5113495bSYour Name  * Copyright (c) 2022 Qualcomm Innovation Center, Inc. All rights reserved.
4*5113495bSYour Name  *
5*5113495bSYour Name  * Permission to use, copy, modify, and/or distribute this software for any
6*5113495bSYour Name  * purpose with or without fee is hereby granted, provided that the above
7*5113495bSYour Name  * copyright notice and this permission notice appear in all copies.
8*5113495bSYour Name  *
9*5113495bSYour Name  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10*5113495bSYour Name  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11*5113495bSYour Name  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12*5113495bSYour Name  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13*5113495bSYour Name  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14*5113495bSYour Name  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15*5113495bSYour Name  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16*5113495bSYour Name  */
17*5113495bSYour Name 
18*5113495bSYour Name /**
19*5113495bSYour Name  * DOC: wlan_coex_utils_api.h
20*5113495bSYour Name  *
21*5113495bSYour Name  * This header file provides declaration of public APIs exposed to other UMAC
22*5113495bSYour Name  * components.
23*5113495bSYour Name  */
24*5113495bSYour Name 
25*5113495bSYour Name #ifndef _WLAN_COEX_UTILS_API_H_
26*5113495bSYour Name #define _WLAN_COEX_UTILS_API_H_
27*5113495bSYour Name #include <wlan_objmgr_psoc_obj.h>
28*5113495bSYour Name 
29*5113495bSYour Name /*
30*5113495bSYour Name  * wlan_coex_init() - Coex module initialization API
31*5113495bSYour Name  *
32*5113495bSYour Name  * Return: QDF_STATUS
33*5113495bSYour Name  */
34*5113495bSYour Name QDF_STATUS wlan_coex_init(void);
35*5113495bSYour Name 
36*5113495bSYour Name /*
37*5113495bSYour Name  * wlan_coex_deinit() - Coex module deinitialization API
38*5113495bSYour Name  *
39*5113495bSYour Name  * Return: QDF_STATUS
40*5113495bSYour Name  */
41*5113495bSYour Name QDF_STATUS wlan_coex_deinit(void);
42*5113495bSYour Name 
43*5113495bSYour Name /**
44*5113495bSYour Name  * wlan_coex_psoc_open() - Open coex component
45*5113495bSYour Name  * @psoc: soc context
46*5113495bSYour Name  *
47*5113495bSYour Name  * This function gets called when dispatcher opening.
48*5113495bSYour Name  *
49*5113495bSYour Name  * Return: QDF_STATUS_SUCCESS - in case of success
50*5113495bSYour Name  */
51*5113495bSYour Name QDF_STATUS
52*5113495bSYour Name wlan_coex_psoc_open(struct wlan_objmgr_psoc *psoc);
53*5113495bSYour Name 
54*5113495bSYour Name /**
55*5113495bSYour Name  * wlan_coex_psoc_close() - Close coex component
56*5113495bSYour Name  * @psoc: soc context
57*5113495bSYour Name  *
58*5113495bSYour Name  * This function gets called when dispatcher closing.
59*5113495bSYour Name  *
60*5113495bSYour Name  * Return: QDF_STATUS_SUCCESS - in case of success
61*5113495bSYour Name  */
62*5113495bSYour Name QDF_STATUS
63*5113495bSYour Name wlan_coex_psoc_close(struct wlan_objmgr_psoc *psoc);
64*5113495bSYour Name 
65*5113495bSYour Name #ifdef WLAN_FEATURE_DBAM_CONFIG
66*5113495bSYour Name /**
67*5113495bSYour Name  * wlan_dbam_psoc_enable() - API to enable coex dbam psoc component
68*5113495bSYour Name  * @psoc: pointer to psoc
69*5113495bSYour Name  *
70*5113495bSYour Name  * This API is invoked from dispatcher psoc enable.
71*5113495bSYour Name  * This API will register dbam WMI event handlers.
72*5113495bSYour Name  *
73*5113495bSYour Name  * Return: QDF_STATUS_SUCCESS on success, QDF_STATUS_E_** on error
74*5113495bSYour Name  */
75*5113495bSYour Name QDF_STATUS wlan_dbam_psoc_enable(struct wlan_objmgr_psoc *psoc);
76*5113495bSYour Name 
77*5113495bSYour Name /**
78*5113495bSYour Name  * wlan_dbam_psoc_disable() - API to disable coex dbam psoc component
79*5113495bSYour Name  * @psoc: pointer to psoc
80*5113495bSYour Name  *
81*5113495bSYour Name  * This API is invoked from dispatcher psoc disable.
82*5113495bSYour Name  * This API will unregister dbam WMI event handlers.
83*5113495bSYour Name  *
84*5113495bSYour Name  * Return: QDF_STATUS_SUCCESS on success, QDF_STATUS_E_** on error
85*5113495bSYour Name  */
86*5113495bSYour Name QDF_STATUS wlan_dbam_psoc_disable(struct wlan_objmgr_psoc *psoc);
87*5113495bSYour Name #endif /* WLAN_FEATURE_DBAM_CONFIG */
88*5113495bSYour Name #endif
89