xref: /wlan-driver/qcacld-3.0/components/target_if/fw_offload/inc/target_if_fwol.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2019 The Linux Foundation. All rights reserved.
3*5113495bSYour Name  * Copyright (c) 2023 Qualcomm Innovation Center, Inc. All rights reserved.
4*5113495bSYour Name  *
5*5113495bSYour Name  * Permission to use, copy, modify, and/or distribute this software for
6*5113495bSYour Name  * any purpose with or without fee is hereby granted, provided that the
7*5113495bSYour Name  * above copyright notice and this permission notice appear in all
8*5113495bSYour Name  * copies.
9*5113495bSYour Name  *
10*5113495bSYour Name  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
11*5113495bSYour Name  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
12*5113495bSYour Name  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
13*5113495bSYour Name  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
14*5113495bSYour Name  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
15*5113495bSYour Name  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
16*5113495bSYour Name  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
17*5113495bSYour Name  * PERFORMANCE OF THIS SOFTWARE.
18*5113495bSYour Name  */
19*5113495bSYour Name 
20*5113495bSYour Name /**
21*5113495bSYour Name  * DOC: target interface APIs for fw offload
22*5113495bSYour Name  *
23*5113495bSYour Name  */
24*5113495bSYour Name 
25*5113495bSYour Name #ifndef __TARGET_IF_FWOL_H__
26*5113495bSYour Name #define __TARGET_IF_FWOL_H__
27*5113495bSYour Name 
28*5113495bSYour Name /**
29*5113495bSYour Name  * target_if_fwol_register_event_handler() - register fw offload event handler
30*5113495bSYour Name  * @psoc: psoc object
31*5113495bSYour Name  * @arg: argument passed to lmac
32*5113495bSYour Name  *
33*5113495bSYour Name  * Return: QDF_STATUS
34*5113495bSYour Name  */
35*5113495bSYour Name QDF_STATUS target_if_fwol_register_event_handler(struct wlan_objmgr_psoc *psoc,
36*5113495bSYour Name 						 void *arg);
37*5113495bSYour Name 
38*5113495bSYour Name /**
39*5113495bSYour Name  * target_if_fwol_unregister_event_handler() - unregister fw offload event
40*5113495bSYour Name  * handler
41*5113495bSYour Name  * @psoc: psoc object
42*5113495bSYour Name  * @arg: argument passed to lmac
43*5113495bSYour Name  *
44*5113495bSYour Name  * Return: QDF_STATUS
45*5113495bSYour Name  */
46*5113495bSYour Name QDF_STATUS
47*5113495bSYour Name target_if_fwol_unregister_event_handler(struct wlan_objmgr_psoc *psoc,
48*5113495bSYour Name 					void *arg);
49*5113495bSYour Name 
50*5113495bSYour Name /**
51*5113495bSYour Name  * target_if_fwol_register_tx_ops() - register fw offload tx ops callback
52*5113495bSYour Name  * functions
53*5113495bSYour Name  * @tx_ops: fw offload tx operations
54*5113495bSYour Name  *
55*5113495bSYour Name  * Return: QDF_STATUS
56*5113495bSYour Name  */
57*5113495bSYour Name QDF_STATUS target_if_fwol_register_tx_ops(struct wlan_fwol_tx_ops *tx_ops);
58*5113495bSYour Name 
59*5113495bSYour Name /**
60*5113495bSYour Name  * target_if_fwol_notify_thermal_throttle() - Notify thermal throttle level
61*5113495bSYour Name  * to upper layer
62*5113495bSYour Name  * @psoc: PSOC object manager
63*5113495bSYour Name  * @info: Thermal throttle information from target
64*5113495bSYour Name  *
65*5113495bSYour Name  * This function is used to notify thermal throttle level to upper layer
66*5113495bSYour Name  * when thermal management event receive.
67*5113495bSYour Name  *
68*5113495bSYour Name  * Return: QDF_STATUS_SUCCESS for success otherwise failure
69*5113495bSYour Name  */
70*5113495bSYour Name #ifdef FW_THERMAL_THROTTLE_SUPPORT
71*5113495bSYour Name QDF_STATUS
72*5113495bSYour Name target_if_fwol_notify_thermal_throttle(struct wlan_objmgr_psoc *psoc,
73*5113495bSYour Name 				       struct thermal_throttle_info *info);
74*5113495bSYour Name #else
75*5113495bSYour Name static inline QDF_STATUS
target_if_fwol_notify_thermal_throttle(struct wlan_objmgr_psoc * psoc,struct thermal_throttle_info * info)76*5113495bSYour Name target_if_fwol_notify_thermal_throttle(struct wlan_objmgr_psoc *psoc,
77*5113495bSYour Name 				       struct thermal_throttle_info *info)
78*5113495bSYour Name {
79*5113495bSYour Name 	return QDF_STATUS_E_INVAL;
80*5113495bSYour Name }
81*5113495bSYour Name #endif
82*5113495bSYour Name #endif /* __TARGET_IF_FWOL_H__ */
83