xref: /wlan-dirver/qca-wifi-host-cmn/umac/wifi_pos/src/wifi_pos_main_i.h (revision 11f5a63a6cbdda84849a730de22f0a71e635d58c)
1 /*
2  * Copyright (c) 2017, 2019 The Linux Foundation. All rights reserved.
3  *
4  * Permission to use, copy, modify, and/or distribute this software for
5  * any purpose with or without fee is hereby granted, provided that the
6  * above copyright notice and this permission notice appear in all
7  * copies.
8  *
9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
10  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
11  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
12  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
13  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
14  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
15  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
16  * PERFORMANCE OF THIS SOFTWARE.
17  */
18 
19 /**
20  * DOC: wifi_pos_main_i.h
21  * This file prototyps the important functions pertinent to wifi positioning
22  * component.
23  */
24 
25 #ifndef _WIFI_POS_MAIN_H_
26 #define _WIFI_POS_MAIN_H_
27 
28 /* forward reference */
29 struct wlan_objmgr_psoc;
30 
31 /**
32  * wifi_pos_psoc_obj_created_notification: callback registered to be called when
33  * psoc object is created.
34  * @psoc: pointer to psoc object just created
35  * @arg_list: argument list
36  *
37  * This function will:
38  *         create WIFI POS psoc object and attach to psoc
39  *         register TLV vs nonTLV callbacks
40  * Return: status of operation
41  */
42 QDF_STATUS wifi_pos_psoc_obj_created_notification(
43 		struct wlan_objmgr_psoc *psoc, void *arg_list);
44 
45 /**
46  * wifi_pos_psoc_obj_destroyed_notification: callback registered to be called
47  * when psoc object is destroyed.
48  * @psoc: pointer to psoc object just about to be destroyed
49  * @arg_list: argument list
50  *
51  * This function will:
52  *         detach WIFI POS from psoc object and free
53  * Return: status of operation
54  */
55 QDF_STATUS  wifi_pos_psoc_obj_destroyed_notification(
56 				struct wlan_objmgr_psoc *psoc, void *arg_list);
57 
58 /**
59  * wifi_pos_oem_rsp_handler: lmac rx ops registered
60  * @psoc: pointer to psoc object
61  * @oem_rsp: response from firmware
62  *
63  * Return: status of operation
64  */
65 int wifi_pos_oem_rsp_handler(struct wlan_objmgr_psoc *psoc,
66 			     struct oem_data_rsp *oem_rsp);
67 
68 /**
69  * wifi_pos_get_tx_ops: api to get tx ops
70  * @psoc: pointer to psoc object
71  *
72  * Return: tx ops
73  */
74 struct wlan_lmac_if_wifi_pos_tx_ops *
75 	wifi_pos_get_tx_ops(struct wlan_objmgr_psoc *psoc);
76 #endif
77