xref: /wlan-driver/qcacld-3.0/components/fw_offload/dispatcher/inc/wlan_fwol_tgt_api.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
1 /*
2  * Copyright (c) 2019-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
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: fw offload south bound interface declaration
22  */
23 #ifndef _WLAN_FWOL_TGT_API_H
24 #define _WLAN_FWOL_TGT_API_H
25 
26 #include "wlan_fwol_public_structs.h"
27 
28 #define FWOL_WILDCARD_PDEV_ID   0
29 
30 /**
31  * tgt_fwol_register_ev_handler() - register south bound event handler
32  * @psoc: psoc handle
33  *
34  * Return: QDF_STATUS_SUCCESS on success
35  */
36 QDF_STATUS tgt_fwol_register_ev_handler(struct wlan_objmgr_psoc *psoc);
37 
38 /**
39  * tgt_fwol_unregister_ev_handler() - unregister south bound event handler
40  * @psoc: psoc handle
41  *
42  * Return: QDF_STATUS_SUCCESS on success
43  */
44 QDF_STATUS tgt_fwol_unregister_ev_handler(struct wlan_objmgr_psoc *psoc);
45 
46 /**
47  * tgt_fwol_register_rx_ops() - register fw offload rx operations
48  * @rx_ops: fps to rx operations
49  *
50  * Return: QDF_STATUS_SUCCESS on success
51  */
52 QDF_STATUS tgt_fwol_register_rx_ops(struct wlan_fwol_rx_ops *rx_ops);
53 
54 /**
55  * tgt_fwol_pdev_param_send() - send pdev params to firmware
56  * @pdev: pdev handle
57  * @pdev_param: pdev params
58  *
59  * Return: QDF_STATUS_SUCCESS on success
60  */
61 QDF_STATUS tgt_fwol_pdev_param_send(struct wlan_objmgr_pdev *pdev,
62 				    struct pdev_params pdev_param);
63 
64 /**
65  * tgt_fwol_vdev_param_send() - send vdev params to firmware
66  * @psoc: psoc handle
67  * @vdev_param: vdev params
68  *
69  * Return: QDF_STATUS_SUCCESS on success
70  */
71 QDF_STATUS tgt_fwol_vdev_param_send(struct wlan_objmgr_psoc *psoc,
72 				    struct vdev_set_params vdev_param);
73 
74 #endif /* _WLAN_FWOL_TGT_API_H */
75