xref: /wlan-dirver/qca-wifi-host-cmn/umac/thermal/dispatcher/inc/wlan_thermal_public_struct.h (revision 97f44cd39e4ff816eaa1710279d28cf6b9e65ad9)
1 /* Copyright (c) 2020, The Linux Foundation. All rights reserved.
2  *
3  * Permission to use, copy, modify, and/or distribute this software for any
4  * purpose with or without fee is hereby granted, provided that the above
5  * copyright notice and this permission notice appear in all copies.
6  *
7  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
8  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
9  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
10  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
11  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
12  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
13  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
14  */
15 
16 /**
17  * DOC: declare the thermal public structure
18  */
19 #ifndef _WLAN_THERMAL_PUBLIC_STRUCT_H_
20 #define _WLAN_THERMAL_PUBLIC_STRUCT_H_
21 
22 /**
23  * enum thermal_throttle_level - firmware offload throttle level
24  * @THERMAL_FULLPERF: no any throtting
25  * @THERMAL_MITIGATION: throtting tx to do mitigation
26  * @THERMAL_SHUTOFF: shut down the tx completely
27  * @THERMAL_UNKNOWN: unknown level from target.
28  */
29 enum thermal_throttle_level {
30 	 THERMAL_FULLPERF,
31 	 THERMAL_MITIGATION,
32 	 THERMAL_SHUTOFF,
33 	 THERMAL_UNKNOWN,
34 };
35 
36 #endif /* _WLAN_THERMAL_PUBLIC_STRUCT_H_ */
37