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