xref: /wlan-dirver/qca-wifi-host-cmn/ftm/dispatcher/inc/wlan_ftm_init_deinit_api.h (revision 3149adf58a329e17232a4c0e58d460d025edd55a)
1 /*
2  * Copyright (c) 2018 The Linux Foundation. All rights reserved.
3  *
4  *
5  * Permission to use, copy, modify, and/or distribute this software for
6  * any purpose with or without fee is hereby granted, provided that the
7  * above copyright notice and this permission notice appear in all
8  * copies.
9  *
10  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
11  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
12  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
13  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
14  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
15  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
16  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
17  * PERFORMANCE OF THIS SOFTWARE.
18  */
19 
20 /**
21  * DOC: declare the ftm service data structure and apis
22  */
23 #ifndef _WLAN_FTM_UCFG_API_H_
24 #define _WLAN_FTM_UCFG_API_H_
25 
26 #include <qdf_types.h>
27 #include <qdf_status.h>
28 #include <wlan_objmgr_cmn.h>
29 
30 /**
31  * dispatcher_ftm_init() - FTM testmode initialization API
32  *
33  * Return: QDF_STATUS_SUCCESS on success, QDF_STATUS_E_** on error
34  */
35 QDF_STATUS dispatcher_ftm_init(void);
36 
37 /**
38  * dispatcher_ftm_deinit() - FTM testmode deinitialization API
39  *
40  * Return: QDF_STATUS_SUCCESS on success, QDF_STATUS_E_** on error
41  */
42 QDF_STATUS dispatcher_ftm_deinit(void);
43 
44 /**
45  * dispatcher_ftm_psoc_open() - FTM module open API
46  * @psoc: psoc object
47  *
48  * Return: QDF_STATUS_SUCCESS on success, QDF_STATUS_E_** on error
49  */
50 QDF_STATUS dispatcher_ftm_psoc_open(struct wlan_objmgr_psoc *psoc);
51 
52 /**
53  * dispatcher_ftm_psoc_close() - FTM module close API
54  * @psoc: psoc object
55  *
56  * Return: QDF_STATUS_SUCCESS on success, QDF_STATUS_E_** on error
57  */
58 QDF_STATUS dispatcher_ftm_psoc_close(struct wlan_objmgr_psoc *psoc);
59 #endif /* _WLAN_FTM_UCFG_API_H_ */
60