xref: /wlan-dirver/qca-wifi-host-cmn/umac/mlme/psoc_mgr/dispatcher/inc/wlan_psoc_mlme_api.h (revision 11f5a63a6cbdda84849a730de22f0a71e635d58c)
1 /*
2  * Copyright (c) 2019 The Linux Foundation. All rights reserved.
3  *
4  * Permission to use, copy, modify, and/or distribute this software for any
5  * purpose with or without fee is hereby granted, provided that the above
6  * copyright notice and this permission notice appear in all copies.
7  *
8  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15  */
16 
17 /**
18  * DOC: Define PSOC MLME public APIs
19  */
20 
21 #ifndef _WLAN_PSOC_MLME_API_H_
22 #define _WLAN_PSOC_MLME_API_H_
23 
24 /**
25  * wlan_psoc_mlme_get_cmpt_obj() - Returns PSOC MLME component object
26  * @psoc: PSOC object
27  *
28  * Retrieves MLME component object from PSOC object
29  *
30  * Return: comp handle on SUCCESS
31  *         NULL, if it fails to retrieve
32  */
33 struct psoc_mlme_obj *wlan_psoc_mlme_get_cmpt_obj(
34 						struct wlan_objmgr_psoc *psoc);
35 
36 /**
37  * wlan_psoc_mlme_get_ext_hdl() - Returns legacy handle
38  * @psoc: PSOC object
39  *
40  * Retrieves legacy handle from psoc mlme component object
41  *
42  * Return: legacy handle on SUCCESS
43  *         NULL, if it fails to retrieve
44  */
45 mlme_psoc_ext_t *wlan_psoc_mlme_get_ext_hdl(struct wlan_objmgr_psoc *psoc);
46 
47 /**
48  * wlan_psoc_mlme_set_ext_hdl() - Set legacy handle
49  * @psoc_mlme: psoc_mlme object
50  * psoc_ext_hdl: PSOC level legacy handle
51  *
52  * Sets legacy handle in psoc mlme component object
53  *
54  * Return: Void
55  */
56 void wlan_psoc_mlme_set_ext_hdl(struct psoc_mlme_obj *psoc_mlme,
57 				mlme_psoc_ext_t *psoc_ext_hdl);
58 
59 #endif
60